How to Program SmartThings
14 likes5,455 views
This document provides an overview of how to program SmartThings by building SmartApps and device types. It discusses SmartThings architecture including SmartApps, devices, and capabilities. It provides examples of building a SmartApp that triggers lights based on a door sensor, and building a device type for an Arduino shield with switch and sensor capabilities. The document outlines the steps to create an empty SmartApp and device type template and defines the necessary components like parsing events, handling commands, and defining tiles.
![Tile Definitions
standardTile()
valueTile()
controlTile()
Tile Layouts
valueTile("temperature",
"device.temperature",
width:
2,
height:
2)
main
"temperature"
details(["temperature",
“mode",
…])](https://image.slidesharecdn.com/smartthings20141022-141022044548-conversion-gate01/85/How-to-Program-SmartThings-27-320.jpg)
![https://gist.github.com/janetyc/34c1642f8eaa3e4299da
metadata
{
definition
(name:
"On/Off
Shield
(Janet)",
namespace:
"janetyc",
author:
"Janet
Huang")
{
capability
"Switch"
capability
"Sensor"
command
"hello"
}
simulator
{
//
TODO:
define
status
and
reply
messages
here
status
"on":
"catchall:
0104
0000
01
01
0040
00
0A21
00
00
0000
0A
00
0A6F6E"
status
"off":
"catchall:
0104
0000
01
01
0040
00
0A21
00
00
0000
0A
00
0A6F6666"
//
reply
messages
reply
"raw
0x0
{
00
00
0a
0a
6f
6e
}":
"catchall:
0104
0000
01
01
0040
00
0A21
00
00
0000
0A
00
0A6F6E"
reply
"raw
0x0
{
00
00
0a
0a
6f
66
66
}":
"catchall:
0104
0000
01
01
0040
00
0A21
00
00
0000
0A
00
0A6F6666"
}
tiles
{
//
TODO:
define
your
main
and
details
tiles
here
standardTile("switch",
"device.switch",
width:
2,
height:
2,
canChangeIcon:
true,
canChangeBackground:
true)
{
state
"on",
label:
'${name}',
action:
"switch.off",
icon:
"st.shields.shields.arduino",
backgroundColor:
"#79b821"
state
"off",
label:
'${name}',
action:
"switch.on",
icon:
"st.shields.shields.arduino",
backgroundColor:
"#ffffff"
}
standardTile("greeting",
"device.greeting",
width:
1,
height:
1,
canChangeIcon:
true,
canChangeBackground:
true)
{
state
"greeting",
label:
'hello',
action:
"hello",
icon:
"st.switches.switch.off",
backgroundColor:
"#ccccff"
}
valueTile("message",
"device.message",
inactiveLabel:
false)
{
state
"message",
label:'${currentValue}',
unit:""
}
valueTile("sensorValue",
"device.sensorValue",
){
state
"sensorValue",
label:'${currentValue}',
inactiveLabel:
false,
backgroundColors:[
[value:
31,
color:
"#153591"],
[value:
44,
color:
"#1e9cbb"],
[value:
59,
color:
"#90d2a7"],
[value:
74,
color:
"#44b621"],
[value:
84,
color:
"#f1d801"],
[value:
120,
color:
"#d04e00"],
[value:
195,
color:
"#bc2323"]
]
}
main
"switch"
details(["switch","greeting","message","sensorValue"])
}
}](https://image.slidesharecdn.com/smartthings20141022-141022044548-conversion-gate01/85/How-to-Program-SmartThings-28-320.jpg)
![//
parse
events
into
attributes
def
parse(String
description)
{
log.debug
"raw:
${description}”
!
def
value
=
zigbee.parse(description)?.text
def
linkText
=
getLinkText(device)
def
descriptionText
=
getDescriptionText(description,
linkText,
value)
def
handlerName
=
value
def
isStateChange
=
value
!=
"ping"
def
displayed
=
value
&&
isStateChange
def
name
=
"null"
if
(value?.startsWith("lightValue:
"))
{
value
=
value
-‐
"lightValue:
"
name
=
"sensorValue"
value
=
Integer.parseInt(value)
}else
if
(value?.startsWith("irValue:
"))
{
value
=
value
-‐
"irValue:
"
name
=
"irValue"
value
=
Integer.parseInt(value)
}else
{
name
=
value
in
["on","off"]
?
"switch"
:
(value
&&
value
!=
"ping"
?
"message"
:
"null")
value
=
value
}
def
result
=
[
value:
value,
name:
name,
handlerName:
handlerName,
linkText:
linkText,
descriptionText:
descriptionText,
isStateChange:
isStateChange,
displayed:
displayed
]
result
}
debug log
parse zigbee message
attribute name
https://gist.github.com/janetyc/34c1642f8eaa3e4299da](https://image.slidesharecdn.com/smartthings20141022-141022044548-conversion-gate01/85/How-to-Program-SmartThings-29-320.jpg)
How to Program SmartThings
- 1. Programming Your SmartThings Janet Huang janetyc@gmail.com 2014.10.22 @ NTU CSIE
- 3. Outline • Introduction • Conceptual Architecture • SmartThings Architecture • How to Program SmartThings • Build a SmartApp • Build a Device Type
- 4. Important Concepts Image Capture Lock Contact Sensor Switch Music Player Temperature Measurement
- 7. SmartApps SmartDevices SmartThings Shield Customized Smart Device Arduino-compatible board (Uno, Mega, Duemilanove, and Leonardo) + Sensor, Actuator = 1 2 3 ZigBee or ZigWave Device
- 8. SmartApp Event Handler SmartApps Subscribe events and call a handler method Solution Module SmartApps Built-in apps in dashboard Service Manager SmartApps Be used to connect to your external devices Device Type Hub Connected Devices ZigBee Home Automation Devices Z-Wave Devices Cloud Connected Devices Authenticate via a standard OAuth2 flow Communicate via HTTP-based APIs LAN-Connected Devices Communicate via REST or with SOAP requests using UPnP (Universal Plug and Play)
- 10. SmartApp Execution 1. Event Subscription attribute changes -> creates an event (triggers a subscription, calls a handler method) 2. Scheduled Events call a method at a particular time, e.g. runIn() 3. Endpoint Triggers create an endpoint accessible over the web that calls a method within your SmartApp
- 11. Capabilities device state action https://graph.api.smartthings.com/ide/doc/capabilities
- 13. SmartApp Empty Template define input install setting update setting
- 15. Create an Empty SmartApp
- 16. SmartThings IDE
- 19. Example 1a: Lights Off, When Closed (Built-in example) app setting define input subscribe event define action
- 20. Example 1b: Lights On/Off, When Opened/Closed https://gist.github.com/janetyc/22c0ecf586f1550669b5
- 21. check the state of the door https://gist.github.com/janetyc/22c0ecf586f1550669b5
- 22. 1 Select location 2 Select testing devices 4 Testing on real devices 3 Testing on simulator
- 23. Your First Device Type
- 24. Create an Empty SmartDevice
- 26. Device Type Empty Template define capability, command define UI parse events commands
- 27. Tile Definitions standardTile() valueTile() controlTile() Tile Layouts valueTile("temperature", "device.temperature", width: 2, height: 2) main "temperature" details(["temperature", “mode", …])
- 28. https://gist.github.com/janetyc/34c1642f8eaa3e4299da metadata { definition (name: "On/Off Shield (Janet)", namespace: "janetyc", author: "Janet Huang") { capability "Switch" capability "Sensor" command "hello" } simulator { // TODO: define status and reply messages here status "on": "catchall: 0104 0000 01 01 0040 00 0A21 00 00 0000 0A 00 0A6F6E" status "off": "catchall: 0104 0000 01 01 0040 00 0A21 00 00 0000 0A 00 0A6F6666" // reply messages reply "raw 0x0 { 00 00 0a 0a 6f 6e }": "catchall: 0104 0000 01 01 0040 00 0A21 00 00 0000 0A 00 0A6F6E" reply "raw 0x0 { 00 00 0a 0a 6f 66 66 }": "catchall: 0104 0000 01 01 0040 00 0A21 00 00 0000 0A 00 0A6F6666" } tiles { // TODO: define your main and details tiles here standardTile("switch", "device.switch", width: 2, height: 2, canChangeIcon: true, canChangeBackground: true) { state "on", label: '${name}', action: "switch.off", icon: "st.shields.shields.arduino", backgroundColor: "#79b821" state "off", label: '${name}', action: "switch.on", icon: "st.shields.shields.arduino", backgroundColor: "#ffffff" } standardTile("greeting", "device.greeting", width: 1, height: 1, canChangeIcon: true, canChangeBackground: true) { state "greeting", label: 'hello', action: "hello", icon: "st.switches.switch.off", backgroundColor: "#ccccff" } valueTile("message", "device.message", inactiveLabel: false) { state "message", label:'${currentValue}', unit:"" } valueTile("sensorValue", "device.sensorValue", ){ state "sensorValue", label:'${currentValue}', inactiveLabel: false, backgroundColors:[ [value: 31, color: "#153591"], [value: 44, color: "#1e9cbb"], [value: 59, color: "#90d2a7"], [value: 74, color: "#44b621"], [value: 84, color: "#f1d801"], [value: 120, color: "#d04e00"], [value: 195, color: "#bc2323"] ] } main "switch" details(["switch","greeting","message","sensorValue"]) } }
- 29. // parse events into attributes def parse(String description) { log.debug "raw: ${description}” ! def value = zigbee.parse(description)?.text def linkText = getLinkText(device) def descriptionText = getDescriptionText(description, linkText, value) def handlerName = value def isStateChange = value != "ping" def displayed = value && isStateChange def name = "null" if (value?.startsWith("lightValue: ")) { value = value -‐ "lightValue: " name = "sensorValue" value = Integer.parseInt(value) }else if (value?.startsWith("irValue: ")) { value = value -‐ "irValue: " name = "irValue" value = Integer.parseInt(value) }else { name = value in ["on","off"] ? "switch" : (value && value != "ping" ? "message" : "null") value = value } def result = [ value: value, name: name, handlerName: handlerName, linkText: linkText, descriptionText: descriptionText, isStateChange: isStateChange, displayed: displayed ] result } debug log parse zigbee message attribute name https://gist.github.com/janetyc/34c1642f8eaa3e4299da
- 30. // handle commands def on() { log.debug "Executing 'on'" zigbee.smartShield(text: "on").format() //send 'on' to device } def off() { log.debug "Executing 'off'" zigbee.smartShield(text: "off").format() //send 'off' to device } //customized commands def hello() { log.debug "Executing 'hello'" zigbee.smartShield(text: "hello").format() //send 'hello' to device } https://gist.github.com/janetyc/34c1642f8eaa3e4299da
- 31. It’s Your Turn!! Build Your SmartApp & SmartDevice