Skip to main content

IBinaryActuator

Interface for controlling two-state actuators (e.g., pneumatic cylinders, solenoid valves).

Namespace: ControlBee.Interfaces

Extends: IActorItem, IUsesPlaceholder

Methods

IsOn

Checks whether the actuator is in the on state.

bool? IsOn(CommandActualType type = CommandActualType.Actual);

Returns: true if on, false if off, or null if unknown.

IsOff

Checks whether the actuator is in the off state.

bool? IsOff(CommandActualType type = CommandActualType.Actual);

Returns: true if off, false if on, or null if unknown.

OnDetect

Checks whether the on-state sensor detects the actuator in the on position.

bool OnDetect();

Returns: true if the on sensor is active.

OffDetect

Checks whether the off-state sensor detects the actuator in the off position.

bool OffDetect();

Returns: true if the off sensor is active.

On

Commands the actuator to turn on.

void On();

Off

Commands the actuator to turn off.

void Off();

OnAndWait

Turns the actuator on and waits for the sensor to confirm.

void OnAndWait();

OffAndWait

Turns the actuator off and waits for the sensor to confirm.

void OffAndWait();

SetOnAndWait

Sets the actuator to the specified state and waits for confirmation.

void SetOnAndWait(bool value);

Parameters:

  • valuetrue to turn on, false to turn off.

Wait

Waits until the actuator reaches its expected state.

void Wait();

See Also