Skip to content

Commit edb40d2

Browse files
committed
finish the device settings section of the docs
1 parent 49cecbc commit edb40d2

5 files changed

+39
-1
lines changed
126 KB
Loading
165 KB
Loading
43.5 KB
Loading

docs/settings_devices.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# IoT Node - LoRaWAN - Device Settings
2+
3+
The device settings menu of the system presents the property pages for each device connected to the IoT Node - LoRaWAN board.
4+
5+
The contents of the Device Settings page is dynamic and changes based on the devices connected to the board. The following is an example of a device settings listing page:
6+
7+
![Device List](assets/img/settings_device_list.png)
8+
9+
In this page, the devices ***MAX17948*** and ***BME280*** are listed. Selected an individual device entry will bring up the property page for that device.
10+
11+
Below is the property page for the ***BME280** device:
12+
13+
![Device Page](assets/img/settings-device-page.png)
14+
15+
While the contents of a specific device settings page is dependent on the particular device, each page as a common set of operations.
16+
17+
## Parameters
18+
19+
All devices have a set of parameters, as shown in the above device page for the BME280 device.
20+
21+
Parameters can be enabled/disabled, controlling which values are output - logged to the Serial Console and sent to the LoRaWAN.
22+
23+
Each device allows the enabling/disabling of individual parameters, but functions are also provided to enable or disable all parameters with one operation.
24+
25+
When a parameter is disabled, it is highlighted on the devices settings page.
26+
27+
### LoRaWAN Sent Values
28+
29+
Not all parameters are sent via the LoRaWAN - only those that *make sense* for the limitations of the LoRaWAN system. To determine which values are sent, consult the Advanced section of this documentation, or enable verbose messaging and display a devices settings page. The format of this is shown in the settings page of the ENS160 device later on this page.
30+
31+
## Properties
32+
33+
If a device as available properties, these are listed on the devices settings page. The following page shows properties and parameter settings for the ***ENS160*** device.
34+
35+
![Device ENS160](assets/img/settings_device_ens160.png)
36+
37+
The properties/settings behave just like any other setting within the system. Once set, if a device with the same name/type is loaded, the saved settings are applied at startup.
38+

docs/settings_settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# IoT Node - LoRaWAN Settings
1+
# IoT Node - LoRaWAN - Settings
22

33
The following sections provide an overview of the available settings and functions within the settings menu of the IoT Node - LoRaWAN firmware.
44

0 commit comments

Comments
 (0)