HF-BNO08x Documentation

Welcome! This directory contains step-by-step guides for installing, building, and using the HF-BNO08x library.

The driver supports I²C, SPI, UART (SH-2), and UART RVC via a single CommInterface. Your transport reports its type with GetInterfaceType() so the driver enables the right mode (Begin() for SH-2, BeginRvc() for RVC, Dfu() for firmware update where supported). See Platform Integration.

📚 Documentation Structure

Getting Started

  1. 🛠️ Installation – Prerequisites and how to obtain the source
  2. ⚡ Quick Start – Minimal working example to get you running
  3. 🔌 Hardware Setup – Wiring diagrams and pin connections

Integration

  1. 🔧 Platform Integration – Implement the CRTP communication interface for your platform
  2. ⚙️ Configuration – Configuration options and settings

Reference

  1. 📖 API Reference – Complete API documentation
  2. 💡 Examples – Detailed example walkthroughs

Advanced Features

  1. 🧹 RVC Mode – Robot Vacuum Cleaner mode for simplified UART streaming
  2. 📦 DFU (Firmware Update) – Device Firmware Update guide

Troubleshooting

  1. 🐛 Troubleshooting – Common issues and solutions

🚀 Quick Start Path

New to BNO08x? Follow this recommended path:

  1. Start with Installation to prepare your environment
  2. Follow Hardware Setup to wire your hardware
  3. Read Quick Start for a minimal working example
  4. Check Platform Integration to implement the communication interface
  5. Explore Examples for more advanced usage

💡 Need Help?

  • 🐛 Found a bug? Check the Troubleshooting guide
  • ❓ Have questions? Review the API Reference
  • 📝 Want to contribute? See the contributing guidelines in the main README

Navigation ➡️ Installation

Table of contents