Create a cloud-connected device

This article explains how to create a cloud-connected device on Developer Workspace.

Cloud Connector types

From the project creation page, select Device Integration. Select the Cloud Connector option.

Create SmartThings device integration

Select one of the following methods to develop your Cloud Connector:

  • SmartThings Schema is the quickest integration method and is recommended for clouds that support OAuth 2.0.
  • SmartApp is an option for implementing certain advanced features or customizing your device onboarding UX.

SmartThings Schema Connector

After selecting SmartThings Schema Connector, follow these steps.

  • Name your project and click CREATE PROJECT.
    • The Overview page shows your current development tasks: Building the Connector and registering the Connector.

Register the SmartThings Schema Connector

  • In the Develop menu, click Cloud Connector to register your Connector. The Hosting and Credentials tab will open.
  • Select a hosting type.
    • AWS Lambda requires a Target ARN for each region in which you plan to distribute your integration. For better execution latency, you should deploy your Lambda function in an AWS region that is geographically closer to the end-user's Location.
    • Webhook Endpoint requires a Target URL where the Connector will be hosted.
  • Enter the Device Cloud Credentials.
  • Client ID is a unique public string used to identify the device cloud.
  • Client Secret is a credential used to authenticate with the Access Token URI. This is combined with the client ID to identify the request.
  • Authorization URI where users will be redirected to enter login credentials.
  • Refresh Token URL where refresh tokens can be obtained in order to get a new access token or ID token.
  • Partner OAuth scope specifies the OAuth scopes required for the device cloud to communicate with SmartThings Cloud.
  • Click Next to open the Catalog Info tab.
  • Enter a Connector Display Name to show in the SmartThings app.
  • Upload a Logo (240x240px) to be used in the SmartThings app.

After saving the above information, click DEPLOY TO TEST. Return to the Cloud Connector page to access the client ID and client secret for this SmartThings Schema Connector.

SmartThings Schema Connector info

You can now test and publish your SmartThings Schema Connector.

SmartApp Connector

After selecting SmartApp Connector, follow these steps.

  • Name your project and click CREATE PROJECT.

Add a device profile

  • In the Develop menu, click Device Profile to create a new device profile or clone an existing one.

Register the SmartApp Connector

  • In the Develop menu, click Cloud Connector to register your Connector. The Hosting tab will open.
  • Select a hosting type.
    • AWS Lambda requires a Target ARN for the SmartApp.
    • Webhook Endpoint requires a Target URL where the Connector will be hosted.
  • Click Next to open the App Scope tab.
  • Select the OAuth2 scopes required for the device cloud to communicate with SmartThings Cloud.
  • Click Next to open the App Settings tab.
  • Enter a Connector Display Name to be shown in the SmartThings app.
  • Select whether you will allow single or multiple SmartApp Instances.
    • Multiple instances allows users to install this SmartApp more than once, with different configurations in the same location.
    • Single instance allows users to install this SmartApp once, using a single configuration in one location.
  • Add any Custom Parameters used in your Cloud Connector code.
  • Click SAVE.

After saving the above information, return to the Cloud Connector page to access the public key, client ID, and client secret for this SmartApp Connector.

SmartApp Connector info

You can now test and publish your SmartApp Connector.

Next steps