RELEASE: OSRAM Lightify Smart Dimmer Switch (button controller device handler and smart app)

osram
dth_remotes
dth_lighting

(Michael) #1

Has anyone looked at the OSRAM Lightify Dimming Switch shown below? I have one and it pairs with the ST hub but it has no functions defined and only shows up as “Thing”. I am fairly new to ST especially when it comes to custom device types but I am willing to take a stab at it if I can figure out what is needed. Any pointers to creating a device type for something like this would help, or if someone else has already played around with this and has something that would work that would be nice as well.

I am also curious if anyone has any other on/off/dimmer controllers that work with ST they would recommend. I only need to use the switch for standard dimmable LED bulbs and don’t need any kind of color control.

EDIT: I have created (thanks to some great tips from @Sticks18 and @JDRoberts) a device handler to allow this device to work with ST, you can get the code from the GitHub site linked below. The device handler will create events for a each button press as well as events for holding each button as opposed to pressing, there is also an event for the release of the button after holding. I also added a battery monitor tile to the handler so you can keep tabs on the battery life. There is also a smart app linked below which can be used with the device type although you can also use the device type with other smart apps that utilize button events. My smart app is very simple and allows you to use the short presses as on/off and the long presses for 2 specific light levels which you can configure during app setup.

For those that are new to using custom device code and smart apps please see the thread below which is a very good writeup of how to get started, the link to the IDE referenced where you add the custom code is https://graph.api.smartthings.com/login/auth

For those of you that are looking to control zigbee lights only and want fast, local processing please see the thread below by @adamoutler. He has taken the device type further and made it use Zigbee commands to directly control zigbee dimmable lights which allows true dimming instead of just set values for the button hold events and it attempts to replicate all of the Lightify functionality within ST. The bulbs I use are Z-wave so I have not done any testing on this but if you are using zigbee only lights with these switches I suggest you check it out. No smart app is needed with the below device type since the device handler controls the devices directly.


Osram Lightify Switch (Not the Osram Dimming Switch)
Anyone seen this new two button wallmount?
Smart Lighting App for Sylvania Dimmer Switch (73743)?
Sylvania LIGHTIFY 74099 ZigBee 4-button switch
Osram Lightify Switch (Not the Osram Dimming Switch)
FAQ: Full list of buttons and remotes confirmed to work with SmartThings
Centralite 3 series smart switch 3130
Osram/Sylvania Lightify (it works)
FAQ: Philips Hue and Other Smart Bulbs - What sort of light switches to use with them? (Long FAQ)
Iris Smart Fob 3450L (2nd generation)
[Alpha] Lutron Connected Bulb Remote
Lowes website
Configuring OSRAM dimmer to control Leviton lamp module
[RELEASE] OSRAM Lightify Dimmer Switch Device Type - use as Switch, not buttons
RELEASE: OSRAM Lightify Smart Dimming Switch(Ultra-fast Zigbee Handler, No Smart App)
FAQ: Sylvania battery-power dimming Switch (model 73743): why there are three different DTHs to choose from
IKEA Trådfri
Just a Button? 1 button, nothing more fancy?
Neutral Wiring Capable?
(Scott G) #2

It’s most likely very similar to the Hue Dimmer Switch. I wrote a device handler for that remote, but unfortunately it doesn’t maintain its connection to ST. Maybe this one will work better.

The linked post has the Github link for that code and I added a lot of comments to the code that explain what I was doing. You’ll want to trigger the configure() method as that’ll be the key to getting it to send messages to ST.

Then you’ll have to use live logging to track what messages it sends for each type of button press and modify the code to react to those instead of the ones I was capturing.


(Michael) #3

Thanks @Sticks18 , I will take a look at that and report here when I have anything interesting to report.

So far I have logged the join session and got the fingerprint but am somewhat lost beyond that. I am a programmer by day so I shouldn’t have much issue picking up on it once I spend some time on it and I am sure your example should be enough to get me going.

I have a Hue Dimmer switch as well but have left that connected to my Hue hub since it was already programmed to control a set of lights and it worked well. I like these OSRAM switches because they are designed to be placed over top of an existing switch that you have converted to HA control and don’t want the switch turned off. Unfortunately in my house I don’t have common available at the switches so I have to use in-wall relays and connected bulbs.


(Scott G) #4

If you post up the fingerprint, I might be able to add some additional pointers or at least confirm that the Hue Switch is the right template.


(Michael) #5

This is what you need right? I converted the below logs to the fingerprint line also below.

