Updated license and formatting

[BME280_driver] / bme280.h

diff --git a/bme280.h b/bme280.h
index 414b3bd346d0633e657ea15d4a7bb66cd1ced578..958f0fa0a2730e434396012a6cc1d84b0c74fe96 100644 (file)
--- a/bme280.h
+++ b/bme280.h
@@ -1,50 +1,40 @@
 /**\r
- * Copyright (C) 2018 - 2019 Bosch Sensortec GmbH\r
- *\r
- * Redistribution and use in source and binary forms, with or without\r
- * modification, are permitted provided that the following conditions are met:\r
- *\r
- * Redistributions of source code must retain the above copyright\r
- * notice, this list of conditions and the following disclaimer.\r
- *\r
- * Redistributions in binary form must reproduce the above copyright\r
- * notice, this list of conditions and the following disclaimer in the\r
- * documentation and/or other materials provided with the distribution.\r
- *\r
- * Neither the name of the copyright holder nor the names of the\r
- * contributors may be used to endorse or promote products derived from\r
- * this software without specific prior written permission.\r
- *\r
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND\r
- * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR\r
- * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\r
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\r
- * DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER\r
- * OR CONTRIBUTORS BE LIABLE FOR ANY\r
- * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,\r
- * OR CONSEQUENTIAL DAMAGES(INCLUDING, BUT NOT LIMITED TO,\r
- * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\r
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\r
- * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,\r
- * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\r
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN\r
- * ANY WAY OUT OF THE USE OF THIS\r
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE\r
- *\r
- * The information provided is believed to be accurate and reliable.\r
- * The copyright holder assumes no responsibility\r
- * for the consequences of use\r
- * of such information nor for any infringement of patents or\r
- * other rights of third parties which may result from its use.\r
- * No license is granted by implication or otherwise under any patent or\r
- * patent rights of the copyright holder.\r
- *\r
- * @file    bme280.h\r
- * @date    26 Aug 2019\r
- * @version 3.3.7\r
- * @brief\r
- *\r
- */\r
+* Copyright (c) 2020 Bosch Sensortec GmbH. All rights reserved.\r
+*\r
+* BSD-3-Clause\r
+*\r
+* Redistribution and use in source and binary forms, with or without\r
+* modification, are permitted provided that the following conditions are met:\r
+*\r
+* 1. Redistributions of source code must retain the above copyright\r
+*    notice, this list of conditions and the following disclaimer.\r
+*\r
+* 2. Redistributions in binary form must reproduce the above copyright\r
+*    notice, this list of conditions and the following disclaimer in the\r
+*    documentation and/or other materials provided with the distribution.\r
+*\r
+* 3. Neither the name of the copyright holder nor the names of its\r
+*    contributors may be used to endorse or promote products derived from\r
+*    this software without specific prior written permission.\r
+*\r
+* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\r
+* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\r
+* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS\r
+* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE\r
+* COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,\r
+* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\r
+* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\r
+* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\r
+* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,\r
+* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING\r
+* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\r
+* POSSIBILITY OF SUCH DAMAGE.\r
+*\r
+* @file bme280.h\r
+* @date 10/01/2020\r
+* @version  3.4.1\r
+*\r
+*/\r
 \r
 /*! @file bme280.h\r
  * @brief Sensor driver for BME280 sensor\r
@@ -237,6 +227,18 @@ int8_t bme280_compensate_data(uint8_t sensor_comp,
                               struct bme280_data *comp_data,\r
                               struct bme280_calib_data *calib_data);\r
 \r
+/*!\r
+ * @brief This API is used to calculate the maximum delay in milliseconds required for the\r
+ * temperature/pressure/humidity(which ever are enabled) measurement to complete.\r
+ * The delay depends upon the number of sensors enabled and their oversampling configuration.\r
+ *\r
+ * @param[in] settings : contains the oversampling configurations.\r
+ *\r
+ * @return delay required in milliseconds.\r
+ */\r
+\r
+uint32_t bme280_cal_meas_delay(const struct bme280_settings *settings);\r
+\r
 #ifdef __cplusplus\r
 }\r
 #endif /* End of CPP guard */\r