1WCT(1) User Contributed Perl Documentation WCT(1)
2
6 wct - Whozz Calling Ethernet Link Device interactive tool
7
9 wct [--debug | -D]
10 [--help | -h]
11 [--logfile-append | -l <filename>]
12 [--logfile-overwrite | -L <filename>]
13 [--configfile | -C <filename>]
14 [--man | -m]
15 [--set-wc]
16 [--pidfile | -p <filename>]
17 [--discover | --discovery | -d
18 [--discover-loop | --discovery-loop <secs>]
19 [--verbose | -v <1-9>]
20 [--version | -V]
21 [--wchost | -w <address1>[,address2][,...]
22
24 This script allows you to interact with a Whozz Calling device in order
25 to view or change its configuration. This script is generic as
26 configuration settings vary depending on the Whozz Calling model and
27 firmware version.
28 Enter the commands one per line, or simply hit <ENTER> alone to see if
30 there are pending responses.
31 DO NOT type the '^^Id' prefix as it will be included automatically.
33
35 -w <address1[,address2][,...]>, --wchost <address1[,address2],[,...]>
36 Specifies the Whozz Calling Ethernet Link Device or devices.
37 Multiple addresses for devices are comma separated.
38 Input must be <address> or <address1,address2,etc>.
40 Default: 192.168.0.90
42 This option is ignored if --discover or --discover-loop is in effect.
44 -D, --debug
46 Debug mode, displays all messages that go into the log file.
47 -h, --help
49 Prints the help message and exits.
50 -m, --man
52 Prints the manual page and exits.
53 -C, --configfile <filename>
55 Specifies the configuration file to use. The program will still run
56 if a configuration file is not found.
57 If --discover or --discover-loop is in effect, the configuration file
59 will still be processed but any "wcaddr" addresses will be ignored.
60 Default: /etc/ncid/wc2ncid.conf
62 --set-wc
64 Sets the IP address, beginning line number, number of telephone lines
65 and sending port for each Whozz Calling Ethernet Link Device.
66 It sets the IP address for the WC device from the address for
68 "wcaddr" in the configuration file or --wchost on the command line.
69 It automatically sets the beginning line number for the WC device
71 which is used as a line label prefixed with "WC". Each device gets a
72 beginning line number that is the ending line number plus one from
73 the preceeding device, for example; device 1 (WC01 WC02) device 2
74 (WC03 WC04 WC05 WC06).
75 NOTE: All devices are automatically configured to send call
77 information on port 3520.
78 This option is ignored if --discover or --discover-loop is in effect.
80 -l, --logfile-append <filename>
82 -L, --logfile-overwrite <filename>
83 Specifies the logfile name to write. The program will still run if
84 it does not have permission to write to it.
85 If both options are present, --logfile-append takes precedence.
87 Default: Append to wct.log in your current directory.
89 -p, --pidfile <filename>
91 Specifies the pidfile name to write. The program will still run if it
92 does not have permission to write a pidfile. The pid filename that
93 should be used is /var/run/wc2ncid.pid.
94 Default: no pidfile
96 -d, --discover, --discovery =item --discover-loop <secs>,
98 --discovery-loop <secs>
99 Force discovery of all powered-on Whozz Calling Ethernet Link
100 Devices. IP addresses in the configuration file, or on the command
101 line, will be ignored.
102 Using --discover-loop causes continuous looping with a new discovery
104 ("^^IdX") being sent every <secs> seconds.
105 Normal invocation of this script functions the same as wc2ncid,
107 including the initialization of each device's configuration
108 "toggles." Use the --discover or --discover-loop options if you want
109 to bypass this initialization.
110 -v, --verbose <1-9>
112 Output information, used for the logfile and the debug option. Set
113 the level to a higher number for more information. Levels range from
114 1 to 9, but not all levels are used.
115 Default: verbose = 1
117 -V, --version
119 Displays the version.
120
122 Start wct and look for all powered-on devices:
123 wct -d
124 Start wct, set IP address to 192.168.1.90 from command line, set the
126 beginning line number automatically and set the sending Ethernet port
127 to 3520 (the default):
128 wct --set-wc --wchost 192.168.1.90
129
131 d2h
132 Decimal-to-hex conversion.
133 User will be asked for the decimal number to be converted to hex.
135 An IP address may also be typed (e.g., 192.168.1.90) to show the
137 proper hex digits for the 'D' and 'I' commands.
138 help
140 Displays this interactive command mode help. Press letter 'q' to
141 return to the command prompt at any time.
142 select
144 When multiple Whozz Calling Ethernet Link Devices are being used,
145 allows selecting which one to interact with.
146 A special "ALL DEVICES" choice is also available, meaning all typed
148 commands will be broadcast to all devices. For example, selecting
149 "ALL DEVICES" and then typing the Z command will cause all powered on
150 devices to be reset to their factory defaults. Use "ALL DEVICES" with
151 care because you could set all devices to have the same IP address,
152 same MAC address, etc.
153 1-9
155 Entering a single digit changes the verbosity level on-the-fly.
156 Not all of the commands below are supported by all WC devices.
158 Single character commands
160 N Set destination IP and MAC addresses to THIS computer.
161 X Show unit#, serial#, network settings. This command can be used
163 to discover all powered-on WC devices. It is the same as
164 runnning wct with the --discover command line option.
165 Z Reset unit# to '123' and network settings to factory defaults;
167 does NOT change: toggles, block/pass numbers in memory,
168 date/time or the device's starting line#. See also "Other ways
169 to reset a device" on the last page of this manual.
170 Settings changed by this command will not be reflected under
172 the 'select' menu until the next time you do an 'X' to discover
173 all available devices.
174 Two character commands
176 -@ Causes a device to respond with "#" sign. Can be used for
177 establishing device communication.
178 -J Show contents of block/pass numbers stored in memory. Be sure
180 to first set the verbose level to 4 or greater to see the
181 actual numbers.
182 -R Perform power-on reset and sets all toggles to uppercase.
184 Leaves network configuration and block/pass memory and the
185 device's starting line# unchanged. See also "Other ways to
186 reset a device" on the last page of this manual.
187 -t Where 't' is any single toggle, case sensitive (e.g., -E, -b).
189 Uppercase usually means the feature/setting is OFF, lowercase
191 means it is ON.
192 E, e Command echo
194 C, c Leading '$' and dashes in numbers (wc2ncid and wct
195 always strip both)
196 X, x Comprehensive (X) or limited (x) data format
197 U, u Use phone numbers in internal block/pass memory
198 D, d Detail information (rings, hook on/off/flash)
199 A, a Data sent at start AND end of a call
200 S, s See below
201 O, o Only inbound (O) calls reported, or inbound and
202 outbound (o)
203 B, b Suppress first ring (B) or always pass through (b)
204 K, k See below
205 T, t Inbound DTMF monitoring
206 The 'U' and 'A' toggles each have a companion toggle as
208 described below.
209 If 'U' is set, blocking/passing is turned OFF and toggles
211 'K' and 'k' are ignored.
212 If 'u' is set, blocking/passing is turned ON. The toggle 'K'
214 will pass all calls by default (i.e., only the phone numbers
215 in the internal memory will be blocked) and 'k' will block
216 all calls by default (i.e., only the phone numbers in the
217 internal memory will be passed through).
218 If 'A' is set, data is sent at the start AND end of a call
220 and toggles 'S' and 's' are ignored.
221 If 'a' is set, data is sent only at start(S) or end(s) of a
223 call.
224 -V Show processor version, all toggles, line# of channel 1, date,
226 time.
227 -v Show internal jumper settings.
229 Multiple character commands requiring HEX digits.
231 Numbers in parentheses () indicate required number of hex digits.
232 Commands I, T and U are typically the only ones that will be used.
234 Hex digits A - F may be entered in lowercase or uppercase.
236 Chhhhhhhhhhhh
238 Set destination MAC address (12) of the computer to receive WC
239 data (use all 'F's for entire LAN).
240 Dhhhhhhhh
242 Set destination IP address (8) of the computer to receive WC
243 data (use all 'F's for entire LAN).
244 Ihhhhhhhh
246 Set device IP address (8).
247 Changing the IP address will not be reflected under the
249 'select' menu until the next time you do an 'X' to discover all
250 available devices.
251 Mhhhhhhhhhhhh
253 Set device MAC address (12).
254 Changing the MAC address will not be reflected under the
256 'select' menu until the next time you do an 'X' to discover all
257 available devices.
258 Phhhh Set destination port number (4 hex digits) of the computer to
260 receive WC data. This is normally 0DC0, or 3520 in decimal.
261 It is very rare that this command would be used. You most
263 likely would want to use 'Thhhh' instead.
264 Thhhh Set device port number (4 hex digits). This is normally 0DC0,
266 or 3520 in decimal.
267 Changing the port number will not be reflected under the
269 'select' menu until the next time you do an 'X' to discover all
270 available devices.
271 Uhhhhhhhhhhhh
273 Set unit number (12).
274 Changing the unit number will not be reflected under the
276 'select' menu until the next time you do an 'X' to discover all
277 available devices.
278 Note that wc2ncid will change and use the unit number to track
280 the number of telephone lines (2, 4, or 8) that can be
281 connected to the device. This is used when establishing the
282 starting line# of channel#1, i.e., the "L=xx" parameter seen
283 when executing the '-V' command.
284 Multiple character commands requiring DECIMAL digits.
286 Normally these require a terminating carriage return character, but the
287 wct script takes care of this for you by sending a terminating carriage
288 return after all commands.
289 -Nnnnnnnnnnnnn
291 Add a 7 to 12 digit phone number to block/pass memory, maximum
292 of 40 phone numbers.
293 The WC device will not check to see if the number you're adding
295 is already stored in memory. It lets you add duplicates.
296 If the memory becomes full, additional numbers will be silently
298 ignored.
299 -N66 Add Out-of-area callers to block/pass memory. '-J' command will
301 list as the letter 'O' ("oh") and not '66'. This counts against
302 the maximum of 40 phone numbers.
303 -N77 Add Private callers to block/pass memory. '-J' command will
305 list as the letter 'P' and not '77'. This counts against the
306 maximum of 40 phone numbers.
307 -N00000077nn
309 Special undocumented command to set line# of channel#1 instead
310 of using the 'Line No. Select' button on back of the device.
311 And unlike the 'Line No. Select' button, you're not restricted
312 to increments of four. 'nn' is base 16 but accepts digits only
313 (no letters 'A' to 'F'). For example, '-N0000007710' sets
314 line# to '16' not '10'.
315 The echo toggle ('E') must be OFF for this setting to be saved
317 in the device's memory.
318 You should wait at least 9 seconds after sending this command
320 before sending the next one. Otherwise, the next command sent
321 may be ignored.
322 Unlike the other uses of '-N', this special command does not
324 affect the internal block/pass memory.
325 -Wnn If toggle 'u' is set, block or pass the real-time inbound call
327 on logical line 'nn'. Note that this is NOT the physical
328 channel# that a phone line is hooked into.
329 -Zmmddhhmm
331 Manually set date and time (24 hour format). Normally the date
332 and time are set automatically by the first incoming ring.
333 Other ways to reset a device
335 The download section at CallerID.com has a Windows program called "EL
336 Config". To use wct to emulate the EL Config reset options, do the
337 following commands:
338 Config->Reset Unit Defaults
340 -N0000007701
342 -R
343 The above sets the line# of channel#1 ('N') to be 1, followed by a
345 power-on reset ('R') that sets all toggles to uppercase. It does
346 not change the network settings nor the block/pass memory.
347 Config->Reset Ethernet Defaults
349 DFFFFFFFF
351 U000000000001
352 IC0A8005A
353 CFFFFFFFFFFFF
354 T0DC0
355 The above will set the destination IP address ('D') to be the
357 entire LAN, the unit number ('U') to 1, the device's IP address
358 ('I') to 192.168.0.90, the destination MAC address ('C') to be the
359 entire LAN and the device's port# ('T') to 3520. It does not change
360 the device toggles, nor the block/pass memory, nor the device's
361 starting line#.
362
364 perl 5.6 or higher, perl(Config::Simple), perl(Data::HexDump)
365
367 /etc/ncid/wc2ncid.conf
368
370 ncidd.8, wc2ncid.8, wc2ncid.conf.5
371perl v5.28.1 2018-05-31 WCT(1)