Skip to content

Add sensors to ntfy integration #39114

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: next
Choose a base branch
from
Open

Add sensors to ntfy integration #39114

wants to merge 1 commit into from

Conversation

tr4nt0r
Copy link
Contributor

@tr4nt0r tr4nt0r commented May 20, 2025 •
edited by coderabbitai bot
Loading

Proposed change

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 a new "Sensors" section to the ntfy integration documentation, detailing sensors for usage statistics and account limits across various categories such as messages, emails, phone calls, reserved topics, attachments, and subscription tier.

@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 20, 2025
@netlify Netlify
Copy link

netlify bot commented May 20, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit adf11ac
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/682c704489651600081f03a1
😎 Deploy Preview https://deploy-preview-39114--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.

@tr4nt0r tr4nt0r mentioned this pull request May 20, 2025
Open
19 tasks
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented May 20, 2025

📝 Walkthrough

Walkthrough

The documentation for the ntfy integration was updated to include a new "Sensors" section. This section details various sensors provided by the integration, categorizing them by the type of usage statistics and account limits they report. No changes were made to existing documentation or configuration instructions.

Changes

File Change Summary
source/_integrations/ntfy.markdown Added a new "Sensors" section describing device sensors for usage statistics and account limits, grouped by type.

Sequence Diagram(s)

No sequence diagram is generated as the changes are limited to documentation updates.

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

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.

coderabbitai[bot]
coderabbitai bot reviewed May 20, 2025
View reviewed changes
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 (6)
source/_integrations/ntfy.markdown (6)

106-112: Use standardized sensor macro for Message stats
To improve consistency with other Home Assistant docs and enable automatic linking of entities, replace the bold text with the sensor macro. For example:

- - **Messages published**: The total number of messages sent today.
+ - {{ sensor("ntfy", "messages_published") }}: The total number of messages sent today.

113-118: Use standardized sensor macro for Email stats
Likewise, consider using the sensor macro here:

- - **Emails sent**: The number of email notifications sent today.
+ - {{ sensor("ntfy", "emails_sent") }}: The number of email notifications sent today.

119-124: Use standardized sensor macro for Phone call stats
Update the phone-call bullets to use the macro for consistency:

- - **Phone calls made**: The total phone call alerts made today.
+ - {{ sensor("ntfy", "phone_calls_made") }}: The total phone call alerts made today.

125-130: Rename “Reserved topics” heading for parallelism
Other categories include “stats” in their headings. For consistency, rename to:

- ### 🔒 Reserved topics
+ ### 🔒 Reserved topics stats

And consider applying the sensor macro to each bullet as above.

131-139: Use standardized sensor macro for Attachment stats
Apply the same pattern to the attachment sensors. For example:

- - **Attachment storage**: The amount of storage space currently used by file attachments.
+ - {{ sensor("ntfy", "attachment_storage") }}: The amount of storage space currently used by file attachments.

140-143: Rename “Account” to “Account stats”
To maintain naming consistency across categories, update the heading to:

- ### ⭐ Account
+ ### ⭐ Account stats
📜 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 ca19430 and adf11ac.

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

102-105: Addition of Sensors section looks good
The new “## Sensors” section and introductory text correctly introduce the set of usage-related sensors. Ensure that this heading is reflected in the page’s table of contents and follows the prescribed ordering in the integration docs.

c0ffeeca7
c0ffeeca7 approved these changes May 20, 2025
View reviewed changes
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, @tr4nt0r 👍

@c0ffeeca7 c0ffeeca7 added the awaits-parent Awaits the merge of an parent PR label May 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@c0ffeeca7 c0ffeeca7 c0ffeeca7 approved these changes

Assignees
No one assigned
Labels
awaits-parent Awaits the merge of an parent PR has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@tr4nt0r @c0ffeeca7
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy