supla-device
Loading...
Searching...
No Matches
proto.h
1/*
2 Copyright (C) AC SOFTWARE SP. Z O.O.
3
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17 */
18
19#ifndef supla_proto_H_
20#define supla_proto_H_
21
22#ifdef _WIN32
23// *** WINDOWS ***
24
25#include <WinSock2.h>
26#define _supla_int_t int
27#define _supla_int16_t short
28#define _supla_int64_t __int64
29#define _supla_timeval timeval
30
31#elif defined(__AVR__)
32// *** ARDUINO MEGA ***
33
34#define SPROTO_WITHOUT_OUT_BUFFER
35
36struct _supla_timeval {
37 long tv_sec[2];
38 long tv_usec[2];
39};
40
41#define timeval _supla_timeval
42
43#define _supla_int16_t int
44#define _supla_int_t long
45#define _supla_int64_t long long
46
47#elif defined(ESP8266) || defined(ESP32) || defined(ESP_PLATFORM)
48// *** Espressif NONOS SDK for ESP8266 OR ARDUINO WITH ESP8266 or ESP32 ***
49// *** ESP-IDF, ESP8266 RTOS SDK ***
50#ifndef ESP_PLATFORM
51#ifndef ARDUINO
52#include <mem.h>
53#define PROTO_ICACHE_FLASH ICACHE_FLASH_ATTR
54#endif /*ARDUINO*/
55#endif /*ESP_PLATFORM*/
56
57#if defined(ARDUINO) || defined(ESP_PLATFORM)
58// *** Only ARDUINO ESPxxx and ESP-IDS, RTOS SDK (NONOS is excluded) ***
59#define SPROTO_WITHOUT_OUT_BUFFER
60#endif /*ARDUINO_ARCH_ESP8266*/
61
62struct _supla_timeval {
63 long long tv_sec;
64 long long tv_usec;
65};
66
67#define _supla_int16_t short
68#define _supla_int_t int
69#define _supla_int64_t long long
70#elif defined(__arm__)
71// *** ARM - RPI? ***
72
73struct _supla_timeval {
74 long long tv_sec;
75 long long tv_usec;
76};
77
78#include <sys/time.h>
79#define _supla_int16_t short
80#define _supla_int_t int
81#define _supla_int64_t long long
82
83#else /*__arm__*/
84// *** OTHER? Linux, what else? ***
85#include <sys/time.h>
86#define _supla_int16_t short
87#define _supla_int_t int
88#define _supla_int64_t long long
89// timeval for 64 bit system
90#if __GNUC__
91#if __x86_64__ || __ppc64__
92#define _supla_timeval timeval
93#else
94// timeval for 32 bit system
95struct _supla_timeval {
96 long long tv_sec;
97 long long tv_usec;
98};
99
100#endif /* __x86_64__ || __ppc64__*/
101#endif /* __GNUC__*/
102#endif
103
104#ifndef PROTO_ICACHE_FLASH
105#define PROTO_ICACHE_FLASH
106#endif /*PROTO_ICACHE_FLASH*/
107
108#ifdef __cplusplus
109extern "C" {
110#endif
111
112#define SUPLA_TAG_SIZE 5
113extern char sproto_tag[SUPLA_TAG_SIZE];
114
115// DCS - device/client -> server
116// SDC - server -> device/client
117// DS - device -> server
118// SD - server -> device
119// CS - client -> server
120// SC - server -> client
121
122#define SUPLA_PROTO_VERSION 27
123#define SUPLA_PROTO_VERSION_MIN 1
124
125#if defined(ARDUINO_ARCH_AVR) || defined(ARDUINO) || defined(SUPLA_DEVICE)
126// All Arduino IDE and SuplaDevice compilations
127// Max packet size was reduced and register device is now send in chunks:
128// first is header, then channel data
129// SUPLA_MAX_DATA_SIZE should be bigger then calcfg, device config, channel
130// config MAXSIZE. Otherwise sending will fail
131#define SUPLA_MAX_DATA_SIZE 600 // Registration header without channels
132#define USE_DEPRECATED_EMEV_V2 // Temporary. It will be removed.
133#elif defined(ESP8266)
134#define USE_DEPRECATED_EMEV_V2 // Temporary. It will be removed.
135// supla-espressif-esp compilations
136#define SUPLA_MAX_DATA_SIZE 1536
137#else
138#define SUPLA_MAX_DATA_SIZE 10240
139#endif
140#define SUPLA_RC_MAX_DEV_COUNT 50
141#define SUPLA_SOFTVER_MAXSIZE 21
142
143#define SUPLA_CAPTION_MAXSIZE 401
144
145#define SUPLA_GUID_SIZE 16
146#define SUPLA_GUID_HEXSIZE 33
147#define SUPLA_LOCATION_PWD_MAXSIZE 33
148#define SUPLA_ACCESSID_PWD_MAXSIZE 33
149#define SUPLA_LOCATION_CAPTION_MAXSIZE SUPLA_CAPTION_MAXSIZE
150#define SUPLA_LOCATIONPACK_MAXCOUNT 20
151#define SUPLA_CHANNEL_CAPTION_MAXSIZE SUPLA_CAPTION_MAXSIZE
152#define SUPLA_CHANNEL_GROUP_CAPTION_MAXSIZE SUPLA_CAPTION_MAXSIZE
153#define SUPLA_CHANNELPACK_MAXCOUNT 20
154#define SUPLA_URL_HOST_MAXSIZE 101
155#define SUPLA_URL_PATH_MAXSIZE 101
156#define SUPLA_SERVER_NAME_MAXSIZE 65
157#define SUPLA_EMAIL_MAXSIZE 256 // ver. >= 7
158#define SUPLA_PASSWORD_MAXSIZE 64 // ver. >= 10
159#define SUPLA_AUTHKEY_SIZE 16 // ver. >= 7
160#define SUPLA_AUTHKEY_HEXSIZE 33 // ver. >= 7
161#define SUPLA_OAUTH_TOKEN_MAXSIZE 256 // ver. >= 10
162#define SUPLA_CHANNELGROUP_PACK_MAXCOUNT 20 // ver. >= 9
163#define SUPLA_CHANNELGROUP_CAPTION_MAXSIZE 401 // ver. >= 9
164#define SUPLA_CHANNELVALUE_PACK_MAXCOUNT 20 // ver. >= 9
165#define SUPLA_CHANNELEXTENDEDVALUE_PACK_MAXCOUNT 5 // ver. >= 10
166#define SUPLA_CHANNELEXTENDEDVALUE_PACK_MAXDATASIZE \
167 (SUPLA_MAX_DATA_SIZE - 50) // ver. >= 10
168#define SUPLA_CALCFG_DATA_MAXSIZE 128 // ver. >= 10
169#define SUPLA_TIMEZONE_MAXSIZE 51 // ver. >= 11
170#define SUPLA_ACTION_PARAM_MAXSIZE 500 // ver. >= 18
171
172#ifndef SUPLA_CHANNELGROUP_RELATION_PACK_MAXCOUNT
173#define SUPLA_CHANNELGROUP_RELATION_PACK_MAXCOUNT 100 // ver. >= 9
174#endif /*SUPLA_CHANNELGROUP_RELATION_PACK_MAXCOUNT*/
175
176#define SUPLA_SCENE_CAPTION_MAXSIZE SUPLA_CAPTION_MAXSIZE // ver. >= 18
177#define SUPLA_SCENE_PACK_MAXCOUNT 20 // ver. >= 18
178#define SUPLA_SCENE_STATE_PACK_MAXCOUNT 20 // ver. >= 18
179
180#define SUPLA_CHANNEL_RELATION_PACK_MAXCOUNT 100 // ver. >= 21
181
182#define SUPLA_CHANNEL_STATE_PACK_MAXCOUNT 20 // ver. >= 26
183
184#define SUPLA_DCS_CALL_GETVERSION 10
185#define SUPLA_SDC_CALL_GETVERSION_RESULT 20
186#define SUPLA_SDC_CALL_VERSIONERROR 30
187#define SUPLA_DCS_CALL_PING_SERVER 40
188#define SUPLA_SDC_CALL_PING_SERVER_RESULT 50
189#define SUPLA_DS_CALL_REGISTER_DEVICE 60
190#define SUPLA_DS_CALL_REGISTER_DEVICE_B 65 // ver. >= 2
191#define SUPLA_DS_CALL_REGISTER_DEVICE_C 67 // ver. >= 6
192#define SUPLA_DS_CALL_REGISTER_DEVICE_D 68 // ver. >= 7
193#define SUPLA_DS_CALL_REGISTER_DEVICE_E 69 // ver. >= 10
194#define SUPLA_SD_CALL_REGISTER_DEVICE_RESULT 70
195#define SUPLA_SD_CALL_REGISTER_DEVICE_RESULT_B 71 // ver. >= 25
196#define SUPLA_DS_CALL_REGISTER_DEVICE_F 75 // ver. >= 23
197#define SUPLA_DS_CALL_REGISTER_DEVICE_G 76 // ver. >= 25
198#define SUPLA_CS_CALL_REGISTER_CLIENT 80
199#define SUPLA_CS_CALL_REGISTER_CLIENT_B 85 // ver. >= 6
200#define SUPLA_CS_CALL_REGISTER_CLIENT_C 86 // ver. >= 7
201#define SUPLA_CS_CALL_REGISTER_CLIENT_D 87 // ver. >= 12
202#define SUPLA_SC_CALL_REGISTER_CLIENT_RESULT 90
203#define SUPLA_SC_CALL_REGISTER_CLIENT_RESULT_B 92 // ver. >= 9
204#define SUPLA_SC_CALL_REGISTER_CLIENT_RESULT_C 94 // ver. >= 17
205#define SUPLA_SC_CALL_REGISTER_CLIENT_RESULT_D 96 // ver. >= 19
206#define SUPLA_DS_CALL_DEVICE_CHANNEL_VALUE_CHANGED 100
207#define SUPLA_DS_CALL_DEVICE_CHANNEL_VALUE_CHANGED_B 102 // ver. >= 12
208#define SUPLA_DS_CALL_DEVICE_CHANNEL_VALUE_CHANGED_C 103 // ver. >= 12
209#define SUPLA_DS_CALL_DEVICE_CHANNEL_EXTENDEDVALUE_CHANGED 105 // ver. >= 10
210#define SUPLA_SD_CALL_CHANNEL_SET_VALUE 110
211#define SUPLA_SD_CALL_CHANNELGROUP_SET_VALUE 115 // ver. >= 13
212#define SUPLA_DS_CALL_CHANNEL_SET_VALUE_RESULT 120
213#define SUPLA_SC_CALL_LOCATION_UPDATE 130
214#define SUPLA_SC_CALL_LOCATIONPACK_UPDATE 140
215#define SUPLA_SC_CALL_CHANNELPACK_UPDATE 160
216#define SUPLA_SC_CALL_CHANNEL_VALUE_UPDATE 170
217#define SUPLA_SC_CALL_CHANNEL_VALUE_UPDATE_B 171
218#define SUPLA_CS_CALL_GET_NEXT 180
219#define SUPLA_SC_CALL_EVENT 190
220#define SUPLA_CS_CALL_CHANNEL_SET_VALUE 200
221#define SUPLA_CS_CALL_CHANNEL_SET_VALUE_B 205 // ver. >= 3
222#define SUPLA_DCS_CALL_SET_ACTIVITY_TIMEOUT 210 // ver. >= 2
223#define SUPLA_SDC_CALL_SET_ACTIVITY_TIMEOUT_RESULT 220 // ver. >= 2
224#define SUPLA_DS_CALL_GET_FIRMWARE_UPDATE_URL 300 // ver. >= 5
225#define SUPLA_SD_CALL_GET_FIRMWARE_UPDATE_URL_RESULT 310 // ver. >= 5
226#define SUPLA_DCS_CALL_GET_REGISTRATION_ENABLED 320 // ver. >= 7
227#define SUPLA_SDC_CALL_GET_REGISTRATION_ENABLED_RESULT 330 // ver. >= 7
228#define SUPLA_CS_CALL_OAUTH_TOKEN_REQUEST 340 // ver. >= 10
229#define SUPLA_SC_CALL_OAUTH_TOKEN_REQUEST_RESULT 350 // ver. >= 10
230#define SUPLA_SC_CALL_CHANNELPACK_UPDATE_B 360 // ver. >= 8
231#define SUPLA_SC_CALL_CHANNELPACK_UPDATE_C 361 // ver. >= 10
232#define SUPLA_SC_CALL_CHANNELPACK_UPDATE_D 362 // ver. >= 15
233#define SUPLA_SC_CALL_CHANNELPACK_UPDATE_E 363 // ver. >= 23
234#define SUPLA_SC_CALL_CHANNELGROUP_PACK_UPDATE 380 // ver. >= 9
235#define SUPLA_SC_CALL_CHANNELGROUP_PACK_UPDATE_B 381 // ver. >= 10
236#define SUPLA_SC_CALL_CHANNELGROUP_RELATION_PACK_UPDATE 390 // ver. >= 9
237#define SUPLA_SC_CALL_CHANNEL_RELATION_PACK_UPDATE 395 // ver. >= 21
238#define SUPLA_SC_CALL_CHANNELVALUE_PACK_UPDATE 400 // ver. >= 9
239#define SUPLA_SC_CALL_CHANNELVALUE_PACK_UPDATE_B 401 // ver. >= 15
240#define SUPLA_SC_CALL_CHANNELEXTENDEDVALUE_PACK_UPDATE 405 // ver. >= 10
241#define SUPLA_SC_CALL_CHANNEL_STATE_PACK_UPDATE 408 // ver. >= 26
242#define SUPLA_CS_CALL_SET_VALUE 410 // ver. >= 9
243#define SUPLA_CS_CALL_SUPERUSER_AUTHORIZATION_REQUEST 420 // ver. >= 10
244#define SUPLA_CS_CALL_GET_SUPERUSER_AUTHORIZATION_RESULT 425 // ver. >= 12
245#define SUPLA_SC_CALL_SUPERUSER_AUTHORIZATION_RESULT 430 // ver. >= 10
246#define SUPLA_CS_CALL_DEVICE_CALCFG_REQUEST 440 // ver. >= 10
247#define SUPLA_CS_CALL_DEVICE_CALCFG_REQUEST_B 445 // ver. >= 11
248#define SUPLA_SC_CALL_DEVICE_CALCFG_RESULT 450 // ver. >= 10
249#define SUPLA_SD_CALL_DEVICE_CALCFG_REQUEST 460 // ver. >= 10
250#define SUPLA_DS_CALL_DEVICE_CALCFG_RESULT 470 // ver. >= 10
251#define SUPLA_DCS_CALL_GET_USER_LOCALTIME 480 // ver. >= 11
252#define SUPLA_DCS_CALL_GET_USER_LOCALTIME_RESULT 490 // ver. >= 11
253#define SUPLA_CSD_CALL_GET_CHANNEL_STATE 500 // ver. >= 12
254#define SUPLA_DSC_CALL_CHANNEL_STATE_RESULT 510 // ver. >= 12
255#define SUPLA_CS_CALL_GET_CHANNEL_BASIC_CFG 520 // ver. >= 12
256#define SUPLA_SC_CALL_CHANNEL_BASIC_CFG_RESULT 530 // ver. >= 12
257#define SUPLA_CS_CALL_SET_CHANNEL_FUNCTION 540 // ver. >= 12
258#define SUPLA_SC_CALL_SET_CHANNEL_FUNCTION_RESULT 550 // ver. >= 12
259#define SUPLA_CS_CALL_CLIENTS_RECONNECT_REQUEST 560 // ver. >= 12
260#define SUPLA_SC_CALL_CLIENTS_RECONNECT_REQUEST_RESULT 570 // ver. >= 12
261#define SUPLA_CS_CALL_SET_REGISTRATION_ENABLED 580 // ver. >= 12
262#define SUPLA_SC_CALL_SET_REGISTRATION_ENABLED_RESULT 590 // ver. >= 12
263#define SUPLA_CS_CALL_DEVICE_RECONNECT_REQUEST 600 // ver. >= 12
264#define SUPLA_SC_CALL_DEVICE_RECONNECT_REQUEST_RESULT 610 // ver. >= 12
265#define SUPLA_DS_CALL_GET_CHANNEL_FUNCTIONS 620 // ver. >= 12
266#define SUPLA_SD_CALL_GET_CHANNEL_FUNCTIONS_RESULT 630 // ver. >= 12
267#define SUPLA_DCS_CALL_SET_CHANNEL_CAPTION 640 // ver. >= 12
268#define SUPLA_SCD_CALL_SET_CHANNEL_CAPTION_RESULT 650 // ver. >= 12
269#define SUPLA_CS_CALL_SET_CHANNEL_GROUP_CAPTION 642 // ver. >= 20
270#define SUPLA_SC_CALL_SET_CHANNEL_GROUP_CAPTION_RESULT 652 // ver. >= 20
271#define SUPLA_CS_CALL_SET_LOCATION_CAPTION 645 // ver. >= 14
272#define SUPLA_SC_CALL_SET_LOCATION_CAPTION_RESULT 655 // ver. >= 14
273#define SUPLA_DS_CALL_GET_CHANNEL_CONFIG 680 // ver. >= 16
274#define SUPLA_SD_CALL_GET_CHANNEL_CONFIG_RESULT 690 // ver. >= 16
275#define SUPLA_DS_CALL_SET_CHANNEL_CONFIG 681 // ver. >= 21
276#define SUPLA_SD_CALL_SET_CHANNEL_CONFIG_RESULT 691 // ver. >= 21
277#define SUPLA_SD_CALL_SET_CHANNEL_CONFIG 682 // ver. >= 21
278#define SUPLA_DS_CALL_SET_CHANNEL_CONFIG_RESULT 692 // ver. >= 21
279#define SUPLA_SD_CALL_CHANNEL_CONFIG_FINISHED 683 // ver. >= 21
280#define SUPLA_DS_CALL_SET_DEVICE_CONFIG 684 // ver. >= 21
281#define SUPLA_SD_CALL_SET_DEVICE_CONFIG_RESULT 694 // ver. >= 21
282#define SUPLA_SD_CALL_SET_DEVICE_CONFIG 685 // ver. >= 21
283#define SUPLA_DS_CALL_SET_DEVICE_CONFIG_RESULT 695 // ver. >= 21
284#define SUPLA_DS_CALL_ACTIONTRIGGER 700 // ver. >= 16
285#define SUPLA_CS_CALL_TIMER_ARM 800 // ver. >= 17
286#define SUPLA_SC_CALL_SCENE_PACK_UPDATE 900 // ver. >= 18
287#define SUPLA_SC_CALL_SCENE_STATE_PACK_UPDATE 910 // ver. >= 18
288#define SUPLA_CS_CALL_EXECUTE_ACTION 1000 // ver. >= 19
289#define SUPLA_CS_CALL_EXECUTE_ACTION_WITH_AUTH 1010 // ver. >= 19
290#define SUPLA_SC_CALL_ACTION_EXECUTION_RESULT 1020 // ver. >= 19
291#define SUPLA_CS_CALL_GET_CHANNEL_VALUE_WITH_AUTH 1030 // ver. >= 19
292#define SUPLA_SC_CALL_GET_CHANNEL_VALUE_RESULT 1040 // ver. >= 19
293#define SUPLA_CS_CALL_SET_SCENE_CAPTION 1045 // ver. >= 19
294#define SUPLA_SC_CALL_SET_SCENE_CAPTION_RESULT 1055 // ver. >= 19
295#define SUPLA_DS_CALL_REGISTER_PUSH_NOTIFICATION 1100 // ver. >= 20
296#define SUPLA_DS_CALL_SEND_PUSH_NOTIFICATION 1110 // ver. >= 20
297#define SUPLA_CS_CALL_REGISTER_PN_CLIENT_TOKEN 1120 // ver. >= 20
298#define SUPLA_SC_CALL_REGISTER_PN_CLIENT_TOKEN_RESULT 1121 // ver. >= 20
299#define SUPLA_CS_CALL_GET_CHANNEL_CONFIG 1200 // ver. >= 21
300#define SUPLA_SC_CALL_CHANNEL_CONFIG_UPDATE_OR_RESULT 1210 // ver. >= 21
301#define SUPLA_CS_CALL_SET_CHANNEL_CONFIG 1220 // ver. >= 21
302#define SUPLA_CS_CALL_GET_DEVICE_CONFIG 1240 // ver. >= 21
303#define SUPLA_SC_CALL_DEVICE_CONFIG_UPDATE_OR_RESULT 1250 // ver. >= 21
304#define SUPLA_DS_CALL_SET_SUBDEVICE_DETAILS 1260 // ver. >= 25
305
306#define SUPLA_RESULT_RESPONSE_TIMEOUT -8
307#define SUPLA_RESULT_CANT_CONNECT_TO_HOST -7
308#define SUPLA_RESULT_HOST_NOT_FOUND -6
309#define SUPLA_RESULT_CALL_NOT_ALLOWED -5
310#define SUPLA_RESULT_DATA_TOO_LARGE -4
311#define SUPLA_RESULT_BUFFER_OVERFLOW -3
312#define SUPLA_RESULT_DATA_ERROR -2
313#define SUPLA_RESULT_VERSION_ERROR -1
314#define SUPLA_RESULT_FALSE 0
315#define SUPLA_RESULT_TRUE 1
316
317// SUPLA_RESULTCODE_ are sent in TSuplaDataPacket.data (unsigned char)
318#define SUPLA_RESULTCODE_NONE 0
319#define SUPLA_RESULTCODE_UNSUPORTED 1
320#define SUPLA_RESULTCODE_FALSE 2
321#define SUPLA_RESULTCODE_TRUE 3
322#define SUPLA_RESULTCODE_TEMPORARILY_UNAVAILABLE 4
323#define SUPLA_RESULTCODE_BAD_CREDENTIALS 5
324#define SUPLA_RESULTCODE_LOCATION_CONFLICT 6
325#define SUPLA_RESULTCODE_CHANNEL_CONFLICT 7
326#define SUPLA_RESULTCODE_DEVICE_DISABLED 8
327#define SUPLA_RESULTCODE_ACCESSID_DISABLED 9
328#define SUPLA_RESULTCODE_LOCATION_DISABLED 10
329#define SUPLA_RESULTCODE_CLIENT_DISABLED 11
330#define SUPLA_RESULTCODE_CLIENT_LIMITEXCEEDED 12
331#define SUPLA_RESULTCODE_DEVICE_LIMITEXCEEDED 13
332#define SUPLA_RESULTCODE_GUID_ERROR 14
333#define SUPLA_RESULTCODE_DEVICE_LOCKED 15 // ver. >= 22
334#define SUPLA_RESULTCODE_REGISTRATION_DISABLED 17 // ver. >= 7
335#define SUPLA_RESULTCODE_ACCESSID_NOT_ASSIGNED 18 // ver. >= 7
336#define SUPLA_RESULTCODE_AUTHKEY_ERROR 19 // ver. >= 7
337#define SUPLA_RESULTCODE_NO_LOCATION_AVAILABLE 20 // ver. >= 7
338#define SUPLA_RESULTCODE_USER_CONFLICT 21 // Deprecated
339#define SUPLA_RESULTCODE_UNAUTHORIZED 22 // ver. >= 10
340#define SUPLA_RESULTCODE_AUTHORIZED 23 // ver. >= 10
341#define SUPLA_RESULTCODE_NOT_ALLOWED 24 // ver. >= 12
342#define SUPLA_RESULTCODE_CHANNELNOTFOUND 25 // ver. >= 12
343#define SUPLA_RESULTCODE_UNKNOWN_ERROR 26 // ver. >= 12
344#define SUPLA_RESULTCODE_DENY_CHANNEL_BELONG_TO_GROUP 27 // ver. >= 12
345#define SUPLA_RESULTCODE_DENY_CHANNEL_HAS_SCHEDULE 28 // ver. >= 12
346#define SUPLA_RESULTCODE_DENY_CHANNEL_IS_ASSOCIETED_WITH_SCENE 29 // ver. >= 12
347#define SUPLA_RESULTCODE_DENY_CHANNEL_IS_ASSOCIETED_WITH_ACTION_TRIGGER \
348 30 // ver. >= 16
349#define SUPLA_RESULTCODE_INACTIVE 31 // ver. >= 17
350#define SUPLA_RESULTCODE_CFG_MODE_REQUESTED 32 // ver. >= 18
351#define SUPLA_RESULTCODE_ACTION_UNSUPPORTED 33 // ver. >= 19
352#define SUPLA_RESULTCODE_SUBJECT_NOT_FOUND 34 // ver. >= 19
353#define SUPLA_RESULTCODE_INCORRECT_PARAMETERS 35 // ver. >= 19
354#define SUPLA_RESULTCODE_CLIENT_NOT_EXISTS 36 // ver. >= 19
355#define SUPLA_RESULTCODE_COUNTRY_REJECTED 37
356#define SUPLA_RESULTCODE_CHANNEL_IS_OFFLINE 38 // ver. >= 19
357#define SUPLA_RESULTCODE_NOT_REGISTERED 39 // ver. >= 20
358#define SUPLA_RESULTCODE_DENY_CHANNEL_IS_ASSOCIETED_WITH_VBT 40 // >= 20
359#define SUPLA_RESULTCODE_DENY_CHANNEL_IS_ASSOCIETED_WITH_PUSH 41 // >= 20
360#define SUPLA_RESULTCODE_RESTART_REQUESTED 42 // ver. >= 25
361#define SUPLA_RESULTCODE_IDENTIFY_REQUESTED 43 // ver. >= 25
362#define SUPLA_RESULTCODE_MALFORMED_EMAIL 44 // ver. >= ?
363#define SUPLA_RESULTCODE_RESET_TO_FACTORY_SETTINGS 45 // ver. >= 28
364
365#define SUPLA_OAUTH_RESULTCODE_ERROR 0 // ver. >= 10
366#define SUPLA_OAUTH_RESULTCODE_SUCCESS 1 // ver. >= 10
367#define SUPLA_OAUTH_TEMPORARILY_UNAVAILABLE 2 // ver. >= 10
368
369#define SUPLA_DEVICE_NAME_MAXSIZE 201
370#define SUPLA_CLIENT_NAME_MAXSIZE 201
371#define SUPLA_SENDER_NAME_MAXSIZE 201
372#define SUPLA_INITIATOR_NAME_MAXSIZE SUPLA_SENDER_NAME_MAXSIZE
373
374#define SUPLA_CHANNELMAXCOUNT 128
375
376#define SUPLA_CHANNELVALUE_SIZE 8
377
378#if defined(__AVR__) || defined(ESP8266) || defined(ESP32) || \
379 defined(ESP_PLATFORM) || defined(ARDUINO) || defined(SUPLA_DEVICE)
380#define SUPLA_CHANNELEXTENDEDVALUE_SIZE 256
381#else
382#define SUPLA_CHANNELEXTENDEDVALUE_SIZE 1024
383#endif
384
385#define SUPLA_CHANNELTYPE_SENSORNO 1000 // name DEPRECATED
386// use BINARYSENSOR instead
387#define SUPLA_CHANNELTYPE_BINARYSENSOR 1000
388#define SUPLA_CHANNELTYPE_SENSORNC 1010 // DEPRECATED
389#define SUPLA_CHANNELTYPE_DISTANCESENSOR 1020 // ver. >= 5
390#define SUPLA_CHANNELTYPE_CALLBUTTON 1500 // ver. >= 4
391#define SUPLA_CHANNELTYPE_RELAYHFD4 2000 // DEPRECATED
392#define SUPLA_CHANNELTYPE_RELAYG5LA1A 2010 // DEPRECATED
393#define SUPLA_CHANNELTYPE_2XRELAYG5LA1A 2020 // DEPRECATED
394#define SUPLA_CHANNELTYPE_RELAY 2900
395#define SUPLA_CHANNELTYPE_THERMOMETERDS18B20 3000 // DEPRECATED
396#define SUPLA_CHANNELTYPE_DHT11 3010 // ver. >= 4 DEPRECATED
397#define SUPLA_CHANNELTYPE_DHT22 3020 // ver. >= 4 DEPRECATED
398#define SUPLA_CHANNELTYPE_DHT21 3022 // ver. >= 5 DEPRECATED
399#define SUPLA_CHANNELTYPE_AM2302 3030 // ver. >= 4 DEPRECATED
400#define SUPLA_CHANNELTYPE_AM2301 3032 // ver. >= 5 DEPRECATED
401
402#define SUPLA_CHANNELTYPE_THERMOMETER 3034 // ver. >= 8
403#define SUPLA_CHANNELTYPE_HUMIDITYSENSOR 3036 // ver. >= 8
404#define SUPLA_CHANNELTYPE_HUMIDITYANDTEMPSENSOR 3038 // ver. >= 8
405#define SUPLA_CHANNELTYPE_WINDSENSOR 3042 // ver. >= 8
406#define SUPLA_CHANNELTYPE_PRESSURESENSOR 3044 // ver. >= 8
407#define SUPLA_CHANNELTYPE_RAINSENSOR 3048 // ver. >= 8
408#define SUPLA_CHANNELTYPE_WEIGHTSENSOR 3050 // ver. >= 8
409#define SUPLA_CHANNELTYPE_WEATHER_STATION 3100 // ver. >= 8
410#define SUPLA_CHANNELTYPE_CONTAINER 3200 // ver. >= 26
411
412#define SUPLA_CHANNELTYPE_DIMMER 4000 // ver. >= 4
413#define SUPLA_CHANNELTYPE_RGBLEDCONTROLLER 4010 // ver. >= 4
414#define SUPLA_CHANNELTYPE_DIMMERANDRGBLED 4020 // ver. >= 4
415
416#define SUPLA_CHANNELTYPE_ELECTRICITY_METER 5000 // ver. >= 10
417#define SUPLA_CHANNELTYPE_IMPULSE_COUNTER 5010 // ver. >= 10
418
419#define SUPLA_CHANNELTYPE_THERMOSTAT 6000 // ver. >= 11
420#define SUPLA_CHANNELTYPE_THERMOSTAT_HEATPOL_HOMEPLUS 6010 // ver. >= 11
421#define SUPLA_CHANNELTYPE_HVAC 6100 // ver. >= 21
422
423#define SUPLA_CHANNELTYPE_VALVE_OPENCLOSE 7000 // ver. >= 12
424#define SUPLA_CHANNELTYPE_VALVE_PERCENTAGE 7010 // ver. >= 12
425#define SUPLA_CHANNELTYPE_BRIDGE 8000 // ver. >= 12
426#define SUPLA_CHANNELTYPE_GENERAL_PURPOSE_MEASUREMENT 9000 // ver. >= 23
427#define SUPLA_CHANNELTYPE_GENERAL_PURPOSE_METER 9010 // ver. >= 23
428#define SUPLA_CHANNELTYPE_ENGINE 10000 // ver. >= 12
429#define SUPLA_CHANNELTYPE_ACTIONTRIGGER 11000 // ver. >= 16
430#define SUPLA_CHANNELTYPE_DIGIGLASS 12000 // ver. >= 12
431
432#define SUPLA_CHANNELTYPE_VIRTUAL 13000 // ver. >= 21
433
434#define SUPLA_CHANNELDRIVER_MCP23008 2
435
436#define SUPLA_CHANNELFNC_NONE 0
437#define SUPLA_CHANNELFNC_CONTROLLINGTHEGATEWAYLOCK 10
438#define SUPLA_CHANNELFNC_CONTROLLINGTHEGATE 20
439#define SUPLA_CHANNELFNC_CONTROLLINGTHEGARAGEDOOR 30
440#define SUPLA_CHANNELFNC_THERMOMETER 40
441#define SUPLA_CHANNELFNC_HUMIDITY 42
442#define SUPLA_CHANNELFNC_HUMIDITYANDTEMPERATURE 45
443#define SUPLA_CHANNELFNC_OPENINGSENSOR_GATEWAY 50
444#define SUPLA_CHANNELFNC_OPENINGSENSOR_GATE 60
445#define SUPLA_CHANNELFNC_OPENINGSENSOR_GARAGEDOOR 70
446#define SUPLA_CHANNELFNC_NOLIQUIDSENSOR 80
447#define SUPLA_CHANNELFNC_CONTROLLINGTHEDOORLOCK 90
448#define SUPLA_CHANNELFNC_OPENINGSENSOR_DOOR 100
449#define SUPLA_CHANNELFNC_CONTROLLINGTHEROLLERSHUTTER 110
450#define SUPLA_CHANNELFNC_CONTROLLINGTHEROOFWINDOW 115 // ver. >= 13
451#define SUPLA_CHANNELFNC_OPENINGSENSOR_ROLLERSHUTTER 120
452#define SUPLA_CHANNELFNC_OPENINGSENSOR_ROOFWINDOW 125 // ver. >= 13
453#define SUPLA_CHANNELFNC_POWERSWITCH 130
454#define SUPLA_CHANNELFNC_LIGHTSWITCH 140
455#define SUPLA_CHANNELFNC_RING 150
456#define SUPLA_CHANNELFNC_ALARM 160
457#define SUPLA_CHANNELFNC_NOTIFICATION 170
458#define SUPLA_CHANNELFNC_DIMMER 180
459#define SUPLA_CHANNELFNC_RGBLIGHTING 190
460#define SUPLA_CHANNELFNC_DIMMERANDRGBLIGHTING 200
461#define SUPLA_CHANNELFNC_DEPTHSENSOR 210 // ver. >= 5
462#define SUPLA_CHANNELFNC_DISTANCESENSOR 220 // ver. >= 5
463#define SUPLA_CHANNELFNC_OPENINGSENSOR_WINDOW 230 // ver. >= 8
464#define SUPLA_CHANNELFNC_HOTELCARDSENSOR 235 // ver. >= 21
465#define SUPLA_CHANNELFNC_ALARMARMAMENTSENSOR 236 // ver. >= 21
466#define SUPLA_CHANNELFNC_MAILSENSOR 240 // ver. >= 8
467#define SUPLA_CHANNELFNC_WINDSENSOR 250 // ver. >= 8
468#define SUPLA_CHANNELFNC_PRESSURESENSOR 260 // ver. >= 8
469#define SUPLA_CHANNELFNC_RAINSENSOR 270 // ver. >= 8
470#define SUPLA_CHANNELFNC_WEIGHTSENSOR 280 // ver. >= 8
471#define SUPLA_CHANNELFNC_WEATHER_STATION 290 // ver. >= 8
472#define SUPLA_CHANNELFNC_STAIRCASETIMER 300 // ver. >= 8
473#define SUPLA_CHANNELFNC_ELECTRICITY_METER 310 // ver. >= 10
474#define SUPLA_CHANNELFNC_IC_ELECTRICITY_METER 315 // ver. >= 12
475#define SUPLA_CHANNELFNC_IC_GAS_METER 320 // ver. >= 10
476#define SUPLA_CHANNELFNC_IC_WATER_METER 330 // ver. >= 10
477#define SUPLA_CHANNELFNC_IC_HEAT_METER 340 // ver. >= 10
478#define SUPLA_CHANNELFNC_IC_EVENTS 350 // ver. >= 21
479#define SUPLA_CHANNELFNC_IC_SECONDS 360 // ver. >= 21
480#define SUPLA_CHANNELFNC_THERMOSTAT_HEATPOL_HOMEPLUS 410 // ver. >= 11
481#define SUPLA_CHANNELFNC_HVAC_THERMOSTAT 420 // ver. >= 21
482#define SUPLA_CHANNELFNC_HVAC_THERMOSTAT_HEAT_COOL 422 // ver. >= 21
483#define SUPLA_CHANNELFNC_HVAC_DRYER 423 // ver. >= 21
484#define SUPLA_CHANNELFNC_HVAC_FAN 424 // ver. >= 21
485#define SUPLA_CHANNELFNC_HVAC_THERMOSTAT_DIFFERENTIAL 425 // ver. >= 21
486#define SUPLA_CHANNELFNC_HVAC_DOMESTIC_HOT_WATER 426 // ver. >= 21
487#define SUPLA_CHANNELFNC_VALVE_OPENCLOSE 500 // ver. >= 12
488#define SUPLA_CHANNELFNC_VALVE_PERCENTAGE 510 // ver. >= 12
489#define SUPLA_CHANNELFNC_GENERAL_PURPOSE_MEASUREMENT 520 // ver. >= 23
490#define SUPLA_CHANNELFNC_GENERAL_PURPOSE_METER 530 // ver. >= 23
491#define SUPLA_CHANNELFNC_CONTROLLINGTHEENGINESPEED 600 // ver. >= 12
492#define SUPLA_CHANNELFNC_ACTIONTRIGGER 700 // ver. >= 16
493#define SUPLA_CHANNELFNC_DIGIGLASS_HORIZONTAL 800 // ver. >= 14
494#define SUPLA_CHANNELFNC_DIGIGLASS_VERTICAL 810 // ver. >= 14
495#define SUPLA_CHANNELFNC_CONTROLLINGTHEFACADEBLIND 900 // ver. >= 24
496#define SUPLA_CHANNELFNC_TERRACE_AWNING 910 // ver. >= 24
497#define SUPLA_CHANNELFNC_PROJECTOR_SCREEN 920 // ver. >= 24
498#define SUPLA_CHANNELFNC_CURTAIN 930 // ver. >= 24
499#define SUPLA_CHANNELFNC_VERTICAL_BLIND 940 // ver. >= 24
500#define SUPLA_CHANNELFNC_ROLLER_GARAGE_DOOR 950 // ver. >= 24
501#define SUPLA_CHANNELFNC_PUMPSWITCH 960 // ver. >= 25
502#define SUPLA_CHANNELFNC_HEATORCOLDSOURCESWITCH 970 // ver. >= 25
503#define SUPLA_CHANNELFNC_CONTAINER 980 // ver. >= 26
504#define SUPLA_CHANNELFNC_SEPTIC_TANK 981 // ver. >= 26
505#define SUPLA_CHANNELFNC_WATER_TANK 982 // ver. >= 26
506#define SUPLA_CHANNELFNC_CONTAINER_LEVEL_SENSOR 990 // ver. >= 26
507#define SUPLA_CHANNELFNC_FLOOD_SENSOR 1000 // ver. >= 27
508
509#define SUPLA_BIT_FUNC_CONTROLLINGTHEGATEWAYLOCK 0x00000001
510#define SUPLA_BIT_FUNC_CONTROLLINGTHEGATE 0x00000002
511#define SUPLA_BIT_FUNC_CONTROLLINGTHEGARAGEDOOR 0x00000004
512#define SUPLA_BIT_FUNC_CONTROLLINGTHEDOORLOCK 0x00000008
513#define SUPLA_BIT_FUNC_CONTROLLINGTHEROLLERSHUTTER 0x00000010
514#define SUPLA_BIT_FUNC_POWERSWITCH 0x00000020
515#define SUPLA_BIT_FUNC_LIGHTSWITCH 0x00000040
516#define SUPLA_BIT_FUNC_STAIRCASETIMER 0x00000080 // ver. >= 8
517#define SUPLA_BIT_FUNC_THERMOMETER 0x00000100 // ver. >= 12
518#define SUPLA_BIT_FUNC_HUMIDITYANDTEMPERATURE 0x00000200 // ver. >= 12
519#define SUPLA_BIT_FUNC_HUMIDITY 0x00000400 // ver. >= 12
520#define SUPLA_BIT_FUNC_WINDSENSOR 0x00000800 // ver. >= 12
521#define SUPLA_BIT_FUNC_PRESSURESENSOR 0x00001000 // ver. >= 12
522#define SUPLA_BIT_FUNC_RAINSENSOR 0x00002000 // ver. >= 12
523#define SUPLA_BIT_FUNC_WEIGHTSENSOR 0x00004000 // ver. >= 12
524#define SUPLA_BIT_FUNC_CONTROLLINGTHEROOFWINDOW 0x00008000 // ver. >= 13
525#define SUPLA_BIT_FUNC_CONTROLLINGTHEFACADEBLIND 0x00010000 // ver. >= 17
526#define SUPLA_BIT_FUNC_HVAC_THERMOSTAT 0x00020000 // ver. >= 21
527#define SUPLA_BIT_FUNC_HVAC_THERMOSTAT_HEAT_COOL 0x00040000 // ver. >= 21
528#define SUPLA_BIT_FUNC_HVAC_THERMOSTAT_DIFFERENTIAL 0x00080000 // ver. >= 21
529#define SUPLA_BIT_FUNC_HVAC_DOMESTIC_HOT_WATER 0x00100000 // ver. >= 21
530#define SUPLA_BIT_FUNC_TERRACE_AWNING 0x00200000 // ver. >= 24
531#define SUPLA_BIT_FUNC_PROJECTOR_SCREEN 0x00400000 // ver. >= 24
532#define SUPLA_BIT_FUNC_CURTAIN 0x00800000 // ver. >= 24
533#define SUPLA_BIT_FUNC_VERTICAL_BLIND 0x01000000 // ver. >= 24
534#define SUPLA_BIT_FUNC_ROLLER_GARAGE_DOOR 0x02000000 // ver. >= 24
535#define SUPLA_BIT_FUNC_PUMPSWITCH 0x04000000 // ver. >= 25
536#define SUPLA_BIT_FUNC_HEATORCOLDSOURCESWITCH 0x08000000 // ver. >= 25
537
538#define SUPLA_EVENT_CONTROLLINGTHEGATEWAYLOCK 10
539#define SUPLA_EVENT_CONTROLLINGTHEGATE 20
540#define SUPLA_EVENT_CONTROLLINGTHEGARAGEDOOR 30
541#define SUPLA_EVENT_CONTROLLINGTHEDOORLOCK 40
542#define SUPLA_EVENT_CONTROLLINGTHEROLLERSHUTTER 50
543#define SUPLA_EVENT_TERRACE_AWNING 51 // ver. >= 24
544#define SUPLA_EVENT_CURTAIN 52 // ver. >= 24
545#define SUPLA_EVENT_PROJECTOR_SCREEN 53 // ver. >= 24
546#define SUPLA_EVENT_ROLLER_GARAGE_DOOR 54 // ver. >= 24
547#define SUPLA_EVENT_CONTROLLINGTHEROOFWINDOW 55
548#define SUPLA_EVENT_CONTROLLINGTHEFACADEBLIND 56 // ver. >= 24
549#define SUPLA_EVENT_VERTICAL_BLIND 57 // ver. >= 24
550#define SUPLA_EVENT_POWERONOFF 60
551#define SUPLA_EVENT_LIGHTONOFF 70
552#define SUPLA_EVENT_STAIRCASETIMERONOFF 80 // ver. >= 9
553#define SUPLA_EVENT_VALVEOPENCLOSE 90 // ver. >= 12
554#define SUPLA_EVENT_SET_BRIDGE_VALUE_FAILED 100 // ver. >= 12
555
556#define SUPLA_URL_PROTO_HTTP 0x01
557#define SUPLA_URL_PROTO_HTTPS 0x02
558
559#define SUPLA_PLATFORM_UNKNOWN 0
560#define SUPLA_PLATFORM_ESP8266 1
561
562#define SUPLA_TARGET_CHANNEL 0
563#define SUPLA_TARGET_GROUP 1
564#define SUPLA_TARGET_IODEVICE 2
565
566#define SUPLA_MFR_UNKNOWN 0
567#define SUPLA_MFR_ACSOFTWARE 1
568#define SUPLA_MFR_TRANSCOM 2
569#define SUPLA_MFR_LOGI 3
570#define SUPLA_MFR_ZAMEL 4
571#define SUPLA_MFR_NICE 5
572#define SUPLA_MFR_ITEAD 6
573#define SUPLA_MFR_DOYLETRATT 7
574#define SUPLA_MFR_HEATPOL 8
575#define SUPLA_MFR_FAKRO 9
576#define SUPLA_MFR_PEVEKO 10
577#define SUPLA_MFR_WEKTA 11
578#define SUPLA_MFR_STA_SYSTEM 12
579#define SUPLA_MFR_DGF 13
580#define SUPLA_MFR_COMELIT 14
581#define SUPLA_MFR_POLIER 15
582#define SUPLA_MFR_ERGO_ENERGIA 16
583#define SUPLA_MFR_SOMEF 17
584#define SUPLA_MFR_AURATON 18
585#define SUPLA_MFR_HPD 19
586#define SUPLA_MFR_LUKFUD 20
587
588// BIT map definition for TDS_SuplaRegisterDevice_*::Flags (32 bit)
589#define SUPLA_DEVICE_FLAG_CALCFG_ENTER_CFG_MODE 0x0010 // ver. >= 17
590#define SUPLA_DEVICE_FLAG_SLEEP_MODE_ENABLED 0x0020 // ver. >= 18
591#define SUPLA_DEVICE_FLAG_CALCFG_SET_TIME 0x0040 // ver. >= 21
592#define SUPLA_DEVICE_FLAG_DEVICE_CONFIG_SUPPORTED 0x0080 // ver. >= 21
593#define SUPLA_DEVICE_FLAG_DEVICE_LOCKED 0x0100 // ver. >= 22
594#define SUPLA_DEVICE_FLAG_CALCFG_SUBDEVICE_PAIRING 0x0200 // ver. >= 25
595#define SUPLA_DEVICE_FLAG_CALCFG_IDENTIFY_DEVICE 0x0400 // ver. >= 25
596#define SUPLA_DEVICE_FLAG_CALCFG_RESTART_DEVICE 0x0800 // ver. >= 25
597#define SUPLA_DEVICE_FLAG_ALWAYS_ALLOW_CHANNEL_DELETION 0x1000 // ver. >= 25
598#define SUPLA_DEVICE_FLAG_BLOCK_ADDING_CHANNELS_AFTER_DELETION \
599 0x2000 // ver. >= 25
600#define SUPLA_DEVICE_FLAG_CALCFG_FACTORY_RESET_SUPPORTED 0x4000 // ver. >= 28
601#define SUPLA_DEVICE_FLAG_AUTOMATIC_FIRMWARE_UPDATE_SUPPORTED \
602 0x8000 // ver. >= 28
603
604// BIT map definition for TDS_SuplaRegisterDevice_F::ConfigFields (64 bit)
605// type: TDeviceConfig_StatusLed
606#define SUPLA_DEVICE_CONFIG_FIELD_STATUS_LED (1ULL << 0) // v. >= 21
607// type: TDeviceConfig_ScreenBrightness
608#define SUPLA_DEVICE_CONFIG_FIELD_SCREEN_BRIGHTNESS (1ULL << 1) // v. >= 21
609// type: TDeviceConfig_ButtonVolume
610#define SUPLA_DEVICE_CONFIG_FIELD_BUTTON_VOLUME (1ULL << 2) // v. >= 21
611// type: TDeviceConfig_DisableUserInterface
612#define SUPLA_DEVICE_CONFIG_FIELD_DISABLE_USER_INTERFACE \
613 (1ULL << 3) // v. >= 21
614// type: TDeviceConfig_AutomaticTimeSync
615#define SUPLA_DEVICE_CONFIG_FIELD_AUTOMATIC_TIME_SYNC (1ULL << 4) // v. >= 21
616// type: TDeviceConfig_HomeScreenOffDelay
617#define SUPLA_DEVICE_CONFIG_FIELD_HOME_SCREEN_OFF_DELAY (1ULL << 5) // v. >= 21
618// type: TDeviceConfig_HomeScreenContent
619#define SUPLA_DEVICE_CONFIG_FIELD_HOME_SCREEN_CONTENT (1ULL << 6) // v. >= 21
620// type: TDeviceConfig_HomeScreenOffDelayType
621#define SUPLA_DEVICE_CONFIG_FIELD_HOME_SCREEN_OFF_DELAY_TYPE \
622 (1ULL << 7) // v. >= 24
623// type: TDeviceConfig_PowerStatusLed
624#define SUPLA_DEVICE_CONFIG_FIELD_POWER_STATUS_LED (1ULL << 8) // v. >= 25
625// type: TDeviceConfig_Modbus
626#define SUPLA_DEVICE_CONFIG_FIELD_MODBUS (1ULL << 9) // v. >= 27
627// type: TDeviceConfig_FirmwareUpdate
628#define SUPLA_DEVICE_CONFIG_FIELD_FIRMWARE_UPDATE (1ULL << 10) // v. >= 28
629
630// BIT map definition for TDS_SuplaDeviceChannel_C::Flags (32 bit)
631// BIT map definition for TDS_SuplaDeviceChannel_D::Flags (64 bit)
632// BIT map definition for TDS_SuplaDeviceChannel_E::Flags (64 bit)
633#define SUPLA_CHANNEL_FLAG_ZWAVE_BRIDGE 0x0001 // ver. >= 12
634#define SUPLA_CHANNEL_FLAG_IR_BRIDGE 0x0002 // ver. >= 12 DEPRECATED
635#define SUPLA_CHANNEL_FLAG_RF_BRIDGE 0x0004 // ver. >= 12 DEPRECATED
636#define SUPLA_CHANNEL_FLAG_OCR 0x0008 // ver. >= 26
637#define SUPLA_CHANNEL_FLAG_FLOOD_SENSORS_SUPPORTED 0x0010 // ver. >= 27
638#define SUPLA_CHANNEL_FLAG_FILL_LEVEL_REPORTING_IN_FULL_RANGE \
639 0x0020 // ver. >= 27
640#define SUPLA_CHANNEL_FLAG_VALVE_MOTOR_ALARM_SUPPORTED 0x0040 // ver. >= 27
641#define SUPLA_CHANNEL_FLAG_RS_SBS_AND_STOP_ACTIONS 0x0080 // ver. >= 17
642#define SUPLA_CHANNEL_FLAG_RGBW_COMMANDS_SUPPORTED 0x0100 // ver. >= 21
643#define SUPLA_CHANNEL_FLAG_ALWAYS_ALLOW_CHANNEL_DELETION 0x0200 // ver. >= 27
644// Free bits for future use: 0x0400, 0x0800
645#define SUPLA_CHANNEL_FLAG_RS_AUTO_CALIBRATION 0x1000 // ver. >= 15
646#define SUPLA_CHANNEL_FLAG_CALCFG_RESET_COUNTERS 0x2000 // ver. >= 15
647#define SUPLA_CHANNEL_FLAG_CALCFG_RECALIBRATE 0x4000 // ver. >= 15
648#define SUPLA_CHANNEL_FLAG_CALCFG_IDENTIFY_SUBDEVICE 0x8000 // ver. >= 25
649#define SUPLA_CHANNEL_FLAG_CHANNELSTATE 0x00010000 // ver. >= 12
650#define SUPLA_CHANNEL_FLAG_PHASE1_UNSUPPORTED 0x00020000 // ver. >= 12
651#define SUPLA_CHANNEL_FLAG_PHASE2_UNSUPPORTED 0x00040000 // ver. >= 12
652#define SUPLA_CHANNEL_FLAG_PHASE3_UNSUPPORTED 0x00080000 // ver. >= 12
653#define SUPLA_CHANNEL_FLAG_TIME_SETTING_NOT_AVAILABLE 0x00100000 // ver. >= 12
654#define SUPLA_CHANNEL_FLAG_RSA_ENCRYPTED_PIN_REQUIRED 0x00200000 // ver. >= 12
655#define SUPLA_CHANNEL_FLAG_OFFLINE_DURING_REGISTRATION 0x00400000 // ver. >= 12
656#define SUPLA_CHANNEL_FLAG_ZIGBEE_BRIDGE 0x00800000 // ver. >= 12
657#define SUPLA_CHANNEL_FLAG_COUNTDOWN_TIMER_SUPPORTED 0x01000000 // ver. >= 12
658#define SUPLA_CHANNEL_FLAG_LIGHTSOURCELIFESPAN_SETTABLE \
659 0x02000000 // ver. >= 12
660#define SUPLA_CHANNEL_FLAG_POSSIBLE_SLEEP_MODE_deprecated \
661 0x04000000 // ver. >= 12 DEPRECATED
662#define SUPLA_CHANNEL_FLAG_RUNTIME_CHANNEL_CONFIG_UPDATE \
663 0x08000000 // ver. >= 21
664#define SUPLA_CHANNEL_FLAG_WEEKLY_SCHEDULE 0x10000000 // ver. >= 21
665#define SUPLA_CHANNEL_FLAG_HAS_PARENT 0x20000000 // ver. >= 21
666#define SUPLA_CHANNEL_FLAG_CALCFG_RESTART_SUBDEVICE 0x40000000 // ver. >= 25
667#define SUPLA_CHANNEL_FLAG_BATTERY_COVER_AVAILABLE 0x80000000 // ver. >= 25
668#pragma pack(push, 1)
669
670typedef struct {
671 char tag[SUPLA_TAG_SIZE];
672 unsigned char version;
673 unsigned _supla_int_t rr_id; // Request/Response ID
674 unsigned _supla_int_t call_id;
675 unsigned _supla_int_t data_size;
676 char data[SUPLA_MAX_DATA_SIZE]; // Last variable in struct!
678
679typedef struct {
680 // server -> device|client
681 unsigned char proto_version_min;
682 unsigned char proto_version;
683 char SoftVer[SUPLA_SOFTVER_MAXSIZE];
685
686typedef struct {
687 // server -> device|client
688 unsigned char server_version_min;
689 unsigned char server_version;
691
692typedef struct {
693 // device|client -> server
694 struct _supla_timeval now;
696
697// Compatibility with ESP8266
699 _supla_int_t tv_sec;
700 _supla_int_t tv_usec;
701};
702
703typedef struct {
704 // device|client -> server
705 struct timeval_compat now;
707
708typedef struct {
709 // server -> device|client
710 struct _supla_timeval now;
712
713typedef struct {
714 // device|client -> server
715 unsigned char activity_timeout;
717
718typedef struct {
719 // server -> device|client
720 unsigned char activity_timeout;
721 unsigned char min;
722 unsigned char max;
724
725typedef struct {
726 char value[SUPLA_CHANNELVALUE_SIZE];
727 char sub_value[SUPLA_CHANNELVALUE_SIZE]; // For example sensor value
729
730typedef struct {
731 char value[SUPLA_CHANNELVALUE_SIZE];
732 char sub_value[SUPLA_CHANNELVALUE_SIZE]; // For example sensor value
733 char sub_value_type; // SUBV_TYPE_
735
736#define SUBV_TYPE_NOT_SET_OR_OFFLINE 0
737#define SUBV_TYPE_SENSOR 1
738#define SUBV_TYPE_ELECTRICITY_MEASUREMENTS 2
739#define SUBV_TYPE_IC_MEASUREMENTS 3
740
741#define EV_TYPE_NONE 0
742#ifdef USE_DEPRECATED_EMEV_V1
743#define EV_TYPE_ELECTRICITY_METER_MEASUREMENT_V1 10
744#endif /*USE_DEPRECATED_EMEV_V1*/
745#ifdef USE_DEPRECATED_EMEV_V2
746#define EV_TYPE_ELECTRICITY_METER_MEASUREMENT_V2 12
747#endif /*USE_DEPRECATED_EMEV_V2*/
748#define EV_TYPE_ELECTRICITY_METER_MEASUREMENT_V3 14
749#define EV_TYPE_IMPULSE_COUNTER_DETAILS_V1 20
750#define EV_TYPE_THERMOSTAT_DETAILS_V1 30
751#define EV_TYPE_CHANNEL_STATE_V1 40
752#define EV_TYPE_TIMER_STATE_V1 50
753#define EV_TYPE_TIMER_STATE_V1_SEC 51
754#define EV_TYPE_CHANNEL_AND_TIMER_STATE_V1 60
755#define EV_TYPE_MULTI_VALUE 100
756
757#define CALCFG_TYPE_THERMOSTAT_DETAILS_V1 10
758
759typedef struct {
760 char type; // EV_TYPE_
761 unsigned _supla_int_t size;
762 char value[SUPLA_CHANNELEXTENDEDVALUE_SIZE]; // Last variable in struct!
763} TSuplaChannelExtendedValue; // v. >= 10
764
765typedef struct {
766 // server -> client
767 char EOL; // End Of List
768 _supla_int_t Id;
769 unsigned _supla_int_t
770 CaptionSize; // including the terminating null byte ('\0')
771 char Caption[SUPLA_LOCATION_CAPTION_MAXSIZE]; // Last variable in struct!
773
774typedef struct {
775 // server -> client
776 _supla_int_t count;
777 _supla_int_t total_left;
779 items[SUPLA_LOCATIONPACK_MAXCOUNT]; // Last variable in struct!
781
782typedef struct {
783 // device -> server
784 unsigned char Number;
785 _supla_int_t Type;
786 char value[SUPLA_CHANNELVALUE_SIZE];
788
789typedef struct {
790 // device -> server
791
792 _supla_int_t LocationID;
793 char LocationPWD[SUPLA_LOCATION_PWD_MAXSIZE]; // UTF8
794
795 char GUID[SUPLA_GUID_SIZE];
796 char Name[SUPLA_DEVICE_NAME_MAXSIZE]; // UTF8
797 char SoftVer[SUPLA_SOFTVER_MAXSIZE];
798
799 unsigned char channel_count;
801 channels[SUPLA_CHANNELMAXCOUNT]; // Last variable in struct!
803
804typedef struct {
805 // device -> server
806
807 unsigned char Number;
808 _supla_int_t Type;
809
810 _supla_int_t FuncList;
811 _supla_int_t Default;
812
813 char value[SUPLA_CHANNELVALUE_SIZE];
814} TDS_SuplaDeviceChannel_B; // ver. >= 2
815
816typedef struct {
817 unsigned char relatedChannelNumber; // ChannelNumber + 1.
818 unsigned _supla_int_t disablesLocalOperation;
820
821#define SUPLA_HVAC_VALUE_FLAG_SETPOINT_TEMP_HEAT_SET (1ULL << 0)
822#define SUPLA_HVAC_VALUE_FLAG_SETPOINT_TEMP_COOL_SET (1ULL << 1)
823// Tells if output responsible for heating function is enabled
824#define SUPLA_HVAC_VALUE_FLAG_HEATING (1ULL << 2)
825// Tells if output responsible for cooling function is enabled
826#define SUPLA_HVAC_VALUE_FLAG_COOLING (1ULL << 3)
827// Tells if channel works in Weekly Schedule mode. If set to 0, then it works
828// in manual mode
829#define SUPLA_HVAC_VALUE_FLAG_WEEKLY_SCHEDULE (1ULL << 4)
830#define SUPLA_HVAC_VALUE_FLAG_COUNTDOWN_TIMER (1ULL << 5)
831// FAN flag tells if fan function is enabled
832#define SUPLA_HVAC_VALUE_FLAG_FAN_ENABLED (1ULL << 6)
833#define SUPLA_HVAC_VALUE_FLAG_THERMOMETER_ERROR (1ULL << 7)
834#define SUPLA_HVAC_VALUE_FLAG_CLOCK_ERROR (1ULL << 8)
835#define SUPLA_HVAC_VALUE_FLAG_FORCED_OFF_BY_SENSOR (1ULL << 9)
836// Only for SUPLA_CHANNELFNC_HVAC_THERMOSTAT
837// If the COOL flag is not set, it means that the thermostat is working in
838// heating mode.
839#define SUPLA_HVAC_VALUE_FLAG_COOL (1ULL << 10)
840#define SUPLA_HVAC_VALUE_FLAG_WEEKLY_SCHEDULE_TEMPORAL_OVERRIDE (1ULL << 11)
841#define SUPLA_HVAC_VALUE_FLAG_BATTERY_COVER_OPEN (1ULL << 12)
842#define SUPLA_HVAC_VALUE_FLAG_CALIBRATION_ERROR (1ULL << 13)
843#define SUPLA_HVAC_VALUE_FLAG_ANTIFREEZE_OVERHEAT_ACTIVE (1ULL << 14)
844
845// HVAC modes are used in channel value (as a command from server or
846// as a status response from device to server) and in weekly schedules
847// programs. Programs can't use value TURN_ON and WEEKLY_SCHEDULE
848// Use SUPLA_HVAC_MODE_NOT_SET if you don't want to modify current mode, but
849// only to alter tempreature setpoints.
850#define SUPLA_HVAC_MODE_NOT_SET 0
851#define SUPLA_HVAC_MODE_OFF 1
852#define SUPLA_HVAC_MODE_HEAT 2
853#define SUPLA_HVAC_MODE_COOL 3
854#define SUPLA_HVAC_MODE_HEAT_COOL 4
855#define SUPLA_HVAC_MODE_FAN_ONLY 6
856#define SUPLA_HVAC_MODE_DRY 7
857// TURN ON mode is a command. Device will use it to turn on and then it will
858// restore previous mode which was used before turn off.
859#define SUPLA_HVAC_MODE_CMD_TURN_ON 8
860// Weekly schedule is a command. Device will use it to enable weekly schedule
861// mode and then it will set its mode according to schedule
862#define SUPLA_HVAC_MODE_CMD_WEEKLY_SCHEDULE 9
863// Switch to manual mode - it will restore previously used manual mode and
864// restore manual mode temperature setpoints when no new setpoints are given
865// in value.
866// It can be also used to switch to default manual mode, when no manual mode
867// was used earlier.
868#define SUPLA_HVAC_MODE_CMD_SWITCH_TO_MANUAL 10
869
870typedef struct {
871 unsigned char IsOn; // DS: 0/1 (for off/on) or 2..102 (for 0-100%)
872 unsigned char Mode; // SUPLA_HVAC_MODE_
873 _supla_int16_t
874 SetpointTemperatureHeat; // * 0.01 Celcius degree - used for heating
875 _supla_int16_t
876 SetpointTemperatureCool; // * 0.01 - Celcius degree used for cooling
877 unsigned _supla_int16_t Flags; // SUPLA_HVAC_VALUE_FLAG_
878} THVACValue;
879
880typedef struct {
881 // device -> server
882
883 unsigned char Number;
884 _supla_int_t Type;
885
886 union {
887 _supla_int_t FuncList;
888 unsigned _supla_int_t ActionTriggerCaps; // ver. >= 16
889 };
890
891 _supla_int_t Default;
892 _supla_int_t Flags;
893
894 union {
895 char value[SUPLA_CHANNELVALUE_SIZE];
896 TActionTriggerProperties actionTriggerProperties; // ver. >= 16
897 THVACValue hvacValue;
898 };
899} TDS_SuplaDeviceChannel_C; // ver. >= 10
900
901// Channel state flag values:
902#define SUPLA_CHANNEL_OFFLINE_FLAG_ONLINE 0
903#define SUPLA_CHANNEL_OFFLINE_FLAG_OFFLINE 1
904#define SUPLA_CHANNEL_OFFLINE_FLAG_ONLINE_BUT_NOT_AVAILABLE 2
905#define SUPLA_CHANNEL_OFFLINE_FLAG_OFFLINE_REMOTE_WAKEUP_NOT_SUPPORTED 3
906#define SUPLA_CHANNEL_OFFLINE_FLAG_FIRMWARE_UPDATE_ONGOING 4
907
908// Update below MAX value when new state is added to the list
909#define SUPLA_CHANNEL_OFFLINE_FLAG_MAX \
910 SUPLA_CHANNEL_OFFLINE_FLAG_FIRMWARE_UPDATE_ONGOING
911
912// Only in ONLINE state, ValidityTimeSec and value variables are used.
913// OFFLINE_REMOTE_WAKEUP_NOT_SUPPORTED - device doesn't support remote wakeup,
914// so we wait for it to initiate the communication.
915
916// Channel online flag values (only online/offline 0/1 values are exchanged,
917// compared to state flag values):
918#define SUPLA_CHANNEL_ONLINE_FLAG_ONLINE 1
919#define SUPLA_CHANNEL_ONLINE_FLAG_OFFLINE 0
920#define SUPLA_CHANNEL_ONLINE_FLAG_ONLINE_BUT_NOT_AVAILABLE \
921 SUPLA_CHANNEL_OFFLINE_FLAG_ONLINE_BUT_NOT_AVAILABLE
922#define SUPLA_CHANNEL_ONLINE_FLAG_STATE_REMOTE_WAKEUP_NOT_SUPPORTED \
923 SUPLA_CHANNEL_OFFLINE_FLAG_OFFLINE_REMOTE_WAKEUP_NOT_SUPPORTED
924#define SUPLA_CHANNEL_ONLINE_FLAG_FIRMWARE_UPDATE_ONGOING \
925 SUPLA_CHANNEL_OFFLINE_FLAG_FIRMWARE_UPDATE_ONGOING
926
927typedef struct {
928 // device -> server
929
930 unsigned char Number;
931 _supla_int_t Type;
932
933 union {
934 _supla_int_t FuncList;
935 unsigned _supla_int_t ActionTriggerCaps; // ver. >= 16
936 };
937
938 _supla_int_t Default;
939 _supla_int64_t Flags;
940
941 unsigned char Offline;
942 unsigned _supla_int_t ValueValidityTimeSec;
943
944 union {
945 char value[SUPLA_CHANNELVALUE_SIZE];
946 TActionTriggerProperties actionTriggerProperties; // ver. >= 16
947 THVACValue hvacValue;
948 };
949
950 unsigned char DefaultIcon;
951} TDS_SuplaDeviceChannel_D; // ver. >= 23
952
953typedef struct {
954 // device -> server
955
956 unsigned char Number;
957 _supla_int_t Type;
958
959 union {
960 _supla_int_t FuncList;
961 unsigned _supla_int_t ActionTriggerCaps; // ver. >= 16
962 };
963
964 _supla_int_t Default;
965 _supla_int64_t Flags;
966
967 unsigned char Offline; // see SUPLA_CHANNEL_OFFLINE_FLAG_
968
969 unsigned _supla_int_t ValueValidityTimeSec;
970
971 union {
972 char value[SUPLA_CHANNELVALUE_SIZE];
973 TActionTriggerProperties actionTriggerProperties; // ver. >= 16
974 THVACValue hvacValue;
975 };
976
977 unsigned char DefaultIcon;
978 unsigned char SubDeviceId; // 0 - no subdevice, 1..255 - subdevice id
979} TDS_SuplaDeviceChannel_E; // ver. >= 25
980
981typedef struct {
982 // device -> server
983
984 _supla_int_t LocationID;
985 char LocationPWD[SUPLA_LOCATION_PWD_MAXSIZE]; // UTF8
986
987 char GUID[SUPLA_GUID_SIZE];
988 char Name[SUPLA_DEVICE_NAME_MAXSIZE]; // UTF8
989 char SoftVer[SUPLA_SOFTVER_MAXSIZE];
990
991 unsigned char channel_count;
993 channels[SUPLA_CHANNELMAXCOUNT]; // Last variable in struct!
994} TDS_SuplaRegisterDevice_B; // ver. >= 2
995
996typedef struct {
997 // device -> server
998
999 _supla_int_t LocationID;
1000 char LocationPWD[SUPLA_LOCATION_PWD_MAXSIZE]; // UTF8
1001
1002 char GUID[SUPLA_GUID_SIZE];
1003 char Name[SUPLA_DEVICE_NAME_MAXSIZE]; // UTF8
1004 char SoftVer[SUPLA_SOFTVER_MAXSIZE];
1005
1006 char ServerName[SUPLA_SERVER_NAME_MAXSIZE]; // ServerName is equal to Server
1007 // host name/IP
1008
1009 unsigned char channel_count;
1011 channels[SUPLA_CHANNELMAXCOUNT]; // Last variable in struct!
1012} TDS_SuplaRegisterDevice_C; // ver. >= 6
1013
1014typedef struct {
1015 // device -> server
1016
1017 char Email[SUPLA_EMAIL_MAXSIZE]; // UTF8
1018 char AuthKey[SUPLA_AUTHKEY_SIZE];
1019
1020 char GUID[SUPLA_GUID_SIZE];
1021
1022 char Name[SUPLA_DEVICE_NAME_MAXSIZE]; // UTF8
1023 char SoftVer[SUPLA_SOFTVER_MAXSIZE];
1024
1025 char ServerName[SUPLA_SERVER_NAME_MAXSIZE];
1026
1027 unsigned char channel_count;
1029 channels[SUPLA_CHANNELMAXCOUNT]; // Last variable in struct!
1030} TDS_SuplaRegisterDevice_D; // ver. >= 7
1031
1032typedef struct {
1033 // device -> server
1034
1035 char Email[SUPLA_EMAIL_MAXSIZE]; // UTF8
1036 char AuthKey[SUPLA_AUTHKEY_SIZE];
1037
1038 char GUID[SUPLA_GUID_SIZE];
1039
1040 char Name[SUPLA_DEVICE_NAME_MAXSIZE]; // UTF8
1041 char SoftVer[SUPLA_SOFTVER_MAXSIZE];
1042
1043 char ServerName[SUPLA_SERVER_NAME_MAXSIZE];
1044
1045 _supla_int_t Flags; // SUPLA_DEVICE_FLAG_*
1046 _supla_int16_t ManufacturerID;
1047 _supla_int16_t ProductID;
1048
1049 unsigned char channel_count;
1051 channels[SUPLA_CHANNELMAXCOUNT]; // Last variable in struct!
1052} TDS_SuplaRegisterDevice_E; // ver. >= 10
1053
1054typedef struct {
1055 // device -> server
1056
1057 char Email[SUPLA_EMAIL_MAXSIZE]; // UTF8
1058 char AuthKey[SUPLA_AUTHKEY_SIZE];
1059
1060 char GUID[SUPLA_GUID_SIZE];
1061
1062 char Name[SUPLA_DEVICE_NAME_MAXSIZE]; // UTF8
1063 char SoftVer[SUPLA_SOFTVER_MAXSIZE];
1064
1065 char ServerName[SUPLA_SERVER_NAME_MAXSIZE];
1066
1067 _supla_int_t Flags; // SUPLA_DEVICE_FLAG_*
1068 _supla_int16_t ManufacturerID;
1069 _supla_int16_t ProductID;
1070
1071 unsigned char channel_count;
1073
1074typedef struct {
1075 // device -> server
1076
1077 char Email[SUPLA_EMAIL_MAXSIZE]; // UTF8
1078 char AuthKey[SUPLA_AUTHKEY_SIZE];
1079
1080 char GUID[SUPLA_GUID_SIZE];
1081
1082 char Name[SUPLA_DEVICE_NAME_MAXSIZE]; // UTF8
1083 char SoftVer[SUPLA_SOFTVER_MAXSIZE];
1084
1085 char ServerName[SUPLA_SERVER_NAME_MAXSIZE];
1086
1087 _supla_int_t Flags; // SUPLA_DEVICE_FLAG_*
1088 _supla_int16_t ManufacturerID;
1089 _supla_int16_t ProductID;
1090
1091 unsigned char channel_count;
1093 channels[SUPLA_CHANNELMAXCOUNT]; // Last variable in struct!
1094} TDS_SuplaRegisterDevice_F; // ver. >= 23
1095
1096typedef struct {
1097 // device -> server
1098
1099 char Email[SUPLA_EMAIL_MAXSIZE]; // UTF8
1100 char AuthKey[SUPLA_AUTHKEY_SIZE];
1101
1102 char GUID[SUPLA_GUID_SIZE];
1103
1104 char Name[SUPLA_DEVICE_NAME_MAXSIZE]; // UTF8
1105 char SoftVer[SUPLA_SOFTVER_MAXSIZE];
1106
1107 char ServerName[SUPLA_SERVER_NAME_MAXSIZE];
1108
1109 _supla_int_t Flags; // SUPLA_DEVICE_FLAG_*
1110 _supla_int16_t ManufacturerID;
1111 _supla_int16_t ProductID;
1112
1113 unsigned char channel_count;
1115 channels[SUPLA_CHANNELMAXCOUNT]; // Last variable in struct!
1116} TDS_SuplaRegisterDevice_G; // ver. >= 25
1117
1118typedef struct {
1119 // server -> device
1120
1121 _supla_int_t result_code;
1122 unsigned char activity_timeout;
1123 unsigned char version;
1124 unsigned char version_min;
1126
1127#define CHANNEL_REPORT_CHANNEL_REGISTERED (1 << 0)
1128#define CHANNEL_REPORT_INCORRECT_CHANNEL_TYPE (1 << 1)
1129#define CHANNEL_REPORT_MAXSIZE 256
1130
1131typedef struct {
1132 // server -> device
1133
1134 _supla_int_t result_code;
1135 unsigned char activity_timeout;
1136 unsigned char version;
1137 unsigned char version_min;
1138
1139 unsigned _supla_int16_t channel_report_size;
1140 unsigned char channel_report
1141 [CHANNEL_REPORT_MAXSIZE]; // One byte per channel. The meaning of the
1142 // bits is determined by CHANNEL_REPORT_*.
1143} TSD_SuplaRegisterDeviceResult_B; // ver. >= 25
1144
1145typedef struct {
1146 // device -> server
1147
1148 unsigned char ChannelNumber;
1149 char value[SUPLA_CHANNELVALUE_SIZE];
1151
1152typedef struct {
1153 // device -> server
1154
1155 unsigned char ChannelNumber;
1156 unsigned char Offline;
1157 char value[SUPLA_CHANNELVALUE_SIZE];
1158} TDS_SuplaDeviceChannelValue_B; // v. >= 12
1159
1160typedef struct {
1161 // device -> server
1162
1163 unsigned char ChannelNumber;
1164 unsigned char Offline; // see SUPLA_CHANNEL_OFFLINE_FLAG_
1165
1166 unsigned _supla_int_t ValidityTimeSec;
1167 char value[SUPLA_CHANNELVALUE_SIZE];
1168} TDS_SuplaDeviceChannelValue_C; // v. >= 12
1169
1170typedef struct {
1171 // device -> server
1172
1173 unsigned char ChannelNumber;
1174 TSuplaChannelExtendedValue value; // Last variable in struct!
1176
1177typedef struct {
1178 // server -> device
1179 _supla_int_t SenderID;
1180 unsigned char ChannelNumber;
1181 union {
1182 unsigned _supla_int_t DurationMS;
1183 unsigned _supla_int_t DurationSec; // ver. >= 21. Applies to HVAC
1184 };
1185
1186 char value[SUPLA_CHANNELVALUE_SIZE];
1188
1189typedef struct {
1190 // server -> device
1191 _supla_int_t SenderID;
1192 _supla_int_t GroupID;
1193 unsigned char EOL; // End Of List
1194 unsigned char ChannelNumber;
1195 union {
1196 unsigned _supla_int_t DurationMS;
1197 unsigned _supla_int_t DurationSec; // ver. >= 21. Applies to HVAC
1198 };
1199 char value[SUPLA_CHANNELVALUE_SIZE];
1200} TSD_SuplaChannelGroupNewValue; // v. >= 13
1201
1202typedef struct {
1203 // device -> server
1204 unsigned char ChannelNumber;
1205 _supla_int_t SenderID;
1206 char Success;
1208
1209typedef struct {
1210 // server -> client
1211
1212 char EOL; // End Of List
1213 _supla_int_t Id;
1214 char online; // see SUPLA_CHANNEL_ONLINE_FLAG_
1215
1216 TSuplaChannelValue value;
1218
1219typedef struct {
1220 // server -> client
1221
1222 char EOL; // End Of List
1223 _supla_int_t Id;
1224 char online; // see SUPLA_CHANNEL_ONLINE_FLAG_
1225
1227} TSC_SuplaChannelValue_B; // ver. >= 15
1228
1229typedef struct {
1230 // server -> client
1231 _supla_int_t Id;
1232
1233 TSuplaChannelExtendedValue value; // Last variable in struct!
1235
1236typedef struct {
1237 // server -> client
1238
1239 _supla_int_t count;
1240 _supla_int_t total_left;
1241
1243 items[SUPLA_CHANNELVALUE_PACK_MAXCOUNT]; // Last variable in struct!
1244} TSC_SuplaChannelValuePack; // ver. >= 9
1245
1246typedef struct {
1247 // server -> client
1248
1249 _supla_int_t count;
1250 _supla_int_t total_left;
1251
1253 items[SUPLA_CHANNELVALUE_PACK_MAXCOUNT]; // Last variable in struct!
1254} TSC_SuplaChannelValuePack_B; // ver. >= 15
1255
1256typedef struct {
1257 // server -> client
1258
1259 _supla_int_t count;
1260 _supla_int_t total_left;
1261 unsigned _supla_int_t pack_size;
1262
1263 char pack[SUPLA_CHANNELEXTENDEDVALUE_PACK_MAXDATASIZE]; // Last variable in
1264 // struct!
1265} TSC_SuplaChannelExtendedValuePack; // ver. >= 10
1266
1267typedef struct {
1268 // server -> client
1269 char EOL; // End Of List
1270
1271 _supla_int_t Id;
1272 _supla_int_t LocationID;
1273 _supla_int_t Func;
1274 char online; // see SUPLA_CHANNEL_ONLINE_FLAG_
1275
1276 TSuplaChannelValue value;
1277
1278 unsigned _supla_int_t
1279 CaptionSize; // including the terminating null byte ('\0')
1280 char Caption[SUPLA_CHANNEL_CAPTION_MAXSIZE]; // Last variable in struct!
1282
1283typedef struct {
1284 // server -> client
1285
1286 _supla_int_t count;
1287 _supla_int_t total_left;
1289 items[SUPLA_CHANNELPACK_MAXCOUNT]; // Last variable in struct!
1291
1292typedef struct {
1293 // server -> client
1294 char EOL; // End Of List
1295
1296 _supla_int_t Id;
1297 _supla_int_t LocationID;
1298 _supla_int_t Func;
1299 _supla_int_t AltIcon;
1300 unsigned _supla_int_t Flags;
1301 unsigned char ProtocolVersion;
1302 char online; // see SUPLA_CHANNEL_ONLINE_FLAG_
1303
1304 TSuplaChannelValue value;
1305
1306 unsigned _supla_int_t
1307 CaptionSize; // including the terminating null byte ('\0')
1308 char Caption[SUPLA_CHANNEL_CAPTION_MAXSIZE]; // Last variable in struct!
1309} TSC_SuplaChannel_B; // ver. >= 8
1310
1311typedef struct {
1312 // server -> client
1313
1314 _supla_int_t count;
1315 _supla_int_t total_left;
1317 items[SUPLA_CHANNELPACK_MAXCOUNT]; // Last variable in struct!
1318} TSC_SuplaChannelPack_B; // ver. >= 8
1319
1320typedef struct {
1321 // server -> client
1322 char EOL; // End Of List
1323
1324 _supla_int_t Id;
1325 _supla_int_t DeviceID;
1326 _supla_int_t LocationID;
1327 _supla_int_t Type;
1328 _supla_int_t Func;
1329 _supla_int_t AltIcon;
1330 _supla_int_t UserIcon;
1331 _supla_int16_t ManufacturerID;
1332 _supla_int16_t ProductID;
1333
1334 unsigned _supla_int_t Flags;
1335 unsigned char ProtocolVersion;
1336 char online; // see SUPLA_CHANNEL_ONLINE_FLAG_
1337
1338 TSuplaChannelValue value;
1339
1340 unsigned _supla_int_t
1341 CaptionSize; // including the terminating null byte ('\0')
1342 char Caption[SUPLA_CHANNEL_CAPTION_MAXSIZE]; // Last variable in struct!
1343} TSC_SuplaChannel_C; // ver. >= 10
1344
1345typedef struct {
1346 // server -> client
1347 char EOL; // End Of List
1348
1349 _supla_int_t Id;
1350 _supla_int_t DeviceID;
1351 _supla_int_t LocationID;
1352 _supla_int_t Type;
1353 _supla_int_t Func;
1354 _supla_int_t AltIcon;
1355 _supla_int_t UserIcon;
1356 _supla_int16_t ManufacturerID;
1357 _supla_int16_t ProductID;
1358
1359 unsigned _supla_int_t Flags;
1360 unsigned char ProtocolVersion;
1361 char online; // see SUPLA_CHANNEL_ONLINE_FLAG_
1362
1364
1365 unsigned _supla_int_t
1366 CaptionSize; // including the terminating null byte ('\0')
1367 char Caption[SUPLA_CHANNEL_CAPTION_MAXSIZE]; // Last variable in struct!
1368} TSC_SuplaChannel_D; // ver. >= 15
1369
1370typedef struct {
1371 // server -> client
1372 char EOL; // End Of List
1373
1374 _supla_int_t Id;
1375 _supla_int_t DeviceID;
1376 _supla_int_t LocationID;
1377 _supla_int_t Type;
1378 _supla_int_t Func;
1379 _supla_int_t AltIcon;
1380 _supla_int_t UserIcon;
1381 _supla_int16_t ManufacturerID;
1382 _supla_int16_t ProductID;
1383 unsigned _supla_int_t DefaultConfigCRC32;
1384
1385 unsigned _supla_int64_t Flags;
1386 unsigned char ProtocolVersion;
1387 char online; // see SUPLA_CHANNEL_ONLINE_FLAG_
1388
1390
1391 unsigned _supla_int_t
1392 CaptionSize; // including the terminating null byte ('\0')
1393 char Caption[SUPLA_CHANNEL_CAPTION_MAXSIZE]; // Last variable in struct!
1394} TSC_SuplaChannel_E; // ver. >= 23
1395
1396typedef struct {
1397 // server -> client
1398
1399 _supla_int_t count;
1400 _supla_int_t total_left;
1402 items[SUPLA_CHANNELPACK_MAXCOUNT]; // Last variable in struct!
1403} TSC_SuplaChannelPack_C; // ver. >= 10
1404
1405typedef struct {
1406 // server -> client
1407
1408 _supla_int_t count;
1409 _supla_int_t total_left;
1411 items[SUPLA_CHANNELPACK_MAXCOUNT]; // Last variable in struct!
1412} TSC_SuplaChannelPack_D; // ver. >= 15
1413
1414typedef struct {
1415 // server -> client
1416
1417 _supla_int_t count;
1418 _supla_int_t total_left;
1420 items[SUPLA_CHANNELPACK_MAXCOUNT]; // Last variable in struct!
1421} TSC_SuplaChannelPack_E; // ver. >= 23
1422
1423typedef struct {
1424 // server -> client
1425 char EOL; // End Of List
1426
1427 _supla_int_t Id;
1428 _supla_int_t LocationID;
1429 _supla_int_t Func;
1430 _supla_int_t AltIcon;
1431 unsigned _supla_int_t Flags;
1432
1433 unsigned _supla_int_t
1434 CaptionSize; // including the terminating null byte ('\0')
1435 char Caption[SUPLA_CHANNELGROUP_CAPTION_MAXSIZE]; // Last variable in struct!
1436} TSC_SuplaChannelGroup; // ver. >= 9
1437
1438typedef struct {
1439 // server -> client
1440 char EOL; // End Of List
1441
1442 _supla_int_t Id;
1443 _supla_int_t LocationID;
1444 _supla_int_t Func;
1445 _supla_int_t AltIcon;
1446 _supla_int_t UserIcon;
1447 unsigned _supla_int_t Flags;
1448
1449 unsigned _supla_int_t
1450 CaptionSize; // including the terminating null byte ('\0')
1451 char Caption[SUPLA_CHANNELGROUP_CAPTION_MAXSIZE]; // Last variable in struct!
1452} TSC_SuplaChannelGroup_B; // ver. >= 10
1453
1454typedef struct {
1455 // server -> client
1456
1457 _supla_int_t count;
1458 _supla_int_t total_left;
1460 items[SUPLA_CHANNELGROUP_PACK_MAXCOUNT]; // Last variable in struct!
1461} TSC_SuplaChannelGroupPack; // ver. >= 9
1462
1463typedef struct {
1464 // server -> client
1465
1466 _supla_int_t count;
1467 _supla_int_t total_left;
1469 items[SUPLA_CHANNELGROUP_PACK_MAXCOUNT]; // Last variable in struct!
1470} TSC_SuplaChannelGroupPack_B; // ver. >= 10
1471
1472typedef struct {
1473 // server -> client
1474 char EOL; // End Of List
1475
1476 _supla_int_t ChannelGroupID;
1477 _supla_int_t ChannelID;
1478} TSC_SuplaChannelGroupRelation; // ver. >= 9
1479
1480typedef struct {
1481 // server -> client
1482
1483 _supla_int_t count;
1484 _supla_int_t total_left;
1486 items[SUPLA_CHANNELGROUP_RELATION_PACK_MAXCOUNT]; // Last variable in
1487 // struct!
1489
1490#define CHANNEL_RELATION_TYPE_DEFAULT 0
1491#define CHANNEL_RELATION_TYPE_OPENING_SENSOR 1
1492#define CHANNEL_RELATION_TYPE_PARTIAL_OPENING_SENSOR 2
1493#define CHANNEL_RELATION_TYPE_METER 3
1494#define CHANNEL_RELATION_TYPE_MAIN_TERMOMETER 4
1495#define CHANNEL_RELATION_TYPE_AUX_THERMOMETER_FLOOR 5
1496#define CHANNEL_RELATION_TYPE_AUX_THERMOMETER_WATER 6
1497#define CHANNEL_RELATION_TYPE_AUX_THERMOMETER_GENERIC_HEATER 7
1498#define CHANNEL_RELATION_TYPE_AUX_THERMOMETER_GENERIC_COOLER 8
1499
1500#define CHANNEL_RELATION_TYPE_MASTER_THERMOSTAT 20
1501#define CHANNEL_RELATION_TYPE_HEAT_OR_COLD_SOURCE_SWITCH 21
1502#define CHANNEL_RELATION_TYPE_PUMP_SWITCH 22
1503
1504typedef struct {
1505 char EOL; // End Of List
1506 _supla_int_t Id;
1507 _supla_int_t ParentId;
1508 _supla_int16_t Type; // CHANNEL_RELATION_TYPE_
1509} TSC_SuplaChannelRelation; // ver. >= 21
1510
1511typedef struct {
1512 _supla_int_t count;
1513 _supla_int_t total_left;
1515 items[SUPLA_CHANNEL_RELATION_PACK_MAXCOUNT]; // Last variable in struct!
1517
1518typedef struct {
1519 // server -> client
1520 char EOL; // End Of List
1521
1522 _supla_int_t Id;
1523 _supla_int_t LocationId;
1524 _supla_int_t AltIcon;
1525 _supla_int_t UserIcon;
1526
1527 unsigned _supla_int16_t
1528 CaptionSize; // including the terminating null byte ('\0')
1529 char Caption[SUPLA_SCENE_CAPTION_MAXSIZE]; // Last variable in struct!
1530} TSC_SuplaScene; // ver. >= 18
1531
1532typedef struct {
1533 // server -> client
1534
1535 _supla_int_t count;
1536 _supla_int_t total_left;
1537 TSC_SuplaScene items[SUPLA_SCENE_PACK_MAXCOUNT]; // Last variable in struct!
1538} TSC_SuplaScenePack; // ver. >= 18
1539
1540typedef struct {
1541 // server -> client
1542 char EOL; // End Of List
1543
1544 _supla_int_t SceneId;
1545 unsigned _supla_int_t MillisecondsFromStart;
1546 unsigned _supla_int_t MillisecondsLeft;
1547
1548 _supla_int_t InitiatorId;
1549 unsigned _supla_int16_t
1550 InitiatorNameSize; // including the terminating null byte ('\0')
1551 char InitiatorName[SUPLA_INITIATOR_NAME_MAXSIZE]; // Last variable in struct!
1552} TSC_SuplaSceneState; // ver. >= 18
1553
1554typedef struct {
1555 // server -> client
1556
1557 _supla_int_t count;
1558 _supla_int_t total_left;
1560 items[SUPLA_SCENE_STATE_PACK_MAXCOUNT]; // Last variable in struct!
1561} TSC_SuplaSceneStatePack; // ver. >= 18
1562
1563#define ACTION_SUBJECT_TYPE_UNKNOWN 0
1564#define ACTION_SUBJECT_TYPE_CHANNEL 1
1565#define ACTION_SUBJECT_TYPE_CHANNEL_GROUP 2
1566#define ACTION_SUBJECT_TYPE_SCENE 3
1567#define ACTION_SUBJECT_TYPE_SCHEDULE 4
1568
1569#define ACTION_OPEN 10
1570#define ACTION_CLOSE 20
1571#define ACTION_SHUT 30
1572#define ACTION_REVEAL 40
1573#define ACTION_REVEAL_PARTIALLY 50
1574#define ACTION_SHUT_PARTIALLY 51
1575#define ACTION_TURN_ON 60
1576#define ACTION_TURN_ON_WITH_DURATION 61
1577#define ACTION_TURN_OFF 70
1578#define ACTION_TURN_OFF_WITH_DURATION 71
1579#define ACTION_SET_RGBW_PARAMETERS 80
1580#define ACTION_OPEN_CLOSE 90
1581#define ACTION_STOP 100
1582#define ACTION_TOGGLE 110
1583#define ACTION_UP_OR_STOP 140
1584#define ACTION_DOWN_OR_STOP 150
1585#define ACTION_STEP_BY_STEP 160
1586#define ACTION_UP 170
1587#define ACTION_DOWN 180
1588#define ACTION_ENABLE 200
1589#define ACTION_DISABLE 210
1590#define ACTION_SEND 220
1591#define ACTION_HVAC_SET_PARAMETERS 230
1592#define ACTION_HVAC_SWITCH_TO_PROGRAM_MODE 231
1593#define ACTION_HVAC_SWITCH_TO_MANUAL_MODE 232
1594#define ACTION_HVAC_SET_TEMPERATURES 233
1595#define ACTION_HVAC_SET_TEMPERATURE 234
1596#define ACTION_READ 1000
1597#define ACTION_SET 2000
1598#define ACTION_EXECUTE 3000
1599#define ACTION_INTERRUPT 3001
1600#define ACTION_INTERRUPT_AND_EXECUTE 3002
1601#define ACTION_COPY 10100
1602#define ACTION_FORWARD_OUTSIDE 10000
1603
1604#define SSP_FLAG_PERCENTAGE_AS_DELTA (1 << 0)
1605#define SSP_FLAG_TILT_AS_DELTA (1 << 1)
1606
1607typedef struct {
1608 char Percentage;
1609 unsigned char Flags; // SSP_FLAG_
1610 signed char Tilt;
1611 char Reserved[13];
1612} TAction_ShadingSystem_Parameters; // ver. >= 19
1613
1614typedef struct {
1615 char Brightness; // -1 == Ignore
1616 char ColorBrightness; // -1 == Ignore
1617 unsigned _supla_int_t Color; // 0 == Ignore
1618 char ColorRandom;
1619 char OnOff;
1620 char Reserved[8];
1621} TAction_RGBW_Parameters; // ver. >= 19
1622
1623typedef struct {
1624 unsigned _supla_int_t DurationSec;
1625 unsigned char Mode; // for HVAC: SUPLA_HVAC_MODE_
1626 _supla_int16_t
1627 SetpointTemperatureHeat; // * 0.01 Celcius degree - used for heating
1628 _supla_int16_t
1629 SetpointTemperatureCool; // * 0.01 - Celcius degree used for coolingx
1630 unsigned _supla_int16_t Flags; // SUPLA_HVAC_VALUE_FLAG_
1632
1633typedef struct {
1634 _supla_int_t ActionId;
1635 _supla_int_t SubjectId;
1636 unsigned char SubjectType;
1637 unsigned _supla_int16_t ParamSize;
1638 char Param[SUPLA_ACTION_PARAM_MAXSIZE];
1639} TCS_Action; // ver. >= 19
1640
1641typedef struct {
1642 _supla_int_t AccessID;
1643 char AccessIDpwd[SUPLA_ACCESSID_PWD_MAXSIZE]; // UTF8
1644 char Email[SUPLA_EMAIL_MAXSIZE]; // UTF8
1645 char AuthKey[SUPLA_AUTHKEY_SIZE];
1646 char GUID[SUPLA_GUID_SIZE];
1647 char ServerName[SUPLA_SERVER_NAME_MAXSIZE];
1648} TCS_ClientAuthorizationDetails; // ver. >= 19
1649
1650typedef struct {
1652 TCS_Action Action;
1653} TCS_ActionWithAuth; // ver. >= 19
1654
1655typedef struct {
1656 unsigned char ResultCode;
1657 _supla_int_t ActionId;
1658 _supla_int_t SubjectId;
1659 _supla_int_t SubjectType;
1660} TSC_ActionExecutionResult; // ver. >= 19
1661
1662typedef struct {
1663 // server -> client
1664 unsigned char ResultCode;
1665 _supla_int_t ChannelId; // Alias SubjectId
1666 _supla_int_t Function;
1667
1669 TSuplaChannelExtendedValue ExtendedValue; // Last variable in struct!
1670} TSC_GetChannelValueResult; // ver. >= 19;
1671
1672typedef struct {
1674 _supla_int_t ChannelId;
1675} TCS_GetChannelValueWithAuth; // ver. >= 19
1676
1677typedef struct {
1678 // client -> server
1679
1680 _supla_int_t AccessID;
1681 char AccessIDpwd[SUPLA_ACCESSID_PWD_MAXSIZE]; // UTF8
1682
1683 char GUID[SUPLA_GUID_SIZE];
1684 char Name[SUPLA_CLIENT_NAME_MAXSIZE]; // UTF8
1685 char SoftVer[SUPLA_SOFTVER_MAXSIZE];
1687
1688typedef struct {
1689 // client -> server
1690
1691 _supla_int_t AccessID;
1692 char AccessIDpwd[SUPLA_ACCESSID_PWD_MAXSIZE]; // UTF8
1693
1694 char GUID[SUPLA_GUID_SIZE];
1695 char Name[SUPLA_CLIENT_NAME_MAXSIZE]; // UTF8
1696 char SoftVer[SUPLA_SOFTVER_MAXSIZE];
1697
1698 char ServerName[SUPLA_SERVER_NAME_MAXSIZE];
1699} TCS_SuplaRegisterClient_B; // ver. >= 6
1700
1701typedef struct {
1702 // client -> server
1703
1704 char Email[SUPLA_EMAIL_MAXSIZE]; // UTF8
1705 char AuthKey[SUPLA_AUTHKEY_SIZE];
1706
1707 char GUID[SUPLA_GUID_SIZE];
1708 char Name[SUPLA_CLIENT_NAME_MAXSIZE]; // UTF8
1709 char SoftVer[SUPLA_SOFTVER_MAXSIZE];
1710
1711 char ServerName[SUPLA_SERVER_NAME_MAXSIZE];
1712} TCS_SuplaRegisterClient_C; // ver. >= 7
1713
1714typedef struct {
1715 // client -> server
1716
1717 char Email[SUPLA_EMAIL_MAXSIZE]; // UTF8
1718 char Password[SUPLA_PASSWORD_MAXSIZE]; // Optional - UTF8
1719 char AuthKey[SUPLA_AUTHKEY_SIZE];
1720
1721 char GUID[SUPLA_GUID_SIZE];
1722 char Name[SUPLA_CLIENT_NAME_MAXSIZE]; // UTF8
1723 char SoftVer[SUPLA_SOFTVER_MAXSIZE];
1724
1725 char ServerName[SUPLA_SERVER_NAME_MAXSIZE];
1726} TCS_SuplaRegisterClient_D; // ver. >= 12
1727
1728typedef struct {
1729 // server -> client
1730
1731 _supla_int_t result_code;
1732 _supla_int_t ClientID;
1733 _supla_int_t LocationCount;
1734 _supla_int_t ChannelCount;
1735 unsigned char activity_timeout;
1736 unsigned char version;
1737 unsigned char version_min;
1739
1740typedef struct {
1741 // server -> client
1742
1743 _supla_int_t result_code;
1744 _supla_int_t ClientID;
1745 _supla_int_t LocationCount;
1746 _supla_int_t ChannelCount;
1747 _supla_int_t ChannelGroupCount;
1748 _supla_int_t Flags;
1749 unsigned char activity_timeout;
1750 unsigned char version;
1751 unsigned char version_min;
1752} TSC_SuplaRegisterClientResult_B; // ver. >= 9
1753
1754typedef struct {
1755 // server -> client
1756
1757 _supla_int_t result_code;
1758 _supla_int_t ClientID;
1759 _supla_int_t LocationCount;
1760 _supla_int_t ChannelCount;
1761 _supla_int_t ChannelGroupCount;
1762 _supla_int_t Flags;
1763 unsigned char activity_timeout;
1764 unsigned char version;
1765 unsigned char version_min;
1766 unsigned _supla_int_t serverUnixTimestamp; // current server time
1767} TSC_SuplaRegisterClientResult_C; // ver. >= 17
1768
1769typedef struct {
1770 // server -> client
1771
1772 _supla_int_t result_code;
1773 _supla_int_t ClientID;
1774 _supla_int16_t LocationCount;
1775 _supla_int16_t ChannelCount;
1776 _supla_int16_t ChannelGroupCount;
1777 _supla_int16_t SceneCount;
1778 _supla_int_t Flags;
1779 unsigned char activity_timeout;
1780 unsigned char version;
1781 unsigned char version_min;
1782 unsigned _supla_int_t serverUnixTimestamp; // current server time
1783} TSC_SuplaRegisterClientResult_D; // ver. >= 19
1784
1785typedef struct {
1786 // client -> server
1787 unsigned char ChannelId;
1788 char value[SUPLA_CHANNELVALUE_SIZE];
1789} TCS_SuplaChannelNewValue; // Deprecated
1790
1791typedef struct {
1792 // client -> server
1793 _supla_int_t ChannelId;
1794 char value[SUPLA_CHANNELVALUE_SIZE];
1796
1797typedef struct {
1798 // client -> server
1799 _supla_int_t Id;
1800 char Target; // SUPLA_TARGET_
1801 char value[SUPLA_CHANNELVALUE_SIZE];
1802} TCS_SuplaNewValue; // ver. >= 9
1803
1804typedef struct {
1805 // server -> client
1806 _supla_int_t Event;
1807 _supla_int_t ChannelID;
1808 unsigned _supla_int_t DurationMS;
1809
1810 _supla_int_t SenderID;
1811 unsigned _supla_int_t
1812 SenderNameSize; // including the terminating null byte ('\0')
1813 char
1814 SenderName[SUPLA_SENDER_NAME_MAXSIZE]; // Last variable in struct! | UTF8
1816
1817typedef struct {
1818 char Platform;
1819
1820 _supla_int_t Param1;
1821 _supla_int_t Param2;
1822 _supla_int_t Param3;
1823 _supla_int_t Param4;
1825
1826typedef struct {
1827 char available_protocols;
1828 char host[SUPLA_URL_HOST_MAXSIZE];
1829 _supla_int_t port;
1830 char path[SUPLA_URL_PATH_MAXSIZE];
1832
1833typedef struct {
1834 char exists;
1837
1838typedef struct {
1839 unsigned _supla_int_t client_timestamp; // time >= now == enabled
1840 unsigned _supla_int_t iodevice_timestamp; // time >= now == enabled
1842
1843typedef struct {
1844 unsigned _supla_int_t ExpiresIn;
1845 unsigned _supla_int_t
1846 TokenSize; // including the terminating null byte ('\0')
1847 char Token[SUPLA_OAUTH_TOKEN_MAXSIZE]; // Last variable in struct!
1848} TSC_OAuthToken; // ver. >= 10
1849
1850typedef struct {
1851 unsigned char ResultCode;
1852 TSC_OAuthToken Token;
1853} TSC_OAuthTokenRequestResult; // ver. >= 10
1854
1855typedef struct {
1856 // 3 phases
1857 unsigned _supla_int16_t freq; // * 0.01 Hz
1858 unsigned _supla_int16_t voltage[3]; // * 0.01 V
1859 unsigned _supla_int16_t
1860 current[3]; // * 0.001A (0.01A WHEN EM_VAR_CURRENT_OVER_65A)
1861 _supla_int_t
1862 power_active[3]; // * 0.00001W (0.01kW WHEN EM_VAR_POWER_ACTIVE_KW)
1863 _supla_int_t power_reactive[3]; // * 0.00001var (0.01kvar WHEN
1864 // EM_VAR_POWER_REACTIVE_KVAR)
1865 _supla_int_t power_apparent[3]; // * 0.00001VA (0.01kVA WHEN
1866 // EM_VAR_POWER_APPARENT_KVA)
1867 _supla_int16_t power_factor[3]; // * 0.001
1868 _supla_int16_t phase_angle[3]; // * 0.1 degree
1869} TElectricityMeter_Measurement; // v. >= 10
1870
1871#define EM_VAR_FREQ 0x0001
1872#define EM_VAR_VOLTAGE 0x0002
1873#define EM_VAR_CURRENT 0x0004
1874#define EM_VAR_POWER_ACTIVE 0x0008
1875#define EM_VAR_POWER_REACTIVE 0x0010
1876#define EM_VAR_POWER_APPARENT 0x0020
1877#define EM_VAR_POWER_FACTOR 0x0040
1878#define EM_VAR_PHASE_ANGLE 0x0080
1879#define EM_VAR_FORWARD_ACTIVE_ENERGY 0x0100
1880#define EM_VAR_REVERSE_ACTIVE_ENERGY 0x0200
1881#define EM_VAR_FORWARD_REACTIVE_ENERGY 0x0400
1882#define EM_VAR_REVERSE_REACTIVE_ENERGY 0x0800
1883#define EM_VAR_CURRENT_OVER_65A 0x1000
1884#define EM_VAR_FORWARD_ACTIVE_ENERGY_BALANCED 0x2000
1885#define EM_VAR_REVERSE_ACTIVE_ENERGY_BALANCED 0x4000
1886
1887#define EM_VAR_VOLTAGE_PHASE_ANGLE_12 0x10000 // ver. >= 25
1888#define EM_VAR_VOLTAGE_PHASE_ANGLE_13 0x20000 // ver. >= 25
1889#define EM_VAR_VOLTAGE_PHASE_SEQUENCE 0x40000 // ver. >= 25
1890#define EM_VAR_CURRENT_PHASE_SEQUENCE 0x80000 // ver. >= 25
1891
1892#define EM_VAR_POWER_ACTIVE_KW 0x100000
1893#define EM_VAR_POWER_REACTIVE_KVAR 0x200000
1894#define EM_VAR_POWER_APPARENT_KVA 0x400000
1895
1896#define EM_PHASE_SEQUENCE_VOLTAGE 0x01
1897#define EM_PHASE_SEQUENCE_CURRENT 0x02
1898
1899#if defined(__AVR__) || defined(ESP8266) || defined(ESP32) || \
1900 defined(ESP_PLATFORM) || defined(ARDUINO) || defined(SUPLA_DEVICE)
1901#define EM_MEASUREMENT_COUNT 1
1902#else
1903#define EM_MEASUREMENT_COUNT 5
1904#endif
1905
1906#ifdef USE_DEPRECATED_EMEV_V1
1907// [IODevice->Server->Client]
1908typedef struct {
1909 unsigned _supla_int64_t total_forward_active_energy[3]; // * 0.00001 kWh
1910 unsigned _supla_int64_t total_reverse_active_energy[3]; // * 0.00001 kWh
1911 unsigned _supla_int64_t total_forward_reactive_energy[3]; // * 0.00001 kvarh
1912 unsigned _supla_int64_t total_reverse_reactive_energy[3]; // * 0.00001 kvarh
1913
1914 // The price per unit, total cost and currency is overwritten by the server
1915 // total_cost == SUM(total_forward_active_energy[n] * price_per_unit
1916 _supla_int_t total_cost; // * 0.01
1917 _supla_int_t price_per_unit; // * 0.0001
1918 // Currency Code A https://www.nationsonline.org/oneworld/currencies.htm
1919 char currency[3];
1920
1921 _supla_int_t measured_values;
1922 _supla_int_t period; // Approximate period between measurements in seconds
1923 _supla_int_t m_count;
1924 TElectricityMeter_Measurement m[EM_MEASUREMENT_COUNT]; // Last variable in
1925 // struct!
1926} TElectricityMeter_ExtendedValue; // v. >= 10
1927#endif /*USE_DEPRECATED_EMEV_V1*/
1928
1929#ifdef USE_DEPRECATED_EMEV_V2
1930// [IODevice->Server->Client]
1931typedef struct {
1932 unsigned _supla_int64_t total_forward_active_energy[3]; // * 0.00001 kWh
1933 unsigned _supla_int64_t total_reverse_active_energy[3]; // * 0.00001 kWh
1934 unsigned _supla_int64_t total_forward_reactive_energy[3]; // * 0.00001 kvarh
1935 unsigned _supla_int64_t total_reverse_reactive_energy[3]; // * 0.00001 kvarh
1936 unsigned _supla_int64_t
1937 total_forward_active_energy_balanced; // * 0.00001 kWh
1938 // Vector phase-to-phase balancing
1939 unsigned _supla_int64_t
1940 total_reverse_active_energy_balanced; // * 0.00001 kWh
1941 // Vector phase-to-phase balancing
1942
1943 // The price per unit, total cost and currency is overwritten by the server
1944 // total_cost == SUM(total_forward_active_energy[n] * price_per_unit
1945 _supla_int_t total_cost; // * 0.01
1946 _supla_int_t total_cost_balanced; // * 0.01
1947 _supla_int_t price_per_unit; // * 0.0001
1948 // Currency Code A https://www.nationsonline.org/oneworld/currencies.htm
1949 char currency[3];
1950
1951 _supla_int_t measured_values;
1952 _supla_int_t period; // Approximate period between measurements in seconds
1953 _supla_int_t m_count;
1954 TElectricityMeter_Measurement m[EM_MEASUREMENT_COUNT]; // Last variable in
1955 // struct!
1956} TElectricityMeter_ExtendedValue_V2; // v. >= 12
1957#endif /*USE_DEPRECATED_EMEV_V2*/
1958
1959// [IODevice->Server->Client]
1960typedef struct {
1961 unsigned _supla_int64_t total_forward_active_energy[3]; // * 0.00001 kWh
1962 unsigned _supla_int64_t total_reverse_active_energy[3]; // * 0.00001 kWh
1963 unsigned _supla_int64_t total_forward_reactive_energy[3]; // * 0.00001 kvarh
1964 unsigned _supla_int64_t total_reverse_reactive_energy[3]; // * 0.00001 kvarh
1965 unsigned _supla_int64_t
1966 total_forward_active_energy_balanced; // * 0.00001 kWh
1967 // Vector phase-to-phase balancing
1968 unsigned _supla_int64_t
1969 total_reverse_active_energy_balanced; // * 0.00001 kWh
1970 // Vector phase-to-phase balancing
1971
1972 // Voltage phase angle between phase 1 and 2
1973 unsigned _supla_int16_t voltage_phase_angle_12; // * 0.1 degree, 0..360
1974 // Voltage phase angle between phase 1 and 3
1975 unsigned _supla_int16_t voltage_phase_angle_13; // * 0.1 degree, 0..360
1976 unsigned char phase_sequence; // bit 0x1 - voltage, bit 0x2 current
1977 // EM_PHASE_SEQUENCE_*
1978 // bit value: 0 - 123 (clockwise)
1979 // bit value: 1 - 132 (counter-clockwise)
1980
1981 // The price per unit, total cost and currency is overwritten by the server
1982 // total_cost == SUM(total_forward_active_energy[n] * price_per_unit
1983 _supla_int_t total_cost; // * 0.01
1984 _supla_int_t total_cost_balanced; // * 0.01
1985 _supla_int_t price_per_unit; // * 0.0001
1986 // Currency Code A https://www.nationsonline.org/oneworld/currencies.htm
1987 char currency[3];
1988
1989 _supla_int_t measured_values;
1990 _supla_int_t period; // Approximate period between measurements in seconds
1991 _supla_int_t m_count;
1992 TElectricityMeter_Measurement m[EM_MEASUREMENT_COUNT]; // Last variable in
1993 // struct!
1995
1996#define EM_VALUE_FLAG_PHASE1_ON 0x01
1997#define EM_VALUE_FLAG_PHASE2_ON 0x02
1998#define EM_VALUE_FLAG_PHASE3_ON 0x04
1999
2000// [IODevice->Server->Client]
2001typedef struct {
2002 char flags;
2003 unsigned _supla_int_t total_forward_active_energy; // * 0.01 kW
2004} TElectricityMeter_Value; // v. >= 10
2005
2006typedef struct {
2007 // The price per unit, total cost and currency is overwritten by the server
2008 // total_cost = calculated_value * price_per_unit
2009 _supla_int_t total_cost; // * 0.01
2010 _supla_int_t price_per_unit; // * 0.0001
2011 // Currency Code A https://www.nationsonline.org/oneworld/currencies.htm
2012 char currency[3];
2013 char custom_unit[9]; // UTF8 including the terminating null byte ('\0')
2014
2015 _supla_int_t impulses_per_unit;
2016 unsigned _supla_int64_t counter;
2017 _supla_int64_t calculated_value; // * 0.001
2019
2020typedef struct {
2021 unsigned _supla_int64_t counter;
2023
2024#define RS_VALUE_FLAG_TILT_IS_SET 0x1
2025#define RS_VALUE_FLAG_CALIBRATION_FAILED 0x2
2026#define RS_VALUE_FLAG_CALIBRATION_LOST 0x4
2027#define RS_VALUE_FLAG_MOTOR_PROBLEM 0x8
2028#define RS_VALUE_FLAG_CALIBRATION_IN_PROGRESS 0x10
2029
2030#define SUPLA_TILT_CONTROL_TYPE_UNKNOWN 0
2031#define SUPLA_TILT_CONTROL_TYPE_STANDS_IN_POSITION_WHILE_TILTING 1
2032#define SUPLA_TILT_CONTROL_TYPE_CHANGES_POSITION_WHILE_TILTING 2
2033#define SUPLA_TILT_CONTROL_TYPE_TILTS_ONLY_WHEN_FULLY_CLOSED 3
2034
2035// Roller shutter channel value payload
2036// Device -> Server -> Client
2037typedef struct {
2038 signed char position; // -1 == calibration. -1, 0% (open) - 100% (closed) DSC
2039 char reserved1;
2040 signed char bottom_position; // Percentage points to the windowsill, SC
2041 _supla_int16_t flags; // DSC
2042 char reserved2;
2043 char reserved3;
2044 char reserved4;
2046
2047typedef TDSC_RollerShutterValue TDSC_TerraceAwningValue;
2048typedef TDSC_RollerShutterValue TDSC_ProjectorScreen;
2049typedef TDSC_RollerShutterValue TDSC_CurtainValue;
2050typedef TDSC_RollerShutterValue TDSC_RollerGarageDoor;
2051
2052// Roller shutter channel value payload
2053// Client -> Server -> Device
2054typedef struct {
2055 signed char position; // 0 - STOP
2056 // 1 - DOWN (CLOSE)
2057 // 2 - UP (OPEN)
2058 // 3 - DOWN_OR_STOP (CLOSE_OR_STOP)
2059 // 4 - UP_OR_STOP (OPEN_OR_STOP)
2060 // 5 - STEP_BY_STEP
2061 // 10-110 - target position + 10 (0 open, 100 closed)
2062 char reserved[7];
2064
2065typedef TCSD_RollerShutterValue TCSD_TerraceAwningValue;
2066typedef TCSD_RollerShutterValue TCSD_ProjectorScreen;
2067typedef TCSD_RollerShutterValue TCSD_CurtainValue;
2068typedef TCSD_RollerShutterValue TCSD_RollerGarageDoor;
2069
2070// Facade blind channel value payload
2071// Device -> Server -> Client
2072typedef struct {
2073 signed char position; // -1 == calibration. -1, 0% (open) - 100% (closed) DSC
2074 signed char tilt; // -1 == not used/calibration, -1, 0% - 100%, DSC
2075 char reserved;
2076 _supla_int16_t flags; // DSC
2077 char reserved2[3];
2079
2080typedef TDSC_FacadeBlindValue TDSC_VerticalBlindValue;
2081
2082// Facade blind channel value payload
2083// Client -> Server -> Device
2084typedef struct {
2085 signed char position; // -1 - not set (actual behavior is device specific)
2086 // 0 - STOP
2087 // 1 - DOWN (CLOSE)
2088 // 2 - UP (OPEN)
2089 // 3 - DOWN_OR_STOP (CLOSE_OR_STOP)
2090 // 4 - UP_OR_STOP (OPEN_OR_STOP)
2091 // 5 - STEP_BY_STEP
2092 // 10-110 - target position + 10 (0 open, 100 closed)
2093 signed char tilt; // -1 - not set (actual behavior is device specific)
2094 // 10-110 - target position + 10
2095 char reserved[6];
2097
2098typedef TCSD_FacadeBlindValue TCSD_VerticalBlindValue;
2099
2100typedef struct {
2101 unsigned _supla_int64_t calculated_value; // * 0.001
2102} TSC_ImpulseCounter_Value; // v. >= 10
2103
2104typedef struct {
2105 char Email[SUPLA_EMAIL_MAXSIZE]; // UTF8
2106 char Password[SUPLA_PASSWORD_MAXSIZE]; // UTF8
2108
2109typedef struct {
2110 _supla_int_t Result;
2112
2113#define SUPLA_CALCFG_RESULT_FALSE 0 // ver. >= 12
2114#define SUPLA_CALCFG_RESULT_TRUE 1 // ver. >= 12
2115#define SUPLA_CALCFG_RESULT_DONE 2 // ver. >= 12
2116#define SUPLA_CALCFG_RESULT_IN_PROGRESS 3 // ver. >= 12
2117#define SUPLA_CALCFG_RESULT_NODE_FOUND 4 // ver. >= 12
2118#define SUPLA_CALCFG_RESULT_SENDER_CONFLICT 100 // ver. >= 12
2119#define SUPLA_CALCFG_RESULT_TIMEOUT 101 // ver. >= 12
2120#define SUPLA_CALCFG_RESULT_NOT_SUPPORTED 102 // ver. >= 12
2121#define SUPLA_CALCFG_RESULT_ID_NOT_EXISTS 103 // ver. >= 12
2122#define SUPLA_CALCFG_RESULT_UNAUTHORIZED 104 // ver. >= 12
2123#define SUPLA_CALCFG_RESULT_DEBUG 105 // ver. >= 12
2124#define SUPLA_CALCFG_RESULT_NOT_SUPPORTED_IN_SLAVE_MODE 106 // ver. >= 12
2125
2126#define SUPLA_CALCFG_CMD_GET_CHANNEL_FUNCLIST 1000 // v. >= 11
2127#define SUPLA_CALCFG_CMD_CANCEL_ALL_CLIENT_COMMANDS 1010 // v. >= 12
2128#define SUPLA_CALCFG_CMD_ZWAVE_RESET_AND_CLEAR 2000 // v. >= 12
2129#define SUPLA_CALCFG_CMD_ZWAVE_ADD_NODE 2010 // v. >= 12
2130#define SUPLA_CALCFG_CMD_ZWAVE_REMOVE_NODE 2020 // v. >= 12
2131#define SUPLA_CALCFG_CMD_ZWAVE_GET_NODE_LIST 2030 // v. >= 12
2132#define SUPLA_CALCFG_CMD_ZWAVE_GET_ASSIGNED_NODE_ID 2040 // v. >= 12
2133#define SUPLA_CALCFG_CMD_ZWAVE_ASSIGN_NODE_ID 2050 // v. >= 12
2134#define SUPLA_CALCFG_CMD_ZWAVE_GET_WAKE_UP_SETTINGS 2060 // v. >= 12
2135#define SUPLA_CALCFG_CMD_ZWAVE_SET_WAKE_UP_TIME 2070 // v. >= 12
2136#define SUPLA_CALCFG_CMD_ZWAVE_CONFIG_MODE_ACTIVE 4000 // v. >= 12
2137#define SUPLA_CALCFG_CMD_DEBUG_STRING 5000 // v. >= 12
2138#define SUPLA_CALCFG_CMD_PROGRESS_REPORT 5001 // v. >= 12
2139#define SUPLA_CALCFG_CMD_SET_LIGHTSOURCE_LIFESPAN 6000 // v. >= 12
2140#define SUPLA_CALCFG_CMD_RESET_COUNTERS 7000 // v. >= 15
2141#define SUPLA_CALCFG_CMD_RECALIBRATE 8000 // v. >= 15
2142#define SUPLA_CALCFG_CMD_ENTER_CFG_MODE 9000 // v. >= 17
2143#define SUPLA_CALCFG_CMD_RESET_TO_FACTORY_SETTINGS 9010 // v. >= 28
2144#define SUPLA_CALCFG_CMD_CHECK_FIRMWARE_UPDATE 9020 // v. >= 28
2145#define SUPLA_CALCFG_CMD_START_FIRMWARE_UPDATE 9030 // v. >= 28
2146#define SUPLA_CALCFG_CMD_START_SECURITY_UPDATE 9040 // v. >= 28
2147#define SUPLA_CALCFG_CMD_SET_TIME 9100 // v. >= 21
2148#define SUPLA_CALCFG_CMD_START_SUBDEVICE_PAIRING 9200 // v. >= 25
2149#define SUPLA_CALCFG_CMD_IDENTIFY_DEVICE 9300 // v. >= 25
2150#define SUPLA_CALCFG_CMD_IDENTIFY_SUBDEVICE 9310 // v. >= 25
2151#define SUPLA_CALCFG_CMD_RESTART_DEVICE 9400 // v. >= 25
2152#define SUPLA_CALCFG_CMD_RESTART_SUBDEVICE 9410 // v. >= 25
2153#define SUPLA_CALCFG_CMD_TAKE_OCR_PHOTO 9420 // v. >= 25
2154#define SUPLA_CALCFG_CMD_MUTE_ALARM_SOUND 9430 // v. >= 26
2155
2156#define SUPLA_CALCFG_DATATYPE_RS_SETTINGS 1000
2157#define SUPLA_CALCFG_DATATYPE_FB_SETTINGS 1100 // v. >= 17
2158
2159#define CALCFG_ZWAVE_SCREENTYPE_UNKNOWN 0
2160#define CALCFG_ZWAVE_SCREENTYPE_MULTILEVEL 1
2161#define CALCFG_ZWAVE_SCREENTYPE_BINARY 2
2162#define CALCFG_ZWAVE_SCREENTYPE_MULTILEVEL_AUTOSHADE 3
2163#define CALCFG_ZWAVE_SCREENTYPE_MULTILEVEL_COLOR_CONTROL 4
2164#define CALCFG_ZWAVE_SCREENTYPE_BINARY_COLOR_CONTROL 5
2165#define CALCFG_ZWAVE_SCREENTYPE_SENSOR 6
2166
2167#define ZWAVE_NODE_NAME_MAXSIZE 50
2168
2169#define ZWAVE_NODE_FLAG_CHANNEL_ASSIGNED 0x1
2170#define ZWAVE_NODE_FLAG_WAKEUP_TIME_SETTABLE 0x2
2171
2172typedef struct {
2173 unsigned char Id;
2174 unsigned char Flags;
2175 union {
2176 unsigned char ChannelNumber;
2177 _supla_int_t ChannelID;
2178 };
2179 unsigned char ScreenType;
2180 unsigned char NameSize; // including the terminating null byte ('\0')
2181 char Name[ZWAVE_NODE_NAME_MAXSIZE]; // UTF8. Last variable in struct!
2182} TCalCfg_ZWave_Node; // v. >= 12
2183
2184typedef struct {
2185 unsigned _supla_int_t MinimumSec : 24;
2186 unsigned _supla_int_t MaximumSec : 24;
2187 unsigned _supla_int_t ValueSec : 24;
2188 unsigned _supla_int_t IntervalStepSec : 24;
2190
2191typedef struct {
2192 unsigned _supla_int_t TimeSec : 24;
2194
2195typedef struct {
2196 _supla_int_t Command;
2197 unsigned char Progress; // 0 - 100%
2199
2200typedef struct {
2201 unsigned char ResetCounter; // 0 - NO, 1 - YES
2202 unsigned char SetTime; // 0 - NO, 1 - YES
2203 unsigned _supla_int16_t LightSourceLifespan; // 0 - 65535 hours
2205
2206#define SUPLA_CALCFG_SUBDEVICE_NAME_MAXSIZE 120
2207
2208// Subdevice Pairing result is send in TDS_DeviceCalCfgResult. Possible values:
2209// SUPLA_CALCFG_RESULT_TRUE - paring result/status is in Data
2210// SUPLA_CALCFG_RESULT_UNAUTHORIZED - unauthorized
2211// SUPLA_CALCFG_RESULT_NOT_SUPPORTED - not supported
2212// Only in case of TRUE, TCalCfg_SubdevicePairingResult is included in
2213// TDS_DeviceCalCfgResult.
2214#define SUPLA_CALCFG_PAIRINGRESULT_PROCEDURE_STARTED 0
2215#define SUPLA_CALCFG_PAIRINGRESULT_ONGOING 1
2216#define SUPLA_CALCFG_PAIRINGRESULT_NO_NEW_DEVICE_FOUND 2
2217#define SUPLA_CALCFG_PAIRINGRESULT_SUCCESS 3
2218#define SUPLA_CALCFG_PAIRINGRESULT_DEVICE_NOT_SUPPORTED 4
2219#define SUPLA_CALCFG_PAIRINGRESULT_RESOURCES_LIMIT_EXCEEDED 5
2220#define SUPLA_CALCFG_PAIRINGRESULT_NOT_STARTED_NOT_READY 6
2221#define SUPLA_CALCFG_PAIRINGRESULT_NOT_STARTED_BUSY 7
2222
2223typedef struct {
2224 unsigned _supla_int16_t
2225 ElapsedTimeSec; // Time in seconds since procedure was started
2226 unsigned _supla_int16_t MaximumDurationSec; // Time in seconds
2227 unsigned char PairingResult; // SUPLA_CALCFG_PAIRINGRESULT_
2228 unsigned char NameSize; // including the terminating null byte ('\0')
2229 char Name[SUPLA_CALCFG_SUBDEVICE_NAME_MAXSIZE]; // UTF8. Last variable in
2230 // struct!
2231} TCalCfg_SubdevicePairingResult; // v. >= 25
2232
2233// CALCFG == CALIBRATION / CONFIG
2234typedef struct {
2235 _supla_int_t ChannelID;
2236 _supla_int_t Command;
2237 _supla_int_t DataType;
2238 unsigned _supla_int_t DataSize;
2239 char Data[SUPLA_CALCFG_DATA_MAXSIZE]; // Last variable in struct!
2240} TCS_DeviceCalCfgRequest; // v. >= 10
2241
2242// CALCFG == CALIBRATION / CONFIG
2243typedef struct {
2244 _supla_int_t Id;
2245 char Target; // SUPLA_TARGET_
2246 _supla_int_t Command;
2247 _supla_int_t DataType;
2248 unsigned _supla_int_t DataSize;
2249 char Data[SUPLA_CALCFG_DATA_MAXSIZE]; // Last variable in struct!
2250} TCS_DeviceCalCfgRequest_B; // v. >= 11
2251
2252typedef struct {
2253 _supla_int_t ChannelID;
2254 _supla_int_t Command;
2255 _supla_int_t Result;
2256 unsigned _supla_int_t DataSize;
2257 char Data[SUPLA_CALCFG_DATA_MAXSIZE]; // Last variable in struct!
2258} TSC_DeviceCalCfgResult; // v. >= 10
2259
2260typedef struct {
2261 _supla_int_t SenderID;
2262 _supla_int_t ChannelNumber;
2263 _supla_int_t Command;
2264 char SuperUserAuthorized;
2265 _supla_int_t DataType;
2266 unsigned _supla_int_t DataSize;
2267 char Data[SUPLA_CALCFG_DATA_MAXSIZE]; // Last variable in struct!
2268} TSD_DeviceCalCfgRequest; // v. >= 10
2269
2270typedef struct {
2271 _supla_int_t ReceiverID;
2272 _supla_int_t ChannelNumber;
2273 _supla_int_t Command;
2274 _supla_int_t Result;
2275 unsigned _supla_int_t DataSize;
2276 char Data[SUPLA_CALCFG_DATA_MAXSIZE]; // Last variable in struct!
2277} TDS_DeviceCalCfgResult; // v. >= 10
2278
2279// Used in CALCFG recalibrate command
2280typedef struct {
2281 _supla_int_t FullOpeningTimeMS;
2282 _supla_int_t FullClosingTimeMS;
2284
2285#define SUPLA_FIRMWARE_CHECK_RESULT_UPDATE_NOT_AVAILABLE 0
2286#define SUPLA_FIRMWARE_CHECK_RESULT_UPDATE_AVAILABLE 1
2287#define SUPLA_FIRMWARE_CHECK_RESULT_ERROR 2
2288
2289typedef struct {
2290 unsigned char Result; // SUPLA_FIRMWARE_CHECK_RESULT_
2291 char SoftVer[SUPLA_SOFTVER_MAXSIZE];
2292} TCalCfg_FirmwareCheckResult; // v. >= 28
2293
2294
2295#define RGBW_BRIGHTNESS_ONOFF 0x1
2296#define RGBW_COLOR_ONOFF 0x2
2297
2298// Values from other fields are applied in a standard way
2299#define RGBW_COMMAND_NOT_SET 0
2300// Ignores all other bytes and turns on the dimmer
2301#define RGBW_COMMAND_TURN_ON_DIMMER 1
2302// Ignores all other bytes and turns off the dimmer
2303#define RGBW_COMMAND_TURN_OFF_DIMMER 2
2304// Ignores all other bytes and toggles the dimmer
2305#define RGBW_COMMAND_TOGGLE_DIMMER 3
2306// Ignores all other bytes and turns on the RGB
2307#define RGBW_COMMAND_TURN_ON_RGB 4
2308// Ignores all other bytes and turns off the RGB
2309#define RGBW_COMMAND_TURN_OFF_RGB 5
2310// Ignores all other bytes and toggles the RGB
2311#define RGBW_COMMAND_TOGGLE_RGB 6
2312// Ignores all other bytes and turns on the RGB and Dimmer
2313#define RGBW_COMMAND_TURN_ON_ALL 7
2314// Ignores all other bytes and turns off the RGB and Dimmer
2315#define RGBW_COMMAND_TURN_OFF_ALL 8
2316// Ignores all other bytes and toggles the RGB and Dimmer (with sync, so both
2317// will be off or both will be on)
2318#define RGBW_COMMAND_TOGGLE_ALL 9
2319// Stores brightness value and ignores all other bytes, if dimmer is off, it
2320// stays off
2321#define RGBW_COMMAND_SET_BRIGHTNESS_WITHOUT_TURN_ON 10
2322// Stores colorBrightness value and ignores all other bytes.
2323// If RGB is off, it stays off
2324#define RGBW_COMMAND_SET_COLOR_BRIGHTNESS_WITHOUT_TURN_ON 11
2325// Stores color value (R, G, B) and ignores all other bytes.
2326// If RGB is off, it stays off
2327#define RGBW_COMMAND_SET_RGB_WITHOUT_TURN_ON 12
2328// Start brightness dimmer iteration
2329#define RGBW_COMMAND_START_ITERATE_DIMMER 13
2330// Start color brightness iteration
2331#define RGBW_COMMAND_START_ITERATE_RGB 14
2332// Start dimmer and rgb brightness iteration
2333#define RGBW_COMMAND_START_ITERATE_ALL 15
2334// Stop brightness dimmer iteration
2335#define RGBW_COMMAND_STOP_ITERATE_DIMMER 16
2336// Stop color brightness iteration
2337#define RGBW_COMMAND_STOP_ITERATE_RGB 17
2338// Stop dimmer and rgb brightness iteration
2339#define RGBW_COMMAND_STOP_ITERATE_ALL 18
2340
2341typedef struct {
2342 char brightness;
2343 char colorBrightness;
2344 char B;
2345 char G;
2346 char R;
2347 char onOff;
2348 char command; // RGBW_COMMAND_, requires
2349 // SUPLA_CHANNEL_FLAG_RGBW_COMMANDS_SUPPORTED v. >= 21
2350} TRGBW_Value; // v. >= 10
2351
2352#define SUPLA_RELAY_FLAG_OVERCURRENT_RELAY_OFF 0x1
2353
2354typedef struct {
2355 char hi; // actual state of relay - 0 turned off, >= 1 - turned on
2356 unsigned _supla_int16_t flags; // SUPLA_RELAY_FLAG_*
2357} TRelayChannel_Value; // v. >= 15
2358
2359#define DIGIGLASS_TOO_LONG_OPERATION_WARNING 0x1
2360#define DIGIGLASS_PLANNED_REGENERATION_IN_PROGRESS 0x2
2361#define DIGIGLASS_REGENERATION_AFTER_20H_IN_PROGRESS 0x4
2362
2363typedef struct {
2364 unsigned char flags;
2365 unsigned char sectionCount; // 1 - 16 Filled by server
2366 unsigned _supla_int16_t mask; // bit mask. 0 - opaque, 1 - transparent
2367} TDigiglass_Value; // v. >= 14
2368
2369typedef struct {
2370 unsigned _supla_int16_t mask; // Bit mask. 0 - opaque, 1 - transparent
2371 unsigned _supla_int16_t
2372 active_bits; // Specifies which bits of the mask are not skipped
2373} TCSD_Digiglass_NewValue; // v. >= 14
2374
2375#define CONTAINER_FLAG_WARNING_LEVEL (1 << 0)
2376#define CONTAINER_FLAG_ALARM_LEVEL (1 << 1)
2377#define CONTAINER_FLAG_INVALID_SENSOR_STATE (1 << 2)
2378#define CONTAINER_FLAG_SOUND_ALARM_ON (1 << 3)
2379
2380typedef struct {
2381 unsigned char level; // 0 - unknown; 1-101 - container fill level 0-100%
2382 unsigned _supla_int16_t flags; // CONTAINER_FLAG_*
2383} TContainerChannel_Value; // v. >= 26
2384
2385typedef struct {
2386 unsigned char sec; // 0-59
2387 unsigned char min; // 0-59
2388 unsigned char hour; // 0-24
2389 unsigned char dayOfWeek; // 1 = Sunday, 2 = Monday, …, 7 = Saturday
2390} TThermostat_Time; // v. >= 11
2391
2392#define THERMOSTAT_SCHEDULE_DAY_SUNDAY 0x01
2393#define THERMOSTAT_SCHEDULE_DAY_MONDAY 0x02
2394#define THERMOSTAT_SCHEDULE_DAY_TUESDAY 0x04
2395#define THERMOSTAT_SCHEDULE_DAY_WEDNESDAY 0x08
2396#define THERMOSTAT_SCHEDULE_DAY_THURSDAY 0x10
2397#define THERMOSTAT_SCHEDULE_DAY_FRIDAY 0x20
2398#define THERMOSTAT_SCHEDULE_DAY_SATURDAY 0x40
2399#define THERMOSTAT_SCHEDULE_DAY_ALL 0xFF
2400
2401#define THERMOSTAT_SCHEDULE_HOURVALUE_TYPE_TEMPERATURE 0
2402#define THERMOSTAT_SCHEDULE_HOURVALUE_TYPE_PROGRAM 1
2403
2404typedef struct {
2405 unsigned char ValueType; // THERMOSTAT_SCHEDULE_HOURVALUE_TYPE_
2406 char HourValue[7][24]; // 7 days x 24h
2407 // 0 = Sunday, 1 = Monday, …, 6 = Saturday
2408} TThermostat_Schedule; // v. >= 11
2409
2410typedef struct {
2411 unsigned char ValueType; // THERMOSTAT_SCHEDULE_HOURVALUE_TYPE_
2412 unsigned char WeekDays; // THERMOSTAT_SCHEDULE_DAY_
2413 char HourValue[24];
2414} TThermostatValueGroup; // v. >= 11
2415
2416// Used in Heatpol thermostat
2417typedef struct {
2418 TThermostatValueGroup Group[4];
2419} TThermostat_ScheduleCfg; // v. >= 11
2420
2421// Temperature definitions for Heatpol thermostat
2422// TThermostatTemperatureCfg
2423#define TEMPERATURE_INDEX1 0x0001
2424#define TEMPERATURE_INDEX2 0x0002
2425#define TEMPERATURE_INDEX3 0x0004
2426#define TEMPERATURE_INDEX4 0x0008
2427#define TEMPERATURE_INDEX5 0x0010
2428#define TEMPERATURE_INDEX6 0x0020
2429#define TEMPERATURE_INDEX7 0x0040
2430#define TEMPERATURE_INDEX8 0x0080
2431#define TEMPERATURE_INDEX9 0x0100
2432#define TEMPERATURE_INDEX10 0x0200
2433// TThermostatTemperatureCfg has only 10 fields
2434
2435// Used in Heatpol thermostat
2436typedef struct {
2437 _supla_int16_t Index; // BIT0 Temperature[0], BIT1 Temperature[1] etc...
2438 unsigned _supla_int16_t Temperature[10];
2440
2441// Temperature definitions for HVAC
2442// THVACTemperatureCfg
2443// Below values are settable by user in UI
2444// Temperature below which heating will be enabled as a freeze protection
2445#define TEMPERATURE_FREEZE_PROTECTION (1ULL << 0)
2446// Economic temperaturey
2447#define TEMPERATURE_ECO (1ULL << 1)
2448// Comfort temperature
2449#define TEMPERATURE_COMFORT (1ULL << 2)
2450#define TEMPERATURE_BOOST (1ULL << 3)
2451// Temperature above which cooling will be enabled as an overheating protection.
2452#define TEMPERATURE_HEAT_PROTECTION (1ULL << 4)
2453// Histeresis value - i.e. heating will be enabled when current temperature
2454// is histeresis/2 lower than current setpoint.
2455#define TEMPERATURE_HISTERESIS (1ULL << 5)
2456// AUX histeresis value - used to determine heating based on AUX temperature
2457// If aux histeresis is missing, then TEMPERATURE_HISTERESIS is used
2458#define TEMPERATURE_AUX_HISTERESIS (1ULL << 18)
2459// Turns on "alarm" when temperature is below this value. Can be visual effect
2460// or sound (if device is capable). It can also send AT to server (TBD)
2461#define TEMPERATURE_BELOW_ALARM (1ULL << 6)
2462// As above, but for tempertatures above threshold
2463#define TEMPERATURE_ABOVE_ALARM (1ULL << 7)
2464// Minimum temperature to be kept on heat/cold source (i.e. keeps floor always
2465// at least 19 degrees)
2466#define TEMPERATURE_AUX_MIN_SETPOINT (1ULL << 8)
2467// Maximum temperature to be kept on heat/cold source (i.e. protect floor
2468// from overheating and keep at most 28 degrees)
2469#define TEMPERATURE_AUX_MAX_SETPOINT (1ULL << 9)
2470
2471// Below values are readonly for user
2472// Minimum room (main thermometer) temperature to be set by user
2473#define TEMPERATURE_ROOM_MIN (1ULL << 10)
2474// Maximum room (main thermometer) temperature to be set by user
2475#define TEMPERATURE_ROOM_MAX (1ULL << 11)
2476// Minimum allowed temperature for heat/cold source (used with second
2477// thermomter for floor/water/etc.)
2478#define TEMPERATURE_AUX_MIN (1ULL << 12)
2479// Maximum allowed temperature for heat/cold source
2480#define TEMPERATURE_AUX_MAX (1ULL << 13)
2481// Minimum histereis value
2482#define TEMPERATURE_HISTERESIS_MIN (1ULL << 14)
2483// Maximum histereis value
2484#define TEMPERATURE_HISTERESIS_MAX (1ULL << 15)
2485// Minimum temperature offset in HEAT_COOL mode
2486#define TEMPERATURE_HEAT_COOL_OFFSET_MIN (1ULL << 16)
2487// Maximum temperature offset in HEAT_COOL mode
2488#define TEMPERATURE_HEAT_COOL_OFFSET_MAX (1ULL << 17)
2489// 5 values left for future use (value << 18 is defined earlier)
2490
2491#define SUPLA_TEMPERATURE_INVALID_INT16 -32768
2492
2493// Used in Supla Thermostat
2494typedef struct {
2495 unsigned _supla_int_t Index; // BIT0 Temperature[0], BIT1 Temperature[1]
2496 // etc...
2497 _supla_int16_t Temperature[24];
2499
2500// Heatpol: Thermostat configuration commands - ver. >= 11
2501#define SUPLA_THERMOSTAT_CMD_TURNON 1
2502#define SUPLA_THERMOSTAT_CMD_SET_MODE_AUTO 2
2503#define SUPLA_THERMOSTAT_CMD_SET_MODE_COOL 3
2504#define SUPLA_THERMOSTAT_CMD_SET_MODE_HEAT 4
2505#define SUPLA_THERMOSTAT_CMD_SET_MODE_NORMAL 5
2506#define SUPLA_THERMOSTAT_CMD_SET_MODE_ECO 6
2507#define SUPLA_THERMOSTAT_CMD_SET_MODE_TURBO 7
2508#define SUPLA_THERMOSTAT_CMD_SET_MODE_DRY 8
2509#define SUPLA_THERMOSTAT_CMD_SET_MODE_FANONLY 9
2510#define SUPLA_THERMOSTAT_CMD_SET_MODE_PURIFIER 10
2511#define SUPLA_THERMOSTAT_CMD_SET_SCHEDULE 11
2512#define SUPLA_THERMOSTAT_CMD_SET_TIME 12
2513#define SUPLA_THERMOSTAT_CMD_SET_TEMPERATURE 13
2514
2515// Heatpol: Thermostat value flags - ver. >= 11
2516#define SUPLA_THERMOSTAT_VALUE_FLAG_ON 0x0001
2517#define SUPLA_THERMOSTAT_VALUE_FLAG_AUTO_MODE 0x0002
2518#define SUPLA_THERMOSTAT_VALUE_FLAG_COOL_MODE 0x0004
2519#define SUPLA_THERMOSTAT_VALUE_FLAG_HEAT_MODE 0x0008
2520#define SUPLA_THERMOSTAT_VALUE_FLAG_ECO_MODE 0x0010
2521#define SUPLA_THERMOSTAT_VALUE_FLAG_DRY_MODE 0x0020
2522#define SUPLA_THERMOSTAT_VALUE_FLAG_FANONLY_MODE 0x0040
2523#define SUPLA_THERMOSTAT_VALUE_FLAG_PURIFIER_MODE 0x0080
2524
2525// Heatpol: Thermostat fields - ver. >= 11
2526#define THERMOSTAT_FIELD_MeasuredTemperatures 0x01
2527#define THERMOSTAT_FIELD_PresetTemperatures 0x02
2528#define THERMOSTAT_FIELD_Flags 0x04
2529#define THERMOSTAT_FIELD_Values 0x08
2530#define THERMOSTAT_FIELD_Time 0x10
2531#define THERMOSTAT_FIELD_Schedule 0x20
2532
2533// Used in Heatpol only
2534typedef struct {
2535 unsigned char Fields;
2536 _supla_int16_t MeasuredTemperature[10]; // * 0.01
2537 _supla_int16_t PresetTemperature[10]; // * 0.01
2538 _supla_int16_t Flags[8];
2539 _supla_int16_t Values[8];
2540 TThermostat_Time Time;
2541 TThermostat_Schedule Schedule; // 7 days x 24h (4bit/hour)
2542} TThermostat_ExtendedValue; // v. >= 11
2543
2544// Used in Heatpol only
2545typedef struct {
2546 unsigned char IsOn;
2547 unsigned char Flags;
2548 _supla_int16_t MeasuredTemperature; // * 0.01
2549 _supla_int16_t PresetTemperature; // * 0.01
2550} TThermostat_Value; // v. >= 11
2551
2552typedef struct {
2553 unsigned _supla_int16_t year;
2554 unsigned char month;
2555 unsigned char day;
2556 unsigned char dayOfWeek; // 1 = Sunday, 2 = Monday, …, 7 = Saturday
2557 unsigned char hour;
2558 unsigned char min;
2559 unsigned char sec;
2560 unsigned _supla_int_t
2561 timezoneSize; // including the terminating null byte ('\0')
2562 char timezone[SUPLA_TIMEZONE_MAXSIZE]; // Last variable in struct!
2564
2565typedef struct {
2566 _supla_int_t SenderID;
2567 union {
2568 _supla_int_t ChannelID; // Client -> Server
2569 unsigned char ChannelNumber; // Server -> Device
2570 };
2571} TCSD_ChannelStateRequest; // v. >= 12 Client -> Server -> Device
2572
2573#define SUPLA_CHANNELSTATE_FIELD_IPV4 0x0001
2574#define SUPLA_CHANNELSTATE_FIELD_MAC 0x0002
2575#define SUPLA_CHANNELSTATE_FIELD_BATTERYLEVEL 0x0004
2576#define SUPLA_CHANNELSTATE_FIELD_BATTERYPOWERED 0x0008
2577#define SUPLA_CHANNELSTATE_FIELD_WIFIRSSI 0x0010
2578#define SUPLA_CHANNELSTATE_FIELD_WIFISIGNALSTRENGTH 0x0020
2579#define SUPLA_CHANNELSTATE_FIELD_BRIDGENODESIGNALSTRENGTH 0x0040
2580#define SUPLA_CHANNELSTATE_FIELD_UPTIME 0x0080
2581#define SUPLA_CHANNELSTATE_FIELD_CONNECTIONUPTIME 0x0100
2582#define SUPLA_CHANNELSTATE_FIELD_BATTERYHEALTH 0x0200
2583#define SUPLA_CHANNELSTATE_FIELD_BRIDGENODEONLINE 0x0400
2584#define SUPLA_CHANNELSTATE_FIELD_LASTCONNECTIONRESETCAUSE 0x0800
2585// LIGHTSOURCELIFESPAN, LIGHTSOURCEOPERATINGTIME, and OPERATINGTIME are
2586// mutually exclusive. Use only one of them.
2587#define SUPLA_CHANNELSTATE_FIELD_LIGHTSOURCELIFESPAN 0x1000
2588#define SUPLA_CHANNELSTATE_FIELD_LIGHTSOURCEOPERATINGTIME 0x2000
2589#define SUPLA_CHANNELSTATE_FIELD_OPERATINGTIME 0x4000
2590// SWITCHCYCLECOUNT and defualtIconField are is mutually exclusive. Use only one
2591// of them.
2592#define SUPLA_CHANNELSTATE_FIELD_SWITCHCYCLECOUNT 0x8000
2593
2594#define SUPLA_LASTCONNECTIONRESETCAUSE_UNKNOWN 0
2595#define SUPLA_LASTCONNECTIONRESETCAUSE_ACTIVITY_TIMEOUT 1
2596#define SUPLA_LASTCONNECTIONRESETCAUSE_WIFI_CONNECTION_LOST 2
2597#define SUPLA_LASTCONNECTIONRESETCAUSE_SERVER_CONNECTION_LOST 3
2598
2599typedef struct {
2600 _supla_int_t ReceiverID; // Not used in extended values
2601 union {
2602 // Not used in extended values
2603 _supla_int_t ChannelID; // Server -> Client
2604 unsigned char ChannelNumber; // Device -> Server
2605 };
2606 _supla_int_t Fields; // SUPLA_CHANNELSTATE_FIELD_*
2607 union {
2608 _supla_int_t defaultIconField;
2609 unsigned _supla_int_t SwitchCycleCount;
2610 };
2611 unsigned _supla_int_t IPv4;
2612 unsigned char MAC[6];
2613 unsigned char BatteryLevel; // 0 - 100%
2614 unsigned char BatteryPowered; // true(1)/false(0)
2615 char WiFiRSSI;
2616 unsigned char WiFiSignalStrength; // 0 - 100%
2617 unsigned char BridgeNodeOnline; // 0/1
2618 unsigned char BridgeNodeSignalStrength; // 0 - 100%
2619 unsigned _supla_int_t Uptime; // sec.
2620 unsigned _supla_int_t ConnectionUptime; // sec.
2621 unsigned char BatteryHealth;
2622 unsigned char LastConnectionResetCause; // SUPLA_LASTCONNECTIONRESETCAUSE_*
2623 unsigned _supla_int16_t LightSourceLifespan; // 0 - 65535 hours
2624 union {
2625 _supla_int16_t LightSourceLifespanLeft; // -327,67 - 100.00%
2626 // LightSourceLifespan * 0.01
2627 _supla_int_t LightSourceOperatingTime; // -3932100sec. - 3932100sec.
2628 unsigned _supla_int_t OperatingTime; // time in seconds
2629 };
2630 char EOL; // End Of List // v. >= 26
2631 char EmptySpace[1]; // Empty space for future use
2632} TDSC_ChannelState; // v. >= 12 Device -> Server -> Client
2633
2634#define TChannelState_ExtendedValue TDSC_ChannelState
2635
2636typedef struct {
2637 _supla_int_t ChannelID;
2638} TCS_ChannelBasicCfgRequest; // v. >= 12
2639
2640typedef struct {
2641 union {
2642 // Remaining time to turn off
2643 unsigned _supla_int_t RemainingTimeMs;
2644 unsigned _supla_int_t RemainingTimeS;
2645 unsigned _supla_int_t CountdownEndsAt; // Unix timestamp - Filled by server
2646 };
2647
2648 unsigned char TargetValue[SUPLA_CHANNELVALUE_SIZE];
2649
2650 _supla_int_t SenderID;
2651 unsigned _supla_int_t
2652 SenderNameSize; // including the terminating null byte ('\0')
2653 char SenderName[SUPLA_SENDER_NAME_MAXSIZE]; // Last variable in struct!
2654 // UTF8 | Filled by server
2656
2657typedef struct {
2658 TChannelState_ExtendedValue Channel;
2659 TTimerState_ExtendedValue Timer; // Last variable in struct!
2661
2662typedef struct {
2663 char DeviceName[SUPLA_DEVICE_NAME_MAXSIZE]; // UTF8
2664 char DeviceSoftVer[SUPLA_SOFTVER_MAXSIZE];
2665 _supla_int_t DeviceID;
2666 _supla_int_t DeviceFlags;
2667 _supla_int16_t ManufacturerID;
2668 _supla_int16_t ProductID;
2669
2670 _supla_int_t ID;
2671 unsigned char Number;
2672 _supla_int_t Type;
2673 _supla_int_t Func;
2674 _supla_int_t FuncList;
2675
2676 unsigned _supla_int_t ChannelFlags;
2677 unsigned _supla_int_t
2678 CaptionSize; // including the terminating null byte ('\0')
2679 char Caption[SUPLA_CHANNEL_CAPTION_MAXSIZE]; // Last variable in struct!
2680} TSC_ChannelBasicCfg; // v. >= 12
2681
2682typedef struct {
2683 _supla_int_t ChannelID;
2684 _supla_int_t Func;
2685} TCS_SetChannelFunction; // v. >= 12
2686
2687typedef struct {
2688 _supla_int_t ChannelID;
2689 _supla_int_t Func;
2690 unsigned char ResultCode;
2691} TSC_SetChannelFunctionResult; // v. >= 12
2692
2693typedef struct {
2694 union {
2695 unsigned char ChannelNumber;
2696 _supla_int_t ID;
2697 };
2698
2699 unsigned _supla_int_t
2700 CaptionSize; // including the terminating null byte ('\0')
2701 char Caption[SUPLA_CAPTION_MAXSIZE]; // Last variable in struct!
2702} TDCS_SetCaption; // v. >= 12
2703
2704typedef struct {
2705 union {
2706 unsigned char ChannelNumber;
2707 _supla_int_t ID;
2708 };
2709
2710 unsigned char ResultCode;
2711 unsigned _supla_int_t
2712 CaptionSize; // including the terminating null byte ('\0')
2713 char Caption[SUPLA_CAPTION_MAXSIZE]; // Last variable in struct!
2714} TSCD_SetCaptionResult; // v. >= 12
2715
2716typedef struct {
2717 unsigned char ResultCode;
2719
2720typedef struct {
2721 // Disabled: 0
2722 // Ignore: <0
2723 _supla_int_t IODeviceRegistrationTimeSec;
2724 _supla_int_t ClientRegistrationTimeSec;
2725} TCS_SetRegistrationEnabled; // v. >= 12
2726
2727typedef struct {
2728 unsigned char ResultCode;
2730
2731typedef struct {
2732 _supla_int_t DeviceID;
2733} TCS_DeviceReconnectRequest; // v. >= 12
2734
2735typedef struct {
2736 _supla_int_t DeviceID;
2737 unsigned char ResultCode;
2739
2740typedef struct {
2741 // server -> device
2742
2743 unsigned char ChannelCount;
2744 _supla_int_t Functions[SUPLA_CHANNELMAXCOUNT]; // Last variable in struct!
2745 // Functions[ChannelNumber]
2746} TSD_ChannelFunctions; // ver. >= 12
2747
2748typedef struct {
2749 unsigned char ChannelNumber;
2751
2752typedef struct {
2753 unsigned char ChannelNumber;
2754 _supla_int_t Param1;
2755 _supla_int_t Param2;
2756 _supla_int_t Param3;
2758
2759#define SUPLA_CHANNEL_CONFIG_MAXSIZE 512 // v. <= 19 - 128; v. >= 21 - 512
2760#define SUPLA_DEVICE_CONFIG_MAXSIZE 512
2761
2762// Default type is used for standard channel config (user modifiable)
2763#define SUPLA_CONFIG_TYPE_DEFAULT 0
2764// Weekly schedule
2765#define SUPLA_CONFIG_TYPE_WEEKLY_SCHEDULE 2
2766// For SUPLA_CHANNELFNC_HVAC_THERMOSTAT, ALT weekly schedule is used for
2767// cooling subfuction, while standard weelkly schedule is used for heating
2768#define SUPLA_CONFIG_TYPE_ALT_WEEKLY_SCHEDULE 3
2769#define SUPLA_CONFIG_TYPE_OCR 4
2770#define SUPLA_CONFIG_TYPE_EXTENDED 5
2771
2772/********************************************
2773 * DEVICE CONFIG STRUCTURES
2774 ********************************************/
2775
2776// SUPLA_DS_CALL_SET_DEVICE_CONFIG
2777// SUPLA_SD_CALL_SET_DEVICE_CONFIG
2778// Config field should contain fields stored in order as they appear in
2779// Fields parameter. Size of parameter depends on Field type.
2780typedef struct {
2781 unsigned char EndOfDataFlag; // 1 - last message; 0 - more messages will come
2782 unsigned char zero[8]; // for future use
2783 unsigned _supla_int64_t
2784 AvailableFields; // bit map of SUPLA_DEVICE_CONFIG_FIELD_
2785 unsigned _supla_int64_t Fields; // bit map of SUPLA_DEVICE_CONFIG_FIELD_
2786 unsigned _supla_int16_t ConfigSize;
2787 char Config[SUPLA_DEVICE_CONFIG_MAXSIZE]; // Last variable in struct!
2788} TSDS_SetDeviceConfig; // v. >= 21
2789
2790// SUPLA_SD_CALL_SET_DEVICE_CONFIG_RESULT
2791// SUPLA_DS_CALL_SET_DEVICE_CONFIG_RESULT
2792typedef struct {
2793 unsigned char Result; // SUPLA_CONFIG_RESULT_*
2794 unsigned char zero[9]; // for future use
2796
2797typedef struct {
2798 _supla_int_t DeviceId;
2799 unsigned char EndOfDataFlag; // 1 - last message; 0 - more messages will come
2800 unsigned char zero[8]; // for future use
2801 unsigned _supla_int64_t
2802 AvailableFields; // bit map of SUPLA_DEVICE_CONFIG_FIELD_
2803 unsigned _supla_int64_t Fields; // bit map of SUPLA_DEVICE_CONFIG_FIELD_
2804 unsigned _supla_int16_t ConfigSize;
2805 char Config[SUPLA_DEVICE_CONFIG_MAXSIZE]; // Last variable in struct!
2806} TSCS_DeviceConfig; // v. >= 21
2807
2808// SUPLA_SC_CALL_DEVICE_CONFIG_UPDATE_OR_RESULT
2809typedef struct {
2810 unsigned char Result; // SUPLA_CONFIG_RESULT_*. It matters when it is a
2811 // response to SUPLA_CS_CALL_GET_DEVICE_CONFIG
2812 TSCS_DeviceConfig Config; // Last variable in struct!
2814
2815// SUPLA_CS_CALL_GET_DEVICE_CONFIG
2816typedef struct {
2817 _supla_int_t DeviceId;
2818 unsigned _supla_int64_t Fields; // bit map of SUPLA_DEVICE_CONFIG_FIELD_
2819 unsigned char zero[8]; // for future use
2821
2822#define SUPLA_DEVCFG_STATUS_LED_ON_WHEN_CONNECTED 0
2823#define SUPLA_DEVCFG_STATUS_LED_OFF_WHEN_CONNECTED 1
2824#define SUPLA_DEVCFG_STATUS_LED_ALWAYS_OFF 2
2825
2826typedef struct {
2827 unsigned char StatusLedType; // SUPLA_DEVCFG_STATUS_LED_
2828} TDeviceConfig_StatusLed; // v. >= 21
2829
2830typedef struct {
2831 unsigned char Disabled; // 1 - true; 0 - false
2832} TDeviceConfig_PowerStatusLed; // v. >= 25
2833
2834typedef struct {
2835 unsigned char ScreenBrightness; // 0-100%
2836 unsigned char Automatic; // 0 - false; 1 - true
2837 signed char AdjustmentForAutomatic;
2838} TDeviceConfig_ScreenBrightness; // v. >= 21
2839
2840typedef struct {
2841 unsigned char Volume; // 0-100%
2842} TDeviceConfig_ButtonVolume; // v. >= 21
2843
2844typedef struct {
2845 unsigned char DisableUserInterface; // 0 - false (local UI enabled)
2846 // 1 - true (local UI disabled)
2847 // 2 - partial
2848 // min/max allowed parameters are mandatory for "partial" variant
2849 unsigned _supla_int16_t minAllowedTemperatureSetpointFromLocalUI;
2850 unsigned _supla_int16_t maxAllowedTemperatureSetpointFromLocalUI;
2852
2853typedef struct {
2854 unsigned char AutomaticTimeSync; // 0 - disabled
2855 // 1 - enabled
2857
2858typedef struct {
2859 unsigned _supla_int16_t HomeScreenOffDelayS; // delay in seconds
2860 // 0 - disabled
2862
2863#define SUPLA_DEVCFG_HOME_SCREEN_OFF_DELAY_TYPE_ALWAYS_ENABLED 0
2864#define SUPLA_DEVCFG_HOME_SCREEN_OFF_DELAY_TYPE_ENABLED_WHEN_DARK 1
2865typedef struct {
2866 unsigned char
2867 HomeScreenOffDelayType; // SUPLA_DEVCFG_HOME_SCREEN_OFF_DELAY_TYPE_
2869
2870#define SUPLA_DEVCFG_HOME_SCREEN_CONTENT_NONE (1ULL << 0)
2871#define SUPLA_DEVCFG_HOME_SCREEN_CONTENT_TEMPERATURE (1ULL << 1)
2872#define SUPLA_DEVCFG_HOME_SCREEN_CONTENT_TEMPERATURE_AND_HUMIDITY (1ULL << 2)
2873#define SUPLA_DEVCFG_HOME_SCREEN_CONTENT_TIME (1ULL << 3)
2874#define SUPLA_DEVCFG_HOME_SCREEN_CONTENT_TIME_DATE (1ULL << 4)
2875#define SUPLA_DEVCFG_HOME_SCREEN_CONTENT_TEMPERATURE_TIME (1ULL << 5)
2876#define SUPLA_DEVCFG_HOME_SCREEN_CONTENT_MAIN_AND_AUX_TEMPERATURE (1ULL << 6)
2877#define SUPLA_DEVCFG_HOME_SCREEN_CONTENT_MODE_OR_TEMPERATURE (1ULL << 7)
2878
2879typedef struct {
2880 // bit field with all available modes (reported by device, readonly for other
2881 // components)
2882 unsigned _supla_int64_t ContentAvailable;
2883 // configured mode (settable)
2884 unsigned _supla_int64_t
2885 HomeScreenContent; // SUPLA_DEVCFG_HOME_SCREEN_CONTENT_
2887
2888// type: TDeviceConfig_Modbus
2889#define MODBUS_SERIAL_MODE_DISABLED 0
2890#define MODBUS_SERIAL_MODE_RTU 1
2891#define MODBUS_SERIAL_MODE_ASCII 2
2892
2893#define MODBUS_SERIAL_STOP_BITS_ONE 0
2894#define MODBUS_SERIAL_STOP_BITS_ONE_AND_HALF 1
2895#define MODBUS_SERIAL_STOP_BITS_TWO 2
2896
2897typedef struct {
2898 unsigned char Mode; // MODBUS_SERIAL_MODE_*
2899 _supla_int_t Baudrate; // 19200 (default and mandatory by modbus)
2900 unsigned char StopBits; // MODBUS_SERIAL_STOP_BITS_*
2901 unsigned char Reserved[20];
2903
2904#define MODBUS_NETWORK_MODE_DISABLED 0
2905#define MODBUS_NETWORK_MODE_TCP 1
2906#define MODBUS_NETWORK_MODE_UDP 2
2907
2908typedef struct {
2909 unsigned char Mode; // MODBUS_NETWORK_MODE_*
2910 unsigned int Port; // Default: 502
2911 unsigned char Reserved[20];
2913
2914// Readonly Modbus properties, which tells which functions/modes are
2915// available
2916typedef struct {
2917 struct {
2918 unsigned char Master : 1;
2919 unsigned char Slave : 1;
2920 unsigned char Rtu : 1;
2921 unsigned char Ascii : 1;
2922 unsigned char Tcp : 1;
2923 unsigned char Udp : 1;
2924 unsigned char Reserved : 2;
2925 unsigned char Reserved2 : 8;
2926 } Protocol;
2927 struct {
2928 unsigned char B4800 : 1;
2929 unsigned char B9600 : 1; // modbus mandatory
2930 unsigned char B19200 : 1; // modbus mandatory
2931 unsigned char B38400 : 1;
2932 unsigned char B57600 : 1;
2933 unsigned char B115200 : 1;
2934 unsigned char Reserved : 2;
2935 unsigned char Reserved2 : 8;
2936 } Baudrate;
2937 struct {
2938 unsigned char One : 1;
2939 unsigned char OneAndHalf : 1;
2940 unsigned char Two : 1;
2941 unsigned char Reserved : 5;
2942 } StopBits;
2943 unsigned char Reserved[20];
2945
2946#define MODBUS_ROLE_NOT_SET 0
2947#define MODBUS_ROLE_MASTER 1
2948#define MODBUS_ROLE_SLAVE 2
2949
2950typedef struct {
2951 unsigned char Role; // MODBUS_ROLE_*
2952 unsigned char ModbusAddress; // only for slave
2953 unsigned _supla_int_t SlaveTimeoutMs; // only for master
2954 ModbusSerialConfig SerialConfig;
2955 ModbusNetworkConfig NetworkConfig;
2956 ModbusConfigProperties Properties;
2957 unsigned char Reserved[20];
2959
2960// type: TDeviceConfig_FirmwareUpdate
2961// Forced off - firmware update is disabled by user on device (via local web
2962// interface) and can't be changed remotely
2963// Disabled - firmware update is disabled by user and can be changed remotely
2964// Security only - firmware update is enabled only for security updates
2965// All enabled - firmware update is enabled for all updates
2966#define SUPLA_FIRMWARE_UPDATE_MODE_FORCED_OFF 0
2967#define SUPLA_FIRMWARE_UPDATE_MODE_DISABLED 1
2968#define SUPLA_FIRMWARE_UPDATE_MODE_SECURITY_ONLY 2 // default
2969#define SUPLA_FIRMWARE_UPDATE_MODE_ALL_ENABLED 3
2970
2971typedef struct {
2972 unsigned char Mode; // SUPLA_FIRMWARE_UPDATE_MODE_
2973 unsigned char Reserved[20];
2975
2976/********************************************
2977 * CHANNEL CONFIG STRUCTURES
2978 ********************************************/
2979
2980#define SUPLA_CONFIG_RESULT_FALSE 0
2981#define SUPLA_CONFIG_RESULT_TRUE 1
2982#define SUPLA_CONFIG_RESULT_DATA_ERROR 2
2983#define SUPLA_CONFIG_RESULT_TYPE_NOT_SUPPORTED 3
2984#define SUPLA_CONFIG_RESULT_FUNCTION_NOT_SUPPORTED 4
2985#define SUPLA_CONFIG_RESULT_LOCAL_CONFIG_DISABLED 5
2986#define SUPLA_CONFIG_RESULT_NOT_ALLOWED 6
2987#define SUPLA_CONFIG_RESULT_DEVICE_NOT_FOUND 7
2988
2989// SUPLA_CS_CALL_GET_CHANNEL_CONFIG
2990typedef struct {
2991 _supla_int_t ChannelId;
2992 unsigned char ConfigType; // SUPLA_CONFIG_TYPE_
2993 unsigned _supla_int_t Flags;
2994} TCS_GetChannelConfigRequest; // v. >= 21
2995
2996// SUPLA_CS_CALL_SET_CHANNEL_CONFIG
2997typedef struct {
2998 _supla_int_t ChannelId;
2999 _supla_int_t Func;
3000 unsigned char ConfigType; // SUPLA_CONFIG_TYPE_
3001 unsigned _supla_int16_t ConfigSize;
3002 char Config[SUPLA_CHANNEL_CONFIG_MAXSIZE]; // Last variable in struct!
3003 // v. >= 21
3004 // TChannelConfig_*
3006
3007// SUPLA_SC_CALL_CHANNEL_CONFIG_UPDATE
3008typedef struct {
3009 unsigned char Result; // SUPLA_CONFIG_RESULT_*. It matters when it is a
3010 // response to SUPLA_CS_CALL_GET_CHANNEL_CONFIG or
3011 // SUPLA_CS_CALL_SET_CHANNEL_CONFIG
3012 TSCS_ChannelConfig Config; // Last variable in struct!
3014
3015// SUPLA_DS_CALL_GET_CHANNEL_CONFIG
3016typedef struct {
3017 unsigned char ChannelNumber;
3018 unsigned char ConfigType; // SUPLA_CONFIG_TYPE_
3019 unsigned _supla_int_t Flags;
3020} TDS_GetChannelConfigRequest; // v. >= 16
3021
3022// SUPLA_SD_CALL_GET_CHANNEL_CONFIG_RESULT
3023// SUPLA_DS_CALL_SET_CHANNEL_CONFIG
3024// SUPLA_SD_CALL_SET_CHANNEL_CONFIG
3025typedef struct {
3026 unsigned char ChannelNumber;
3027 _supla_int_t Func;
3028 unsigned char ConfigType; // SUPLA_CONFIG_TYPE_
3029 unsigned _supla_int16_t ConfigSize;
3030 char Config[SUPLA_CHANNEL_CONFIG_MAXSIZE]; // Last variable in struct!
3031 // v. >= 16
3032 // TChannelConfig_*
3034
3035// SUPLA_DS_CALL_SET_CHANNEL_CONFIG
3036// SUPLA_SD_CALL_SET_CHANNEL_CONFIG
3037typedef TSD_ChannelConfig TSDS_SetChannelConfig; // v. >= 21
3038
3039// SUPLA_SD_CALL_SET_CHANNEL_CONFIG_RESULT
3040// SUPLA_DS_CALL_SET_CHANNEL_CONFIG_RESULT
3041typedef struct {
3042 unsigned char Result; // SUPLA_CONFIG_RESULT_*
3043 unsigned char ConfigType; // SUPLA_CONFIG_TYPE_
3044 unsigned char ChannelNumber;
3046
3047// SUPLA_SD_CALL_CHANNEL_CONFIG_FINISHED
3048typedef struct {
3049 unsigned char ChannelNumber;
3051
3052typedef struct {
3053 _supla_int_t TimeMS;
3054} TChannelConfig_StaircaseTimer; // v. >= 16
3055
3056typedef struct {
3057 _supla_int_t ClosingTimeMS;
3058 _supla_int_t OpeningTimeMS;
3059 unsigned char MotorUpsideDown; // 0 - not set/not used, 1 - false, 2 - true
3060 unsigned char ButtonsUpsideDown; // 0 - not set/not used, 1 - false, 2 - true
3061 signed char TimeMargin; // -1 default (device specific), 0 - not set/not used
3062 // 1 - no margin,
3063 // > 1 - 51% of opening/closing time added on extreme
3064 // positions - value should be decremented by 1.
3065 unsigned char VisualizationType; // 0 - default, other values depends on
3066 // Cloud and App support
3067 unsigned char Reserved[32];
3068} TChannelConfig_RollerShutter; // v. >= 16
3069
3070typedef TChannelConfig_RollerShutter TChannelConfig_TerraceAwning;
3071typedef TChannelConfig_RollerShutter TChannelConfig_ProjectorScreen;
3072typedef TChannelConfig_RollerShutter TChannelConfig_Curtain;
3073typedef TChannelConfig_RollerShutter TChannelConfig_RollerGarageDoor;
3074
3075typedef struct {
3076 _supla_int_t ClosingTimeMS;
3077 _supla_int_t OpeningTimeMS;
3078 _supla_int_t TiltingTimeMS;
3079 unsigned char MotorUpsideDown; // 0 - not set/not used, 1 - false, 2 - true
3080 unsigned char ButtonsUpsideDown; // 0 - not set/not used, 1 - false, 2 - true
3081 signed char TimeMargin; // -1 default (device specific), 0 - not set/not used
3082 // 1 - no margin,
3083 // > 1 - 51% of opening/closing time added on extreme
3084 // positions - value should be decremented by 1.
3085 unsigned _supla_int16_t
3086 Tilt0Angle; // 0 - 180 - degree corresponding to tilt 0
3087 unsigned _supla_int16_t
3088 Tilt100Angle; // 0 - 180 - degree corresponding to tilt 100
3089 unsigned char TiltControlType; // SUPLA_TILT_CONTROL_TYPE_
3090 unsigned char VisualizationType; // 0 - default, other values depends on
3091 // Cloud and App support
3092 unsigned char Reserved[32];
3093} TChannelConfig_FacadeBlind; // v. >= 24
3094
3095typedef TChannelConfig_FacadeBlind TChannelConfig_VerticalBlind;
3096
3097typedef struct {
3098 unsigned _supla_int_t ActiveActions;
3099} TChannelConfig_ActionTrigger; // v. >= 16
3100
3101// Weekly schedule definition for HVAC channel
3102typedef struct {
3103 unsigned char Mode; // for HVAC: SUPLA_HVAC_MODE_
3104 union {
3105 _supla_int16_t SetpointTemperatureHeat; // * 0.01 - used for heating
3106 _supla_int16_t Value1;
3107 };
3108 union {
3109 _supla_int16_t SetpointTemperatureCool; // * 0.01 - used for cooling
3110 _supla_int16_t Value2;
3111 };
3113
3114#define SUPLA_WEEKLY_SCHEDULE_PROGRAMS_MAX_SIZE 4
3115#define SUPLA_WEEKLY_SCHEDULE_VALUES_SIZE (7 * 24 * 4)
3116
3117typedef struct {
3118 // 4*5 = 20 B
3119 TWeeklyScheduleProgram Program[SUPLA_WEEKLY_SCHEDULE_PROGRAMS_MAX_SIZE];
3120 // "Quarters" contain Program setting for each 15 min. One 15 min program is
3121 // set on 4 bits, so in one byte we have settings for two 2x 15 min. 0 - off
3122 // 1 - program 1
3123 // 2 - program 2
3124 // 3 - program 3
3125 // 4 - program 4
3126 // (Quarter[0] & 0x0F) is Sunday, 0:00 to 0:14
3127 // (Quarter[0] & 0xF0) >> 4 is Sunday, 0:15 to 0:29
3128 // Days of week are numbered: 0 - Sunday, 1 - Monday, etc.
3129 unsigned char Quarters[SUPLA_WEEKLY_SCHEDULE_VALUES_SIZE / 2]; // 336 B
3130} TChannelConfig_WeeklySchedule; // v. >= 21
3131
3132// Config used for thermometers, humidity sensors, and thermometers with
3133// humidity channels.
3134// Correction is always applied by io device. Parameter
3135// AdjustmentAppliedByDevice is added in order to handle older versions where
3136// correction was applied by server. Devices supporting this setting will
3137// retreive config from server and if AdjustmentAppliedByDevice is set to 0,
3138// then they will store new correction value, set AdjustmentAppliedByDevice to 1
3139// and send it to server, so server will no longer apply correction.
3140typedef struct {
3141 _supla_int16_t TemperatureAdjustment; // * 0.01
3142 _supla_int16_t HumidityAdjustment; // * 0.01
3143 unsigned char AdjustmentAppliedByDevice; // 1/true - by device
3144 // 0/false - by server
3145 // Min/Max allowed adjustment values that channel supports. If set to 0, then
3146 // field is not supported by device and Cloud should use default -10..10 range
3147 // for correction. Otherwise, Cloud should use these values.
3148 _supla_int16_t MinTemperatureAdjustment; // * 0.01
3149 _supla_int16_t MaxTemperatureAdjustment; // * 0.01
3150 _supla_int16_t MinHumidityAdjustment; // * 0.01
3151 _supla_int16_t MaxHumidityAdjustment; // * 0.01
3152 unsigned char Reserved[27 - 4 * sizeof(_supla_int16_t)];
3154
3155// ChannelConfig for all binary sensors (all functions valid for
3156// SUPLA_CHANNELTYPE_BINARYSENSOR)
3157// Device doesn't apply this inverted logic on communication towards server.
3158// It is used only for interanal purposes and for other external interfaces
3159// like MQTT
3160// FilteringTimeMs is used to configure how long device should wait for stable
3161// input signal before changing it's state. If value is set to 0, then field
3162// is not used by device and server should ignore it. Device may impose minimum
3163// and maximum values for this field.
3164typedef struct {
3165 unsigned char InvertedLogic; // 0 - not inverted, 1 - inverted
3166 unsigned _supla_int16_t FilteringTimeMs; // 0 - not used, > 0 - time in ms
3167 unsigned char Reserved[29];
3168} TChannelConfig_BinarySensor; // v. >= 21
3169
3170// Not set is set when there is no thermometer for "AUX" available
3171// at all.
3172// Disabled is set when thermometer is available (i.e. we can read it and show
3173// to user), but it is not used by thermostat for any other purpose
3174// Other values are mainly for UI adjustement (i.e. show temperature as floor,
3175// as water, generic heater or cooler device)
3176#define SUPLA_HVAC_AUX_THERMOMETER_TYPE_NOT_SET 0
3177#define SUPLA_HVAC_AUX_THERMOMETER_TYPE_DISABLED 1
3178#define SUPLA_HVAC_AUX_THERMOMETER_TYPE_FLOOR 2
3179#define SUPLA_HVAC_AUX_THERMOMETER_TYPE_WATER 3
3180#define SUPLA_HVAC_AUX_THERMOMETER_TYPE_GENERIC_HEATER 4
3181#define SUPLA_HVAC_AUX_THERMOMETER_TYPE_GENERIC_COOLER 5
3182
3183#define SUPLA_HVAC_ALGORITHM_NOT_SET 0
3184#define SUPLA_HVAC_ALGORITHM_ON_OFF_SETPOINT_MIDDLE (1ULL << 0)
3185#define SUPLA_HVAC_ALGORITHM_ON_OFF_SETPOINT_AT_MOST (1ULL << 1)
3186#define SUPLA_HVAC_ALGORITHM_PID (1ULL << 2)
3187
3188// HVAC channel validation rules for thermometers:
3189// - MainThermometerChannelNo must be set
3190// - AuxThermometerChannelNo is validated and used only when
3191// AuxThermometerType != SUPLA_HVAC_AUX_THERMOMETER_TYPE_NOT_SET
3192// - AuxThermometerChannelNo != MainThermometerChannelNo
3193// - AuxThermometerChannelNo must be set for
3194// SUPLA_CHANNELFNC_HVAC_THERMOSTAT_DIFFERENTIAL. For other functions it is
3195// optional.
3196// - MainThermometerChannelNo and AuxThermometerChannelNo have to be
3197// SUPLA_CHANNELTYPE_HUMIDITYANDTEMPSENSOR or SUPLA_CHANNELTYPE_THERMOMETER
3198// - When AuxThermometerType == SUPLA_HVAC_AUX_THERMOMETER_TYPE_NOT_SET,
3199// AuxThermometerChannelNo is ignored, it can be set to 0.
3200
3201// HVAC channel validation for AntiFreezeAndOverheatProtectionEnabled:
3202// - function is available for channel functions: HEAT, COOL, HEAT_COOL
3203// - for other channel functions, this parameter is ignored
3204// - AntiFreeze/Overheat protection always use MainThermometerChannelNo as
3205// temperature source
3206
3207// HVAC channel validation for Algorithms:
3208// - AvailableAlgorithms is set only by device
3209// - UsedAlgorithm == 0 may be reported by device for incorrectly configured
3210// thermostat (i.e. there AvailableAlgorithms == 0), this shouldn't happen
3211// for devices with proper SW.
3212// - UsedAlgorithm & AvailableAlgorithms should evaluate to true
3213// - UsedAlgorithm should contain only one bit set
3214
3215// MinOnTimeS and MinOffTimeS:
3216// - function is always available
3217// - time is given in seconds
3218// - allowed range: 0 - 600 sec
3219
3220// OutputValueOnError:
3221// - function is always available
3222// - allowed values: -100 .. 100
3223// - it is recommended to use only -100 (cool), 0 (off), 100 (heat).
3224// - info: this range comes from assumption that cooling and heating may
3225// be enabled with gradients (i.e. for some thermostat with PWM output), but
3226// majority of thermostats are on/off, so only -100 (cool), 0 (off), and 100
3227// (heat) are proposed here.
3228
3229// Temperature validation rules:
3230// - Temperature in "Room Constrain" means:
3231// TEMPERATURE_ROOM_MIN <= t <= TEMPERATURE_ROOM_MAX
3232// - Temperature in "Aux Constrain" means:
3233// TEMPERATURE_AUX_MIN <= t <= TEMPERATURE_AUX_MAX
3234// - Temperatures (t_min, t_max) in "Auto Constrain" means:
3235// TEMPERATURE_ROOM_MIN <= t_min <= TEMPERATURE_ROOM_MAX AND
3236// TEMPERATURE_ROOM_MIN <= t_max <= TEMPERATURE_ROOM_MAX AND
3237// (t_max - t_min >= TEMPERATURE_HEAT_COOL_OFFSET_MIN) AND
3238// (t_max - t_min <= TEMPERATURE_HEAT_COOL_OFFSET_MAX)
3239
3240// TEMPERATURE_FREEZE_PROTECTION - has to be in Room Constrain when
3241// AntiFreezeAndOverheatProtectionEnabled is set
3242// TEMPERATURE_ECO - has to be in Room Constrain
3243// TEMPERATURE_COMFORT - has to be in Room Constrain
3244// TEMPERATURE_BOOST - has to be in Room Constrain
3245// TEMPERATURE_HEAT_PROTECTION - has to be in Room Constrain when function
3246// is COOL or HEAT_COOL
3247// TEMPERATURE_HISTERESIS and TEMPERATURE_AUX_HISTERESIS - has to be
3248// TEMPERATURE_HISTERESIS_MIN <= t <= TEMPERATURE_HISTERESIS_MAX
3249// TEMPERATURE_BELOW_ALARM - has to be in Room Constrain
3250// TEMPERATURE_ABOVE_ALARM - has to be in Room Constrain
3251// TEMPERATURE_AUX_MIN_SETPOINT - has to be in Aux Constrain and has
3252// to be < TEMPERATURE_AUX_MAX_SETPOINT
3253// TEMPERATURE_AUX_MAX_SETPOINT - has to be in Aux Constrain and has
3254// to be > TEMPERATURE_AUX_MIN_SETPOINT
3255
3256// Below values are readonly and defines device capabilities for current
3257// function:
3258// TEMPERATURE_ROOM_MIN < TEMPERATURE_ROOM_MAX
3259// TEMPERATURE_AUX_MIN < TEMPERATURE_AUX_MAX
3260// TEMPERATURE_HISTERESIS_MIN < TEMPERATURE_HISTERESIS_MAX
3261// TEMPERATURE_HEAT_COOL_OFFSET_MIN < TEMPERATURE_HEAT_COOL_OFFSET_MAX
3262
3263// Subfunction for SUPLA_CHANNELFNC_HVAC_THERMOSTAT
3264// Other channel functions dont' use subfunction setting (yet)
3265#define SUPLA_HVAC_SUBFUNCTION_NOT_SET 0
3266#define SUPLA_HVAC_SUBFUNCTION_HEAT 1
3267#define SUPLA_HVAC_SUBFUNCTION_COOL 2
3268
3269#define SUPLA_HVAC_TEMPERATURE_CONTROL_TYPE_NOT_SUPPORTED 0
3270#define SUPLA_HVAC_TEMPERATURE_CONTROL_TYPE_ROOM_TEMPERATURE 1
3271#define SUPLA_HVAC_TEMPERATURE_CONTROL_TYPE_AUX_HEATER_COOLER_TEMPERATURE 2
3272
3273#define LOCAL_UI_LOCK_FULL 0x1
3274#define LOCAL_UI_LOCK_TEMPERATURE 0x2
3275
3276typedef struct {
3277 unsigned _supla_int_t MainThermometerChannelNoReadonly : 1;
3278 unsigned _supla_int_t MainThermometerChannelNoHidden : 1;
3279 unsigned _supla_int_t AuxThermometerChannelNoReadonly : 1;
3280 unsigned _supla_int_t AuxThermometerChannelNoHidden : 1;
3281 unsigned _supla_int_t BinarySensorChannelNoReadonly : 1;
3282 unsigned _supla_int_t BinarySensorChannelNoHidden : 1;
3283 unsigned _supla_int_t AuxThermometerTypeReadonly : 1;
3284 unsigned _supla_int_t AuxThermometerTypeHidden : 1;
3285 unsigned _supla_int_t AntiFreezeAndOverheatProtectionEnabledReadonly : 1;
3286 unsigned _supla_int_t AntiFreezeAndOverheatProtectionEnabledHidden : 1;
3287 unsigned _supla_int_t UsedAlgorithmReadonly : 1;
3288 unsigned _supla_int_t UsedAlgorithmHidden : 1;
3289 unsigned _supla_int_t MinOnTimeSReadonly : 1;
3290 unsigned _supla_int_t MinOnTimeSHidden : 1;
3291 unsigned _supla_int_t MinOffTimeSReadonly : 1;
3292 unsigned _supla_int_t MinOffTimeSHidden : 1;
3293 unsigned _supla_int_t OutputValueOnErrorReadonly : 1;
3294 unsigned _supla_int_t OutputValueOnErrorHidden : 1;
3295 unsigned _supla_int_t SubfunctionReadonly : 1;
3296 unsigned _supla_int_t SubfunctionHidden : 1;
3297 unsigned _supla_int_t
3298 TemperatureSetpointChangeSwitchesToManualModeReadonly : 1;
3299 unsigned _supla_int_t TemperatureSetpointChangeSwitchesToManualModeHidden : 1;
3300 unsigned _supla_int_t AuxMinMaxSetpointEnabledReadonly : 1;
3301 unsigned _supla_int_t AuxMinMaxSetpointEnabledHidden : 1;
3302 unsigned _supla_int_t UseSeparateHeatCoolOutputsReadonly : 1;
3303 unsigned _supla_int_t UseSeparateHeatCoolOutputsHidden : 1;
3304 unsigned _supla_int_t TemperaturesFreezeProtectionReadonly : 1;
3305 unsigned _supla_int_t TemperaturesFreezeProtectionHidden : 1;
3306 unsigned _supla_int_t TemperaturesEcoReadonly : 1;
3307 unsigned _supla_int_t TemperaturesEcoHidden : 1;
3308 unsigned _supla_int_t TemperaturesComfortReadonly : 1;
3309 unsigned _supla_int_t TemperaturesComfortHidden : 1;
3310 unsigned _supla_int_t TemperaturesBoostReadonly : 1;
3311 unsigned _supla_int_t TemperaturesBoostHidden : 1;
3312 unsigned _supla_int_t TemperaturesHeatProtectionReadonly : 1;
3313 unsigned _supla_int_t TemperaturesHeatProtectionHidden : 1;
3314 unsigned _supla_int_t TemperaturesHisteresisReadonly : 1;
3315 unsigned _supla_int_t TemperaturesHisteresisHidden : 1;
3316 unsigned _supla_int_t TemperaturesBelowAlarmReadonly : 1;
3317 unsigned _supla_int_t TemperaturesBelowAlarmHidden : 1;
3318 unsigned _supla_int_t TemperaturesAboveAlarmReadonly : 1;
3319 unsigned _supla_int_t TemperaturesAboveAlarmHidden : 1;
3320 unsigned _supla_int_t TemperaturesAuxMinSetpointReadonly : 1;
3321 unsigned _supla_int_t TemperaturesAuxMinSetpointHidden : 1;
3322 unsigned _supla_int_t TemperaturesAuxMaxSetpointReadonly : 1;
3323 unsigned _supla_int_t TemperaturesAuxMaxSetpointHidden : 1;
3324 unsigned _supla_int_t MasterThermostatChannelNoReadonly : 1;
3325 unsigned _supla_int_t MasterThermostatChannelNoHidden : 1;
3326 unsigned _supla_int_t HeatOrColdSourceSwitchReadonly : 1;
3327 unsigned _supla_int_t HeatOrColdSourceSwitchHidden : 1;
3328 unsigned _supla_int_t PumpSwitchReadonly : 1;
3329 unsigned _supla_int_t PumpSwitchHidden : 1;
3330 unsigned _supla_int_t TemperaturesAuxHisteresisReadonly : 1;
3331 unsigned _supla_int_t TemperaturesAuxHisteresisHidden : 1;
3332 unsigned _supla_int_t Reserved : 10;
3334
3335typedef struct {
3336 union {
3337 _supla_int_t MainThermometerChannelId;
3338 // Channel numbers for thermometer config. Channels have to be local and
3339 // numbering is the same as for registration message
3340 unsigned char MainThermometerChannelNo;
3341 };
3342
3343 union {
3344 _supla_int_t AuxThermometerChannelId;
3345 unsigned char
3346 AuxThermometerChannelNo; // If the channel number points to itself, it
3347 // means that the aux thermometer is not set.
3348 };
3349
3350 union {
3351 _supla_int_t BinarySensorChannelId;
3352 unsigned char
3353 BinarySensorChannelNo; // If the channel number points to itself, it
3354 // means that the binary sensor is not set.
3355 };
3356
3357 // SUPLA_HVAC_AUX_THERMOMETER_TYPE_
3358 unsigned char AuxThermometerType;
3359 unsigned char AntiFreezeAndOverheatProtectionEnabled;
3360 // bit map SUPLA_HVAC_ALGORITHM_ (readonly)
3361 unsigned _supla_int16_t AvailableAlgorithms;
3362 // only one value of SUPLA_HVAC_ALGORITHM_
3363 unsigned _supla_int16_t UsedAlgorithm;
3364 // Below Min TimeS parameters defines minimum time of relay/output to be
3365 // be disabled or enabled in seconds. It is used to prevent to frequent relay
3366 // state change.
3367 // Allowed values are 0-600 (10 minutes)
3368 unsigned _supla_int16_t MinOnTimeS; // minimum allowed time for output to
3369 // be enabled
3370 unsigned _supla_int16_t MinOffTimeS; // minimum allowed time for output to
3371 // be disabled
3372 signed char OutputValueOnError; // -100 cool, 0 off (default), 100 heat
3373 unsigned char Subfunction; // SUPLA_HVAC_SUBFUNCTION_
3374 unsigned char TemperatureSetpointChangeSwitchesToManualMode; // 0 - off,
3375 // 1 - on (def)
3376 unsigned char AuxMinMaxSetpointEnabled; // 0 - off (default), 1 - on
3377 // For HEAT_COOL thermostats we have two outpus. They can either use
3378 // shared output for heating/cooling action and second output for heat vs
3379 // cool mode selection, or they can use separate outputs - one for heating
3380 // and one for cooling
3381 unsigned char UseSeparateHeatCoolOutputs; // 0 - off (default), 1 - on
3382 HvacParameterFlags ParameterFlags;
3383
3384 union {
3385 _supla_int_t MasterThermostatChannelId;
3386 struct {
3387 unsigned char MasterThermostatIsSet; // 0 - no; 1 - yes
3388 unsigned char MasterThermostatChannelNo;
3389 }; // v. >= 25
3390 };
3391
3392 union {
3393 _supla_int_t HeatOrColdSourceSwitchChannelId;
3394 struct {
3395 unsigned char HeatOrColdSourceSwitchIsSet; // 0 - no; 1 - yes
3396 unsigned char HeatOrColdSourceSwitchChannelNo;
3397 }; // v. >= 25
3398 };
3399
3400 union {
3401 _supla_int_t PumpSwitchChannelId;
3402 struct {
3403 unsigned char PumpSwitchIsSet; // 0 - no; 1 - yes
3404 unsigned char PumpSwitchChannelNo;
3405 }; // v. >= 25
3406 };
3407
3408 // TemperatureControlType allows to switch between work based on main
3409 // thermometer (room) and aux thermometer (heater/cooler).
3410 // Option is available only for SUPLA_CHANNELFNC_HVAC_THERMOSTAT
3411 // If set to 0, then it is not supported.
3412 unsigned char TemperatureControlType; // SUPLA_HVAC_TEMPERATURE_CONTROL_TYPE_
3413
3414 unsigned char LocalUILockingCapabilities; // LOCAL_UI_LOCK_*
3415 unsigned char LocalUILock; // LOCAL_UI_LOCK_*
3416
3417 // min/max allowed parameters are used only with LocalUILock &
3418 // LOCAL_UI_LOCK_TEMPERATURE
3419 _supla_int16_t MinAllowedTemperatureSetpointFromLocalUI;
3420 _supla_int16_t MaxAllowedTemperatureSetpointFromLocalUI;
3421 unsigned char Reserved[48 - sizeof(HvacParameterFlags) -
3422 sizeof(_supla_int_t) - sizeof(_supla_int_t) -
3423 sizeof(_supla_int_t) - sizeof(unsigned char) -
3424 sizeof(unsigned char) - sizeof(unsigned char) -
3425 sizeof(_supla_int16_t) - sizeof(_supla_int16_t)];
3426 THVACTemperatureCfg Temperatures;
3427} TChannelConfig_HVAC; // v. >= 21
3428
3429#define SUPLA_GENERAL_PURPOSE_MEASUREMENT_CHART_TYPE_LINEAR 0
3430#define SUPLA_GENERAL_PURPOSE_MEASUREMENT_CHART_TYPE_BAR 1
3431#define SUPLA_GENERAL_PURPOSE_MEASUREMENT_CHART_TYPE_CANDLE 2
3432
3433#define SUPLA_GENERAL_PURPOSE_UNIT_SIZE 15
3434
3435// General Purpose Mesurement channel config:
3436// Calculated value is: (value / ValueDivider) * ValueMultiplier + ValueAdded
3437typedef struct {
3438 // Value divider
3439 _supla_int_t ValueDivider; // 0.001 units; 0 is considered as 1
3440 // Value multiplier
3441 _supla_int_t ValueMultiplier; // 0.001 units; 0 is considered as 1
3442 // Value added
3443 _supla_int64_t ValueAdded; // 0.001 units
3444 // Display precicion
3445 unsigned char ValuePrecision; // 0 - 4 decimal points
3446 // Display unit (before value) - UTF8 including the terminating null byte '\0'
3447 char UnitBeforeValue[SUPLA_GENERAL_PURPOSE_UNIT_SIZE];
3448 // Display unit (after value) - UTF8 including the terminating null byte '\0'
3449 char UnitAfterValue[SUPLA_GENERAL_PURPOSE_UNIT_SIZE];
3450 unsigned char
3451 NoSpaceBeforeValue; // 0 - with space (default), 1 - without space
3452 unsigned char
3453 NoSpaceAfterValue; // 0 - with space (default), 1 - without space
3454 // Keep history on server
3455 unsigned char KeepHistory; // 0 - no (default), 1 - yes
3456 // Chart type linear/bar/candle
3457 unsigned char ChartType; // SUPLA_GENERAL_PURPOSE_MEASUREMENT_CHART_TYPE_*
3458 // Channel refresh interval [ms], allowed range 1 .. 65535
3459 // Actual channel implementation may enforce minimum value
3460 // 0 - default - implementation dependent
3461 unsigned _supla_int16_t RefreshIntervalMs;
3462
3463 // Readonly and default parameters
3464 // Default value divider
3465 _supla_int_t DefaultValueDivider; // 0.001 units; 0 is considered as 1
3466 // Default value multiplier
3467 _supla_int_t DefaultValueMultiplier; // 0.001 units; 0 is considered as 1
3468 // Default value added
3469 _supla_int64_t DefaultValueAdded; // 0.001 units
3470 // Default display precicion
3471 unsigned char DefaultValuePrecision; // 0 - 4 decimal points
3472 // Default unit (before value) - UTF8 including the terminating null byte '\0'
3473 char DefaultUnitBeforeValue[SUPLA_GENERAL_PURPOSE_UNIT_SIZE];
3474 // Default unit (after value) - UTF8 including the terminating null byte '\0'
3475 char DefaultUnitAfterValue[SUPLA_GENERAL_PURPOSE_UNIT_SIZE];
3476
3477 unsigned char Reserved[8];
3479
3480#define SUPLA_GENERAL_PURPOSE_METER_COUNTER_TYPE_INCREMENT_DECREMENT 0
3481#define SUPLA_GENERAL_PURPOSE_METER_COUNTER_TYPE_ALWAYS_INCREMENT 1
3482#define SUPLA_GENERAL_PURPOSE_METER_COUNTER_TYPE_ALWAYS_DECREMENT 2
3483
3484#define SUPLA_GENERAL_PURPOSE_METER_CHART_TYPE_BAR 0
3485#define SUPLA_GENERAL_PURPOSE_METER_CHART_TYPE_LINEAR 1
3486
3487// General Purpose Meter channel config:
3488// Calculated value is: (value / ValueDivider) * ValueMultiplier + ValueAdded
3489typedef struct {
3490 // Counter type
3491 unsigned char CounterType; // SUPLA_GENERAL_PURPOSE_METER_COUNTER_TYPE_*
3492
3493 // Value divider
3494 _supla_int_t ValueDivider; // 0.001 units; 0 is considered as 1
3495 // Value multiplier
3496 _supla_int_t ValueMultiplier; // 0.001 units; 0 is considered as 1
3497 // Value added
3498 _supla_int64_t ValueAdded; // 0.001 units
3499 // Display precicion
3500 unsigned char ValuePrecision; // 0 - 4 decimal points
3501 // Display unit (before value) - UTF8 including the terminating null byte '\0'
3502 char UnitBeforeValue[SUPLA_GENERAL_PURPOSE_UNIT_SIZE];
3503 // Display unit (after value) - UTF8 including the terminating null byte '\0'
3504 char UnitAfterValue[SUPLA_GENERAL_PURPOSE_UNIT_SIZE];
3505 unsigned char
3506 NoSpaceBeforeValue; // 0 - with space (default), 1 - without space
3507 unsigned char
3508 NoSpaceAfterValue; // 0 - with space (default), 1 - without space
3509 // Keep history on server
3510 unsigned char KeepHistory; // 0 - no (default), 1 - yes
3511 // Chart type linear/bar/candle
3512 unsigned char ChartType; // SUPLA_GENERAL_PURPOSE_METER_CHART_TYPE_*
3513 // Include value added in history
3514 unsigned char IncludeValueAddedInHistory; // 0 - no (default), 1 - yes
3515 // Fill missing data
3516 unsigned char FillMissingData; // 0 - no (default), 1 - yes
3517 // Channel refresh interval [ms], allowed range 1 .. 65535
3518 // Actual channel implementation may enforce minimum value
3519 // 0 - default - implementation dependent
3520 unsigned _supla_int16_t RefreshIntervalMs;
3521
3522 // Readonly and default parameters
3523 // Default value divider
3524 _supla_int_t DefaultValueDivider; // 0.001 units; 0 is considered as 1
3525 // Default value multiplier
3526 _supla_int_t DefaultValueMultiplier; // 0.001 units; 0 is considered as 1
3527 // Default value added
3528 _supla_int64_t DefaultValueAdded; // 0.001 units
3529 // Default display precicion
3530 unsigned char DefaultValuePrecision; // 0 - 4 decimal points
3531 // Default unit (before value) - UTF8 including the terminating null byte '\0'
3532 char DefaultUnitBeforeValue[SUPLA_GENERAL_PURPOSE_UNIT_SIZE];
3533 // Default unit (after value) - UTF8 including the terminating null byte '\0'
3534 char DefaultUnitAfterValue[SUPLA_GENERAL_PURPOSE_UNIT_SIZE];
3535
3536 unsigned char Reserved[8];
3538
3539#define EM_CT_TYPE_100A_33mA (1ULL << 0)
3540#define EM_CT_TYPE_200A_66mA (1ULL << 1)
3541#define EM_CT_TYPE_400A_133mA (1ULL << 2)
3542
3543#define EM_PHASE_LED_TYPE_OFF (1ULL << 0)
3544#define EM_PHASE_LED_TYPE_VOLTAGE_PRESENCE (1ULL << 1)
3545#define EM_PHASE_LED_TYPE_VOLTAGE_PRESENCE_INVERTED (1ULL << 2)
3546// Voltage level:
3547// - PhaseLedParam1 - "low threshold", units 0.01 V.
3548// When voltage < low threshold -> blue LED
3549// - PhaseLedParam2 - "high threshold", units 0.01 V.
3550// When voltage > high threshold -> red LED
3551// - Voltage between low and high threshold -> green LED
3552#define EM_PHASE_LED_TYPE_VOLTAGE_LEVEL (1ULL << 3)
3553// Active power direction:
3554// - PhaseLedParam1 - "low threshold", units 0.01 W.
3555// When power < low threshold -> green LED.
3556// - PhaseLedParam2 - "high threshold", units 0.01 W.
3557// When power > high threshold -> red LED
3558#define EM_PHASE_LED_TYPE_POWER_ACTIVE_DIRECTION (1ULL << 4)
3559
3560// Electricity meter channel config
3561typedef struct {
3562 // Selected CT type
3563 unsigned _supla_int64_t UsedCTType; // EM_CT_TYPE_
3564 // Selected phase LED type
3565 unsigned _supla_int64_t UsedPhaseLedType; // EM_PHASE_LED_TYPE_*
3566
3567 // Phase LED params (actual meaning depends on phase LED type)
3568 _supla_int_t PhaseLedParam1;
3569 _supla_int_t PhaseLedParam2;
3570
3571 // readonly, device capabilities
3572 unsigned _supla_int64_t AvailableCTTypes;
3573 unsigned _supla_int64_t AvailablePhaseLedTypes;
3574
3575 unsigned char Reserved[32];
3577
3578typedef struct {
3579 _supla_int_t PricePerUnit; // * 0.0001
3580 // Currency Code A https://www.nationsonline.org/oneworld/currencies.htm
3581 char Currency[3];
3582 char CustomUnit[9]; // UTF8 including the terminating null byte ('\0')
3583
3584 _supla_int_t ImpulsesPerUnit;
3585 _supla_int64_t InitialValue; // 0.001 units
3586 unsigned char AddToHistory; // 0 - False, 1 - True
3587
3588 unsigned char Reserved[32];
3589} TChannelConfig_ImpulseCounter; // v. >= 25
3590
3591typedef struct {
3592 unsigned char FillLevel; // Fill level in 0-100 %
3593 union {
3594 _supla_int_t ChannelId;
3595 struct {
3596 unsigned char IsSet; // 0 - no; 1 - yes
3597 unsigned char ChannelNo;
3598 };
3599 };
3601
3602typedef struct {
3603 unsigned char WarningAboveLevel; // 0 - not set, 1-101 for 0-100%
3604 unsigned char AlarmAboveLevel; // 0 - not set, 1-101 for 0-100%
3605 unsigned char WarningBelowLevel; // 0 - not set, 1-101 for 0-100%
3606 unsigned char AlarmBelowLevel; // 0 - not set, 1-101 for 0-100%
3607
3608 unsigned char MuteAlarmSoundWithoutAdditionalAuth; // 0 - admin login is
3609 // required, 1 - regular
3610 // user is allowed
3611
3612 TContainer_SensorInfo SensorInfo[10];
3613 unsigned char Reserved[32];
3614} TChannelConfig_Container; // v. >= 26
3615
3616typedef struct {
3617 union {
3618 _supla_int_t ChannelId;
3619 struct {
3620 unsigned char IsSet; // 0 - no; 1 - yes
3621 unsigned char ChannelNo;
3622 };
3623 };
3624} TValve_SensorInfo; // v. >= 27
3625
3626#define SUPLA_VALVE_CLOSE_ON_FLOOD_TYPE_NONE 0
3627#define SUPLA_VALVE_CLOSE_ON_FLOOD_TYPE_ALWAYS 1
3628#define SUPLA_VALVE_CLOSE_ON_FLOOD_TYPE_ON_CHANGE 2
3629
3630typedef struct {
3632 SensorInfo[20]; // Flood sensors can be attached only if
3633 // SUPLA_CHANNEL_FLAG_FLOOD_SENSORS_SUPPORTED is set
3634 unsigned char CloseValveOnFloodType; // SUPLA_VALVE_CLOSE_ON_FLOOD_TYPE_*
3635 unsigned char Reserved[31];
3636} TChannelConfig_Valve; // v. >= 27
3637
3638#define SUPLA_OCR_AUTHKEY_SIZE 33
3639
3640#define OCR_LIGHTING_MODE_OFF (1ULL << 0)
3641#define OCR_LIGHTING_MODE_ALWAYS_ON (1ULL << 1)
3642#define OCR_LIGHTING_MODE_AUTO (1ULL << 2)
3643
3644typedef struct {
3645 char AuthKey[SUPLA_OCR_AUTHKEY_SIZE]; // Set by the server. Alphanumeric null
3646 // terminated string.
3647 char Host[SUPLA_URL_HOST_MAXSIZE]; // Set by the server. Including the
3648 // terminating null byte ('\0').
3649
3650 unsigned _supla_int_t
3651 PhotoIntervalSec; // 0 - Disabled. The server may discard the
3652 // value if it considers the frequency to be
3653 // too high or too low. The server can set
3654 // the accepted value.
3655 unsigned _supla_int64_t LightingMode; // OCR_LIGHTING_MODE *
3656 unsigned char LightingLevel; // 1-100%
3657 unsigned _supla_int64_t MaximumIncrement; // Maximum impulse increment
3658 // between shots. 0 == Unspecified
3659
3660 // readonly, device capabilities
3661 unsigned _supla_int64_t AvailableLightingModes;
3662 unsigned char Reserved[128];
3663} TChannelConfig_OCR; // v. >= 25
3664
3665typedef struct {
3666 // If OvercurrentMaxAllowed == 0, then overcurrent settings are not available.
3667 // If OvercurrentThreshold == 0, then overcurrent protection is disabled.
3668 unsigned _supla_int_t OvercurrentThreshold; // in 0.01 A
3669 unsigned _supla_int_t OvercurrentMaxAllowed; // in 0.01 A, readonly
3670 unsigned char DefaultRelatedMeterIsSet; // readonly, 1 - true, 0 - false
3671 unsigned char
3672 DefaultRelatedMeterChannelNo; // readonly, provides channel number of
3673 // related meter if RelatedMeterIsSet
3674 unsigned char Reserved[32];
3675} TChannelConfig_PowerSwitch; // v. >= 25
3676
3677typedef TChannelConfig_PowerSwitch TChannelConfig_LightSwitch;
3678
3679// Staircase timer ext use SUPLA_CONFIG_TYPE_EXTENDED
3680typedef TChannelConfig_PowerSwitch TChannelConfig_StaircaseTimer_Ext;
3681
3682typedef struct {
3683 _supla_int_t ChannelID;
3684 union {
3685 unsigned _supla_int_t DurationMS;
3686 unsigned _supla_int_t DurationSec; // ver. >= 21. Applies to HVAC
3687 };
3688 unsigned char On;
3689} TCS_TimerArmRequest; // v. >= 17
3690
3691// Recommended for bistable buttons
3692#define SUPLA_ACTION_CAP_TURN_ON (1 << 0)
3693#define SUPLA_ACTION_CAP_TURN_OFF (1 << 1)
3694#define SUPLA_ACTION_CAP_TOGGLE_x1 (1 << 2)
3695#define SUPLA_ACTION_CAP_TOGGLE_x2 (1 << 3)
3696#define SUPLA_ACTION_CAP_TOGGLE_x3 (1 << 4)
3697#define SUPLA_ACTION_CAP_TOGGLE_x4 (1 << 5)
3698#define SUPLA_ACTION_CAP_TOGGLE_x5 (1 << 6)
3699
3700// Recommended for monostable buttons
3701#define SUPLA_ACTION_CAP_HOLD (1 << 10)
3702#define SUPLA_ACTION_CAP_SHORT_PRESS_x1 (1 << 11)
3703#define SUPLA_ACTION_CAP_SHORT_PRESS_x2 (1 << 12)
3704#define SUPLA_ACTION_CAP_SHORT_PRESS_x3 (1 << 13)
3705#define SUPLA_ACTION_CAP_SHORT_PRESS_x4 (1 << 14)
3706#define SUPLA_ACTION_CAP_SHORT_PRESS_x5 (1 << 15)
3707
3708#define SUPLA_VALVE_FLAG_FLOODING 0x1
3709#define SUPLA_VALVE_FLAG_MANUALLY_CLOSED 0x2
3710#define SUPLA_VALVE_FLAG_MOTOR_PROBLEM 0x4
3711
3712// Valve channel value
3713// Device -> Server -> Client
3714typedef struct {
3715 union {
3716 unsigned char closed; // 0 - open, 1 - closed
3717 unsigned char closed_percent;
3718 };
3719
3720 unsigned char flags; // see SUPLA_VALVE_FLAG_
3721} TValve_Value;
3722
3723// Valve channel value payload
3724// Client -> Server -> Device
3725typedef struct {
3726 unsigned char command; // 0 - close
3727 // 1 - open
3728 char reserved[7];
3729} TCSD_Valve;
3730
3731typedef struct {
3732 unsigned char ChannelNumber;
3733 _supla_int_t ActionTrigger;
3734 unsigned char zero[10]; // Place for future variables
3736
3737#define SUPLA_PN_TITLE_MAXSIZE 101
3738#define SUPLA_PN_BODY_MAXSIZE 256
3739#define SUPLA_PN_PROFILE_NAME_MAXSIZE 51
3740
3741#define PN_SERVER_MANAGED_TITLE (1 << 0)
3742#define PN_SERVER_MANAGED_BODY (1 << 1)
3743#define PN_SERVER_MANAGED_SOUND (1 << 2)
3744
3745typedef struct {
3746 unsigned char
3747 ServerManagedFields; // Specifies the fields that will be managed by the
3748 // server. This value is only considered for the
3749 // first notification within a given context and
3750 // applies to all subsequent notifications.
3751
3752 _supla_int16_t Context; // >= 0 Channel, -1 Device
3753 signed char Reserved[8];
3755
3756typedef struct {
3757 _supla_int16_t Context; // >= 0 Channel, -1 Device
3758 signed char Reserved[32];
3759 _supla_int_t SoundId;
3760 unsigned _supla_int16_t
3761 TitleSize; // Including the terminating null byte ('\0').
3762 unsigned _supla_int16_t
3763 BodySize; // Including the terminating null byte ('\0').
3764 signed char TitleAndBody[SUPLA_PN_TITLE_MAXSIZE +
3765 SUPLA_PN_BODY_MAXSIZE]; // Last variable in struct!
3767
3768#define SUPLA_SUBDEVICE_PRODUCT_CODE_MAXSIZE 51
3769#define SUPLA_SUBDEVICE_SERIAL_NUMBER_MAXSIZE 51
3770
3771typedef struct {
3772 // device -> server
3773 unsigned char SubDeviceId;
3774
3775 char Name[SUPLA_DEVICE_NAME_MAXSIZE]; // UTF8 - 201 B including the
3776 // terminating null byte ('\0').
3777 char SoftVer[SUPLA_SOFTVER_MAXSIZE]; // 21 B including the terminating null
3778 // byte ('\0').
3779 char ProductCode[SUPLA_SUBDEVICE_PRODUCT_CODE_MAXSIZE]; // 51 B including the
3780 // terminating null
3781 // byte ('\0').
3782 char
3783 SerialNumber[SUPLA_SUBDEVICE_SERIAL_NUMBER_MAXSIZE]; // 51 B including
3784 // the terminating
3785 // null byte ('\0').
3787
3788#define SUPLA_PN_CLIENT_TOKEN_MAXSIZE 256
3789#define PLATFORM_UNKNOWN 0
3790#define PLATFORM_IOS 1
3791#define PLATFORM_ANDROID 2
3792#define PLATFORM_HOMEGRAPH 3 // v. >= 23
3793
3794typedef struct {
3795 unsigned char DevelopmentEnv;
3796 _supla_int_t Platform;
3797 _supla_int_t AppId;
3798 signed char
3799 ProfileName[SUPLA_PN_PROFILE_NAME_MAXSIZE]; // Including the terminating
3800 // null byte ('\0').
3801 unsigned _supla_int16_t
3802 RealTokenSize; // It allows you to determine if the maximum size of the
3803 // Token variable is sufficient.
3804 unsigned _supla_int16_t
3805 TokenSize; // Including the terminating null byte ('\0'). Size
3806 // <= 1 removes the token
3807 signed char Token[SUPLA_PN_CLIENT_TOKEN_MAXSIZE]; // Last variable in struct!
3809
3810typedef struct {
3812 TCS_PnClientToken Token; // Last variable in struct!
3814
3815typedef struct {
3816 _supla_int_t ResultCode;
3818
3819typedef struct {
3820 _supla_int_t count;
3821 _supla_int_t total_left;
3823 items[SUPLA_CHANNEL_STATE_PACK_MAXCOUNT]; // Last variable in struct!
3825
3826#pragma pack(pop)
3827
3828void *PROTO_ICACHE_FLASH sproto_init(void);
3829void PROTO_ICACHE_FLASH sproto_free(void *spd_ptr);
3830
3831#ifndef SPROTO_WITHOUT_OUT_BUFFER
3832char PROTO_ICACHE_FLASH sproto_out_buffer_append(void *spd_ptr,
3833 TSuplaDataPacket *sdp);
3834unsigned _supla_int_t sproto_pop_out_data(void *spd_ptr, char *buffer,
3835 unsigned _supla_int_t buffer_size);
3836#endif /*SPROTO_WITHOUT_OUT_BUFFER*/
3837char PROTO_ICACHE_FLASH sproto_out_dataexists(void *spd_ptr);
3838char PROTO_ICACHE_FLASH sproto_in_buffer_append(
3839 void *spd_ptr, char *data, unsigned _supla_int_t data_size);
3840
3841char PROTO_ICACHE_FLASH sproto_pop_in_sdp(void *spd_ptr, TSuplaDataPacket *sdp);
3842char PROTO_ICACHE_FLASH sproto_in_dataexists(void *spd_ptr);
3843
3844unsigned char PROTO_ICACHE_FLASH sproto_get_version(void *spd_ptr);
3845void PROTO_ICACHE_FLASH sproto_set_version(void *spd_ptr,
3846 unsigned char version);
3847void PROTO_ICACHE_FLASH sproto_sdp_init(void *spd_ptr, TSuplaDataPacket *sdp);
3848char PROTO_ICACHE_FLASH sproto_set_data(TSuplaDataPacket *sdp, char *data,
3849 unsigned _supla_int_t data_size,
3850 unsigned _supla_int_t call_id);
3851TSuplaDataPacket *PROTO_ICACHE_FLASH sproto_sdp_malloc(void *spd_ptr);
3852void PROTO_ICACHE_FLASH sproto_sdp_free(TSuplaDataPacket *sdp);
3853
3854void PROTO_ICACHE_FLASH sproto_log_summary(void *spd_ptr);
3855void PROTO_ICACHE_FLASH sproto_buffer_dump(void *spd_ptr, unsigned char in);
3856
3857void PROTO_ICACHE_FLASH sproto_set_null_terminated_string(
3858 const char *src, char *dest, unsigned _supla_int_t *dest_size,
3859 unsigned int max_size);
3860
3861void PROTO_ICACHE_FLASH sproto__set_null_terminated_string(
3862 const char *src, char *dest, unsigned _supla_int16_t *dest_size,
3863 unsigned int max_size);
3864
3865#ifdef __cplusplus
3866}
3867#endif
3868
3869#endif /* supla_proto_H_ */
Definition proto.h:3276
Definition proto.h:2916
Definition proto.h:2908
Definition proto.h:2897
Definition proto.h:816
Definition proto.h:1623
Definition proto.h:1614
Definition proto.h:1607
Definition proto.h:2565
Definition proto.h:2369
Definition proto.h:2084
Definition proto.h:2054
Definition proto.h:3725
Definition proto.h:1650
Definition proto.h:1633
Definition proto.h:2636
Definition proto.h:1641
Definition proto.h:2243
Definition proto.h:2234
Definition proto.h:2731
Definition proto.h:2990
Definition proto.h:1672
Definition proto.h:2816
Definition proto.h:3794
Definition proto.h:3810
Definition proto.h:2682
Definition proto.h:2720
Definition proto.h:2104
Definition proto.h:1791
Definition proto.h:1785
Definition proto.h:1797
Definition proto.h:1688
Definition proto.h:1701
Definition proto.h:1714
Definition proto.h:1677
Definition proto.h:3682
Definition proto.h:2289
Definition proto.h:2200
Definition proto.h:2195
Definition proto.h:2280
Definition proto.h:2223
Definition proto.h:2172
Definition proto.h:2191
Definition proto.h:2184
Definition proto.h:3097
Definition proto.h:3164
Definition proto.h:3602
Definition proto.h:3561
Definition proto.h:3075
Definition proto.h:3489
Definition proto.h:3335
Definition proto.h:3578
Definition proto.h:3644
Definition proto.h:3665
Definition proto.h:3056
Definition proto.h:3052
Definition proto.h:3630
Definition proto.h:3117
Definition proto.h:2380
Definition proto.h:3591
Definition proto.h:2693
Definition proto.h:703
Definition proto.h:692
Definition proto.h:713
Definition proto.h:2599
Definition proto.h:2072
Definition proto.h:2037
Definition proto.h:3731
Definition proto.h:2270
Definition proto.h:1817
Definition proto.h:3016
Definition proto.h:2748
Definition proto.h:2020
Definition proto.h:3756
Definition proto.h:3745
Definition proto.h:3771
Definition proto.h:1202
Definition proto.h:1152
Definition proto.h:1160
Definition proto.h:1145
Definition proto.h:804
Definition proto.h:880
Definition proto.h:927
Definition proto.h:953
Definition proto.h:782
Definition proto.h:1054
Definition proto.h:981
Definition proto.h:996
Definition proto.h:1014
Definition proto.h:1032
Definition proto.h:1074
Definition proto.h:1096
Definition proto.h:789
Definition proto.h:2853
Definition proto.h:2840
Definition proto.h:2844
Definition proto.h:2971
Definition proto.h:2879
Definition proto.h:2858
Definition proto.h:2950
Definition proto.h:2830
Definition proto.h:2834
Definition proto.h:2826
Definition proto.h:2363
Definition proto.h:1960
Definition proto.h:1855
Definition proto.h:2001
Definition proto.h:2494
Definition proto.h:870
Definition proto.h:2341
Definition proto.h:2354
Definition proto.h:2704
Definition proto.h:2997
Definition proto.h:2797
Definition proto.h:1655
Definition proto.h:2662
Definition proto.h:3008
Definition proto.h:2716
Definition proto.h:2252
Definition proto.h:2809
Definition proto.h:2735
Definition proto.h:1662
Definition proto.h:2006
Definition proto.h:2100
Definition proto.h:1850
Definition proto.h:1843
Definition proto.h:3815
Definition proto.h:2687
Definition proto.h:2727
Definition proto.h:2109
Definition proto.h:1256
Definition proto.h:1229
Definition proto.h:1463
Definition proto.h:1454
Definition proto.h:1480
Definition proto.h:1472
Definition proto.h:1438
Definition proto.h:1423
Definition proto.h:1311
Definition proto.h:1396
Definition proto.h:1405
Definition proto.h:1414
Definition proto.h:1283
Definition proto.h:1511
Definition proto.h:1504
Definition proto.h:3819
Definition proto.h:1246
Definition proto.h:1236
Definition proto.h:1219
Definition proto.h:1209
Definition proto.h:1292
Definition proto.h:1320
Definition proto.h:1345
Definition proto.h:1370
Definition proto.h:1267
Definition proto.h:1804
Definition proto.h:774
Definition proto.h:765
Definition proto.h:1740
Definition proto.h:1754
Definition proto.h:1769
Definition proto.h:1728
Definition proto.h:1532
Definition proto.h:1554
Definition proto.h:1540
Definition proto.h:1518
Definition proto.h:1838
Definition proto.h:679
Definition proto.h:708
Definition proto.h:686
Definition proto.h:2552
Definition proto.h:3041
Definition proto.h:2792
Definition proto.h:2780
Definition proto.h:3048
Definition proto.h:3025
Definition proto.h:2740
Definition proto.h:2752
Definition proto.h:2260
Definition proto.h:1833
Definition proto.h:1826
Definition proto.h:1189
Definition proto.h:1177
Definition proto.h:1131
Definition proto.h:1118
Definition proto.h:759
Definition proto.h:730
Definition proto.h:725
Definition proto.h:670
Definition proto.h:2436
Definition proto.h:2410
Definition proto.h:2534
Definition proto.h:2417
Definition proto.h:2404
Definition proto.h:2385
Definition proto.h:2545
Definition proto.h:2640
Definition proto.h:3616
Definition proto.h:3714
Definition proto.h:3102
Definition proto.h:698