Files
domoticz-ds238-modbus-tcp/README.md

84 lines
2.5 KiB
Markdown

# Domoticz DS238-2 ModbusTCP plugin
A Domoticz plugin to collect data from Hiking DS238-2 D/ZN power meter ModbusTCP.
## Requirements
You need the DS238 to be connected over modbus over TCP. Wired or wireless.
Setup that use this on this plugin is using PW21
You need also to find the address of the DS238. You can find it using the
push button. Per default the address is 1.
## Installation of the plugin
This guide is based on Ubuntu 20.04 LTS:
Install `pip3`:
``` shell
sudo apt install python3-pip
```
Install `domoticz`:
``` shell
curl -sSL install.domoticz.com | sudo bash
```
Make sure that the `plugins` folder exists in the `domoticz` folder.
Install the plugin:
``` shell
cd domoticz/plugins
git clone https://github.com/xbeaudouin/domoticz-ds238-modbus-tcp.git
```
Go to the plugin folder and install all required addons:
``` shell
cd domoticz/plugins/domoticz-ds238-modbus-tcp
sudo pip3 install -r requirements.txt
```
Once that is done, restart domoticz:
``` shell
sudo service domoticz.sh restart
```
## Configuration in Domoticz
Once the plugin is installed, a new hardware type will be available: `DS238-2 D/ZN ModbusTCP`.
To add the inverter, go to `Setup` -> `Hardware` and add the counter:
- Enter a `name` for the counter.
- Select `DS238-2 D/ZN ModbusTCP` from the `type` dropdown list.
- Enter the IP address of the PW21 in the `Inverter IP Address` field.
- Enter the port number (default: 502) of the inverter in the `Inverter Port Number` field.
- Select `Yes` in the `Add missing devices` to create the devices when the counter is added. Select `No` after deleting unwanted devices. Leaving the option set to `Yes` will recreate the deleted devices once Domoticz is restarted.
- Select an `Interval` (default: 10 seconds); this defines how often the plugin will collect the data from the counter. Short intervals will result in more accurate values and graphs, but also result in more network traffic and a higher workload for both Domoticz and the counter.
- Optionally change the `Log level`; this defaults to `Normal`. When selecting `Extra`, the plugin will print all the information it received from the counter in the log.
- Optionally turn on `Debug`; be aware: this will generate a lot of entries in the Domoticz log!
- `Add` the counter.
This should result in a lot of new devices in the `Setup` -> `Devices` menu.
## Updating the plugin
Go to the plugin folder and get the new verion:
``` shell
cd domoticz/plugins/domoticz-ds238-modbus-tcp
git pull
```
Once that is done, restart domoticz:
``` shell
sudo service domoticz.sh restart
```