Hamlib  4.5.5
Data Fields
rig_state Struct Reference

Rig state containing live data and customized fields. More...

#include <rig.h>

Data Fields

hamlib_port_t_deprecated rigport_deprecated
 
hamlib_port_t_deprecated pttport_deprecated
 
hamlib_port_t_deprecated dcdport_deprecated
 
double vfo_comp
 
int deprecated_itu_region
 
freq_range_t rx_range_list [HAMLIB_FRQRANGESIZ]
 
freq_range_t tx_range_list [HAMLIB_FRQRANGESIZ]
 
struct tuning_step_list tuning_steps [HAMLIB_TSLSTSIZ]
 
struct filter_list filters [HAMLIB_FLTLSTSIZ]
 
cal_table_t str_cal
 
chan_t chan_list [HAMLIB_CHANLSTSIZ]
 
shortfreq_t max_rit
 
shortfreq_t max_xit
 
shortfreq_t max_ifshift
 
ann_t announces
 
int preamp [HAMLIB_MAXDBLSTSIZ]
 
int attenuator [HAMLIB_MAXDBLSTSIZ]
 
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 [64]
 
gran_t parm_gran [64]
 
int transaction_active
 
vfo_t current_vfo
 
int vfo_list
 
int comm_state
 
rig_ptr_t priv
 
rig_ptr_t obj
 
int async_data_enabled
 
int poll_interval
 
freq_t current_freq
 
rmode_t current_mode
 
pbwidth_t current_width
 
vfo_t tx_vfo
 
rmode_t mode_list
 
int transmit
 
freq_t lo_freq
 
time_t twiddle_time
 
int twiddle_timeout
 
int uplink
 
struct rig_cache cache
 
int vfo_opt
 
int auto_power_on
 
int auto_power_off
 
int auto_disable_screensaver
 
int ptt_share
 
int power_now
 
int power_min
 
int power_max
 
unsigned char disable_yaesu_bandselect
 
int twiddle_rit
 
int twiddle_state
 
vfo_t rx_vfo
 
volatile unsigned int snapshot_packet_sequence_number
 
volatile int multicast_publisher_run
 
void * multicast_publisher_priv_data
 
volatile int async_data_handler_thread_run
 
void * async_data_handler_priv_data
 
volatile int poll_routine_thread_run
 
void * poll_routine_priv_data
 
pthread_mutex_t mutex_set_transaction
 
hamlib_port_t rigport
 
hamlib_port_t pttport
 
hamlib_port_t dcdport
 
int use_cached_freq
 
int use_cached_mode
 
int use_cached_ptt
 
int depth
 
int lock_mode
 
powerstat_t powerstat
 

Detailed Description

Rig state containing live data and customized fields.

This struct contains live data, as well as a copy of capability fields that may be updated (ie. customized)

It is NOT fine to move fields around as it can break share library offset As of 2021-03-03 vfo_list is the last known item being reference externally So any additions or changes to this structure must be at the end of the structure

Field Documentation

ann_t rig_state::announces

Announces bit field list

int rig_state::async_data_enabled

Whether async data mode is enabled

int rig_state::attenuator[HAMLIB_MAXDBLSTSIZ]

Preamp list in dB, 0 terminated

int rig_state::auto_disable_screensaver

Allow Hamlib to disable the rig's screen saver automatically if supported

int rig_state::auto_power_off

Allow Hamlib to power off rig automatically if supported

int rig_state::auto_power_on

Allow Hamlib to power on rig automatically if supported

chan_t rig_state::chan_list[HAMLIB_CHANLSTSIZ]

Channel list, zero ended

int rig_state::comm_state

Comm port state, opened/closed.

freq_t rig_state::current_freq

Frequency currently set

rmode_t rig_state::current_mode

Mode currently set

vfo_t rig_state::current_vfo

VFO currently set

pbwidth_t rig_state::current_width

Passband width currently set

hamlib_port_t rig_state::dcdport

DCD port (internal use).

hamlib_port_t_deprecated rig_state::dcdport_deprecated

DCD port (internal use).

int rig_state::deprecated_itu_region

ITU region to select among freq_range_t

unsigned char rig_state::disable_yaesu_bandselect

Disables Yaesu band select logic

struct filter_list rig_state::filters[HAMLIB_FLTLSTSIZ]

Mode/filter table, at -6dB

setting_t rig_state::has_get_func

List of get functions

setting_t rig_state::has_get_level

List of get level

setting_t rig_state::has_get_parm

List of get parm

setting_t rig_state::has_set_func

List of set functions

setting_t rig_state::has_set_level

List of set level

setting_t rig_state::has_set_parm

List of set parm

gran_t rig_state::level_gran[64]

level granularity

freq_t rig_state::lo_freq

Local oscillator frequency of any transverter

shortfreq_t rig_state::max_ifshift

max absolute IF-SHIFT

shortfreq_t rig_state::max_rit

max absolute RIT

shortfreq_t rig_state::max_xit

max absolute XIT

rmode_t rig_state::mode_list

Complete list of modes for this rig

rig_ptr_t rig_state::obj

Internal use by hamlib++ for event handling.

gran_t rig_state::parm_gran[64]

parm granularity

int rig_state::poll_interval

Rig state polling period in milliseconds

int rig_state::power_max

Maximum RF power level in rig units

int rig_state::power_min

Minimum RF power level in rig units

int rig_state::power_now

Current RF power level in rig units

int rig_state::preamp[HAMLIB_MAXDBLSTSIZ]

Preamp list in dB, 0 terminated

rig_ptr_t rig_state::priv

Pointer to private rig state data.

int rig_state::ptt_share

Share ptt port by open/close during get_ptt, set_ptt hogs the port while active

hamlib_port_t rig_state::pttport

PTT port (internal use).

hamlib_port_t_deprecated rig_state::pttport_deprecated

PTT port (internal use).

hamlib_port_t rig_state::rigport

Rig port (internal use).

hamlib_port_t_deprecated rig_state::rigport_deprecated

Rig port (internal use).

freq_range_t rig_state::rx_range_list[HAMLIB_FRQRANGESIZ]

Receive frequency range list

vfo_t rig_state::rx_vfo

Rx VFO currently set

cal_table_t rig_state::str_cal

S-meter calibration table

int rig_state::transaction_active

set to 1 to inform the async reader thread that a synchronous command transaction is waiting for a response, otherwise 0

int rig_state::transmit

rig should be transmitting i.e. hard wired PTT asserted - used by rigs that don't do CAT while in Tx

struct tuning_step_list rig_state::tuning_steps[HAMLIB_TSLSTSIZ]

Tuning step list

int rig_state::twiddle_rit

Suppresses VFOB reading (cached value used) so RIT control can be used

int rig_state::twiddle_state

keeps track of twiddle status

time_t rig_state::twiddle_time

time when vfo twiddling was detected

int rig_state::twiddle_timeout

timeout to resume from twiddling

freq_range_t rig_state::tx_range_list[HAMLIB_FRQRANGESIZ]

Transmit frequency range list

vfo_t rig_state::tx_vfo

Tx VFO currently set

int rig_state::uplink

uplink=1 will not read Sub, uplink=2 will not read Main

double rig_state::vfo_comp

VFO compensation in PPM, 0.0 to disable

int rig_state::vfo_list

Complete list of VFO for this rig

int rig_state::vfo_opt

Is -o switch turned on?


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