Struct Bridge

pub struct Bridge { /* private fields */ }

A bridge with IP address and username.

Implementations

impl Bridge

pub fn new<S>(ip_address: IpAddr, username: S) -> Self

where S: Into<String>,

Creates a new bridge.

Examples

Create a bridge with an already registered user:

use huelib::Bridge;
use std::net::{IpAddr, Ipv4Addr};

let ip = IpAddr::V4(Ipv4Addr::new(192, 168, 1, 2));
let bridge = Bridge::new(ip, "username");

Examples found in repository

examples/get_all_lights.rs (line 13)

fn main() {
    // Discover bridges in the local network and save the first IP address as `bridge_ip`.
    let bridge_ip = bridge::discover_nupnp().unwrap().pop().unwrap();

    // Register a new user.
    let username = bridge::register_user(bridge_ip, "huelib-rs example").unwrap();

    // Create a new bridge.
    let bridge = Bridge::new(bridge_ip, username);

    // Print out every light that is connected to the bridge.
    let lights = bridge.get_all_lights().unwrap();
    println!("{:?}", lights);
}

examples/delete_light.rs (line 13)

fn main() {
    // Discover bridges in the local network and save the first IP address as `bridge_ip`.
    let bridge_ip = bridge::discover_nupnp().unwrap().pop().unwrap();

    // Register a new user.
    let username = bridge::register_user(bridge_ip, "huelib-rs example").unwrap();

    // Create a new bridge.
    let bridge = Bridge::new(bridge_ip, username);

    // Deletes the light with the id 1.
    match bridge.delete_light("1") {
        Ok(_) => println!("Deleted light"),
        Err(e) => println!("Failed to delete light: {}", e),
    };
}

examples/set_light_state.rs (line 14)

fn main() {
    // Discover bridges in the local network and save the first IP address as `bridge_ip`.
    let bridge_ip = bridge::discover_nupnp().unwrap().pop().unwrap();

    // Register a new user.
    let username = bridge::register_user(bridge_ip, "huelib-rs example").unwrap();

    // Create a new bridge.
    let bridge = Bridge::new(bridge_ip, username);

    // Creates a new light modifier to turn on the light, set the saturation to 10 and decrement
    // the brightness by 40.
    let light_modifier = light::StateModifier::new()
        .with_on(true)
        .with_saturation(Adjust::Override(10))
        .with_alert(Alert::Select)
        .with_brightness(Adjust::Decrement(40));

    // Modify the attributes declared in `light_modifier` on the light with the id 1.
    let response = bridge.set_light_state("1", &light_modifier).unwrap();
    println!("{:?}", response);
}

pub fn username(&self) -> &str

Returns the name of the user that is connected to the bridge.

pub fn ip_address(&self) -> &IpAddr

Returns the IP address of the bridge.

pub fn set_config(&self, modifier: &Modifier) -> Result<Vec<Response<Modified>>>

Modifies the configuration of the bridge.

pub fn get_config(&self) -> Result<Config>

Returns the configuration of the bridge.

pub fn set_light_attribute<S>( &self, id: S, modifier: &AttributeModifier, ) -> Result<Vec<Response<Modified>>>

where S: Into<String>,

Modifies attributes of a light.

pub fn set_light_state<S>( &self, id: S, modifier: &StateModifier, ) -> Result<Vec<Response<Modified>>>

where S: Into<String>,

Modifies the state of a light.

Examples found in repository

examples/set_light_state.rs (line 25)

