diff --git a/source/_components/lock.mqtt.markdown b/source/_components/lock.mqtt.markdown index 7009e9224e9..cf47519cb74 100644 --- a/source/_components/lock.mqtt.markdown +++ b/source/_components/lock.mqtt.markdown @@ -36,6 +36,10 @@ name: required: false type: string default: MQTT Lock +unique_id: + description: An ID that uniquely identifies this lock. If two locks have the same unique ID, Home Assistant will raise an exception. + required: false + type: string command_topic: description: The MQTT topic to publish commands to change the lock state. required: true @@ -87,6 +91,35 @@ payload_not_available: required: false type: string default: offline +device: + description: 'Information about the device this lock is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/docs/mqtt/discovery/) and when [`unique_id`](#unique_id) is set.' + required: false + type: map + keys: + identifiers: + description: 'A list of IDs that uniquely identify the device. For example a serial number.' + required: false + type: list, string + connections: + description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.' + required: false + type: list + manufacturer: + description: 'The manufacturer of the device.' + required: false + type: string + model: + description: 'The model of the device.' + required: false + type: string + name: + description: 'The name of the device.' + required: false + type: string + sw_version: + description: 'The firmware version of the device.' + required: false + type: string {% endconfiguration %}