Skip to content

Add Ezviz select entity: Work Mode #30359

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed

Conversation

pjbuffard
Copy link
Contributor

@pjbuffard pjbuffard commented Dec 15, 2023

Proposed change

Update documentation for new EZVIZ select entity: Work Mode.

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • New Features
    • Introduced the ability to select the work mode for battery-powered cameras to optimize battery consumption.
    • Enabled motion detection warning sounds for cameras that support this feature.

@home-assistant home-assistant bot added in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch next This PR goes into the next branch labels Dec 15, 2023
@home-assistant
Copy link

It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo and removed needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Dec 15, 2023
@pjbuffard pjbuffard marked this pull request as ready for review December 15, 2023 13:08
@pjbuffard pjbuffard force-pushed the ezviz-battery-work-mode branch from 2d154f7 to fe78451 Compare February 15, 2024 15:49
Copy link

netlify bot commented Feb 15, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit d2918e0
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6671e4c634a32c0008e24515
😎 Deploy Preview https://deploy-preview-30359--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@pjbuffard pjbuffard force-pushed the ezviz-battery-work-mode branch from fe78451 to 81c493c Compare June 18, 2024 17:54
Copy link
Contributor

coderabbitai bot commented Jun 18, 2024

Walkthrough

Walkthrough

The update introduces a new feature allowing users to select different work modes on battery-powered cameras, aimed at optimizing battery consumption. Moreover, it enhances functionality by enabling motion detection warning sounds for compatible cameras.

Changes

Files Change Summary
source/_integrations/ezviz.markdown Added a new feature for selecting the work mode on battery-powered cameras and using motion detection warning sounds for supported cameras. Updated the declaration of the new Work mode entity for better battery optimization.

Sequence Diagram(s)

sequenceDiagram
    User->>+App: Open Camera Settings
    App->>+BatteryPoweredCamera: Request Current Work Mode
    BatteryPoweredCamera-->>-App: Return Current Work Mode
    User->>+App: Select New Work Mode
    App->>+BatteryPoweredCamera: Set New Work Mode
    BatteryPoweredCamera-->>-App: Acknowledge Mode Change
    App-->>User: Confirmation of Mode Change

    Note over User,App: Motion Detection Warning Sounds (If Supported)
    User->>+App: Enable Motion Detection Warning Sounds
    App->>+CompatibleCamera: Enable Warning Sounds
    CompatibleCamera-->>-App: Acknowledge Warning Sounds Activation
    App-->>User: Confirmation of Warning Sounds Activation
Loading

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 81c493c and d2918e0.

Files selected for processing (1)
  • source/_integrations/ezviz.markdown (1 hunks)
Additional context used
LanguageTool
source/_integrations/ezviz.markdown

[misspelling] ~33-~33: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ... the camera from the dashboard --- The ezviz sensor platform uses the ezvizlife.com...


