Struct Device

pub struct Device { /* private fields */ }

Represents a device.

For the details of fields, please refer to the devices section of the API documentation.

Implementations

impl Device

pub fn device_id(&self) -> &str

The device ID.

pub fn device_name(&self) -> &str

The device name. This is the name configured in the SwitchBot app.

pub fn is_remote(&self) -> bool

True if this device is an infrared remote device.

pub fn device_type(&self) -> &str

The device type. This is empty if this is an infrared remote device.

pub fn remote_type(&self) -> &str

The device type for an infrared remote device.

pub fn hub_device_id(&self) -> &str

The parent Hub ID.

pub async fn command(&self, command: &CommandRequest) -> Result<()>

Send the command to the SwitchBot API.

Please also see the CommandRequest.

Examples

let command = CommandRequest { command: "turnOn".into(), ..Default::default() };
device.command(&command).await?;

pub async fn update_status(&self) -> Result<()>

Get the device status from the SwitchBot API.

Please see Device::status_by_key() and some other functions to retrieve the status captured by this function.

pub fn status_by_key(&self, key: &str) -> Option<Value>

Get the value of a key from the device status.

The Device::update_status() must be called prior to this function.

Examples

device.update_status().await?;
println!("Power = {}", device.status_by_key("power").unwrap());

pub fn eval_condition(&self, condition: &str) -> Result<bool>

Evaluate a conditional expression.

Following operators are supported.

• key, key=true, and key=false for boolean types.
• =, <, <=, >, and >= for numeric types.
• = for string and other types.

Returns an error if the expression is invalid, or if the key does not exist. Please also see the switchbot-cli documentation about the “if-command”.

The Device::update_status() must be called prior to this function.

Examples

device.update_status().await?;
println!("Power-on = {}", device.eval_condition("power=on")?);

pub fn write_status_to(&self, writer: impl Write) -> Result<()>

Write the list of the device status to the writer.

The Device::update_status() must be called prior to this function.

Examples

device.update_status().await?;
device.write_status_to(std::io::stdout());

Trait Implementations

impl Debug for Device

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Device

fn default() -> Device

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Device

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Device

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.