commit b525e97c63f15f742fc590acfeb84bc7abddcb57 Author: John J. McDonough jjmcd@fedoraproject.org Date: Tue Mar 25 09:22:23 2014 -0400
Additional hamlib documentation
en-US/images/rig-hamlib/hamlib2.png | Bin 9926 -> 9896 bytes en-US/images/rig-hamlib/hamlib4.png | Bin 11389 -> 11362 bytes en-US/images/rig-hamlib/hamlib5.png | Bin 9784 -> 9771 bytes en-US/images/rig-hamlib/hamlib6.png | Bin 0 -> 16100 bytes en-US/rig-hamlib.xml | 442 ++++++++++++++++++++--------------- 5 files changed, 248 insertions(+), 194 deletions(-) --- 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 @@ </itemizedlist> In addition, there are daemons provided for controllig the rig and rotor. </para> -<!-- - <para> - yum info as placeholder -<screen> -Description: Hamlib provides a standardised programming interface that - : applications can use to send the appropriate commands to a radio. - : - : Also included in the package is a simple radio control program - : 'rigctl', which lets one control a radio transceiver or receiver, - : either from command line interface or in a text-oriented - : interactive interface. -</screen> - </para> ---> + <!-- + <para> + yum info as placeholder + <screen> + Description: Hamlib provides a standardised programming interface that + : applications can use to send the appropriate commands to a radio. + : + : Also included in the package is a simple radio control program + : 'rigctl', which lets one control a radio transceiver or receiver, + : either from command line interface or in a text-oriented + : interactive interface. + </screen> + </para> + --> <para> The various <package>hamlib</package> applications require certain switches to describe the rig and its connection, and most take a number of commands. - <table frame="all"> - <title>Rig description switches</title> - <tgroup cols="2"> - <colspec colnum="1" colname="c1" colwidth="2*" /> - <colspec colnum="2" colname="c2" colwidth="3*" /> - <thead> - <row> - <entry>Switch</entry> - <entry>Meaning</entry> - </row> - </thead> - <tbody> - <row> - <entry><command>-m, --model=id</command></entry> - <entry>Select radio model number. See model list (use - '<command>rigctl -l</command>').</entry> - </row> - <row> - <entry><command>-r, --rig-file=device</command></entry> - <entry>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 - <filename>/dev/ttyS0</filename>, - <filename>/dev/ttyS1</filename>, - <filename>/dev/ttyUSB0</filename>, etc.</entry> - </row> - <row> - <entry><command>-p, --ptt-file=device</command></entry> - <entry>Use device as the file name of the Push-To-Talk - device using a device file as described above.</entry> - </row> - <row> - <entry><command>-d, --dcd-file=device</command></entry> - <entry>Use device as the file name of the Data Carrier - Detect device using a device file as described - above.</entry> - </row> - <row> - <entry><command>-P, --ptt-type=type</command></entry> - <entry>Use type of Push-To-Talk device. Supported types - are RIG, DTR, RTS, PARALLEL, NONE, overriding PTT type - defined in the rig's backend.</entry> - </row> - <row> - <entry><command>-D, --dcd-type=type</command></entry> - <entry>Use type of Data Carrier Detect device. - Supported types are RIG, DSR, CTS, CD, PARALLEL, - NONE.</entry> - </row> - <row> - <entry><command>-s, --serial-speed=baud</command></entry> - <entry>Set serial speed to baud rate. Uses maximum - serial speed from rig backend capabilities as the - default.</entry> - </row> - <row> - <entry><command>-c, --civaddr=id</command></entry> - <entry>Use id as the CI-V address to communicate with - the rig. Only useful for Icom rigs.</entry> - </row> - <row> - <entry><command>-t, --send-cmd-term=char</command></entry> - <entry>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 '<command>-1</command>' - tells rigctl to switch to binary protocol. See the - send_cmd command for further explanation.</entry> - </row> - <row> - <entry><command>-L, --show-conf</command></entry> - <entry>List all config parameters for the radio defined - with <command>-m</command> above.</entry> - </row> - <row> - <entry><command>-C, - --set-conf=parm=val[,parm=val]</command> - </entry> - <entry>Set config parameter. - e.g. <command>stop_bits=2</command>. Use - <command>-L</command> option for a list.</entry> - </row> - <row> - <entry><command>-l, --list</command></entry> - <entry>List all model numbers defined in Hamlib and - exit.</entry> - </row> - <row> - <entry><command>-u, --dump-caps</command></entry> - <entry>Dump capabilities for the radio defined with - <command>-m</command> above and exit.</entry> - </row> - <row> - <entry><command>-o, --vfo</command></entry> - <entry>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.</entry> - </row> - <row> - <entry><command>-v, --verbose</command></entry> - <entry>Set verbose mode, cumulative.</entry> - </row> - <row> - <entry><command>-h, --help</command></entry> - <entry>Show summary of these options and exit.</entry> - </row> - <row> - <entry><command>-V, --version</command></entry> - <entry>Show version of rigctl and exit.</entry> - </row> - </tbody> - </tgroup> - </table> + <table frame="all"> + <title>Rig description switches</title> + <tgroup cols="2"> + <colspec colnum="1" colname="c1" colwidth="2*" /> + <colspec colnum="2" colname="c2" colwidth="3*" /> + <thead> + <row> + <entry>Switch</entry> + <entry>Meaning</entry> + </row> + </thead> + <tbody> + <row> + <entry><command>-m, --model=id</command></entry> + <entry>Select radio model number. See model list (use + '<command>rigctl -l</command>').</entry> + </row> + <row> + <entry><command>-r, --rig-file=device</command></entry> + <entry>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 + <filename>/dev/ttyS0</filename>, + <filename>/dev/ttyS1</filename>, + <filename>/dev/ttyUSB0</filename>, etc.</entry> + </row> + <row> + <entry><command>-p, --ptt-file=device</command></entry> + <entry>Use device as the file name of the Push-To-Talk + device using a device file as described above.</entry> + </row> + <row> + <entry><command>-d, --dcd-file=device</command></entry> + <entry>Use device as the file name of the Data Carrier + Detect device using a device file as described + above.</entry> + </row> + <row> + <entry><command>-P, --ptt-type=type</command></entry> + <entry>Use type of Push-To-Talk device. Supported types + are RIG, DTR, RTS, PARALLEL, NONE, overriding PTT type + defined in the rig's backend.</entry> + </row> + <row> + <entry><command>-D, --dcd-type=type</command></entry> + <entry>Use type of Data Carrier Detect device. + Supported types are RIG, DSR, CTS, CD, PARALLEL, + NONE.</entry> + </row> + <row> + <entry><command>-s, --serial-speed=baud</command></entry> + <entry>Set serial speed to baud rate. Uses maximum + serial speed from rig backend capabilities as the + default.</entry> + </row> + <row> + <entry><command>-c, --civaddr=id</command></entry> + <entry>Use id as the CI-V address to communicate with + the rig. Only useful for Icom rigs.</entry> + </row> + <row> + <entry><command>-t, --send-cmd-term=char</command></entry> + <entry>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 '<command>-1</command>' + tells rigctl to switch to binary protocol. See the + send_cmd command for further explanation.</entry> + </row> + <row> + <entry><command>-L, --show-conf</command></entry> + <entry>List all config parameters for the radio defined + with <command>-m</command> above.</entry> + </row> + <row> + <entry><command>-C, + --set-conf=parm=val[,parm=val]</command> + </entry> + <entry>Set config parameter. + e.g. <command>stop_bits=2</command>. Use + <command>-L</command> option for a list.</entry> + </row> + <row> + <entry><command>-l, --list</command></entry> + <entry>List all model numbers defined in Hamlib and + exit.</entry> + </row> + <row> + <entry><command>-u, --dump-caps</command></entry> + <entry>Dump capabilities for the radio defined with + <command>-m</command> above and exit.</entry> + </row> + <row> + <entry><command>-o, --vfo</command></entry> + <entry>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.</entry> + </row> + <row> + <entry><command>-v, --verbose</command></entry> + <entry>Set verbose mode, cumulative.</entry> + </row> + <row> + <entry><command>-h, --help</command></entry> + <entry>Show summary of these options and exit.</entry> + </row> + <row> + <entry><command>-V, --version</command></entry> + <entry>Show version of rigctl and exit.</entry> + </row> + </tbody> + </tgroup> + </table> </para> <para> For example, to communicate with an Icom 7000 on <filename>/dev/ttyUSB0</filename> at 19,200 baud: -<screen> -rigctl -m 360 -r /dev/ttyUSB0 -s 19200 -c 0x70 -</screen> + <screen> + rigctl -m 360 -r /dev/ttyUSB0 -s 19200 -c 0x70 + </screen> </para> - <para> - <application>rigtcl</application> 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 <command>man rigctl</command>. + <section> + <title>rigctl</title> + <para> + <application>rigtcl</application> 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 <command>man rigctl</command>. <table frame="all"> <title>Rig description switches</title> <tgroup cols="2"> @@ -300,63 +302,115 @@ rigctl -m 360 -r /dev/ttyUSB0 -s 19200 -c 0x70 </tbody> </tgroup> </table> - </para> - <para> - For example, the following command asks to display the frequency - and mode. The mode display always also shows the bandwidth: - <figure float="0"><title>rigctl - show mode and frequency</title> - <mediaobject> - <imageobject> - <imagedata scale="99" scalefit="1" - fileref="images/rig-hamlib/hamlib2.png" - format="PNG"/> - </imageobject> - <textobject> - <para> - rigctl - </para> - </textobject> - </mediaobject> - </figure> - </para> - <para> - The following example asks whether the tone squelch is on and what - are the volume and squelch control settings: - <figure float="0"><title>rigctl - show tone squelch, AF and - Squelch controls</title> - <mediaobject> - <imageobject> - <imagedata scale="99" scalefit="1" - fileref="images/rig-hamlib/hamlib4.png" - format="PNG"/> - </imageobject> - <textobject> - <para> - rigctl - </para> - </textobject> - </mediaobject> - </figure> - </para> - <para> - 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: - <figure float="0"><title>rigctl - set frequency and mode</title> - <mediaobject> - <imageobject> - <imagedata scale="99" scalefit="1" - fileref="images/rig-hamlib/hamlib5.png" - format="PNG"/> - </imageobject> - <textobject> - <para> - rigctl - </para> - </textobject> - </mediaobject> - </figure> - </para> + </para> + <para> + For example, the following command asks to display the frequency + and mode. The mode display always also shows the bandwidth: + <figure float="0"><title>rigctl - show mode and frequency</title> + <mediaobject> + <imageobject> + <imagedata scale="99" scalefit="1" + fileref="images/rig-hamlib/hamlib2.png" + format="PNG"/> + </imageobject> + <textobject> + <para> + rigctl + </para> + </textobject> + </mediaobject> + </figure> + </para> + <para> + The following example asks whether the tone squelch is on and what + are the volume and squelch control settings: + <figure float="0"><title>rigctl - show tone squelch, AF and + Squelch controls</title> + <mediaobject> + <imageobject> + <imagedata scale="99" scalefit="1" + fileref="images/rig-hamlib/hamlib4.png" + format="PNG"/> + </imageobject> + <textobject> + <para> + rigctl + </para> + </textobject> + </mediaobject> + </figure> + </para> + <para> + 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: + <figure float="0"><title>rigctl - set frequency and mode</title> + <mediaobject> + <imageobject> + <imagedata scale="99" scalefit="1" + fileref="images/rig-hamlib/hamlib5.png" + format="PNG"/> + </imageobject> + <textobject> + <para> + rigctl + </para> + </textobject> + </mediaobject> + </figure> + </para> + </section> + <section> + <title>rigmem</title> + <para> + <application>rigmem</application> reads or restores the radio's + memories. <application>rigmem</application> uses the same + communication parameters as <application>rigctl</application> + folowed by to more parameters; the action to be performed and + the file name to save memories to or restore memories from. + </para> + <para> + <application>rigmem</application> 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. + </para> + </section> + <section> + <title>rigswr</title> + <para> + <application>rigswr</application> takes the same communication + parameters as the other commands, followed by start and end + frequencies and a step size. <application>rigswr</application> + 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. + <figure float="0"><title>rigswr</title> + <mediaobject> + <imageobject> + <imagedata scale="99" scalefit="1" + fileref="images/rig-hamlib/hamlib6.png" + format="PNG"/> + </imageobject> + <textobject> + <para> + rigswr + </para> + </textobject> + </mediaobject> + </figure> + </para>
+ </section> + <section> + <title>rotctl</title> + <para /> + </section> + <section> + <title>rigsmtr</title> + <para /> + </section>
</section>
docs-commits@lists.fedoraproject.org