Add some example Hex addresses #36754
Conversation
None of the HA documentation seems to mention Hex addresses. As mentioned in: https://community.home-assistant.io/t/allow-modbus-address-port-register-to-be-specified-in-hex/800954 I didn't think/know that YAML would let me use Hex literals for device interfacing (and I must have got the format wrong when I tried it and it failed). A few random Hex constants will at least let developers search for the possibility
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request modifies the Modbus integration documentation in the source markdown file, updating configuration examples to represent entity addresses in hexadecimal format. The changes involve converting decimal address representations to their equivalent hexadecimal notation for both climate and sensor entity configurations, providing an alternative way of specifying Modbus device addresses. Changes
Sequence DiagramsequenceDiagram
participant Config as Modbus Configuration
participant Integration as Modbus Integration
Config->>Integration: Provide Hexadecimal Address
Integration->>Integration: Convert Hex Address to Decimal
Integration->>Device: Communicate using Converted Address
The sequence diagram illustrates how the Modbus integration processes the hexadecimal address configuration, converting it to the appropriate decimal representation for device communication. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_integrations/modbus.markdown (1)
1442-1442: LGTM! Hex address conversion is correct.The conversion from decimal
0to hexadecimal0x9Aadds a new example that demonstrates hex address usage in sensor configurations.For additional clarity, consider adding a brief comment in the configuration example to highlight that both decimal and hexadecimal address formats are supported.
- name: Room_1 slave: 10 - address: 0x9A + address: 0x9A # Hexadecimal addresses are supported (0x9A = 154 in decimal) input_type: holding
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/modbus.markdown(2 hunks)
⏰ 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/modbus.markdown (1)
822-822: LGTM! Hex address conversion is correct.The conversion from decimal
27586to hexadecimal0x6BC2is mathematically correct and improves the documentation by showing how hex addresses can be used in YAML configurations.
None of the HA documentation seems to mention Hex addresses.
As mentioned in:
https://community.home-assistant.io/t/allow-modbus-address-port-register-to-be-specified-in-hex/800954
I didn't think/know that YAML would let me use Hex literals for device interfacing (and I must have got the format wrong when I tried it and it failed).
A few random Hex constants will at least let developers search for the possibility
Proposed change
No Hex address examples in doco, so use some Hex address literals in a few ModBUS YAML examples
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.Summary by CodeRabbit