Skip to content

provide Squeezebox player sensor for next alarm timestamp#155788

Merged
joostlek merged 6 commits into
home-assistant:devfrom
wollew:player_sensor_next_alarm
Dec 22, 2025
Merged

provide Squeezebox player sensor for next alarm timestamp#155788
joostlek merged 6 commits into
home-assistant:devfrom
wollew:player_sensor_next_alarm

Conversation

@wollew
Copy link
Copy Markdown
Contributor

@wollew wollew commented Nov 4, 2025

Proposed change

This PR provides a player sensor with the time stamp of the next scheduled alarm for this player. It is a follow-up to #154491 which provides binary sensors for player alarms.

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

  • I understand the code I am submitting and can explain how it works.
  • 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.
  • Any generated code has been carefully reviewed for correctness and compliance with project standards.

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:

@home-assistant
Copy link
Copy Markdown
Contributor

home-assistant Bot commented Nov 4, 2025

Hey there @rajlaud, @pssc, @peteS-UK, mind taking a look at this pull request as it has been labeled with an integration (squeezebox) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of squeezebox can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign squeezebox Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds player-level alarm sensors to the Squeezebox integration, complementing the existing server-level sensors. The new functionality includes three binary sensors for alarm states (active, snoozed, upcoming) and one timestamp sensor for the next scheduled alarm time.

Key changes:

  • Added player-based alarm sensors (binary sensors for alarm states and timestamp sensor for next alarm)
  • Refactored test setup to use platform-specific fixtures reducing code duplication
  • Introduced new sensor entity classes that follow the existing SqueezeboxEntity pattern

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
homeassistant/components/squeezebox/sensor.py Added player alarm timestamp sensor entity class and setup logic
homeassistant/components/squeezebox/binary_sensor.py Added player alarm binary sensor entities for active, snoozed, and upcoming states
homeassistant/components/squeezebox/const.py Added constants for new player alarm sensor keys
homeassistant/components/squeezebox/strings.json Added translation keys for the new alarm sensor entities
tests/components/squeezebox/test_sensor.py Added test coverage for player alarm sensor and refactored test structure
tests/components/squeezebox/test_binary_sensor.py Added comprehensive tests for player alarm binary sensors
tests/components/squeezebox/test_switch.py Fixed incorrect docstring describing media_player instead of switch
tests/components/squeezebox/conftest.py Added alarm-related mock attributes to test player fixture

Comment thread homeassistant/components/squeezebox/binary_sensor.py
Comment thread homeassistant/components/squeezebox/sensor.py
@wollew wollew marked this pull request as draft November 4, 2025 13:33
@wollew wollew changed the title Squeezebox: provide player sensor for next alarm timestamp provide Squeezebox player sensor for next alarm timestamp Nov 10, 2025
@wollew wollew force-pushed the player_sensor_next_alarm branch from d114a80 to 5a62894 Compare December 7, 2025 15:39
@wollew wollew marked this pull request as ready for review December 7, 2025 17:30
Comment on lines +147 to +153
@property
def native_value(self) -> StateType:
"""Sensor value directly from player coordinator."""
return cast(
StateType,
getattr(self.coordinator.player, self.entity_description.key, None),
)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Instead of using getattr, I'd rather see the entity description being extended with a value_fn that return the value of the entity, as that would be typed, we can avoid the cast as well

Copy link
Copy Markdown
Contributor Author

@wollew wollew Dec 18, 2025

Choose a reason for hiding this comment

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

Done. I was surprised to find that StateType does not include datetime. So I changed the return value of native_value() to datetime, because currently the only sensor returns exactly that. To have a more general implementation this would have to be StateType | date | datetime | Decimal according to https://developers.home-assistant.io/docs/core/entity/sensor, is this correct?

@home-assistant home-assistant Bot marked this pull request as draft December 18, 2025 12:50
@home-assistant
Copy link
Copy Markdown
Contributor

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.

@wollew wollew marked this pull request as ready for review December 18, 2025 15:03
@home-assistant home-assistant Bot requested a review from joostlek December 18, 2025 15:03
@joostlek joostlek merged commit 01c3e88 into home-assistant:dev Dec 22, 2025
36 checks passed
@wollew wollew deleted the player_sensor_next_alarm branch December 22, 2025 13:16
@github-actions github-actions Bot locked and limited conversation to collaborators Dec 23, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants