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
Copy file name to clipboardExpand all lines: README.md
+29-25Lines changed: 29 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,12 +12,14 @@ Python API for querying an [E3/DC](https://e3dc.de/) systems
12
12
This is supported either directly via RSCP connection or through the manufacturer's portal. The RSCP implementation has currently the most capabilities.
13
13
14
14
In order to use it you need:
15
+
15
16
- Your user name
16
17
- Your password
17
18
- The IP address of the E3/DC system
18
19
- The RSCP Password (encryption key), as set on the device under Main Page -> Personalize -> User profile -> RSCP password
19
20
20
21
Alternatively, for a web connection, you need:
22
+
21
23
- Your user name
22
24
- Your password
23
25
- The serial number of the system, which can be found when logging into the E3/DC webpage.
@@ -37,7 +39,7 @@ This library assumes, that there is one inverter installed and the root power me
37
39
38
40
For any other configurations, there is an optional `configuration` object that can be used to alter the defaults:
39
41
40
-
```
42
+
```python
41
43
{
42
44
"pvis": [
43
45
{
@@ -86,6 +88,7 @@ print(e3dc.get_pvi_data())
86
88
### poll() return values
87
89
88
90
Poll returns a dictionary like the following:
91
+
89
92
```python
90
93
{
91
94
'autarky': 100,
@@ -107,23 +110,23 @@ Poll returns a dictionary like the following:
107
110
108
111
### Available methods
109
112
110
-
*`poll()`
111
-
*`get_system_info()`
112
-
*`get_system_status()`
113
-
*`poll_switches()`
114
-
*`get_idle_periods()`
115
-
*`set_idle_periods()`
116
-
*`get_db_data()`
117
-
*`get_battery_data()`
118
-
*`get_batteries_data()`
119
-
*`get_pvi_data()`
120
-
*`get_pvis_data()`
121
-
*`get_powermeter_data()`
122
-
*`get_powermeters_data()`
123
-
*`get_power_settings()`
124
-
*`set_power_limits()`
125
-
*`set_powersave()`
126
-
*`set_weather_regulated_charge()`
113
+
-`poll()`
114
+
-`get_system_info()`
115
+
-`get_system_status()`
116
+
-`poll_switches()`
117
+
-`get_idle_periods()`
118
+
-`set_idle_periods()`
119
+
-`get_db_data()`
120
+
-`get_battery_data()`
121
+
-`get_batteries_data()`
122
+
-`get_pvi_data()`
123
+
-`get_pvis_data()`
124
+
-`get_powermeter_data()`
125
+
-`get_powermeters_data()`
126
+
-`get_power_settings()`
127
+
-`set_power_limits()`
128
+
-`set_powersave()`
129
+
-`set_weather_regulated_charge()`
127
130
128
131
See the full documentation on [ReadTheDocs](https://python-e3dc.readthedocs.io/en/latest/)
129
132
@@ -162,13 +165,14 @@ One limitation of the package concerns the implemented RSCP methods. This projec
162
165
163
166
## Projects using this library
164
167
165
-
*[e3dc-rest](https://github.com/vchrisb/e3dc-rest): a simple REST API to access an E3/DC system
166
-
*[e3dc-to-mqtt](https://github.com/mdhom/e3dc-to-mqtt): publish E3/DC data via MQTT
167
-
*[weewx-photovoltaics](https://github.com/roe-dl/weewx-photovoltaics): Extension to WeeWX for processing data of the photovoltaics system E3/DC
168
+
-[e3dc-rest](https://github.com/vchrisb/e3dc-rest): a simple REST API to access an E3/DC system
169
+
-[e3dc-to-mqtt](https://github.com/mdhom/e3dc-to-mqtt): publish E3/DC data via MQTT
170
+
-[weewx-photovoltaics](https://github.com/roe-dl/weewx-photovoltaics): Extension to WeeWX for processing data of the photovoltaics system E3/DC
168
171
169
172
## Contribution
170
173
171
-
* open an issue before making a pull request
172
-
* note the E3/DC system you tested with and implementation details
0 commit comments