AHP® GT Controllers API
AHP GT Controllers
Functions

Functions

DLL_EXPORT MountType ahp_gt_get_mount_type (void)
 Get the current GT mount type. More...
 
DLL_EXPORT int ahp_gt_get_axis_number ()
 Get the current GT controller axis number. More...
 
DLL_EXPORT GTFeature ahp_gt_get_feature (int axis)
 Get the current GT features. More...
 
DLL_EXPORT SkywatcherFeature ahp_gt_get_features (int axis)
 Get the current SkyWatcher features. More...
 
DLL_EXPORT double ahp_gt_get_motor_steps (int axis)
 Get the current motor steps number. More...
 
DLL_EXPORT double ahp_gt_get_motor_teeth (int axis)
 Get the current motor gear teeth number. More...
 
DLL_EXPORT double ahp_gt_get_worm_teeth (int axis)
 Get the current worm gear teeth number. More...
 
DLL_EXPORT double ahp_gt_get_crown_teeth (int axis)
 Get the current crown gear teeth number. More...
 
DLL_EXPORT double ahp_gt_get_divider (int axis)
 Get the divider in the current configuration. More...
 
DLL_EXPORT double ahp_gt_get_multiplier (int axis)
 Get the multiplier in the current configuration. More...
 
DLL_EXPORT int ahp_gt_get_totalsteps (int axis)
 Get the total number of steps. More...
 
DLL_EXPORT int ahp_gt_get_wormsteps (int axis)
 Get the worm number of steps. More...
 
DLL_EXPORT double ahp_gt_get_guide_steps (int axis)
 Get the guiding rate. More...
 
DLL_EXPORT double ahp_gt_get_acceleration_steps (int axis)
 Get the acceleration increment steps number. More...
 
DLL_EXPORT double ahp_gt_get_acceleration_angle (int axis)
 Get the acceleration angle. More...
 
DLL_EXPORT int ahp_gt_get_rs232_polarity (void)
 Get the rs232 port polarity. More...
 
DLL_EXPORT int ahp_gt_get_pwm_frequency (void)
 Get the microstepping pwm frequency. More...
 
DLL_EXPORT int ahp_gt_get_direction_invert (int axis)
 Get the forward direction. More...
 
DLL_EXPORT GTFlags ahp_gt_get_mount_flags ()
 Get the mount flags. More...
 
DLL_EXPORT GTSteppingConfiguration ahp_gt_get_stepping_conf (int axis)
 Get the stepping configuration. More...
 
DLL_EXPORT GTSteppingMode ahp_gt_get_stepping_mode (int axis)
 Get the stepping mode. More...
 
DLL_EXPORT double ahp_gt_get_max_speed (int axis)
 Get the maximum speed. More...
 
DLL_EXPORT double ahp_gt_get_speed_limit (int axis)
 Get the speed limit. More...
 
DLL_EXPORT double ahp_gt_get_timing (int axis)
 Get the timing value of the axis. More...
 
DLL_EXPORT void ahp_gt_set_timing (int axis, int value)
 Set the timing value of the axis. More...
 
DLL_EXPORT void ahp_gt_set_mount_type (MountType value)
 Set the mount type. More...
 
DLL_EXPORT void ahp_gt_set_axis_number (int axis, int value)
 Set the GT controller axis number. More...
 
DLL_EXPORT void ahp_gt_set_features (int axis, SkywatcherFeature value)
 Set the Skywatcher features. More...
 
DLL_EXPORT void ahp_gt_set_feature (int axis, GTFeature value)
 Set the GT features. More...
 
DLL_EXPORT void ahp_gt_set_motor_steps (int axis, double value)
 Set the motor steps number. More...
 
DLL_EXPORT void ahp_gt_set_motor_teeth (int axis, double value)
 Set the motor gear teeth number. More...
 
DLL_EXPORT void ahp_gt_set_worm_teeth (int axis, double value)
 Set the worm gear teeth number. More...
 
DLL_EXPORT void ahp_gt_set_crown_teeth (int axis, double value)
 Set the crown gear teeth number. More...
 
