/home/fwph/code/wurde/modules/requiredPTUCode/ptu.h File Reference

Go to the source code of this file.

Defines

#define _UNIX
#define PTU_OK   0
#define PTU_ILLEGAL_COMMAND_ARGUMENT   1
#define PTU_ILLEGAL_COMMAND   2
#define PTU_ILLEGAL_POSITION_ARGUMENT   3
#define PTU_ILLEGAL_SPEED_ARGUMENT   4
#define PTU_ACCEL_TABLE_EXCEEDED   5
#define PTU_DEFAULTS_EEPROM_FAULT   6
#define PTU_SAVED_DEFAULTS_CORRUPTED   7
#define PTU_LIMIT_HIT   8
#define PTU_CABLE_DISCONNECTED   9
#define PTU_ILLEGAL_UNIT_ID   10
#define PTU_ILLEGAL_POWER_MODE   11
#define PTU_RESET_FAILED   12
#define PTU_NOT_RESPONDING   13
#define PTU_FIRMWARE_VERSION_TOO_LOW   14
#define PAN   1
#define TILT   2
#define POSITION   1
#define SPEED   2
#define ACCELERATION   3
#define BASE   4
#define UPPER_SPEED_LIMIT   5
#define LOWER_SPEED_LIMIT   6
#define MINIMUM_POSITION   7
#define MAXIMUM_POSITION   8
#define HOLD_POWER_LEVEL   9
#define MOVE_POWER_LEVEL   10
#define RESOLUTION   11
#define RELATIVE   1
#define ABSOLUTE   2
#define QUERY   NULL
#define PTU_HI_POWER   1
#define PTU_REG_POWER   2
#define PTU_LOW_POWER   3
#define PTU_OFF_POWER   4
#define COMMAND_EXECUTION_MODE   1
#define ASCII_VERBOSE_MODE   2
#define ASCII_ECHO_MODE   3
#define POSITION_LIMITS_MODE   4
#define DEFAULTS   5
#define SPEED_CONTROL_MODE   6
#define EXECUTE_IMMEDIATELY   1
#define EXECUTE_UPON_IMMEDIATE_OR_AWAIT   2
#define VERBOSE   1
#define TERSE   0
#define ON_MODE   1
#define OFF_MODE   0
#define SAVE_CURRENT_SETTINGS   0
#define RESTORE_SAVED_SETTINGS   1
#define RESTORE_FACTORY_SETTINGS   2
#define QUERY_MODE   3
#define ALL   3

Typedefs

typedef short int PTU_PARM_PTR
typedef unsigned short int UID_fd
typedef unsigned char(*) event_handler_fn_ptr_type (unsigned char)

Functions

portstream_fd open_host_port (char *)
char close_host_port (portstream_fd)
char reset_PTU_parser (long)
char set_desired (char, char, PTU_PARM_PTR *, char)
long get_current (char, char)
long get_desired (char, char)
char set_mode (char, char)
char halt (char)
char await_completion (void)
char reset_ptu (void)
char * firmware_version (void)
char select_host_port (portstream_fd)
char select_unit (UID_fd)
char set_unit_id (UID_fd)
unsigned char default_async_event_handler (unsigned char)
unsigned char set_async_event_handler (void(*)(unsigned char))


Define Documentation

#define _UNIX

Definition at line 36 of file ptu.h.

#define ABSOLUTE   2

Definition at line 196 of file ptu.h.

#define ACCELERATION   3

Definition at line 180 of file ptu.h.

#define ALL   3

Definition at line 231 of file ptu.h.

#define ASCII_ECHO_MODE   3

Definition at line 211 of file ptu.h.

#define ASCII_VERBOSE_MODE   2

Definition at line 210 of file ptu.h.

#define BASE   4

Definition at line 181 of file ptu.h.

#define COMMAND_EXECUTION_MODE   1

Definition at line 209 of file ptu.h.

#define DEFAULTS   5

Definition at line 213 of file ptu.h.

#define EXECUTE_IMMEDIATELY   1

Definition at line 216 of file ptu.h.

#define EXECUTE_UPON_IMMEDIATE_OR_AWAIT   2

Definition at line 217 of file ptu.h.

#define HOLD_POWER_LEVEL   9

Definition at line 186 of file ptu.h.

#define LOWER_SPEED_LIMIT   6

Definition at line 183 of file ptu.h.

#define MAXIMUM_POSITION   8

