Go to the source code of this file.
Classes | |
| class | YMove |
| class | YServo |
Macros | |
| #define | _CLASS_YMOVE |
| #define | _Y_ENABLED_ENUM |
| #define | _Y_ENABLEDATPOWERON_ENUM |
| #define | Y_NEUTRAL_INVALID (YAPI_INVALID_UINT) |
| #define | Y_POSITION_INVALID (YAPI_INVALID_INT) |
| #define | Y_POSITIONATPOWERON_INVALID (YAPI_INVALID_INT) |
| #define | Y_RANGE_INVALID (YAPI_INVALID_UINT) |
Typedefs | |
| typedef void(* | YServoValueCallback) (YServo *func, const string &functionValue) |
Enumerations | |
| enum | Y_ENABLED_enum { Y_ENABLED_FALSE = 0, Y_ENABLED_TRUE = 1, Y_ENABLED_INVALID = -1, Y_ENABLED_FALSE = 0, Y_ENABLED_TRUE = 1, Y_ENABLED_INVALID = -1, Y_ENABLED_FALSE = 0, Y_ENABLED_TRUE = 1, Y_ENABLED_INVALID = -1, Y_ENABLED_FALSE = 0, Y_ENABLED_TRUE = 1, Y_ENABLED_INVALID = -1, Y_ENABLED_FALSE = 0, Y_ENABLED_TRUE = 1, Y_ENABLED_INVALID = -1, Y_ENABLED_FALSE = 0, Y_ENABLED_TRUE = 1, Y_ENABLED_INVALID = -1 } |
| enum | Y_ENABLEDATPOWERON_enum { Y_ENABLEDATPOWERON_FALSE = 0, Y_ENABLEDATPOWERON_TRUE = 1, Y_ENABLEDATPOWERON_INVALID = -1, Y_ENABLEDATPOWERON_FALSE = 0, Y_ENABLEDATPOWERON_TRUE = 1, Y_ENABLEDATPOWERON_INVALID = -1 } |
Functions | |
| YServo * | yFindServo (const string &func) |
| YServo * | yFirstServo (void) |
Macro Definition Documentation
| #define _CLASS_YMOVE |
Definition at line 64 of file yocto_servo.h.
| #define _Y_ENABLED_ENUM |
Definition at line 56 of file yocto_servo.h.
| #define _Y_ENABLEDATPOWERON_ENUM |
Definition at line 81 of file yocto_servo.h.
| #define Y_NEUTRAL_INVALID (YAPI_INVALID_UINT) |
Definition at line 90 of file yocto_servo.h.
| #define Y_POSITION_INVALID (YAPI_INVALID_INT) |
Definition at line 88 of file yocto_servo.h.
| #define Y_POSITIONATPOWERON_INVALID (YAPI_INVALID_INT) |
Definition at line 91 of file yocto_servo.h.
| #define Y_RANGE_INVALID (YAPI_INVALID_UINT) |
Definition at line 89 of file yocto_servo.h.
Typedef Documentation
| typedef void(* YServoValueCallback) (YServo *func, const string &functionValue) |
Definition at line 54 of file yocto_servo.h.
Enumeration Type Documentation
| enum Y_ENABLED_enum |
Definition at line 57 of file yocto_servo.h.
| Enumerator | |
|---|---|
| Y_ENABLEDATPOWERON_FALSE | |
| Y_ENABLEDATPOWERON_TRUE | |
| Y_ENABLEDATPOWERON_INVALID | |
| Y_ENABLEDATPOWERON_FALSE | |
| Y_ENABLEDATPOWERON_TRUE | |
| Y_ENABLEDATPOWERON_INVALID | |
Definition at line 82 of file yocto_servo.h.
Function Documentation
|
inline |
Retrieves a servo 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 servo is online at the time it is invoked. The returned object is nevertheless valid. Use the method YServo.isOnline() to test if the servo is indeed online at a given time. In case of ambiguity when looking for a servo 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 servo
- Returns
- a YServo object allowing you to drive the servo.
Definition at line 439 of file yocto_servo.h.
|
inline |
Starts the enumeration of servos currently accessible. Use the method YServo.nextServo() to iterate on next servos.
- Returns
- a pointer to a YServo object, corresponding to the first servo currently online, or a NULL pointer if there are none.
Definition at line 450 of file yocto_servo.h.