You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -4,168 +4,51 @@ A Domoticz plugin to collect data from SolarEdge power inverters over ModbusTCP.
4
4
5
5
The plugin uses the `solaredge_modbus` library (<https://github.com/nmakel/solaredge_modbus>) to communicate with the inverter.
6
6
7
+
The 1.x.x. versions of the plugin only read the inverter data.
8
+
9
+
The upcoming 2.x.x version will support meters and batteries.
10
+
7
11
## Requirements
8
12
9
13
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.
10
14
11
15
## Installation of the plugin
12
16
13
-
### Domoticz running on Ubuntu 20.04 LTS
17
+
Install D`omoticz` and make sure that `python 3.x` is installed on the computer.
14
18
15
-
Install `pip3`:
19
+
Download the plugin zip-file from [releases](https://github.com/addiejanssen/domoticz-solaredge-modbustcp-plugin/releases)
16
20
17
-
```shell
18
-
sudo apt install python3-pip
19
-
```
21
+
Unpack the contents of the zip-file into a folder in the `plugins` folder of your Domoticz installation.
20
22
21
-
Install `domoticz`:
23
+
Go to the folder where the plugin files were extracted to and install the dependencies:
22
24
23
-
```shell
24
-
curl -sSL install.domoticz.com | sudo bash
25
25
```
26
-
27
-
Make sure that the `plugins` folder exists in the `domoticz` folder.
Go to the plugin folder and install all required addons:
37
-
38
-
```shell
39
-
cd domoticz/plugins/domoticz-solaredge-modbustcp-plugin
40
26
sudo pip3 install -r requirements.txt
41
27
```
42
28
43
-
Once that is done, restart domoticz:
44
-
45
-
```shell
46
-
sudo service domoticz.sh restart
47
-
```
48
-
49
-
### Domoticz running inside Docker
50
-
51
-
Please have a look at the Domoticz documentation before going this route: https://www.domoticz.com/wiki/Docker
52
-
53
-
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
54
-
55
-
The installation documentation states:
56
-
> 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.
57
-
58
-
You will need to start Domoticz once to create the data in that userdata folder.
59
-
Once the folder is initialized, we can install the plugin:
There are multiple ways to install the modules that are required by this plugin.
67
-
This is the _easy going_ option, but it may not be the best solution for the long run:
68
-
69
-
Connect to the running container
70
-
71
-
```shell
72
-
docker exec -it domoticz
73
-
```
29
+
Then restart Domoticz and the plugin should become visible in the hardware dropdown list.
74
30
75
-
Go to the plugin folder and install all required addons in the plugin folder:
31
+
## Updating the plugin
76
32
77
-
```shell
78
-
cd userdata/plugins/domoticz-solaredge-modbustcp-plugin
79
-
pip3 install -r requirements.txt -t .
80
-
```
33
+
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.
81
34
82
-
Once that is done, restart the domoticz container.
35
+
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.
83
36
84
37
## Configuration in Domoticz
85
38
86
39
Once the plugin is installed, a new hardware type will be available: `SolarEdge ModbusTCP`.
87
40
88
-
To add the inverter, go to `Setup` -> `Hardware` and add the inverter:
41
+
To add the inverter, go to `Setup` -\>`Hardware` and add the inverter:
89
42
90
-
- Enter a `name` for the inverter.
91
-
- Select `SolarEdge ModbusTCP` from the `type` dropdown list.
92
-
- Enter the IP address of the inverter in the `Inverter IP Address` field.
93
-
- Enter the port number (default: 502) of the inverter in the `Inverter Port Number` field.
94
-
- Enter the Modbus device address (default: 1) of the inverter in the `Inverter Modbus device address` field.
95
-
- 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.
96
-
- 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.
97
-
- 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.
98
-
- 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.
99
-
-`Add` the inverter.
100
-
101
-
This should result in a lot of new devices in the `Setup` -> `Devices` menu.
102
-
103
-
## Updating the plugin
104
-
105
-
### Domoticz running on Ubuntu 20.04 LTS
106
-
107
-
Go to the plugin folder and get the new version:
108
-
109
-
```shell
110
-
cd domoticz/plugins/domoticz-solaredge-modbustcp-plugin
111
-
git pull
112
-
sudo pip3 install -r requirements.txt
113
-
```
114
-
115
-
Once that is done, restart domoticz:
116
-
117
-
```shell
118
-
sudo service domoticz.sh restart
119
-
```
120
-
121
-
### Domoticz running inside Docker
122
-
123
-
Connect to the running container
124
-
125
-
```shell
126
-
docker exec -it domoticz
127
-
```
128
-
129
-
Go to the plugin folder and install all required addons in the plugin folder:
130
-
131
-
```shell
132
-
cd userdata/plugins/domoticz-solaredge-modbustcp-plugin
133
-
git pull
134
-
pip3 install -r requirements.txt -t .
135
-
```
43
+
- Enter a `name` for the inverter.
44
+
- Select `SolarEdge ModbusTCP` from the `type` dropdown list.
45
+
- Enter the IP address or the DNS name of the inverter in the `Inverter IP Address` field.
46
+
- Enter the port number (default: 502) of the inverter in the `Inverter Port Number` field.
47
+
- Enter the Modbus device address (default: 1) of the inverter in the `Inverter Modbus device address` field.
48
+
- 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.
49
+
- 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.
50
+
- 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.
51
+
- 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.
52
+
-`Add` the inverter.
136
53
137
-
Once that is done, restart the domoticz container.
138
-
139
-
## Example
140
-
141
-
Here's an example of information returned by an inverter (in this case a SE7000 3 phase inverter):
0 commit comments