1. /**
2. *    SmartThings Lightify Dimmer Switch support
3. *    Copyright (C) 2016  Adam Outler
4. *
5. *    This program is free software: you can redistribute it and/or modify
6. *    it under the terms of the GNU General Public License as published by
7. *    the Free Software Foundation, either version 3 of the License, or
8. *    (at your option) any later version.
9. *
10. *    This program is distributed in the hope that it will be useful,
11. *    but WITHOUT ANY WARRANTY; without even the implied warranty of
12. *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13. *    GNU General Public License for more details.
14. *
15. *    You should have received a copy of the GNU General Public License
16. *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
17. *
18. */
19.  
20. /**
21. * Command reference
22. * on  'catchall: 0104 0006 01 01 0140 00 3A68 01 00 0000 01 00 '
23. * off  'catchall: 0104 0006 01 01 0140 00 3A68 01 00 0000 00 00 '
24. * held up   'catchall: 0104 0008 01 01 0140 00 3A68 01 00 0000 05 00 0032'
25. * held down  'catchall: 0104 0008 01 01 0140 00 3A68 01 00 0000 01 00 0132'
26. * released   'catchall: 0104 0008 01 01 0140 00 3A68 01 00 0000 03 00 '
27. */
28.  
29.  
30. /**
31. *sets up fingerprint for autojoin
32. *sets up commands for polling and others
33. *sets up capabilities
34. *sets up variables
35. */
36. metadata {
37.  definition(name: "Lightify Dimming Switch- Zigbee", namespace: "adamoutler", author: "Adam Amber House") {
38.   capability "Battery"
39.   capability "Button"
40.   capability "Switch Level"
41.   attribute "State Array", "string"
42.   attribute 'Awesomeness Level', "string"
43.   attribute 'state', "string"
44.   command "refresh"
45.   command "poll"
46.   command "toggle"
47.   command "configure"
48.   command "installed"
49.   fingerprint profileId: "0104", deviceId: "0001", inClusters: "0000, 0001, 0003, 0020, 0402, 0B05", outClusters: "0003, 0006, 0008, 0019", manufacturer: "OSRAM", model: "LIGHTIFY Dimming Switch", deviceJoinName: "OSRAM Lightify Dimming Switch"
50.  }
51.  
52.  
53.  simulator {
54.   // Simulations are for loosers, work in production :D
55.  }
56.  
57.  
58. preferences {
59.   section("Device1") {
60.    input("device1", "string", title: "Device Network ID 1", description: "The Device Network Id", defaultValue: "", type: "capability.switch", required: false, displayDuringSetup: false)
61.    input("end1", "string", title: "Device Endpoint ID 1", description: "endpointId from Data Section of device", defaultValue: "", required: false, displayDuringSetup: false)
62.   }
63.   section("Device2") {
64.    input("device2", "string", title: "Device Network ID 2", description: "The Device Network Id", defaultValue: "", type: "capability.switch", required: false, displayDuringSetup: false)
65.    input("end2", "string", title: "Device Endpoint ID 2", description: "endpointId from Data Section of device", defaultValue: "", required: false, displayDuringSetup: false)
66.   }
67.   section("Device3") {
68.    input("device3", "string", title: "Device Network ID 3", description: "The Device Network Id", defaultValue: "", type: "capability.switch", required: false, displayDuringSetup: false)
69.    input("end3", "string", title: "Device Endpoint ID 3", description: "endpointId from Data Section of device", defaultValue: "", required: false, displayDuringSetup: false)
70.   }
71.   section("Device4") {
72.    input("device4", "string", title: "Device Network ID 4", description: "The Device Network Id", defaultValue: "", type: "capability.switch", required: false, displayDuringSetup: false)
73.    input("end4", "string", title: "Device Endpoint ID 4", description: "endpointId from Data Section of device", defaultValue: "", required: false, displayDuringSetup: false)
74.   }
75.   section("Device5") {
76.    input("device5", "string", title: "Device Network ID 5", description: "The Device Network Id", defaultValue: "", type: "capability.switch", required: false, displayDuringSetup: false)
77.    input("end5", "string", title: "Device Endpoint ID 5", description: "endpointId from Data Section of device", defaultValue: "", required: false, displayDuringSetup: false)
78.   }
79.  }
80.  
81.  
82. /**
83. *UI tile definitions
84. */
85.  tiles(scale: 2) {
86.   standardTile("button", "device.state", width: 6, height: 4) {
87.    state "off", label: 'Off', action: "toggle", icon: "st.switches.switch.off", backgroundColor: "#ffffff", nextState: "turningOn"
88.    state "on", label: "On", action: "toggle", icon: "st.switches.switch.on", backgroundColor: "#79b821", nextState: "turningOff"
89.    state "turningOn", label: 'Turning on', icon: "st.switches.switch.on", backgroundColor: "#79b821", nextState: "turningOff"
90.    state "turningOff", label: 'Turning off', icon: "st.switches.switch.off", backgroundColor: "#ffffff", nextState: "turningOn"
91.   }
92.   valueTile("battery", "device.battery", decoration: "flat", inactiveLabel: false, width: 2, height: 2) {
93.    state "battery", label: 'battery ${currentValue}%'
94.   }
95.   valueTile("brightness", "device.level", decoration: "flat", inactiveLabel: false, width: 2, height: 2) {
96.    state "brightness", label: 'brightnessn${currentValue}%'
97.   }
98.   standardTile("refresh", "device.button", decoration: "flat", width: 2, height: 2) {
99.    state "default", label: "", action: "refresh", icon: "st.secondary.refresh"
100.   }
101.   controlTile("levelSliderControl", "device.level", "slider", height: 2, width: 6, inactiveLabel: false, range:"(1..100)") {
102.     state "level", action:"setLevel"
103.   }
104.   main "button"
105.   details(["button", "levelSliderControl", "switch", "battery", "brightness", "refresh"])
106.  }
107. }
108.  
109. /**
110. *returns a map representing important states
111. */
112. private Map getStatus() {
113.  return [name: 'button',
114.   brightness: state.brightness,
115.   battery: state.battery,
116.   value: state.value,
117.   level: state.level,
118.   lastAction: state.lastAction,
119.   on: state.on,
120.   data: '',
121.   descriptionText: "$device.displayName button $state.buttonNumber was $value"
122.  ]
123. }
124.  
125.  
126. /**
127.  *Gets a list of devices in [address,endpoint] format compiled from inputs above
128.  *returns: Arraylist<[address,endpoint]>
129.  */
130. final ArrayList < String[] > getDevices() {
131.  String[] devs = [settings.device1, device2, device3, device4, device5]
132.  if (devs == [null, null, null, null, null]) log.info("------No devices configured in $device preferences--------")
133.  String[] ends = [end1, end2, end3, end4, end5]
134.  ArrayList < String[] > list = new ArrayList < > ([])
135.  for (int i = 0; i < 4; i++) {
136.   if (devs[i] != null) {
137.    list.add([devs[i], ends[i]])
138.   }
139.  }
140.  return list
141. }
142.  
143. /**
144. *Parse events into attributes.
145. */
146. def parse(String msgFromST) {
147.  log.debug(msgFromST)
148.  if (msgFromST?.startsWith('catchall:')) {
149.   def value = handleMessage(msgFromST)
150.   fireCommands(value.command)
151.  } else if (msgFromST.startsWith("read")) {
152.   if (msgFromST.contains("attrId: 0000")) return state
153.   if (msgFromST.contains("attrId: 0020,")) return batteryHandler(zigbee.parseDescriptionAsMap(msgFromST))
154.   log.error('unrecognized command:' + msgFromST)
155.  } else {
156.   log.error('unrecognized command:' + msgFromST)
157.  }
158.  return getStatus()
159. }
160.  
161.  
162. /**
163. *fire commands into the hub
164. *commands - an array of string commands to be fired
165. */
166. private fireCommands(List commands) {
167.  
168.  
169.   if (commands != null && commands.size() > 0) {
170.   log.trace("Executing commands-- state:" + state + " commands:" + commands)
171.   for (String value : commands){
172.    sendHubCommand([value].collect {new physicalgraph.device.HubAction(it)
173.   })
174.   }
175.  }
176. }
177.  
178.  
179. Map handleMessage(String msgFromST) {
180.  Map msg = zigbee.parseDescriptionAsMap(msgFromST)
181.  switch (Integer.parseInt(msg.clusterId)) {
182.   case 6: //button press
183.    def returnval = handleButtonPress(msg)
184.    return returnval
185.    break
186.   case 8:
187.    handleButtonHeld(msg)
188.    break
189.   case 8021:
190.    log.info("Networking Bind Response received!!!")
191.    updateButtonState("Network binding complete!")
192.    state.boundnetwork=true
193.    return state
194.    break
195.   case 8034:
196.    log.info("Network managment Leave Response!!!")
197.    state.boundnetwork=false
198.    return state
199.    break
200.   default:
201.    log.error("Unhandled message: " + msg)
202.    break
203.  }
204. }
205.  
206.  
207. /**
208. * This is the handler for button presses.  Map is routed here once a button press has been detected
209. */
210. def Map handleButtonPress(Map msg) {
211.  switch (msg.command) {
212.   case "01":
213.    def returnval = on()
214.    updateButtonState("on")
215.    return returnval
216.    break
217.   case "03":
218.    bothButtonsPressed()
219.    break
220.   case "00":
221.    def returnval = off()
222.    updateButtonState("off")
223.    return returnval
224.    break
225.   case "07":
226.    log.info("Button Press Bind Response!!!")
227.    state.boundonoff=true
228.    return state
229.   break
230.   default:
231.    log.error(getLinkText(device)+" got unknown button press command: " + msg.command)
232.    return [name:"error",value:"unknown button press command"]
233.    break
234.  }
235. }
236.  
237. /**
238. *this is the handler for button held events. Map is routed here once a button held event has been detected
239. */
240. def Map handleButtonHeld(Map msg) {
241.  switch (Integer.parseInt(msg.command)) {
242.   case 1:
243.    log.debug("Button held- Lowering brightness commanded")
244.    state.dimming = true
245.    updateButtonState("lowering brightness")
246.    state.lastHeld = "down"
247.    return adjustBrightness(false, state.brightness)
248.    break
249.   case 3:
250.    log.debug("stop brightness commanded")
251.    updateButtonState(state.lastHeld + " released")
252.    state.dimming = false
253.    return state
254.    break
255.   case 5:
256.    log.debug("Button held- raising brightness commanded")
257.    state.lastHeld = "up"
258.    updateButtonState("raising brightness")
259.    state.dimming = true
260.    return adjustBrightness(true, state.brightness)
261.    break
262.   case 7:
263.    log.info("Button Held Bind Response - 7!!!")
264.    state.bounddimmer=true
265.    return state
266.   break
267.   case 8:
268.    log.info("Button Held Bind Response - 8!!!")
269.    state.bounddimmer=true
270.   return state
271.   break
272.   default:
273.    log.error("Unhandled button held event: " + msg)
274.    break
275.  }
276.  return msg
277. }
278.  
279.  
280. /**
281.  * adjusts brightness up/down depending on the value of the up boolean true is up, false is down
282.  * continues to adjust until state.dimming is changed
283.  * up- true if we are adjusting brightness up, false if down
284.  * level - first level commanded
285.  */
286. def Map adjustBrightness(final boolean up, double level) {
287.  Map result
288.  log.debug("adjusting brightness" + (up?"up" : "down") + " from current " + state.brightness)
289.  if (state.dimming) {
290.   //increase or decrease brightness
291.   if (up) {
292.    state.brightening = true
293.   } else {
294.    state.brightening = false
295.   }
296.   state.brightness = (int) level
297.   executeBrightnessAdjustmentUntilButtonReleased()
298.  } else {
299.   log.debug("Final brightness adjusted to " + state.brightness)
300.  }
301.  
302.  sendEvent(name: "brightness", value: state.brightness)
303.  return getStatus()
304. }
305.  
306. /**
307.  * performs a recursive brightness adjustment based on state.brightening while state.dimming is true
308.  */
309. void executeBrightnessAdjustmentUntilButtonReleased() {
310.  if (state.dimming) {
311.   if (state.brightening) {
312.    state.brightness = state.brightness + 20
313.   } else {
314.    state.brightness = state.brightness - 20
315.   }
316.   if (state.brightness > 100) {
317.    state.brightness = 100
318.    state.dimming=false
319.   }
320.   if (state.brightness < 1){
321.    state.brightness = 1
322.    state.dimming=false
323.   }
324.   setLevel((double) state.brightness, 1000)
325.   reportOnState(true) //Manage and report states
326.   runIn(1, executeBrightnessAdjustmentUntilButtonReleased)
327.  }
328. }
329.  
330.  
331. /**
332. * gets the current brightness in hex format
333. * length - the length of the number after leading 0's have been applied.  This will likely be "2"
334. */
335. String getBrightnessHex(int length) {
336.  StringBuilder sb = new StringBuilder(Integer.toHexString((Integer) Math.round(state.brightness * 2.55)))
337.  if (sb.size() > length) return sb.toString()
338.  for (int i = sb.size(); i < length; i++) {
339.   sb.insert(0, '0')
340.  }
341.  return sb.toString()
342. }
343.  
344. /**
345. *formats a decimal value with leading 0's
346. *value - the value to be formatted
347. *length - the size of the number after leading 0's have been added
348. */
349. String formatNumber(int value, int length) {
350.  return String.format("%" + length + "d", value);
351. }
352.  
353. /**
354. *performs configuration and bindings
355. */
356. def configure() {
357.  if (state.boundnetwork && state.bounddimmer && state.boundonoff){
358.   log.debug("configuration complete")
359.   sendEvent(name:"Configured", value:"true")
360.   return
361.  }
362.  log.debug "Confuguring Reporting and Bindings."
363.  fireCommands(zigbee.onOffConfig() + zigbee.levelConfig() + zigbee.onOffRefresh() + zigbee.levelRefresh() + zigbee.readAttribute(0x0001, 0x0020))
364.  configureDaemon()
365.  return configCmds
366. }
367.  
368. /*
369. * handles binding if switch doesn't pay attention the first time.
370. */
371. def configureDaemon(){
372.   return runIn(8, "configure")
373. }
374.  
375.  
376.  
377. def mySleep(int ms) {
378.         def start = now()
379.         while (now() < start + ms) {
380.     }
381. }
382.  
383.  
384. /**
385. *Refresh support.  Causes battery status update and others
386. */
387. def refresh() {
388.    fireCommands(zigbee.readAttribute(0x0001, 0x0020) +zigbee.onOffRefresh() + zigbee.levelRefresh() + zigbee.onOffConfig() + zigbee.levelConfig() + zigbee.readAttribute(0x0001, 0x0020) )
389. }
390.  
391.  
392. /**
393. *actions to be taken once the device is installed
394. */
395.  
396. def installed() {
397.  log.info(device.name + " installed!!!")
398.  sendEvent(name:"Configured", value:"false")
399.  state.boundnetwork=false
400.  state.bounddimmer=false
401.  state.boundonoff=false
402.  state.on = false
403.  state.lastAction = 0
404.  state.brightness = 0
405.  state.buttonNumber = 1
406.  state.value = "unknown"
407.  state.lastHeld = "none"
408.  state.battery = 100
409.  state.dimming = false
410.  return reportOnState(getOnState())
411. }
412.  
413. def updated(){
414.  log.info("updated")
415.  return  refresh()
416. }
417.  
418.  
419.  
420. /**
421. *handles battery messages
422. */
423. private Map batteryHandler(Map rawValue) {
424.   int value = Integer.valueOf(rawValue.value, 16)
425.   def linkText = getLinkText(device)
426.   def result = [ name: 'battery', value: state.battery ]
427.   def volts = Integer.valueOf(rawValue.value, 16) / 10
428.   def descriptionText
429.   if (rawValue == 0) {
430.    state.battery = "unknown"
431.   } else {
432.    if (volts > 3.5) {
433.     result.descriptionText = "${linkText} battery has too much power (${volts} volts)."
434.     state.battery = "overvoltage"
435.    } else if (volts > 0) {
436.     def minVolts = 2.1
437.     def maxVolts = 3.0
438.     def pct = (volts - minVolts) / (maxVolts - minVolts)
439.     state.battery = Math.min(100, (int) pct * 100)
440.     result.battery = state.battery
441.     result.descriptionText = "${linkText} battery was ${result.value}%"
442.    }
443.   }
444.   sendEvent(name: 'battery', value: state.battery, units: "%")
445.   log.debug "${result?.descriptionText}"
446.   return result
447.  }
448.  
449.  
450.  /**
451.   * handle level commands,
452.   * level=desired level
453.   * duration=desired time-to-level
454.   */
455. def setLevel(Double level, Double duration) {
456.  if (level > 100 || level < 0 || duration < 0 || duration > 9999) {
457.   log.debug("Maximum parameters (level 0-100, duration 0-9999)-- commanded level:" + level + " commanded duration:" + duration)
458.   return
459.  }
460.  log.info("Brightness commanded to " + level + "%")
461.  state.brightness = (int) level
462.  def result = createStCommand(" 8 4 {" + getBrightnessHex(2) + " " + formatNumber((int) duration, 4) + "}")
463.  if (state.on != "on") on()
464.  fireCommands(result.command) //send it to the hub for processing
465.  reportOnState(true)
466. }
467.  
468. /**
469. *sets level using a 1-second duration
470. *level= percent
471. */
472. def setLevel(Double level) {
473.  setLevel(level, 1000)
474. }
475.  
476. /**
477. * Returns true if the switch is on.  false if off.
478. */
479. Boolean getOnState(){
480.     return (state.on == "on")
481. }
482.  
483. /**
484. *poll support, forces an update of states
485. */
486. def poll() {
487.  sendEvent(name: 'brightness', value: state.brightness, units: "%")
488.  reportOnState(getOnState())
489. }
490.  
491. /**
492. *takes a command and data, generates an "st cmd" array
493. *command- string representing the command and data to be send to the device
494. *returns the command for all devices on the switch
495. */
496. def Map createStCommand(String command) {
497.  List<String> output = []
498.  LinkedHashMap result = getStatus()
499.  for (item in getDevices()) {
500.   output.add("st cmd 0x" + item[0] + " 0x" + item[1] + " " + command)
501.  }
502.  result['command'] = (List)output.flatten()
503.  return result
504. }
505.  
506. /**
507.  * Handles event updates.  All updates go here.
508.  */
509. def reportOnState(boolean on) {
510.  String onValue = (on ? "on" : "off")
511.  sendEvent(name: 'state', type:"thing", value:onValue)
512.  sendEvent(name: 'battery', value: state.battery)
513.  sendEvent(name: 'level', value: state.brightness)
514.  sendEvent(name: 'button', value: state.value)
515.  sendEvent(name: 'numberOfButtons', value: 5)
516.  sendEvent(name: 'State Array', value: state)
517.  sendEvent(name: 'Awesomeness Level', value: "over 9000")
518.  
519.  state.on = onValue
520. }
521.  
522. def updateButtonState(def value) {
523.  state.value = value
524.  sendEvent(name: "button", value: value, unit: "")
525. }
526.  
527. /**
528. *commands the opposite of the current state
529. *if on, turn off, if off, turn on.
530. */
531. def toggle() {
532.  Map command
533.  if (state.on == "on") {
534.   log.debug(device.displayName + " toggled on")
535.   command = off()
536.  } else {
537.   command = on()
538.   log.debug(device.displayName + " toggled off")
539.  }
540.  log.debug(command)
541.  fireCommands(command.command)
542. }
543.  
544. /**
545. *detects the current state versus commanded
546. *if curret is off, and commanded is off, returns true and same for inverse
547. */
548. boolean doubleTapped(boolean commanded) {
549.  boolean on=(state.on=="on")
550.  if (on && commanded|| !on && !commanded) return true
551.  return false
552. }
553.  
554. /**
555. *This switch does not support pressing the same button in rapid sucession
556. *this check finds out if user tapped one button and then the other within 1.5 seconds.
557. */
558. boolean onOffTapped(){
559.  return (state.lastAction < now()+1500)
560. }
561.  
562. //TODO create a up-down tapped mechanism.
563.  
564.  
565. /**
566. *turns light on.
567. *if already on, commands max
568. */
569. Map on() {
570.  log.debug(device.displayName + " commanded on" )
571.  if (onOffTapped){
572.    
573.  }
574.  state.lastAction=now()
575.  if (doubleTapped(true)) setLevel(100, 1000)
576.  reportOnState(true)
577.  return createStCommand("6 1 {}")
578. }
579.  
580. /**
581. *turns light off
582. *if already off, commands on to minimum
583. */
584. Map off() {
585.  log.debug(device.displayName + " commanded off")
586.  if (onOffTapped){
587.    
588.  }
589.  state.lastAction=now()
590.  if (doubleTapped(false)){
591.     def value=on()
592.     setLevel(1, 1000)
593.     return value
594.  }
595.  reportOnState(false)
596.  return createStCommand("6 0 {}")
597. }
598.  
599.  
600. /**
601. *Action to be taken when both buttons are pressed at the same time
602. */
603. def bothButtonsPressed() {
604.  log.error("Both Buttons Pressed" + state)
605.  installed()
606.  state.lastAction = 100
607.  updateButtonState("Initiating configuration routines.  Please stand by.")
608.  configure()
609.  return state
610. }