hass-rs 0.4.0

An async websocket client for Home Assistant
Documentation 
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
66
67
68
69
70
71
72
73
74
75

use serde::Serialize;
use serde_json::Value;
use tokio_tungstenite::tungstenite::Message as TungsteniteMessage;

/// This enum defines the type of commands that the client is allowed to send to the Websocket server
#[derive(Debug, Serialize)]
#[serde(untagged)]
pub(crate) enum Command {
    AuthInit(Auth),
    Ping(Ask),
    SubscribeEvent(Subscribe),
    #[allow(unused)]
    Unsubscribe(Unsubscribe),
    GetConfig(Ask),
    GetServices(Ask),
    GetStates(Ask),
    GetPanels(Ask),
    CallService(CallService),
    #[allow(dead_code)]
    Close,
}

impl Command {
    /// This function transform a command into a TungsteniteMessage and needs the last
    /// gateway sequence in order to send it correctly
    pub(crate) fn to_tungstenite_message(self) -> TungsteniteMessage {
        let cmd_str = serde_json::to_string(&self).unwrap();
        TungsteniteMessage::text(cmd_str)
    }
}

//used to authenticate the session
#[derive(Debug, Serialize, PartialEq)]
pub(crate) struct Auth {
    #[serde(rename = "type")]
    pub(crate) msg_type: String,
    pub(crate) access_token: String,
}

//used to fetch from server
#[derive(Debug, Serialize, PartialEq)]
pub(crate) struct Ask {
    pub(crate) id: u64,
    #[serde(rename = "type")]
    pub(crate) msg_type: String,
}

//used for Event subscribtion
#[derive(Debug, Serialize, PartialEq)]
pub(crate) struct Subscribe {
    pub(crate) id: u64,
    #[serde(rename = "type")]
    pub(crate) msg_type: String,
    pub(crate) event_type: String,
}

//used for Event Unsubscribe
#[derive(Debug, Serialize, PartialEq)]
pub(crate) struct Unsubscribe {
    pub(crate) id: u64,
    #[serde(rename = "type")]
    pub(crate) msg_type: String,
    pub(crate) subscription: u64,
}

//used to call a service
#[derive(Debug, Serialize, PartialEq)]
pub(crate) struct CallService {
    pub(crate) id: u64,
    #[serde(rename = "type")]
    pub(crate) msg_type: String,
    pub(crate) domain: String,
    pub(crate) service: String,
    pub(crate) service_data: Option<Value>,
}