/
pyenergy.py
595 lines (477 loc) · 21.3 KB
/
pyenergy.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
import usb
import usb.core
import usb.util
from struct import *
from copy import copy
from collections import namedtuple
import operator
from functools import total_ordering
import logging
logger = logging.getLogger(__name__)
logger.addHandler(logging.NullHandler())
warning = logger.warning
error = logger.error
info = logger.info
debug = logger.debug
# import multiprocessing
@total_ordering
class MeasurementSet(object):
def __init__(self, measurements):
self.measurements = measurements
self.energy = sum(self.measurements).energy
self.time = sum(self.measurements).time / len(self.measurements)
self.peak_power = sum(self.measurements).peak_power # This is only a rough guide
self.peak_voltage = sum(self.measurements).peak_voltage
self.peak_current = sum(self.measurements).peak_current
self.n_samples = sum(self.measurements).n_samples
self.avg_voltage = sum(self.measurements).avg_voltage
self.avg_current = sum(self.measurements).avg_current
self.avg_power = sum(self.measurements).avg_power
def _op_self(self, other, fn):
params = ["energy", "time", "peak_power", "peak_voltage", "peak_current",
"n_samples", "avg_voltage", "avg_current", "avg_power"]
newmeasurements = []
for m1, m2 in zip(self.measurements, other.measurements):
m = fn(m1, m2)
newmeasurements.append(m)
return MeasurementSet(newmeasurements)
def _op_const(self, const, fn):
params = ["energy", "time", "peak_power", "peak_voltage", "peak_current",
"n_samples", "avg_voltage", "avg_current", "avg_power"]
newmeasurements = []
for m1 in self.measurements:
m = fn(m1, const)
newmeasurements.append(m)
return MeasurementSet(newmeasurements)
def _op(self, other, fn):
if isinstance(other, MeasurementSet):
assert len(self.measurements) == len(other.measurements)
return self._op_self(other, fn)
else:
return self._op_const(other, fn);
def __add__(self, other):
return self._op(other, operator.add)
def __sub__(self, other):
return self._op(other, operator.sub)
def __mul__(self, other):
return self._op(other, operator.mul)
def __div__(self, other):
return self._op(other, operator.div)
def __radd__(self, other):
return self._op(other, operator.add)
def __rsub__(self, other):
return self._op(other, operator.sub)
def __rmul__(self, other):
return self._op(other, operator.mul)
def __rdiv__(self, other):
return self._op(other, operator.div)
def __repr__(self):
keys = ["energy", "time", "peak_power", "peak_voltage", "peak_current", "n_samples", "avg_voltage", "avg_current", "avg_power"]
vals = ", ".join(map(lambda x: "{}={}".format(x,self.__dict__[x]), keys))
return "MeasurementSet({} measurements, {})".format(len(self.measurements), vals)
def __eq__(self, rhs):
return all(map(operator.eq, self.measurements, rhs.measurements))
def __lt__(self, rhs):
return self.measurements < rhs.measurements
@total_ordering
class Measurement(object):
class_version = 1
def __init__(self, energy=0, time=0, peak_power=0, peak_voltage=0, peak_current=0,
n_samples=0, avg_voltage=0, avg_current=0, avg_power=0):
self.energy = float(energy)
self.time = float(time)
self.peak_power = float(peak_power)
self.peak_voltage = float(peak_voltage)
self.peak_current = float(peak_current)
self.n_samples = float(n_samples)
self.avg_voltage = float(avg_voltage)
self.avg_current = float(avg_current)
self.avg_power = float(avg_power)
self.version = Measurement.class_version
def _op_self(self, other, fn):
params = ["energy", "time", "peak_power", "peak_voltage", "peak_current",
"n_samples", "avg_voltage", "avg_current", "avg_power"]
m = Measurement()
for p in params:
m.__dict__[p] = fn(self.__dict__[p], other.__dict__[p])
return m
def _op_const(self, const, fn):
params = ["energy", "time", "peak_power", "peak_voltage", "peak_current",
"n_samples", "avg_voltage", "avg_current", "avg_power"]
m = Measurement()
for p in params:
m.__dict__[p] = fn(self.__dict__[p], const)
return m
def _op(self, other, fn):
if isinstance(other, Measurement):
return self._op_self(other, fn)
else:
return self._op_const(other, fn);
def __add__(self, other):
return self._op(other, operator.add)
def __sub__(self, other):
return self._op(other, operator.sub)
def __mul__(self, other):
return self._op(other, operator.mul)
def __div__(self, other):
return self._op(other, operator.div)
def __radd__(self, other):
return self._op(other, operator.add)
def __rsub__(self, other):
return self._op(other, operator.sub)
def __rmul__(self, other):
return self._op(other, operator.mul)
def __rdiv__(self, other):
return self._op(other, operator.div)
def __repr__(self):
return "Measurement(" + ", ".join(map("{0[0]}={0[1]}".format, self.__dict__.items())) + ")"
def __eq__(self, rhs):
params = ["energy", "time", "peak_power", "peak_voltage", "peak_current",
"n_samples", "avg_voltage", "avg_current", "avg_power"]
for p in params:
if self.__dict__[p] != rhs.__dict__[p]:
return False
return True
def __lt__(self, rhs):
params = ["energy", "time", "peak_power", "peak_voltage", "peak_current",
"n_samples", "avg_voltage", "avg_current", "avg_power"]
s1 = (self.__dict__[p] for p in params)
s2 = (rhs.__dict__[p] for p in params)
return s1 < s2
# Future proof for new version
def __getstate__(self):
return self.__dict__
def __setstate__(self, d):
if 'version' not in d or d['version'] < 1:
# likely to only happen when we have unversioned data
# so lets make this an info message instead of a warning
# as we've probably warned about it already
info("Upgrading to version 1")
d['version'] = 1
if "avg_power" not in d:
d['avg_power'] = d['energy'] / d['time']
# In future, if this class gets upgraded, add code here to upgrade from
# previous versions
if d['version'] > self.class_version:
error("Measurement was created with a newer version of pyenergy, please upgrade")
self.__dict__.update(d)
class EnergyMonitor(object):
"""
The class implements the interface over USB to the MAGEEC enenergy
monitor boards. This is fairly simple with pyusb, as all of the
commands are implemented over the control endpoint.
The class should be instantiated with a serial number, which tells
it which board to connect to.
em = EnergyMonitor("EE00")
Before measuring, the measurement point needs to be enabled. This
maps an ADC to the measurement point correctly.
em.enableMeasurementPoint(1)
After this, either a trigger can be set, or the measurement
manually start and stopped.
em.setTrigger("PA0", 1)
em.start(1)
em.stop(1)
The measurement can then be retrieved.
em.getMeasurement(1)
"""
MeasurementData = namedtuple('MeasurementData', 'energy_accum elapsed_time peak_power peak_voltage peak_current n_samples avg_current avg_voltage')
MeasurementData_packing = "=QQLLLLQQ"
InstantaneousData = namedtuple('InstantaneousData', 'voltage current average_voltage average_current current_time')
InstantaneousData_packing = "=LLLLQ"
ADC1 = 0
ADC2 = 1
ADC3 = 2
# These port mappings are the pins connected to voltage and current
# (respectively) on the stm32f4discovery board.
port_mappings = {1: ["PA2", "PC2"], 2: ["PA3", "PA1"], 3: ["PB1", "PC5"], 4:["PB0", "PC4"]}
# The boards did not use to have a version associated with them, the first
# version is version 10 (thus if we have an error getting the version we
# assume the board is older than version 10).
newestVersion = 13
baseVersion = 10
def __init__(self, serial="EE00"):
devs = self.getBoards()
sdevs = []
for d in devs:
try:
d.set_configuration()
except usb.core.USBError, e:
warning("Could not access one of the boards")
warning(str(e))
v = self.getVersion(d)
if v < EnergyMonitor.baseVersion:
warning("Device attached with old firmware, cannot check if this is desired device")
continue
if v < 13:
if usb.util.get_string(d, 3).encode("utf8","ignore") == serial:
error("You need to update the firmware on this board before you can use it")
continue
s = self.getSerial(d)
if s == serial:
sdevs.append(d)
# TODO else release config
devs = sdevs
if len(devs) > 1:
warning("More than one device ({}) available with serial {}".format(len(devs), serial))
if len(devs) == 0:
raise RuntimeError("Cannot find energy monitor with serial " + serial)
self.serial = serial
self.dev = devs[0]
# Set up default parameters for each measurement point
defaultparams = {'resistor':1, 'gain':50, 'vref':3}
self.measurement_params = {i : copy(defaultparams) for i in [1,2,3]}
# Measurement point 4 is the 'self' measurement point
self.measurement_params[4] = {'resistor':0.5, 'gain':50, 'vref':3}
# Equal to tperiod in the firmware
self.samplePeriod = 500
self.adcMpoint = [None, None, None]
@staticmethod
def getBoards():
"""Return a list of all energy monitor boards connected to the host"""
devs = list(usb.core.find(idVendor=0xf539, idProduct=0xf539, find_all = True))
return devs
# Connect to the device
def connect(self):
"""Connect to the specified board, and check firmware version"""
info("Connecting to energy monitor")
self.version = self.getVersion(self)
if self.version < EnergyMonitor.baseVersion or self.version < 13:
error("Firmware is too old, please update")
if self.version < EnergyMonitor.newestVersion:
warning("More recent firmware is available, please update")
# Get version
@staticmethod
def getVersion(dev):
"""
Get the API version of the energy monitoring boards. This may fail
if the firmware is old and does not implement this request,
therefore we catch this error.
"""
try:
dev = dev.dev
except:
pass
try:
b = dev.ctrl_transfer(0xc3, 12, 0, 0, 4)
except usb.core.USBError as e:
try:
b = dev.ctrl_transfer(0xc1, 12, 0, 0, 4)
except usb.core.USBError as e:
if e.errno == 32:
return 0
raise
version = unpack("=L", b)[0]
return version
# Get serial
@staticmethod
def getSerial(dev):
"""Get the serial from the board."""
try:
dev = dev.dev
except:
pass
b = dev.ctrl_transfer(0xc3, 13, 0, 0, 4)
serial = unpack("=4s", b)[0]
return serial
# Toggle the LEDs on the device
def toggleLEDs(self):
"""Toggle some of the LEDs on the board."""
self.dev.ctrl_transfer(0x43, 0, 0, 0, None)
# Start measuring on m_point
def start(self, m_point=1):
"""Clear the number of runs and start measurement on the specified
measurement point."""
self.clearNumberOfRuns()
self.dev.ctrl_transfer(0x43, 1, int(m_point), 0, None)
# Stop measuring on m_point
def stop(self, m_point=1):
"""Stop the measurement on the specified measurement point."""
self.dev.ctrl_transfer(0x43, 2, int(m_point), 0, None)
# Return whether the measurement point is currently taking
# measurements or not
def isRunning(self, m_point=1):
"""Check whether a particular measurement point is running."""
debug("Check if running")
b = self.dev.ctrl_transfer(0xc3, 8, int(m_point), 0, 4)
debug("Received bytes: {0}".format(b))
running = unpack("=L", b)
debug("Running: {0}".format(running))
return bool(running[0])
# This counts the number of end measurement signals caught
# by the energy monitor.
def getNumberOfRuns(self, m_point=1):
"""
Return the number of 'runs' seen by the energy monitor. This is
the number of times a full measurement has been taken since the
last clearNumberOfRuns call.
This is mostly used as part of checking whether a triggered
measurement has completed, in measurementComplete.
"""
debug("Get number of runs")
b = self.dev.ctrl_transfer(0xc3, 9, int(m_point), 0, 4)
runs = unpack("=L", b)
debug("Runs: {0}".format(runs[0]))
return int(runs[0])
# Reset the number of runs counts to 0
def clearNumberOfRuns(self, m_point=1):
"""Clear the counter used to store the number of runs."""
self.dev.ctrl_transfer(0x43, 10, int(m_point), 0, None)
# Have we completed a measurement?
def measurementCompleted(self, m_point = 1):
"""
Check whether a full measurement has been taken. Also clear the
number of runs if we are waiting for a trigger.
"""
runs = self.getNumberOfRuns(m_point)
if runs > 1:
warning("More than one measurement has completed (expected one)")
if not self.isRunning(m_point) and runs > 0:
self.clearNumberOfRuns(m_point)
return True
return False
# Set the serial number
def setSerial(self, ser):
"""Set the board's serial number. Must be exactly 4 characters long."""
if len(ser) != 4:
warning("Serial should be 4 characters.")
ser = (ser + "0000")[:4]
self.dev.ctrl_transfer(0x43, 3, ord(ser[0]) | (ord(ser[1])<<8), ord(ser[2]) | (ord(ser[3])<<8), None)
# Set a particular port as a pin trigger for a measurement point
# e.g PA0
def setTrigger(self, port, m_point=1):
"""
Set up a trigger on the specified port and measurement point. The
board will automatically start measuring when the pin rises, and
stop when the pin falls.
The port should be of the form P[A-H][0-9]. Not all pins on the
board will work, due to peripheral multiplexing and additional
components attached to some pins.
TODO: a list of acceptable and tested pins (PA0 works).
"""
# TODO check port is of the form PA0
info("Set trigger on {}".format(port))
self.dev.ctrl_transfer(0x43, 4, ord(port[1]) | (m_point<<8), int(port[2]), None)
# Enable a particular measurement point. There are
# only 3 ADCs in the device, so only 3 measurement points
# can be used simultaneously
def enableMeasurementPoint(self, m_point, adc=None):
"""
Enable a measurement point on the board.
There are only 3 ADCs and 4 measurement points. Additionally
certain ADCs can only measure certain measurement points,
hence this function to map an ADC to a measurement point.
This function records which measurement points are in use,
the attempts to map an ADC to it, if any are free.
"""
if m_point in self.adcMpoint:
warning("Tried to enable already enabled measurement point "+str(m_point))
return
if self.adcMpoint.count(None) == 0:
raise RuntimeError("Cannot enable measurement point {}. Maximum of enabled measurement points reached".format(m_point))
if adc is not None and self.adcMpoint[adc] is not None:
raise RuntimeError("Cannot enable map measurement point {0} to ADC{1}. ADC{1} already has measurement point {2}".format(m_point, adc, self.adcMpoint[adc]))
if adc is None:
# If we want mpoint 1 or 2 and ADC3 is free, prioritise it
# becuase ADC3 doesnt work with mpoint 3 or self
if m_point in [1, 2] and self.adcMpoint[2] is None:
adc = 2
else:
adc = self.adcMpoint.index(None)
if m_point in [3,4] and adc == 2:
raise RuntimeError("Measurement point {} cannot be used with ADC3 (the only free ADC)".format(m_point))
info("Measurement point {} mapped to ADC {}".format(m_point, adc))
self.adcMpoint[adc] = m_point
self.dev.ctrl_transfer(0x43, 7, int(m_point), adc, None)
# Disable a particular measurement point, so that the
# ADC could potentially be used with a different one
def disableMeasurementPoint(self, m_point):
"""
To disable the measurement point we simply remove it from the set
of mapped measurement points.
We also send a stop command, to ensure no further measurements are
taken.
"""
info("Disable measurement point {}".format(m_point))
if m_point not in self.adcMpoint:
warning("Tried to disable already disabled measurement point "+str(m_point))
return
adc = self.adcMpoint.index(m_point)
self.adcMpoint[adc] = None
# TODO remove the trigger
self.stop()
def convertData(self, md, resistor, gain, vref, samplePeriod):
"""
Convert the data from the raw form returned, and into standard
units.
"""
try:
en = float(vref)**2 / gain / resistor / 4096**2 * 2 * samplePeriod * 2 / 168000000. * md.energy_accum * 2
el = md.elapsed_time * 2. / 168000000 * 2
pp = float(vref)**2 / gain / resistor / 4096**2 * md.peak_power * 2
pv = float(vref) / 4096. * md.peak_voltage * 2
pi = float(vref) / gain / resistor / 4096. * md.peak_current
av = float(vref) / 4096. * md.avg_voltage / md.n_samples * 2
ai = float(vref) / gain / resistor / 4096. * md.avg_current / md.n_samples
ap = en/el
except ZeroDivisionError:
en, el, pp, pv, pi, av, ai, ap = 0, 0, 0, 0, 0, 0, 0, 0
m = Measurement(en, el, pp, pv, pi, md.n_samples, av, ai, ap)
return m
def getMeasurement(self, m_point=1):
"""
Get the most recent measurement taken for a particular measurement
point.
"""
info("getMeasurement")
b = self.dev.ctrl_transfer(0xc3, 6, int(m_point), 0, calcsize(EnergyMonitor.MeasurementData_packing))
u = EnergyMonitor.MeasurementData._make(unpack(EnergyMonitor.MeasurementData_packing, b))
info(u)
return self.convertData(u, samplePeriod=self.samplePeriod, **self.measurement_params[m_point])
# get an instantaneous measurement of voltage and current (debugging)
def getInstantaneous(self, m_point=1):
"""
This is mostly a debug function that returns the instantaneous
current and voltage, as well as an average of the current and
voltage over the last 32 samples.
"""
b = self.dev.ctrl_transfer(0xc3, 11, int(m_point), 0, calcsize(EnergyMonitor.InstantaneousData_packing))
args = list(unpack(EnergyMonitor.InstantaneousData_packing, b))
args.append(m_point)
return args
# Convert and display instantaneous measurement
def debugInstantaneous(self, v):
"""
Display the data returned in getInstantaneous.
"""
mp = v[5]
resistor = self.measurement_params[mp]['resistor']
gain = self.measurement_params[mp]['gain']
vref = self.measurement_params[mp]['vref']
print "Timestamp:", v[4] * 2. / 168000000 * 2
print "Current: Raw={:4d} Voltage@{}={:1.3f}V Res Vdrop={:1.5f}V Current={:1.5f}A".format(mp,
EnergyMonitor.port_mappings[mp][1],
v[3]/4096.*vref,
float(vref) / gain / 4096. * v[3],
float(vref) / gain / resistor / 4096. * v[3])
print "Voltage: Raw={:4d} Voltage@{}={:1.3f}V Voltage={:1.5f}V".format(v[2],
EnergyMonitor.port_mappings[mp][0],
v[2]/4096.*vref,
float(vref) / 4096. * v[2] * 2)
print ""
def disconnect(self):
"""For now this doesn't do anything"""
pass
if __name__ == "__main__":
from time import sleep
em = EnergyMonitor("EE00")
em.connect()
em.toggleLEDs()
em.enableMeasurementPoint(1)
em.enableMeasurementPoint(2)
em.setTrigger("PA0", 1)
em.setTrigger("PA0", 2)
print "*** Press the blue button to make a measurement"
while True:
while not em.measurementCompleted(): sleep(0.1)
print em.getMeasurement(1)
print em.getMeasurement(2)