obi2ncid [--configfile | -C <filename>]
[--debug | -D]
[--delay | -d <seconds>]
[--help | -h]
[--hostname-flag | -H <0|1>]
[--linefx | -f <string>]
[--logfile-append | -l <filename>]
[--logfile-overwrite | -L <filename>]
[--man | -m]
[--ncidhost | -n <[host][:port]>]
[--no-filter | -N]
[--obiport | -o <port>]
[--pidfile | -p <filename>]
[--rawfile-append | -r <filename>]
[--rawfile-overwrite | -R <filename>]
[--test | -t]
[--verbose | -v <1-9>]
[--version | -V]
The gateway was developed using Obi100, OBi110 and OBi200 devices that were available.
The obi2ncid gateway uses either GTALK, the Voice Service AuthUserName, or the configurable default name for a line identifier.
The line identifier(s) can be aliased by the NCID server so you can give each Voice Service a meaningful identification.
The obi2ncid configuration file is /etc/ncid/obi2ncid.conf. See the obi2ncid.conf man page for more details.
The obi2ncid gateway can run on any computer, but normally it is run on the 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.
Call type Lineid assigned
========= ===============
Google Voice in or out "GTALK"
VoIP in or out on default line <AuthUserName>
Incoming PSTN "FXO"
Outgoing PSTN using ##<number> "FXS"
Outgoing VoIP using **1<number> "SP1"
Outgoing VoIP using **2<number> "SP2"
Outgoing VoIP using **3<number> "SP3"
Outgoing VoIP using **4<number> "SP4"
Device setup using **5<number> "SP5"
Outgoing VoIP using **9<number> "OBITALK" (a.k.a. Obi-to-Obi)
NOTES: If line selected is the GTALK line, then GTALK replaces SP?.
If line selected is **9, then OBITALK replaces SP9.
PSTN requires an OBiLINE device connected to an Obi200.
For incoming/outgoing PSTN calls, see the description for --linefx.
If **[0-9] is dialed on the keypad to select a line, the lineid becomes SP[0-9].
The number of SP lines are 1 to 4 plus 5 and 9, depending on the device. The default lineid for SP1 to SP4 can be changed only in the obi2ncid.conf configuration file. Google Talk is special in that "GTALK" can be detected on which SP line is used for it. The other voice providers must have their linesp[0-4] variable set to their lineid.
SP9 has the reserved lineid of "OBITALK" and can not be changed.
In cases where the lineid cannot otherwise be determined, the default lineid becomes OBIHAI.
perl 5.6 or higher, perl(Config::Simple)
Default: /etc/ncid/obi2ncid.conf
Default: 15
Default: 0
Normally "FXO" and "FXS" refer to line (telco) and phone (handset) respectively. OBiLINE changes the meaning of these to be "FXO" for incoming calls and "FXS" for outgoing calls, so by default "FXO" and "FXS" are used as the lineid and can not be changed.
However, if --linefx is given a value, it replaces both "FXO" and "FXS" with that value.
For example:
--linefx POTS
will cause the lineid for incoming and outgoing calls to be POTS.
Default: no default
If both options are present, --logfile-append takes precedence.
Default: Append to /var/log/obi2ncid.log
Input must be <host> or <host:port>, or <:port>.
Default: localhost:3333
A list of zero or more filter lines is stored in obi2ncid.conf.
An Obihai device periodically sends out packets when it is doing its own internal "housekeeping." Such packets do not have anything to do with call activity, but they can clutter and confuse verbose output because of their sheer volume and frequency.
However, in unusual circumstances it may be necessary to use the --no-filter option to include all housekeeping packets.
Default: filtering is ON
Default: 4335
Default: no pidfile
Writes packets to a file exactly as received from the gateway device. A filename extension of .data is suggested. The rawfile can be "played back" using test-obi-gw.
Raw packets from Obihai devices do not have a date/time stamp. When played back, the obi2ncid gateway script will treat the packets as arriving using the current date/time.
If both options are present, --rawfile-append takes precedence.
Default: no raw file
Default: no test mode
Default: verbose = 1