-
Notifications
You must be signed in to change notification settings - Fork 1
/
parser.py
341 lines (277 loc) · 8.92 KB
/
parser.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
# -*- coding: utf-8 -*-
"""
Function for parsing data packets from Oregon Scientific weather sensors
"""
import logging
import threading
from utils import computeDewPoint, computeWindchill, computeSeaLevelPressure
__version__ = '0.2'
__all__ = ['computeChecksum', 'parsePacketv21', 'parsePacketStream',
'__version__', '__all__']
# Setup the logger
parserLogger = logging.getLogger('__main__')
def computeChecksum(bits):
"""
Compute the byte-based checksum for a sequence of bits.
"""
# Bits -> Integers
values = [int(v, 16) for v in bits]
# Sum
value = sum(values)
# Convert to an 8-bit value
value = (value & 0xFF) + (value >> 8)
# Done
return value
def _parseBHTR968(data):
"""
Parse the data section of a BHTR968 indoor temperature/humidity/pressure
sensor packet and return a dictionary of the values recovered.
"""
output = {'temperature': -99, 'humidity': -99, 'pressure': -99,
'comfortLevel': 'unknown', 'forecast': 'unknown'}
# Indoor temperature in C
temp = data[0:3][::-1]
temp = int(temp)/10.0
if int(data[3]) != 0:
temp *= -1
output['temperature'] = temp
# Indoor relative humidity as a percentage
humi = data[4:6][::-1]
humi = int(humi)
output['humidity'] = humi
# Indoor "comfort level"
comf = int(data[6], 16)
if comf == 0:
output['comfortLevel'] = 'normal'
elif comf == 4:
output['comfortLevel'] = 'comfortable'
elif comf == 8:
output['comfortLevel'] = 'dry'
elif comf == 0xC:
output['comfortLevel'] = 'wet'
else:
output['comfortLevel'] = 'unknown'
# Barometric pressure in mbar
baro = data[7:9][::-1]
baro = int(baro, 16)
if baro >= 128:
baro -= 256
output['pressure'] = baro + 856
# Pressure-based weather forecast
fore = int(data[10], 16)
if fore == 2:
output['forecast'] = 'cloudy'
elif fore == 3:
output['forecast'] = 'rainy'
elif fore == 6:
output['forecast'] = 'partly cloudy'
elif fore == 0xC:
output['forecast'] = 'sunny'
else:
output['forecast'] = 'unknown'
return output
def _parseRGR968(data):
"""
Parse the data section of a RGR968 rain gauge packet and return a dictionary
of the values recovered.
"""
output = {'rainrate': -99, 'rainfall': -99}
# Rainfall rate in mm/hr
rrate = int(data[0:3][::-1])/10.0
output['rainrate'] = rrate
# Total rainfall in mm
rtotl = int(data[3:8][::-1])/10.0
output['rainfall'] = rtotl
return output
def _parseWGR968(data):
"""
Parse the data section of a WGR968 anemometer packet and return a dictionary
of the values recovered.
"""
output = {'average': -99, 'gust': -99, 'direction': -99}
# Wind direction in degrees (N = 0)
wdir = int(data[0:3][::-1])
output['direction'] = wdir
# Gust wind speed in m/s
gspd = int(data[3:6][::-1])/10.0
output['gust'] = gspd
# Average wind speed in m/s
aspd = int(data[6:9][::-1])/10.0
output['average'] = aspd
return output
def _parseTHGR268(data):
"""
Parse the data section of a THGR268 temperature/humidity sensor packet and return a dictionary
of the values recovered.
"""
output = {'temperature': -99, 'humidity': -99}
# Temperature in C
temp = int(data[0:3][::-1])/10.0
if int(data[3]) != 0:
temp *= -1
output['temperature'] = temp
# Relative humidity as a percentage
humi = int(data[4:6][::-1])
output['humidity'] = humi
return output
def _parseTHGR968(data):
"""
Parse the data section of a THGR268 temperature/humidity sensor packet and return a dictionary
of the values recovered.
"""
output = {'temperature': -99, 'humidity': -99}
# Temperature in C
temp = int(data[0:3][::-1])/10.0
if int(data[3]) != 0:
temp *= -1
output['temperature'] = temp
# Relative humidity as a percentage
humi = int(data[4:6][::-1])
output['humidity'] = humi
return output
def parsePacketv21(packet, wxData=None):
"""
Given a sequence of bits try to find a valid Oregon Scientific v2.1
packet. This function returns a status code of whether or not the packet
is valid, the sensor name, the channel number, and a dictionary of the
values recovered.
Supported Sensors:
* 5D60 - BHTR968 - Indoor temperature/humidity/pressure
* 2D10 - RGR968 - Rain gauge
* 3D00 - WGR968 - Anemometer
* 1D20 - THGR268 - Outdoor temperature/humidity
* 1D30 - THGR968 - Outdoor temperature/humidity
"""
# Consolidate
packet = ''.join(packet)
# Check for a valid sync word.
if packet[0] != 'A':
return False, 'Invalid', -1, {}
# Try to figure out which sensor is present so that we can get
# the packet length
sensor = packet[1:5]
if sensor == '5D60':
nm = 'BHTR968'
elif sensor == '2D10':
nm = 'RGR968'
elif sensor == '3D00':
nm = 'WGR968'
elif sensor == '1D20':
nm = 'THGR268'
elif sensor == '1D30':
nm = 'THGR968'
else:
## Unknown - fail
return False, 'Invalid', -1, {}
## Make sure there are enough bits that we get a checksum
#if len(packet) < ds+8:
# return False, 'Invalid', -1, {}
# Report
parserLogger.debug("sync %s", str(packet[ 0: 1]))
parserLogger.debug("sensor %s", str(packet[ 1: 5]))
parserLogger.debug("channel %s", str(packet[ 5: 6]))
parserLogger.debug("code %s", str(packet[ 6: 8]))
parserLogger.debug("flags %s", str(packet[ 8: 9]))
parserLogger.debug("data %s", str(packet[ 9:-4]))
parserLogger.debug("checksum %s", str(packet[-4:-2]))
parserLogger.debug("postamble %s", str(packet[-2:]))
parserLogger.debug("----------")
# Compute the checksum and compare it to what is in the packet
ccs = computeChecksum(packet[1:-4])
ccs = "%02X" % ccs
parserLogger.debug("computed %s", str(ccs[::-1]))
parserLogger.debug("valid %s", str(ccs[::-1] == packet[-4:-2]))
parserLogger.debug("----------")
if packet[-4:-2] != ccs[::-1]:
return False, 'Invalid', -1, {}
# Parse
data = packet[9:-4]
channel = int(packet[5])
if nm == 'BHTR968':
output = _parseBHTR968(data)
elif nm == 'RGR968':
output = _parseRGR968(data)
elif nm == 'WGR968':
output = _parseWGR968(data)
elif nm == 'THGR268':
output = _parseTHGR268(data)
elif nm == 'THGR968':
output = _parseTHGR968(data)
else:
return False, 'Invalid', -1, {}
# Report
parserLogger.debug("output %s", str(output))
# Return the packet validity, channel, and data dictionary
return True, nm, channel, output
def parsePacketStream(packets, elevation=0.0, inputDataDict=None):
"""
Given a sequence of two-element type,payload packets from read433,
find all of the Oregon Scientific sensor values and return the data
as a dictionary. In the process, compute various derived quantities
(dew point, windchill, and sea level correctedpressure).
.. note::
The sea level corrected pressure is only compute if the elevation
(in meters) is set to a non-zero value.
"""
# Setup the output dictionary
output = {}
if inputDataDict is not None:
for key,value in inputDataDict.iteritems():
output[key] = value
# Parse the packet payload and save the output
gspd = []
gdir = []
for pType,pPayload in packets:
if pType == 'OSV2':
valid, sensorName, channel, sensorData = parsePacketv21(pPayload)
else:
continue
## Data reorganization and computed quantities
if valid:
### Gust tracker
if sensorName == 'WGR968':
gspd.append( sensorData['gust'] )
gdir.append( sensorData['direction'] )
### Dew point - indoor and output
if sensorName in ('BHTR968', 'THGR268', 'THGR968'):
sensorData['dewpoint'] = computeDewPoint(sensorData['temperature'], sensorData['humidity'])
### Sea level corrected barometric pressure
if sensorName in ('BHTR968',) and elevation != 0.0:
sensorData['pressure'] = computeSeaLevelPressure(sensorData['pressure'], elevation)
### Disentangle the indoor temperatures from the outdoor temperatures
if sensorName == 'BHTR968':
for key in ('temperature', 'humidity', 'dewpoint'):
newKey = 'indoor%s' % key.capitalize()
sensorData[newKey] = sensorData[key]
del sensorData[key]
### Multiplex the THGR268 values
for key in sensorData.keys():
if key in ('temperature', 'humidity', 'dewpoint'):
if sensorName == 'THGR968':
output[key] = sensorData[key]
else:
try:
output['alt%s' % key.capitalize()][channel-1] = sensorData[key]
except KeyError:
output['alt%s' % key.capitalize()] = [None, None, None, None]
output['alt%s' % key.capitalize()][channel-1] = sensorData[key]
else:
output[key] = sensorData[key]
# Compute combined quantities
## Maximum gust observed
if len(gspd) > 0:
best = gspd.index( max(gspd) )
output['gust'] = gspd[best]
output['gustDirection'] = gdir[best]
## Windchill
if 'temperature' in output.keys() and 'average' in output.keys():
output['windchill'] = computeWindchill(output['temperature'], output['average'])
# Done
return output
if __name__ == "__main__":
# Testing
packets = [('OSV2', 'A1D201BB05710818544A'),
('OSV2', 'A1D3012200710618D2E0'),
('OSV2', 'A3D000470712930730B3AE'),
('OSV2', 'A5D600BB09220528CD83E6AF'),]
output = parsePacketStream(packets)