2016-08-22 18:16:11 +00:00
|
|
|
DSMR Parser
|
|
|
|
|
===========
|
|
|
|
|
|
2016-08-22 18:38:16 +00:00
|
|
|
.. image:: https://img.shields.io/pypi/v/dsmr-parser.svg
|
|
|
|
|
:target: https://pypi.python.org/pypi/dsmr-parser
|
|
|
|
|
|
2016-08-22 18:16:11 +00:00
|
|
|
A library for parsing Dutch Smart Meter Requirements (DSMR) telegram data. It
|
|
|
|
|
also includes a serial client to directly read and parse smart meter data.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Features
|
|
|
|
|
--------
|
|
|
|
|
|
2016-11-20 11:44:45 +00:00
|
|
|
DSMR Parser currently supports DSMR versions 2.2 and 4.x. It has been tested with Python 3.4 and 3.5.
|
2016-08-22 18:16:11 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Examples
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
Using the serial reader to connect to your smart meter and parse it's telegrams:
|
|
|
|
|
|
|
|
|
|
.. code-block:: python
|
|
|
|
|
|
|
|
|
|
from dsmr_parser import telegram_specifications
|
|
|
|
|
from dsmr_parser.obis_references import P1_MESSAGE_TIMESTAMP
|
|
|
|
|
from dsmr_parser.serial import SerialReader, SERIAL_SETTINGS_V4
|
|
|
|
|
|
|
|
|
|
serial_reader = SerialReader(
|
|
|
|
|
device='/dev/ttyUSB0',
|
|
|
|
|
serial_settings=SERIAL_SETTINGS_V4,
|
|
|
|
|
telegram_specification=telegram_specifications.V4
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
for telegram in serial_reader.read():
|
|
|
|
|
|
|
|
|
|
# The telegram message timestamp.
|
|
|
|
|
message_datetime = telegram[P1_MESSAGE_TIMESTAMP]
|
|
|
|
|
|
|
|
|
|
# Using the active tariff to determine the electricity being used and
|
|
|
|
|
# delivered for the right tariff.
|
|
|
|
|
tariff = telegram[ELECTRICITY_ACTIVE_TARIFF]
|
|
|
|
|
tariff = int(tariff.value)
|
|
|
|
|
|
|
|
|
|
electricity_used_total \
|
|
|
|
|
= telegram[ELECTRICITY_USED_TARIFF_ALL[tariff - 1]]
|
|
|
|
|
electricity_delivered_total = \
|
|
|
|
|
telegram[ELECTRICITY_DELIVERED_TARIFF_ALL[tariff - 1]]
|
|
|
|
|
|
|
|
|
|
gas_reading = telegram[HOURLY_GAS_METER_READING]
|
|
|
|
|
|
|
|
|
|
# See dsmr_reader.obis_references for all readable telegram values.
|
|
|
|
|
|
2016-11-20 11:44:45 +00:00
|
|
|
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.
|
2016-08-22 18:16:11 +00:00
|
|
|
|
|
|
|
|
Installation
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
To install DSMR Parser:
|
|
|
|
|
|
|
|
|
|
.. code-block:: bash
|
|
|
|
|
|
|
|
|
|
$ pip install dsmr-parser
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
TODO
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
|
- verify telegram checksum
|
|
|
|
|
- improve ease of use
|
