Struct hust::bridge::Bridge

pub struct Bridge {
    pub url_base: String,
    pub device: BridgeDevice,
}

An object to communicate with a bridge.

The struct attributes contain the static properties of the bridge.

The methods can be used for communication like commands.

Fields

url_base: String

The base URL of the bridge, which all /api/ resources are below of.

device: BridgeDevice

The device properties of this bridge.

Implementations

impl Bridge

pub fn from_description_url(url: String) -> Result<Bridge>

Creates a Bridge object from a description URL like returned in SSDP discovery.

pub fn user_readable_identifier(&self) -> &str

The unique but user-friendly name of the bridge.

pub fn register_user(&self) -> Result<String>

Registers a user and return its name.

Save it to communicate further with the bridge, e.g. to switch lights.

Note that the button of the bridge has to be pressed.

pub fn modify_light<T: Serialize>(
    &self,
    user: &str,
    light: &str,
    key: &str,
    value: T
) -> Result<()>

Set an attribute of a light.

user is the user you had to register with register_user.

light is the identifier of the light. All identifiers can be obtained by listing the HashMap keys of get_all_lights.

key can be any attribute of crate::lights::LightState.

pub fn get_all_lights(&self, user: &str) -> Result<HashMap<String, Light>>

List all lights connected to this bridge

The listed lights are bundled with their state. You have to specify a user in order to be authenticated.

pub fn switch_light(&self, user: &str, light: &str, on: bool) -> Result<()>

Switch light on / off.

user is the user you had to register with register_user.

light is the identifier of the light. All identifiers can be obtained by listing the HashMap keys of get_all_lights.

To switch the light off, specify on as false.

Trait Implementations

impl Debug for Bridge

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Bridge

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Bridge

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.