c16f1a9b-f899-41f5-b234-76a1a79746ee 5:50:55 PM: trace NON-HUE EVENT desc: 01 0104 0001 00 06 0000 0001 0003 0020 0402 0B05 04 0003 0006 0008 0019 c16f1a9b-f899-41f5-b234-76a1a79746ee 5:50:55 PM: trace Location: desc: 01 0104 0001 00 06 0000 0001 0003 0020 0402 0B05 04 0003 0006 0008 0019 c16f1a9b-f899-41f5-b234-76a1a79746ee 5:50:54 PM: trace NON-HUE EVENT ep_cnt:1, ep:01 c16f1a9b-f899-41f5-b234-76a1a79746ee 5:50:54 PM: trace Location: ep_cnt:1, ep:01

fingerprint profileId: “0104”, deviceId: “0001”, inClusters: “0000, 0001, 0003, 0020, 0402, 0B05”, outClusters: “0003, 0006, 0008, 0019”, manufacturer: “OSRAM”, model: “Lightify 2.4GHZZB/SWITCH/LFY”, deviceJoinName: “OSRAM Lightify Dimming Switch”

Seems to be a bit different by looking at the fingerprint you have in your code.


(Scott G) #6

The core functionality will be the same and come from the 0006 and 0008 out clusters which will send the on/off/dim commands. The binding in the Hue configure section should make sure ST gets copied on those commands similar to the Hue.

What’s different and cool is this switch actually has some useful in clusters. Good chance it will stay connected. Only one of the in clusters will be configured. 0402 is temperature measurement, so this switch should have a temp sensor. Check out the Smartsense motion sensor code for examples of incorporating temp reporting and parsing.

I have high hopes for this switch.


(Michael) #7

Ok, I am currently looking through your example and trying to understand what all is going on, once I do that I will look into the temperature sensor. I would be surprised if it does has a temperature sensor as the docs say nothing about that and there is virtually nothing on the board, I only see 2 very small chips on a mostly blank board (other than the 2 buttons and an LED). I would think if it had temperature they would advertise that.

The one thing I can see different already though is the Hue switch has 4 physical buttons where this one only has 2, the dimming function works by holding either the up or down button, single press of up turns on and single press of down turns off.


(Michael) #8

@Sticks18, I am trying to understand what is going on and not having a lot of success but i have not given up. I am curious if you can tell me what I need to have in place to see messages that are coming from the switch? I have the device paired and using a device type which is basically a copy of your code with the fingerprint changed but when I click a button I see nothing in the live logging section in the IDE. My initial guess is the commands are not coming in via cluster ids 6 or 8 so the conditionals are not firing and hence no messages are generated.

Also, I have been reading some docs and the commands being used in your code don’t match up with what I am reading, either I am misunderstanding or reading the wrong thing or is your code written for the V1 hub and I have a V2 which is different? Again I am fairly new to the ST hub and especially the custom coding so I appreciate your help.


#9

Good luck with this, I am very interested in this device as well. :sunglasses:

I used to be a network engineer so I understand this type of coding but I am now quadriparetic (use a wheelchair and have limited hand function) so I now rely on text to speech, which means I can’t read most code now. (Trust me, you do not want to do groovy with text to speech!)

Coding for the V1 hub and the V2 is the same, and the same device handlers work on both.

Anyway, since you’re a programmer, you might find the following thread helpful. In it a community member picks up a new 3 button Zigbee key fob and with the community’s help builds a new device handler for it. Although it’s a different device class and so uses different clusters than the Osram switch, it’s the best example I know of for how the process works with SmartThings and Zigbee devices:

Also, here’s the FAQ on the various logs available:

And the FAQ on publishing custom code so you can use it, although you may not need this one once you’ve been through the other two:


(Scott G) #10

They recently changed some of the zigbee coding documentation; however this type of device will need to use the older methods since they didn’t update ZDO Binding and they won’t have these command messages in their zigbee database.

You probably aren’t getting messages because the configure() section hasn’t run. The easiest way to get this to run while the switch is awake and able to receive messages is to reset the switch and pair it back to ST. Now that you have a device handler installed with the fingerprint, it should pick that one automatically and run the configure…

You’ll also want to un-comment the 2nd line in the parse section log.trace description so you can see the full message coming from the device when you press buttons. Press ‘on’ on the switch and see what comes through. Hold ‘on’ on the switch to start “dimming” and see what comes through. Most likely you’ll see one message during the hold and another when you let go. Repeat this for ‘off’ button and you should have all the messages the switch sends.

Then it’s a matter of deciding how you want those messages to be treated to create events in ST. If you can log all those messages and when/how they come through, we can help you come up with the best solution for treating the messages.


(Michael) #11

Thanks both of you for the additional info, I will work on this more today.