fn main() {
    // Discover bridges in the local network and save the first IP address as `bridge_ip`.
    let bridge_ip = bridge::discover_nupnp().unwrap().pop().unwrap();

    // Register a new user.
    let username = bridge::register_user(bridge_ip, "huelib-rs example").unwrap();

    // Create a new bridge.
    let bridge = Bridge::new(bridge_ip, username);

    // Creates a new light modifier to turn on the light, set the saturation to 10 and decrement
    // the brightness by 40.
    let light_modifier = light::StateModifier::new()
        .with_on(true)
        .with_saturation(Adjust::Override(10))
        .with_alert(Alert::Select)
        .with_brightness(Adjust::Decrement(40));

    // Modify the attributes declared in `light_modifier` on the light with the id 1.
    let response = bridge.set_light_state("1", &light_modifier).unwrap();
    println!("{:?}", response);
}

pub fn get_light<S>(&self, id: S) -> Result<Light>

where S: Into<String>,

Returns a light.

pub fn get_all_lights(&self) -> Result<Vec<Light>>

Returns all lights that are connected to the bridge.

Examples found in repository

examples/get_all_lights.rs (line 16)

fn main() {
    // Discover bridges in the local network and save the first IP address as `bridge_ip`.
    let bridge_ip = bridge::discover_nupnp().unwrap().pop().unwrap();

    // Register a new user.
    let username = bridge::register_user(bridge_ip, "huelib-rs example").unwrap();

    // Create a new bridge.
    let bridge = Bridge::new(bridge_ip, username);

    // Print out every light that is connected to the bridge.
    let lights = bridge.get_all_lights().unwrap();
    println!("{:?}", lights);
}

pub fn search_new_lights(&self, scanner: &Scanner) -> Result<()>

Starts searching for new lights.

The bridge will open the network for 40 seconds. The overall search might take longer since the configuration of new devices can take longer. If many devices are found the command will have to be issued a second time after discovery time has elapsed. If the command is received again during search the search will continue for at least an additional 40 seconds.

When the search has finished, new lights will be available using the get_new_lights function.

pub fn get_new_lights(&self) -> Result<Scan>

Returns discovered lights.

pub fn delete_light<S>(&self, id: S) -> Result<()>

where S: Into<String>,

Deletes a light from the bridge.

Examples found in repository

examples/delete_light.rs (line 16)

fn main() {
    // Discover bridges in the local network and save the first IP address as `bridge_ip`.
    let bridge_ip = bridge::discover_nupnp().unwrap().pop().unwrap();

    // Register a new user.
    let username = bridge::register_user(bridge_ip, "huelib-rs example").unwrap();

    // Create a new bridge.
    let bridge = Bridge::new(bridge_ip, username);

    // Deletes the light with the id 1.
    match bridge.delete_light("1") {
        Ok(_) => println!("Deleted light"),
        Err(e) => println!("Failed to delete light: {}", e),
    };
}

pub fn create_group(&self, creator: &Creator) -> Result<String>

Creates a new group.

pub fn set_group_attribute<S>( &self, id: S, modifier: &AttributeModifier, ) -> Result<Vec<Response<Modified>>>

where S: Into<String>,

Modifies attributes of a group.

pub fn set_group_state<S>( &self, id: S, modifier: &StateModifier, ) -> Result<Vec<Response<Modified>>>

where S: Into<String>,

Modifies the state of a group.

pub fn get_group<S>(&self, id: S) -> Result<Group>

where S: Into<String>,

Returns a group.

pub fn get_all_groups(&self) -> Result<Vec<Group>>

Returns all groups.

pub fn delete_group<S>(&self, id: S) -> Result<()>

where S: Into<String>,

Deletes a group from the bridge.

pub fn create_scene(&self, creator: &Creator) -> Result<String>

Creates a new scene.

pub fn set_scene<S>( &self, id: S, modifier: &Modifier, ) -> Result<Vec<Response<Modified>>>

where S: Into<String>,

Modifies the state and attributes of a scene.

pub fn get_scene<S>(&self, id: S) -> Result<Scene>

where S: Into<String>,

Returns a scene.

pub fn get_all_scenes(&self) -> Result<Vec<Scene>>

Returns all scenes.

pub fn delete_scene<S>(&self, id: S) -> Result<()>

where S: Into<String>,

