Add support for EzViz Battery Camera work mode #105802

pjbuffard · 2023-12-15T13:07:30Z

Proposed change

Add a new select entity called "Work Mode". Allows setting and getting camera work mode for battery powered camera.

Bump pyezviz to 0.2.2.3 to be able to do this
BaQs/pyEzviz@0.2.1.2...0.2.2.3

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New integration (thank you!)
New feature (which adds functionality to an existing integration)
Deprecation (breaking change to happen in the future)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Additional information

This PR fixes or closes issue: fixes #
This PR is related to issue:
Link to documentation pull request: Add Ezviz select entity: Work Mode home-assistant.io#30359

Checklist

The code change is tested and works locally.
Local tests pass. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist
I have followed the perfect PR recommendations
The code has been formatted using Ruff (ruff format homeassistant tests)
Tests have been added to verify that the new code works.

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

Documentation added/updated for www.home-assistant.io

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

The manifest file has all fields filled out correctly.
Updated and included derived files by running: python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt.
Updated by running python3 -m script.gen_requirements_all.
For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

I have reviewed two other open pull requests in this repository.

home-assistant

Hi @pjbuffard

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!

home-assistant · 2023-12-15T13:07:35Z

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

home-assistant · 2023-12-15T13:07:38Z

Hey there @RenierM26, @BaQs, mind taking a look at this pull request as it has been labeled with an integration (ezviz) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of ezviz can trigger bot actions by commenting:

@home-assistant close Closes the pull request.
@home-assistant rename Awesome new title Renames the pull request.
@home-assistant reopen Reopen the pull request.
@home-assistant unassign ezviz Removes the current integration label and assignees on the pull request, add the integration domain after the command.
@home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
@home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

Stale

github-actions · 2024-02-13T14:04:50Z

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
If you are the author of this PR, please leave a comment if you want to keep it open. Also, please rebase your PR onto the latest dev branch to ensure that it's up to date with the latest changes.
Thank you for your contribution!

pjbuffard · 2024-02-15T15:33:32Z

please keep this pr opened

RenierM26 · 2024-02-17T04:55:27Z

Hi There,

Please also tick "dependency upgrade" in the "proposed changes" section of this pull request.

You'll also need to link a git compare and release notes URL. (a git compare example is in the release notes, just change the version in the URL to match from and to version)

RenierM26 · 2024-02-17T05:00:07Z

homeassistant/components/ezviz/select.py

@@ -95,3 +122,43 @@ def select_option(self, option: str) -> None:
            raise HomeAssistantError(
                f"Cannot set Warning sound level for {self.entity_id}"
            ) from err
+
+
+class EzvizBatteryWorkModeSelect(EzvizEntity, SelectEntity):


Might be cleaner to add a Mixin to the EzvizSelectEntityDescription with the methods (fuctions) used to set the options. Could then perhaps get away with a single EzvizSelect class.

@pjbuffard tagging you just in case you missed the comments notification 👀

Hello, yes thanks ! I will try to have a look asap but it might not be before April (holiday time 🏖️ )

I hope it is better/cleaner now: I added a EzvizSelectEntityActionBase to handle real actions for each type of select. So, as requested, there is still only one EzvizSelect 😉

ping for @RenierM26 and @BaQs 👀

emontnemery · 2024-04-16T14:16:00Z

I'm setting this PR as draft since there are non-addressed review comments.
@pjbuffard Please don't forget to hit the "ready for review"-button once you've done the required changed 👍

github-actions · 2024-06-15T16:05:24Z

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
If you are the author of this PR, please leave a comment if you want to keep it open. Also, please rebase your PR onto the latest dev branch to ensure that it's up to date with the latest changes.
Thank you for your contribution!

srescio · 2024-06-15T21:07:22Z

Pls keep open, this is a very useful feature that combined with automation could greatly increase devices battery life decrease recharge frequency

joostlek

I left some comments that are trying to explain how the code could look cleaner without the ActionBase but with just using callables in the entity descriptions which is a common pattern within core integrations.

joostlek · 2024-07-05T10:25:19Z

homeassistant/components/ezviz/select.py