@JDRoberts, I understand the IDE and how to install/use custom code but I will definitely look into the other 2 for more tips, especially the logging since I think that is the biggest part I am missing right now. Once I know the messages that the switch sends I don’t think I will have too much issue figuring out what to do with them. I think trying to use text to speech to decipher any programming language would have some major challenges and interesting side effects. :smile:

I did write a smart app to work with my Fibaro RGBW controller so it is just a matter of figuring out the device type code, in my profession I develop code and manage infrastructure for a configuration management solution called Puppet so I feel confident in the coding space once I figure out what inputs I will be dealing with.

@Sticks18, I did try to reset the switch and re-pair it with the device code in place but for some reason it still associated itself with the “Acceleration Sensor” device type, also when it comes up in the ST app it shows as a presence device and when I click to configure it brings up my already configured mobile phone, if I back out of that configuration then the device shows as an unconfigured device and I can go through the configuration step. In this case since it automatically assigned itself to the “Acceleration Sensor” device type it probably ran the config for that device type. On my next attempt I will validate the the correct device type is associated before I try to configure it so that the correct configure code will run. I believe I have read that you can pair a device but then login to IDE and change the device type before actually configuring it, is that correct?

I have seen this before where a device I am trying to add shows up as a new presence device and then when I back out I can configure the correct device so I suspect this is just a bug in the ST app for Android

Currently I have the log line set to debug (log.debug “Parsing ‘${description}’”). Should I still remove that line or is debug the level I want anyway? If I remove it altogether is debug the default (maybe I will find this out by reading the logging doc that @JDRoberts posted)?


(Michael) #12

Just wanted to report back what I have found so far. I was finally able to get the switch to start sending output using the code at the Github site below. Please keep in mind this is an early work in progress and is my first attempt at device handler code!

I was able to get the output below from the switch. I am guessing the first to lines returned are the initial return of the configCmds array? The same command seems to come back when you let go of either the up or down dimming button so I assume the first command is a dim up/down command and then the second command is a stop command? The others are obviously the on/off commands. Now to see what I can do to use these commands, will I have to write a smart app to bind the dimmer to specific lights or can that be done in the device handler config? I would assume the latter but maybe not.

`configCmds??
ed5e70cd-04bf-4bed-bf71-13d2e5b50ce2 5:00:45 PM: debug parse description: catchall: 0000 8021 00 00 0040 00 68C9 00 00 0000 00 1B 00
ed5e70cd-04bf-4bed-bf71-13d2e5b50ce2 5:00:45 PM: debug parse description: catchall: 0104 0006 01 01 0140 00 68C9 01 04 104E 03 00

On
ed5e70cd-04bf-4bed-bf71-13d2e5b50ce2 5:03:15 PM: debug parse description: catchall: 0104 0006 01 01 0140 00 68C9 01 00 0000 01 00

Off
ed5e70cd-04bf-4bed-bf71-13d2e5b50ce2 5:03:39 PM: debug parse description: catchall: 0104 0006 01 01 0140 00 68C9 01 00 0000 00 00

Dimmer Up
ed5e70cd-04bf-4bed-bf71-13d2e5b50ce2 5:03:44 PM: debug parse description: catchall: 0104 0008 01 01 0140 00 68C9 01 00 0000 05 00 0032
ed5e70cd-04bf-4bed-bf71-13d2e5b50ce2 5:03:47 PM: debug parse description: catchall: 0104 0008 01 01 0140 00 68C9 01 00 0000 03 00

Dimmer Down
ed5e70cd-04bf-4bed-bf71-13d2e5b50ce2 5:03:50 PM: debug parse description: catchall: 0104 0008 01 01 0140 00 68C9 01 00 0000 01 00 0132
ed5e70cd-04bf-4bed-bf71-13d2e5b50ce2 5:03:53 PM: debug parse description: catchall: 0104 0008 01 01 0140 00 68C9 01 00 0000 03 00`


#13

Normally in SmartThings we don’t use single protocol local binds or associations, but rather treat the device as a “button controller” and send all commands to the hub. This allows a Zigbee switch to control a zwave light or a group combining some Zigbee devices and some zwave devices. Or change a mode, run a routine, etc.

This can introduce a small amount of lag, but allows for much more flexibility.


(Michael) #14

Yeah, I am currently knee deep in groovy docs and other device handler examples and starting to see that. From what I am seeing you parse the commands and create events the the hub can use to trigger other things. I think this means that someone would need something like the Button Controller along with the device handler to map the buttons to a device, is that correct?

I am starting to write some conditionals based on the command being returned and calling some other objects that I still need to define which will create the proper event which can be used by a smart app. Am I on the right track or am I complicating it? The groovy language is very new to me so still stumbling through.

