-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathapp.py
1161 lines (992 loc) · 42 KB
/
app.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
# -*- coding: utf-8 -*-
#
# @file app.py
# Author : Bernd Waldmann
# Created : Sun Oct 27 23:01:35 2019
# This Revision: $Id: app.py 1685 2024-11-27 11:19:02Z $
#
# Tracker for MySensors messages, with web viewer
#
# Copyright (C) 2019,2021 Bernd Waldmann
#
# This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
# If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/
#
# SPDX-License-Identifier: MPL-2.0
#
# adjust these constants to your environment
# in the author's setup, the topic is 'my/N/stat/...' where N is number of the gateway
MQTT_BROKER = "ha-server" # the name of your MQTT broker
MQTT_TOPIC = "my/+/stat/#" # the topic to subscribe to, includes wildcards
MQTT_PATTERN = r'my\/\w+\/stat\/(.+)' # regular expression to extract the interesting part of topic
DATABASE_FILE = 'mysensors.db'
DB_DIR = '/var/lib/mytracker/'
REVISION = '$Id: app.py 1685 2024-11-27 11:19:02Z $'
import sys,re,time,os
import math, json
import logging
import logging.config
from datetime import datetime,timedelta
import paho.mqtt.client as mqtt # EPL 1.0 or EDPL 1.0
from peewee import * # MIT license
import flask # BSD license
from flask import Flask,render_template,request,url_for,redirect
from playhouse.flask_utils import FlaskDB
from playhouse.hybrid import hybrid_property
from playhouse.flask_utils import object_list
from playhouse.migrate import *
from playhouse.reflection import Introspector
import wtforms as wtf # BSD license
import mysensors
##############################################################################
#region Logging
def init_logging():
logging.config.dictConfig({
'version': 1,
'formatters': {
'default': {
'format': '[%(asctime)s] %(levelname)s in %(module)s: %(message)s',
},
'brief': {
'format': '%(levelname)s in %(module)s: %(message)s',
}
},
'handlers': {
'wsgi': {
'class': 'logging.StreamHandler',
'stream': 'ext://flask.logging.wsgi_errors_stream',
'formatter': 'default'
},
'console': {
'class': 'logging.StreamHandler',
'stream': 'ext://sys.stderr',
'formatter': 'default',
},
},
'loggers': {
'root': {
'level': logging.INFO,
'handlers': ['wsgi','console']
},
'app': {
'level': logging.INFO,
'handlers': ['console'],
},
},
'disable_existing_loggers': False,
})
return logging.getLogger('app')
applog = init_logging()
#endregion
if not os.path.isdir(DB_DIR):
DB_DIR = os.path.dirname(os.path.realpath(__file__))
DATABASE_URI = 'sqlite:///%s' % os.path.join(DB_DIR, DATABASE_FILE)
applog.info('Using database at '+DB_DIR)
app = Flask(__name__)
app.config['FLASK_ENV'] = 'development'
app.config['DEBUG'] = True
app.config['TESTING'] = True
##############################################################################
#region Model helpers
def make_usid(nid,cid):
"""calculate globally unique sensor id from node id and child id
Args:
nid (int): MySensors node id
cid (int): MySensors child id
Returns:
int: unique id
"""
return 1000*nid + cid
##----------------------------------------------------------------------------
def split_usid(usid):
nid = usid // 1000
cid = usid % 1000
return (nid,cid)
##----------------------------------------------------------------------------
def make_uvid(nid,cid,typ):
"""calculate globally unique value id from node id, child id, message type
Args:
nid (int): MySensors node id
cid (int): MySensors child id
typ (int): MySensors type id
Returns:
int: unique id
"""
return 1000000 *typ + 1000*nid + cid
#endregion
##############################################################################
#region Model definition
db = SqliteDatabase(None)
class BaseModel(Model):
class Meta:
database = db
class Node(BaseModel):
""" table describing MySensor nodes
"""
nid = IntegerField( primary_key=True, help_text="MySensors node id") # e.g. '109'
sk_name = CharField( max_length=25, null=True, help_text="sketch name") # e.g. 'MyWindowSensor'
sk_version = CharField( max_length=25, null=True, help_text="sketch version") # e.g. '$Rev: 1685 $'
sk_revision = IntegerField( default=0, help_text="sketch SVN rev")
api_ver = CharField( max_length=25, null=True, help_text="MySensors API version") # e.g. '2.3.1'
lastseen = DateTimeField( default=datetime.now, help_text="last message" )
location = CharField( max_length=32, null=True, help_text="where in the house is it?")
bat_changed = DateField( null=True, help_text="date of last battery change")
bat_level = IntegerField(null=True, help_text="battery level in %")
parent = IntegerField(null=True, help_text="parent node Id")
arc = IntegerField(null=True, help_text="ARC success rate")
class Sensor(BaseModel):
""" table describing MySensor sensors,
Each row is one sensor on one node, as reported in present() calls in presentation() function
"""
usid = IntegerField( primary_key=True, help_text="unique id")
nid = ForeignKeyField(Node)
cid = IntegerField( help_text="MySensors child id") # e.g. '11' (contact)
typ = IntegerField( null=True, help_text="MySensors sensor type") # e.g. '0'=S_DOOR
name = CharField( max_length=25, null=True, help_text="sensor description") # e.g. "Contact L"
values = BigBitField( null=True, help_text="which V_xxx types have been seen")
lastseen = DateTimeField( default=datetime.now, help_text="last message" )
class ValueType(BaseModel):
""" table describing a sensor sub-channel, as reported by type=V_xxx messages
Each row is one V_xxx value type sent by one sensor on one node
"""
uvid = IntegerField( primary_key=True, help_text="unique channel id" )
usid = ForeignKeyField(Sensor)
nid = ForeignKeyField(Node, backref='tvalues')
cid = IntegerField( help_text="MySensors child id") # e.g. '11' (contact)
typ = IntegerField( help_text="MySensors value type") # e.g. '2'=V_STATUS
value = CharField( max_length=25, null=True, help_text="Current value")
received = DateTimeField( default=datetime.now, help_text="timestamp" )
@hybrid_property
def timestamp(self):
return self.received.to_timestamp()
class Message(BaseModel):
""" table for all information contained in one MySensors message, as reported by gateway.
Each row is one message received via gateway
"""
nid = ForeignKeyField(Node)
cid = IntegerField( help_text="MySensors child id" ) # e.g. '11' (contact)
cmd = IntegerField( help_text="MySensors command")
typ = IntegerField( help_text="MySensors type")
payload = CharField( max_length=25)
received = DateTimeField(default=datetime.now, help_text="timestamp" )
@hybrid_property
def usid(self):
return make_usid(self.nid.nid, self.cid)
@hybrid_property
def value(self):
return self.payload
@hybrid_property
def timestamp(self):
return self.received.to_timestamp()
#endregion
##############################################################################
#region Model access
#
def add_or_select_node(nid):
"""make sure node record exists, create if necessary
Args:
nid (int): MySensors node ID
Returns:
Node: instance
"""
node, create = Node.get_or_create(nid=nid)
return node
##----------------------------------------------------------------------------
def add_or_select_sensor(nid,cid):
"""make sure sensor record exists, create if necessary
Args:
nid (int): node id
cid (int): child id
Returns:
Sensor: instance
"""
sensor, create = Sensor.get_or_create(
usid=make_usid(nid,cid),
defaults={'nid':nid, 'cid':cid}
)
return sensor
##----------------------------------------------------------------------------
def add_or_select_tvalue(nid,cid,typ,val=None,dt=None):
"""make sure TypedValue record exists, create if necessary
Args:
nid (int): node id
cid (int): child id
typ (int): type V_xxx constant
val (str): value string or None
dt (datetime): timestamp or None
Returns:
ValueType: instance
"""
tvalue, create = ValueType.get_or_create(
uvid=make_uvid(nid,cid,typ),
defaults={'nid':nid, 'cid':cid, 'typ':typ, 'usid':make_usid(nid,cid) }
)
if val is not None:
tvalue.value = val
if dt is not None:
tvalue.received = dt
return tvalue
##----------------------------------------------------------------------------
def fill_tvalues():
""" migrate older DB version by filling ValueType table from Message table
"""
query = Sensor.select().order_by(Sensor.usid)
for s in query:
for typ in range(64):
if s.values.is_set(typ):
try:
msg = Message.select().where(
Message.nid == s.nid,
Message.cid == s.cid,
Message.cmd == mysensors.Commands.C_SET,
Message.typ == typ
).order_by(Message.received.desc()).get()
tvalue = add_or_select_tvalue(
s.nid_id,
s.cid,typ,
msg.payload,
msg.received )
tvalue.save()
applog.debug("added tvalue uvid:%d nid:%d cid:%d typ:%d = '%s'",
tvalue.uvid, s.nid_id, s.cid, typ, msg.payload )
except Message.DoesNotExist:
pass
##----------------------------------------------------------------------------
def new_battery( nid, date=datetime.today()):
""" declare that new battery has been inserted
Args:
nid (int): MySensors node ID
date (datetime.date): date of battery change
"""
node = add_or_select_node(nid)
node.bat_changed = date
node.save()
##----------------------------------------------------------------------------
def delete_node( nid ):
""" delete a node, and all table rows that refer to it
Args:
nid (int): MySensors node ID
"""
with db.atomic() as txn:
applog.debug("Deleting node {0}".format(nid))
n = Message.delete().where(Message.nid==nid).execute()
applog.debug("{0} messages removed".format(n))
n = ValueType.delete().where(ValueType.nid==nid).execute()
applog.debug("{0} types removed".format(n))
n = Sensor.delete().where(Sensor.nid==nid).execute()
applog.debug("{0} sensors removed".format(n))
n = Node.delete().where(Node.nid==nid).execute()
applog.debug("{0} nodes removed".format(n))
##----------------------------------------------------------------------------
def delete_node_requests( nid ):
""" delete all request messages for this node
Args:
nid (int): MySensors node ID
"""
with db.atomic() as txn:
applog.debug("Deleting node requests {0}".format(nid))
n = Message.delete().where( (Message.nid==nid) & (Message.cmd == mysensors.Commands.C_REQ) ).execute()
applog.debug("{0} request messages removed".format(n))
##----------------------------------------------------------------------------
def delete_sensor( nid, cid ):
""" delete a sensor, and all table rows that refer to it
Args:
nid (int): MySensors node ID
cid (int): MySensors child ID
"""
usid = make_usid(nid,cid)
with db.atomic() as txn:
applog.debug("Deleting node {0} sensor {1}".format( nid, cid ))
n = Message.delete().where( (Message.nid==nid) & (Message.cid==cid) ).execute()
applog.debug("{0} messages removed".format(n))
n = ValueType.delete().where(ValueType.usid==usid).execute()
applog.debug("{0} types removed".format(n))
n = Sensor.delete().where(Sensor.usid==usid).execute()
applog.debug("{0} sensors removed".format(n))
##----------------------------------------------------------------------------
def delete_old_stuff( ndays ):
""" delete everything older than `ndays` days
Args:
ndays (int): no of days to keep
"""
cutoff = (datetime.today()-timedelta(days=ndays)).timestamp()
applog.info("Deleting everything older than {0} days".format(ndays))
n = ValueType.delete().where( ValueType.timestamp < cutoff ).execute()
applog.debug("{0} values removed".format(n))
n = Message.delete().where( Message.timestamp < cutoff ).execute()
applog.debug("{0} messages removed".format(n))
#endregion
##############################################################################
#region MQTT message handling
def add_message( nid,cid,cmd,typ,pay ):
""" add a record to 'messages' table
Args:
nid (int): MySensors node ID
cid (int): MySensors child ID
cmd (int): MySensors C_xxx command
typ (int): MySensors I_xxx type
pay (string): payload
"""
tnow = datetime.now()
node = add_or_select_node(nid)
node.lastseen = tnow
node.save()
sensor = add_or_select_sensor(nid,cid)
sensor.lastseen = tnow
sensor.save()
msg = Message.create(nid=nid,cid=cid,cmd=cmd,typ=typ,payload=pay)
msg.save()
##----------------------------------------------------------------------------
def on_parent_message( nid,val ):
""" update parent field for a node
Args:
nid (int): MySensors node ID
val (string): payload
"""
node = add_or_select_node(nid) # make sure node exists
parent = int(val[8:].strip())
node.parent = parent
node.save()
applog.debug("on_parent_message( nid:%d parent:%d'", nid,parent)
##----------------------------------------------------------------------------
def on_arc_message( nid,val ):
""" update arc field for a node
Args:
nid (int): MySensors node ID
val (string): payload like '{P:5460,R:3638,S:60}'
"""
applog.info("on_arc_message( nid:%d ARC:'%s'", nid,val)
node = add_or_select_node(nid) # make sure node exists
# convert "pseudo-JSON" like '{P:5460,R:3638,S:60}' to real JSON like '{"P":5460","R":3638","S":60}'
nojs = val
nojs=nojs.replace('{','{"')
nojs=nojs.replace(':','":')
nojs=nojs.replace(',',',"')
try:
js = json.loads(nojs)
success = js["S"]
node.arc = success
node.save()
applog.info("ARC success: %d%%", success)
except:
applog.warn("error in ARC message: '%s'", val)
pass
##----------------------------------------------------------------------------
def on_value_message( nid,cid,typ,val ):
""" add a record to 'values' table, for a sensor
Args:
nid (int): MySensors node ID
cid (int): MySensors child ID
typ (int): MySensors I_xxx type
val (string): payload
"""
valname = mysensors.value_names.get(typ,"?")
node = add_or_select_node(nid) # make sure node exists
sensor = add_or_select_sensor(nid,cid) # make sure sensor exists
if typ >= 0:
sensor.values.set_bit(typ)
sensor.save()
tvalue = add_or_select_tvalue(nid,cid,typ,val,datetime.now())
tvalue.save()
# my convention: message sensor=98, type=47 is a report on parent node
if (cid==98 and typ==47 and val.startswith('parent:')):
on_parent_message(nid,val)
# my convention: message sensor=98, type=28 (V_VAR5) is a report on ARC statistics,
if (cid==98 and typ==28):
on_arc_message(nid,val)
applog.debug("on_value_message( nid:%d cid:%d typ:%d (%s) = '%s'", nid,cid,typ,valname,val)
##----------------------------------------------------------------------------
def on_node_value_message( nid,typ,val ):
""" add a record to 'values' table, for sensor==255, i.e. node itself
Args:
nid (int): MySensors node ID
typ (int): MySensors I_xxx type
val (string): payload
"""
valname = mysensors.value_names.get(typ,"?")
applog.debug("on_node_value_message( nid:%d typ:%d (%s) = '%s'", nid,typ,valname,val)
on_value_message( nid, 255, typ, val )
##----------------------------------------------------------------------------
def on_internal_message( nid, cid, typ, val ):
"""handle INTERNAL messages
Args:
nid (int): MySensors node ID
cid (int): MySensors child ID
typ (int): MySensors I_xxx type
val (string): payload
"""
typname = mysensors.internal_names.get(typ,"?")
applog.debug("on_internal_message( nid:%d cid:%d typ:%d (%s) = '%s'", nid,cid,typ,typname,val)
node = add_or_select_node(nid)
# my/2/stat/123/255/3/0/11 bwWindowSensor
if (cid==255 and typ==mysensors.Internal.I_SKETCH_NAME):
node.sk_name = val
applog.debug("sk_name='%s'", val)
node.save()
# my/2/stat/123/255/3/0/12 $ Rev: 826 $ 11:34:24
# or
# my/2/stat/199/255/3/0/12 586
elif (cid==255 and typ==mysensors.Internal.I_SKETCH_VERSION):
node.sk_version = val
applog.debug("sk_version='%s'", val)
rev = 0
if val.strip().isdigit():
rev = int(val.strip())
else:
m = re.search(r"\$Rev: (\d+) *\$.*",val)
if (m):
rev = int(m.group(1))
node.sk_revision = rev
applog.debug("revision=%d", rev)
node.save()
elif (cid==255 and typ==mysensors.Internal.I_BATTERY_LEVEL):
on_node_value_message( nid, int(mysensors.Values.V_PERCENTAGE), val)
return
else:
return
##----------------------------------------------------------------------------
def on_presentation_message( nid, cid, typ, val ):
"""handle PRESENTATION messages for sensors
Args:
nid (int): MySensors node ID
cid (int): MySensors child ID
typ (int): MySensors I_xxx type
val (string): payload
"""
applog.debug("on_presentation_message( nid:%d cid:%d typ:%d = '%s'", nid,cid,typ,val)
node = add_or_select_node(nid)
sensor = add_or_select_sensor(nid,cid)
# my/2/stat/123/11/0/0/0 Contact L
# or
# my/2/stat/199/81/0/0/37 Gas flow&vol [ct,l,l/h]
if (cid!=255):
sensor.name = val
sensor.typ = typ
sensor.save()
##----------------------------------------------------------------------------
def on_node_presentation_message( nid, typ, val ):
"""handle PRESENTATION messages where cid==255
Args:
nid (int): MySensors node ID
typ (int): MySensors S_xxx type
val (string): payload
"""
applog.debug("on_node_presentation_message( nid:%d typ:%d = '%s'", nid,typ,val)
node = add_or_select_node(nid)
# my/2/stat/123/255/0/0/17 2.3.1
if (typ==mysensors.Sensors.S_ARDUINO_NODE or typ==mysensors.Sensors.S_ARDUINO_REPEATER_NODE):
node.api_ver = val # update node API version in payload
node.save()
##----------------------------------------------------------------------------
last_topic = ""
last_payload = ""
last_time = time.time()
def on_message(mqttc, userdata, msg):
"""MQTT callback function
Args:
mqttc (mqtt.Client): client object
userdata (n/a): n/a
msg (MQTTMessage): topic and payload
"""
# example my/3/stat/106/61/1/0/23 37
global last_topic, last_payload, last_time, applog
try:
payload = msg.payload.decode("utf-8")
now = time.time()
m = re.search(MQTT_PATTERN,msg.topic)
if m is None:
return
topic = m.group(1)
path = topic.split('/')
if (len(path) < 5):
return
# remove duplicates
isnew = (last_topic != topic) or (last_payload != payload) or ((now - last_time) > 1)
last_topic = topic
last_payload = payload
last_time = now
if not isnew: return
nid = int(path[0])
cid = int(path[1])
cmd = int(path[2])
typ = int(path[4])
val = msg.payload.decode("utf-8")
applog.debug("message nid:%d cid:%d cmd:%d typ:%d = '%s'",nid,cid,cmd,typ,val)
add_message(nid,cid,cmd,typ,val)
if (cmd==mysensors.Commands.C_SET and cid!=255):
on_value_message(nid,cid,typ,val)
elif (cmd==mysensors.Commands.C_SET and cid==255):
on_node_value_message(nid,typ,val)
elif (cmd==mysensors.Commands.C_PRESENTATION and cid!=255):
on_presentation_message(nid,cid,typ,val)
elif (cmd==mysensors.Commands.C_PRESENTATION and cid==255):
on_node_presentation_message(nid,typ,val)
elif (cmd==mysensors.Commands.C_INTERNAL):
on_internal_message(nid,cid,typ,val)
except Exception as err:
print("Error: " + str(err))
sys.exit(1)
raise
#endregion
##############################################################################
#region Routes
@app.route('/')
def index():
return render_template('index.html', rev=REVISION[1:-1])
##----------------------------------------------------------------------------
@app.route('/nodes')
def nodes():
sort = flask.request.args.get('sort', default="nid", type=str)
query = Node.select(Node,ValueType.value.alias('level')).join(
ValueType,
JOIN.LEFT_OUTER,
on=(
(Node.nid==ValueType.nid_id) &
(ValueType.cid==255) &
(ValueType.typ==3),
),
)
if (sort=="date"):
query = query.order_by(Node.lastseen.desc())
else:
query = query.order_by(Node.nid)
return object_list('nodes.html', query.objects(), sort=sort )
##----------------------------------------------------------------------------
@app.route('/sensors')
def sensors():
sort = flask.request.args.get('sort', default="usid", type=str)
cid = flask.request.args.get('cid', default=None, type=int)
nid = flask.request.args.get('nid', default=None, type=int)
query = Sensor.select().join(Node)
# sort as requested
if sort=="cid":
query = query.order_by(Sensor.cid)
elif sort=="date":
query = query.order_by(Sensor.lastseen.desc())
else:
query = query.order_by(Sensor.usid)
# filter by nid if requested
if nid is not None:
if nid >=0:
query = query.where(Sensor.nid==nid)
else:
query = query.where(Sensor.nid!=-nid)
return object_list( 'sensors.html', query, sort=sort, nid=nid, cid=cid )
##----------------------------------------------------------------------------
@app.route('/tvalues')
def tvalues():
# get parameters
sort = flask.request.args.get('sort', default="usid", type=str)
nid = flask.request.args.get('nid', default=None, type=str)
cid = flask.request.args.get('cid', default=None, type=str)
usid = flask.request.args.get('usid', default=None, type=str)
query = ValueType.select().join(Node).switch(ValueType).join(Sensor)
# sort as requested
if sort=="cid":
query = query.order_by(ValueType.cid)
elif sort=="date":
query = query.order_by(ValueType.received.desc())
else:
query = query.order_by(ValueType.usid)
# filter if requested
if usid is not None and len(usid)>0:
iusid = int(usid)
query = query.where(ValueType.usid==iusid)
elif nid is not None and len(nid)>0:
inid = int(nid)
if inid >=0:
query = query.where(ValueType.nid==inid)
else:
query = query.where(ValueType.nid!=-inid)
elif cid is not None and len(cid)>0:
icid = int(cid)
if (icid>=0):
query = query.where(ValueType.cid==icid)
else:
query = query.where(ValueType.cid!=-icid)
return object_list( 'types.html', query, sort=sort, nid=nid, cid=cid, usid=usid )
##----------------------------------------------------------------------------
@app.route('/values')
def values():
# get parameters
sort = flask.request.args.get('sort', default="usid", type=str)
nid = flask.request.args.get('nid', default=None, type=str)
cid = flask.request.args.get('cid', default=None, type=str)
usid = flask.request.args.get('usid', default=None, type=str)
query = Message.select().where(Message.cmd==mysensors.Commands.C_SET)
# sort as requested
if sort=="cid":
query = query.order_by(Message.cid)
elif sort=="date":
query = query.order_by(Message.received.desc())
else:
query = query.order_by(Message.nid, Message.cid)
# filter if requested
if usid is not None and len(usid)>0:
iusid = int(usid)
inid,icid = split_usid(iusid)
query = query.where( (Message.nid==inid) & (Message.cid==icid) )
elif nid is not None and len(nid)>0:
inid = int(nid)
if inid >=0:
query = query.where(Message.nid==inid)
else:
query = query.where(Message.nid!=-inid)
elif cid is not None and len(cid)>0:
icid = int(cid)
if (icid>=0):
query = query.where(Message.cid==icid)
else:
query = query.where(Message.cid!=-icid)
return object_list( 'values.html', query, sort=sort, nid=nid, cid=cid, usid=usid )
##----------------------------------------------------------------------------
@app.route('/messages')
def messages():
# get parameters
sort = flask.request.args.get('sort', default="usid", type=str)
cid = flask.request.args.get('cid', default=None, type=str)
nid = flask.request.args.get('nid', default=None, type=str)
usid = flask.request.args.get('usid', default=None, type=str)
# sort as requested
if sort=='nid':
query = Message.select().order_by(Message.nid)
elif sort=="cid":
query = Message.select().order_by(Message.cid)
elif sort=="cmd":
query = Message.select().order_by(Message.cmd)
elif sort=='typ':
query = Message.select().order_by(Message.typ)
else:
query = Message.select().order_by(Message.received.desc())
# filter if requested
if usid is not None and len(usid)>0:
iusid = int(usid)
query = query.where(Message.usid==iusid)
elif nid is not None and len(nid)>0:
inid = int(nid)
if inid >=0:
query = query.where(Message.nid==inid)
else:
query = query.where(Message.nid!=-inid)
elif cid is not None and len(cid)>0:
icid = int(cid)
if (icid>=0):
query = query.where(Message.cid==icid)
else:
query = query.where(Message.cid!=-icid)
return object_list( 'messages.html', query, sort=sort, nid=nid, cid=cid, usid=usid )
##----------------------------------------------------------------------------
@app.route('/newbattery', methods=['GET','POST'])
def battery_today():
if request.method=='POST':
print("POST: ")
print( request.form )
if 'today' in request.form:
nid = request.form['today']
print("Node {0} battery changed today".format(nid))
new_battery(int(nid))
elif request.method=='GET':
print("GET: ")
print (request )
return redirect(url_for('batteries'))
#endregion
##############################################################################
#region Jinja helpers
@app.context_processor
def my_processor():
def command_string(cmd):
"""look up C_symbolic name for command
Args:
cmd (int): MySensors command, see API doc
Returns:
string: symbolic name like C_PRESENTATION
"""
if cmd is None: return None
return mysensors.command_names.get(cmd)
def sensor_string(typ):
"""look up S_xxx symbolic name for sensor type <typ>
Args:
typ (int): MySensors sensor type, see API doc
Returns:
string: symbolic name like S_DOOR
"""
if typ is None: return None
return mysensors.sensor_names.get(typ)
def type_string(cmd,typ):
"""look up symbolic name for type (sensor or value, depending on command)
Args:
cmd (int): MySensors command
typ (int): MySensors type
Returns:
string: symbolic name like S_DOOR or V_STATUS
"""
if (cmd is None) or (typ is None): return None
if (cmd==mysensors.Commands.C_REQ) or (cmd==mysensors.Commands.C_SET):
return mysensors.value_names.get(typ)
elif (cmd==mysensors.Commands.C_PRESENTATION):
return mysensors.sensor_names.get(typ)
elif (cmd==mysensors.Commands.C_INTERNAL):
return mysensors.internal_names.get(typ)
else:
return None
def value_string(typ):
"""look up V_xxx symbolic name for value type
Args:
typ (int): MySensors value type, see API doc
Returns:
string: symbolic name like V_STATUS
"""
if typ is None: return None
return mysensors.value_names.get(typ)
def values_string(values: BigBitField):
"""return a list of symbolic names of values types sent by this sensor
Args:
values (BigBitField): bit 0 set if type 0 found, etc
Returns:
string: comma-separated list of symbolic names
"""
vnames = []
for i in range(64):
if values.is_set(i):
vname = mysensors.value_names.get(i)
if vname is not None:
vnames.append(vname)
return ", ".join(vnames)
def days_ago(dt: datetime):
"""calculate how many days ago a date was
Args:
dt (datetime): datestamp
Returns:
int: number of days in the past
"""
if dt is not None:
return math.floor((dt.now()-dt).total_seconds()/(60*60*24))
else:
return None
def months_ago(dt: datetime):
"""calculate how many months ago a date was
Args:
dt (datetime): datestamp
Returns:
int: number of months in the past
"""
if dt is not None:
return round( (datetime.today().date() - dt).total_seconds() / (60*60*24*30) )
else:
return None
return dict(
command_string=command_string,
sensor_string=sensor_string,
type_string=type_string,
value_string=value_string,
values_string=values_string,
days_ago=days_ago,
months_ago=months_ago,
)
#endregion
##############################################################################
#region Forms
class ConfirmDeleteNodeForm(wtf.Form):
f_nid = wtf.IntegerField("Node ID:", render_kw={"class":"edit edit-node"})
@app.route("/nodes/<int:nid>/delete", methods=['GET','POST'])
def confirm_delete_node(nid):
form = ConfirmDeleteNodeForm(request.form)
# if POST, then use data from form
if (request.method=='POST'):
print ("Delete node {0}".format(request.form['f_nid']))
delete_node(nid)
return redirect(url_for('nodes'))
# else if GET, then display form
form.f_nid.data = nid
return render_template('confirm_delete_node.html', form=form )
##----------------------------------------------------------------------------
class ConfirmDeleteSensorForm(wtf.Form):
f_nid = wtf.IntegerField("Node ID:", render_kw={"class":"edit edit-node"})
f_cid = wtf.IntegerField("Sensor ID:", render_kw={"class":"edit edit-node"})
@app.route("/sensors/<int:usid>/delete", methods=['GET','POST'])
def confirm_delete_sensor(usid):
nid,cid = split_usid(usid)
form = ConfirmDeleteSensorForm(request.form)
# if POST, then use data from form
if (request.method=='POST'):
print ("Delete node {0} sensor {1}".format( request.form['f_nid'], request.form['f_cid'] ))
delete_sensor(nid,cid)
return redirect(url_for('sensors'))
# else if GET, then display form
form.f_nid.data = nid
form.f_cid.data = cid
return render_template('confirm_delete_sensor.html', form=form )
##----------------------------------------------------------------------------
class ConfirmDeleteNodeRequestsForm(wtf.Form):
f_nid = wtf.IntegerField("Node ID:", render_kw={"class":"edit edit-node"})
@app.route("/nodes/<int:nid>/delete-requests", methods=['GET','POST'])
def confirm_delete_node_requests(nid):
form = ConfirmDeleteNodeRequestsForm(request.form)
# if POST, then use data from form
if (request.method=='POST'):
print ("Delete node {0} requests".format(request.form['f_nid']))
delete_node_requests(nid)
return redirect(url_for('nodes'))
# else if GET, then display form
form.f_nid.data = nid
return render_template('confirm_delete_node_req.html', form=form )
##----------------------------------------------------------------------------
class ConfirmDeleteOldForm(wtf.Form):
f_ndays = wtf.IntegerField("", render_kw={"class":"edit edit-node"})
@app.route("/messages/delete/<int:ndays>", methods=['GET','POST'])
def confirm_delete_old(ndays):
ndays = 365
form = ConfirmDeleteOldForm(request.form)
# if POST, then use data from form
if (request.method=='POST'):
ndays = int(request.form['f_ndays'])
print ("Delete records older than {0} days".format(ndays))
delete_old_stuff(ndays)
return redirect(url_for('nodes'))
# else if GET, then display form
form.f_ndays.data = ndays
return render_template('confirm_delete_old.html', form=form )
##----------------------------------------------------------------------------
class ConfirmNewBatteryForm(wtf.Form):
f_nid = wtf.IntegerField("Node ID:", render_kw={"class":"edit edit-node"})
f_bat = wtf.DateField("Date:", render_kw={"class":"edit edit-date"})