Skip to content

[mipi_dsi] Document DMA2D async flush options#6747

Open
kyvaith wants to merge 2 commits into
esphome:nextfrom
kyvaith:mipi-dsi-async-dma2d-docs
Open

[mipi_dsi] Document DMA2D async flush options#6747
kyvaith wants to merge 2 commits into
esphome:nextfrom
kyvaith:mipi-dsi-async-dma2d-docs

Conversation

@kyvaith

@kyvaith kyvaith commented Jun 7, 2026

Copy link
Copy Markdown

Description

Documents the use_dma2d and async_lvgl_flush options added by esphome/esphome#16853.

Related pull request

esphome[bot]
esphome Bot previously requested changes Jun 7, 2026

@esphome esphome 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.

As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.

@esphome

esphome Bot commented Jun 7, 2026

Copy link
Copy Markdown

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 June 7, 2026 15:31
@netlify

netlify Bot commented Jun 7, 2026

Copy link
Copy Markdown

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 1076b96
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/6a2597b1a9b3bc000839e98d
😎 Deploy Preview https://deploy-preview-6747--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.

@kyvaith kyvaith marked this pull request as ready for review June 7, 2026 15:33
@esphome esphome Bot dismissed their stale review June 7, 2026 15:33

Stale

@coderabbitai

coderabbitai Bot commented Jun 7, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Caution

Review failed

Failed to post review comments

Walkthrough

This PR updates many documentation pages and site metadata: a version bump, new Router speaker docs, new MIPI DSI options, numerous component documentation clarifications/additions, and CLI/security guide updates.

Changes

Documentation updates (site-wide)

Layer / File(s) Summary
Version and index
data/version.yaml, src/content/docs/components/index.mdx
Bumps version/release to 2026.6 series and adds a "Router Speaker" entry to the components index.
Display docs
src/content/docs/components/display/mipi_dsi.mdx, src/content/docs/components/display/nextion.mdx, src/content/docs/components/display/sdl.mdx, src/content/docs/components/lvgl/index.mdx, src/content/docs/components/lvgl/widgets.mdx
Documents use_dma2d and async_lvgl_flush for MIPI DSI; removes Nextion dump_device_info; refines SDL window_options.position and install notes; updates LVGL byte_order and adds meter rounded.
Speaker platforms
src/content/docs/components/speaker/router.mdx, src/content/docs/components/speaker/mixer.mdx, src/content/docs/components/speaker/i2s_audio.mdx
Adds router speaker docs and example; adds mixer bits_per_sample; updates i2s_audio SPDIF constraints and example YAML.
Climate & Light
src/content/docs/components/climate/mitsubishi_cn105.mdx, src/content/docs/components/light/index.mdx
Adds supported_swing_modes to Mitsubishi CN105 docs; documents light.effect.next/previous and exposes it LightState variable in lambda examples.
I²C and RP2040
src/content/docs/components/i2c.mdx, src/content/docs/components/rp2040.mdx
Adds host platform to I²C docs and reorganizes per-platform variables and multi-bus guidance; introduces RP2040 variant and board/variant validation rules.
Network / Ethernet / USB UART
src/content/docs/components/network.mdx, src/content/docs/components/ethernet.mdx, src/content/docs/components/usb_uart.mdx
Clarifies enable_ipv6 on nRF52; adds enable_on_boot and Ethernet actions/conditions; updates USB UART supported device list and type values.
Sensor / Time / Packages
src/content/docs/components/sensor/dsmr.mdx, src/content/docs/components/time/homeassistant.mdx, src/content/docs/components/time/index.mdx, src/content/docs/components/packages.mdx
Refines DSMR CRC guidance and examples; clarifies timezone handling and UTC-empty-string behavior; lists supported shorthand Git hosts for packages.
Guides & Security
src/content/docs/guides/cli.mdx, src/content/docs/guides/security_best_practices.mdx
Adds --states/--no-states CLI docs for run/logs and revises WiFi min_auth_mode guidance to default to WPA2 across platforms.

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs:

Suggested labels:
component: display

Suggested reviewers:

  • ssieb
  • clydebarrow
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title '[mipi_dsi] Document DMA2D async flush options' accurately describes the main change—documenting the use_dma2d and async_lvgl_flush options in the MIPI DSI documentation.
Description check ✅ Passed The description is directly relevant to the changeset, explaining that it documents the use_dma2d and async_lvgl_flush options added by a related ESPHome PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@kyvaith kyvaith force-pushed the mipi-dsi-async-dma2d-docs branch from 03ec3be to e6f1c12 Compare June 7, 2026 15:39
@kyvaith kyvaith changed the base branch from current to next June 7, 2026 15:39
esphome[bot]
esphome Bot previously requested changes Jun 7, 2026

@esphome esphome 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.

As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.

@esphome esphome Bot marked this pull request as draft June 7, 2026 15:39
@esphome esphome Bot added the next label Jun 7, 2026
@esphome esphome Bot dismissed their stale review June 7, 2026 15:39

Base branch has been corrected - dismissing previous review.

@kyvaith kyvaith marked this pull request as ready for review June 7, 2026 15:40

kyvaith commented Jun 7, 2026

Copy link
Copy Markdown
Author

I opened esphome/esphome#16873 as the shared architecture/performance discussion for the ESP32-P4 LVGL/MIPI DSI PR stack. It includes how the MIPI DSI docs fit into the async flush, DMA2D, zero-copy/cache-sync, PPA, and LVGL 9.5 work, plus downstream benchmark numbers.

For cross-PR design questions it is probably easier to discuss there and keep this docs PR focused on documenting the scoped options.

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