ncid-notify(1)

1NCID-NOTIFY(1)                       NCID                       NCID-NOTIFY(1)
2
3
4

NAME

6       ncid-notify - send an NCID notification to your iOS device
7

SYNOPSIS

9       ncid --no-gui --module ncid-notify
10

DESCRIPTION

12       The  ncid-notify  output  module uses Prowl to display the Caller ID or
13       message on an iOS device.
14
15   Prowl (iOS)
16       notify 'application', 'event' and 'notification' values:
17           $NAME $NMBR $LINE $DATE $TIME $TYPE
18           $DESC $MESG $MTYPE
19
20       Three "rows" of information are available for Prowl.
21
22       When $TYPE is one of the CALLTYPEs
23           Row 1 'application'            NCID
24           Row 2 'event' text             Incoming Call
25           Row 3 'notification' text      John on Cell 407-555-7777 POTS
26           Click on ">" to see 'url'      http://callerr.com/4075557777
27
28           The Prowl "bubble" notification pop-up is even more compact,
29           consisting of only two lines:
30           Row 1 'application' & 'event'  NCID -- Incoming Call
31           Row 2 'notification'           John on Cell 407-555-7777 POTS
32
33       When $TYPE is one of the MSGTYPEs
34           Row 1 'application'            NCID
35           Row 2 'event' text             Message
36           Row 3 'notification' text      Food ready!
37
38           The Prowl "bubble" notification pop-up is even more compact,
39           consisting of only two lines:
40           Row 1 'application' & 'event'  NCID -- Message
41           Row 2 'notification'           Food ready!
42
43       Prowl defaults when $TYPE is one of the CALLTYPEs
44          notify_application_for_calls_prowl='NCID'
45                notify_event_for_calls_prowl='$DESC'
46         notify_notification_for_calls_prowl='$NAME $NMBR $LINE'
47
48       Prowl defaults when  $TYPE  is  one  of  the  MSGTYPEs  notify_applica‐
49       tion_for_messages_prowl='NCID'
50             notify_event_for_messages_prowl='$DESC'          notify_notifica‐
51       tion_for_messages_prowl='$MESG'
52
53
54   NMA (Notify My Android)
55       No longer supported, closed operation on May 24, 2018.
56

CONFIGURATION

58       The ncid-notify output module is configured in ncid-notify.conf.
59
60       allowed types
61              This sets the NCID call and/or message  types  ncid-notify  will
62              send.  See ncid-notify.conf for a complete list.
63
64              Default: allowed_types="ALLTYPES"
65
66       If  you  want  to  send notification only when a ring count is reached,
67       configure ring by creating the ncid_notify variable in ncid-conf.
68

REQUIREMENTS

70       The ncid-notify module requires either a key variable to be set  to  an
71       API key or a key file that contains the API key.
72
73       iOS Device Requirements:
74              The Prowl (Growl client for iOS) app from the app store
75              Registration at Prowl website http://www.prowlapp.com/
76              Generated API key to be placed in configuration file.
77

FILES

79       /etc/ncid/conf.d/ncid-notify.conf
80       /usr/share/ncid/modules/ncid-notify
81       /etc/ncid/conf.d/key-prowl-api
82       /etc/ncid/conf.d/key-prowl-provider
83

NAME

SYNOPSIS

DESCRIPTION

CONFIGURATION

REQUIREMENTS

FILES

SEE ALSO