kerryxex/e3dc-proxy repository overview

⁠Project site

https://github.com/KerryXEX/E3DCproxy/tree/main⁠

⁠E3DCproxy

A proxy server to access E3DC status and history data from the internet.

This library provides read-only access to most commonly used status and data from an E3DC system and does not fully implement the wohle RSCP api.

⁠Setup

Access from the internet needs to be setup via a reverse proxy or simple port forwarding in your router. The standard exposed port is 5033 for http protocol.

A reverse proxy with SSL encyption is highly recommended!

⁠Configuration

To configure access to your E3DC power system, the following environment variables need to be set in the Docker environment:

• Local IP address of the E3DC system (192.168.x.x)
• Your login name (email) for the E3DC portal
• Your login password for the E3DC portal
• The RSCP password set in the E3DC power system

⁠API Requests

The follwoing api requests are implemented and return JSON strings:

• "/": returns the E3DC server data object configuration data as SunServer object
• "/canConnect": returns bool if E3DC RSCP connect is successful
• "/getStates": returns current E3DC states as SunState object
• "/getHistSumStates": returns a list of SunState objects with sum values for today, yesterday, 7-days, 30-days, 90-days, 360-days
• "/getHistory?days=1&interval=900": returns a list of Sunstate objects with sums for the requested timespan (# of days) and interval (# of seconds)
• "/getBatteries": returns config data for installed batteries as List of BatteryData object

⁠API Request Security

API requests must submit the RSCP password as API-Key authorization with name "X-Api-Key" added to the request header.

⁠Frontend App

The corresponding frontend app "SunStateApp" is published on the Apple AppStore and Google Playstore.