spider-bot/fw/nrf52/nrf5_sdk/components/drivers_ext/mpu6050/mpu6050.h

111 lines
3.8 KiB
C

/**
* Copyright (c) 2009 - 2019, Nordic Semiconductor ASA
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form, except as embedded into a Nordic
* Semiconductor ASA integrated circuit in a product or a software update for
* such product, must reproduce the above copyright notice, this list of
* conditions and the following disclaimer in the documentation and/or other
* materials provided with the distribution.
*
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* 4. This software, with or without modification, must only be used with a
* Nordic Semiconductor ASA integrated circuit.
*
* 5. Any software provided in binary form under this license must not be reverse
* engineered, decompiled, modified and/or disassembled.
*
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
#ifndef MPU6050_H
#define MPU6050_H
/*lint ++flb "Enter library region" */
#include <stdbool.h>
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif
/** @file
* @brief MPU6050 gyro/accelerometer driver.
*
*
* @defgroup nrf_drivers_mpu6050 MPU6050 gyro/accelerometer driver
* @{
* @ingroup ext_drivers
* @brief MPU6050 gyro/accelerometer driver.
*/
/**
* @brief Function for initializing MPU6050 and verifies it's on the bus.
*
* @param device_address Device TWI address in bits [6:0].
* @return
* @retval true MPU6050 found on the bus and ready for operation.
* @retval false MPU6050 not found on the bus or communication failure.
*/
bool mpu6050_init(uint8_t device_address);
/**
@brief Function for writing a MPU6050 register contents over TWI.
@param[in] register_address Register address to start writing to
@param[in] value Value to write to register
@retval true Register write succeeded
@retval false Register write failed
*/
bool mpu6050_register_write(uint8_t register_address, const uint8_t value);
/**
@brief Function for reading MPU6050 register contents over TWI.
Reads one or more consecutive registers.
@param[in] register_address Register address to start reading from
@param[in] number_of_bytes Number of bytes to read
@param[out] destination Pointer to a data buffer where read data will be stored
@retval true Register read succeeded
@retval false Register read failed
*/
bool mpu6050_register_read(uint8_t register_address, uint8_t *destination, uint8_t number_of_bytes);
/**
@brief Function for reading and verifying MPU6050 product ID.
@retval true Product ID is what was expected
@retval false Product ID was not what was expected
*/
bool mpu6050_verify_product_id(void);
/**
*@}
**/
/*lint --flb "Leave library region" */
#ifdef __cplusplus
}
#endif
#endif /* MPU6050_H */