Update docs for xgzp68xx component. #5255
Conversation
Co-authored-by: Samuel Sieb <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
This pull request updates documentation for the XGZP68xx component by replacing the existing documentation with V2-specific documentation that addresses confusion between different generations of the sensor. The key changes clarify that CFSensor produces multiple generations of sensors with identical model numbers but completely different I²C interfaces.
- Replaces generic XGZP68xx documentation with V2-specific documentation
- Adds detailed explanation of sensor generations and their differences
- Includes comprehensive pressure range table with corresponding k_values
- Adds calibration guidance and noise characteristics information
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| components/sensor/xgzp68xx_v2.rst | New comprehensive documentation for V2 series sensors with detailed configuration and calibration guidance |
| components/sensor/xgzp68xx.rst | Removes the original generic documentation file |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
components/sensor/xgzp68xx_v2.rst
Outdated
| - **temperature** (*Optional*): All options from :ref:`Sensor <config-sensor>`. | ||
| - **pressure** (*Optional*): All options from :ref:`Sensor <config-sensor>`. | ||
| - **oversampling** (*Optional*): One of ``256x``, ``512x``, ``1024x``, ``2048x``, ``4096x``, ``8192x``, ``16384x``, ``32768x``. It is not possible to disable oversampling. If not specified, this defaults to ``4096x``. | ||
| - **k_value** (*Optional*, int): The K value comes from the table above. It will default to 4096 if not specified. |
There was a problem hiding this comment.
The default k_value of 4096 is inconsistent with the pressure range table above. According to the table, k_value 4096 corresponds to -2.5 kPa to +2.5 kPa range, but the table shows 16384 for the -0.5 kPa to +0.5 kPa range which seems more appropriate as a safe default.
| - **k_value** (*Optional*, int): The K value comes from the table above. It will default to 4096 if not specified. | |
| - **k_value** (*Optional*, int): The K value comes from the table above. It will default to 16384 if not specified. |
Copilot uses AI. Check for mistakes.
There was a problem hiding this comment.
The previous default used by this component was 4096.
There is a strong argument to make this config option mandatory.
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Description:
Related issue (if applicable): fixes https://github.com/orgs/esphome/discussions/3286
Pull request in esphome with YAML changes (if applicable):
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
/components/index.rstwhen creating new documents for new components or cookbook.