SmartThings

SmartThings is integrated into Home Assistant through the SmartThings Cloud API. The features of this integration include:

1. Controlling SmartThings devices as Home Assistant entities (see platforms for supported devices and capabilities).
2. Entities automatically synchronized upon restart of Home Assistant when changed in SmartThings.
3. Support for multiple SmartThings accounts and locations with each represented as an integration instance in Home Assistant.
4. No brokers, bridges, or additional dependencies.

Prerequisites

1. A SmartThings personal access token.
2. An internet accessible incoming webhook or active Home Assistant Cloud subscription.

Personal Access Token (PAT)

The PAT is used to create a Home Assistant SmartApp in your SmartThings account during setup of the integration.

1. Log into the personal access tokens page and select Generate new token.
2. Enter a token name (can be whatever you want), for example, ‘Home Assistant’ and select the following authorized scopes:
   • Devices (all)
   • Installed Applications (all)
   • Apps (all)
   • Locations (all)
   • Scenes (all)
   • Schedules (all)
3. Select Generate token. When the token is displayed copy and save it somewhere safe (such as your keystore) as you will not be able to retrieve it again.

Webhook

This integration requires an internet accessible incoming webhook to receive push updates from SmartThings. The preferred approach is to subscribe to Home Assistant Cloud (Nabu Casa) and the integration will configure and use a cloudhook automatically. Alternatively, you will have to configure and setup an internet accessible webhook in Home Assistant as described below:

