search

Apollon77 / ioBroker.smartmeter

ioBroker-Adapter to read out Smart-Meter using protocols like SML, D0 and such
MIT License
36 stars 17 forks source link
d0-protocol iobroker iobroker-adapter serial smartmeter smartmeter-library sml

readme

Logo

ioBroker.smartmeter

Number of Installations Number of Installations NPM version

Test and Release Translation status Downloads

This adapter uses Sentry libraries to automatically report exceptions and code errors to me as the developer. More details see below!

This adapter for ioBroker allows the reading and parsing of smartmeter protocols that follow the OBIS number logic to make their data available.

The Adapter needs nodejs 16.x+ to work!

This Adapter needs to have git installed currently for installing!

Description of parameters

ioBroker-Forum-Thread: http://forum.iobroker.net/viewtopic.php?f=23&t=5047&p=54973

Data Protocol

Supported Protocols:

Data Transfer

Data request interval

Number of seconds to wait for next request or pause serial receiving, value 0 possible to restart directly after finishing one message,

Default: is 300 (=5 Minutes)

Serial Device Baudrate

baudrate for initial serial connection, if not defined default values per Transport type are used (9600 for SerialResponseTransprt and 300 for SerialRequestResponseTransport)

D0: SignOn-Message Command

Command for SignIn-Message, default "?" to query mandatory fields, other values depending on device. Example: The 2WR5 Heatmeter uses "#" to query a lot more data (optional fields together with all mandatory)

D0: Mode-Overwrite

The Adapter tries to determine the D0 Protocol mode as defined in the specifications. There are some devices that do not comply to the specifications and so bring problems. Using this option you can overwrite the determined protocol mode.

D0: Baudrate-Changeover-Overwrite

The adapter tries to determine the Baudrate for the data messages as defined in the protocol specifications. But as with the Mode some smartmeter provide wrong data here. SO you can use this to overwrite the baudrate for the data message as needed. Leave empty to use the baudrate changeover as defined by the smart meter.

Adapter is tested with ...

... at least:

Please send me an info on devices where you have used the library successfully and I will add it here.

Special Smartmeters and problems

DZG DVS74

It seems to be an error in the SML firmware sometimes and values are wrongly encoded in the SML message, but the message itself is valid. Solution is to post process the value using a Javascript. See https://github.com/Apollon77/smartmeter-obis/issues/75#issuecomment-581650736

How to report issues and feature requests

Please use GitHub issues for this.

Best is to set the adapter to Debug log mode (Instances -> Expert mode -> Column Log level). Then please get the logfile from disk (subdirectory "log" in ioBroker installation directory and not from Admin because Admin cuts the lines). If you do not like providing it in GitHub issue you can also send it to me via email (iobroker@fischer-ka.de). Please add a reference to the relevant GitHub issue AND also describe what I see in the log at which time.

What is Sentry and what is reported to the servers?

Sentry.io is a way for developers to get an overview about errors from their applications. And exactly this is implemented in this adapter.

When the adapter crashes or an other Code error happens, this error message that also appears in the ioBroker log is submitted to our own Sentry server hosted in germany. When you allowed iobroker GmbH to collect diagnostic data then also your installation ID (this is just a unique ID without any additional infos about you, email, name or such) is included. This allows Sentry to group errors and show how many unique users are affected by such an error. All of this helps me to provide error free adapters that basically never crashs.

Changelog

3.4.0 (2023-11-25)

3.3.4 (2022-03-11)

3.3.3 (2022-02-21)

3.2.1 (2021-05-09)

3.2.0 (2021-01-24)

3.1.9 (2021-01-22)

3.1.8 (2021-01-14)

3.1.7 (2021-01-13)

3.1.6 (2020-11-15)

3.1.5 (2020-09-21)

3.1.3 (2020-07-20)

3.1.2 (2020-04-12)

3.1.1 (2020-03-11)

3.1.0 (2020-03-08)

3.0.10 (2020-02-05)

3.0.8 (2019-12-20)

3.0.7 (2019-12-18)

3.0.6 (2019-12-07)

3.0.3 (2019-11-30)

3.0.2 (2019-11-29)

3.0.1 (2019-11-27)

2.0.0 (2019-03-22)

1.2.2 (2018-11-11)

1.2.1 (2018-06-23)

1.1.3 (2018-04-13)

1.1.2 (26.03.2018)

1.1.0 (31.01.2018)

1.0.0 (25.08.2017)

0.5.12 (23.07.2017)

0.5.11 (21.06.2017)

0.5.8 (06.04.2017)

0.5.6 (02.04.2017)

0.5.5 (19.03.2017)

0.5.0 (26.02.2017)

0.4.2 (27.02.2017)

0.4.1 (24.02.2017)

0.4.0 (23.02.2017)

0.3.2 (22.02.2017)

0.3.1 (12.02.2017)

0.3.0 (11.02.2017)

0.1.1

0.1.0

0.0.1

License

The MIT License (MIT)

Copyright (c) 2017-2023 Apollon77 ingo@fischer-ka.de

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.