Skip to content

Commit

Permalink
Update readme format
Browse files Browse the repository at this point in the history
  • Loading branch information
xeonqq committed Nov 7, 2023
1 parent 0327384 commit 8c4ee1e
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions Sming/Libraries/MPU6050/README.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,20 @@
API Documentation
-----------------
MPU6050 Gyro / Accelerometer
=============================

.. doxygenclass:: MPU6050
:members:

# MPU6050 Six-Axis (Gyro + Accelerometer)
Based on code from [jrowberg/i2cdevlib](https://github.com/jrowberg/i2cdevlib/tree/master/ESP32_ESP-IDF/components/MPU6050) @ 605a740. Most of the code is the same, except:
Based on code from `jrowberg/i2cdevlib <https://github.com/jrowberg/i2cdevlib/tree/master/ESP32_ESP-IDF/components/MPU6050>` @ 605a740. Most of the code is the same, except:

- Removed MPU6050::ReadRegister function due to incompatibility. It is also not used anywhere in the original code.
- MPU6050_6Axis_MotionApps20.h and MPU6050_9Axis_MotionApps41.h are not included due to deps to freeRTOS. helper_3dmath.h is also not included since it is only used in the above mentioned files.
- Removed map function in favor of the Sming built-in one.
- Adapted include path, coding style and applied clangformat
- Deleted Calibration and Memory Block related code for code quality reason


API Documentation
-----------------

.. doxygenclass:: MPU6050
:members:

0 comments on commit 8c4ee1e

Please sign in to comment.