Update requirement version and add switcher_kis services #23477

TomerFi · 2019-04-27T15:35:11Z

Description:

Updated aioswitcher requirement from 2019.3.21 to 2019.4.26.
Added two services for the switcher_kis component:
- switcher_kis.set_auto_off for setting the auto-shutdown configuration value on the device.
  Takes one argument named auto_off of type time_period_str (example: "02:30").
- switcher_kis.update_device_name for setting the name configuration value on the device.
  Takes one argument named 'name' of type string with 2 < length < 32 (example: "My Switcher Device").
Added test cases for the new services.
Fixed a couple of left-overs change requests from the previous PR Added component named switcher_kis switcher water heater integration. #22325.
Added ServiceCallType in homeassistant.helpers.typing for use with static typing.

Checklist:

The code change is tested and works locally.
Local tests pass with tox. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.

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 (example).
New dependencies have been added to requirements in the manifest (example).
New dependencies are only imported inside functions that use them (example).
New or updated dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
New files were added to .coveragerc.

ghost · 2019-04-27T15:35:19Z

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

This is a automatic comment generated by codeowners-mention to help ensure issues and pull requests are seen by the right people.

balloob · 2019-04-30T03:31:58Z

homeassistant/components/switcher_kis/__init__.py

+    async def async_set_auto_off_service(service: ServiceCallType) -> None:
+        """Use for handling setting device auto-off service calls."""
+        from aioswitcher.api import SwitcherV2Api
+        async with SwitcherV2Api(hass.loop, device_data.ip_addr, phone_id,


You should validate that the user has at least access to control a single entity of this integration.

Thank you very much, I'll get right on it!
:-)

Resolved with the use of async_listen_platform in this commit.

Reading this again, I think @balloob wants us to check the access rights for the user to run the service on an entity.

https://developers.home-assistant.io/blog/2019/03/11/user-permissions.html

@MartinHjelmare
Oh yes I see that now.
I'll have a closer look tonight and push the adjustments.
Thanks!

Resolved in this commit.

Now that I think about it...
I should probably add a component verification before the permission verification.
Otherwise a user can pass any permitted entity and he will pass the verification process, because there is no actual use for the entity in there two services.

Added domain and entity_id validation in this commit.
The domain validation might seem redundant, but it won't be once I'll integrate the sensor platform representing the device's schedules.
For now, I can easily remove it if necessary.

@MartinHjelmare
Any thoughts?
:-)

homeassistant/components/switcher_kis/__init__.py

balloob · 2019-06-06T19:19:00Z

homeassistant/components/switcher_kis/__init__.py

+                await swapi.set_device_name(service.data[CONF_NAME])
+
+        hass.services.async_register(
+            DOMAIN, SERVICE_UPDATE_DEVICE_NAME_NAME,


What's the use of allowing people to set a device name? Since it has a unique ID, users can just use the entity registry to change the name and entity ID.

We should only offer things as a service that might be used for automations. Administrative tasks should be done in the app for the product.

@balloob
Yeah but that entity registry modification will of course only reflect in home assistant.
This service sets the actual device name so it's also reflected in the vendor's app.

It's on a nice-to-have basis I believe,
I can drop this service if you think in redundant.

Please advice...

Let's drop it. We generally avoid putting device management into HA (exceptions if integration is about a protocol like Zigbee/Z-Wave)

@balloob
Removed in this commit.

Thanks!
:-)

Co-Authored-By: TomerFi <tomer.figenblat@gmail.com>

balloob · 2019-06-14T22:48:29Z

Awesome! 🐬

…ant#23477) * Update aioswitcher requirement to 2019.4.26. * Removed unnecessary legacy function call. * Fixed log message capital first letter. * Replaced None argument with empty dict. * Replaced guard. * Added ServiceCallType. * Added set_auto_off and update_device_name services to the component. * Added test cases for service calls. * Conditioned the component services registry with the platform discovery. * Update homeassistant/components/switcher_kis/__init__.py Co-Authored-By: TomerFi <tomer.figenblat@gmail.com> * Update homeassistant/components/switcher_kis/__init__.py Co-Authored-By: TomerFi <tomer.figenblat@gmail.com> * Resolved change requests. * Added ContextType. * Addes permission verification for service calls. * Added test cases for permision verification and more. * Replaced POLICY_CONTROL with the more suited POLICY_EDIT. * More appropriate function name. * Added domain and entity_id validation for calling services. * Removed service for setting the vendor's device name.

