Monitor Happened Io Signal

Checks if at least one of the received values of an io signal verifies a comparison

operation against a value during a timeout. The call to this function will block the execution until the attribute value that satisfies the conditions is found or the timeout is expired.

Arguments Description

channel_path (str): The channel path should be in the format: HW::SignalHwName or PS::psChannelName.

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 reference signal value.

timeout (int): A defined period of time 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 at least one of the received values of an io signal is verifies a comparison

operation against a value; otherwise, False.

Example

${res}= Monitor Happened Io Signal HW::${SignalHwName} Voltage ${11} ${2000}

Note

  • No io observer needs to be started to monitor the io signal .

  • If io observer on that signal is already active, 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 io signal.