Merge pull request #1443 from jackchi/health-appengine-readme

Device types should include better health documentation
This commit is contained in:
Vinay Rao
2016-11-09 16:23:00 -08:00
committed by GitHub
28 changed files with 106 additions and 86 deletions

View File

@@ -1,6 +1,6 @@
# Connected Cree LED Bulb # Connected Cree LED Bulb
Cloud Execution
Works with: Works with:
@@ -23,8 +23,10 @@ Works with:
## Device Health ## Device Health
A Category C6 Connected Cree LED Bulb with maxReportTime of 5 mins. Connected Cree LED Bulb with cloud polling it every __5min__
Check-in interval = 12 mins SmartThings platform will ping the device after `checkInterval` seconds of inactivity in last attempt to reach the device before marking it `OFFLINE`
* __12min__ checkInterval
## Troubleshooting ## Troubleshooting

View File

@@ -105,7 +105,7 @@ def healthPoll() {
def configure() { def configure() {
unschedule() unschedule()
runEvery5Minutes("healthPoll") runEvery5Minutes("healthPoll")
// Device-Watch allows 2 check-in misses from device // Device-Watch allows 2 check-in misses from device + ping
sendEvent(name: "checkInterval", value: 60 * 12, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID]) sendEvent(name: "checkInterval", value: 60 * 12, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
zigbee.onOffRefresh() + zigbee.levelRefresh() zigbee.onOffRefresh() + zigbee.levelRefresh()
} }

View File

@@ -1,6 +1,6 @@
# Z-wave Dimmer Switch # Z-wave Dimmer Switch
Local Execution on V2 Hubs
Works with: Works with:
@@ -34,6 +34,8 @@ Not to mention after going OFFLINE when the device is plugged back in, it might
the device to appear as ONLINE again. This is because if this listening device does not respond to two poll requests in a row, the device to appear as ONLINE again. This is because if this listening device does not respond to two poll requests in a row,
it is not polled for 5 minutes by the hub. This can delay up the process of being marked ONLINE by quite some time. it is not polled for 5 minutes by the hub. This can delay up the process of being marked ONLINE by quite some time.
* __32min__ checkInterval
## Troubleshooting ## Troubleshooting
If the device doesn't pair when trying from the SmartThings mobile app, it is possible that the device is out of range. If the device doesn't pair when trying from the SmartThings mobile app, it is possible that the device is out of range.

View File

@@ -1,6 +1,6 @@
# Nyce Door/Window Sensor (Open/Close Sensor) # Nyce Door/Window Sensor (Open/Close Sensor)
Cloud Execution
Works with: Works with:
@@ -23,7 +23,11 @@ Works with:
## Device Health ## Device Health
A Category C2 Nyce Door/Window sensor that has 12min check-in interval Nyce Door/Window sensor with reporting interval of 5 min.
SmartThings platform will ping the device after `checkInterval` seconds of inactivity in last attempt to reach the device before marking it `OFFLINE`
* __12min__ checkInterval
## Battery Specification ## Battery Specification

View File

@@ -1,6 +1,6 @@
# SmartPower Outlet # SmartPower Outlet
Local Execution on V2 Hubs
Works with: Works with:
@@ -23,10 +23,11 @@ Works with:
## Device Health ## Device Health
A Category C1 smart power outlet with maxReportTime of 5 mins. SmartPower outlet with reporting interval of 5 mins
Check-in interval is double the value of maxReportTime. SmartThings platform will ping the device after `checkInterval` seconds of inactivity in last attempt to reach the device before marking it `OFFLINE`
This gives the device twice the amount of time to respond before it is marked as offline.
Check-in interval = 12 mins * V1, TV, HubV2 AppEngine < 1.5.1 - __21min__ checkInterval
* HubV2 AppEngine 1.5.1 - __12min__ checkInterval
## Troubleshooting ## Troubleshooting

View File

@@ -145,9 +145,9 @@ def refresh() {
} }
def configure() { def configure() {
// Device-Watch allows 3 check-in misses from device (plus 1 min lag time) // Device-Watch allows 2 check-in misses from device + ping (plus 1 min lag time)
// enrolls with default periodic reporting until newer 5 min interval is confirmed // enrolls with default periodic reporting until newer 5 min interval is confirmed
sendEvent(name: "checkInterval", value: 3 * 10 * 60 + 1 * 60, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID]) sendEvent(name: "checkInterval", value: 2 * 10 * 60 + 1 * 60, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
// OnOff minReportTime 0 seconds, maxReportTime 5 min. Reporting interval if no activity // OnOff minReportTime 0 seconds, maxReportTime 5 min. Reporting interval if no activity
refresh() + zigbee.onOffConfig(0, 300) + powerConfig() refresh() + zigbee.onOffConfig(0, 300) + powerConfig()

View File

@@ -1,6 +1,6 @@
# Smartsense Moisture Sensor # Smartsense Moisture Sensor
Local Execution on V2 Hubs
Works with: Works with:
@@ -23,10 +23,11 @@ Works with:
## Device Health ## Device Health
A Category C2 moisture sensor with maxReportTime of 5 mins. SmartSense Moisture sensor with reporting interval of 5 mins.
Check-in interval is double the value of maxReportTime. SmartThings platform will ping the device after `checkInterval` seconds of inactivity in last attempt to reach the device before marking it `OFFLINE`
This gives the device twice the amount of time to respond before it is marked as offline.
Check-in interval = 12 mins * V1, TV, HubV2 AppEngine < 1.5.1 - __121min__ checkInterval
* HubV2 AppEngine 1.5.1 - __12min__ checkInterval
## Battery Specification ## Battery Specification

View File

@@ -293,9 +293,9 @@ def refresh() {
} }
def configure() { def configure() {
// Device-Watch allows 3 check-in misses from device (plus 1 min lag time) // Device-Watch allows 2 check-in misses from device + ping (plus 1 min lag time)
// enrolls with default periodic reporting until newer 5 min interval is confirmed // enrolls with default periodic reporting until newer 5 min interval is confirmed
sendEvent(name: "checkInterval", value: 3 * 60 * 60 + 1 * 60, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID]) sendEvent(name: "checkInterval", value: 2 * 60 * 60 + 1 * 60, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
// temperature minReportTime 30 seconds, maxReportTime 5 min. Reporting interval if no activity // temperature minReportTime 30 seconds, maxReportTime 5 min. Reporting interval if no activity
// battery minReport 30 seconds, maxReportTime 6 hrs by default // battery minReport 30 seconds, maxReportTime 6 hrs by default

View File

@@ -1,6 +1,6 @@
# Smartsense Motion Sensor # Smartsense Motion Sensor
Local Execution on V2 Hubs
Works with: Works with:
@@ -22,10 +22,12 @@ Works with:
## Device Health ## Device Health
A Category C2 motion sensor with maxReportTime of 5 mins. SmartSense Motion sensor with reporting interval of 5 mins.
Check-in interval is double the value of maxReportTime. SmartThings platform will ping the device after `checkInterval` seconds of inactivity in last attempt to reach the device before marking it `OFFLINE`
This gives the device twice the amount of time to respond before it is marked as offline.
Check-in interval = 12 mins * V1, TV, HubV2 AppEngine < 1.5.1 - __121min__ checkInterval
* HubV2 AppEngine 1.5.1 - __12min__ checkInterval
## Battery Specification ## Battery Specification

View File

@@ -306,9 +306,9 @@ def refresh() {
} }
def configure() { def configure() {
// Device-Watch allows 3 check-in misses from device (plus 1 min lag time) // Device-Watch allows 2 check-in misses from device + ping (plus 1 min lag time)
// enrolls with default periodic reporting until newer 5 min interval is confirmed // enrolls with default periodic reporting until newer 5 min interval is confirmed
sendEvent(name: "checkInterval", value: 3 * 60 * 60 + 1 * 60, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID]) sendEvent(name: "checkInterval", value: 2 * 60 * 60 + 1 * 60, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
// temperature minReportTime 30 seconds, maxReportTime 5 min. Reporting interval if no activity // temperature minReportTime 30 seconds, maxReportTime 5 min. Reporting interval if no activity
// battery minReport 30 seconds, maxReportTime 6 hrs by default // battery minReport 30 seconds, maxReportTime 6 hrs by default

View File

@@ -1,6 +1,6 @@
# Smartsense Multi Sensor # Smartsense Multi Sensor
Local Execution on V2 Hubs
Works with: Works with:
@@ -26,10 +26,11 @@ Works with:
## Device Health ## Device Health
A Category C2 multi sensor with maxReportTime of 5 mins. SmartSense Multi sensor with reporting interval of 5 mins.
Check-in interval is double the value of maxReportTime. SmartThings platform will ping the device after `checkInterval` seconds of inactivity in last attempt to reach the device before marking it `OFFLINE`
This gives the device twice the amount of time to respond before it is marked as offline.
Check-in interval = 12 mins * V1, TV, HubV2 AppEngine < 1.5.1 - __121min__ checkInterval
* HubV2 AppEngine 1.5.1 - __12min__ checkInterval
## Battery Specification ## Battery Specification

View File

@@ -400,9 +400,9 @@ def refresh() {
} }
def configure() { def configure() {
// Device-Watch allows 3 check-in misses from device (plus 1 min lag time) // Device-Watch allows 2 check-in misses from device + ping (plus 1 min lag time)
// enrolls with default periodic reporting until newer 5 min interval is confirmed // enrolls with default periodic reporting until newer 5 min interval is confirmed
sendEvent(name: "checkInterval", value: 3 * 60 * 60 + 1 * 60, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID]) sendEvent(name: "checkInterval", value: 2 * 60 * 60 + 1 * 60, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
log.debug "Configuring Reporting" log.debug "Configuring Reporting"

View File

@@ -1,6 +1,6 @@
# Smartsense Open/Closed Sensor # Smartsense Open/Closed Sensor
Local Execution on V2 Hubs
Works with: Works with:
@@ -24,10 +24,11 @@ Works with:
## Device Health ## Device Health
A Category C2 open/closed sensor with maxReportTime of 5 mins. SmartSense Open Closed sensor with reporting interval of 5 mins.
Check-in interval is double the value of maxReportTime. SmartThings platform will ping the device after `checkInterval` seconds of inactivity in last attempt to reach the device before marking it `OFFLINE`
This gives the device twice the amount of time to respond before it is marked as offline.
Check-in interval = 12 mins * V1, TV, HubV2 AppEngine < 1.5.1 - __121min__ checkInterval
* HubV2 AppEngine 1.5.1 - __12min__ checkInterval
## Battery Specification ## Battery Specification

View File

@@ -260,9 +260,9 @@ def refresh() {
} }
def configure() { def configure() {
// Device-Watch allows 3 check-in misses from device (plus 1 min lag time) // Device-Watch allows 2 check-in misses from device + ping (plus 1 min lag time)
// enrolls with default periodic reporting until newer 5 min interval is confirmed // enrolls with default periodic reporting until newer 5 min interval is confirmed
sendEvent(name: "checkInterval", value: 3 * 60 * 60 + 1 * 60, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID]) sendEvent(name: "checkInterval", value: 2 * 60 * 60 + 1 * 60, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
log.debug "Configuring Reporting, IAS CIE, and Bindings." log.debug "Configuring Reporting, IAS CIE, and Bindings."

View File

@@ -1,6 +1,6 @@
# SmartSense Temp/Humidity Sensor # SmartSense Temp/Humidity Sensor
Local Execution on V2 Hubs
Works with: Works with:
@@ -24,10 +24,11 @@ Works with:
## Device Health ## Device Health
A Category C2 SmartSense Temp/Humidity Sensor with maxReportTime of 5 mins. SmartSense Temp/Humidity Sensor with reporting interval of 5 mins.
Check-in interval is double the value of maxReportTime. SmartThings platform will ping the device after `checkInterval` seconds of inactivity in last attempt to reach the device before marking it `OFFLINE`
This gives the device twice the amount of time to respond before it is marked as offline.
Check-in interval = 12 mins * V1, TV, HubV2 AppEngine < 1.5.1 - __121min__ checkInterval
* HubV2 AppEngine 1.5.1 - __12min__ checkIntervalr 5 min interval is confirmed
## Battery Specification ## Battery Specification

View File

@@ -264,9 +264,9 @@ def refresh()
} }
def configure() { def configure() {
// Device-Watch allows 3 check-in misses from device (plus 1 min lag time) // Device-Watch allows 2 check-in misses from device + ping (plus 1 min lag time)
// enrolls with default periodic reporting until newer 5 min interval is confirmed // enrolls with default periodic reporting until newer 5 min interval is confirmed
sendEvent(name: "checkInterval", value: 3 * 60 * 60 + 1 * 60, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID]) sendEvent(name: "checkInterval", value: 2 * 60 * 60 + 1 * 60, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
log.debug "Configuring Reporting and Bindings." log.debug "Configuring Reporting and Bindings."
def humidityConfigCmds = [ def humidityConfigCmds = [

View File

@@ -1,6 +1,6 @@
# Tyco Door Window Sensor # Tyco Door Window Sensor
Cloud Execution
Works with: Works with:
@@ -23,10 +23,11 @@ Works with:
## Device Health ## Device Health
Contact sensor with maxReportTime of 5 mins. Tyco Door Window Sensor with reporting interval of 5 mins.
Check-in interval is double the value of maxReportTime for Zigbee device. Check-in interval is double the value of maxReportTime for Zigbee device.
This gives the device twice the amount of time to respond before it is marked as offline. This gives the device twice the amount of time to respond before it is marked as offline.
Check-in interval = 12 min
* __12min__ checkInterval
## Battery Specification ## Battery Specification

View File

@@ -1,6 +1,6 @@
# GE Plug-In/In-Wall Smart Dimmer (ZigBee) # GE Plug-In/In-Wall Smart Dimmer (ZigBee)
Cloud Execution
Works with: Works with:
@@ -26,11 +26,11 @@ Works with:
## Device Health ## Device Health
A Zigbee dimmer with maxReportTime of 5 mins. A Zigbee Power Dimmer with reporting interval of 5 mins.
Check-in interval is double the value of maxReportTime. SmartThings platform will ping the device after `checkInterval` seconds of inactivity in last attempt to reach the device before marking it `OFFLINE`
This gives the device twice the amount of time to respond before it is marked as offline.
Enrolls with default periodic reporting until newer 5 min interval is confirmed * __12min__ checkInterval
It then enrolls the device with updated checkInterval i.e. 12 mins
## Troubleshooting ## Troubleshooting

View File

@@ -114,8 +114,8 @@ def refresh() {
def configure() { def configure() {
log.debug "Configuring Reporting and Bindings." log.debug "Configuring Reporting and Bindings."
// Device-Watch allows 3 check-in misses from device (plus 1 min lag time) // Device-Watch allows 2 check-in misses from device + ping (plus 1 min lag time)
// enrolls with default periodic reporting until newer 5 min interval is confirmed // enrolls with default periodic reporting until newer 5 min interval is confirmed
sendEvent(name: "checkInterval", value: 3 * 60 * 60 + 1 * 60, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID]) sendEvent(name: "checkInterval", value: 2 * 60 * 60 + 1 * 60, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
refresh() refresh()
} }

View File

@@ -1,6 +1,6 @@
# Zigbee Dimmer # Zigbee Dimmer
Cloud Execution
Works with: Works with:
@@ -24,11 +24,11 @@ Works with:
## Device Health ## Device Health
A Zigbee dimmer with maxReportTime of 5 mins. ZigBee Dimmer with reporting interval of 5 mins.
Check-in interval is double the value of maxReportTime. SmartThings platform will ping the device after `checkInterval` seconds of inactivity in last attempt to reach the device before marking it `OFFLINE`
This gives the device twice the amount of time to respond before it is marked as offline.
Enrolls with default periodic reporting until newer 5 min interval is confirmed * __12min__ checkInterval
It then enrolls the device with updated checkInterval i.e. 12 mins
## Troubleshooting ## Troubleshooting

View File

@@ -102,9 +102,9 @@ def refresh() {
def configure() { def configure() {
log.debug "Configuring Reporting and Bindings." log.debug "Configuring Reporting and Bindings."
// Device-Watch allows 3 check-in misses from device (plus 1 min lag time) // Device-Watch allows 2 check-in misses from device + ping (plus 1 min lag time)
// enrolls with default periodic reporting until newer 5 min interval is confirmed // enrolls with default periodic reporting until newer 5 min interval is confirmed
sendEvent(name: "checkInterval", value: 3 * 10 * 60 + 1 * 60, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID]) sendEvent(name: "checkInterval", value: 2 * 10 * 60 + 1 * 60, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
// OnOff minReportTime 0 seconds, maxReportTime 5 min. Reporting interval if no activity // OnOff minReportTime 0 seconds, maxReportTime 5 min. Reporting interval if no activity
zigbee.onOffRefresh() + zigbee.levelRefresh() + zigbee.onOffConfig(0, 300) + zigbee.levelConfig() zigbee.onOffRefresh() + zigbee.levelRefresh() + zigbee.onOffConfig(0, 300) + zigbee.levelConfig()

View File

@@ -1,6 +1,6 @@
# OSRAM LIGHTIFY LED RGBW Bulb # OSRAM LIGHTIFY LED RGBW Bulb
Cloud Execution
Works with: Works with:
@@ -27,11 +27,10 @@ Works with:
## Device Health ## Device Health
A Category C6 OSRAM LIGHTIFY LED RGBW Bulb with maxReportTime of 5 mins. OSRAM LIGHTIFY LED RGBW Bulb with reporting interval of 5 mins.
Check-in interval is double the value of maxReportTime. SmartThings platform will ping the device after `checkInterval` seconds of inactivity in last attempt to reach the device before marking it `OFFLINE`
This gives the device twice the amount of time to respond before it is marked as offline.
Check-in interval = 12 mins
* __12min__ checkInterval
## Troubleshooting ## Troubleshooting

View File

@@ -143,9 +143,9 @@ def refresh() {
def configure() { def configure() {
log.debug "Configuring Reporting and Bindings." log.debug "Configuring Reporting and Bindings."
// Device-Watch allows 3 check-in misses from device (plus 1 min lag time) // Device-Watch allows 2 check-in misses from device + ping (plus 1 min lag time)
// enrolls with default periodic reporting until newer 5 min interval is confirmed // enrolls with default periodic reporting until newer 5 min interval is confirmed
sendEvent(name: "checkInterval", value: 3 * 10 * 60 + 1 * 60, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID]) sendEvent(name: "checkInterval", value: 2 * 10 * 60 + 1 * 60, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
// OnOff minReportTime 0 seconds, maxReportTime 5 min. Reporting interval if no activity // OnOff minReportTime 0 seconds, maxReportTime 5 min. Reporting interval if no activity
refresh() refresh()

View File

@@ -1,6 +1,6 @@
# ZigBee White Color Temperature Bulb # ZigBee White Color Temperature Bulb
Cloud Execution
Works with: Works with:
@@ -25,11 +25,10 @@ Works with:
## Device Health ## Device Health
Zigbee Bulb with maxReportTime of 5 mins. Zigbee Bulb with reporting interval of 5 mins.
Check-in interval is double the value of maxReportTime. SmartThings platform will ping the device after `checkInterval` seconds of inactivity in last attempt to reach the device before marking it `OFFLINE`
This gives the device twice the amount of time to respond before it is marked as offline.
Enrolls with default periodic reporting until newer 5 min interval is confirmed *__12min__ checkInterval
It then enrolls the device with updated checkInterval i.e. 12 mins
## Troubleshooting ## Troubleshooting

View File

@@ -207,9 +207,9 @@ def refresh() {
def configure() { def configure() {
log.debug "Configuring Reporting and Bindings." log.debug "Configuring Reporting and Bindings."
// Device-Watch allows 3 check-in misses from device (plus 1 min lag time) // Device-Watch allows 2 check-in misses from device + ping (plus 1 min lag time)
// enrolls with default periodic reporting until newer 5 min interval is confirmed // enrolls with default periodic reporting until newer 5 min interval is confirmed
sendEvent(name: "checkInterval", value: 3 * 10 * 60 + 1 * 60, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID]) sendEvent(name: "checkInterval", value: 2 * 10 * 60 + 1 * 60, displayed: false, data: [protocol: "zigbee", hubHardwareId: device.hub.hardwareID])
refresh() + requestBindingTable(0) + ["delay 2000"] refresh() + requestBindingTable(0) + ["delay 2000"]
} }

View File

@@ -1,6 +1,6 @@
# Z-wave Dimmer # Z-wave Dimmer Switch Generic
Cloud Execution
Works with: Works with:
@@ -32,6 +32,8 @@ Not to mention after going OFFLINE when the device is plugged back in, it might
the device to appear as ONLINE again. This is because if this listening device does not respond to two poll requests in a row, the device to appear as ONLINE again. This is because if this listening device does not respond to two poll requests in a row,
it is not polled for 5 minutes by the hub. This can delay up the process of being marked ONLINE by quite some time. it is not polled for 5 minutes by the hub. This can delay up the process of being marked ONLINE by quite some time.
* __32min__ checkInterval
## Troubleshooting ## Troubleshooting
If the device doesn't pair when trying from the SmartThings mobile app, it is possible that the device is out of range. If the device doesn't pair when trying from the SmartThings mobile app, it is possible that the device is out of range.

View File

@@ -1,6 +1,6 @@
# Z-wave Switch # Z-wave Switch
Cloud Execution
Works with: Works with:
@@ -32,6 +32,8 @@ Not to mention after going OFFLINE when the device is plugged back in, it might
the device to appear as ONLINE again. This is because if this listening device does not respond to two poll requests in a row, the device to appear as ONLINE again. This is because if this listening device does not respond to two poll requests in a row,
it is not polled for 5 minutes by the hub. This can delay up the process of being marked ONLINE by quite some time. it is not polled for 5 minutes by the hub. This can delay up the process of being marked ONLINE by quite some time.
* __32min__ checkInterval
## Troubleshooting ## Troubleshooting
If the device doesn't pair when trying from the SmartThings mobile app, it is possible that the device is out of range. If the device doesn't pair when trying from the SmartThings mobile app, it is possible that the device is out of range.

View File

@@ -1,5 +1,6 @@
# Z-Wave Switch # Z-Wave Switch
Local Execution on V2 Hubs
Works with: Works with:
@@ -34,6 +35,7 @@ Not to mention after going OFFLINE when the device is plugged back in, it might
the device to appear as ONLINE again. This is because if this listening device does not respond to two poll requests in a row, the device to appear as ONLINE again. This is because if this listening device does not respond to two poll requests in a row,
it is not polled for 5 minutes by the hub. This can delay up the process of being marked ONLINE by quite some time. it is not polled for 5 minutes by the hub. This can delay up the process of being marked ONLINE by quite some time.
* __32min__ checkInterval
## Troubleshooting ## Troubleshooting