Persistent values after reboot for sensor_total_energy and sensor_total_daily_energy #527

ojwc · 2024-07-06T09:53:26Z

Changes to pulse_meter, sensor_total_energy, and sensor_total_daily_energy to restore their previous values after a reboot

Also adds on_boot flag to esphome which calls pulse_meter.set_total_pulses to manually restore the value as pulse_meter total doesn't have a restore flag.

Finally, added preferences to restrict flash writes to once every 5 minutes, to reduce wear on flash memory.

Tested on ESP32 nodemcu-32s only.

Summary by CodeRabbit

New Features
- Added configuration for resetting pulse meter total pulses on boot.
- Introduced settings for flash write interval to optimize web server performance.
- Added a global variable to persist total energy readings across reboots.
Improvements
- Enhanced sensor reading filters for more accurate pulse rate calculations.
- Implemented a restore property for the sensor to maintain state across reboots.

create global variable persist_sensor_total_energy, supports making sensor_total_energy persistent after reboot

restricts flash write intervals to 5 minutes, ensures no unnecessary wear on flash memory

change pulse_meter_on_raw_value filter so it writes sensor_total_energy to global persist_sensor_total_energy

adding on_boot flag to restore sensor_total_energy from flash after a reboot.

adding restore: True to sensor_total_daily_energy so previous value is restored from flash after boot

vercel · 2024-07-06T09:53:30Z

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	Aug 12, 2024 11:46pm
home-assistant-glow-wupl	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 12, 2024 11:46pm

coderabbitai · 2024-07-06T09:53:55Z

Walkthrough

The recent updates enhance the configuration of the pulse_meter component and the Home Assistant Glow ESP32 settings. Key changes include the introduction of a restore property for persistent sensor states, the setup of pulse_meter.set_total_pulses to initialize on boot, and adjustments to flash_write_interval preferences. Additionally, a global variable for tracking total energy has been added, improving data retention and operational reliability.

Changes

File Path	Change Summary
components/pulse_meter.yaml	Updated sensor filters with a new lambda function and added the `restore` property to sensors.
home-assistant-glow/esp32.yaml	Introduced `pulse_meter.set_total_pulses` on boot, updated `flash_write_interval` preferences, and added a persistent global variable for total energy.

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

ojwc · 2024-07-06T09:54:12Z

PS: apologies for the excessive number of commits, I haven't done this before.

coderabbitai

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 359f22f and 3b9104a.

Files selected for processing (2)

components/pulse_meter.yaml (2 hunks)
home-assistant-glow/esp32.yaml (2 hunks)

Additional context used

yamllint

home-assistant-glow/esp32.yaml

[error] 28-28: trailing spaces

(trailing-spaces)

[error] 30-30: trailing spaces

(trailing-spaces)

Additional comments not posted (4)

home-assistant-glow/esp32.yaml (2)

68-72: LGTM!

Setting flash_write_interval to 5 minutes to reduce flash wear is a good practice.

73-76: LGTM!

Adding a global variable persist_sensor_total_energy with restore_value set to true is appropriate for persisting the sensor value across reboots.

components/pulse_meter.yaml (2)

64-68: LGTM!

The lambda function appropriately updates the value of persist_sensor_total_energy and computes the pulse rate.

94-97: LGTM!

Setting the restore property to true for the sensor_total_daily_energy is appropriate for enabling state restoration across reboots.

home-assistant-glow/esp32.yaml

good bot Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3b9104a and 3103eb3.

Files selected for processing (1)

home-assistant-glow/esp32.yaml (2 hunks)

Files skipped from review as they are similar to previous changes (1)

home-assistant-glow/esp32.yaml

klaasnicolaas

Since we adjust things in pulse_meter, adjustments are also needed in the ESP8266 code, otherwise it will break.

components/pulse_meter.yaml

fixed formatting + added explanatory comment

coderabbitai

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3103eb3 and 0ea7e5d.

Files selected for processing (1)

components/pulse_meter.yaml (2 hunks)

Additional context used

yamllint

components/pulse_meter.yaml

[error] 68-68: syntax error: expected , but found ''

(syntax)

Additional comments not posted (1)

components/pulse_meter.yaml (1)

93-93: The addition of the restore property is approved.

Adding restore: True ensures the sensor's state is retained across reboots, enhancing reliability.

