Homeworks support #52

rzulian · 2020-04-22T05:13:34Z

This PR is adding:

support for Homeworks QS.
support for recursive areas in naming
areas with IntegrationID are OccupancyGroup
revised standard naming for components and keypad components
OUTPUT to support movement raise, lower, stop, jogs(eg for motors)
buttons: support for actions
corrected led states
support for QS_IO_INTERFACE
support for phantom keypads
support for seetouch international keypads
support for CCI

# Conflicts: # pylutron/__init__.py

thecynic

Sorry for the long lack of response, finally went through it all.

In the future I recommend you clean up your patchstack so that the changes collect related code. Seems like you just kept typing "git commit -m 'foo'" periodically, without organizing your improvements into logical changes :)

pylutron/__init__.py

jthop · 2020-05-13T02:37:57Z

Guys with more advanced Homeworks systems desperately need this branch merged. The default one can't handle phantoms, any VCRX stuff, international keypads, etc... the CSD001 detection was a great idea. Please, we need this... or can anyone tell me how to force Hassio to use this instead of the default????

txwindsurfer · 2020-06-10T19:29:32Z

@jthop I can share my version of the lutron component which is using this branch of pylutron.
I was waiting for this PR to be merged, to open a PR on the Hassio.

I would be happy to test both the lutron component in Hassio and this branch of pylutron on my Homeworks QS system if you would like to share the lutron component.

jthop · 2020-06-10T19:31:32Z

Oh yes, I would love to test as well....

jthop · 2020-06-11T15:28:28Z

@txwindsurfer would love to see it... scratching my head why these major upgrades for homeworks take so long to be approved???

thecynic · 2020-06-13T01:45:04Z

The main problem is that it's quite a major change to the code, so I really have the time to review and then test the changes against my radio ra 2 system.

…

On Thu, Jun 11, 2020, 8:28 AM Jamie Hopper ***@***.***> wrote: @txwindsurfer <https://github.com/txwindsurfer> would love to see it... scratching my head why these major upgrades for homeworks take so long to be approved??? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#52 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AALQIMMR4P5EOMBUGZSWQ23RWDZ2XANCNFSM4MN27M4Q> .

jthop · 2020-06-14T01:28:52Z

@rzulian fwiw would be nice to have access to homework variables as well... They use command SYSVAR and have integration IDs just like everything else. they aren't reported by default, you have to do a "#MONITORING,10,1" to see them... just an idea, you guys are doing great.

thecynic · 2020-06-13T23:02:34Z

pylutron/__init__.py

-    led_logic = button_xml.get('LedLogic')
-    name = button_xml.get('Name')
+    led_logic = 0 if button_xml.get('LedLogic') is None else int(button_xml.get('LedLogic'))
+    name = f"keypad {keypad.id}: Btn {component_number}"


I still strongly dislike sticking all the other cruft into the name. It should be up to the client to decide how to combine the various names. cdheiser's recent change should allow everything to have a true unique identifier so none of this should be necessary for uniqueness.

Please remove this here and everywhere else, keeping the name as is (and removing engraving).

thecynic · 2020-06-13T23:10:06Z

pylutron/__init__.py

@@ -446,7 +446,8 @@ def __init__(self, host, user, password):
  @property
  def areas(self):
    """Return the areas that were discovered for this Lutron controller."""
-    return self._areas
+    # return self._areas
+    return tuple(area for area in self._areas)


Heh. Only reason I can see is if someone was taking the returned list and modifying it and you wanted to isolate us from that? Is that a problem somehow in HASS?

Since we don't do this everywhere else, I suggest you removed this and keep as is. If that's a worry somehow, it should be a separate PR to generate a copy for all these APIs to keep us safe, and we can discuss the merits then.

thecynic · 2020-06-13T23:15:03Z

pylutron/__init__.py

+  _ACTION_START_RAISING = 2
+  _ACTION_START_LOWERING = 3
+  _ACTION_STOP = 4
+  _ACTION_JOG_RAISE = 18


