ANY-maze Help > The ANY-maze reference > The Protocol page > The elements of a protocol > Inputs and outputs > On/off outputs > On/off output actions

On/off output actions

Introduction

As you may know, a procedure can include actions, some of which can affect an on/off output - these are detailed below.

Actions

Activate the output

Sets the output to its active state. If an output is already active, this action has no effect. If the output is set to turn on or off for a set duration, then it will automatically deactivate after the appropriate time. If the output is set to create a pulse train, this will start the pulses.

Deactivate the output

Sets the output to its inactive state. If the output is already inactive, this action has no effect. If the output is set to turn on or off for a set duratio, but the duration has not yet passed, then this action will deactivate the output (and cancel the pulse timing). If the output is set to create a pulse train, this will end the pulses immediately, even if this is in the middle of a pulse.

Set output frequency

Changes the frequency of the pulses of a pulse train to the value specified as the action's parameter. The parameter is in Hertz. If the on/off output is not set to create a pulse train, this action will have no effect. This action will not activate (or deactivate) the output. If the output is active, then the pulse train frequency will change on-the-fly and the change will be asynchronous, i.e. it will not occur at the end of a cycle.

Set output duty cycle

Changes the duty cycle of a pulse train to the value specified as the action's parameter. The parameter is in percent and represents the amount of a single cycle for which the output will be ON. If the on/off output is not set to create a pulse train, this action will have no effect. This action will not activate (or deactivate) the output. If the output is active, then the duty cycle will change on-the-fly and the change will be asynchronous, i.e. it will not occur at the end of a cycle.

Set output duration

Changes the duration for which the on/off output will be active to the value specified as the action's parameter. The duration can be any time value, and can include units of ms (milliseconds), s (seconds), min or m (minutes), h (hours) and d (days); if no units are specified seconds are assumed. If the output is not set to turn on or turn off for a specific duration, or to create a pulse train, this action will have no effect. This action notes the new duration, but it will only be used the next time the on/off output is activated. This means that if the output is active when the duration is set, the output will continue to use the old duration until that duration passes (or the output is deactivated).

ANY-maze help topic T0199