-
Notifications
You must be signed in to change notification settings - Fork 1.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documentation for new OpenTherm component #3800
Conversation
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
# Conflicts: # index.rst
…docs into opentherm-next-docs
…docs into opentherm-next-docs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mostly clean-up & copy fixes.
Also, please wrap all lines at no more than 120 characters.
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Couple other things I missed earlier -- for pins in documentation, we use GPIOXX
to prompt the user to specify their own pins.
Co-authored-by: Keith Burzinski <[email protected]>
…s requested by users.
…docs into opentherm-next-docs
You describe values such as t_set as inputs - Surely they are outputs. index 819120c9..91945ae3 100644
--- a/components/opentherm.rst
+++ b/components/opentherm.rst
@@ -147,7 +147,7 @@ output and number components by default:
- ``auto_min_value`` (boolean): Automatically configure the minimum value to a value reported by the boiler. Not
available for all inputs.
-The following inputs are available:
+The following outputs are available:
- ``t_set``: Control setpoint: temperature setpoint for the boiler's supply water (°C)
|
@FreeBear-nc You are correct, this terminology looks confusing. It's part of the original documentation from Arthur Rump that I didn't change. But I wouldn't call them inputs either because then we can declare an input as an output, and it's confusing :) I would rewrite this whole section as following:
|
Description:
This PR adds documentation for the new OpenTherm component in ESPHome.
Pull request in esphome with YAML changes (if applicable): esphome/esphome#6645
Checklist:
next
because this is new documentation that has a matching pull-request in esphome as linked above./index.rst
when creating new documents for new components or cookbook.