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

Hamlib rotator data structures. More...

#include <hamlib/rig.h>
#include <hamlib/rotlist.h>
Include dependency graph for rotator.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  rot_state
 Live data and customized fields. More...
 
struct  s_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_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_STATUS_N(n)   (1u<<(n))
 
#define ROT_SPEED_NOCHANGE   (-1)
 Macro for not changing the rotator speed with move() function.
 
#define ROT_FUNC_NONE   0
 Rotator Function Settings. More...
 
#define ROT_FUNC_BIT63   CONSTANT_64BIT_FLAG (63)
 
#define rot_debug   rig_debug
 Convenience definition for debug level. More...
 

Typedefs

typedef struct s_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_status_t {
  ROT_STATUS_NONE = 0 , ROT_STATUS_BUSY = (1 << 0) , ROT_STATUS_MOVING = (1 << 1) , ROT_STATUS_MOVING_AZ = (1 << 2) ,
  ROT_STATUS_MOVING_LEFT = (1 << 3) , ROT_STATUS_MOVING_RIGHT = (1 << 4) , ROT_STATUS_MOVING_EL = (1 << 5) , ROT_STATUS_MOVING_UP = (1 << 6) ,
  ROT_STATUS_MOVING_DOWN = (1 << 7) , ROT_STATUS_LIMIT_UP = (1 << 8) , ROT_STATUS_LIMIT_DOWN = (1 << 9) , ROT_STATUS_LIMIT_LEFT = (1 << 10) ,
  ROT_STATUS_LIMIT_RIGHT = (1 << 11) , ROT_STATUS_OVERLAP_UP = (1 << 12) , ROT_STATUS_OVERLAP_DOWN = (1 << 13) , ROT_STATUS_OVERLAP_LEFT = (1 << 14) ,
  ROT_STATUS_OVERLAP_RIGHT = (1 << 16)
}
 Rotator status flags. More...
 
enum  rot_level_e { ROT_LEVEL_NONE = 0 , ROT_LEVEL_SPEED = (1 << 0) , ROT_LEVEL_63 = CONSTANT_64BIT_FLAG(63) }
 Rotator Level Settings. More...
 
enum  rot_parm_e { ROT_PARM_NONE = 0 }
 Rotator Parameters. More...
 

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.9.1

Hamlib documentation for version 4.1 -- Mon Feb 1 2021 08:00:28
Project page: http://www.hamlib.org