These are internal constants inside this component. You shouldn't be using them from an external library. We should figure out the right API for that and not create an inadvertent dependency on these names from our clients.

thecynic · 2020-06-13T23:17:30Z

pylutron/__init__.py


+  def is_light(self):


my point is that you still don't know what's on the other end of the load, so we shouldn't pretend. Get rid of is_light() and just improve 'is_dimmable' logic by itself.

thecynic · 2020-06-13T23:20:37Z

pylutron/__init__.py

    HOLD_RELEASED = 5


-  def __init__(self, lutron, keypad, name, num, button_type, direction):
+  def __init__(self, lutron, keypad, name, engraving, num, button_type, direction, led_logic):


Ah, LED state, ok. Yeah I only have radio ra2 and their feature-set is quite minimal (I get on/off 😞 ), sadly. I'm jelly of Homeworks. I'd do anything for that double-tap :)

I really don't want to expose things like led_logic as bare ints without proper enum constants is that it ends up spreading weird droppings like this with no concept of what they mean, and suddenly HASS has a random 5 somewhere. You need to add a better API for the client to figure these things out. At least provide a named enum for 0-3 that we can keep stable, and also add a CUSTOM or INTEGRATION for your 5.

Thought, actually this is all a property of an LED, and not of the button, isn't it? Why can't you instead delegate the LED control to the Led class?

Also, Does LED state change gets its own event? I don't remember.

pylutron/__init__.py

thecynic · 2020-06-14T05:37:54Z

pylutron/__init__.py

                    button_type=button_type,
-                    direction=direction)
+                    direction=direction,
+                    led_logic=led_logic)


I think the problem is that you have like 20+ changes with stuff scatted all over them with no logical breakdown between the individual changes. So I'm sure this gets used, but in some other git commit. Github almost incentivizes bad habits :( I'm used to, and prefer, seeing one git commit per logical change, and a stack of commits that logicall follow each other adding incremental functionality.

pylutron/__init__.py

robby-d · 2020-08-24T12:59:24Z

Hi, I wanted to note that as of Homeworks v16, and with the new Homeworks QSX processor (released earlier this year) it appears that telnet support is being discontinued in favor of Lutron's LEAP API. I can't find published specs to that yet.

More info: https://forums.lutron.com/showthread.php/15404-Is-QSX-replacing-QS-processors-or-will-they-serve-different-purposes

Basically, it looks like Lutron just removed telnet support entirely in Homeworks v16. No depreciation warning/time period.

jthop · 2020-08-24T14:09:40Z

Ok yes and FYI there are no published specs as of now from what I understand. Lutron worked with all the majors (Crestron, Control4, Savant, etc) and they all have drivers developed already... they do plan to release the API in the future but not sure when. Anyway this is a major change, but you gotta admit that an API using telnet is a bit outdated....

…

On Mon, Aug 24, 2020 at 7:59 AM Robby Dermody ***@***.***> wrote: Hi, I wanted to note that as of Homeworks v16, and with the new Homeworks QSX processor (released earlier this year) it appears that telnet support is being discontinued in favor of Lutron's LEAP API. I can't find published specs to that yet. More info: https://forums.lutron.com/showthread.php/15404-Is-QSX-replacing-QS-processors-or-will-they-serve-different-purposes — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#52 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAWCG2TYP6VDTLTGRQLBIJLSCJP3VANCNFSM4MN27M4Q> .

-- Jamie Hopper Megahertz Technology, Inc. 214-365-0933 www.mhztech.com

thecynic · 2020-08-26T21:00:05Z

That would be amazing. The telnet API is terrible :)

…

