Skip to content

Commit

Permalink
Updated the README
Browse files Browse the repository at this point in the history
  • Loading branch information
@addiejanssen
addiejanssen committed Oct 2, 2022
1 parent f41df26 commit 126d018
Showing 1 changed file with 24 additions and 141 deletions.
165 changes: 24 additions & 141 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,168 +4,51 @@ A Domoticz plugin to collect data from SolarEdge power inverters over ModbusTCP.

The plugin uses the `solaredge_modbus` library (<https://github.com/nmakel/solaredge_modbus>) to communicate with the inverter.

The 1.x.x. versions of the plugin only read the inverter data.

The upcoming 2.x.x version will support meters and batteries.

## Requirements

The inverter needs to be connected to the network (either wired or wireless) and Modbus must be enabled on the device. Please consult the documentation of your inverter to find out how to enable Modbus.

## Installation of the plugin

### Domoticz running on Ubuntu 20.04 LTS
Install D`omoticz` and make sure that `python 3.x` is installed on the computer.

Install `pip3`:
Download the plugin zip-file from [releases](https://github.com/addiejanssen/domoticz-solaredge-modbustcp-plugin/releases)

``` shell
sudo apt install python3-pip
```
Unpack the contents of the zip-file into a folder in the `plugins` folder of your Domoticz installation.

Install `domoticz`:
Go to the folder where the plugin files were extracted to and install the dependencies:

``` 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/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
sudo service domoticz.sh restart
```

### Domoticz running inside Docker

Please have a look at the Domoticz documentation before going this route: https://www.domoticz.com/wiki/Docker

This guide is based on the information of the original Domoticz Docker image, which can be found here: https://hub.docker.com/r/domoticz/domoticz

The installation documentation states:
> When launching the docker container for the first time, a plugin folder is created in the userdata folder. You need to place your python plugins is folder.
You will need to start Domoticz once to create the data in that userdata folder.
Once the folder is initialized, we can install the plugin:

``` shell
cd <path for config files>/plugins
git clone https://github.com/addiejanssen/domoticz-solaredge-modbustcp-plugin.git
```

There are multiple ways to install the modules that are required by this plugin.
This is the _easy going_ option, but it may not be the best solution for the long run:

Connect to the running container

``` shell
docker exec -it domoticz
```
Then restart Domoticz and the plugin should become visible in the hardware dropdown list.

Go to the plugin folder and install all required addons in the plugin folder:
## Updating the plugin

``` shell
cd userdata/plugins/domoticz-solaredge-modbustcp-plugin
pip3 install -r requirements.txt -t .
```
Updating the plugin can be done by removing the previous version and do a clean install again. Make sure to stop the Domoticz service before you start or at least stop all hardware that is related to the plugin.

Once that is done, restart the domoticz container.
Make sure that the requirements listed in the `requirements.txt` file are met. If newer versions of the `solaredge_modbus` library are required, make sure that you remove the older versions to prevent version conflicts.

## Configuration in Domoticz

Once the plugin is installed, a new hardware type will be available: `SolarEdge ModbusTCP`.

To add the inverter, go to `Setup` -> `Hardware` and add the inverter:
To add the inverter, go to `Setup` -\> `Hardware` and add the inverter:

- Enter a `name` for the inverter.
- Select `SolarEdge ModbusTCP` from the `type` dropdown list.
- Enter the IP address of the inverter in the `Inverter IP Address` field.
- Enter the port number (default: 502) of the inverter in the `Inverter Port Number` field.
- Enter the Modbus device address (default: 1) of the inverter in the `Inverter Modbus device address` 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 `Auto Avg/Max math`; this defaults to `Enabled` which means that the Domoticz graphs for most values will be averaged over time. When selecting `Disabled`, the calculations will be disabled and the Domoticz graphs will be based on the last retrieved value.
- 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. When selecting `Debug`, even more information will be logged.
- `Add` the inverter.

This should result in a lot of new devices in the `Setup` -> `Devices` menu.

## Updating the plugin

### Domoticz running on Ubuntu 20.04 LTS

Go to the plugin folder and get the new version:

``` shell
cd domoticz/plugins/domoticz-solaredge-modbustcp-plugin
git pull
sudo pip3 install -r requirements.txt
```

Once that is done, restart domoticz:

``` shell
sudo service domoticz.sh restart
```

### Domoticz running inside Docker

Connect to the running container

``` shell
docker exec -it domoticz
```

Go to the plugin folder and install all required addons in the plugin folder:

``` shell
cd userdata/plugins/domoticz-solaredge-modbustcp-plugin
git pull
pip3 install -r requirements.txt -t .
```
- Enter a `name` for the inverter.
- Select `SolarEdge ModbusTCP` from the `type` dropdown list.
- Enter the IP address or the DNS name of the inverter in the `Inverter IP Address` field.
- Enter the port number (default: 502) of the inverter in the `Inverter Port Number` field.
- Enter the Modbus device address (default: 1) of the inverter in the `Inverter Modbus device address` field.
- Select `Yes` in the `Add missing devices` to create the devices when the inverter is added. Select `No` after deleting unused 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 `Auto Avg/Max math`; this defaults to `Enabled` which means that the Domoticz graphs for most values will be averaged over time. When selecting `Disabled`, the Domoticz graphs will be based on the last retrieved value.
- Optionally change the `Log level`; this defaults to `Normal`. When selecting `Extra`, the plugin will print all the information it receives from the inverter in the log. When selecting `Debug`, even more information will be logged.
- `Add` the inverter.

Once that is done, restart the domoticz container.

## Example

Here's an example of information returned by an inverter (in this case a SE7000 3 phase inverter):

| Name | Value | Symbol |
|-------------------|-----------------------|--------|
| Model | SE7K | |
| Version | 0003.2251 | |
| Serial | 7E2AB053 | |
| Modbus ID | 1 | |
| SunSpec DID | Three Phase Inverter | |
| Status | Producing | |
| Vendor Status | 0 | |
| Current | 3.59 | A |
| L1 Current | 1.21 | A |
| L2 Current | 1.17 | A |
| L3 Current | 1.20 | A |
| L1 Voltage | 401.4 | V |
| L2 Voltage | 401.2 | V |
| L3 Voltage | 402.8 | V |
| L1-N Voltage | 230.1 | V |
| L2-N Voltage | 232.7 | V |
| L3-N Voltage | 230.4 | V |
| Power | 784.0 | W |
| Frequency | 50.01 | Hz |
| Power (Apparent) | 829.1 | VA |
| Power (Reactive) | -270.00 | VAr |
| Power Factor | -94.46 | % |
| Total Energy | 10773388 | Wh |
| DC Current | 1.0647 | A |
| DC Voltage | 747.5 | V |
| DC Power | 795.9 | W |
| Temperature | 43.53 | °C |
This should result in a lot of new devices in the `Setup` -\> `Devices` menu.

0 comments on commit 126d018

Please sign in to comment.