modm API documentation
modm::Bme280< I2cMaster > Class Template Reference

#include <modm/driver/pressure/bme280.hpp>

Public Typedefs

using Calibration = modm::bme280data::Calibration
 
using Data = modm::bme280data::Data
 
using DataBase = modm::bme280data::DataBase
 
using DataDouble = modm::bme280data::DataDouble
 
typedef Configuration< CtrlMeas_t, Mode,(Bit1|Bit0) > Mode_t
 
typedef Configuration< CtrlMeas_t, Oversampling,(Bit2|Bit1|Bit0), 2 > Pressure
 
typedef Configuration< CtrlMeas_t, Oversampling,(Bit2|Bit1|Bit0), 5 > Temperature
 
typedef Configuration< CtrlHum_t, Oversampling,(Bit2|Bit1|Bit0), 0 > Humidity
 
typedef Configuration< Config_t, TimeStandby,(Bit7|Bit6|Bit5) > TimeStandby_t
 

Public Types

enum  CtrlHum : uint8_t
 
enum  Status : uint8_t
 
enum  CtrlMeas : uint8_t
 
enum  Mode : uint8_t
 
enum  Oversampling : uint8_t
 
enum  Config : uint8_t
 
enum  TimeStandby : uint8_t
 
enum  FilterSettings : uint8_t
 

Public Member Functions

 MODM_FLAGS8 (CtrlHum)
 
 MODM_FLAGS8 (Status)
 
 MODM_FLAGS8 (CtrlMeas)
 
 MODM_FLAGS8 (Config)
 
 Bme280 (Data &data, uint8_t address=0x76)
 
modm::ResumableResult< bool > initialize (Mode mode=Mode::Normal, Oversampling temperature=Oversampling::Single, Oversampling pressure=Oversampling::Single, Oversampling humidity=Oversampling::Single)
 Reads out and stores the calibration bytes.
 
modm::ResumableResult< bool > readout ()
 Read the raw data from the sensor. Conversion must be freerunning.
 
modm::ResumableResult< bool > startMeasurement (Oversampling temperature=Oversampling::Single, Oversampling pressure=Oversampling::Single)
 
DatagetData ()
 Get the data object for this sensor.
 

Detailed Description

template<typename I2cMaster>
class modm::Bme280< I2cMaster >

Author
Sascha Schade
Template Parameters
I2cMasterI2C interface

Constructor & Destructor Documentation

template<typename I2cMaster >
modm::Bme280< I2cMaster >::Bme280 ( Data data,
uint8_t  address = 0x76 
)
Parameters
datapointer to buffer of the internal data of type Data
addressaddress defaults to 0x76

Member Function Documentation

template<typename I2cMaster >
modm::ResumableResult<bool> modm::Bme280< I2cMaster >::startMeasurement ( Oversampling  temperature = Oversampling::Single,
Oversampling  pressure = Oversampling::Single 
)

Start a single measurement in forced mode. Sensor will go to standby after this. To reduce bus traffic only the absolute necessary register (CTRL_MEAS) is written. If oversampling of humidity shall be changed, another method must be used.


The documentation for this class was generated from the following file: