-
Notifications
You must be signed in to change notification settings - Fork 1
Config Common
Jeroen Simonetti edited this page May 31, 2026
·
4 revisions
Auto-generated from helper_common/config.py. These models are shared by all mimirheim helper tools.
See Common for the narrative guide.
MQTT broker connection parameters, shared by all mimirheim input helper daemons.
| Field | Type | Default | Description |
|---|---|---|---|
host |
str |
(required) | Broker hostname or IP address. |
port |
int |
1883 |
Broker TCP port. |
client_id |
`str | None` | None |
username |
`str | None` | None |
password |
`str | None` | None |
tls |
bool |
False |
Enable TLS for the broker connection. Set to true when the broker listens on an encrypted port (typically 8883). |
tls_allow_insecure |
bool |
False |
Skip broker certificate verification when TLS is enabled. Has no effect when tls is false. |
Home Assistant MQTT discovery settings for a helper tool.
When enabled is True, the daemon publishes a retained discovery payload
to {discovery_prefix}/button/{tool_name}/config on every broker connect
and whenever HA's birth message (homeassistant/status = online) is
received. This creates a button entity in HA that triggers the tool on press.
| Field | Type | Default | Description |
|---|---|---|---|
enabled |
bool |
False |
Enable HA MQTT discovery. |
discovery_prefix |
str |
'homeassistant' |
HA MQTT discovery topic prefix. |
device_name |
str |
'' |
Display name for the HA device. Defaults to tool name. |
forecast_sensor |
bool |
True |
Publish an additional HA sensor entity for the helper's forecast output topic. |
Getting started
Helpers
- Common
- Nordpool
- Zonneplan
- PV Fetcher
- PV ML Learner
- Baseload (Static)
- Baseload (HA)
- Baseload (HA DB)
- Reporter
- Scheduler
- Config Editor
Developer
Reference