artech2ncid - Man Page

artech2ncid [options]

Options:

[--configfile <filename>    | -C <filename>]
[--disable_incoming <0-0xF>   | -d <0-0xF>]
[--debug                    | -D]
[--help                     | -h]
[--hostname-flag <0|1>      | -H <0|1>]
[--logfile <filename>       | -L <filename>]
[--mem_trace <0-2>          | -m <0-2>
[--ncid     <[host][:port]> | -n [host][:port]>]
[--pidfile <filename>       | -P <filename>]
[--test                     | -t]
[--tracefile <filename>     | -T <filename>]
[--verbose <1-9>            | -v <1-9>     ]
[--version                  | -V]

The artech2ncid gateway is designed for the ARTECH AD102 device. The device captures CID data for incoming and outgoing calls on a POTS line.  It also keeps track of the phone line state.

The line identifier is set in the config file artech2ncid.conf. It can be aliased by the NCID server so you can give each phone line a meaningful identification such as the last 4 digits of the phone number. For example: 1234.  You can even use the complete phone number if you desire.

The configuration file for artech2ncid is prefix3=/etc/ncid/artech2ncid.conf. It may be located in same directory as the script, or in the etc directory, or in NCID default configuration directory. Read the comments in the config file for more details.

The artech2ncid device can run on any system, but normally it is run on same box as the NCID server. If it is not run on the same box as the NCID server, you must configure the server IP address in the configuration file.

-C <filename> | --config <filename>

Configuration file.

Default: prefix3=/etc/ncid/artech2ncid.conf

-d <0|1>| --disable_incoming <0-0xF>

The artech2ncid gateway, by default, obtains the CID/WID/RID/MWI from a call and sends the information to the server. If you want the the server to hangup on a call, set cidinput = 2 and enable hangup in ncidd.conf.

If you want the modem to get CID from a call and do hangup, set this option to 0x1, and enable hangup in ncidd.conf.  There is normally no reason to do this.

It is possible to disable selectively the sending of incoming calls to ncidd : 0x0 will send everything (default)  , 0x1 disables sending CID , 0x2 disables sending WID , 0x4 disables sending RID , 0x8 disable sending MWI. Those 4 bits can be combined . This is useful for special cases like multiple gateways on the same line .

Default: 0

-D | --debug

Debug mode, artech2ncid stays attached to the terminal and displays all messages that go into the log file.

-h | --help

Displays the help message and exits.

-H <0|1> | --hostname-flag <0|1>

When the hostname flag is set to 1, the IDENT string sent to a server will include the hostname with the program name.

Default: 1

-L <filename> | --logfile <filename>

Specifies the logfile name to use.

Default: /var/log/artech2ncid.log

-m <0-2> | --mem_trace <0-2>

Trace mode : Dumps the 64 byte read buffer of the device into the tracefile

0: no trace.

1: dumps read buffer every time important bytes change.

2: dumps read buffer every time it is read (heavy).

Default: 0

-P <filename> | --pidfile <filename>

Specifies the pidfile name to write. Set to /var/run/artech2ncid.pid in an rc or init script when used as a service. The program will still run if it does not have permission to write a pidfile. There is no default.  If pidfile is not set, no pid file will be used.

-v <1-9> | --verbose <1-9>

Verbose mode. Send information into the logfile

To debug, try: verbose = 4 or 5

Default: 1

-t | --test

Test mode, artech2ncid stays attached to the terminal and no connection is made to the server.  Displays all messages that go into the log file.

Test mode sets debug mode and verbose = 3.  The verbose level can be changed on the command line.

-T <filename> | --tracefile <filename>

Specifies the trace file name to write.

Default: /var/log/artech2ncid.trace

-V | --version

Displays the version then exits

ARTECH AD102 device

prefix3=/etc/ncid/artech2ncid.conf

artech2ncid.conf(5), ncidd(8), ncidd.conf(5), ncid_gateways(7)

artech2ncid.conf(5).