DLL_EXPORT void ahp_gt_set_divider (int axis, int value)
 Set the divider in the current configuration. More...
 
DLL_EXPORT void ahp_gt_set_multiplier (int axis, int value)
 Set the multiplier in the current configuration. More...
 
DLL_EXPORT void ahp_gt_set_totalsteps (int axis, int value)
 Set the total number of steps. More...
 
DLL_EXPORT void ahp_gt_set_wormsteps (int axis, int value)
 Set the worm number of steps. More...
 
DLL_EXPORT void ahp_gt_set_guide_steps (int axis, double value)
 Set the guiding speed. More...
 
DLL_EXPORT void ahp_gt_set_acceleration_angle (int axis, double value)
 Set the acceleration in high speed mode. More...
 
DLL_EXPORT void ahp_gt_set_rs232_polarity (int value)
 Set the rs232 port polarity. More...
 
DLL_EXPORT void ahp_gt_set_pwm_frequency (int value)
 Set the microstepping pwm frequency. More...
 
DLL_EXPORT void ahp_gt_set_direction_invert (int axis, int value)
 Set the forward direction. More...
 
DLL_EXPORT void ahp_gt_set_mount_flags (GTFlags value)
 Set the mount flags. More...
 
DLL_EXPORT void ahp_gt_set_stepping_conf (int axis, GTSteppingConfiguration value)
 Set the stepping configuration. More...
 
DLL_EXPORT void ahp_gt_set_stepping_mode (int axis, GTSteppingMode value)
 Set the stepping mode. More...
 
DLL_EXPORT void ahp_gt_set_max_speed (int axis, double value)
 Set the maximum goto speed. More...
 

Detailed Description

Function Documentation

◆ ahp_gt_get_acceleration_angle()

DLL_EXPORT double ahp_gt_get_acceleration_angle ( int  axis)
Parameters
axisThe motor to query
Returns
The angle in radians the GT controller will cover to reach the desired rate

◆ ahp_gt_get_acceleration_steps()

DLL_EXPORT double ahp_gt_get_acceleration_steps ( int  axis)
Parameters
axisThe motor to query
Returns
The calculated acceleration steps

◆ ahp_gt_get_axis_number()

DLL_EXPORT int ahp_gt_get_axis_number ( )
Returns
The GT controller axis number

◆ ahp_gt_get_crown_teeth()

DLL_EXPORT double ahp_gt_get_crown_teeth ( int  axis)
Parameters
axisThe motor to query
Returns
The GT controller configured crown gear teeth

◆ ahp_gt_get_direction_invert()

DLL_EXPORT int ahp_gt_get_direction_invert ( int  axis)
Parameters
axisThe motor to query
Returns
Non-zero if the direction of this axis is inverted

◆ ahp_gt_get_divider()

DLL_EXPORT double ahp_gt_get_divider ( int  axis)
Parameters
axisThe motor to query
Returns
The calculated stepping divider

◆ ahp_gt_get_feature()

DLL_EXPORT GTFeature ahp_gt_get_feature ( int  axis)
Parameters
axisThe motor to query
Returns
The GT controller GTFeature configuration

◆ ahp_gt_get_features()

DLL_EXPORT SkywatcherFeature ahp_gt_get_features ( int  axis)
Parameters
axisThe motor to query
Returns
The GT controller SkywatcherFeature configuration

◆ ahp_gt_get_guide_steps()

DLL_EXPORT double ahp_gt_get_guide_steps ( int  axis)
Parameters
axisThe motor to query
Returns
The current ST4 port guide rate in radians per second

◆ ahp_gt_get_max_speed()

DLL_EXPORT double ahp_gt_get_max_speed ( int  axis)
Parameters
axisThe motor to query
Returns
The maximum speed in radians per second

◆ ahp_gt_get_motor_steps()

DLL_EXPORT double ahp_gt_get_motor_steps ( int  axis)
Parameters
axisThe motor to query
Returns
The GT controller configured motor steps

◆ ahp_gt_get_motor_teeth()