+        return self.entity_description.action_handler.select_option(
+            self, self._serial, option
+        )


Honestly, keep the try catch here. It will help you remove the try catch from the function you are executing. You can use the key of the entity description to create a translatable error.

joostlek · 2024-07-05T10:26:59Z

homeassistant/components/ezviz/select.py

 @dataclass(frozen=True, kw_only=True)
 class EzvizSelectEntityDescription(SelectEntityDescription):
    """Describe a EZVIZ Select entity."""

    supported_switch: int
+    action_handler: type[EzvizSelectEntityActionBase]


Suggested change

action_handler: type[EzvizSelectEntityActionBase]

current_option_fn: Callable[[EzvizSelect], str | None]

select_option_fn: Callable[[EzvizSelect, str, str], None]

Or maybe even just replace EzvizSelect with ezvizSelect.data[ezvizSelect.entity_description.key] in the current_option_fn and the ezviz_client in the select_option_fn

joostlek · 2024-07-05T10:29:23Z

homeassistant/components/ezviz/select.py

+    def current_option(ezvizSelect: EzvizSelect) -> str | None:
+        """Return the selected entity option to represent the entity state."""
+        battery_work_mode = getattr(
+            BatteryCameraWorkMode,
+            ezvizSelect.data[ezvizSelect.entity_description.key],
+            BatteryCameraWorkMode.UNKNOWN,
+        )
+        if battery_work_mode == BatteryCameraWorkMode.UNKNOWN:
+            return None
+
+        return battery_work_mode.name.lower()


This can just be a separate function

joostlek · 2024-07-05T10:31:01Z

homeassistant/components/ezviz/select.py

+        "custom",
+    ],
+    supported_switch=-1,
+    action_handler=BatteryWorkModeAction,


Suggested change

action_handler=BatteryWorkModeAction,

current_option_fn=current_battery_work_mode,

select_option_fn=lambda client, serial_no, option: client.set_battery_camera_work_mode(

serial, BatteryCameraWorkMode(option)

)

Where current_battery_work_mode is the func I was talking about

joostlek · 2024-07-05T10:31:26Z

homeassistant/components/ezviz/select.py

    async_add_entities(
-        EzvizSelect(coordinator, camera)
+        EzvizSelect(coordinator, camera, ALARM_SOUND_MODE_SELECT_TYPE)
        for camera in coordinator.data
        for switch in coordinator.data[camera]["switches"]
-        if switch == SELECT_TYPE.supported_switch
+        if switch == ALARM_SOUND_MODE_SELECT_TYPE.supported_switch
+    )
+
+    async_add_entities(
+        EzvizSelect(coordinator, camera, BATTERY_WORK_MODE_SELECT_TYPE)
+        for camera in coordinator.data
+        if coordinator.data[camera]["device_category"]
+        == DeviceCatagories.BATTERY_CAMERA_DEVICE_CATEGORY.value
    )


Please add all the entities you want to add in a list and execute async_add_entities once, since its expensive

joostlek · 2024-07-05T10:31:47Z

homeassistant/components/ezviz/strings.json

@@ -68,6 +68,16 @@
          "intensive": "Intensive",
          "silent": "Silent"
        }