components/pulse_meter.yaml

ojwc · 2024-08-12T23:45:18Z

I don't have any ESP8266 devices available for testing - are you able to make the necessary adjustments?

formatting :( Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0ea7e5d and eddfec9.

Files selected for processing (1)

components/pulse_meter.yaml (2 hunks)

Files skipped from review as they are similar to previous changes (1)

components/pulse_meter.yaml

github-actions · 2024-09-12T08:12:05Z

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.

ojwc added 5 commits July 6, 2024 19:33

Update esp32.yaml

126b8c2

create global variable persist_sensor_total_energy, supports making sensor_total_energy persistent after reboot

Update esp32.yaml

97d93bf

restricts flash write intervals to 5 minutes, ensures no unnecessary wear on flash memory

Update pulse_meter.yaml

3a32e04

change pulse_meter_on_raw_value filter so it writes sensor_total_energy to global persist_sensor_total_energy

Update esp32.yaml

05d85b9

adding on_boot flag to restore sensor_total_energy from flash after a reboot.

Update pulse_meter.yaml

3b9104a

adding restore: True to sensor_total_daily_energy so previous value is restored from flash after boot

vercel bot deployed to Preview July 6, 2024 09:54 View deployment

coderabbitai bot reviewed Jul 6, 2024

View reviewed changes

home-assistant-glow/esp32.yaml Outdated Show resolved Hide resolved

Update home-assistant-glow/esp32.yaml

3103eb3

good bot Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

vercel bot deployed to Preview July 6, 2024 09:57 View deployment

coderabbitai bot reviewed Jul 6, 2024

View reviewed changes

klaasnicolaas added new-feature New features or request. enhancement Enhancement of the code, not introducing new features. labels Jul 23, 2024

klaasnicolaas requested changes Jul 23, 2024

View reviewed changes

components/pulse_meter.yaml Outdated Show resolved Hide resolved

components/pulse_meter.yaml Outdated Show resolved Hide resolved

Update pulse_meter.yaml

0ea7e5d

fixed formatting + added explanatory comment

vercel bot deployed to Preview August 12, 2024 23:44 View deployment

coderabbitai bot reviewed Aug 12, 2024

View reviewed changes

components/pulse_meter.yaml Outdated Show resolved Hide resolved

Update components/pulse_meter.yaml

eddfec9

formatting :( Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

ojwc requested a review from klaasnicolaas August 12, 2024 23:46

vercel bot deployed to Preview August 12, 2024 23:46 View deployment

coderabbitai bot reviewed Aug 12, 2024

View reviewed changes

github-actions bot added the stale There has not been activity on this issue or PR for quite some time. label Sep 12, 2024

klaasnicolaas added no-stale This issue or PR is exempted from the stable bot. and removed stale There has not been activity on this issue or PR for quite some time. labels Sep 12, 2024

klaasnicolaas mentioned this pull request Sep 13, 2024

House Total Energy get reset #319

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Persistent values after reboot for sensor_total_energy and sensor_total_daily_energy #527

Persistent values after reboot for sensor_total_energy and sensor_total_daily_energy #527

ojwc commented Jul 6, 2024 •

edited by coderabbitai bot

Loading

vercel bot commented Jul 6, 2024 •

edited

Loading

coderabbitai bot commented Jul 6, 2024 •

edited

Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

ojwc commented Jul 6, 2024

coderabbitai bot left a comment

coderabbitai bot left a comment

klaasnicolaas left a comment

coderabbitai bot left a comment

ojwc commented Aug 12, 2024

coderabbitai bot left a comment

github-actions bot commented Sep 12, 2024

Persistent values after reboot for sensor_total_energy and sensor_total_daily_energy #527

Are you sure you want to change the base?

Persistent values after reboot for sensor_total_energy and sensor_total_daily_energy #527

Conversation

ojwc commented Jul 6, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

vercel bot commented Jul 6, 2024 • edited Loading

coderabbitai bot commented Jul 6, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

ojwc commented Jul 6, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

klaasnicolaas left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

ojwc commented Aug 12, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

github-actions bot commented Sep 12, 2024

ojwc commented Jul 6, 2024 •

edited by coderabbitai bot

Loading

vercel bot commented Jul 6, 2024 •

edited

Loading

coderabbitai bot commented Jul 6, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)