Update uptime.rst #4011
Closed
Update uptime.rst #4011
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add an example to get a humain readable uptime with simple function
WalkthroughThe update introduces an example YAML configuration for creating a human-readable uptime sensor using the Changes
Sequence Diagram(s)sequenceDiagram
actor User
participant YAML_Config as YAML Configuration
participant Uptime_Sensor as Uptime Sensor
participant Text_Sensor as Text Sensor
User->>YAML_Config: Define uptime sensor with lambda
YAML_Config->>Uptime_Sensor: Initialize sensor with on_value lambda
Uptime_Sensor->>Uptime_Sensor: Calculate uptime
Uptime_Sensor->>Text_Sensor: Format uptime in days, hours, minutes, seconds
Text_Sensor->>User: Display formatted uptime
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Comment on lines
+32
to
+49
| sensor: | ||
| - platform: uptime | ||
| name: Uptime Sensor | ||
| id: uptime_seconds | ||
| internal: true | ||
| on_value: | ||
| then: | ||
| - lambda: |- | ||
| char buffer[25]; | ||
| int seconds = (id(uptime_seconds).state); | ||
| int days = seconds / (24 * 3600); | ||
| seconds = seconds % (24 * 3600); | ||
| int hours = seconds / 3600; | ||
| seconds = seconds % 3600; | ||
| int minutes = seconds / 60; | ||
| seconds = seconds % 60; | ||
| sprintf(buffer, "%d days %d:%d:%d", days, hours, minutes, seconds); | ||
| id(uptime_human).publish_state(to_string(buffer)); |
There was a problem hiding this comment.
LGTM! But consider using snprintf for safety.
The code changes are approved. The lambda function correctly calculates and formats the uptime. However, consider using snprintf instead of sprintf to avoid potential buffer overflows.
- sprintf(buffer, "%d days %d:%d:%d", days, hours, minutes, seconds);
+ snprintf(buffer, sizeof(buffer), "%d days %d:%d:%d", days, hours, minutes, seconds);Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| sensor: | |
| - platform: uptime | |
| name: Uptime Sensor | |
| id: uptime_seconds | |
| internal: true | |
| on_value: | |
| then: | |
| - lambda: |- | |
| char buffer[25]; | |
| int seconds = (id(uptime_seconds).state); | |
| int days = seconds / (24 * 3600); | |
| seconds = seconds % (24 * 3600); | |
| int hours = seconds / 3600; | |
| seconds = seconds % 3600; | |
| int minutes = seconds / 60; | |
| seconds = seconds % 60; | |
| sprintf(buffer, "%d days %d:%d:%d", days, hours, minutes, seconds); | |
| id(uptime_human).publish_state(to_string(buffer)); | |
| sensor: | |
| - platform: uptime | |
| name: Uptime Sensor | |
| id: uptime_seconds | |
| internal: true | |
| on_value: | |
| then: | |
| - lambda: |- | |
| char buffer[25]; | |
| int seconds = (id(uptime_seconds).state); | |
| int days = seconds / (24 * 3600); | |
| seconds = seconds % (24 * 3600); | |
| int hours = seconds / 3600; | |
| seconds = seconds % 3600; | |
| int minutes = seconds = 60; | |
| seconds = seconds % 60; | |
| snprintf(buffer, sizeof(buffer), "%d days %d:%d:%d", days, hours, minutes, seconds); | |
| id(uptime_human).publish_state(to_string(buffer)); |
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
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. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add an example to get a humain readable uptime with simple function
Description:
Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable): esphome/esphome#
Checklist:
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/index.rstwhen creating new documents for new components or cookbook.