Phidget Stepper
[Specific Phidgets]


Typedefs

typedef struct _CPhidgetStepper * CPhidgetStepperHandle

Functions

int CPhidgetStepper_create (CPhidgetStepperHandle *phid)
int CPhidgetStepper_getInputCount (CPhidgetStepperHandle phid, int *count)
int CPhidgetStepper_getInputState (CPhidgetStepperHandle phid, int index, int *inputState)
int CPhidgetStepper_set_OnInputChange_Handler (CPhidgetStepperHandle phid, int(*fptr)(CPhidgetStepperHandle phid, void *userPtr, int index, int inputState), void *userPtr)
int CPhidgetStepper_getMotorCount (CPhidgetStepperHandle phid, int *count)
int CPhidgetStepper_getAcceleration (CPhidgetStepperHandle phid, int index, double *acceleration)
int CPhidgetStepper_setAcceleration (CPhidgetStepperHandle phid, int index, double acceleration)
int CPhidgetStepper_getAccelerationMax (CPhidgetStepperHandle phid, int index, double *max)
int CPhidgetStepper_getAccelerationMin (CPhidgetStepperHandle phid, int index, double *min)
int CPhidgetStepper_getVelocityLimit (CPhidgetStepperHandle phid, int index, double *limit)
int CPhidgetStepper_setVelocityLimit (CPhidgetStepperHandle phid, int index, double limit)
int CPhidgetStepper_getVelocity (CPhidgetStepperHandle phid, int index, double *velocity)
int CPhidgetStepper_getVelocityMax (CPhidgetStepperHandle phid, int index, double *max)
int CPhidgetStepper_getVelocityMin (CPhidgetStepperHandle phid, int index, double *min)
int CPhidgetStepper_set_OnVelocityChange_Handler (CPhidgetStepperHandle phid, int(*fptr)(CPhidgetStepperHandle phid, void *userPtr, int index, double velocity), void *userPtr)
int CPhidgetStepper_getTargetPosition (CPhidgetStepperHandle phid, int index, __int64 *position)
int CPhidgetStepper_setTargetPosition (CPhidgetStepperHandle phid, int index, __int64 position)
int CPhidgetStepper_getCurrentPosition (CPhidgetStepperHandle phid, int index, __int64 *position)
int CPhidgetStepper_setCurrentPosition (CPhidgetStepperHandle phid, int index, __int64 position)
int CPhidgetStepper_getPositionMax (CPhidgetStepperHandle phid, int index, __int64 *max)
int CPhidgetStepper_getPositionMin (CPhidgetStepperHandle phid, int index, __int64 *min)
int CPhidgetStepper_set_OnPositionChange_Handler (CPhidgetStepperHandle phid, int(*fptr)(CPhidgetStepperHandle phid, void *userPtr, int index, __int64 position), void *userPtr)
int CPhidgetStepper_getCurrentLimit (CPhidgetStepperHandle phid, int index, double *limit)
int CPhidgetStepper_setCurrentLimit (CPhidgetStepperHandle phid, int index, double limit)
int CPhidgetStepper_getCurrent (CPhidgetStepperHandle phid, int index, double *current)
int CPhidgetStepper_getCurrentMax (CPhidgetStepperHandle phid, int index, double *max)
int CPhidgetStepper_getCurrentMin (CPhidgetStepperHandle phid, int index, double *min)
int CPhidgetStepper_set_OnCurrentChange_Handler (CPhidgetStepperHandle phid, int(*fptr)(CPhidgetStepperHandle phid, void *userPtr, int index, double current), void *userPtr)
int CPhidgetStepper_getEngaged (CPhidgetStepperHandle phid, int index, int *engagedState)
int CPhidgetStepper_setEngaged (CPhidgetStepperHandle phid, int index, int engagedState)
int CPhidgetStepper_getStopped (CPhidgetStepperHandle phid, int index, int *stoppedState)

Detailed Description

Calls specific to the Phidget Stepper. See the product manual for more specific API details, supported functionality, units, etc.

Typedef Documentation

typedef struct _CPhidgetStepper* CPhidgetStepperHandle

A Phidget Stepper handle

Function Documentation

int CPhidgetStepper_create ( CPhidgetStepperHandle *  phid  ) 

Creates a Phidget Stepper handle.

Parameters:
phid A pointer to an unallocated Phidget Stepper handle.

