Struct huelib::bridge::Bridge

pub struct Bridge {
    pub username: String,
    pub ip_address: IpAddr,
    // some fields omitted
}

A bridge with IP address and username.

Fields

username: String

Name of the user that is connected to the bridge.

ip_address: IpAddr

IP address of the bridge.

Methods

impl Bridge

pub fn new(ip_address: IpAddr, username: &str) -> Self

Creates a new bridge.

Examples

Create a bridge with an already registered user.

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

let bridge_ip = IpAddr::V4(Ipv4Addr::new(192, 168, 1, 2));
let bridge = huelib::Bridge::new(bridge_ip, "example-username");

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

Returns the configuration of the bridge.

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

Modifies the configuration of the bridge

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

Modifies attributes of a light.

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

Modifies the state of a light.

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

Deletes a light from the bridge.

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

Returns a light.

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

Returns all lights that are connected to the bridge.

pub fn search_new_lights(
    &self,
    device_ids: Option<&[&str]>
) -> Result<(), Error>

Starts searching for new lights.

The bridge will open the network for 40s. The overall search might take longer since the configuration of (multiple) 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 40s.

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

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

Returns lights that were discovered the last time a search for new lights was performed. The list of new lights is always deleted when a new search is started.

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

Creates a new group.

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

Modifies attributes of a group.

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

Modifies the state of a group.

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

Deletes a group from the bridge.

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

Returns a group.

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

Returns all groups.

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

Creates a new scene.

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

Modifies light states of a scene.

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

Deletes a scene.

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

Returns a scene.

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

Returns all scenes.

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

Returns the capabilities of resources.

Trait Implementations

impl Clone for Bridge

fn clone(&self) -> Bridge

Returns a copy 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 Eq for Bridge

impl PartialEq<Bridge> for Bridge

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for Bridge

impl StructuralPartialEq for Bridge