From 927a4bc8e7131c3f0863e126f56238d9f652b248 Mon Sep 17 00:00:00 2001 From: Nigel Dokter Date: Sun, 20 Nov 2016 12:44:45 +0100 Subject: [PATCH] added DSMR v4 parsing unit test; added alternative serial settings for DSMR v2 and v4; --- README.rst | 6 +- dsmr_parser/parsers.py | 2 +- dsmr_parser/serial.py | 21 ++ test/__init__.py | 0 test/{test_parse.py => test_parse_v2_2.py} | 15 +- test/test_parse_v4_2.py | 231 +++++++++++++++++++++ 6 files changed, 265 insertions(+), 10 deletions(-) create mode 100644 test/__init__.py rename test/{test_parse.py => test_parse_v2_2.py} (69%) create mode 100644 test/test_parse_v4_2.py diff --git a/README.rst b/README.rst index 23aff2f..b6feed0 100644 --- a/README.rst +++ b/README.rst @@ -11,7 +11,7 @@ also includes a serial client to directly read and parse smart meter data. Features -------- -DSMR Parser currently supports DSMR versions 2.2 and 4.x. It has been tested with Python 3.5 and 3.4. +DSMR Parser currently supports DSMR versions 2.2 and 4.x. It has been tested with Python 3.4 and 3.5. Examples @@ -50,6 +50,9 @@ Using the serial reader to connect to your smart meter and parse it's telegrams: # See dsmr_reader.obis_references for all readable telegram values. +The dsmr_parser.serial module contains multiple settings that should work in +most cases. For example: if SERIAL_SETTINGS_V4 doesn't work, then try +SERIAL_SETTINGS_V4_EVEN too. Installation ------------ @@ -64,6 +67,5 @@ To install DSMR Parser: TODO ---- -- add unit tests - verify telegram checksum - improve ease of use diff --git a/dsmr_parser/parsers.py b/dsmr_parser/parsers.py index 4b49a68..0e86a2a 100644 --- a/dsmr_parser/parsers.py +++ b/dsmr_parser/parsers.py @@ -36,7 +36,7 @@ class TelegramParser(object): return telegram def parse_line(self, line_value): - logger.debug('Parsing line\'%s\'', line_value) + logger.debug('Parsing line \'%s\'', line_value) obis_reference, parser = self._find_line_parser(line_value) diff --git a/dsmr_parser/serial.py b/dsmr_parser/serial.py index 6f47b1c..f9276f7 100644 --- a/dsmr_parser/serial.py +++ b/dsmr_parser/serial.py @@ -13,7 +13,27 @@ SERIAL_SETTINGS_V2_2 = { 'timeout': 20 } +SERIAL_SETTINGS_V2_2_EVEN = { + 'baudrate': 9600, + 'bytesize': serial.SEVENBITS, + 'parity': serial.PARITY_EVEN, + 'stopbits': serial.STOPBITS_ONE, + 'xonxoff': 0, + 'rtscts': 0, + 'timeout': 20 +} + SERIAL_SETTINGS_V4 = { + 'baudrate': 115200, + 'bytesize': serial.SEVENBITS, + 'parity': serial.PARITY_NONE, + 'stopbits': serial.STOPBITS_ONE, + 'xonxoff': 0, + 'rtscts': 0, + 'timeout': 20 +} + +SERIAL_SETTINGS_V4_EVEN = { 'baudrate': 115200, 'bytesize': serial.SEVENBITS, 'parity': serial.PARITY_EVEN, @@ -24,6 +44,7 @@ SERIAL_SETTINGS_V4 = { } + def is_start_of_telegram(line): return line.startswith('/') diff --git a/test/__init__.py b/test/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/test/test_parse.py b/test/test_parse_v2_2.py similarity index 69% rename from test/test_parse.py rename to test/test_parse_v2_2.py index 433fd15..92717e1 100644 --- a/test/test_parse.py +++ b/test/test_parse_v2_2.py @@ -1,8 +1,8 @@ -"""Test telegram parsing.""" +"""Test parsing of a DSMR v2.2 telegram.""" from dsmr_parser.parsers import TelegramParserV2_2 from dsmr_parser import telegram_specifications -from dsmr_parser.obis_references import CURRENT_ELECTRICITY_USAGE, GAS_METER_READING +from dsmr_parser import obis_references as obis TELEGRAM_V2_2 = [ "/ISk5\2MT382-1004", @@ -28,13 +28,14 @@ TELEGRAM_V2_2 = [ ] -def test_parse_v2_2(): +def test_parse(): """Test if telegram parsing results in correct results.""" parser = TelegramParserV2_2(telegram_specifications.V2_2) result = parser.parse(TELEGRAM_V2_2) - assert float(result[CURRENT_ELECTRICITY_USAGE].value) == 1.01 - assert result[CURRENT_ELECTRICITY_USAGE].unit == 'kW' - assert float(result[GAS_METER_READING].value) == 1.001 - assert result[GAS_METER_READING].unit == 'm3' + assert float(result[obis.CURRENT_ELECTRICITY_USAGE].value) == 1.01 + assert result[obis.CURRENT_ELECTRICITY_USAGE].unit == 'kW' + + assert float(result[obis.GAS_METER_READING].value) == 1.001 + assert result[obis.GAS_METER_READING].unit == 'm3' diff --git a/test/test_parse_v4_2.py b/test/test_parse_v4_2.py new file mode 100644 index 0000000..14730a9 --- /dev/null +++ b/test/test_parse_v4_2.py @@ -0,0 +1,231 @@ +"""Test parsing of a DSMR v4.2 telegram.""" +import datetime + +from decimal import Decimal +import pytz + +from dsmr_parser.objects import CosemObject, MBusObject +from dsmr_parser.parsers import TelegramParser +from dsmr_parser import telegram_specifications +from dsmr_parser import obis_references as obis + +TELEGRAM_V4_2 = [ + '1-3:0.2.8(42)', + '0-0:1.0.0(161113205757W)', + '0-0:96.1.1(1231231231231231231231231231231231)', + '1-0:1.8.1(001511.267*kWh)', + '1-0:1.8.2(001265.173*kWh)', + '1-0:2.8.1(000000.000*kWh)', + '1-0:2.8.2(000000.000*kWh)', + '0-0:96.14.0(0001)', + '1-0:1.7.0(00.235*kW)', + '1-0:2.7.0(00.000*kW)', + '0-0:96.7.21(00015)', + '0-0:96.7.9(00007)', + '1-0:99.97.0(3)(0-0:96.7.19)(000103180420W)(0000237126*s)(000101000001W)(2147483647*s)(000101000001W)(2147483647*s)', + '1-0:32.32.0(00000)', + '1-0:52.32.0(00000)', + '1-0:72.32.0(00000)', + '1-0:32.36.0(00000)', + '1-0:52.36.0(00000)', + '1-0:72.36.0(00000)', + '0-0:96.13.1()', + '0-0:96.13.0()', + '1-0:31.7.0(000*A)', + '1-0:51.7.0(000*A)', + '1-0:71.7.0(000*A)', + '1-0:21.7.0(00.095*kW)', + '1-0:22.7.0(00.000*kW)', + '1-0:41.7.0(00.025*kW)', + '1-0:42.7.0(00.000*kW)', + '1-0:61.7.0(00.115*kW)', + '1-0:62.7.0(00.000*kW)', + '0-1:24.1.0(003)', + '0-1:96.1.0(3404856892390357246729543587524029)', + '0-1:24.2.1(161113200000W)(00915.219*m3)', + '!5D83', +] + + +def test_parse(): + parser = TelegramParser(telegram_specifications.V4) + result = parser.parse(TELEGRAM_V4_2) + + # P1_MESSAGE_HEADER (1-3:0.2.8) + assert isinstance(result[obis.P1_MESSAGE_HEADER], CosemObject) + assert result[obis.P1_MESSAGE_HEADER].unit is None + assert isinstance(result[obis.P1_MESSAGE_HEADER].value, str) + assert result[obis.P1_MESSAGE_HEADER].value == '42' + + # P1_MESSAGE_TIMESTAMP (0-0:1.0.0) + assert isinstance(result[obis.P1_MESSAGE_TIMESTAMP], CosemObject) + assert result[obis.P1_MESSAGE_TIMESTAMP].unit is None + assert isinstance(result[obis.P1_MESSAGE_TIMESTAMP].value, datetime.datetime) + assert result[obis.P1_MESSAGE_TIMESTAMP].value == \ + datetime.datetime(2016, 11, 13, 19, 57, 57, tzinfo=pytz.UTC) + + # ELECTRICITY_USED_TARIFF_1 (1-0:1.8.1) + assert isinstance(result[obis.ELECTRICITY_USED_TARIFF_1], CosemObject) + assert result[obis.ELECTRICITY_USED_TARIFF_1].unit == 'kWh' + assert isinstance(result[obis.ELECTRICITY_USED_TARIFF_1].value, Decimal) + assert result[obis.ELECTRICITY_USED_TARIFF_1].value == Decimal('1511.267') + + # ELECTRICITY_USED_TARIFF_2 (1-0:1.8.2) + assert isinstance(result[obis.ELECTRICITY_USED_TARIFF_2], CosemObject) + assert result[obis.ELECTRICITY_USED_TARIFF_2].unit == 'kWh' + assert isinstance(result[obis.ELECTRICITY_USED_TARIFF_2].value, Decimal) + assert result[obis.ELECTRICITY_USED_TARIFF_2].value == Decimal('1265.173') + + # ELECTRICITY_DELIVERED_TARIFF_1 (1-0:2.8.1) + assert isinstance(result[obis.ELECTRICITY_DELIVERED_TARIFF_1], CosemObject) + assert result[obis.ELECTRICITY_DELIVERED_TARIFF_1].unit == 'kWh' + assert isinstance(result[obis.ELECTRICITY_DELIVERED_TARIFF_1].value, Decimal) + assert result[obis.ELECTRICITY_DELIVERED_TARIFF_1].value == Decimal('0') + + # ELECTRICITY_DELIVERED_TARIFF_2 (1-0:2.8.2) + assert isinstance(result[obis.ELECTRICITY_DELIVERED_TARIFF_2], CosemObject) + assert result[obis.ELECTRICITY_DELIVERED_TARIFF_2].unit == 'kWh' + assert isinstance(result[obis.ELECTRICITY_DELIVERED_TARIFF_2].value, Decimal) + assert result[obis.ELECTRICITY_DELIVERED_TARIFF_2].value == Decimal('0') + + # ELECTRICITY_ACTIVE_TARIFF (0-0:96.14.0) + assert isinstance(result[obis.ELECTRICITY_ACTIVE_TARIFF], CosemObject) + assert result[obis.ELECTRICITY_ACTIVE_TARIFF].unit is None + assert isinstance(result[obis.ELECTRICITY_ACTIVE_TARIFF].value, str) + assert result[obis.ELECTRICITY_ACTIVE_TARIFF].value == '0001' + + # EQUIPMENT_IDENTIFIER (0-0:96.1.1) + assert isinstance(result[obis.EQUIPMENT_IDENTIFIER], CosemObject) + assert result[obis.EQUIPMENT_IDENTIFIER].unit is None + assert isinstance(result[obis.EQUIPMENT_IDENTIFIER].value, str) + assert result[obis.EQUIPMENT_IDENTIFIER].value == '1231231231231231231231231231231231' + + # CURRENT_ELECTRICITY_USAGE (1-0:1.7.0) + assert isinstance(result[obis.CURRENT_ELECTRICITY_USAGE], CosemObject) + assert result[obis.CURRENT_ELECTRICITY_USAGE].unit == 'kW' + assert isinstance(result[obis.CURRENT_ELECTRICITY_USAGE].value, Decimal) + assert result[obis.CURRENT_ELECTRICITY_USAGE].value == Decimal('0.235') + + # CURRENT_ELECTRICITY_DELIVERY (1-0:2.7.0) + assert isinstance(result[obis.CURRENT_ELECTRICITY_DELIVERY], CosemObject) + assert result[obis.CURRENT_ELECTRICITY_DELIVERY].unit == 'kW' + assert isinstance(result[obis.CURRENT_ELECTRICITY_DELIVERY].value, Decimal) + assert result[obis.CURRENT_ELECTRICITY_DELIVERY].value == Decimal('0') + + # LONG_POWER_FAILURE_COUNT (96.7.9) + assert isinstance(result[obis.LONG_POWER_FAILURE_COUNT], CosemObject) + assert result[obis.LONG_POWER_FAILURE_COUNT].unit is None + assert isinstance(result[obis.LONG_POWER_FAILURE_COUNT].value, int) + assert result[obis.LONG_POWER_FAILURE_COUNT].value == 7 + + # VOLTAGE_SAG_L1_COUNT (1-0:32.32.0) + assert isinstance(result[obis.VOLTAGE_SAG_L1_COUNT], CosemObject) + assert result[obis.VOLTAGE_SAG_L1_COUNT].unit is None + assert isinstance(result[obis.VOLTAGE_SAG_L1_COUNT].value, int) + assert result[obis.VOLTAGE_SAG_L1_COUNT].value == 0 + + # VOLTAGE_SAG_L2_COUNT (1-0:52.32.0) + assert isinstance(result[obis.VOLTAGE_SAG_L2_COUNT], CosemObject) + assert result[obis.VOLTAGE_SAG_L2_COUNT].unit is None + assert isinstance(result[obis.VOLTAGE_SAG_L2_COUNT].value, int) + assert result[obis.VOLTAGE_SAG_L2_COUNT].value == 0 + + # VOLTAGE_SAG_L3_COUNT (1-0:72.32.0) + assert isinstance(result[obis.VOLTAGE_SAG_L3_COUNT], CosemObject) + assert result[obis.VOLTAGE_SAG_L3_COUNT].unit is None + assert isinstance(result[obis.VOLTAGE_SAG_L3_COUNT].value, int) + assert result[obis.VOLTAGE_SAG_L3_COUNT].value == 0 + + # VOLTAGE_SWELL_L1_COUNT (1-0:32.36.0) + assert isinstance(result[obis.VOLTAGE_SWELL_L1_COUNT], CosemObject) + assert result[obis.VOLTAGE_SWELL_L1_COUNT].unit is None + assert isinstance(result[obis.VOLTAGE_SWELL_L1_COUNT].value, int) + assert result[obis.VOLTAGE_SWELL_L1_COUNT].value == 0 + + # VOLTAGE_SWELL_L2_COUNT (1-0:52.36.0) + assert isinstance(result[obis.VOLTAGE_SWELL_L2_COUNT], CosemObject) + assert result[obis.VOLTAGE_SWELL_L2_COUNT].unit is None + assert isinstance(result[obis.VOLTAGE_SWELL_L2_COUNT].value, int) + assert result[obis.VOLTAGE_SWELL_L2_COUNT].value == 0 + + # VOLTAGE_SWELL_L3_COUNT (1-0:72.36.0) + assert isinstance(result[obis.VOLTAGE_SWELL_L3_COUNT], CosemObject) + assert result[obis.VOLTAGE_SWELL_L3_COUNT].unit is None + assert isinstance(result[obis.VOLTAGE_SWELL_L3_COUNT].value, int) + assert result[obis.VOLTAGE_SWELL_L3_COUNT].value == 0 + + # TEXT_MESSAGE_CODE (0-0:96.13.1) + assert isinstance(result[obis.TEXT_MESSAGE_CODE], CosemObject) + assert result[obis.TEXT_MESSAGE_CODE].unit is None + assert result[obis.TEXT_MESSAGE_CODE].value is None + + # TEXT_MESSAGE (0-0:96.13.0) + assert isinstance(result[obis.TEXT_MESSAGE], CosemObject) + assert result[obis.TEXT_MESSAGE].unit is None + assert result[obis.TEXT_MESSAGE].value is None + + # DEVICE_TYPE (0-x:24.1.0) + assert isinstance(result[obis.TEXT_MESSAGE], CosemObject) + assert result[obis.DEVICE_TYPE].unit is None + assert isinstance(result[obis.DEVICE_TYPE].value, int) + assert result[obis.DEVICE_TYPE].value == 3 + + # INSTANTANEOUS_ACTIVE_POWER_L1_POSITIVE (1-0:21.7.0) + assert isinstance(result[obis.INSTANTANEOUS_ACTIVE_POWER_L1_POSITIVE], CosemObject) + assert result[obis.INSTANTANEOUS_ACTIVE_POWER_L1_POSITIVE].unit == 'kW' + assert isinstance(result[obis.INSTANTANEOUS_ACTIVE_POWER_L1_POSITIVE].value, Decimal) + assert result[obis.INSTANTANEOUS_ACTIVE_POWER_L1_POSITIVE].value == Decimal('0.095') + + # INSTANTANEOUS_ACTIVE_POWER_L2_POSITIVE (1-0:41.7.0) + assert isinstance(result[obis.INSTANTANEOUS_ACTIVE_POWER_L2_POSITIVE], CosemObject) + assert result[obis.INSTANTANEOUS_ACTIVE_POWER_L2_POSITIVE].unit == 'kW' + assert isinstance(result[obis.INSTANTANEOUS_ACTIVE_POWER_L2_POSITIVE].value, Decimal) + assert result[obis.INSTANTANEOUS_ACTIVE_POWER_L2_POSITIVE].value == Decimal('0.025') + + # INSTANTANEOUS_ACTIVE_POWER_L3_POSITIVE (1-0:61.7.0) + assert isinstance(result[obis.INSTANTANEOUS_ACTIVE_POWER_L3_POSITIVE], CosemObject) + assert result[obis.INSTANTANEOUS_ACTIVE_POWER_L3_POSITIVE].unit == 'kW' + assert isinstance(result[obis.INSTANTANEOUS_ACTIVE_POWER_L3_POSITIVE].value, Decimal) + assert result[obis.INSTANTANEOUS_ACTIVE_POWER_L3_POSITIVE].value == Decimal('0.115') + + # INSTANTANEOUS_ACTIVE_POWER_L1_NEGATIVE (1-0:22.7.0) + assert isinstance(result[obis.INSTANTANEOUS_ACTIVE_POWER_L1_NEGATIVE], CosemObject) + assert result[obis.INSTANTANEOUS_ACTIVE_POWER_L1_NEGATIVE].unit == 'kW' + assert isinstance(result[obis.INSTANTANEOUS_ACTIVE_POWER_L1_NEGATIVE].value, Decimal) + assert result[obis.INSTANTANEOUS_ACTIVE_POWER_L1_NEGATIVE].value == Decimal('0') + + # INSTANTANEOUS_ACTIVE_POWER_L2_NEGATIVE (1-0:42.7.0) + assert isinstance(result[obis.INSTANTANEOUS_ACTIVE_POWER_L2_NEGATIVE], CosemObject) + assert result[obis.INSTANTANEOUS_ACTIVE_POWER_L2_NEGATIVE].unit == 'kW' + assert isinstance(result[obis.INSTANTANEOUS_ACTIVE_POWER_L2_NEGATIVE].value, Decimal) + assert result[obis.INSTANTANEOUS_ACTIVE_POWER_L2_NEGATIVE].value == Decimal('0') + + # INSTANTANEOUS_ACTIVE_POWER_L3_NEGATIVE (1-0:62.7.0) + assert isinstance(result[obis.INSTANTANEOUS_ACTIVE_POWER_L3_NEGATIVE], CosemObject) + assert result[obis.INSTANTANEOUS_ACTIVE_POWER_L3_NEGATIVE].unit == 'kW' + assert isinstance(result[obis.INSTANTANEOUS_ACTIVE_POWER_L3_NEGATIVE].value, Decimal) + assert result[obis.INSTANTANEOUS_ACTIVE_POWER_L3_NEGATIVE].value == Decimal('0') + + # EQUIPMENT_IDENTIFIER_GAS (0-x:96.1.0) + assert isinstance(result[obis.EQUIPMENT_IDENTIFIER_GAS], CosemObject) + assert result[obis.EQUIPMENT_IDENTIFIER_GAS].unit is None + assert isinstance(result[obis.EQUIPMENT_IDENTIFIER_GAS].value, str) + assert result[obis.EQUIPMENT_IDENTIFIER_GAS].value == '3404856892390357246729543587524029' + + # HOURLY_GAS_METER_READING (0-1:24.2.1) + assert isinstance(result[obis.HOURLY_GAS_METER_READING], MBusObject) + assert result[obis.HOURLY_GAS_METER_READING].unit == 'm3' + assert isinstance(result[obis.HOURLY_GAS_METER_READING].value, Decimal) + assert result[obis.HOURLY_GAS_METER_READING].value == Decimal('915.219') + + # POWER_EVENT_FAILURE_LOG (99.97.0) + # TODO to be implemented + + # ACTUAL_TRESHOLD_ELECTRICITY (0-0:17.0.0) + # TODO to be implemented + + # ACTUAL_SWITCH_POSITION (0-0:96.3.10) + # TODO to be implemented + + # VALVE_POSITION_GAS (0-x:24.4.0) + # TODO to be implemented