From b525e97c63f15f742fc590acfeb84bc7abddcb57 Mon Sep 17 00:00:00 2001 From: John J. McDonough Date: Mar 25 2014 13:22:23 +0000 Subject: Additional hamlib documentation --- diff --git a/en-US/images/rig-hamlib/hamlib2.png b/en-US/images/rig-hamlib/hamlib2.png index ff99542..f6e209a 100644 Binary files a/en-US/images/rig-hamlib/hamlib2.png and b/en-US/images/rig-hamlib/hamlib2.png differ diff --git a/en-US/images/rig-hamlib/hamlib4.png b/en-US/images/rig-hamlib/hamlib4.png index 3d4100a..dd123ba 100644 Binary files a/en-US/images/rig-hamlib/hamlib4.png and b/en-US/images/rig-hamlib/hamlib4.png differ diff --git a/en-US/images/rig-hamlib/hamlib5.png b/en-US/images/rig-hamlib/hamlib5.png index b59ec3d..2480fa7 100644 Binary files a/en-US/images/rig-hamlib/hamlib5.png and b/en-US/images/rig-hamlib/hamlib5.png differ diff --git a/en-US/images/rig-hamlib/hamlib6.png b/en-US/images/rig-hamlib/hamlib6.png new file mode 100644 index 0000000..5c54e56 Binary files /dev/null and b/en-US/images/rig-hamlib/hamlib6.png differ diff --git a/en-US/rig-hamlib.xml b/en-US/rig-hamlib.xml index 01522a5..a716477 100644 --- a/en-US/rig-hamlib.xml +++ b/en-US/rig-hamlib.xml @@ -59,152 +59,154 @@ In addition, there are daemons provided for controllig the rig and rotor. - + The various hamlib applications require certain switches to describe the rig and its connection, and most take a number of commands. - - Rig description switches - - - - - - Switch - Meaning - - - - - -m, --model=id - Select radio model number. See model list (use - 'rigctl -l'). - - - -r, --rig-file=device - Use device as the file name of the port the radio - is connected. Often a serial port, but could be a USB - to serial adapter. Typically - /dev/ttyS0, - /dev/ttyS1, - /dev/ttyUSB0, etc. - - - -p, --ptt-file=device - Use device as the file name of the Push-To-Talk - device using a device file as described above. - - - -d, --dcd-file=device - Use device as the file name of the Data Carrier - Detect device using a device file as described - above. - - - -P, --ptt-type=type - Use type of Push-To-Talk device. Supported types - are RIG, DTR, RTS, PARALLEL, NONE, overriding PTT type - defined in the rig's backend. - - - -D, --dcd-type=type - Use type of Data Carrier Detect device. - Supported types are RIG, DSR, CTS, CD, PARALLEL, - NONE. - - - -s, --serial-speed=baud - Set serial speed to baud rate. Uses maximum - serial speed from rig backend capabilities as the - default. - - - -c, --civaddr=id - Use id as the CI-V address to communicate with - the rig. Only useful for Icom rigs. - - - -t, --send-cmd-term=char - Change the termination char for text protocol - when using the send_cmd command. The default value is - <CR> (0x0d). Non ASCII printable characters can - be specified as an ASCII number, in hexadecimal format, - prepended with 0x. You may pass an empty string for no - termination char. The string '-1' - tells rigctl to switch to binary protocol. See the - send_cmd command for further explanation. - - - -L, --show-conf - List all config parameters for the radio defined - with -m above. - - - -C, - --set-conf=parm=val[,parm=val] - - Set config parameter. - e.g. stop_bits=2. Use - -L option for a list. - - - -l, --list - List all model numbers defined in Hamlib and - exit. - - - -u, --dump-caps - Dump capabilities for the radio defined with - -m above and exit. - - - -o, --vfo - Set vfo mode, requiring an extra VFO argument in - front of each appropriate command. Otherwise, VFO_CURR - is assumed when this option is not set. - - - -v, --verbose - Set verbose mode, cumulative. - - - -h, --help - Show summary of these options and exit. - - - -V, --version - Show version of rigctl and exit. - - - -
+ + Rig description switches + + + + + + Switch + Meaning + + + + + -m, --model=id + Select radio model number. See model list (use + 'rigctl -l'). + + + -r, --rig-file=device + Use device as the file name of the port the radio + is connected. Often a serial port, but could be a USB + to serial adapter. Typically + /dev/ttyS0, + /dev/ttyS1, + /dev/ttyUSB0, etc. + + + -p, --ptt-file=device + Use device as the file name of the Push-To-Talk + device using a device file as described above. + + + -d, --dcd-file=device + Use device as the file name of the Data Carrier + Detect device using a device file as described + above. + + + -P, --ptt-type=type + Use type of Push-To-Talk device. Supported types + are RIG, DTR, RTS, PARALLEL, NONE, overriding PTT type + defined in the rig's backend. + + + -D, --dcd-type=type + Use type of Data Carrier Detect device. + Supported types are RIG, DSR, CTS, CD, PARALLEL, + NONE. + + + -s, --serial-speed=baud + Set serial speed to baud rate. Uses maximum + serial speed from rig backend capabilities as the + default. + + + -c, --civaddr=id + Use id as the CI-V address to communicate with + the rig. Only useful for Icom rigs. + + + -t, --send-cmd-term=char + Change the termination char for text protocol + when using the send_cmd command. The default value is + <CR> (0x0d). Non ASCII printable characters can + be specified as an ASCII number, in hexadecimal format, + prepended with 0x. You may pass an empty string for no + termination char. The string '-1' + tells rigctl to switch to binary protocol. See the + send_cmd command for further explanation. + + + -L, --show-conf + List all config parameters for the radio defined + with -m above. + + + -C, + --set-conf=parm=val[,parm=val] + + Set config parameter. + e.g. stop_bits=2. Use + -L option for a list. + + + -l, --list + List all model numbers defined in Hamlib and + exit. + + + -u, --dump-caps + Dump capabilities for the radio defined with + -m above and exit. + + + -o, --vfo + Set vfo mode, requiring an extra VFO argument in + front of each appropriate command. Otherwise, VFO_CURR + is assumed when this option is not set. + + + -v, --verbose + Set verbose mode, cumulative. + + + -h, --help + Show summary of these options and exit. + + + -V, --version + Show version of rigctl and exit. + + + +
For example, to communicate with an Icom 7000 on /dev/ttyUSB0 at 19,200 baud: - -rigctl -m 360 -r /dev/ttyUSB0 -s 19200 -c 0x70 - + + rigctl -m 360 -r /dev/ttyUSB0 -s 19200 -c 0x70 + - - rigtcl can accept a large number of - commands, either on the command line or in interactive mode. The - following table lists some of the more commom commands. For more - details see man rigctl. +
+ rigctl + + rigtcl can accept a large number of + commands, either on the command line or in interactive mode. The + following table lists some of the more commom commands. For more + details see man rigctl. Rig description switches @@ -300,63 +302,115 @@ rigctl -m 360 -r /dev/ttyUSB0 -s 19200 -c 0x70
- - - For example, the following command asks to display the frequency - and mode. The mode display always also shows the bandwidth: -
rigctl - show mode and frequency - - - - - - - rigctl - - - -
- - - The following example asks whether the tone squelch is on and what - are the volume and squelch control settings: -
rigctl - show tone squelch, AF and - Squelch controls - - - - - - - rigctl - - - -
- - - The radio can be controlled as well. In the following example the - radio is set to CW mode with a 500 Hz filter, and the frequency is - set to 3.563 MHz: -
rigctl - set frequency and mode - - - - - - - rigctl - - - -
- + + + For example, the following command asks to display the frequency + and mode. The mode display always also shows the bandwidth: +
rigctl - show mode and frequency + + + + + + + rigctl + + + +
+ + + The following example asks whether the tone squelch is on and what + are the volume and squelch control settings: +
rigctl - show tone squelch, AF and + Squelch controls + + + + + + + rigctl + + + +
+ + + The radio can be controlled as well. In the following example the + radio is set to CW mode with a 500 Hz filter, and the frequency is + set to 3.563 MHz: +
rigctl - set frequency and mode + + + + + + + rigctl + + + +
+ +
+
+ rigmem + + rigmem reads or restores the radio's + memories. rigmem uses the same + communication parameters as rigctl + folowed by to more parameters; the action to be performed and + the file name to save memories to or restore memories from. + + + rigmem queries the radio for the + number of memories available, then asks for all the information + about each of those memories. Because not all radios support + all possible parameters, this may result in hundreds of + messages. These messages are benign. + +
+
+ rigswr + + rigswr takes the same communication + parameters as the other commands, followed by start and end + frequencies and a step size. rigswr + then cycles through the frequencies, keying the transmitter in + CW mode for a half second at each frequency and reporting the + SWR. For this to work the rig must support sending the SWR + while the rig is keyed. +
rigswr + + + + + + + rigswr + + + +
+ +
+
+ rotctl + +
+
+ rigsmtr + +