-
Notifications
You must be signed in to change notification settings - Fork 18
/
MyTTN_MQTT.py
1367 lines (1306 loc) · 63.5 KB
/
MyTTN_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
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# Contact Teus Hagen webmaster@behouddeparel.nl to report improvements and bugs
#
# Copyright (C) 2017, Behoud de Parel, Teus Hagen, the Netherlands
#
# This program 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.
#
# This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
#
# $Id: MyTTN_MQTT.py,v 2.11 2018/10/04 13:54:23 teus Exp teus $
# Broker between TTN and some data collectors: luftdaten.info map and MySQL DB
# module mqtt: git clone https://github.com/eclipse/paho.mqtt.python.git
# cd paho.mqtt.python ; python setup.py install
# broker server: Debian: apt-get install mqtt
""" Download measurements from TTN MQTTT server:
Subscribe to measurements from a Mosquitto Broker server
e.g.
Publish measurements as client to luftdaten.info and MySQL
One may need to change payload and TTN record format!
"""
modulename='$RCSfile: MyTTN_MQTT.py,v $'[10:-4]
__version__ = "0." + "$Revision: 2.11 $"[11:-2]
try:
import MyLogger
import dateutil.parser as dp
import datetime
import sys, os
import signal
import json
import socket
import re
from time import time, sleep, localtime
socket.setdefaulttimeout(60)
import paho.mqtt.client as mqtt
from struct import *
import base64
except ImportError as e:
print("One of the import modules not found: %s\n" % e)
exit(1)
waiting = False # waiting for telegram
mid = None # for logging: message ID
telegrams = [] # telegram buffer, max length is 100
ErrorCnt = 0 # connectivity error cnt, slows down, >20 reconnect, >40 abort
PingTimeout = 0 # last time ping request was sent
# TTN working command line example
# mosquitto_sub -v -h eu.thethings.network -p 1883 -u 20179215970128 -P 'ttn-account-v2.ZJvoRKh3kHsegybn_XhADOGEglqf6CGAChqLUJLrXA' -t '+/devices/+/up' -v
# configurable options
__options__ = [
'input', # output enables
'hostname','port', 'user','password', # MQTT server credentials
'dust', 'meteo'# classes field names coming from TTN MQTT server
# to do: should go as conf per device and needs type of sensor
'packing', # how it is packed, which sensor types
'classes', # map appl/device to class of sensor kit config
'sensors', # sensor module types for 'dust', 'meteo' ...
'all', # skip not registered and "inactive" nodes
'timeout', # timeout for no server active
'rate', # expected rate of telegrams received
'file', # data input json records from file iso MQTT server
'adminfile', # meta data for sensor kits (location, etc.)
]
Conf = {
'input': False,
'hostname': 'eu.thethings.network', # server host number for mqtt broker
'port': 1883, # default MQTT port
'user': 'account_name', 'password': 'ttn-account-v2.acacadabra',
# credentials to access broker
'qos' : 0, # dflt 0 (max 1 telegram), 1 (1 telegram), or 2 (more)
'cert' : None, # X.509 encryption
'project': 'XYZ', # default prefix to unique device/serial number
# + is a wild card in TTN
'topic': 'devices', # main topic
'AppId': '+', # to be fixed regular expression to accept AppId to subscribe to
'DevAddr': '+', # to be fixed regular expression to accept DevAddr numbers
'timeout': 2*60*60, # timeout for this broker
'rate': 7*60, # expected time(out) between telegrams published
# this will read from a dump MQTT file, can be defined from command line file=..
# 'file': 'Dumped.json', # uncomment this for operation from data from file
# TO DO: adminfile should go to database
# defines nodes, LoRa, firmware, classes, etc. for Configure info
# 'adminfile': 'LoPy-Admin.conf.json', # meta identy data for sensor kits
'nodes': {}, # DB of sensorkits info
# adminfile will define and overwrite:
# LoRa, nodes, sensors, classes, firmware, and translate
# 'test': True # use TTN record example in stead of server access
# DB dictionary with different sensors: type, producer, sensors/units
# should go to a json file
# key calibrations is optional
# types need to be capitalized
# group classification is not used yet
"LoRa": { # TO DO: create a row, one per threard
"project": "test",
"hostname": "eu.thethings.network",
"port": 1883,
"topic": "app id", # used as Conf['user'] TTN MQTT access
"account": "ttn-account-v2.acacadabra" # TTN password MQTT server
},
# the sensor products
# DB dictionary with different sensors: type, producer, sensors/units
# should go to a json adminfile To Do: put this in a DB
# types need to be capitalized
# group classification is not used yet
"sensors": [
{ "type":"unknown",
"producer":"unknown","group":"dust",
"fields":["pm1","pm25","pm10"],
"units":["ug/m3","ug/m3","ug/m3"],
"calibrations": [[0,1.0],[0,1.0]]},
{ "type":"SDS011",
"producer":"Nova","group":"dust",
"fields":["pm25","pm10"],
"units":["ug/m3","ug/m3"],
"calibrations": [[0,1.0],[0,1.0]]},
# Plantower standard ug/m3 measurements
{ "type":"PMS7003",
"producer":"Plantower","group":"dust",
"fields":["pm1","pm25","pm10"],
"units":["ug/m3","ug/m3","ug/m3"],
"calibrations": [None,[0,1.0],[0,1.0]]}, # None is [0,1.0]
# Plantower the atmosphere ug/m3 measurements
{ "type":"PMS7003_ATM",
"producer":"Plantower","group":"dust",
"fields":["pm1_atm","pm25_atm","pm10_atm"],
# "calibrations": [[0,1.0],[0,1.0],[0,1.0]],
"units":["ug/m3","ug/m3","ug/m3"]
},
# Plantower the count particulates measurements
{ "type":"PMS7003_PCS",
"producer":"Plantower","group":"dust",
"fields":["pm03_pcs","pm05_pcs","pm1_pcs","pm25_pcs","pm5_pcs","pm10_pcs"],
"units":["pcs/0.1dm3","pcs/0.1dm3","pcs/0.1dm3","pcs/0.1dm3","pcs/0.1dm3","pcs/0.1dm3"],
"calibrations": [[0,1.0],[0,1.0],[0,1.0],[0,1.0],[0,1.0],[0,1.0]]},
{ "type": "PPD42NS",
"producer":"Shiney","group":"dust",
"fields":["pm25","pm10"],
"units":["pcs/0.01qft","pcs/0.01qft"],
"calibrations": [[0,1.0],[0,1.0]]},
{ "type": "DC1100PRO",
"producer":"Dylos","group":"dust",
"fields":["pm25","pm10"],
"units":["pcs/0.01qft","pcs/0.01qft"],
"calibrations": [[0,1.0],[0,1.0]]},
{ "type": "unknown",
"producer":"unknown","group":"meteo",
"fields":["temp","rv"],"units":["C","%"],
"calibrations": [[0,1.0],[0,1.0]]},
{ "type": "DHT22",
"producer":"Adafruit","group":"meteo",
"fields":["temp","rv"],"units":["C","%"],
"calibrations": [[0,1.0],[0,1.0]]},
{ "type": "BME280",
"producer":"Bosch","group":"meteo",
"fields":["temp","rv","luchtdruk"],
"units":["C","%","hPa"],
"calibrations": [[0,1.0],[0,1.0],[0,1.0]]},
{ "type": "BME680",
"producer":"Bosch","group":"meteo",
"fields":["temp","rv","luchtdruk","gas", "aqi"],
"units":["C","%","hPa","kOhm","%"],
"calibrations": [[0,1],[0,1],[0,1],[0,1],[0,1]]},
{ "type": "TTN NODE",
"producer":"TTN","group":"LoRa",
"fields":["battery","light","temp"],
"units":["mV","lux","C"],
"calibrations": [[0,1.0],[0,1.0],[0,1.0]]},
{ "type": "TTN EVENT",
"producer":"TTN","group":"LoRa",
"fields":["event"],
"units": ["id"],"calibrations": [None]},
{ "type": "GPS",
"producer":"Grove","group":"GPS",
"fields":["longitude","latitude","altitude"],
"units": ["degrees","degrees","m"],
"calibrations": [[0,1],[0,1],[0,1]]},
{ "type": "PYCOM",
"producer": "ESP", "group":"controller",
"fields":["time"], "units":["sec"],"calibrations":[None]},
{ "type": "MYSENSE",
"producer": "BdP", "group": "IoS",
"fields": ["version","meteo","dust"],
"units": ["nr","type","type"],
"calibrations": [None,None,None]},
# not yet activated
{ "type":"ToDo",
"producer":"Spect", "group":"gas",
"fields":["NO2","CO2","O3","NH3"],
"units":["ppm","ppm","ppm","ppm"],
"calibrations": [[0,1.0],[0,1.0],[0,1.0],[0,1.0]]}
],
# if only as payload in packed format
# To Do: use reg exp, classID gives pointer to payload for a device
'classes': [
{ 'classID': 'VW2017', 'regexp': 'pmsensor/pmsensor\d+(/\d)?', },
{ "classID": "TTNnode", "regexp": "201801275971az/2018[0-9a-zA-Z]+/[1-4]"},
{ "classID": "LoPyNode", "regexp": "201802215971az/lopyprototype2018[0-9]{4}"},
],
# To Do: create a handle from application/device to device config
# AppId eui, Dev eui and fport define the algorithm firmware to be used
# should be in json admin file To Do: put this in a DB
# To Do: add packing per length of bytes:
# [ {'length': nr bytes, "packing": ">HH", "adjust":[[...]], "fields":[]}
# To Do: check all referrals
"firmware": [
{
"id": "VW2017", # size of payload as ident
"port2": {
"packing": ">HHHH", # how it is packed, here 4 X unsigned int16/short
"adjust": [[0,0.1],[0,0.1],[-20,0.1],[0,0.1]], # unpack algorithm
"fields": ["pm25","pm10","temp","rv"], # fields
"sensors": ["SDS011","DHT22"] # use upper cased names
}
},
{
"id": "TTNnode", # size of payload as ident
"port2": {
"packing": ">HHH",# how it is packed, here 4 X unsigned int16/short
"fields": ["battery","light","temp"], # fields
"adjust": [[0,1],[0,1],[0,0.01]], # unpack algorithm
"sensors": ["TTN node","TTN node","TTN node"] # use upper cased names
},
# ports may be used as just an event iso 1 byte value
"port3": { "packing": ">B", "fields": ["interval"], "adjust": [[0,1]] },
"port4": { "packing": ">B", "fields": ["motion"], "adjust": [[0,1]] },
"port5": { "packing": ">B", "fields": ["button"], "adjust": [[0,1]] }
},
{
"id": "LoPyNode",
"port2": {
# To Do: add HHH if gps is added
# [">HHHHHHHHl",">HHHHHHHHllll"]
"packing": ">HHHHHHHHl",
# + "longitude","latitude","altitude"
"fields": ["pm1","pm25","pm10","temperature","humidity","pressure","gas","aqi","time"],
# + [0,0.000001],[0,0.000001],[0,0.1]
"adjust": [[0,0.1],[0,0.1],[0,0.1],[-30,0.1],[0,0.1],[0,1],[0,1],[0,0.1],[0,1]],
"sensors": ["PMS7003","SDS011","BME680","BME280","GPS","PYCOM"]
},
"port3": {
"packing": ">BBlll",
"fields": ["version","meteo","dust","latitude","longitude","altitude"],
"adjust": [[0,0.1],[0,1],[0,0.000001],[0,0.00001],[0,0.1]],
"sensors": ["MYSENSE","GPS"],
"meteo": ["unknown","PPD42NS","SDS011","PMS7003"],
"dust": ["unknown","DHT11","DHT22","BME280","BME680"]
}
}
],
# defs of used fields by MySense, do not change the keys
# To Do: put this in a DB
"translate": {
"pm03": ["pm0.3","PM0.3"],
"pm1": ["roet","soot"],
"pm25": ["pm2.5","PM2.5"],
"pm5": ["pm5.0","PM5.0"],
"pm10": ["pm","PM"],
"O3": ["ozon"],
"NH3": ["ammoniak","ammonium"],
"NO2": ["stikstof","stikstofdioxide","nitrogendioxide"],
"NO": ["stikstof","stikstofoxide","nitrogenoxide"],
"CO2": ["koolstofdioxide","carbondioxide"],
"CO": ["koolstofmonoxide","carbonoxide"],
"temp": ["temperature"],
"luchtdruk": ["pressure","pres","pha","pHa"],
"rv": ["humidity","hum","vochtigheid","vocht"],
"ws": ["windspeed","windsnelheid"],
"wr": ["windrichting","winddirection","direction"],
"altitude": ["alt","hoogte","height"],
"longitude": ["long","lon","lengte graad"],
"latitude": ["lat","breedte graad"],
"geolocation": ["gps","GPS","coordinates","geo"],
"gas": ["air"],
"aqi": ["air quality","luchtkwaliteit","lki"],
"version": ["versie","release"],
"meteo": ["weer"],
"dust": ["fijnstof"],
"time": ["utime","timestamp"]
},
'all': False, # skip non active and not registered nodes
}
# rename names into known field names
# prepend with field_ if not known
def translate( sense ):
sense.replace('PM','pm')
for strg in ('O3','NH','NO','CO'):
sense.replace(strg.lower(),strg)
if not 'translate' in Conf.keys(): return 'field_' + sense
for strg in Conf['translate'].keys():
if sense.lower() == strg.lower(): return strg
for item in Conf['translate'][strg]:
if item == sense: return strg
return 'field_' + sense
dirtyCaches = False
def GetAdminDevicesInfo( overwrite = True ):
global Conf, dirtyCaches, dirtyIdentCache
if (not overwrite) and (len(Conf['nodes']) > 0): return # only once
new = {}
if ('adminfile' in Conf.keys()) and Conf['adminfile']:
# admin conf.json should be read from file
try:
# json file may have comments in this case
from jsmin import jsmin # tool to delete comments and compress json
with open(Conf['adminfile']) as _typeOfJSON:
new = jsmin(_typeOfJSON.read())
new = json.loads(new)
except ValueError as e:
MyLogger.log(modulename,'ERROR',"Json error in admin file %s: %s" % (Conf['adminfile'],e))
if not overwrite:
MyLogger.log(modulename,'FATAL','Unable to proceed. Fix admin file.')
return
MyLogger.log(modulename,'ATTENT','Missing or errors in LoRa admin json file with info for all LaRa nodes. Using defaults.')
Conf['nodes'] = { 'no_devices': {} }
# return
# example of content of admin file specified for TTN MQTT RIVM records
# fields may be optional
# TO DO: per AppID one nodes dict (device name may not be unique per TTN)
Conf['nodes'] = {
'pmsensorN': { # Device id TTN
'GPS': {
'longitude': 51.12345, 'latitude': 6.12345, 'altitude': 23, },
'label': 'Jelle', 'street': 'Fontys nr 8',
'village': 'Venlo', 'pcode': '5888 XY',
'province': 'Limburg', 'municipality': 'Venlo',
'date': '20 december 2017', # start date
'tel': '+31773270012',
'comment': 'test device',
# 'serial': None, if not defined use hash topic/device name
"serial": "30aea4008438", # PyCom unique ID
# To Do: add calibration details
'AppSKEY': 'xyz', # LoRa key from eg RIVM
'NwkSKey': 'acacadabra', # LoRa key from eg RIVM
'meteo': 'BME280', # meteo sensor type
'dust': 'SDS011', # dust sensor type
'luftdaten.info': False, # forward to Open Data Germany?
'active': False,
}
}
dirtyCaches = True ; dirtyIdentCache = True
# nodes should go to database
for item in ['project','nodes','sensors','firmware','classes','translate','LoRa']:
if item in new.keys():
Conf[item] = new[item]
MyLogger.log(modulename,'ATTENT','Overwriting dflt definitions for Conf[%s].' % item)
if not 'all' in Conf.keys(): # handle nodes: dflt all if not configured
Conf['all'] = False
if len(Conf['nodes']) > 1: Conf['all'] = False # dflt: only registrated nodes
for device in Conf['nodes'].keys(): # build array of sensor types in this device
if not 'sensors' in Conf['nodes'][device].keys(): Conf['nodes'][device]['sensors'] = []
for sense in ['meteo','dust','gas']:
if (sense in Conf['nodes'][device].keys()):
if type(Conf['nodes'][device][sense]) is unicode:
Conf['nodes'][device][sense] = str(Conf['nodes'][device][sense])
if type(Conf['nodes'][device][sense]) is str:
Conf['nodes'][device][sense] = Conf['nodes'][device][sense].split(',')
for item in Conf['nodes'][device][sense]:
item = item.upper()
if not item in Conf['nodes'][device]['sensors']:
Conf['nodes'][device]['sensors'].append(item)
Conf['nodes'][device]['sensors'].sort()
# reread admin meta info of nodes in, may de/activate data arcghiving of the node
def SigUSR2handler(signum,frame):
GetAdminDevicesInfo() # reload admin info from admin file
# see if we know this product
unkownProducts = []
def ProductKnown( product ):
global Conf
if not 'sensors' in Conf.keys():
MyLogger.log(modulename,'FATAL','Missing sensors key in Conf dictionary.')
return None
if product in unkownProducts: return None
for sense in Conf['sensors']:
if sense['type'] == product:
return sense
if not product in unkownProducts:
MyLogger.log(modulename,'ATTENT',"Unknown sensor product %s" % product)
unkownProducts.append(product)
return None
# calibrate as ordered function order defined by length calibration factor array
def calibrate(coeffs,value):
if not type(coeffs) is list: return value
if type(value) is int: value = value/1.0
if not type(value) is float: return value
rts = 0; pow = 0
for a in coeffs:
rts += a*(value**pow)
pow += 1
return round(rts,2)
# search name of pollutant in fields and try to calibrate the value
def tryCalibrate(field,value,fields,calibrations):
if (not type(fields) is list) or (not type(calibrations) is list):
return value
try:
# only first field with the name is expected
if fields.count(field) > 0:
idx = fields.index(field)
if idx < len(calibrations):
value = calibrate(calibrations[idx],value)
except:
pass
return value
# returns distance in meters between two GPS coodinates
# hypothetical sphere radius 6372795 meter
# courtesy of TinyGPS and Maarten Lamers
# should return 208 meter 5 decimals is diff of 11 meter
# GPSdistance((51.419563,6.14741),(51.420473,6.144795))
LAT = 0
LON = 1
ALT = 2
def GPSdistance(gps1,gps2):
from math import sin, cos, radians, pow, sqrt, atan2
delta = radians(gps1[LON]-gps2[LON])
sdlon = sin(delta)
cdlon = cos(delta)
lat = radians(gps1[LAT])
slat1 = sin(lat); clat1 = cos(lat)
lat = radians(gps2[LAT])
slat2 = sin(lat); clat2 = cos(lat)
delta = pow((clat1 * slat2) - (slat1 * clat2 * cdlon),2)
delta += pow(clat2 * sdlon,2)
delta = sqrt(delta)
denom = (slat1 * slat2) + (clat1 * clat2 * cdlon)
return int(round(6372795 * atan2(delta, denom)))
# try to guess the sensor types and fields from the values present in the record
# returns dict with record data and 'sensors' + 'fields'
def checkFields(record):
global Conf
def getTypes(sFlds,fld):
for grp in sFlds.keys():
if fld in sFlds[grp].keys(): return sFlds[grp][fld]
if translate(fld) in sFlds[grp].keys(): return sFlds[grp][translate(fld)]
return []
SenseFlds = {}
for sensor in Conf['sensors']:
if (not 'fields' in sensor.keys()) or (not 'group' in sensor.keys()):
continue
group = sensor['group']; omits = []
for fld in sensor['fields']:
fnd = None
for one in record.keys():
if translate(one) == fld:
fnd = one ; break
if not fnd: continue
if not sensor['group'] in SenseFlds.keys(): SenseFlds[group] = {}
if not fnd in SenseFlds[group].keys(): SenseFlds[group][fnd] = []
if not sensor['type'] in SenseFlds[group][fnd]:
SenseFlds[group][fnd].append(sensor['type'])
# we have a table with groups, and fields/values present, collect the sensor types
rts = { 'types': [], 'fields':[]}; data = {}
for group in SenseFlds.keys():
types = {}; max = None
for fld in record.keys():
if fld in data.keys(): continue
if not fld in SenseFlds[group].keys(): continue
if record[fld] or (fld in 'temperature'):
if not fld in rts['fields']:
rts['fields'].append(fld)
else: continue
new = getTypes(SenseFlds, fld)
for one in new:
if not one in types.keys(): types[one] = []
types[one].append(fld)
if not max: max = one
if len(types[one]) > len(types[max]): max = one
data[fld] = record[fld]
for one in types.keys():
if len(types[one]) < len(types[max]): continue
if not one in rts['types']:
rts['types'] += [one]
for fld in record.keys():
if record[fld] or (fld in 'temperature'): continue
for tpe in getTypes(SenseFlds,fld):
try: rts['types'].remove(tpe)
except: pass
data['sensors'] = list(set(rts['types']))
data['fields'] = list(set(rts['fields']))
return data
# unpack base64 TTN LoRa payload string into array of values NOT TESTED
# architecture is changed!, To Do: unpack on length of received bytes!
def payload2fields(payload, firmware, portNr):
global cached, Conf
packing = None; port = 'port%d' % portNr
load = base64.decodestring(payload)
import struct
declared = []
try:
loadID = firmware['id']
packing = firmware['packing']
if (type(packing) is list) or (type(packing) is tuple):
for pack in packing:
save = load
try:
load = list(struct.unpack(pack,load))
break
except: load = save; pass
if not type(load) is tuple: packing = None
else: load = list(struct.unpack(packing,load))
except: packing = None; pass
if packing == None:
MyLogger.log(modulename,'ERROR','Cannot find payload converter definition for id %s.' % firmware['id'])
return {}
rts = {}
if firmware['id'] == 'LoPyNode': declared += ['GPS','PYCOM']
try:
# I do not like special cases
if (firmware['id'] == 'LoPyNode') and (portNr == 3):
rts['sensors'] = []
if (load[1] & 017) > 0:
rts['sensors'].append(firmware['dust'][(load[1] & 017)] )
declared.append(rts['sensors'][-1])
if ((load[1]>>4) & 07) > 0:
rts['sensors'].append(firmware['meteo'][((load[1]>>4) & 017)] )
declared.append(rts['sensors'][-1])
if ((load[1]>>4) & 010) > 0:
rts['sensors'].append('GPS')
declared.append(rts['sensors'][-1])
load.insert(2,None); load.insert(3,None)
else:
rts['sensors'] = firmware['sensors']
for idx in range(0,len(load)):
if firmware['adjust'][idx] != None:
rts[firmware['fields'][idx]] = calibrate(firmware['adjust'][idx],load[idx])
# try to improve guess for sensor type via existing field value
rts = checkFields(rts)
rts['sensors'] = list(set(rts['sensors'] + declared))
for sensor in Conf['sensors']:
if (sensor['type'] in declared) or (sensor['type'].lower() in declared):
rts['fields'] = list(set(rts['fields']+sensor['fields']))
rts['sensors'].sort(); rts['fields'].sort()
except:
MyLogger.log(modulename,'ERROR','Unpacking LoRa MQTT payload. Record skipped.')
raise ValueError
return{}
return rts
# update ident record with info from json admin file
def updateIdent( AppId, devAddr, ident, updateCache=False):
global Conf, cached
if not devAddr in Conf['nodes'].keys():
return ident
cacheKey = AppId+'/'+devAddr
if updateCache:
for k in ident.keys():
Conf['nodes'][devAddr][k] = ident[k]
cached[cacheKey]['ident'] = ident
if not 'geolocation' in Conf['nodes'][devAddr].keys():
if 'GPS' in Conf['nodes'][devAddr].keys():
Conf['nodes'][devAddr]['geolocation'] = str(Conf['nodes'][devAddr]['GPS']['longitude'])+','+str(Conf['nodes'][devAddr]['GPS']['latitude'])+','+str(Conf['nodes'][devAddr]['GPS']['altitude'])
for item in ["geolocation",'label','village','street','pcode','province','municipality','active']:
if item in Conf['nodes'][devAddr].keys():
ident[item] = Conf['nodes'][devAddr][item]
if ('comment' in Conf['nodes'][devAddr].keys()) and Conf['nodes'][devAddr]['comment']:
if not 'description' in ident.keys(): ident['description'] = ''
else: ident['description'] += ';'
ident['description'] += Conf['nodes'][devAddr]['comment']
for item in ['luftdaten.info','luftdaten','madavi']:
if item in Conf['nodes'][devAddr].keys():
ident[item.replace('.info','')] = Conf['nodes'][devAddr][item]
if 'ident' in cached[cacheKey].keys():
return cached[cacheKey]['ident']
return ident
# =======================================================
# post json data to a MQTT broker for nodes somewhere internet land
# =======================================================
# use telegram style
# use input file as MQTT records, used merely as restore data
def ReadFromFile(filename):
global Conf
if not 'fileFD' in Conf.keys():
try:
Conf['fileFD'] = open(Conf['file'],'r')
except:
MyLogger.log(modulename,'FATAL',"unable to open json input file %s" % Conf['file'])
exit(1)
while(1):
line = Conf['fileFD'].readline()
if (not line) or (not len(line)): # EOF
Conf['fileFD'].close()
exit(0)
if line.find('/up {') < 0: continue
return( { 'topic': line[0:line.find(' ')], 'payload': line[line.find(' ')+1:] } )
# Define event callbacks
# this is multi threaded: TTN download data thread
def PubOrSub(topic,option):
global Conf, waiting, mid, telegrams, PingTimeout, ErrorCnt
waiting = False
mid = None
telegram = None
# uncomment if TTN server does not publish records
# following is the telegram as is expected from TTN MQTT server
if ('test' in Conf.keys()) and Conf['test']:
return ( {
'topic': 'pmsensors/devices/pmsensor1/up',
'payload': '{"app_id":"pmsensors","dev_id":"pmsensor10","hardware_serial":"EEABABABBAABABAB","port":1,"counter":73,"payload_raw":"ACgALAG0ASU=","payload__fields":{"PM10":4.4,"PM25":4,"hum":29.3,"temp":23.6,"type":"SDS011"},"metadata":{"time":"2017-12-15T19:32:04.220584016Z","frequency":868.3,"modulation":"LORA","data_rate":"SF12BW125","coding_rate":"4/5","gateways":[{"gtw_id":"eui-1dee14d549d1e063","timestamp":536700428,"time":"","channel":1,"rssi":-100,"snr":6,"rf_chain":1,"latitude":51.35284,"longitude":6.154711,"altitude":40,"location_source":"registry"}],"latitude":51.353,"longitude":6.1538496,"altitude":2,"location_source":"registry"}}'
})
def on_connect(client, obj, flags, rc):
global waiting
if rc != 0:
MyLogger.log(modulename,'ERROR','Connection error nr: %s' % str(rc))
waiting = False
if 'fd' in Conf.keys():
Conf['fd'] = None
raise IOError("MQTTsub connect failure.")
else:
MyLogger.log(modulename,'DEBUG','Connected.')
pass
def on_message(client, obj, msg):
global waiting, telegrams
waiting = False
try:
if len(telegrams) > 100: # 100 * 250 bytes
MyLogger.log(modulename,'ERROR','Input buffer is full.')
return
# append the TTN data to local FiFo buffer
# print str(msg.topic)
# print str(msg.payload)
telegrams.append( {
'topic': msg.topic,
# payload is unpacked by TTN: make sure to add the unpack rules TTN
'payload': str(msg.payload),
})
except:
MyLogger.log(modulename,'ERROR Except','In message.')
def on_subscribe(client, obj, MiD, granted_qos):
global waiting, mid
mid = MiD
MyLogger.log(modulename,'DEBUG','mid: ' + str(mid) + ",qos:" + str(granted_qos))
def on_log(client, obj, level, string):
global PingTimeout, Conf, ErrorCnt
if string.find('PINGREQ') >= 0:
if not PingTimeout:
PingTimeout = int(time())
elif int(time())-PingTimeout > 10*60: # should receive pong in 10 minutes
MyLogger.log(modulename,'ATTENT','Ping/pong timeout exceeded.')
if ('fd' in Conf.keys()) and (Conf['fd'] != None):
Conf['fd'].disconnect()
waiting = False
Conf['registrated'] = False
del Conf['fd']
ErrorCnt += 1
PingTimeout = 0
elif string.find('PINGRESP') >= 0:
if int(time())-PingTimeout != 0:
MyLogger.log(modulename,'DEBUG','Log: ping/pong time: %d secs' % (int(time())-PingTimeout))
PingTimeout = 0
else:
MyLogger.log(modulename,'DEBUG','Log: %s...' % string[:17])
def on_disconnect(client, obj, MiD):
global waiting, mid, Conf
waiting = False
if 'fd' in Conf.keys():
Conf['fd'] = None
mid = MiD
MyLogger.log(modulename,'DEBUG','Disconnect mid: ' + str(mid))
raise IOError("MQTTsub: disconnected")
def reConnect():
global Conf
if ('fd' in Conf.keys()) and (Conf['fd'] != None):
# disconnect
Conf['fd'].disconnect()
Conf['fd'].loop_stop()
Conf['fd'] = None
sleep(2)
try:
Conf['fd'] = mqtt.Client(Conf['project']+str(os.getpid()))
Conf['fd'].on_connect = on_connect
Conf['fd'].on_disconnect = on_disconnect
if ('user' in Conf.keys()) and Conf['user'] and ('password' in Conf.keys()) and Conf['password']:
Conf['fd'].username_pw_set(username=Conf['user'],password=Conf['password'])
Conf['fd'].connect(Conf['hostname'], Conf['port'], keepalive=60)
#Conf['fd'].connect(Conf['hostname'], Conf['port'])
Conf['fd'].on_subscribe = on_subscribe
Conf['fd'].on_message = on_message
Conf['fd'].loop_start() # start thread
Conf['fd'].subscribe(topic, qos=Conf['qos'])
return True
except:
return False
if ('file' in Conf.keys()) and Conf['file']:
return ReadFromFile(Conf['file'])
try:
if (not 'fd' in Conf.keys()) or (Conf['fd'] == None):
if not reConnect(): raise IOError
sleep(1)
tryAgain = time()
timeout = tryAgain + Conf['timeout']
waiting = True
while waiting:
if len(telegrams):
waiting = False
break
if time() > timeout: # give up
break
if time() > (tryAgain + Conf['rate']):
reConnect()
tryAgain = time()
MyLogger.log(modulename,'ATTENT','Try to reconnect with TTN MQTT broker')
else: sleep(30) # slow down
except:
MyLogger.log(modulename,'ERROR','Failure type: %s; value: %s. MQTT broker aborted.' % (sys.exc_info()[0],sys.exc_info()[1]) )
Conf['input'] = False
del Conf['fd']
raise IOError("%s" % str(mid))
return telegram
if waiting:
MyLogger.log(modulename,'ATTENT','Sending telegram to broker')
raise IOError("%s" % str(mid))
return telegram
MyLogger.log(modulename,'DEBUG','Received telegram from broker, waiting = %s, message id: %s' % (str(waiting),str(mid)) )
if len(telegrams):
return telegrams.pop(0)
return telegram
# mqttc = mosquitto.Mosquitto()
# # Assign event callbacks
# mqttc.on_message = on_message
# mqttc.on_connect = on_connect
# mqttc.on_publish = on_publish
# mqttc.on_subscribe = on_subscribe
#
# Uncomment to enable debug messages
#mqttc.on_log = on_log
last_records = {} # remember last record seen so far
# sensor module name is received via TTN record field 'type'
# maintain some logging
cached = {
# 'applID/deviceID': {
# 'unknown_fields': [] seen but not used fields
# 'last_seen': unix timestamp secs
# 'count': received records count
# 'eui': LoRa EUI ID
# 'sensors': list of sensor types (same as firmware/sensors) deprecated
# 'firmware': {sensors,fields,id (classId)}
# 'port%d': {packing, adjust}
# 'ident': collected meta info
# },
}
# show current status of nodes seen so far
def SigUSR1handler(signum,frame):
global modulename, cached
for name in cached.keys():
MyLogger.log(modulename,'INFO',"Status device %s EUI=%s: count: %d, last seen: %s, unknown fields: %s, sensors %s" % (name,cached[name]['eui'] if 'eui' in cached[name].keys() else 'unknown',cached[name]['count'],datetime.datetime.fromtimestamp(cached[name]['last_seen']).strftime("%Y-%m-%d %H:%M:%S"), ' '.join(cached[name]['unknown_fields']),', '.join(cached[name]['firmware']['sensors'].keys()) if 'sensors' in cached[name]['firmware'].keys() else 'not defined'))
# search record for first EUI and rssi value of the sensor/node
def Get_GtwID(msg):
if (not 'gateways' in msg.keys()) or (not type(msg['gateways']) is list):
return None
tfirst = 0 ; rssi = None ; eui = None ; location = []
for one in msg['gateways']:
if (not 'timestamp' in one.keys()) or (not 'gtw_id' in one.keys()) or (not 'rssi' in one.keys()):
continue
if not tfirst: tfirst = one['timestamp']
if one['timestamp'] <= tfirst:
tfirst = one['timestamp']
rssi = one['rssi']
gtw_id = one['gtw_id']
for crd in ['latitude','longitude','altitude']:
try: location.append(one[crd])
except: location.append(None)
if tfirst: return (gtw_id,rssi,location)
return None
# ident cache
# to do: add memory use watchdog
dirtyIdentCache = False
IdentCache = {}
def newIdent( sensors ):
global IdentCache, dirtyIdentCache, Conf
sensors.sort()
theKey = '/'.join(sensors)
if dirtyIdentCache:
IdentCache = {} ; dirtyIdentCache = False
if theKey in IdentCache.keys(): return IdentCache[theKey].copy()
ident = {
'project': '', 'sensors': '',
'description': 'hw: '+','.join(sensors),
'fields': ['time', ], 'types': ['time'], 'units': ['s',],
'calibrations': [None,],
}
for sensor in sensors:
product = ProductKnown(sensor)
for j in range(0,len(product['fields'])):
# ident['sensors'] = ','.join([ident['sensors'],'%s(%s)' % (Conf['nodes'][sensor]['fields'][j],Conf['nodes'][sensor]['units'][j]])
ident['types'].append(sensor.lower())
for t in ['fields','units','calibrations']:
try:
ident[t].append(product[t][j])
except:
ident[t].append(None)
IdentCache[theKey] = ident
return ident.copy()
# get from appID/deviceID of TTN topic via classID firmware sensors config
def getFirmware( app, device, port):
global Conf
if (not 'classes' in Conf.keys()) or (not 'firmware' in Conf.keys()):
MyLogger.log(modulename,'FATAL','Missing classes or firmware in Conf.')
return {}
ID = None
for item in Conf['classes']:
if type(item['regexp']) is unicode:
item['regexp'] = str(item['regexp'])
if type(item['regexp']) is str:
item['regexp'] = re.compile(item['regexp'], re.I)
if item['regexp'].match(app+'/'+device+'/'+ '%d' % port):
ID = item['classID'] ; break
if not ID: return {}
portNr = 'port%d' % port
for item in Conf['firmware']:
if (item['id'] == ID) and (portNr in item.keys()):
rts = { "id": ID }
for k in item[portNr].keys(): rts[k] = item[portNr][k]
return rts
return {}
def delDecrFld(ident,fld):
if (not 'description' in ident.keys()) or (not ident['description']):
return
descr = ident['description'].split(';')
ident['description'] = []
for item in descr:
if item.find(fld) < 0: ident['description'].append(item)
ident['description'] = ';'.join(ident['description'])
def addInfo(module,ident,clear=False):
try:
if clear:
for t in ['types','fields','units','calibrations']:
ident[t] = []
ident['sensors'] = ''
delDecrFld(ident,'hw:')
return True
sensor = None
for t in Conf['sensors']:
if t['type'] == module:
sensor = t; break
if not sensor: raise ValueError("Unknown module type %s" % module)
ident['sensors'] += ',' if len(ident['sensors']) else ''
ident['sensors'] += module
for t in ['types','fields','units','calibrations']:
for i in range(0,len(sensor['fields'])):
if t == 'types': ident[t].append(module.lower())
else:
if (type(sensor[t]) is list) and (i <= len(sensor[t])):
ident[t].append(sensor[t][i])
else: ident[t].append(None)
except Exception as e:
print("addInfo error %s: on module %s, key %s, index %d" % (e,module,t,i))
return False
return True
# convert MQTT structure to MySense ident,value structure
def convert2MySense( data, **sensor):
global Conf, cached, dirtyCaches
device = data['topic'][2]
values = {} # init record with measurements
record = {}
timing = None
for item in ['counter','payload_raw','port',]:
if item in data['payload'].keys():
record[item] = data['payload'][item]
else: record[item] = None # should be an error: return {}
myID = data['topic'][0]+'/'+data['topic'][2] # to do: should use eui ID
if dirtyCaches:
cached = {} ; dirtyCaches = False
if not myID in cached.keys(): # caching
if len(cached) >= 100: # FiFo to avoid exhaustion
oldest = time() ; oldestKey = None
for key in cached.keys():
if cached[key]['last_seen'] <= oldest:
oldest = cached[key]['last_seen']
oldestKey = key
del cached[oldestKey]
cached[myID] = { 'unknown_fields': [], 'count': 0, 'firmware': getFirmware(data['topic'][0],data['topic'][2],record['port']),}
cached[myID]['port%d' % record['port']] = {}
for key in ['packing','adjust']:
try:
cached[myID]['port%d' % record['port']][key] = cached[myID]['firmware'][key]
except: pass
if 'sensors' in cached[myID]['firmware'].keys():
if type(cached[myID]['firmware']['sensors']) is unicode:
cached[myID]['firmware']['sensors'] = str(cached[myID]['firmware']['sensors'])
if type(cached[myID]['firmware']['sensors']) is str:
cached[myID]['firmware']['sensors'] = cached[myID]['firmware']['sensors'].upper()
cached[myID]['firmware']['sensors'] = cached[myID]['firmware']['sensors'].split(',')
if not 'port%d' % record['port'] in cached[myID].keys():
try:
firmware = getFirmware(data['topic'][0],data['topic'][2],record['port'])
cached[myID]['port%d' % record['port']] = {}
for key in ['packing','adjust']:
try:
cached[myID]['port%d' % record['port']][key] = firmware[key]
except: pass
for key in firmware['sensors']:
if not key in cached[myID]['firmware']['sensors']:
cached[myID]['firmware']['sensors'].append(key)
except: pass
cached[myID]['last_seen'] = time() ; cached[myID]['count'] += 1
gtwID = None # gateway id
# make sure pay_load_fields have: keys types (sensors) and fields
# this needs some rework! Too many fields and types!
# collect sensor product names, cache them,
# and check if (translated) fields are known
if ("payload_fields" in data['payload'].keys()) \
and len(data['payload']['payload_fields']):
if 'type' in data['payload']['payload_fields'].keys(): # deprecated
if not data['payload']['payload_fields']['type'].upper() in cached[myID]['sensors']:
cached[myID]['sensors'].append(data['payload']['payload_fields']['type'].upper())
del data['payload']['payload_fields']['type']
if 'sensors' in data['payload']['payload_fields'].keys():
if not isinstance(data['payload']['payload_fields']['sensors'], list):
data['payload']['payload_fields']['sensors'] = data['payload']['payload_fields']['sensors'].split(',')
for sensor in data['payload']['payload_fields']['sensors']:
if not sensor.upper() in cached[myID]['sensors']:
cached[myID]['sensors'].append(sensor.upper())
del data['payload']['payload_fields']['sensors']
if ('time' in data['payload']['payload_fields'].keys()) and (data['payload']['payload_fields']['time'] > 946681200): # 1 jan 2000
record['time'] = values['time'] = data['payload']['payload_fields']['time']
del data['payload']['payload_fields']['time']
timing = values['time']
# cached['sensors'] is now up to date
for sense in data['payload']['payload_fields'].keys():
field = translate(sense)
fnd = False
for sensor in cached[myID]['firmware']['sensors']:
sensor = ProductKnown(sensor)
if not sensor: continue
if field in sensor['fields']:
fnd = True
break
if not fnd:
if not sense in cached[myID]['unknown_fields']:
MyLogger.log(modulename,'ERROR','Unknown field "%s" in sensor kit %s. Skipped.' % (sense,myID))
cached[myID]['unknown_fields'].append(sense)
del data['payload']['payload_fields'][sense]
elif sense != field:
data['payload']['payload_fields'][field] = data['payload']['payload_fields'][sense]
del data['payload']['payload_fields'][sense]
data['payload']['payload_fields'] = checkFields(data['payload']['payload_fields'])
elif ('payload_raw' in data['payload'].keys()) \
and len(data['payload']['payload_raw']):
if not 'firmware' in cached[myID]: # try default
firmware = getFirmware(data['topic'][0],data['topic'][2],data['payload']['port'])
if not len(firmware):
firmware = getFirmware('201802215971az','lopyprototype20180000',2)
print("Unable to find firmware for device %s using LoPyNode" % device)
else:
firmware = cached[myID]['firmware']
data['payload']['payload_fields'] = payload2fields(data['payload']['payload_raw'],firmware,data['payload']['port'])
else: return {}
# side effect payload2fields: key sensors
if 'sensors' in data['payload']['payload_fields']:
if (not 'sensors' in cached[myID].keys()) or (not len(cached[myID]['sensors'])) or (len(cached[myID]['sensors']) > len(data['payload']['payload_fields']['sensors'])):
cached[myID]['sensors'] = data['payload']['payload_fields']['sensors']