rig_caps Struct Reference
[Rig (transceiver) API]

Rig data structure. More...

#include <rig.h>


Data Fields

rig_model_t rig_model
const char * model_name
const char * mfg_name
const char * version
const char * copyright
enum rig_status_e status
int rig_type
ptt_type_t ptt_type
dcd_type_t dcd_type
rig_port_t port_type
int serial_rate_min
int serial_rate_max
int serial_data_bits
int serial_stop_bits
enum serial_parity_e serial_parity
enum serial_handshake_e serial_handshake
int write_delay
int post_write_delay
int timeout
int retry
setting_t has_get_func
setting_t has_set_func
setting_t has_get_level
setting_t has_set_level
setting_t has_get_parm
setting_t has_set_parm
gran_t level_gran [32]
gran_t parm_gran [32]
struct confparamsextparms
struct confparamsextlevels
const tone_tctcss_list
const tone_tdcs_list
int preamp [8]
int attenuator [8]
shortfreq_t max_rit
shortfreq_t max_xit
shortfreq_t max_ifshift
ann_t announces
vfo_op_t vfo_ops
scan_t scan_ops
int targetable_vfo
int transceive
int bank_qty
int chan_desc_sz
chan_t chan_list [16]
freq_range_t rx_range_list1 [30]
freq_range_t tx_range_list1 [30]
freq_range_t rx_range_list2 [30]
freq_range_t tx_range_list2 [30]
struct tuning_step_list tuning_steps [20]
struct filter_list filters [42]
cal_table_t str_cal
struct confparamscfgparams
const char * priv
const char * clone_combo_set
const char * clone_combo_get


Detailed Description

Rig data structure.

Basic rig type, can store some useful info about different radios. Each lib must be able to populate this structure, so we can make useful inquiries about capabilities.

The main idea of this struct is that it will be defined by the backend rig driver, and will remain readonly for the application. Fields that need to be modifiable by the application are copied into the struct rig_state, which is a kind of private of the RIG instance. This way, you can have several rigs running within the same application, sharing the struct rig_caps of the backend, while keeping their own customized data. NB: don't move fields around, as backend depends on it when initializing their caps.


Field Documentation

Rig model.

const char* rig_caps::model_name

Model name.

const char* rig_caps::mfg_name

Manufacturer.

const char* rig_caps::version

Driver version.

const char* rig_caps::copyright

Copyright info.

Driver status.

Rig type.

Type of the PTT port.

Type of the DCD port.

Type of communication port.

Minimum serial speed.

Maximum serial speed.

Number of data bits.

Number of stop bits.

Parity.

Handshake.

Delay between each byte sent out, in mS

Delay between each commands send out, in mS

Timeout, in mS

Maximum number of retries if command fails, 0 to disable

List of get functions

List of set functions

List of get level

List of set level

List of get parm

List of set parm

level granularity (i.e. steps)

parm granularity (i.e. steps)

Extension parm list,

See also:
ext.c

Extension level list,

See also:
ext.c

CTCSS tones list, zero ended

DCS code list, zero ended

Preamp list in dB, 0 terminated

Preamp list in dB, 0 terminated

max absolute RIT

max absolute XIT

max absolute IF-SHIFT

Announces bit field list

VFO op bit field list

Scan bit field list

Bit field list of direct VFO access commands

Supported transceive mode

Number of banks

Max length of memory channel name

Channel list, zero ended

Receive frequency range list for ITU region 1

Transmit frequency range list for ITU region 1

Receive frequency range list for ITU region 2

Transmit frequency range list for ITU region 2

Tuning step list

struct filter_list rig_caps::filters[42] [read]

mode/filter table, at -6dB

S-meter calibration table

Configuration parametres.

const char* rig_caps::priv

Private data.

String describing key combination to enter load cloning mode

String describing key combination to enter save cloning mode


The documentation for this struct was generated from the following file:

Hamlib documentation for version 1.2.8 -- Mon Dec 15 18:03:30 2008
Project page: http://hamlib.org