Common

Shared Helper Configuration

All mimirheim input helpers share the same mqtt: and optional ha_discovery: configuration blocks, defined once in the helper_common package. This page documents both sections.

Full auto-generated field reference: Config-Common

---

mqtt — MQTT broker connection

Every helper config file has a top-level mqtt: section:

mqtt:
  host: localhost
  port: 1883
  client_id: mimir-nordpool    # must be unique per helper instance
  username: null              # omit for anonymous access
  password: null
  tls_allow_insecure: false

Field	Type	Default	Description
host	string	(required)	Broker hostname or IP address
port	int	1883	TCP port. Use 8883 with TLS.
client_id	string	(required)	Must be unique across all clients on the broker. Two clients with the same ID cause each other to disconnect repeatedly.
username	string or null	null	Broker username. Omit for anonymous access.
password	string or null	null	Broker password.
tls_allow_insecure	bool	false	Enable TLS without certificate verification. Only for self-signed certificates on private networks.

TLS: set port: 8883 and tls_allow_insecure: false to connect to a TLS-secured broker with a valid CA-signed certificate. Set tls_allow_insecure: true for self-signed certificates in a private home network.

---

ha_discovery — Home Assistant MQTT discovery

All helpers (except the reporter and scheduler) support optional HA MQTT discovery. When enabled, the daemon registers a button entity in HA that triggers the tool on press.

ha_discovery:
  enabled: true
  discovery_prefix: homeassistant    # default; matches HA's default
  device_name: "MIMIRHEIM PV Fetcher"     # displayed on the HA device card

Field	Type	Default	Description
enabled	bool	false	Enable HA MQTT discovery.
discovery_prefix	string	homeassistant	HA discovery topic prefix. Match the discovery_prefix set in HA's MQTT integration configuration.
device_name	string	""	Human-readable name for the HA device card. Defaults to a formatted version of the tool name if left empty.

When enabled: true, the daemon publishes a retained discovery payload to:

{discovery_prefix}/button/{client_id}/config

This payload is re-published on every broker connect and whenever HA's birth message (homeassistant/status = online) is received.

Birth message handling is important for HA restart resilience: when HA restarts and its MQTT integration comes back online, it publishes homeassistant/status = online. The helper re-publishes its discovery payload in response, so HA re-registers the entity without needing a helper restart.

---

stats_topic — Per-cycle run statistics

Most helpers support an optional stats_topic that receives a JSON payload summarising each run cycle. Useful for monitoring dashboards.

stats_topic: mimirheim-helpers/stats/nordpool    # null = disabled (default)

The payload schema varies by helper; refer to the individual helper guide.

---

signal_mimir and mimir_trigger_topic

Most helpers can signal mimirheim to re-solve immediately after publishing new data:

signal_mimir: true
mimir_trigger_topic: mimir/input/trigger    # defaults to derived topic

signal_mimir: true causes the helper to publish an empty retained message to mimir_trigger_topic after each successful data publish. This ensures mimirheim re-optimises with the freshest data without waiting for the next scheduler cycle.

mimir_trigger_topic defaults to {mimir_topic_prefix}/input/trigger when not set explicitly.