TomerFi requested a review from a team as a code owner April 27, 2019 15:35

homeassistant added cla-signed core has-tests integration: switcher_kis labels Apr 27, 2019

ghost assigned TomerFi Apr 27, 2019

TomerFi mentioned this pull request Apr 27, 2019

Added component named switcher_kis switcher water heater integration. #22325

Merged

7 tasks

balloob reviewed Apr 30, 2019

View reviewed changes

TomerFi force-pushed the add-switcher_kis-services branch from 94157b0 to 2a5a002 Compare April 30, 2019 11:38

MartinHjelmare requested changes May 6, 2019

View reviewed changes

homeassistant/components/switcher_kis/__init__.py Outdated Show resolved Hide resolved

homeassistant/components/switcher_kis/__init__.py Outdated Show resolved Hide resolved

homeassistant/components/switcher_kis/__init__.py Show resolved Hide resolved

TomerFi force-pushed the add-switcher_kis-services branch from 7134421 to 7decb90 Compare May 7, 2019 12:20

balloob reviewed Jun 6, 2019

View reviewed changes

TomerFi and others added 17 commits June 12, 2019 10:51

Update aioswitcher requirement to 2019.4.26.

877d957

Removed unnecessary legacy function call.

20697a7

Fixed log message capital first letter.

fc4290b

Replaced None argument with empty dict.

4e67b0b

Replaced guard.

65e71d5

Added ServiceCallType.

237c7d6

Added set_auto_off and update_device_name services to the component.

161b969

Added test cases for service calls.

04f8df6

Conditioned the component services registry with the platform discovery.

e51e660

Update homeassistant/components/switcher_kis/__init__.py

95f9b57

Co-Authored-By: TomerFi <tomer.figenblat@gmail.com>

Update homeassistant/components/switcher_kis/__init__.py

a349c78

Co-Authored-By: TomerFi <tomer.figenblat@gmail.com>

Resolved change requests.

ba2e089

Added ContextType.

5dd0304

Addes permission verification for service calls.

4388051

Added test cases for permision verification and more.

1a6dcf6

Replaced POLICY_CONTROL with the more suited POLICY_EDIT.

57c504a

More appropriate function name.

b50d6aa

TomerFi added 2 commits June 12, 2019 10:51

Added domain and entity_id validation for calling services.

bb616ee

Removed service for setting the vendor's device name.

61ec269

TomerFi force-pushed the add-switcher_kis-services branch from 0a1e62c to 61ec269 Compare June 12, 2019 08:13

balloob approved these changes Jun 14, 2019

View reviewed changes

balloob merged commit fe8a330 into home-assistant:dev Jun 14, 2019

TomerFi mentioned this pull request Jun 16, 2019

Add switcher kis auto off service home-assistant/home-assistant.io#9640

Merged

2 tasks

balloob mentioned this pull request Jun 26, 2019

0.95.0 #24776

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update requirement version and add switcher_kis services #23477

Update requirement version and add switcher_kis services #23477

TomerFi commented Apr 27, 2019

ghost commented Apr 27, 2019

balloob Apr 30, 2019

TomerFi Apr 30, 2019

TomerFi Apr 30, 2019

MartinHjelmare May 7, 2019

TomerFi May 7, 2019

TomerFi May 7, 2019

TomerFi May 7, 2019 •

edited

TomerFi May 8, 2019

TomerFi May 31, 2019

balloob Jun 6, 2019

TomerFi Jun 6, 2019 •

edited

balloob Jun 11, 2019

TomerFi Jun 12, 2019

balloob commented Jun 14, 2019

Update requirement version and add switcher_kis services #23477

Update requirement version and add switcher_kis services #23477

Conversation

TomerFi commented Apr 27, 2019

Description:

Checklist:

ghost commented Apr 27, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TomerFi May 7, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TomerFi Jun 6, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

balloob commented Jun 14, 2019

TomerFi May 7, 2019 •

edited

TomerFi Jun 6, 2019 •

edited