-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Add BNO055 9-DOF Absolute Orientation Sensor documentation #6002
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: next
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughThis PR adds comprehensive documentation for the BNO055 9-DOF Absolute Orientation Sensor integration, including YAML configuration examples, detailed configuration variables, I2C considerations, and calibration guidance. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested labels
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@content/components/sensor/bno055.md`:
- Around line 153-158: Replace the unit text "uT" with the proper microtesla
symbol "µT" for the magnetic field properties in the BNO055 docs: update the
descriptions for mag_x, mag_y, and mag_z so they read "microtesla (µT)" instead
of "microtesla (uT)"; ensure the same change is applied consistently wherever
mag_x, mag_y, or mag_z mention the unit symbol.
content/components/sensor/bno055.md
Outdated
| - **mag_x** (*Optional*): Magnetic field X-axis in microtesla (uT). All options from | ||
| [Sensor](/components/sensor). | ||
| - **mag_y** (*Optional*): Magnetic field Y-axis in microtesla (uT). All options from | ||
| [Sensor](/components/sensor). | ||
| - **mag_z** (*Optional*): Magnetic field Z-axis in microtesla (uT). All options from | ||
| [Sensor](/components/sensor). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use the proper unit symbol for microtesla.
Docs should use µT (microtesla) rather than uT. This is a minor formatting/consistency fix.
✏️ Suggested edit
- **mag_x** (*Optional*): Magnetic field X-axis in microtesla (uT). All options from
+ **mag_x** (*Optional*): Magnetic field X-axis in microtesla (µT). All options from
- **mag_y** (*Optional*): Magnetic field Y-axis in microtesla (uT). All options from
+ **mag_y** (*Optional*): Magnetic field Y-axis in microtesla (µT). All options from
- **mag_z** (*Optional*): Magnetic field Z-axis in microtesla (uT). All options from
+ **mag_z** (*Optional*): Magnetic field Z-axis in microtesla (µT). All options from📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - **mag_x** (*Optional*): Magnetic field X-axis in microtesla (uT). All options from | |
| [Sensor](/components/sensor). | |
| - **mag_y** (*Optional*): Magnetic field Y-axis in microtesla (uT). All options from | |
| [Sensor](/components/sensor). | |
| - **mag_z** (*Optional*): Magnetic field Z-axis in microtesla (uT). All options from | |
| [Sensor](/components/sensor). | |
| - **mag_x** (*Optional*): Magnetic field X-axis in microtesla (µT). All options from | |
| [Sensor](/components/sensor). | |
| - **mag_y** (*Optional*): Magnetic field Y-axis in microtesla (µT). All options from | |
| [Sensor](/components/sensor). | |
| - **mag_z** (*Optional*): Magnetic field Z-axis in microtesla (µT). All options from | |
| [Sensor](/components/sensor). |
🤖 Prompt for AI Agents
In `@content/components/sensor/bno055.md` around lines 153 - 158, Replace the unit
text "uT" with the proper microtesla symbol "µT" for the magnetic field
properties in the BNO055 docs: update the descriptions for mag_x, mag_y, and
mag_z so they read "microtesla (µT)" instead of "microtesla (uT)"; ensure the
same change is applied consistently wherever mag_x, mag_y, or mag_z mention the
unit symbol.
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Documentation for the new bno055 component in esphome/esphome#13616. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Use 1/1/1 ordered list style per markdownlint rules - Use proper µT symbol for microtesla Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
6e6e405 to
942485b
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.
Base branch has been corrected - dismissing previous review.
Documentation for the BNO055 9-DOF Absolute Orientation Sensor component.
Related component PR: esphome/esphome#13616
Summary
This adds documentation for the new
bno055sensor platform, including:Preview
The documentation covers: