Update the MQTT fan documentation #1345
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@wingrunr21, thanks for your PR! By analyzing the history of the files in this pull request, we identified @fabaff to be a potential reviewer. |
Landrash
requested changes
Oct 28, 2016
|
|
||
| Optimistic mode can be forced, even if state topic is available. Try to enable it, if experiencing incorrect fan operation. | ||
| 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: | ||
|
|
||
| ```yaml | ||
| # Example configuration.yml entry | ||
| fan: |
There was a problem hiding this comment.
This is a great addition but the example code should always try to be minimized.
Feel free to have a fully fleshed out example also but avoid having the Optional variables in the minimized one.
There was a problem hiding this comment.
So happy to make the change but the way the original author defined the component would mean the minimal version would ONLY be the command topic. Would you be ok with some kind of happy medium?
|
With home-assistant/core#4134 was the documentation updated without taking that PR into account. Duplicated work. I will fix my mess. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a documentation update for the MQTT Fan component. When the original component was merged (via home-assistant/core#3095) incomplete/incorrect documentation was added at the same time. This brings the docs inline with the component.