thermopro: add set_datetime button for TP358/TP393 #36987
Conversation
home-assistant
bot
added
has-parent
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request updates the ThermoPro integration documentation by adding a new "Buttons" section. This section documents a new "Set Date&Time" action that sets the device’s time (on models TP358 and TP393) to the system time in a 24-hour format. Additionally, it provides an example YAML automation that demonstrates how to schedule this action daily via Home Assistant. Changes
Sequence Diagram(s)sequenceDiagram
participant HA as Home Assistant
participant TP as ThermoPro Device
Note over HA: Daily Automation Trigger
HA->>HA: Trigger automation at scheduled time
HA->>HA: Execute button.press action ("Set Date&Time")
HA->>TP: Send command with system date/time (24-hour format)
TP-->>HA: (Optional) Acknowledge time update
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}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
source/_integrations/thermopro.markdown (3)
37-38: Style Enhancement: Formatting Device Names
Consider adding a space before the parenthesis for clarity. For example, change
devices(TP358, TP393)
to
devices (TP358, TP393).
41-42: Grammar & Consistency: Use Hyphenated Notation
Use "24-hour" and "12-hour" instead of "24 hour" and "12 hour" for consistency and clarity. For example, update the text to:
"Sets the date & time on target devices to the system time in 24-hour notation."
and
"The device is capable of showing 12-hour notation (AM/PM), but setting this is currently not implemented."🧰 Tools
🪛 LanguageTool
[grammar] ~42-~42: Possible agreement error. The noun ‘hour’ seems to be countable.
Context: ...on. The device is capable of showing 12 hour notation(AM/PM) but setting this is cur...(CD_NN)
44-44: Grammar Correction: Clarify the Example Description
The sentence "For example, the following action in an automation and set the datetime of the thermometer each day." is ambiguous. Consider revising it to:
"For example, the following automation sets the datetime of the thermometer each day."
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/thermopro.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/thermopro.markdown
[grammar] ~42-~42: Possible agreement error. The noun ‘hour’ seems to be countable.
Context: ...on. The device is capable of showing 12 hour notation(AM/PM) but setting this is cur...
(CD_NN)
🔇 Additional comments (1)
source/_integrations/thermopro.markdown (1)
48-61: YAML Format: Trigger Key Verification
The provided YAML snippet uses "triggers:" with an item specifying- trigger: time. Home Assistant automations typically specify time-based triggers with the keyplatform: time. Please verify if"trigger: time"is correct for this integration or consider replacing it with:- triggers: - - trigger: time - at: "03:03:03" + trigger: + - platform: time + at: "03:03:03"This ensures the example aligns with common Home Assistant automation conventions.
bdraco
changed the title
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_integrations/thermopro.markdown (1)
46-61: YAML Automation Example: Validate Key NamesThe included YAML automation example is helpful, and wrapping it in
{% raw %}tags is the recommended practice to avoid templating issues. However, please consider aligning the key names with the standard Home Assistant automation conventions. Typically:
- Use
trigger:(singular) with a key such asplatform: timerather than "triggers:" containing "trigger: time".- Similarly, use
action:(singular) with a key such asservice: button.pressrather than "actions:" containing "action: button.press".Below is a suggested diff for clarity and consistency:
-mode: single -triggers: - - trigger: time - at: "03:03:03" -conditions: [] -actions: - - action: button.press - target: - entity_id: button.tp_358_xxxx_your_device_set_date_time - data: {} +mode: single +trigger: + - platform: time + at: "03:03:03" +condition: [] +action: + - service: button.press + target: + entity_id: button.tp_358_xxxx_your_device_set_date_time + data: {}Review that this proposed change aligns with the Home Assistant automation YAML guidelines, and adjust if the current naming is intentional for your integration.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/thermopro.markdown(1 hunks)
🔇 Additional comments (2)
source/_integrations/thermopro.markdown (2)
34-38: New "Buttons" Section Addition is Well-StructuredThe addition of the "Buttons" section clearly documents the new capability for setting the time on supported devices (TP358, TP393) via Home Assistant. The description is concise and adheres to the documentation standards.
39-43: Clear Documentation of "Set Date&Time" ActionThe "Set Date&Time" button section is clearly titled and explains that the action sets the device’s time in 24-hour notation, while also noting the limitation regarding 12-hour formatting. This clarity will help users understand the current functionality.
Proposed change
In home-assistant/core#135740, I am about to add a service to set the date&time for ThermoPro TP358/TP393 temperature sensor thingies.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit