jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-22 16:56:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove None as default option in MQTT documentation (#30900)

Browse Source
This commit is contained in:
Jan Bouwhuis 2024-01-18 08:36:48 +01:00 committed by GitHub
parent 94b84c4e2f
commit ab1eb994a9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
24 changed files with 5 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
source/_integrations/alarm_control_panel.mqtt.markdown
View File

@ -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

2
source/_integrations/binary_sensor.mqtt.markdown
View File

@ -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

3
source/_integrations/button.mqtt.markdown
View File

@ -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

2
source/_integrations/camera.mqtt.markdown
View File

@ -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

1
source/_integrations/climate.mqtt.markdown
View File

@ -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

2
source/_integrations/cover.mqtt.markdown
View File

@ -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

2
source/_integrations/device_tracker.mqtt.markdown
View File

@ -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

4
source/_integrations/event.mqtt.markdown
View File

@ -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:

5
source/_integrations/fan.mqtt.markdown
View File

@ -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

5
source/_integrations/humidifier.mqtt.markdown
View File

@ -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

2
source/_integrations/image.mqtt.markdown
View File

@ -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

1
source/_integrations/lawn_mower.mqtt.markdown
View File

@ -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

3
source/_integrations/light.mqtt.markdown
View File

@ -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

1
source/_integrations/lock.mqtt.markdown
View File

@ -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

4
source/_integrations/number.mqtt.markdown
View File

@ -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:

1
source/_integrations/scene.mqtt.markdown
View File

@ -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

1
source/_integrations/select.mqtt.markdown
View File

@ -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

6
source/_integrations/sensor.mqtt.markdown
View File

@ -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:

1
source/_integrations/siren.mqtt.markdown
View File

@ -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

2
source/_integrations/switch.mqtt.markdown
View File

@ -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

1
source/_integrations/text.mqtt.markdown
View File

@ -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

3
source/_integrations/update.mqtt.markdown
View File

@ -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

2
source/_integrations/valve.mqtt.markdown
View File

@ -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

1
source/_integrations/water_heater.mqtt.markdown
View File

@ -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