Expand ecobee documentation for set_hold_mode #5980
Merged
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
frenck
previously requested changes
Aug 8, 2018
Added some notes explaining how to access your custom ecobee "Comfort Settings" when using set_hold_mode
|
Thanks for bearing with me. This is my first ever attempt to commit to a major open-source project. Learning to rebase now. Closed by accident, reopening. |
|
Well... you did a fine job @dbrowndan 👍 |
DubhAd
reviewed
Aug 11, 2018
| @@ -245,7 +245,7 @@ canceled. | |||
| | Service data attribute | Optional | Description | | |||
| | ---------------------- | -------- | ----------- | | |||
| | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. | |||
| | `hold_mode` | no | 'temp', 'home', 'away', 'sleep', etc., None | |||
| | `hold_mode` | no | `temp`, `home`, `away`, `sleep`, `None`, etc. NOTE: If you create custom hold modes (also known as "Comfort Settings") on your ecobee.com dashboard, their hold_modes are 'smart1', 'smart2', 'smart3', etc. The number for each custom mode should match the mode's icon on your ecobee.com dashboard. Also note that the mode numbers/icons in the ecobee mobile app MAY NOT MATCH the numbers/icons from the ecobee.com web dashboard. The ones on the website are the ones you shoud use to determine the correct 'smartX' hold_mode IDs. | |||
There was a problem hiding this comment.
This makes the table hard to read IMO - it'd be better having that as a follow on paragraph after the table.
|
Thanks for looking things over, @DubhAd! Changes committed. |
DubhAd
reviewed
Aug 16, 2018
| | `hold_mode` | no | 'temp', 'home', 'away', 'sleep', etc., None | ||
| | `hold_mode` | no | `temp`, `home`, `away`, `sleep`, `None`, `smart1`, `smart2`, etc. | ||
|
|
||
| NOTE: If you create custom hold modes (also known as "Comfort Settings") on your ecobee.com dashboard, their hold_modes are `smart1`, `smart2`, `smart3`, etc. The number for each custom mode should match the mode's icon on your ecobee.com dashboard. Also note that the mode numbers/icons in the ecobee mobile app MAY NOT MATCH the numbers/icons from the ecobee.com web dashboard. The ones on the website are the ones you shoud use to determine the correct 'smartX' hold_mode IDs. |
There was a problem hiding this comment.
Sorry, missed the SHOUTING - please use italics for emphasis
There was a problem hiding this comment.
Sure thing, updated. Thanks again.
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.
Add some notes explaining how to access your custom ecobee Comfort Settings when using the 'set_hold_mode' service
Source: My own experimentation
Description:
Just minor documentation tweaks.
Pull request in home-assistant (if applicable): home-assistant/home-assistant#
Checklist:
current. New documentation for platforms/components and features should go tonext.