Hamlib
3.0.1
|
Hamlib rig data structures. More...
Go to the source code of this file.
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 |
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... | |
Macros | |
#define | __BEGIN_DECLS /* empty */ |
#define | __END_DECLS /* empty */ |
#define | HAMLIB_PARAMS(protos) () |
#define | rig_ptr_t char* |
#define | NETRIGCTL_RET "RPRT " |
Token in the netrigctl protocol for returning error code. | |
#define | RIGNAMSIZ 30 |
#define | RIGVERSIZ 8 |
#define | FILPATHLEN 100 |
#define | FRQRANGESIZ 30 |
#define | MAXCHANDESC 30 /* describe channel eg: "WWV 5Mhz" */ |
#define | TSLSTSIZ 20 /* max tuning step list size, zero ended */ |
#define | FLTLSTSIZ 60 /* max mode/filter list size, zero ended */ |
#define | MAXDBLSTSIZ 8 /* max preamp/att levels supported, zero ended */ |
#define | CHANLSTSIZ 16 /* max mem_list size, zero ended */ |
#define | MAX_CAL_LENGTH 32 /* max calibration plots in cal_table_t */ |
#define | RIG_FLAG_TRANSCEIVER (RIG_FLAG_RECEIVER|RIG_FLAG_TRANSMITTER) |
#define | RIG_TYPE_MASK (RIG_FLAG_TRANSCEIVER|RIG_FLAG_SCANNER|RIG_FLAG_MOBILE|RIG_FLAG_HANDHELD|RIG_FLAG_COMPUTER|RIG_FLAG_TRUNKING|RIG_FLAG_TUNER) |
#define | RIG_TYPE_OTHER 0 |
#define | RIG_TYPE_TRANSCEIVER RIG_FLAG_TRANSCEIVER |
#define | RIG_TYPE_HANDHELD (RIG_FLAG_TRANSCEIVER|RIG_FLAG_HANDHELD) |
#define | RIG_TYPE_MOBILE (RIG_FLAG_TRANSCEIVER|RIG_FLAG_MOBILE) |
#define | RIG_TYPE_RECEIVER RIG_FLAG_RECEIVER |
#define | RIG_TYPE_PCRECEIVER (RIG_FLAG_COMPUTER|RIG_FLAG_RECEIVER) |
#define | RIG_TYPE_SCANNER (RIG_FLAG_SCANNER|RIG_FLAG_RECEIVER) |
#define | RIG_TYPE_TRUNKSCANNER (RIG_TYPE_SCANNER|RIG_FLAG_TRUNKING) |
#define | RIG_TYPE_COMPUTER (RIG_FLAG_TRANSCEIVER|RIG_FLAG_COMPUTER) |
#define | RIG_TYPE_TUNER RIG_FLAG_TUNER |
#define | RIG_STATUS_NEW RIG_STATUS_UNTESTED |
Map all deprecated RIG_STATUS_NEW references to RIG_STATUS_UNTESTED for backward compatibility. | |
#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 | FREQFMT SCNfreq |
#define | Hz(f) ((freq_t)(f)) |
#define | kHz(f) ((freq_t)((f)*(freq_t)1000)) |
#define | MHz(f) ((freq_t)((f)*(freq_t)1000000)) |
#define | GHz(f) ((freq_t)((f)*(freq_t)1000000000)) |
#define | s_Hz(f) ((shortfreq_t)(f)) |
#define | s_kHz(f) ((shortfreq_t)((f)*(shortfreq_t)1000)) |
#define | s_MHz(f) ((shortfreq_t)((f)*(shortfreq_t)1000000)) |
#define | s_GHz(f) ((shortfreq_t)((f)*(shortfreq_t)1000000000)) |
#define | RIG_FREQ_NONE Hz(0) |
#define | RIG_VFO_NONE 0 |
'' – used in caps | |
#define | RIG_VFO_TX_FLAG (1<<30) |
#define | RIG_VFO_CURR (1<<29) |
currVFO – current "tunable channel"/VFO | |
#define | RIG_VFO_MEM (1<<28) |
MEM – means Memory mode, to be used with set_vfo | |
#define | RIG_VFO_VFO (1<<27) |
VFO – means (last or any)VFO mode, with set_vfo | |
#define | RIG_VFO_TX_VFO(v) ((v)|RIG_VFO_TX_FLAG) |
#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 (1<<26) |
Main – alias for MAIN | |
#define | RIG_VFO_SUB (1<<25) |
Sub – alias for SUB | |
#define | RIG_VFO_N(n) (1<<(n)) |
#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_TARGETABLE_NONE 0 |
#define | RIG_TARGETABLE_FREQ (1<<0) |
#define | RIG_TARGETABLE_MODE (1<<1) |
#define | RIG_TARGETABLE_PURE (1<<2) |
#define | RIG_TARGETABLE_TONE (1<<3) |
#define | RIG_TARGETABLE_FUNC (1<<4) |
#define | RIG_TARGETABLE_ALL 0x7fffffff |
#define | RIG_PASSBAND_NORMAL s_Hz(0) |
#define | RIG_CONF_END 0 |
#define | RIG_COMBO_MAX 8 |
#define | RIG_ANT_NONE 0 |
#define | RIG_ANT_N(n) ((ant_t)1<<(n)) |
#define | RIG_ANT_1 RIG_ANT_N(0) |
#define | RIG_ANT_2 RIG_ANT_N(1) |
#define | RIG_ANT_3 RIG_ANT_N(2) |
#define | RIG_ANT_4 RIG_ANT_N(3) |
#define | RIG_ANT_5 RIG_ANT_N(4) |
#define | RIG_LEVEL_FLOAT_LIST (RIG_LEVEL_AF|RIG_LEVEL_RF|RIG_LEVEL_SQL|RIG_LEVEL_APF|RIG_LEVEL_NR|RIG_LEVEL_PBT_IN|RIG_LEVEL_PBT_OUT|RIG_LEVEL_RFPOWER|RIG_LEVEL_MICGAIN|RIG_LEVEL_COMP|RIG_LEVEL_BALANCE|RIG_LEVEL_SWR|RIG_LEVEL_ALC|RIG_LEVEL_VOXGAIN|RIG_LEVEL_ANTIVOX) |
#define | RIG_LEVEL_READONLY_LIST (RIG_LEVEL_SQLSTAT|RIG_LEVEL_SWR|RIG_LEVEL_ALC|RIG_LEVEL_STRENGTH|RIG_LEVEL_RAWSTR) |
#define | RIG_LEVEL_IS_FLOAT(l) ((l)&RIG_LEVEL_FLOAT_LIST) |
#define | RIG_LEVEL_SET(l) ((l)&~RIG_LEVEL_READONLY_LIST) |
#define | RIG_PARM_FLOAT_LIST (RIG_PARM_BACKLIGHT|RIG_PARM_BAT) |
#define | RIG_PARM_READONLY_LIST (RIG_PARM_BAT) |
#define | RIG_PARM_IS_FLOAT(l) ((l)&RIG_PARM_FLOAT_LIST) |
#define | RIG_PARM_SET(l) ((l)&~RIG_PARM_READONLY_LIST) |
#define | RIG_SETTING_MAX 32 |
#define | RIG_TRN_OFF 0 |
#define | RIG_TRN_RIG 1 |
#define | RIG_TRN_POLL 2 |
#define | RIG_FUNC_NONE 0 |
Rig Function Settings. More... | |
#define | RIG_FUNC_FAGC (1UL<<0) |
#define | RIG_FUNC_NB (1UL<<1) |
#define | RIG_FUNC_COMP (1UL<<2) |
#define | RIG_FUNC_VOX (1UL<<3) |
#define | RIG_FUNC_TONE (1UL<<4) |
#define | RIG_FUNC_TSQL (1UL<<5) |
#define | RIG_FUNC_SBKIN (1UL<<6) |
#define | RIG_FUNC_FBKIN (1UL<<7) |
#define | RIG_FUNC_ANF (1UL<<8) |
#define | RIG_FUNC_NR (1UL<<9) |
#define | RIG_FUNC_AIP (1UL<<10) |
#define | RIG_FUNC_APF (1UL<<11) |
#define | RIG_FUNC_MON (1UL<<12) |
#define | RIG_FUNC_MN (1UL<<13) |
#define | RIG_FUNC_RF (1UL<<14) |
#define | RIG_FUNC_ARO (1UL<<15) |
#define | RIG_FUNC_LOCK (1UL<<16) |
#define | RIG_FUNC_MUTE (1UL<<17) |
#define | RIG_FUNC_VSC (1UL<<18) |
#define | RIG_FUNC_REV (1UL<<19) |
#define | RIG_FUNC_SQL (1UL<<20) |
#define | RIG_FUNC_ABM (1UL<<21) |
#define | RIG_FUNC_BC (1UL<<22) |
#define | RIG_FUNC_MBC (1UL<<23) |
#define | RIG_FUNC_RIT (1UL<<24) |
#define | RIG_FUNC_AFC (1UL<<25) |
#define | RIG_FUNC_SATMODE (1UL<<26) |
#define | RIG_FUNC_SCOPE (1UL<<27) |
#define | RIG_FUNC_RESUME (1UL<<28) |
#define | RIG_FUNC_TBURST (1UL<<29) |
#define | RIG_FUNC_TUNER (1UL<<30) |
#define | RIG_FUNC_XIT (1UL<<31) |
#define | mW(p) ((int)(p)) |
#define | Watts(p) ((int)((p)*1000)) |
#define | W(p) Watts(p) |
#define | kW(p) ((int)((p)*1000000L)) |
#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. | |
#define | RIG_DBLST_END 0 /* end marker in a preamp/att level list */ |
#define | RIG_IS_DBLST_END(d) ((d)==0) |
#define | RIG_FRNG_END {Hz(0),Hz(0),RIG_MODE_NONE,0,0,RIG_VFO_NONE} |
#define | RIG_IS_FRNG_END(r) ((r).start == Hz(0) && (r).end == Hz(0)) |
#define | RIG_ITU_REGION1 1 |
#define | RIG_ITU_REGION2 2 |
#define | RIG_ITU_REGION3 3 |
#define | RIG_TS_ANY 0 |
#define | RIG_TS_END {RIG_MODE_NONE,0} |
#define | RIG_IS_TS_END(t) ((t).modes == RIG_MODE_NONE && (t).ts == 0) |
#define | RIG_FLT_ANY 0 |
#define | RIG_FLT_END {RIG_MODE_NONE,0} |
#define | RIG_IS_FLT_END(f) ((f).modes == RIG_MODE_NONE) |
#define | RIG_CHFLAG_NONE 0 |
Empty channel_t.flags field. | |
#define | RIG_CHFLAG_SKIP (1<<0) |
skip memory channel during scan (lock out), channel_t.flags | |
#define | RIG_CHFLAG_DATA (1<<1) |
DATA port mode flag. | |
#define | RIG_EXT_END {0, {.i=0}} |
#define | RIG_IS_EXT_END(x) ((x).token == 0) |
#define | RIG_CHAN_END {0,0,RIG_MTYPE_NONE} |
#define | RIG_IS_CHAN_END(c) ((c).type == RIG_MTYPE_NONE) |
#define | RIG_MEM_CAPS_ALL -1 |
Special memory channel value to tell rig_lookup_mem_caps() to retrieve all the ranges. | |
#define | EMPTY_STR_CAL { 0, { { 0, 0 }, } } |
#define | rig_set_split(r, v, s) rig_set_split_vfo((r),(v),(s),RIG_VFO_CURR) |
#define | rig_get_split(r, v, s) ({ vfo_t _tx_vfo; rig_get_split_vfo((r),(v),(s),&_tx_vfo); }) |
#define | rig_get_strength(r, v, s) rig_get_level((r),(v),RIG_LEVEL_STRENGTH, (value_t*)(s)) |
#define | rig_idx2setting(i) (1UL<<(i)) |
#define | rig_set_debug_level(level) rig_set_debug(level) |
Typedefs | |
typedef struct rig | RIG |
Rig structure definition (see rig for details). | |
typedef unsigned int | tone_t |
CTCSS and DCS type definition. More... | |
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. More... | |
typedef shortfreq_t | pbwidth_t |
Passband width, in Hz. More... | |
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. More... | |
typedef struct freq_range_list | freq_range_t |
Frequency range. More... | |
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 More... | |
typedef int(* | chan_cb_t )(RIG *, channel_t **, int, const chan_t *, char *) |
typedef int(* | confval_cb_t )(RIG *, const struct confparams *, value_t *, char *) |
typedef struct hamlib_port | hamlib_port_t |
Port definition. More... | |
typedef hamlib_port_t | port_t |
typedef int(* | vprintf_cb_t )(enum rig_debug_level_e, char *, const char *, va_list) |
typedef int(* | freq_cb_t )(RIG *, vfo_t, freq_t, char *) |
typedef int(* | mode_cb_t )(RIG *, vfo_t, rmode_t, pbwidth_t, char *) |
typedef int(* | vfo_cb_t )(RIG *, vfo_t, char *) |
typedef int(* | ptt_cb_t )(RIG *, vfo_t, ptt_t, char *) |
typedef int(* | dcd_cb_t )(RIG *, vfo_t, dcd_t, char *) |
typedef int(* | pltune_cb_t )(RIG *, vfo_t, freq_t *, rmode_t *, pbwidth_t *, char *) |
typedef int(* | rig_probe_func_t )(const hamlib_port_t *, rig_model_t, char *) |
Functions | |
RIG * | rig_init () |
int | rig_open () |
int | rig_set_freq () |
int | rig_get_freq () |
int | rig_set_mode () |
int | rig_get_mode () |
int | rig_set_vfo () |
int | rig_get_vfo () |
int | rig_set_ptt () |
int | rig_get_ptt () |
int | rig_get_dcd () |
int | rig_set_rptr_shift () |
int | rig_get_rptr_shift () |
int | rig_set_rptr_offs () |
int | rig_get_rptr_offs () |
int | rig_set_ctcss_tone () |
int | rig_get_ctcss_tone () |
int | rig_set_dcs_code () |
int | rig_get_dcs_code () |
int | rig_set_ctcss_sql () |
int | rig_get_ctcss_sql () |
int | rig_set_dcs_sql () |
int | rig_get_dcs_sql () |
int | rig_set_split_freq () |
int | rig_get_split_freq () |
int | rig_set_split_mode () |
int | rig_get_split_mode () |
int | rig_set_split_vfo () |
int | rig_get_split_vfo () |
int | rig_set_rit () |
int | rig_get_rit () |
int | rig_set_xit () |
int | rig_get_xit () |
int | rig_set_ts () |
int | rig_get_ts () |
int | rig_power2mW () |
int | rig_mW2power () |
shortfreq_t | rig_get_resolution () |
int | rig_set_level () |
int | rig_get_level () |
int | rig_set_parm () |
int | rig_get_parm () |
int | rig_set_conf () |
int | rig_get_conf () |
int | rig_set_powerstat () |
int | rig_get_powerstat () |
int | rig_reset () |
int | rig_set_ext_level () |
int | rig_get_ext_level () |
int | rig_set_ext_parm () |
int | rig_get_ext_parm () |
int | rig_ext_level_foreach () |
int | rig_ext_parm_foreach () |
const struct confparams * | rig_ext_lookup () |
const struct confparams * | rig_ext_lookup_tok () |
token_t | rig_ext_token_lookup () |
int | rig_token_foreach () |
const struct confparams * | rig_confparam_lookup () |
token_t | rig_token_lookup () |
int | rig_close () |
int | rig_cleanup () |
int | rig_set_ant () |
int | rig_get_ant () |
setting_t | rig_has_get_level () |
setting_t | rig_has_set_level () |
setting_t | rig_has_get_parm () |
setting_t | rig_has_set_parm () |
setting_t | rig_has_get_func () |
setting_t | rig_has_set_func () |
int | rig_set_func () |
int | rig_get_func () |
int | rig_send_dtmf () |
int | rig_recv_dtmf () |
int | rig_send_morse () |
int | rig_set_bank () |
int | rig_set_mem () |
int | rig_get_mem () |
int | rig_vfo_op () |
vfo_op_t | rig_has_vfo_op () |
int | rig_scan () |
scan_t | rig_has_scan () |
int | rig_set_channel () |
int | rig_get_channel () |
int | rig_set_chan_all () |
int | rig_get_chan_all () |
int | rig_set_chan_all_cb () |
int | rig_get_chan_all_cb () |
int | rig_set_mem_all_cb () |
int | rig_get_mem_all_cb () |
int | rig_set_mem_all () |
int | rig_get_mem_all () |
const chan_t * | rig_lookup_mem_caps () |
int | rig_mem_count () |
int | rig_set_trn () |
int | rig_get_trn () |
int | rig_set_freq_callback () |
int | rig_set_mode_callback () |
int | rig_set_vfo_callback () |
int | rig_set_ptt_callback () |
int | rig_set_dcd_callback () |
int | rig_set_pltune_callback () |
const char * | rig_get_info () |
const struct rig_caps * | rig_get_caps () |
const freq_range_t * | rig_get_range () |
pbwidth_t | rig_passband_normal () |
pbwidth_t | rig_passband_narrow () |
pbwidth_t | rig_passband_wide () |
const char * | rigerror () |
int | rig_setting2idx () |
void | rig_set_debug () |
int | rig_need_debug () |
void | rig_debug () |
vprintf_cb_t | rig_set_debug_callback () |
FILE * | rig_set_debug_file () |
int | rig_register () |
int | rig_unregister () |
int | rig_list_foreach () |
int | rig_load_backend () |
int | rig_check_backend () |
int | rig_load_all_backends () |
int | rig_probe_all () |
rig_model_t | rig_probe () |
const char * | rig_strrmode (rmode_t mode) |
Convert enum RIG_MODE to alpha string. More... | |
const char * | rig_strvfo (vfo_t vfo) |
Convert enum RIG_VFO_... to alpha string. More... | |
const char * | rig_strfunc (setting_t) |
Convert enum RIG_FUNC_... to alpha string. More... | |
const char * | rig_strlevel (setting_t) |
Convert enum RIG_LEVEL_... to alpha string. More... | |
const char * | rig_strparm (setting_t) |
Convert enum RIG_PARM_... to alpha string. More... | |
const char * | rig_strptrshift (rptr_shift_t) |
convert enum RIG_RPT_SHIFT_... to printable character More... | |
const char * | rig_strvfop (vfo_op_t op) |
Convert enum RIG_OP_... to alpha string. More... | |
const char * | rig_strscan (scan_t scan) |
Convert enum RIG_SCAN_... to alpha string. More... | |
const char * | rig_strstatus (enum rig_status_e status) |
Convert enum RIG_STATUS_... to printable string. More... | |
const char * | rig_strmtype (chan_type_t mtype) |
Convert enum RIG_MTYPE_... to alpha string. More... | |
rmode_t | rig_parse_mode (const char *s) |
Convert alpha string to enum RIG_MODE. More... | |
vfo_t | rig_parse_vfo (const char *s) |
Convert alpha string to enum RIG_VFO_... More... | |
setting_t | rig_parse_func (const char *s) |
Convert alpha string to enum RIG_FUNC_... More... | |
setting_t | rig_parse_level (const char *s) |
Convert alpha string to enum RIG_LEVEL_... More... | |
setting_t | rig_parse_parm (const char *s) |
Convert alpha string to RIG_PARM_... More... | |
vfo_op_t | rig_parse_vfo_op (const char *s) |
Convert alpha string to enum RIG_OP_... More... | |
scan_t | rig_parse_scan (const char *s) |
Convert alpha string to enum RIG_SCAN_... More... | |
rptr_shift_t | rig_parse_rptr_shift (const char *s) |
Convert alpha char to enum RIG_RPT_SHIFT_... More... | |
chan_type_t | rig_parse_mtype (const char *s) |
Convert alpha string to enum RIG_MTYPE_... More... | |
Variables | |
const char | hamlib_version [] |
Hamlib release number The version number has the format x.y.z. | |
const char | hamlib_copyright [] |
Hamlib copyright notice. | |
Hamlib rig data structures.
This file contains the data structures and definitions for the Hamlib rig API. see the rig.c file for more details on the rig API.
Hamlib documentation for version 3.0.1 -- Wed Jan 13 2016 15:05:23
Project page: http://www.hamlib.org