RSCP2MQTT - Docker Compose

This repository offers the option of starting the tools rscp2mqtt and rscp2mqtt-dashboard via docker compose. An MQTT broker can also be started. This significantly reduces and simplifies the otherwise necessary installation steps. All you have to do is enter the access data for the E3/DC house power station in the .env file and then execute ./start.sh.

The rscp2mqtt tool is always started. Additional options are

• the rscp2mqtt-dashboard for visualising the house power station data
• an MQTT broker, if you are not yet running one in your environment

Configuration

# Edit .env file
nano .env

# E3/DC access
E3DC_IP=<IP address of your home power station>
E3DC_USER=<your portal user name i.e. e-mail address>
E3DC_PASSWORD=<your portal password>
E3DC_AES_PASSWORD=<RSCP password, set via the display of your home power station>
INTERVAL=4

# For the new started internal broker
MQTT_PORT_OUT=1883

# Or for an existing external broker
MQTT_HOST=<your mqtt broker host name>
MQTT_PORT=1883

# Dashboard HTTP Port
HTTP_PORT=8080

.env can be extended by further environment variables that are known by the tools rscp2mqtt and rscp2mqtt-dashboard!

# make scripts executable
chmod +x start.sh
chmod +x stop.sh

Start Docker Container

Usage: ./start.sh [OPTIONS]

Options:
  --with-broker       Start internal MQTT broker
  --with-dashboard    Start rscp2mqtt-dashboard
  --help              Show this help message

Examples:
  ./start.sh                          # rscp2mqtt only
  ./start.sh --with-dashboard         # rscp2mqtt + dashboard
  ./start.sh --with-broker            # rscp2mqtt + internal broker
  ./start.sh --with-dashboard --with-broker  # all services

Stop Docker Container

Usage: ./stop.sh [OPTIONS]

Options:
  --with-broker       Stop internal MQTT broker
  --with-dashboard    Stop rscp2mqtt-dashboard
  --all               Stop all services (default)
  --help              Show this help message

Examples:
  ./stop.sh                          # stop all services
  ./stop.sh --with-dashboard         # stop dashboard only
  ./stop.sh --with-broker            # stop broker only
  ./stop.sh --with-dashboard --with-broker  # stop both optional services

Dashboard

If the dashboard has been selected as an option (--with-dashboard), it can be accessed at http://<your server>:8080/ui

MQTT broker

If the MQTT broker is also to be loaded (--with-broker), you can customise its configuration in the mosquitto/config/mosquitto.conf file. Otherwise, you can address an existing MQTT broker in your environment.

Start via docker compose

As an alternative to the shell scripts, the services can be started using docker compose.

docker compose --profile internal-broker --profile dashboard up -d