Draft
Conversation
Add documentation for weather-compensated heating controller with heating curve calculation and optional PID correction.
Highlight the visualization and tuning tool for heating curve parameters.
- Use proper mathematical notation with KaTeX - Explain radiator exponent physics - Add example flow temperature table
Lead with intuition and practical guidance, follow with math for reference.
Document when to use zero vs nonzero multipliers with trade-offs.
Include units prominently and warn about thermal shock risks.
Clarify why +20°C outdoor shows 26°C (min).
Use SCREAMING_SNAKE_CASE for sensor types to match the actual enum values in the equitherm sensor platform.
- outdoor_fallback_active → outdoor_sensor_fault - indoor_fallback_active → indoor_sensor_fault
Relocate Building Type/Typical Range tables for heat_curve_coefficient and heat_curve_exponent to appear right after "What Each Setting Does" section. Replace duplicate tables in Control Parameters with links.
Add missing documentation for manual_flow_temp configuration option that enables a "Manual" preset bypassing heating curve and rate limiting for direct boiler control. Include example YAML with template number.
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
P4uLT
force-pushed
the
feature/equitherm-climate
branch
from
d78d4fb to
ea49b15
Compare
12 tasks
P4uLT
force-pushed
the
feature/equitherm-climate
branch
from
1be098d to
77d5ab2
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds comprehensive documentation for the
equithermclimate platform - a weather-compensated heating controller that calculates optimal flow temperature based on outdoor conditions.Related issue (if applicable): fixes
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.