ErriezBMX280 Class Reference

BMX280 class. More...

#include <ErriezBMX280.h>

Public Member Functions
	ErriezBMX280 (uint8_t i2cAddr)
	Constructor. More...
bool	begin ()
	Sensor initialization. More...
uint8_t	getChipID ()
	Get chip ID. More...
float	readTemperature ()
	Read temperature. More...
float	readPressure ()
	Read pressure. More...
float	readAltitude (float seaLevel)
	Read approximate altitude. More...
float	readHumidity ()
	Read humidity (BME280 only) More...
void	setSampling (BMX280_Mode_e mode=BMX280_MODE_NORMAL, BMX280_Sampling_e tempSampling=BMX280_SAMPLING_X16, BMX280_Sampling_e pressSampling=BMX280_SAMPLING_X16, BMX280_Sampling_e humSampling=BMX280_SAMPLING_X16, BMX280_Filter_e filter=BMX280_FILTER_OFF, BMX280_Standby_e standbyDuration=BMX280_STANDBY_MS_0_5)
	Set sampling registers. More...
uint8_t	read8 (uint8_t reg)
	Read from 8-bit register. More...
uint16_t	read16 (uint8_t reg)
	Read from 16-bit register. More...
uint16_t	read16_LE (uint8_t reg)
	Read from 16-bit unsigned register little endian. More...
int16_t	readS16_LE (uint8_t reg)
	Read from 16-bit signed register little endian. More...
uint32_t	read24 (uint8_t reg)
	Read from 24-bit register. More...
void	write8 (uint8_t reg, uint8_t value)
	Write to 8-bit register. More...

Detailed Description

BMX280 class.

Definition at line 134 of file ErriezBMX280.h.

Constructor & Destructor Documentation

ErriezBMX280()

ErriezBMX280::ErriezBMX280

(

uint8_t

i2cAddr

)

Constructor.

Parameters

i2cAddr

I2C address

Definition at line 43 of file ErriezBMX280.cpp.

Member Function Documentation

begin()

bool ErriezBMX280::begin

(

)

Sensor initialization.

Return values

true	BMP280 or BME280 sensor detected
false	Error: No (supported) sensor detected

Definition at line 55 of file ErriezBMX280.cpp.

getChipID()

uint8_t ErriezBMX280::getChipID

(

)

Get chip ID.

Returns

Chip ID as read with begin()

Definition at line 93 of file ErriezBMX280.cpp.

read16()

uint16_t ErriezBMX280::read16

(

uint8_t

reg

)

Read from 16-bit register.

Parameters

reg	Register address

Returns

16-bit register value

Definition at line 357 of file ErriezBMX280.cpp.

read16_LE()

uint16_t ErriezBMX280::read16_LE

(

uint8_t

reg

)

Read from 16-bit unsigned register little endian.

Parameters

reg	Register address

Returns

16-bit unsigned register value in little endian

Definition at line 329 of file ErriezBMX280.cpp.

read24()

uint32_t ErriezBMX280::read24

(

uint8_t

reg

)

Read from 24-bit register.

Parameters

reg	Register address

Returns

24-bit register value

Definition at line 375 of file ErriezBMX280.cpp.

read8()

uint8_t ErriezBMX280::read8

(

uint8_t

reg

)

Read from 8-bit register.

Parameters

reg	Register address

Returns

8-bit register value

Definition at line 296 of file ErriezBMX280.cpp.

readAltitude()

float ErriezBMX280::readAltitude

(

float

seaLevel

)

Read approximate altitude.

Parameters

seaLevel

Sea level in hPa

Returns

Altitude (float)

Definition at line 174 of file ErriezBMX280.cpp.

readHumidity()

float ErriezBMX280::readHumidity

(

)

Read humidity (BME280 only)

Returns

Humidity (float)

Definition at line 187 of file ErriezBMX280.cpp.

readPressure()

float ErriezBMX280::readPressure

(

)

Read pressure.

Returns

Pressure (float)

Definition at line 132 of file ErriezBMX280.cpp.

readS16_LE()

int16_t ErriezBMX280::readS16_LE

(

uint8_t

reg

)

Read from 16-bit signed register little endian.

Parameters

reg	Register address

Returns

16-bit signed register value in little endian

Definition at line 345 of file ErriezBMX280.cpp.

readTemperature()

float ErriezBMX280::readTemperature

(

)

Read temperature.

Returns

Temperature (float)

Definition at line 104 of file ErriezBMX280.cpp.

setSampling()

void ErriezBMX280::setSampling	(	BMX280_Mode_e	mode = BMX280_MODE_NORMAL,
		BMX280_Sampling_e	tempSampling = BMX280_SAMPLING_X16,
		BMX280_Sampling_e	pressSampling = BMX280_SAMPLING_X16,
		BMX280_Sampling_e	humSampling = BMX280_SAMPLING_X16,
		BMX280_Filter_e	filter = BMX280_FILTER_OFF,
		BMX280_Standby_e	standbyDuration = BMX280_STANDBY_MS_0_5
	)

Set sampling registers.

Parameters

mode	See BMX280_Mode_e
tempSampling	See BMX280_Sampling_e
pressSampling	See BMX280_Sampling_e
humSampling	See BMX280_Sampling_e
filter	See BMX280_Filter_e
standbyDuration	See BMX280_Standby_e

Definition at line 269 of file ErriezBMX280.cpp.

write8()

void ErriezBMX280::write8	(	uint8_t	reg,
		uint8_t	value
	)

Write to 8-bit register.

Parameters

reg	Register address
value	8-bit register value

Definition at line 314 of file ErriezBMX280.cpp.

---

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

• src/ErriezBMX280.h
• src/ErriezBMX280.cpp