Skip to content

Add Nuki Matter #38815

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

Merged
merged 1 commit into from
Apr 30, 2025
Merged

Add Nuki Matter #38815

merged 1 commit into from
Apr 30, 2025

Conversation

edenhaus
Copy link
Member

@edenhaus edenhaus commented Apr 30, 2025

Proposed change

Add Nuki Matter integration

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 Nuki Matter integration, detailing support for Nuki Matter locks via the Matter protocol in Home Assistant, with local control and instant status updates.

@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 Apr 30, 2025
Copy link

netlify bot commented Apr 30, 2025

Deploy Preview for home-assistant-docs ready!

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

coderabbitai bot commented Apr 30, 2025

📝 Walkthrough

Walkthrough

A new documentation file for the "Nuki Matter" integration has been added. This file introduces and describes the integration of Nuki Matter devices with Home Assistant via the Matter protocol. It outlines the integration's features, configuration methods, supported device types, and relevant links. The documentation notes that the integration is scheduled for release in version 2025.5 and is maintained by the Matter team.

Changes

File(s) Change Summary
source/_integrations/nuki_matter.markdown Added new documentation for the Nuki Matter integration, detailing features, configuration, and relevant links.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistant
    participant NukiMatterDevice

    User->>HomeAssistant: Initiate Nuki Matter integration setup
    HomeAssistant->>NukiMatterDevice: Discover and connect via Matter protocol
    NukiMatterDevice-->>HomeAssistant: Provide device status and control capabilities
    User->>HomeAssistant: Control or monitor Nuki Matter device
    HomeAssistant->>NukiMatterDevice: Send commands (e.g., lock/unlock)
    NukiMatterDevice-->>HomeAssistant: Respond with updated status
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.
    • 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.
  • @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

🧹 Nitpick comments (5)
source/_integrations/nuki_matter.markdown (5)

4-14: Normalize the IoT class value.

In existing Home Assistant documentation, ha_iot_class uses lowercase with an underscore (e.g., local_push) rather than a title-cased string. Please update:

-ha_iot_class: Local Push
+ha_iot_class: local_push

2-3: Clarify the description for consistency.

The description is clear but could read more idiomatically:

-description: Control your Nuki Matter devices using the Matter integration.
+description: Control Nuki Matter devices via the Matter integration.

This removes redundant phrasing and aligns with other integration docs.


21-23: Improve grammar and tone in introductory text.

  • Line 21: Change “making sure” to “ensuring” for a more formal tone.
  • Line 23: Replace “As all connectivity is happening locally” with “Because all connectivity happens locally” for readability.
-[Nuki](https://nuki.io) is committed to making sure their products are up-to-date and ready to use in Home Assistant.
+[Nuki](https://nuki.io) is committed to ensuring their products remain up-to-date and compatible with Home Assistant.

-Nuki Matter devices work locally and integrate seamlessly with the Matter integration in Home Assistant. As all connectivity is happening locally, status updates and controlling your devices happen instantly in Home Assistant.
+Nuki Matter devices work locally and integrate seamlessly with the Matter integration in Home Assistant. Because all connectivity happens locally, status updates and control occur instantly within Home Assistant.

27-28: Add a final newline and punctuation.

  • Ensure there's a blank line at EOF.
  • Add a period at the end of the link line for consistency with prose:
-[Learn more about Matter in Home Assistant.](/integrations/matter/)
+[Learn more about Matter in Home Assistant.](/integrations/matter/).

20-28: Enhance documentation structure with sections.

The file currently has only a brief description. To align with other integration docs, consider adding headings such as:

Features

  • Local Matter connectivity
  • Instant status updates

Configuration

Navigate to Settings → Devices & Services, click Add Integration, and select Nuki Matter.

Resources

This improves readability and helps users find information quickly.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5cbba07 and d683e2f.

📒 Files selected for processing (1)
  • source/_integrations/nuki_matter.markdown (1 hunks)
⏰ 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/nuki_matter.markdown (1)

25-25: Verify the badge macro syntax.

Most integration docs use the add_integration_badge macro, e.g.:

{% my add_integration_badge(domain=page.ha_domain) %}

Please confirm that add_matter_device is the correct macro name and syntax. If not, switch to the standard badge:

{% my add_integration_badge(domain=page.ha_domain) %}

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, @edenhaus 👍

../Frenck

@home-assistant home-assistant bot added the parent-merged The parent PR has been merged already label Apr 30, 2025
frenck
frenck previously requested changes Apr 30, 2025
Comment on lines +23 to +24
Nuki Matter devices work locally and integrate seamlessly with the Matter integration in Home Assistant. As all connectivity is happening locally, status updates and controlling your devices happen instantly in Home Assistant.

Copy link
Member

Choose a reason for hiding this comment

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

Do we need to list the devices?

@home-assistant home-assistant bot marked this pull request as draft April 30, 2025 09:15
@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.

@c0ffeeca7 c0ffeeca7 marked this pull request as ready for review April 30, 2025 11:37
@home-assistant home-assistant bot requested a review from frenck April 30, 2025 11:37
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, @edenhaus 👍

@c0ffeeca7 c0ffeeca7 dismissed frenck’s stale review April 30, 2025 11:37

input edenhaus: to be added later.

@c0ffeeca7 c0ffeeca7 merged commit df3be84 into next Apr 30, 2025
9 checks passed
@home-assistant home-assistant bot removed the parent-merged The parent PR has been merged already label Apr 30, 2025
@c0ffeeca7 c0ffeeca7 deleted the edenhaus-nuki-matter branch April 30, 2025 11:38
@github-actions github-actions bot locked and limited conversation to collaborators May 1, 2025
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