|
| 1 | +--- |
| 2 | +layout: page |
| 3 | +title: "IBM Watson IoT Platform" |
| 4 | +description: "Record events in the IBM Watson IoT Platform." |
| 5 | +date: 2018-04-03 22:09 |
| 6 | +sidebar: true |
| 7 | +comments: false |
| 8 | +sharing: true |
| 9 | +footer: true |
| 10 | +logo: ibm.png |
| 11 | +ha_category: History |
| 12 | +ha_release: 0.72 |
| 13 | +--- |
| 14 | + |
| 15 | +The `watson_iot` component enables you to link the devices in Home Assistant |
| 16 | +with an [IBM Watson IoT Platform instance](https://www.ibm.com/us-en/marketplace/internet-of-things-cloud). |
| 17 | + |
| 18 | +## {% linkable_title Configuration %} |
| 19 | + |
| 20 | +To use this component, you first need to register a gateway device type and then |
| 21 | +a gateway device in your IoT platform instance. For instructions on how to do |
| 22 | +this check the [official documentation](https://console.bluemix.net/docs/services/IoT/gateways/dashboard.html#IoT_connectGateway) |
| 23 | +which provides the details on doing this. After you register the gateway device |
| 24 | +for your home-assistant you'll need 4 pieces of information: |
| 25 | + - Organization ID |
| 26 | + - Gateway device Type |
| 27 | + - Gateway device ID |
| 28 | + - Authentication Token |
| 29 | + |
| 30 | +With this basic information you can configure the component: |
| 31 | + |
| 32 | +```yaml |
| 33 | +# Example configuration.yaml entry: |
| 34 | +watson_iot: |
| 35 | + organization: 'organization_id' |
| 36 | + type: 'device_type' |
| 37 | + id: 'device_id' |
| 38 | + token: 'auth_token' |
| 39 | +``` |
| 40 | +
|
| 41 | +{% configuration %} |
| 42 | +organization: |
| 43 | + description: The Organization ID for your Watson IoT Platform instance |
| 44 | + required: true |
| 45 | + type: string |
| 46 | +type: |
| 47 | + description: The device type for the gateway device to use |
| 48 | + required: true |
| 49 | + type: string |
| 50 | +id: |
| 51 | + description: The device id for the gateway device to use |
| 52 | + required: true |
| 53 | + type: string |
| 54 | +token: |
| 55 | + description: The authentication token for the gateway device |
| 56 | + required: true |
| 57 | + type: string |
| 58 | +exclude: |
| 59 | + description: Configure which components should be excluded from recording to Watson IoT Platform. |
| 60 | + required: false |
| 61 | + type: map |
| 62 | + keys: |
| 63 | + entities: |
| 64 | + description: The list of entity ids to be excluded from recording to Watson IoT Platform. |
| 65 | + required: false |
| 66 | + type: list |
| 67 | + domains: |
| 68 | + description: The list of domains to be excluded from recording to Watson IoT Platform. |
| 69 | + required: false |
| 70 | + type: list |
| 71 | +include: |
| 72 | + 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. |
| 73 | + required: false |
| 74 | + type: map |
| 75 | + keys: |
| 76 | + entities: |
| 77 | + description: The list of entity ids to be included from recordings to Watson IoT Platform. |
| 78 | + required: false |
| 79 | + type: list |
| 80 | + domains: |
| 81 | + description: The list of domains to be included from recordings to Watson IoT Platform. |
| 82 | + required: false |
| 83 | + type: list |
| 84 | +{% endconfiguration %} |
| 85 | +
|
| 86 | +
|
| 87 | +## {% linkable_title Examples %} |
| 88 | +
|
| 89 | +### {% linkable_title Full configuration %} |
| 90 | +
|
| 91 | +```yaml |
| 92 | +watson_iot: |
| 93 | + |
| 94 | + exclude: |
| 95 | + entities: |
| 96 | + - entity.id1 |
| 97 | + - entity.id2 |
| 98 | + domains: |
| 99 | + - automation |
| 100 | + include: |
| 101 | + entities: |
| 102 | + - entity.id3 |
| 103 | + - entity.id4 |
| 104 | +``` |
0 commit comments