Signal Entity

See the Signal Entity for generic information.

group SignalEntity

Interface to digital pins configured to produce square wave signals. This class is designed to allow for square waves at various frequencies and duty cycles. Control is defined by specifying the wave period as (T3Time) and the active portion of the cycle as (T2Time). See the entity overview section of the reference for more detail regarding the timing.

void signal_getEnable(unsigned int *id, struct Result *result, int signalNum)

Get the Enable/Disable of the signal.

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.

  • signalNum: The index of the Signal entity.

void signal_setEnable(unsigned int *id, struct Result *result, int signalNum, int enable)

Enable/Disable the signal output.

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

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

  • signalNum: The index of the Signal entity.

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

void signal_getInvert(unsigned int *id, struct Result *result, int signalNum)

Get the invert status the signal output..

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

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

  • signalNum: The index of the Signal entity.

void signal_setInvert(unsigned int *id, struct Result *result, int signalNum, int invert)

Invert the signal output. Normal mode is High on t0 then low at t2. Inverted mode is Low at t0 on period start and high at t2.

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

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

  • signalNum: The index of the Signal entity.

  • invert: The inversion mode to be set. 0 = Normal; 1 = Inverted.

void signal_getT3Time(unsigned int *id, struct Result *result, int signalNum)

Get the signal period or T3 in nanoseconds.

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

  • result: object, containing NO_ERROR and the t3 time in nanoseconds (1e-9s) or a non zero Error code.

  • signalNum: The index of the Signal entity.

void signal_setT3Time(unsigned int *id, struct Result *result, int signalNum, int t3Time)

Set the signal period or T3 in nanoseconds.

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

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

  • signalNum: The index of the Signal entity.

  • t3Time: The t3 time to be set.

void signal_getT2Time(unsigned int *id, struct Result *result, int signalNum)

Get the signal period or T2 in nanoseconds.

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

  • result: object, containing NO_ERROR and the t2 time in nanoseconds (1e-9s) or a non zero Error code.

  • signalNum: The index of the Signal entity.

void signal_setT2Time(unsigned int *id, struct Result *result, int signalNum, int t2Time)

Set the signal period or T2 in nanoseconds.

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

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

  • signalNum: The index of the Signal entity.

  • t2Time: The t2 time to be set.