Thanks again for all the tips.


(Scott G) #15

Very cool! And you’re spot on with your breakdown of the commands. The on/off commands are pretty easy. 01 is command for ‘on’, and 00 is off from 0006 cluster.

For the dimming (cluster 0008), the 2nd command for each is indeed a stop command 03. For dimming up they’re using 05 which is move with on/off meaning the light will turn on if it’s currently off, then the payload 0032 means the direction 00 is dimming up and each of these will move 32. Dimming down is very similar but they use command 01 which is just move because they don’t want the light to turn off when dimming starts. Payload is similar to dim up, but first two digits are 01, which means down direction. Same 32 step.

It sounds like you’re on the right track by using conditionals and creating events. @JDRoberts is right that configuring it as a button remote gives the most flexibility and is what this community will probably want. But feel free to explore direct device binding too as it will result in a much faster, more natural experience with zigbee bulbs.


(Michael) #16

Yeah, I guess I wasn’t considering binding directly to a device, maybe I didn’t make that statement clear. What I was kind-of expecting was that there would be a way to select the ST devices that you want to control during the config part of the device handler (when you add a new dimmer switch), then unless you re-configure it the switch would always trigger the on/off/dim events to those specific devices.

I have an updated copy of the device handler on the github site previously linked if you wouldn’t mind checking it out and see if I am on the right track. At this point I think I have the logic setup as needed but still trying to understand how to create these events and then what the next step would be. Currently the code has a bunch of debug log statements just so I can see the flow is working correctly, the output I now get when pushing the buttons is below. This is with the conditional logic in place and showing that the correct function is called and the command/data fields were passed which I am guessing is all I need for the event.

c56e4422-3682-498e-abce-a9102dedf37d 8:02:40 PM: debug Stopping brightness change. c56e4422-3682-498e-abce-a9102dedf37d 8:02:40 PM: debug Command is 3 and data is [] c56e4422-3682-498e-abce-a9102dedf37d 8:02:40 PM: debug SmartShield(clusterId: 0x0008, command: 0x03, data: [], destinationEndpoint: 0x01, direction: 0x00, isClusterSpecific: true, isManufacturerSpecific: false, manufacturerId: 0x0000, messageType: 0x00, number: null, options: 0x0140, profileId: 0x0104, senderShortId: 0x601d, sourceEndpoint: 0x01, text: null) c56e4422-3682-498e-abce-a9102dedf37d 8:02:40 PM: debug parse description: catchall: 0104 0008 01 01 0140 00 601D 01 00 0000 03 00 c56e4422-3682-498e-abce-a9102dedf37d 8:02:39 PM: debug Decreasing light(s) brightness. c56e4422-3682-498e-abce-a9102dedf37d 8:02:39 PM: debug Command is 5 and data is [0, 50] c56e4422-3682-498e-abce-a9102dedf37d 8:02:39 PM: debug SmartShield(clusterId: 0x0008, command: 0x05, data: [0x00, 0x32], destinationEndpoint: 0x01, direction: 0x00, isClusterSpecific: true, isManufacturerSpecific: false, manufacturerId: 0x0000, messageType: 0x00, number: null, options: 0x0140, profileId: 0x0104, senderShortId: 0x601d, sourceEndpoint: 0x01, text: null) c56e4422-3682-498e-abce-a9102dedf37d 8:02:39 PM: debug parse description: catchall: 0104 0008 01 01 0140 00 601D 01 00 0000 05 00 0032 c56e4422-3682-498e-abce-a9102dedf37d 8:02:37 PM: debug Stopping brightness change. c56e4422-3682-498e-abce-a9102dedf37d 8:02:37 PM: debug Command is 3 and data is [] c56e4422-3682-498e-abce-a9102dedf37d 8:02:37 PM: debug SmartShield(clusterId: 0x0008, command: 0x03, data: [], destinationEndpoint: 0x01, direction: 0x00, isClusterSpecific: true, isManufacturerSpecific: false, manufacturerId: 0x0000, messageType: 0x00, number: null, options: 0x0140, profileId: 0x0104, senderShortId: 0x601d, sourceEndpoint: 0x01, text: null) c56e4422-3682-498e-abce-a9102dedf37d 8:02:37 PM: debug parse description: catchall: 0104 0008 01 01 0140 00 601D 01 00 0000 03 00 c56e4422-3682-498e-abce-a9102dedf37d 8:02:36 PM: debug Increasing light(s) brightness. c56e4422-3682-498e-abce-a9102dedf37d 8:02:36 PM: debug Command is 1 and data is [1, 50] c56e4422-3682-498e-abce-a9102dedf37d 8:02:36 PM: debug SmartShield(clusterId: 0x0008, command: 0x01, data: [0x01, 0x32], destinationEndpoint: 0x01, direction: 0x00, isClusterSpecific: true, isManufacturerSpecific: false, manufacturerId: 0x0000, messageType: 0x00, number: null, options: 0x0140, profileId: 0x0104, senderShortId: 0x601d, sourceEndpoint: 0x01, text: null) c56e4422-3682-498e-abce-a9102dedf37d 8:02:36 PM: debug parse description: catchall: 0104 0008 01 01 0140 00 601D 01 00 0000 01 00 0132 c56e4422-3682-498e-abce-a9102dedf37d 8:02:32 PM: debug Turning light(s) on. c56e4422-3682-498e-abce-a9102dedf37d 8:02:32 PM: debug Command is 1 and data is [] c56e4422-3682-498e-abce-a9102dedf37d 8:02:32 PM: debug SmartShield(clusterId: 0x0006, command: 0x01, data: [], destinationEndpoint: 0x01, direction: 0x00, isClusterSpecific: true, isManufacturerSpecific: false, manufacturerId: 0x0000, messageType: 0x00, number: null, options: 0x0140, profileId: 0x0104, senderShortId: 0x601d, sourceEndpoint: 0x01, text: null) c56e4422-3682-498e-abce-a9102dedf37d 8:02:32 PM: debug parse description: catchall: 0104 0006 01 01 0140 00 601D 01 00 0000 01 00 c56e4422-3682-498e-abce-a9102dedf37d 8:02:29 PM: debug Turning light(s) off. c56e4422-3682-498e-abce-a9102dedf37d 8:02:29 PM: debug Command is 0 and data is [] c56e4422-3682-498e-abce-a9102dedf37d 8:02:29 PM: debug SmartShield(clusterId: 0x0006, command: 0x00, data: [], destinationEndpoint: 0x01, direction: 0x00, isClusterSpecific: true, isManufacturerSpecific: false, manufacturerId: 0x0000, messageType: 0x00, number: null, options: 0x0140, profileId: 0x0104, senderShortId: 0x601d, sourceEndpoint: 0x01, text: null) c56e4422-3682-498e-abce-a9102dedf37d 8:02:29 PM: debug parse description: catchall: 0104 0006 01 01 0140 00 601D 01 00 0000 00 00


