Skip to content

[sd_storage] Add SD card storage component documentation#6891

Draft
p1ngb4ck wants to merge 10 commits into
esphome:nextfrom
p1ngb4ck:feature/sd-storage-docs
Draft

[sd_storage] Add SD card storage component documentation#6891
p1ngb4ck wants to merge 10 commits into
esphome:nextfrom
p1ngb4ck:feature/sd-storage-docs

Conversation

@p1ngb4ck

@p1ngb4ck p1ngb4ck commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Adds documentation for the new sd_storage component, which mounts SD cards into the ESP-IDF virtual filesystem via SD-MMC or SPI interface.

Covers:

Configuration variables for both sd_mmc and sd_spi types

Wiring tables for 4-bit SD-MMC, 1-bit SD-MMC, and SPI

All automations: on_mounted trigger, mount/unmount actions, list_files action, is_mounted condition

Depends on the storage base docs PR (feature/storage-base-docs) which adds the Storage Components section to the index.

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.

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

ImgTable blocks are not in alphabetical order

Found 1 ImgTable block(s) with incorrect ordering below Network Protocols.
Each table has at most one Core item (matching the section name, e.g. "Sensor Core" for the Sensor section), pinned first, followed by Template items (names starting with "Template "), then all remaining items sorted alphabetically.

You can fix this automatically by running:

node script/check_component_index.mjs --fix

See the inline suggestions below for the correct order in each section.

Comment thread src/content/docs/components/index.mdx Outdated
@netlify

netlify Bot commented Jul 1, 2026

Copy link
Copy Markdown

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 59197f0
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/6a457fc3d14483000810e0f8
😎 Deploy Preview https://deploy-preview-6891--esphome.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

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

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@github-actions github-actions Bot dismissed their stale review July 1, 2026 20:38

Component index ordering has been fixed — dismissing review.

@p1ngb4ck p1ngb4ck changed the title Feature/sd storage docs [sd_storage] Add SD card storage component documentation Jul 1, 2026
…e dead link

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@p1ngb4ck

p1ngb4ck commented Jul 1, 2026

Copy link
Copy Markdown
Contributor Author

@esphomebot generate image sd_storage

@github-actions

github-actions Bot commented Jul 1, 2026

Copy link
Copy Markdown

@p1ngb4ck Committed public/images/sd_storage.svg to this PR and updated the component index.

Artifact: https://github.com/esphome/esphome.io/actions/runs/28547345639/artifacts/8022407462

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.

2 participants