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 the snoo integration #36607

Open
wants to merge 4 commits into
base: next
Choose a base branch
from
Open

Conversation

Lash-L
Copy link
Contributor

@Lash-L Lash-L commented Dec 29, 2024

Proposed change

Adds an integration for a Smart Bassinet Snoo by Happiest Baby.

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

Summary by CodeRabbit

  • New Features
    • Added documentation for Snoo integration in Home Assistant.
    • Provided comprehensive installation and removal instructions for the Snoo integration.
    • Included metadata for the Snoo integration, detailing its features and configuration.
    • Described the various states and events of the Snoo, enhancing user understanding.

@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 29, 2024
@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.

Copy link

netlify bot commented Dec 29, 2024

Deploy Preview for home-assistant-docs failed.

Name Link
🔨 Latest commit 1186af9
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6771f519b064e500085439d2

@home-assistant home-assistant bot added the has-parent This PR has a parent PR in a other repo label Dec 29, 2024
@home-assistant home-assistant bot removed the needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch label Dec 29, 2024
Copy link
Contributor

coderabbitai bot commented Dec 29, 2024

📝 Walkthrough

Walkthrough

A new markdown documentation file for the Snoo integration has been added to the Home Assistant documentation. The file provides comprehensive information about integrating Snoos into Home Assistant, including metadata, installation instructions, and references to configuration and removal procedures. This addition follows the standard documentation format for Home Assistant integrations, offering users clear guidance on how to set up and manage the Snoo integration.

Changes

File Change Summary
source/_integrations/snoo.markdown New markdown file created with integration documentation, including metadata, installation instructions, and references to configuration and removal processes.

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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

🧹 Nitpick comments (2)
source/_integrations/snoo.markdown (2)

19-22: Add blank line before heading

According to markdown best practices, headings should be surrounded by blank lines.

Apply this diff to fix the formatting:

 

+
## Installing the integration
🧰 Tools
🪛 Markdownlint (0.37.0)

19-19: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


1-29: Consider adding more detailed documentation

While the current documentation covers the basics, consider enhancing it with:

  1. A list of available sensors and their capabilities
  2. Any limitations or requirements (e.g., minimum firmware version)
  3. Examples of common automations or use cases
  4. Troubleshooting section for common issues

This would provide users with a more comprehensive understanding of the integration's capabilities.

Would you like me to help draft these additional sections?

🧰 Tools
🪛 LanguageTool

[uncategorized] ~17-~17: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...n --- Snoo's are a smart bassinet that help get your baby to sleep and help keep th...

(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)


[uncategorized] ~17-~17: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...et that help get your baby to sleep and help keep them asleep. ## Installing the i...

(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)

🪛 Markdownlint (0.37.0)

17-17: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


19-19: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b9e2dbc and 255e440.

📒 Files selected for processing (1)
  • source/_integrations/snoo.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/snoo.markdown

[uncategorized] ~17-~17: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...n --- Snoo's are a smart bassinet that help get your baby to sleep and help keep th...

(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)


[uncategorized] ~17-~17: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...et that help get your baby to sleep and help keep them asleep. ## Installing the i...

(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)

🪛 Markdownlint (0.37.0)
source/_integrations/snoo.markdown

17-17: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


19-19: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

🔇 Additional comments (2)
source/_integrations/snoo.markdown (2)

7-7: Verify the release version

The release version is set to 2025.2. This seems quite far in the future. Please confirm if this is intentional or if it should be adjusted to a closer release version.


24-29: LGTM!

The removal section is well-structured and includes the appropriate template references.

source/_integrations/snoo.markdown Outdated Show resolved Hide resolved
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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: 0

🧹 Nitpick comments (2)
source/_integrations/snoo.markdown (2)

19-22: Add blank line before heading

Add a blank line before the "Installing the integration" heading to improve readability and comply with markdown standards.

 The Snoo is a smart bassinet that helps get your baby to sleep and helps keep them asleep.

+
 ## Installing the integration
 This integration follows standard integration installation. No extra steps are required.
🧰 Tools
🪛 Markdownlint (0.37.0)

19-19: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


26-27: Combine split lines

Consider combining the split lines for better readability in the raw markdown:

-This integration follows standard integration removal. No extra steps are
-required.
+This integration follows standard integration removal. No extra steps are required.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 255e440 and d2095d3.

