|
1 |
| - |
2 |
| -CONTENTS OF THIS FILE |
3 |
| -======================= |
4 |
| - * Introduction |
5 |
| - * Version |
6 |
| - * Integration details |
7 |
| - * Driver files information |
8 |
| - * Supported sensor interface |
9 |
| - * Copyright |
10 |
| - |
11 |
| - |
12 |
| -INTRODUCTION |
13 |
| -=============== |
14 |
| - - This package contains the Bosch Sensortec MEMS BNO055 sensor driver (sensor API) |
15 |
| - - The sensor driver package includes bno055.h, bno055.c and bno055_support.c files |
16 |
| - |
17 |
| -VERSION |
18 |
| -========= |
19 |
| - - Version of bno055 sensor driver is: |
20 |
| - * bno055.c - V2.0.3 |
21 |
| - * bno055.h - V2.0.3 |
22 |
| - * bno055_support.c - V1.0.4 |
23 |
| - |
24 |
| -INTEGRATION DETAILS |
25 |
| -===================== |
26 |
| - - Integrate bno055.h and bno055.c file in to your project. |
27 |
| - - The bno055_support.c file contains only examples for API use cases, so it is not required to integrate into project. |
28 |
| - |
29 |
| -Driver FILES INFORMATION |
30 |
| -=========================== |
31 |
| - bno055.h |
32 |
| - ----------- |
33 |
| - * This header file has the register address definition, constant definitions, data type definition and supported sensor driver calls declarations. |
34 |
| - |
35 |
| - bno055.c |
36 |
| - ------------ |
37 |
| - * This file contains the implementation for the sensor driver APIs. |
38 |
| - |
39 |
| - bno055_support.c |
40 |
| - ---------------------- |
41 |
| - * This file shall be used as an user guidance, here you can find samples of |
42 |
| - * Initialize the sensor with I2C communication |
43 |
| - - Add your code to the I2C bus read and bus write functions. |
44 |
| - - Return value can be chosen by yourself |
45 |
| - - API just passes that value to your application code |
46 |
| - - Add your code to the delay function |
47 |
| - - Change I2C address accordingly in bno055.h |
48 |
| - * Power mode configuration of the sensor |
49 |
| - * Get and set functions usage |
50 |
| - * Reading the sensor read out data |
51 |
| - |
52 |
| -SUPPORTED SENSOR INTERFACE |
53 |
| -==================================== |
54 |
| - - This BNO055 sensor driver supports I2C interface |
55 |
| - |
56 |
| - |
57 |
| -COPYRIGHT |
58 |
| -=========== |
59 |
| - - Copyright (C) 2015 - 2016 Bosch Sensortec GmbH |
60 |
| - |
61 |
| - |
| 1 | +## Table of Contents |
| 2 | +- [Introduction](#intro) |
| 3 | +- [Version](#ver) |
| 4 | +- [Integration details](#integration) |
| 5 | +- [Driver files information](#fileinfo) |
| 6 | +- [Supported sensor interface](#interface) |
| 7 | +- [Copyright](#copy) |
| 8 | + |
| 9 | +### Introduction<a name=intro></a> |
| 10 | +- This package contains the Bosch Sensortec MEMS BNO055 sensor driver (sensor API) |
| 11 | +- The sensor driver package includes bno055.h, bno055.c and bno055_support.c files |
| 12 | + |
| 13 | +### Version<a name=ver></a> |
| 14 | +- Version of bno055 sensor driver is: |
| 15 | + * bno055.c - V2.0.3 |
| 16 | + * bno055.h - V2.0.3 |
| 17 | + * bno055_support.c - V1.0.4 |
| 18 | + |
| 19 | +### Integration details<a name=integration></a> |
| 20 | +- Integrate bno055.h and bno055.c file in to your project. |
| 21 | +- The bno055_support.c file contains only examples for API use cases, so it is not required to integrate into project. |
| 22 | + |
| 23 | +### Driver files information<a name=fileinfo></a> |
| 24 | +- bno055.h |
| 25 | + * This header file has the register address definition, constant definitions, data type definition and supported sensor driver calls declarations. |
| 26 | +- bno055.c |
| 27 | + * This file contains the implementation for the sensor driver APIs. |
| 28 | +- bno055_support.c |
| 29 | + * This file shall be used as an user guidance, here you can find samples of |
| 30 | + * Initialize the sensor with I2C communication |
| 31 | + - Add your code to the I2C bus read and bus write functions. |
| 32 | + - Return value can be chosen by yourself |
| 33 | + - API just passes that value to your application code |
| 34 | + - Add your code to the delay function |
| 35 | + - Change I2C address accordingly in bno055.h |
| 36 | + * Power mode configuration of the sensor |
| 37 | + * Get and set functions usage |
| 38 | + * Reading the sensor read out data |
| 39 | + |
| 40 | +### Supported sensor interface<a name=interface></a> |
| 41 | +- This BNO055 sensor driver supports I2C and SPI interfaces |
| 42 | + |
| 43 | +### Copyright<a name=copy></a> |
| 44 | +- Copyright (C) 2015 - 2016 Bosch Sensortec GmbH |
| 45 | + |
0 commit comments