Add documentation for the new watson_iot component#5100
Add documentation for the new watson_iot component#5100balloob merged 6 commits intohome-assistant:nextfrom
Conversation
This commit adds documention for the new watson_iot component which was added in home-assistant/core#13664 It links to the official documentation for setting up the cloud service and generating the required auth information.
| token: 'auth_token' | ||
| ``` | ||
|
|
||
| Configuration variables: |
There was a problem hiding this comment.
Please use the configuration tags, for more information please see:
https://home-assistant.io/developers/documentation/create_page/#configuration
There was a problem hiding this comment.
Ok, I pushed a patch to use the configuration tags
|
Thank you for this PR @mtreinish! I've reviewed it and found one abnormality. |
frenck
added
the
new-integration
This commit updates the formatting of the configuration section of the documentation. Previously it manually formatted a list instead of leveraging the templating format. This corrects that oversight and uses the standard format.
|
Thanks for updating the PR @mtreinish! 👍 Bonus: Maybe add the IBM or IBM Watson logo? |
|
|
||
| To use this component, you first need to register a gateway device type and then | ||
| a gateway device in your IoT platform instance. For instructions on how to do | ||
| this check the [official documentation](https://console.bluemix.net/docs/services/IoT/gateways/dashboard.html#IoT_connectGateway) |
There was a problem hiding this comment.
Please indicate whether it is FREE or paid so that users are not wasting their time.
There was a problem hiding this comment.
They have a free tier, which is sufficient imho.
| footer: true | ||
| logo: ibm.png | ||
| ha_category: History | ||
| ha_release: 0.68 |
There was a problem hiding this comment.
Remember to update the release.
| ha_release: 0.68 | ||
| --- | ||
|
|
||
| The `watson_iot` component enables you to link the devices in home-assistant |
There was a problem hiding this comment.
home-assistant -> Home Assistant
|
|
||
| To use this component, you first need to register a gateway device type and then | ||
| a gateway device in your IoT platform instance. For instructions on how to do | ||
| this check the [official documentation](https://console.bluemix.net/docs/services/IoT/gateways/dashboard.html#IoT_connectGateway) |
There was a problem hiding this comment.
Could I suggest adding a line about why you would use this component? "i.e. you can use this to bring IoT history data into Watson to build an application..." My thought is that people will see Watson and think they will get some out of the box analytics or machine learning.
balloob
added
the
cherry-picked
* Add documentation for the new watson_iot component This commit adds documention for the new watson_iot component which was added in home-assistant/core#13664 It links to the official documentation for setting up the cloud service and generating the required auth information. * ✏️ Missing comma * Use configuration tags This commit updates the formatting of the configuration section of the documentation. Previously it manually formatted a list instead of leveraging the templating format. This corrects that oversight and uses the standard format. * 🎨 Adds logo * ⬆️ ha_release -> 0.68 * ✏️ Processed RFC's
5 participants
Description:
This commit adds documention for the new watson_iot component which was
added in home-assistant/core#13664
It links to the official documentation for setting up the cloud service
and generating the required auth information.
Pull request in home-assistant (if applicable): home-assistant/core#13664
Checklist:
current. New documentation for platforms/components and features should go tonext.