📒 Files selected for processing (1)
  • source/_integrations/snoo.markdown (1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
source/_integrations/snoo.markdown

19-19: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

🔇 Additional comments (3)
source/_integrations/snoo.markdown (3)

7-7: Verify the release version

The release version is set to 2025.2. Please confirm if this is intentional or if it should be adjusted to a closer release version.


17-17: LGTM!

The description is clear, concise, and grammatically correct.


1-29: Verify documentation completeness

Please ensure the following common documentation elements are considered:

  1. Links to the manufacturer's website or product page
  2. Any prerequisites or requirements (e.g., account creation)
  3. Available sensors and their descriptions
  4. Any rate limits or API restrictions

Would you like me to help add these sections to the documentation?

🧰 Tools
🪛 Markdownlint (0.37.0)

19-19: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

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

🧹 Nitpick comments (3)
source/_integrations/snoo.markdown (3)

25-50: Improve formatting and grammar in the sensors section

The content is informative but needs some refinements:

Apply these changes:

 ### State
+
 The Snoo can have one of 8 states
+
 1. Baseline - This is the basic state the snoo starts with. It has not detected the need to do any further soothing.
 2. Level 1 - This is the lowest level of soothing
 3. Level 2
 4. Level 3
 5. Level 4
 6. Stop - The snoo is no longer running
 7. Pre-timeout - the snoo is preparing to go back to stop rotating
 8. Timeout - the snoo is stopping rotating.
 
 ### Last Event
-The snoo will send a message whenever a event occurs. This entity displays the last event that was sent. There are 9 possible events
+The snoo will send a message whenever an event occurs. This entity displays the last event that was sent. There are 9 possible events:
+
 1. Activity button - The activity button was pressed
🧰 Tools
🪛 LanguageTool

[misspelling] ~40-~40: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...t The snoo will send a message whenever a event occurs. This entity displays the ...

(EN_A_VS_AN)


[grammar] ~41-~41: Possible agreement error. The noun ‘button’ seems to be countable.
Context: ...There are 9 possible events 1. Activity button - The activity button was pressed 2. Ti...

(CD_NN)

🪛 Markdownlint (0.37.0)

39-39: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


30-30: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


41-41: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


51-52: Improve formatting and clarity in the time left section

Apply these changes:

+
 ## Time left
-This describes how long until the Snoo will change levels or it is -1 if it is not currently planning to change levels.
+This describes how long until the Snoo will change levels, or it is -1 if it is not currently planning to change levels.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~52-~52: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...w long until the Snoo will change levels or it is -1 if it is not currently plannin...

(COMMA_COMPOUND_SENTENCE)

🪛 Markdownlint (0.37.0)

51-51: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


56-56: Fix typo in removal section

-This integration follows standard integration removal. No extra steps arerequired.
+This integration follows standard integration removal. No extra steps are required.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d2095d3 and 1186af9.

📒 Files selected for processing (1)
  • source/_integrations/snoo.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/snoo.markdown

[misspelling] ~40-~40: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...t The snoo will send a message whenever a event occurs. This entity displays the ...

(EN_A_VS_AN)


[grammar] ~41-~41: Possible agreement error. The noun ‘button’ seems to be countable.
Context: ...There are 9 possible events 1. Activity button - The activity button was pressed 2. Ti...

(CD_NN)


[uncategorized] ~52-~52: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...w long until the Snoo will change levels or it is -1 if it is not currently plannin...

(COMMA_COMPOUND_SENTENCE)

🪛 Markdownlint (0.37.0)
source/_integrations/snoo.markdown

19-19: Expected: 1; Actual: 2
Multiple consecutive blank lines

(MD012, no-multiple-blanks)


20-20: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


39-39: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


51-51: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


30-30: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)


41-41: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

🔇 Additional comments (2)
source/_integrations/snoo.markdown (2)

17-17: LGTM!

The description is clear and grammatically correct.


20-23: LGTM!

The installation section correctly references the standard configuration flow.

🧰 Tools
🪛 Markdownlint (0.37.0)

20-20: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

ha_category:
- Sensor
ha_iot_class: Cloud Push
ha_release: 2025.2
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Release version 2025.2 is too far in the future

The release version 2025.2 is set too far ahead. Based on the search results, recent integrations are being released with versions in the 2023.x range. The release version should be set to a closer upcoming version.

  • Consider updating ha_release: 2025.2 to target a more immediate future release
🔗 Analysis chain

Verify the release version

The release version is set to 2025.2, which seems quite far in the future. Consider setting it to a closer upcoming version.

Run the following script to check recent release versions:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check recent Home Assistant release versions
# Look for version patterns in markdown files

rg -g "*.markdown" -g "*.md" "ha_release: 202[34]" | sort -u

Length of output: 1286

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
has-parent This PR has a parent PR in a other repo in-progress This PR/Issue is currently being worked on next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant