Python E3DC

https://python-e3dc.readthedocs.io/
Admin
Python E3DC provides an API for querying E3/DC systems, supporting connections directly via RSCP or...
Tokens:5,244
Snippets:45
Trust Score:9.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Custom E3/DC Configuration Object

Source: https://python-e3dc.readthedocs.io

Use this optional configuration object to specify custom settings for PVIs, power meters, and batteries when the library's defaults do not match your E3/DC system setup. Not all options require explicit configuration.

```json
{
  "pvis": [
    {
      "index": 0,
      "strings": 2,
      "phases": 3
    }
  ],
  "powermeters": [
    {
      "index": 6
    }
  ],
  "batteries": [
    {
      "index": 0,
      "dcbs": 2
    }
  ]
}

```

--------------------------------

### E3DC poll() Return Value Example

Source: https://python-e3dc.readthedocs.io

Illustrates the dictionary structure returned by the poll() method, including autarky, consumption, production, state of charge, self-consumption, and timestamp.

```json
{
    'autarky': 100,
    'consumption': {
        'battery': 470,
        'house': 477,
        'wallbox': 0
    },
    'production': {
        'solar' : 951,
        'add' : 0,
        'grid' : -4
    },
    'stateOfCharge': 77,
    'selfConsumption': 100,
    'time': datetime.datetime(2021, 8, 14, 7, 6, 13)
}

```

--------------------------------

### get_system_info()

Source: https://python-e3dc.readthedocs.io

Retrieves general information about the E3/DC system.

```APIDOC
## get_system_info()

### Description
Retrieves general information about the E3/DC system.

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
```python
api.get_system_info()
```

### Response
Returns system information. Specific fields are not detailed in the source.
```

--------------------------------

### set_wallbox_schuko()

Source: https://python-e3dc.readthedocs.io

Configures the wallbox for Schuko charging.

```APIDOC
## set_wallbox_schuko()

### Description
Configures the wallbox for Schuko charging.

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
```python
api.set_wallbox_schuko()
```

### Response
Confirms the Schuko configuration. Specific response details are not provided.
```

--------------------------------

### set_wallbox_sunmode()

Source: https://python-e3dc.readthedocs.io

Enables sun mode charging for the wallbox.

```APIDOC
## set_wallbox_sunmode()

### Description
Enables sun mode charging for the wallbox.

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
```python
api.set_wallbox_sunmode()
```

### Response
Confirms sun mode activation. Specific response details are not provided.
```

--------------------------------

### toggle_wallbox_phases()

Source: https://python-e3dc.readthedocs.io

Toggles the phases used by the wallbox (e.g., single-phase/three-phase).

```APIDOC
## toggle_wallbox_phases()

### Description
Toggles the phases used by the wallbox (e.g., single-phase/three-phase).

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
```python
api.toggle_wallbox_phases()
```

### Response
Confirms the phase toggle. Specific response details are not provided.
```

--------------------------------

### toggle_wallbox_charging()

Source: https://python-e3dc.readthedocs.io

Toggles the charging state of the wallbox (start/stop).

```APIDOC
## toggle_wallbox_charging()

### Description
Toggles the charging state of the wallbox (start/stop).

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
```python
api.toggle_wallbox_charging()
```

### Response
Confirms the charging state toggle. Specific response details are not provided.
```

--------------------------------

### sendWallboxSetRequest()

Source: https://python-e3dc.readthedocs.io

Sends a generic setting request to the E3/DC wallbox.

```APIDOC
## sendWallboxSetRequest(request_data)

### Description
Sends a generic setting request to the E3/DC wallbox.

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
* **request_data** (any) - Required - The data payload for the wallbox setting request.

### Request Example
```python
api.sendWallboxSetRequest({'parameter': 'maxCurrent', 'value': 20})
```

### Response
Returns the response from the wallbox regarding the setting. Specific fields are not detailed in the source.
```

--------------------------------

### E3DC Class Methods

Source: https://python-e3dc.readthedocs.io

This section details the various methods available in the E3DC class for interacting with an E3/DC system. These methods cover data retrieval, system status, power management, and wallbox control.

