Skip to content

Commit f36325e

Browse files
committed
added verbose output page
1 parent 8510e54 commit f36325e

File tree

4 files changed

+56
-0
lines changed

4 files changed

+56
-0
lines changed
149 KB
Loading

docs/assets/img/verbose-startup.png

245 KB
Loading
233 KB
Loading

docs/verbose_output.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Verbose Output
2+
3+
For advanced work with the firmware, enabling **Verbose Mode** is incredibly helpful. This is especially true for data encoding and transmission.
4+
5+
When verbose messaging is enabled, verbose messages are prefixed with a **[V]** and Debug messages are prefixed with a **[D]**.
6+
7+
## Enabling verbose Mode
8+
9+
There are three main methods to enable verbose mode:
10+
11+
| Location | Details |
12+
|--|--|
13+
|Settings Menu | Settings>Application Settings > Verbose Messages. Enabled/Disable Verbose Messaging. This setting will persist across restarts.|
14+
!!verbose Console Command| This toggles verbose messages and is not persistent|
15+
|Start Menu - Select option 'v' | Enables verbose messages before system startup. This value is not persistent|
16+
17+
## Output LoRaWAN Encoding
18+
19+
When verbose messaging is enabled, when a loRaWAN message is packed, the packed values and the overall payload is output.
20+
21+
The following is an example of output for two data values:
22+
23+
![Data Packing](assets/img/verbose-lora-message.png)
24+
25+
In this example, verbose output is enabled using the console command **!verbose**, and a logging event triggered using **!log-now**.
26+
27+
Two sensor values are packed for transmission - **Humidity** and **TemperatureF**. The verbose message output includes the Value Type/ID for each data value, as well as the encoded value in hexadecimal.
28+
29+
And once a LoRaWAN data payload is sent, the entire 11 byte payload is output, along with it's send status and associated frame ID.
30+
31+
## Device Value Type IDs
32+
33+
For each supported device, a subset of parameters are enabled for LoRaWAN transmission. With verbose output enabled, these parameters are indicated by having a Value Type ID when viewed in on a device settings page.
34+
35+
The following is an example of the Value Type codes for the BME280 device:
36+
37+
![Parameter Value Types](assets/img/verbose-value-type.png)
38+
39+
On this page, the parameters that have **Value Types** codes are enabled for LoRaWAN transmission.
40+
41+
> [!NOTE]
42+
> Parameters that are disabled are not sent to the LoRaWAN.
43+
44+
## Startup Messages
45+
46+
If Verbose Output is enabled and save in the system settings, or if the ***[v]erbose*** startup mode was selected, some addition messages are output during the startup sequence.
47+
48+
And example of startup messages:
49+
50+
![Startup Output](assets/img/verbose-startup.png)
51+
52+
In this example, "Verbose Output" was enabled in the system settings, and is noted on startup.
53+
54+
Several **Debug** messages related to some settings not saved/restore - but these can easily be ignored.
55+
56+
Additional information is output when connected to the LoRaWAN network, including the device EUID, and what operating class the LoRaWAN module is set to.

0 commit comments

Comments
 (0)