The mqtt climate platform let you control your MQTT enabled HVAC devices.
The mqtt climate platform lets you control your MQTT enabled HVAC devices.
The platform currently works in optimistic mode, which means it does not obtain states from MQTT topics, but it sends and remembers control commands.
It uses a sensor under the hood to obtain the current temperature.
# Example configuration.yaml entry
diff --git a/components/cover.mqtt/index.html b/components/cover.mqtt/index.html
index 04c964bc83..a1fdfb1690 100644
--- a/components/cover.mqtt/index.html
+++ b/components/cover.mqtt/index.html
@@ -117,7 +117,7 @@
tilt_invert_state (Optional): Flag that determines if open/close are flipped; higher values toward closed and lower values toward open. Default is False
Examples
-In this section you find some real life examples of how to use this platform.
+In this section you will find some real life examples of how to use this platform.
Full configuration without tilt
The example below shows a full configuration for a cover without tilt.
# Example configuration.yml entry
diff --git a/components/fan.mqtt/index.html b/components/fan.mqtt/index.html
index beebbfb324..63d347aac2 100644
--- a/components/fan.mqtt/index.html
+++ b/components/fan.mqtt/index.html
@@ -74,8 +74,8 @@
- The mqtt fan platform let you control your MQTT enabled fans.
-In an ideal scenario, the MQTT device will have a state_topic to publish state changes. If these messages are published with RETAIN flag, the MQTT fan will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state of the fan will be false.
+ The mqtt fan platform lets you control your MQTT enabled fans.
+In an ideal scenario, the MQTT device will have a state_topic to publish state changes. If these messages are published with a RETAIN flag, the MQTT fan will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state of the fan will be false / off.
When a state_topic is not available, the fan will work in optimistic mode. In this mode, the fan will immediately change state after every command. Otherwise, the fan will wait for state confirmation from the device (message from state_topic).
Optimistic mode can be forced even if a state_topic is available. Try to enable it if you are experiencing incorrect fan operation.
To enable MQTT fans in your installation, add the following to your configuration.yaml file:
@@ -111,7 +111,7 @@
speeds array (Optional): Valid entries for the list are off, low, medium, and high.
-Make sure that your topic is an exact match. some-topic/ and some-topic are different topics.
+Make sure that your topics match exactly. some-topic/ and some-topic are different topics.
Examples
In this section you find some real life examples of how to use this fan.
diff --git a/components/light.mqtt/index.html b/components/light.mqtt/index.html
index d06caa20e0..8765ba3479 100644
--- a/components/light.mqtt/index.html
+++ b/components/light.mqtt/index.html
@@ -75,9 +75,9 @@
The mqtt light platform lets you control your MQTT enabled lights. It supports setting brightness, color temperature, effects, flashing, on/off, RGB colors, transitions, XY colors and white values.
-In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with RETAIN flag, the MQTT light will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state of the switch will be false/off.
-When a state topic is not available, the light will work in optimistic mode. In this mode, the light will immediately change state after every command. Otherwise, the light will wait for state confirmation from device (message from state_topic).
-Optimistic mode can be forced, even if state topic is available. Try to enable it, if experiencing incorrect light operation.
+In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with a RETAIN flag, the MQTT light will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state of the switch will be false / off.
+When a state topic is not available, the light will work in optimistic mode. In this mode, the light will immediately change state after every command. Otherwise, the light will wait for state confirmation from the device (message from state_topic).
+Optimistic mode can be forced, even if the state_topic is available. Try to enable it, if experiencing incorrect light operation.
# Example configuration.yml entry
light:
- platform: mqtt
@@ -118,7 +118,7 @@
xy_value_template (Optional): Defines a template to extract the XY value.
- Make sure that your topics match exact. some-topic/ and some-topic are different topics.
+ Make sure that your topics match exactly. some-topic/ and some-topic are different topics.
XY and RGB can not be used at the same time. If both are provided, XY overrides RGB.
@@ -185,7 +185,7 @@
Examples
-In this section you find some real life examples of how to use this sensor.
+In this section you will find some real life examples of how to use this sensor.
Brightness and RGB support
To enable a light with brightness and RGB support in your installation, add the following to your configuration.yaml file:
# Example configuration.yml entry
diff --git a/components/lock.mqtt/index.html b/components/lock.mqtt/index.html
index 26d4b6ec65..e769175579 100644
--- a/components/lock.mqtt/index.html
+++ b/components/lock.mqtt/index.html
@@ -74,8 +74,8 @@
- The mqtt lock platform let you control your MQTT enabled locks.
-In an ideal scenario, the MQTT device will have a state_topic to publish state changes. If these messages are published with RETAIN flag, the MQTT lock will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state of the lock will be false/unlocked.
+ The mqtt lock platform lets you control your MQTT enabled locks.
+In an ideal scenario, the MQTT device will have a state_topic to publish state changes. If these messages are published with a RETAIN flag, the MQTT lock will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state of the lock will be false / unlocked.
When a state_topic is not available, the lock will work in optimistic mode. In this mode, the lock will immediately change state after every command. Otherwise, the lock will wait for state confirmation from the device (message from state_topic).
Optimistic mode can be forced, even if state topic is available. Try to enable it, if experiencing incorrect lock operation.
To enable MQTT locks in your installation, add the following to your configuration.yaml file:
@@ -98,10 +98,10 @@
value_template (Optional): Defines a template to extract a value from the payload.
-Make sure that your topic match exact. some-topic/ and some-topic are different topics.
+Make sure that your topics match exactly. some-topic/ and some-topic are different topics.
Examples
-In this section you find some real life examples of how to use this lock.
+In this section you will find some real life examples of how to use this lock.
Full configuration
The example below shows a full configuration for a MQTT lock.
# Example configuration.yml entry
diff --git a/components/notify.mqtt/index.html b/components/notify.mqtt/index.html
index 90e6298c94..6533b83e81 100644
--- a/components/notify.mqtt/index.html
+++ b/components/notify.mqtt/index.html
@@ -74,7 +74,7 @@
- The MQTT notification support is different than the other notification platforms. It is a service. This means that you don’t have to create a configuration entry but you need to provide more details while calling the service.
+ The MQTT notification support is different than the other notification platforms. It is a service. This means that you don’t have to create a configuration entry but you need to provide more details when calling the service.
Call Service section from the Developer Tools allows you to send MQTT messages. Choose mqtt/publish from the list of Available services: and enter something like the sample below into the Service Data field and hit CALL SERVICE.
{"payload": "Test message from HA", "topic": "home/notification", "qos": 0, "retain": 0}
diff --git a/components/switch.mqtt/index.html b/components/switch.mqtt/index.html
index 1280233f4b..8060759678 100644
--- a/components/switch.mqtt/index.html
+++ b/components/switch.mqtt/index.html
@@ -74,10 +74,10 @@
- The mqtt switch platform let you control your MQTT enabled switch.
-In an ideal scenario, the MQTT device will have a state_topic to publish state changes. If these messages are published with RETAIN flag, the MQTT switch will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state of the switch will be false/off.
-When a state_topic is not available, the switch will work in optimistic mode. In this mode, the switch will immediately change state after every command. Otherwise, the switch will wait for state confirmation from device (message from state_topic).
-Optimistic mode can be forced, even if state topic is available. Try to enable it, if experiencing incorrect switch operation.
+ The mqtt switch platform lets you control your MQTT enabled switches.
+In an ideal scenario, the MQTT device will have a state_topic to publish state changes. If these messages are published with a RETAIN flag, the MQTT switch will receive an instant state update after subscription, and will start with the correct state. Otherwise, the initial state of the switch will be false / off.
+When a state_topic is not available, the switch will work in optimistic mode. In this mode, the switch will immediately change state after every command. Otherwise, the switch will wait for state confirmation from the device (message from state_topic).
+Optimistic mode can be forced, even if the state_topic is available. Try to enable it, if experiencing incorrect switch operation.
To enable this switch in your installation, add the following to your configuration.yaml file:
# Example configuration.yml entry
switch:
@@ -101,10 +101,10 @@
value_template (Optional): Defines a template to extract a value from the payload.
-Make sure that your topic match exact. some-topic/ and some-topic are different topics.
+Make sure that your topic matches exactly. some-topic/ and some-topic are different topics.
Examples
-In this section you find some real life examples of how to use this sensor.
+In this section you will find some real life examples of how to use this sensor.
Full configuration
The example below shows a full configuration for a switch.
# Example configuration.yml entry
diff --git a/components/vacuum.mqtt/index.html b/components/vacuum.mqtt/index.html
index dda99830c3..c730a52d16 100644
--- a/components/vacuum.mqtt/index.html
+++ b/components/vacuum.mqtt/index.html
@@ -74,7 +74,7 @@
- The mqtt component allows you to control your MQTT-enabled vacuum.
+ The mqtt vacuum component allows you to control your MQTT-enabled vacuum.
To add your MQTT vacuum to your installation, add the following to your configuration.yaml file:
# Example configuration.yaml entry
vacuum:
diff --git a/developers/maintenance/index.html b/developers/maintenance/index.html
index 2bd1792979..c6f478f3b1 100644
--- a/developers/maintenance/index.html
+++ b/developers/maintenance/index.html
@@ -91,7 +91,7 @@
$ script/gen_requirements_all.py
-Start a test run of Home Assistant if that was successful include all files in a Pull Request. Add a short summary of the changes, a sample configuration entry, details about the tests you performed to ensure the update works, and other useful information to the description.
+Start a test run of Home Assistant. If that was successful, include all files in a Pull Request. Add a short summary of the changes, a sample configuration entry, details about the tests you performed to ensure the update works, and other useful information to the description.