SmartThings SDK

Platform API Reference

Device Profiles

deviceprofiles.list (query = {max: 500})

deviceprofiles.get (id)

deviceprofiles.create (data)

deviceprofiles.update (id, data)

Devices

create(params)

params:

label -- display name of the device
profileId -- device profile ID
externalId (optional) -- ID of the device in the external service

devices.delete (deviceId)

devices.get (deviceId)

devices.update (deviceId, data)

devices.sendEvents (deviceId, events)

devices.listInLocation ()

devices.listAll ()

devices.sendCommand (item, capability, command, args)

devices.sendCommands (items, capability, command, args)

devices.postCommands (deviceId, body)

devices.getState (deviceId)

devices.getComponentState (deviceId, componentId)

devices.getCapabilityState (deviceId, componentId, capabilityId)

devices.getHealth (deviceId)

devices.getAttributeValue (deviceId, capability, attribute)

devices.namedColor (color, sat = 100)

Installed Apps

installedapps.list (locationId = null)

installedapps.get (id = null)

installedapps.update (id, data)

installedapps.getConfigs (id = null)

installedapps.getConfig (id = null, configId)

installedapps.deleteInstalledApp (id)

installedapps.listChildDevices ()

Locations

locations.list (query = {max: 500})

locations.get (id = null)

locations.updateLocation (id, data)

locations.createLocation (data)

locations.deleteLocation (id)

Modes

modes.list (query = {max: 500})

modes.get (id)

modes.update (id, data)

Scenes

scenes.list (query = {max: 500})

scenes.getScene (id)

scenes.execute (id)

Schedules

schedules.schedule (name, cronExpression)

schedules.runDaily (name, time)

Accepts time setting, Date object, or ISO string

schedules.runIn (name, delay)

schedules.unschedule (name)

schedules.unscheduleAll ()

Subscriptions

subscriptions.list ()

subscriptions.get (name)

subscriptions.update (name, data)

subscriptions.unsubscribe (name)

subscriptions.unsubscribeAll ()

subscriptions.subscribeToDevices (devices, capability, attribute, subscriptionName, options={})

subscriptions.subscribeToCapability (capability, attribute, subscriptionName, options={})

subscriptions.subscribeToModeChange (subscriptionName)

subscriptions.subscribeToDeviceLifecycle (devices, subscriptionName)

subscriptions.subscribeToDeviceHealth (devices, subscriptionName)

subscriptions.subscribeToSecuritySystem (subscriptionName)

subscriptions.subscribeToHubHealth (subscriptionName)

subscriptions.subscribeToSceneLifecycle (subscriptionName)