```APIDOC
## E3DC Class Methods

### Description
Provides methods to interact with an E3/DC system, including retrieving various data points, setting configurations, and controlling system behavior.

### Methods
- `E3DC.disconnect()`
- `E3DC.get_batteries()`
- `E3DC.get_batteries_data()`
- `E3DC.get_battery_data()`
- `E3DC.get_db_data()`
- `E3DC.get_db_data_timestamp()`
- `E3DC.get_idle_periods()`
- `E3DC.get_power_settings()`
- `E3DC.get_powermeter_data()`
- `E3DC.get_powermeters()`
- `E3DC.get_powermeters_data()`
- `E3DC.get_pvi_data()`
- `E3DC.get_pvis()`
- `E3DC.get_pvis_data()`
- `E3DC.get_system_info()`
- `E3DC.get_system_info_static()`
- `E3DC.get_system_status()`
- `E3DC.get_wallbox_data()`
- `E3DC.poll()`
- `E3DC.poll_switches()`
- `E3DC.sendRequest()`
- `E3DC.sendRequestTag()`
- `E3DC.sendWallboxRequest()`
- `E3DC.sendWallboxSetRequest()`
- `E3DC.set_battery_to_car_mode()`
- `E3DC.set_idle_periods()`
- `E3DC.set_power_limits()`
- `E3DC.set_powersave()`
- `E3DC.set_switch_onoff()`
- `E3DC.set_wallbox_max_charge_current()`
- `E3DC.set_wallbox_schuko()`
- `E3DC.set_wallbox_sunmode()`
- `E3DC.set_weather_regulated_charge()`
- `E3DC.toggle_wallbox_charging()`
- `E3DC.toggle_wallbox_phases()`

### Constants
- `E3DC.CONNECT_LOCAL`
- `E3DC.CONNECT_WEB

### Helper Functions
- `set_rscp_debug()`
```

--------------------------------

### get_power_settings()

Source: https://python-e3dc.readthedocs.io

Retrieves the current power settings of the E3/DC system.

```APIDOC
## get_power_settings()

### Description
Retrieves the current power settings of the E3/DC system.

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
```python
api.get_power_settings()
```

### Response
Returns the power settings. Specific fields are not detailed in the source.
```

--------------------------------

### get_system_status()

Source: https://python-e3dc.readthedocs.io

Fetches the current status of the E3/DC system.

```APIDOC
## get_system_status()

### Description
Fetches the current status of the E3/DC system.

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
```python
api.get_system_status()
```

### Response
Returns the system status. Specific fields are not detailed in the source.
```

--------------------------------

### get_pvis()

Source: https://python-e3dc.readthedocs.io

Retrieves a list of PV inverters connected to the E3/DC system.

```APIDOC
## get_pvis()

### Description
Retrieves a list of PV inverters connected to the E3/DC system.

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
```python
api.get_pvis()
```

### Response
Returns a list of PV inverter identifiers or objects. Specific fields are not detailed in the source.
```

--------------------------------

### sendWallboxRequest()

Source: https://python-e3dc.readthedocs.io

Sends a generic request to the E3/DC wallbox.

```APIDOC
## sendWallboxRequest(request_data)

### Description
Sends a generic request to the E3/DC wallbox.

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
* **request_data** (any) - Required - The data payload for the wallbox request.

### Request Example
```python
api.sendWallboxRequest({'command': 'getStatus'})
```

### Response
Returns the response from the wallbox. Specific fields are not detailed in the source.
```

--------------------------------

### set_power_limits()

Source: https://python-e3dc.readthedocs.io

Sets the power limits for the E3/DC system.

```APIDOC
## set_power_limits(limit_value)

### Description
Sets the power limits for the E3/DC system.

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
* **limit_value** (number) - Required - The desired power limit.

### Request Example
```python
api.set_power_limits(limit_value=5000)
```

### Response
Confirms the power limit setting. Specific response details are not provided.
```

--------------------------------

### set_wallbox_max_charge_current()

Source: https://python-e3dc.readthedocs.io

Sets the maximum charging current for the wallbox.

```APIDOC
## set_wallbox_max_charge_current(current_amperes)

### Description
Sets the maximum charging current for the wallbox.

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
* **current_amperes** (number) - Required - The maximum charging current in amperes.

### Request Example
```python
api.set_wallbox_max_charge_current(current_amperes=16)
```

### Response
Confirms the maximum charge current setting. Specific response details are not provided.
```

--------------------------------

### get_pvis_data()

Source: https://python-e3dc.readthedocs.io

Retrieves detailed data for all connected PV inverters.

```APIDOC
## get_pvis_data()

