forked from thingsboard/thingsboard-python-client-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtb_device_mqtt.py
1183 lines (1035 loc) · 55 KB
/
tb_device_mqtt.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright 2024. ThingsBoard
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import logging
from copy import deepcopy
from inspect import signature
from time import sleep
import paho.mqtt.client as paho
from math import ceil
try:
from time import monotonic, time as timestamp
except ImportError:
from time import time, time as timestamp
import ssl
from threading import RLock, Thread
from enum import Enum
from paho.mqtt.reasoncodes import ReasonCodes
from orjson import dumps, loads, JSONDecodeError
from sdk_utils import verify_checksum
FW_TITLE_ATTR = "fw_title"
FW_VERSION_ATTR = "fw_version"
FW_CHECKSUM_ATTR = "fw_checksum"
FW_CHECKSUM_ALG_ATTR = "fw_checksum_algorithm"
FW_SIZE_ATTR = "fw_size"
FW_STATE_ATTR = "fw_state"
REQUIRED_SHARED_KEYS = f"{FW_CHECKSUM_ATTR},{FW_CHECKSUM_ALG_ATTR},{FW_SIZE_ATTR},{FW_TITLE_ATTR},{FW_VERSION_ATTR}"
RPC_RESPONSE_TOPIC = 'v1/devices/me/rpc/response/'
RPC_REQUEST_TOPIC = 'v1/devices/me/rpc/request/'
ATTRIBUTES_TOPIC = 'v1/devices/me/attributes'
ATTRIBUTES_TOPIC_REQUEST = 'v1/devices/me/attributes/request/'
ATTRIBUTES_TOPIC_RESPONSE = 'v1/devices/me/attributes/response/'
TELEMETRY_TOPIC = 'v1/devices/me/telemetry'
CLAIMING_TOPIC = 'v1/devices/me/claim'
PROVISION_TOPIC_REQUEST = '/provision/request'
PROVISION_TOPIC_RESPONSE = '/provision/response'
log = logging.getLogger('tb_connection')
RESULT_CODES = {
1: "incorrect protocol version",
2: "invalid client identifier",
3: "server unavailable",
4: "bad username or password",
5: "not authorised",
}
class TBTimeoutException(Exception):
pass
class TBQoSException(Exception):
pass
DEFAULT_TIMEOUT = 5
class TBSendMethod(Enum):
SUBSCRIBE = 0
PUBLISH = 1
UNSUBSCRIBE = 2
class TBPublishInfo:
TB_ERR_AGAIN = -1
TB_ERR_SUCCESS = 0
TB_ERR_NOMEM = 1
TB_ERR_PROTOCOL = 2
TB_ERR_INVAL = 3
TB_ERR_NO_CONN = 4
TB_ERR_CONN_REFUSED = 5
TB_ERR_NOT_FOUND = 6
TB_ERR_CONN_LOST = 7
TB_ERR_TLS = 8
TB_ERR_PAYLOAD_SIZE = 9
TB_ERR_NOT_SUPPORTED = 10
TB_ERR_AUTH = 11
TB_ERR_ACL_DENIED = 12
TB_ERR_UNKNOWN = 13
TB_ERR_ERRNO = 14
TB_ERR_QUEUE_SIZE = 15
ERRORS_DESCRIPTION = {
-1: 'Previous error repeated.',
0: 'The operation completed successfully.',
1: 'Out of memory.',
2: 'A network protocol error occurred when communicating with the broker.',
3: 'Invalid function arguments provided.',
4: 'The client is not currently connected.',
5: 'The connection was refused.',
6: 'Entity not found (for example, trying to unsubscribe from a topic not currently subscribed to).',
7: 'The connection was lost.',
8: 'A TLS error occurred.',
9: 'Payload size is too large.',
10: 'This feature is not supported.',
11: 'Authorization failed.',
12: 'Access denied to the specified ACL.',
13: 'Unknown error.',
14: 'A system call returned an error.',
15: 'The queue size was exceeded.',
16: 'The keepalive time has been exceeded.'
}
def __init__(self, message_info):
self.message_info = message_info
# pylint: disable=invalid-name
def rc(self):
if isinstance(self.message_info, list):
for info in self.message_info:
if info.rc != 0:
return info.rc
return self.TB_ERR_SUCCESS
else:
return self.message_info.rc
def mid(self):
if isinstance(self.message_info, list):
return [info.mid for info in self.message_info]
else:
return self.message_info.mid
def get(self):
if isinstance(self.message_info, list):
for info in self.message_info:
info.wait_for_publish(timeout=1)
else:
self.message_info.wait_for_publish(timeout=1)
return self.rc()
class RateLimit:
def __init__(self, rate_limit, name=None, percentage=80):
self.__no_limit = False
self.__rate_limit_dict = {}
self.__lock = RLock()
self.__minimal_timeout = DEFAULT_TIMEOUT
self.__minimal_limit = 1000000000
from_dict = isinstance(rate_limit, dict)
if from_dict:
self.__rate_limit_dict = rate_limit.get('rateLimit', rate_limit)
name = rate_limit.get('name', name)
percentage = rate_limit.get('percentage', percentage)
self.no_limit = rate_limit.get('no_limit', False)
self.name = name
self.percentage = percentage
self.__start_time = int(monotonic())
if not from_dict:
if ''.join(c for c in rate_limit if c not in [' ', ',', ';']) in ("", "0:0"):
self.__no_limit = True
rate_configs = rate_limit.split(";")
if "," in rate_limit:
rate_configs = rate_limit.split(",")
for rate in rate_configs:
if rate == "":
continue
rate = rate.split(":")
self.__rate_limit_dict[int(rate[1])] = {"counter": 0,
"start": int(monotonic()),
"limit": int(int(rate[0]) * self.percentage / 100)}
log.debug("Rate limit %s set to values: " % self.name)
with self.__lock:
if not self.__no_limit:
for rate_limit_time in self.__rate_limit_dict:
log.debug("Time: %s, Limit: %s", rate_limit_time,
self.__rate_limit_dict[rate_limit_time]["limit"])
if self.__rate_limit_dict[rate_limit_time]["limit"] < self.__minimal_limit:
self.__minimal_limit = self.__rate_limit_dict[rate_limit_time]["limit"]
if rate_limit_time < self.__minimal_limit:
self.__minimal_timeout = rate_limit_time + 1
else:
log.debug("No rate limits.")
def increase_rate_limit_counter(self, amount=1):
if self.__no_limit:
return
with self.__lock:
for rate_limit_time in self.__rate_limit_dict:
self.__rate_limit_dict[rate_limit_time]["counter"] += amount
def check_limit_reached(self, amount=1):
if self.__no_limit:
return False
with self.__lock:
current_time = int(monotonic())
for rate_limit_time, rate_limit_info in self.__rate_limit_dict.items():
if self.__rate_limit_dict[rate_limit_time]["start"] + rate_limit_time <= current_time:
self.__rate_limit_dict[rate_limit_time]["start"] = current_time
self.__rate_limit_dict[rate_limit_time]["counter"] = 0
if rate_limit_info['counter'] + amount > rate_limit_info['limit']:
return rate_limit_time
return False
def get_minimal_limit(self):
return self.__minimal_limit
def get_minimal_timeout(self):
return self.__minimal_timeout
def has_limit(self):
return not self.__no_limit
def set_limit(self, rate_limit, percentage=80):
with self.__lock:
old_rate_limit_dict = deepcopy(self.__rate_limit_dict)
self.__rate_limit_dict = {}
self.percentage = percentage if percentage != 0 else self.percentage
rate_configs = rate_limit.split(";")
if "," in rate_limit:
rate_configs = rate_limit.split(",")
for rate in rate_configs:
if rate == "":
continue
rate = rate.split(":")
rate_limit_time = int(rate[1])
limit = int(int(rate[0]) * percentage / 100)
self.__rate_limit_dict[int(rate[1])] = {
"counter": old_rate_limit_dict.get(rate_limit_time, {}).get('counter', 0),
"start": self.__rate_limit_dict.get(rate_limit_time, {}).get('start', int(monotonic())),
"limit": limit}
if rate_limit_time < self.__minimal_limit:
self.__minimal_timeout = rate_limit_time + 1
if limit < self.__minimal_limit:
self.__minimal_limit = limit
if self.__rate_limit_dict:
self.__no_limit = False
log.debug("Rate limit set to values: ")
for rate_limit_time in self.__rate_limit_dict:
log.debug("Time: %s, Limit: %s", rate_limit_time, self.__rate_limit_dict[rate_limit_time]["limit"])
def __dict__(self):
return {
"rateLimit": self.__rate_limit_dict,
"name": self.name,
"percentage": self.percentage,
"no_limit": self.__no_limit
}
@staticmethod
def get_rate_limits_by_host(host, rate_limit, dp_rate_limit):
rate_limit = RateLimit.get_rate_limit_by_host(host, rate_limit)
dp_rate_limit = RateLimit.get_dp_rate_limit_by_host(host, dp_rate_limit)
return rate_limit, dp_rate_limit
@staticmethod
def get_rate_limit_by_host(host, rate_limit):
if rate_limit == "DEFAULT_TELEMETRY_RATE_LIMIT":
if "thingsboard.cloud" in host:
rate_limit = "10:1,60:60,"
elif "tb" in host and "cloud" in host:
rate_limit = "10:1,60:60,"
elif "demo.thingsboard.io" in host:
rate_limit = "10:1,60:60,"
else:
rate_limit = "0:0,"
elif rate_limit == "DEFAULT_MESSAGES_RATE_LIMIT":
if "thingsboard.cloud" in host:
rate_limit = "10:1,60:60,"
elif "tb" in host and "cloud" in host:
rate_limit = "10:1,60:60,"
elif "demo.thingsboard.io" in host:
rate_limit = "10:1,60:60,"
else:
rate_limit = "0:0,"
else:
rate_limit = rate_limit
return rate_limit
@staticmethod
def get_dp_rate_limit_by_host(host, dp_rate_limit):
if dp_rate_limit == "DEFAULT_TELEMETRY_DP_RATE_LIMIT":
if "thingsboard.cloud" in host:
dp_rate_limit = "10:1,300:60,"
elif "tb" in host and "cloud" in host:
dp_rate_limit = "10:1,300:60,"
elif "demo.thingsboard.io" in host:
dp_rate_limit = "10:1,300:60,"
else:
dp_rate_limit = "0:0,"
else:
dp_rate_limit = dp_rate_limit
return dp_rate_limit
class TBDeviceMqttClient:
"""ThingsBoard MQTT client. This class provides interface to send data to ThingsBoard and receive data from"""
EMPTY_RATE_LIMIT = RateLimit('0:0,', "EMPTY_RATE_LIMIT")
def __init__(self, host, port=1883, username=None, password=None, quality_of_service=None, client_id="",
chunk_size=0, messages_rate_limit="DEFAULT_MESSAGES_RATE_LIMIT",
telemetry_rate_limit="DEFAULT_TELEMETRY_RATE_LIMIT",
telemetry_dp_rate_limit="DEFAULT_TELEMETRY_DP_RATE_LIMIT", max_payload_size=8196, **kwargs):
# Added for compatibility with old versions
if kwargs.get('rate_limit') is not None or kwargs.get('dp_rate_limit') is not None:
messages_rate_limit = messages_rate_limit if kwargs.get('rate_limit') == "DEFAULT_RATE_LIMIT" else kwargs.get('rate_limit', messages_rate_limit)
telemetry_rate_limit = telemetry_rate_limit if kwargs.get('rate_limit') == "DEFAULT_RATE_LIMIT" else kwargs.get('rate_limit', telemetry_rate_limit)
telemetry_dp_rate_limit = telemetry_dp_rate_limit if kwargs.get('dp_rate_limit') == "DEFAULT_RATE_LIMIT" else kwargs.get('dp_rate_limit', telemetry_dp_rate_limit)
self._client = paho.Client(protocol=5, client_id=client_id)
self.quality_of_service = quality_of_service if quality_of_service is not None else 1
self.__host = host
self.__port = port
if username == "":
log.warning("Token is not set, connection without TLS won't be established!")
else:
self._client.username_pw_set(username, password=password)
self._lock = RLock()
self._attr_request_dict = {}
self.stopped = False
self.__is_connected = False
self.__device_on_server_side_rpc_response = None
self.__connect_callback = None
self.__device_max_sub_id = 0
self.__device_client_rpc_number = 0
self.__device_sub_dict = {}
self.__device_client_rpc_dict = {}
self.__attr_request_number = 0
self.max_payload_size = max_payload_size
self.service_configuration_callback = self.on_service_configuration
telemetry_rate_limit, telemetry_dp_rate_limit = RateLimit.get_rate_limits_by_host(self.__host,
telemetry_rate_limit,
telemetry_dp_rate_limit)
messages_rate_limit = RateLimit.get_rate_limit_by_host(self.__host, messages_rate_limit)
self._messages_rate_limit = RateLimit(messages_rate_limit, "Rate limit for messages")
self._telemetry_rate_limit = RateLimit(telemetry_rate_limit, "Rate limit for telemetry messages")
self._telemetry_dp_rate_limit = RateLimit(telemetry_dp_rate_limit, "Rate limit for telemetry data points")
self._client.max_inflight_messages_set(self._telemetry_rate_limit.get_minimal_limit())
self.__attrs_request_timeout = {}
self.__timeout_thread = Thread(target=self.__timeout_check)
self.__timeout_thread.daemon = True
self.__timeout_thread.start()
self._client.on_connect = self._on_connect
# self._client.on_publish = self._on_publish
self._client.on_message = self._on_message
self._client.on_disconnect = self._on_disconnect
self.current_firmware_info = {
"current_" + FW_TITLE_ATTR: "Initial",
"current_" + FW_VERSION_ATTR: "v0",
FW_STATE_ATTR: "IDLE"
}
self.__request_id = 0
self.__firmware_request_id = 0
self.__chunk_size = chunk_size
self.firmware_received = False
self.__updating_thread = Thread(target=self.__update_thread, name="Updating thread")
self.__updating_thread.daemon = True
self.rate_limits_received = False
def _on_publish(self, client, userdata, mid):
# log.debug("Message %s was published, by client with id: %r", mid ,id(client))
pass
def _on_disconnect(self, client: paho.Client, userdata, result_code, properties=None):
self.__is_connected = False
client._out_packet.clear()
client._out_messages.clear()
client._in_messages.clear()
self.__attr_request_number = 0
self.__device_max_sub_id = 0
self.__device_client_rpc_number = 0
self.__device_sub_dict = {}
self.__device_client_rpc_dict = {}
self.__attrs_request_timeout = {}
log.warning("MQTT client was disconnected with reason code %s (%s) ",
str(result_code), TBPublishInfo.ERRORS_DESCRIPTION.get(result_code, "Description not found."))
log.debug("Client: %s, user data: %s, result code: %s. Description: %s",
str(client), str(userdata),
str(result_code), TBPublishInfo.ERRORS_DESCRIPTION.get(result_code, "Description not found."))
def _on_connect(self, client, userdata, flags, result_code, *extra_params):
if result_code == 0:
self.__is_connected = True
log.info("MQTT client %r - Connected!", client)
self._subscribe_to_topic(ATTRIBUTES_TOPIC, qos=self.quality_of_service)
self._subscribe_to_topic(ATTRIBUTES_TOPIC + "/response/+", qos=self.quality_of_service)
self._subscribe_to_topic(RPC_REQUEST_TOPIC + '+', qos=self.quality_of_service)
self._subscribe_to_topic(RPC_RESPONSE_TOPIC + '+', qos=self.quality_of_service)
self.request_service_configuration(self.service_configuration_callback)
else:
if isinstance(result_code, int):
if result_code in RESULT_CODES:
log.error("connection FAIL with error %s %s", result_code, RESULT_CODES[result_code])
else:
log.error("connection FAIL with unknown error")
elif isinstance(result_code, ReasonCodes):
log.error("connection FAIL with error %s %s", result_code, result_code.getName())
if callable(self.__connect_callback):
sleep(.2)
if "tb_client" in signature(self.__connect_callback).parameters:
self.__connect_callback(client, userdata, flags, result_code, *extra_params, tb_client=self)
else:
self.__connect_callback(client, userdata, flags, result_code, *extra_params)
def get_firmware_update(self):
self._client.subscribe("v2/fw/response/+")
self.send_telemetry(self.current_firmware_info)
self.__request_firmware_info()
self.__updating_thread.start()
def __request_firmware_info(self):
self.__request_id = self.__request_id + 1
self._publish_data({"sharedKeys": REQUIRED_SHARED_KEYS},
f"v1/devices/me/attributes/request/{self.__request_id}",
1)
def is_connected(self):
return self.__is_connected
def connect(self, callback=None, min_reconnect_delay=1, timeout=120, tls=False, ca_certs=None, cert_file=None,
key_file=None, keepalive=120):
"""Connect to ThingsBoard. The callback will be called when the connection is established."""
if tls:
try:
self._client.tls_set(ca_certs=ca_certs,
certfile=cert_file,
keyfile=key_file,
cert_reqs=ssl.CERT_REQUIRED,
tls_version=ssl.PROTOCOL_TLSv1_2,
ciphers=None)
self._client.tls_insecure_set(False)
except ValueError:
pass
self.reconnect_delay_set(min_reconnect_delay, timeout)
self._client.connect(self.__host, self.__port, keepalive=keepalive)
self._client.loop_start()
self.__connect_callback = callback
def disconnect(self):
"""Disconnect from ThingsBoard."""
result = self._client.disconnect()
log.debug(self._client)
log.debug("Disconnecting from ThingsBoard")
self.__is_connected = False
self._client.loop_stop()
return result
def stop(self):
self.stopped = True
def _on_message(self, client, userdata, message):
update_response_pattern = "v2/fw/response/" + str(self.__firmware_request_id) + "/chunk/"
if message.topic.startswith(update_response_pattern):
firmware_data = message.payload
self.firmware_data = self.firmware_data + firmware_data
self.__current_chunk = self.__current_chunk + 1
log.debug('Getting chunk with number: %s. Chunk size is : %r byte(s).' % (
self.__current_chunk, self.__chunk_size))
if len(self.firmware_data) == self.__target_firmware_length:
self.__process_firmware()
else:
self.__get_firmware()
else:
content = self._decode(message)
self._on_decoded_message(content, message)
def _on_decoded_message(self, content, message):
if message.topic.startswith(RPC_REQUEST_TOPIC):
request_id = message.topic[len(RPC_REQUEST_TOPIC):len(message.topic)]
if self.__device_on_server_side_rpc_response:
self.__device_on_server_side_rpc_response(request_id, content)
elif message.topic.startswith(RPC_RESPONSE_TOPIC):
with self._lock:
request_id = int(message.topic[len(RPC_RESPONSE_TOPIC):len(message.topic)])
if self.__device_client_rpc_dict.get(request_id):
callback = self.__device_client_rpc_dict.pop(request_id)
else:
callback = None
if callback is not None:
callback(request_id, content, None)
elif message.topic == ATTRIBUTES_TOPIC:
dict_results = []
with self._lock:
# callbacks for everything
if self.__device_sub_dict.get("*"):
for subscription_id in self.__device_sub_dict["*"]:
dict_results.append(self.__device_sub_dict["*"][subscription_id])
# specific callback
keys = content.keys()
keys_list = []
for key in keys:
keys_list.append(key)
# iterate through message
for key in keys_list:
# find key in our dict
if self.__device_sub_dict.get(key):
for subscription in self.__device_sub_dict[key]:
dict_results.append(self.__device_sub_dict[key][subscription])
for res in dict_results:
res(content, None)
elif message.topic.startswith(ATTRIBUTES_TOPIC_RESPONSE):
with self._lock:
req_id = int(message.topic[len(ATTRIBUTES_TOPIC + "/response/"):])
# pop callback and use it
if self._attr_request_dict.get(req_id):
callback = self._attr_request_dict.pop(req_id)
else:
callback = None
if isinstance(callback, tuple):
callback[0](content, None, callback[1])
elif callback is not None:
callback(content, None)
if message.topic.startswith("v1/devices/me/attributes"):
self.firmware_info = loads(message.payload)
if "/response/" in message.topic:
self.firmware_info = self.firmware_info.get("shared", {}) if isinstance(self.firmware_info, dict) else {}
if ((self.firmware_info.get(FW_VERSION_ATTR) is not None
and self.firmware_info.get(FW_VERSION_ATTR) != self.current_firmware_info.get("current_" + FW_VERSION_ATTR))
or (self.firmware_info.get(FW_TITLE_ATTR) is not None
and self.firmware_info.get(FW_TITLE_ATTR) != self.current_firmware_info.get("current_" + FW_TITLE_ATTR))):
log.debug('Firmware is not the same')
self.firmware_data = b''
self.__current_chunk = 0
self.current_firmware_info[FW_STATE_ATTR] = "DOWNLOADING"
self.send_telemetry(self.current_firmware_info)
sleep(1)
self.__firmware_request_id = self.__firmware_request_id + 1
self.__target_firmware_length = self.firmware_info[FW_SIZE_ATTR]
self.__chunk_count = 0 if not self.__chunk_size else ceil(
self.firmware_info[FW_SIZE_ATTR] / self.__chunk_size)
self.__get_firmware()
def __process_firmware(self):
self.current_firmware_info[FW_STATE_ATTR] = "DOWNLOADED"
self.send_telemetry(self.current_firmware_info)
sleep(1)
verification_result = verify_checksum(self.firmware_data, self.firmware_info.get(FW_CHECKSUM_ALG_ATTR),
self.firmware_info.get(FW_CHECKSUM_ATTR))
if verification_result:
log.debug('Checksum verified!')
self.current_firmware_info[FW_STATE_ATTR] = "VERIFIED"
self.send_telemetry(self.current_firmware_info)
sleep(1)
else:
log.debug('Checksum verification failed!')
self.current_firmware_info[FW_STATE_ATTR] = "FAILED"
self.send_telemetry(self.current_firmware_info)
self.__request_firmware_info()
return
self.firmware_received = True
def __get_firmware(self):
payload = '' if not self.__chunk_size or self.__chunk_size > self.firmware_info.get(FW_SIZE_ATTR, 0) \
else str(self.__chunk_size).encode()
self._publish_data(payload, f"v2/fw/request/{self.__firmware_request_id}/chunk/{self.__current_chunk}",
1)
def __on_firmware_received(self, version_to):
with open(self.firmware_info.get(FW_TITLE_ATTR), "wb") as firmware_file:
firmware_file.write(self.firmware_data)
log.info('Firmware is updated!\n Current firmware version is: %s' % version_to)
def __update_thread(self):
while not self.stopped:
if self.firmware_received:
self.current_firmware_info[FW_STATE_ATTR] = "UPDATING"
self.send_telemetry(self.current_firmware_info)
sleep(1)
self.__on_firmware_received(self.firmware_info.get(FW_VERSION_ATTR))
self.current_firmware_info = {
"current_" + FW_TITLE_ATTR: self.firmware_info.get(FW_TITLE_ATTR),
"current_" + FW_VERSION_ATTR: self.firmware_info.get(FW_VERSION_ATTR),
FW_STATE_ATTR: "UPDATED"
}
self.send_telemetry(self.current_firmware_info)
self.firmware_received = False
sleep(0.2)
@staticmethod
def _decode(message):
try:
if isinstance(message.payload, bytes):
content = loads(message.payload.decode("utf-8", "ignore"))
else:
content = loads(message.payload)
except JSONDecodeError:
try:
content = message.payload.decode("utf-8", "ignore")
except JSONDecodeError:
content = message.payload
return content
def max_inflight_messages_set(self, inflight):
"""Set the maximum number of messages with QoS>0 that can be a part way through their network flow at once.
Defaults to minimal rate limit. Increasing this value will consume more memory but can increase throughput."""
self._client.max_inflight_messages_set(inflight)
def max_queued_messages_set(self, queue_size):
"""Set the maximum number of outgoing messages with QoS>0 that can be pending in the outgoing message queue.
Defaults to 0. 0 means unlimited. When the queue is full, any further outgoing messages would be dropped."""
self._client.max_queued_messages_set(queue_size)
def reconnect_delay_set(self, min_delay=1, max_delay=120):
"""The client will automatically retry connection. Between each attempt it will wait a number of seconds
between min_delay and max_delay. When the connection is lost, initially the reconnection attempt is delayed
of min_delay seconds. It’s doubled between subsequent attempt up to max_delay. The delay is reset to min_delay
when the connection complete (e.g. the CONNACK is received, not just the TCP connection is established)."""
self._client.reconnect_delay_set(min_delay, max_delay)
def send_rpc_reply(self, req_id, resp, quality_of_service=None, wait_for_publish=False):
"""Send RPC reply to ThingsBoard. The response will be sent to the RPC_RESPONSE_TOPIC with the request id."""
quality_of_service = quality_of_service if quality_of_service is not None else self.quality_of_service
if quality_of_service not in (0, 1):
log.error("Quality of service (qos) value must be 0 or 1")
return None
info = self._publish_data(resp, RPC_RESPONSE_TOPIC + req_id, quality_of_service)
if wait_for_publish:
info.get()
def send_rpc_call(self, method, params, callback):
"""Send RPC call to ThingsBoard. The callback will be called when the response is received."""
with self._lock:
self.__device_client_rpc_number += 1
self.__device_client_rpc_dict.update({self.__device_client_rpc_number: callback})
rpc_request_id = self.__device_client_rpc_number
payload = {"method": method, "params": params}
self._publish_data(payload, RPC_REQUEST_TOPIC + str(rpc_request_id), self.quality_of_service)
def request_service_configuration(self, callback):
self.send_rpc_call("getSessionLimits", {"timeout": 5000}, callback)
def on_service_configuration(self, _, response, *args, **kwargs):
if "error" in response:
log.warning("Timeout while waiting for service configuration!, session will use default configuration.")
self.rate_limits_received = True
return
service_config = response
if not isinstance(service_config, dict) or 'rateLimit' not in service_config:
log.warning("Cannot retrieve service configuration, session will use default configuration.")
log.debug("Received the following response: %r", service_config)
return
if service_config.get("rateLimit"):
rate_limits_config = service_config.get("rateLimit")
if rate_limits_config.get('messages'):
self._messages_rate_limit.set_limit(rate_limits_config.get('messages'), percentage=80)
if rate_limits_config.get('telemetryMessages'):
self._telemetry_rate_limit.set_limit(rate_limits_config.get('telemetryMessages'), percentage=80)
if rate_limits_config.get('telemetryDataPoints'):
self._telemetry_dp_rate_limit.set_limit(rate_limits_config.get('telemetryDataPoints'), percentage=80)
if service_config.get('maxInflightMessages'):
max_inflight_messages = int(min(self._messages_rate_limit.get_minimal_limit(),
self._telemetry_rate_limit.get_minimal_limit(),
service_config.get('maxInflightMessages', 100)) * 80 / 100)
self.max_inflight_messages_set(max_inflight_messages)
if service_config.get('maxPayloadSize'):
self.max_payload_size = int(int(service_config.get('maxPayloadSize')) * 80 / 100)
log.info("Service configuration was successfully retrieved and applied.")
log.info("Current limits: %r", service_config)
self.rate_limits_received = True
def set_server_side_rpc_request_handler(self, handler):
"""Set the callback that will be called when a server-side RPC is received."""
self.__device_on_server_side_rpc_response = handler
def _wait_for_rate_limit_released(self, timeout, message_rate_limit, dp_rate_limit=None, amount=1):
start_time = int(monotonic())
dp_rate_limit_timeout = dp_rate_limit.get_minimal_timeout() if dp_rate_limit is not None else 0
timeout = max(message_rate_limit.get_minimal_timeout(), dp_rate_limit_timeout, timeout) + 10
timeout_updated = False
disconnected = False
limit_reached_check = True
log_posted = False
waited = False
while limit_reached_check:
limit_reached_check = (message_rate_limit.check_limit_reached()
or (dp_rate_limit is not None and dp_rate_limit.check_limit_reached(amount=amount))
or not self.is_connected())
if timeout < limit_reached_check:
timeout = limit_reached_check
if not timeout_updated and limit_reached_check:
timeout += 10
timeout_updated = True
if self.stopped:
return TBPublishInfo(paho.MQTTMessageInfo(None))
if not disconnected and not self.is_connected():
log.warning("Waiting for connection to be established before sending data to ThingsBoard!")
disconnected = True
timeout = max(timeout, 180) + 10
if int(monotonic()) >= timeout + start_time:
log.warning("Timeout while waiting for rate limit for %i seconds to be released!", limit_reached_check)
return TBPublishInfo(paho.MQTTMessageInfo(None))
if not log_posted and limit_reached_check:
if isinstance(limit_reached_check, int):
log.warning("Rate limit reached for %i seconds, waiting for rate limit to be released...",
limit_reached_check)
waited = True
else:
log.debug("Waiting for rate limit to be released...")
log_posted = True
sleep(.01)
if waited:
log.debug("Rate limit released, sending data to ThingsBoard...")
def wait_until_current_queued_messages_processed(self):
previous_notification_time = 0
current_out_messages = len(self._client._out_messages) * 2
inflight_messages = self._client._max_inflight_messages or 5
if current_out_messages > 0:
while current_out_messages >= inflight_messages and not self.stopped:
current_out_messages = len(self._client._out_messages)
if int(monotonic()) - previous_notification_time > 5 and current_out_messages > inflight_messages:
log.debug("Waiting for messages to be processed by paho client, current queue size - %r, max inflight messages: %r",
current_out_messages, inflight_messages)
previous_notification_time = int(monotonic())
sleep(.001)
def _send_request(self, _type, kwargs, timeout=DEFAULT_TIMEOUT, device=None,
msg_rate_limit=None, dp_rate_limit=None):
if msg_rate_limit is None:
if kwargs.get('topic') == TELEMETRY_TOPIC:
msg_rate_limit = self._telemetry_rate_limit
else:
msg_rate_limit = self._messages_rate_limit
if dp_rate_limit is None:
if kwargs.get('topic') == TELEMETRY_TOPIC:
dp_rate_limit = self._telemetry_dp_rate_limit
else:
dp_rate_limit = self.EMPTY_RATE_LIMIT
if msg_rate_limit.has_limit() or dp_rate_limit.has_limit():
msg_rate_limit.increase_rate_limit_counter()
is_reached = self._wait_for_rate_limit_released(timeout, msg_rate_limit, dp_rate_limit)
if is_reached:
return is_reached
if _type == TBSendMethod.PUBLISH:
self.__add_metadata_to_data_dict_from_device(kwargs["payload"])
return self.__send_publish_with_limitations(kwargs, timeout, device, msg_rate_limit, dp_rate_limit)
elif _type == TBSendMethod.SUBSCRIBE:
return self._client.subscribe(**kwargs)
elif _type == TBSendMethod.UNSUBSCRIBE:
return self._client.unsubscribe(**kwargs)
def __add_metadata_to_data_dict_from_device(self, data):
if isinstance(data, dict) and "metadata" in data:
data["metadata"]["publishedTs"] = int(timestamp() * 1000)
elif isinstance(data, list):
current_time = int(timestamp() * 1000)
for data_item in data:
if isinstance(data_item, dict):
if 'ts' in data_item and 'metadata' in data_item:
data_item["metadata"]["publishedTs"] = current_time
elif isinstance(data, dict):
for key, value in data.items():
self.__add_metadata_to_data_dict_from_device(value)
def __get_rate_limits_by_topic(self, topic, device=None, msg_rate_limit=None, dp_rate_limit=None):
if device is not None:
return msg_rate_limit, dp_rate_limit
else:
if topic == TELEMETRY_TOPIC:
return self._telemetry_rate_limit, self._telemetry_dp_rate_limit
else:
return self._messages_rate_limit, None
def __send_publish_with_limitations(self, kwargs, timeout, device=None, msg_rate_limit: RateLimit = None,
dp_rate_limit: RateLimit = None):
data = kwargs.get("payload")
if isinstance(data, str):
data = loads(data)
topic = kwargs.get("topic", '')
attributes_format = topic.endswith('attributes')
if topic.endswith('telemetry') or attributes_format:
if device is None or data.get(device) is None:
device_split_messages = self._split_message(data, dp_rate_limit.get_minimal_limit(), self.max_payload_size)
if attributes_format:
split_messages = [{'message': msg_data, 'datapoints': len(msg_data)} for split_message in device_split_messages for msg_data in split_message['data']]
else:
split_messages = [{'message': split_message['data'], 'datapoints': split_message['datapoints']} for split_message in device_split_messages]
else:
device_data = data.get(device)
device_split_messages = self._split_message(device_data, dp_rate_limit.get_minimal_limit(), self.max_payload_size)
if attributes_format:
split_messages = [{'message': {device: msg_data}, 'datapoints': len(msg_data)} for split_message in device_split_messages for msg_data in split_message['data']]
else:
split_messages = [{'message': {device: split_message['data']}, 'datapoints': split_message['datapoints']} for split_message in device_split_messages]
else:
split_messages = [{'message': data, 'datapoints': self._count_datapoints_in_message(data, device)}]
results = []
for part in split_messages:
if not part:
continue
dp_rate_limit.increase_rate_limit_counter(part['datapoints'])
rate_limited = self._wait_for_rate_limit_released(timeout,
message_rate_limit=msg_rate_limit,
dp_rate_limit=dp_rate_limit,
amount=part['datapoints'])
if rate_limited:
return rate_limited
msg_rate_limit.increase_rate_limit_counter()
kwargs["payload"] = dumps(part['message'])
self.wait_until_current_queued_messages_processed()
if not self.stopped:
if device is not None:
log.debug("Device: %s, Sending message to topic: %s ", device, topic)
if part['datapoints'] > 0:
log.debug("Sending message with %i datapoints", part['datapoints'])
log.debug("Message payload: %r", kwargs["payload"])
log.debug("Rate limits after sending message: %r", msg_rate_limit.__dict__)
log.debug("Data points rate limits after sending message: %r", dp_rate_limit.__dict__)
else:
log.debug("Sending message with %r", kwargs["payload"])
log.debug("Message payload: %r", kwargs["payload"])
log.debug("Rate limits after sending message: %r", msg_rate_limit.__dict__)
log.debug("Data points rate limits after sending message: %r", dp_rate_limit.__dict__)
results.append(self._client.publish(**kwargs))
return TBPublishInfo(results)
def _subscribe_to_topic(self, topic, qos=None, timeout=DEFAULT_TIMEOUT):
if qos is None:
qos = self.quality_of_service
waiting_for_connection_message_time = 0
while not self.is_connected() and not self.stopped:
if self.stopped:
return TBPublishInfo(paho.MQTTMessageInfo(None))
if monotonic() - waiting_for_connection_message_time > 10.0:
log.warning("Waiting for connection to be established before subscribing for data on ThingsBoard!")
waiting_for_connection_message_time = monotonic()
sleep(0.01)
return self._send_request(TBSendMethod.SUBSCRIBE, {"topic": topic, "qos": qos}, timeout, msg_rate_limit=self._messages_rate_limit)
def _publish_data(self, data, topic, qos, timeout=DEFAULT_TIMEOUT, device=None,
msg_rate_limit=None, dp_rate_limit=None):
if qos is None:
qos = self.quality_of_service
if qos not in (0, 1):
log.exception("Quality of service (qos) value must be 0 or 1")
raise TBQoSException("Quality of service (qos) value must be 0 or 1")
waiting_for_connection_message_time = 0.0
while not self.is_connected():
if self.stopped:
return TBPublishInfo(paho.MQTTMessageInfo(None))
if monotonic() - waiting_for_connection_message_time > 10.0:
log.warning("Waiting for connection to be established before sending data to ThingsBoard!")
waiting_for_connection_message_time = monotonic()
sleep(0.01)
return self._send_request(TBSendMethod.PUBLISH, {"topic": topic, "payload": data, "qos": qos}, timeout,
device=device, msg_rate_limit=msg_rate_limit, dp_rate_limit=dp_rate_limit)
def send_telemetry(self, telemetry, quality_of_service=None, wait_for_publish=True):
"""Send telemetry to ThingsBoard. The telemetry can be a single dictionary or a list of dictionaries."""
quality_of_service = quality_of_service if quality_of_service is not None else self.quality_of_service
if not isinstance(telemetry, list) and not (isinstance(telemetry, dict) and telemetry.get("ts") is not None):
telemetry = [telemetry]
return self._publish_data(telemetry, TELEMETRY_TOPIC, quality_of_service, wait_for_publish)
def send_attributes(self, attributes, quality_of_service=None, wait_for_publish=True):
"""Send attributes to ThingsBoard. The attributes can be a single dictionary or a list of dictionaries."""
quality_of_service = quality_of_service if quality_of_service is not None else self.quality_of_service
return self._publish_data(attributes, ATTRIBUTES_TOPIC, quality_of_service, wait_for_publish)
def unsubscribe_from_attribute(self, subscription_id):
"""Unsubscribe from attribute updates for subscription_id."""
with self._lock:
for attribute in self.__device_sub_dict:
if self.__device_sub_dict[attribute].get(subscription_id):
del self.__device_sub_dict[attribute][subscription_id]
log.debug("Unsubscribed from %s, subscription id %i", attribute, subscription_id)
if subscription_id == '*':
self.__device_sub_dict = {}
self.__device_sub_dict = dict((k, v) for k, v in self.__device_sub_dict.items() if v)
def clean_device_sub_dict(self):
self.__device_sub_dict = {}
def subscribe_to_all_attributes(self, callback):
"""Subscribe to all attribute updates. The callback will be called when an attribute update is received."""
return self.subscribe_to_attribute("*", callback)
def subscribe_to_attribute(self, key, callback):
"""Subscribe to attribute updates for attribute with key.
The callback will be called when an attribute update is received."""
with self._lock:
self.__device_max_sub_id += 1
if key not in self.__device_sub_dict:
self.__device_sub_dict.update({key: {self.__device_max_sub_id: callback}})
else:
self.__device_sub_dict[key].update({self.__device_max_sub_id: callback})
log.debug("Subscribed to %s with id %i", key, self.__device_max_sub_id)
return self.__device_max_sub_id
def request_attributes(self, client_keys=None, shared_keys=None, callback=None):
"""Request attributes from ThingsBoard. The callback will be called when the response is received."""
msg = {}
if client_keys:
tmp = ""
for key in client_keys:
tmp += key + ","
tmp = tmp[:len(tmp) - 1]
msg.update({"clientKeys": tmp})
if shared_keys:
tmp = ""
for key in shared_keys:
tmp += key + ","
tmp = tmp[:len(tmp) - 1]
msg.update({"sharedKeys": tmp})
start_processing_attribute_request = int(monotonic())
attr_request_number = self._add_attr_request_callback(callback)
info = self._publish_data(msg, ATTRIBUTES_TOPIC_REQUEST + str(attr_request_number), self.quality_of_service)
self.__attrs_request_timeout[attr_request_number] = start_processing_attribute_request + 20
return info
def _add_attr_request_callback(self, callback):
with self._lock:
self.__attr_request_number += 1
self._attr_request_dict.update({self.__attr_request_number: callback})
attr_request_number = self.__attr_request_number
return attr_request_number
def __timeout_check(self):
while not self.stopped:
current_time = int(monotonic())
for (attr_request_number, ts) in tuple(self.__attrs_request_timeout.items()):
if current_time < ts:
continue
with self._lock:
callback = None
if self._attr_request_dict.get(attr_request_number):
callback = self._attr_request_dict.pop(attr_request_number)
if callback is not None:
if isinstance(callback, tuple):
callback[0](None, TBTimeoutException("Timeout while waiting for a reply for attribute request from ThingsBoard!"),
callback[1])
else:
callback(None, TBTimeoutException("Timeout while waiting for a reply for attribute request from ThingsBoard!"))
self.__attrs_request_timeout.pop(attr_request_number)
sleep(0.1)
def claim(self, secret_key, duration=30000):
"""Claim the device in Thingsboard. The duration is in milliseconds."""
claiming_request = {
"secretKey": secret_key,
"durationMs": duration
}
info = self._publish_data(claiming_request, CLAIMING_TOPIC, self.quality_of_service)
return info
@staticmethod
def _count_datapoints_in_message(data, device=None):
datapoints = 0
if device is not None:
if isinstance(data.get(device), list):
for data_object in data[device]:
datapoints += TBDeviceMqttClient._count_datapoints_in_message(data_object) # noqa
elif isinstance(data.get(device), dict):
datapoints += TBDeviceMqttClient._count_datapoints_in_message(data.get(device, data.get('device')))
else:
datapoints += 1
else:
if isinstance(data, dict):
datapoints += TBDeviceMqttClient._get_data_points_from_message(data)
elif isinstance(data, list):