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

   1 # BME280 sensor API\r
   2 ## Introduction\r
   3 This package contains the Bosch Sensortec's BME280 pressure sensor driver (sensor API)\r
   4 \r
   5 The sensor driver package includes bme280.c, bme280.h and bme280_defs.h files.\r
   6 \r
   7 ## Version\r
   8 File          | Version | Date\r
   9 --------------|---------|------------\r
  10 bme280.c      |  3.3.7  | 26 Aug 2019\r
  11 bme280.h      |  3.3.7  | 26 Aug 2019\r
  12 bme280_defs.h |  3.3.7  | 26 Aug 2019\r
  13 \r
  14 ## Integration details\r
  15 * Integrate bme280.h, bme280_defs.h and bme280.c file in to the project.\r
  16 * Include the bme280.h file in your code like below.\r
  17 ``` c\r
  18 #include "bme280.h"\r
  19 ```\r
  20 \r
  21 ## File information\r
  22 * bme280_defs.h : This header file has the constants, macros and datatype declarations.\r
  23 * bme280.h : This header file contains the declarations of the sensor driver APIs.\r
  24 * bme280.c : This source file contains the definitions of the sensor driver APIs.\r
  25 \r
  26 ## Supported sensor interfaces\r
  27 * SPI 4-wire\r
  28 * I2C\r
  29 \r
  30 SPI 3-wire is currently not supported in the API.\r
  31 ## Usage guide\r
  32 ### Initializing the sensor\r
  33 To initialize the sensor, user need to create a device structure. User can do this by \r
  34 creating an instance of the structure bme280_dev. After creating the device strcuture, user \r
  35 need to fill in the various parameters as shown below.\r
  36 \r
  37 #### Example for SPI 4-Wire\r
  38 ``` c\r
  39 struct bme280_dev dev;\r
  40 int8_t rslt = BME280_OK;\r
  41 \r
  42 /* Sensor_0 interface over SPI with native chip select line */\r
  43 dev.dev_id = 0;\r
  44 dev.intf = BME280_SPI_INTF;\r
  45 dev.read = user_spi_read;\r
  46 dev.write = user_spi_write;\r
  47 dev.delay_ms = user_delay_ms;\r
  48 \r
  49 rslt = bme280_init(&dev);\r
  50 ```\r
  51 #### Example for I2C\r
  52 ``` c\r
  53 struct bme280_dev dev;\r
  54 int8_t rslt = BME280_OK;\r
  55 \r
  56 dev.dev_id = BME280_I2C_ADDR_PRIM;\r
  57 dev.intf = BME280_I2C_INTF;\r
  58 dev.read = user_i2c_read;\r
  59 dev.write = user_i2c_write;\r
  60 dev.delay_ms = user_delay_ms;\r
  61 \r
  62 rslt = bme280_init(&dev);\r
  63 ```\r
  64 Regarding compensation functions for temperature,pressure and humidity we have two implementations.\r
  65 1) Double precision floating point version\r
  66 2) Integer version\r
  67 \r
  68 By default, integer version is used in the API. If the user needs the floating point version, the user has to uncomment BME280_FLOAT_ENABLE macro in bme280_defs.h file or add that to the compiler flags.\r
  69 \r
  70 In integer compensation functions, we also have below two implementations for pressure.\r
  71 1) For 32 bit machine.\r
  72 2) For 64 bit machine.\r
  73 \r
  74 By default, 64 bit variant is used in the API. If the user wants 32 bit variant, the user can disable the\r
  75 macro BME280_64BIT_ENABLE in bme280_defs.h file.\r
  76 \r
  77 ### Sensor data units\r
  78 > The sensor data units depends on the following macros being enabled or not, \r
  79 > (in bme280_defs.h file or as compiler macros)\r
  80 >   * BME280_FLOAT_ENABLE\r
  81 >   * BME280_64BIT_ENABLE\r
  82 \r
  83 In case of the macro "BME280_FLOAT_ENABLE" enabled,\r
  84 The outputs are in double and the units are\r
  85 \r
  86     - °C for temperature\r
  87     - % relative humidity\r
  88     - Pascal for pressure\r
  89 \r
  90 In case if "BME280_FLOAT_ENABLE" is not enabled, then it is\r
  91 \r
  92     - int32_t for temperature with the units 100 * °C\r
  93     - uint32_t for humidity with the units 1024 * % relative humidity\r
  94     - uint32_t for pressure\r
  95          If macro "BME280_64BIT_ENABLE" is enabled, which it is by default, the unit is 100 * Pascal\r
  96          If this macro is disabled, Then the unit is in Pascal\r
  97 \r
  98 ### Stream sensor data\r
  99 #### Stream sensor data in forced mode\r
 100 \r
 101 ``` c\r
 102 int8_t stream_sensor_data_forced_mode(struct bme280_dev *dev)\r
 103 {\r
 104     int8_t rslt;\r
 105     uint8_t settings_sel;\r
 106     struct bme280_data comp_data;\r
 107 \r
 108     /* Recommended mode of operation: Indoor navigation */\r
 109     dev->settings.osr_h = BME280_OVERSAMPLING_1X;\r
 110     dev->settings.osr_p = BME280_OVERSAMPLING_16X;\r
 111     dev->settings.osr_t = BME280_OVERSAMPLING_2X;\r
 112     dev->settings.filter = BME280_FILTER_COEFF_16;\r
 113 \r
 114     settings_sel = BME280_OSR_PRESS_SEL | BME280_OSR_TEMP_SEL | BME280_OSR_HUM_SEL | BME280_FILTER_SEL;\r
 115 \r
 116     rslt = bme280_set_sensor_settings(settings_sel, dev);\r
 117 \r
 118     printf("Temperature, Pressure, Humidity\r\n");\r
 119     /* Continuously stream sensor data */\r
 120     while (1) {\r
 121         rslt = bme280_set_sensor_mode(BME280_FORCED_MODE, dev);\r
 122         /* Wait for the measurement to complete and print data @25Hz */\r
 123         dev->delay_ms(40);\r
 124         rslt = bme280_get_sensor_data(BME280_ALL, &comp_data, dev);\r
 125         print_sensor_data(&comp_data);\r
 126     }\r
 127     return rslt;\r
 128 }\r
 129 \r
 130 void print_sensor_data(struct bme280_data *comp_data)\r
 131 {\r
 132 #ifdef BME280_FLOAT_ENABLE\r
 133         printf("%0.2f, %0.2f, %0.2f\r\n",comp_data->temperature, comp_data->pressure, comp_data->humidity);\r
 134 #else\r
 135         printf("%ld, %ld, %ld\r\n",comp_data->temperature, comp_data->pressure, comp_data->humidity);\r
 136 #endif\r
 137 }\r
 138 ```\r
 139 ##### Stream sensor data in normal mode\r
 140 ``` c\r
 141 int8_t stream_sensor_data_normal_mode(struct bme280_dev *dev)\r
 142 {\r
 143         int8_t rslt;\r
 144         uint8_t settings_sel;\r
 145         struct bme280_data comp_data;\r
 146 \r
 147         /* Recommended mode of operation: Indoor navigation */\r
 148         dev->settings.osr_h = BME280_OVERSAMPLING_1X;\r
 149         dev->settings.osr_p = BME280_OVERSAMPLING_16X;\r
 150         dev->settings.osr_t = BME280_OVERSAMPLING_2X;\r
 151         dev->settings.filter = BME280_FILTER_COEFF_16;\r
 152         dev->settings.standby_time = BME280_STANDBY_TIME_62_5_MS;\r
 153 \r
 154         settings_sel = BME280_OSR_PRESS_SEL;\r
 155         settings_sel |= BME280_OSR_TEMP_SEL;\r
 156         settings_sel |= BME280_OSR_HUM_SEL;\r
 157         settings_sel |= BME280_STANDBY_SEL;\r
 158         settings_sel |= BME280_FILTER_SEL;\r
 159         rslt = bme280_set_sensor_settings(settings_sel, dev);\r
 160         rslt = bme280_set_sensor_mode(BME280_NORMAL_MODE, dev);\r
 161 \r
 162         printf("Temperature, Pressure, Humidity\r\n");\r
 163         while (1) {\r
 164                 /* Delay while the sensor completes a measurement */\r
 165                 dev->delay_ms(70);\r
 166                 rslt = bme280_get_sensor_data(BME280_ALL, &comp_data, dev);\r
 167                 print_sensor_data(&comp_data);\r
 168         }\r
 169 \r
 170         return rslt;\r
 171 }\r
 172 \r
 173 void print_sensor_data(struct bme280_data *comp_data)\r
 174 {\r
 175 #ifdef BME280_FLOAT_ENABLE\r
 176         printf("%0.2f, %0.2f, %0.2f\r\n",comp_data->temperature, comp_data->pressure, comp_data->humidity);\r
 177 #else\r
 178         printf("%ld, %ld, %ld\r\n",comp_data->temperature, comp_data->pressure, comp_data->humidity);\r
 179 #endif\r
 180 }\r
 181 ```\r
 182 \r
 183 ### Templates for function pointers\r
 184 ``` c\r
 185 \r
 186 void user_delay_ms(uint32_t period)\r
 187 {\r
 188     /*\r
 189      * Return control or wait,\r
 190      * for a period amount of milliseconds\r
 191      */\r
 192 }\r
 193 \r
 194 int8_t user_spi_read(uint8_t dev_id, uint8_t reg_addr, uint8_t *reg_data, uint16_t len)\r
 195 {\r
 196     int8_t rslt = 0; /* Return 0 for Success, non-zero for failure */\r
 197 \r
 198     /*\r
 199      * The parameter dev_id can be used as a variable to select which Chip Select pin has\r
 200      * to be set low to activate the relevant device on the SPI bus\r
 201      */\r
 202 \r
 203     /*\r
 204      * Data on the bus should be like\r
 205      * |----------------+---------------------+-------------|\r
 206      * | MOSI           | MISO                | Chip Select |\r
 207      * |----------------+---------------------|-------------|\r
 208      * | (don't care)   | (don't care)        | HIGH        |\r
 209      * | (reg_addr)     | (don't care)        | LOW         |\r
 210      * | (don't care)   | (reg_data[0])       | LOW         |\r
 211      * | (....)         | (....)              | LOW         |\r
 212      * | (don't care)   | (reg_data[len - 1]) | LOW         |\r
 213      * | (don't care)   | (don't care)        | HIGH        |\r
 214      * |----------------+---------------------|-------------|\r
 215      */\r
 216 \r
 217     return rslt;\r
 218 }\r
 219 \r
 220 int8_t user_spi_write(uint8_t dev_id, uint8_t reg_addr, uint8_t *reg_data, uint16_t len)\r
 221 {\r
 222     int8_t rslt = 0; /* Return 0 for Success, non-zero for failure */\r
 223 \r
 224     /*\r
 225      * The parameter dev_id can be used as a variable to select which Chip Select pin has\r
 226      * to be set low to activate the relevant device on the SPI bus\r
 227      */\r
 228 \r
 229     /*\r
 230      * Data on the bus should be like\r
 231      * |---------------------+--------------+-------------|\r
 232      * | MOSI                | MISO         | Chip Select |\r
 233      * |---------------------+--------------|-------------|\r
 234      * | (don't care)        | (don't care) | HIGH        |\r
 235      * | (reg_addr)          | (don't care) | LOW         |\r
 236      * | (reg_data[0])       | (don't care) | LOW         |\r
 237      * | (....)              | (....)       | LOW         |\r
 238      * | (reg_data[len - 1]) | (don't care) | LOW         |\r
 239      * | (don't care)        | (don't care) | HIGH        |\r
 240      * |---------------------+--------------|-------------|\r
 241      */\r
 242 \r
 243     return rslt;\r
 244 }\r
 245 \r
 246 int8_t user_i2c_read(uint8_t dev_id, uint8_t reg_addr, uint8_t *reg_data, uint16_t len)\r
 247 {\r
 248     int8_t rslt = 0; /* Return 0 for Success, non-zero for failure */\r
 249 \r
 250     /*\r
 251      * The parameter dev_id can be used as a variable to store the I2C address of the device\r
 252      */\r
 253 \r
 254     /*\r
 255      * Data on the bus should be like\r
 256      * |------------+---------------------|\r
 257      * | I2C action | Data                |\r
 258      * |------------+---------------------|\r
 259      * | Start      | -                   |\r
 260      * | Write      | (reg_addr)          |\r
 261      * | Stop       | -                   |\r
 262      * | Start      | -                   |\r
 263      * | Read       | (reg_data[0])       |\r
 264      * | Read       | (....)              |\r
 265      * | Read       | (reg_data[len - 1]) |\r
 266      * | Stop       | -                   |\r
 267      * |------------+---------------------|\r
 268      */\r
 269 \r
 270     return rslt;\r
 271 }\r
 272 \r
 273 int8_t user_i2c_write(uint8_t dev_id, uint8_t reg_addr, uint8_t *reg_data, uint16_t len)\r
 274 {\r
 275     int8_t rslt = 0; /* Return 0 for Success, non-zero for failure */\r
 276 \r
 277     /*\r
 278      * The parameter dev_id can be used as a variable to store the I2C address of the device\r
 279      */\r
 280 \r
 281     /*\r
 282      * Data on the bus should be like\r
 283      * |------------+---------------------|\r
 284      * | I2C action | Data                |\r
 285      * |------------+---------------------|\r
 286      * | Start      | -                   |\r
 287      * | Write      | (reg_addr)          |\r
 288      * | Write      | (reg_data[0])       |\r
 289      * | Write      | (....)              |\r
 290      * | Write      | (reg_data[len - 1]) |\r
 291      * | Stop       | -                   |\r
 292      * |------------+---------------------|\r
 293      */\r
 294 \r
 295     return rslt;\r
 296 }\r
 297 \r
 298 ```\r
 299 \r
 300 ## Copyright (C) 2016 - 2017 Bosch Sensortec GmbH