### Description
Retrieves detailed data for all connected PV inverters.

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
```python
api.get_pvis_data()
```

### Response
Returns detailed data for all PV inverters. Specific fields are not detailed in the source.
```

--------------------------------

### get_pvi_data()

Source: https://python-e3dc.readthedocs.io

Retrieves detailed data for a specific PV inverter.

```APIDOC
## get_pvi_data(pvi_id)

### Description
Retrieves detailed data for a specific PV inverter.

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
* **pvi_id** (string) - Required - The identifier of the PV inverter.

### Request Example
```python
api.get_pvi_data(pvi_id='pvi_1')
```

### Response
Returns detailed data for the specified PV inverter. Specific fields are not detailed in the source.
```

--------------------------------

### get_batteries()

Source: https://python-e3dc.readthedocs.io

Retrieves a list of batteries connected to the E3/DC system.

```APIDOC
## get_batteries()

### Description
Retrieves a list of batteries connected to the E3/DC system.

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
```python
api.get_batteries()
```

### Response
Returns a list of battery identifiers or objects. Specific fields are not detailed in the source.
```

--------------------------------

### get_batteries_data()

Source: https://python-e3dc.readthedocs.io

Retrieves detailed data for all connected batteries.

```APIDOC
## get_batteries_data()

### Description
Retrieves detailed data for all connected batteries.

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
```python
api.get_batteries_data()
```

### Response
Returns detailed data for all batteries. Specific fields are not detailed in the source.
```

--------------------------------

### get_powermeters()

Source: https://python-e3dc.readthedocs.io

Retrieves a list of power meters connected to the E3/DC system.

```APIDOC
## get_powermeters()

### Description
Retrieves a list of power meters connected to the E3/DC system.

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
```python
api.get_powermeters()
```

### Response
Returns a list of power meter identifiers or objects. Specific fields are not detailed in the source.
```

--------------------------------

### get_battery_data()

Source: https://python-e3dc.readthedocs.io

Retrieves detailed data for a specific battery.

```APIDOC
## get_battery_data(battery_id)

### Description
Retrieves detailed data for a specific battery.

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
* **battery_id** (string) - Required - The identifier of the battery.

### Request Example
```python
api.get_battery_data(battery_id='battery_1')
```

### Response
Returns detailed data for the specified battery. Specific fields are not detailed in the source.
```

--------------------------------

### get_wallbox_data()

Source: https://python-e3dc.readthedocs.io

Retrieves data related to the E3/DC wallbox.

```APIDOC
## get_wallbox_data()

### Description
Retrieves data related to the E3/DC wallbox.

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
```python
api.get_wallbox_data()
```

### Response
Returns wallbox data. Specific fields are not detailed in the source.
```

--------------------------------

### get_idle_periods()

Source: https://python-e3dc.readthedocs.io

Retrieves the configured idle periods for the E3/DC system.

```APIDOC
## get_idle_periods()

### Description
Retrieves the configured idle periods for the E3/DC system.

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
```python
api.get_idle_periods()
```

### Response
Returns the idle periods configuration. Specific fields are not detailed in the source.
```

--------------------------------

### set_powersave()

Source: https://python-e3dc.readthedocs.io

Enables or disables power saving mode on the E3/DC system.

```APIDOC
## set_powersave(enable)

### Description
Enables or disables power saving mode on the E3/DC system.

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
* **enable** (boolean) - Required - True to enable power saving, False to disable.

### Request Example
```python
api.set_powersave(enable=True)
```

### Response
Confirms the power saving mode change. Specific response details are not provided.
```

--------------------------------

### get_powermeters_data()

Source: https://python-e3dc.readthedocs.io

Retrieves detailed data for all connected power meters.

```APIDOC
## get_powermeters_data()

### Description
Retrieves detailed data for all connected power meters.

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
```python
api.get_powermeters_data()
```

### Response
Returns detailed data for all power meters. Specific fields are not detailed in the source.
```

--------------------------------

### set_weather_regulated_charge()

Source: https://python-e3dc.readthedocs.io

Enables weather-regulated charging for the E3/DC system.

```APIDOC
## set_weather_regulated_charge()

### Description
Enables weather-regulated charging for the E3/DC system.

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
```python
api.set_weather_regulated_charge()
```

