Skip to content

Commit c00677f

Browse files
[openthread] Docs for static log level code quality improvement (#6219)
Co-authored-by: Jonathan Swoboda <154711427+swoboda1337@users.noreply.github.com>
1 parent d644381 commit c00677f

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

src/content/docs/components/openthread.mdx

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,9 +99,32 @@ See [https://openthread.io/guides/thread-primer/node-roles-and-types](https://op
9999
The Poll Period makes the device behave as a SED. Follow on work is needed utilizing Power Management and/or Light Sleep capability in esp-idf.
100100
If the device is always awake, the API timeout is 60 seconds, so a ping request will force interaction with the parent when the poll period is greater than 60 seconds.
101101

102+
## OpenThread ESP-IDF Logging
103+
104+
The OpenThread log level is controlled by the ``log_level`` setting in the ESP-IDF framework configuration.
105+
The ESP-IDF log levels are mapped to OpenThread log levels as follows:
106+
107+
| ESP-IDF Level | OpenThread Level |
108+
|---------------|------------------|
109+
| NONE | NONE |
110+
| ERROR | CRIT |
111+
| WARN | WARN |
112+
| INFO | NOTE |
113+
| DEBUG | INFO |
114+
| VERBOSE | DEBG |
115+
116+
```yaml
117+
# Example ESP-IDF framework log_level setting
118+
esp32:
119+
framework:
120+
type: esp-idf
121+
log_level: INFO
122+
```
123+
102124
## See Also
103125

104126
- [OpenThread Info Text Sensor](/components/text_sensor/openthread_info/)
105127
- [Network component](/components/network/)
128+
- [ESP32 Platform](/components/esp32/)
106129
- [https://openthread.io/](https://openthread.io/)
107130
- <APIRef text="openthread.h" path="openthread/openthread.h" />

0 commit comments

Comments
 (0)