Skip to content

Commit cde62d5

Browse files
Merge pull request TheThingsNetwork#7 from maveonair/doc-config-temp
Documentation: Enable the temperature sensor
2 parents 3242266 + 8a0caed commit cde62d5

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/TheThingsNode.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Usage:
4949
```c
5050
void setup() {
5151
node = TheThingsNode::setup();
52-
52+
5353
node->onWake(wake);
5454
}
5555
@@ -72,7 +72,7 @@ Usage:
7272
```c
7373
void setup() {
7474
node = TheThingsNode::setup();
75-
75+
7676
node->onSleep(sleep);
7777
}
7878
@@ -87,10 +87,10 @@ Instead of using your `loop()` function, use `configInterval()` and `onInterval(
8787
```c
8888
void setup() {
8989
node = TheThingsNode::setup();
90-
90+
9191
// Call every 30s instead of the default 60
9292
node->configInterval(true, 30000);
93-
93+
9494
node->onInterval(interval);
9595
}
9696

@@ -193,15 +193,15 @@ void configTemperature(bool enabled, MCP9804_Resolution resolution);
193193
void configTemperature(bool enabled);
194194
```
195195
196-
- `bool enabled `: Enable or disable temperature alerts. Enabled automatically by `onTemperature()`, but you can use this method to temporarily disable the alerts. Defaults to `false`.
196+
- `bool enabled `: Enable or disable the temperature sensor. Enabled automatically by `onTemperature()`, but you can use this method to temporarily disable the sensor and therefore the alerts. Defaults to `false`.
197197
- `MCP9804_Resolution resolution = R_DEGREES_0_0625 `: Set the resolution (precision) of the sensor. One of:
198198
- `R_DEGREES_0_5000`: +0.5 C
199199
- `R_DEGREES_0_2500`: +0.25 C
200200
- `R_DEGREES_0_1250`: +0.125 C
201201
- `R_DEGREES_0_0625`: +0.0625 (default)
202202
203203
See the sensor's [data sheet, section 5.2.4](http://ww1.microchip.com/downloads/en/DeviceDoc/22203C.pdf) for more details.
204-
204+
205205
- `int8_t lower`: Alert when temperature in Celsius is lower. Defaults to `0`.
206206
- `int8_t upper`: Alert when temperature in Celsius is higher. Defaults to `30`.
207207
- `int8_t critical = 55`: Alert when temperature in Celsius is higher. Defaults to `55`, above which you run the risk of battery failure.

0 commit comments

Comments
 (0)