### Response
Confirms weather-regulated charging activation. Specific response details are not provided.
```

--------------------------------

### Local E3DC Connection

Source: https://python-e3dc.readthedocs.io

Connect to an E3DC device using its local IP address. Ensure you have the correct IP, username, password, and key.

```python
from e3dc import E3DC

TCP_IP = '192.168.1.57'
USERNAME = 'test@test.com'
PASS = 'MySecurePassword'
KEY = 'abc123'
CONFIG = {}
# CONFIG = {"powermeters": [{"index": 6}]}

print("local connection")
e3dc_obj = E3DC(E3DC.CONNECT_LOCAL, username=USERNAME, password=PASS, ipAddress = TCP_IP, key = KEY, configuration = CONFIG)
# The following connections are performed through the RSCP interface
print(e3dc_obj.poll(keepAlive=True))
print(e3dc_obj.get_pvi_data(keepAlive=True))
e3dc_obj.disconnect()

```

--------------------------------

### set_idle_periods()

Source: https://python-e3dc.readthedocs.io

Sets the idle periods for the E3/DC system.

```APIDOC
## set_idle_periods(start_time, end_time)

### Description
Sets the idle periods for the E3/DC system.

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
* **start_time** (time) - Required - The start time for the idle period.
* **end_time** (time) - Required - The end time for the idle period.

### Request Example
```python
api.set_idle_periods(start_time='08:00', end_time='17:00')
```

### Response
Confirms the setting of idle periods. Specific response details are not provided.
```

--------------------------------

### poll()

Source: https://python-e3dc.readthedocs.io

Polls the E3/DC system for updates. This is a general-purpose method for fetching current system data.

```APIDOC
## poll()

### Description
Polls the E3/DC system for updates. This is a general-purpose method for fetching current system data.

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
```python
api.poll()
```

### Response
Returns current system data. Specific fields are not detailed in the source.
```

--------------------------------

### Web E3DC Connection

Source: https://python-e3dc.readthedocs.io

Connect to an E3DC device via the web portal. Requires username, password, and serial number. The isPasswordMd5 parameter should be set appropriately.

```python
from e3dc import E3DC

USERNAME = 'test@test.com'
PASS = 'MySecurePassword'
SERIALNUMBER = 'S10-012345678910'
CONFIG = {}

print("web connection")
e3dc_obj = E3DC(E3DC.CONNECT_WEB, username=USERNAME, password=PASS, serialNumber = SERIALNUMBER, isPasswordMd5=False, configuration = CONFIG)
# connect to the portal and poll the status. This might raise an exception in case of failed login. This operation is performed with Ajax
print(e3dc_obj.poll(keepAlive=True))
print(e3dc_obj.get_pvi_data(keepAlive=True))
e3dc_obj.disconnect()

```

--------------------------------

### set_battery_to_car_mode()

Source: https://python-e3dc.readthedocs.io

Sets the battery to car charging mode.

```APIDOC
## set_battery_to_car_mode()

### Description
Sets the battery to car charging mode.

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
```python
api.set_battery_to_car_mode()
```

### Response
Confirms the mode change. Specific response details are not provided.
```

--------------------------------

### get_db_data()

Source: https://python-e3dc.readthedocs.io

Retrieves data related to the DC bus of the E3/DC system.

```APIDOC
## get_db_data()

### Description
Retrieves data related to the DC bus of the E3/DC system.

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
```python
api.get_db_data()
```

### Response
Returns DC bus data. Specific fields are not detailed in the source.
```

--------------------------------

### get_powermeter_data()

Source: https://python-e3dc.readthedocs.io

Retrieves detailed data for a specific power meter.

```APIDOC
## get_powermeter_data(meter_id)

### Description
Retrieves detailed data for a specific power meter.

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
* **meter_id** (string) - Required - The identifier of the power meter.

### Request Example
```python
api.get_powermeter_data(meter_id='meter_1')
```

### Response
Returns detailed data for the specified power meter. Specific fields are not detailed in the source.
```

--------------------------------

### poll_switches()

Source: https://python-e3dc.readthedocs.io

Polls the status of switches within the E3/DC system.

```APIDOC
## poll_switches()

### Description
Polls the status of switches within the E3/DC system.

### Method
Not specified (assumed to be a Python method call)

### Endpoint
N/A

### Parameters
None explicitly documented.

### Request Example
```python
api.poll_switches()
```

### Response
Returns the status of switches. Specific fields are not detailed in the source.
```
Tokens:
Raw