Relay Class

class RelayClass : public Acroname::BrainStem::EntityClass

The RelayClass is the interface to relay entities on BrainStem modules. Relay entities can be set, and the voltage read. Other capabilities may be available, please see the product datasheet.

Public Functions

RelayClass(void)

Constructor.

virtual ~RelayClass(void)

Destructor.

void init(Module *pModule, const uint8_t index)

Initialize the class.

Parameters
  • pModule: The module to which this entity belongs.
  • index: The index of the digital entity being initialized.

aErr setEnable(const uint8_t bEnable)

Set the enable/disable state.

Return
Returns common entity return values
Parameters
  • bEnable: False or 0 = Disabled, True or 1 = Enabled

aErr getEnable(uint8_t *bEnabled)

Get the state.

Return
Returns common entity return values
Parameters
  • bEnabled: False or 0 = Disabled, True or 1 = Enabled

aErr getVoltage(int32_t *microVolts)

Get the scaled micro volt value with refrence to ground.

Note
Not all modules provide 32 bits of accuracy; Refer to the module’s datasheet to determine the analog bit depth and reference voltage.
Return
Returns common entity return values
Parameters
  • microVolts: 32 bit signed integer (in micro Volts) based on the boards ground and refrence voltages.