2024.11.0
Home ▸ Integrations ▸

IBM Watson IoT Platform

The IBM Watson IoT Platform integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] enables you to link the devices in Home Assistant with an IBM Watson IoT Platform instance.

Configuration

To use this integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more], 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 which provides the details on doing this. After you register the gateway device for your Home Assistant instance you’ll need four pieces of information:

  • Organization ID
  • Gateway device Type
  • Gateway device ID
  • Authentication Token

With this basic information you can add the integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] to your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file. After changing the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes.

# Example configuration.yaml entry:
watson_iot:
  organization: "organization_id"
  type: "device_type"
  id: "device_id"
  token: "auth_token"

Configuration Variables

Looking for your configuration file?
organization string Required

The Organization ID for your Watson IoT Platform instance.

type string Required

The device type for the gateway device to use.

id string Required

The device id for the gateway device to use.

token string Required

The authentication token for the gateway device.

exclude map (Optional)

Configure which integrations should be excluded from recording to Watson IoT Platform.

entities list (Optional)

The list of entity ids to be excluded from recording to Watson IoT Platform.

domains list (Optional)

The list of domains to be excluded from recording to Watson IoT Platform.

include map (Optional)

Configure which integrations 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 exclude option will prevail.

entities list (Optional)

The list of entity ids to be included from recordings to Watson IoT Platform.

domains list (Optional)

The list of domains to be included from recordings to Watson IoT Platform.

Examples

Full configuration 

watson_iot:

  exclude:
    entities:
       - entity.id1
       - entity.id2
    domains:
       - automation
  include:
    entities:
       - entity.id3
       - entity.id4

Related topics