Skip to content

Commit 096e236

Browse files
committed
add more documentation
1 parent 89c2e1d commit 096e236

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,37 @@
22

33
An OpenAction ([OpenDeck](https://github.com/nekename/OpenDeck)) plugin to control ham radio transceivers through a hamlib rigctld daemon.
44

5+
## Configuration
6+
7+
The plugin currently supports only one rigctld connection to `localhost:4532`.
8+
9+
## Actions
10+
11+
The following actions are currently available:
12+
13+
| Action | rigctld Command | Description |
14+
|--------|----------------|-------------|
15+
| Frequency Dial | `\set_freq`, `\get_freq` | Encoder to tune the VFO frequency in configurable steps |
16+
| Level Encoder | `\set_level`, `\get_level` | Encoder to adjust a level value in configurable steps |
17+
| On/Off | `\get_powerstat`, `\set_powerstat` | Toggle the rig power between on and off |
18+
| Power State | `\set_powerstat` | Set the rig to a specific power state (off, on, standby, operate) |
19+
| RIT | `\set_rit`, `\get_rit`, `\set_func` | Encoder to adjust the RIT offset, press/keypad to toggle RIT on/off |
20+
| Select Mode | `\set_mode` | Set the operating mode for a VFO |
21+
| Select VFO | `\set_vfo` | Select the active VFO |
22+
| Send Morse | `\send_morse` | Send a preconfigured text as Morse code |
23+
| Set Antenna | `\set_ant` | Select an antenna for a VFO |
24+
| Set Frequency | `\set_freq` | Set the frequency of a VFO to a fixed value |
25+
| Set Frequency (rel) | `\set_freq`, `\get_freq` | Set a VFO frequency relative to another VFO's frequency |
26+
| Set Function | `\set_func` | Enable or disable a rig function |
27+
| Set Level | `\set_level` | Set a level to a fixed value |
28+
| Set Parameter | `\set_parm` | Set a rig-wide parameter value |
29+
| Set Split VFO | `\set_split_vfo` | Enable or disable split operation and set the TX VFO |
30+
| Stop Morse | `\stop_morse` | Stop the current Morse code transmission |
31+
| Toggle Function | `\get_func`, `\set_func` | Toggle a rig function on/off |
32+
| VFO Operation | `\vfo_op` | Perform a VFO operation (e.g. copy, exchange, band up/down) |
33+
| VFO Operation Encoder | `\vfo_op` | Encoder with configurable VFO operations for clockwise, counter-clockwise, and press |
34+
| XIT | `\set_xit`, `\get_xit`, `\set_func` | Encoder to adjust the XIT offset, press/keypad to toggle XIT on/off |
35+
536
## License
637
This software is published under the [MIT License](https://www.tldrlegal.com/l/mit).
738

0 commit comments

Comments
 (0)