Documentation of the Xiaomi Philips Light component#3246
Conversation
|
+New-component/platform |
|
Please add Did you base your page on another page? (and thus we have another page missing a ha_version tag) |
|
I just removed the ha_version because I was unsure. The page is based on vacuum.xiaomi.markdown. |
|
|
||
| Current supported features are `on`, `off`, `set_cct` (colortemp) , `set_bright` (brightness). | ||
|
|
||
| ## {% linkable_title Getting started %} |
There was a problem hiding this comment.
I moved the instructions from the vacuum platform to the component. So a link to https://home-assistant.io/components/xiaomi/#retrieving-the-access-token would be sufficient.
There was a problem hiding this comment.
The new location of the token instructions isn't appropriate. The page "https://home-assistant.io/components/xiaomi/" belongs to the xiaomi gateway. A device with another protocol and another security mechanism (key != token). We mixed up two independent platforms now.
There was a problem hiding this comment.
Same app, same name... Sure, we can improve the location but I don't see an issue here as the intro make it clear that it's for platforms.
Maintaining three times the same instructions which will be outdated probably soon and are extensive doesn't make sense and will lead to frustrated users. We saw that with the Raspberry platforms in the past.
| name: Xiaomi Philips Smart LED Ceiling Lamp | ||
| host: 192.168.130.68 | ||
| token: your-ceiling-lamp-token-here | ||
| ``` |
There was a problem hiding this comment.
We try to keep all configuration samples minimal. Thus, no optional requirement in the default sample. This helps user to get started quickly by copy-&-paste the sample without worrying about optional parameters which they most likely not need. If required, insert a full configuration sample later that covers special setups or alike.
fabaff
added
the
new-integration
|
Can you move section "Retrieving the Access Token" to a better place or make a suggestion? |
|
The new place is okay for me. I will suggest a change again if the community users will mix up the xiaomi zigbee gateway (keys) and wifi (tokens) too often which is mentioned on the same page now. |
* Documentation for Xiaomi Philips Light component added. * HA version added. * Syntax error fixed. * Section "Retrieving the Access Token" has a central place now. * Spelling & grammar fixed.
3 participants
Description:
Documentation of the Xiaomi Philips Light component.
Pull request in home-assistant: home-assistant/core#9087