[misspelling] ~36-~36: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...retrieves data from the API used in the EZVIZ mobile app, [hosted here](https://apiie...


[misspelling] ~42-~42: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ... to be enabled. To do that: - Open the EZVIZ mobile app. - Select the profile icon. ...


[uncategorized] ~52-~52: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...ss a high or low res stream. Generally, though it will just work without any modificat...


[uncategorized] ~56-~56: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...ity options Request Timeout (seconds): - This option determines the duration ...


[misspelling] ~58-~58: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ... Home Assistant waits for data from the EZVIZ API before giving up. This timeout is s...


[misspelling] ~58-~58: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...onditions and the responsiveness of the EZVIZ API. A higher timeout may be necessary ...


[misspelling] ~60-~60: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...p to 30 seconds for a response from the EZVIZ API before timing out. - Please note t...


[uncategorized] ~62-~62: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ... EZVIZ API before timing out. - Please note this only works on the main EZVIZ cloud...


[misspelling] ~62-~62: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...Please note this only works on the main EZVIZ cloud entity. `Arguments passed to ffm...


[uncategorized] ~64-~64: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...Arguments passed to ffmpeg for cameras: - This option allows you to define add...


[misspelling] ~66-~66: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...ameters for capturing footage from your EZVIZ cameras. While camera resolution and co...


[misspelling] ~66-~66: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...ttings are typically configured in the "Ezviz Studio" desktop application, you can us...


[misspelling] ~66-~66: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ... option to select the desired stream or substream for capturing the footage. - To choose...


[misspelling] ~68-~68: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ... - To choose the appropriate stream or substream, specify the corresponding channel path...


[misspelling] ~68-~68: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...y the corresponding channel path in the Arguments passed to ffmpeg for cameras field. The channel path id...


[misspelling] ~68-~68: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ... path identifies the specific stream or substream of the camera. - Example: If you want ...


[misspelling] ~70-~70: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...xample: If you want to use the camera's substream, you can specify the channel path as `/...


[misspelling] ~70-~70: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ... You can also configure multiple stream/substream options based on your camera's capabili...


[misspelling] ~78-~78: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...## Service ezviz.alarm_sound If your EZVIZ camera supports warning sounds, you can...


[misspelling] ~82-~82: The word ‘ids’ is not standard English. Did you mean “id’s” (curly apostrophe) or “id's” (straight apostrophe)? (NON_STANDARD_WORD) Context: ...String or list of strings that point at entity_ids of cameras. Use entity_id: all` to tar...


[misspelling] ~87-~87: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ... | ### Service ezviz.ptz If your EZVIZ camera supports <abbr title="pan, tilt,...


[misspelling] ~91-~91: The word ‘ids’ is not standard English. Did you mean “id’s” (curly apostrophe) or “id's” (straight apostrophe)? (NON_STANDARD_WORD) Context: ...String or list of strings that point at entity_ids of cameras. Use entity_id: all` to tar...


[misspelling] ~97-~97: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...t_alarm_detection_sensibility` If your EZVIZ camera supports motion detection, you w...


[misspelling] ~101-~101: The word ‘ids’ is not standard English. Did you mean “id’s” (curly apostrophe) or “id's” (straight apostrophe)? (NON_STANDARD_WORD) Context: ...String or list of strings that point at entity_ids of cameras. Use entity_id: all` to tar...


[misspelling] ~107-~107: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...## Service ezviz.sound_alarm If your EZVIZ camera has a built-in siren, you can us...


[misspelling] ~111-~111: The word ‘ids’ is not standard English. Did you mean “id’s” (curly apostrophe) or “id's” (straight apostrophe)? (NON_STANDARD_WORD) Context: ...String or list of strings that point at entity_ids of cameras. Use entity_id: all` to tar...


[misspelling] ~120-~120: The word ‘ids’ is not standard English. Did you mean “id’s” (curly apostrophe) or “id's” (straight apostrophe)? (NON_STANDARD_WORD) Context: ...String or list of strings that point at entity_ids of cameras. Use entity_id: all` to tar...


[misspelling] ~128-~128: The word ‘ids’ is not standard English. Did you mean “id’s” (curly apostrophe) or “id's” (straight apostrophe)? (NON_STANDARD_WORD) Context: ...String or list of strings that point at entity_ids of cameras. Use entity_id: all` to tar...


[misspelling] ~134-~134: The word ‘ids’ is not standard English. Did you mean “id’s” (curly apostrophe) or “id's” (straight apostrophe)? (NON_STANDARD_WORD) Context: ...String or list of strings that point at entity_ids of cameras. Use entity_id: all` to tar...


[misspelling] ~138-~138: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ... The Alarm control panel entity in the EZVIZ platform allows users to manage and con...


[misspelling] ~138-~138: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...d control the armed status of all their EZVIZ devices. With this entity, users can ch...


[misspelling] ~151-~151: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...omatically deactivate after 60 seconds (EZVIZ does this, not done via integration). A...


[grammar] ~170-~170: This is normally spelled as one word. (SUPER_COMPOUNDS)
Context: ... | | Super power saving | Sleep mode is on. Active l...


[uncategorized] ~183-~183: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...oubleshooting - authentication failed: The authentication requires an EZVIZ ac...


[misspelling] ~183-~183: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...failed`: The authentication requires an EZVIZ account with two-step verification disa...


[misspelling] ~183-~183: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...led. Google, Facebook, TikTok, or other Oauth-based accounts will not work.

Markdownlint
source/_integrations/ezviz.markdown

122-122: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces


87-87: Element: abbr (MD033, no-inline-html)
Inline HTML


155-155: Element: abbr (MD033, no-inline-html)
Inline HTML


155-155: Element: abbr (MD033, no-inline-html)
Inline HTML

Additional comments not posted (1)
source/_integrations/ezviz.markdown (1)

161-172: The "Work Mode" section for battery-powered cameras provides a good overview of the available modes. However, as previously suggested, a more detailed explanation of each mode would enhance user understanding. Consider adding details on how each mode affects battery life and camera functionality, possibly through a descriptive paragraph or a detailed table.

Tools
LanguageTool

[grammar] ~170-~170: This is normally spelled as one word. (SUPER_COMPOUNDS)
Context: ... | | Super power saving | Sleep mode is on. Active l...


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Comment on lines +161 to +164
### Work mode

For battery powered cameras, you can use this entity to select the work mode to optimize your battery consumption.

Copy link
Contributor

@coderabbitai coderabbitai bot Jun 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a more detailed explanation of the "Work Mode" options.

The documentation for the new "Work Mode" entity is quite brief. It would be beneficial for users to have a more detailed explanation of what each mode does and how it affects battery life and camera functionality. Consider adding examples or a table that describes each mode.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added a table to describe each mode

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pjbuffard Thank you for updating the documentation with the detailed table for the "Work Mode" options. This addition provides clear and valuable information for users on how each mode affects battery life and camera functionality, aligning well with the initial suggestion for enhanced clarity. Great work! If there's anything else you'd like to adjust or add, feel free to let me know.

Analysis chain
Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Fetch the latest content of the file `source/_integrations/ezviz.markdown` to review the updated "Work Mode" table.
cat source/_integrations/ezviz.markdown

Length of output: 11026

@home-assistant home-assistant bot closed this Nov 10, 2024
@home-assistant home-assistant bot removed the in-progress This PR/Issue is currently being worked on label Nov 10, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Nov 11, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

1 participant