Installation¶
miniEMS consists of two parts that must both be installed:
| Part | What it is | Where it runs |
|---|---|---|
| miniEMS Add-on | The EMS engine — reads sensors, makes decisions, hosts the dashboard | HA add-on (Docker container) |
| miniEMS Integration | Custom HA integration — creates sensor.miniems_* entities in HA |
Home Assistant core (custom_components) |
1. Install the Add-on¶
miniEMS is distributed as a local Home Assistant add-on.
- Copy the
miniems/folder into your HA add-on directory via SSH or Samba: - In HA go to Settings → Add-ons → Add-on Store → ⋮ → Check for updates.
- The miniEMS add-on will appear under Local add-ons.
- Click Install.
- Click Start. The add-on will launch on port 8080 (ingress).
- Open the sidebar panel — you should see the miniEMS Dashboard with
Idlemode. Warnings are expected at this stage.
2. Install the Custom Integration¶
The integration creates all sensor.miniems_* entities in Home Assistant by polling the add-on's /api/status endpoint.
Automatic installation
The add-on automatically copies the integration files to
/config/custom_components/miniems/ on every startup. No manual file copying is needed.
Make sure the add-on is running (step 1) before restarting HA.
Restart Home Assistant¶
A full HA restart is required to load the new custom component — restarting only the add-on is not enough.
Settings → System → Restart Home Assistant
Add the integration¶
- Go to Settings → Integrations → + Add integration.
- Search for miniEMS and select it.
- Enter the Base URL of the add-on API:
| Setup | URL |
|---|---|
| Default (same host) | http://homeassistant:8080 |
| Custom / external | http://<your-ha-ip>:8080 |
- Click Submit. The integration tests the connection to
/api/status. If it succeeds, the miniEMS device and all 28 sensors are created immediately.
Options (optional)¶
After setup you can adjust the poll interval:
Settings → Integrations → miniEMS → Configure
| Option | Default | Range | Description |
|---|---|---|---|
| Poll interval | 30 s | 10 – 300 s | How often the integration fetches /api/status |
3. Configure the Add-on¶
- Open the miniEMS sidebar panel and go to the Settings tab.
- Enter your entity IDs (inverter, price sensor, etc.) and thresholds.
- Click Save & Restart.
See Configuration for the full settings reference.
Updates¶
Add-on update¶
- Replace the add-on files in
/addons/local/miniems/. - In HA: Settings → Add-ons → miniEMS → Update (or restart the add-on).
- Configuration is migrated automatically — no manual steps required.
Integration update¶
The add-on automatically updates the integration files on startup when a new version is detected.
- Update the add-on (see above) and restart it.
- Restart Home Assistant to load the new custom component.
Config persistence
All settings are stored in /data/config.json on the HA host. They survive add-on updates, restarts, and Supervisor reloads.
Uninstall¶
- Remove the integration: Settings → Integrations → miniEMS → Delete.
- Stop and remove the add-on via Settings → Add-ons → miniEMS → Uninstall.
- Delete the integration files:
/config/custom_components/miniems/. - To also remove stored data: delete
/data/miniems.dband/data/config.jsonvia the HA Terminal add-on.