Home Explore Help
Register Sign In
stan
/
python-energymeter
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: 205015bb03
Branches Tags
python-energ...
/
energymeter.py

energymeter.py 49 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721 
  1. #!/usr/bin/env python3
    2. 

  2. 

  3. """
    4. 

  4. EnergyMeter: A Python module for interfacing with several energy meters.
    5. 

  5. """
    6. 

  6. 

  7. __author__  = 'Stan Janssen'
    8. 

  8. __email__   = 'stanjanssen@finetuned.nl'
    9. 

  9. __url__     = 'https://finetuned.nl/'
    10. 

  10. __license__ = 'Apache License, Version 2.0'
    11. 

  11. 

  12. __version__ = '0.73'
    13. 

  13. __status__  = 'Beta'
    14. 

  14. 

  15. import random
    16. 

  16. import socket
    17. 

  17. import struct
    18. 

  18. import time
    19. 

  19. import minimalmodbus
    20. 

  20. 

  21. class ABBMeter:
    22. 

  22.     """Meter class that uses a minimalmodbus Instrument to query an ABB meter."""
    23. 

  23.     def __init__(self, port, baudrate=38400, slaveaddress=1, type=None):
    24. 

  24.         """ Initialize the ABBMeter object.
    25. 

  25. 

  26.         Arguments:
    27. 

  27.             * port: a serial port (string)
    28. 

  28.             * baudrate: the baudrate to use (integer)
    29. 

  29.             * slaveaddress: the address of the modbus device (integer)
    30. 

  30.             * Specification of the type. Used to limit the registers to a specific set.
    31. 

  31. 

  32.         Returns:
    33. 

  33.             * An ABBMeter object
    34. 

  34. 

  35.         """
    36. 

  36.         minimalmodbus.BAUDRATE = baudrate
    37. 

  37.         minimalmodbus.TIMEOUT = 0.5
    38. 

  38.         self.instrument = minimalmodbus.Instrument(port, slaveaddress)
    39. 

  39.         if type in ABBMeter.REGSETS:
    40. 

  40.             self.registers = [register for register in ABBMeter.REGS if register['name'] in ABBMeter.REGSETS[type]]
    41. 

  41.         else:
    42. 

  42.             self.registers = ABBMeter.REGS
    43. 

  43. 

  44.     def read(self, regnames=None):
    45. 

  45.         """ Read one, many or all registers from the device
    46. 

  46. 

  47.         Args:
    48. 

  48.             * registers (str or list). If None, read all. If string, read
    49. 

  49.               single register. If list, read all registers from list.
    50. 

  50. 

  51.         Returns:
    52. 

  52.             * If single register, it returns a single value. If all or list,
    53. 

  53.               return a dict with the keys and values.
    54. 

  54. 

  55.         Raises:
    56. 

  56.             * KeyError, TypeError, IOError
    57. 

  57.         """
    58. 

  58.         if regnames is None:
    59. 

  59.             return self._batch_read(self.registers)
    60. 

  60.         if type(regnames) is list:
    61. 

  61.             registers = [register for register in self.registers if register['name'] in regnames]
    62. 

  62.             if len(registers) < len(regnames):
    63. 

  63.                 regs_not_available = [regname for regname in regnames if regname not in \
    64. 

  64.                                       [register['name'] for register in self.registers]]
    65. 

  65.                 print("Warning: the following registers are not available on this device: " +
    66. 

  66.                       ", ".join(regs_not_available))
    67. 

  67.                 print("The available registers are: %s" +
    68. 

  68.                       ", ".join(register['name'] for register in self.registers))
    69. 

  69.             if len(registers) == 0:
    70. 

  70.                 return {}
    71. 

  71.             registers.sort(key=lambda reg: reg['start'])
    72. 

  72.             return self._batch_read(registers)
    73. 

  73.         elif type(regnames) is str:
    74. 

  74.             registers = [register for register in self.registers if register['name'] == regnames]
    75. 

  75.             if len(registers) == 0:
    76. 

  76.                 return "Register not found on device."
    77. 

  77.             return self._read_single(registers[0])
    78. 

  78.         else:
    79. 

  79.             raise TypeError
    80. 

  80. 

  81.     def _read_single(self, register):
    82. 

  82.         """
    83. 

  83.         Read a single register and return the value.
    84. 

  84.         """
    85. 

  85. 

  86.         if register['length'] is 1:
    87. 

  87.             return self.instrument.read_register(registeraddress=register['start'],
    88. 

  88.                                                  numberOfDecimals=register['decimals'],
    89. 

  89.                                                  signed=register['signed'])
    90. 

  90.         if register['length'] is 2:
    91. 

  91.             value = self.instrument.read_long(registeraddress=register['start'],
    92. 

  92.                                               signed=register['signed'])
    93. 

  93.             return value / 10 ** register['decimals']
    94. 

  94. 

  95.         if register['length'] is 4:
    96. 

  96.             value = self.instrument.read_registers(registeraddress=register['start'],
    97. 

  97.                                                    numberOfRegisters=register['length'])
    98. 

  98.             return self._convert_value(values=value,
    99. 

  99.                                        signed=register['signed'],
    100. 

  100.                                        numberOfDecimals=register['decimals'])
    101. 

  101. 

  102.     def _read_multiple(self, registers):
    103. 

  103.         """
    104. 

  104.         Read multiple registers from the slave device and return their values as a dict.
    105. 

  105. 

  106.         Arguments:
    107. 

  107.             * A list of registers (complete structs)
    108. 

  108. 

  109.         Returns:
    110. 

  110.             * A dict containing all keys and values
    111. 

  111.         """
    112. 

  112. 

  113.         first_reg = min([register['start'] for register in registers])
    114. 

  114.         num_regs = max([register['start'] + register['length'] for register in registers]) - first_reg
    115. 

  115.         values = self.instrument.read_registers(registeraddress=first_reg,
    116. 

  116.                                                 numberOfRegisters=num_regs)
    117. 

  117.         return self._interpret_result(values, registers)
    118. 

  118. 

  119.     def _batch_read(self, registers):
    120. 

  120.         """
    121. 

  121.         Read multiple registers in batches, limiting each batch to at most 128 registers.
    122. 

  122. 

  123.         Arguments:
    124. 

  124.             * A list of registers (complete structs)
    125. 

  125. 

  126.         Returns:
    127. 

  127.             * A dict containing all keys and values
    128. 

  128.         """
    129. 

  129.         # Count up to at most 128 registers:
    130. 

  130.         start_reg = registers[0]['start']
    131. 

  131.         batch = []
    132. 

  132.         results = {}
    133. 

  133.         for register in registers:
    134. 

  134.             if register['start'] + register['length'] - start_reg < 128:
    135. 

  135.                 batch.append(register)
    136. 

  136.             else:
    137. 

  137.                 results.update(self._read_multiple(batch))
    138. 

  138.                 batch = []
    139. 

  139.                 batch.append(register)
    140. 

  140.                 start_reg = register['start']
    141. 

  141. 

  142.         results.update(self._read_multiple(batch))
    143. 

  143.         return results
    144. 

  144. 

  145.     def _interpret_result(self, data, registers):
    146. 

  146.         """
    147. 

  147.         Pull the returned string apart and package the data back to its
    148. 

  148.         intended form.
    149. 

  149. 

  150.         Arguments:
    151. 

  151.             * data: list of register values returned from the device
    152. 

  152.             * registers: the original requested set of registers
    153. 

  153. 

  154.         Returns:
    155. 

  155.             * A dict containing the register names and resulting values
    156. 

  156. 

  157.         """
    158. 

  158.         first_reg = min([register['start'] for register in registers])
    159. 

  159. 

  160.         results = {}
    161. 

  161.         for register in registers:
    162. 

  162.             regname = register['name']
    163. 

  163.             start = register['start'] - first_reg
    164. 

  164.             end = start + register['length']
    165. 

  165.             values = data[start:end]
    166. 

  166.             results[regname] = self._convert_value(values=values,
    167. 

  167.                                                    signed=register['signed'],
    168. 

  168.                                                    numberOfDecimals=register['decimals'])
    169. 

  169.         return results
    170. 

  170. 

  171.     def _convert_value(self, values, signed=False, numberOfDecimals=0):
    172. 

  172.         """
    173. 

  173.         Convert a list of returned integers to the intended value.
    174. 

  174. 

  175.         Arguments:
    176. 

  176.             * bytestring: a list of integers that together represent the value
    177. 

  177.             * signed: whether the value is a signed value
    178. 

  178.             * decimals: number of decimals the return value should contain
    179. 

  179.         """
    180. 

  180. 

  181.         numberOfRegisters = len(values)
    182. 

  182.         formatcode_i = '>'
    183. 

  183.         formatcode_o = '>'
    184. 

  184. 

  185.         if numberOfRegisters == 1:
    186. 

  186.             formatcode_i += "H"
    187. 

  187.             if signed:
    188. 

  188.                 formatcode_o += "h"
    189. 

  189.             else:
    190. 

  190.                 formatcode_o += "H"
    191. 

  191. 

  192.         if numberOfRegisters == 2:
    193. 

  193.             formatcode_i += 'HH'
    194. 

  194.             if signed:
    195. 

  195.                 formatcode_o += "l"
    196. 

  196.             else:
    197. 

  197.                 formatcode_o += "L"
    198. 

  198. 

  199.         if numberOfRegisters == 4:
    200. 

  200.             formatcode_i += "HHHH"
    201. 

  201.             if signed:
    202. 

  202.                 formatcode_o += "q"
    203. 

  203.             else:
    204. 

  204.                 formatcode_o += "Q"
    205. 

  205. 

  206.         bytestring = struct.pack(formatcode_i, *values)
    207. 

  207.         value = struct.unpack(formatcode_o, bytestring)[0]
    208. 

  208. 

  209.         if value in ABBMeter.NULLS:
    210. 

  210.             return None
    211. 

  211.         else:
    212. 

  212.             return float(value) / 10 ** numberOfDecimals
    213. 

  213. 

  214.     # Register map of the ABB A and B series energy meters.
    215. 

  215.     REGS = [{'name': 'active_import',              'start': 20480, 'length': 4, 'signed': True, 'decimals': 2},
    216. 

  216.             {'name': 'active_export',              'start': 20484, 'length': 4, 'signed': True, 'decimals': 2},
    217. 

  217.             {'name': 'active_net',                 'start': 20488, 'length': 4, 'signed': True, 'decimals': 2},
    218. 

  218.             {'name': 'reactive_import',            'start': 20492, 'length': 4, 'signed': True, 'decimals': 2},
    219. 

  219.             {'name': 'reactive_export',            'start': 20496, 'length': 4, 'signed': True, 'decimals': 2},
    220. 

  220.             {'name': 'reactive_net',               'start': 20500, 'length': 4, 'signed': True, 'decimals': 2},
    221. 

  221.             {'name': 'apparent_import',            'start': 20504, 'length': 4, 'signed': True, 'decimals': 2},
    222. 

  222.             {'name': 'apparent_export',            'start': 20508, 'length': 4, 'signed': True, 'decimals': 2},
    223. 

  223.             {'name': 'apparent_net',               'start': 20512, 'length': 4, 'signed': True, 'decimals': 2},
    224. 

  224.             {'name': 'active_import_co2',          'start': 20516, 'length': 4, 'signed': True, 'decimals': 2},
    225. 

  225.             {'name': 'active_import_currency',     'start': 20532, 'length': 4, 'signed': True, 'decimals': 2},
    226. 

  226.             {'name': 'active_import_tariff_1',     'start': 20848, 'length': 4, 'signed': False, 'decimals': 2},
    227. 

  227.             {'name': 'active_import_tariff_2',     'start': 20852, 'length': 4, 'signed': False, 'decimals': 2},
    228. 

  228.             {'name': 'active_import_tariff_3',     'start': 20856, 'length': 4, 'signed': False, 'decimals': 2},
    229. 

  229.             {'name': 'active_import_tariff_4',     'start': 20860, 'length': 4, 'signed': False, 'decimals': 2},
    230. 

  230.             {'name': 'active_export_tariff_1',     'start': 20880, 'length': 4, 'signed': False, 'decimals': 2},
    231. 

  231.             {'name': 'active_export_tariff_2',     'start': 20884, 'length': 4, 'signed': False, 'decimals': 2},
    232. 

  232.             {'name': 'active_export_tariff_3',     'start': 20888, 'length': 4, 'signed': False, 'decimals': 2},
    233. 

  233.             {'name': 'active_export_tariff_4',     'start': 20892, 'length': 4, 'signed': False, 'decimals': 2},
    234. 

  234.             {'name': 'reactive_import_tariff_1',   'start': 20912, 'length': 4, 'signed': False, 'decimals': 2},
    235. 

  235.             {'name': 'reactive_import_tariff_2',   'start': 20916, 'length': 4, 'signed': False, 'decimals': 2},
    236. 

  236.             {'name': 'reactive_import_tariff_3',   'start': 20920, 'length': 4, 'signed': False, 'decimals': 2},
    237. 

  237.             {'name': 'reactive_import_tariff_4',   'start': 20924, 'length': 4, 'signed': False, 'decimals': 2},
    238. 

  238.             {'name': 'reactive_export_tariff_1',   'start': 20944, 'length': 4, 'signed': False, 'decimals': 2},
    239. 

  239.             {'name': 'reactive_export_tariff_2',   'start': 20948, 'length': 4, 'signed': False, 'decimals': 2},
    240. 

  240.             {'name': 'reactive_export_tariff_3',   'start': 20952, 'length': 4, 'signed': False, 'decimals': 2},
    241. 

  241.             {'name': 'reactive_export_tariff_4',   'start': 20956, 'length': 4, 'signed': False, 'decimals': 2},
    242. 

  242.             {'name': 'active_import_l1',           'start': 21600, 'length': 4, 'signed': False, 'decimals': 2},
    243. 

  243.             {'name': 'active_import_l2',           'start': 21604, 'length': 4, 'signed': False, 'decimals': 2},
    244. 

  244.             {'name': 'active_import_l3',           'start': 21608, 'length': 4, 'signed': False, 'decimals': 2},
    245. 

  245.             {'name': 'active_export_l1',           'start': 21612, 'length': 4, 'signed': False, 'decimals': 2},
    246. 

  246.             {'name': 'active_export_l2',           'start': 21616, 'length': 4, 'signed': False, 'decimals': 2},
    247. 

  247.             {'name': 'active_export_l3',           'start': 21620, 'length': 4, 'signed': False, 'decimals': 2},
    248. 

  248.             {'name': 'active_net_l1',              'start': 21624, 'length': 4, 'signed': True, 'decimals': 2},
    249. 

  249.             {'name': 'active_net_l2',              'start': 21628, 'length': 4, 'signed': True, 'decimals': 2},
    250. 

  250.             {'name': 'active_net_l3',              'start': 21632, 'length': 4, 'signed': True, 'decimals': 2},
    251. 

  251.             {'name': 'reactive_import_l1',         'start': 21636, 'length': 4, 'signed': False, 'decimals': 2},
    252. 

  252.             {'name': 'reactive_import_l2',         'start': 21640, 'length': 4, 'signed': False, 'decimals': 2},
    253. 

  253.             {'name': 'reactive_import_l3',         'start': 21644, 'length': 4, 'signed': False, 'decimals': 2},
    254. 

  254.             {'name': 'reactive_export_l1',         'start': 21648, 'length': 4, 'signed': False, 'decimals': 2},
    255. 

  255.             {'name': 'reactive_export_l2',         'start': 21652, 'length': 4, 'signed': False, 'decimals': 2},
    256. 

  256.             {'name': 'reactive_export_l3',         'start': 21656, 'length': 4, 'signed': False, 'decimals': 2},
    257. 

  257.             {'name': 'reactive_net_l1',            'start': 21660, 'length': 4, 'signed': True, 'decimals': 2},
    258. 

  258.             {'name': 'reactive_net_l2',            'start': 21664, 'length': 4, 'signed': True, 'decimals': 2},
    259. 

  259.             {'name': 'reactive_net_l3',            'start': 21668, 'length': 4, 'signed': True, 'decimals': 2},
    260. 

  260.             {'name': 'apparent_import_l1',         'start': 21672, 'length': 4, 'signed': False, 'decimals': 2},
    261. 

  261.             {'name': 'apparent_import_l2',         'start': 21676, 'length': 4, 'signed': False, 'decimals': 2},
    262. 

  262.             {'name': 'apparent_import_l3',         'start': 21680, 'length': 4, 'signed': False, 'decimals': 2},
    263. 

  263.             {'name': 'apparent_export_l1',         'start': 21684, 'length': 4, 'signed': False, 'decimals': 2},
    264. 

  264.             {'name': 'apparent_export_l2',         'start': 21688, 'length': 4, 'signed': False, 'decimals': 2},
    265. 

  265.             {'name': 'apparent_export_l3',         'start': 21692, 'length': 4, 'signed': False, 'decimals': 2},
    266. 

  266.             {'name': 'apparent_net_l1',            'start': 21696, 'length': 4, 'signed': True, 'decimals': 2},
    267. 

  267.             {'name': 'apparent_net_l2',            'start': 21700, 'length': 4, 'signed': True, 'decimals': 2},
    268. 

  268.             {'name': 'apparent_net_l3',            'start': 21704, 'length': 4, 'signed': True, 'decimals': 2},
    269. 

  269.             {'name': 'resettable_active_import',   'start': 21804, 'length': 4, 'signed': False, 'decimals': 2},
    270. 

  270.             {'name': 'resettable_active_export',   'start': 21808, 'length': 4, 'signed': False, 'decimals': 2},
    271. 

  271.             {'name': 'resettable_reactive_import', 'start': 21812, 'length': 4, 'signed': False, 'decimals': 2},
    272. 

  272.             {'name': 'resettable_reactive_export', 'start': 21816, 'length': 4, 'signed': False, 'decimals': 2},
    273. 

  273.             {'name': 'voltage_l1_n',               'start': 23296, 'length': 2, 'signed': False, 'decimals': 1},
    274. 

  274.             {'name': 'voltage_l2_n',               'start': 23298, 'length': 2, 'signed': False, 'decimals': 1},
    275. 

  275.             {'name': 'voltage_l3_n',               'start': 23300, 'length': 2, 'signed': False, 'decimals': 1},
    276. 

  276.             {'name': 'voltage_l1_l2',              'start': 23302, 'length': 2, 'signed': False, 'decimals': 1},
    277. 

  277.             {'name': 'voltage_l3_l2',              'start': 23304, 'length': 2, 'signed': False, 'decimals': 1},
    278. 

  278.             {'name': 'voltage_l1_l3',              'start': 23306, 'length': 2, 'signed': False, 'decimals': 1},
    279. 

  279.             {'name': 'current_l1',                 'start': 23308, 'length': 2, 'signed': False, 'decimals': 2},
    280. 

  280.             {'name': 'current_l2',                 'start': 23310, 'length': 2, 'signed': False, 'decimals': 2},
    281. 

  281.             {'name': 'current_l3',                 'start': 23312, 'length': 2, 'signed': False, 'decimals': 2},
    282. 

  282.             {'name': 'current_n',                  'start': 23314, 'length': 2, 'signed': False, 'decimals': 2},
    283. 

  283.             {'name': 'active_power_total',         'start': 23316, 'length': 2, 'signed': True, 'decimals': 2},
    284. 

  284.             {'name': 'active_power_l1',            'start': 23318, 'length': 2, 'signed': True, 'decimals': 2},
    285. 

  285.             {'name': 'active_power_l2',            'start': 23320, 'length': 2, 'signed': True, 'decimals': 2},
    286. 

  286.             {'name': 'active_power_l3',            'start': 23322, 'length': 2, 'signed': True, 'decimals': 2},
    287. 

  287.             {'name': 'reactive_power_total',       'start': 23324, 'length': 2, 'signed': True, 'decimals': 2},
    288. 

  288.             {'name': 'reactive_power_l1',          'start': 23326, 'length': 2, 'signed': True, 'decimals': 2},
    289. 

  289.             {'name': 'reactive_power_l2',          'start': 23328, 'length': 2, 'signed': True, 'decimals': 2},
    290. 

  290.             {'name': 'reactive_power_l3',          'start': 23330, 'length': 2, 'signed': True, 'decimals': 2},
    291. 

  291.             {'name': 'apparent_power_total',       'start': 23332, 'length': 2, 'signed': True, 'decimals': 2},
    292. 

  292.             {'name': 'apparent_power_l1',          'start': 23334, 'length': 2, 'signed': True, 'decimals': 2},
    293. 

  293.             {'name': 'apparent_power_l2',          'start': 23336, 'length': 2, 'signed': True, 'decimals': 2},
    294. 

  294.             {'name': 'apparent_power_l3',          'start': 23338, 'length': 2, 'signed': True, 'decimals': 2},
    295. 

  295.             {'name': 'frequency',                  'start': 23340, 'length': 1, 'signed': False, 'decimals': 2},
    296. 

  296.             {'name': 'phase_angle_power_total',    'start': 23341, 'length': 1, 'signed': True, 'decimals': 1},
    297. 

  297.             {'name': 'phase_angle_power_l1',       'start': 23342, 'length': 1, 'signed': True, 'decimals': 1},
    298. 

  298.             {'name': 'phase_angle_power_l2',       'start': 23343, 'length': 1, 'signed': True, 'decimals': 1},
    299. 

  299.             {'name': 'phase_angle_power_l3',       'start': 23344, 'length': 1, 'signed': True, 'decimals': 1},
    300. 

  300.             {'name': 'phase_angle_voltage_l1',     'start': 23345, 'length': 1, 'signed': True, 'decimals': 1},
    301. 

  301.             {'name': 'phase_angle_voltage_l2',     'start': 23346, 'length': 1, 'signed': True, 'decimals': 1},
    302. 

  302.             {'name': 'phase_angle_voltage_l3',     'start': 23347, 'length': 1, 'signed': True, 'decimals': 1},
    303. 

  303.             {'name': 'phase_angle_current_l1',     'start': 23351, 'length': 1, 'signed': True, 'decimals': 1},
    304. 

  304.             {'name': 'phase_angle_current_l2',     'start': 23352, 'length': 1, 'signed': True, 'decimals': 1},
    305. 

  305.             {'name': 'phase_angle_current_l3',     'start': 23353, 'length': 1, 'signed': True, 'decimals': 1},
    306. 

  306.             {'name': 'power_factor_total',         'start': 23354, 'length': 1, 'signed': True, 'decimals': 3},
    307. 

  307.             {'name': 'power_factor_l1',            'start': 23355, 'length': 1, 'signed': True, 'decimals': 3},
    308. 

  308.             {'name': 'power_factor_l2',            'start': 23356, 'length': 1, 'signed': True, 'decimals': 3},
    309. 

  309.             {'name': 'power_factor_l3',            'start': 23357, 'length': 1, 'signed': True, 'decimals': 3},
    310. 

  310.             {'name': 'current_quadrant_total',     'start': 23358, 'length': 1, 'signed': False, 'decimals': 0},
    311. 

  311.             {'name': 'current_quadrant_l1',        'start': 23359, 'length': 1, 'signed': False, 'decimals': 0},
    312. 

  312.             {'name': 'current_quadrant_l2',        'start': 23360, 'length': 1, 'signed': False, 'decimals': 0},
    313. 

  313.             {'name': 'current_quadrant_l3',        'start': 23361, 'length': 1, 'signed': False, 'decimals': 0},
    314. 

  314.             {'name': 'voltage_harmonics_l1_n_thd', 'start': 23808, 'length': 2, 'signed': False, 'decimals': 1},
    315. 

  315.             {'name': 'voltage_harmonics_l1_n_2nd', 'start': 23810, 'length': 2, 'signed': False, 'decimals': 1},
    316. 

  316.             {'name': 'voltage_harmonics_l1_n_3rd', 'start': 23812, 'length': 2, 'signed': False, 'decimals': 1},
    317. 

  317.             {'name': 'voltage_harmonics_l1_n_4th', 'start': 23814, 'length': 2, 'signed': False, 'decimals': 1},
    318. 

  318.             {'name': 'voltage_harmonics_l1_n_5th', 'start': 23816, 'length': 2, 'signed': False, 'decimals': 1},
    319. 

  319.             {'name': 'voltage_harmonics_l1_n_6th', 'start': 23818, 'length': 2, 'signed': False, 'decimals': 1},
    320. 

  320.             {'name': 'voltage_harmonics_l1_n_7th', 'start': 23820, 'length': 2, 'signed': False, 'decimals': 1},
    321. 

  321.             {'name': 'voltage_harmonics_l1_n_8th', 'start': 23822, 'length': 2, 'signed': False, 'decimals': 1},
    322. 

  322.             {'name': 'voltage_harmonics_l1_n_9th', 'start': 23824, 'length': 2, 'signed': False, 'decimals': 1},
    323. 

  323.             {'name': 'voltage_harmonics_l1_n_10th', 'start': 23826, 'length': 2, 'signed': False, 'decimals': 1},
    324. 

  324.             {'name': 'voltage_harmonics_l1_n_11th', 'start': 23828, 'length': 2, 'signed': False, 'decimals': 1},
    325. 

  325.             {'name': 'voltage_harmonics_l1_n_12th', 'start': 23830, 'length': 2, 'signed': False, 'decimals': 1},
    326. 

  326.             {'name': 'voltage_harmonics_l1_n_13th', 'start': 23832, 'length': 2, 'signed': False, 'decimals': 1},
    327. 

  327.             {'name': 'voltage_harmonics_l1_n_14th', 'start': 23834, 'length': 2, 'signed': False, 'decimals': 1},
    328. 

  328.             {'name': 'voltage_harmonics_l1_n_15th', 'start': 23836, 'length': 2, 'signed': False, 'decimals': 1},
    329. 

  329.             {'name': 'voltage_harmonics_l1_n_16th', 'start': 23838, 'length': 2, 'signed': False, 'decimals': 1},
    330. 

  330.             {'name': 'voltage_harmonics_l2_n_thd', 'start': 23936, 'length': 2, 'signed': False, 'decimals': 1},
    331. 

  331.             {'name': 'voltage_harmonics_l2_n_2nd', 'start': 23938, 'length': 2, 'signed': False, 'decimals': 1},
    332. 

  332.             {'name': 'voltage_harmonics_l2_n_3rd', 'start': 23940, 'length': 2, 'signed': False, 'decimals': 1},
    333. 

  333.             {'name': 'voltage_harmonics_l2_n_4th', 'start': 23942, 'length': 2, 'signed': False, 'decimals': 1},
    334. 

  334.             {'name': 'voltage_harmonics_l2_n_5th', 'start': 23944, 'length': 2, 'signed': False, 'decimals': 1},
    335. 

  335.             {'name': 'voltage_harmonics_l2_n_6th', 'start': 23946, 'length': 2, 'signed': False, 'decimals': 1},
    336. 

  336.             {'name': 'voltage_harmonics_l2_n_7th', 'start': 23948, 'length': 2, 'signed': False, 'decimals': 1},
    337. 

  337.             {'name': 'voltage_harmonics_l2_n_8th', 'start': 23950, 'length': 2, 'signed': False, 'decimals': 1},
    338. 

  338.             {'name': 'voltage_harmonics_l2_n_9th', 'start': 23952, 'length': 2, 'signed': False, 'decimals': 1},
    339. 

  339.             {'name': 'voltage_harmonics_l2_n_10th', 'start': 23954, 'length': 2, 'signed': False, 'decimals': 1},
    340. 

  340.             {'name': 'voltage_harmonics_l2_n_11th', 'start': 23956, 'length': 2, 'signed': False, 'decimals': 1},
    341. 

  341.             {'name': 'voltage_harmonics_l2_n_12th', 'start': 23958, 'length': 2, 'signed': False, 'decimals': 1},
    342. 

  342.             {'name': 'voltage_harmonics_l2_n_13th', 'start': 23960, 'length': 2, 'signed': False, 'decimals': 1},
    343. 

  343.             {'name': 'voltage_harmonics_l2_n_14th', 'start': 23962, 'length': 2, 'signed': False, 'decimals': 1},
    344. 

  344.             {'name': 'voltage_harmonics_l2_n_15th', 'start': 23964, 'length': 2, 'signed': False, 'decimals': 1},
    345. 

  345.             {'name': 'voltage_harmonics_l2_n_16th', 'start': 23966, 'length': 2, 'signed': False, 'decimals': 1},
    346. 

  346.             {'name': 'voltage_harmonics_l3_n_thd', 'start': 24064, 'length': 2, 'signed': False, 'decimals': 1},
    347. 

  347.             {'name': 'voltage_harmonics_l3_n_2nd', 'start': 24066, 'length': 2, 'signed': False, 'decimals': 1},
    348. 

  348.             {'name': 'voltage_harmonics_l3_n_3rd', 'start': 24068, 'length': 2, 'signed': False, 'decimals': 1},
    349. 

  349.             {'name': 'voltage_harmonics_l3_n_4th', 'start': 24070, 'length': 2, 'signed': False, 'decimals': 1},
    350. 

  350.             {'name': 'voltage_harmonics_l3_n_5th', 'start': 24072, 'length': 2, 'signed': False, 'decimals': 1},
    351. 

  351.             {'name': 'voltage_harmonics_l3_n_6th', 'start': 24074, 'length': 2, 'signed': False, 'decimals': 1},
    352. 

  352.             {'name': 'voltage_harmonics_l3_n_7th', 'start': 24076, 'length': 2, 'signed': False, 'decimals': 1},
    353. 

  353.             {'name': 'voltage_harmonics_l3_n_8th', 'start': 24078, 'length': 2, 'signed': False, 'decimals': 1},
    354. 

  354.             {'name': 'voltage_harmonics_l3_n_9th', 'start': 24080, 'length': 2, 'signed': False, 'decimals': 1},
    355. 

  355.             {'name': 'voltage_harmonics_l3_n_10th', 'start': 24082, 'length': 2, 'signed': False, 'decimals': 1},
    356. 

  356.             {'name': 'voltage_harmonics_l3_n_11th', 'start': 24084, 'length': 2, 'signed': False, 'decimals': 1},
    357. 

  357.             {'name': 'voltage_harmonics_l3_n_12th', 'start': 24086, 'length': 2, 'signed': False, 'decimals': 1},
    358. 

  358.             {'name': 'voltage_harmonics_l3_n_13th', 'start': 24088, 'length': 2, 'signed': False, 'decimals': 1},
    359. 

  359.             {'name': 'voltage_harmonics_l3_n_14th', 'start': 24090, 'length': 2, 'signed': False, 'decimals': 1},
    360. 

  360.             {'name': 'voltage_harmonics_l3_n_15th', 'start': 24092, 'length': 2, 'signed': False, 'decimals': 1},
    361. 

  361.             {'name': 'voltage_harmonics_l3_n_16th', 'start': 24094, 'length': 2, 'signed': False, 'decimals': 1},
    362. 

  362.             {'name': 'voltage_harmonics_l1_l2_thd', 'start': 24192, 'length': 2, 'signed': False, 'decimals': 1},
    363. 

  363.             {'name': 'voltage_harmonics_l1_l2_2nd', 'start': 24194, 'length': 2, 'signed': False, 'decimals': 1},
    364. 

  364.             {'name': 'voltage_harmonics_l1_l2_3rd', 'start': 24196, 'length': 2, 'signed': False, 'decimals': 1},
    365. 

  365.             {'name': 'voltage_harmonics_l1_l2_4th', 'start': 24198, 'length': 2, 'signed': False, 'decimals': 1},
    366. 

  366.             {'name': 'voltage_harmonics_l1_l2_5th', 'start': 24200, 'length': 2, 'signed': False, 'decimals': 1},
    367. 

  367.             {'name': 'voltage_harmonics_l1_l2_6th', 'start': 24202, 'length': 2, 'signed': False, 'decimals': 1},
    368. 

  368.             {'name': 'voltage_harmonics_l1_l2_7th', 'start': 24204, 'length': 2, 'signed': False, 'decimals': 1},
    369. 

  369.             {'name': 'voltage_harmonics_l1_l2_8th', 'start': 24206, 'length': 2, 'signed': False, 'decimals': 1},
    370. 

  370.             {'name': 'voltage_harmonics_l1_l2_9th', 'start': 24208, 'length': 2, 'signed': False, 'decimals': 1},
    371. 

  371.             {'name': 'voltage_harmonics_l1_l2_10th', 'start': 24210, 'length': 2, 'signed': False, 'decimals': 1},
    372. 

  372.             {'name': 'voltage_harmonics_l1_l2_11th', 'start': 24212, 'length': 2, 'signed': False, 'decimals': 1},
    373. 

  373.             {'name': 'voltage_harmonics_l1_l2_12th', 'start': 24214, 'length': 2, 'signed': False, 'decimals': 1},
    374. 

  374.             {'name': 'voltage_harmonics_l1_l2_13th', 'start': 24216, 'length': 2, 'signed': False, 'decimals': 1},
    375. 

  375.             {'name': 'voltage_harmonics_l1_l2_14th', 'start': 24218, 'length': 2, 'signed': False, 'decimals': 1},
    376. 

  376.             {'name': 'voltage_harmonics_l1_l2_15th', 'start': 24220, 'length': 2, 'signed': False, 'decimals': 1},
    377. 

  377.             {'name': 'voltage_harmonics_l1_l2_16th', 'start': 24222, 'length': 2, 'signed': False, 'decimals': 1},
    378. 

  378.             {'name': 'voltage_harmonics_l3_l2_thd', 'start': 24320, 'length': 2, 'signed': False, 'decimals': 1},
    379. 

  379.             {'name': 'voltage_harmonics_l3_l2_2nd', 'start': 24322, 'length': 2, 'signed': False, 'decimals': 1},
    380. 

  380.             {'name': 'voltage_harmonics_l3_l2_3rd', 'start': 24324, 'length': 2, 'signed': False, 'decimals': 1},
    381. 

  381.             {'name': 'voltage_harmonics_l3_l2_4th', 'start': 24326, 'length': 2, 'signed': False, 'decimals': 1},
    382. 

  382.             {'name': 'voltage_harmonics_l3_l2_5th', 'start': 24328, 'length': 2, 'signed': False, 'decimals': 1},
    383. 

  383.             {'name': 'voltage_harmonics_l3_l2_6th', 'start': 24330, 'length': 2, 'signed': False, 'decimals': 1},
    384. 

  384.             {'name': 'voltage_harmonics_l3_l2_7th', 'start': 24332, 'length': 2, 'signed': False, 'decimals': 1},
    385. 

  385.             {'name': 'voltage_harmonics_l3_l2_8th', 'start': 24334, 'length': 2, 'signed': False, 'decimals': 1},
    386. 

  386.             {'name': 'voltage_harmonics_l3_l2_9th', 'start': 24336, 'length': 2, 'signed': False, 'decimals': 1},
    387. 

  387.             {'name': 'voltage_harmonics_l3_l2_10th', 'start': 24338, 'length': 2, 'signed': False, 'decimals': 1},
    388. 

  388.             {'name': 'voltage_harmonics_l3_l2_11th', 'start': 24340, 'length': 2, 'signed': False, 'decimals': 1},
    389. 

  389.             {'name': 'voltage_harmonics_l3_l2_12th', 'start': 24342, 'length': 2, 'signed': False, 'decimals': 1},
    390. 

  390.             {'name': 'voltage_harmonics_l3_l2_13th', 'start': 24344, 'length': 2, 'signed': False, 'decimals': 1},
    391. 

  391.             {'name': 'voltage_harmonics_l3_l2_14th', 'start': 24346, 'length': 2, 'signed': False, 'decimals': 1},
    392. 

  392.             {'name': 'voltage_harmonics_l3_l2_15th', 'start': 24348, 'length': 2, 'signed': False, 'decimals': 1},
    393. 

  393.             {'name': 'voltage_harmonics_l3_l2_16th', 'start': 24350, 'length': 2, 'signed': False, 'decimals': 1},
    394. 

  394.             {'name': 'voltage_harmonics_l1_l3_thd', 'start': 24448, 'length': 2, 'signed': False, 'decimals': 1},
    395. 

  395.             {'name': 'voltage_harmonics_l1_l3_2nd', 'start': 24450, 'length': 2, 'signed': False, 'decimals': 1},
    396. 

  396.             {'name': 'voltage_harmonics_l1_l3_3rd', 'start': 24452, 'length': 2, 'signed': False, 'decimals': 1},
    397. 

  397.             {'name': 'voltage_harmonics_l1_l3_4th', 'start': 24454, 'length': 2, 'signed': False, 'decimals': 1},
    398. 

  398.             {'name': 'voltage_harmonics_l1_l3_5th', 'start': 24456, 'length': 2, 'signed': False, 'decimals': 1},
    399. 

  399.             {'name': 'voltage_harmonics_l1_l3_6th', 'start': 24458, 'length': 2, 'signed': False, 'decimals': 1},
    400. 

  400.             {'name': 'voltage_harmonics_l1_l3_7th', 'start': 24460, 'length': 2, 'signed': False, 'decimals': 1},
    401. 

  401.             {'name': 'voltage_harmonics_l1_l3_8th', 'start': 24462, 'length': 2, 'signed': False, 'decimals': 1},
    402. 

  402.             {'name': 'voltage_harmonics_l1_l3_9th', 'start': 24464, 'length': 2, 'signed': False, 'decimals': 1},
    403. 

  403.             {'name': 'voltage_harmonics_l1_l3_10th', 'start': 24466, 'length': 2, 'signed': False, 'decimals': 1},
    404. 

  404.             {'name': 'voltage_harmonics_l1_l3_11th', 'start': 24468, 'length': 2, 'signed': False, 'decimals': 1},
    405. 

  405.             {'name': 'voltage_harmonics_l1_l3_12th', 'start': 24470, 'length': 2, 'signed': False, 'decimals': 1},
    406. 

  406.             {'name': 'voltage_harmonics_l1_l3_13th', 'start': 24472, 'length': 2, 'signed': False, 'decimals': 1},
    407. 

  407.             {'name': 'voltage_harmonics_l1_l3_14th', 'start': 24474, 'length': 2, 'signed': False, 'decimals': 1},
    408. 

  408.             {'name': 'voltage_harmonics_l1_l3_15th', 'start': 24476, 'length': 2, 'signed': False, 'decimals': 1},
    409. 

  409.             {'name': 'voltage_harmonics_l1_l3_16th', 'start': 24478, 'length': 2, 'signed': False, 'decimals': 1},
    410. 

  410.             {'name': 'current_harmonics_l1_thd', 'start': 24576, 'length': 2, 'signed': False, 'decimals': 1},
    411. 

  411.             {'name': 'current_harmonics_l1_2nd', 'start': 24578, 'length': 2, 'signed': False, 'decimals': 1},
    412. 

  412.             {'name': 'current_harmonics_l1_3rd', 'start': 24580, 'length': 2, 'signed': False, 'decimals': 1},
    413. 

  413.             {'name': 'current_harmonics_l1_4th', 'start': 24582, 'length': 2, 'signed': False, 'decimals': 1},
    414. 

  414.             {'name': 'current_harmonics_l1_5th', 'start': 24584, 'length': 2, 'signed': False, 'decimals': 1},
    415. 

  415.             {'name': 'current_harmonics_l1_6th', 'start': 24586, 'length': 2, 'signed': False, 'decimals': 1},
    416. 

  416.             {'name': 'current_harmonics_l1_7th', 'start': 24588, 'length': 2, 'signed': False, 'decimals': 1},
    417. 

  417.             {'name': 'current_harmonics_l1_8th', 'start': 24590, 'length': 2, 'signed': False, 'decimals': 1},
    418. 

  418.             {'name': 'current_harmonics_l1_9th', 'start': 24592, 'length': 2, 'signed': False, 'decimals': 1},
    419. 

  419.             {'name': 'current_harmonics_l1_10th', 'start': 24594, 'length': 2, 'signed': False, 'decimals': 1},
    420. 

  420.             {'name': 'current_harmonics_l1_11th', 'start': 24596, 'length': 2, 'signed': False, 'decimals': 1},
    421. 

  421.             {'name': 'current_harmonics_l1_12th', 'start': 24598, 'length': 2, 'signed': False, 'decimals': 1},
    422. 

  422.             {'name': 'current_harmonics_l1_13th', 'start': 24600, 'length': 2, 'signed': False, 'decimals': 1},
    423. 

  423.             {'name': 'current_harmonics_l1_14th', 'start': 24602, 'length': 2, 'signed': False, 'decimals': 1},
    424. 

  424.             {'name': 'current_harmonics_l1_15th', 'start': 24604, 'length': 2, 'signed': False, 'decimals': 1},
    425. 

  425.             {'name': 'current_harmonics_l1_16th', 'start': 24606, 'length': 2, 'signed': False, 'decimals': 1},
    426. 

  426.             {'name': 'current_harmonics_l2_thd', 'start': 24704, 'length': 2, 'signed': False, 'decimals': 1},
    427. 

  427.             {'name': 'current_harmonics_l2_2nd', 'start': 24706, 'length': 2, 'signed': False, 'decimals': 1},
    428. 

  428.             {'name': 'current_harmonics_l2_3rd', 'start': 24708, 'length': 2, 'signed': False, 'decimals': 1},
    429. 

  429.             {'name': 'current_harmonics_l2_4th', 'start': 24710, 'length': 2, 'signed': False, 'decimals': 1},
    430. 

  430.             {'name': 'current_harmonics_l2_5th', 'start': 24712, 'length': 2, 'signed': False, 'decimals': 1},
    431. 

  431.             {'name': 'current_harmonics_l2_6th', 'start': 24714, 'length': 2, 'signed': False, 'decimals': 1},
    432. 

  432.             {'name': 'current_harmonics_l2_7th', 'start': 24716, 'length': 2, 'signed': False, 'decimals': 1},
    433. 

  433.             {'name': 'current_harmonics_l2_8th', 'start': 24718, 'length': 2, 'signed': False, 'decimals': 1},
    434. 

  434.             {'name': 'current_harmonics_l2_9th', 'start': 24720, 'length': 2, 'signed': False, 'decimals': 1},
    435. 

  435.             {'name': 'current_harmonics_l2_10th', 'start': 24722, 'length': 2, 'signed': False, 'decimals': 1},
    436. 

  436.             {'name': 'current_harmonics_l2_11th', 'start': 24724, 'length': 2, 'signed': False, 'decimals': 1},
    437. 

  437.             {'name': 'current_harmonics_l2_12th', 'start': 24726, 'length': 2, 'signed': False, 'decimals': 1},
    438. 

  438.             {'name': 'current_harmonics_l2_13th', 'start': 24728, 'length': 2, 'signed': False, 'decimals': 1},
    439. 

  439.             {'name': 'current_harmonics_l2_14th', 'start': 24730, 'length': 2, 'signed': False, 'decimals': 1},
    440. 

  440.             {'name': 'current_harmonics_l2_15th', 'start': 24732, 'length': 2, 'signed': False, 'decimals': 1},
    441. 

  441.             {'name': 'current_harmonics_l2_16th', 'start': 24734, 'length': 2, 'signed': False, 'decimals': 1},
    442. 

  442.             {'name': 'current_harmonics_l3_thd', 'start': 24832, 'length': 2, 'signed': False, 'decimals': 1},
    443. 

  443.             {'name': 'current_harmonics_l3_2nd', 'start': 24834, 'length': 2, 'signed': False, 'decimals': 1},
    444. 

  444.             {'name': 'current_harmonics_l3_3rd', 'start': 24836, 'length': 2, 'signed': False, 'decimals': 1},
    445. 

  445.             {'name': 'current_harmonics_l3_4th', 'start': 24838, 'length': 2, 'signed': False, 'decimals': 1},
    446. 

  446.             {'name': 'current_harmonics_l3_5th', 'start': 24840, 'length': 2, 'signed': False, 'decimals': 1},
    447. 

  447.             {'name': 'current_harmonics_l3_6th', 'start': 24842, 'length': 2, 'signed': False, 'decimals': 1},
    448. 

  448.             {'name': 'current_harmonics_l3_7th', 'start': 24844, 'length': 2, 'signed': False, 'decimals': 1},
    449. 

  449.             {'name': 'current_harmonics_l3_8th', 'start': 24846, 'length': 2, 'signed': False, 'decimals': 1},
    450. 

  450.             {'name': 'current_harmonics_l3_9th', 'start': 24848, 'length': 2, 'signed': False, 'decimals': 1},
    451. 

  451.             {'name': 'current_harmonics_l3_10th', 'start': 24850, 'length': 2, 'signed': False, 'decimals': 1},
    452. 

  452.             {'name': 'current_harmonics_l3_11th', 'start': 24852, 'length': 2, 'signed': False, 'decimals': 1},
    453. 

  453.             {'name': 'current_harmonics_l3_12th', 'start': 24854, 'length': 2, 'signed': False, 'decimals': 1},
    454. 

  454.             {'name': 'current_harmonics_l3_13th', 'start': 24856, 'length': 2, 'signed': False, 'decimals': 1},
    455. 

  455.             {'name': 'current_harmonics_l3_14th', 'start': 24858, 'length': 2, 'signed': False, 'decimals': 1},
    456. 

  456.             {'name': 'current_harmonics_l3_15th', 'start': 24860, 'length': 2, 'signed': False, 'decimals': 1},
    457. 

  457.             {'name': 'current_harmonics_l3_16th', 'start': 24862, 'length': 2, 'signed': False, 'decimals': 1},
    458. 

  458.             {'name': 'current_harmonics_n_thd', 'start': 24960, 'length': 2, 'signed': False, 'decimals': 1},
    459. 

  459.             {'name': 'current_harmonics_n_2nd', 'start': 24962, 'length': 2, 'signed': False, 'decimals': 1},
    460. 

  460.             {'name': 'current_harmonics_n_3rd', 'start': 24964, 'length': 2, 'signed': False, 'decimals': 1},
    461. 

  461.             {'name': 'current_harmonics_n_4th', 'start': 24966, 'length': 2, 'signed': False, 'decimals': 1},
    462. 

  462.             {'name': 'current_harmonics_n_5th', 'start': 24968, 'length': 2, 'signed': False, 'decimals': 1},
    463. 

  463.             {'name': 'current_harmonics_n_6th', 'start': 24970, 'length': 2, 'signed': False, 'decimals': 1},
    464. 

  464.             {'name': 'current_harmonics_n_7th', 'start': 24972, 'length': 2, 'signed': False, 'decimals': 1},
    465. 

  465.             {'name': 'current_harmonics_n_8th', 'start': 24974, 'length': 2, 'signed': False, 'decimals': 1},
    466. 

  466.             {'name': 'current_harmonics_n_9th', 'start': 24976, 'length': 2, 'signed': False, 'decimals': 1},
    467. 

  467.             {'name': 'current_harmonics_n_10th', 'start': 24978, 'length': 2, 'signed': False, 'decimals': 1},
    468. 

  468.             {'name': 'current_harmonics_n_11th', 'start': 24980, 'length': 2, 'signed': False, 'decimals': 1},
    469. 

  469.             {'name': 'current_harmonics_n_12th', 'start': 24982, 'length': 2, 'signed': False, 'decimals': 1},
    470. 

  470.             {'name': 'current_harmonics_n_13th', 'start': 24984, 'length': 2, 'signed': False, 'decimals': 1},
    471. 

  471.             {'name': 'current_harmonics_n_14th', 'start': 24986, 'length': 2, 'signed': False, 'decimals': 1},
    472. 

  472.             {'name': 'current_harmonics_n_15th', 'start': 24988, 'length': 2, 'signed': False, 'decimals': 1},
    473. 

  473.             {'name': 'current_harmonics_n_16th', 'start': 24990, 'length': 2, 'signed': False, 'decimals': 1}]
    474. 

  474.     REGSETS = {
    475. 

  475.                "A43": ["active_import", "active_export", "active_net",
    476. 

  476.                        "reactive_import", "reactive_export", "reactive_net",
    477. 

  477.                        "apparent_import", "apparent_export", "apparent_net",
    478. 

  478.                        "active_import_co2", "active_import_currency",
    479. 

  479.                        "active_import_l1", "active_import_l2", "active_import_l3",
    480. 

  480.                        "active_export_l1", "active_export_l2", "active_export_l3",
    481. 

  481.                        "active_net_l1", "active_net_l2", "active_net_l3",
    482. 

  482.                        "reactive_import_l1", "reactive_import_l2",
    483. 

  483.                        "reactive_import_l3", "reactive_export_l1",
    484. 

  484.                        "reactive_export_l2", "reactive_export_l3",
    485. 

  485.                        "reactive_net_l1", "reactive_net_l2", "reactive_net_l3",
    486. 

  486.                        "apparent_import_l1", "apparent_import_l2",
    487. 

  487.                        "apparent_import_l3", "apparent_export_l1",
    488. 

  488.                        "apparent_export_l2", "apparent_export_l3",
    489. 

  489.                        "apparent_net_l1", "apparent_net_l2", "apparent_net_l3",
    490. 

  490.                        "voltage_l1_n", "voltage_l2_n", "voltage_l3_n",
    491. 

  491.                        "voltage_l1_l2", "voltage_l3_l2", "voltage_l1_l3",
    492. 

  492.                        "current_l1", "current_l2", "current_l3",
    493. 

  493.                        "active_power_total", "active_power_l1", "active_power_l2",
    494. 

  494.                        "active_power_l3", "reactive_power_total",
    495. 

  495.                        "reactive_power_l1", "reactive_power_l2",
    496. 

  496.                        "reactive_power_l3", "apparent_power_total",
    497. 

  497.                        "apparent_power_l1", "apparent_power_l2",
    498. 

  498.                        "apparent_power_l3", "frequency", "phase_angle_power_total",
    499. 

  499.                        "power_factor_total", "power_factor_l1", "power_factor_l2",
    500. 

  500.                        "power_factor_l3", "current_quadrant_total",
    501. 

  501.                        "current_quadrant_l1", "current_quadrant_l2",
    502. 

  502.                        "current_quadrant_l3"],
    503. 

  503.                "B23": ["active_import", "active_export", "active_net",
    504. 

  504.                        "reactive_import", "reactive_export", "reactive_net",
    505. 

  505.                        "apparent_import", "apparent_export", "apparent_net",
    506. 

  506.                        "active_import_co2", "active_import_currency",
    507. 

  507.                        "active_import_l1", "active_import_l2", "active_import_l3",
    508. 

  508.                        "active_export_l1", "active_export_l2", "active_export_l3",
    509. 

  509.                        "active_net_l1", "active_net_l2", "active_net_l3",
    510. 

  510.                        "reactive_import_l1", "reactive_import_l2",
    511. 

  511.                        "reactive_import_l3", "reactive_export_l1",
    512. 

  512.                        "reactive_export_l2", "reactive_export_l3",
    513. 

  513.                        "reactive_net_l1", "reactive_net_l2", "reactive_net_l3",
    514. 

  514.                        "apparent_import_l1", "apparent_import_l2",
    515. 

  515.                        "apparent_import_l3", "apparent_export_l1",
    516. 

  516.                        "apparent_export_l2", "apparent_export_l3",
    517. 

  517.                        "apparent_net_l1", "apparent_net_l2", "apparent_net_l3",
    518. 

  518.                        "voltage_l1_n", "voltage_l2_n", "voltage_l3_n",
    519. 

  519.                        "voltage_l1_l2", "voltage_l3_l2", "voltage_l1_l3",
    520. 

  520.                        "current_l1", "current_l2", "current_l3",
    521. 

  521.                        "active_power_total", "active_power_l1", "active_power_l2",
    522. 

  522.                        "active_power_l3", "reactive_power_total",
    523. 

  523.                        "reactive_power_l1", "reactive_power_l2",
    524. 

  524.                        "reactive_power_l3", "apparent_power_total",
    525. 

  525.                        "apparent_power_l1", "apparent_power_l2",
    526. 

  526.                        "apparent_power_l3", "frequency", "phase_angle_power_total",
    527. 

  527.                        "power_factor_total", "power_factor_l1", "power_factor_l2",
    528. 

  528.                        "power_factor_l3", "current_quadrant_total",
    529. 

  529.                        "current_quadrant_l1", "current_quadrant_l2",
    530. 

  530.                        "current_quadrant_l3"],
    531. 

  531.                "B21": ["active_import", "active_export", "active_net",
    532. 

  532.                        "reactive_import", "reactive_export", "reactive_net",
    533. 

  533.                        "apparent_import", "apparent_export", "apparent_net",
    534. 

  534.                        "active_import_co2", "active_import_currency",
    535. 

  535.                        "voltage_l1_n", "current_l1", "active_power_total",
    536. 

  536.                        "reactive_power_total", "apparent_power_total", "frequency",
    537. 

  537.                        "phase_angle_power_total", "power_factor_total",
    538. 

  538.                        "current_quadrant_total"]
    539. 

  539.                }
    540. 

  540.     NULLS = [pow(2, n) - 1 for n in (64, 63, 32, 31, 16, 15)]
    541. 

  541. 

  542. class SMAMeter:
    543. 

  543.     """
    544. 

  544.     Implementation for a Sunny Boy SMA Modbus over TCP meter.
    545. 

  545. 

  546.     """
    547. 

  547.     def __init__(self, port, tcp_port=502, slaveaddress=126, type=None, baudrate=None):
    548. 

  548.         self.device = socket.create_connection(address=(port, tcp_port))
    549. 

  549.         self.device_id = slaveaddress
    550. 

  550. 

  551.     def read(self, regnames=None):
    552. 

  552.         if regnames is None:
    553. 

  553.             registers = SMAMeter.REGS
    554. 

  554.             return self._read_multiple(registers)
    555. 

  555.         if type(regnames) is str:
    556. 

  556.             registers = [register for register in SMAMeter.REGS if register['name'] == regnames]
    557. 

  557.             if len(registers) == 0:
    558. 

  558.                 return "Register not found on device."
    559. 

  559.             return self._read_single(registers[0])
    560. 

  560.         if type(regnames) is list:
    561. 

  561.             registers = [register for register in SMAMeter.REGS if register['name'] in regnames]
    562. 

  562.             return self._read_multiple(registers)
    563. 

  563. 

  564.     def _read_single(self, register):
    565. 

  565.         message = self._modbus_message(start_reg=register['start'], num_regs=register['length'])
    566. 

  566.         data = self._perform_request(message)
    567. 

  567.         return self._convert_value(data, signed=register['signed'], decimals=register['decimals'])
    568. 

  568. 

  569.     def _read_multiple(self, registers):
    570. 

  570.         registers.sort(key=lambda reg: reg['start'])
    571. 

  571.         first_reg = min([register['start'] for register in registers])
    572. 

  572.         num_regs = max([register['start'] + register['length'] for register in registers]) - first_reg
    573. 

  573.         message = self._modbus_message(start_reg=first_reg, num_regs=num_regs)
    574. 

  574.         data = self._perform_request(message)
    575. 

  575.         return self._interpret_result(data, registers)
    576. 

  576. 

  577.     def _modbus_message(self, start_reg, num_regs):
    578. 

  578.         transaction_id = random.randint(1, 2**16 - 1)
    579. 

  579.         return struct.pack(">HHHBBHH", transaction_id,
    580. 

  580.                                        SMAMeter.PROTOCOL_CODE,
    581. 

  581.                                        6,
    582. 

  582.                                        self.device_id,
    583. 

  583.                                        SMAMeter.FUNCTION_CODE,
    584. 

  584.                                        start_reg - SMAMeter.REG_OFFSET,
    585. 

  585.                                        num_regs)
    586. 

  586. 

  587.     def _perform_request(self, message):
    588. 

  588.         self.device.send(message)
    589. 

  589.         data = bytes()
    590. 

  590.         expect_bytes = 9 + 2 * struct.unpack(">H", message[-2:])[0]
    591. 

  591.         attempt = 1
    592. 

  592.         while len(data) is not expect_bytes:
    593. 

  593.             time.sleep(0.05)
    594. 

  594.             data += self.device.recv(2048)
    595. 

  595.             if attempt >= 10:
    596. 

  596.                 return 2 * struct.unpack(">H", message[-2:])[0] * [0]
    597. 

  597.             attempt += 1
    598. 

  598.         return data[9:]
    599. 

  599. 

  600.     def _interpret_result(self, data, registers):
    601. 

  601.         """
    602. 

  602.         Pull the returned string apart and package the data back to its
    603. 

  603.         intended form.
    604. 

  604. 

  605.         Arguments:
    606. 

  606.             * data: list of register values returned from the device
    607. 

  607.             * registers: the original requested set of registers
    608. 

  608. 

  609.         Returns:
    610. 

  610.             * A dict containing the register names and resulting values
    611. 

  611. 

  612.         """
    613. 

  613.         first_reg = min([register['start'] for register in registers])
    614. 

  614. 

  615.         results = {}
    616. 

  616.         for register in registers:
    617. 

  617.             regname = register['name']
    618. 

  618.             start = (register['start'] - first_reg) * 2
    619. 

  619.             end = start + register['length'] * 2
    620. 

  620.             values = data[start:end]
    621. 

  621.             results[regname] = self._convert_value(values=values,
    622. 

  622.                                                    signed=register['signed'],
    623. 

  623.                                                    decimals=register['decimals'])
    624. 

  624.             if regname == "power_factor_total" and results[regname] == 0:
    625. 

  625.                 results[regname] = 1    # The SMA will send out a 0 when the power factor is 100%
    626. 

  626.         return results
    627. 

  627. 

  628.     def _convert_value(self, values, signed=False, decimals=0):
    629. 

  629.         """
    630. 

  630.         Convert a list of returned integers to the intended value.
    631. 

  631. 

  632.         Arguments:
    633. 

  633.             * bytestring: a list of integers that together represent the value
    634. 

  634.             * signed: whether the value is a signed value
    635. 

  635.             * decimals: number of decimals the return value should contain
    636. 

  636. 

  637.         """
    638. 

  638.         numberOfBytes = len(values)
    639. 

  639.         formatcode_o = '>'
    640. 

  640. 

  641.         if numberOfBytes == 1:
    642. 

  642.             if signed:
    643. 

  643.                 formatcode_o += "b"
    644. 

  644.             else:
    645. 

  645.                 formatcode_o += "B"
    646. 

  646. 

  647.         if numberOfBytes == 2:
    648. 

  648.             if signed:
    649. 

  649.                 formatcode_o += "h"
    650. 

  650.             else:
    651. 

  651.                 formatcode_o += "H"
    652. 

  652. 

  653.         if numberOfBytes == 4:
    654. 

  654.             if signed:
    655. 

  655.                 formatcode_o += "l"
    656. 

  656.             else:
    657. 

  657.                 formatcode_o += "L"
    658. 

  658. 

  659.         value = struct.unpack(formatcode_o, bytes(values))[0]
    660. 

  660. 

  661.         if value in SMAMeter.NULLS:
    662. 

  662.             return None
    663. 

  663.         else:
    664. 

  664.             return float(value) / 10 ** decimals
    665. 

  665. 

  666.     REGS = [
    667. 

  667.             {'name': 'current_ac', 'start': 40188, 'length': 1, 'signed': False, 'decimals': 1},
    668. 

  668.             {'name': 'current_l1', 'start': 40189, 'length': 1, 'signed': False, 'decimals': 1},
    669. 

  669.             {'name': 'current_l2', 'start': 40190, 'length': 1, 'signed': False, 'decimals': 1},
    670. 

  670.             {'name': 'current_l3', 'start': 40191, 'length': 1, 'signed': False, 'decimals': 1},
    671. 

  671.             {'name': 'voltage_l1_l2', 'start': 40193, 'length': 1, 'signed': False, 'decimals': 1},
    672. 

  672.             {'name': 'voltage_l2_l3', 'start': 40194, 'length': 1, 'signed': False, 'decimals': 1},
    673. 

  673.             {'name': 'voltage_l3_l1', 'start': 40195, 'length': 1, 'signed': False, 'decimals': 1},
    674. 

  674.             {'name': 'voltage_l1_n', 'start': 40196, 'length': 1, 'signed': False, 'decimals': 1},
    675. 

  675.             {'name': 'voltage_l2_n', 'start': 40197, 'length': 1, 'signed': False, 'decimals': 1},
    676. 

  676.             {'name': 'voltage_l3_n', 'start': 40198, 'length': 1, 'signed': False, 'decimals': 1},
    677. 

  677.             {'name': 'active_power_total', 'start': 40200, 'length': 1, 'signed': True, 'decimals': -1},
    678. 

  678.             {'name': 'frequency', 'start': 40202, 'length': 1, 'signed': False, 'decimals': 2},
    679. 

  679.             {'name': 'apparent_power_total', 'start': 40204, 'length': 1, 'signed': True, 'decimals': -1},
    680. 

  680.             {'name': 'reactive_power_total', 'start': 40206, 'length': 1, 'signed': True, 'decimals': -1},
    681. 

  681.             {'name': 'power_factor_total', 'start': 40208, 'length': 1, 'signed': True, 'decimals': 3},
    682. 

  682.             {'name': 'active_export', 'start': 40210, 'length': 2, 'signed': False, 'decimals': 3},
    683. 

  683.             {'name': 'dc_power', 'start': 40217, 'length': 1, 'signed': False, 'decimals': -1},
    684. 

  684.             {'name': 'temperature_internal', 'start': 40219, 'length': 1, 'signed': False, 'decimals': 0},
    685. 

  685.             {'name': 'temperature_other', 'start': 40222, 'length': 1, 'signed': False, 'decimals': 0},
    686. 

  686.             {'name': 'operating_status', 'start': 40224, 'length': 1, 'signed': False, 'decimals': 0}
    687. 

  687.            ]
    688. 

  688. 

  689.     REG_OFFSET = 1
    690. 

  690.     PROTOCOL_CODE = 0
    691. 

  691.     FUNCTION_CODE = 3
    692. 

  692.     NULLS = [2**16 - 1, 2**15 - 1, 2**15, -2**15]
    693. 

  693. 

  694. if __name__ == "__main__":
    695. 

  695.     import argparse
    696. 

  696. 

  697.     parser = argparse.ArgumentParser(description='Read energy meters.')
    698. 

  698.     parser.add_argument('--device', '-d', dest='device', required=True, type=str, help='the serial port or IP-address for the device')
    699. 

  699.     parser.add_argument('--baud', '-b', dest='baud', required=False, default=38400, type=int, help='the serial baudrate')
    700. 

  700.     parser.add_argument('--type', '-t', dest='devtype', required=True, type=str, help='the type of energy meter: abb or sma')
    701. 

  701.     parser.add_argument('--slaveaddress', '-a', dest='slaveaddress', default=1, nargs=1, type=int, help='the modbus slave address (only when using serial)')
    702. 

  702.     parser.add_argument('--registers', '-r', dest='regs', type=str, help='the register you wish to read (default: all)', nargs='+')
    703. 

  703.     args = parser.parse_args()
    704. 

  704. 

  705.     types = {'abb': ABBMeter,
    706. 

  706.              'sma': SMAMeter}
    707. 

  707. 

  708.     meter = types[args.devtype](port=args.device, baudrate=args.baud, slaveaddress=args.slaveaddress[0])
    709. 

  709. 

  710.     if args.regs is None:
    711. 

  711.         result = meter.read()
    712. 

  712.     elif len(args.regs) == 1:
    713. 

  713.         result = meter.read(args.regs[0])
    714. 

  714.     else:
    715. 

  715.         result = meter.read(args.regs)
    716. 

  716. 

  717.     if args.regs is None or len(args.regs) > 1:
    718. 

  718.         for key in result:
    719. 

  719.             print(key + ": " + str(result[key]))
    720. 

  720.     else:
    721. 

  721.         print(result)
    722.