ncid-notify - Man Page
send an NCID notification to your iOS device
Synopsis
ncid --no-gui --module ncid-notify
Description
The ncid-notify output module uses Prowl to display the Caller ID or message on an iOS device.
Prowl (iOS)
notify 'application', 'event' and 'notification' values:
$NAME $NMBR $LINE $DATE $TIME $TYPE
$DESC $MESG $MTYPE
Three "rows" of information are available for Prowl.
When $TYPE is one of the CALLTYPEs
Row 1 'application' NCID
Row 2 'event' text Incoming Call
Row 3 'notification' text John on Cell 407-555-7777 POTS
Click on ">" to see 'url' http://callerr.com/4075557777
The Prowl "bubble" notification pop-up is even more compact,
consisting of only two lines:
Row 1 'application' & 'event' NCID -- Incoming Call
Row 2 'notification' John on Cell 407-555-7777 POTS
When $TYPE is one of the MSGTYPEs
Row 1 'application' NCID
Row 2 'event' text Message
Row 3 'notification' text Food ready!
The Prowl "bubble" notification pop-up is even more compact,
consisting of only two lines:
Row 1 'application' & 'event' NCID -- Message
Row 2 'notification' Food ready!
Prowl defaults when $TYPE is one of the CALLTYPEs
notify_application_for_calls_prowl='NCID'
notify_event_for_calls_prowl='$DESC'
notify_notification_for_calls_prowl='$NAME $NMBR $LINE'
Prowl defaults when $TYPE is one of the MSGTYPEs notify_application_for_messages_prowl='NCID'
notify_event_for_messages_prowl='$DESC' notify_notification_for_messages_prowl='$MESG'
NMA (Notify My Android)
No longer supported, closed operation on May 24, 2018.
Configuration
The ncid-notify output module is configured in ncid-notify.conf.
- allowed types
This sets the NCID call and/or message types ncid-notify will send. See ncid-notify.conf for a complete list.
Default: allowed_types="ALLTYPES"
If you want to send notification only when a ring count is reached, configure ring by creating the ncid_notify variable in ncid-conf.
Requirements
The ncid-notify module requires either a key variable to be set to an API key or a key file that contains the API key.
iOS Device Requirements: The Prowl (Growl client for iOS) app from the app store Registration at Prowl website http://www.prowlapp.com/ Generated API key to be placed in configuration file.
Files
/etc/ncid/conf.d/ncid-notify.conf /usr/share/ncid/modules/ncid-notify /etc/ncid/conf.d/key-prowl-api /etc/ncid/conf.d/key-prowl-provider