Commit a5c6adc4 authored by Daniel Friesel's avatar Daniel Friesel
Browse files

Add Bosch SensorTec BME680 driver + utilities

parent 9fbfe1c5

Makefile

+8 −3
Original line number Diff line number Diff line
@@ -38,6 +38,11 @@ ifneq ($(findstring am2320,${drivers}), ) 
	COMMON_FLAGS += -DDRIVER_AM2320

endif



ifneq ($(findstring bme680,${drivers}), )

	CXX_TARGETS += src/driver/bme680.cc src/driver/bme680_util.cc

	COMMON_FLAGS += -DDRIVER_BME680

endif



ifneq ($(findstring ccs811,${drivers}), )

	CXX_TARGETS += src/driver/ccs811.cc

	COMMON_FLAGS += -DDRIVER_CCS811
@@ -83,12 +88,12 @@ endif 


ifneq ($(findstring sharp96,${drivers}), )

	CXX_TARGETS += src/driver/sharp96.cc

	sharp96_power_pin ?= p1_2

	sharp96_en_pin ?= p6_2

	sharp96_cs_pin ?= p1_3

	sharp96_power_pin ?= p4_2

	sharp96_en_pin ?= p4_3

	sharp96_cs_pin ?= p2_4

	sharp96_power_pin ?= p1_2

	sharp96_en_pin ?= p6_2

	sharp96_cs_pin ?= p1_3

	COMMON_FLAGS += -DDRIVER_SHARP6

	COMMON_FLAGS += -DSHARP96_POWER_PIN=GPIO::${sharp96_power_pin}

	COMMON_FLAGS += -DSHARP96_EN_PIN=GPIO::${sharp96_en_pin}

include/driver/bme680.h

0 → 100644
+225 −0
Original line number Diff line number Diff line 
/**

 * Copyright (C) 2017 - 2018 Bosch Sensortec GmbH

 *

 * Redistribution and use in source and binary forms, with or without

 * modification, are permitted provided that the following conditions are met:

 *

 * Redistributions of source code must retain the above copyright

 * notice, this list of conditions and the following disclaimer.

 *

 * 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.

 *

 * Neither the name of the copyright holder nor the names of the

 * 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 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

 *

 * The information provided is believed to be accurate and reliable.

 * The copyright holder assumes no responsibility

 * for the consequences of use

 * of such information nor for any infringement of patents or

 * other rights of third parties which may result from its use.

 * No license is granted by implication or otherwise under any patent or

 * patent rights of the copyright holder.

 *

 * @file	bme680.h

 * @date	19 Jun 2018

 * @version	3.5.9

 * @brief

 *

 */

/*! @file bme680.h

 @brief Sensor driver for BME680 sensor */

/*!

 * @defgroup BME680 SENSOR API

 * @{*/

#ifndef BME680_H_

#define BME680_H_



/*! CPP guard */

#ifdef __cplusplus

extern "C"

