RCServo Class

See the RCServo Entity for generic information.

class RCServoClass : public Acroname::BrainStem2CLI::EntityClass

RCServoClass: 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.

Public Functions

RCServoClass()

Constructors.

~RCServoClass()

Destructor.

!RCServoClass ()

Finalizer.

void init (BrainStem2CLI::ModuleClass^ module, const unsigned char index)

Initializes the class. Should only be called when manually creating classes.

Parameters:
  • pModule – The module.

  • index – The cmdSERVO index to be addressed.

aErr setEnable(const unsigned char enable)

Enable the servo channel

Parameters:

enable – The state to be set. 0 is disabled, 1 is enabled.

Returns:

Returns common entity return values

aErr getEnable(unsigned char %enable)

Get the enable status of the servo channel.

Parameters:

enable – The current enable status of the servo entity. 0 is disabled, 1 is enabled.

Returns:

Returns common entity return values

aErr setPosition(const unsigned char position)

Set the position of the servo channel

Parameters:

position – The position to be set. Default 64 = a 1ms pulse and 192 = a 2ms pulse.

Returns:

Returns common entity return values

aErr getPosition(unsigned char %position)

Get the position of the servo channel

Parameters:

position – The current position of the servo channel. Default 64 = a 1ms pulse and 192 = a 2ms pulse.

Returns:

Returns common entity return values

aErr setReverse(const unsigned char reverse)

Set the output to be reversed on the servo channel

Parameters:

reverse – 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:

Returns common entity return values

aErr getReverse(unsigned char %reverse)

Get the reverse status of the servo channel

Parameters:

reverse – The current reverse status of the servo entity. 0 = not reversed, 1 = reversed.

Returns:

Returns common entity return values