Skip to content

Commit 5b0e6d5

Browse files
committed
inprogress work of the settings docs
1 parent dec16fa commit 5b0e6d5

8 files changed

+165
-2
lines changed
116 KB
Loading
140 KB
Loading

docs/assets/img/settings_logger.png

120 KB
Loading

docs/assets/img/settings_lorawan.png

104 KB
Loading
45.7 KB
Loading

docs/assets/img/settings_system.png

48.3 KB
Loading

docs/assets/img/settings_timer.png

38.4 KB
Loading

docs/settings_settings.md

Lines changed: 165 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,169 @@
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

5-
The settings system is divided into two sections - ***Settings*** and ***Device Settings***.
5+
The settings system is divided into two sections - ***Settings*** and ***Device Settings*** as shown in the following image:
66

7-
## Settings
7+
![Settings Top Menu](assets/img/settings_top_menu.png)
8+
9+
## Settings - System Settings and Operations
10+
11+
When this entry is selected, the following entries are presented:
12+
13+
![All Settings](assets/img/settings_all_settings.png)
14+
15+
### Application Settings
16+
17+
The ***Application Settings*** menu has the following entries:
18+
19+
![Settings > Application Settings](assets/img/settings_application.png)
20+
21+
#### Color Output
22+
23+
When enabled (the default), output to the console will use colors to highlight values and functionality. When disabled, all output is plain text. When using a limited serial console application, set this value to false.
24+
25+
#### Board Name
26+
27+
Set this value any name desired for the particular board. By default this value is ***empty***.
28+
29+
#### Serial Console Format
30+
31+
This property sets the output format for sensor/log data for the serial console. Available values include CSV, JSON and Disabled. The default value is ***CSV***.
32+
33+
#### JSON Buffer Size
34+
35+
This is the size - in bytes - the application should use when building JSON formatted output. The default value is ***1600*** bytes. This value should only be adjusted if logging a large number of values to the serial console.
36+
37+
The maximum bytes used by the JSON system is displayed on the ***About*** page of the application (try using `!about` console command to see this value).
38+
39+
#### Terminal Baud Rate
40+
41+
Use this value to change the baud rate settings for the serial console. Once changed this value might require a system restart to take effect. The default value is ***115200***.
42+
43+
#### Device Names
44+
45+
When enabled (default is ***disabled***), attached devices have their address appended to the name. This is helpful to identify a particular board when two or more of the same board type are attached to the IoT Node board.
46+
47+
#### Startup Delay
48+
49+
When the IoT Node board starts up, an startup menu is displayed. This settings determines how long to display this menu. Setting this value disables the menu.
50+
51+
The startup menu has the following options:
52+
53+
![Startup Menu](assets/img/settings_startupmenu.png)
54+
55+
Pressing the indicted menu key selects that option. If the startup delay expires, a *normal* startup sequence occurs.
56+
57+
##### Startup Menu Entries
58+
59+
* 'n' = Normal startup sequence
60+
* 'v' = Verbose output messaging is enabled at startup
61+
* 'a' = Disable qwiic device autoload
62+
* 'l' = List the available qwiic/i2c drivers at startup (this list is deleted after startup)
63+
* 's' = Disable settings restore on startup
64+
65+
#### Verbose Messages
66+
67+
When enabled, verbose output is enabled. This value is ***disabled*** by default.
68+
69+
#### About...
70+
71+
When selected, the system displays the ***About*** page for the application. This reflects the current status of system. This page is also displayed using the `!about` console command.
72+
73+
### LoRaWAN Network
74+
75+
The LoRaWAN Network page has the following settings:
76+
77+
![LoRaWAN Network](assets/img/settings_lorawan.png)
78+
79+
#### Enabled
80+
81+
Used to enable/disable the LoRaWAN network functionality. This value is *enabled* by default.
82+
83+
#### Application EUI
84+
85+
The Application EUI for the LoRaWAN connection
86+
87+
#### Application Key
88+
89+
The Application Key for the LoRaWAN connection. This value is *secret*, and while editable, it is not visible when editing.
90+
91+
#### Network Key
92+
93+
The Network Key for the LoRaWAN connection. This value is *secret*, and while editable, it is not visible when editing.
94+
95+
#### LoRaWAN Class
96+
97+
The operating class for the LoRaWAN module. By default this value is set to ***C***.
98+
99+
#### LoRaWAN Region
100+
101+
The operating region for the LoRaWAN module. By default this value is ***US915***.
102+
103+
#### Reset
104+
105+
Calls the *reset* function on the module.
106+
107+
### LoRaWAN Logger
108+
109+
This pages has no entires currently.
110+
111+
### Logger
112+
113+
The logger system is used to output values to the Serial Console.
114+
115+
The logger has the following settings:
116+
117+
![Settings Logger](assets/img/settings_logger.png)
118+
119+
120+
#### Timestamp Mode
121+
122+
Enables output of a timestamp to the logged information and sets the format of the timestamp. By default this is ***disabled***.
123+
124+
#### Sample Numbering
125+
126+
If enabled, a sample number is included in the console output of logged data. This value is ***disabled*** by default.
127+
128+
#### Numbering Increment
129+
130+
The amount to increment each sample number when sample numbering is enabled. The default value is ***1***.
131+
132+
#### Output ID
133+
134+
When enabled, the board ID is included in the logged output. This value is ***disabled*** by default.
135+
136+
#### Output Name
137+
138+
When enabled, the board Name is included in the logged output. This value is ***disabled*** by default.
139+
140+
#### Rate Metic
141+
142+
When enabled, metrics are recorded for the logging system. This value is ***disabled*** by default.
143+
144+
#### Reset Sample Counter
145+
146+
Resets the data sample number to a user provided value.
147+
148+
### Logging Timer
149+
150+
The timer has the following properties:
151+
152+
![Logging Timer](assets/img/settings_timer.png)
153+
154+
#### Interval
155+
156+
The interval for the logging timer. For every *interval* period, a logging event occurs - sending data to the LoRaWAN and serial console (if enabled). The default value is ***90000 ms***.
157+
158+
### System Control
159+
160+
The System Control page includes the following entries:
161+
162+
![System Control](assets/img/settings_system.png)
163+
164+
#### Device Restart
165+
166+
When selected, the user is prompted to restart the device/system. This is also available using the `!restart` console command.
167+
168+
#### Device Reset
169+
170+
When selected, the user is prompted to reset the device/system. A device reset erases the current saved settings values and restarts the board/system. This is also available using the `!reset-device` console command.

0 commit comments

Comments
 (0)