rig_state.h

Go to the documentation of this file.

/*
 *  Hamlib Interface - Rig state structure
 *  Copyright (c) 2000-2025 The Hamlib Group
 *  Copyright (c) 2025 George Baltz
 *
 *
 *   This library is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU Lesser General Public
 *   License as published by the Free Software Foundation; either
 *   version 2.1 of the License, or (at your option) any later version.
 *
 *   This library is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *   Lesser General Public License for more details.
 *
 *   You should have received a copy of the GNU Lesser General Public
 *   License along with this library; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */
/* SPDX-License-Identifier: LGPL-2.1-or-later */
 
#ifndef _RIG_STATE_H
#define _RIG_STATE_H 1
 
//#include <hamlib/rig.h>
//#include <pthread.h>
 
__BEGIN_DECLS


 
/* Forward declarations
 *
 * Structures pointed to by rig_state and defined elsewhere
 */
struct FIFO_RIG_s;  /* Defined in src/fifo.h */

struct rig_state {
    /********* ENSURE ANY NEW ITEMS ARE ADDED AT BOTTOM OF THIS STRUCTURE *********/
    /*
     * overridable fields
     */
    // moving the hamlib_port_t to the end of rig_state and making it a pointer
    // this should allow changes to hamlib_port_t without breaking shared libraries
    // these will maintain a copy of the new port_t for backwards compatibility
    // to these offsets -- note these must stay until a major version update is done like 5.0
    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[RIG_SETTING_MAX]; 
    gran_t parm_gran[RIG_SETTING_MAX];  
 
 
    /*
     * non overridable fields, internal use
     */
 
    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;       
    //rmode_t current_modeB;      /*!< Mode currently set VFOB */
    pbwidth_t current_width;    
    vfo_t tx_vfo;               
    rmode_t mode_list;              
    // mode_list is used by some
    // so anything added to this structure must be below here
    int transmit;               
    freq_t lo_freq;             
    time_t twiddle_time;        
    int twiddle_timeout;        
    // uplink allows gpredict to behave better by no reading the uplink VFO
    int uplink;                 
    HL_DEPRECATED
    struct rig_cache_deprecated 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;  
    /********* DO NOT ADD or CHANGE anything (or than to rename) ABOVE THIS LINE *********/
    /********* ENSURE ANY NEW ITEMS ARE ADDED AFTER HERE *********/
    /* flags instructing the rig_get routines to use cached values when asyncio is in use */
    int use_cached_freq; 
    int use_cached_mode; 
    int use_cached_ptt;  
    int depth; 
    int lock_mode; 
    powerstat_t powerstat; 
    char *tuner_control_pathname;  
    char client_version[32];  
    freq_t offset_vfoa; 
    freq_t offset_vfob; 
    struct multicast_s *multicast; 
    // Adding a number of items so netrigctl can see the real rig information
    // Eventually may want to add these so that rigctld can see more of the backend
    // But that will come later if requested -- for now they just fill out dumpstate.c
    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;                  
    int targetable_vfo;         
    int async_data_supported;       
    int agc_level_count; 
    enum agc_level_e agc_levels[HAMLIB_MAX_AGC_LEVELS]; 
    tone_t *ctcss_list;   
    tone_t *dcs_list;     
    vfo_op_t vfo_ops;           
    scan_t scan_ops;            
    int transceive;             
    int bank_qty;               
    int chan_desc_sz;           
    freq_range_t rx_range_list1[HAMLIB_FRQRANGESIZ];   
    freq_range_t tx_range_list1[HAMLIB_FRQRANGESIZ];   
    freq_range_t rx_range_list2[HAMLIB_FRQRANGESIZ];   
    freq_range_t tx_range_list2[HAMLIB_FRQRANGESIZ];   
    freq_range_t rx_range_list3[HAMLIB_FRQRANGESIZ];   
    freq_range_t tx_range_list3[HAMLIB_FRQRANGESIZ];   
    freq_range_t rx_range_list4[HAMLIB_FRQRANGESIZ];   
    freq_range_t tx_range_list4[HAMLIB_FRQRANGESIZ];   
    freq_range_t rx_range_list5[HAMLIB_FRQRANGESIZ];   
    freq_range_t tx_range_list5[HAMLIB_FRQRANGESIZ];   
    struct rig_spectrum_scope spectrum_scopes[HAMLIB_MAX_SPECTRUM_SCOPES]; 
    enum rig_spectrum_mode_e spectrum_modes[HAMLIB_MAX_SPECTRUM_MODES]; 
    freq_t spectrum_spans[HAMLIB_MAX_SPECTRUM_SPANS];                   
    struct rig_spectrum_avg_mode spectrum_avg_modes[HAMLIB_MAX_SPECTRUM_AVG_MODES]; 
    int spectrum_attenuator[HAMLIB_MAXDBLSTSIZ];    
    volatile int morse_data_handler_thread_run;   
    void *morse_data_handler_priv_data;           
    struct FIFO_RIG_s *fifo_morse;                
    int doppler;         
    char *multicast_data_addr;  
    int multicast_data_port;  
    char *multicast_cmd_addr;  
    int multicast_cmd_port;  
    volatile int multicast_receiver_run;    
    void *multicast_receiver_priv_data;     
    rig_comm_status_t comm_status;          
    char device_id[HAMLIB_RIGNAMSIZ];       
    int dual_watch;         
    int post_ptt_delay;     
    struct timespec freq_event_elapsed;     
    int freq_skip; 
    client_t client;        
    pthread_mutex_t api_mutex;      
// New rig_state items go before this line ============================================
};
 
//---Start cut here---
struct rig_state_deprecated {
    /********* ENSURE YOU DO NOT EVER MODIFY THIS STRUCTURE *********/
    /********* It will remain forever to provide DLL backwards compatibility ******/
    /*
     * overridable fields
     */
    // moving the hamlib_port_t to the end of rig_state and making it a pointer
    // this should allow changes to hamlib_port_t without breaking shared libraries
    // these will maintain a copy of the new port_t for backwards compatibility
    // to these offsets -- note these must stay until a major version update is done like 5.0
    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[RIG_SETTING_MAX]; 
    gran_t parm_gran[RIG_SETTING_MAX];  
 
 
    /*
     * non overridable fields, internal use
     */
 
    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;       
    //rmode_t current_modeB;      /*!< Mode currently set VFOB */
    pbwidth_t current_width;    
    vfo_t tx_vfo;               
    rmode_t mode_list;              
    // mode_list is used by some
    // so anything added to this structure must be below here
    int transmit;               
    freq_t lo_freq;             
    time_t twiddle_time;        
    int twiddle_timeout;        
    // uplink allows gpredict to behave better by no reading the uplink VFO
    int uplink;                 
    struct rig_cache_deprecated 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;  
    /********* DO NOT ADD or CHANGE anything (or than to rename) ABOVE THIS LINE *********/
    /********* ENSURE ANY NEW ITEMS ARE ADDED AFTER HERE *********/
    /* flags instructing the rig_get routines to use cached values when asyncio is in use */
    int use_cached_freq; 
    int use_cached_mode; 
    int use_cached_ptt;  
    int depth; 
    int lock_mode; 
    powerstat_t powerstat; 
    char *tuner_control_pathname;  
    char client_version[32];  
    freq_t offset_vfoa; 
    freq_t offset_vfob; 
    struct multicast_s *multicast; 
};
//---End cut here---
 
#if defined(IN_HAMLIB)
#define STATE(r) (&(r)->state)
#endif
#define HAMLIB_STATE(r) ((struct rig_state *)rig_data_pointer(r, RIG_PTRX_STATE))
 
__END_DECLS
 
#endif /* _RIG_STATE_H */