-
Notifications
You must be signed in to change notification settings - Fork 4
/
sds011.py
337 lines (270 loc) · 9.99 KB
/
sds011.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
#!/usr/bin/env python
# Copyright 2019 Matthew Wall
# Distributed under the terms of the GNU Public License (GPLv3)
"""Driver for collecting data from SDS011 particulate sensor.
Apparently if you poll the device too often you will get bogus data.
Credits:
2016 Frank Heuer
https://gitlab.com/frankrich/sds011_particle_sensor
2017 Martin Lutzelberger
https://github.com/luetzel/sds011/blob/master/sds011_pylab.py
2018 zefanja
https://github.com/zefanja/aqi/
"""
import struct
import syslog
import time
import weewx
import weewx.drivers
DRIVER_NAME = 'SDS011'
DRIVER_VERSION = '0.2'
printlog = False
def logmsg(dst, msg):
msg = 'SDS011: %s' % msg
if printlog:
print(msg)
syslog.syslog(dst, msg)
def logdbg(msg):
logmsg(syslog.LOG_DEBUG, msg)
def loginf(msg):
logmsg(syslog.LOG_INFO, msg)
def logerr(msg):
logmsg(syslog.LOG_ERR, msg)
def loader(config_dict, _):
return SDS011Driver(**config_dict[DRIVER_NAME])
def confeditor_loader():
return SDS011ConfEditor()
schema = [
('dateTime', 'INTEGER NOT NULL PRIMARY KEY'),
('usUnits', 'INTEGER NOT NULL'),
('interval', 'INTEGER NOT NULL'),
('pm2_5', 'REAL'),
('pm10_0', 'REAL'),
]
class SDS011ConfEditor(weewx.drivers.AbstractConfEditor):
@property
def default_stanza(self):
return """
[SDS011]
# This section is for SDS011 particulate sensors.
model = NovaPM
port = /dev/ttyUSB0
# How often to poll the device, in seconds (do not set lower than 10)
poll_interval = 10
# The driver to use
driver = user.sds011
"""
def prompt_for_settings(self):
print "Specify the serial port on which the sensor is connected, for"
print "example /dev/ttyUSB0 or /dev/ttyS0 or /dev/tty.usbserial"
port = self._prompt('port', '/dev/ttyUSB0')
return {'port': port}
class SDS011Driver(weewx.drivers.AbstractDevice):
def __init__(self, **stn_dict):
loginf('driver version is %s' % DRIVER_VERSION)
self.model = stn_dict.get('model', 'NovaPM')
loginf("model is %s" % self.model)
port = stn_dict.get('port', SDS011.DEFAULT_PORT)
loginf("port is %s" % port)
timeout = int(stn_dict.get('timeout', SDS011.DEFAULT_TIMEOUT))
self.poll_interval = int(stn_dict.get('poll_interval', 30))
loginf("poll interval is %s" % self.poll_interval)
if self.poll_interval < 10:
loginf("warning: short poll interval may result in bad data")
self.max_tries = int(stn_dict.get('max_tries', 3))
self.retry_wait = int(stn_dict.get('retry_wait', 5))
self.sensor = SDS011(port, timeout)
self.sensor.open()
@property
def hardware_name(self):
return self.model
def closePort(self):
self.sensor.close()
self.sensor = None
def genLoopPackets(self):
while True:
pm2_5, pm10_0 = self._get_with_retries()
logdbg("data: %s %s" % (pm2_5, pm10_0))
pkt = dict()
pkt['dateTime'] = int(time.time() + 0.5)
pkt['usUnits'] = weewx.METRICWX
pkt['pm2_5'] = pm2_5
pkt['pm10_0'] = pm10_0
yield pkt
if self.poll_interval:
time.sleep(self.poll_interval)
def _get_with_retries(self):
for n in range(self.max_tries):
try:
return self.sensor.get_data()
except (IOError, ValueError, TypeError), e:
loginf("failed attempt %s of %s: %s" %
(n + 1, self.max_tries, e))
time.sleep(self.retry_wait)
else:
raise weewx.WeeWxIOError("%s: max tries %s exceeded" %
(method, self.max_tries))
def _fmt(x):
return ' '.join(["%0.2X" % ord(c) for c in x])
class SDS011(object):
DEFAULT_PORT = '/dev/ttyUSB0'
DEFAULT_BAUDRATE = 9600
DEFAULT_TIMEOUT = 3.0 # seconds
CMD_MODE = 2
CMD_QUERY_DATA = 4
CMD_DEVICE_ID = 5
CMD_SLEEP = 6
CMD_FIRMWARE = 7
CMD_WORKING_PERIOD = 8
MODE_ACTIVE = 0
MODE_QUERY = 1
def __init__(self, port, timeout=DEFAULT_TIMEOUT):
self.port = port
self.baudrate = self.DEFAULT_BAUDRATE
self.timeout = timeout
self.serial_port = None
def __enter__(self):
self.open()
return self
def __exit__(self, _, value, traceback):
self.close()
def open(self):
import serial
self.serial_port = serial.Serial(port=self.port,
baudrate=self.baudrate,
timeout=self.timeout)
self.serial_port.open()
self.serial_port.flushInput()
def close(self):
if self.serial_port:
self.serial_port.close()
self.serial_port = None
@staticmethod
def _chksum(raw):
return sum(ord(v) for v in raw[2:8]) % 256
@staticmethod
def _cmd(cmd, data=[]):
# a command is a string of 19 bytes with this format:
#
# 0xaa 0xb4 cmd data 0xff 0xff chksum 0xab
#
# where:
# cmd is a single byte
# data is 12 bytes or less
# chksum is a single byte
data += [0,] * (12 - len(data))
chksum = (sum(data) + cmd - 2) % 256
ret = "\xaa\xb4" + chr(cmd)
ret += ''.join(chr(x) for x in data)
ret += "\xff\xff" + chr(chksum) + "\xab"
return ret
@staticmethod
def parse_data(raw):
r = struct.unpack('<HHxxBB', raw[2:])
pm2_5 = r[0] / 10.0 # ug/m^3
pm10_0 = r[1] / 10.0 # ug/m^3
chksum = SDS011._chksum(raw)
return [pm2_5, pm10_0]
@staticmethod
def parse_version(raw):
r = struct.unpack('<BBBHBB', raw[3:])
fwver = "20%s-%s-%s %s" % (r[0], r[1], r[2], hex(r[3]))
chksum = SDS011._chksum(raw)
return fwver
def write_command(self, cmd, data=[]):
x = SDS011._cmd(cmd, data)
logdbg("write: %s" % _fmt(x))
self.serial_port.write(x)
def read_bytes(self):
x = 0
while x != "\xaa":
x = self.serial_port.read(size=1)
data = self.serial_port.read(size=9)
logdbg("read: %s" % _fmt(data))
return x + data
def get_firmware_version(self):
self.write_command(SDS011.CMD_FIRMWARE)
raw = self.read_bytes()
return SDS011.parse_version(raw)
def get_data(self):
self.write_command(SDS011.CMD_QUERY_DATA)
raw = self.read_bytes()
return SDS011.parse_data(raw)
def set_sleep(self, period=1):
mode = 0 if period else 1
self.write_command(SDS011.CMD_SLEEP, [0x1, mode])
raw = self.read_bytes()
def set_working_period(self, period):
self.write_command(SDS011.CMD_WORKING_PERIOD, [0x1, period])
raw = self.read_bytes()
def set_mode(self, mode=MODE_QUERY):
self.write_command(SDS011.CMD_MODE, [0x1, mode])
raw = self.read_bytes()
def set_id(self, device_id):
id_hi = (device_id >> 8) % 256
id_lo = device_id % 256
self.write_command(SDS011.CMD_DEVICE_ID, [0] * 10 + [id_lo, id_hi])
raw = self.read_bytes()
def sensor_wake(self):
self.set_sleep(0)
def sensor_sleep(self):
self.set_sleep(1)
if __name__ == '__main__':
import optparse
usage = """%prog [options] [--debug] [--help]"""
syslog.openlog('wee_sds011', syslog.LOG_PID | syslog.LOG_CONS)
parser = optparse.OptionParser(usage=usage)
parser.add_option('--version', dest='version', action='store_true',
help='display driver version')
parser.add_option('--debug', dest='debug', action='store_true',
help='display diagnostic information while running')
parser.add_option('--port', dest='port', metavar='PORT',
help='serial port to which the station is connected',
default=SDS011.DEFAULT_PORT)
parser.add_option('--timeout', dest='timeout', metavar='TIMEOUT',
help='serial timeout, in seconds', type=int,
default=SDS011.DEFAULT_TIMEOUT)
parser.add_option('--poll-interval', metavar='PERIOD', type=int, default=10,
help='how often to poll for data, in seconds')
parser.add_option('--info', action='store_true',
help='display device information')
parser.add_option('--set-id', metavar='ID', type=int, dest='device_id',
help='set device identifier')
parser.add_option('--set-mode', metavar='MODE', dest='device_mode',
help='set the mode to active or query')
parser.add_option('--set-sleep', metavar='PERIOD', type=int, dest='sleep',
help='set sleep period, in seconds')
parser.add_option('--set-work', metavar='PERIOD', type=int, dest='work',
help='set working period, in seconds')
(options, _) = parser.parse_args()
if options.version:
print "driver version %s" % DRIVER_VERSION
exit(1)
if options.debug is not None:
printlog = True
syslog.setlogmask(syslog.LOG_UPTO(syslog.LOG_DEBUG))
else:
syslog.setlogmask(syslog.LOG_UPTO(syslog.LOG_INFO))
s = SDS011(options.port, options.timeout)
s.open()
if options.info:
print("firmware: %s" % s.get_firmware_version())
exit(0)
if options.device_id is not None:
print("set id to %s" % options.device_id)
s.set_id(options.device_id)
elif options.device_mode is not None:
print("set mode to %s" % options.device_mode)
s.set_mode(options.device_mode)
elif options.sleep is not None:
print("set sleep to %s" % options.sleep)
s.set_sleep(options.sleep)
elif options.work is not None:
print("set work to %s" % options.work)
s.set_work(options.work)
else:
while True:
s.sensor_wake()
time.sleep(options.poll_interval)
pm2_5, pm10_0 = s.get_data()
print("pm2_5=%s pm10_0=%s" % (pm2_5, pm10_0))