Skip to content

Add nomaiq integration #39497

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

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

Conversation

mnfjorge
Copy link

@mnfjorge mnfjorge commented Jun 12, 2025

Proposed change

Add new integration for NomaIQ devices.

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

  • Documentation
    • Added new documentation for the NomaIQ integration, detailing setup instructions, supported devices (currently Garage Door Opener as a Light entity), and available features.

@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 Jun 12, 2025
Copy link

netlify bot commented Jun 12, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 1464123
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/684a745fa0ccd5000827f6f9
😎 Deploy Preview https://deploy-preview-39497--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 project configuration.

@mnfjorge mnfjorge marked this pull request as ready for review June 12, 2025 06:18
@mnfjorge mnfjorge marked this pull request as draft June 12, 2025 06:20
Copy link
Contributor

coderabbitai bot commented Jun 12, 2025

📝 Walkthrough

Walkthrough

A new documentation file for the NomaIQ integration has been added. This document outlines support for NomaIQ devices in Home Assistant, specifically the Garage Door Opener device, which is exposed as a Light entity. It details prerequisites, configuration steps, and supported actions, and encourages user feedback for unsupported devices.

Changes

File(s) Change Summary
source/_integrations/nomaiq.markdown Added documentation for new NomaIQ integration, including setup, supported devices, and actions

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Home Assistant
    participant NomaIQ Cloud

    User->>Home Assistant: Initiate NomaIQ integration setup
    Home Assistant->>User: Prompt for NomaIQ credentials
    User->>Home Assistant: Provide credentials
    Home Assistant->>NomaIQ Cloud: Authenticate and poll devices
    NomaIQ Cloud-->>Home Assistant: Return device list (Garage Door Opener)
    Home Assistant->>User: Expose Garage Door Opener as Light entity
    User->>Home Assistant: Turn Light entity on/off
    Home Assistant->>NomaIQ Cloud: Send control command
    NomaIQ Cloud-->>Home Assistant: Confirm action
Loading

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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: 0

🔭 Outside diff range comments (1)
source/_integrations/nomaiq.markdown (1)

36-37: ⚠️ Potential issue

Fix the link anchor for Light actions and split into separate bullets.

The current anchor /integrations/light#action-lightturn_on is invalid and only covers turn_on. Split the action into two bullets with correct anchors:

- - [`turn on/off`](/integrations/light#action-lightturn_on)
+ - [`turn_on`](/integrations/light#action-light-turn-on)
+ - [`turn_off`](/integrations/light#action-light-turn-off)
🧹 Nitpick comments (1)
source/_integrations/nomaiq.markdown (1)

19-23: Replace "At the moment" with a concise adverb.

For style and consistency, use "Currently" instead of "At the moment".

Apply this diff:

- This integration was only tested with a Garage Door Opener. At the moment it only loads the Light entity.
+ This integration was only tested with a Garage Door Opener. Currently it only loads the Light entity.
🧰 Tools
🪛 LanguageTool

[style] ~21-~21: For conciseness, consider replacing this expression with an adverb.
Context: ... only tested with a Garage Door Opener. At the moment it only loads the Light entity. If you...

(AT_THE_MOMENT)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 45f323c and c7faca2.

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

[style] ~21-~21: For conciseness, consider replacing this expression with an adverb.
Context: ... only tested with a Garage Door Opener. At the moment it only loads the Light entity. If you...

(AT_THE_MOMENT)

🔇 Additional comments (1)
source/_integrations/nomaiq.markdown (1)

4-6: Confirm release version accuracy.

Please verify that ha_release: 2025.6 aligns with the Home Assistant release schedule for this integration. Using an incorrect or far-future release could delay or misrepresent availability in the documentation.

@mnfjorge mnfjorge marked this pull request as ready for review June 12, 2025 06:32
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 (3)
source/_integrations/nomaiq.markdown (3)

21-21: Add comma after “Currently” for clarity
A comma is needed after the conjunctive adverb.

- This integration was only tested with a Garage Door Opener. Currently it only loads the Light entity.
+ This integration was only tested with a Garage Door Opener. Currently, it only loads the Light entity.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~21-~21: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ... only tested with a Garage Door Opener. Currently it only loads the Light entity. If you...

(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)


23-23: Use a neutral, community-oriented tone
Avoid first-person phrasing—suggest opening an issue directly.

- If you don't see a light entity loaded, then this integration doesn't support your device yet. Please reach out so I can work on it for you (or open a PR yourself).
+ If you don't see a light entity loaded, this integration doesn't support your device yet. Please open an issue on GitHub or submit a PR to add support.

38-38: Add a trailing newline at end of file
POSIX-compliant files should end with a newline.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between c7faca2 and 1464123.

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

[uncategorized] ~21-~21: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ... only tested with a Garage Door Opener. Currently it only loads the Light entity. If you...

(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (1)
source/_integrations/nomaiq.markdown (1)

6-6: Verify the ha_release version
Ensure that 2025.6 matches the target Home Assistant release for this integration.

@c0ffeeca7 c0ffeeca7 added the new-integration This PR adds documentation for a new Home Assistant integration label Jun 16, 2025
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 new-integration This PR adds documentation for a new Home Assistant integration next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants