Hamlib  3.3
Data Fields
rot_caps Struct Reference

Rotator data structure. More...

#include <rotator.h>

Data Fields

rot_model_t rot_model
 
const char * model_name
 
const char * mfg_name
 
const char * version
 
const char * copyright
 
enum rig_status_e status
 
int rot_type
 
enum rig_port_e 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
 
azimuth_t min_az
 
azimuth_t max_az
 
elevation_t min_el
 
elevation_t max_el
 
const struct confparamscfgparams
 
const char * priv
 
int(* rot_init )(ROT *rot)
 
int(* rot_cleanup )(ROT *rot)
 
int(* rot_open )(ROT *rot)
 
int(* rot_close )(ROT *rot)
 
int(* set_conf )(ROT *rot, token_t token, const char *val)
 
int(* get_conf )(ROT *rot, token_t token, char *val)
 
int(* set_position )(ROT *rot, azimuth_t azimuth, elevation_t elevation)
 
int(* get_position )(ROT *rot, azimuth_t *azimuth, elevation_t *elevation)
 
int(* stop )(ROT *rot)
 
int(* park )(ROT *rot)
 
int(* reset )(ROT *rot, rot_reset_t reset)
 
int(* move )(ROT *rot, int direction, int speed)
 
const char *(* get_info )(ROT *rot)
 

Detailed Description

Rotator data structure.

Rotator Caps

The main idea of this struct is that it will be defined by the backend rotator driver, and will remain readonly for the application. Fields that need to be modifiable by the application are copied into the struct rot_state, which is a kind of private of the ROT instance.

This way, you can have several rigs running within the same application, sharing the struct rot_caps of the backend, while keeping their own customized data.

n.b.: Don't move fields around, as the backends depend on it when initializing their caps.

Field Documentation

◆ cfgparams

const struct confparams* rot_caps::cfgparams

Configuration parametres.

◆ copyright

const char* rot_caps::copyright

Copyright info.

◆ max_az

azimuth_t rot_caps::max_az

Upper limit for azimuth (relative to North).

◆ max_el

elevation_t rot_caps::max_el

Upper limit for elevation.

◆ mfg_name

const char* rot_caps::mfg_name

Manufacturer.

◆ min_az

azimuth_t rot_caps::min_az

Lower limit for azimuth (relative to North).

◆ min_el

elevation_t rot_caps::min_el

Lower limit for elevation.

◆ model_name

const char* rot_caps::model_name

Model name.

◆ port_type

enum rig_port_e rot_caps::port_type

Type of communication port.

◆ post_write_delay

int rot_caps::post_write_delay

Post-write delay.

◆ priv

const char* rot_caps::priv

Private data.

◆ retry

int rot_caps::retry

Number of retry if command fails.

◆ rot_model

rot_model_t rot_caps::rot_model

Rotator model.

◆ rot_type

int rot_caps::rot_type

Rotator type.

◆ serial_data_bits

int rot_caps::serial_data_bits

Number of data bits.

◆ serial_handshake

enum serial_handshake_e rot_caps::serial_handshake

Handshake.

◆ serial_parity

enum serial_parity_e rot_caps::serial_parity

Parity.

◆ serial_rate_max

int rot_caps::serial_rate_max

Maximal serial speed.

◆ serial_rate_min

int rot_caps::serial_rate_min

Minimal serial speed.

◆ serial_stop_bits

int rot_caps::serial_stop_bits

Number of stop bits.

◆ status

enum rig_status_e rot_caps::status

Driver status.

◆ timeout

int rot_caps::timeout

Timeout.

◆ version

const char* rot_caps::version

Driver version.

◆ write_delay

int rot_caps::write_delay

Write delay.


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

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