Deletes a scene.

pub fn get_capabilities(&self) -> Result<Capabilities>

Returns the capabilities of resources.

pub fn create_schedule(&self, creator: &Creator) -> Result<String>

Creates a new schedule and returns the identifier.

pub fn set_schedule<S>( &self, id: S, modifier: &Modifier, ) -> Result<Vec<Response<Modified>>>

where S: Into<String>,

Modifies attributes of a schedule.

pub fn get_schedule<S>(&self, id: S) -> Result<Schedule>

where S: Into<String>,

Returns a schedule.

pub fn get_all_schedules(&self) -> Result<Vec<Schedule>>

Returns all schedules.

pub fn delete_schedule<S>(&self, id: S) -> Result<()>

where S: Into<String>,

Deletes a schedule.

pub fn create_resourcelink(&self, creator: &Creator) -> Result<String>

Creates a new resourcelink and returns the identifier.

pub fn set_resourcelink<S>( &self, id: S, modifier: &Modifier, ) -> Result<Vec<Response<Modified>>>

where S: Into<String>,

Modifies attributes of a resourcelink.

pub fn get_resourcelink<S>(&self, id: S) -> Result<Resourcelink>

where S: Into<String>,

Returns a resourcelink.

pub fn get_all_resourcelinks(&self) -> Result<Vec<Resourcelink>>

Returns all resourcelinks.

pub fn delete_resourcelink<S>(&self, id: S) -> Result<()>

where S: Into<String>,

Deletes a resourcelink.

pub fn set_sensor_attribute<S>( &self, id: S, modifier: &AttributeModifier, ) -> Result<Vec<Response<Modified>>>

where S: Into<String>,

Modifies attributes of a sensor.

pub fn set_sensor_state<S>( &self, id: S, modifier: &StateModifier, ) -> Result<Vec<Response<Modified>>>

where S: Into<String>,

Modifies the state of a sensor.

pub fn set_sensor_config<S>( &self, id: S, modifier: &ConfigModifier, ) -> Result<Vec<Response<Modified>>>

where S: Into<String>,

Modifies the configuration of a sensor.

pub fn get_sensor<S>(&self, id: S) -> Result<Sensor>

where S: Into<String>,

Returns a sensor.

pub fn get_all_sensors(&self) -> Result<Vec<Sensor>>

Returns all sensors that are connected to the bridge.

pub fn search_new_sensors(&self, scanner: &Scanner) -> Result<()>

Starts searching for new sensors.

The bridge will open the network for 40 seconds. The overall search might take longer since the configuration of new devices can take longer. If many devices are found the command will have to be issued a second time after discovery time has elapsed. If the command is received again during search the search will continue for at least an additional 40 seconds.

When the search has finished, new sensors will be available using the get_new_sensors function.

pub fn get_new_sensors(&self) -> Result<Scan>

Returns discovered sensors.

pub fn delete_sensor<S>(&self, id: S) -> Result<()>

where S: Into<String>,

Deletes a sensor from the bridge.

pub fn create_rule(&self, creator: &Creator) -> Result<String>

Creates a new rule.

pub fn set_rule<S>( &self, id: S, modifier: &Modifier, ) -> Result<Vec<Response<Modified>>>

where S: Into<String>,

Modifies attributes of a rule.

pub fn get_rule<S>(&self, id: S) -> Result<Rule>

where S: Into<String>,

Returns a rule.

pub fn get_all_rules(&self) -> Result<Vec<Rule>>

Returns all rules.

pub fn delete_rule<S>(&self, id: S) -> Result<()>

where S: Into<String>,

Deletes a rule.

Trait Implementations

impl Clone for Bridge

fn clone(&self) -> Bridge

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Bridge

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

Formats the value using the given formatter.

impl Hash for Bridge

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Bridge

fn eq(&self, other: &Bridge) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Bridge

impl StructuralPartialEq for Bridge