Skip to content
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

Merged
merged 39 commits into from
Nov 12, 2024

Conversation

olegtarasov
Copy link
Contributor

@olegtarasov olegtarasov commented Apr 26, 2024

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:

  • I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
  • Link added in /index.rst when creating new documents for new components or cookbook.

@probot-esphome probot-esphome bot added the next label Apr 26, 2024
Copy link

netlify bot commented Apr 26, 2024

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 5e7af2b
🔍 Latest deploy log https://app.netlify.com/sites/esphome/deploys/6731e16fed3b2b0008a80593
😎 Deploy Preview https://deploy-preview-3800--esphome.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Member

@kbx81 kbx81 left a 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.

components/opentherm.rst Outdated Show resolved Hide resolved
components/opentherm.rst Outdated Show resolved Hide resolved
components/opentherm.rst Outdated Show resolved Hide resolved
components/opentherm.rst Outdated Show resolved Hide resolved
components/opentherm.rst Outdated Show resolved Hide resolved
components/opentherm.rst Outdated Show resolved Hide resolved
components/opentherm.rst Outdated Show resolved Hide resolved
components/opentherm.rst Outdated Show resolved Hide resolved
@esphome
Copy link

esphome bot commented Sep 11, 2024

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@esphome esphome bot marked this pull request as draft September 11, 2024 06:25
Copy link
Member

@kbx81 kbx81 left a 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.

components/opentherm.rst Outdated Show resolved Hide resolved
components/opentherm.rst Outdated Show resolved Hide resolved
components/opentherm.rst Outdated Show resolved Hide resolved
kbx81
kbx81 previously approved these changes Sep 15, 2024
kbx81
kbx81 previously approved these changes Oct 10, 2024
@FreeBear-nc
Copy link
Contributor

FreeBear-nc commented Oct 25, 2024

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)
 

@olegtarasov
Copy link
Contributor Author

@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:

Numerical values
*****************

There are three ways to set a numerical value:

- As an input sensor, defined in the hub configuration:

[skipped] 

  This can be useful if you have an external thermostat-like device that provides the setpoint as a sensor.

- As a number:

[skipped] 

  This is useful if you want full control over your boiler and want to manually set all values.

- As an output:

[ skipped ]

The following numerical values are available:```

@esphome esphome bot marked this pull request as draft November 11, 2024 04:30
@olegtarasov olegtarasov marked this pull request as ready for review November 11, 2024 10:50
@esphome esphome bot requested review from kbx81 and jesserockz November 11, 2024 10:50
@jesserockz jesserockz merged commit 2e6381a into esphome:next Nov 12, 2024
3 checks passed
@jesserockz jesserockz mentioned this pull request Nov 13, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Nov 14, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants