Hamlib  3.3
Data Structures | Macros | Typedefs | Enumerations | Functions | Variables
rig.h File Reference

Hamlib rig data structures. More...

#include <stdio.h>
#include <stdarg.h>
#include <hamlib/riglist.h>
#include <hamlib/rig_dll.h>

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   512
 
#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_PASSBAND_NOCHANGE   s_Hz(-1)
 
#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
 Tranceive mode. More...
 
#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))
 power unit macros More...
 
#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,. More...
 
typedef signed long shortfreq_t
 Short frequency type. More...
 
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 *)
 

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 code definition that can be returned by the Hamlib functions. Unless stated otherwise, Hamlib functions return the negative value of rig_errcode_e definitions in case of error, or 0 when successful. 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, RIG_PORT_UDP_NETWORK, RIG_PORT_CM108,
  RIG_PORT_GPIO, RIG_PORT_GPION
}
 Port type. More...
 
enum  serial_parity_e {
  RIG_PARITY_NONE = 0, RIG_PARITY_ODD, RIG_PARITY_EVEN, RIG_PARITY_MARK,
  RIG_PARITY_SPACE
}
 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
}
 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, RIG_DCD_CM108
}
 DCD type. More...
 
enum  ptt_t { RIG_PTT_OFF = 0, RIG_PTT_ON, RIG_PTT_ON_MIC, RIG_PTT_ON_DATA }
 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, RIG_PTT_RIG_MICDATA, RIG_PTT_CM108, RIG_PTT_GPIO,
  RIG_PTT_GPION
}
 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_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_STOP = (1 << 7)
}
 Rig Scan operation. More...
 
enum  rig_conf_e {
  RIG_CONF_STRING, RIG_CONF_COMBO, RIG_CONF_NUMERIC, RIG_CONF_CHECKBUTTON,
  RIG_CONF_BUTTON
}
 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_OFF = 0, RIG_AGC_SUPERFAST, RIG_AGC_FAST, RIG_AGC_SLOW,
  RIG_AGC_USER, RIG_AGC_MEDIUM, RIG_AGC_AUTO
}
 AGC delay settings. More...
 
enum  meter_level_e {
  RIG_METER_NONE = 0, RIG_METER_SWR = (1 << 0), RIG_METER_COMP = (1 << 1), RIG_METER_ALC = (1 << 2),
  RIG_METER_IC = (1 << 3), RIG_METER_DB = (1 << 4), RIG_METER_PO = (1 << 5), RIG_METER_VDD = (1 << 6)
}
 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_BKIN_DLYMS = (1 << 25),
  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  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), RIG_MODE_FMN = (1 << 21), RIG_MODE_PKTAM = (1 << 22), RIG_MODE_TESTS_MAX
}
 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, RIG_MTYPE_BAND, RIG_MTYPE_PRIO
}
 Memory channel type definition. More...
 

Functions

RIG *HAMLIB_API rig_init ()
 
int HAMLIB_API rig_open ()
 
int HAMLIB_API rig_set_freq ()
 
int HAMLIB_API rig_get_freq ()
 
int HAMLIB_API rig_set_mode ()
 
int HAMLIB_API rig_get_mode ()
 
int HAMLIB_API rig_set_vfo ()
 
int HAMLIB_API rig_get_vfo ()
 
int HAMLIB_API rig_set_ptt ()
 
int HAMLIB_API rig_get_ptt ()
 
int HAMLIB_API rig_get_dcd ()
 
int HAMLIB_API rig_set_rptr_shift ()
 
int HAMLIB_API rig_get_rptr_shift ()
 
int HAMLIB_API rig_set_rptr_offs ()
 
int HAMLIB_API rig_get_rptr_offs ()
 
int HAMLIB_API rig_set_ctcss_tone ()
 
int HAMLIB_API rig_get_ctcss_tone ()
 
int HAMLIB_API rig_set_dcs_code ()
 
int HAMLIB_API rig_get_dcs_code ()
 
int HAMLIB_API rig_set_ctcss_sql ()
 
int HAMLIB_API rig_get_ctcss_sql ()
 
int HAMLIB_API rig_set_dcs_sql ()
 
int HAMLIB_API rig_get_dcs_sql ()
 
int HAMLIB_API rig_set_split_freq ()
 
int HAMLIB_API rig_get_split_freq ()
 
int HAMLIB_API rig_set_split_mode ()
 
int HAMLIB_API rig_get_split_mode ()
 
