diff --git a/README.md b/README.md index 8cde7cf..c2f3816 100644 --- a/README.md +++ b/README.md @@ -208,6 +208,21 @@ Query Messages: - `/query/battery` Request that the camera reports its battery level - `/query/pir` Request that the camera reports its pir status +#### MQTT Discovery + +[MQTT Discovery](https://www.home-assistant.io/integrations/mqtt/#mqtt-discovery) is partially supported. +Currently, discovery is opt-in and camera features must be manually specified. + +```toml +[cameras.mqtt] + # + [cameras.mqtt.discovery] + topic = "homeassistant" + features = ["floodlight"] +``` + +See the sample config file for more details. + ### Pause To use the pause feature you will need to adjust your config file as such: diff --git a/sample_config.toml b/sample_config.toml index 1f8128f..f8f2b46 100644 --- a/sample_config.toml +++ b/sample_config.toml @@ -39,7 +39,7 @@ address = "192.168.1.187:9000" # mqtt.port = 1883 # mqtt.credentials = ["mqtt_user", "mqtt_password"] # MQTT Discovery: https://www.home-assistant.io/integrations/mqtt/#mqtt-discovery -# mqtt.discovery.topic = homeassistant # Uncomment to enable +# mqtt.discovery.topic = "homeassistant" # Uncomment to enable # If using discovery, _ characters are replaced with spaces in the name and title case is applied # mqtt.discovery.features = ["floodlight"] # Uncomment if this camera has a spotlight/floodlight