Definition at line 185 of file ptu.h.

#define MINIMUM_POSITION   7

Definition at line 184 of file ptu.h.

#define MOVE_POWER_LEVEL   10

Definition at line 187 of file ptu.h.

#define OFF_MODE   0

Definition at line 223 of file ptu.h.

#define ON_MODE   1

Definition at line 222 of file ptu.h.

#define PAN   1

Definition at line 175 of file ptu.h.

#define POSITION   1

Definition at line 178 of file ptu.h.

#define POSITION_LIMITS_MODE   4

Definition at line 212 of file ptu.h.

#define PTU_ACCEL_TABLE_EXCEEDED   5

Definition at line 60 of file ptu.h.

#define PTU_CABLE_DISCONNECTED   9

Definition at line 64 of file ptu.h.

#define PTU_DEFAULTS_EEPROM_FAULT   6

Definition at line 61 of file ptu.h.

#define PTU_FIRMWARE_VERSION_TOO_LOW   14

Definition at line 69 of file ptu.h.

#define PTU_HI_POWER   1

Definition at line 203 of file ptu.h.

#define PTU_ILLEGAL_COMMAND   2

Definition at line 57 of file ptu.h.

#define PTU_ILLEGAL_COMMAND_ARGUMENT   1

Definition at line 56 of file ptu.h.

#define PTU_ILLEGAL_POSITION_ARGUMENT   3

Definition at line 58 of file ptu.h.

#define PTU_ILLEGAL_POWER_MODE   11

Definition at line 66 of file ptu.h.

#define PTU_ILLEGAL_SPEED_ARGUMENT   4

Definition at line 59 of file ptu.h.

#define PTU_ILLEGAL_UNIT_ID   10

Definition at line 65 of file ptu.h.

#define PTU_LIMIT_HIT   8

Definition at line 63 of file ptu.h.

#define PTU_LOW_POWER   3

Definition at line 205 of file ptu.h.

#define PTU_NOT_RESPONDING   13

Definition at line 68 of file ptu.h.

#define PTU_OFF_POWER   4

Definition at line 206 of file ptu.h.

#define PTU_OK   0

Definition at line 55 of file ptu.h.

#define PTU_REG_POWER   2

Definition at line 204 of file ptu.h.

#define PTU_RESET_FAILED   12

Definition at line 67 of file ptu.h.

#define PTU_SAVED_DEFAULTS_CORRUPTED   7

Definition at line 62 of file ptu.h.

#define QUERY   NULL

Definition at line 200 of file ptu.h.

#define QUERY_MODE   3

Definition at line 229 of file ptu.h.

#define RELATIVE   1

Definition at line 193 of file ptu.h.

#define RESOLUTION   11

Definition at line 188 of file ptu.h.

#define RESTORE_FACTORY_SETTINGS   2

Definition at line 227 of file ptu.h.

#define RESTORE_SAVED_SETTINGS   1

Definition at line 226 of file ptu.h.

#define SAVE_CURRENT_SETTINGS   0

Definition at line 225 of file ptu.h.

#define SPEED   2

Definition at line 179 of file ptu.h.

#define SPEED_CONTROL_MODE   6

Definition at line 214 of file ptu.h.

#define TERSE   0

Definition at line 220 of file ptu.h.

#define TILT   2

Definition at line 176 of file ptu.h.

#define UPPER_SPEED_LIMIT   5

Definition at line 182 of file ptu.h.

#define VERBOSE   1

Definition at line 219 of file ptu.h.


Typedef Documentation

typedef unsigned char(*) event_handler_fn_ptr_type(unsigned char)

Definition at line 160 of file ptu.h.

typedef short int PTU_PARM_PTR

Definition at line 86 of file ptu.h.

typedef unsigned short int UID_fd

Definition at line 145 of file ptu.h.


Function Documentation

char await_completion ( void   ) 

Definition at line 518 of file ptu.cpp.

References AWAIT_COMMAND_COMPLETION, get_binary_command_return_status(), and SerialOut().

char close_host_port ( portstream_fd   ) 

Definition at line 138 of file ptu.cpp.

References closeserial(), current_host_port, and PORT_NOT_OPENED.

unsigned char default_async_event_handler ( unsigned  char  ) 

Definition at line 87 of file ptu.cpp.

References CABLE_DISCONNECT_DETECTED, PAN_LIMIT_HIT, TILT_LIMIT_HIT, and TRUE.