#17

Yeah, the device handler usually doesn’t restrict use to a specific binding. (There are a few exceptions.)

Instead, a smartapp like button controller is used to allow each person to specify the devices they want to use for that specific instance.

For example, it’s entirely possible to have a switch control one set of devices during the day time and another set at night. Just as an example, I have a motion sensor in the bedroom at my house.

During the day, the motion sensor is ignored.

In the evening, triggering that motion sensor turns on the overhead light.

At night after I’ve gone to bed, the exact same motion sensor does not turn on the overhead light. Instead it turns on a soft nightlight.

If I did those associations in the device handler, I wouldn’t be able to use the same motion sensor to control different sets of lights. The device handler does not have conditional filters.

By moving those selections to the smartapp level, which do have conditional filters, I can control just what happens when.

So depending on the use case, yes, it’s pretty common to create both a custom device handler and a smartapp to go with it. :sunglasses:

But that doesn’t mean you have to.


(Scott G) #18

Looks like you have the dimming up and down flipped, but your conditionals are all working.

Unfortunately you would need a SmartApp to accomplish what you’re thinking with selecting devices because you can’t trigger zigbee commands from parse() of a device. I tried exactly this with the Hue remote as an “alternate” control method for people wanting to control zigbee bulbs and found out it didn’t work. I ended up writing a small SmartApp that acted as a pass through. When I’m not on my phone, I’ll try to share it with you if you want.


(Michael) #19

Yes, I did notice the flipped log statements which I have fixed as well as (just for curiosity) I added a binding to the inbound cluster for the temperature as you mentioned but either I did not do that part right or it just does not work, I see no messages coming in but not sure if I need to “poll” for them or what. I have not pushed these recent changes to Github yet.

I am interested in anything you want to share to help with this, as far as the device type once I figure out how to create the events is that pretty much it? as long as the events are created they can be used by a SmartApp?


(Scott G) #20

If it was me, I would treat this switch as a two button remote with both pushed and held variants like:

On command = button 1, pushed
Dim up = button 1, held
Off command = button 2, pushed
Dim down = button 2, held

You can use the Hue remote code to see how to create button events. Once the device is creating/sending those events, you’re done with the device handler. SmartApps can then subscribe to the events and take action.