energymeter.py 48 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697
  1. #!/usr/bin/env python3
  2. """
  3. EnergyMeter: A Python module for interfacing with several energy meters.
  4. """
  5. __author__ = 'Stan Janssen'
  6. __email__ = 'stanjanssen@finetuned.nl'
  7. __url__ = 'https://finetuned.nl/'
  8. __license__ = 'Apache License, Version 2.0'
  9. __version__ = '0.72'
  10. __status__ = 'Beta'
  11. import random
  12. import socket
  13. import struct
  14. import time
  15. import minimalmodbus
  16. class ABBMeter:
  17. """Meter class that uses a minimalmodbus Instrument to query an ABB meter."""
  18. def __init__(self, port, baudrate=38400, slaveaddress=1, type=None):
  19. """ Initialize the ABBMeter object.
  20. Arguments:
  21. * port: a serial port (string)
  22. * baudrate: the baudrate to use (integer)
  23. * slaveaddress: the address of the modbus device (integer)
  24. * Specification of the type. Used to limit the registers to a specific set.
  25. Returns:
  26. * An ABBMeter object
  27. """
  28. minimalmodbus.BAUDRATE = baudrate
  29. minimalmodbus.TIMEOUT = 0.5
  30. self.instrument = minimalmodbus.Instrument(port, slaveaddress)
  31. if type in ABBMeter.REGSETS:
  32. self.registers = [register for register in ABBMeter.REGS if register['name'] in ABBMeter.REGSETS[type]]
  33. else:
  34. self.registers = ABBMeter.REGS
  35. def read(self, regnames=None):
  36. """ Read one, many or all registers from the device
  37. Args:
  38. * registers (str or list). If None, read all. If string, read
  39. single register. If list, read all registers from list.
  40. Returns:
  41. * If single register, it returns a single value. If all or list,
  42. return a dict with the keys and values.
  43. Raises:
  44. * KeyError, TypeError, IOError
  45. """
  46. if regnames is None:
  47. return self._batch_read(self.registers)
  48. if type(regnames) is list:
  49. registers = [register for register in self.registers if register['name'] in regnames]
  50. if len(registers) < len(regnames):
  51. regs_not_available = [regname for regname in regnames if regname not in \
  52. [register['name'] for register in self.registers]]
  53. print("Warning: the following registers are not available on this device: " +
  54. ", ".join(regs_not_available))
  55. print("The available registers are: %s" +
  56. ", ".join(register['name'] for register in self.registers))
  57. if len(registers) == 0:
  58. return {}
  59. registers.sort(key=lambda reg: reg['start'])
  60. return self._batch_read(registers)
  61. elif type(regnames) is str:
  62. register = [register for register in self.registers if register['name'] is regnames][0]
  63. return self._read_single(register)
  64. else:
  65. raise TypeError
  66. def _read_single(self, register):
  67. """
  68. Read a single register and return the value.
  69. """
  70. if register['length'] is 1:
  71. return self.instrument.read_register(registeraddress=register['start'],
  72. numberOfDecimals=register['decimals'],
  73. signed=register['signed'])
  74. if register['length'] is 2:
  75. value = self.instrument.read_long(registeraddress=register['start'],
  76. signed=register['signed'])
  77. return value / 10 ** register['decimals']
  78. if register['length'] is 4:
  79. value = self.instrument.read_registers(registeraddress=register['start'],
  80. numberOfRegisters=register['length'])
  81. return self._convert_value(bytestring=bytes(value),
  82. signed=register['signed'],
  83. numberOfDecimals=register['decimals'])
  84. def _read_multiple(self, registers):
  85. """
  86. Read multiple registers from the slave device and return their values as a dict.
  87. Arguments:
  88. * A list of registers (complete structs)
  89. Returns:
  90. * A dict containing all keys and values
  91. """
  92. first_reg = min([register['start'] for register in registers])
  93. num_regs = max([register['start'] + register['length'] for register in registers]) - first_reg
  94. values = self.instrument.read_registers(registeraddress=first_reg,
  95. numberOfRegisters=num_regs)
  96. return self._interpret_result(values, registers)
  97. def _batch_read(self, registers):
  98. """
  99. Read multiple registers in batches, limiting each batch to at most 128 registers.
  100. Arguments:
  101. * A list of registers (complete structs)
  102. Returns:
  103. * A dict containing all keys and values
  104. """
  105. # Count up to at most 128 registers:
  106. start_reg = registers[0]['start']
  107. batch = []
  108. results = {}
  109. for register in registers:
  110. if register['start'] + register['length'] - start_reg < 128:
  111. batch.append(register)
  112. else:
  113. results.update(self._read_multiple(batch))
  114. batch = []
  115. batch.append(register)
  116. start_reg = register['start']
  117. results.update(self._read_multiple(batch))
  118. return results
  119. def _interpret_result(self, data, registers):
  120. """
  121. Pull the returned string apart and package the data back to its
  122. intended form.
  123. Arguments:
  124. * data: list of register values returned from the device
  125. * registers: the original requested set of registers
  126. Returns:
  127. * A dict containing the register names and resulting values
  128. """
  129. first_reg = min([register['start'] for register in registers])
  130. results = {}
  131. for register in registers:
  132. regname = register['name']
  133. start = register['start'] - first_reg
  134. end = start + register['length']
  135. values = data[start:end]
  136. results[regname] = self._convert_value(values=values,
  137. signed=register['signed'],
  138. numberOfDecimals=register['decimals'])
  139. return results
  140. def _convert_value(self, values, signed=False, numberOfDecimals=0):
  141. """
  142. Convert a list of returned integers to the intended value.
  143. Arguments:
  144. * bytestring: a list of integers that together represent the value
  145. * signed: whether the value is a signed value
  146. * decimals: number of decimals the return value should contain
  147. """
  148. numberOfRegisters = len(values)
  149. formatcode_i = '>'
  150. formatcode_o = '>'
  151. if numberOfRegisters == 1:
  152. formatcode_i += "H"
  153. if signed:
  154. formatcode_o += "h"
  155. else:
  156. formatcode_o += "H"
  157. if numberOfRegisters == 2:
  158. formatcode_i += 'HH'
  159. if signed:
  160. formatcode_o += "l"
  161. else:
  162. formatcode_o += "L"
  163. if numberOfRegisters == 4:
  164. formatcode_i += "HHHH"
  165. if signed:
  166. formatcode_o += "q"
  167. else:
  168. formatcode_o += "Q"
  169. bytestring = struct.pack(formatcode_i, *values)
  170. value = struct.unpack(formatcode_o, bytestring)[0]
  171. if value in ABBMeter.NULLS:
  172. return None
  173. else:
  174. return float(value) / 10 ** numberOfDecimals
  175. # Register map of the ABB A and B series energy meters.
  176. REGS = [{'name': 'active_import', 'start': 20480, 'length': 4, 'signed': True, 'decimals': 2},
  177. {'name': 'active_export', 'start': 20484, 'length': 4, 'signed': True, 'decimals': 2},
  178. {'name': 'active_net', 'start': 20488, 'length': 4, 'signed': True, 'decimals': 2},
  179. {'name': 'reactive_import', 'start': 20492, 'length': 4, 'signed': True, 'decimals': 2},
  180. {'name': 'reactive_export', 'start': 20496, 'length': 4, 'signed': True, 'decimals': 2},
  181. {'name': 'reactive_net', 'start': 20500, 'length': 4, 'signed': True, 'decimals': 2},
  182. {'name': 'apparent_import', 'start': 20504, 'length': 4, 'signed': True, 'decimals': 2},
  183. {'name': 'apparent_export', 'start': 20508, 'length': 4, 'signed': True, 'decimals': 2},
  184. {'name': 'apparent_net', 'start': 20512, 'length': 4, 'signed': True, 'decimals': 2},
  185. {'name': 'active_import_co2', 'start': 20516, 'length': 4, 'signed': True, 'decimals': 2},
  186. {'name': 'active_import_currency', 'start': 20532, 'length': 4, 'signed': True, 'decimals': 2},
  187. {'name': 'active_import_tariff_1', 'start': 20848, 'length': 4, 'signed': False, 'decimals': 2},
  188. {'name': 'active_import_tariff_2', 'start': 20852, 'length': 4, 'signed': False, 'decimals': 2},
  189. {'name': 'active_import_tariff_3', 'start': 20856, 'length': 4, 'signed': False, 'decimals': 2},
  190. {'name': 'active_import_tariff_4', 'start': 20860, 'length': 4, 'signed': False, 'decimals': 2},
  191. {'name': 'active_export_tariff_1', 'start': 20880, 'length': 4, 'signed': False, 'decimals': 2},
  192. {'name': 'active_export_tariff_2', 'start': 20884, 'length': 4, 'signed': False, 'decimals': 2},
  193. {'name': 'active_export_tariff_3', 'start': 20888, 'length': 4, 'signed': False, 'decimals': 2},
  194. {'name': 'active_export_tariff_4', 'start': 20892, 'length': 4, 'signed': False, 'decimals': 2},
  195. {'name': 'reactive_import_tariff_1', 'start': 20912, 'length': 4, 'signed': False, 'decimals': 2},
  196. {'name': 'reactive_import_tariff_2', 'start': 20916, 'length': 4, 'signed': False, 'decimals': 2},
  197. {'name': 'reactive_import_tariff_3', 'start': 20920, 'length': 4, 'signed': False, 'decimals': 2},
  198. {'name': 'reactive_import_tariff_4', 'start': 20924, 'length': 4, 'signed': False, 'decimals': 2},
  199. {'name': 'reactive_export_tariff_1', 'start': 20944, 'length': 4, 'signed': False, 'decimals': 2},
  200. {'name': 'reactive_export_tariff_2', 'start': 20948, 'length': 4, 'signed': False, 'decimals': 2},
  201. {'name': 'reactive_export_tariff_3', 'start': 20952, 'length': 4, 'signed': False, 'decimals': 2},
  202. {'name': 'reactive_export_tariff_4', 'start': 20956, 'length': 4, 'signed': False, 'decimals': 2},
  203. {'name': 'active_import_l1', 'start': 21600, 'length': 4, 'signed': False, 'decimals': 2},
  204. {'name': 'active_import_l2', 'start': 21604, 'length': 4, 'signed': False, 'decimals': 2},
  205. {'name': 'active_import_l3', 'start': 21608, 'length': 4, 'signed': False, 'decimals': 2},
  206. {'name': 'active_export_l1', 'start': 21612, 'length': 4, 'signed': False, 'decimals': 2},
  207. {'name': 'active_export_l2', 'start': 21616, 'length': 4, 'signed': False, 'decimals': 2},
  208. {'name': 'active_export_l3', 'start': 21620, 'length': 4, 'signed': False, 'decimals': 2},
  209. {'name': 'active_net_l1', 'start': 21624, 'length': 4, 'signed': True, 'decimals': 2},
  210. {'name': 'active_net_l2', 'start': 21628, 'length': 4, 'signed': True, 'decimals': 2},
  211. {'name': 'active_net_l3', 'start': 21632, 'length': 4, 'signed': True, 'decimals': 2},
  212. {'name': 'reactive_import_l1', 'start': 21636, 'length': 4, 'signed': False, 'decimals': 2},
  213. {'name': 'reactive_import_l2', 'start': 21640, 'length': 4, 'signed': False, 'decimals': 2},
  214. {'name': 'reactive_import_l3', 'start': 21644, 'length': 4, 'signed': False, 'decimals': 2},
  215. {'name': 'reactive_export_l1', 'start': 21648, 'length': 4, 'signed': False, 'decimals': 2},
  216. {'name': 'reactive_export_l2', 'start': 21652, 'length': 4, 'signed': False, 'decimals': 2},
  217. {'name': 'reactive_export_l3', 'start': 21656, 'length': 4, 'signed': False, 'decimals': 2},
  218. {'name': 'reactive_net_l1', 'start': 21660, 'length': 4, 'signed': True, 'decimals': 2},
  219. {'name': 'reactive_net_l2', 'start': 21664, 'length': 4, 'signed': True, 'decimals': 2},
  220. {'name': 'reactive_net_l3', 'start': 21668, 'length': 4, 'signed': True, 'decimals': 2},
  221. {'name': 'apparent_import_l1', 'start': 21672, 'length': 4, 'signed': False, 'decimals': 2},
  222. {'name': 'apparent_import_l2', 'start': 21676, 'length': 4, 'signed': False, 'decimals': 2},
  223. {'name': 'apparent_import_l3', 'start': 21680, 'length': 4, 'signed': False, 'decimals': 2},
  224. {'name': 'apparent_export_l1', 'start': 21684, 'length': 4, 'signed': False, 'decimals': 2},
  225. {'name': 'apparent_export_l2', 'start': 21688, 'length': 4, 'signed': False, 'decimals': 2},
  226. {'name': 'apparent_export_l3', 'start': 21692, 'length': 4, 'signed': False, 'decimals': 2},
  227. {'name': 'apparent_net_l1', 'start': 21696, 'length': 4, 'signed': True, 'decimals': 2},
  228. {'name': 'apparent_net_l2', 'start': 21700, 'length': 4, 'signed': True, 'decimals': 2},
  229. {'name': 'apparent_net_l3', 'start': 21704, 'length': 4, 'signed': True, 'decimals': 2},
  230. {'name': 'resettable_active_import', 'start': 21804, 'length': 4, 'signed': False, 'decimals': 2},
  231. {'name': 'resettable_active_export', 'start': 21808, 'length': 4, 'signed': False, 'decimals': 2},
  232. {'name': 'resettable_reactive_import', 'start': 21812, 'length': 4, 'signed': False, 'decimals': 2},
  233. {'name': 'resettable_reactive_export', 'start': 21816, 'length': 4, 'signed': False, 'decimals': 2},
  234. {'name': 'voltage_l1_n', 'start': 23296, 'length': 2, 'signed': False, 'decimals': 1},
  235. {'name': 'voltage_l2_n', 'start': 23298, 'length': 2, 'signed': False, 'decimals': 1},
  236. {'name': 'voltage_l3_n', 'start': 23300, 'length': 2, 'signed': False, 'decimals': 1},
  237. {'name': 'voltage_l1_l2', 'start': 23302, 'length': 2, 'signed': False, 'decimals': 1},
  238. {'name': 'voltage_l3_l2', 'start': 23304, 'length': 2, 'signed': False, 'decimals': 1},
  239. {'name': 'voltage_l1_l3', 'start': 23306, 'length': 2, 'signed': False, 'decimals': 1},
  240. {'name': 'current_l1', 'start': 23308, 'length': 2, 'signed': False, 'decimals': 2},
  241. {'name': 'current_l2', 'start': 23310, 'length': 2, 'signed': False, 'decimals': 2},
  242. {'name': 'current_l3', 'start': 23312, 'length': 2, 'signed': False, 'decimals': 2},
  243. {'name': 'current_n', 'start': 23314, 'length': 2, 'signed': False, 'decimals': 2},
  244. {'name': 'active_power_total', 'start': 23316, 'length': 2, 'signed': True, 'decimals': 2},
  245. {'name': 'active_power_l1', 'start': 23318, 'length': 2, 'signed': True, 'decimals': 2},
  246. {'name': 'active_power_l2', 'start': 23320, 'length': 2, 'signed': True, 'decimals': 2},
  247. {'name': 'active_power_l3', 'start': 23322, 'length': 2, 'signed': True, 'decimals': 2},
  248. {'name': 'reactive_power_total', 'start': 23324, 'length': 2, 'signed': True, 'decimals': 2},
  249. {'name': 'reactive_power_l1', 'start': 23326, 'length': 2, 'signed': True, 'decimals': 2},
  250. {'name': 'reactive_power_l2', 'start': 23328, 'length': 2, 'signed': True, 'decimals': 2},
  251. {'name': 'reactive_power_l3', 'start': 23330, 'length': 2, 'signed': True, 'decimals': 2},
  252. {'name': 'apparent_power_total', 'start': 23332, 'length': 2, 'signed': True, 'decimals': 2},
  253. {'name': 'apparent_power_l1', 'start': 23334, 'length': 2, 'signed': True, 'decimals': 2},
  254. {'name': 'apparent_power_l2', 'start': 23336, 'length': 2, 'signed': True, 'decimals': 2},
  255. {'name': 'apparent_power_l3', 'start': 23338, 'length': 2, 'signed': True, 'decimals': 2},
  256. {'name': 'frequency', 'start': 23340, 'length': 1, 'signed': False, 'decimals': 2},
  257. {'name': 'phase_angle_power_total', 'start': 23341, 'length': 1, 'signed': True, 'decimals': 1},
  258. {'name': 'phase_angle_power_l1', 'start': 23342, 'length': 1, 'signed': True, 'decimals': 1},
  259. {'name': 'phase_angle_power_l2', 'start': 23343, 'length': 1, 'signed': True, 'decimals': 1},
  260. {'name': 'phase_angle_power_l3', 'start': 23344, 'length': 1, 'signed': True, 'decimals': 1},
  261. {'name': 'phase_angle_voltage_l1', 'start': 23345, 'length': 1, 'signed': True, 'decimals': 1},
  262. {'name': 'phase_angle_voltage_l2', 'start': 23346, 'length': 1, 'signed': True, 'decimals': 1},
  263. {'name': 'phase_angle_voltage_l3', 'start': 23347, 'length': 1, 'signed': True, 'decimals': 1},
  264. {'name': 'phase_angle_current_l1', 'start': 23351, 'length': 1, 'signed': True, 'decimals': 1},
  265. {'name': 'phase_angle_current_l2', 'start': 23352, 'length': 1, 'signed': True, 'decimals': 1},
  266. {'name': 'phase_angle_current_l3', 'start': 23353, 'length': 1, 'signed': True, 'decimals': 1},
  267. {'name': 'power_factor_total', 'start': 23354, 'length': 1, 'signed': True, 'decimals': 3},
  268. {'name': 'power_factor_l1', 'start': 23355, 'length': 1, 'signed': True, 'decimals': 3},
  269. {'name': 'power_factor_l2', 'start': 23356, 'length': 1, 'signed': True, 'decimals': 3},
  270. {'name': 'power_factor_l3', 'start': 23357, 'length': 1, 'signed': True, 'decimals': 3},
  271. {'name': 'current_quadrant_total', 'start': 23358, 'length': 1, 'signed': False, 'decimals': 0},
  272. {'name': 'current_quadrant_l1', 'start': 23359, 'length': 1, 'signed': False, 'decimals': 0},
  273. {'name': 'current_quadrant_l2', 'start': 23360, 'length': 1, 'signed': False, 'decimals': 0},
  274. {'name': 'current_quadrant_l3', 'start': 23361, 'length': 1, 'signed': False, 'decimals': 0},
  275. {'name': 'voltage_harmonics_l1_n_thd', 'start': 23808, 'length': 2, 'signed': False, 'decimals': 1},
  276. {'name': 'voltage_harmonics_l1_n_2nd', 'start': 23810, 'length': 2, 'signed': False, 'decimals': 1},
  277. {'name': 'voltage_harmonics_l1_n_3rd', 'start': 23812, 'length': 2, 'signed': False, 'decimals': 1},
  278. {'name': 'voltage_harmonics_l1_n_4th', 'start': 23814, 'length': 2, 'signed': False, 'decimals': 1},
  279. {'name': 'voltage_harmonics_l1_n_5th', 'start': 23816, 'length': 2, 'signed': False, 'decimals': 1},
  280. {'name': 'voltage_harmonics_l1_n_6th', 'start': 23818, 'length': 2, 'signed': False, 'decimals': 1},
  281. {'name': 'voltage_harmonics_l1_n_7th', 'start': 23820, 'length': 2, 'signed': False, 'decimals': 1},
  282. {'name': 'voltage_harmonics_l1_n_8th', 'start': 23822, 'length': 2, 'signed': False, 'decimals': 1},
  283. {'name': 'voltage_harmonics_l1_n_9th', 'start': 23824, 'length': 2, 'signed': False, 'decimals': 1},
  284. {'name': 'voltage_harmonics_l1_n_10th', 'start': 23826, 'length': 2, 'signed': False, 'decimals': 1},
  285. {'name': 'voltage_harmonics_l1_n_11th', 'start': 23828, 'length': 2, 'signed': False, 'decimals': 1},
  286. {'name': 'voltage_harmonics_l1_n_12th', 'start': 23830, 'length': 2, 'signed': False, 'decimals': 1},
  287. {'name': 'voltage_harmonics_l1_n_13th', 'start': 23832, 'length': 2, 'signed': False, 'decimals': 1},
  288. {'name': 'voltage_harmonics_l1_n_14th', 'start': 23834, 'length': 2, 'signed': False, 'decimals': 1},
  289. {'name': 'voltage_harmonics_l1_n_15th', 'start': 23836, 'length': 2, 'signed': False, 'decimals': 1},
  290. {'name': 'voltage_harmonics_l1_n_16th', 'start': 23838, 'length': 2, 'signed': False, 'decimals': 1},
  291. {'name': 'voltage_harmonics_l2_n_thd', 'start': 23936, 'length': 2, 'signed': False, 'decimals': 1},
  292. {'name': 'voltage_harmonics_l2_n_2nd', 'start': 23938, 'length': 2, 'signed': False, 'decimals': 1},
  293. {'name': 'voltage_harmonics_l2_n_3rd', 'start': 23940, 'length': 2, 'signed': False, 'decimals': 1},
  294. {'name': 'voltage_harmonics_l2_n_4th', 'start': 23942, 'length': 2, 'signed': False, 'decimals': 1},
  295. {'name': 'voltage_harmonics_l2_n_5th', 'start': 23944, 'length': 2, 'signed': False, 'decimals': 1},
  296. {'name': 'voltage_harmonics_l2_n_6th', 'start': 23946, 'length': 2, 'signed': False, 'decimals': 1},
  297. {'name': 'voltage_harmonics_l2_n_7th', 'start': 23948, 'length': 2, 'signed': False, 'decimals': 1},
  298. {'name': 'voltage_harmonics_l2_n_8th', 'start': 23950, 'length': 2, 'signed': False, 'decimals': 1},
  299. {'name': 'voltage_harmonics_l2_n_9th', 'start': 23952, 'length': 2, 'signed': False, 'decimals': 1},
  300. {'name': 'voltage_harmonics_l2_n_10th', 'start': 23954, 'length': 2, 'signed': False, 'decimals': 1},
  301. {'name': 'voltage_harmonics_l2_n_11th', 'start': 23956, 'length': 2, 'signed': False, 'decimals': 1},
  302. {'name': 'voltage_harmonics_l2_n_12th', 'start': 23958, 'length': 2, 'signed': False, 'decimals': 1},
  303. {'name': 'voltage_harmonics_l2_n_13th', 'start': 23960, 'length': 2, 'signed': False, 'decimals': 1},
  304. {'name': 'voltage_harmonics_l2_n_14th', 'start': 23962, 'length': 2, 'signed': False, 'decimals': 1},
  305. {'name': 'voltage_harmonics_l2_n_15th', 'start': 23964, 'length': 2, 'signed': False, 'decimals': 1},
  306. {'name': 'voltage_harmonics_l2_n_16th', 'start': 23966, 'length': 2, 'signed': False, 'decimals': 1},
  307. {'name': 'voltage_harmonics_l3_n_thd', 'start': 24064, 'length': 2, 'signed': False, 'decimals': 1},
  308. {'name': 'voltage_harmonics_l3_n_2nd', 'start': 24066, 'length': 2, 'signed': False, 'decimals': 1},
  309. {'name': 'voltage_harmonics_l3_n_3rd', 'start': 24068, 'length': 2, 'signed': False, 'decimals': 1},
  310. {'name': 'voltage_harmonics_l3_n_4th', 'start': 24070, 'length': 2, 'signed': False, 'decimals': 1},
  311. {'name': 'voltage_harmonics_l3_n_5th', 'start': 24072, 'length': 2, 'signed': False, 'decimals': 1},
  312. {'name': 'voltage_harmonics_l3_n_6th', 'start': 24074, 'length': 2, 'signed': False, 'decimals': 1},
  313. {'name': 'voltage_harmonics_l3_n_7th', 'start': 24076, 'length': 2, 'signed': False, 'decimals': 1},
  314. {'name': 'voltage_harmonics_l3_n_8th', 'start': 24078, 'length': 2, 'signed': False, 'decimals': 1},
  315. {'name': 'voltage_harmonics_l3_n_9th', 'start': 24080, 'length': 2, 'signed': False, 'decimals': 1},
  316. {'name': 'voltage_harmonics_l3_n_10th', 'start': 24082, 'length': 2, 'signed': False, 'decimals': 1},
  317. {'name': 'voltage_harmonics_l3_n_11th', 'start': 24084, 'length': 2, 'signed': False, 'decimals': 1},
  318. {'name': 'voltage_harmonics_l3_n_12th', 'start': 24086, 'length': 2, 'signed': False, 'decimals': 1},
  319. {'name': 'voltage_harmonics_l3_n_13th', 'start': 24088, 'length': 2, 'signed': False, 'decimals': 1},
  320. {'name': 'voltage_harmonics_l3_n_14th', 'start': 24090, 'length': 2, 'signed': False, 'decimals': 1},
  321. {'name': 'voltage_harmonics_l3_n_15th', 'start': 24092, 'length': 2, 'signed': False, 'decimals': 1},
  322. {'name': 'voltage_harmonics_l3_n_16th', 'start': 24094, 'length': 2, 'signed': False, 'decimals': 1},
  323. {'name': 'voltage_harmonics_l1_l2_thd', 'start': 24192, 'length': 2, 'signed': False, 'decimals': 1},
  324. {'name': 'voltage_harmonics_l1_l2_2nd', 'start': 24194, 'length': 2, 'signed': False, 'decimals': 1},
  325. {'name': 'voltage_harmonics_l1_l2_3rd', 'start': 24196, 'length': 2, 'signed': False, 'decimals': 1},
  326. {'name': 'voltage_harmonics_l1_l2_4th', 'start': 24198, 'length': 2, 'signed': False, 'decimals': 1},
  327. {'name': 'voltage_harmonics_l1_l2_5th', 'start': 24200, 'length': 2, 'signed': False, 'decimals': 1},
  328. {'name': 'voltage_harmonics_l1_l2_6th', 'start': 24202, 'length': 2, 'signed': False, 'decimals': 1},
  329. {'name': 'voltage_harmonics_l1_l2_7th', 'start': 24204, 'length': 2, 'signed': False, 'decimals': 1},
  330. {'name': 'voltage_harmonics_l1_l2_8th', 'start': 24206, 'length': 2, 'signed': False, 'decimals': 1},
  331. {'name': 'voltage_harmonics_l1_l2_9th', 'start': 24208, 'length': 2, 'signed': False, 'decimals': 1},
  332. {'name': 'voltage_harmonics_l1_l2_10th', 'start': 24210, 'length': 2, 'signed': False, 'decimals': 1},
  333. {'name': 'voltage_harmonics_l1_l2_11th', 'start': 24212, 'length': 2, 'signed': False, 'decimals': 1},
  334. {'name': 'voltage_harmonics_l1_l2_12th', 'start': 24214, 'length': 2, 'signed': False, 'decimals': 1},
  335. {'name': 'voltage_harmonics_l1_l2_13th', 'start': 24216, 'length': 2, 'signed': False, 'decimals': 1},
  336. {'name': 'voltage_harmonics_l1_l2_14th', 'start': 24218, 'length': 2, 'signed': False, 'decimals': 1},
  337. {'name': 'voltage_harmonics_l1_l2_15th', 'start': 24220, 'length': 2, 'signed': False, 'decimals': 1},
  338. {'name': 'voltage_harmonics_l1_l2_16th', 'start': 24222, 'length': 2, 'signed': False, 'decimals': 1},
  339. {'name': 'voltage_harmonics_l3_l2_thd', 'start': 24320, 'length': 2, 'signed': False, 'decimals': 1},
  340. {'name': 'voltage_harmonics_l3_l2_2nd', 'start': 24322, 'length': 2, 'signed': False, 'decimals': 1},
  341. {'name': 'voltage_harmonics_l3_l2_3rd', 'start': 24324, 'length': 2, 'signed': False, 'decimals': 1},
  342. {'name': 'voltage_harmonics_l3_l2_4th', 'start': 24326, 'length': 2, 'signed': False, 'decimals': 1},
  343. {'name': 'voltage_harmonics_l3_l2_5th', 'start': 24328, 'length': 2, 'signed': False, 'decimals': 1},
  344. {'name': 'voltage_harmonics_l3_l2_6th', 'start': 24330, 'length': 2, 'signed': False, 'decimals': 1},
  345. {'name': 'voltage_harmonics_l3_l2_7th', 'start': 24332, 'length': 2, 'signed': False, 'decimals': 1},
  346. {'name': 'voltage_harmonics_l3_l2_8th', 'start': 24334, 'length': 2, 'signed': False, 'decimals': 1},
  347. {'name': 'voltage_harmonics_l3_l2_9th', 'start': 24336, 'length': 2, 'signed': False, 'decimals': 1},
  348. {'name': 'voltage_harmonics_l3_l2_10th', 'start': 24338, 'length': 2, 'signed': False, 'decimals': 1},
  349. {'name': 'voltage_harmonics_l3_l2_11th', 'start': 24340, 'length': 2, 'signed': False, 'decimals': 1},
  350. {'name': 'voltage_harmonics_l3_l2_12th', 'start': 24342, 'length': 2, 'signed': False, 'decimals': 1},
  351. {'name': 'voltage_harmonics_l3_l2_13th', 'start': 24344, 'length': 2, 'signed': False, 'decimals': 1},
  352. {'name': 'voltage_harmonics_l3_l2_14th', 'start': 24346, 'length': 2, 'signed': False, 'decimals': 1},
  353. {'name': 'voltage_harmonics_l3_l2_15th', 'start': 24348, 'length': 2, 'signed': False, 'decimals': 1},
  354. {'name': 'voltage_harmonics_l3_l2_16th', 'start': 24350, 'length': 2, 'signed': False, 'decimals': 1},
  355. {'name': 'voltage_harmonics_l1_l3_thd', 'start': 24448, 'length': 2, 'signed': False, 'decimals': 1},
  356. {'name': 'voltage_harmonics_l1_l3_2nd', 'start': 24450, 'length': 2, 'signed': False, 'decimals': 1},
  357. {'name': 'voltage_harmonics_l1_l3_3rd', 'start': 24452, 'length': 2, 'signed': False, 'decimals': 1},
  358. {'name': 'voltage_harmonics_l1_l3_4th', 'start': 24454, 'length': 2, 'signed': False, 'decimals': 1},
  359. {'name': 'voltage_harmonics_l1_l3_5th', 'start': 24456, 'length': 2, 'signed': False, 'decimals': 1},
  360. {'name': 'voltage_harmonics_l1_l3_6th', 'start': 24458, 'length': 2, 'signed': False, 'decimals': 1},
  361. {'name': 'voltage_harmonics_l1_l3_7th', 'start': 24460, 'length': 2, 'signed': False, 'decimals': 1},
  362. {'name': 'voltage_harmonics_l1_l3_8th', 'start': 24462, 'length': 2, 'signed': False, 'decimals': 1},
  363. {'name': 'voltage_harmonics_l1_l3_9th', 'start': 24464, 'length': 2, 'signed': False, 'decimals': 1},
  364. {'name': 'voltage_harmonics_l1_l3_10th', 'start': 24466, 'length': 2, 'signed': False, 'decimals': 1},
  365. {'name': 'voltage_harmonics_l1_l3_11th', 'start': 24468, 'length': 2, 'signed': False, 'decimals': 1},
  366. {'name': 'voltage_harmonics_l1_l3_12th', 'start': 24470, 'length': 2, 'signed': False, 'decimals': 1},
  367. {'name': 'voltage_harmonics_l1_l3_13th', 'start': 24472, 'length': 2, 'signed': False, 'decimals': 1},
  368. {'name': 'voltage_harmonics_l1_l3_14th', 'start': 24474, 'length': 2, 'signed': False, 'decimals': 1},
  369. {'name': 'voltage_harmonics_l1_l3_15th', 'start': 24476, 'length': 2, 'signed': False, 'decimals': 1},
  370. {'name': 'voltage_harmonics_l1_l3_16th', 'start': 24478, 'length': 2, 'signed': False, 'decimals': 1},
  371. {'name': 'current_harmonics_l1_thd', 'start': 24576, 'length': 2, 'signed': False, 'decimals': 1},
  372. {'name': 'current_harmonics_l1_2nd', 'start': 24578, 'length': 2, 'signed': False, 'decimals': 1},
  373. {'name': 'current_harmonics_l1_3rd', 'start': 24580, 'length': 2, 'signed': False, 'decimals': 1},
  374. {'name': 'current_harmonics_l1_4th', 'start': 24582, 'length': 2, 'signed': False, 'decimals': 1},
  375. {'name': 'current_harmonics_l1_5th', 'start': 24584, 'length': 2, 'signed': False, 'decimals': 1},
  376. {'name': 'current_harmonics_l1_6th', 'start': 24586, 'length': 2, 'signed': False, 'decimals': 1},
  377. {'name': 'current_harmonics_l1_7th', 'start': 24588, 'length': 2, 'signed': False, 'decimals': 1},
  378. {'name': 'current_harmonics_l1_8th', 'start': 24590, 'length': 2, 'signed': False, 'decimals': 1},
  379. {'name': 'current_harmonics_l1_9th', 'start': 24592, 'length': 2, 'signed': False, 'decimals': 1},
  380. {'name': 'current_harmonics_l1_10th', 'start': 24594, 'length': 2, 'signed': False, 'decimals': 1},
  381. {'name': 'current_harmonics_l1_11th', 'start': 24596, 'length': 2, 'signed': False, 'decimals': 1},
  382. {'name': 'current_harmonics_l1_12th', 'start': 24598, 'length': 2, 'signed': False, 'decimals': 1},
  383. {'name': 'current_harmonics_l1_13th', 'start': 24600, 'length': 2, 'signed': False, 'decimals': 1},
  384. {'name': 'current_harmonics_l1_14th', 'start': 24602, 'length': 2, 'signed': False, 'decimals': 1},
  385. {'name': 'current_harmonics_l1_15th', 'start': 24604, 'length': 2, 'signed': False, 'decimals': 1},
  386. {'name': 'current_harmonics_l1_16th', 'start': 24606, 'length': 2, 'signed': False, 'decimals': 1},
  387. {'name': 'current_harmonics_l2_thd', 'start': 24704, 'length': 2, 'signed': False, 'decimals': 1},
  388. {'name': 'current_harmonics_l2_2nd', 'start': 24706, 'length': 2, 'signed': False, 'decimals': 1},
  389. {'name': 'current_harmonics_l2_3rd', 'start': 24708, 'length': 2, 'signed': False, 'decimals': 1},
  390. {'name': 'current_harmonics_l2_4th', 'start': 24710, 'length': 2, 'signed': False, 'decimals': 1},
  391. {'name': 'current_harmonics_l2_5th', 'start': 24712, 'length': 2, 'signed': False, 'decimals': 1},
  392. {'name': 'current_harmonics_l2_6th', 'start': 24714, 'length': 2, 'signed': False, 'decimals': 1},
  393. {'name': 'current_harmonics_l2_7th', 'start': 24716, 'length': 2, 'signed': False, 'decimals': 1},
  394. {'name': 'current_harmonics_l2_8th', 'start': 24718, 'length': 2, 'signed': False, 'decimals': 1},
  395. {'name': 'current_harmonics_l2_9th', 'start': 24720, 'length': 2, 'signed': False, 'decimals': 1},
  396. {'name': 'current_harmonics_l2_10th', 'start': 24722, 'length': 2, 'signed': False, 'decimals': 1},
  397. {'name': 'current_harmonics_l2_11th', 'start': 24724, 'length': 2, 'signed': False, 'decimals': 1},
  398. {'name': 'current_harmonics_l2_12th', 'start': 24726, 'length': 2, 'signed': False, 'decimals': 1},
  399. {'name': 'current_harmonics_l2_13th', 'start': 24728, 'length': 2, 'signed': False, 'decimals': 1},
  400. {'name': 'current_harmonics_l2_14th', 'start': 24730, 'length': 2, 'signed': False, 'decimals': 1},
  401. {'name': 'current_harmonics_l2_15th', 'start': 24732, 'length': 2, 'signed': False, 'decimals': 1},
  402. {'name': 'current_harmonics_l2_16th', 'start': 24734, 'length': 2, 'signed': False, 'decimals': 1},
  403. {'name': 'current_harmonics_l3_thd', 'start': 24832, 'length': 2, 'signed': False, 'decimals': 1},
  404. {'name': 'current_harmonics_l3_2nd', 'start': 24834, 'length': 2, 'signed': False, 'decimals': 1},
  405. {'name': 'current_harmonics_l3_3rd', 'start': 24836, 'length': 2, 'signed': False, 'decimals': 1},
  406. {'name': 'current_harmonics_l3_4th', 'start': 24838, 'length': 2, 'signed': False, 'decimals': 1},
  407. {'name': 'current_harmonics_l3_5th', 'start': 24840, 'length': 2, 'signed': False, 'decimals': 1},
  408. {'name': 'current_harmonics_l3_6th', 'start': 24842, 'length': 2, 'signed': False, 'decimals': 1},
  409. {'name': 'current_harmonics_l3_7th', 'start': 24844, 'length': 2, 'signed': False, 'decimals': 1},
  410. {'name': 'current_harmonics_l3_8th', 'start': 24846, 'length': 2, 'signed': False, 'decimals': 1},
  411. {'name': 'current_harmonics_l3_9th', 'start': 24848, 'length': 2, 'signed': False, 'decimals': 1},
  412. {'name': 'current_harmonics_l3_10th', 'start': 24850, 'length': 2, 'signed': False, 'decimals': 1},
  413. {'name': 'current_harmonics_l3_11th', 'start': 24852, 'length': 2, 'signed': False, 'decimals': 1},
  414. {'name': 'current_harmonics_l3_12th', 'start': 24854, 'length': 2, 'signed': False, 'decimals': 1},
  415. {'name': 'current_harmonics_l3_13th', 'start': 24856, 'length': 2, 'signed': False, 'decimals': 1},
  416. {'name': 'current_harmonics_l3_14th', 'start': 24858, 'length': 2, 'signed': False, 'decimals': 1},
  417. {'name': 'current_harmonics_l3_15th', 'start': 24860, 'length': 2, 'signed': False, 'decimals': 1},
  418. {'name': 'current_harmonics_l3_16th', 'start': 24862, 'length': 2, 'signed': False, 'decimals': 1},
  419. {'name': 'current_harmonics_n_thd', 'start': 24960, 'length': 2, 'signed': False, 'decimals': 1},
  420. {'name': 'current_harmonics_n_2nd', 'start': 24962, 'length': 2, 'signed': False, 'decimals': 1},
  421. {'name': 'current_harmonics_n_3rd', 'start': 24964, 'length': 2, 'signed': False, 'decimals': 1},
  422. {'name': 'current_harmonics_n_4th', 'start': 24966, 'length': 2, 'signed': False, 'decimals': 1},
  423. {'name': 'current_harmonics_n_5th', 'start': 24968, 'length': 2, 'signed': False, 'decimals': 1},
  424. {'name': 'current_harmonics_n_6th', 'start': 24970, 'length': 2, 'signed': False, 'decimals': 1},
  425. {'name': 'current_harmonics_n_7th', 'start': 24972, 'length': 2, 'signed': False, 'decimals': 1},
  426. {'name': 'current_harmonics_n_8th', 'start': 24974, 'length': 2, 'signed': False, 'decimals': 1},
  427. {'name': 'current_harmonics_n_9th', 'start': 24976, 'length': 2, 'signed': False, 'decimals': 1},
  428. {'name': 'current_harmonics_n_10th', 'start': 24978, 'length': 2, 'signed': False, 'decimals': 1},
  429. {'name': 'current_harmonics_n_11th', 'start': 24980, 'length': 2, 'signed': False, 'decimals': 1},
  430. {'name': 'current_harmonics_n_12th', 'start': 24982, 'length': 2, 'signed': False, 'decimals': 1},
  431. {'name': 'current_harmonics_n_13th', 'start': 24984, 'length': 2, 'signed': False, 'decimals': 1},
  432. {'name': 'current_harmonics_n_14th', 'start': 24986, 'length': 2, 'signed': False, 'decimals': 1},
  433. {'name': 'current_harmonics_n_15th', 'start': 24988, 'length': 2, 'signed': False, 'decimals': 1},
  434. {'name': 'current_harmonics_n_16th', 'start': 24990, 'length': 2, 'signed': False, 'decimals': 1}]
  435. REGSETS = {
  436. "A43": ["active_import", "active_export", "active_net",
  437. "reactive_import", "reactive_export", "reactive_net",
  438. "apparent_import", "apparent_export", "apparent_net",
  439. "active_import_co2", "active_import_currency",
  440. "active_import_l1", "active_import_l2", "active_import_l3",
  441. "active_export_l1", "active_export_l2", "active_export_l3",
  442. "active_net_l1", "active_net_l2", "active_net_l3",
  443. "reactive_import_l1", "reactive_import_l2",
  444. "reactive_import_l3", "reactive_export_l1",
  445. "reactive_export_l2", "reactive_export_l3",
  446. "reactive_net_l1", "reactive_net_l2", "reactive_net_l3",
  447. "apparent_import_l1", "apparent_import_l2",
  448. "apparent_import_l3", "apparent_export_l1",
  449. "apparent_export_l2", "apparent_export_l3",
  450. "apparent_net_l1", "apparent_net_l2", "apparent_net_l3",
  451. "voltage_l1_n", "voltage_l2_n", "voltage_l3_n",
  452. "voltage_l1_l2", "voltage_l3_l2", "voltage_l1_l3",
  453. "current_l1", "current_l2", "current_l3",
  454. "active_power_total", "active_power_l1", "active_power_l2",
  455. "active_power_l3", "reactive_power_total",
  456. "reactive_power_l1", "reactive_power_l2",
  457. "reactive_power_l3", "apparent_power_total",
  458. "apparent_power_l1", "apparent_power_l2",
  459. "apparent_power_l3", "frequency", "phase_angle_power_total",
  460. "power_factor_total", "power_factor_l1", "power_factor_l2",
  461. "power_factor_l3", "current_quadrant_total",
  462. "current_quadrant_l1", "current_quadrant_l2",
  463. "current_quadrant_l3"],
  464. "B23": ["active_import", "active_export", "active_net",
  465. "reactive_import", "reactive_export", "reactive_net",
  466. "apparent_import", "apparent_export", "apparent_net",
  467. "active_import_co2", "active_import_currency",
  468. "active_import_l1", "active_import_l2", "active_import_l3",
  469. "active_export_l1", "active_export_l2", "active_export_l3",
  470. "active_net_l1", "active_net_l2", "active_net_l3",
  471. "reactive_import_l1", "reactive_import_l2",
  472. "reactive_import_l3", "reactive_export_l1",
  473. "reactive_export_l2", "reactive_export_l3",
  474. "reactive_net_l1", "reactive_net_l2", "reactive_net_l3",
  475. "apparent_import_l1", "apparent_import_l2",
  476. "apparent_import_l3", "apparent_export_l1",
  477. "apparent_export_l2", "apparent_export_l3",
  478. "apparent_net_l1", "apparent_net_l2", "apparent_net_l3",
  479. "voltage_l1_n", "voltage_l2_n", "voltage_l3_n",
  480. "voltage_l1_l2", "voltage_l3_l2", "voltage_l1_l3",
  481. "current_l1", "current_l2", "current_l3",
  482. "active_power_total", "active_power_l1", "active_power_l2",
  483. "active_power_l3", "reactive_power_total",
  484. "reactive_power_l1", "reactive_power_l2",
  485. "reactive_power_l3", "apparent_power_total",
  486. "apparent_power_l1", "apparent_power_l2",
  487. "apparent_power_l3", "frequency", "phase_angle_power_total",
  488. "power_factor_total", "power_factor_l1", "power_factor_l2",
  489. "power_factor_l3", "current_quadrant_total",
  490. "current_quadrant_l1", "current_quadrant_l2",
  491. "current_quadrant_l3"],
  492. "B21": ["active_import", "active_export", "active_net",
  493. "reactive_import", "reactive_export", "reactive_net",
  494. "apparent_import", "apparent_export", "apparent_net",
  495. "active_import_co2", "active_import_currency",
  496. "voltage_l1_n", "current_l1", "active_power_total",
  497. "reactive_power_total", "apparent_power_total", "frequency",
  498. "phase_angle_power_total", "power_factor_total",
  499. "current_quadrant_total"]
  500. }
  501. NULLS = [pow(2, n) - 1 for n in (64, 63, 32, 31, 16, 15)]
  502. class SMAMeter:
  503. """
  504. Implementation for a Sunny Boy SMA Modbus over TCP meter.
  505. """
  506. def __init__(self, port, tcp_port=502, slaveaddress=126, type=None, baudrate=None):
  507. self.device = socket.create_connection(address=(port, tcp_port))
  508. self.device_id = slaveaddress
  509. def read(self, regnames=None):
  510. if regnames is None:
  511. registers = SMAMeter.REGS
  512. return self._read_multiple(registers)
  513. if type(regnames) is str:
  514. register = [register for register in SMAMeter.REGS if register['name'] is regnames][0]
  515. return self._read_single(register)
  516. if type(regnames) is list:
  517. registers = [register for register in SMAMeter.REGS if register['name'] in regnames]
  518. return self._read_multiple(registers)
  519. def _read_single(self, register):
  520. message = self._modbus_message(start_reg=register['start'], num_regs=1)
  521. data = self._perform_request(message)
  522. return self._convert_value(data, signed=register['signed'], decimals=register['decimals'])
  523. def _read_multiple(self, registers):
  524. registers.sort(key=lambda reg: reg['start'])
  525. first_reg = min([register['start'] for register in registers])
  526. num_regs = max([register['start'] + register['length'] for register in registers]) - first_reg
  527. message = self._modbus_message(start_reg=first_reg, num_regs=num_regs)
  528. data = self._perform_request(message)
  529. return self._interpret_result(data, registers)
  530. def _modbus_message(self, start_reg, num_regs):
  531. transaction_id = random.randint(1, 2**16 - 1)
  532. return struct.pack(">HHHBBHH", transaction_id,
  533. SMAMeter.PROTOCOL_CODE,
  534. 6,
  535. self.device_id,
  536. SMAMeter.FUNCTION_CODE,
  537. start_reg - SMAMeter.REG_OFFSET,
  538. num_regs)
  539. def _perform_request(self, message):
  540. self.device.send(message)
  541. data = bytes()
  542. expect_bytes = 9 + 2 * struct.unpack(">H", message[-2:])[0]
  543. attempt = 1
  544. while len(data) is not expect_bytes:
  545. time.sleep(0.05)
  546. data += self.device.recv(2048)
  547. if attempt >= 10:
  548. return 2 * struct.unpack(">H", message[-2:])[0] * [0]
  549. attempt += 1
  550. return data[9:]
  551. def _interpret_result(self, data, registers):
  552. """
  553. Pull the returned string apart and package the data back to its
  554. intended form.
  555. Arguments:
  556. * data: list of register values returned from the device
  557. * registers: the original requested set of registers
  558. Returns:
  559. * A dict containing the register names and resulting values
  560. """
  561. first_reg = min([register['start'] for register in registers])
  562. results = {}
  563. for register in registers:
  564. regname = register['name']
  565. start = (register['start'] - first_reg) * 2
  566. end = start + register['length'] * 2
  567. values = data[start:end]
  568. results[regname] = self._convert_value(values=values,
  569. signed=register['signed'],
  570. decimals=register['decimals'])
  571. if regname == "power_factor_total" and results[regname] == 0:
  572. results[regname] = 1 # The SMA will send out a 0 when the power factor is 100%
  573. return results
  574. def _convert_value(self, values, signed=False, decimals=0):
  575. """
  576. Convert a list of returned integers to the intended value.
  577. Arguments:
  578. * bytestring: a list of integers that together represent the value
  579. * signed: whether the value is a signed value
  580. * decimals: number of decimals the return value should contain
  581. """
  582. numberOfBytes = len(values)
  583. formatcode_o = '>'
  584. if numberOfBytes == 1:
  585. if signed:
  586. formatcode_o += "b"
  587. else:
  588. formatcode_o += "B"
  589. if numberOfBytes == 2:
  590. if signed:
  591. formatcode_o += "h"
  592. else:
  593. formatcode_o += "H"
  594. if numberOfBytes == 4:
  595. if signed:
  596. formatcode_o += "l"
  597. else:
  598. formatcode_o += "L"
  599. value = struct.unpack(formatcode_o, bytes(values))[0]
  600. if value in SMAMeter.NULLS:
  601. return None
  602. else:
  603. return float(value) / 10 ** decimals
  604. REGS = [
  605. {'name': 'current_ac', 'start': 40188, 'length': 1, 'signed': False, 'decimals': 1},
  606. {'name': 'current_l1', 'start': 40189, 'length': 1, 'signed': False, 'decimals': 1},
  607. {'name': 'current_l2', 'start': 40190, 'length': 1, 'signed': False, 'decimals': 1},
  608. {'name': 'current_l3', 'start': 40191, 'length': 1, 'signed': False, 'decimals': 1},
  609. {'name': 'voltage_l1_l2', 'start': 40193, 'length': 1, 'signed': False, 'decimals': 1},
  610. {'name': 'voltage_l2_l3', 'start': 40194, 'length': 1, 'signed': False, 'decimals': 1},
  611. {'name': 'voltage_l3_l1', 'start': 40195, 'length': 1, 'signed': False, 'decimals': 1},
  612. {'name': 'voltage_l1_n', 'start': 40196, 'length': 1, 'signed': False, 'decimals': 1},
  613. {'name': 'voltage_l2_n', 'start': 40197, 'length': 1, 'signed': False, 'decimals': 1},
  614. {'name': 'voltage_l3_n', 'start': 40198, 'length': 1, 'signed': False, 'decimals': 1},
  615. {'name': 'active_power_total', 'start': 40200, 'length': 1, 'signed': True, 'decimals': -1},
  616. {'name': 'frequency', 'start': 40202, 'length': 1, 'signed': False, 'decimals': 2},
  617. {'name': 'apparent_power_total', 'start': 40204, 'length': 1, 'signed': True, 'decimals': -1},
  618. {'name': 'reactive_power_total', 'start': 40206, 'length': 1, 'signed': True, 'decimals': -1},
  619. {'name': 'power_factor_total', 'start': 40208, 'length': 1, 'signed': True, 'decimals': 3},
  620. {'name': 'active_export', 'start': 40210, 'length': 2, 'signed': False, 'decimals': 3},
  621. {'name': 'dc_power', 'start': 40217, 'length': 1, 'signed': False, 'decimals': -1},
  622. {'name': 'temperature_internal', 'start': 40219, 'length': 1, 'signed': False, 'decimals': 0},
  623. {'name': 'temperature_other', 'start': 40222, 'length': 1, 'signed': False, 'decimals': 0},
  624. {'name': 'operating_status', 'start': 40224, 'length': 1, 'signed': False, 'decimals': 0}
  625. ]
  626. REG_OFFSET = 1
  627. PROTOCOL_CODE = 0
  628. FUNCTION_CODE = 3
  629. NULLS = [2**16 - 1, 2**15 - 1, 2**15, -2**15]
  630. if __name__ == "__main__":
  631. import json
  632. import datetime
  633. sma = SMAMeter('192.168.0.235')
  634. while True:
  635. values = sma.read()
  636. print(datetime.datetime.now())
  637. print(json.dumps(values, indent=4))