1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

//! # Async HomeAssistant Websocket Library
//!
//! Hass-rs is a HomeAssistant Websocket API client library.
//!
//! It is based on the [official API specifications](https://developers.home-assistant.io/docs/api/websocket).
//!
//! # 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`
//!
//! ```toml
//! [dependencies.hass_rs]
//! version = "0.1.0"
//! default-features = false
//! features = ["tokio-runtime"]
//! ```
//!
//!
//! # Example usage
//! It is fetching the Home Assistant Config
//!
//! ```rust
//! 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(())
//! }
//! ```

pub mod errors;
pub use errors::{HassError, HassResult};

pub mod types;
pub use types::*;

pub mod client;
pub use client::{connect, HassClient};

mod runtime;
use runtime::{connect_async, task, WebSocket};

mod wsconn;
use wsconn::WsConn;