Skip to content

Commit 2f452b2

Browse files
authored
Doc update for bme280.lua (#3384)
- Changed the note about bme280_math dependency into a blue note box, like in the [bh1750 documentation](https://nodemcu.readthedocs.io/en/release/lua-modules/bh1750/) - Added a paragraph on differentiating between BMP280 and BME280 sensors. It put it in an orange caution box for now, might be too visible for a rare problem. - Small fixes in bme280.setup() description
1 parent fc10850 commit 2f452b2

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

docs/lua-modules/bme280.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,19 @@
55

66
This module communicates with [BME280/BMP280 temperature/air presssure/humidity sensors](http://www.bosch-sensortec.com/bst/products/all_products/bme280) (Bosch Sensortec) through [I2C](../modules/i2c.md) interface.
77

8-
Note: the module works only with the [bme280_math](../modules/bme280_math) module.
8+
!!! note
9+
10+
The module works only with the [bme280_math](../modules/bme280_math) module.
11+
12+
!!! caution
13+
14+
The BMP280 only supports temperature and air pressure measurements. It will give wrong readings for humidity but no warnings or errors. Sometimes sellers of breakout boards for these sensors confuse the two and sell one as the other.
15+
16+
To easily check if you have a BMP280 or a BME280 look at the shape of the sensor: The BMP280 has rectangular shape, whereas the BME280 has a square one.
917

1018
## bme280.setup()
1119

12-
Creates bme280sensor object and initializes module. Initialization is mandatory before read values. Note that there has to be a delay between some tens to hundreds of milliseconds between calling `setup()` and reading measurements.
20+
Creates bme280sensor object and initializes the module. Initialization is mandatory before reading values. Note that there has to be a delay between some tens to hundreds of milliseconds between calling `setup()` and reading measurements.
1321

1422
Functions supported by bme280sensor object:
1523
- [setup()](#sobjsetup)

0 commit comments

Comments
 (0)