Loading...
Searching...
No Matches
rotator.h File Reference
Rotator API

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_caps
| Rotator capability data structure. More...
struct | rot_state
| Rotator state structure. More...
struct | s_rot
| Master rotator structure. More...

## Macros

#define | NETROTCTL_RET "RPRT "
| The token in the netrotctl protocol for returning an error condition code.
#define | ROT_RESET_ALL 1
| A macro that returns the flag for the reset operation.
#define | ROT_TYPE_OTHER 0
| Other type of rotator.
#define | ROT_TYPE_AZIMUTH ROT_FLAG_AZIMUTH
| Azimuth only rotator.
#define | ROT_TYPE_ELEVATION ROT_FLAG_ELEVATION
| Elevation only rotator.
#define | ROT_TYPE_AZEL (ROT_FLAG_AZIMUTH|ROT_FLAG_ELEVATION)
| Combination azimuth/elevation rotator.
#define | ROT_MOVE_UP (1<<1)
| A macro that returns the flag for the UP direction.
#define | ROT_MOVE_DOWN (1<<2)
| A macro that returns the flag for the DOWN direction.
#define | ROT_MOVE_LEFT (1<<3)
| A macro that returns the flag for the LEFT direction.
#define | ROT_MOVE_CCW ROT_MOVE_LEFT
| A macro that returns the flag for the counterclockwise direction.
#define | ROT_MOVE_RIGHT (1<<4)
| A macro that returns the flag for the RIGHT direction.
#define | ROT_MOVE_CW ROT_MOVE_RIGHT
| A macro that returns the flag for the clockwise direction.
#define | ROT_MOVE_UP_LEFT (1<<5)
| A macro that returns the flag for the clockwise direction.
#define | ROT_MOVE_UP_CCW ROT_MOVE_UP_LEFT
| A macro that returns the flag for the clockwise direction.
#define | ROT_MOVE_UP_RIGHT (1<<6)
| A macro that returns the flag for the clockwise direction.
#define | ROT_MOVE_UP_CW ROT_MOVE_UP_RIGHT
| A macro that returns the flag for the clockwise direction.
#define | ROT_MOVE_DOWN_LEFT (1 << 7)
| A macro that returns the flag for the clockwise direction.
#define | ROT_MOVE_DOWN_CCW ROT_MOVE_DOWN_LEFT
| A macro that returns the flag for the clockwise direction.
#define | ROT_MOVE_DOWN_RIGHT (1 << 8)
| A macro that returns the flag for the clockwise direction.
#define | ROT_MOVE_DOWN_CW ROT_MOVE_DOWN_RIGHT
| A macro that returns the flag for the clockwise direction.
#define | HAMLIB_MAX_ROTOR_STATUS 16
#define | ROT_SPEED_NOCHANGE (-1)
| Macro for not changing the rotator speed with move() function.
#define | ROT_FUNC_NONE 0
| Rotator Function Settings.
#define | ROT_FUNC_BIT63 CONSTANT_64BIT_FLAG (63)
#define | rot_debug rig_debug
| Convenience macro for generating debugging messages.

## Typedefs

typedef struct s_rot | ROT
| Main rotator handle type definition.
typedef float | elevation_t
| Type definition for elevation.
typedef float | azimuth_t
| Type definition for azimuth.
typedef int | rot_reset_t
| Type definition for rotator reset.

## Enumerations

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

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 Application Programming Interface (API).

See the rotator.c file for more details on the rotator API functions.