Update README.md
authorBoschSensortec <BoschSensortec@users.noreply.github.com>
Thu, 18 Dec 2014 08:26:39 +0000 (16:26 +0800)
committerBoschSensortec <BoschSensortec@users.noreply.github.com>
Thu, 18 Dec 2014 08:26:39 +0000 (16:26 +0800)
README.md

index e557a10..a6624d3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,61 @@
-BNO055_driver
-=============
 
-Bosch Sensortec BNO055 sensor driver
+CONTENTS OF THIS FILE
+=======================
+       * Introduction
+       * Version
+       * Integration details
+       * Driver files information
+       * Supported sensor interface
+       * Copyright
+
+
+INTRODUCTION
+===============
+       - This package contains the Bosch Sensortec MEMS BNO055 sensor driver (sensor API)
+       - The sensor driver package includes bno055.h, bno055.c and bno055_support.c files
+
+VERSION
+=========
+       - Version of bno055 sensor driver is:
+               * bno055.c              - V2.0.2
+               * bno055.h              - V2.0.2
+               * bno055_support.c      - V1.0.3
+
+INTEGRATION DETAILS
+=====================
+       - Integrate bno055.h and bno055.c file in to your project.
+       - The bno055_support.c file contains only examples for API use cases, so it is not required to integrate into project.
+
+Driver FILES INFORMATION
+===========================
+       bno055.h
+       -----------
+               * This header file has the register address definition, constant definitions, data type definition and supported sensor driver calls declarations.
+
+        bno055.c
+       ------------
+               * This file contains the implementation for the sensor driver APIs.
+
+        bno055_support.c
+       ----------------------
+               * This file shall be used as an user guidance, here you can find samples of
+                       * Initialize the sensor with I2C communication
+                                       - Add your code to the I2C bus read and bus write functions.
+                                               - Return value can be chosen by yourself
+                                               - API just passes that value to your application code
+                                       - Add your code to the delay function
+                                       - Change I2C address accordingly in bno055.h
+                       * Power mode configuration of the sensor
+                       * Get and set functions usage
+                       * Reading the sensor read out data
+
+SUPPORTED SENSOR INTERFACE
+====================================
+       - This BNO055 sensor driver supports I2C interface
+
+
+COPYRIGHT
+===========
+       - Copyright (C) 2013 - 2014 Bosch Sensortec GmbH
+
+