char* firmware_version ( void   ) 

Definition at line 902 of file ptu.cpp.

References current_host_port, do_delay(), FIRMWARE_VERSION_QUERY, ReadSerialLine(), and SerialOut().

long get_current ( char  ,
char   
)

Definition at line 530 of file ptu.cpp.

References ACCELERATION, BASE, current_host_port, err, GetSerialChar(), GetSignedLong(), GetSignedShort(), GetUnsignedShort(), HOLD_POWER_LEVEL, LOWER_SPEED_LIMIT, MAXIMUM_POSITION, MINIMUM_POSITION, MOVE_POWER_LEVEL, PAN, PAN_ACCEL_QUERY, PAN_BASE_SPEED_QUERY, PAN_CURRENT_POS_QUERY, PAN_CURRENT_SPEED_QUERY, PAN_HOLD_POWER_QUERY, PAN_LOWER_SPEED_LIMIT_QUERY, PAN_MAX_POSITION_QUERY, PAN_MIN_POSITION_QUERY, PAN_MOVE_POWER_QUERY, PAN_RESOLUTION_QUERY, PAN_UPPER_SPEED_LIMIT_QUERY, POSITION, PTU_ILLEGAL_COMMAND_ARGUMENT, PTU_INDEPENDENT_SPEED_CONTROL_MODE, RESOLUTION, SerialOut(), SPEED, speed_control_mode, TILT, TILT_ACCEL_QUERY, TILT_BASE_SPEED_QUERY, TILT_CURRENT_POS_QUERY, TILT_CURRENT_SPEED_QUERY, TILT_HOLD_POWER_QUERY, TILT_LOWER_SPEED_LIMIT_QUERY, TILT_MAX_POSITION_QUERY, TILT_MIN_POSITION_QUERY, TILT_MOVE_POWER_QUERY, TILT_RESOLUTION_QUERY, TILT_UPPER_SPEED_LIMIT_QUERY, TRUE, and UPPER_SPEED_LIMIT.

long get_desired ( char  ,
char   
)

Definition at line 661 of file ptu.cpp.

References ACCELERATION, BASE, current_host_port, err, GetSerialChar(), GetSignedLong(), GetSignedShort(), GetUnsignedShort(), HOLD_POWER_LEVEL, LOWER_SPEED_LIMIT, MAXIMUM_POSITION, MINIMUM_POSITION, MOVE_POWER_LEVEL, PAN, PAN_ACCEL_QUERY, PAN_BASE_SPEED_QUERY, PAN_DESIRED_POS_QUERY, PAN_DESIRED_SPEED_QUERY, PAN_HOLD_POWER_QUERY, PAN_LOWER_SPEED_LIMIT_QUERY, PAN_MAX_POSITION_QUERY, PAN_MIN_POSITION_QUERY, PAN_MOVE_POWER_QUERY, PAN_RESOLUTION_QUERY, PAN_UPPER_SPEED_LIMIT_QUERY, POSITION, PTU_ILLEGAL_COMMAND_ARGUMENT, PTU_INDEPENDENT_SPEED_CONTROL_MODE, RESOLUTION, SerialOut(), SPEED, speed_control_mode, TILT, TILT_ACCEL_QUERY, TILT_BASE_SPEED_QUERY, TILT_DESIRED_POS_QUERY, TILT_DESIRED_SPEED_QUERY, TILT_HOLD_POWER_QUERY, TILT_LOWER_SPEED_LIMIT_QUERY, TILT_MAX_POSITION_QUERY, TILT_MIN_POSITION_QUERY, TILT_MOVE_POWER_QUERY, TILT_RESOLUTION_QUERY, TILT_UPPER_SPEED_LIMIT_QUERY, TRUE, and UPPER_SPEED_LIMIT.

char halt ( char   ) 

Definition at line 888 of file ptu.cpp.

References get_binary_command_return_status(), HALT, HALT_PAN, HALT_TILT, PAN, SerialOut(), and TILT.

portstream_fd open_host_port ( char *   ) 

Definition at line 124 of file ptu.cpp.

References current_host_port, do_delay(), openserial(), and SerialBytesOut().

char reset_ptu ( void   ) 

Definition at line 187 of file ptu.cpp.

References GetSerialChar(), PAN_LIMIT_HIT, SerialOut(), TILT_LIMIT_HIT, TRUE, and UNIT_RESET.

