From ab1eb994a926d5688f330b82406479a9942cb202 Mon Sep 17 00:00:00 2001 From: Jan Bouwhuis Date: Thu, 18 Jan 2024 08:36:48 +0100 Subject: [PATCH] Remove None as default option in MQTT documentation (#30900) --- source/_integrations/alarm_control_panel.mqtt.markdown | 1 - source/_integrations/binary_sensor.mqtt.markdown | 2 -- source/_integrations/button.mqtt.markdown | 3 --- source/_integrations/camera.mqtt.markdown | 2 -- source/_integrations/climate.mqtt.markdown | 1 - source/_integrations/cover.mqtt.markdown | 2 -- source/_integrations/device_tracker.mqtt.markdown | 2 +- source/_integrations/event.mqtt.markdown | 4 ---- source/_integrations/fan.mqtt.markdown | 5 ++--- source/_integrations/humidifier.mqtt.markdown | 5 ++--- source/_integrations/image.mqtt.markdown | 2 -- source/_integrations/lawn_mower.mqtt.markdown | 1 - source/_integrations/light.mqtt.markdown | 3 --- source/_integrations/lock.mqtt.markdown | 1 - source/_integrations/number.mqtt.markdown | 4 ---- source/_integrations/scene.mqtt.markdown | 1 - source/_integrations/select.mqtt.markdown | 1 - source/_integrations/sensor.mqtt.markdown | 6 ------ source/_integrations/siren.mqtt.markdown | 1 - source/_integrations/switch.mqtt.markdown | 2 -- source/_integrations/text.mqtt.markdown | 1 - source/_integrations/update.mqtt.markdown | 3 --- source/_integrations/valve.mqtt.markdown | 2 -- source/_integrations/water_heater.mqtt.markdown | 1 - 24 files changed, 5 insertions(+), 51 deletions(-) diff --git a/source/_integrations/alarm_control_panel.mqtt.markdown b/source/_integrations/alarm_control_panel.mqtt.markdown index cffe3bfacaf..144e369d836 100644 --- a/source/_integrations/alarm_control_panel.mqtt.markdown +++ b/source/_integrations/alarm_control_panel.mqtt.markdown @@ -161,7 +161,6 @@ entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false type: string - default: None icon: description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity." required: false diff --git a/source/_integrations/binary_sensor.mqtt.markdown b/source/_integrations/binary_sensor.mqtt.markdown index 6d2cde1fdda..933dbca94a0 100644 --- a/source/_integrations/binary_sensor.mqtt.markdown +++ b/source/_integrations/binary_sensor.mqtt.markdown @@ -114,7 +114,6 @@ device: type: string device_class: description: Sets the [class of the device](/integrations/binary_sensor/#device-class), changing the device state and icon that is displayed on the frontend. The `device_class` can be `null`. - default: None required: false type: string enabled_by_default: @@ -131,7 +130,6 @@ entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity/#generic-properties) of the entity. When set, the entity category must be `diagnostic` for sensors. required: false type: string - default: None expire_after: description: If set, it defines the number of seconds after the sensor's state expires, if it's not updated. After expiry, the sensor's state becomes `unavailable`. Default the sensors state never expires. required: false diff --git a/source/_integrations/button.mqtt.markdown b/source/_integrations/button.mqtt.markdown index b27e5a3d42e..d46e615d146 100644 --- a/source/_integrations/button.mqtt.markdown +++ b/source/_integrations/button.mqtt.markdown @@ -112,9 +112,7 @@ device: device_class: description: The [type/class](/integrations/button/#device-class) of the button to set the icon in the frontend. The `device_class` can be `null`. required: false - default: None type: device_class - default: None enabled_by_default: description: Flag which defines if the entity should be enabled when first added. required: false @@ -129,7 +127,6 @@ entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false type: string - default: None icon: description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity." required: false diff --git a/source/_integrations/camera.mqtt.markdown b/source/_integrations/camera.mqtt.markdown index d958bd78791..8f33f9413b0 100644 --- a/source/_integrations/camera.mqtt.markdown +++ b/source/_integrations/camera.mqtt.markdown @@ -125,7 +125,6 @@ entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false type: string - default: None icon: description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity." required: false @@ -134,7 +133,6 @@ image_encoding: description: The encoding of the image payloads received. Set to `"b64"` to enable base64 decoding of image payload. If not set, the image payload must be raw binary data. required: false type: string - default: None json_attributes_template: description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the JSON dictionary from messages received on the `json_attributes_topic`." required: false diff --git a/source/_integrations/climate.mqtt.markdown b/source/_integrations/climate.mqtt.markdown index 9bd168069ed..acd3466b33b 100644 --- a/source/_integrations/climate.mqtt.markdown +++ b/source/_integrations/climate.mqtt.markdown @@ -144,7 +144,6 @@ entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false type: string - default: None fan_mode_command_template: description: A template to render the value sent to the `fan_mode_command_topic` with. required: false diff --git a/source/_integrations/cover.mqtt.markdown b/source/_integrations/cover.mqtt.markdown index 5a919d36ea2..f6947e48694 100644 --- a/source/_integrations/cover.mqtt.markdown +++ b/source/_integrations/cover.mqtt.markdown @@ -124,7 +124,6 @@ device: type: string device_class: description: Sets the [class of the device](/integrations/cover/), changing the device state and icon that is displayed on the frontend. The `device_class` can be `null`. - default: None required: false type: string enabled_by_default: @@ -141,7 +140,6 @@ entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false type: string - default: None icon: description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity." required: false diff --git a/source/_integrations/device_tracker.mqtt.markdown b/source/_integrations/device_tracker.mqtt.markdown index ebb659809aa..ee7ad9ef7e2 100644 --- a/source/_integrations/device_tracker.mqtt.markdown +++ b/source/_integrations/device_tracker.mqtt.markdown @@ -159,7 +159,7 @@ payload_reset: description: The payload value that will have the device's location automatically derived from Home Assistant's zones. required: false type: string - default: "None" + default: '"None"' qos: description: The maximum QoS level to be used when receiving and publishing messages. required: false diff --git a/source/_integrations/event.mqtt.markdown b/source/_integrations/event.mqtt.markdown index 7bf28a846b3..1018596cf85 100644 --- a/source/_integrations/event.mqtt.markdown +++ b/source/_integrations/event.mqtt.markdown @@ -106,9 +106,7 @@ device: device_class: description: The [type/class](/integrations/event/#device-class) of the event to set the icon in the frontend. The `device_class` can be `null`. required: false - default: None type: device_class - default: None enabled_by_default: description: Flag which defines if the entity should be enabled when first added. required: false @@ -123,7 +121,6 @@ entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false type: string - default: None event_types: description: A list of valid `event_type` strings. required: true @@ -166,7 +163,6 @@ qos: default: 0 state_topic: description: The MQTT topic subscribed to receive JSON event payloads. The JSON payload should contain the `event_type` element. The event type should be one of the configured `event_types`. Note that replayed retained messages will be discarded. - default: None required: true type: string unique_id: diff --git a/source/_integrations/fan.mqtt.markdown b/source/_integrations/fan.mqtt.markdown index fed05d176b9..840e7e3cc27 100644 --- a/source/_integrations/fan.mqtt.markdown +++ b/source/_integrations/fan.mqtt.markdown @@ -131,7 +131,6 @@ entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false type: string - default: None icon: description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity." required: false @@ -224,12 +223,12 @@ payload_reset_percentage: description: A special payload that resets the `percentage` state attribute to `unknown` when received at the `percentage_state_topic`. required: false type: string - default: 'None' + default: '"None"' payload_reset_preset_mode: description: A special payload that resets the `preset_mode` state attribute to `unknown` when received at the `preset_mode_state_topic`. required: false type: string - default: 'None' + default: '"None"' percentage_command_template: description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate the payload to send to `percentage_command_topic`. required: false diff --git a/source/_integrations/humidifier.mqtt.markdown b/source/_integrations/humidifier.mqtt.markdown index e7b71d0b40e..cc1893c7ff2 100644 --- a/source/_integrations/humidifier.mqtt.markdown +++ b/source/_integrations/humidifier.mqtt.markdown @@ -155,7 +155,6 @@ entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false type: string - default: None icon: description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity." required: false @@ -216,12 +215,12 @@ payload_reset_humidity: description: A special payload that resets the `target_humidity` state attribute to an `unknown` state when received at the `target_humidity_state_topic`. When received at `current_humidity_topic` it will reset the current humidity state. required: false type: string - default: 'None' + default: '"None"' payload_reset_mode: description: A special payload that resets the `mode` state attribute to an `unknown` state when received at the `mode_state_topic`. required: false type: string - default: 'None' + default: '"None"' target_humidity_command_template: description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate the payload to send to `target_humidity_command_topic`. required: false diff --git a/source/_integrations/image.mqtt.markdown b/source/_integrations/image.mqtt.markdown index 4f9af9fafc8..cd0897c9f36 100644 --- a/source/_integrations/image.mqtt.markdown +++ b/source/_integrations/image.mqtt.markdown @@ -128,7 +128,6 @@ entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false type: string - default: None icon: description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity." required: false @@ -137,7 +136,6 @@ image_encoding: description: The encoding of the image payloads received. Set to `"b64"` to enable base64 decoding of image payload. If not set, the image payload must be raw binary data. required: false type: string - default: None image_topic: description: The MQTT topic to subscribe to receive the image payload of the image to be downloaded. Ensure the `content_type` type option is set to the corresponding content type. This option cannot be used together with the `url_topic` option. But at least one of these option is required. required: exclusive diff --git a/source/_integrations/lawn_mower.mqtt.markdown b/source/_integrations/lawn_mower.mqtt.markdown index f027c913d2a..7a5107d4519 100644 --- a/source/_integrations/lawn_mower.mqtt.markdown +++ b/source/_integrations/lawn_mower.mqtt.markdown @@ -134,7 +134,6 @@ entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false type: string - default: None icon: description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity." required: false diff --git a/source/_integrations/light.mqtt.markdown b/source/_integrations/light.mqtt.markdown index 1b68606524d..544b7bf347d 100644 --- a/source/_integrations/light.mqtt.markdown +++ b/source/_integrations/light.mqtt.markdown @@ -194,7 +194,6 @@ entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false type: string - default: None effect_command_topic: description: "The MQTT topic to publish commands to change the light's effect state." required: false @@ -625,7 +624,6 @@ entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false type: string - default: None effect: description: Flag that defines if the light supports effects. required: false @@ -994,7 +992,6 @@ entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false type: string - default: None effect_list: description: List of possible effects. required: false diff --git a/source/_integrations/lock.mqtt.markdown b/source/_integrations/lock.mqtt.markdown index 03a9482798d..5a072617faf 100644 --- a/source/_integrations/lock.mqtt.markdown +++ b/source/_integrations/lock.mqtt.markdown @@ -138,7 +138,6 @@ entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false type: string - default: None icon: description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity." required: false diff --git a/source/_integrations/number.mqtt.markdown b/source/_integrations/number.mqtt.markdown index d49876b4daa..30dcac34763 100644 --- a/source/_integrations/number.mqtt.markdown +++ b/source/_integrations/number.mqtt.markdown @@ -105,10 +105,8 @@ device: type: string device_class: description: The [type/class](/integrations/number/#device-class) of the number. The `device_class` can be `null`. - default: None required: false type: device_class - default: None enabled_by_default: description: Flag which defines if the entity should be enabled when first added. required: false @@ -123,7 +121,6 @@ entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false type: string - default: None icon: description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity." required: false @@ -194,7 +191,6 @@ unique_id: type: string unit_of_measurement: description: Defines the unit of measurement of the sensor, if any. The `unit_of_measurement` can be `null`. - Default: None required: false type: string value_template: diff --git a/source/_integrations/scene.mqtt.markdown b/source/_integrations/scene.mqtt.markdown index bfbe7511bac..5923428de1c 100644 --- a/source/_integrations/scene.mqtt.markdown +++ b/source/_integrations/scene.mqtt.markdown @@ -116,7 +116,6 @@ entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false type: string - default: None encoding: description: The encoding of the published messages. required: false diff --git a/source/_integrations/select.mqtt.markdown b/source/_integrations/select.mqtt.markdown index 348fc90b29f..91706c5f0e4 100644 --- a/source/_integrations/select.mqtt.markdown +++ b/source/_integrations/select.mqtt.markdown @@ -129,7 +129,6 @@ entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false type: string - default: None icon: description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity." required: false diff --git a/source/_integrations/sensor.mqtt.markdown b/source/_integrations/sensor.mqtt.markdown index e6d6d9511f2..a7060a113c8 100644 --- a/source/_integrations/sensor.mqtt.markdown +++ b/source/_integrations/sensor.mqtt.markdown @@ -106,10 +106,8 @@ device: type: string device_class: description: The [type/class](/integrations/sensor/#device-class) of the sensor to set the icon in the frontend. The `device_class` can be `null`. - default: None required: false type: device_class - default: None enabled_by_default: description: Flag which defines if the entity should be enabled when first added. required: false @@ -124,7 +122,6 @@ entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. When set, the entity category must be `diagnostic` for sensors. required: false type: string - default: None expire_after: description: If set, it defines the number of seconds after the sensor's state expires, if it's not updated. After expiry, the sensor's state becomes `unavailable`. Default the sensors state never expires. required: false @@ -183,10 +180,8 @@ state_class: description: The [state_class](https://developers.home-assistant.io/docs/core/entity/sensor#available-state-classes) of the sensor. required: false type: string - default: None state_topic: description: The MQTT topic subscribed to receive sensor values. If `device_class`, `state_class`, `unit_of_measurement` or `suggested_display_precision` is set, and a numeric value is expected, an empty value `''` will be ignored and will not update the state, a `'null'` value will set the sensor to an `unknown` state. The `device_class` can be `null`. - default: None required: true type: string unique_id: @@ -195,7 +190,6 @@ unique_id: type: string unit_of_measurement: description: Defines the units of measurement of the sensor, if any. The `unit_of_measurement` can be `null`. - default: None required: false type: string value_template: diff --git a/source/_integrations/siren.mqtt.markdown b/source/_integrations/siren.mqtt.markdown index dc77a556057..e4b960af696 100644 --- a/source/_integrations/siren.mqtt.markdown +++ b/source/_integrations/siren.mqtt.markdown @@ -140,7 +140,6 @@ entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false type: string - default: None icon: description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity." required: false diff --git a/source/_integrations/switch.mqtt.markdown b/source/_integrations/switch.mqtt.markdown index 66a11eace31..c449fdd3bdc 100644 --- a/source/_integrations/switch.mqtt.markdown +++ b/source/_integrations/switch.mqtt.markdown @@ -117,7 +117,6 @@ device_class: description: The [type/class](/integrations/switch/#device-class) of the switch to set the icon in the frontend. The `device_class` can be `null`. required: false type: device_class - default: None enabled_by_default: description: Flag which defines if the entity should be enabled when first added. required: false @@ -132,7 +131,6 @@ entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false type: string - default: None icon: description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity." required: false diff --git a/source/_integrations/text.mqtt.markdown b/source/_integrations/text.mqtt.markdown index fc32722f0ea..761c382f146 100644 --- a/source/_integrations/text.mqtt.markdown +++ b/source/_integrations/text.mqtt.markdown @@ -125,7 +125,6 @@ entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false type: string - default: None json_attributes_template: description: "Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract the JSON dictionary from messages received on the `json_attributes_topic`." required: false diff --git a/source/_integrations/update.mqtt.markdown b/source/_integrations/update.mqtt.markdown index 3e9f96ea834..2b5d62ee391 100644 --- a/source/_integrations/update.mqtt.markdown +++ b/source/_integrations/update.mqtt.markdown @@ -110,10 +110,8 @@ device: type: string device_class: description: The [type/class](/integrations/update/#device-classes) of the update to set the icon in the frontend. The `device_class` can be `null`. - default: None required: false type: device_class - default: None enabled_by_default: description: Flag which defines if the entity should be enabled when first added. required: false @@ -128,7 +126,6 @@ entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false type: string - default: None entity_picture: description: "Picture URL for the entity." required: false diff --git a/source/_integrations/valve.mqtt.markdown b/source/_integrations/valve.mqtt.markdown index 46caf2e55f5..8e9315a465d 100644 --- a/source/_integrations/valve.mqtt.markdown +++ b/source/_integrations/valve.mqtt.markdown @@ -148,7 +148,6 @@ device: type: string device_class: description: Sets the [class of the device](/integrations/valve/), changing the device state and icon that is displayed on the frontend. The `device_class` can be `null`. - default: None required: false type: string enabled_by_default: @@ -165,7 +164,6 @@ entity_category: description: "The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity." required: false type: string - default: None icon: description: "[Icon](/docs/configuration/customizing-devices/#icon) for the entity." required: false diff --git a/source/_integrations/water_heater.mqtt.markdown b/source/_integrations/water_heater.mqtt.markdown index 75e5cb1779d..f62d61a9d33 100644 --- a/source/_integrations/water_heater.mqtt.markdown +++ b/source/_integrations/water_heater.mqtt.markdown @@ -126,7 +126,6 @@ entity_category: description: The [category](https://developers.home-assistant.io/docs/core/entity#generic-properties) of the entity. required: false type: string - default: None initial: description: Set the initial target temperature. The default value depends on the temperature unit, and will be 43.3°C or 110°F. required: false