Skip to content

Conversation

solarkennedy
Copy link
Contributor

Description:

esphome/esphome#10873

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 /components/index.rst 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 UPPER_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 images/ folder of this repository.

  4. Use the image in your component's index table entry in /components/index.rst.

Example: For a component called "DHT22 Temperature Sensor", use:

@esphomebot generate image DHT22

@Copilot Copilot AI review requested due to automatic review settings September 27, 2025 00:06
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds documentation for the Inkplate 6 COLOR display model, which is a new 7-color ACeP display that uses SPI communication instead of the parallel GPIO interface used by other Inkplate models.

Key changes:

  • Added support for three new Inkplate models in the model list
  • Added I2C pin configuration to an existing example
  • Created comprehensive documentation section for the Inkplate 6 COLOR with configuration examples and color constants reference

return adc;
filters:
- multiply: 2
Copy link

Copilot AI Sep 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The I2C pin configuration is added without context or explanation. Since this appears in an existing example, it should include a comment explaining why these specific pins are needed or reference the section where I2C usage is documented.

Suggested change
# The Inkplate hardware requires I2C on these specific pins (SDA: 21, SCL: 22).
# See the Inkplate documentation for more details: https://inkplate.io/docs/

Copilot uses AI. Check for mistakes.

Copy link

netlify bot commented Sep 27, 2025

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 36ea624
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/68d72a82e695c400080627a0
😎 Deploy Preview https://deploy-preview-5418--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