mirror of
https://github.com/nodemcu/nodemcu-firmware.git
synced 2025-01-30 21:12:55 +08:00
BMP085: Added documentation
This commit is contained in:
parent
517faf44e3
commit
5922fdba21
67
docs/en/modules/bmp085.md
Normal file
67
docs/en/modules/bmp085.md
Normal file
@ -0,0 +1,67 @@
|
|||||||
|
# BMP085 Module
|
||||||
|
|
||||||
|
This module provides access to the BMP085 temperature and pressure sensor. The module also works with BMP180.
|
||||||
|
|
||||||
|
## bmp085.init()
|
||||||
|
Initializes the module and sets the pin configuration.
|
||||||
|
|
||||||
|
#### Syntax
|
||||||
|
`bmp085.init(sda, scl)`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
- `sda` data pin
|
||||||
|
- `scl` clock pin
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
`nil`
|
||||||
|
|
||||||
|
## bmp085.temperature()
|
||||||
|
Samples the sensor and returns the temperature in celsius as an integer multiplied with 10.
|
||||||
|
|
||||||
|
#### Syntax
|
||||||
|
`bmp085.temperature()`
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
`integer` temperature multiplied with 10.
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
```lua
|
||||||
|
bmp085.init(1, 2)
|
||||||
|
local t = bmp085.temperature()
|
||||||
|
print(string.format("Temperature: %s.%s degrees C", t / 10, t % 10))
|
||||||
|
```
|
||||||
|
|
||||||
|
## bmp085.pressure()
|
||||||
|
Samples the sensor and returns the pressure in pascal as an integer.
|
||||||
|
|
||||||
|
The optional `oversampling_setting` parameter determines for how long time the sensor samples data.
|
||||||
|
The default is `3` which is the longest sampling setting. Possible values are 0, 1, 2, 3.
|
||||||
|
See the data sheet for more information.
|
||||||
|
|
||||||
|
#### Syntax
|
||||||
|
`bmp085.pressure(oversampling_setting)`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
- `oversampling_setting` integer that can be 0, 1, 2 or 3.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
`integer` pressure in pascals.
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
```lua
|
||||||
|
bmp085.init(1, 2)
|
||||||
|
local p = bmp085.pressure()
|
||||||
|
print(string.format("Pressure: %s.%s mbar", p / 100, p % 100))
|
||||||
|
```
|
||||||
|
|
||||||
|
## bmp085.pressure_raw()
|
||||||
|
Samples the sensor and returns the raw pressure in internal units. Might be useful if you need higher precision.
|
||||||
|
|
||||||
|
#### Syntax
|
||||||
|
`bmp085.pressure_raw(oversampling_setting)`
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
- `oversampling_setting` integer that can be 0, 1, 2 or 3.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
`integer` raw pressure sampling value
|
Loading…
x
Reference in New Issue
Block a user