Monitor Io Always Signal
- Checks all received io signal values during a timeout
and verifies the comparison operation against the provided signal value.
Arguments Description
signal_path (str): The signal path should be in the format: HW::SignalHwName.
- attribute_name (str): HW type: it could be: { Voltage,
Current, DutyCycle only relevant for PWM (yaml field –> MeasurementAttribute: PWM, Frequency, Power : relevant only for PS_Channel, Resistance, RawValue, ShortCutToVbat, ShortCutToGnd, OpenLoad, LowVoltage}
signal_value (int): The expected signal value.
timeout (int): A predefined period in milliseconds.
- comparison (CompareOperation, optional): Defaults to CompareOperation.EQ.
CompareOperation | value | Sign |EQ | 0 | == |GE | 1 | >= |GT | 2 | > |LE | 3 | <= |LT | 4 | < |NE | 5 | != |
Returns
- bool: True if all received io signal values verify the comparaison operation against the expected signal value
during the timeout; otherwise, False.
Example
Monitor Io Always Signal HW::${SignalHwName} Voltage ${8} ${2000} ${2}
Note
If no data point is received during the timeout, the last received value is checked.
No io signal observer needs to be started to monitor the io signal.
If an io signal observer on that io signal is already activated, all the received values of that observer will be cleared. Nevertheless the observer will not be stopped after the timeout and will continue monitoring the signal.