Skip to content

[lvgl] Fix type of byte_order parameter#6637

Open
guillempages wants to merge 2 commits into
esphome:nextfrom
guillempages:lvgl_byt_order
Open

[lvgl] Fix type of byte_order parameter#6637
guillempages wants to merge 2 commits into
esphome:nextfrom
guillempages:lvgl_byt_order

Conversation

@guillempages
Copy link
Copy Markdown
Contributor

@guillempages guillempages commented May 17, 2026

Description

The byte_order global configuration parameter for lvgl wrongly specifies int16 as its type; while the available values are big_endian or little_endian, which are strings.

Related issue (if applicable): fixes

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

esphome/esphome#16702

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.

@esphome esphome Bot added the current label May 17, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 17, 2026

Review Change Stack

Caution

Review failed

Failed to post review comments

Walkthrough

Repository version metadata is bumped to 2026.6.0-dev and multiple documentation pages were updated across components (LVGL, lights, NeoPixelBus, RP2040, network, WiFi, speaker, time, packages, Nextion, Mitsubishi climate) to clarify configuration types, defaults, new options, deprecation and migration guidance, and behavior notes.

Changes

Documentation edits and version metadata

Layer / File(s) Summary
Repository version metadata update
data/version.yaml
Update release to 2026.6.0-dev and version to 2026.6.
Mitsubishi CN105 swing mode docs
src/content/docs/components/climate/mitsubishi_cn105.mdx
Adds supported_swing_modes option, updates example to BOTH, and expands supported features list to include OFF, VERTICAL, HORIZONTAL, BOTH.
Nextion display docs removal
src/content/docs/components/display/nextion.mdx
Removes dump_device_info configuration variable entry.
Light effect next/previous actions
src/content/docs/components/light/index.mdx
Adds docs for light.effect.next/light.effect.previous actions, parameters, examples, and behavior notes.
NeoPixelBus ESP32 deprecation & migration
src/content/docs/components/light/neopixelbus.mdx
Replaces ESP-IDF warning with CAUTION about ESP32 deprecation (2026.6 → removal by 2027.1), notes upstream status, and adds ESP32 migration paths.
LVGL byte_order type correction
src/content/docs/components/lvgl/index.mdx
Changes byte_order field type to string with allowed values big_endian/little_endian, notes auto-configuration from display metadata; default big_endian.
LVGL meter arc rounded option
src/content/docs/components/lvgl/widgets.mdx
Documents new optional boolean rounded for meter.scales.indicators.arc (default false).
Network enable_ipv6 nRF52 note
src/content/docs/components/network.mdx
Adds note that enable_ipv6 is always true on nRF52 due to lack of IPv4 support; retains default line.
Packages shorthand host list
src/content/docs/components/packages.mdx
Adds supported shorthand package hosts list (Codeberg, GitHub, GitLab) to remote/Git packages example.
RP2040 board/variant config docs
src/content/docs/components/rp2040.mdx
Makes board optional, adds variant option, and documents validation/inference and compatibility warnings.
SPDIF constraints and example update
src/content/docs/components/speaker/i2s_audio.mdx
Removes bits_per_sample constraint and example line; retains sample_rate and channel constraints and updates example accordingly.
Home Assistant time source timezone behavior
src/content/docs/components/time/homeassistant.mdx
Documents build-host timezone inference and runtime updates from Home Assistant; explicit timezone prevents updates.
Timezone empty-string disables handling
src/content/docs/components/time/index.mdx
Documents that timezone: "" disables timezone handling so device operates on UTC.
WiFi min_auth_mode default wording
src/content/docs/components/wifi.mdx
Updates default wording to state WPA2 is default on both ESP32 and ESP8266.
Security guide WiFi guidance
src/content/docs/guides/security_best_practices.mdx
Unifies best-practices wording to WPA2 default across ESP32/ESP8266 and notes min_auth_mode: WPA3 on ESP32.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically identifies the main change: fixing the documented type of the byte_order parameter in the lvgl component from int16 to string.
Description check ✅ Passed The description is directly related to the changeset, explaining that byte_order was incorrectly documented as int16 when the actual values are strings (big_endian or little_endian).
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

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


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.

@netlify
Copy link
Copy Markdown

netlify Bot commented May 17, 2026

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 94c76bf
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/6a1ae66256eec20008ae9587
😎 Deploy Preview https://deploy-preview-6637--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.

@guillempages guillempages requested a review from clydebarrow May 30, 2026 05:29
@clydebarrow
Copy link
Copy Markdown
Contributor

LGTM but...

esphome/esphome#16702 changes this somewhat as it allows LVGL to infer the correct byte order from the display byte order.

Maybe tie this PR to that one, and amend the wording to add the information about the automatic byte_order selection?

The byte_order global configuration parameter for lvgl wrongly specifies
`int16` as its type; while the available values are `big_endian` or
`little_endian`, which are strings.
@guillempages
Copy link
Copy Markdown
Contributor Author

I've updated the wording and linked it to your PR in the description. (And rebased it to "next" instead of "current")

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