{

#endif



/* Header includes */

#include "driver/bme680_defs.h"



/* function prototype declarations */

/*!

 *  @brief This API is the entry point.

 *  It reads the chip-id and calibration data from the sensor.

 *

 *  @param[in,out] dev : Structure instance of bme680_dev

 *

 *  @return Result of API execution status

 *  @retval zero -> Success / +ve value -> Warning / -ve value -> Error

 */

int8_t bme680_init(struct bme680_dev *dev);



/*!

 * @brief This API writes the given data to the register address

 * of the sensor.

 *

 * @param[in] reg_addr : Register address from where the data to be written.

 * @param[in] reg_data : Pointer to data buffer which is to be written

 * in the sensor.

 * @param[in] len : No of bytes of data to write..

 * @param[in] dev : Structure instance of bme680_dev.

 *

 * @return Result of API execution status

 * @retval zero -> Success / +ve value -> Warning / -ve value -> Error

 */

int8_t bme680_set_regs(const uint8_t *reg_addr, const uint8_t *reg_data, uint8_t len, struct bme680_dev *dev);



/*!

 * @brief This API reads the data from the given register address of the sensor.

 *

 * @param[in] reg_addr : Register address from where the data to be read

 * @param[out] reg_data : Pointer to data buffer to store the read data.

 * @param[in] len : No of bytes of data to be read.

 * @param[in] dev : Structure instance of bme680_dev.

 *

 * @return Result of API execution status

 * @retval zero -> Success / +ve value -> Warning / -ve value -> Error

 */

int8_t bme680_get_regs(uint8_t reg_addr, uint8_t *reg_data, uint16_t len, struct bme680_dev *dev);



/*!

 * @brief This API performs the soft reset of the sensor.

 *

 * @param[in] dev : Structure instance of bme680_dev.

 *

 * @return Result of API execution status

 * @retval zero -> Success / +ve value -> Warning / -ve value -> Error.

 */

int8_t bme680_soft_reset(struct bme680_dev *dev);



/*!

 * @brief This API is used to set the power mode of the sensor.

 *

 * @param[in] dev : Structure instance of bme680_dev

 * @note : Pass the value to bme680_dev.power_mode structure variable.

 *

 *  value	|	mode

 * -------------|------------------

 *	0x00	|	BME680_SLEEP_MODE

 *	0x01	|	BME680_FORCED_MODE

 *

 * * @return Result of API execution status

 * @retval zero -> Success / +ve value -> Warning / -ve value -> Error

 */

int8_t bme680_set_sensor_mode(struct bme680_dev *dev);



/*!

 * @brief This API is used to get the power mode of the sensor.

 *

 * @param[in] dev : Structure instance of bme680_dev

 * @note : bme680_dev.power_mode structure variable hold the power mode.

 *

 *  value	|	mode

 * ---------|------------------

 *	0x00	|	BME680_SLEEP_MODE

 *	0x01	|	BME680_FORCED_MODE

 *

 * @return Result of API execution status

 * @retval zero -> Success / +ve value -> Warning / -ve value -> Error

 */

int8_t bme680_get_sensor_mode(struct bme680_dev *dev);



/*!

 * @brief This API is used to set the profile duration of the sensor.

 *

 * @param[in] dev	   : Structure instance of bme680_dev.

 * @param[in] duration : Duration of the measurement in ms.

 *

 * @return Nothing

 */

void bme680_set_profile_dur(uint16_t duration, struct bme680_dev *dev);



/*!

 * @brief This API is used to get the profile duration of the sensor.

 *

 * @param[in] dev	   : Structure instance of bme680_dev.

 * @param[in] duration : Duration of the measurement in ms.

 *

 * @return Nothing

 */

void bme680_get_profile_dur(uint16_t *duration, const struct bme680_dev *dev);



/*!

 * @brief This API reads the pressure, temperature and humidity and gas data

 * from the sensor, compensates the data and store it in the bme680_data

 * structure instance passed by the user.

 *

 * @param[out] data: Structure instance to hold the data.

 * @param[in] dev : Structure instance of bme680_dev.

 *

 * @return Result of API execution status

 * @retval zero -> Success / +ve value -> Warning / -ve value -> Error

 */

int8_t bme680_get_sensor_data(struct bme680_field_data *data, struct bme680_dev *dev);



/*!

 * @brief This API is used to set the oversampling, filter and T,P,H, gas selection

 * settings in the sensor.

 *

 * @param[in] dev : Structure instance of bme680_dev.

 * @param[in] desired_settings : Variable used to select the settings which

 * are to be set in the sensor.

 *

 *	 Macros	                   |  Functionality

 *---------------------------------|----------------------------------------------

 *	BME680_OST_SEL             |    To set temperature oversampling.

 *	BME680_OSP_SEL             |    To set pressure oversampling.

 *	BME680_OSH_SEL             |    To set humidity oversampling.

 *	BME680_GAS_MEAS_SEL        |    To set gas measurement setting.

 *	BME680_FILTER_SEL          |    To set filter setting.

 *	BME680_HCNTRL_SEL          |    To set humidity control setting.

 *	BME680_RUN_GAS_SEL         |    To set run gas setting.

 *	BME680_NBCONV_SEL          |    To set NB conversion setting.

 *	BME680_GAS_SENSOR_SEL      |    To set all gas sensor related settings

 *

 * @note : Below are the macros to be used by the user for selecting the

 * desired settings. User can do OR operation of these macros for configuring

 * multiple settings.

 *

 * @return Result of API execution status

 * @retval zero -> Success / +ve value -> Warning / -ve value -> Error.

 */

int8_t bme680_set_sensor_settings(uint16_t desired_settings, struct bme680_dev *dev);



/*!

 * @brief This API is used to get the oversampling, filter and T,P,H, gas selection

 * settings in the sensor.

 *

 * @param[in] dev : Structure instance of bme680_dev.

 * @param[in] desired_settings : Variable used to select the settings which

 * are to be get from the sensor.

 *

 * @return Result of API execution status

 * @retval zero -> Success / +ve value -> Warning / -ve value -> Error.

 */

int8_t bme680_get_sensor_settings(uint16_t desired_settings, struct bme680_dev *dev);

#ifdef __cplusplus

}

