Files | |
file | conf.c |
Rig configuration interface. | |
file | event.c |
Event handling. | |
file | ext.c |
Extension request parameter interface. | |
file | mem.c |
Memory and channel interface. | |
file | rig.c |
Ham Radio Control Libraries interface. | |
file | settings.c |
func/level/parm interface | |
file | tones.c |
CTCSS and DCS interface and tables. | |
file | rig.h |
Hamlib rig data structures. | |
Data Structures | |
struct | confparams |
Configuration parameter structure. More... | |
union | value_t |
Universal approach for passing values. More... | |
struct | freq_range_list |
Frequency range. More... | |
struct | tuning_step_list |
Tuning step definition. More... | |
struct | filter_list |
Filter definition. More... | |
struct | ext_list |
Extension attribute definition. More... | |
struct | channel |
Channel structure. More... | |
struct | channel_cap |
Channel capability definition. More... | |
struct | chan_list |
Memory channel list definition. More... | |
struct | gran |
level/parm granularity definition More... | |
struct | cal_table |
Calibration table struct. More... | |
struct | rig_caps |
Rig data structure. More... | |
struct | hamlib_port_t |
Port definition. More... | |
struct | rig_state |
Rig state containing live data and customized fields. More... | |
struct | rig_callbacks |
Callback functions and args for rig event. More... | |
struct | rig |
The Rig structure. More... | |
Defines | |
#define | PRIfreq "f" |
printf(3) format to be used for freq_t type | |
#define | SCNfreq "lf" |
scanf(3) format to be used for freq_t type | |
#define | RIG_VFO_NONE 0 |
'' -- used in caps | |
#define | RIG_VFO_CURR ((vfo_t)(1<<29)) |
currVFO -- current "tunable channel"/VFO | |
#define | RIG_VFO_MEM ((vfo_t)(1<<28)) |
MEM -- means Memory mode, to be used with set_vfo | |
#define | RIG_VFO_VFO ((vfo_t)(1<<27)) |
VFO -- means (last or any)VFO mode, with set_vfo | |
#define | RIG_VFO_TX RIG_VFO_TX_VFO(RIG_VFO_CURR) |
TX -- alias for split tx or uplink, of VFO_CURR | |
#define | RIG_VFO_RX RIG_VFO_CURR |
RX -- alias for split rx or downlink | |
#define | RIG_VFO_MAIN ((vfo_t)(1<<26)) |
Main -- alias for MAIN | |
#define | RIG_VFO_SUB ((vfo_t)(1<<25)) |
Sub -- alias for SUB | |
#define | RIG_VFO_A RIG_VFO_N(0) |
VFOA -- VFO A | |
#define | RIG_VFO_B RIG_VFO_N(1) |
VFOB -- VFO B | |
#define | RIG_VFO_C RIG_VFO_N(2) |
VFOC -- VFO C | |
#define | RIG_MODE_SSB (RIG_MODE_USB|RIG_MODE_LSB) |
macro for backends, not to be used by rig_set_mode et al. | |
#define | RIG_MODE_ECSS (RIG_MODE_ECSSUSB|RIG_MODE_ECSSLSB) |
macro for backends, not to be used by rig_set_mode et al. | |
Typedefs | |
typedef struct rig | RIG |
Rig structure definition (see rig for details). | |
typedef unsigned int | tone_t |
CTCSS and DCS type definition. | |
typedef enum rig_port_e | rig_port_t |
Port type. | |
typedef double | freq_t |
Frequency type, Frequency type unit in Hz, able to hold SHF frequencies. | |
typedef signed long | shortfreq_t |
Short frequency type Frequency in Hz restricted to 31bits, suitable for offsets, shifts, etc.. | |
typedef int | vfo_t |
VFO definition. | |
typedef shortfreq_t | pbwidth_t |
Passband width, in Hz. | |
typedef enum dcd_e | dcd_t |
DCD status. | |
typedef long | token_t |
configuration token | |
typedef int | ant_t |
Antenna number. | |
typedef unsigned long | setting_t |
Setting. | |
typedef struct freq_range_list | freq_range_t |
Frequency range. | |
typedef struct channel | channel_t |
Channel structure typedef. | |
typedef struct channel_cap | channel_cap_t |
Channel cap. | |
typedef struct chan_list | chan_t |
chan_t type | |
typedef struct gran | gran_t |
gran_t type | |
typedef struct cal_table | cal_table_t |
calibration table type | |
Enumerations | |
enum | rig_errcode_e { RIG_OK = 0, RIG_EINVAL, RIG_ECONF, RIG_ENOMEM, RIG_ENIMPL, RIG_ETIMEOUT, RIG_EIO, RIG_EINTERNAL, RIG_EPROTO, RIG_ERJCTED, RIG_ETRUNC, RIG_ENAVAIL, RIG_ENTARGET, RIG_BUSERROR, RIG_BUSBUSY, RIG_EARG, RIG_EVFO, RIG_EDOM } |
Hamlib error codes Error codes that can be returned by the Hamlib functions. More... | |
enum | rig_debug_level_e { RIG_DEBUG_NONE = 0, RIG_DEBUG_BUG, RIG_DEBUG_ERR, RIG_DEBUG_WARN, RIG_DEBUG_VERBOSE, RIG_DEBUG_TRACE } |
Hamlib debug levels. More... | |
enum | rig_port_e { RIG_PORT_NONE = 0, RIG_PORT_SERIAL, RIG_PORT_NETWORK, RIG_PORT_DEVICE, RIG_PORT_PACKET, RIG_PORT_DTMF, RIG_PORT_ULTRA, RIG_PORT_RPC, RIG_PORT_PARALLEL, RIG_PORT_USB } |
Port type. More... | |
enum | serial_parity_e { RIG_PARITY_NONE = 0, RIG_PARITY_ODD, RIG_PARITY_EVEN } |
Serial parity. More... | |
enum | serial_handshake_e { RIG_HANDSHAKE_NONE = 0, RIG_HANDSHAKE_XONXOFF, RIG_HANDSHAKE_HARDWARE } |
Serial handshake. More... | |
enum | serial_control_state_e { RIG_SIGNAL_UNSET = 0, RIG_SIGNAL_ON, RIG_SIGNAL_OFF } |
Serial control state. More... | |
enum | rig_type_t { RIG_FLAG_RECEIVER = (1<<1), RIG_FLAG_TRANSMITTER = (1<<2), RIG_FLAG_SCANNER = (1<<3), RIG_FLAG_MOBILE = (1<<4), RIG_FLAG_HANDHELD = (1<<5), RIG_FLAG_COMPUTER = (1<<6), RIG_FLAG_TRUNKING = (1<<7), RIG_FLAG_APRS = (1<<8), RIG_FLAG_TNC = (1<<9), RIG_FLAG_DXCLUSTER = (1<<10), RIG_FLAG_TUNER = (1<<11) } |
Rig type flags. More... | |
enum | rig_status_e { RIG_STATUS_ALPHA = 0, RIG_STATUS_UNTESTED, RIG_STATUS_BETA, RIG_STATUS_STABLE, RIG_STATUS_BUGGY, RIG_STATUS_NEW } |
Development status of the backend. More... | |
enum | rptr_shift_t { RIG_RPT_SHIFT_NONE = 0, RIG_RPT_SHIFT_MINUS, RIG_RPT_SHIFT_PLUS } |
Repeater shift type. More... | |
enum | split_t { RIG_SPLIT_OFF = 0, RIG_SPLIT_ON } |
Split mode. More... | |
enum | dcd_e { RIG_DCD_OFF = 0, RIG_DCD_ON } |
DCD status. More... | |
enum | dcd_type_t { RIG_DCD_NONE = 0, RIG_DCD_RIG, RIG_DCD_SERIAL_DSR, RIG_DCD_SERIAL_CTS, RIG_DCD_SERIAL_CAR, RIG_DCD_PARALLEL } |
DCD type. More... | |
enum | ptt_t { RIG_PTT_OFF = 0, RIG_PTT_ON } |
PTT status. More... | |
enum | ptt_type_t { RIG_PTT_NONE = 0, RIG_PTT_RIG, RIG_PTT_SERIAL_DTR, RIG_PTT_SERIAL_RTS, RIG_PTT_PARALLEL } |
PTT type. More... | |
enum | powerstat_t { RIG_POWER_OFF = 0, RIG_POWER_ON = (1<<0), RIG_POWER_STANDBY = (1<<1) } |
Radio power state. More... | |
enum | reset_t { RIG_RESET_NONE = 0, RIG_RESET_SOFT = (1<<0), RIG_RESET_VFO = (1<<1), RIG_RESET_MCALL = (1<<2), RIG_RESET_MASTER = (1<<3) } |
Reset operation. More... | |
enum | vfo_op_t { RIG_OP_NONE = 0, RIG_OP_CPY = (1<<0), RIG_OP_XCHG = (1<<1), RIG_OP_FROM_VFO = (1<<2), RIG_OP_TO_VFO = (1<<3), RIG_OP_MCL = (1<<4), RIG_OP_UP = (1<<5), RIG_OP_DOWN = (1<<6), RIG_OP_BAND_UP = (1<<7), RIG_OP_BAND_DOWN = (1<<8), RIG_OP_LEFT = (1<<9), RIG_OP_RIGHT = (1<<10), RIG_OP_TUNE = (1<<11), RIG_OP_TOGGLE = (1<<12) } |
VFO operation. More... | |
enum | scan_t { RIG_SCAN_NONE = 0, RIG_SCAN_STOP = RIG_SCAN_NONE, RIG_SCAN_MEM = (1<<0), RIG_SCAN_SLCT = (1<<1), RIG_SCAN_PRIO = (1<<2), RIG_SCAN_PROG = (1<<3), RIG_SCAN_DELTA = (1<<4), RIG_SCAN_VFO = (1<<5), RIG_SCAN_PLT = (1<<6) } |
Rig Scan operation. More... | |
enum | rig_conf_e { RIG_CONF_STRING, RIG_CONF_COMBO, RIG_CONF_NUMERIC, RIG_CONF_CHECKBUTTON } |
parameter types More... | |
enum | ann_t { RIG_ANN_NONE = 0, RIG_ANN_OFF = RIG_ANN_NONE, RIG_ANN_FREQ = (1<<0), RIG_ANN_RXMODE = (1<<1), RIG_ANN_CW = (1<<2), RIG_ANN_ENG = (1<<3), RIG_ANN_JAP = (1<<4) } |
Announce. More... | |
enum | agc_level_e { , RIG_AGC_USER } |
AGC delay settings. More... | |
enum | meter_level_e |
Level display meters. | |
enum | rig_level_e { RIG_LEVEL_NONE = 0, RIG_LEVEL_PREAMP = (1<<0), RIG_LEVEL_ATT = (1<<1), RIG_LEVEL_VOX = (1<<2), RIG_LEVEL_AF = (1<<3), RIG_LEVEL_RF = (1<<4), RIG_LEVEL_SQL = (1<<5), RIG_LEVEL_IF = (1<<6), RIG_LEVEL_APF = (1<<7), RIG_LEVEL_NR = (1<<8), RIG_LEVEL_PBT_IN = (1<<9), RIG_LEVEL_PBT_OUT = (1<<10), RIG_LEVEL_CWPITCH = (1<<11), RIG_LEVEL_RFPOWER = (1<<12), RIG_LEVEL_MICGAIN = (1<<13), RIG_LEVEL_KEYSPD = (1<<14), RIG_LEVEL_NOTCHF = (1<<15), RIG_LEVEL_COMP = (1<<16), RIG_LEVEL_AGC = (1<<17), RIG_LEVEL_BKINDL = (1<<18), RIG_LEVEL_BALANCE = (1<<19), RIG_LEVEL_METER = (1<<20), RIG_LEVEL_VOXGAIN = (1<<21), RIG_LEVEL_VOXDELAY = RIG_LEVEL_VOX, RIG_LEVEL_ANTIVOX = (1<<22), RIG_LEVEL_SLOPE_LOW = (1<<23), RIG_LEVEL_SLOPE_HIGH = (1<<24), RIG_LEVEL_RAWSTR = (1<<26), RIG_LEVEL_SQLSTAT = (1<<27), RIG_LEVEL_SWR = (1<<28), RIG_LEVEL_ALC = (1<<29), RIG_LEVEL_STRENGTH = (1<<30) } |
Rig Level Settings. More... | |
enum | rig_parm_e { RIG_PARM_NONE = 0, RIG_PARM_ANN = (1<<0), RIG_PARM_APO = (1<<1), RIG_PARM_BACKLIGHT = (1<<2), RIG_PARM_BEEP = (1<<4), RIG_PARM_TIME = (1<<5), RIG_PARM_BAT = (1<<6), RIG_PARM_KEYLIGHT = (1<<7) } |
Rig Parameters. More... | |
enum | rig_func_e { RIG_FUNC_NONE = 0, RIG_FUNC_FAGC = (1<<0), RIG_FUNC_NB = (1<<1), RIG_FUNC_COMP = (1<<2), RIG_FUNC_VOX = (1<<3), RIG_FUNC_TONE = (1<<4), RIG_FUNC_TSQL = (1<<5), RIG_FUNC_SBKIN = (1<<6), RIG_FUNC_FBKIN = (1<<7), RIG_FUNC_ANF = (1<<8), RIG_FUNC_NR = (1<<9), RIG_FUNC_AIP = (1<<10), RIG_FUNC_APF = (1<<11), RIG_FUNC_MON = (1<<12), RIG_FUNC_MN = (1<<13), RIG_FUNC_RF = (1<<14), RIG_FUNC_ARO = (1<<15), RIG_FUNC_LOCK = (1<<16), RIG_FUNC_MUTE = (1<<17), RIG_FUNC_VSC = (1<<18), RIG_FUNC_REV = (1<<19), RIG_FUNC_SQL = (1<<20), RIG_FUNC_ABM = (1<<21), RIG_FUNC_BC = (1<<22), RIG_FUNC_MBC = (1<<23), RIG_FUNC_AFC = (1<<25), RIG_FUNC_SATMODE = (1<<26), RIG_FUNC_SCOPE = (1<<27), RIG_FUNC_RESUME = (1<<28), RIG_FUNC_TBURST = (1<<29), RIG_FUNC_TUNER = (1<<30) } |
Rig Function Settings. More... | |
enum | rmode_t { RIG_MODE_NONE = 0, RIG_MODE_AM = (1<<0), RIG_MODE_CW = (1<<1), RIG_MODE_USB = (1<<2), RIG_MODE_LSB = (1<<3), RIG_MODE_RTTY = (1<<4), RIG_MODE_FM = (1<<5), RIG_MODE_WFM = (1<<6), RIG_MODE_CWR = (1<<7), RIG_MODE_RTTYR = (1<<8), RIG_MODE_AMS = (1<<9), RIG_MODE_PKTLSB = (1<<10), RIG_MODE_PKTUSB = (1<<11), RIG_MODE_PKTFM = (1<<12), RIG_MODE_ECSSUSB = (1<<13), RIG_MODE_ECSSLSB = (1<<14), RIG_MODE_FAX = (1<<15), RIG_MODE_SAM = (1<<16), RIG_MODE_SAL = (1<<17), RIG_MODE_SAH = (1<<18), RIG_MODE_DSB = (1<<19) } |
Radio mode. More... | |
enum | chan_type_t { RIG_MTYPE_NONE = 0, RIG_MTYPE_MEM, RIG_MTYPE_EDGE, RIG_MTYPE_CALL, RIG_MTYPE_MEMOPAD, RIG_MTYPE_SAT } |
Memory channel type definition. More... | |
Functions | |
int | rig_token_foreach (RIG *rig, int(*cfunc)(const struct confparams *, char *), char *data) |
call a function against each configuration token of a rig | |
struct confparams * | rig_confparam_lookup (RIG *rig, const char *name) |
lookup a confparam struct | |
token_t | rig_token_lookup (RIG *rig, const char *name) |
lookup a token id | |
int | rig_set_conf (RIG *rig, token_t token, const char *val) |
set a radio configuration parameter | |
int | rig_get_conf (RIG *rig, token_t token, char *val) |
get the value of a configuration parameter | |
int | rig_set_freq_callback (RIG *rig, freq_cb_t cb, char *arg) |
set the callback for freq events | |
int | rig_set_mode_callback (RIG *rig, mode_cb_t cb, char *arg) |
set the callback for mode events | |
int | rig_set_vfo_callback (RIG *rig, vfo_cb_t cb, char *arg) |
set the callback for vfo events | |
int | rig_set_ptt_callback (RIG *rig, ptt_cb_t cb, char *arg) |
set the callback for ptt events | |
int | rig_set_dcd_callback (RIG *rig, dcd_cb_t cb, char *arg) |
set the callback for dcd events | |
int | rig_set_pltune_callback (RIG *rig, pltune_cb_t cb, char *arg) |
set the callback for pipelined tuning module | |
int | rig_set_trn (RIG *rig, int trn) |
control the transceive mode | |
int | rig_get_trn (RIG *rig, int *trn) |
get the current transceive mode | |
int | rig_ext_level_foreach (RIG *rig, int(*cfunc)(RIG *, const struct confparams *, char *), char *data) |
Executes cfunc on all the elements stored in the extlevels table. | |
int | rig_ext_parm_foreach (RIG *rig, int(*cfunc)(RIG *, const struct confparams *, char *), char *data) |
Executes cfunc on all the elements stored in the extparms table. | |
struct confparams * | rig_ext_lookup (RIG *rig, const char *name) |
lookup ext token by its name, return pointer to confparams struct. | |
struct confparams * | rig_ext_lookup_tok (RIG *rig, token_t token) |
lookup ext token, return pointer to confparams struct. | |
token_t | rig_ext_token_lookup (RIG *rig, const char *name) |
Simple lookup returning token id assicated with name. | |
int | rig_set_mem (RIG *rig, vfo_t vfo, int ch) |
set the current memory channel number | |
int | rig_get_mem (RIG *rig, vfo_t vfo, int *ch) |
get the current memory channel number | |
int | rig_set_bank (RIG *rig, vfo_t vfo, int bank) |
set the current memory bank | |
int | rig_set_channel (RIG *rig, const channel_t *chan) |
set channel data | |
int | rig_get_channel (RIG *rig, channel_t *chan) |
get channel data | |
int | rig_set_chan_all_cb (RIG *rig, chan_cb_t chan_cb, char *arg) |
set all channel data, by callback | |
int | rig_get_chan_all_cb (RIG *rig, chan_cb_t chan_cb, char *arg) |
get all channel data, by callback | |
int | rig_set_chan_all (RIG *rig, const channel_t chans[]) |
set all channel data | |
int | rig_get_chan_all (RIG *rig, channel_t chans[]) |
get all channel data | |
int | rig_set_mem_all_cb (RIG *rig, chan_cb_t chan_cb, confval_cb_t parm_cb, char *arg) |
set all channel and non-channel data by call-back | |
int | rig_get_mem_all_cb (RIG *rig, chan_cb_t chan_cb, confval_cb_t parm_cb, char *arg) |
get all channel and non-channel data by call-back | |
int | rig_set_mem_all (RIG *rig, const channel_t chans[], const struct confparams cfgps[], const value_t vals[]) |
set all channel and non-channel data | |
int | rig_get_mem_all (RIG *rig, channel_t chans[], const struct confparams cfgps[], value_t vals[]) |
get all channel and non-channel data | |
const char * | rigerror (int errnum) |
get string describing the error code | |
RIG * | rig_init (rig_model_t rig_model) |
allocate a new RIG handle | |
int | rig_open (RIG *rig) |
open the communication to the rig | |
int | rig_close (RIG *rig) |
close the communication to the rig | |
int | rig_cleanup (RIG *rig) |
release a rig handle and free associated memory | |
int | rig_set_freq (RIG *rig, vfo_t vfo, freq_t freq) |
set the frequency of the target VFO | |
int | rig_get_freq (RIG *rig, vfo_t vfo, freq_t *freq) |
get the frequency of the target VFO | |
int | rig_set_mode (RIG *rig, vfo_t vfo, rmode_t mode, pbwidth_t width) |
set the mode of the target VFO | |
int | rig_get_mode (RIG *rig, vfo_t vfo, rmode_t *mode, pbwidth_t *width) |
get the mode of the target VFO | |
pbwidth_t | rig_passband_normal (RIG *rig, rmode_t mode) |
get the normal passband of a mode | |
pbwidth_t | rig_passband_narrow (RIG *rig, rmode_t mode) |
get the narrow passband of a mode | |
pbwidth_t | rig_passband_wide (RIG *rig, rmode_t mode) |
get the wide passband of a mode | |
int | rig_set_vfo (RIG *rig, vfo_t vfo) |
set the current VFO | |
int | rig_get_vfo (RIG *rig, vfo_t *vfo) |
get the current VFO | |
int | rig_set_ptt (RIG *rig, vfo_t vfo, ptt_t ptt) |
set PTT on/off | |
int | rig_get_ptt (RIG *rig, vfo_t vfo, ptt_t *ptt) |
get the status of the PTT | |
int | rig_get_dcd (RIG *rig, vfo_t vfo, dcd_t *dcd) |
get the status of the DCD | |
int | rig_set_rptr_shift (RIG *rig, vfo_t vfo, rptr_shift_t rptr_shift) |
set the repeater shift | |
int | rig_get_rptr_shift (RIG *rig, vfo_t vfo, rptr_shift_t *rptr_shift) |
get the current repeater shift | |
int | rig_set_rptr_offs (RIG *rig, vfo_t vfo, shortfreq_t rptr_offs) |
set the repeater offset | |
int | rig_get_rptr_offs (RIG *rig, vfo_t vfo, shortfreq_t *rptr_offs) |
get the current repeater offset | |
int | rig_set_split_freq (RIG *rig, vfo_t vfo, freq_t tx_freq) |
set the split frequencies | |
int | rig_get_split_freq (RIG *rig, vfo_t vfo, freq_t *tx_freq) |
get the current split frequencies | |
int | rig_set_split_mode (RIG *rig, vfo_t vfo, rmode_t tx_mode, pbwidth_t tx_width) |
set the split modes | |
int | rig_get_split_mode (RIG *rig, vfo_t vfo, rmode_t *tx_mode, pbwidth_t *tx_width) |
get the current split modes | |
int | rig_set_split_vfo (RIG *rig, vfo_t vfo, split_t split, vfo_t tx_vfo) |
set the split mode | |
int | rig_get_split_vfo (RIG *rig, vfo_t vfo, split_t *split, vfo_t *tx_vfo) |
get the current split mode | |
int | rig_set_rit (RIG *rig, vfo_t vfo, shortfreq_t rit) |
set the RIT | |
int | rig_get_rit (RIG *rig, vfo_t vfo, shortfreq_t *rit) |
get the current RIT offset | |
int | rig_set_xit (RIG *rig, vfo_t vfo, shortfreq_t xit) |
set the XIT | |
int | rig_get_xit (RIG *rig, vfo_t vfo, shortfreq_t *xit) |
get the current XIT offset | |
int | rig_set_ts (RIG *rig, vfo_t vfo, shortfreq_t ts) |
set the Tuning Step | |
int | rig_get_ts (RIG *rig, vfo_t vfo, shortfreq_t *ts) |
get the current Tuning Step | |
int | rig_set_ant (RIG *rig, vfo_t vfo, ant_t ant) |
set the antenna | |
int | rig_get_ant (RIG *rig, vfo_t vfo, ant_t *ant) |
get the current antenna | |
int | rig_power2mW (RIG *rig, unsigned int *mwpower, float power, freq_t freq, rmode_t mode) |
conversion utility from relative range to absolute in mW | |
int | rig_mW2power (RIG *rig, float *power, unsigned int mwpower, freq_t freq, rmode_t mode) |
conversion utility from absolute in mW to relative range | |
shortfreq_t | rig_get_resolution (RIG *rig, rmode_t mode) |
get the best frequency resolution of the rig | |
int | rig_set_powerstat (RIG *rig, powerstat_t status) |
turn on/off the radio | |
int | rig_get_powerstat (RIG *rig, powerstat_t *status) |
get the on/off status of the radio | |
int | rig_reset (RIG *rig, reset_t reset) |
reset the radio | |
rig_model_t | rig_probe (hamlib_port_t *port) |
try to guess a rig | |
int | rig_probe_all (hamlib_port_t *port, rig_probe_func_t cfunc, char *data) |
try to guess rigs | |
vfo_op_t | rig_has_vfo_op (RIG *rig, vfo_op_t op) |
check retrieval ability of VFO operations | |
int | rig_vfo_op (RIG *rig, vfo_t vfo, vfo_op_t op) |
perform Memory/VFO operations | |
scan_t | rig_has_scan (RIG *rig, scan_t scan) |
check availability of scaning functions | |
int | rig_scan (RIG *rig, vfo_t vfo, scan_t scan, int ch) |
perform Memory/VFO operations | |
int | rig_send_dtmf (RIG *rig, vfo_t vfo, const char *digits) |
send DTMF digits | |
int | rig_recv_dtmf (RIG *rig, vfo_t vfo, char *digits, int *length) |
receive DTMF digits | |
int | rig_send_morse (RIG *rig, vfo_t vfo, const char *msg) |
send morse code | |
const freq_range_t * | rig_get_range (const freq_range_t range_list[], freq_t freq, rmode_t mode) |
find the freq_range of freq/mode | |
const char * | rig_get_info (RIG *rig) |
get general information from the radio | |
int | rig_set_level (RIG *rig, vfo_t vfo, setting_t level, value_t val) |
set a radio level setting | |
int | rig_get_level (RIG *rig, vfo_t vfo, setting_t level, value_t *val) |
get the value of a level | |
int | rig_set_parm (RIG *rig, setting_t parm, value_t val) |
set a radio parameter | |
int | rig_get_parm (RIG *rig, setting_t parm, value_t *val) |
get the value of a parameter | |
setting_t | rig_has_get_level (RIG *rig, setting_t level) |
check retrieval ability of level settings | |
setting_t | rig_has_set_level (RIG *rig, setting_t level) |
check settable ability of level settings | |
setting_t | rig_has_get_parm (RIG *rig, setting_t parm) |
check retrieval ability of parameter settings | |
setting_t | rig_has_set_parm (RIG *rig, setting_t parm) |
check settable ability of parameter settings | |
setting_t | rig_has_get_func (RIG *rig, setting_t func) |
check ability of radio functions | |
setting_t | rig_has_set_func (RIG *rig, setting_t func) |
check ability of radio functions | |
int | rig_set_func (RIG *rig, vfo_t vfo, setting_t func, int status) |
activate/de-activate functions of radio | |
int | rig_get_func (RIG *rig, vfo_t vfo, setting_t func, int *status) |
get the status of functions of the radio | |
int | rig_set_ext_level (RIG *rig, vfo_t vfo, token_t token, value_t val) |
set a radio level extra parameter | |
int | rig_get_ext_level (RIG *rig, vfo_t vfo, token_t token, value_t *val) |
get the value of a level extra parameter | |
int | rig_set_ext_parm (RIG *rig, token_t token, value_t val) |
set a radio parm extra parameter | |
int | rig_get_ext_parm (RIG *rig, token_t token, value_t *val) |
get the value of a parm extra parameter | |
int | rig_setting2idx (setting_t s) |
basically convert setting_t expressed 2^n to n | |
int | rig_set_ctcss_tone (RIG *rig, vfo_t vfo, tone_t tone) |
set CTCSS sub-tone frequency | |
int | rig_get_ctcss_tone (RIG *rig, vfo_t vfo, tone_t *tone) |
get the current CTCSS sub-tone frequency | |
int | rig_set_dcs_code (RIG *rig, vfo_t vfo, tone_t code) |
set the current encoding DCS code | |
int | rig_get_dcs_code (RIG *rig, vfo_t vfo, tone_t *code) |
get the current encoding DCS code | |
int | rig_set_ctcss_sql (RIG *rig, vfo_t vfo, tone_t tone) |
set CTCSS squelch | |
int | rig_get_ctcss_sql (RIG *rig, vfo_t vfo, tone_t *tone) |
get the current CTCSS squelch | |
int | rig_set_dcs_sql (RIG *rig, vfo_t vfo, tone_t code) |
set the current DCS code | |
int | rig_get_dcs_sql (RIG *rig, vfo_t vfo, tone_t *code) |
get the current DCS code | |
const char * | rig_strrmode (rmode_t mode) |
Convert enum RIG_MODE to alpha string. | |
const char * | rig_strvfo (vfo_t vfo) |
Convert enum RIG_VFO_... to alpha string. | |
const char * | rig_strfunc (setting_t) |
Convert enum RIG_FUNC_... to alpha string. | |
const char * | rig_strlevel (setting_t) |
Convert enum RIG_LEVEL_... to alpha string. | |
const char * | rig_strparm (setting_t) |
Convert enum RIG_PARM_... to alpha string. | |
const char * | rig_strptrshift (rptr_shift_t) |
convert enum RIG_RPT_SHIFT_... to printable character | |
const char * | rig_strvfop (vfo_op_t op) |
Convert enum RIG_OP_... to alpha string. | |
const char * | rig_strscan (scan_t scan) |
Convert enum RIG_SCAN_... to alpha string. | |
const char * | rig_strstatus (enum rig_status_e status) |
Convert enum RIG_STATUS_... to printable string. | |
rmode_t | rig_parse_mode (const char *s) |
Convert alpha string to enum RIG_MODE. | |
vfo_t | rig_parse_vfo (const char *s) |
Convert alpha string to enum RIG_VFO_... | |
setting_t | rig_parse_func (const char *s) |
Convert alpha string to enum RIG_FUNC_... | |
setting_t | rig_parse_level (const char *s) |
Convert alpha string to enum RIG_LEVEL_... | |
setting_t | rig_parse_parm (const char *s) |
Convert alpha string to RIG_PARM_... | |
vfo_op_t | rig_parse_vfo_op (const char *s) |
Convert alpha string to enum RIG_OP_... | |
scan_t | rig_parse_scan (const char *s) |
Convert alpha string to enum RIG_SCAN_... | |
rptr_shift_t | rig_parse_rptr_shift (const char *s) |
Convert alpha char to enum RIG_RPT_SHIFT_... | |
Variables | |
const char | hamlib_version [] = "Hamlib version " PACKAGE_VERSION |
Hamlib release number The version number has the format x.y.z. | |
const char | hamlib_copyright [] |
Hamlib copyright notice. | |
const tone_t | full_ctcss_list [] = { 600, 670, 693, 719, 744, 770, 797, 825, 854, 885, 915, 948, 974, 1000, 1035, 1072, 1109, 1148, 1188, 1200, 1230, 1273, 1318, 1365, 1413, 1462, 1514, 1567, 1598, 1622, 1655, 1679, 1713, 1738, 1773, 1799, 1835, 1862, 1899, 1928, 1966, 1995, 2035, 2065, 2107, 2181, 2257, 2291, 2336, 2418, 2503, 2541, 0, } |
const tone_t | common_ctcss_list [] = { 670, 693, 719, 744, 770, 797, 825, 854, 885, 915, 948, 974, 1000, 1035, 1072, 1109, 1148, 1188, 1230, 1273, 1318, 1365, 1413, 1462, 1514, 1567, 1598, 1622, 1655, 1679, 1713, 1738, 1773, 1799, 1835, 1862, 1899, 1928, 1966, 1995, 2035, 2065, 2107, 2181, 2257, 2291, 2336, 2418, 2503, 2541, 0, } |
const tone_t | full_dcs_list [] = { 17, 23, 25, 26, 31, 32, 36, 43, 47, 50, 51, 53, 54, 65, 71, 72, 73, 74, 114, 115, 116, 122, 125, 131, 132, 134, 143, 145, 152, 155, 156, 162, 165, 172, 174, 205, 212, 223, 225, 226, 243, 244, 245, 246, 251, 252, 255, 261, 263, 265, 266, 271, 274, 306, 311, 315, 325, 331, 332, 343, 346, 351, 356, 364, 365, 371, 411, 412, 413, 423, 431, 432, 445, 446, 452, 454, 455, 462, 464, 465, 466, 503, 506, 516, 523, 526, 532, 546, 565, 606, 612, 624, 627, 631, 632, 654, 662, 664, 703, 712, 723, 731, 732, 734, 743, 754, 0, } |
const char | hamlib_version [] |
Hamlib release number The version number has the format x.y.z. | |
const char | hamlib_copyright [] |
Hamlib copyright notice. |
typedef struct cal_table cal_table_t |
calibration table type
cal_table_t is a data type suited to hold linear calibration. cal_table_t.size tells the number of plots cal_table_t.table contains.
If a value is below or equal to cal_table_t.table[0].raw, rig_raw2val() will return cal_table_t.table[0].val.
If a value is greater or equal to cal_table_t.table[cal_table_t.size-1].raw, rig_raw2val() will return cal_table_t.table[cal_table_t.size-1].val.
typedef struct freq_range_list freq_range_t |
Frequency range.
Put together a group of this struct in an array to define what frequencies your rig has access to.
typedef shortfreq_t pbwidth_t |
typedef unsigned long setting_t |
Setting.
This can be a func, a level or a parm. Each bit designates one of them.
typedef unsigned int tone_t |
CTCSS and DCS type definition.
Continuous Tone Controlled Squelch System (CTCSS) sub-audible tone frequency are expressed in tenth of Hz. For example, the subaudible tone of 88.5 Hz is represented within Hamlib by 885.
Digitally-Coded Squelch codes are simple direct integers.
typedef int vfo_t |
VFO definition.
There are several ways of using a vfo_t. For most cases, using RIG_VFO_A, RIG_VFO_B, RIG_VFO_CURR, etc., as opaque macros should suffice.
Strictly speaking a VFO is Variable Frequency Oscillator. Here, it is referred as a tunable channel, from the radio operator's point of view. The channel can be designated individually by its real number, or by using an alias.
Aliases may or may not be honored by a backend and are defined using high significant bits, i.e. RIG_VFO_MEM, RIG_VFO_MAIN, etc.
enum agc_level_e |
enum ann_t |
enum chan_type_t |
Memory channel type definition.
Definition of memory types. Depending on the type, the content of the memory channel has to be interpreted accordingly. For instance, a RIG_MTYPE_EDGE channel_t will hold only a start or stop frequency.
RIG_MTYPE_NONE | None |
RIG_MTYPE_MEM | Regular |
RIG_MTYPE_EDGE | Scan edge |
RIG_MTYPE_CALL | Call channel |
RIG_MTYPE_MEMOPAD | Memory pad |
RIG_MTYPE_SAT | Satellite |
enum dcd_e |
enum dcd_type_t |
DCD type.
RIG_DCD_NONE | No DCD available |
RIG_DCD_RIG | Rig has DCD status support, i.e. rig has get_dcd cap |
RIG_DCD_SERIAL_DSR | DCD status from serial DSR signal |
RIG_DCD_SERIAL_CTS | DCD status from serial CTS signal |
RIG_DCD_SERIAL_CAR | DCD status from serial CD signal |
RIG_DCD_PARALLEL | DCD status from parallel port pin |
enum powerstat_t |
enum ptt_t |
enum ptt_type_t |
enum reset_t |
enum rig_conf_e |
parameter types
Used with configuration, parameter and extra-parm tables.
Current internal implementation NUMERIC: val.f or val.i COMBO: val.i, starting from 0. Points to a table of strings or asci stored values. STRING: val.s or val.cs CHECKBUTTON: val.i 0/1
enum rig_debug_level_e |
enum rig_errcode_e |
Hamlib error codes Error codes that can be returned by the Hamlib functions.
RIG_OK | No error, operation completed sucessfully |
RIG_EINVAL | invalid parameter |
RIG_ECONF | invalid configuration (serial,..) |
RIG_ENOMEM | memory shortage |
RIG_ENIMPL | function not implemented, but will be |
RIG_ETIMEOUT | communication timed out |
RIG_EIO | IO error, including open failed |
RIG_EINTERNAL | Internal Hamlib error, huh! |
RIG_EPROTO | Protocol error |
RIG_ERJCTED | Command rejected by the rig |
RIG_ETRUNC | Command performed, but arg truncated |
RIG_ENAVAIL | function not available |
RIG_ENTARGET | VFO not targetable |
RIG_BUSERROR | Error talking on the bus |
RIG_BUSBUSY | Collision on the bus |
RIG_EARG | NULL RIG handle or any invalid pointer parameter in get arg |
RIG_EVFO | Invalid VFO |
RIG_EDOM | Argument out of domain of func |
enum rig_func_e |
Rig Function Settings.
Various operating functions supported by a rig.
STRING
used in rigctl
enum rig_level_e |
Rig Level Settings.
Various operating levels supported by a rig.
STRING
used in rigctl
RIG_LEVEL_NONE | '' -- No Level |
RIG_LEVEL_PREAMP |
PREAMP -- Preamp, arg int (dB) |
RIG_LEVEL_ATT |
ATT -- Attenuator, arg int (dB) |
RIG_LEVEL_VOX |
VOX -- VOX delay, arg int (tenth of seconds) |
RIG_LEVEL_AF |
AF -- Volume, arg float [0.0 ... 1.0] |
RIG_LEVEL_RF |
RF -- RF gain (not TX power), arg float [0.0 ... 1.0] |
RIG_LEVEL_SQL |
SQL -- Squelch, arg float [0.0 ... 1.0] |
RIG_LEVEL_IF |
IF -- IF, arg int (Hz) |
RIG_LEVEL_APF |
APF -- APF, arg float [0.0 ... 1.0] |
RIG_LEVEL_NR |
NR -- Noise Reduction, arg float [0.0 ... 1.0] |
RIG_LEVEL_PBT_IN |
PBT_IN -- Twin PBT (inside), arg float [0.0 ... 1.0] |
RIG_LEVEL_PBT_OUT |
PBT_OUT -- Twin PBT (outside), arg float [0.0 ... 1.0] |
RIG_LEVEL_CWPITCH |
CWPITCH -- CW pitch, arg int (Hz) |
RIG_LEVEL_RFPOWER |
RFPOWER -- RF Power, arg float [0.0 ... 1.0] |
RIG_LEVEL_MICGAIN |
MICGAIN -- MIC Gain, arg float [0.0 ... 1.0] |
RIG_LEVEL_KEYSPD |
KEYSPD -- Key Speed, arg int (WPM) |
RIG_LEVEL_NOTCHF |
NOTCHF -- Notch Freq., arg int (Hz) |
RIG_LEVEL_COMP |
COMP -- Compressor, arg float [0.0 ... 1.0] |
RIG_LEVEL_AGC |
AGC -- AGC, arg int (see enum agc_level_e) |
RIG_LEVEL_BKINDL |
BKINDL -- BKin Delay, arg int (tenth of dots) |
RIG_LEVEL_BALANCE |
BAL -- Balance (Dual Watch), arg float [0.0 ... 1.0] |
RIG_LEVEL_METER |
METER -- Display meter, arg int (see enum meter_level_e) |
RIG_LEVEL_VOXGAIN |
VOXGAIN -- VOX gain level, arg float [0.0 ... 1.0] |
RIG_LEVEL_VOXDELAY | Synonym of RIG_LEVEL_VOX |
RIG_LEVEL_ANTIVOX |
ANTIVOX -- anti-VOX level, arg float [0.0 ... 1.0] |
RIG_LEVEL_SLOPE_LOW |
SLOPE_LOW -- Slope tune, low frequency cut, |
RIG_LEVEL_SLOPE_HIGH |
SLOPE_HIGH -- Slope tune, high frequency cut, |
RIG_LEVEL_RAWSTR |
These ones are not settable RAWSTR -- Raw (A/D) value for signal strength, specific to each rig, arg int |
RIG_LEVEL_SQLSTAT |
SQLSTAT -- SQL status, arg int (open=1/closed=0). Deprecated, use get_dcd instead |
RIG_LEVEL_SWR |
SWR -- SWR, arg float [0.0 ... infinite] |
RIG_LEVEL_ALC |
ALC -- ALC, arg float |
RIG_LEVEL_STRENGTH |
STRENGTH -- Effective (calibrated) signal strength relative to S9, arg int (dB) Bandwidth Control, arg int (Hz) |
enum rig_parm_e |
Rig Parameters.
Parameters are settings that are not VFO specific.
STRING
used in rigctl
enum rig_port_e |
Port type.
RIG_PORT_NONE | No port |
RIG_PORT_SERIAL | Serial |
RIG_PORT_NETWORK | Network socket type |
RIG_PORT_DEVICE | Device driver, like the WiNRADiO |
RIG_PORT_PACKET | AX.25 network type, e.g. SV8CS protocol |
RIG_PORT_DTMF | DTMF protocol bridge via another rig, eg. Kenwood Sky Cmd System |
RIG_PORT_ULTRA | IrDA Ultra protocol! |
RIG_PORT_RPC | RPC wrapper |
RIG_PORT_PARALLEL | Parallel port |
RIG_PORT_USB | USB port |
enum rig_status_e |
Development status of the backend.
RIG_STATUS_ALPHA | Alpha quality, i.e. development |
RIG_STATUS_UNTESTED | Written from available specs, rig unavailable for test, feedback wanted! |
RIG_STATUS_BETA | Beta quality |
RIG_STATUS_STABLE | Stable |
RIG_STATUS_BUGGY | Was stable, but something broke it! |
RIG_STATUS_NEW | Initial release of code |
enum rig_type_t |
Rig type flags.
RIG_FLAG_RECEIVER | Receiver |
RIG_FLAG_TRANSMITTER | Transmitter |
RIG_FLAG_SCANNER | Scanner |
RIG_FLAG_MOBILE | mobile sized |
RIG_FLAG_HANDHELD | handheld sized |
RIG_FLAG_COMPUTER | "Computer" rig |
RIG_FLAG_TRUNKING | has trunking |
RIG_FLAG_APRS | has APRS |
RIG_FLAG_TNC | has TNC |
RIG_FLAG_DXCLUSTER | has DXCluster |
RIG_FLAG_TUNER | dumb tuner |
enum rmode_t |
Radio mode.
Various modes supported by a rig.
STRING
used in rigctl
enum rptr_shift_t |
enum scan_t |
Rig Scan operation.
Various scan operations supported by a rig.
STRING
used in rigctl
RIG_SCAN_NONE | '' No Scan |
RIG_SCAN_STOP |
STOP -- Stop scanning |
RIG_SCAN_MEM |
MEM -- Scan all memory channels |
RIG_SCAN_SLCT |
SLCT -- Scan all selected memory channels |
RIG_SCAN_PRIO |
PRIO -- Priority watch (mem or call channel) |
RIG_SCAN_PROG |
PROG -- Programmed(edge) scan |
RIG_SCAN_DELTA |
DELTA -- delta-f scan |
RIG_SCAN_VFO |
VFO -- most basic scan |
RIG_SCAN_PLT |
PLT -- Scan using pipelined tuning |
enum serial_handshake_e |
enum serial_parity_e |
enum split_t |
enum vfo_op_t |
VFO operation.
A VFO operation is an action on a VFO (or tunable memory). The difference with a function is that an action has no on/off status, it is performed at once.
Note: the vfo argument for some vfo operation may be irrelevant, and thus will be ignored.
The VFO/MEM "mode" is set by rig_set_vfo.
STRING
used in rigctl
int rig_cleanup | ( | RIG * | rig | ) |
release a rig handle and free associated memory
Releases a rig struct which port has eventualy been closed already with rig_close().
int rig_close | ( | RIG * | rig | ) |
close the communication to the rig
Closes communication to a radio which RIG handle has been passed by argument that was previously open with rig_open().
struct confparams* rig_confparam_lookup | ( | RIG * | rig, | |
const char * | name | |||
) | [read] |
lookup a confparam struct
Lookup conf token by its name.
int rig_ext_level_foreach | ( | RIG * | rig, | |
int(*)(RIG *, const struct confparams *, char *) | cfunc, | |||
char * | data | |||
) |
struct confparams* rig_ext_lookup | ( | RIG * | rig, | |
const char * | name | |||
) | [read] |
lookup ext token by its name, return pointer to confparams struct.
rig | ||
name | Lookup extlevels table first, then fall back to extparms. |
TODO: should use Lex to speed it up, strcmp hurts!
struct confparams* rig_ext_lookup_tok | ( | RIG * | rig, | |
token_t | token | |||
) | [read] |
lookup ext token, return pointer to confparams struct.
rig | ||
token | lookup extlevels table first, then fall back to extparms. |
int rig_ext_parm_foreach | ( | RIG * | rig, | |
int(*)(RIG *, const struct confparams *, char *) | cfunc, | |||
char * | data | |||
) |
Executes cfunc on all the elements stored in the extparms table.
rig | ||
cfunc | The function to be called | |
data | The data |
get the current antenna
rig | The rig handle | |
vfo | The target VFO | |
ant | The location where to store the current antenna |
get all channel data
Retrieves the data associated with all the memory channels.
int rig_get_chan_all_cb | ( | RIG * | rig, | |
chan_cb_t | chan_cb, | |||
char * | arg | |||
) |
get all channel data, by callback
rig | The rig handle | |
chan_cb | Pointer to a callback function to retrieve channel data | |
arg | Arbitrary argument passed back to chan_cb |
chan_cb is called first with no data in chan (chan equals NULL). This means the application has to provide a struct where to store future data for channel channel_num. If channel_num == chan->channel_num, the application does not need to provide a new allocated structure.
get channel data
Retrieves the data associated with a channel. This channel can either be the state of a VFO specified by chan->vfo, or a memory channel specified with chan->vfo = RIG_VFO_MEM and chan->channel_num. See channel_t for more information.
Example:
channel_t chan; int err; chan->vfo = RIG_VFO_MEM; chan->channel_num = 10; err = rig_get_channel(rig, &chan); if (err != RIG_OK) error("get_channel failed: %s", rigerror(err));
The rig_get_channel is supposed to have no impact on the current VFO and memory number selected. Depending on backend and rig capabilities, the chan struct may not be filled in completely.
Note: chan->ext_levels is a pointer to a newly mallocated memory. This is the responsability of the caller to manage and eventually free it.
get the value of a configuration parameter
rig | The rig handle | |
token | The parameter | |
val | The location where to store the value of config token |
get the current CTCSS squelch
Retrieves the current Continuous Tone Controlled Squelch System (CTCSS) sub-audible *squelch* tone.
get the current CTCSS sub-tone frequency
Retrieves the current Continuous Tone Controlled Squelch System (CTCSS) sub-audible tone frequency.
get the status of the DCD
rig | The rig handle | |
vfo | The target VFO | |
dcd | The location where to store the status of the DCD |
get the current encoding DCS code
Retrieves the current encoding Digitally-Coded Squelch code.
get the current DCS code
Retrieves the current Digitally-Coded *Squelch* code.
get the value of a level extra parameter
rig | The rig handle | |
vfo | The target VFO | |
token | The parameter | |
val | The location where to store the value of token |
get the value of a parm extra parameter
rig | The rig handle | |
token | The parameter | |
val | The location where to store the value of token |
get the frequency of the target VFO
rig | The rig handle | |
vfo | The target VFO | |
freq | The location where to store the current frequency |
get the status of functions of the radio
rig | The rig handle | |
vfo | The target VFO | |
func | The functions to get the status | |
status | The location where to store the function status |
const char* rig_get_info | ( | RIG * | rig | ) |
get general information from the radio
Retrieves some general information from the radio. This can include firmware revision, exact model name, or just nothing.
get the value of a level
rig | The rig handle | |
vfo | The target VFO | |
level | The level setting | |
val | The location where to store the value of level |
RIG_LEVEL_STRENGTH: val is an integer, representing the S Meter level in dB, according to the ideal S Meter scale. The ideal S Meter scale is as follow: S0=-54, S1=-48, S2=-42, S3=-36, S4=-30, S5=-24, S6=-18, S7=-12, S8=-6, S9=0, +10=10, +20=20, +30=30, +40=40, +50=50 and +60=60. This is the responsability of the backend to return values calibrated for this scale.
get the current memory channel number
rig | The rig handle | |
vfo | The target VFO | |
ch | The location where to store the current memory channel number |
int rig_get_mem_all | ( | RIG * | rig, | |
channel_t | chans[], | |||
const struct confparams | cfgps[], | |||
value_t | vals[] | |||
) |
get all channel and non-channel data
rig | The rig handle | |
chans | Array of channels where to store the data | |
cfgps | Array of config parameters to retrieve | |
vals | Array of values where to store the data |
int rig_get_mem_all_cb | ( | RIG * | rig, | |
chan_cb_t | chan_cb, | |||
confval_cb_t | parm_cb, | |||
char * | arg | |||
) |
get all channel and non-channel data by call-back
rig | The rig handle | |
chan_cb | The callback for channel data | |
parm_cb | The callback for non-channel(aka parm) data | |
arg | Cookie passed to chan_cb and parm_cb |
get the mode of the target VFO
rig | The rig handle | |
vfo | The target VFO | |
mode | The location where to store the current mode | |
width | The location where to store the current passband width |
get the value of a parameter
Retrieves the value of a parm. The parameter value val can be a float or an integer. See value_t for more information.
int rig_get_powerstat | ( | RIG * | rig, | |
powerstat_t * | status | |||
) |
get the on/off status of the radio
Retrieve the status of the radio. See RIG_POWER_ON, RIG_POWER_OFF and RIG_POWER_STANDBY defines for the status.
get the status of the PTT
rig | The rig handle | |
vfo | The target VFO | |
ptt | The location where to store the status of the PTT |
const freq_range_t* rig_get_range | ( | const freq_range_t | range_list[], | |
freq_t | freq, | |||
rmode_t | mode | |||
) |
find the freq_range of freq/mode
range_list | The range list to search from | |
freq | The frequency that will be part of this range | |
mode | The mode that will be part of this range |
shortfreq_t rig_get_resolution | ( | RIG * | rig, | |
rmode_t | mode | |||
) |
int rig_get_rit | ( | RIG * | rig, | |
vfo_t | vfo, | |||
shortfreq_t * | rit | |||
) |
get the current RIT offset
rig | The rig handle | |
vfo | The target VFO | |
rit | The location where to store the current RIT offset |
int rig_get_rptr_offs | ( | RIG * | rig, | |
vfo_t | vfo, | |||
shortfreq_t * | rptr_offs | |||
) |
get the current repeater offset
rig | The rig handle | |
vfo | The target VFO | |
rptr_offs | The location where to store the current repeater offset |
int rig_get_rptr_shift | ( | RIG * | rig, | |
vfo_t | vfo, | |||
rptr_shift_t * | rptr_shift | |||
) |
get the current repeater shift
rig | The rig handle | |
vfo | The target VFO | |
rptr_shift | The location where to store the current repeater shift |
get the current split frequencies
rig | The rig handle | |
vfo | The target VFO | |
tx_freq | The location where to store the current transmit split frequency |
get the current split modes
rig | The rig handle | |
vfo | The target VFO | |
tx_mode | The location where to store the current transmit split mode | |
tx_width | The location where to store the current transmit split width |
get the current split mode
rig | The rig handle | |
vfo | The target VFO | |
split | The location where to store the current split mode | |
tx_vfo | The transmit VFO |
int rig_get_trn | ( | RIG * | rig, | |
int * | trn | |||
) |
get the current transceive mode
Retrieves the current status of the transceive mode, i.e. if radio sends new status automatically when some changes happened on the radio.
int rig_get_ts | ( | RIG * | rig, | |
vfo_t | vfo, | |||
shortfreq_t * | ts | |||
) |
get the current Tuning Step
rig | The rig handle | |
vfo | The target VFO | |
ts | The location where to store the current tuning step |
get the current VFO
Retrieves the current VFO. The VFO can be RIG_VFO_A, RIG_VFO_B, RIG_VFO_C for VFOA, VFOB, VFOC respectively or RIG_VFO_MEM for Memory mode. Supported VFOs depends on rig capabilities.
int rig_get_xit | ( | RIG * | rig, | |
vfo_t | vfo, | |||
shortfreq_t * | xit | |||
) |
get the current XIT offset
rig | The rig handle | |
vfo | The target VFO | |
xit | The location where to store the current XIT offset |
check ability of radio functions
Checks if a rig supports a set of functions. Since the func is an OR'ed bitwise argument, more than one function can be checked at the same time.
EXAMPLE: if (rig_has_get_func(my_rig,RIG_FUNC_FAGC)) disp_fagc_button();
check retrieval ability of level settings
Checks if a rig is capable of *getting* a level setting. Since the level is an OR'ed bitwise argument, more than one level can be checked at the same time.
EXAMPLE: if (rig_has_get_level(my_rig, RIG_LVL_STRENGTH)) disp_Smeter();
check retrieval ability of parameter settings
Checks if a rig is capable of *getting* a parm setting. Since the parm is an OR'ed bitwise argument, more than one parameter can be checked at the same time.
EXAMPLE: if (rig_has_get_parm(my_rig, RIG_PARM_ANN)) good4you();
check availability of scaning functions
Checks if a rig is capable of performing a scan operation. Since the scan parameter is an OR'ed bitmap argument, more than one op can be checked at the same time.
EXAMPLE: if (rig_has_scan(my_rig, RIG_SCAN_PRIO)) disp_SCANprio_btn();
check ability of radio functions
Checks if a rig supports a set of functions. Since the func is an OR'ed bitwise argument, more than one function can be checked at the same time.
EXAMPLE: if (rig_has_set_func(my_rig,RIG_FUNC_FAGC)) disp_fagc_button();
check settable ability of level settings
Checks if a rig can *set* a level setting. Since the level is an OR'ed bitwise argument, more than one level can be check at the same time.
EXAMPLE: if (rig_has_set_level(my_rig, RIG_LVL_RFPOWER)) crank_tx();
check settable ability of parameter settings
Checks if a rig can *set* a parameter setting. Since the parm is an OR'ed bitwise argument, more than one parameter can be check at the same time.
EXAMPLE: if (rig_has_set_parm(my_rig, RIG_PARM_ANN)) announce_all();
check retrieval ability of VFO operations
Checks if a rig is capable of executing a VFO operation. Since the op is an OR'ed bitmap argument, more than one op can be checked at the same time.
EXAMPLE: if (rig_has_vfo_op(my_rig, RIG_OP_CPY)) disp_VFOcpy_btn();
RIG* rig_init | ( | rig_model_t | rig_model | ) |
allocate a new RIG handle
rig_model | The rig model for this new handle |
conversion utility from absolute in mW to relative range
rig | The rig handle | |
power | The location where to store the converted relative power | |
mwpower | The power in mW | |
freq | The frequency where the conversion should take place | |
mode | The mode where the conversion should take place |
int rig_open | ( | RIG * | rig | ) |
open the communication to the rig
Opens communication to a radio which RIG handle has been passed by argument.
RIG_EINVAL | rig is NULL or unconsistent. | |
RIG_ENIMPL | port type communication is not implemented yet. |
setting_t rig_parse_func | ( | const char * | s | ) |
Convert alpha string to enum RIG_FUNC_...
s | input alpha string |
setting_t rig_parse_level | ( | const char * | s | ) |
Convert alpha string to enum RIG_LEVEL_...
s | input alpha string |
rmode_t rig_parse_mode | ( | const char * | s | ) |
Convert alpha string to enum RIG_MODE.
s | input alpha string |
setting_t rig_parse_parm | ( | const char * | s | ) |
Convert alpha string to RIG_PARM_...
s | input alpha string |
rptr_shift_t rig_parse_rptr_shift | ( | const char * | s | ) |
Convert alpha char to enum RIG_RPT_SHIFT_...
s | alpha char |
scan_t rig_parse_scan | ( | const char * | s | ) |
Convert alpha string to enum RIG_SCAN_...
s | alpha string |
vfo_t rig_parse_vfo | ( | const char * | s | ) |
Convert alpha string to enum RIG_VFO_...
s | input alpha string |
vfo_op_t rig_parse_vfo_op | ( | const char * | s | ) |
Convert alpha string to enum RIG_OP_...
s | alpha string |
get the narrow passband of a mode
Returns the narrow (closest) passband for the given mode. EXAMPLE: rig_set_mode(my_rig, RIG_MODE_LSB, rig_passband_narrow(my_rig, RIG_MODE_LSB) );
get the normal passband of a mode
Returns the normal (default) passband for the given mode.
get the wide passband of a mode
Returns the wide (default) passband for the given mode. EXAMPLE: rig_set_mode(my_rig, RIG_MODE_AM, rig_passband_wide(my_rig, RIG_MODE_AM) );
conversion utility from relative range to absolute in mW
rig | The rig handle | |
mwpower | The location where to store the converted power in mW | |
power | The relative power | |
freq | The frequency where the conversion should take place | |
mode | The mode where the conversion should take place |
rig_model_t rig_probe | ( | hamlib_port_t * | port | ) |
try to guess a rig
port | A pointer describing a port linking the host to the rig |
int rig_probe_all | ( | hamlib_port_t * | port, | |
rig_probe_func_t | cfunc, | |||
char * | data | |||
) |
try to guess rigs
port | A pointer describing a port linking the host to the rigs | |
cfunc | Function to be called each time a rig is found | |
data | Arbitrary data passed to cfunc |
receive DTMF digits
rig | The rig handle | |
vfo | The target VFO | |
digits | Location where the digits are to be stored | |
length | in: max length of buffer, out: number really read. |
reset the radio
Resets the radio. See RIG_RESET_NONE, RIG_RESET_SOFT and RIG_RESET_MCALL defines for the reset.
perform Memory/VFO operations
rig | The rig handle | |
vfo | The target VFO | |
scan | The scanning operation to perform | |
ch | Optional channel argument used for the scan. |
set the antenna
Select the antenna connector.
rig_set_ant(rig, RIG_VFO_CURR, RIG_ANT_1); // apply to both TX&RX rig_set_ant(rig, RIG_VFO_RX, RIG_ANT_2);
set the current memory bank
Sets the current memory bank number. It is not mandatory for the radio to be in memory mode. Actually it depends on rigs. YMMV.
set all channel data
Write the data associated with all the memory channels.
int rig_set_chan_all_cb | ( | RIG * | rig, | |
chan_cb_t | chan_cb, | |||
char * | arg | |||
) |
set all channel data, by callback
rig | The rig handle | |
chan_cb | Pointer to a callback function to provide channel data | |
arg | Arbitrary argument passed back to chan_cb |
set channel data
Sets the data associated with a channel. This channel can either be the state of a VFO specified by chan->vfo, or a memory channel specified with chan->vfo = RIG_VFO_MEM and chan->channel_num. See channel_t for more information.
The rig_set_channel is supposed to have no impact on the current VFO and memory number selected. Depending on backend and rig capabilities, the chan struct may not be set completely.
set a radio configuration parameter
Sets a configuration parameter.
set CTCSS squelch
Sets the current Continuous Tone Controlled Squelch System (CTCSS) sub-audible *squelch* tone.
set CTCSS sub-tone frequency
Sets the current Continuous Tone Controlled Squelch System (CTCSS) sub-audible tone frequency.
int rig_set_dcd_callback | ( | RIG * | rig, | |
dcd_cb_t | cb, | |||
char * | arg | |||
) |
set the callback for dcd events
rig | The rig handle | |
cb | The callback to install | |
arg | A Pointer to some private data to pass later on to the callback |
set the current encoding DCS code
Sets the current encoding Digitally-Coded Squelch code.
set the current DCS code
Sets the current Digitally-Coded *Squelch* code.
set a radio level extra parameter
rig | The rig handle | |
vfo | The target VFO | |
token | The parameter | |
val | The value to set the parameter to |
set a radio parm extra parameter
Sets an parm extra parameter.
set the frequency of the target VFO
Sets the frequency of the target VFO.
int rig_set_freq_callback | ( | RIG * | rig, | |
freq_cb_t | cb, | |||
char * | arg | |||
) |
set the callback for freq events
rig | The rig handle | |
cb | The callback to install | |
arg | A Pointer to some private data to pass later on to the callback |
activate/de-activate functions of radio
rig | The rig handle | |
vfo | The target VFO | |
func | The functions to activate | |
status | The status (on or off) to set to |
The status argument is a non null value for "activate", "de-activate" otherwise, much as TRUE/FALSE definitions in C language.
set a radio level setting
rig | The rig handle | |
vfo | The target VFO | |
level | The level setting | |
val | The value to set the level setting to |
set the current memory channel number
Sets the current memory channel number. It is not mandatory for the radio to be in memory mode. Actually it depends on rigs. YMMV.
int rig_set_mem_all | ( | RIG * | rig, | |
const channel_t | chans[], | |||
const struct confparams | cfgps[], | |||
const value_t | vals[] | |||
) |
set all channel and non-channel data
Writes the data associated with all the memory channels, and rigs memory parameters.
int rig_set_mem_all_cb | ( | RIG * | rig, | |
chan_cb_t | chan_cb, | |||
confval_cb_t | parm_cb, | |||
char * | arg | |||
) |
set all channel and non-channel data by call-back
rig | The rig handle | |
chan_cb | The callback for channel data | |
parm_cb | The callback for non-channel(aka parm) data | |
arg | Cookie passed to chan_cb and parm_cb |
set the mode of the target VFO
rig | The rig handle | |
vfo | The target VFO | |
mode | The mode to set to | |
width | The passband width to set to |
int rig_set_mode_callback | ( | RIG * | rig, | |
mode_cb_t | cb, | |||
char * | arg | |||
) |
set the callback for mode events
rig | The rig handle | |
cb | The callback to install | |
arg | A Pointer to some private data to pass later on to the callback |
set a radio parameter
Sets a parameter. The parameter value val can be a float or an integer. See value_t for more information.
int rig_set_pltune_callback | ( | RIG * | rig, | |
pltune_cb_t | cb, | |||
char * | arg | |||
) |
set the callback for pipelined tuning module
rig | The rig handle | |
cb | The callback to install | |
arg | A Pointer to some private data to pass later on to the callback used to maintain state during pipelined tuning. |
int rig_set_powerstat | ( | RIG * | rig, | |
powerstat_t | status | |||
) |
turn on/off the radio
turns on/off the radio. See RIG_POWER_ON, RIG_POWER_OFF and RIG_POWER_STANDBY defines for the status.
set PTT on/off
Sets "Push-To-Talk" on/off.
int rig_set_ptt_callback | ( | RIG * | rig, | |
ptt_cb_t | cb, | |||
char * | arg | |||
) |
set the callback for ptt events
rig | The rig handle | |
cb | The callback to install | |
arg | A Pointer to some private data to pass later on to the callback |
int rig_set_rit | ( | RIG * | rig, | |
vfo_t | vfo, | |||
shortfreq_t | rit | |||
) |
set the RIT
Sets the current RIT offset. A value of 0 for rit disables RIT.
int rig_set_rptr_offs | ( | RIG * | rig, | |
vfo_t | vfo, | |||
shortfreq_t | rptr_offs | |||
) |
set the repeater offset
Sets the current repeater offset.
int rig_set_rptr_shift | ( | RIG * | rig, | |
vfo_t | vfo, | |||
rptr_shift_t | rptr_shift | |||
) |
set the repeater shift
Sets the current repeater shift.
set the split frequencies
Sets the split(TX) frequency.
set the split modes
rig | The rig handle | |
vfo | The target VFO | |
tx_mode | The transmit split mode to set to | |
tx_width | The transmit split width to set to |
set the split mode
rig | The rig handle | |
vfo | The target VFO | |
split | The split mode to set to | |
tx_vfo | The transmit VFO |
int rig_set_trn | ( | RIG * | rig, | |
int | trn | |||
) |
control the transceive mode
Enable/disable the transceive handling of a rig and kick off async mode.
int rig_set_ts | ( | RIG * | rig, | |
vfo_t | vfo, | |||
shortfreq_t | ts | |||
) |
set the Tuning Step
Sets the Tuning Step.
set the current VFO
Sets the current VFO. The VFO can be RIG_VFO_A, RIG_VFO_B, RIG_VFO_C for VFOA, VFOB, VFOC respectively or RIG_VFO_MEM for Memory mode. Supported VFOs depends on rig capabilities.
int rig_set_vfo_callback | ( | RIG * | rig, | |
vfo_cb_t | cb, | |||
char * | arg | |||
) |
set the callback for vfo events
rig | The rig handle | |
cb | The callback to install | |
arg | A Pointer to some private data to pass later on to the callback |
int rig_set_xit | ( | RIG * | rig, | |
vfo_t | vfo, | |||
shortfreq_t | xit | |||
) |
set the XIT
Sets the current XIT offset. A value of 0 for xit disables XIT.
int rig_setting2idx | ( | setting_t | s | ) |
basically convert setting_t expressed 2^n to n
s | The setting to convert to |
const char* rig_strfunc | ( | setting_t | func | ) |
Convert enum RIG_FUNC_... to alpha string.
func | RIG_FUNC_... |
const char* rig_strlevel | ( | setting_t | level | ) |
Convert enum RIG_LEVEL_... to alpha string.
level | RIG_LEVEL_... |
const char* rig_strparm | ( | setting_t | parm | ) |
Convert enum RIG_PARM_... to alpha string.
parm | RIG_PARM_... |
const char* rig_strptrshift | ( | rptr_shift_t | shift | ) |
convert enum RIG_RPT_SHIFT_... to printable character
shift | RIG_RPT_SHIFT_?? |
const char* rig_strrmode | ( | rmode_t | mode | ) |
Convert enum RIG_MODE to alpha string.
mode | RIG_MODE_... |
const char* rig_strscan | ( | scan_t | rscan | ) |
Convert enum RIG_SCAN_... to alpha string.
rscan | RIG_SCAN_... |
const char* rig_strstatus | ( | enum rig_status_e | status | ) |
Convert enum RIG_STATUS_... to printable string.
status | RIG_STATUS_?? |
const char* rig_strvfo | ( | vfo_t | vfo | ) |
Convert enum RIG_VFO_... to alpha string.
vfo | RIG_VFO_... |
const char* rig_strvfop | ( | vfo_op_t | op | ) |
Convert enum RIG_OP_... to alpha string.
op | RIG_OP_... |
int rig_token_foreach | ( | RIG * | rig, | |
int(*)(const struct confparams *, char *) | cfunc, | |||
char * | data | |||
) |
call a function against each configuration token of a rig
rig | The rig handle | |
cfunc | The function to perform on each token | |
data | Any data to be passed to cfunc |
perform Memory/VFO operations
Performs Memory/VFO operation. See vfo_op_t for more information.
const char* rigerror | ( | int | errnum | ) |
get string describing the error code
errnum | The error code |
const tone_t common_ctcss_list[] = { 670, 693, 719, 744, 770, 797, 825, 854, 885, 915, 948, 974, 1000, 1035, 1072, 1109, 1148, 1188, 1230, 1273, 1318, 1365, 1413, 1462, 1514, 1567, 1598, 1622, 1655, 1679, 1713, 1738, 1773, 1799, 1835, 1862, 1899, 1928, 1966, 1995, 2035, 2065, 2107, 2181, 2257, 2291, 2336, 2418, 2503, 2541, 0, } |
50 CTCSS sub-audible tones, from 67.0Hz to 254.1Hz
const tone_t full_ctcss_list[] = { 600, 670, 693, 719, 744, 770, 797, 825, 854, 885, 915, 948, 974, 1000, 1035, 1072, 1109, 1148, 1188, 1200, 1230, 1273, 1318, 1365, 1413, 1462, 1514, 1567, 1598, 1622, 1655, 1679, 1713, 1738, 1773, 1799, 1835, 1862, 1899, 1928, 1966, 1995, 2035, 2065, 2107, 2181, 2257, 2291, 2336, 2418, 2503, 2541, 0, } |
52 CTCSS sub-audible tones
const tone_t full_dcs_list[] = { 17, 23, 25, 26, 31, 32, 36, 43, 47, 50, 51, 53, 54, 65, 71, 72, 73, 74, 114, 115, 116, 122, 125, 131, 132, 134, 143, 145, 152, 155, 156, 162, 165, 172, 174, 205, 212, 223, 225, 226, 243, 244, 245, 246, 251, 252, 255, 261, 263, 265, 266, 271, 274, 306, 311, 315, 325, 331, 332, 343, 346, 351, 356, 364, 365, 371, 411, 412, 413, 423, 431, 432, 445, 446, 452, 454, 455, 462, 464, 465, 466, 503, 506, 516, 523, 526, 532, 546, 565, 606, 612, 624, 627, 631, 632, 654, 662, 664, 703, 712, 723, 731, 732, 734, 743, 754, 0, } |
106 DCS codes
Hamlib documentation for version 1.2.7 -- Tue Aug 26 21:43:29 2008
Project page: http://hamlib.org