-
Notifications
You must be signed in to change notification settings - Fork 2
/
__init__.py
2396 lines (2060 loc) · 107 KB
/
__init__.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
#!/usr/bin/env python3
# vim: set encoding=utf-8 tabstop=4 softtabstop=4 shiftwidth=4 expandtab
#########################################################################
# Copyright 2022- Michael Wenzel wenzel_michael(a)web.de
# Stefan Hauf stefan.hauf(a)gmail.com
# Christian Cordes info(a)pol3cat.de
#########################################################################
# This file is part of SmartHomeNG.
# https://www.smarthomeNG.de
# https://knx-user-forum.de/forum/supportforen/smarthome-py
#
# This plugin connect NSPanel (with tasmota) to SmartHomeNG
#
# SmartHomeNG is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# SmartHomeNG is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with SmartHomeNG. If not, see <http://www.gnu.org/licenses/>.
#
#########################################################################
import colorsys
import math
import os
import queue
import sys
from datetime import datetime, timedelta
import yaml
from lib.item import Items
from lib.model.mqttplugin import MqttPlugin
from lib.shtime import Shtime
from . import nspanel_icons_colors
from .webif import WebInterface
Icons = nspanel_icons_colors.IconsSelector()
Colors = nspanel_icons_colors.ColorThemes()
class NSPanel(MqttPlugin):
"""
Main class of the Plugin. Does all plugin specific stuff and provides
the update functions for the items
"""
TEMP_SENSOR = ['ANALOG', 'ESP32']
TEMP_SENSOR_KEYS = {'Temperature1': 'item_temp_analog', 'Temperature': 'item_temp_esp32'}
PLUGIN_VERSION = '1.0.0'
def __init__(self, sh):
"""
Initializes the plugin.
"""
# Call init code of parent class (MqttPlugin)
super().__init__()
if not self._init_complete:
return
self.shtime = Shtime.get_instance()
self.items = Items.get_instance()
# get the parameters for the plugin (as defined in metadata plugin.yaml):
try:
self.webif_pagelength = self.get_parameter_value('webif_pagelength')
self.tasmota_topic = self.get_parameter_value('topic')
self.telemetry_period = self.get_parameter_value('telemetry_period')
self.config_file_location = self.get_parameter_value('config_file_location')
self.full_topic = self.get_parameter_value('full_topic').lower()
self.desired_panel_model = self.get_parameter_value('model')
self.firmware_check = self.get_parameter_value('firmware_check')
self.brightness = self.get_parameter_value('brightness')
self.temperatureUnit = self.get_parameter_value('temperatureUnit')
self.defaultBackgroundColor = self.get_parameter_value('defaultBackgroundColor')
self.defaultColor = self.get_parameter_value('defaultColor')
self.defaultOffColor = self.get_parameter_value('defaultOffColor')
self.defaultOnColor = self.get_parameter_value('defaultOnColor')
# TODO check if colors are valid otherwise use existing
pass
except KeyError as e:
self.logger.critical(
"Plugin '{}': Inconsistent plugin (invalid metadata definition: {} not defined)".format(
self.get_shortname(), e))
self._init_complete = False
return
# create full_topic
if self.full_topic.find('%prefix%') == -1 or self.full_topic.find('%topic%') == -1:
self.full_topic = '%prefix%/%topic%/'
if self.full_topic[-1] != '/':
self.full_topic += '/'
# define properties
self.current_page = 1
self.panel_status = {'online': False, 'online_timeout': datetime.now(), 'uptime': '-', 'sensors': {},
'relay': {}, 'screensaver_active': False}
self.custom_msg_queue = queue.Queue(maxsize=50) # Queue containing last 50 messages containing "CustomRecv"
self.panel_items = {}
self.panel_config_items = []
self.panel_config_items_page = {}
self.berry_driver_version = 0
self.display_firmware_version = 0
self.panel_model = ''
self.alive = None
self.lastPayload = []
# define desired versions
self.desired_berry_driver_version = 8
self.display_driver_update = True
self.desired_display_firmware_version = 48
self.desired_version = "v3.8.3"
self.display_display_update = True
# URLs for display updates
if self.desired_panel_model == "us-l":
# us landscape version
self.desired_display_firmware_url = f"http://nspanel.pky.eu/lovelace-ui/github/nspanel-us-l-{self.desired_version}.tft"
elif self.desired_panel_model == "us-p":
# us portrait version
self.desired_display_firmware_url = f"http://nspanel.pky.eu/lovelace-ui/github/nspanel-us-p-{self.desired_version}.tft"
else:
# eu version
self.desired_display_firmware_url = f"http://nspanel.pky.eu/lovelace-ui/github/nspanel-{self.desired_version}.tft"
# URL for berry driver update
self.desired_berry_driver_url = "https://raw.githubusercontent.com/joBr99/nspanel-lovelace-ui/main/tasmota/autoexec.be"
# read panel config file
try:
self.panel_config = self._parse_config_file()
except Exception as e:
self.logger.warning(f"Exception during parsing of page config yaml file occurred: {e}")
self._init_complete = False
return
# link items from config to method 'update_item'
self.get_items_of_panel_config_to_update_item()
# read locale file
try:
self.locale = self._parse_locale_file()
except Exception as e:
self.logger.warning(f"Exception during parsing of locals yaml file occurred: {e}")
self._init_complete = False
return
# Add subscription to get device LWT
self.add_tasmota_subscription('tele', self.tasmota_topic, 'LWT', 'bool', bool_values=['Offline', 'Online'],
callback=self.on_mqtt_lwt_message)
# Add subscription to get device actions results
self.add_tasmota_subscription('tele', self.tasmota_topic, 'STATE', 'dict', callback=self.on_mqtt_message)
self.add_tasmota_subscription('tele', self.tasmota_topic, 'SENSOR', 'dict', callback=self.on_mqtt_message)
self.add_tasmota_subscription('tele', self.tasmota_topic, 'RESULT', 'dict', callback=self.on_mqtt_message)
self.add_tasmota_subscription('stat', self.tasmota_topic, 'RESULT', 'dict', callback=self.on_mqtt_message)
self.add_tasmota_subscription('stat', self.tasmota_topic, 'POWER1', 'num', callback=self.on_mqtt_power_message)
self.add_tasmota_subscription('stat', self.tasmota_topic, 'POWER2', 'num', callback=self.on_mqtt_power_message)
# init WebIF
self.init_webinterface(WebInterface)
return
def run(self):
"""
Run method for the plugin
"""
self.logger.debug("Run method called")
self.logger.debug("Check if items from config are available")
for itemname in self.panel_config_items:
item = self.items.return_item(itemname)
if item is None:
self.logger.error(f"{itemname} is not a valid item. Check configuration")
# TODO more action necessary?
# start subscription to all topics
self.start_subscriptions()
# set plugin alive
self.alive = True
def stop(self):
"""
Stop method for the plugin
"""
self.logger.debug("Stop method called")
self.alive = False
# stop subscription to all topics
self.stop_subscriptions()
# remove scheduler
self._remove_scheduler()
def parse_item(self, item):
"""
Default plugin parse_item method. Is called when the plugin is initialized.
The plugin can, corresponding to its attribute keywords, decide what to do with
the item in the future, like adding it to an internal array for future reference
:param item: The item to process.
:return: If the plugin needs to be informed of an items change you should return a call back function
like the function update_item down below. An example when this is needed is the knx plugin
where parse_item returns the update_item function when the attribute knx_send is found.
This means that when the items value is about to be updated, the call back function is called
with the item, caller, source and dest as arguments and in case of the knx plugin the value
can be sent to the knx with a knx write function within the knx plugin.
"""
if self.has_iattr(item.conf, 'nspanel_attr'):
nspanel_attr = self.get_iattr_value(item.conf, 'nspanel_attr')
self.logger.info(f"Item={item.id()} identified for NSPanel with nspanel_attr={nspanel_attr}")
if nspanel_attr:
nspanel_attr = nspanel_attr.lower()
else:
return
# fill panel_items dict / used for web interface
self.panel_items[f'item_{nspanel_attr}'] = item
if nspanel_attr[:5] == 'relay':
return self.update_item
if nspanel_attr[:11] == 'screensaver':
return self.update_item
# register screensaver update items
if self.has_iattr(item.conf, 'nspanel_update'):
return self.update_item
# search for notify items
if self.has_iattr(item.conf, 'nspanel_popup'):
nspanel_popup = self.get_iattr_value(item.conf, 'nspanel_popup')
self.logger.info(f"parsing item: {item.id()} with nspanel_popup={nspanel_popup}")
return self.update_item
if item.property.path in self.panel_config_items:
return self.update_item
return None
def parse_logic(self, logic):
"""
Default plugin parse_logic method
"""
if 'xxx' in logic.conf:
# self.function(logic['name'])
self.logger.waring('logic not implemented')
pass
def update_item(self, item, caller=None, source=None, dest=None):
"""
Item has been updated
This method is called, if the value of an item has been updated by SmartHomeNG.
It should write the changed value out to the device (hardware/interface) that
is managed by this plugin
:param item: item to be updated towards the plugin
:param caller: if given it represents the callers name
:param source: if given it represents the source
:param dest: if given it represents the dest
"""
if self.alive and caller != self.get_shortname():
# code to execute if the plugin is not stopped
# and only, if the item has not been changed by this plugin:
# stop if only update and no change
if abs(item.property.last_change_age - item.property.last_update_age) > 0.01:
self.logger.debug(
f"update_item was called with item {item.property.path} - no change")
return
self.logger.debug(
f"update_item was called with item {item.property.path} from caller {caller}, source {source} and dest {dest}")
if self.has_iattr(item.conf, 'nspanel_attr'):
nspanel_attr = self.get_iattr_value(item.conf, 'nspanel_attr')
if nspanel_attr[:5] == 'relay':
value = item()
# check data type
if not isinstance(value, bool):
return
if value is not None:
relay = nspanel_attr[5:]
self.publish_tasmota_topic('cmnd', self.tasmota_topic, f"POWER{relay}", value, item,
bool_values=['OFF', 'ON'])
# Update screensaver, if active
if self.has_iattr(item.conf, 'nspanel_update') and self.panel_status['screensaver_active']:
nspanel_update = self.get_iattr_value(item.conf, 'nspanel_update')
if nspanel_update == 'weather':
self.HandleScreensaverWeatherUpdate()
if nspanel_update == 'status':
self.HandleScreensaverIconUpdate()
if nspanel_update == 'time':
self.send_current_time()
elif self.has_iattr(item.conf, 'nspanel_popup'):
nspanel_popup = self.get_iattr_value(item.conf, 'nspanel_popup')
if nspanel_popup[:6] == 'notify':
item_value = item()
if isinstance(item_value, dict):
if nspanel_popup[6:] == '_screensaver':
self.SendToPanel(self.GenerateScreensaverNotify(item_value))
else:
self.SendToPanel(self.GeneratePopupNotify(item_value))
else:
self.logger.warning(f"{item.id} must be a dict")
elif self.get_iattr_value(item.conf, 'nspanel_popup') == 'timer':
entities = self.panel_config[self.current_page]['entities']
entity_name = next(
(entity['entity'] for entity in entities if entity.get('item', '') == item.property.path), None)
if entity_name is not None:
self.SendToPanel(self.GenerateDetailTimer(entity_name))
elif not self.panel_status['screensaver_active']:
if item.property.path in self.panel_config_items_page[self.current_page]:
self.GeneratePage(self.current_page)
else:
self.logger.debug(f"item not on current_page = {self.current_page}")
else:
self.logger.debug(f"screensaver active")
pass
################################
# CallBacks
################################
def on_mqtt_lwt_message(self, topic: str, payload: bool, qos: int = None, retain: bool = None) -> None:
"""
Callback function to handle received lwt messages
:param topic: MQTT topic
:param payload: MQTT message payload
:param qos: qos for this message (optional)
:param retain: retain flag for this message (optional)
"""
try:
(topic_type, tasmota_topic, info_topic) = topic.split('/')
self.logger.info(
f"Received LWT Message for {tasmota_topic} with payload={payload}, qos={qos} and retain={retain}")
except Exception as e:
self.logger.error(f"received topic {topic} is not in correct format. Error was: {e}")
else:
if payload:
self.panel_status['online_timeout'] = datetime.now() + timedelta(seconds=self.telemetry_period + 5)
self.panel_status['online'] = payload
self._set_item_value('item_online', payload)
self._add_scheduler()
self.publish_tasmota_topic('cmnd', self.tasmota_topic, 'GetDriverVersion', 'x')
self.SendToPanel('pageType~pageStartup')
# set telemetry to get the latest STATE and SENSOR information
self._set_telemetry_period(self.telemetry_period)
else:
self._set_device_offline()
def on_mqtt_message(self, topic: str, payload: dict, qos: int = None, retain: bool = None) -> None:
"""
Callback function to handle received messages
:param topic: MQTT topic
:param payload: MQTT message payload
:param qos: qos for this message (optional)
:param retain: retain flag for this message (optional)
"""
# tele/NSPanel1/STATE = {"Time":"2022-12-03T13:16:26","Uptime":"0T00:25:13","UptimeSec":1513,"Heap":127,"SleepMode":"Dynamic","Sleep":0,"LoadAvg":999,"MqttCount":1,"Berry":{"HeapUsed":14,"Objects":218},"POWER1":"ON","POWER2":"OFF","Wifi":{"AP":1,"SSId":"FritzBox","BSSId":"F0:B0:14:4A:08:CD","Channel":1,"Mode":"11n","RSSI":42,"Signal":-79,"LinkCount":1,"Downtime":"0T00:00:07"}}
# tele/NSPanel1/SENSOR = {"Time":"2022-12-03T13:16:26","ANALOG":{"Temperature1":27.4},"ESP32":{"Temperature":37.8},"TempUnit":"C"}
#: topic_type = tele, tasmota_topic = NSPanel1, info_topic = RESULT, payload = {'CustomRecv': 'event,startup,45,eu'}
try:
(topic_type, tasmota_topic, info_topic) = topic.split('/')
self.logger.debug(
f"on_mqtt_message: topic_type={topic_type}, tasmota_topic={tasmota_topic}, info_topic={info_topic}, payload={payload}, qos={qos} and retain={retain}")
except Exception as e:
self.logger.error(f"received topic {topic} is not in correct format. Error was: {e}")
else:
# handle message
if isinstance(payload, dict) and info_topic in ['STATE', 'RESULT']:
# Handling of Driver Version
if 'nlui_driver_version' in payload:
self.logger.info(f"Received Message decoded as driver version message.")
self.berry_driver_version = payload['nlui_driver_version']
# Handling of TelePeriod
if 'TelePeriod' in payload:
self.logger.info(f"Received Message decoded as teleperiod message.")
self._handle_teleperiod(payload['TelePeriod'])
# Handling of CustomRecv messages
elif 'CustomRecv' in payload:
self.logger.info(
f"Received Message decoded as NSPanel Message, will be put to queue for logging reasons. {self.custom_msg_queue.qsize() + 1} messages logged.")
self.custom_msg_queue.put(payload['CustomRecv'])
self.HandlePanelMessage(payload['CustomRecv'])
# Handling of Power messages
elif any(item.startswith("POWER") for item in payload.keys()):
self.logger.info(f"Received Message decoded as power message.")
self._handle_power(payload)
# Handling of Wi-Fi
if 'Wifi' in payload:
self.logger.info(f"Received Message contains Wifi information.")
self._handle_wifi(payload['Wifi'])
# Handling of Uptime
if 'Uptime' in payload:
self.logger.info(f"Received Message contains Uptime information.")
self._handle_uptime(payload['Uptime'])
elif isinstance(payload, dict) and info_topic == 'SENSOR':
self.logger.info(f"Received Message contains sensor information.")
self._handle_sensor(payload)
else:
self.logger.warning(f"Received Message '{payload}' not handled within plugin.")
# setting new online-timeout
self.panel_status['online_timeout'] = datetime.now() + timedelta(seconds=self.telemetry_period + 5)
def on_mqtt_power_message(self, topic: str, payload: dict, qos: int = None, retain: bool = None) -> None:
"""
Callback function to handle received messages
:param topic: MQTT topic
:param payload: MQTT message payload
:param qos: qos for this message (optional)
:param retain: retain flag for this message (optional)
"""
try:
(topic_type, tasmota_topic, info_topic) = topic.split('/')
self.logger.info(
f"on_mqtt_power_message: topic_type={topic_type}, tasmota_topic={tasmota_topic}, info_topic={info_topic}, payload={payload}, qos={qos} and retain={retain}")
except Exception as e:
self.logger.error(f"received topic {topic} is not in correct format. Error was: {e}")
else:
if info_topic.startswith('POWER'):
tasmota_relay = str(info_topic[5:])
tasmota_relay = '1' if not tasmota_relay else None
item_relay = f'item_relay{tasmota_relay}'
self._set_item_value(item_relay, payload == 'ON')
self.panel_status['relay'][info_topic] = payload
################################
# MQTT Stuff
################################
def publish_tasmota_topic(self, prefix: str = 'cmnd', topic: str = None, detail: str = None, payload: any = None,
item=None, qos: int = None, retain: bool = False, bool_values: list = None) -> None:
"""
build the topic in Tasmota style and publish to mqtt
:param prefix: prefix of topic to publish
:param topic: unique part of topic to publish
:param detail: detail of topic to publish
:param payload: payload to publish
:param item: item (if relevant)
:param qos: qos for this message (optional)
:param retain: retain flag for this message (optional)
:param bool_values: bool values (for publishing this topic, optional)
"""
topic = topic if topic is not None else self.tasmota_topic
detail = detail if detail is not None else 'CustomSend'
tpc = self.full_topic.replace("%prefix%", prefix)
tpc = tpc.replace("%topic%", topic)
tpc += detail
# self.logger.debug(f"publish_topic with tpc={tpc}, payload={payload}")
self.publish_topic(tpc, payload, item, qos, retain, bool_values)
def add_tasmota_subscription(self, prefix: str, topic: str, detail: str, payload_type: str,
bool_values: list = None, callback=None) -> None:
"""
build the topic in Tasmota style and add the subscription to mqtt
:param prefix: prefix of topic to subscribe to
:param topic: unique part of topic to subscribe to
:param detail: detail of topic to subscribe to
:param payload_type: payload type of the topic (for this subscription to the topic)
:param bool_values: bool values (for this subscription to the topic)
:param callback: a plugin can provide an own callback function, if special handling of the payload is needed
"""
tpc = self.full_topic.replace("%prefix%", prefix)
tpc = tpc.replace("%topic%", topic)
tpc += detail
self.add_subscription(tpc, payload_type, bool_values=bool_values, callback=callback)
################################
# Tasmota Stuff
################################
def _set_item_value(self, itemtype: str, value) -> None:
"""
Sets item value
:param itemtype: itemtype to be set
:param value: value to be set
"""
if itemtype in self.panel_items:
# get item to be set
item = self.panel_items[itemtype]
# set item value
self.logger.info(
f"{self.tasmota_topic}: Item '{item.id()}' via itemtype '{itemtype}' set to value '{value}'.")
item(value, self.get_shortname())
else:
self.logger.debug(
f"{self.tasmota_topic}: No item for itemtype '{itemtype}' defined to set to '{value}'.")
def _set_device_offline(self):
self._set_item_value('item_online', False)
self.logger.info(
f"{self.tasmota_topic} is not online any more - online_timeout={self.panel_status['online_timeout']}, now={datetime.now()}")
# clean data to show correct status
self.panel_status['online_timeout'] = datetime.now()
self.panel_status['online'] = False
self.panel_status['screensaver_active'] = False
self.panel_status['uptime'] = '-'
self.panel_status['wifi_signal'] = 0
self.panel_status['sensors'].clear()
self.panel_status['relay'].clear()
self._remove_scheduler()
def _check_online_status(self):
"""
checks all tasmota topics, if last message is with telemetry period. If not set tasmota_topic offline
"""
self.logger.info(f"_check_online_status: Checking online status of {self.tasmota_topic}")
if self.panel_status.get('online') is True and self.panel_status.get('online_timeout'):
if self.panel_status['online_timeout'] < datetime.now():
self._set_device_offline()
else:
self.logger.debug(f'_check_online_status: Checking online status of {self.tasmota_topic} successful')
def _set_telemetry_period(self, telemetry_period: int) -> None:
"""
sets telemetry period for given topic
"""
self.logger.info(f"run: Setting telemetry period to {telemetry_period} seconds")
self.publish_tasmota_topic('cmnd', self.tasmota_topic, 'teleperiod', telemetry_period)
def _handle_wifi(self, payload: dict) -> None:
"""
Extracts Wi-Fi information out of payload and updates plugin dict
:param payload: MQTT message payload
"""
self.logger.debug(f"_handle_wifi: received payload={payload}")
wifi_signal = payload.get('Signal')
if wifi_signal:
if isinstance(wifi_signal, str) and wifi_signal.isdigit():
wifi_signal = int(wifi_signal)
self.panel_status['wifi_signal'] = wifi_signal
self._set_item_value('item_wifi_signal', wifi_signal)
def _handle_teleperiod(self, teleperiod: dict) -> None:
self.panel_status['teleperiod'] = teleperiod
if teleperiod != self.telemetry_period:
self._set_telemetry_period(self.telemetry_period)
def _handle_uptime(self, uptime: str) -> None:
self.logger.debug(f"Received Message contains Uptime information. uptime={uptime}")
self.panel_status['uptime'] = uptime
self._set_item_value('item_uptime', uptime)
def _handle_power(self, payload: dict) -> None:
"""
Extracts Power information out of payload and updates plugin dict
:param payload: MQTT message payload
"""
# payload = {"Time": "2022-11-21T12:56:34", "Uptime": "0T00:00:11", "UptimeSec": 11, "Heap": 27, "SleepMode": "Dynamic", "Sleep": 50, "LoadAvg": 19, "MqttCount": 0, "POWER1": "OFF", "POWER2": "OFF", "POWER3": "OFF", "POWER4": "OFF", "Wifi": {"AP": 1, "SSId": "WLAN-Access", "BSSId": "38:10:D5:15:87:69", "Channel": 1, "Mode": "11n", "RSSI": 82, "Signal": -59, "LinkCount": 1, "Downtime": "0T00:00:03"}}
power_dict = {key: val for key, val in payload.items() if key.startswith('POWER')}
self.panel_status['relay'].update(power_dict)
for power in power_dict:
relay_index = 1 if len(power) == 5 else str(power[5:])
item_relay = f'item_relay{relay_index}'
self._set_item_value(item_relay, power_dict[power])
def _handle_sensor(self, payload: dict) -> None:
"""
:param payload:
:return:
"""
# tele / NSPanel1 / SENSOR = {"Time": "2022-12-03T13:21:26", "ANALOG": {"Temperature1": 28.0}, "ESP32": {"Temperature": 38.9}, "TempUnit": "C"}
for sensor in self.TEMP_SENSOR:
data = payload.get(sensor)
if data and isinstance(data, dict):
self.logger.info(f"Received Message decoded as {sensor} Sensor message.")
if sensor not in self.panel_status['sensors']:
self.panel_status['sensors'][sensor] = {}
for key in self.TEMP_SENSOR_KEYS:
if key in data:
self.panel_status['sensors'][sensor][key.lower()] = data[key]
self._set_item_value(self.TEMP_SENSOR_KEYS[key], data[key])
################################
# NSPage Stuff
################################
def _add_scheduler(self):
"""
add scheduler for cyclic time and date update
"""
self.logger.debug('Add scheduler for cyclic updates of time and date')
dt = self.shtime.now() + timedelta(seconds=20)
self.scheduler_add('update_time', self.send_current_time, next=dt, cycle=60)
self.scheduler_add('update_date', self.send_current_date, cron='1 0 0 * * *', next=dt)
self.logger.debug(f"Add scheduler for online_status")
dt = self.shtime.now() + timedelta(seconds=(self.telemetry_period - 3))
self.scheduler_add('check_online_status', self._check_online_status, cycle=self.telemetry_period, next=dt)
def _remove_scheduler(self):
"""
remove scheduler for cyclic time and date update
"""
self.logger.debug('Remove scheduler for cyclic updates of time and date')
self.scheduler_remove('update_time')
self.scheduler_remove('update_date')
self.logger.debug('Remove scheduler for online status')
self.scheduler_remove('check_online_status')
def _parse_config_file(self):
"""
Parse the page config file and check for completeness
"""
with open(self.config_file_location, 'r') as stream:
try:
config = yaml.safe_load(stream)
except yaml.YAMLError as exc:
self.logger.warning(f"Exception during parsing of page config yaml file occurred: {exc}")
return None
# ToDo: Für alle Pages die Anzahl der Entities prüfen
# ToDo: Für alle Pages die Konfig auf Vollständigkeit prüfen
self.logger.debug(f"_parse_config_file: page-config={config} available!")
return config
def _parse_locale_file(self):
"""
Parse the locals file and check for completeness
"""
with open(os.path.join(sys.path[0], "plugins", self.get_shortname(), "locale.yaml"), "r") as stream:
try:
locale_dict = yaml.safe_load(stream)
except yaml.YAMLError as exc:
self.logger.warning(f"Exception during parsing of locale yaml file occurred: {exc}")
return None
self.logger.debug(f"_parse_locale_file: locale={locale_dict} available!")
return locale_dict
def get_items_of_panel_config_to_update_item(self):
"""
Put all item out of config file to update_item
"""
for idx, card in enumerate(self.panel_config):
self.panel_config_items_page[idx] = []
temp = []
entities = card.get('entities')
if entities is not None:
for entity in entities:
item = entity.get('item', None)
# Add all possible items without check, parse_item is only called for valid items
if item is not None and item != '' and item not in temp:
temp.append(item)
if item not in self.panel_config_items:
self.panel_config_items.append(item)
for element in card:
if element[:4] == 'item':
item = card.get(element, None)
if item is not None and item != '' and item not in temp:
temp.append(item)
if item not in self.panel_config_items:
self.panel_config_items.append(item)
self.panel_config_items_page[idx] = temp
def _next_page(self):
"""
return next_page number
"""
self.current_page += 1
if self.current_page >= len(self.panel_config):
self.current_page -= len(self.panel_config)
self.logger.debug(f"next_page={self.current_page}")
def _previous_page(self):
"""
return previous_page number
"""
self.current_page -= 1
if self.current_page < 1:
self.current_page += len(self.panel_config)
self.logger.debug(f"previous_page={self.current_page}")
def _get_locale(self, group, entry):
return self.locale.get(group, {}).get(entry, {}).get('de-DE') # TODO configure in plugin.yaml
def send_current_time(self):
secondLineItem = self.panel_config[0].get('itemSecondLine', '')
secondLine = self.items.return_item(secondLineItem)()
if secondLine is None:
secondLine = ''
timeFormat = self.panel_config[0].get('timeFormat', "%H:%M")
self.publish_tasmota_topic(payload=f"time~{self.shtime.now().strftime(timeFormat)}~{secondLine}")
def send_current_date(self):
dateFormat = self.panel_config[0].get('dateFormat', "%A, %-d. %B %Y")
# replace some variables to get localized strings
dateFormat = dateFormat.replace('%A',
self.shtime.weekday_name()) # TODO add code after merge in main repository .replace('%B', self.shtime.current_monthname())
self.publish_tasmota_topic(payload=f"date~{self.shtime.now().strftime(dateFormat)}")
def send_screensavertimeout(self):
screensavertimeout = self.panel_config[0].get('timeout', 10)
self.publish_tasmota_topic(payload=f"timeout~{screensavertimeout}")
def send_panel_brightness(self):
brightness_screensaver = self.panel_config[0].get('brightness', 10)
brightness_active = self.brightness
dbc = Colors.GetColor(self.defaultBackgroundColor)
# same value for both values will break sleep timer of the firmware # comment from HA code
if brightness_screensaver == brightness_active:
brightness_screensaver = brightness_screensaver - 1
self.publish_tasmota_topic(payload=f"dimmode~{brightness_screensaver}~{brightness_active}~{dbc}")
def HandlePanelMessage(self, payload: str) -> None:
"""
# general
event,buttonPress2,pageName,bNext
event,buttonPress2,pageName,bPrev
event,buttonPress2,pageName,bExit,number_of_taps
event,buttonPress2,pageName,sleepReached
# startup page
event,startup,version,model
# screensaver page
event,buttonPress2,screensaver,exit - Touch Event on Screensaver
event,screensaverOpen - Screensaver has opened
# cardEntities Page
event,*eventName*,*entityName*,*actionName*,*optionalValue*
event,buttonPress2,item,up
event,buttonPress2,item,down
event,buttonPress2,item,stop
event,buttonPress2,item,OnOff,1
event,buttonPress2,item,button
# popupLight Page
event,pageOpenDetail,popupLight,item
event,buttonPress2,item,OnOff,1
event,buttonPress2,item,brightnessSlider,50
event,buttonPress2,item,colorTempSlider,50
event,buttonPress2,item,colorWheel,x|y|wh
# popupShutter Page
event,pageOpenDetail,popupShutter,item
event,buttonPress2,item,positionSlider,50
# popupNotify Page
event,buttonPress2,*internalName*,notifyAction,yes
event,buttonPress2,*internalName*,notifyAction,no
# cardThermo Page
event,buttonPress2,*entityName*,tempUpd,*temperature*
event,buttonPress2,*entityName*,hvac_action,*hvac_action*
# cardMedia Page
event,buttonPress2,item,media-back
event,buttonPress2,item,media-pause
event,buttonPress2,item,media-next
event,buttonPress2,item,volumeSlider,75
# cardAlarm Page
event,buttonPress2,item,actionName,code
"""
try:
content_list = payload.split(',')
except Exception as e:
self.logger.warning(f"During handling of payload exception occurred: {e}")
return None
self.logger.debug(
f"HandlePanelMessage: content_list={content_list}, length of content_list={len(content_list)}")
typ = content_list[0]
method = content_list[1]
words = content_list
if typ == 'event':
if method == 'startup':
self.display_firmware_version = words[2]
self.panel_model = words[3]
self.send_screensavertimeout()
self.send_panel_brightness()
if self.firmware_check == 'notify':
# Check driver version
if int(self.berry_driver_version) < self.desired_berry_driver_version:
self.logger.warning(
f"Update of Tasmota Driver needed! installed: {self.berry_driver_version} required: {self.desired_berry_driver_version}")
if self.display_driver_update:
update_message = {
"entity": "driverUpdate",
"heading": "Driver Update available!",
"text": ("There's an update available for the Tasmota\r\n"
"Berry driver, do you want to start the update\r\n"
"now?\r\n"
"If you encounter issues after the update or\r\n"
"this message appears frequently, please check\r\n"
"the manual and repeat the installation steps\r\n"
"for the Tasmota Berry driver."
),
"buttonLeft": "Dismiss",
"buttonRight": "Update",
"timeout": 0,
}
self.SendToPanel(self.GeneratePopupNotify(update_message))
self.display_driver_update = False
# Check panel model
elif self.panel_model != self.desired_panel_model:
self.logger.warning(
f"Update of Display Firmware needed! installed: {self.panel_model} configured: {self.desired_panel_model}")
if self.display_display_update:
update_message = {
"entity": "displayUpdate",
"heading": "Display Update available!",
"text": ("The configured model does not match to the\r\n"
"installed firmware. Possible solutions:\r\n"
f"- Set model to '{self.panel_model}' in configuration\r\n"
"- Update the correct display firmware\r\n"
"If the update fails check the installation manu-\r\n"
"al and flash again over the Tasmota console\r\n"
"Be patient, the update will take a while.\r\n"
),
"buttonLeft": "Dismiss",
"buttonRight": "Update",
"timeout": 0,
}
self.SendToPanel(self.GeneratePopupNotify(update_message))
# Check display firmware version
elif int(self.display_firmware_version) < self.desired_display_firmware_version:
self.logger.warning(
f"Update of Display Firmware needed! installed: {self.display_firmware_version} required: {self.desired_display_firmware_version}")
if self.display_display_update:
update_message = {
"entity": "displayUpdate",
"heading": "Display Update available!",
"text": ("There's a firmware update available for the\r\n"
"Nextion screen of the NSPanel. Do you want to\r\n"
"start the update now?\r\n"
"If the update fails check the installation manu-\r\n"
"al and flash again over the Tasmota console\r\n"
"Be patient, the update will take a while."
),
"buttonLeft": "Dismiss",
"buttonRight": "Update",
"timeout": 0,
}
self.SendToPanel(self.GeneratePopupNotify(update_message))
self.display_display_update = False
else:
# Normal startup
self.HandleScreensaver()
else:
# startup without check
self.HandleScreensaver()
elif method == 'sleepReached':
# event,sleepReached,cardEntities
self.HandleScreensaver()
elif method == 'pageOpenDetail':
# event,pageOpenDetail,popupLight,entity
self.GenerateDetailPage(words[2], words[3])
elif method == 'buttonPress2':
self.HandleButtonEvent(words)
elif method == 'button1':
self.HandleHardwareButton(method)
elif method == 'button2':
self.HandleHardwareButton(method)
def HandleScreensaver(self):
self.panel_status['screensaver_active'] = True
self._set_item_value('item_screensaver_active', self.panel_status['screensaver_active'])
self.current_page = 1
self.lastPayload = [""]
screensaver = self.panel_config[0].get('pageType', 'screensaver')
self.publish_tasmota_topic(payload=f"pageType~{screensaver}")
self.send_current_time()
self.send_current_date()
self.HandleScreensaverIconUpdate()
self.HandleScreensaverWeatherUpdate()
def get_status_icons(self) -> str:
self.logger.debug("get_status_icons called")
screensaver = self.panel_config[0]
iconLeft = self.items.return_item(screensaver.get('statusIconLeft', None))()
iconRight = self.items.return_item(screensaver.get('statusIconRight', None))()
iconSize = screensaver.get('statusIconBig', True)
if iconSize:
iconSize = 1
else:
iconSize = ''
# Left Icon
icon1 = ''
icon1Color = 'White'
if isinstance(iconLeft, dict):
icon1 = Icons.GetIcon(iconLeft.get('icon', ''))
icon1Color = Colors.GetColor(iconLeft.get('color', 'White'))
# Right Icon
icon2 = ''
icon2Color = 'White'
if isinstance(iconRight, dict):
icon2 = Icons.GetIcon(iconRight.get('icon', ''))
icon2Color = Colors.GetColor(iconRight.get('color', 'White'))
icon1Font = iconSize
icon2Font = iconSize
return f"{icon1}~{icon1Color}~{icon2}~{icon2Color}~{icon1Font}~{icon2Font}"
def HandleScreensaverIconUpdate(self):
self.logger.info('Function HandleScreensaverIconUpdate')
status_icons = self.get_status_icons()
self.publish_tasmota_topic(payload=f"statusUpdate~{status_icons}")
def getWeatherIcon(self, weathercondition):
"""Get weather icon from weather data."""
weatherMapping = {
'clear_night': 'weather-night',
'cloudy': 'weather-cloudy',
'exceptional': 'alert-circle-outline',
'fog': 'weather-fog',
'hail': 'weather-hail',
'lightning': 'weather-lightning',
'lightning_rainy': 'weather-lightning-rainy',
'partlycloudy': 'weather-partly-cloudy',
'pouring': 'weather-pouring',
'rainy': 'weather-rainy',
'snowy': 'weather-snowy',
'snowy_rainy': 'weather-snowy-rainy',
'sunny': 'weather-sunny',
'windy': 'weather-windy',
'windy_variant': 'weather-windy-variant'
}
self.logger.debug(f"getWeatherIcon called with weathercondition={weathercondition}")
return Icons.GetIcon(weatherMapping.get(weathercondition, "-"))
def getItemValue(self, itemname):
item = self.items.return_item(itemname)
if item is not None:
return item()
else:
return itemname
def HandleScreensaverWeatherUpdate(self):
self.logger.info('Function HandleScreensaverWeatherUpdate')
screensaver_config = self.panel_config[0]
entities = screensaver_config.get('entities', {})
if entities:
pageData = f"weatherUpdate~"
alternativeData = ""
maxEntities = 5
if screensaver_config.get('pageType', 'screensaver') == 'screensaver2':
maxEntities = 15
for idx, entity in enumerate(entities):
if idx >= maxEntities:
break
heading = self.getItemValue(entity.get('heading', ''))
item = self.getItemValue(entity.get('item', ''))
icon = self.getItemValue(entity.get('icon', ''))