added support to include the UM pir mqtt device to associate with has…

[rommo911]

added support to include the UM pir mqtt device to associate with hass wled integration device by adding mac adresse & ip to discovery information

previously the um only send basic mqtt discovery that will be discovered as individual stand alone device in mqtt integration, by using this commit it will merge the mqtt device with WLED device. pretty neat.

Summary by CodeRabbit

• New Features
  • Enhanced Home Assistant integration by including device availability and connection details (MAC and IP address) in the MQTT discovery payload.

[coderabbitai]

Walkthrough

The update extends the Home Assistant MQTT discovery payload across multiple usermod modules by adding a device connections array containing the device's MAC and IP addresses. In the PIR sensor switch module, an availability topic was also added. The multi relay module's discovery payload now includes detailed device metadata such as name, unique ID, manufacturer, model, and software version. The SHT usermod replaced an unsupported chip model call with predefined macros for device model and manufacturer. No logic or control flow changes were introduced; the modifications focus solely on enhancing the JSON payload structure for Home Assistant integration.

Changes

File(s)	Change Summary
usermods/PIR_sensor_switch/PIR_sensor_switch.cpp	Added availability topic and device connections (MAC, IP) to Home Assistant MQTT discovery payload; removed a blank line after a boolean member declaration.
usermods/Battery/Battery.cpp	Added device connections (MAC, IP) array to the MQTT Home Assistant discovery JSON payload in the sensor configuration.
usermods/multi_relay/multi_relay.cpp	Enhanced MQTT Home Assistant autodiscovery payload with detailed device metadata and added device connections (MAC, IP) array.
usermods/sht/sht.cpp	Replaced unsupported chip model call with macros for device model and manufacturer; added device connections (MAC, IP) array to discovery message.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between db4b8b4 and 11719b0.

📒 Files selected for processing (4)

• usermods/Battery/Battery.cpp (1 hunks)
• usermods/PIR_sensor_switch/PIR_sensor_switch.cpp (1 hunks)
• usermods/multi_relay/multi_relay.cpp (1 hunks)
• usermods/sht/sht.cpp (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• usermods/PIR_sensor_switch/PIR_sensor_switch.cpp

🔇 Additional comments (3)

usermods/sht/sht.cpp (1)

146-154: Improvement for better Home Assistant device association

The changes correctly add device connection information to the MQTT discovery payload, which will enable Home Assistant to associate this SHT sensor with the main WLED device instead of treating it as a standalone device. The code also fixes the compile error caused by the unsupported ESP.getChipModel() call by using predefined macros.

This implementation addresses the PR objective of improving device association in Home Assistant by including MAC and IP address information.

usermods/Battery/Battery.cpp (1)

159-164: Good implementation of Home Assistant device association

These changes add the device connection details (MAC and IP addresses) to the MQTT discovery payload, which will allow Home Assistant to properly associate the battery sensor with the main WLED device rather than treating it as a separate entity.

The implementation is consistent with the changes in other usermods and aligns with the PR objective.

usermods/multi_relay/multi_relay.cpp (1)

488-499: Comprehensive implementation of Home Assistant device metadata

These changes add detailed device information including name, unique ID, manufacturer, model, software version, and most importantly, the connection array with MAC and IP address to the MQTT discovery payload for relay devices.

This implementation is thorough and ensures that the relay devices will be associated with the main WLED device in Home Assistant, matching the PR objective of improving device association.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

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

[KrX3D]

i think that should be added to all the usermods, since there are a couple others that also hav this "problem"

[blazoncek]

It would be good to add a few comments in the code for non-HA users (like myself) to find out what the change does.

[rommo911]

Done