Skip to content

Commit 4baaaf6

Browse files
author
vsky
committed
Doc fix
1 parent 6c44e23 commit 4baaaf6

File tree

2 files changed

+25
-13
lines changed

2 files changed

+25
-13
lines changed

docs/lua-modules/bme280.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Creates bme280sensor object and initializes module. Initialization is mandatory
1111

1212
Functions supported by bme280sensor object:
1313
- [setup()](#sobjsetup)
14-
- [read()](#sobjresad)
14+
- [read()](#sobjread)
1515
- [startreadout()](#sobjstartreadout)
1616
- [qfe2qnh](#sobjqfe2qnh)
1717
- [altitude](#sobjaltitude)
@@ -73,6 +73,18 @@ Using forced mode is recommended for applications which require low sampling rat
7373

7474
## BME280 Sensor Object Methods
7575

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+
7688
### sobj:altitude()
7789

7890
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.

docs/modules/bme280_math.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# BME280 module
1+
# BME280_math module
22
| Since | Origin / Contributor | Maintainer | Source |
33
| :----- | :-------------------- | :---------- | :------ |
44
| 2016-02-21 | [vsky279](https://github.com/vsky279) | [vsky279](https://github.com/vsky279) | [bme280_math.c](../../app/modules/bme280_math.c)|
@@ -7,12 +7,12 @@ This module provides calculation routines for [BME280/BMP280 temperature/air pre
77

88
See [bme280](../lua-modules/bme280.md) Lua module for examples.
99

10-
## bme280.altitude()
10+
## bme280_math.altitude()
1111

1212
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.
1313

1414
#### Syntax
15-
`bme280.altitude([self], P, QNH)`
15+
`bme280_math.altitude([self], P, QNH)`
1616

1717
#### Parameters
1818
- (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://
2222
#### Returns
2323
altitude in meters of measurement point
2424

25-
## bme280.dewpoint()
25+
## bme280_math.dewpoint()
2626

2727
For given temperature and relative humidity returns the dew point in celsius.
2828

2929
#### Syntax
30-
`bme280.dewpoint([self], H, T)`
30+
`bme280_math.dewpoint([self], H, T)`
3131

3232
#### Parameters
3333
- (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.
3737
#### Returns
3838
dew point in celsisus
3939

40-
## bme280.qfe2qnh()
40+
## bme280_math.qfe2qnh()
4141

4242
For given altitude converts the air pressure to sea level air pressure ([QNH](https://en.wikipedia.org/wiki/QNH)).
4343

4444
#### Syntax
45-
`bme280.qfe2qnh([self], P, altitude)`
45+
`bme280_math.qfe2qnh([self], P, altitude)`
4646

4747
#### Parameters
4848
- (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
5353
sea level pressure
5454

5555

56-
## bme280.read()
56+
## bme280_math.read()
5757

5858
Reads the sensor and returns the temperature, the air pressure, the air relative humidity and see level air pressure when `altitude` is specified.
5959

6060
#### Syntax
61-
`bme280.read(bme280sensor, registers, [altitude])`
61+
`bme280_math.read(bme280sensor, registers, [altitude])`
6262

6363
#### Parameters
64-
- `bme280sensor` - BME280 sensor user data returned by `bme280.setup()`
64+
- `bme280sensor` - BME280 sensor user data returned by `bme280_math.setup()`
6565
- `registers` - string of 8 bytes (chars) registers read from `BME280_REGISTER_PRESS`
6666
- (optional) `altitude`- altitude in meters of measurement point. If provided also the air pressure converted to sea level air pressure is returned.
6767

@@ -73,13 +73,13 @@ Reads the sensor and returns the temperature, the air pressure, the air relative
7373

7474
Returns `nil` if the conversion is not successful.
7575

76-
## bme280.setup()
76+
## bme280_math.setup()
7777

7878
Initializes module. Initialization is mandatory before read values.
7979

8080
#### Syntax
8181

82-
`bme280.setup(registers, [temp_oss, press_oss, humi_oss, power_mode, inactive_duration, IIR_filter])`
82+
`bme280_math.setup(registers, [temp_oss, press_oss, humi_oss, power_mode, inactive_duration, IIR_filter])`
8383

8484
#### Parameters
8585
- 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

Comments
 (0)