Developing Your SmartThings Find Device

Code Lab

Want to learn how to build a sample SmartThings Find-compatible device interactively? Visit the Develop a SmartThings Find-compatible device code lab to get started.

Set Up Your Programming Environment

The first step in developing your SmartThings Find device is getting your programming environment up and running. The SmartThings Find Device SDK includes a detailed guide on setting up your programming environment.

Register Your Device

Now that your development environment is set up, the next step is to register your device in the Developer Center. SmartThings Find device registration includes defining the device profile, providing device onboarding instructions, registering your brand, naming the device, and provisioning the device identity.

1. Create a product
2. Define a device profile
3. Define device onboarding info
4. Register a brand
5. Define product info
6. Test your device
7. (Optional) Publish your device

Sign In to the Developer Center and Create a Product

Begin by signing in to the Developer Center with your Samsung account.

important

You must enroll your organization or be enrolled in an organization as a member to publish a Mobile Connected Device. As a member of an organization, be sure you have switched from your private workspace to your organization's workspace.

After signing in, create a new SmartThings Find product:

1. Click Device Integrations.
2. Click Create on the Products tab.
3. Select SmartThings Find as the product type.

After creating your new product, you will be taken to an overview of your product in the Developer Center. The Overview page guides you through the steps of creating a Mobile-connected device integration. Remember, your product is a one-to-one relationship with your device.

tip

Product Status

Your product detail page shows a completion percentage and a status such as DRAFT:

• DRAFT - The status of your product when it is created. You are defining the device features and other information that will allow the device to onboard to SmartThings.
• As you complete the Product Details, Brand, and Setup & Support Profiles sections, your completion percentage increases. You are able to test your device under developer mode in the SmartThings app once you've registered a test device.
• Once all three required sections are COMPLETE, progress reaches 100% and the Submit for Certification button becomes active so you can submit a request to be WWST certified.
• Published - The device has been certified and is available to the public in the SmartThings app.

Define Your Device Profile

Before joining your device to the SmartThings Platform, you'll need to define your device profile as part of your Setup & Support Profile in the Developer Center.

SmartThings provides two types of pre-defined Device Profiles for Mobile Connected Devices:

• BLE
• BLE + UWB

Select the appropriate Protocol Type in your Setup & Support Profile in the Developer Center for your product.

Define Your Device Onboarding Information

The Setup & Support Profiles section of your product in the Developer Center will guide you through the process of creating your device's onboarding profile. This profile defines how users will onboard your device to the SmartThings Platform and the information they will be presented with as they onboard your device.

Ensure you add a unique identifier for the onboarding profile. This identifier is used by the SmartThings Find Device SDK and SmartThings app to locate your onboarding profile during the pairing sequence.

important

Test devices will not connect successfully if you change your product's onboarding profile after registering their identity. To correct this error, delete and register the devices again.

Register Your Brand

Before joining your device to the SmartThings Platform, you'll also need to register your brand from the Brand section of your product in the Developer Center. Your brand is the brand, company, and contact information shown to users, and is required to commercially integrate a product with SmartThings.

note

The brand name must be unique. If you already have a certified brand, you can link it to your account instead of creating a new one by contacting partners@smartthings.com.

Define Your Product Info

You can modify or add product info from the Product Details section of your product in the Developer Center. Basic product information is required as a placeholder for your device in the SmartThings catalog and as a link to the device identities that are registered.

note

By default, your device is set to be available only in the United States. This is sufficient for testing. You can make changes to your device's availability before publishing.

Test Your Device

After you have defined a profile, onboarding instructions, brand, and product information, you are ready to begin testing. For detailed testing instructions, visit Test Your Device.

Now is a good time to download the test cases for your device to know what tests your device must pass for WWST certification. In addition, download and review the security and certification application under the Publish menu. Use the information in these documents to test and ensure that your device will meet SmartThings functional and security requirements.

Publish a Commercial Device

Publishing a device makes the device publicly available on the SmartThings Platform. Before Mobile Connected Devices are published, the devices must be certified with Works With SmartThings (WWST). Verify that your device meets functional and security requirements before submitting for certification. Information regarding functional and security requirements can be downloaded from the Test and Publish menus from your product in the Developer Center.

tip

Visit the Works With SmartThings (WWST) Certification page to learn more about certifying your devices.

Publish Request

When you have completed testing and are ready to submit for certification, visit the Developer Center and click Submit for Certification to obtain your WWST certification.

Commercial Devices

Once your device is WWST-certified, you are able to provision the identity of commercial devices. You can preload your device identity and credentials before the publish date, allowing you to coordinate the distribution and availability of your devices.

All Mobile Connected Devices must be registered with SmartThings in order to connect with the platform. Provision device identities in the Developer Center using the upload features under Commercial Devices. You can upload your device identities individually or in bulk via CSV file. Up to 100,000 devices can be processed in a single bulk upload request.