Developing Your SmartThings Find Device
#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 programing environment.
#Register Your Device
Now that your development environment is set up, the next step is to register your device in the Developer Workspace. SmartThings Find device registration includes defining the device profile, providing device onboarding instructions, naming the device, and provisioning the device identity.
- Create a project
- Define a device profile
- Define device onboarding info
- Define product info
- Test your device
- (Optional) Publish your device
#Sign In to the Developer Workspace and Create a Project
Begin by signing in to the Developer Workspace with your Samsung account.
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 device integration:
- Click New Project.
- Click Device Integration.
- Select Mobile Connected as the device integration type.
After creating your new project, you will be taken to an overview of your project in the Developer Workspace. The Overview page guides you through the steps of creating a Mobile-connected device integration. Remember, your project is a one-to-one relationship with your device.
Your project can be in one of four states:
- Develop - The state of your project when it is created. You are defining the device features and other information that will allow the device to onboard to SmartThings.
- Deployed to Test - The state of your project after you have provided the minimum information for the SmartThings catalog, device, and onboarding profiles. You are able to test your device under developer mode in the SmartThings app.
- Publish Request - Once your device is ready for wider release, 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 in the Developer Workspace.
SmartThings provides two types of pre-defined Device Profiles for Mobile Connected Devices:
- BLE + UWB
Select the appropriate Device Profile in the Developer Workspace for your project.
#Define Your Device Onboarding Information
The Device Onboarding page in the Developer Workspace 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.
Test devices will not connect successfully if you change the project's onboarding profile after registering their identity. To correct this error, delete and register the devices again.
#Define Your Product Info
You can modify or add product info from the Product Info section of the Developer Workspace. Basic product information is required as a placeholder for your device in the SmartThings catalog and as a link to the the device identities that are registered.
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, 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 project in the Developer Workspace.
Visit the Works With SmartThings (WWST) Certification page to learn more about certifying your devices.
When you have completed testing and are ready to submit for certification, visit the Developer Workspace and click Request to Publish to obtain your WWST certification.
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 Workspace 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.