-
Notifications
You must be signed in to change notification settings - Fork 1
/
sage_light_switch.groovy
428 lines (328 loc) · 15.5 KB
/
sage_light_switch.groovy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
/**
* SAGE Light Switch
Presence and bat support
Hubitat driver. 206611
FCC ID :DKN-301LM
Adds battery support (simlated) if stops reporting bat goes to 0
If device keeps sending 0000 0006 pings switch to internal driver
and use config option then switch back.
Help is needed do you know the command to stop the above?
Factory reset:
Hold down ON while inserting battery it will start flashing red
================================================================================
v2.8.4 12/20/2022 bug fix in ident cluster
v2.8.3 11/22/2022 bug fix cluster 0013
v2.8.2 11/12/2022 Another bug fix for presence
v2.8.0 11/11/2022 Presence Upgraded with retries
v2.7.1 11/05/2022 added schedule options
v2.7.0 11/04/2022 Imported Sage doorbell code and modified into a switch
v2.6.0 10/30/2022 Presence Bug Fix Was not warning first
Copyright [2022] [tmaster winnfreenet.com]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
uses some source code from.
https://github.com/trunzoc/Hubitat/blob/master/Drivers/Sage_Doorbell/Sage_Doorbell.groovy (11/27/2019)
https://github.com/rbaldwi3/Sage-HVAC-Sensor/edit/master/groovy
*/
import hubitat.zigbee.clusters.iaszone.ZoneStatus
import hubitat.zigbee.zcl.DataType
import hubitat.helper.HexUtils
def clientVersion() {
TheVersion="2.8.4"
if (state.version != TheVersion){
state.version = TheVersion
configure() // Forces config on updates
}
}
metadata {
definition (name: "Sage light switch echostar", namespace: "tmastersmart", author: "Tmaster", importUrl: "https://raw.githubusercontent.com/tmastersmart/hubitat-code/main/sage_light_switch.groovy") {
capability "Configuration"
capability "Pushable Button"
capability "ReleasableButton"
capability "Refresh"
capability "Battery"
capability "PresenceSensor"
capability "Actuator"
capability "Switch"
command "checkPresence"
command "uninstall"
fingerprint model:" Switch", manufacturer:" Echostar", profileId:"0104", endpointId:"12", inClusters:"0000,0003,0009,0001", outClusters:"0003,0006,0008,0019", application:"02"
}
preferences {
input name: "infoLogging", type: "bool", title: "Enable info logging", description: "Recomended low level" ,defaultValue: true,required: true
input name: "debugLogging", type: "bool", title: "Enable debug logging", description: "MED level Debug" ,defaultValue: false,required: true
input name: "traceLogging", type: "bool", title: "Enable trace logging", description: "Insane HIGH level", defaultValue: false,required: true
input name: "pollYes",type: "bool", title: "Enable Presence", description: "", defaultValue: true,required: true
input name: "pollHR" ,type: "enum", title: "Check Presence Hours",description: "Press config after saving",options: ["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20"], defaultValue: 15 ,required: true
}
}
def installed() {
logging("Paired!", "info")
configure()
updated()
runIn(20,refresh)
}
def uninstall() {
unschedule()
state.remove("lastCheckInMin")
state.remove("lastCheckin")
state.remove("timeBetweenPresses")
state.remove("lastButton2Updated")
state.remove("lastButton1Updated")
state.remove("version")
device.deleteCurrentState("presence")
device.deleteCurrentState("battery")
removeDataValue("presence")
removeDataValue("battery")
}
def updated(){
loggingUpdate()
clientVersion()
}
def configure() {
state.remove("ignore01")
state.remove("ignore00")
state.remove("lastButton1Updated")
state.remove("lastButton2Updated")
// removeDataValue("softwareBuild")//00000009
// removeDataValue("firmwareMT")//1014-0002-00000009
getIcons()
unschedule()
if (pollYes){
randomSixty = Math.abs(new Random().nextInt() % 60)
randomSixty2 = Math.abs(new Random().nextInt() % 60)
randomTwentyFour = Math.abs(new Random().nextInt() % 24)
logging("CHRON: ${randomSixty2} ${randomSixty} ${randomTwentyFour}/${pollHR} * * ? *", "debug")
schedule("${randomSixty2} ${randomSixty} ${randomTwentyFour}/${pollHR} * * ? *", checkPresence)
logging("Presence Check Every ${pollHR}hrs starting at ${randomTwentyFour}:${randomSixty}:${randomSixty2} ", "info")
}
buttons = device.currentValue("numberOfButtons")
if (buttons != 2){sendEvent(name: "numberOfButtons", value: 2, displayed: true)}
if(!timeBetweenPresses){timeBetweenPresses = 10}
String zigbeeEui = swapEndianHex(device.hub.zigbeeEui)
logging("Configure", "info")
sendEvent(name: "battery", value: 90, unit: "%",descriptionText:"Simulated ${state.version}", isStateChange: true)
delayBetween([
sendZigbeeCommands(["zcl global write 0x500 0x10 0xf0 {${zigbeeEui}}"]),
sendZigbeeCommands(["send 0x${device.deviceNetworkId} 1 1"]),
sendZigbeeCommands(["zdo bind 0x${device.deviceNetworkId} ${endpointId} 1 1 {${device.zigbeeId}} {}"]),
sendZigbeeCommands(["zcl global send-me-a-report 1 0x20 0x20 30 21600 {01}"]), //checkin time 6 hrs
sendZigbeeCommands(["send 0x${device.deviceNetworkId} 1 1"]),
sendZigbeeCommands(["zdo bind 0x${device.deviceNetworkId} ${endpointId} 1 0x402 {${device.zigbeeId}} {}"]),
sendZigbeeCommands(["zcl global send-me-a-report 0x402 0 0x29 30 21600 {6400}"]), //checkin time 6 hrs
// sendZigbeeCommands(["zcl global send-me-a-report 0x402 0 0x29 30 3600 {6400}"]),
sendZigbeeCommands(["send 0x${device.deviceNetworkId} 1 1"]),
sendZigbeeCommands(zigbee.enrollResponse())
], 1000)
// “send-me-a-report” cluster, attribute, data type, min report, max report,
runIn(8,refresh)
}
def checkPresence() {
// presence routine. v5.1 11-12-22
// simulated 0% battery detection
if(!state.tries){state.tries = 0}
state.lastPoll = new Date().format('MM/dd/yyyy h:mm a',location.timeZone)
def checkMin = 2800
def timeSinceLastCheckin = (now() - state.lastCheckin ?: 0) / 1000
def theCheckInterval = (checkInterval ? checkInterval as int : 2) * 60
state.lastCheckInMin = timeSinceLastCheckin/60
logging("Check Presence its been ${state.lastCheckInMin} mins Timeout:${checkMin} Tries:${state.tries}","debug")
if (state.lastCheckInMin <= checkMin){
state.tries = 0
test = device.currentValue("presence")
if (test != "present"){
value = "present"
logging("Creating presence event: ${value} ","info")
sendEvent(name:"presence",value: value , descriptionText:"${value} ${state.version}", isStateChange: true)
sendEvent(name: "battery", value: 90, unit: "%",descriptionText:"Simulated ${state.version}", isStateChange: true)
return
}
}
if (state.lastCheckInMin >= checkMin) {
state.tries = state.tries + 1
if (state.tries >=5){
test = device.currentValue("presence")
if (test != "not present" ){
value = "not present"
logging("Creating presence event: ${value}","warn")
sendEvent(name:"presence",value: value , descriptionText:"${value} ${state.version}", isStateChange: true)
sendEvent(name: "battery", value: 0, unit: "%",descriptionText:"Simulated ${state.version}", isStateChange: true)
return // we dont want a ping after this or it could toggle
}
}
runIn(2,ping)
if (state.tries <4){
logging("Recovery in process Last checkin ${state.lastCheckInMin} min ago ","warn")
runIn(50,checkPresence)
}
}
}
// parse =====================================================
def parse(String description) {
state.lastCheckin = now()
checkPresence()
logging("Raw [${description}]", "trace")
Map descMap = zigbee.parseDescriptionAsMap(description)
logging("Map :${descMap}", "trace")
logging("profileId:${descMap.profileId} clusterId:${descMap.clusterId} clusterInt:${descMap.clusterInt} sourceEndpoint${descMap.sourceEndpoint} destinationEndpoint${descMap.destinationEndpoint} options:${descMap.options} command:${descMap.command} data:${descMap.data}", "trace")
if (description?.startsWith('enroll request')) {
// enrollResponse()
zigbee.enrollResponse()
return
}
if (descMap.clusterId){descMap.cluster = descMap.clusterId} // fix for 2 formats
//profileId:0104 clusterId:0006 clusterInt:6 sourceEndpoint12 destinationEndpoint01 options:0040 command:00 data:[]
if (descMap.clusterId == "0006" && descMap.profileId == "0104" ){
logging("Action ${descMap.command}", "debug")
if (descMap.command == "01" ){
push(1)
on()
}
if (descMap.command == "00" ){
push(2)
off()
}
//}else if (descMap.cluster == "0001" && descMap.attrId == "0020") {//Power configuration
// battery = Integer.parseInt(descMap.value, 16)
// logging("Battery: is TRUE", "info")
// logging("${descMap}", "warn")
// device does not support battery cluster
}else if (descMap.cluster == "0000"){
// model Identifier Was pinging us with this.
if (descMap.clusterId == "0006" ){
logging("Cluster 0000 id:0006 ${descMap}", "warn")
zigbee.enrollResponse()
}
if (descMap.attrId== "0001" ){
logging("Application ID :${descMap.value}", "debug")
// should be 0x0104=Home Automation
}
if( descMap.attrId == "0004") {
logging("Manufacturer:${descMap.value} ", "debug")
state.MFR = descMap.value
updateDataValue("manufacturer", descMap.value)
}
if (descMap.attrId == "0005") {
logging("Device:${descMap.value} ", "debug")
state.model = descMap.value
state.DataUpdate = true
updateDataValue("device", descMap.value)
updateDataValue("partNo", "206611")
updateDataValue("model", "SWITCH")
updateDataValue("fcc", "DKN-301LM")
}
}else if (descMap.cluster == "8032" ||descMap.cluster == "8031" || descMap.cluster == "8021" ||descMap.cluster == "0500" || descMap.cluster == "0000" ||descMap.cluster == "0001" ||descMap.cluster == "0013" || descMap.cluster == "0402" || descMap.cluster == "8038" || descMap.cluster == "8005") {
text= "unknown"
if (descMap.cluster =="8001"){text="GENERAL"}
else if (descMap.cluster =="8021"){text="BIND RESPONSE"}
else if (descMap.cluster =="8031"){text="Link Quality"}
else if (descMap.cluster =="8032"){text="Routing Table"}
if (descMap.data){text ="${text} clusterInt:${descMap.clusterInt} command:${descMap.command} options:${descMap.options} data:${descMap.data}" }
logging("Ignoring ${descMap.cluster} ${text}", "debug")
}else if (descMap.cluster == "0013") {
logging("cluster:${descMap.cluster} 0013 Responding to Enroll Request. Likely Battery Change", "info")
zigbee.enrollResponse()
}else if (descMap.cluster == "0006") {
logging("cluster:${descMap.cluster} 0006 Seen after a Enroll Request. Unknown", "debug")
zigbee.enrollResponse()
} else{logging("New unknown Cluster${descMap.cluster} Detected: ${descMap}", "warn")}// report to dev
}
def push(cmd){
if (cmd ==1){ Name = "on"}
if (cmd ==2){ Name = "off"}
logging("${Name} button ${cmd} Pressed!", "info")
sendEvent(name: "pushed", value: cmd, isStateChange: true,descriptionText:"${Name} button Pressed! ${state.version}")
}
def on(){
Test = device.currentValue("switch")
logging("Switch On our State:${Test}", "debug")
if(Test != "on"){
logging("Switch On", "info")
sendEvent(name: "switch", value: "on" , isStateChange: true,descriptionText:"Virtual Switch ON ${state.version}")
}
}
def off(){
Test = device.currentValue("switch")
logging("Switch Off our State:${Test}", "debug")
if(Test != "off"){
logging("Switch Off", "info")
sendEvent(name: "switch", value: "off" , isStateChange: true,descriptionText:"Virtual Switch OFF ${state.version}")
}
}
def refresh() {
if(state.DataUpdate){ logging("Refreshing ${state.MFR} ${state.model} Ver:${state.version}", "info")}
else {logging("Refreshing -unknown device- Ver:${state.version}", "info")}
delayBetween([
sendZigbeeCommands(zigbee.readAttribute(0x0000, 0x0004)),// mf
sendZigbeeCommands(zigbee.readAttribute(0x0000, 0x0005)),// model
// sendZigbeeCommands(zigbee.readAttribute(0x0402, 0x0000)),// temp
// sendZigbeeCommands(zigbee.readAttribute(0x0001, 0x0020)),// battery not supported
// sendZigbeeCommands(["he rattr 0x${device.deviceNetworkId} 18 0x0001 0x20"]), // bat
// sendZigbeeCommands(["he raw 0x${device.deviceNetworkId} 1 0x12 0x0000 {10 00 00 04 00}"]),
// sendZigbeeCommands(["he raw 0x${device.deviceNetworkId} 1 0x12 0x0000 {10 00 00 05 00}"]),
], 1000)
}
def ping() {
logging("ping", "info")
sendZigbeeCommands(zigbee.readAttribute(0x0000, 0x0005))// model
}
private getEndpointId() {
new BigInteger(device.endpointId, 16).toString()
}
private hex(value) {
new BigInteger(Math.round(value).toString()).toString(16)
}
private String swapEndianHex(String hex) {
reverseArray(hex.decodeHex()).encodeHex()
}
private byte[] reverseArray(byte[] array) {
int i = 0;
int j = array.length - 1;
byte tmp;
while (j > i) {
tmp = array[j];
array[j] = array[i];
array[i] = tmp;
j--;
i++;
}
return array
}
void sendZigbeeCommands(List<String> cmds) {
logging("Sending:${cmds}", "trace")
sendHubCommand(new hubitat.device.HubMultiAction(cmds, hubitat.device.Protocol.ZIGBEE))
}
// Logging block v3
// device.updateSetting("infoLogging",[value:"true",type:"bool"])
void loggingUpdate() {
logging("Logging Info:[${infoLogging}] Debug:[${debugLogging}] Trace:[${traceLogging}]", "infoBypass")
// Only do this when its needed
if (debugLogging){runIn(3600,debugLogOff)}
if (traceLogging){runIn(1800,traceLogOff)}
}
void traceLogOff(){
device.updateSetting("traceLogging",[value:"false",type:"bool"])
log.trace "${device} : Trace Logging : Automatically Disabled"
}
void debugLogOff(){
device.updateSetting("debugLogging",[value:"false",type:"bool"])
log.debug "${device} : Debug Logging : Automatically Disabled"
}
private logging(String message, String level) {
if (level == "infoBypass"){log.info "${device} : $message"}
if (level == "error"){ log.error "${device} : $message"}
if (level == "warn") { log.warn "${device} : $message"}
if (level == "trace" && traceLogging) {log.trace "${device} : $message"}
if (level == "debug" && debugLogging) {log.debug "${device} : $message"}
if (level == "info" && infoLogging) {log.info "${device} : $message"}
}
void getIcons(){
state.donate="<a href='https://www.paypal.com/paypalme/tmastersat?locale.x=en_US'><img src='https://raw.githubusercontent.com/tmastersmart/hubitat-code/main/images/paypal2.gif'></a>"
}