Skip to content
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

Badges - Show timestamp the same way as timer #21298

Closed
wants to merge 2 commits into from

Conversation

surfingbytes
Copy link

@surfingbytes surfingbytes commented Jul 4, 2024

Proposed change

Badges currently support timer, where it nicely shows timer's icon and remaining time. This change handles sensor with device_class: timestamp the same way - icon with remaining time. That allows you to display remaining time to next sunrise, or next Alexa timer from Alexa Media Player integration (which is timestamp, not timer).

Before:
image
After:
image

Type of change

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

Example configuration

views:
  - path: default_view
    title: Home
    badges:
      - entity: sensor.sun_next_dawn
    cards: []

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue or discussion:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • There is no commented out code in this PR.
  • Tests have been added to verify that the new code works.

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

Summary by CodeRabbit

  • New Features
    • Enhanced badge functionality to handle sensor device classes, particularly timestamps. The badge now correctly evaluates and displays state information for timestamp sensors.

Copy link
Contributor

coderabbitai bot commented Jul 4, 2024

Walkthrough

The changes to the ha-state-label-badge.ts file focus on improving the handling of sensor device classes, specifically for timestamps. The updates introduce logic to manage state calculations, intervals, and timestamp remaining estimations when the sensor device class is a timestamp. This refinement enhances the HaStateLabelBadge component by enabling precise handling of timestamp-based sensors, including enforcement of specific conditions, state evaluations, and improved interval management.

Changes

File Change Summary
src/components/entity/ha-state-label-badge.ts - Added import for SENSOR_DEVICE_CLASS_TIMESTAMP.
- Modified computeStateValue, computeStateDomain, and computeStateUnit methods to handle timestamp device class.
- Restructured startInterval method to separately manage timer and sensor domains with the new timestamp logic.
- Introduced new method calculateTimestampRemaining for timestamp calculations.

Sequence Diagram(s)

sequenceDiagram
    participant HaStateLabelBadge
    participant Sensor
    participant Timer
    
    Note over HaStateLabelBadge: Interval Management Based on Device Class
    HaStateLabelBadge ->> Sensor: Check `attributes.device_class`
    alt is `SENSOR_DEVICE_CLASS_TIMESTAMP`
        HaStateLabelBadge ->> HaStateLabelBadge: calculateTimestampRemaining()
        HaStateLabelBadge ->> HaStateLabelBadge: Update State Value, Domain, and Unit
    else is Not `SENSOR_DEVICE_CLASS_TIMESTAMP`
        HaStateLabelBadge ->> Timer: Handle Timer Normally
        HaStateLabelBadge ->> HaStateLabelBadge: Update State Value, Domain, and Unit
    end
Loading

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@surfingbytes
Copy link
Author

@matthiasdebaat could you please check this? Are PR reviewers not automatically assigned?
The screenshot is with next sun dawn, because that's an entity that's always there so I was able to use it. However, better example would be dishwasher finish time.
Thank you

@piitaya
Copy link
Member

piitaya commented Jul 15, 2024

Hi 👋
We are working on a redesign of the badge with the design team : #21401
It will be possible to customize the display state on these badge like the tile card. So I guess we can add an option to choose between absolute time (July 15, 2024, 8:20), relative time (in 2 hours) or live timer (2:04:01).

Also, I'm not sure it makes sense for all timestamps. For moon and sun, the date is always less than 1 day but for some others it can be many days. So, I guess it should be an option, not the default.

@surfingbytes
Copy link
Author

Hi @piitaya , thanks for the info. The new badges looks cool. However, as they look completely different from the current ones, could the current ones be renamed to, let's say, alerts? That way thy could be uses in parallel to the new ones. Tbh, with the red circle, they even look like alerts, and I'm using them as such - to show plants that need watering, batteries that needs replacing, running timers etc. It would also be great if they can be used as cards (=anywhere on dashboard, not just on top).

Anyway, whether you decide to completely replace current badges with the new ones, or have them side by side (under different names of course), it can take anywhere between 6 months to infinity :) And in that case, would it be possible to approve this PR, so we have at least something until the new badges arrive? This PR really does change it to better, looking at the before/after screenshots.

@bramkragten
Copy link
Member

We decided not to keep the old badges around and replace them fully. We are open to adding other types of badges, but they will have to fit in the new design system.

It is also possible to create custom badges to keep using the old, or any other, style of badges.

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.

3 participants