Skip to content

Conversation

@iret33
Copy link
Contributor

@iret33 iret33 commented Jan 29, 2026

Documentation for the BNO055 9-DOF Absolute Orientation Sensor component.

Related component PR: esphome/esphome#13616

Summary

This adds documentation for the new bno055 sensor platform, including:

  • Configuration examples (minimal and full)
  • All configuration variables documented
  • Sensor output categories explained
  • ESP32 I2C clock stretching considerations
  • Calibration procedure notes

Preview

The documentation covers:

Category Sensors Unit
Euler Angles heading, roll, pitch degrees
Quaternion w, x, y, z unitless
Linear Acceleration x, y, z m/s²
Gravity x, y, z m/s²
Raw Acceleration x, y, z m/s²
Gyroscope x, y, z °/s
Magnetometer x, y, z µT
Temperature temp °C

esphome[bot]
esphome bot previously requested changes Jan 29, 2026
Copy link

@esphome esphome bot left a 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.

@esphome
Copy link

esphome bot commented Jan 29, 2026

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

Learn more about our pull request process.

@netlify
Copy link

netlify bot commented Jan 29, 2026

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 08a7f08
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/697cff4339c3cb0008b02bae
😎 Deploy Preview https://deploy-preview-6002--esphome.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 29, 2026

Walkthrough

This 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

Cohort / File(s) Summary
BNO055 Sensor Documentation
content/components/sensor/bno055.md
New documentation file covering BNO055 sensor integration with minimal and full YAML configuration examples, configuration variables (Euler angles, quaternions, linear acceleration, gravity, raw sensor data, temperature), ESP32 I2C considerations, and calibration guidance.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested labels

has-parent

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and specifically describes the main change: adding documentation for the BNO055 9-DOF sensor component, which matches the raw summary and PR objectives.
Description check ✅ Passed The description is well-detailed and directly related to the changeset, providing context, configuration details, and a preview of documented sensor categories, all aligned with the documentation addition.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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.

Comment on lines 153 to 158
- **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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

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.

Suggested change
- **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.

dependabot bot and others added 3 commits January 29, 2026 11:09
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>
@iret33 iret33 changed the base branch from current to next January 29, 2026 08:10
esphome[bot]
esphome bot previously requested changes Jan 29, 2026
Copy link

@esphome esphome bot left a 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.

@esphome esphome bot added the next label Jan 29, 2026
@esphome esphome bot dismissed their stale review January 29, 2026 08:10

Base branch has been corrected - dismissing previous review.

@iret33 iret33 marked this pull request as ready for review January 29, 2026 09:55
@esphome esphome bot dismissed their stale review January 29, 2026 09:55

Stale

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant