open_ecc 0.0.6

Unofficial Elgato Command Centre API
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217

use crate::serialization::{
    temperature_handler, temperature_option_handler, u8_bool_handler, u8_bool_option_handler,
};
use serde::{Deserialize, Serialize};

#[derive(Debug, Default, Serialize, Deserialize, Clone)]
#[serde(rename_all = "camelCase")]
pub struct LightsGet {
    pub number_of_lights: u8,
    pub lights: Vec<LightGet>,
}

#[derive(Debug, Default, Serialize, Deserialize, Clone)]
#[serde(rename_all = "camelCase")]
pub struct LightsPut {
    pub lights: Vec<LightPut>,
}

#[derive(Debug, Default, Serialize, Deserialize, Clone, Copy)]
#[serde(rename_all = "camelCase")]
pub struct LightGet {
    /// State
    #[serde(with = "u8_bool_handler")]
    pub on: bool,
    /// Brightness
    pub brightness: u8,
    #[serde(with = "temperature_handler")]
    /// Range: 2900 - 7000 Kelvin
    pub temperature: u16,
}

#[derive(Debug, Default, Serialize, Deserialize, Clone, Copy)]
#[serde(rename_all = "camelCase")]
pub struct LightPut {
    /// State
    #[serde(
        skip_serializing_if = "Option::is_none",
        with = "u8_bool_option_handler"
    )]
    pub on: Option<bool>,
    /// Range: 0 - 100
    #[serde(skip_serializing_if = "Option::is_none")]
    pub brightness: Option<u8>,
    /// Range: 2900 - 7000 Kelvin
    #[serde(
        skip_serializing_if = "Option::is_none",
        with = "temperature_option_handler"
    )]
    pub temperature: Option<u16>,
}

#[derive(Debug, Default, Serialize, Deserialize, Clone)]
#[serde(rename_all = "camelCase")]
pub struct LightsSettingsGet {
    /// State: 0 | 1
    pub power_on_behavior: u8,
    /// Range: 0 - 100
    pub power_on_brightness: u8,
    /// Range: 2900 - 7000 (increments of 50)
    #[serde(with = "temperature_handler")]
    pub power_on_temperature: u16,
    pub switch_on_duration_ms: u16,
    pub switch_off_duration_ms: u16,
    pub color_change_duration_ms: u16,
    pub remote_control: RemoteControl,
}

#[derive(Debug, Default, Serialize, Deserialize, Clone)]
#[serde(rename_all = "camelCase")]
pub struct RemoteControl {
    pub favourites: Vec<Favourite>,
    pub auto_mode: AutoMode,
}

#[derive(Debug, Default, Serialize, Deserialize, Clone, Copy)]
#[serde(rename_all = "camelCase")]
pub struct Favourite {
    /// Range: 0 - 100
    pub brightness: u8,
    /// Range: 2900 - 7000 (increments of 50)
    #[serde(with = "temperature_handler")]
    pub temperature: u16,
}

#[derive(Debug, Default, Serialize, Deserialize, Clone, Copy)]
#[serde(rename_all = "camelCase")]
pub struct AutoMode {
    pub target_lux_value: u16,
}

#[derive(Debug, Default, Serialize, Deserialize, Clone)]
#[serde(rename_all = "camelCase")]
pub struct LightsSettingsPut {
    /// State: 0 | 1
    pub power_on_behavior: Option<u8>,
    /// Range: 0 - 100
    pub power_on_brightness: Option<u8>,
    /// Range: 2900 - 7000 (increments of 50)
    #[serde(
        skip_serializing_if = "Option::is_none",
        with = "temperature_option_handler"
    )]
    pub power_on_temperature: Option<u16>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub switch_on_duration_ms: Option<u16>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub switch_off_duration_ms: Option<u16>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub color_change_duration_ms: Option<u16>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub remote_control: Option<RemoteControlPut>,
}

#[derive(Debug, Default, Serialize, Deserialize, Clone)]
#[serde(rename_all = "camelCase")]
pub struct RemoteControlPut {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub favourites: Option<Vec<FavouritePut>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub auto_mode: Option<AutoModePut>,
}

#[derive(Debug, Default, Serialize, Deserialize, Clone, Copy)]
#[serde(rename_all = "camelCase")]
pub struct FavouritePut {
    /// Range: 0 - 100
    #[serde(skip_serializing_if = "Option::is_none")]
    pub brightness: Option<u8>,
    /// Range: 2900 - 7000 (increments of 50)
    #[serde(
        skip_serializing_if = "Option::is_none",
        with = "temperature_option_handler"
    )]
    pub temperature: Option<u16>,
}

#[derive(Debug, Default, Serialize, Deserialize, Clone, Copy)]
#[serde(rename_all = "camelCase")]
pub struct AutoModePut {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub target_lux_value: Option<u16>,
}

#[derive(Debug, Default, Serialize, Deserialize, Clone)]
#[serde(rename_all = "camelCase")]
pub struct AccessoryInfoGet {
    pub product_name: String,
    pub hardware_board_type: u16,
    pub hardware_revision: String,
    pub mac_address: String,
    pub firmware_build_number: u16,
    pub firmware_version: String,
    pub serial_number: String,
    /// The user specified name of the device
    pub display_name: String,
    pub features: Vec<String>,
    #[serde(rename = "wifi-info")]
    pub wifi_info: WifiInfo,
    #[serde(rename = "bt-info")]
    pub bt_info: BtInfo,
}

#[derive(Debug, Default, Serialize, Deserialize, Clone)]
#[serde(rename_all = "camelCase")]
pub struct AccessoryInfoPut {
    /// The user specified name of the device
    #[serde(skip_serializing_if = "Option::is_none")]
    pub display_name: Option<String>,
}

#[derive(Debug, Default, Serialize, Deserialize, Clone)]
#[serde(rename_all = "camelCase")]
pub struct WifiInfo {
    pub ssid: String,
    #[serde(rename = "frequencyMHz")]
    pub frequency_mhz: u16,
    pub rssi: i8,
}

#[derive(Debug, Default, Serialize, Deserialize, Clone, Copy)]
#[serde(rename_all = "camelCase")]
pub struct BtInfo {
    pub broadcast_mode: u8,
    pub pairing: bool,
    pub paired: bool,
}

#[derive(Debug, Default, Serialize, Deserialize, Clone)]
pub struct WifiConfig {
    #[serde(rename = "SSID")]
    pub ssid: String,
    #[serde(rename = "Passphrase", skip_serializing_if = "Option::is_none")]
    pub passphrase: Option<String>,
    #[serde(rename = "SecurityType")]
    pub security_type: WifiSecurity,
    /// Range: 1 - 14
    #[serde(rename = "Channel", skip_serializing_if = "Option::is_none")]
    pub channel: Option<u8>,
}

#[derive(Debug, Default, Serialize, Deserialize, Clone, Copy)]
pub enum WifiSecurity {
    #[default]
    None = 0,
    WpaOrWpa2Personal = 2,
}

#[derive(Debug, Default, Serialize, Deserialize, Clone)]
pub struct JsonErrors {
    pub errors: Vec<JsonError>,
}

#[derive(Debug, Default, Serialize, Deserialize, Clone)]
pub struct JsonError {
    pub message: String,
    pub code: i32,
}