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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
|
# Data Models
Data models are used to strongly type and verify API request and response structure. All
API calls require a data model to be passed in as a parameter. Each module in the `pyvesync.models` module is for a specific product type or API call.
The dataclasses inherit from mashumaro's `DataClassORJSONMixin` which allows for easy serialization and deserialization of the data models, as well as providing a discrimintor for subclasses.
The `bypassv2_models` module is a generic mixin for the bypassv2 API calls.
- [Data Models](#data-models)
- [Data Models Module](#data-models-module)
- [Base Models](#base-models)
- [BypassV2 Models](#bypassv2-models)
- [VeSync General API Models](#vesync-general-api-models)
- [Bulb Models](#bulb-models)
- [Fan Models](#fan-models)
- [Humidifier Models](#humidifier-models)
- [Outlet Models](#outlet-models)
- [Purifier Models](#purifier-models)
- [Switch Models](#switch-models)
- [Fryer Models](#fryer-models)
- [Thermostat Models](#thermostat-models)
## Data Models Module
::: pyvesync.models
options:
members: false
heading_level: 3
show_root_heading: false
show_root_toc_entry: false
## Base Models
::: pyvesync.models.base_models
options:
show_signature_annotations: true
heading_level: 3
show_submodules: false
signature_crossrefs: true
show_root_heading: false
show_category_heading: true
show_root_toc_entry: true
inherited_members: false
show_source: true
filters:
- "!Config"
- "!^__.*"
- "!^_.*"
- "!IntFlag"
- "!StrFlag"
- "!RGB"
- "!Color"
- "!HSV"
## BypassV2 Models
::: pyvesync.models.bypass_models
options:
show_signature_annotations: true
show_submodules: false
heading_level: 3
signature_crossrefs: true
show_root_heading: false
show_category_heading: true
show_root_toc_entry: true
inherited_members: false
show_source: true
filters:
- "!Config"
- "!^__.*"
- "!^_.*"
- "!IntFlag"
- "!StrFlag"
- "!RGB"
- "!Color"
- "!HSV"
## VeSync General API Models
::: pyvesync.models.vesync_models
options:
show_signature_annotations: true
show_submodules: false
heading_level: 3
signature_crossrefs: true
show_root_heading: false
show_category_heading: true
show_root_toc_entry: true
inherited_members: false
show_source: true
filters:
- "!Config"
- "!^__.*"
- "!^_.*"
- "!IntFlag"
- "!StrFlag"
- "!RGB"
- "!Color"
- "!HSV"
## Bulb Models
::: pyvesync.models.bulb_models
options:
show_signature_annotations: true
show_submodules: false
signature_crossrefs: true
show_root_heading: false
heading_level: 3
show_category_heading: true
show_root_toc_entry: true
inherited_members: false
show_source: true
filters:
- "!Config"
- "!^__.*"
- "!^_.*"
- "!IntFlag"
- "!StrFlag"
- "!RGB"
- "!Color"
- "!HSV"
## Fan Models
::: pyvesync.models.fan_models
options:
show_signature_annotations: true
show_submodules: false
signature_crossrefs: true
heading_level: 3
show_root_heading: false
show_category_heading: true
show_root_toc_entry: true
inherited_members: false
show_source: true
filters:
- "!Config"
- "!^__.*"
- "!^_.*"
- "!IntFlag"
- "!StrFlag"
- "!RGB"
- "!Color"
- "!HSV"
## Humidifier Models
::: pyvesync.models.humidifier_models
options:
show_signature_annotations: true
show_submodules: false
signature_crossrefs: true
heading_level: 3
show_root_heading: false
show_category_heading: true
show_root_toc_entry: true
inherited_members: false
show_source: true
filters:
- "!Config"
- "!^__.*"
- "!^_.*"
- "!IntFlag"
- "!StrFlag"
- "!RGB"
- "!Color"
- "!HSV"
## Outlet Models
::: pyvesync.models.outlet_models
options:
show_signature_annotations: true
show_submodules: false
heading_level: 3
signature_crossrefs: true
show_root_heading: false
show_category_heading: true
show_root_toc_entry: true
inherited_members: false
show_source: true
filters:
- "!Config"
- "!^__.*"
- "!^_.*"
- "!IntFlag"
- "!StrFlag"
- "!RGB"
- "!Color"
- "!HSV"
## Purifier Models
::: pyvesync.models.purifier_models
options:
show_signature_annotations: true
show_submodules: false
heading_level: 3
signature_crossrefs: true
show_root_heading: false
show_category_heading: true
show_root_toc_entry: true
inherited_members: false
show_source: true
filters:
- "!Config"
- "!^__.*"
- "!^_.*"
- "!IntFlag"
- "!StrFlag"
- "!RGB"
- "!Color"
- "!HSV"
## Switch Models
::: pyvesync.models.switch_models
options:
show_signature_annotations: true
show_submodules: false
heading_level: 3
signature_crossrefs: true
show_root_heading: false
show_category_heading: true
show_root_toc_entry: true
inherited_members: false
show_source: true
filters:
- "!Config"
- "!^__.*"
- "!^_.*"
- "!IntFlag"
- "!StrFlag"
- "!RGB"
- "!Color"
- "!HSV"
## Fryer Models
::: pyvesync.models.fryer_models
options:
show_signature_annotations: true
show_submodules: false
heading_level: 3
signature_crossrefs: true
show_root_heading: false
show_category_heading: true
show_root_toc_entry: true
inherited_members: false
show_source: true
filters:
- "!Config"
- "!^__.*"
- "!^_.*"
- "!IntFlag"
- "!StrFlag"
- "!RGB"
- "!Color"
- "!HSV"
## Thermostat Models
::: pyvesync.models.thermostat_models
options:
show_signature_annotations: true
show_submodules: false
heading_level: 3
signature_crossrefs: true
show_root_heading: false
show_category_heading: true
show_root_toc_entry: true
inherited_members: false
show_source: true
filters:
- "!Config"
- "!^__.*"
- "!^_.*"
- "!IntFlag"
- "!StrFlag"
- "!RGB"
- "!Color"
- "!HSV"
|
