Add switches (on/off zones) to geniushub by castaway · Pull Request #28182 · home-assistant/core

castaway · 2019-10-24T19:03:39Z

Description:

The geniushub integration shows smart plug Devices as BinarySensors; it can report when they are on or off, but can not change their state (this is done in GH via the parent Zone).

This PR adds on/off Zones as SwitchDevices:

'turn_on' - set Zone to GH's Override/On mode
'turn_off' - set Zone to GH's Timer mode

Also bumps geniushub-client from 0.6.28 to 0.6.29, see: manzanotti/geniushub-client@v0.6.28...v0.630, which fixes:

Pull request with documentation for home-assistant.io: home-assistant/home-assistant.io#11095

Checklist:

The code change is tested and works locally.
Local tests pass with tox. Your PR cannot be merged unless tests pass - no tests for geniushub
There is no commented out code in this PR.
I have followed the development checklist

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in home-assistant.io

If the code communicates with devices, web services, or third-party tools:

The manifest file has all fields filled out correctly. Update and include derived files by running python3 -m script.hassfest. - nothing changed
New or updated dependencies have been added to requirements_all.txt by running python3 -m script.gen_requirements_all. - no new ones
Untested files have been added to .coveragerc.

homeassistant · 2019-10-24T19:03:40Z

Hi @castaway,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

probot-home-assistant · 2019-10-24T19:03:46Z

Hey there @zxdavb, mind taking a look at this pull request as its been labeled with a integration (geniushub) you are listed as a codeowner for? Thanks!

zxdavb · 2019-10-25T15:20:22Z

Thanks for your PR - we'll definitely get this useful PR merged.

zxdavb

Please add:

    @property
    def device_class(self):
        """Return the class of this device, from component DEVICE_CLASSES."""
        return DEVICE_CLASS_OUTLET

zxdavb · 2019-10-25T16:05:24Z

The geniushub integration shows outlets as binary sensors, it can report when they are on or off, but does not allow the user to change the status. This PR adds them as SwitchDevices ...

Please be aware of the distinction between a GH Device (that is a binary_sensor)), and a GH on/off Zone (a switch).

For example, an on/off Zone can have (say) three Devices (smart plugs). All 3 will turn on when the Zone is on, and all three off otherwise.

castaway · 2019-10-25T16:18:52Z

The geniushub integration shows outlets as binary sensors, it can report when they are on or off, but does not allow the user to change the status. This PR adds them as SwitchDevices ...

Please be aware of the distinction between a GH Device (that is a binary_sensor)), and a GH on/off Zone (a switch).

For example, an on/off Zone can have (say) three Devices (smart plugs). All 3 will turn on when the Zone is on, and all three off otherwise.

I am aware of these however, (see above), I can only see ways to turn on/off whole zones, not individual devices.. At least in the v1 API.

castaway · 2019-10-25T16:21:08Z

Please add:

    @property
    def device_class(self):
        """Return the class of this device, from component DEVICE_CLASSES."""
        return DEVICE_CLASS_OUTLET

Aha ok, I took the switch parts from the smartthings/switch.py, which doesn't contain this..

zxdavb · 2019-10-25T17:36:43Z

I am aware of these however, (see above), I can only see ways to turn on/off whole zones, not individual devices.. At least in the v1 API.

Correct.

zxdavb · 2019-10-25T17:51:12Z

The problem is, and this is why I haven't been rushing to implement this functionality, that HA switches have no concept of operating mode / profile. That is, they expect to be turned off, and turned on - they have no concept of following a schedule (Timer mode)...

So have a think about what you expect this entity to do when it is turned on, and turned off.

castaway · 2019-10-25T17:56:34Z

Latest push: 857dce0 - should contain all of the suggestions, apart from the discussion on "!= "off" .

zxdavb · 2019-10-27T09:38:02Z

FYI: just identified an issue with the geniushub-client, where is can't change the override of an on/off zone.

castaway · 2019-10-29T10:57:43Z

I felt like crap all weekend... looks like you were busy, what else do we need to poke to make this work as an initial version?

I think the set override time (without temp) on the client is needed, as otherwise the on/off only blinks it on for a second or two.

Anything else?

zxdavb · 2019-10-29T21:48:45Z

Anything else?

Sorry, got side tracked with another PR (now done).

The changes are here: manzanotti/geniushub-client@v0.6.28...toggle_on_off_zones

It previous had a default duration of 0 seconds for override mode - it is now 3600 seconds.

