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

Move pulse meter flash trigger to total sensor #690

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

gapple
Copy link

@gapple gapple commented Dec 29, 2024

In #135 it was determined that when the Pulse Meter reads the same duration between subsequent pulses, the sensor is not updated and on_raw_value is never triggered so the LED never flashes. This becomes increasingly likely during high usage as pulse durations become shorter.
This PR moves the trigger to the Pulse Meter's Total sensor, which does get triggered for every pulse.
The light.turn_on action can also be called with a flash_length parameter, rather than using turn_on, delay, turn_off.

During high pulse rates a first pulse's turn_off may trigger between a later pulse's turn_on and turn_off, resulting in inconsistent flash lengths, though I'm not sure if using flash_length might address this. With a meter that pulses for each Wh (1000 / kWh), 100ms flashes should be distinct for loads below 36 kW, while 200ms flashes would overlap at 18kW.

Summary by CodeRabbit

  • New Features
    • Enhanced pulse meter sensor configuration with a more responsive LED indicator
    • Simplified LED feedback mechanism when receiving raw sensor values

Copy link

vercel bot commented Dec 29, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
home-assistant-glow ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 29, 2024 10:20am

Copy link
Contributor

coderabbitai bot commented Dec 29, 2024

📝 Walkthrough

Walkthrough

The pull request modifies the components/pulse_meter.yaml configuration file, focusing on the event handling for pulse meter sensor raw values. The changes streamline the LED indicator's response mechanism by introducing a direct flash for the led_red light when a raw value is received from the sensor_total_energy entity. This replaces the previous more complex event handler that involved turning the light on, waiting, and then turning it off.

Changes

File Change Summary
components/pulse_meter.yaml - Added on_raw_value event handler for sensor_total_energy
- Implemented direct light.turn_on for led_red with 100ms flash length
- Removed previous on_raw_value event handler for sensor_energy_pulse_meter

Sequence Diagram

sequenceDiagram
    participant Sensor as sensor_total_energy
    participant LED as led_red
    
    Sensor->>LED: Raw value received
    LED->>LED: Flash for 100ms
Loading

The sequence diagram illustrates the simplified event handling: when a raw value is received from the sensor_total_energy, the led_red immediately flashes for a short duration (100ms).


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>, 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. (Beta)
  • @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 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 (1)
components/pulse_meter.yaml (1)

74-78: Consider documenting flash timing behavior

While the 100ms flash timing is well-chosen for typical usage (distinct flashes below 36kW), consider adding a comment in the configuration to document:

  • The relationship between power consumption and flash overlap
  • The rationale for choosing 100ms (helps future maintenance)

Example comment to add above the on_raw_value section:

# Flash timing: 100ms provides distinct flashes for loads below 36kW
# For meters with 1000 imp/kWh, flashes may overlap at higher loads
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1b1ced9 and fa901b0.

📒 Files selected for processing (1)
  • components/pulse_meter.yaml (1 hunks)
🔇 Additional comments (2)
components/pulse_meter.yaml (2)

Line range hint 31-73: Sensor configuration maintains proper metrics and calculations

The pulse meter and total energy sensor configurations are well structured with:

  • Appropriate state_class and device_class assignments
  • Correct unit conversions through lambda filters
  • Proper handling of pulse rate calculations

74-78: Implementation aligns well with PR objectives

The new flash trigger implementation using flash_length: 100ms is a good solution that:

  • Simplifies the code by using an atomic operation
  • Reduces the risk of flash interference during high pulse rates
  • Provides distinct flashes for loads below 36kW as required

Let's verify the flash_length parameter support:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant