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

NAME

6       obi2ncid - Obihai device to NCID gateway
7

SYNOPSIS

9        obi2ncid [--configfile        | -C <filename>]
10                 [--debug             | -D]
11                 [--delay             | -d <seconds>]
12                 [--help              | -h]
13                 [--hostname-flag     | -H <0|1>]
14                 [--linefx            | -f <string>]
15                 [--logfile-append    | -l <filename>]
16                 [--logfile-overwrite | -L <filename>]
17                 [--man               | -m]
18                 [--ncidhost          | -n <[host][:port]>]
19                 [--no-filter         | -N]
20                 [--obiport           | -o <port>]
21                 [--pidfile           | -p <filename>]
22                 [--rawfile-append    | -r <filename>]
23                 [--rawfile-overwrite | -R <filename>]
24                 [--test              | -t]
25                 [--verbose           | -v <1-9>]
26                 [--version           | -V]
27

DESCRIPTION

29       The obi2ncid gateway obtains Caller ID from an Obihai VOiP telephone
30       adapter and sends it to the NCID server.  The server then sends the CID
31       information to the NCID clients.
32
33       The gateway was developed using Obi100, OBi110 and OBi200 devices that
34       were available.
35
36       The obi2ncid gateway uses either GTALK, the Voice Service AuthUserName,
37       or the configurable default name for a line identifier.
38
39       The line identifier(s) can be aliased by the NCID server so you can
40       give each Voice Service a meaningful identification.
41
42       The obi2ncid configuration file is /etc/ncid/obi2ncid.conf.  See the
43       obi2ncid.conf man page for more details.
44
45       The obi2ncid gateway can run on any computer, but normally it is run on
46       the same box as the NCID server.  If it is not run on the same box as
47       the NCID server, you must configure the server IP address in the
48       configuration file.
49
50   LINEID
51       The obi2ncid gateway attempts to assign the lineid based on the
52       following table. "SP" is an abbreviation for "Service Provider" and
53       "PSTN" is an abbreviation for "Public Switched Telephone Network."
54
55           Call type                       Lineid assigned
56           =========                       ===============
57           Google Voice in or out              "GTALK"
58           VoIP in or out on default line   <AuthUserName>
59           Incoming PSTN                        "FXO"
60           Outgoing PSTN using ##<number>       "FXS"
61           Outgoing VoIP using **1<number>      "SP1"
62           Outgoing VoIP using **2<number>      "SP2"
63           Outgoing VoIP using **3<number>      "SP3"
64           Outgoing VoIP using **4<number>      "SP4"
65           Device setup  using **5<number>      "SP5"
66           Outgoing VoIP using **9<number>    "OBITALK"  (a.k.a. Obi-to-Obi)
67
68           NOTES: If line selected is the GTALK line, then GTALK replaces SP?.
69                  If line selected is **9, then OBITALK replaces SP9.
70                  PSTN requires an OBiLINE device connected to an Obi200.
71
72       For incoming/outgoing PSTN calls, see the description for --linefx.
73
74       If **[0-9] is dialed on the keypad to select a line, the lineid becomes
75       SP[0-9].
76
77       The number of SP lines are 1 to 4 plus 5 and 9, depending on the
78       device. The default lineid for SP1 to SP4 can be changed only in the
79       obi2ncid.conf configuration file.  Google Talk is special in that
80       "GTALK" can be detected on which SP line is used for it.  The other
81       voice providers must have their linesp[0-4] variable set to their
82       lineid.
83
84       SP9 has the reserved lineid of "OBITALK" and can not be changed.
85
86       In cases where the lineid cannot otherwise be determined, the default
87       lineid becomes OBIHAI.
88
89   IMPORTANT
90       This gateway does not work properly with a OBILINE add-on accessory
91       that connects to a phone line.
92

REQUIREMENTS

94       Obihai VoIP Telephone Adapter: Obi100, Obi110, Obi200, Obi202?
95           http://www.obihai.com/
96
97       Google Voice or a SIP voice provider
98           (voip.ms, callcentric, others untested)
99
100       The NCID server
101           http://ncid.sourceforge.net/ncid/ncid.html
102
103       perl 5.6 or higher, perl(Config::Simple)
104

OPTIONS

106       --configfile <filename>, -C <filename>
107         Specifies the configuration file to use.  The program will still run
108         if a configuration file is not found.
109
110         Default: /etc/ncid/obi2ncid.conf
111
112       --debug, -D
113         Debug mode, displays all messages that go into the log file.  Use
114         this option to run interactively.
115
116       --delay <seconds>, -d <seconds>
117         If the connection to the NCID server is lost, try every <delay>
118         seconds to reconnect.
119
120         Default: 15
121
122       --help, -h
123         Displays the help message and exits.
124
125       --hostname-flag <0|1>, -H <0|1>
126         When the hostname flag is set to 1, the IDENT string sent to a server
127         will include the hostname with the program name.
128
129         Default: 0
130
131       --linefx <string>, -f <string>
132         This option requires the OBiLINE FXO-to-USB Phone Line Adapter for
133         the Obi2xx series. The Obi110 has it built in.
134
135         Normally "FXO" and "FXS" refer to line (telco) and phone (handset)
136         respectively. OBiLINE changes the meaning of these to be "FXO" for
137         incoming calls and "FXS" for outgoing calls, so by default "FXO" and
138         "FXS" are used as the lineid and can not be changed.
139
140         However, if --linefx is given a value, it replaces both "FXO" and
141         "FXS" with that value.
142
143         For example:
144             --linefx POTS will cause the lineid for incoming and outgoing
145         calls to be POTS.
146
147         Default: no default
148
149       --logfile-append <filename>, -l <filename>
150       --logfile-overwrite <filename>, -L <filename>
151         Specifies the logfile name to write.  The program will still run if
152         it does not have permission to write to it.
153
154         If both options are present, --logfile-append takes precedence.
155
156         Default: Append to /var/log/obi2ncid.log
157
158       --man, -m
159         Displays the manual page and exits.
160
161       --ncidhost <[host][:port]>, -n <[host][:port]>
162         Specifies the NCID server.  Port may be specified by suffixing the
163         hostname with :<port>.
164
165         Input must be <host> or <host:port>, or <:port>.
166
167         Default:  localhost:3333
168
169       --no-filter, -N
170         Useful for development and troubleshooting purposes.
171
172         A list of zero or more filter lines is stored in obi2ncid.conf.
173
174         An Obihai device periodically sends out packets when it is doing its
175         own internal "housekeeping." Such packets do not have anything to do
176         with call activity, but they can clutter and confuse verbose output
177         because of their sheer volume and frequency.
178
179         However, in unusual circumstances it may be necessary to use the
180         --no-filter option to include all housekeeping packets.
181
182         Default: filtering is ON
183
184       --obiport <port>, -o <port>
185         Specifies the UDP port to listen on for Caller ID from an OBi device.
186
187         Default: 4335
188
189       --pcap-read <filename>
190         Read packets from a libpcap capture file instead of the network. This
191         also sets the test option and verbose to level 3. Mostly only useful
192         for development and debug purposes.
193
194       --pidfile <filename>, -p <filename>
195         Specifies the pidfile name to write. The program will still run if it
196         does not have permission to write a pidfile. The pid filename that
197         should be used is /var/run/obi2ncid.pid.
198
199         Default: no pidfile
200
201       --rawfile-append <filename>, -r <filename>
202       --rawfile-overwrite <filename>, -R <filename>
203         Useful for development and troubleshooting purposes.
204
205         Writes packets to a file exactly as received from the gateway device.
206         A filename extension of .data is suggested. The rawfile can be
207         "played back" using test-obi-gw.
208
209         Raw packets from Obihai devices do not have a date/time stamp.  When
210         played back, the obi2ncid gateway script will treat the packets as
211         arriving using the current date/time.
212
213         If both options are present, --rawfile-append takes precedence.
214
215         Default: no raw file
216
217       --test, -t
218         Test mode is a connection to the gateway device without a connection
219         to the NCID server. It sets debug mode and verbose = 3.  The verbose
220         level can be changed on the command line.
221
222         Default: no test mode
223
224       --verbose <1-9>, -v <1-9>
225         Output information, used for the logfile and the debug option.  Set
226         the level to a higher number for more information.  Levels range from
227         1 to 9, but not all levels are used.
228
229         Default: verbose = 1
230
231       --version, -V
232         Displays the version and exits.
233

EXAMPLES

235       Start obi2ncid in test mode at verbose level 3
236           obi2ncid --test
237
238       Start obi2ncid in test mode at verbose level 5 and keep a test log
239           obi2ncid -t -v5 -L test.log
240
241       Start obi2ncid in test mode and keep a file of the input data
242           obi2ncid -t -R test.data
243
244       Start obi2ncid in debug mode at verbose level 1
245           obi2ncid -D
246

FILES

248       /etc/ncid/obi2ncid.conf
249

SEE ALSO

251       obi2ncid.conf.5, ncidd.8, ncidd.conf.5, ncid_gateways.7
252
253
254
255perl v5.38.0                      2023-10-03                       OBI2NCID(1)
Impressum