Add Probe Plus integration documentation #38665
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughA new documentation file has been introduced for the "Probe Plus" integration in Home Assistant. This file details the setup, supported devices, features, use cases, known limitations, and troubleshooting steps for integrating Bluetooth-enabled Probe Plus food temperature probes. The documentation covers supported models, sensor entities provided, connection behavior, and metadata relevant to Home Assistant releases and categorization. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HomeAssistant
participant ProbePlusDevice
User->>HomeAssistant: Power on Probe Plus device
HomeAssistant->>ProbePlusDevice: Discover via Bluetooth
ProbePlusDevice-->>HomeAssistant: Responds to discovery
HomeAssistant->>ProbePlusDevice: Attempt connection every 15 seconds
ProbePlusDevice-->>HomeAssistant: Provides sensor data (temperature, battery, etc.)
HomeAssistant-->>User: Exposes sensor entities for monitoring
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 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: 3
🧹 Nitpick comments (2)
source/_integrations/probe_plus.markdown (2)
21-21: Grammar and trailing whitespace
Replace "providing that the model is FM2**" with "provided that the model is FM2**" and remove the trailing space at the end of the line.🧰 Tools
🪛 LanguageTool
[style] ~21-~21: Consider shortening this phrase to avoid wordiness.
Context: ...robe should be discovered automatically providing that the model is FM2**. If you are configu...(PROVIDING_THAT)
🪛 markdownlint-cli2 (0.17.2)
21-21: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
57-57: Capitalize unit names
"Celsius" and "Fahrenheit" are proper nouns and must be capitalized.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/probe_plus.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/probe_plus.markdown
[style] ~21-~21: Consider shortening this phrase to avoid wordiness.
Context: ...robe should be discovered automatically providing that the model is FM2**. If you are configu...
(PROVIDING_THAT)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/probe_plus.markdown
21-21: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
⏰ 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
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
source/_integrations/probe_plus.markdown (3)
21-21: Fix preposition and remove trailing whitespace on discovery sentenceThe phrase “within Bluetooth range to your Home Assistant host” is uncommon—use “within Bluetooth range of your Home Assistant host”. Also, there is trailing whitespace at the end of the line.
- If your probe is within Bluetooth range to your Home Assistant host and the [Bluetooth](/integrations/bluetooth) integration is fully loaded, the probe should be discovered automatically provided that the model name starts with FM2. + If your probe is within Bluetooth range of your Home Assistant host and the [Bluetooth](/integrations/bluetooth) integration is fully loaded, the probe should be discovered automatically provided that the model name starts with FM2.🧰 Tools
🪛 LanguageTool
[uncategorized] ~21-~21: The preposition “of” seems more likely in this position.
Context: ...If your probe is within Bluetooth range to your Home Assistant host and the [Bluet...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
🪛 markdownlint-cli2 (0.17.2)
21-21: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
50-53: Improve use-case sentence clarityThe two clauses on monitoring temperatures and combining with Voice could be separated or joined more cleanly. For example:
- This integration can be used to monitor food temperatures, you could combine this with your Home Assistant Voice to alert you when the food has finished cooking. As a bonus, multiple probes are supported and therefore if you are cooking a large family meal, you can view all your food temperatures on one dashboard. + This integration can be used to monitor food temperatures. Combine this with Home Assistant Voice to alert you when cooking is complete. As a bonus, multiple probes are supported, so you can view all your food temperatures on one dashboard for a large family meal.
56-58: Refine known limitations wordingThe first bullet reads “While this integration is configured for your device,” which is a bit awkward. Consider clarifying that the connection is exclusive. For example:
- While this integration is configured for your device, you won't be able to use the official app, as only one connection at a time is supported. + While the Probe Plus integration is connected to your device, the official app cannot connect (only one Bluetooth connection is supported at a time).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/probe_plus.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/probe_plus.markdown
[uncategorized] ~21-~21: The preposition “of” seems more likely in this position.
Context: ...If your probe is within Bluetooth range to your Home Assistant host and the [Bluet...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/probe_plus.markdown
21-21: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
source/_integrations/probe_plus.markdown (6)
21-21: Fix preposition and remove trailing space
Use “within Bluetooth range of your Home Assistant host” instead of “range to,” and remove the extra space at the end of the line.- If your probe is within Bluetooth range to your Home Assistant host and the [Bluetooth](/integrations/bluetooth) integration is fully loaded, the probe should be discovered automatically provided that the model name starts with FM2. If you are configuring the device manually, your probe needs to be turned on during setup. + If your probe is within Bluetooth range of your Home Assistant host and the [Bluetooth](/integrations/bluetooth) integration is fully loaded, the probe should be discovered automatically provided that the model name starts with FM2. If you are configuring the device manually, your probe needs to be turned on during setup.🧰 Tools
🪛 LanguageTool
[uncategorized] ~21-~21: The preposition “of” seems more likely in this position.
Context: ...If your probe is within Bluetooth range to your Home Assistant host and the [Bluet...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
🪛 markdownlint-cli2 (0.17.2)
21-21: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
32-32: Replace ampersand with “and” in heading
For consistency and accessibility, use “and” instead of “&” in section headings.- ## Available platforms & entities + ## Available platforms and entities
46-46: Format device model names as code
Device identifiers should be back‑ticked to distinguish them as machine names.- - FMC210/FMC213 + - `FMC210` / `FMC213`
52-53: Split run‑on sentence for readability
Separate the comma splice into two sentences and preserve the bonus note.- This integration can be used to monitor food temperatures, you could combine this with your Home Assistant Voice to alert you when the food has finished cooking. As a bonus, multiple probes are supported and therefore if you are cooking a large family meal, you can view all your food temperatures on one dashboard. + This integration can be used to monitor food temperatures. You could combine this with your Home Assistant Voice to alert you when the food has finished cooking. + + As a bonus, multiple probes are supported and therefore if you are cooking a large family meal, you can view all your food temperatures on one dashboard.
57-57: Add missing comma for clarity
Insert a comma before the “in case” clause to improve readability.- Make sure you have changed this in the app before setting up in case you are using Fahrenheit. A template helper can be used to convert between units. + Make sure you have changed this in the app before setting up, in case you are using Fahrenheit. A template helper can be used to convert between units.🧰 Tools
🪛 LanguageTool
[uncategorized] ~57-~57: Possible missing comma found.
Context: ... changed this in the app before setting up in case you are using Fahrenheit. A tem...(AI_HYDRA_LEO_MISSING_COMMA)
68-68: Correct comma splice in “Remove integration” section
Split into two sentences for grammatical correctness.- This integration follows standard integration removal, no extra steps are required. + This integration follows standard integration removal. No extra steps are required.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/probe_plus.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/probe_plus.markdown
[uncategorized] ~21-~21: The preposition “of” seems more likely in this position.
Context: ...If your probe is within Bluetooth range to your Home Assistant host and the [Bluet...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~57-~57: Possible missing comma found.
Context: ... changed this in the app before setting up in case you are using Fahrenheit. A tem...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/probe_plus.markdown
21-21: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
🔇 Additional comments (2)
source/_integrations/probe_plus.markdown (2)
1-17: Front matter metadata is valid
All requiredha_*keys follow Home Assistant’s schema, and the YAML front matter is well‑formed.
25-30: Configuration block is correct
The{% configuration_basic %}include and its YAML structure follow documentation guidelines.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_integrations/probe_plus.markdown (2)
21-21: Use correct preposition and remove trailing whitespace
Replace “within Bluetooth range to your Home Assistant host ” with “within Bluetooth range of your Home Assistant host” and remove any trailing spaces:- If your probe is within Bluetooth range to your Home Assistant host and the [Bluetooth](/integrations/bluetooth) integration is fully loaded, the probe should be discovered automatically provided that the model name starts with FM2. + If your probe is within Bluetooth range of your Home Assistant host and the [Bluetooth](/integrations/bluetooth) integration is fully loaded, the probe should be discovered automatically provided that the model name starts with FM2.🧰 Tools
🪛 LanguageTool
[uncategorized] ~21-~21: The preposition “of” seems more likely in this position.
Context: ...If your probe is within Bluetooth range to your Home Assistant host and the [Bluet...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
🪛 markdownlint-cli2 (0.17.2)
21-21: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
57-57: Add missing comma for clarity
Consider adding a comma before “in case” to improve readability:- ... before setting up in case you are using Fahrenheit. + ... before setting up, in case you are using Fahrenheit.🧰 Tools
🪛 LanguageTool
[uncategorized] ~57-~57: Possible missing comma found.
Context: ... changed this in the app before setting up in case you are using Fahrenheit. A tem...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/probe_plus.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/probe_plus.markdown
[uncategorized] ~21-~21: The preposition “of” seems more likely in this position.
Context: ...If your probe is within Bluetooth range to your Home Assistant host and the [Bluet...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~57-~57: Possible missing comma found.
Context: ... changed this in the app before setting up in case you are using Fahrenheit. A tem...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/probe_plus.markdown
21-21: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
⏰ 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
🔇 Additional comments (11)
source/_integrations/probe_plus.markdown (11)
1-17: Front matter metadata is well‑formed
The YAML front matter includes all required keys (title,description,ha_release,ha_category,ha_iot_class,ha_config_flow,ha_domain,ha_platforms,ha_bluetooth,ha_codeowners,ha_integration_type,ha_quality_scale) and uses the correct formats.
19-19: Introduction is clear and concise
The opening sentence clearly defines the integration and links to the Probe Plus app.
25-26: Config flow inclusion is correct
The{% include integrations/config_flow.md %}directive is properly placed to show setup steps.
27-30: Basic configuration block is valid
Theconfiguration_basicexample is formatted correctly and provides clear guidance on selecting the Bluetooth device.
32-34: Functionality section structure is appropriate
The “Available functionality” section with a subheading for sensors follows Home Assistant docs conventions.
36-40: Sensor entity descriptions are clear and consistent
Each sensor name uses sentence-style capitalization and ends with a period. The notes on unsupported models are in‑line.
42-49: Supported devices section is clear
Listing tested models and encouraging contributions for additional device support is well handled.
50-53: Use‑cases guidance is informative
The example use‑case illustrates how to combine multiple probes with voice alerts, which is helpful for end users.
54-58: Known limitations are well‑documented
The points on exclusive connections and unit‑configuration assumptions provide users with realistic expectations.🧰 Tools
🪛 LanguageTool
[uncategorized] ~57-~57: Possible missing comma found.
Context: ... changed this in the app before setting up in case you are using Fahrenheit. A tem...(AI_HYDRA_LEO_MISSING_COMMA)
61-64: Troubleshooting instructions are adequate
The details block covers discovery issues, Bluetooth proxy recommendations, and debugging steps effectively.
66-69: Removal instructions align with standards
The “Removing the integration” section and service inclusion follow the standard documentation pattern.
Proposed change
Add documentation for Probe Plus integration
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit