Fork me on GitHub

pimatic-smartmeter-obis by Bert Gierveld (bertreb) | github | npm

pimatic-smartmeter-obis

Reading energy values from a smartmeter. This plugin is a based on the smartmeter-obis@1.1.3 library from Apollon77. This plugin supports OBIS smartmeter readings over D0 and SLM protocol and is compatible with node v4 to v10. The OBIS codes for electricity (usage and delivery) and gas (usage) are preset, but can be configured to meet the requirements of your smartmeter.

Installation

To enable the smartmeter plugin add this to the plugins section via the GUI or add it in the config.json file.

...
{
  "plugin": "Smartmeter-obis"
}
...

After restart of Pimatic the SmartmeterObis device can be added. Below the settings with the default values.

{
  "id": "smartmeter-obis",
  "class": "SmartmeterObisDevice",
  "name": "xxxx",
  "protocol": [D0Protocol | SlmProtocol] (D0Protocol is default)
  "serialport": "/dev/ttyUSB0",
  "baudRate" : 115200,
  "dataBits": 8,
  "parity": "none",
  "stopBits": 1,
  "requestInterval" : 10,
  "capabilityLog": false,
  "debuglevel": 0 (default 0 is no debugging)
}

The required smartmeter values can be selected on de device configuration page.

Configuration

Connect your smartmeter via een serial connection to your computer. Identify the serialport ID and communications settings of the smartmeter connection, on your computer (/dev/.....). Debuglevel 1 is for basic debugging and level 2 is for detailed debugging. When the capabilityLog is switched on, a smartmeter capability list with all the available OBIS values will be generated once on (re)start of the device. This capability list is writen into the pimatic log under "info".

Create a new SmartmeterObis device. You can choose between the D0 of Slm protocol depending on the type of smartmeter you are using.

The initial device doesn't expose any values. You need to add them in the device configuration (obisValues). The available values are:

  • actualusage - the actual power consumption (kW)
  • totalusage - the total consumed power; sum of Tariff1 and Tariff2 (kWh)
  • tariff1totalusage - the total consumed tariff1 (kWh)
  • tariff2totalusage - the total consumend tariff2 power (kWh)
  • gastotalusage - the total consumed gas (m3)
  • totaldelivery - the total delivered power; sum of tariff1 and tariff2 (kWh)
  • tariff1totaldelivery - the total delivered power tariff1 (kWh)
  • tariff2totaldelivery - the total delivered power tariff2 (kWh)

The OBIS string are preconfigured, based on my smartmeter:

  • actualusage: 1-0:1.7.0
  • totalusage: 1-0:1.8.0
  • tariff1totalusage: 1-0:1.8.1
  • tariff2totalusage: 1-0:1.8.2
  • gastotalusage: 0-1:24.2.1
  • totaldelivery: 1-0:2.8.0
  • tariff1totaldelivery: 1-0:2.8.1
  • tariff2totaldelivery: 1-0:2.8.2

You can change the OBIS string to get the right values from your smartmeter. The acronym and unit per value can be customized. You can use the capabilityLog info to tune your device.

If you want to format the values in the GUI, use xAttributeOptions. For example: to get rid of the decimals 'behind the dot' use displayFormat: fixed, decimal:0.

The plugin is in development. Please backup Pimatic before you are using it!

Plugin Config Options

SmartmeterObis

Device Config Options

pimatic-smartmeter-obis device config schemas

SmartmeterObisDevice

Smartmeter config options
OptionDescriptionDefault
protocol
string
Protocol to be used; D0Protocol or SmlProtocol
"D0Protocol"
serialPort
string
Serialport name (e.g. /dev/ttyUSB0)
"/dev/ttyUSB0"
baudRate
integer
Baudrate to use for communicating with smartmeter (e.g. 115200)
115200
dataBits
integer
Number of databits to use (e.g. 7)
8
parity
string
Parity to use (can be 'none', 'even', 'mark', 'odd', 'space')
"none"
stopBits
integer
Number of stopBits to use (can be 1 or 2)
1
requestInterval
integer
Interval between measurements (in seconds)
10
capabilityLog
boolean
Log of capabilities of smartmeter on (re)start of Device
false
debuglevel
integer
Debuglevel (can be 0 (none), 1 (basic) or 2 (detailed))
0
obisValues
array of objects
Smartmeter values that will be exposed in the device
[]
Elements
pimatic-smartmeter-obis is written by Bert Gierveld (bertreb)