add docs for added climate.pid. set_deadband_control_parameters_multipliers action and K[P,I,D]_DEADBAND_MULTIPLIER sensors in pid climate.#6266
Conversation
…pliers action and K[P,I,D]_DEADBAND_MULTIPLIER sensors in pid climate.
There was a problem hiding this comment.
Pull request overview
Updates the PID Climate documentation to cover newly added runtime deadband PID multiplier controls and associated diagnostic sensor types, aligning docs with the corresponding ESPHome feature addition.
Changes:
- Documented the new
climate.pid.set_deadband_control_parameters_multipliersaction, including usage example and configuration options. - Added
KP_DEADBAND_MULTIPLIER,KI_DEADBAND_MULTIPLIER, andKD_DEADBAND_MULTIPLIERto thepidsensortypelist.
You can also share your feedback on Copilot code review. Take the survey.
| - `KD` - The current factor for the differential term of the PID controller. | ||
| - `KP_DEADBAND_MULTIPLIER` - The current deadband multiplier for the proportional term. | ||
| - `KI_DEADBAND_MULTIPLIER` - The current deadband multiplier for the integral term. | ||
| - `KD_DEADBAND_MULTIPLIER` - The current deadband multiplier for the differential term. |
There was a problem hiding this comment.
The new KD_DEADBAND_MULTIPLIER bullet uses “differential term”, while earlier in this document the corresponding PID term is referred to as the “derivative term” (e.g., DERIVATIVE and the kd parameter). Consider using consistent terminology here (and for KD) to avoid confusing readers about whether this refers to the D/derivative term.
| - `KD` - The current factor for the differential term of the PID controller. | |
| - `KP_DEADBAND_MULTIPLIER` - The current deadband multiplier for the proportional term. | |
| - `KI_DEADBAND_MULTIPLIER` - The current deadband multiplier for the integral term. | |
| - `KD_DEADBAND_MULTIPLIER` - The current deadband multiplier for the differential term. | |
| - `KD` - The current factor for the derivative term of the PID controller. | |
| - `KP_DEADBAND_MULTIPLIER` - The current deadband multiplier for the proportional term. | |
| - `KI_DEADBAND_MULTIPLIER` - The current deadband multiplier for the integral term. | |
| - `KD_DEADBAND_MULTIPLIER` - The current deadband multiplier for the derivative term. |
WalkthroughThis pull request updates the PID controller documentation in the climate component, adding a new action for configuring runtime deadband control parameter multipliers and exposing three new sensor fields for reading current deadband multiplier values. Also includes a clarification note on when PID parameter updates take effect. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Suggested labels
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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. Comment |
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![esphome[bot]](https://avatars.githubusercontent.com/in/247347?s=60&v=4){kind=small}
There was a problem hiding this comment.
As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
Update docs for esphome PR14730.
Add action climate.pid.set_deadband_control_parameters_multipliers
Add sensors K{P,I,D]_DEADBAND_MULTIPLIER
**Related issue (if applicable): NA
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
/src/content/docs/components/index.mdxwhen creating new documents for new components or cookbook.New Component Images
If you are adding a new component to ESPHome, you can automatically generate a standardized black and white component name image for the documentation.
To generate a component image:
Comment on this pull request with the following command, replacing
component_namewith your component name in lower_case format with underscores (e.g.,bme280,sht3x,dallas_temp):The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.
Extract the SVG file and place it in the
/public/images/folder of this repository.Use the image in your component's index table entry in
/src/content/docs/components/index.mdx.Example: For a component called "DHT22 Temperature Sensor", use:
Note: All images used in ImgTable components must be placed in
/public/images/as the component resolves them to absolute paths.