+      },
+      "battery_camera_work_mode": {
+        "name": "Work Mode",


Suggested change

"name": "Work Mode",

"name": "Work mode",

Should it mention the battery by the way?

github-actions · 2024-09-03T11:05:09Z

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
If you are the author of this PR, please leave a comment if you want to keep it open. Also, please rebase your PR onto the latest dev branch to ensure that it's up to date with the latest changes.
Thank you for your contribution!

pjbuffard · 2024-09-03T12:14:49Z

Pls keep opened, I have to find time to work on it

github-actions · 2024-11-02T14:04:44Z

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
If you are the author of this PR, please leave a comment if you want to keep it open. Also, please rebase your PR onto the latest dev branch to ensure that it's up to date with the latest changes.
Thank you for your contribution!

srescio · 2024-11-02T14:15:47Z

Keep it alive!! 👀

emontnemery · 2024-11-07T09:39:49Z

@srescio If you want to see this PR finished, you can help by addressing the review comments

frenck · 2024-11-10T20:04:03Z

Because there hasn't been any activity on this PR for quite some time now, I've decided to close it for being stale.

Feel free to re-open this PR when you are ready to pick up work on it again 👍

../Frenck

home-assistant bot previously requested changes Dec 15, 2023

View reviewed changes

home-assistant bot added cla-needed integration: ezviz new-feature labels Dec 15, 2023

home-assistant bot marked this pull request as draft December 15, 2023 13:07

home-assistant bot added the Quality Scale: No score label Dec 15, 2023

pjbuffard mentioned this pull request Dec 15, 2023

Add Ezviz select entity: Work Mode home-assistant/home-assistant.io#30359

Closed

8 tasks

pjbuffard marked this pull request as ready for review December 15, 2023 13:08

home-assistant bot added cla-recheck cla-signed and removed cla-recheck cla-needed labels Dec 15, 2023

github-actions bot added the stale label Feb 13, 2024

pjbuffard force-pushed the ezviz-battery-camera-work-mode branch from bf1a2a6 to c97b3b8 Compare February 15, 2024 15:11

github-actions bot removed the stale label Feb 15, 2024

RenierM26 reviewed Feb 17, 2024

View reviewed changes

emontnemery marked this pull request as draft April 16, 2024 14:16

github-actions bot added the stale label Jun 15, 2024

github-actions bot removed the stale label Jun 15, 2024

pjbuffard force-pushed the ezviz-battery-camera-work-mode branch from c97b3b8 to 61b0a20 Compare June 18, 2024 13:11

Add support for EzViz Battery Camera work mode

a105940

pjbuffard force-pushed the ezviz-battery-camera-work-mode branch from 61b0a20 to a105940 Compare June 18, 2024 17:40

pjbuffard marked this pull request as ready for review June 18, 2024 20:09

joostlek requested changes Jul 5, 2024

View reviewed changes

home-assistant bot marked this pull request as draft July 5, 2024 10:34

joostlek added the dependency label Jul 5, 2024

github-actions bot added the stale label Sep 3, 2024

github-actions bot removed the stale label Sep 3, 2024

github-actions bot added the stale label Nov 2, 2024

github-actions bot removed the stale label Nov 2, 2024

frenck closed this Nov 10, 2024

github-actions bot locked and limited conversation to collaborators Nov 11, 2024

	action_handler: type[EzvizSelectEntityActionBase]
	current_option_fn: Callable[[EzvizSelect], str \| None]
	select_option_fn: Callable[[EzvizSelect, str, str], None]

-    action_handler=BatteryWorkModeAction,
+    current_option_fn=current_battery_work_mode,
+    select_option_fn=lambda client, serial_no, option: client.set_battery_camera_work_mode(
+                serial, BatteryCameraWorkMode(option)
+            )

Uh oh!

Add support for EzViz Battery Camera work mode #105802

Add support for EzViz Battery Camera work mode #105802

Uh oh!

Conversation

pjbuffard commented Dec 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Additional information

Checklist

Uh oh!

home-assistant bot left a comment

Choose a reason for hiding this comment

Uh oh!

home-assistant bot commented Dec 15, 2023

Uh oh!

home-assistant bot commented Dec 15, 2023

Uh oh!

github-actions bot commented Feb 13, 2024

Uh oh!

pjbuffard commented Feb 15, 2024

Uh oh!

RenierM26 commented Feb 17, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

emontnemery commented Apr 16, 2024

Uh oh!

github-actions bot commented Jun 15, 2024

Uh oh!

srescio commented Jun 15, 2024

Uh oh!

joostlek left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Sep 3, 2024

Uh oh!

pjbuffard commented Sep 3, 2024

Uh oh!

github-actions bot commented Nov 2, 2024

Uh oh!

srescio commented Nov 2, 2024

Uh oh!

emontnemery commented Nov 7, 2024

Uh oh!

frenck commented Nov 10, 2024

Uh oh!

Uh oh!

pjbuffard commented Dec 15, 2023 •

edited

Loading