Crate hass_rs

Async HomeAssistant Websocket Library

Hass-rs is a HomeAssistant Websocket API client library.

It is based on the official API specifications.

Configuring async runtime

hass_rs supports async-std and tokio runtimes, by default it uses async-std, to use tokio change the feature flags in Cargo.toml

[dependencies.hass_rs]
version = "0.1.0"
default-features = false
features = ["tokio-runtime"]

Example usage

It is fetching the Home Assistant Config

use hass_rs::client;
use lazy_static::lazy_static;
use std::env::var;

lazy_static! {
    static ref TOKEN: String =
        var("HASS_TOKEN").expect("need HASS_TOKEN environment variable");
}

#[async_std::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {

// Create the websocket client and connect to gateway
    let mut client = client::connect("localhost", 8123).await?;

// Authenticate the session
    client.auth_with_longlivedtoken(&*TOKEN).await?;
    println!("WebSocket connection and authethication works");

// Fetch the Home Assistant Config
    println!("Get Hass Config");
    match client.get_config().await {
        Ok(v) => println!("{:?}", v),
        Err(err) => println!("Oh no, an error: {}", err),
    }
    Ok(())
}

Re-exports

pub use errors::HassError;

pub use errors::HassResult;

pub use types::*;

pub use client::connect;

pub use client::HassClient;

Modules

client	Home Assistant client implementation
errors	Convenient error handling
types	API types.