Signal¶
See the Signal Entity for generic information.
- class brainstem.entity.Signal(module, index)[source]¶
SignalClass: 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.
- getEnable()[source]¶
Get the Enable/Disable of the signal. True to enable, false to disable
- Returns:
Result object containing the requested value when the results error is set to NO_ERROR(0)
- Return type:
- getInvert()[source]¶
Get the invert status 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. to invert, false for normal mode.
- Returns:
Result object containing the requested value when the results error is set to NO_ERROR(0)
- Return type:
- getT2Time()[source]¶
Get the signal active period or T2 in nanoseconds. Integer not larger than unsigned 32 bit max value representing the wave active period in nanoseconds.
- Returns:
Result object containing the requested value when the results error is set to NO_ERROR(0)
- Return type:
- getT3Time()[source]¶
Get the signal period or T3 in nanoseconds. Integer not larger than unsigned 32 bit max value representing the wave period in nanoseconds.
- Returns:
Result object containing the requested value when the results error is set to NO_ERROR(0)
- Return type:
- setEnable(enable)[source]¶
Enable/Disable the signal output.
- Parameters:
enable (const unsigned char) – True to enable, false to disable
- Returns:
An error result from the list of defined error codes in brainstem.result
- Return type:
unsigned byte
- setInvert(invert)[source]¶
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:
invert (const unsigned char) – to invert, false for normal mode.
- Returns:
An error result from the list of defined error codes in brainstem.result
- Return type:
unsigned byte
- setT2Time(t2_nsec)[source]¶
Set the signal active period or T2 in nanoseconds.
- Parameters:
t2_nsec (const unsigned int) – Integer not larger than unsigned 32 bit max value representing the wave active period in nanoseconds.
- Returns:
An error result from the list of defined error codes in brainstem.result
- Return type:
unsigned byte
- setT3Time(t3_nsec)[source]¶
Set the signal period or T3 in nanoseconds.
- Parameters:
t3_nsec (const unsigned int) – Integer not larger than unsigned 32 bit max value representing the wave period in nanoseconds.
- Returns:
An error result from the list of defined error codes in brainstem.result
- Return type:
unsigned byte