Go to the source code of this file.
Classes | |
| class | YStepperMotor |
Macros | |
| #define | _Y_MOTORSTATE_ENUM |
| #define | _Y_STEPPING_ENUM |
| #define | Y_ALERTMODE_INVALID (YAPI_INVALID_STRING) |
| #define | Y_AUXMODE_INVALID (YAPI_INVALID_STRING) |
| #define | Y_AUXSIGNAL_INVALID (YAPI_INVALID_INT) |
| #define | Y_COMMAND_INVALID (YAPI_INVALID_STRING) |
| #define | Y_DIAGS_INVALID (YAPI_INVALID_UINT) |
| #define | Y_MAXACCEL_INVALID (YAPI_INVALID_DOUBLE) |
| #define | Y_MAXSPEED_INVALID (YAPI_INVALID_DOUBLE) |
| #define | Y_OVERCURRENT_INVALID (YAPI_INVALID_UINT) |
| #define | Y_PULLINSPEED_INVALID (YAPI_INVALID_DOUBLE) |
| #define | Y_SPEED_INVALID (YAPI_INVALID_DOUBLE) |
| #define | Y_STEPPOS_INVALID (YAPI_INVALID_DOUBLE) |
| #define | Y_TCURRRUN_INVALID (YAPI_INVALID_UINT) |
| #define | Y_TCURRSTOP_INVALID (YAPI_INVALID_UINT) |
Typedefs | |
| typedef void(* | YStepperMotorValueCallback) (YStepperMotor *func, const string &functionValue) |
Enumerations | |
| enum | Y_MOTORSTATE_enum { Y_MOTORSTATE_ABSENT = 0, Y_MOTORSTATE_ALERT = 1, Y_MOTORSTATE_HI_Z = 2, Y_MOTORSTATE_STOP = 3, Y_MOTORSTATE_RUN = 4, Y_MOTORSTATE_BATCH = 5, Y_MOTORSTATE_INVALID = -1 } |
| enum | Y_STEPPING_enum { Y_STEPPING_MICROSTEP16 = 0, Y_STEPPING_MICROSTEP8 = 1, Y_STEPPING_MICROSTEP4 = 2, Y_STEPPING_HALFSTEP = 3, Y_STEPPING_FULLSTEP = 4, Y_STEPPING_INVALID = -1 } |
Functions | |
| YStepperMotor * | yFindStepperMotor (const string &func) |
| YStepperMotor * | yFirstStepperMotor (void) |
Macro Definition Documentation
| #define _Y_MOTORSTATE_ENUM |
Definition at line 56 of file yocto_steppermotor.h.
| #define _Y_STEPPING_ENUM |
Definition at line 68 of file yocto_steppermotor.h.
| #define Y_ALERTMODE_INVALID (YAPI_INVALID_STRING) |
Definition at line 87 of file yocto_steppermotor.h.
| #define Y_AUXMODE_INVALID (YAPI_INVALID_STRING) |
Definition at line 88 of file yocto_steppermotor.h.
| #define Y_AUXSIGNAL_INVALID (YAPI_INVALID_INT) |
Definition at line 89 of file yocto_steppermotor.h.
| #define Y_COMMAND_INVALID (YAPI_INVALID_STRING) |
Definition at line 90 of file yocto_steppermotor.h.
| #define Y_DIAGS_INVALID (YAPI_INVALID_UINT) |
Definition at line 78 of file yocto_steppermotor.h.
| #define Y_MAXACCEL_INVALID (YAPI_INVALID_DOUBLE) |
Definition at line 82 of file yocto_steppermotor.h.
| #define Y_MAXSPEED_INVALID (YAPI_INVALID_DOUBLE) |
Definition at line 83 of file yocto_steppermotor.h.
| #define Y_OVERCURRENT_INVALID (YAPI_INVALID_UINT) |
Definition at line 84 of file yocto_steppermotor.h.
| #define Y_PULLINSPEED_INVALID (YAPI_INVALID_DOUBLE) |
Definition at line 81 of file yocto_steppermotor.h.
| #define Y_SPEED_INVALID (YAPI_INVALID_DOUBLE) |
Definition at line 80 of file yocto_steppermotor.h.
| #define Y_STEPPOS_INVALID (YAPI_INVALID_DOUBLE) |
Definition at line 79 of file yocto_steppermotor.h.
| #define Y_TCURRRUN_INVALID (YAPI_INVALID_UINT) |
Definition at line 86 of file yocto_steppermotor.h.
| #define Y_TCURRSTOP_INVALID (YAPI_INVALID_UINT) |
Definition at line 85 of file yocto_steppermotor.h.
Typedef Documentation
| typedef void(* YStepperMotorValueCallback) (YStepperMotor *func, const string &functionValue) |
Definition at line 54 of file yocto_steppermotor.h.
Enumeration Type Documentation
| enum Y_MOTORSTATE_enum |
| Enumerator | |
|---|---|
| Y_MOTORSTATE_ABSENT | |
| Y_MOTORSTATE_ALERT | |
| Y_MOTORSTATE_HI_Z | |
| Y_MOTORSTATE_STOP | |
| Y_MOTORSTATE_RUN | |
| Y_MOTORSTATE_BATCH | |
| Y_MOTORSTATE_INVALID | |
Definition at line 57 of file yocto_steppermotor.h.
| enum Y_STEPPING_enum |
| Enumerator | |
|---|---|
| Y_STEPPING_MICROSTEP16 | |
| Y_STEPPING_MICROSTEP8 | |
| Y_STEPPING_MICROSTEP4 | |
| Y_STEPPING_HALFSTEP | |
| Y_STEPPING_FULLSTEP | |
| Y_STEPPING_INVALID | |
Definition at line 69 of file yocto_steppermotor.h.
Function Documentation
|
inline |
Retrieves a stepper motor for a given identifier. The identifier can be specified using several formats:
- FunctionLogicalName
- ModuleSerialNumber.FunctionIdentifier
- ModuleSerialNumber.FunctionLogicalName
- ModuleLogicalName.FunctionIdentifier
- ModuleLogicalName.FunctionLogicalName
This function does not require that the stepper motor is online at the time it is invoked. The returned object is nevertheless valid. Use the method YStepperMotor.isOnline() to test if the stepper motor is indeed online at a given time. In case of ambiguity when looking for a stepper motor by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.
If a call to this object's is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.
- Parameters
-
func : a string that uniquely characterizes the stepper motor
- Returns
- a YStepperMotor object allowing you to drive the stepper motor.
Definition at line 701 of file yocto_steppermotor.h.
|
inline |
Starts the enumeration of stepper motors currently accessible. Use the method YStepperMotor.nextStepperMotor() to iterate on next stepper motors.
- Returns
- a pointer to a YStepperMotor object, corresponding to the first stepper motor currently online, or a NULL pointer if there are none.
Definition at line 712 of file yocto_steppermotor.h.