Relay Entity

group RelayEntity

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.

void relay_getEnable(unsigned int *id, struct Result *result, int relayNum)

Get the state.

Parameters
  • id: The id assigned by the create stem vi.

  • result: object, containing NO_ERROR and the enable status or a non zero Error code.

  • relayNum: The index of the Relay entity.

void relay_setEnable(unsigned int *id, struct Result *result, int relayNum, int enable)

Set the enable/disable state.

Parameters
  • id: The id assigned by the create stem vi.

  • result: object, containing NO_ERROR or a non zero Error code.

  • relayNum: The index of the Relay entity.

  • enable: The state to be set. 0 = Disabled; 1 = Enabled.

void relay_getVoltage(unsigned int *id, struct Result *result, int relayNum)

Get the scaled micro volt value with reference to ground.

Parameters
  • id: The id assigned by the create stem vi.

  • result: object, containing NO_ERROR and the voltage in micro volts (1e-6V). or a non zero Error code.

  • relayNum: The index of the Relay entity.