Hamlib  3.3
Data Structures | Macros | Typedefs | Enumerations | Functions
rotator.h File Reference

Hamlib rotator data structures. More...

#include <hamlib/rig.h>
#include <hamlib/rotlist.h>

Go to the source code of this file.

Data Structures

struct  rot_caps
 Rotator data structure. More...
 
struct  rot_state
 Live data and customized fields. More...
 
struct  rot
 This is the master data structure, acting as a handle for the controlled rotator. More...
 

Macros

#define NETROTCTL_RET   "RPRT "
 Token in the netrotctl protocol for returning error code.
 
#define ROT_RESET_ALL   1
 A macro that returns the flag for the reset operation. More...
 
#define ROT_TYPE_MASK   (ROT_FLAG_AZIMUTH|ROT_FLAG_ELEVATION)
 
#define ROT_TYPE_OTHER   0
 
#define ROT_TYPE_AZIMUTH   ROT_FLAG_AZIMUTH
 
#define ROT_TYPE_ELEVATION   ROT_FLAG_ELEVATION
 
#define ROT_TYPE_AZEL   (ROT_FLAG_AZIMUTH|ROT_FLAG_ELEVATION)
 
#define ROT_MOVE_UP   (1<<1)
 A macro that returns the flag for the UP direction. More...
 
#define ROT_MOVE_DOWN   (1<<2)
 A macro that returns the flag for the DOWN direction. More...
 
#define ROT_MOVE_LEFT   (1<<3)
 A macro that returns the flag for the LEFT direction. More...
 
#define ROT_MOVE_CCW   ROT_MOVE_LEFT
 A macro that returns the flag for the counterclockwise direction. More...
 
#define ROT_MOVE_RIGHT   (1<<4)
 A macro that returns the flag for the RIGHT direction. More...
 
#define ROT_MOVE_CW   ROT_MOVE_RIGHT
 A macro that returns the flag for the clockwise direction. More...
 
#define rot_debug   rig_debug
 Convenience definition for debug level. More...
 

Typedefs

typedef struct rot ROT
 Rotator structure definition (see rot for details).
 
typedef float elevation_t
 Type definition for elevation. More...
 
typedef float azimuth_t
 Type definition for azimuth. More...
 
typedef int rot_reset_t
 Type definition for rotator reset. More...
 

Enumerations

enum  rot_type_t { ROT_FLAG_AZIMUTH = (1 << 1), ROT_FLAG_ELEVATION = (1 << 2) }
 Rotator type flags. More...
 

Functions

ROT *HAMLIB_API rot_init ()
 
int HAMLIB_API rot_open ()
 
int HAMLIB_API rot_close ()
 
int HAMLIB_API rot_cleanup ()
 
int HAMLIB_API rot_set_conf ()
 
int HAMLIB_API rot_get_conf ()
 
int HAMLIB_API rot_set_position ()
 
int HAMLIB_API rot_get_position ()
 
int HAMLIB_API rot_stop ()
 
int HAMLIB_API rot_park ()
 
int HAMLIB_API rot_reset ()
 
int HAMLIB_API rot_move ()
 
const char *HAMLIB_API rot_get_info ()
 
int HAMLIB_API rot_register ()
 
int HAMLIB_API rot_unregister ()
 
int HAMLIB_API rot_list_foreach ()
 
int HAMLIB_API rot_load_backend ()
 
int HAMLIB_API rot_check_backend ()
 
int HAMLIB_API rot_load_all_backends ()
 
rot_model_t HAMLIB_API rot_probe_all ()
 
int HAMLIB_API rot_token_foreach ()
 
const struct confparams *HAMLIB_API rot_confparam_lookup ()
 
token_t HAMLIB_API rot_token_lookup ()
 
const struct rot_caps *HAMLIB_API rot_get_caps ()
 
int HAMLIB_API qrb ()
 
double HAMLIB_API distance_long_path ()
 
double HAMLIB_API azimuth_long_path ()
 
int HAMLIB_API longlat2locator ()
 
int HAMLIB_API locator2longlat ()
 
double HAMLIB_API dms2dec ()
 
int HAMLIB_API dec2dms ()
 
int HAMLIB_API dec2dmmm ()
 
double HAMLIB_API dmmm2dec ()
 

Detailed Description

Hamlib rotator data structures.

This file contains the data structures and declarations for the Hamlib rotator API. see the rotator.c file for more details on the rotator API.


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