char reset_PTU_parser ( long   ) 

Definition at line 266 of file ptu.cpp.

References current_host_port, do_delay(), FALSE, firmware_version_OK(), FlushInputBuffer(), GetSerialChar(), PAN_HOLD_POWER_QUERY, PTU_NOT_RESPONDING, PTU_OFF_POWER, PTU_OK, PTU_REG_POWER, SerialOut(), and TRUE.

char select_host_port ( portstream_fd   ) 

Definition at line 179 of file ptu.cpp.

References current_host_port.

char select_unit ( UID_fd   ) 

Definition at line 915 of file ptu.cpp.

References current_host_port, SerialBytesOut(), and TRUE.

unsigned char set_async_event_handler ( void(*)(unsigned char)   ) 

Definition at line 112 of file ptu.cpp.

References async_event_handler_fn_ptr, and default_async_event_handler().

char set_desired ( char  ,
char  ,
PTU_PARM_PTR ,
char   
)

Definition at line 308 of file ptu.cpp.

References ABSOLUTE, ACCELERATION, BASE, current_host_port, get_binary_command_return_status(), get_current(), HOLD_POWER_LEVEL, LOWER_SPEED_LIMIT, MOVE_POWER_LEVEL, PAN, PAN_SET_ABS_POS, PAN_SET_ABS_SPEED, PAN_SET_ACCEL, PAN_SET_BASE_SPEED, PAN_SET_HOLD_POWER, PAN_SET_LOWER_SPEED_LIMIT, PAN_SET_MOVE_POWER, PAN_SET_REL_POS, PAN_SET_REL_SPEED, PAN_SET_UPPER_SPEED_LIMIT, POSITION, PTU_ILLEGAL_COMMAND_ARGUMENT, PTU_INDEPENDENT_SPEED_CONTROL_MODE, PutSignedLong(), PutSignedShort(), PutUnsignedShort(), RELATIVE, SerialOut(), SPEED, speed_control_mode, TILT, TILT_SET_ABS_POS, TILT_SET_ABS_SPEED, TILT_SET_ACCEL, TILT_SET_BASE_SPEED, TILT_SET_HOLD_POWER, TILT_SET_LOWER_SPEED_LIMIT, TILT_SET_MOVE_POWER, TILT_SET_REL_POS, TILT_SET_REL_SPEED, TILT_SET_UPPER_SPEED_LIMIT, and UPPER_SPEED_LIMIT.

char set_mode ( char  ,
char   
)

Definition at line 797 of file ptu.cpp.

References ASCII_ECHO_MODE, ASCII_VERBOSE_MODE, COMMAND_EXECUTION_MODE, DEFAULTS, DISABLE_ECHO, DISABLE_POSITION_LIMITS, ECHO_QUERY, ENABLE_ECHO, ENABLE_POSITION_LIMITS, EXECUTE_IMMEDIATELY, EXECUTE_UPON_IMMEDIATE_OR_AWAIT, get_binary_command_return_status(), OFF_MODE, ON_MODE, POSITION_LIMITS_MODE, POSITION_LIMITS_QUERY, PTU_ILLEGAL_COMMAND_ARGUMENT, PTU_INDEPENDENT_SPEED_CONTROL_MODE, PTU_PURE_VELOCITY_SPEED_CONTROL_MODE, QUERY_MODE, QUERY_SPEED_CONTROL_MODE, RESTORE_FACTORY_DEFAULTS, RESTORE_FACTORY_SETTINGS, RESTORE_SAVED_DEFAULTS, RESTORE_SAVED_SETTINGS, SAVE_CURRENT_SETTINGS, SAVE_DEFAULTS, SerialOut(), SET_IMMEDIATE_COMMAND_MODE, SET_INDEPENDENT_CONTROL_MODE, SET_PURE_VELOCITY_CONTROL_MODE, SET_SLAVED_COMMAND_MODE, SET_VERBOSE_ASCII_OFF, SET_VERBOSE_ASCII_ON, speed_control_mode, SPEED_CONTROL_MODE, TERSE, VERBOSE, and VERBOSE_QUERY.

char set_unit_id ( UID_fd   ) 

Definition at line 931 of file ptu.cpp.

References current_host_port, GetSerialChar(), PutUnsignedShort(), SerialOut(), SET_UNIT_ID, and TRUE.


Generated on Thu Feb 1 15:31:54 2007 for WURDE by  doxygen 1.5.1