Relay

class brainstem.entity.Relay(module, index)

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

getEnable()

Get the state. False or 0 = Disabled, True or 1 = Enabled

Returns:

Result object containing the requested value when the results error is set to NO_ERROR(0)

Return type:

Result

getVoltage()

Get the scaled micro volt value with reference to ground. 32 bit signed integer (in micro Volts) based on the boards ground and reference voltages. Note: Not all modules provide 32 bits of accuracy; Refer to the module’s datasheet to determine the analog bit depth and reference voltage.

Returns:

Result object containing the requested value when the results error is set to NO_ERROR(0)

Return type:

Result

setEnable(bEnable)

Set the enable/disable state.

Parameters:

bEnable (const unsigned char) – False or 0 = Disabled, True or 1 = Enabled

Returns:

An error result from the list of defined error codes in brainstem.result

Return type:

unsigned byte