Struct SwitchBot

pub struct SwitchBot { /* private fields */ }

Represents a SwitchBot API server.

Implementations

impl SwitchBot

pub fn new() -> Self

Construct a new instance with the default parameters.

pub fn new_with_authentication(token: &str, secret: &str) -> Self

Construct a new instance with the authentication information.

Please refer to the SwitchBot documentation about how to obtain the token and secret key.

This function is equivalent to:

let mut switch_bot = SwitchBot::new();
switch_bot.set_authentication(token, secret);

pub fn new_for_test(num_devices: usize) -> Self

Construct an instance for testing. The instance has the specified number of devices for testing.

pub fn set_authentication(&mut self, token: &str, secret: &str)

Set the authentication information.

Please refer to the SwitchBot documentation about how to obtain the token and secret key.

pub fn devices(&self) -> &DeviceList

Returns a list of Devices. This list is empty initially. Call SwitchBot::load_devices() to populate the list.

pub async fn load_devices(&mut self) -> Result<()>

Load the device list from the SwitchBot API.

Trait Implementations

impl Debug for SwitchBot

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

Formats the value using the given formatter.

impl Default for SwitchBot

fn default() -> SwitchBot

Returns the “default value” for a type.