`settings` — Homie Settings¶

This module is to configure the home device. For reference see the example settings file in the repository.

Mandatory¶

All mandatory settings must be set in the settings.py config file on the device.

Wifi settings¶

settings.WIFI_SSID¶: SSID for the wifi to connect with. Value must be string.

settings.WIFI_PASSWORD¶: The password for the wifi to connect with. Value must be string.

Multiple WiFi credentials¶

settings.WIFI_CREDENTIALS¶: Microhomie can connect to a knwon wifi nearby. For this feature the WIFI_CREDENTIALS dictionary can contain multible wifi credentials in the format "ssid": "secret".

MQTT broker¶

settings.MQTT_BROKER¶: The MQTT broker IP address or hostname. Value must be string.

Optional settings¶

Optional settings have a default value an can be overwritten in the settings file.

Debug¶

settings.DEBUG¶: Set DEBUG to True to enable debug log output and to disable the WDT. Default ist False.

MQTT settings¶

settings.MQTT_PORT¶: Default port is 1883. Value must be integer.

settings.MQTT_USERNAME¶

The username to connect with. Default is None. Value must be string.

Do not set username for anonymouse auth.

settings.MQTT_PASSWORD¶: The password for the username to connect with. Default is None. Value must be string.

settings.MQTT_KEEPALIVE¶: Default keepalive in seconds is 30. Value must be interger.

settings.MQTT_SSL¶: My only work on ESP32. Default is False. Set to True to enable SSL.

settings.MQTT_SSL_PARAMS¶: Aditional SSL params as dict(). Default is set to {"do_handshake": True}.

settings.MQTT_BASE_TOPIC¶: The base topic for the homie device. Default is "homie". Value must be string.

Device settings¶

settings.DEVICE_ID¶

The device ID for registration at the broker. The device id is also the base topic of the device and must be unique. Default is to use a generated ID with homie.utils.get_unique_id().

Value must be string and unique.

settings.DEVICE_NAME¶: Friendly name of the device. Value must be string.

settings.DEVICE_STATS_INTERVAL¶: Time in seconds the stats coro publish updates. Default is 60 seconds.

settings.BROADCAST¶: Subscribe to broadcast topic is enabled by default. To disable broadcast messages set BROADCAST to False.

Extensions¶

settings.EXTENSIONS¶

Default is a empty list() for no extensions. Microhomie currently supports the two legacy extensions and a microhomie extension. Add the extensions to the list to activate them. Items in the list() must be string.

constants.EXT_MPY for org.microhomie.mpy:0.1.0:[4.x]
constants.EXT_FW for org.homie.legacy-firmware:0.1.1:[4.x]
constants.EXT_STATS for org.homie.legacy-stats:0.1.1:[4.x]

Example:

EXTENSIONS = [
    EXT_MPY,
    EXT_FW,
    EXT_STATS,
]

settings — Homie Settings¶