Skip to content

Add sensors to ntfy integration #145262

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 4 commits into
base: dev
Choose a base branch
from

Conversation

tr4nt0r
Copy link
Contributor

@tr4nt0r tr4nt0r commented May 20, 2025

Proposed change

The service itself is added as device and provides various sensors showing usage statistics and usage limits for your account (based on IP if unauthenticated)

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

Comment on lines +98 to +103
NtfySensorEntityDescription(
key=NtfySensor.EMAILS_REMAINING,
translation_key=NtfySensor.EMAILS_REMAINING,
value_fn=lambda account: account.stats.emails_remaining,
entity_registry_enabled_default=False,
),
Copy link
Member

Choose a reason for hiding this comment

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

I would argue that remaining also is diagnostic

Copy link
Contributor Author

@tr4nt0r tr4nt0r May 20, 2025

Choose a reason for hiding this comment

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

well, they are the invert of their respective sensors like NtfySensor.EMAILS and change at the same time. The limit entities on the other hand are quite static, they change based on the subscription tier, therefore i put them in diagnostics. I wasn't even sure if I should add them or not, but i decided to include them as deactivated by default. If you decide they are diagnostic entities or if they are not useful and should be removed, I'm ok with both.

@home-assistant home-assistant bot marked this pull request as draft May 20, 2025 17:41
@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.

@tr4nt0r tr4nt0r requested a review from joostlek May 20, 2025 18:14
@tr4nt0r tr4nt0r marked this pull request as ready for review May 20, 2025 19:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants