Update ESPHome entity_id docs for unicode chars #39704

bdraco · 2025-06-25T11:09:03Z

Proposed change

Update ESPHome entity_id docs for unicode chars

Type of change

Spelling, grammar or other readability improvements (current branch).
Adjusted missing or incorrect information in the current documentation (current branch).
Added documentation for a new integration I'm adding to Home Assistant (next branch).
- I've opened up a PR to add logos and icons in Brands repository.
Added documentation for a new feature I'm adding to Home Assistant (next branch).
Removed stale or deprecated documentation.

Additional information

Link to parent pull request in the codebase: Fix ESPHome entity_id generation if name contains unicode characters core#146796
Link to parent pull request in the Brands repository:
This PR fixes or closes issue: fixes #

Checklist

This PR uses the correct branch, based on one of the following:
- I made a change to the existing documentation and used the current branch.
- I made a change that is related to an upcoming version of Home Assistant and used the next branch.
The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

Documentation
- Clarified how Unicode characters in entity names and IDs are handled for the ESPHome integration.
- Added an example showing transliteration of Unicode characters to ASCII equivalents in entity IDs.

Copilot

Pull Request Overview

This PR updates the ESPHome integration documentation to explain how Unicode characters are handled when generating entity IDs and adds an illustrative example.

Added a bullet point describing transliteration of Unicode characters to ASCII.
Provided a YAML example showing accented characters and how they become ASCII-only in the resulting entity ID.

Comments suppressed due to low confidence (1)

source/_integrations/esphome.markdown:155

Consider clarifying that punctuation and certain symbols (such as hyphens or spaces) are also normalized to underscores after transliteration, so readers understand which characters are transliterated versus replaced.

- Unicode characters in names are transliterated to their closest ASCII equivalents for compatibility

netlify · 2025-06-25T11:09:33Z

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	`5ce4b3a`
🔍 Latest deploy log	https://app.netlify.com/projects/home-assistant-docs/deploys/685bd8d231530e00083c3dc7
😎 Deploy Preview	https://deploy-preview-39704--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

coderabbitai · 2025-06-25T11:11:29Z

📝 Walkthrough

Walkthrough

The ESPHome integration documentation was updated to clarify how Unicode characters in entity names and IDs are handled. Specifically, it now states that Unicode characters are transliterated to their closest ASCII equivalents, and it provides an example illustrating this behavior.

Changes

File	Change Summary
source/_integrations/esphome.markdown	Updated documentation to explain Unicode handling in entity names/IDs and added a relevant example.

Sequence Diagram(s)

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

source/_integrations/esphome.markdown (1)
182-194: Minor YAML-format tweak improves accuracy

ESPHome examples normally model sensor: as a list item. Switching to the list form (using a dash and 2-space indentation) keeps the sample syntactically identical to real-world configs and avoids user copy-paste surprises.
-sensor:
-   name: "Árvíztűrő tükörfúrógép"
+sensor:
+  - name: "Árvíztűrő tükörfúrógép"

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between f11446a and 5ce4b3a.

📒 Files selected for processing (1)

source/_integrations/esphome.markdown (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

`source/_integrations/*`: Integration documentation must use the provided template structure and section order.

source/_integrations/*: Integration documentation must use the provided template structure and section order.

📄 Source: CodeRabbit Inference Engine (.github/copilot-instructions.md)

List of files the instruction was applied to:

source/_integrations/esphome.markdown

⏰ Context from checks skipped due to timeout of 90000ms (3)

GitHub Check: Redirect rules - home-assistant-docs
GitHub Check: Header rules - home-assistant-docs
GitHub Check: Pages changed - home-assistant-docs

🔇 Additional comments (1)

source/_integrations/esphome.markdown (1)

153-156: Bullet addition looks good

The new note about Unicode transliteration is clear, consistent with the preceding bullets (no trailing period) and fits naturally in this section.

c0ffeeca7

Thank you, @bdraco 👍

bdraco · 2025-06-25T11:43:16Z

Thanks!

Update ESPHome entity_id docs for unicode chars

5ce4b3a

Copilot AI review requested due to automatic review settings June 25, 2025 11:09

bdraco requested review from OttoWinter, jesserockz and kbx81 as code owners June 25, 2025 11:09

home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Jun 25, 2025

Copilot AI reviewed Jun 25, 2025

View reviewed changes

bdraco mentioned this pull request Jun 25, 2025

Fix ESPHome entity_id generation if name contains unicode characters home-assistant/core#146796

Merged

19 tasks

coderabbitai bot reviewed Jun 25, 2025

View reviewed changes

home-assistant bot added the parent-merged The parent PR has been merged already label Jun 25, 2025

c0ffeeca7 approved these changes Jun 25, 2025

View reviewed changes

c0ffeeca7 merged commit 28f3589 into next Jun 25, 2025
9 checks passed

c0ffeeca7 deleted the esphome_entity_id_change branch June 25, 2025 11:38

home-assistant bot removed the parent-merged The parent PR has been merged already label Jun 25, 2025

github-actions bot locked and limited conversation to collaborators Jun 26, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Update ESPHome entity_id docs for unicode chars #39704

Update ESPHome entity_id docs for unicode chars #39704

Uh oh!

bdraco commented Jun 25, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

netlify bot commented Jun 25, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jun 25, 2025

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

c0ffeeca7 left a comment •

edited

Loading

Uh oh!

Uh oh!

bdraco commented Jun 25, 2025

Uh oh!

Uh oh!

Uh oh!

Update ESPHome entity_id docs for unicode chars #39704

Update ESPHome entity_id docs for unicode chars #39704

Uh oh!

Conversation

bdraco commented Jun 25, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Additional information

Checklist

Summary by CodeRabbit

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

netlify bot commented Jun 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for home-assistant-docs ready!

Uh oh!

coderabbitai bot commented Jun 25, 2025

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

c0ffeeca7 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bdraco commented Jun 25, 2025

Uh oh!

Uh oh!

bdraco commented Jun 25, 2025 •

edited by coderabbitai bot

Loading

netlify bot commented Jun 25, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

c0ffeeca7 left a comment •

edited

Loading