Skip to content

Commit fd7bd95

Browse files
Update list of tags and move to enum (#87)
* Update RSCP tags and move to enum * Add script to automatically generate RscpTag Enum * RscpType, RscpError, PowermeterType as Enum
1 parent 09f215a commit fd7bd95

7 files changed

Lines changed: 4502 additions & 2620 deletions

File tree

README.md

Lines changed: 29 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,14 @@ Python API for querying an [E3/DC](https://e3dc.de/) systems
1212
This is supported either directly via RSCP connection or through the manufacturer's portal. The RSCP implementation has currently the most capabilities.
1313

1414
In order to use it you need:
15+
1516
- Your user name
1617
- Your password
1718
- The IP address of the E3/DC system
1819
- The RSCP Password (encryption key), as set on the device under Main Page -> Personalize -> User profile -> RSCP password
1920

2021
Alternatively, for a web connection, you need:
22+
2123
- Your user name
2224
- Your password
2325
- 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
3739

3840
For any other configurations, there is an optional `configuration` object that can be used to alter the defaults:
3941

40-
```
42+
```python
4143
{
4244
"pvis": [
4345
{
@@ -86,6 +88,7 @@ print(e3dc.get_pvi_data())
8688
### poll() return values
8789

8890
Poll returns a dictionary like the following:
91+
8992
```python
9093
{
9194
'autarky': 100,
@@ -107,23 +110,23 @@ Poll returns a dictionary like the following:
107110

108111
### Available methods
109112

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()`
127130

128131
See the full documentation on [ReadTheDocs](https://python-e3dc.readthedocs.io/en/latest/)
129132

@@ -162,13 +165,14 @@ One limitation of the package concerns the implemented RSCP methods. This projec
162165

163166
## Projects using this library
164167

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
168171

169172
## Contribution
170173

171-
* open an issue before making a pull request
172-
* note the E3/DC system you tested with and implementation details
173-
* pull request checks will enforce code styling (black, flake8, isort)
174-
* consider adding yourself to `AUTHORS`
174+
- Open an issue before making a pull request
175+
- Note the E3/DC system you tested with and implementation details
176+
- Pull request checks will enforce code styling (black, flake8, flake8-docstrings, isort)
177+
- Make sure to support Python versions >= 3.7
178+
- Consider adding yourself to `AUTHORS`

0 commit comments

Comments
 (0)