RCServo¶
See the RCServo Entity for generic information.
- class brainstem.entity.RCServo(module, index)[source]¶
Interface to servo entities on BrainStem modules. Servo entities are built upon the digital input/output pins and therefore can also be inputs or outputs. Please see the product datasheet on the configuration limitations.
- getEnable()[source]¶
Get the enable status of the servo channel.
- Returns:
- Object containing error code and returned value on success.
- errorunsigned byte
An error result from the list of defined error codes
- valuebool
The current enable status of the servo entity. 0 is disabled, 1 is enabled.
- Return type:
- getPosition()[source]¶
Get the position of the servo channel
- Returns:
- Object containing error code and returned value on success.
- errorunsigned byte
An error result from the list of defined error codes
- valueunsigned char
The current position of the servo channel. Default 64 = a 1ms pulse and 192 = a 2ms pulse.
- Return type:
- getReverse()[source]¶
Get the reverse status of the servo channel
- Returns:
- Object containing error code and returned value on success.
- errorunsigned byte
An error result from the list of defined error codes
- valuebool
The current reverse status of the servo entity. 0 = not reversed, 1 = reversed.
- Return type:
- setEnable(enable)[source]¶
Enable the servo channel
- Parameters:
enable (bool) – The state to be set. 0 is disabled, 1 is enabled.
- Returns:
An error result from the list of defined error codes in brainstem.result.Result
- Return type:
unsigned byte
- setPosition(position)[source]¶
Set the position of the servo channel
- Parameters:
position (unsigned char) – The position to be set. Default 64 = a 1ms pulse and 192 = a 2ms pulse.
- Returns:
An error result from the list of defined error codes in brainstem.result.Result
- Return type:
unsigned byte
- setReverse(reverse)[source]¶
Set the output to be reversed on the servo channel
- Parameters:
reverse (bool) – Reverses the value set by “setPosition”. For example, if the position is set to 64 (1ms pulse) the output will now be 192 (2ms pulse), however “getPostion” will return the set value of 64. 0 = not reversed, 1 = reversed.
- Returns:
An error result from the list of defined error codes in brainstem.result.Result
- Return type:
unsigned byte