diff --git a/README.md b/README.md index 6e951b9..2721920 100644 --- a/README.md +++ b/README.md @@ -14,12 +14,18 @@
  • Example
  • Documentation
  • +
  • + Program Flowcharts + +
  • Acknowledgements
  • License
  • Contact
  • - ## About esp32_BNO08x is a C++ esp-idf v5.x component, intended to serve as a driver for both the BNO080 and BNO085 IMUs. @@ -102,8 +108,22 @@ extern "C" void app_main(void) API documentation generated with doxygen can be found in the documentation directory of the master branch.

    (back to top)

    -## Acknowledgements +## Program Flowcharts +The following charts illustrate the program flow this library implements for sending and receiving data from BNO08x. +These are here to aid development for anyone looking to modify, fork, or contribute. +

    (back to top)

    +### Receiving Case +This assumes the user as initialized the imu and has sent a command to enable a report (for ex. enable_game_rotation_vector). +![image](esp32_BNO08x_receieve_flowchart.png) +

    (back to top)

    + + +### Sending Case +![image](esp32_BNO08x_send_flowchart.png) +

    (back to top)

    + +## Acknowledgements Special thanks to the original creators of the sparkfun BNO080 library. Developing this without a reference would have been much more time consuming. https://github.com/sparkfun/SparkFun_BNO080_Arduino_Library diff --git a/esp32_BNO08x_receieve_flowchart.png b/esp32_BNO08x_receieve_flowchart.png new file mode 100644 index 0000000..efbc694 Binary files /dev/null and b/esp32_BNO08x_receieve_flowchart.png differ diff --git a/esp32_BNO08x_send_flowchart.png b/esp32_BNO08x_send_flowchart.png new file mode 100644 index 0000000..eb759f7 Binary files /dev/null and b/esp32_BNO08x_send_flowchart.png differ