From b721084c4c530c0bad9a504e12f756152fb6b1f3 Mon Sep 17 00:00:00 2001 From: Jan Bouwhuis Date: Tue, 16 Jan 2024 14:03:00 +0100 Subject: [PATCH] Add serial_number config attribute to MQTT device mapping (#30855) * Add serial_number config attribute to MQTT device mapping * Fix type --- .../_integrations/alarm_control_panel.mqtt.markdown | 4 ++++ source/_integrations/binary_sensor.mqtt.markdown | 4 ++++ source/_integrations/button.mqtt.markdown | 4 ++++ source/_integrations/camera.mqtt.markdown | 4 ++++ source/_integrations/climate.mqtt.markdown | 4 ++++ source/_integrations/cover.mqtt.markdown | 4 ++++ source/_integrations/device_trigger.mqtt.markdown | 4 ++++ source/_integrations/event.mqtt.markdown | 4 ++++ source/_integrations/fan.mqtt.markdown | 4 ++++ source/_integrations/humidifier.mqtt.markdown | 4 ++++ source/_integrations/image.mqtt.markdown | 4 ++++ source/_integrations/lawn_mower.mqtt.markdown | 4 ++++ source/_integrations/light.mqtt.markdown | 12 ++++++++++++ source/_integrations/lock.mqtt.markdown | 4 ++++ source/_integrations/mqtt.markdown | 2 ++ source/_integrations/number.mqtt.markdown | 4 ++++ source/_integrations/scene.mqtt.markdown | 4 ++++ source/_integrations/select.mqtt.markdown | 4 ++++ source/_integrations/sensor.mqtt.markdown | 4 ++++ source/_integrations/siren.mqtt.markdown | 4 ++++ source/_integrations/switch.mqtt.markdown | 4 ++++ source/_integrations/tag.mqtt.markdown | 4 ++++ source/_integrations/text.mqtt.markdown | 4 ++++ source/_integrations/update.mqtt.markdown | 4 ++++ source/_integrations/vacuum.mqtt.markdown | 4 ++++ source/_integrations/valve.mqtt.markdown | 4 ++++ source/_integrations/water_heater.mqtt.markdown | 4 ++++ 27 files changed, 114 insertions(+) diff --git a/source/_integrations/alarm_control_panel.mqtt.markdown b/source/_integrations/alarm_control_panel.mqtt.markdown index cffe3bfacaf..acdf38563ee 100644 --- a/source/_integrations/alarm_control_panel.mqtt.markdown +++ b/source/_integrations/alarm_control_panel.mqtt.markdown @@ -135,6 +135,10 @@ device: description: "The name of the device." required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string suggested_area: description: 'Suggest an area if the device isn’t in one yet.' required: false diff --git a/source/_integrations/binary_sensor.mqtt.markdown b/source/_integrations/binary_sensor.mqtt.markdown index 6d2cde1fdda..39745b269af 100644 --- a/source/_integrations/binary_sensor.mqtt.markdown +++ b/source/_integrations/binary_sensor.mqtt.markdown @@ -100,6 +100,10 @@ device: description: The name of the device. required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string suggested_area: description: 'Suggest an area if the device isn’t in one yet.' required: false diff --git a/source/_integrations/button.mqtt.markdown b/source/_integrations/button.mqtt.markdown index b27e5a3d42e..835a4c9c3da 100644 --- a/source/_integrations/button.mqtt.markdown +++ b/source/_integrations/button.mqtt.markdown @@ -97,6 +97,10 @@ device: description: The name of the device. required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string suggested_area: description: 'Suggest an area if the device isn’t in one yet.' required: false diff --git a/source/_integrations/camera.mqtt.markdown b/source/_integrations/camera.mqtt.markdown index d958bd78791..47153d6ef91 100644 --- a/source/_integrations/camera.mqtt.markdown +++ b/source/_integrations/camera.mqtt.markdown @@ -99,6 +99,10 @@ device: description: The name of the device. required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string suggested_area: description: 'Suggest an area if the device isn’t in one yet.' required: false diff --git a/source/_integrations/climate.mqtt.markdown b/source/_integrations/climate.mqtt.markdown index 9bd168069ed..99a7b30df35 100644 --- a/source/_integrations/climate.mqtt.markdown +++ b/source/_integrations/climate.mqtt.markdown @@ -118,6 +118,10 @@ device: description: 'The name of the device.' required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string suggested_area: description: 'Suggest an area if the device isn’t in one yet.' required: false diff --git a/source/_integrations/cover.mqtt.markdown b/source/_integrations/cover.mqtt.markdown index 5a919d36ea2..f640883776b 100644 --- a/source/_integrations/cover.mqtt.markdown +++ b/source/_integrations/cover.mqtt.markdown @@ -110,6 +110,10 @@ device: description: The name of the device. required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string suggested_area: description: 'Suggest an area if the device isn’t in one yet.' required: false diff --git a/source/_integrations/device_trigger.mqtt.markdown b/source/_integrations/device_trigger.mqtt.markdown index 14eea3c1761..752312b24c6 100644 --- a/source/_integrations/device_trigger.mqtt.markdown +++ b/source/_integrations/device_trigger.mqtt.markdown @@ -72,6 +72,10 @@ device: description: The name of the device. required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string suggested_area: description: 'Suggest an area if the device isn’t in one yet.' required: false diff --git a/source/_integrations/event.mqtt.markdown b/source/_integrations/event.mqtt.markdown index 7bf28a846b3..9b9d0a381bf 100644 --- a/source/_integrations/event.mqtt.markdown +++ b/source/_integrations/event.mqtt.markdown @@ -91,6 +91,10 @@ device: description: The name of the device. required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string suggested_area: description: 'Suggest an area if the device isn’t in one yet.' required: false diff --git a/source/_integrations/fan.mqtt.markdown b/source/_integrations/fan.mqtt.markdown index fed05d176b9..a62f9f788c7 100644 --- a/source/_integrations/fan.mqtt.markdown +++ b/source/_integrations/fan.mqtt.markdown @@ -105,6 +105,10 @@ device: description: The name of the device. required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string suggested_area: description: 'Suggest an area if the device isn’t in one yet.' required: false diff --git a/source/_integrations/humidifier.mqtt.markdown b/source/_integrations/humidifier.mqtt.markdown index e7b71d0b40e..8d321f781da 100644 --- a/source/_integrations/humidifier.mqtt.markdown +++ b/source/_integrations/humidifier.mqtt.markdown @@ -124,6 +124,10 @@ device: description: The name of the device. required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string suggested_area: description: 'Suggest an area if the device isn’t in one yet.' required: false diff --git a/source/_integrations/image.mqtt.markdown b/source/_integrations/image.mqtt.markdown index 4f9af9fafc8..367aa7510b9 100644 --- a/source/_integrations/image.mqtt.markdown +++ b/source/_integrations/image.mqtt.markdown @@ -102,6 +102,10 @@ device: description: The name of the device. required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string suggested_area: description: 'Suggest an area if the device isn’t in one yet.' required: false diff --git a/source/_integrations/lawn_mower.mqtt.markdown b/source/_integrations/lawn_mower.mqtt.markdown index f027c913d2a..2869e6d6f78 100644 --- a/source/_integrations/lawn_mower.mqtt.markdown +++ b/source/_integrations/lawn_mower.mqtt.markdown @@ -100,6 +100,10 @@ device: description: The name of the device. required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string suggested_area: description: 'Suggest an area if the device isn’t in one yet.' required: false diff --git a/source/_integrations/light.mqtt.markdown b/source/_integrations/light.mqtt.markdown index 1b68606524d..4e6dfae7bd7 100644 --- a/source/_integrations/light.mqtt.markdown +++ b/source/_integrations/light.mqtt.markdown @@ -168,6 +168,10 @@ device: description: 'The name of the device.' required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string suggested_area: description: 'Suggest an area if the device isn’t in one yet.' required: false @@ -607,6 +611,10 @@ device: description: 'The name of the device.' required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string sw_version: description: 'The firmware version of the device.' required: false @@ -976,6 +984,10 @@ device: description: 'The name of the device.' required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string sw_version: description: 'The firmware version of the device.' required: false diff --git a/source/_integrations/lock.mqtt.markdown b/source/_integrations/lock.mqtt.markdown index 03a9482798d..eada2cf9b24 100644 --- a/source/_integrations/lock.mqtt.markdown +++ b/source/_integrations/lock.mqtt.markdown @@ -112,6 +112,10 @@ device: description: 'The name of the device.' required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string suggested_area: description: 'Suggest an area if the device isn’t in one yet.' required: false diff --git a/source/_integrations/mqtt.markdown b/source/_integrations/mqtt.markdown index 82c18536a7a..e1986df8192 100644 --- a/source/_integrations/mqtt.markdown +++ b/source/_integrations/mqtt.markdown @@ -557,6 +557,7 @@ support_url: 'hw': 'hw_version', 'sw': 'sw_version', 'sa': 'suggested_area', + 'sn': 'serial_number', ``` {% enddetails %} {% details "Supported abbreviations for origin info" %} @@ -900,6 +901,7 @@ Setting up a [light that takes JSON payloads](/integrations/light.mqtt/#json-sch "mf": "Bla electronics", "mdl": "xya", "sw": "1.0", + "sn": "ea334450945afc", "hw": "1.0rev2", }, "o": { diff --git a/source/_integrations/number.mqtt.markdown b/source/_integrations/number.mqtt.markdown index d49876b4daa..e72b2c01b53 100644 --- a/source/_integrations/number.mqtt.markdown +++ b/source/_integrations/number.mqtt.markdown @@ -91,6 +91,10 @@ device: description: The name of the device. required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string suggested_area: description: 'Suggest an area if the device isn’t in one yet.' required: false diff --git a/source/_integrations/scene.mqtt.markdown b/source/_integrations/scene.mqtt.markdown index bfbe7511bac..f180f4a07c2 100644 --- a/source/_integrations/scene.mqtt.markdown +++ b/source/_integrations/scene.mqtt.markdown @@ -95,6 +95,10 @@ device: description: The name of the device. required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string suggested_area: description: 'Suggest an area if the device isn’t in one yet.' required: false diff --git a/source/_integrations/select.mqtt.markdown b/source/_integrations/select.mqtt.markdown index 348fc90b29f..fae4c67c4a7 100644 --- a/source/_integrations/select.mqtt.markdown +++ b/source/_integrations/select.mqtt.markdown @@ -103,6 +103,10 @@ device: description: The name of the device. required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string suggested_area: description: 'Suggest an area if the device isn’t in one yet.' required: false diff --git a/source/_integrations/sensor.mqtt.markdown b/source/_integrations/sensor.mqtt.markdown index e6d6d9511f2..a336d7a5bc0 100644 --- a/source/_integrations/sensor.mqtt.markdown +++ b/source/_integrations/sensor.mqtt.markdown @@ -92,6 +92,10 @@ device: description: The name of the device. required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string suggested_area: description: 'Suggest an area if the device isn’t in one yet.' required: false diff --git a/source/_integrations/siren.mqtt.markdown b/source/_integrations/siren.mqtt.markdown index dc77a556057..609ed22294e 100644 --- a/source/_integrations/siren.mqtt.markdown +++ b/source/_integrations/siren.mqtt.markdown @@ -114,6 +114,10 @@ device: description: The name of the device. required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string suggested_area: description: 'Suggest an area if the device isn’t in one yet.' required: false diff --git a/source/_integrations/switch.mqtt.markdown b/source/_integrations/switch.mqtt.markdown index 66a11eace31..29fdbded48c 100644 --- a/source/_integrations/switch.mqtt.markdown +++ b/source/_integrations/switch.mqtt.markdown @@ -101,6 +101,10 @@ device: description: The name of the device. required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string suggested_area: description: 'Suggest an area if the device isn’t in one yet.' required: false diff --git a/source/_integrations/tag.mqtt.markdown b/source/_integrations/tag.mqtt.markdown index 915db473c05..93e6b0a442a 100644 --- a/source/_integrations/tag.mqtt.markdown +++ b/source/_integrations/tag.mqtt.markdown @@ -57,6 +57,10 @@ device: description: The name of the device. required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string suggested_area: description: 'Suggest an area if the device isn’t in one yet.' required: false diff --git a/source/_integrations/text.mqtt.markdown b/source/_integrations/text.mqtt.markdown index fc32722f0ea..d60f413acf7 100644 --- a/source/_integrations/text.mqtt.markdown +++ b/source/_integrations/text.mqtt.markdown @@ -99,6 +99,10 @@ device: description: The name of the device. required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string suggested_area: description: 'Suggest an area if the device isn’t in one yet.' required: false diff --git a/source/_integrations/update.mqtt.markdown b/source/_integrations/update.mqtt.markdown index 3e9f96ea834..d4724ad9743 100644 --- a/source/_integrations/update.mqtt.markdown +++ b/source/_integrations/update.mqtt.markdown @@ -96,6 +96,10 @@ device: description: The name of the device. required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string suggested_area: description: 'Suggest an area if the device isn’t in one yet.' required: false diff --git a/source/_integrations/vacuum.mqtt.markdown b/source/_integrations/vacuum.mqtt.markdown index f1920b18ebd..9c209178b13 100644 --- a/source/_integrations/vacuum.mqtt.markdown +++ b/source/_integrations/vacuum.mqtt.markdown @@ -88,6 +88,10 @@ device: description: The name of the device. required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string suggested_area: description: 'Suggest an area if the device isn’t in one yet.' required: false diff --git a/source/_integrations/valve.mqtt.markdown b/source/_integrations/valve.mqtt.markdown index 46caf2e55f5..e6f9e10102a 100644 --- a/source/_integrations/valve.mqtt.markdown +++ b/source/_integrations/valve.mqtt.markdown @@ -134,6 +134,10 @@ device: description: The name of the device. required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string suggested_area: description: Suggest an area if the device isn’t in one yet. required: false diff --git a/source/_integrations/water_heater.mqtt.markdown b/source/_integrations/water_heater.mqtt.markdown index 75e5cb1779d..2ab3f29ac6e 100644 --- a/source/_integrations/water_heater.mqtt.markdown +++ b/source/_integrations/water_heater.mqtt.markdown @@ -100,6 +100,10 @@ device: description: 'The name of the device.' required: false type: string + serial_number: + description: "The serial number of the device." + required: false + type: string suggested_area: description: 'Suggest an area if the device isn’t in one yet.' required: false