On Mon, Aug 24, 2020, 7:09 AM Jamie Hopper ***@***.***> wrote: Ok yes and FYI there are no published specs as of now from what I understand. Lutron worked with all the majors (Crestron, Control4, Savant, etc) and they all have drivers developed already... they do plan to release the API in the future but not sure when. Anyway this is a major change, but you gotta admit that an API using telnet is a bit outdated.... On Mon, Aug 24, 2020 at 7:59 AM Robby Dermody ***@***.***> wrote: > Hi, I wanted to note that as of Homeworks v16, and with the new Homeworks > QSX processor (released earlier this year) it appears that telnet support > is being discontinued in favor of Lutron's LEAP API. I can't find published > specs to that yet. > > More info: > https://forums.lutron.com/showthread.php/15404-Is-QSX-replacing-QS-processors-or-will-they-serve-different-purposes > > — > You are receiving this because you were mentioned. > Reply to this email directly, view it on GitHub > <#52 (comment)>, or > unsubscribe > < https://github.com/notifications/unsubscribe-auth/AAWCG2TYP6VDTLTGRQLBIJLSCJP3VANCNFSM4MN27M4Q > > . > -- Jamie Hopper Megahertz Technology, Inc. 214-365-0933 www.mhztech.com — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#52 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AALQIMNMTWSWAVLFIHUYZKLSCJYDHANCNFSM4MN27M4Q> .

rzulian · 2020-09-23T13:20:36Z

@thecynic : could you please have a final review and approve this PR?

@txwindsurfer @jthop : If you want to try the current branch I've a repo with the Lutron custom component here https://github.com/rzulian/lutron_custom_component

txwindsurfer · 2020-09-23T21:19:07Z

Great work @rzulian! I added your files into custom_components/lutron and upgraded to the latest version of HA (0.116.0.dev20200923) on my test system and now I have the buttons on my keypads mapped as scenes (albeit no unique id so can't manage in UI). I also now have occupancy binary_sensors mapped for each room but since I don't have occupancy sensors I am guessing they are default entries in the Lutron schema. From a naming convention, I wasn't using the 1st floor or 2nd floor designation in the names of my objects so if I adopt your integration I will need to change lots of names. Adding unique ids to the objects would greatly help in managing the names from the UI. Thanks for sharing and your continued work!!

rzulian · 2020-09-24T09:33:02Z

@txwindsurfer :

scene UI. my bad :( I've uploaded a new version that fix this, including in the scene name the keypad_name
occupancy sensors. I'm assuming that if your area has an integration ID there is a occupancy sensor. This is how it's working on my installation. Is it your setup different?
naming. I'm using the full path for the area name because I've duplicated area names in different locations. I could add an option on the HA config to use the full path or only the area name.

txwindsurfer · 2020-09-28T23:23:47Z

@rzulian:

I appreciate again your work and realize that designing for may different systems is difficult if not impossible. So with that premise, I kindly offer the following comments:

1a) First ignore my previous comment on unique ids for the scenes as it really doesn't make sense to edit scenes in the UI as an edited scene cannot be passed back to Lutron. Editing scenes for Lutron keypads is best done in Lutron Designer.

1b) Second, the addition of the keypad_name didn't add information for my installation since the DeviceGroup Name already identified the keypad.
My keypad buttons now looks like:
1st Floor Entry keypad: 25: Btn 1
Rather than the keypad number or the button number, I would love to have Engraving which identifies the button in english. DeviceGroup Name + Engraving would look like:
1st Floor Entry Sconces
And, finally if I had the choice to drop the full name for the scene I would get:
Entry Sconces
which would be just perfect for my installation.

