From 001438f0a6fcbcd05dbc461cec5e201d2c66d958 Mon Sep 17 00:00:00 2001 From: Addie Janssen <55428983+addiejanssen@users.noreply.github.com> Date: Sun, 25 Oct 2020 14:17:16 +0100 Subject: [PATCH] Update README.md - Changed the installation instructions to use the `requirements.txt` file. - Mentioned the `Log level` option in the hardware setup menu. --- README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 2aa1202..b1bd23b 100644 --- a/README.md +++ b/README.md @@ -12,33 +12,34 @@ The inverter needs to be connected to the network (either wired or wireless) and This guide is based on Ubuntu 20.04 LTS: -Install `domoticz`: - -``` shell -curl -sSL install.domoticz.com | sudo bash -``` - Install `pip3`: ``` shell sudo apt install python3-pip ``` -Install the `solaredge_modbus` library: +Install `domoticz`: ``` shell -sudo pip3 install solaredge_modbus +curl -sSL install.domoticz.com | sudo bash ``` Make sure that the `plugins` folder exists in the `domoticz` folder. -Install the plugin itself: +Install the plugin: ``` shell cd domoticz/plugins git clone https://github.com/addiejanssen/domoticz-solaredge-modbustcp-plugin.git ``` +Go to the plugin folder and install all required addons: + +``` shell +cd domoticz/plugins/domoticz-solaredge-modbustcp-plugin +sudo pip3 install -r requirements.txt +``` + Once that is done, restart domoticz: ``` shell @@ -57,6 +58,7 @@ To add the inverter, go to `Setup` -> `Hardware` and add the inverter: - 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 inverter 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: 5 seconds); this defines how often the plugin will collect the data from the inverter. 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 inverter. +- Optionally change the `Log level`; this defaults to `Normal`. When selecting `Extra`, the plugin will print all the information it received from the inverter in the log. - Optionally turn on `Debug`; be aware: this will generate a lot of entries in the Domoticz log! - `Add` the inverter.