You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/lua-modules/bme280.md
+13-1
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ Creates bme280sensor object and initializes module. Initialization is mandatory
11
11
12
12
Functions supported by bme280sensor object:
13
13
-[setup()](#sobjsetup)
14
-
-[read()](#sobjresad)
14
+
-[read()](#sobjread)
15
15
-[startreadout()](#sobjstartreadout)
16
16
-[qfe2qnh](#sobjqfe2qnh)
17
17
-[altitude](#sobjaltitude)
@@ -73,6 +73,18 @@ Using forced mode is recommended for applications which require low sampling rat
73
73
74
74
## BME280 Sensor Object Methods
75
75
76
+
### sobj:setup()
77
+
78
+
Re-initializes the sensor.
79
+
80
+
### Parameters
81
+
82
+
Parameters are the same as for the [bme280.setup](#bme280setup) function.
83
+
84
+
### Return
85
+
86
+
Returned values are the same as for the [bme280.setup](#bme280setup) function.
87
+
76
88
### sobj:altitude()
77
89
78
90
For given air pressure (called QFE in aviation - see [wiki QNH article](https://en.wikipedia.org/wiki/QNH)) and sea level air pressure returns the altitude in meters, i.e. altimeter function.
@@ -7,12 +7,12 @@ This module provides calculation routines for [BME280/BMP280 temperature/air pre
7
7
8
8
See [bme280](../lua-modules/bme280.md) Lua module for examples.
9
9
10
-
## bme280.altitude()
10
+
## bme280_math.altitude()
11
11
12
12
For given air pressure (called QFE in aviation - see [wiki QNH article](https://en.wikipedia.org/wiki/QNH)) and sea level air pressure returns the altitude in meters, i.e. altimeter function.
13
13
14
14
#### Syntax
15
-
`bme280.altitude([self], P, QNH)`
15
+
`bme280_math.altitude([self], P, QNH)`
16
16
17
17
#### Parameters
18
18
- (optional) `self` userdata or table structure so that the function can be directly called as object method, parameter is ignored in the calculation
@@ -22,12 +22,12 @@ For given air pressure (called QFE in aviation - see [wiki QNH article](https://
22
22
#### Returns
23
23
altitude in meters of measurement point
24
24
25
-
## bme280.dewpoint()
25
+
## bme280_math.dewpoint()
26
26
27
27
For given temperature and relative humidity returns the dew point in celsius.
28
28
29
29
#### Syntax
30
-
`bme280.dewpoint([self], H, T)`
30
+
`bme280_math.dewpoint([self], H, T)`
31
31
32
32
#### Parameters
33
33
- (optional) `self` userdata or table structure so that the function can be directly called as object method, parameter is ignored in the calculation
@@ -37,12 +37,12 @@ For given temperature and relative humidity returns the dew point in celsius.
37
37
#### Returns
38
38
dew point in celsisus
39
39
40
-
## bme280.qfe2qnh()
40
+
## bme280_math.qfe2qnh()
41
41
42
42
For given altitude converts the air pressure to sea level air pressure ([QNH](https://en.wikipedia.org/wiki/QNH)).
43
43
44
44
#### Syntax
45
-
`bme280.qfe2qnh([self], P, altitude)`
45
+
`bme280_math.qfe2qnh([self], P, altitude)`
46
46
47
47
#### Parameters
48
48
- (optional) `self` userdata or table structure so that the function can be directly called as object method, parameter is ignored in the calculation
@@ -53,15 +53,15 @@ For given altitude converts the air pressure to sea level air pressure ([QNH](ht
53
53
sea level pressure
54
54
55
55
56
-
## bme280.read()
56
+
## bme280_math.read()
57
57
58
58
Reads the sensor and returns the temperature, the air pressure, the air relative humidity and see level air pressure when `altitude` is specified.
- registers - String of configuration registers read from the BME280 sensor. It consists of 6 bytes (chars) of `BME280_REGISTER_DIG_T`, 18 bytes (chars) `BME280_REGISTER_DIG_P` and optional (not present for BMP280 sensor) 8 bytes (chars) of `BME280_REGISTER_DIG_H1` (1 byte) and `BME280_REGISTER_DIG_H2` (7 bytes)
0 commit comments