DLL_EXPORT double ahp_gt_get_motor_teeth ( int  axis)
Parameters
axisThe motor to query
Returns
The GT controller configured motor teeth

◆ ahp_gt_get_mount_flags()

DLL_EXPORT GTFlags ahp_gt_get_mount_flags ( )
Returns
Custom 10bit GTFlags - for future usage

◆ ahp_gt_get_mount_type()

DLL_EXPORT MountType ahp_gt_get_mount_type ( void  )
Returns
The GT controller MountType configuration

◆ ahp_gt_get_multiplier()

DLL_EXPORT double ahp_gt_get_multiplier ( int  axis)
Parameters
axisThe motor to query
Returns
The calculated stepping multiplier

◆ ahp_gt_get_pwm_frequency()

DLL_EXPORT int ahp_gt_get_pwm_frequency ( void  )
Returns
The PWM frequency index - microstepping only

◆ ahp_gt_get_rs232_polarity()

DLL_EXPORT int ahp_gt_get_rs232_polarity ( void  )
Returns
Non-zero if inverted polarity was configured for the communication port

◆ ahp_gt_get_speed_limit()

DLL_EXPORT double ahp_gt_get_speed_limit ( int  axis)
Parameters
axisThe motor to query
Returns
The speed limit allowed by autoconfiguration, in radians per second

◆ ahp_gt_get_stepping_conf()

DLL_EXPORT GTSteppingConfiguration ahp_gt_get_stepping_conf ( int  axis)
Parameters
axisThe motor to query
Returns
The GTSteppingConfiguration of the given axis - the coil polarization order

◆ ahp_gt_get_stepping_mode()

DLL_EXPORT GTSteppingMode ahp_gt_get_stepping_mode ( int  axis)
Parameters
axisThe motor to query
Returns
The GTSteppingMode of the given axis

◆ ahp_gt_get_timing()

DLL_EXPORT double ahp_gt_get_timing ( int  axis)
Parameters
axisThe motor to query
Returns
The timing value

◆ ahp_gt_get_totalsteps()

DLL_EXPORT int ahp_gt_get_totalsteps ( int  axis)
Parameters
axisThe motor to query
Returns
The calculated total steps number

◆ ahp_gt_get_worm_teeth()

DLL_EXPORT double ahp_gt_get_worm_teeth ( int  axis)
Parameters
axisThe motor to query
Returns
The GT controller configured worm gear teeth

◆ ahp_gt_get_wormsteps()

DLL_EXPORT int ahp_gt_get_wormsteps ( int  axis)
Parameters
axisThe motor to query
Returns
The calculated worm steps number

◆ ahp_gt_set_acceleration_angle()

DLL_EXPORT void ahp_gt_set_acceleration_angle ( int  axis,
double  value 
)
Parameters
axisThe motor to reconfigure
valueThe angle in radians to cover to reach full speed after ahp_gt_write_values

◆ ahp_gt_set_axis_number()

DLL_EXPORT void ahp_gt_set_axis_number ( int  axis,
int  value 
)
Parameters
axisThe motor old axis number
valueThe motor axis number

◆ ahp_gt_set_crown_teeth()

DLL_EXPORT void ahp_gt_set_crown_teeth ( int  axis,
double  value 
)
Parameters
axisThe motor to reconfigure
valueThe crown gear teeth for autoconfiguration after ahp_gt_write_values

◆ ahp_gt_set_direction_invert()

DLL_EXPORT void ahp_gt_set_direction_invert ( int  axis,
int  value 
)
Parameters
axisThe motor to reconfigure
valueIf 1 is passed the direction of this axis will be inverted after ahp_gt_write_values

◆ ahp_gt_set_divider()

DLL_EXPORT void ahp_gt_set_divider ( int  axis,
int  value 
)
Parameters
axisThe motor to reconfigure
valueThe step divider value after ahp_gt_write_values

◆ ahp_gt_set_feature()

