UPM

The UPM API is a high level sensor library for IoT devices using MRAA. See examples here. Back to index page.
SparkFun sensor images provided under CC BY-NC-SA-3.0.

BME280 Class

Module: bmp280
  • ID: bme280
  • Name: Digital Humidity, Pressure, and Temperature Sensor
  • Category: pressure humidity
  • Manufacturer: bosch adafruit
  • Connection: i2c spi gpio
  • Link: https://www.adafruit.com/products/2652

The BME280 is as combined digital humidity, pressure and temperature sensor based on proven sensing principles. The sensor module is housed in an extremely compact metal-lid LGA package with a footprint of only 2.5 * 2.5 mm2 with a height of 0.93 mm. Its small dimensions and its low power consumption allow the implementation in battery driven devices such as handsets, GPS modules or watches. The BME280 is register and performance compatible to the Bosch Sensortec BMP280 digital pressure sensor.

Methods

BME280

(
  • bus
  • addr
  • cs
)
Number

BME280 constructor.
This driver supports both the BMP280 and the BME280 . The BME280 adds a humidity sensor. The device type is detected automatically by querying the chip id register.
This device can support both I2C and SPI. For SPI, set the addr to -1, and specify a positive integer representing the Chip Select (CS) pin for the cs argument. If you are using a hardware CS pin, then you can connect the proper pin to the hardware CS pin on your MCU and supply -1 for cs. The default operating mode is I2C.

Parameters:

  • bus Number

    I2C or SPI bus to use.

  • addr Number

    The I2C address for this device. Use -1 for SPI.

  • cs Number

    The gpio pin to use for the SPI Chip Select. Use -1 for I2C, or for SPI with a hardware controlled pin.

Returns:

Number:

getHumidity

() Number

Return the current measured relative humidity. update() must have been called prior to calling this method. If the device is a bmp280 rather than a bme280, this method will always return 0.

Returns:

Number:

The relative humidity in percent.

setOversampleRateHumidity

(
  • rate
)

Set the humidity sensor oversampling parameter. See the data sheet for details. This value can be automatically set to a suitable value by using one of the predefined modes for setUsageMode() .

Parameters:

  • rate BME280_OSRS_H_T

    One of the OSRS_H_T values.

getModuleName

() String

Returns name of module. This is the string in library name after libupm_

Returns:

String:

name of module

getHumidityRelative

() Number

Returns:

Number: