xdmf2ncid(1)

1XDMF2NCID(1)          User Contributed Perl Documentation         XDMF2NCID(1)
2
3
4

NAME

6       xdmf2ncid - XDMF Caller ID to NCID gateway
7

SYNOPSIS

9        xdmf2ncid [--configfile        | -C <filename>]
10                  [--debug             | -D]
11                  [--delay             | -d <seconds>]
12                  [--help              | -h]
13                  [--hostname-flag     | -H <0|1>]
14                  [--ht9032-ic         | -I <0|1>]
15                  [--logfile-append    | -l <filename>]
16                  [--logfile-overwrite | -L <filename>]
17                  [--man               | -m]
18                  [--ncidhost          | -n <[host][:port]>]
19                  [--pidfile           | -p <filename>]
20                  [--pretty]
21                  [--test              | -t]
22                  [--usbport           | -u <USB port>]
23                  [--verbose           | -v <1-9>]
24                  [--version           | -V]
25

DESCRIPTION

27       The xdmf2ncid gateway obtains Caller ID and messages from an SDMF or
28       MDMF USB device (or modem) and sends the information to the NCID
29       server. The server then sends the CID information to the NCID clients.
30
31       The USB port is set to 1200 baud with 1 start bit, 8 data bits, 1 stop
32       bit and no parity.
33
34       The gateway uses the USB port as the default line identifier, for
35       example ttyUSB0.
36
37       The line identifier can be aliased by the NCID server so you can give
38       each phone line a meaningful identification such as  the last 4 digits
39       of the phone number.  For example: 1234.  You can even use the complete
40       phone number if you desire.
41
42       The configuration file is /etc/ncid/xdmf2ncid.conf.  See the
43       xdmf2ncid.conf man page for more details.
44
45       The xdmf2ncid gateway can run on any computer, but normally it is run
46       on the same box as the NCID server.  If it is not run on the same box
47       as the NCID server, you must configure the server IP address in the
48       configuration file.
49

REQUIREMENTS

51       Perl 5.6 or higher, perl(Config::Simple)
52
53       The NCID server
54           http://ncid.sourceforge.net/ncid/ncid.html
55
56       Either one of the following:
57
58       CTI Comet USB Caller ID
59           http://www.crucible-technologies.co.uk/products/WEB-COMET
60
61       Modem
62           configured for Caller ID by setting AT+VCID=2
63
64       Holtek HT9032D based PSTN Caller ID module with required USB adapter
65           https://www.aliexpress.com/item/-/32807442435.html
66
67           http://cutedigi.com/pstn-caller-id-module-for-arduino-pcduino/
68
69           USB to UART TTL cable adapter for PC connection
70               https://www.aliexpress.com/item/-/1859099599.html
71
72               http://store.linksprite.com/ttl-uart-to-usb-cable-serial-usb-debug-cable/
73
74       Possibly other Type I Caller ID devices using the HT9032
75           http://www.holtek.com.tw/documents/10179/116745/an0053e.pdf
76

OPTIONS

78       -C, --configfile <filename>
79         Specifies the configuration file to use.  The program will still run
80         if a configuration file is not found.
81
82         Default: /etc/ncid/xdmf2ncid.conf
83
84       -D, --debug
85         Debug mode, displays all messages that go into the log file.  Use
86         this option to run interactively.
87
88       -d <seconds>, --delay <seconds>
89         If the connection to the NCID server is lost, try every <delay>
90         seconds to reconnect.
91
92         Default: 15
93
94       -h, --help
95         Displays the help message and exits.
96
97       -H <0|1>, --hostname-flag <0|1>
98         When the hostname flag is set to 1, the IDENT string sent to a server
99         will include the hostname with the program name.
100
101         Default: 0
102
103       -I <0|1>, --ht9032-ic <0|1>
104         Set to 0 for input from either the CTI Comet USB or modem, or set to
105         1 for input from the Holtek HT9032D based PSTN Caller ID module or
106         possibly other devices based on the Holtek HT9032 IC.
107
108         Default: 0
109
110       -l, --logfile-append <filename>
111       -L, --logfile-overwrite <filename>
112         Specifies the logfile name to write.  The program will still run if
113         it does not have permission to write to it.
114
115         If both options are present, --logfile-append takes precedence.
116
117         Default: Append to /var/log/xdmf2ncid.log
118
119       -m, --man
120         Displays the manual page and exits.
121
122       -n <[host][:port]>, --ncidhost <[host][:port]>
123         Specifies the NCID server.  Port may be specified by suffixing the
124         hostname with :<port>.
125
126         Input must be <host> or <host:port>, or <:port>
127
128         Default:  localhost:3333
129
130       -p, --pidfile <filename>
131         Specifies the pidfile name to write. The program will still run if it
132         does not have permission to write a pidfile. The pid filename that
133         should be used is /var/run/xdmf2ncid.pid.
134
135         Default: no pidfile
136
137       --pretty
138         Provides a more structured, decoded output for debugging and
139         development purposes. Output is in the form of perl comment lines,
140         suitable for insertion into test-xdmf-calls.data.
141
142       -t, --test
143         Test mode is a connection of the SDMF or MDMF USB Caller ID device to
144         the gateway without a connection to the NCID server.  It sets debug
145         mode and verbose = 3.  The verbose level can be changed on the
146         command line.
147
148         Default: no test mode
149
150       -u <USB port>, --usbport <USB port>
151         Specifies the USB port to listen on for messages from an XDMF device.
152
153         Default "/dev/ttyUSB0"
154
155       -v, --verbose <1-9>
156         Output information, used for the logfile and the debug option.  Set
157         the level to a higher number for more information.  Levels range from
158         1 to 9, but not all levels are used.
159
160         Default: verbose = 1
161
162       -V, --version
163         Displays the version.
164

EXAMPLES

166       Start xdmf2ncid in test mode at verbose level 3
167           xdmf2ncid --test
168
169       Start xdmf2ncid in debug mode at verbose level 1
170           xdmf2ncid -D
171

FILES

173       /etc/ncid/xdmf2ncid.conf
174