DLL_EXPORT void ahp_gt_set_feature ( int  axis,
GTFeature  value 
)
Parameters
axisThe motor to reconfigure
valueThe GTFeature after ahp_gt_write_values

◆ ahp_gt_set_features()

DLL_EXPORT void ahp_gt_set_features ( int  axis,
SkywatcherFeature  value 
)
Parameters
axisThe motor to reconfigure
valueThe SkywatcherFeature after ahp_gt_write_values

◆ ahp_gt_set_guide_steps()

DLL_EXPORT void ahp_gt_set_guide_steps ( int  axis,
double  value 
)
Parameters
axisThe motor to reconfigure
valueThe guiding speed in radians per second after ahp_gt_write_values

◆ ahp_gt_set_max_speed()

DLL_EXPORT void ahp_gt_set_max_speed ( int  axis,
double  value 
)
Parameters
axisThe motor to reconfigure
valueThe maximum speed of this axis in radians per second after ahp_gt_write_values

◆ ahp_gt_set_motor_steps()

DLL_EXPORT void ahp_gt_set_motor_steps ( int  axis,
double  value 
)
Parameters
axisThe motor to reconfigure
valueThe motor steps for autoconfiguration after ahp_gt_write_values

◆ ahp_gt_set_motor_teeth()

DLL_EXPORT void ahp_gt_set_motor_teeth ( int  axis,
double  value 
)
Parameters
axisThe motor to reconfigure
valueThe motor teeth for autoconfiguration after ahp_gt_write_values

◆ ahp_gt_set_mount_flags()

DLL_EXPORT void ahp_gt_set_mount_flags ( GTFlags  value)
Parameters
valueOnly isForkMount is supported at the moment

◆ ahp_gt_set_mount_type()

DLL_EXPORT void ahp_gt_set_mount_type ( MountType  value)
Parameters
valueThe MountType after ahp_gt_write_values

◆ ahp_gt_set_multiplier()

DLL_EXPORT void ahp_gt_set_multiplier ( int  axis,
int  value 
)
Parameters
axisThe motor to reconfigure
valueThe microsteps each step in high-speed mode after ahp_gt_write_values

◆ ahp_gt_set_pwm_frequency()

DLL_EXPORT void ahp_gt_set_pwm_frequency ( int  value)
Parameters
valueThe microstepping PWM frequency index after ahp_gt_write_values

◆ ahp_gt_set_rs232_polarity()

DLL_EXPORT void ahp_gt_set_rs232_polarity ( int  value)
Parameters
valueIf 1 is passed communication port polarity will be inverted after ahp_gt_write_values

◆ ahp_gt_set_stepping_conf()

DLL_EXPORT void ahp_gt_set_stepping_conf ( int  axis,
GTSteppingConfiguration  value 
)
Parameters
axisThe motor to reconfigure
valueThe GTSteppingConfiguration of this axis after ahp_gt_write_values

◆ ahp_gt_set_stepping_mode()

DLL_EXPORT void ahp_gt_set_stepping_mode ( int  axis,
GTSteppingMode  value 
)
Parameters
axisThe motor to reconfigure
valueThe GTSteppingMode of this axis after ahp_gt_write_values

◆ ahp_gt_set_timing()

DLL_EXPORT void ahp_gt_set_timing ( int  axis,
int  value 
)
Parameters
axisThe motor to query
valueThe timing value

◆ ahp_gt_set_totalsteps()

DLL_EXPORT void ahp_gt_set_totalsteps ( int  axis,
int  value 
)
Parameters
axisThe motor to reconfigure
valueThe total number of steps after ahp_gt_write_values

◆ ahp_gt_set_worm_teeth()

DLL_EXPORT void ahp_gt_set_worm_teeth ( int  axis,
double  value 
)
Parameters
axisThe motor to reconfigure
valueThe worm gear teeth for autoconfiguration after ahp_gt_write_values

◆ ahp_gt_set_wormsteps()

DLL_EXPORT void ahp_gt_set_wormsteps ( int  axis,
int  value 
)
Parameters
axisThe motor to reconfigure
valueThe worm number of steps after ahp_gt_write_values