int CPhidgetStepper_getInputCount ( CPhidgetStepperHandle  phid,
int *  count 
)

Gets the number of digital inputs supported by this board.

Parameters:
phid An attached phidget stepper handle.
count The ditial input count.

int CPhidgetStepper_getInputState ( CPhidgetStepperHandle  phid,
int  index,
int *  inputState 
)

Gets the state of a digital input.

Parameters:
phid An attached phidget stepper handle.
index The input index.
inputState The input state. Possible values are PTRUE and PFALSE.

int CPhidgetStepper_set_OnInputChange_Handler ( CPhidgetStepperHandle  phid,
int(*)(CPhidgetStepperHandle phid, void *userPtr, int index, int inputState)  fptr,
void *  userPtr 
)

Set a digital input change handler. This is called when a digital input changes.

Parameters:
phid An attached phidget stepper handle.
fptr Callback function pointer.
userPtr A pointer for use by the user - this value is passed back into the callback function.

int CPhidgetStepper_getMotorCount ( CPhidgetStepperHandle  phid,
int *  count 
)

Gets the number of motors supported by this controller

Parameters:
phid An attached phidget stepper handle.
count The motor count.

int CPhidgetStepper_getAcceleration ( CPhidgetStepperHandle  phid,
int  index,
double *  acceleration 
)

Gets the last set acceleration for a motor.

Parameters:
phid An attached phidget stepper handle
index The motor index.
acceleration The acceleration

int CPhidgetStepper_setAcceleration ( CPhidgetStepperHandle  phid,
int  index,
double  acceleration 
)

Sets the acceleration for a motor.

Parameters:
phid An attached phidget stepper handle
index The motor index.
acceleration The acceleration

int CPhidgetStepper_getAccelerationMax ( CPhidgetStepperHandle  phid,
int  index,
double *  max 
)

Gets the maximum acceleration supported by a motor

Parameters:
phid An attached phidget stepper handle
index The motor index.
max The maximum acceleration.

int CPhidgetStepper_getAccelerationMin ( CPhidgetStepperHandle  phid,
int  index,
double *  min 
)

Gets the minimum acceleration supported by a motor.

Parameters:
phid An attached phidget stepper handle
index The motor index.
min The minimum acceleration

int CPhidgetStepper_getVelocityLimit ( CPhidgetStepperHandle  phid,
int  index,
double *  limit 
)

Gets the last set velocity limit for a motor.

Parameters:
phid An attached phidget stepper handle
index The motor index.
limit The velocity limit.

int CPhidgetStepper_setVelocityLimit ( CPhidgetStepperHandle  phid,
int  index,
double  limit 
)

Sets the velocity limit for a motor.

Parameters:
phid An attached phidget stepper handle
index The motor index.
limit The velocity limit.

int CPhidgetStepper_getVelocity ( CPhidgetStepperHandle  phid,
int  index,
double *  velocity 
)

Gets the current velocity of a motor.

Parameters:
phid An attached phidget stepper handle
index The motor index.
velocity The current velocity.

int CPhidgetStepper_getVelocityMax ( CPhidgetStepperHandle  phid,
int  index,
double *  max 
)

Gets the maximum velocity that can be set for a motor.

Parameters:
phid An attached phidget stepper handle
index The motor index.
max The maximum velocity

int CPhidgetStepper_getVelocityMin ( CPhidgetStepperHandle  phid,
int  index,
double *  min 
)

Gets the minimum velocity that can be set for a motor.

Parameters:
phid An attached phidget stepper handle
index The motor index.
min The minimum velocity.

int CPhidgetStepper_set_OnVelocityChange_Handler ( CPhidgetStepperHandle  phid,
int(*)(CPhidgetStepperHandle phid, void *userPtr, int index, double velocity)  fptr,
void *  userPtr 
)

Sets a velocity change event handler. This is called when the velocity changes.

Parameters:
phid An attached phidget stepper handle
fptr Callback function pointer.
userPtr A pointer for use by the user - this value is passed back into the callback function.

int CPhidgetStepper_getTargetPosition ( CPhidgetStepperHandle  phid,
int  index,
__int64 *  position 
)

Gets the last set target position of a motor.

Parameters:
phid An attached phidget stepper handle
index The motor index.
position The position.

int CPhidgetStepper_setTargetPosition ( CPhidgetStepperHandle  phid,
int  index,
__int64  position 
)

Sets the target position of a motor.

