Skip to content

MQTT Climate: Add documentation for receiving the current humidity #25413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
frenck merged 2 commits into from
Jan 9, 2023
Merged

MQTT Climate: Add documentation for receiving the current humidity #25413

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5cf7fcf
MQTT Climate: Add documentation for receiving the current humidity
Stonos Dec 27, 2022
727f693
MQTT Climate: Add documentation for new humidity settings
Stonos Jan 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions source/_integrations/climate.mqtt.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,14 @@ availability_topic:
description: The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with `availability`.
required: false
type: string
current_humidity_template:
description: A template with which the value received on `current_humidity_topic` will be rendered.
required: false
type: template
current_humidity_topic:
description: The MQTT topic on which to listen for the current humidity.
required: false
type: string
current_temperature_template:
description: A template with which the value received on `current_temperature_topic` will be rendered.
required: false
Expand Down Expand Up @@ -189,10 +197,20 @@ json_attributes_topic:
description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation.
required: false
type: string
max_humidity:
description: The minimum target humidity percentage that can be set.
required: false
type: integer
default: 99
max_temp:
description: Maximum set point available.
type: float
required: false
min_humidity:
description: The maximum target humidity percentage that can be set.
required: false
type: integer
default: 30
min_temp:
description: Minimum set point available.
type: float
Expand Down Expand Up @@ -313,6 +331,22 @@ swing_modes:
required: false
default: ['on', 'off']
type: list
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
type: template
target_humidity_command_topic:
description: The MQTT topic to publish commands to change the target humidity.
required: false
type: string
target_humidity_state_topic:
description: The MQTT topic subscribed to receive the target humidity. If this is not set, the target humidity works in optimistic mode (see below).
required: false
type: string
target_humidity_state_template:
description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to extract a value for the climate `target_humidity` state.
required: false
type: string
temperature_command_template:
description: A template to render the value sent to the `temperature_command_topic` with.
required: false
Expand Down