1
0
mirror of https://github.com/esp8266/Arduino.git synced 2025-07-27 18:02:17 +03:00

docs: convert to .rst and add readthedocs

This commit is contained in:
Ivan Grokhotkov
2017-02-19 16:55:37 +08:00
committed by Ivan Grokhotkov
parent 5c7247b0f4
commit 283eb97cd3
81 changed files with 7191 additions and 6324 deletions

View File

@ -1,34 +0,0 @@
## Using GDB stub
- Add `#include <GDBStub.h>` to the sketch
- Upload the sketch
- Redirect serial port to TCP port:
```
tcp_serial_redirect.py -p /dev/tty.SLAB_USBtoUART -b 115200 --spy -P 9980 --rts=0 --dtr=0
```
Change port and baud rate as necessary. This command requires python and pyserial.
- Observe serial output:
```
nc localhost 9980
```
- Once crash happens, close nc and start gdb:
```
xtensa-lx106-elf-gdb /path/to/Sketch.cpp.elf -ex "target remote :9980"
```
Or, using the provided gdbcmds file:
```
xtensa-lx106-elf-gdb /path/to/Sketch.cpp.elf -x gdbcmds
```
- Use gdb to inspect program state at the point of an exception.
## Tips and tricks
- To halt the target when software WDT fires, add
```
((int*)0) = 0;
```
at the top of `__wrap_system_restart_local` in core_esp8266_postmortem.c.
## License
Espressif MIT License. See License file.

View File

@ -0,0 +1,49 @@
Using GDB stub
--------------
- Add ``#include <GDBStub.h>`` to the sketch
- Upload the sketch
- Redirect serial port to TCP port:
::
tcp_serial_redirect.py -p /dev/tty.SLAB_USBtoUART -b 115200 --spy -P 9980 --rts=0 --dtr=0
Change port and baud rate as necessary. This command requires python
and pyserial.
- Observe serial output:
::
nc localhost 9980
- Once crash happens, close nc and start gdb:
::
xtensa-lx106-elf-gdb /path/to/Sketch.cpp.elf -ex "target remote :9980"
Or, using the provided gdbcmds file:
::
xtensa-lx106-elf-gdb /path/to/Sketch.cpp.elf -x gdbcmds
- Use gdb to inspect program state at the point of an exception.
Tips and tricks
---------------
- To halt the target when software WDT fires, add
::
((int*)0) = 0;
at the top of ``__wrap_system_restart_local`` in
core\_esp8266\_postmortem.c.
License
-------
Espressif MIT License. See License file.