Lutron Designer tells me I do not have any occupancy sensors (and I don't), however each area in the XML has this entry which might be causing the creation of occupancy sensors.
-<Area UUID="859" Name="Front Porch" SortOrder="0" OccupancyGroupAssignedToID="861" IntegrationID="20">
Since I do not have an occupancy sensor, I cannot give you an example of what a real XML occupancy sensor entry would look like, but having an integration ID doesn't mean there is an occupancy sensor in my installation.

Just FYI, the XML file also has an OccupancyGroups section even though I don't have any sensors so that should be ignored.

Thanks again for your great work. It is really appreciated

rzulian · 2020-10-13T12:36:47Z

@txwindsurfer
Regarding 1b. I've evaluated to use engraving in names, but I've multiple buttons in different keypads in the same area with the same Engraving, so the names are not unique. I don't know if I can use a friendly name instead. Any suggestion?
Regarding 2. I'm using Lutron designer 9.4. I've had to add to the integration ID the areas with an occupancy sensor to make sure I'm getting the occupancy sensors.

txwindsurfer · 2020-10-14T21:42:24Z

@rzulian
1.b. I didn't think about the same engraving being on the same keypad--that would be a problem. Having engraving as the Friendly Name would be great. You might consider concatenating the engraving to the end of the device+button string but then the string might be too long.
2. I am using Designer 10.7 and the versions do change quite a bit I have heard. In fact, the biggest problem I suppose with doing QS in HA is there are to many different devices and firmware/software versions. No idea how to account for them all. It is easy enough to tailor what you have done to my setup so thanks again for the great work.

rzulian · 2020-10-15T07:43:15Z

@txwindsurfer
1.b I meant the same engraving being on different keypad in the same room. Think about large rooms, you might need to have the ability to recall the same scenario from different keypads
2. I don't have access to 10.7, as I'm not a certified Lutron developer :(

Merged changes from rzulian pr thecynic#52 with pylutron 0.2.12 https://github.com/thecynic/pylutron/releases/tag/0.2.12

Initial merge for Homeworks QS support from thecynic#52

* added UUID and legacy UUID * OccupancyGroups from xml * added flash for Output * Button events renamed and aligned to the Lutron documentation * Led state as value * XLM loadfrom cache or store to cache

txwindsurfer · 2024-05-03T16:27:14Z

@rzulian @thecynic Thank you so much for all the attention to the Lutron Integration. Could you please add 'HWI_SLIM' to the list of keypads around lines 302. With this addition, my keypad buttons show up as intended on the event bus and as event entities.

From my DbXmlInfo for one of the keypads:
Device Name="CSD 001" UUID="2104" SerialNumber="4026536452" IntegrationID="71" DeviceType="HWI_SLIM" GangPosition="0" SortOrder="0">

rzulian · 2024-05-03T19:10:50Z

@txwindsurfer
I'm going to add the support for "HWI_SLIM". I'm also working on a new version of the custom component, which I have aligned to the official "lutron" component, thanks to @ronluna.
I'm adding the ability to:

flag if you want to refresh data from Lutron each time you instantiate the integration
flag if you want to use the full path as area name, which is useful if your layout has areas included in other areas
flag if you want to prepend the area name to the device name (e.g you have multiple lights named "Applique", in multiple rooms. Using this flag you will have room1 Applique, room2 Applique, etc)

rzulian added 26 commits December 23, 2019 09:49

support for HomeWorks prompt

682b1b4

support for seeTouch international keypad

3d2c570

CCI support

96f7ca7

test

281d37d

settings for python3

89c57fb

removed wait

27f7dc6

fix what is a light and id dimmable

7623a7d

hold, tap and hold release on buttons

f7ef8dd

iterate through areas and include path into the name

1a7f820

occupancy_group not only for motion sensor

61f7fab

support for WCI and Internation_seetouch_keypad

6e0aab4

button events for hold, tapped, and hold_released

d94647e

Merge branch 'master' into homeworks-support

9940956

# Conflicts: # pylutron/__init__.py

add OccupancyGroup for Areas with Integration ID

bbdd715

support for QS_IO_INTERFACE, which has buttons like

76b14de

keyPad name for CSD 001 default name

60fc6ab

added led_logic to buttons, name <> engraving

88c9081

movement actions for OUTPUT

f2cf9cc

Button engraving, led_logic and doubletapped

50e6d05

area tuples

027ce25

keypad log

62e4439

is_light property

16af25e

renamed keypad name

9075543

renamed component names

7b550d8

corrected led state

05791b6

phantom keypad

3d34c8d

thecynic requested changes May 2, 2020

View reviewed changes

thecynic reviewed May 2, 2020

View reviewed changes

pylutron/__init__.py Show resolved Hide resolved

small cosmetics

63f6af9

thecynic requested changes Jun 14, 2020

View reviewed changes

rzulian added 3 commits September 23, 2020 11:48

nitpick

9b3d4e4

removed keypad from component's naming

ecdec43

fix and nitpick

b6292e4

ronluna added a commit to ronluna/pylutron that referenced this pull request Mar 25, 2024

Initial support for Homeworks QS

e2957e1

Merged changes from rzulian pr thecynic#52 with pylutron 0.2.12 https://github.com/thecynic/pylutron/releases/tag/0.2.12

ronluna added a commit to ronluna/pylutron that referenced this pull request Mar 25, 2024

Initial working merge

9a0707c

Initial merge for Homeworks QS support from thecynic#52

rzulian added 6 commits April 24, 2024 17:05

ron including areas

a3c5262

final nitpicks

8e5404d

added property location for area

f09089c

OccupancyGroup for area with integration ID only

07c9610

store and load from cache

03ea384

Merge pull request #1

2bc865c

* added UUID and legacy UUID * OccupancyGroups from xml * added flash for Output * Button events renamed and aligned to the Lutron documentation * Led state as value * XLM loadfrom cache or store to cache

support HWI_SLIM keypad

e8c6c18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Homeworks support #52

Homeworks support #52

rzulian commented Apr 22, 2020 •

edited

thecynic left a comment

jthop commented May 13, 2020

txwindsurfer commented Jun 10, 2020

jthop commented Jun 10, 2020

jthop commented Jun 11, 2020

thecynic commented Jun 13, 2020 via email

jthop commented Jun 14, 2020

thecynic Jun 13, 2020

thecynic Jun 13, 2020

thecynic Jun 13, 2020

thecynic Jun 13, 2020

thecynic Jun 13, 2020

thecynic Jun 14, 2020

robby-d commented Aug 24, 2020 •

edited

jthop commented Aug 24, 2020 via email

thecynic commented Aug 26, 2020 via email

rzulian commented Sep 23, 2020

txwindsurfer commented Sep 23, 2020

rzulian commented Sep 24, 2020

txwindsurfer commented Sep 28, 2020

rzulian commented Oct 13, 2020 •

edited

txwindsurfer commented Oct 14, 2020

rzulian commented Oct 15, 2020

txwindsurfer commented May 3, 2024

rzulian commented May 3, 2024

Homeworks support #52

Are you sure you want to change the base?

Homeworks support #52

Conversation

rzulian commented Apr 22, 2020 • edited

thecynic left a comment

Choose a reason for hiding this comment

jthop commented May 13, 2020

txwindsurfer commented Jun 10, 2020

jthop commented Jun 10, 2020

jthop commented Jun 11, 2020

thecynic commented Jun 13, 2020 via email

jthop commented Jun 14, 2020

thecynic Jun 13, 2020

Choose a reason for hiding this comment

thecynic Jun 13, 2020

Choose a reason for hiding this comment

thecynic Jun 13, 2020

Choose a reason for hiding this comment

thecynic Jun 13, 2020

Choose a reason for hiding this comment

thecynic Jun 13, 2020

Choose a reason for hiding this comment

thecynic Jun 14, 2020

Choose a reason for hiding this comment

robby-d commented Aug 24, 2020 • edited

jthop commented Aug 24, 2020 via email

thecynic commented Aug 26, 2020 via email

rzulian commented Sep 23, 2020

txwindsurfer commented Sep 23, 2020

rzulian commented Sep 24, 2020

txwindsurfer commented Sep 28, 2020

rzulian commented Oct 13, 2020 • edited

txwindsurfer commented Oct 14, 2020

rzulian commented Oct 15, 2020

txwindsurfer commented May 3, 2024

rzulian commented May 3, 2024

rzulian commented Apr 22, 2020 •

edited

robby-d commented Aug 24, 2020 •

edited

rzulian commented Oct 13, 2020 •

edited