git.itanic.dy.fi Git - BME280_driver/blob - README.md

   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 INTRODUCTION
  12 ===============
  13         - This package contains the Bosch Sensortec MEMS humidity sensor driver(sensor API)
  14         - The sensor driver package includes bme280.h, bme280.c and bme280_support.c files
  15
  16 VERSION
  17 =========
  18         - Version of bme280 sensor driver is:
  19                 * bme280.c - V2.0.3
  20                 * bme280.h - V2.0.3
  21                 * bme280_support.c - V1.0.4
  22
  23 INTEGRATION DETAILS
  24 =====================
  25         - Integrate bme280.h and bme280.c file in to your project.
  26         - The bme280_support.c file contains only examples for API use cases, so it is not required to integrate into project.
  27
  28 DRIVER FILES INFORMATION
  29 ===========================
  30         bme280.h
  31         -----------
  32                 * This header file has the register address definition, constant definitions, data type definition and supported sensor driver calls declarations.
  33
  34          bme280.c
  35         ------------
  36                 * This file contains the implementation for the sensor driver APIs.
  37
  38          bme280_support.c
  39         ----------------------
  40                 * This file shall be used as an user guidance, here you can find samples of
  41                         * Initialize the sensor with I2C/SPI communication
  42                                         - Add your code to the SPI and/or I2C bus read and bus write functions.
  43                                                 - Return value can be chosen by yourself
  44                                                 - API just passes that value to your application code
  45                                         - Add your code to the delay function
  46                                         - Change I2C address accordingly in bme280.h
  47                         * Power mode configuration of the sensor
  48                         * Get and set functions usage
  49                         * Reading the sensor read out data
  50
  51 SUPPORTED SENSOR INTERFACE
  52 ====================================
  53         - This humidity sensor driver supports SPI and I2C interfaces
  54
  55
  56 COPYRIGHT
  57 ===========
  58         - Copyright (C) 2013 - 2014 Bosch Sensortec GmbH
  59
  60
  61
  62
  63
  64