Giter Club home page Giter Club logo

hues's Introduction

hues

A Rust client for the Philips Hue API v2, with a focus on accuracy to the official spec.

Crates.io (version)

GitHub stars GitHub forks GitHub watchers Follow on GitHub

hues uses reqwest and the tokio async runtime. It currently supports most basic operations, such as:

  • Local network device discovery
    • Via mDNS using the mdns crate, requires the mdns feature
    • Via HTTPS using the Hue Discovery Endpoint
  • App key creation
  • Light, Group, and Scene control
  • Schedule and Smart Scene management

It does not yet support the following features:

  • Entertainment API for fast, synchronous light effects via UDP
  • Advanced features regarding Entertainment Configurations

Warning

This is an experimental library, and is subject to change. Use at your own risk.

Installation

cargo add hues

Usage

If you already know your Bridge IP address and have previously created an App Key, constructing a client is quick and simple:

use hues::prelude::*;

#[tokio::main]
async fn main() -> Result<(), HueAPIError> {
    // Construct a Bridge when IP and App Key are known
    let bridge = Bridge::new([10u8, 0, 0, 123], "my-app-key");
    // Refresh it to fetch the current state of all resources
    bridge.refresh().await?;
    
    // Toggle the power state of a Room named "office", if it exists
    if let Some(office) = bridge.rooms().iter().find(|r| r.name() == "office") {
        office.toggle().await?;
    }
    Ok(())
}

Bridge discovery and registration

When the Bridge IP address is not known, you can locate the device on the local network using the Bridge::discover associated function. If you are creating an app for the first time, the Bridge::create_app method initializes new credentials that can be used for future authentication.

use hues::prelude::*
use std::time::Duration;

#[tokio::main]
async fn main() {
    // Discover a Hue Bridge on the local network, and initialize polling
    // to synchronize state every 30 seconds.
    let mut bridge = Bridge::discover()
        .await
        .unwrap()
        .build()
        .poll(Duration::from_secs(30))
        .await;
    // This is your App Key, it should be saved for future sessions
    // NOTE: press the `Link Button` on the Hues Bridge before attempting
    // to create new app credentials.
    let key = bridge.create_app("my_app", "my_instance").await.unwrap();

    // Blink each light to confirm you're registered!
    for light in bridge.lights() {
        let _ = light.identify().await;
    }
}

Automatic sync with sse

Optionally, you can sync automatically by listening for Server-Sent Events. The bridge will communicate changes as they happen to the client, and you can take action if you choose to do so:

use hues::prelude::*;

#[tokio::main]
async main() -> Result<(), HueAPIError> {
    let bridge = Bridge::new([10u8, 0, 0, 123], "my_app_key").listen(|_rids| {
        // Do something whenever changes are sent from the Bridge
    });
}

License

MIT © Tobias Fried

hues's People

Contributors

rektdeckard avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.