Skip to content
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

Add services for Husqvarna Automower #32731

Merged
merged 7 commits into from
Jun 22, 2024

Conversation

Thomas55555
Copy link
Contributor

@Thomas55555 Thomas55555 commented May 13, 2024

Proposed change

Add description for Husqvarna Automower services.

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 a new service Override schedule in the Husqvarna Automower integration. Users can now control the mower's behavior for a specified duration, overriding all schedules with options to mow or park.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels May 13, 2024
Copy link

netlify bot commented May 13, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit f326f8f
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/666328f9d21a7c000868ff85
😎 Deploy Preview https://deploy-preview-32731--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.

Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

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

Tiny tweaks

source/_integrations/husqvarna_automower.markdown Outdated Show resolved Hide resolved
source/_integrations/husqvarna_automower.markdown Outdated Show resolved Hide resolved
source/_integrations/husqvarna_automower.markdown Outdated Show resolved Hide resolved
@home-assistant
Copy link

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 home-assistant bot marked this pull request as draft May 14, 2024 05:13
@Thomas55555 Thomas55555 marked this pull request as ready for review May 16, 2024 19:43
@home-assistant home-assistant bot requested a review from c0ffeeca7 May 16, 2024 19:43
c0ffeeca7
c0ffeeca7 previously approved these changes May 17, 2024
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

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

Thank you, @Thomas55555 👍

@c0ffeeca7 c0ffeeca7 added the awaits-parent Awaits the merge of an parent PR label May 17, 2024
c0ffeeca7
c0ffeeca7 previously approved these changes Jun 3, 2024
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

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

Oh, nice. You changed the units for the duration. 🎉
Much easier. Thank you, @Thomas55555 👍

Copy link
Contributor

coderabbitai bot commented Jun 7, 2024

Walkthrough

Walkthrough

The husqvarna_automower integration has been enhanced with a new service called Override schedule. This feature allows users to control their mower's behavior for a specified duration, either to mow or park, overriding any existing schedules during that time.

Changes

File Path Change Summary
source/_integrations/husqvarna_automower.markdown Added documentation for the new Override schedule service, detailing its functionality and usage.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant HomeAssistant
    participant HusqvarnaAutomower

    User->>HomeAssistant: Call `husqvarna_automower.override_schedule`
    HomeAssistant->>HusqvarnaAutomower: Send override command with duration and action (mow/park)
    HusqvarnaAutomower-->>HomeAssistant: Acknowledge command
    HomeAssistant-->>User: Confirm override schedule set
Loading

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 984de61 and f326f8f.

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

[style] ~31-~31: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...omower® Connect Module* are supported. In order to use this integration you must properly ...


[typographical] ~32-~32: It seems that a comma is missing. (IN_ORDER_TO_VB_COMMA)
Context: ...e* are supported. In order to use this integration you must properly configure OAuth2 cred...


[grammar] ~62-~62: Make sure that the noun ‘setup’ is correct. Did you mean the past participle “set up”? (BE_VB_OR_NN)
Context: ... Assistant redirect feature needs to be setup to redirect to your Home Assistant inst...


[misspelling] ~69-~69: The verb ‘set up’ is spelled as two words. The noun ‘setup’ is spelled as one. (SETUP_VERB)
Context: ... integration. 3. Acknowledge prompt to setup application credentials. 4. Enter the ...


[uncategorized] ~81-~81: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...varna account 7. After authorizing the integration the browser will show the My Home Assis...


[misspelling] ~134-~134: Only proper nouns start with an uppercase character (there are exceptions for headlines). (EN_UPPER_CASE_NGRAM)
Context: ...e following sensors: - Battery level - Cutting blade usage time (if available) - Error...


[misspelling] ~135-~135: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: .... For example: Mower tilted, outside geofence. - Restricted reason. For example: *We...


[uncategorized] ~155-~155: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...rding to the schedule. If the switch is off the mower will return to the dock and p...

Additional comments not posted (6)
source/_integrations/husqvarna_automower.markdown (6)

Line range hint 31-31: Consider rephrasing to avoid wordiness.
[STYLE]

- In order to use this integration you must properly configure OAuth2 credentials...
+ To use this integration, properly configure OAuth2 credentials...
Tools
LanguageTool

[uncategorized] ~155-~155: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...rding to the schedule. If the switch is off the mower will return to the dock and p...


Line range hint 32-32: Add a comma after "integration" for better readability.
[TYPOGRAPHICAL]

- In order to use this integration you must properly configure OAuth2 credentials...
+ In order to use this integration, you must properly configure OAuth2 credentials...
Tools
LanguageTool

[uncategorized] ~155-~155: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...rding to the schedule. If the switch is off the mower will return to the dock and p...


Line range hint 62-62: Clarify the verb form for "setup".
[GRAMMAR]

- The My Home Assistant redirect feature needs to be setup to redirect to your Home Assistant installation.
+ The My Home Assistant redirect feature needs to be set up to redirect to your Home Assistant installation.
Tools
LanguageTool

[uncategorized] ~155-~155: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...rding to the schedule. If the switch is off the mower will return to the dock and p...


Line range hint 69-69: Correct the verb form for "setup".
[MISSPELLING]

- Acknowledge prompt to setup application credentials.
+ Acknowledge prompt to set up application credentials.
Tools
LanguageTool

[uncategorized] ~155-~155: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...rding to the schedule. If the switch is off the mower will return to the dock and p...


Line range hint 81-81: Add a comma after "integration" for clarity.
[UNCATEGORIZED]

- After authorizing the integration the browser will show the My Home Assistant redirect link to link this account.
+ After authorizing the integration, the browser will show the My Home Assistant redirect link to link this account.
Tools
LanguageTool

[uncategorized] ~155-~155: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...rding to the schedule. If the switch is off the mower will return to the dock and p...


155-155: Add a comma after "off" for clarity.
[UNCATEGORIZED]

- If the switch is off the mower will return to the dock and park until further notice.
+ If the switch is off, the mower will return to the dock and park until further notice.
Tools
LanguageTool

[uncategorized] ~155-~155: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...rding to the schedule. If the switch is off the mower will return to the dock and p...


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
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks, @Thomas55555 👍

../Frenck

@frenck frenck merged commit 5ee9803 into home-assistant:next Jun 22, 2024
6 checks passed
@home-assistant home-assistant bot removed the awaits-parent Awaits the merge of an parent PR label Jun 22, 2024
@Thomas55555 Thomas55555 deleted the add-services2 branch June 22, 2024 19:42
@github-actions github-actions bot locked and limited conversation to collaborators Jun 23, 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
None yet
Development

Successfully merging this pull request may close these issues.

3 participants