Parameters:
phid An attached phidget stepper handle
index The motor index.
position The position.

int CPhidgetStepper_getCurrentPosition ( CPhidgetStepperHandle  phid,
int  index,
__int64 *  position 
)

Gets the current position of a motor.

Parameters:
phid An attached phidget stepper handle
index The motor index.
position The position.

int CPhidgetStepper_setCurrentPosition ( CPhidgetStepperHandle  phid,
int  index,
__int64  position 
)

Sets the current position of a motor. This will not move the motor, just update the position value.

Parameters:
phid An attached phidget stepper handle
index The motor index.
position The position.

int CPhidgetStepper_getPositionMax ( CPhidgetStepperHandle  phid,
int  index,
__int64 *  max 
)

Gets the maximum position that a motor can go to.

Parameters:
phid An attached phidget stepper handle
index The motor index.
max The maximum position.

int CPhidgetStepper_getPositionMin ( CPhidgetStepperHandle  phid,
int  index,
__int64 *  min 
)

Gets the minimum position that a motor can go to.

Parameters:
phid An attached phidget stepper handle
index The motor index.
min The minimum position

int CPhidgetStepper_set_OnPositionChange_Handler ( CPhidgetStepperHandle  phid,
int(*)(CPhidgetStepperHandle phid, void *userPtr, int index, __int64 position)  fptr,
void *  userPtr 
)

Sets a position change event handler. This is called when the position changes.

Parameters:
phid An attached phidget stepper handle
fptr Callback function pointer.
userPtr A pointer for use by the user - this value is passed back into the callback function.

int CPhidgetStepper_getCurrentLimit ( CPhidgetStepperHandle  phid,
int  index,
double *  limit 
)

Gets the current limit for a motor.

Parameters:
phid An attached phidget stepper handle.
index The motor index.
limit The current limit.

int CPhidgetStepper_setCurrentLimit ( CPhidgetStepperHandle  phid,
int  index,
double  limit 
)

Sets the current limit for a motor.

Parameters:
phid An attached phidget stepper handle.
index The motor index.
limit The current limit.

int CPhidgetStepper_getCurrent ( CPhidgetStepperHandle  phid,
int  index,
double *  current 
)

Gets the current current draw for a motor.

Parameters:
phid An attached phidget stepper handle
index The motor index.
current The current.

int CPhidgetStepper_getCurrentMax ( CPhidgetStepperHandle  phid,
int  index,
double *  max 
)

Gets the maximum current limit.

Parameters:
phid An attached phidget stepper handle
index The motor index.
max The maximum current limit.

int CPhidgetStepper_getCurrentMin ( CPhidgetStepperHandle  phid,
int  index,
double *  min 
)

Gets the minimum current limit.

Parameters:
phid An attached phidget stepper handle
index The motor index.
min The minimum current limit.

int CPhidgetStepper_set_OnCurrentChange_Handler ( CPhidgetStepperHandle  phid,
int(*)(CPhidgetStepperHandle phid, void *userPtr, int index, double current)  fptr,
void *  userPtr 
)

Sets a current change event handler. This is called when the current draw changes.

Parameters:
phid An attached phidget stepper handle
fptr Callback function pointer.
userPtr A pointer for use by the user - this value is passed back into the callback function.

int CPhidgetStepper_getEngaged ( CPhidgetStepperHandle  phid,
int  index,
int *  engagedState 
)

Gets the engaged state of a motor. This is whether the motor is powered or not.

Parameters:
phid An attached phidget stepper handle
index The motor index.
engagedState The engaged state. Possible values are PTRUE and PFALSE.

int CPhidgetStepper_setEngaged ( CPhidgetStepperHandle  phid,
int  index,
int  engagedState 
)

Sets the engaged state of a motor. This is whether the motor is powered or not.

Parameters:
phid An attached phidget stepper handle
index The motor index.
engagedState The engaged state. Possible values are PTRUE and PFALSE.

int CPhidgetStepper_getStopped ( CPhidgetStepperHandle  phid,
int  index,
int *  stoppedState 
)

Gets the stopped state of a motor. This is true when the motor is not moving and there are no outstanding commands.

Parameters:
phid An attached phidget stepper handle
index The motor index.
stoppedState The stopped state. Possible values are PTRUE and PFALSE.

Generated on Thu May 3 14:03:28 2012 for Phidget21 by  doxygen 1.5.9