NAME

ncid-skel

SYNOPSIS

ncid --no-gui --module ncid-skel

DESCRIPTION

The ncid-skel output module is used as a template for writing a shell script output module. All it does is send the Caller ID data to standard output. This makes it useful for troubleshooting.

CONFIGURATION

The ncid-skel output module is configured in ncid-skel.conf.

allowed_types

This sets the NCID call and/or message types ncid-skel will send. See ncid-skel.conf for a complete list.

Default: allowed_types="ALLTYPES"

skel_raw

If set to 0, data will be shown as a single horizontal line.

If set to 1, data will also be formatted vertically, one line per input received.

Default: skel_raw=0

REQUIREMENTS

run ncid-skel with ncid in a terminal window to view output:
ncid --no-gui --module ncid-skel

FILES

/usr/local/etc/ncid/conf.d/ncid-skel.conf
/usr/local/share/ncid/modules/ncid-skel

CUSTOM MODULE

Modify ncid-skel as required and rename it to create a custom module. There are three ways to test the custom module.

If you have source you can use ncid/test/test-client. This is the preferred method.

If you do not have source, the custom module can be tested by executing the shell script directly and inputting data.

The command line for a new custom module called ncid-custom:: /usr/local/share/ncid/modules/ncid-custom
The module expects 7 lines of input:: DATE
TIME
NMBR
LINE
TYPE
MESG
MTYPE

TYPE must be a valid, but all others can have any input or no input.

Valid TYPES:

BLK - blocked incoming call
CID - incoming call
HUP - blacklisted hangup
MWI - message waiting
OUT - outgoing call
PID - Caller ID from a smart phone
PUT - smart phone outgoing call
RID - ring back when called number available
WID - incoming call waiting

The last method is execute "ncid --no-gui -m ncid-custom" and make a call.