#endif /* End of CPP guard */

#endif /* BME680_H_ */

/** @}*/

include/driver/bme680_defs.h

0 → 100644
+545 −0

File added.

Preview size limit exceeded, changes collapsed.

include/driver/bme680_util.h

0 → 100644
+7 −0
Original line number Diff line number Diff line 
#include <stdint.h>



void bme680_delay_ms(uint32_t const period);



int8_t bme680_i2c_read(uint8_t dev_id, uint8_t reg_addr, uint8_t *reg_data, uint16_t len);



int8_t bme680_i2c_write(uint8_t dev_id, uint8_t reg_addr, uint8_t *reg_data, uint16_t len);

src/app/i2cdetect/main.cc

+39 −0
Original line number Diff line number Diff line
@@ -12,6 +12,10 @@ 
#ifdef DRIVER_AM2320

#include "driver/am2320.h"

#endif

#ifdef DRIVER_BME680

#include "driver/bme680.h"

#include "driver/bme680_util.h"

#endif

#ifdef DRIVER_CCS811

#include "driver/ccs811.h"

#endif
@@ -42,6 +46,41 @@ void loop(void) 
		kout << "AM2320 error " << dec << am2320.getStatus() << endl;

	}

#endif

#ifdef DRIVER_BME680

	struct bme680_dev gas_sensor;



	gas_sensor.dev_id = BME680_I2C_ADDR_SECONDARY;

	gas_sensor.intf = BME680_I2C_INTF;

	gas_sensor.read = bme680_i2c_read;

	gas_sensor.write = bme680_i2c_write;

	gas_sensor.delay_ms = bme680_delay_ms;

	/* amb_temp can be set to 25 prior to configuring the gas sensor 

	* or by performing a few temperature readings without operating the gas sensor.

	*/

	gas_sensor.amb_temp = 25;



	int8_t rslt = BME680_OK;

	rslt = bme680_init(&gas_sensor);

	kout << "BME680 init " << rslt << endl;



	gas_sensor.power_mode = BME680_FORCED_MODE;

	gas_sensor.tph_sett.os_hum = BME680_OS_1X;

	gas_sensor.tph_sett.os_pres = BME680_OS_16X;

	gas_sensor.tph_sett.os_temp = BME680_OS_2X;



	gas_sensor.gas_sett.run_gas = BME680_ENABLE_GAS_MEAS;

	gas_sensor.gas_sett.heatr_dur = 150;

	gas_sensor.gas_sett.heatr_temp = 300;

	bme680_set_sensor_settings(BME680_OST_SEL | BME680_OSP_SEL | BME680_OSH_SEL | BME680_GAS_SENSOR_SEL, &gas_sensor);

	bme680_set_sensor_mode(&gas_sensor);

	arch.delay_ms(500);

	struct bme680_field_data data;

	bme680_get_sensor_data(&data, &gas_sensor);

	kout << "BME680 temperature " << (float)data.temperature / 100 << " degC" << endl;

	kout << "BME680 humidity " << (float)data.humidity / 1000  << " %" << endl;

	kout << "BME680 pressure " << (float)data.pressure / 100 << " hPa" << endl;

	kout << "BME680 gas resistance " << data.gas_resistance << endl;

#endif

#ifdef DRIVER_CCS811

	kout << "CCS811 status is " << ccs811.check() << endl;

#endif