I will have another look tomorrow - in the meantime, could you mark anything resolved as resolved.

castaway · 2019-10-29T23:52:08Z

Ah awesome, much better!

…

On 29 October 2019 21:49:42 GMT+00:00, David Bonnes ***@***.***> wrote: > Anything else? Sorry, got side tracked with another PR (now done). The changes are here: manzanotti/geniushub-client@v0.6.28...toggle_on_off_zones It previous had a `duration `of 0 seconds for `override` mode - it is now 3600 seconds. -- You are receiving this because you were mentioned. Reply to this email directly or view it on GitHub: #28182 (comment)

-- Sent from my Android phone with K-9 Mail. Please excuse my brevity.

zxdavb · 2019-10-30T16:55:09Z

Please edit manifest.json to bump the client (NB: 0.6.29):

{
  "domain": "geniushub",
  "name": "Genius Hub",
  "documentation": "https://www.home-assistant.io/integrations/geniushub",
  "requirements": [
    "geniushub-client==0.6.29"
  ],
  "dependencies": [],
  "codeowners": ["@zxdavb"]
}

... then run: python3 -m script.gen_requirements_all

castaway · 2019-10-30T18:43:20Z

Please edit manifest.json to bump the client (NB: 0.6.29):

{
  "domain": "geniushub",
  "name": "Genius Hub",
  "documentation": "https://www.home-assistant.io/integrations/geniushub",
  "requirements": [
    "geniushub-client==0.6.29"
  ],
  "dependencies": [],
  "codeowners": ["@zxdavb"]
}

... then run: python3 -m script.gen_requirements_all

I was literally about to look how to do that, well mind read..

castaway · 2019-10-30T21:58:10Z

Please edit manifest.json to bump the client (NB: 0.6.29):
{
  "domain": "geniushub",
  "name": "Genius Hub",
  "documentation": "https://www.home-assistant.io/integrations/geniushub",
  "requirements": [
    "geniushub-client==0.6.29"
  ],
  "dependencies": [],
  "codeowners": ["@zxdavb"]
}
... then run: python3 -m script.gen_requirements_all
I was literally about to look how to do that, well mind read..

Hrm, except that updated the reqs.. if I tell it then to install from requirements_all.txt (or just run it), it doesnt update.. I did pip3 install geniushub-client==0.6.29 instead

castaway · 2019-10-30T22:21:41Z

Hrm. Didnt work - that is, still doesnt set override to an hour.. retested with just latest client from repo to make sure.. doesnt with ghclient either.. time to debug (over on the client repo)

zxdavb · 2019-10-30T22:28:05Z

Hrm, except that updated the reqs.. if I tell it then to install from requirements_all.txt (or just run it), it doesnt update.. I did pip3 install geniushub-client==0.6.29 instead

HA installs the updated client library from PyPI next time you start HA.

Confirm this by removing geniushub-client, and restarting HA:

pip uninstall -y geniushub-client
pip list | grep genius
hass

...

pip list | grep genius

Hrm. Didnt work - that is, still doesnt set override to an hour.. retested with just latest client from repo to make sure.. doesnt with ghclient either.. time to debug (over on the client repo)

The script in this issue works for me - have a go at it: manzanotti/geniushub-client#25

You can push your latest PR, and I'll have a look.

castaway · 2019-10-30T22:50:25Z

Hrm, except that updated the reqs.. if I tell it then to install from requirements_all.txt (or just run it), it doesnt update.. I did pip3 install geniushub-client==0.6.29 instead

HA installs the updated client library from PyPI next time you start HA.

Confirm this by removing geniushub-client, and restarting HA:
pip uninstall -y geniushub-client
pip list | grep genius
hass

...

pip list | grep genius

Aha, the "remove existing version" wasnt obvious, I assumed it would upgrade if given a higher version.. anyhoo manually got there in the end.

Hrm. Didnt work - that is, still doesnt set override to an hour.. retested with just latest client from repo to make sure.. doesnt with ghclient either.. time to debug (over on the client repo)

The script in this issue works for me - have a go at it: zxdavb/geniushub-client#25

You can push your latest PR, and I'll have a look.

I haven't changed it..

Hm, the ghclient.py one? Aha! I'm just calling --zone=X --mode=override .. which still doesn't send a duration (and I think ought to).

…witches

* In which I learn to run pylint locally..

zxdavb · 2019-11-03T19:26:20Z

