Add info about new yeelight start_flow service by zewelor · Pull Request #8166 · home-assistant/home-assistant.io

zewelor · 2019-01-14T16:56:10Z

Description:

Pull request in home-assistant (if applicable): home-assistant/core#20107

Checklist:

Branch: next is for changes and new documentation that will go public with the next home-assistant release. Fixes, changes and adjustments for the current release should be created against current.
The documentation follows the standards.

rytilahti · 2019-01-17T12:26:25Z

+Possible transitions are `RGBTransition`, `HSVTransition`, `TemperatureTransition`, `SleepTransition`
+
+
+More info about values, transitions: https://gitlab.com/stavros/python-yeelight/blob/master/yeelight/flow.py


I think it would be nicer to link to the documentation here: https://yeelight.readthedocs.io/en/stable/flow.html . Also, considering there are not so many options, maybe simply writing them out here?

I think that would require to copy this whole section: https://yeelight.readthedocs.io/en/stable/yeelight.html#flow-objects

Fair enough! I think linking the documentation instead of the source code is enough (the examples will make it clear how to use them) 👍

rytilahti · 2019-01-17T12:28:09Z

          required: false
          type: string
+custom_effects:
+  description: "List of custom effects to add. Check examples below"


No need for quotes.

rytilahti · 2019-01-17T12:29:36Z

+
+| Service data attribute    | Optional | Description                                                                                 |
+|---------------------------|----------|---------------------------------------------------------------------------------------------|
+| `entity_id`               |      yes | Only act on a specific yeelight. Else targets all.                                          |


I think this should be mandatory, see home-assistant/core#19006

zewelor · 2019-01-17T15:38:03Z

Thanks for Review. Updated with comments addressed.

zewelor · 2019-01-24T14:36:08Z

@rytilahti Do I need to change anything more here ?

rytilahti

I added a couple of things which need to be changed, then it's all good, thanks again for the effort :-)

rytilahti · 2019-01-24T14:38:30Z

+
+This example shows how you can add your custom effects in your configuration.
+
+Possible transitions are `RGBTransition`, `HSVTransition`, `TemperatureTransition`, `SleepTransition`


Add dot at the end.

rytilahti · 2019-01-24T14:40:12Z

          required: false
          type: string
+custom_effects:
+  description: List of custom effects to add. Check examples below


Add dots at the end of each description, then it'd be consistent with other docs.

rytilahti · 2019-01-24T14:40:35Z

 | Service data attribute    | Optional | Description                                                                                 |
 |---------------------------|----------|---------------------------------------------------------------------------------------------|
-| `entity_id`               |      yes | Only act on a specific yeelight. Else targets all.                                          |
+| `entity_id`               |       no | Only act on a specific yeelights.                                                            |


'specific lights.'

rytilahti · 2019-01-24T14:40:44Z

+
+| Service data attribute    | Optional | Description                                                                                 |
+|---------------------------|----------|---------------------------------------------------------------------------------------------|
+| `entity_id`               |       no | Only act on a specific yeelights.                                                            |


'specific lights.'

rytilahti · 2019-01-24T14:41:21Z

+|---------------------------|----------|---------------------------------------------------------------------------------------------|
+| `entity_id`               |       no | Only act on a specific yeelights.                                                            |
+| `count`                   |      yes | The number of times to run this flow (0 to run forever).                                    |
+| `transitions`             |       no | Array of transitions, for desired effect. For more info check [example](#custom-effects)    |


remove ', for desired effect', I think it's superfluous.

Also, 'See [examples below] ..'

rytilahti · 2019-01-24T14:42:17Z

+Possible transitions are `RGBTransition`, `HSVTransition`, `TemperatureTransition`, `SleepTransition`
+
+
+More info about values, transitions in [library docs](https://yeelight.readthedocs.io/en/stable/flow.html)


More info about transitions and their expected parameters can be found in [python-yeelight documentation].

zewelor · 2019-01-24T16:39:12Z

Thanks, fixed everything from comments.

rytilahti

Thanks, let's merge this! 🥇

ghost added the to-do label Jan 14, 2019

zewelor mentioned this pull request Jan 14, 2019

Add start_flow service to yeelight with an ability to declare custom effects home-assistant/core#20107

Merged

4 tasks

frenck added new-feature This PR adds documentation for a new Home Assistant feature to an existing integration ready-for-review This PR needs to be reviewed next This PR goes into the next branch has-parent This PR has a parent PR in another repo and removed to-do labels Jan 14, 2019

rytilahti reviewed Jan 17, 2019

View reviewed changes

rytilahti changed the title ~~Add info about new yeelight star flow service~~ Add info about new yeelight start_flow service Jan 19, 2019

rytilahti reviewed Jan 24, 2019

View reviewed changes

Add info about new yeelight star flow service

16d6a5e

rytilahti approved these changes Jan 24, 2019

View reviewed changes

rytilahti merged commit dedd3ca into home-assistant:next Jan 24, 2019

ghost removed the ready-for-review This PR needs to be reviewed label Jan 24, 2019

zewelor deleted the add_info_about_new_start_flow_service_and_config_options_to_yeelight branch February 1, 2019 08:05

zewelor mentioned this pull request Feb 1, 2019

Yeelight custom_effects has no default value home-assistant/core#20628

Closed

		Possible transitions are `RGBTransition`, `HSVTransition`, `TemperatureTransition`, `SleepTransition`


		More info about values, transitions: https://gitlab.com/stavros/python-yeelight/blob/master/yeelight/flow.py


		This example shows how you can add your custom effects in your configuration.

		Possible transitions are `RGBTransition`, `HSVTransition`, `TemperatureTransition`, `SleepTransition`

		Possible transitions are `RGBTransition`, `HSVTransition`, `TemperatureTransition`, `SleepTransition`


		More info about values, transitions in [library docs](https://yeelight.readthedocs.io/en/stable/flow.html)

Uh oh!

Conversation

zewelor commented Jan 14, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zewelor commented Jan 17, 2019

Uh oh!

zewelor commented Jan 24, 2019

Uh oh!

rytilahti left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rytilahti Jan 24, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zewelor commented Jan 24, 2019

Uh oh!

rytilahti left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

zewelor commented Jan 14, 2019 •

edited

Loading

rytilahti Jan 24, 2019 •

edited

Loading