Hamlib  4.3
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Modules Pages
Data Fields
rig_state Struct Reference

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

#include <rig.h>

Collaboration diagram for rig_state:
Collaboration graph
[legend]

Data Fields

hamlib_port_t rigport
 
hamlib_port_t pttport
 
hamlib_port_t dcdport
 
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 hold_decode
 
vfo_t current_vfo
 
int vfo_list
 
int comm_state
 
rig_ptr_t priv
 
rig_ptr_t obj
 
int transceive
 
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
 

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 after vfo_list.

Field Documentation

◆ announces

ann_t rig_state::announces

Announces bit field list

◆ attenuator

int rig_state::attenuator[HAMLIB_MAXDBLSTSIZ]

Preamp list in dB, 0 terminated

◆ auto_disable_screensaver

int rig_state::auto_disable_screensaver

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

◆ auto_power_off

int rig_state::auto_power_off

Allow Hamlib to power off rig automatically if supported

◆ auto_power_on

int rig_state::auto_power_on

Allow Hamlib to power on rig automatically if supported

◆ chan_list

chan_t rig_state::chan_list[HAMLIB_CHANLSTSIZ]

Channel list, zero ended

◆ comm_state

int rig_state::comm_state

Comm port state, opened/closed.

◆ current_freq

freq_t rig_state::current_freq

Frequency currently set

◆ current_mode

rmode_t rig_state::current_mode

Mode currently set

◆ current_vfo

vfo_t rig_state::current_vfo

VFO currently set

◆ current_width

pbwidth_t rig_state::current_width

Passband width currently set

◆ dcdport

hamlib_port_t rig_state::dcdport

DCD port (internal use).

◆ deprecated_itu_region

int rig_state::deprecated_itu_region

ITU region to select among freq_range_t

◆ disable_yaesu_bandselect

unsigned char rig_state::disable_yaesu_bandselect

Disables Yaeus band select logic

◆ filters

struct filter_list rig_state::filters[HAMLIB_FLTLSTSIZ]

Mode/filter table, at -6dB

◆ has_get_func

setting_t rig_state::has_get_func

List of get functions

◆ has_get_level

setting_t rig_state::has_get_level

List of get level

◆ has_get_parm

setting_t rig_state::has_get_parm

List of get parm

◆ has_set_func

setting_t rig_state::has_set_func

List of set functions

◆ has_set_level

setting_t rig_state::has_set_level

List of set level

◆ has_set_parm

setting_t rig_state::has_set_parm

List of set parm

◆ hold_decode

int rig_state::hold_decode

set to 1 to hold the event decoder (async) otherwise 0

◆ level_gran

gran_t rig_state::level_gran[64]

level granularity

◆ lo_freq

freq_t rig_state::lo_freq

Local oscillator frequency of any transverter

◆ max_ifshift

shortfreq_t rig_state::max_ifshift

max absolute IF-SHIFT

◆ max_rit

shortfreq_t rig_state::max_rit

max absolute RIT

◆ max_xit

shortfreq_t rig_state::max_xit

max absolute XIT

◆ mode_list

rmode_t rig_state::mode_list

Complete list of modes for this rig

◆ obj

rig_ptr_t rig_state::obj

Internal use by hamlib++ for event handling.

◆ parm_gran

gran_t rig_state::parm_gran[64]

parm granularity

◆ poll_interval

int rig_state::poll_interval

Event notification polling period in milliseconds

◆ power_max

int rig_state::power_max

Maximum RF power level in rig units

◆ power_min

int rig_state::power_min

Minimum RF power level in rig units

◆ power_now

int rig_state::power_now

Current RF power level in rig units

◆ preamp

int rig_state::preamp[HAMLIB_MAXDBLSTSIZ]

Preamp list in dB, 0 terminated

◆ priv

rig_ptr_t rig_state::priv

Pointer to private rig state data.

◆ ptt_share

int rig_state::ptt_share

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

◆ pttport

hamlib_port_t rig_state::pttport

PTT port (internal use).

◆ rigport

hamlib_port_t rig_state::rigport

Rig port (internal use).

◆ rx_range_list

freq_range_t rig_state::rx_range_list[HAMLIB_FRQRANGESIZ]

Receive frequency range list

◆ str_cal

cal_table_t rig_state::str_cal

S-meter calibration table

◆ transceive

int rig_state::transceive

Whether the transceive mode is on

◆ transmit

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

◆ tuning_steps

struct tuning_step_list rig_state::tuning_steps[HAMLIB_TSLSTSIZ]

Tuning step list

◆ twiddle_rit

int rig_state::twiddle_rit

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

◆ twiddle_state

int rig_state::twiddle_state

keeps track of twiddle status

◆ twiddle_time

time_t rig_state::twiddle_time

time when vfo twiddling was detected

◆ twiddle_timeout

int rig_state::twiddle_timeout

timeout to resume from twiddling

◆ tx_range_list

freq_range_t rig_state::tx_range_list[HAMLIB_FRQRANGESIZ]

Transmit frequency range list

◆ tx_vfo

vfo_t rig_state::tx_vfo

Tx VFO currently set

◆ uplink

int rig_state::uplink

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

◆ vfo_comp

double rig_state::vfo_comp

VFO compensation in PPM, 0.0 to disable

◆ vfo_list

int rig_state::vfo_list

Complete list of VFO for this rig

◆ vfo_opt

int rig_state::vfo_opt

Is -o switch turned on?


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