Add `entity_picture` property to mqtt entity platforms config options

[jbouwh]

Proposed change

Add entity_pictureproperty to mqtt entity platforms config options

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.
• [x] 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: https://github.com/home-assistant/core/pull/128404
• 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

• New Features

  • Introduced an optional entity_picture field for various MQTT integrations, allowing users to visually represent entities with custom images.

• Impact

  • Enhances the visual experience across multiple platforms without affecting existing functionality.

[home-assistant[bot]]

Hey there @emontnemery, @bdraco, mind taking a look at this feedback as it has been labeled with an integration (mqtt) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of mqtt can trigger bot actions by commenting:

• @home-assistant close Closes the feedback.
• @home-assistant rename Awesome new title Renames the feedback.
• @home-assistant reopen Reopen the feedback.
• @home-assistant unassign mqtt Removes the current integration label and assignees on the feedback, add the integration domain after the command.
• @home-assistant add-label needs-more-information Add a label (needs-more-information) to the feedback.
• @home-assistant remove-label needs-more-information Remove a label (needs-more-information) on the feedback.

[netlify[bot]]

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	179b3e35a72827b940303c1ee33d7dad091481d4
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/670d9601f4188700088c8e44
😎 Deploy Preview	https://deploy-preview-35239--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 changes introduce a new optional field, entity_picture, to the configuration options of various MQTT integrations in Home Assistant. This field allows users to provide a URL for an image representing the entity, thereby enhancing visual representation across multiple device types, including sensors, lights, and climate controls. The existing functionality of these integrations remains unchanged, and the overall structure is preserved.

Changes

File Path	Change Summary
source/_integrations/*.mqtt.markdown	Added new optional field entity_picture to the configuration schema for multiple MQTT integrations, including alarm control panels, binary sensors, buttons, cameras, climate devices, covers, events, fans, humidifiers, images, lawn mowers, lights, locks, notifications, numbers, scenes, selects, sensors, sirens, switches, texts, valves, and water heaters.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistant
    participant MQTTIntegration

    User->>HomeAssistant: Configure MQTT integration with entity_picture
    HomeAssistant->>MQTIntegration: Send configuration with entity_picture
    MQTIntegration-->>HomeAssistant: Acknowledge configuration
    HomeAssistant-->>User: Display entity with image

---

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>, please review it.
  • 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 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 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.
  • @coderabbitai help me debug CodeRabbit configuration file.

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