mpu6050.h 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110
  1. /**
  2. * Copyright (c) 2009 - 2020, Nordic Semiconductor ASA
  3. *
  4. * All rights reserved.
  5. *
  6. * Redistribution and use in source and binary forms, with or without modification,
  7. * are permitted provided that the following conditions are met:
  8. *
  9. * 1. Redistributions of source code must retain the above copyright notice, this
  10. * list of conditions and the following disclaimer.
  11. *
  12. * 2. Redistributions in binary form, except as embedded into a Nordic
  13. * Semiconductor ASA integrated circuit in a product or a software update for
  14. * such product, must reproduce the above copyright notice, this list of
  15. * conditions and the following disclaimer in the documentation and/or other
  16. * materials provided with the distribution.
  17. *
  18. * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
  19. * contributors may be used to endorse or promote products derived from this
  20. * software without specific prior written permission.
  21. *
  22. * 4. This software, with or without modification, must only be used with a
  23. * Nordic Semiconductor ASA integrated circuit.
  24. *
  25. * 5. Any software provided in binary form under this license must not be reverse
  26. * engineered, decompiled, modified and/or disassembled.
  27. *
  28. * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
  29. * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  30. * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
  31. * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
  32. * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  33. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  34. * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  37. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38. *
  39. */
  40. #ifndef MPU6050_H
  41. #define MPU6050_H
  42. /*lint ++flb "Enter library region" */
  43. #include <stdbool.h>
  44. #include <stdint.h>
  45. #ifdef __cplusplus
  46. extern "C" {
  47. #endif
  48. /** @file
  49. * @brief MPU6050 gyro/accelerometer driver.
  50. *
  51. *
  52. * @defgroup nrf_drivers_mpu6050 MPU6050 gyro/accelerometer driver
  53. * @{
  54. * @ingroup ext_drivers
  55. * @brief MPU6050 gyro/accelerometer driver.
  56. */
  57. /**
  58. * @brief Function for initializing MPU6050 and verifies it's on the bus.
  59. *
  60. * @param device_address Device TWI address in bits [6:0].
  61. * @return
  62. * @retval true MPU6050 found on the bus and ready for operation.
  63. * @retval false MPU6050 not found on the bus or communication failure.
  64. */
  65. bool mpu6050_init(uint8_t device_address);
  66. /**
  67. @brief Function for writing a MPU6050 register contents over TWI.
  68. @param[in] register_address Register address to start writing to
  69. @param[in] value Value to write to register
  70. @retval true Register write succeeded
  71. @retval false Register write failed
  72. */
  73. bool mpu6050_register_write(uint8_t register_address, const uint8_t value);
  74. /**
  75. @brief Function for reading MPU6050 register contents over TWI.
  76. Reads one or more consecutive registers.
  77. @param[in] register_address Register address to start reading from
  78. @param[in] number_of_bytes Number of bytes to read
  79. @param[out] destination Pointer to a data buffer where read data will be stored
  80. @retval true Register read succeeded
  81. @retval false Register read failed
  82. */
  83. bool mpu6050_register_read(uint8_t register_address, uint8_t *destination, uint8_t number_of_bytes);
  84. /**
  85. @brief Function for reading and verifying MPU6050 product ID.
  86. @retval true Product ID is what was expected
  87. @retval false Product ID was not what was expected
  88. */
  89. bool mpu6050_verify_product_id(void);
  90. /**
  91. *@}
  92. **/
  93. /*lint --flb "Leave library region" */
  94. #ifdef __cplusplus
  95. }
  96. #endif
  97. #endif /* MPU6050_H */