Skip to content

Update documentation for the sun component to describe the offset option#6288

Open
ilikecake wants to merge 1 commit intoesphome:nextfrom
ilikecake:sun-offset
Open

Update documentation for the sun component to describe the offset option#6288
ilikecake wants to merge 1 commit intoesphome:nextfrom
ilikecake:sun-offset

Conversation

@ilikecake
Copy link
Contributor

@ilikecake ilikecake commented Mar 15, 2026

Update the documentation for the sun component to describe the new offset option.

Description

Related issue (if applicable): fixes

Pull request in esphome with YAML changes (if applicable):

Checklist

  • I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
    or

  • I am merging into current because 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.mdx when 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:

  1. Comment on this pull request with the following command, replacing component_name with your component name in lower_case format with underscores (e.g., bme280, sht3x, dallas_temp):

    @esphomebot generate image component_name
    
  2. The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.

  3. Extract the SVG file and place it in the /public/images/ folder of this repository.

  4. 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:

@esphomebot generate image dht22

Note: All images used in ImgTable components must be placed in /public/images/ as the component resolves them to absolute paths.

Added optional offset parameter for sun configuration and updated type options.
@esphome esphome bot added the next label Mar 15, 2026
@netlify
Copy link

netlify bot commented Mar 15, 2026

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 8641038
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/69b733f9fdd229000840905c
😎 Deploy Preview https://deploy-preview-6288--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 project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant