-
-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Add documentation for the new watson_iot component #5100
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
eaf1a89
Add documentation for the new watson_iot component
mtreinish 0c6e193
:pencil2: Missing comma
frenck 5c040df
Use configuration tags
mtreinish de8eb91
:art: Adds logo
frenck f02c564
:arrow_up: ha_release -> 0.68
frenck 0245909
:pencil2: Processed RFC's
frenck File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| --- | ||
| layout: page | ||
| title: "IBM Watson IoT Platform" | ||
| description: "Record events in the IBM Watson IoT Platform." | ||
| date: 2018-04-03 22:09 | ||
| sidebar: true | ||
| comments: false | ||
| sharing: true | ||
| footer: true | ||
| logo: ibm.png | ||
| ha_category: History | ||
| ha_release: 0.72 | ||
| --- | ||
|
|
||
| The `watson_iot` component enables you to link the devices in Home Assistant | ||
| with an [IBM Watson IoT Platform instance](https://www.ibm.com/us-en/marketplace/internet-of-things-cloud). | ||
|
|
||
| ## {% linkable_title Configuration %} | ||
|
|
||
| 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) | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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. |
||
| which provides the details on doing this. After you register the gateway device | ||
| for your home-assistant you'll need 4 pieces of information: | ||
| - Organization ID | ||
| - Gateway device Type | ||
| - Gateway device ID | ||
| - Authentication Token | ||
|
|
||
| With this basic information you can configure the component: | ||
|
|
||
| ```yaml | ||
| # Example configuration.yaml entry: | ||
| watson_iot: | ||
| organization: 'organization_id' | ||
| type: 'device_type' | ||
| id: 'device_id' | ||
| token: 'auth_token' | ||
| ``` | ||
|
|
||
| {% configuration %} | ||
| organization: | ||
| description: The Organization ID for your Watson IoT Platform instance | ||
| required: true | ||
| type: string | ||
| type: | ||
| description: The device type for the gateway device to use | ||
| required: true | ||
| type: string | ||
| id: | ||
| description: The device id for the gateway device to use | ||
| required: true | ||
| type: string | ||
| token: | ||
| description: The authentication token for the gateway device | ||
| required: true | ||
| type: string | ||
| exclude: | ||
| description: Configure which components should be excluded from recording to Watson IoT Platform. | ||
| required: false | ||
| type: map | ||
| keys: | ||
| entities: | ||
| description: The list of entity ids to be excluded from recording to Watson IoT Platform. | ||
| required: false | ||
| type: list | ||
| domains: | ||
| description: The list of domains to be excluded from recording to Watson IoT Platform. | ||
| required: false | ||
| type: list | ||
| include: | ||
| description: Configure which components should be included in recordings to Watson IoT Platform. If set, all other entities will not be recorded to Watson IoT Platform. Values set by the **blacklist** option will prevail. | ||
| required: false | ||
| type: map | ||
| keys: | ||
| entities: | ||
| description: The list of entity ids to be included from recordings to Watson IoT Platform. | ||
| required: false | ||
| type: list | ||
| domains: | ||
| description: The list of domains to be included from recordings to Watson IoT Platform. | ||
| required: false | ||
| type: list | ||
| {% endconfiguration %} | ||
|
|
||
|
|
||
| ## {% linkable_title Examples %} | ||
|
|
||
| ### {% linkable_title Full configuration %} | ||
|
|
||
| ```yaml | ||
| watson_iot: | ||
|
|
||
| exclude: | ||
| entities: | ||
| - entity.id1 | ||
| - entity.id2 | ||
| domains: | ||
| - automation | ||
| include: | ||
| entities: | ||
| - entity.id3 | ||
| - entity.id4 | ||
| ``` | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please indicate whether it is FREE or paid so that users are not wasting their time.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
They have a free tier, which is sufficient imho.