Struct Switch 

pub struct Switch { /* private fields */ }

For things that go on and off. Ex: lights, water pump, water heater, etc.

Implementations

impl Switch

pub fn new(thing: Thing) -> Result<Self, SwitchError>

Create a new Switch from a generic “Thing”. LCI gateway must publish the type as a Switch.

pub fn label(&self) -> String

Returns the label of the device such as “Water Pump” or “Kitchen Lights”.

pub async fn online(&self) -> Result<OnlineState, OnlineStateConversionError>

Returns the device’s online state.

pub async fn on(&mut self) -> Result<(), SetError>

Turns the relay/switch on.

pub async fn off(&mut self) -> Result<(), SetError>

Turns the relay/switch off.

pub async fn state(&self) -> Result<SwitchState, SwitchStateConversionError>

Gets the current relay state.

pub async fn fault(&self) -> Result<SwitchState, SwitchStateConversionError>

Gets if the fault state is on or off.

pub async fn relay_current(&self) -> Result<String, SwitchRelayCurrentError>

Gets the current being used by the relay.