int HAMLIB_API rig_set_split_freq_mode ()
 
int HAMLIB_API rig_get_split_freq_mode ()
 
int HAMLIB_API rig_set_split_vfo ()
 
int HAMLIB_API rig_get_split_vfo ()
 
int HAMLIB_API rig_set_rit ()
 
int HAMLIB_API rig_get_rit ()
 
int HAMLIB_API rig_set_xit ()
 
int HAMLIB_API rig_get_xit ()
 
int HAMLIB_API rig_set_ts ()
 
int HAMLIB_API rig_get_ts ()
 
int HAMLIB_API rig_power2mW ()
 
int HAMLIB_API rig_mW2power ()
 
shortfreq_t HAMLIB_API rig_get_resolution ()
 
int HAMLIB_API rig_set_level ()
 
int HAMLIB_API rig_get_level ()
 
int HAMLIB_API rig_set_parm ()
 
int HAMLIB_API rig_get_parm ()
 
int HAMLIB_API rig_set_conf ()
 
int HAMLIB_API rig_get_conf ()
 
int HAMLIB_API rig_set_powerstat ()
 
int HAMLIB_API rig_get_powerstat ()
 
int HAMLIB_API rig_reset ()
 
int HAMLIB_API rig_set_ext_level ()
 
int HAMLIB_API rig_get_ext_level ()
 
int HAMLIB_API rig_set_ext_parm ()
 
int HAMLIB_API rig_get_ext_parm ()
 
int HAMLIB_API rig_ext_level_foreach ()
 
int HAMLIB_API rig_ext_parm_foreach ()
 
const struct confparams *HAMLIB_API rig_ext_lookup ()
 
const struct confparams *HAMLIB_API rig_ext_lookup_tok ()
 
token_t HAMLIB_API rig_ext_token_lookup ()
 
int HAMLIB_API rig_token_foreach ()
 
const struct confparams *HAMLIB_API rig_confparam_lookup ()
 
token_t HAMLIB_API rig_token_lookup ()
 
int HAMLIB_API rig_close ()
 
int HAMLIB_API rig_cleanup ()
 
int HAMLIB_API rig_set_ant ()
 
int HAMLIB_API rig_get_ant ()
 
setting_t HAMLIB_API rig_has_get_level ()
 
setting_t HAMLIB_API rig_has_set_level ()
 
setting_t HAMLIB_API rig_has_get_parm ()
 
setting_t HAMLIB_API rig_has_set_parm ()
 
setting_t HAMLIB_API rig_has_get_func ()
 
setting_t HAMLIB_API rig_has_set_func ()
 
int HAMLIB_API rig_set_func ()
 
int HAMLIB_API rig_get_func ()
 
int HAMLIB_API rig_send_dtmf ()
 
int HAMLIB_API rig_recv_dtmf ()
 
int HAMLIB_API rig_send_morse ()
 
int HAMLIB_API rig_set_bank ()
 
int HAMLIB_API rig_set_mem ()
 
int HAMLIB_API rig_get_mem ()
 
int HAMLIB_API rig_vfo_op ()
 
vfo_op_t HAMLIB_API rig_has_vfo_op ()
 
int HAMLIB_API rig_scan ()
 
scan_t HAMLIB_API rig_has_scan ()
 
int HAMLIB_API rig_set_channel ()
 
int HAMLIB_API rig_get_channel ()
 
int HAMLIB_API rig_set_chan_all ()
 
int HAMLIB_API rig_get_chan_all ()
 
int HAMLIB_API rig_set_chan_all_cb ()
 
int HAMLIB_API rig_get_chan_all_cb ()
 
int HAMLIB_API rig_set_mem_all_cb ()
 
int HAMLIB_API rig_get_mem_all_cb ()
 
int HAMLIB_API rig_set_mem_all ()
 
int HAMLIB_API rig_get_mem_all ()
 
const chan_t *HAMLIB_API rig_lookup_mem_caps ()
 
int HAMLIB_API rig_mem_count ()
 
int HAMLIB_API rig_set_trn ()
 
int HAMLIB_API rig_get_trn ()
 
int HAMLIB_API rig_set_freq_callback ()
 
int HAMLIB_API rig_set_mode_callback ()
 
int HAMLIB_API rig_set_vfo_callback ()
 
int HAMLIB_API rig_set_ptt_callback ()
 
int HAMLIB_API rig_set_dcd_callback ()
 
int HAMLIB_API rig_set_pltune_callback ()
 
const char *HAMLIB_API rig_get_info ()
 
const struct rig_caps *HAMLIB_API rig_get_caps ()
 
const freq_range_t *HAMLIB_API rig_get_range ()
 
pbwidth_t HAMLIB_API rig_passband_normal ()
 
pbwidth_t HAMLIB_API rig_passband_narrow ()
 
pbwidth_t HAMLIB_API rig_passband_wide ()
 
const char *HAMLIB_API rigerror ()
 
int HAMLIB_API rig_setting2idx ()
 
void HAMLIB_API rig_set_debug ()
 
void HAMLIB_API rig_set_debug_time_stamp ()
 
int HAMLIB_API rig_need_debug ()
 
void HAMLIB_API rig_debug ()
 
vprintf_cb_t HAMLIB_API rig_set_debug_callback ()
 
FILE *HAMLIB_API rig_set_debug_file ()
 
int HAMLIB_API rig_register ()
 
int HAMLIB_API rig_unregister ()
 
int HAMLIB_API rig_list_foreach ()
 
int HAMLIB_API rig_load_backend ()
 
int HAMLIB_API rig_check_backend ()
 
int HAMLIB_API rig_load_all_backends ()
 
int HAMLIB_API rig_probe_all ()
 
rig_model_t HAMLIB_API rig_probe ()
 
const char *HAMLIB_API rig_strrmode (rmode_t mode)
 Convert enum RIG_MODE to alpha string. More...
 
const char *HAMLIB_API rig_strvfo (vfo_t vfo)
 Convert enum RIG_VFO_... to alpha string. More...
 
const char *HAMLIB_API rig_strfunc (setting_t)
 Convert enum RIG_FUNC_... to alpha string. More...
 
const char *HAMLIB_API rig_strlevel (setting_t)
 Convert enum RIG_LEVEL_... to alpha string. More...
 
const char *HAMLIB_API rig_strparm (setting_t)
 Convert enum RIG_PARM_... to alpha string. More...
 
const char *HAMLIB_API rig_strptrshift (rptr_shift_t)
 convert enum RIG_RPT_SHIFT_... to printable character More...
 
const char *HAMLIB_API rig_strvfop (vfo_op_t op)
 Convert enum RIG_OP_... to alpha string. More...
 
const char *HAMLIB_API rig_strscan (scan_t scan)
 Convert enum RIG_SCAN_... to alpha string. More...
 
const char *HAMLIB_API rig_strstatus (enum rig_status_e status)
 Convert enum RIG_STATUS_... to printable string. More...
 
const char *HAMLIB_API rig_strmtype (chan_type_t mtype)
 Convert enum RIG_MTYPE_... to alpha string. More...
 
rmode_t HAMLIB_API rig_parse_mode (const char *s)
 Convert alpha string to enum RIG_MODE. More...
 
vfo_t HAMLIB_API rig_parse_vfo (const char *s)
 Convert alpha string to enum RIG_VFO_... More...
 
setting_t HAMLIB_API rig_parse_func (const char *s)
 Convert alpha string to enum RIG_FUNC_... More...
 
setting_t HAMLIB_API rig_parse_level (const char *s)
 Convert alpha string to enum RIG_LEVEL_... More...
 
setting_t HAMLIB_API rig_parse_parm (const char *s)
 Convert alpha string to RIG_PARM_... More...
 
vfo_op_t HAMLIB_API rig_parse_vfo_op (const char *s)
 Convert alpha string to enum RIG_OP_... More...
 
scan_t HAMLIB_API rig_parse_scan (const char *s)
 Convert alpha string to enum RIG_SCAN_... More...
 
rptr_shift_t HAMLIB_API rig_parse_rptr_shift (const char *s)
 Convert alpha char to enum RIG_RPT_SHIFT_... More...
 
chan_type_t HAMLIB_API rig_parse_mtype (const char *s)
 Convert alpha string to enum RIG_MTYPE_... More...
 
const char * rig_license ()
 
const char * rig_version ()
 
const char * rig_copyright ()
 
void HAMLIB_API rig_no_restore_ai ()
 

Variables

const char hamlib_version []
 
const char hamlib_copyright []
 
const char * hamlib_version2
 
const char * hamlib_copyright2
 Hamlib copyright notice.
 

Detailed Description

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.


Generated by doxygen 1.8.17

Hamlib documentation for version 3.3 -- Wed Jan 29 2020 00:00:00
Project page: http://www.hamlib.org