1. Setup remote access via a domain name secured with SSL. Self-signed SSL certificates are not supported by the SmartThings Cloud API.
2. Set the external URL in the Home Assistant configuration to the URL that Home Assistant is available on the internet (this must start with https://). If you do not use Nabu Casa you must configure your network to allow TCP traffic from the internet to reach the IP address and port of the device running Home Assistant.

Setup instructions

After completing the prerequisite steps above, you are ready to setup the integration! See troubleshooting if you are having issues setting up the integration.

Configuration

To add the SmartThings integration to your Home Assistant instance, use this My button:

SmartThings can be auto-discovered by Home Assistant. If an instance was found, it will be shown as Discovered. You can then set it up right away.

1. Confirm the callback URL is correct. If using Home Assistant Cloud, it will start with https://hooks.nabu.casa. If the URL is not correct, update your Home Assistant configuration, restart, and try again.
2. Enter your Personal Access Token.
3. Select the SmartThings Location to add to Home Assistant.
4. On the window that opens:
   1. Login with your SmartThings account (if not already logged in).
   2. Optionally change the display name and select Done at the bottom of the screen.
   3. Authorize the integration by selecting Allow on the bottom right of the screen.
   4. Select Close Window or close it manually.
5. Back in Home Assistant select Finish.

Removal instructions

To remove the integration from Home Assistant, select the instance from the Home Assistant Integrations page and select the trash icon on the upper right corner. Alternatively, you can remove the SmartApp from the location within the SmartThings application. If the Home Assistant instance that setup the integration is no longer running or functioning, you will need to use this utility to remove the orphaned SmartApps in your SmartThings account.

Events

The SmartThings integration triggers events for select device capabilities.

smartthings.button

The integration will trigger an event when a device with the button capability is actuated and can be used to trigger automations within Home Assistant. Below is an example of the data payload:

{
  "component_id": "main",
  "device_id": "42a16cf2-fef7-4ee8-b4a6-d32cb65474b7",
  "location_id": "2a54b9fa-f66c-42d9-8488-d8f036b980c8",
  "value": "pushed",
  "name": "Scene Button"
}

Event data payloads are logged at the debug level, see debugging for more information.

Platforms

SmartThings represents devices as a set of capabilities and the SmartThings integration maps those to entity platforms in Home Assistant. A single device may be represented by one or more platforms.

• Binary sensor
• Climate
• Cover
• Fan
• Light
• Lock
• Sensor
• Scene
• Switch

Support for additional platforms will be added in the future.

Binary sensor

The SmartThings binary sensor platform lets you view devices that have binary sensor-related capabilities. A binary sensor entity will be created for each attribute (below) supported by the device.

Climate

The SmartThings Climate platform lets you control devices that have air conditioner or thermostat related capabilities.

Air Conditioners

For a SmartThings Air Conditioner to be represented by the climate platform, it must have all of the following required capabilities:

Thermostats

For a SmartThings thermostat to be represented by the climate platform, it must have all the capabilities from either “set a” or “set b”:

Cover

The SmartThings Cover platform lets you control devices that have open/close related capabilities. For a device to be represented by the cover platform, it must have one of the capabilities from “set a” below.

Fan

The SmartThings Fan platform lets you control devices that have fan-related capabilities. For a SmartThings device to be represented by the fan platform, it must have one or more of the capabilities below in addition to the switch capability.

Light

The SmartThings Light platform lets you control devices that have light-related capabilities. For a SmartThings device to be represented by the light platform, it must have one or more of the capabilities below in addition to the switch capability.

Lock

The SmartThings Lock platform lets you control devices that have the lock capability, showing current lock status and supporting lock and unlock commands.

Sensor

The SmartThings Sensor platform lets your view devices that have sensor-related capabilities. A Sensor entity is created for each attribute (below) supported by the device.

Scene

The SmartThings Scene platform lets you activate scenes defined in SmartThings with a scene entity representing each SmartThings scenes within the location.

Switch

The SmartThings Switch platform lets you control devices that have the switch capability that are not already represented by a more specific platform. The following optional capabilities will provide energy and power utilization information:

Troubleshooting

Setup

Aborted: Home Assistant is not configured correctly to receive updates from SmartThings

This error message occurs when you do not have an active Home Assistant Cloud (Nabu Casa) subscription and the external URL is not configured correctly (it must start with https). Update your Home Assistant configuration per the prerequisites above, and try again.

Error: The token must be in the UID/GUID format

The personal access token does not match the expected format. Make sure you are copying the entire token and that there are no extraneous characters (such as trailing whitespace) and try again.

Error: pysmartthings.errors.APIInvalidGrant: Invalid refresh token: (after a restore)

You can fix this by using the SmartThings App to re-grant authorization to the API token you created before.

1. Open SmartThings app on your mobile device (not HA).
2. Select Automations from bottom.
3. Select your Home Assistant automation from the list.
4. Select Done, then select Allow.
5. Reload your SmartThings integration from Home Assistant Devices panel.

Error: The token is invalid or no longer authorized (not solved by above)

The personal access token entered is not valid or has been deleted. Create a new token per the instructions in the prerequisites and try again.

Error: The token does not have the required OAuth scopes

The personal access token entered is valid but does not have the required scopes as outlined in the prerequisites. Create a new token per the instructions in the prerequisites and try again.

Error: SmartThings could not validate the webhook URL

SmartThings was unable to reach your Home Assistant instance using the webhook URL. Enable debug logging to see the specific issue and follow the webhook troubleshooting checklist below.

Aborted: There are no available SmartThings Locations

This error message occurs when all of the SmartThings locations under the account linked to the personal access token are already setup in Home Assistant. Ensure you are using the correct personal access token or create an additional location in SmartThings to integrate and try again.

Webhook Troubleshooting Checklist

1. Ensure external URL is properly set to the external address that Home Assistant is available to the internet. SmartThings must be able to reach this address.

2. Validate there are no problems with your certificate or SSL configuration by using an online checker, such as https://www.digicert.com/help/.

3. Some reverse proxy configuration settings can interfere with communication from SmartThings. For example, TLSv1.3 is not supported. Setting the supported cipher suite too restrictly will prevent handshaking. The following NGINX SSL configuration is known to work:

   # cert.crt also contains intermediate certificates
   ssl_certificate /path/to/cert.crt;
   ssl_certificate_key /path/to/cert.key;
   ssl_dhparam /path/to/dhparam.pem;
   ssl_protocols TLSv1.2;
   ssl_ciphers 'EECDH+AESGCM:EDH+AESGCM:AES256+EECDH:AES256+EDH';
   ssl_prefer_server_ciphers on;
   ssl_ecdh_curve secp384r1;
   ssl_session_timeout  10m;
   ssl_session_cache shared:SSL:10m;
   ssl_session_tickets off;
   

4. While the error message (above) is being displayed, run the following command from outside your local network to confirm it is responding to the ping lifecycle event:

   curl -X POST https://{EXTERNAL_URL}/api/webhook/{WEBHOOK_ID} -H "Content-Type: application/json; charset=utf-8" -d $'{"lifecycle": "PING", "executionId": "00000000-0000-0000-0000-000000000000", "locale": "en", "version": "1.0.0", "pingData": { "challenge": "00000000-0000-0000-0000-000000000000"}}'
   

   Where {EXTERNAL_URL} is your external address and {WEBHOOK_ID} is the value of webhook_id from .storage/smartthings in your Home Assistant configuration directory.

   The expected response is:

   {"pingData": {"challenge": "00000000-0000-0000-0000-000000000000"}}
   

If you have completed the checklist above and are still unable to setup the platform, activate debug logging for the SmartThings integration and include the log messages up until the point of failure in a new issue.

Debugging

The SmartThings integration will log additional information about push updates received, events fired, and other messages when the log level is set to debug. Add the relevant line below to 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]:

logger:
  default: info
  logs:
    homeassistant.components.smartthings: debug