Skip to content

Commit

Permalink
Updated license and formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
BST-Github-Admin authored and kegov committed Jan 14, 2020
1 parent 707c0e4 commit 6c5d87b
Show file tree
Hide file tree
Showing 5 changed files with 28,111 additions and 26,213 deletions.
30 changes: 30 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
Copyright (c) 2020 Bosch Sensortec GmbH. All rights reserved.

BSD-3-Clause

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 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 the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
COPYRIGHT HOLDER 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.
106 changes: 45 additions & 61 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,61 +1,45 @@

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.3
* bno055.h - V2.0.3
* bno055_support.c - V1.0.4

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) 2015 - 2016 Bosch Sensortec GmbH


## Table of Contents
- [Introduction](#intro)
- [Version](#ver)
- [Integration details](#integration)
- [Driver files information](#fileinfo)
- [Supported sensor interface](#interface)
- [Copyright](#copy)

### Introduction<a name=intro></a>
- 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<a name=ver></a>
- Version of bno055 sensor driver is:
* bno055.c - V2.0.3
* bno055.h - V2.0.3
* bno055_support.c - V1.0.4

### Integration details<a name=integration></a>
- 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<a name=fileinfo></a>
- 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<a name=interface></a>
- This BNO055 sensor driver supports I2C and SPI interfaces

### Copyright<a name=copy></a>
- Copyright (C) 2015 - 2016 Bosch Sensortec GmbH

Loading

0 comments on commit 6c5d87b

Please sign in to comment.