Add current cavity temperature sensor to Home Connect docs #37694
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe documentation was updated to include a new sensor labeled "Current cavity temperature" for oven appliances. This update details the sensor's description, notes its availability exclusively for ovens, and includes a caution advising against its use due to potential accuracy issues. Changes
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
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 (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_integrations/home_connect.markdown (1)
810-816: Clarify the disclaimer text for improved clarityThe new sensor entry for Current cavity temperature is clear, but the disclaimer message contains a double negative: "It is not recommended to not use the Current cavity temperature sensor..." This wording can be confusing. Consider rephrasing it to clearly discourage relying on this sensor. For example:
-{% important %} -It is not recommended to not use the **Current cavity temperature** sensor because the temperature might not provide the necessary accuracy. -{% endimportant %} +{% important %} +It is not recommended to use the **Current cavity temperature** sensor because its readings may be inaccurate. +For more details, please refer to the [Home Connect API documentation](https://developer.home-connect.com). +{% endimportant %}This change improves clarity and informs users with a direct reference to the API documentation.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/home_connect.markdown(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
| - **Availability**: Oven | ||
|
|
||
| {% important %} | ||
| It is not recommended to use the **Current cavity temperature** sensor because the temperature might not provide the necessary accuracy. |
There was a problem hiding this comment.
Not recommended for what? To measure the core temp of meat?
There was a problem hiding this comment.
I don't know 😅, I copy-pasted the information from the docs
There was a problem hiding this comment.
Also, there is no more information in the docs about what does the entity do
There was a problem hiding this comment.
I see. Those docs aren't very helpful there. Maybe we remove the notice? It isn't really helpful if we don't know what it actually measures and what we should use instead.
There was a problem hiding this comment.
Adding the disclaimer is something that @MartinHjelmare and I talked about adding because we wanted to make sure that the disclaimer from the Home Connect documentation was added here too.
About what measures, the name of the key (Cooking.Oven.Status.CurrentCavityTemperature) makes me think that it is a sensor that an Oven can have that measures the air temperature of the cavity,
There was a problem hiding this comment.
My interpretation of "oven cavity" is it's the inside compartment of the oven where you cook the food.
In the API provider docs, this notice is mentioned in the context of pre-heating an oven. This data point is also left out of the table of available data points and only mentioned in this note. My impression is they don't want to promote this data point since its precision is low. That's just a guess though.
Proposed change
Add current cavity temperature sensor to Home Connect integration docs
Added a disclaimer because the Home Connect API does warn about this sensor:
(link)
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
New Features
Documentation