1CWDAEMON(8) System Manager's Manual CWDAEMON(8)
2
6 cwdaemon - morse daemon for the serial or parallel port
7
10 cwdaemon [options]
11
14 Cwdaemon is a small daemon which uses the pc parallel or serial port
15 and a simple transistor switch to output morse code to a transmitter
16 from a text message sent to it via udp port 6789.
17
20 cwdaemon can be configured either through command line arguments on
21 start of the daemon, or through requests (escaped requests) sent over
22 network. Each escaped request starts with ASCII Escape character (deci‐
23 mal 27, hex 1B). The Escape character is represented in the list below
24 by "<ESC>" string. Notice that there are no space characters between
25 parts of escaped requests.
26 Some of the arguments and requests require passing a value (e.g. Morse
28 speed [wpm], tone (frequency) [Hz] etc.). Call "cwdaemon -h" to see
29 default values for these arguments/requests, and ranges of accepted
30 values.
31 When handling command line arguments, cwdaemon does not accept invalid,
33 malformed, or out-of-range values passed through command line. It won't
34 attempt to guess caller's intentions, it won't try to start with some
35 fallback value of the argument. Instead it will just print a debug mes‐
36 sage and exit. Rejection of bad values and exiting will happen before
37 attempting to fork.
38 When handling escaped requests, cwdaemon usually does not accept
40 invalid, malformed or out-of-range vales either. But instead of exiting
41 upon receiving request with such value, it simply prints debug message,
42 ignores the request containing such value, and waits for next request.
43 One exception to the rule is PTT delay: requested delay values that are
44 too large will be clipped to maximal allowed value and then will be
45 used by cwdaemon. Requested negative or malformed values of PTT delay
46 will be ignored.
47 Print help text to stdout and exit
51 Command line argument: -h, --help
53 Escaped request: N/A
56 Print version information to stdout and exit
61 Command line argument: -V, --version
63 Escaped request: N/A
66 Set hardware keying device
71 Command line argument: -d, --cwdevice <device>
73 Escaped request: <ESC>8<device>
76 See chapter "DEVICES" below for more information.
79 Don't fork daemon, run in foreground
84 Command line argument: -n, --nofork
86 Escaped request: N/A
89 Debug information will be printed to stdout (unless different
92 debug outut is selected, or debug output is silenced by setting
93 debug output verbosity).
94 Set network UDP port
99 Command line argument: -p, --port <port number>
101 Escaped request: <ESC>9<port number>
104 This escaped request is obsolete and has no effect. Command line
107 argument works as expected.
108 Set process priority (niceness)
113 Command line argument: -P, --priority <priority>
115 Escaped request: N/A
118 Set Morse speed [wpm]
123 Command line argument: -s, --wpm <speed>
125 Escaped request: <ESC>2<speed>
128 Set PTT delay [ms] (TOD, Turn On Delay)
133 Command line argument: -t, --pttdelay <delay>
135 Escaped request: <ESC>d<delay>
138 Turn PTT keying on/off
143 Command line argument: N/A
145 Escaped request: <ESC>a<{0|1}>
148 0 - PTT off, 1 - PTT on
151 Set sound system (sound backend)
156 Command line argument: -x, --system <system>
158 Escaped request: <ESC>f<system>
161 See chapter "SOUND SYSTEM" below for more information.
164 Set sound volume for soundcard [%]
169 Command line argument: -v, --volume <volume>
171 Escaped request: <ESC>g<volume>
174 Set Morse weighting
179 Command line argument: -w, --weighting <weighting>
181 Escaped request: <ESC>7<weighting>
184 Set tone (frequency) of sound [Hz]
189 Command line argument: -T, --tone <tone>
191 Escaped request: <ESC>3<tone>
194 Notice that sending escaped request with value '0' silences
197 cwdaemon.
198 Increase verbosity of debug output
202 Command line argument: -i
204 Escaped request: N/A
207 The argument can be repeated up to four times (-iiii) to gradu‐
210 ally increase the verbosity. Alternatively you can use
211 -y/--verbosity option.
212 Set verbosity threshold for debug strings
217 Command line argument: -y, --verbosity <threshold>
219 Escaped request: N/A
222 Alternatively you can use -i option.
225 See chapter "DEBUGGING" below for more information.
228 Set numeric value of libcw debug flags
235 Command line argument: -I, --libcwflags <flags>
237 Escaped request: N/A
240 Set debug output
245 Command line argument: -f, --debugfile <output>
247 Escaped request: N/A
250 Print debug information to <output> instead of stdout. Value of
253 <output> can be explicitly stated as "stdout" (when not fork‐
254 ing). Value of <output> can be also "stderr" (when not fork‐
255 ing). Special value of <output> being "syslog" is reserved for
256 future use. For now it will be rejected as invalid. Passing
257 path to disc file as value of <output> works in both situations:
258 when forking and when not forking.
259 Reset some of cwdaemon parameters
265 Command line argument: N/A
267 Escaped request: <ESC>0
270 The request resets program's parameters to cwdaemon default val‐
273 ues, unless the defaults were overridden with command line argu‐
274 ments - then the values passed in command line are used.
275 Abort currently sent message
279 Command line argument: N/A
281 Escaped request: <ESC>4
284 Exit (close) daemon
289 Command line argument: N/A
291 Escaped request: <ESC>5
294 Set word mode
300 Command line argument: N/A
302 Escaped request: <ESC>6
305 Set SSB way
310 Command line argument: N/A
312 Escaped request: <ESC>b<{0|1}
315 0 - microphone, 1 - soundcard
318 Tune for a number of seconds
323 Command line argument: N/A
325 Escaped request: <ESC>c<seconds>
328 Tune for <seconds> seconds. The tuning is performed by both
331 selected sound system, and by current hardware keying device.
332 Set band switch output
337 Command line argument: N/A
339 Escaped request: <ESC>e<value>
342 This argument sets band switch output on parport bits 9 (MSB),
345 8, 7, 2 (LSB).
346
352 Any serial device that supports getting and setting the modem control
353 lines can be used. On Linux, ttyS0, ttyS1, etc. will work. On FreeBSD
354 these devices are known as ttyd0, ttyd1, etc. On OpenBSD, these same
355 devices are known as tty00, tty01, etc., but may vary with platform.
356 For parallel ports on Linux try parport0 (default) or parport1, and on
358 FreeBSD, ppi0 (default), ppi1, etc. OpenBSD does not support parallel
359 port operation, and defaults to 'tty00'.
360 For completeness, a dummy 'null' device is provided. This device does
362 exactly nothing (no rig keying, no ssb keying, etc.).
363
368 ´sound system´ should be one of following:
369 ´c´ - console buzzer (PC speaker) - default system,
371 ´o´ - OSS,
373 ´a´ - ALSA,
375 ´p´ - PulseAudio,
377 ´n´ - none - no audio,
379 ´s´ - soundcard - autoselect from OSS/ALSA/PulseAudio.
381
386 cwdaemon can print debug strings. Each debug string in cwdaemon has
387 specified verbosity (verbosity level), and can be printed (or not)
388 depending on current verbosity threshold specified for cwdaemon. The
389 verbosity level value for each string can be changed in future versions
390 of cwdaemon. Don't depend on current setup.
391 The verbosity threshold can be specified through command line argu‐
393 ments: -i, -y, or --verbosity. -y and --verbosity accept "threshold"
394 value (single character) as specified below:
395 ´n´ - none
398 ´e´ - errors
400 ´w´ - warnings (default)
402 ´i´ - information
404 ´d´ - details
406 By default the threshold is set to "warnings" - cwdaemon will print all
409 errors and warnings. Changing the threshold to "information" will make
410 the cwdaemon print errors, warnings, and information.
411 Debug strings can be printed to stdout, stderr, or disc file. Printing
414 to stdout or stderr is available only if cwdaemon has not forked.
415 Printing to disc file is available regardless of whether cwdaemon has
416 forked or not. You can specify intended debug output using -f or
417 --debugfile command line argument. Values "stdout" and "stderr" passed
418 to cwdaemon with these arguments are recognized as special file names.
419 "syslog" value is also treated as special value, but is not supported
420 at the moment. Every other value will be treated as path to disc file.
421 "stdout" is a default debug output for non-forked cwdaemon. You don't
422 have to specify this explicitly through command line arguments, but you
423 can.
424 Regardless of values passed through -f or --debugfile arguments, cwdae‐
427 mon opens a syslog file and (when forked) prints some (few) messages to
428 the syslog. There is no way to override this at the moment. Which mes‐
429 sages are always printed to syslog, and which can be printed to other
430 file, is settled for now, but may be changed in the future. Don't
431 depend too much on current setup.
432
437 When an escaped request "f" (change sound system) is sent asking for
438 switching to sound system that is generally supported by libcw, but not
439 available on given machine, cwdaemon will not recognize that the sound
440 system is not available. It will close current audio system, and will
441 attempt to open unavailable audio system. That fails, and cwdaemon
442 falls back to Null audio system. If the falling back fails, it will
443 result in cwdaemon working without any sound system, and it may poten‐
444 tially crash the daemon on next attempt to play audio.
445
450 The provided README in /usr/share/cwdaemon for a description of the
451 circuitry, usage and testing of cwdaemon.
452
457 Cwdaemon was written by Joop Stakenborg <pg4i at amsat.org>, Rein
458 Couperus <pa0r at amsat.org>, Wolf-Ruediger Juergens, DL2WRJ <WJuergens
459 at t-online.de> and Ladislav Vaiz, OK1ZIA <ok1zia at nagano.cz>. Cwlib
460 is taken and adapted from the unixcw package, version 2.2 by Simon
461 Baldwin, G0FRD. FreeBSD support mostly done by Diane Bruce, VA3DB.
462 OpenBSD support by Jason L. Wright, AI4JW.
463 Since 2012 the main developer is Kamil Ignacak <acerion@wp.pl>.
465ver. 0.10.2 Morse daemon CWDAEMON(8)