Customizing entities: list allowed characters for entity name

[c0ffeeca7]

Proposed change

Customizing entities: list allowed characters for entity name

Type of change

• [ ] Spelling, grammar or other readability improvements (current branch).
• [x] 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:
• Link to parent pull request in the Brands repository:
• This PR fixes or closes issue: fixes #

Checklist

• [x] 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.
• [x] The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

• Documentation
  • Updated instructions for changing the entity ID and friendly name of supported entities.
  • Provided new examples for entity IDs.
  • Specified allowed characters and enforced naming conventions for entity IDs.

[netlify[bot]]

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	5856a712849034f26ed37f049071f6d4dc6d030e
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/6652e2cc17c58a0008e096b9
😎 Deploy Preview	https://deploy-preview-32933--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 site configuration.

[coderabbitai[bot]]

Walkthrough

Walkthrough

The recent updates focus on refining the instructions for customizing entity IDs and friendly names in the configuration documentation. Key improvements include updated examples for entity IDs, clarified permissible characters, and enforced naming conventions to ensure consistency and readability.

Changes

Files	Change Summary
source/_docs/configuration/customizing-devices.markdown	Updated entity ID example from light.bedroom_ligthstrip to light.bedroom_ligthstrip_3. Clarified the use of lowercase letters, numbers, and underscores in entity IDs. Added a rule that the name must not start or end with an underscore.

---

Recent Review Details

Configuration used: CodeRabbit UI Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between dd2a72bebe2741224fb032709a92dd2768d07a4c and 5856a712849034f26ed37f049071f6d4dc6d030e.

Files selected for processing (1)

• source/_docs/configuration/customizing-devices.markdown (2 hunks)

Additional Context Used

LanguageTool (5)

source/_docs/configuration/customizing-devices.markdown (5)

Near line 17: Unpaired symbol: ‘"’ seems to be missing Context: ... > Devices & services > Entities" %} and select the entity from the list.... Rule ID: EN_UNPAIRED_QUOTES

---

Near line 18: Consider adding a hyphen. Context: ...ect the entity from the list. 2. In the top right corner, select the cog icon. ![Enti... Rule ID: TOP_LEFT_CORNER

---

Near line 23: Possible spelling mistake found. Context: ...or example, the entity ID here could be light.bedroom_lightstrip_3. - Do not change the domain of th... Rule ID: MORFOLOGIK_RULE_EN_US

---

Near line 32: Unpaired symbol: ‘"’ seems to be missing Context: ..."Settings > Automations & Scenes" %} open the respective tab and find you... Rule ID: EN_UNPAIRED_QUOTES

---

Near line 36: Possible spelling mistake found. Context: ...Assistant Core integration documentation](/integrations/homeassistant/). Rule ID: MORFOLOGIK_RULE_EN_US

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as 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 full the review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[home-assistant[bot]]

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks :+1:

Learn more about our pull request process.

[c0ffeeca7]

There is a typo in the entity ID

awesome! I completely overlooked that.