Skip to content

Commit 066fd1e

Browse files
committed
github: improve issue instructions
1 parent 99171da commit 066fd1e

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,27 @@ assignees: ''
88
---
99

1010
**Describe the bug**
11+
1112
A clear and concise description of what the bug is.
1213

1314
**To Reproduce**
15+
1416
Steps to reproduce the behavior:
1517
1. Run example '...'
1618
2. Connect to/from remove device '...'
1719
3. Start action '...'
1820

1921
**Expected behavior**
22+
2023
A clear and concise description of what you expected to happen.
2124

2225
**HCI Packet Logs**
2326
For all Bluetooth issues, please provide a full packet log that includes initial pairing. You need to zip the packet log as GitHub does not know how to handle .pklg files.
2427

2528
How to get packet log depends on the port:
2629
- For desktop ports, full packet logging is enabled by default and the packet log is available as `/tmp/hci_dump.pklg` (Mac/Linux), or `hci_dump.pklg' (Windows).
27-
- For embedded ports, you can enable #define LOG_INFO in btstack_config.h and uncomment the call to 'hci_dump_init(..)' in the main() function to enable logging over UART Console or Segger RTT. Please capture text output and process using `btstack/tool/create_packet_log.py`. The tool will generate the text file into a .pklg file which can be analysed with Wireshark or Apple's PacketLogger tool.
28-
- For ESP32: BTstack's `port/esp32/integrate.py` script copies the current version of BTstack into the esp-idf folder. To enable packet logging, you need to edit esp-idf/components/btstack/main.c
30+
- For embedded ports, you can enable #define ENABLE_LOG_INFO in btstack_config.h and uncomment the call to 'hci_dump_init(..)' in the main() function to enable logging over UART Console or Segger RTT. Please capture text output and process using `btstack/tool/create_packet_log.py`. The tool will generate the text file into a .pklg file which can be analysed with Wireshark or Apple's PacketLogger tool.
31+
- For ESP32: BTstack's `port/esp32/integrate.py` script creates one project per example. To enable packet logging, you need to edit app_main in main/main.c of the example project.
2932

3033
**Environment: (please complete the following information):**
3134
- Current BTstack branch: [e.g. develop]

0 commit comments

Comments
 (0)