Woops - my fault: sorted now (and rebased).

zxdavb · 2019-11-03T20:18:54Z

Well done! We can merge as soon as the docs PR is sorted.

You're not interested in adding services are you?
https://developers.home-assistant.io/docs/en/dev_101_services.html

castaway · 2019-11-04T10:34:43Z

home-assistant/home-assistant.io#11095

zxdavb

Ready to go

castaway requested a review from zxdavb as a code owner October 24, 2019 19:03

homeassistant added the cla-needed label Oct 24, 2019

probot-home-assistant Bot added Hacktoberfest integration: geniushub new-platform labels Oct 24, 2019

probot-home-assistant Bot assigned zxdavb Oct 24, 2019

homeassistant added cla-signed and removed cla-needed labels Oct 24, 2019

zxdavb requested changes Oct 25, 2019

View reviewed changes

zxdavb reviewed Oct 25, 2019

View reviewed changes

Comment thread homeassistant/components/geniushub/switch.py

zxdavb added the dependency Pull requests marked as a dependency upgrade label Oct 30, 2019

zxdavb and others added 5 commits November 3, 2019 19:24

bump geniushub-client to 0.6.30

ab3d798

Tidy up based on some requests from @zxdavb

7bf3518

Inherit from GeniusEntity, so we don't drag zone heating stuff into S…

d5563df

…witches

Re-organise to GeniusZone, GeniusHeatingZone, etc

45fbf10

Fixed issue with incorrect import

71026ed

* In which I learn to run pylint locally..

zxdavb force-pushed the feature/geniushub_switches branch from 173705d to 71026ed Compare November 3, 2019 19:25

zxdavb removed request for a team, Adminiuga, Kane610, OttoWinter, andrewsayre, balloob, danielperna84, dmulcahey, jjlawren, pvizeli, robbiet480, rytilahti, scop and syssi November 3, 2019 19:46

castaway added a commit to castaway/home-assistant.io that referenced this pull request Nov 4, 2019

Update docs for home-assistant/core#28182

be9e2ef

frenck removed the docs-missing label Nov 4, 2019

castaway mentioned this pull request Nov 4, 2019

Add switches (on/off) for geniushub outlets home-assistant/home-assistant.io#11095

Merged

2 tasks

zxdavb changed the title ~~Add switches (on/off) for geniushub outlets~~ Add switches (on/off zones) to geniushub Nov 4, 2019

zxdavb approved these changes Nov 4, 2019

View reviewed changes

zxdavb merged commit 5b85456 into home-assistant:dev Nov 4, 2019

lock Bot locked and limited conversation to collaborators Nov 5, 2019

Uh oh!

Conversation

castaway commented Oct 24, 2019 • edited by zxdavb Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

Checklist:

Uh oh!

homeassistant commented Oct 24, 2019

Uh oh!

probot-home-assistant Bot commented Oct 24, 2019

Uh oh!

zxdavb commented Oct 25, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

zxdavb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

zxdavb commented Oct 25, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

castaway commented Oct 25, 2019

Uh oh!

castaway commented Oct 25, 2019

Uh oh!

zxdavb commented Oct 25, 2019

Uh oh!

zxdavb commented Oct 25, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

castaway commented Oct 25, 2019

Uh oh!

zxdavb commented Oct 27, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

castaway commented Oct 29, 2019

Uh oh!

zxdavb commented Oct 29, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

castaway commented Oct 29, 2019 via email

Uh oh!

zxdavb commented Oct 30, 2019

Uh oh!

castaway commented Oct 30, 2019

Uh oh!

castaway commented Oct 30, 2019

Uh oh!

castaway commented Oct 30, 2019

Uh oh!

zxdavb commented Oct 30, 2019

Uh oh!

castaway commented Oct 30, 2019

Uh oh!

zxdavb commented Nov 3, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

zxdavb commented Nov 3, 2019

Uh oh!

castaway commented Nov 4, 2019

Uh oh!

zxdavb left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

castaway commented Oct 24, 2019 •

edited by zxdavb

Loading

zxdavb commented Oct 25, 2019 •

edited

Loading

zxdavb commented Oct 25, 2019 •

edited

Loading

zxdavb commented Oct 25, 2019 •

edited

Loading

zxdavb commented Oct 27, 2019 •

edited

Loading

zxdavb commented Oct 29, 2019 •

edited

Loading

zxdavb commented Nov 3, 2019 •

edited

Loading