Relay Entity

group RelayEntity

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.

void relay_setEnable(unsigned int *id, struct Result *result, const int index, const unsigned char bEnable)

Set the enable/disable state.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone on success. Non-zero error code on failure.

  • index – The index of the entity in question.

  • bEnable – False or 0 = Disabled, True or 1 = Enabled

Returns:

Returns common entity return values

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

Get the state.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values

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

Get the scaled micro volt value with reference to ground.

Parameters:

  • id – The id assigned by the create stem vi.

  • result – Object containing aErrNone and the requested value on success. Non-zero error code on failure.

  • index – The index of the entity in question.

Returns:

Returns common entity return values