Sideloading

If you've created your own custom plugin, you can test it on the SmartThings app by sideloading. How to sideload is mobile OS dependent and it's important to confirm with OS of your mobile devices where the SmartThings app is installed.

Prerequisites

Android

Before sideloading your plugin to your Android phone, you need to set your ADB (Android Debug Bridge) path to connect your phone with the SmartThings SDK.

  1. Download the Android SDK Tools and install it.
  2. Enable adb debugging on your Android phone.
  3. Set the path to your adb installation. The default Windows path is C:\adb.
  st set config --key adbPath --value {your 'adb' path}

To test a plugin you have created, you must side-load it through the SmartThings SDK.

  1. Connect your mobile device to your computer using a USB cable. If you cannot connect your Android phone, set up the ADB path.
  2. To copy the plugin files to your Android phone, use the following command with the password you set up when signing the plugin.
    st sign ppk --in {path of ppk} --passwd {passwd}
    st install app --target

iOS

Before sideloading your plugin to your iPhone, you need to download the latest iTunes and install it.

  1. Use the following command on your project folder. Each files (.plugin, .ppk, and .json) is saved in {selected_project__name}/out_iOS/sideloading.
    st build project
File Directory File format
UI manifest file manifest {MNID}_{VID}_ui.json
Plugin file plugin .plugin
Plugin package file plugin/ppks .ppk
  1. Copy your plugin files to your iPhone using iTunes. For more information, see here.
    1. Open iTunes and connect your iPhone to your computer using a USB cable.
    2. Find and then click your iPhone.
    3. In the left sidebar, click Files Sharing and select SmartThings in Apps.
    4. Drag and drop your sideloading folder including UI manifest, plugin, and plugin package Files onto the SmartThings Documents list to copy them to your iPhone.
  2. Refresh your SmartThings app.