{"id":14963370,"url":"https://github.com/windowsair/wireless-esp8266-dap","last_synced_at":"2025-10-07T09:58:48.721Z","repository":{"id":40517776,"uuid":"238219109","full_name":"windowsair/wireless-esp8266-dap","owner":"windowsair","description":"CMSIS-DAP compatible wireless debugger for ESP8266/ESP32/ESP32C3/ESP32S3. Optional 40MHz SPI acceleration, etc.                                                                                          适配多种ESP芯片的无线调试器","archived":false,"fork":false,"pushed_at":"2025-07-14T06:10:41.000Z","size":543,"stargazers_count":559,"open_issues_count":12,"forks_count":285,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-07-14T09:16:15.092Z","etag":null,"topics":["cmsis-dap","esp-idf","esp32","esp32c3","esp32s3","esp8266","wifi"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/windowsair.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-02-04T13:58:44.000Z","updated_at":"2025-07-14T06:10:46.000Z","dependencies_parsed_at":"2024-09-13T19:13:00.941Z","dependency_job_id":"6df9a05b-77ee-4354-8e01-a1448ad8a20c","html_url":"https://github.com/windowsair/wireless-esp8266-dap","commit_stats":{"total_commits":131,"total_committers":4,"mean_commits":32.75,"dds":0.05343511450381677,"last_synced_commit":"f5a0ea66966cd60771e521f1c8b41817d23c0d15"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/windowsair/wireless-esp8266-dap","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/windowsair%2Fwireless-esp8266-dap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/windowsair%2Fwireless-esp8266-dap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/windowsair%2Fwireless-esp8266-dap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/windowsair%2Fwireless-esp8266-dap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/windowsair","download_url":"https://codeload.github.com/windowsair/wireless-esp8266-dap/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/windowsair%2Fwireless-esp8266-dap/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278755161,"owners_count":26040034,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-07T02:00:06.786Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cmsis-dap","esp-idf","esp32","esp32c3","esp32s3","esp8266","wifi"],"created_at":"2024-09-24T13:31:25.010Z","updated_at":"2025-10-07T09:58:48.715Z","avatar_url":"https://github.com/windowsair.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003cimg src=\"https://user-images.githubusercontent.com/17078589/120061980-49274280-c092-11eb-9916-4965f6c48388.png\"/\u003e\u003c/p\u003e\n\n![image](https://user-images.githubusercontent.com/17078589/107857220-05ecef00-6e68-11eb-9fa0-506b32052dba.png)\n\n\n[![Build Status](https://github.com/windowsair/wireless-esp8266-dap/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/windowsair/wireless-esp8266-dap/actions/workflows/main.yml) master　\n[![Build Status](https://github.com/windowsair/wireless-esp8266-dap/actions/workflows/main.yml/badge.svg?branch=develop)](https://github.com/windowsair/wireless-esp8266-dap/actions/workflows/main.yml) develop\n\n[![](https://img.shields.io/badge/license-MIT-green.svg?style=flat-square)](https://github.com/windowsair/wireless-esp8266-dap/LICENSE)　[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-blue.svg?style=flat-square)](https://github.com/windowsair/wireless-esp8266-dap/pulls)　[![%e2%9d%a4](https://img.shields.io/badge/made%20with-%e2%9d%a4-ff69b4.svg?style=flat-square)](https://github.com/windowsair/wireless-esp8266-dap)\n\n[中文](README_CN.md)\n\n## Introduce\n\nWireless debugging with ***only one ESP Chip*** !\n\nRealized by USBIP and CMSIS-DAP protocol stack.\n\n\u003e 👉 5m range, 100kb size firmware(Hex) earse and download test:\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"https://user-images.githubusercontent.com/17078589/120925694-4bca0d80-c70c-11eb-91b7-ffa54770faea.gif\"/\u003e\u003c/p\u003e\n\n----\n\nFor Keil users, we now also support [elaphureLink](https://github.com/windowsair/elaphureLink). No need for usbip to start your wireless debugging!\n\n## Feature\n\n1. SoC Compatibility\n    - [x] ESP8266/8285\n    - [x] ESP32\n    - [x] ESP32C3\n    - [x] ESP32S3\n\n2. Debug Communication Mode\n    - [x] SWD\n    - [x] JTAG\n\n3. USB Communication Mode\n    - [x] USB-HID\n    - [x] WCID \u0026 WinUSB (Default)\n\n4. Debug Trace (Uart)\n    - [x] Uart TCP Bridge\n\n5. More..\n    - [x] SWD protocol based on SPI acceleration (Up to 40MHz)\n    - [x] Support for [elaphureLink](https://github.com/windowsair/elaphureLink), fast Keil debug without drivers\n    - [x] Support for [elaphure-dap.js](https://github.com/windowsair/elaphure-dap.js), online ARM Cortex-M firmware flash\n    - [x] Support for [OpenOCD-elaphureLink](https://github.com/windowsair/openocd-elaphurelink), Get rid of USBIP!\n    - [x] Support for OpenOCD/pyOCD\n    - [x] ...\n\n\n\n## Link your board\n\n### WIFI\n\nThe default connected WIFI SSID is `DAP` or `OTA` , password `12345678`\n\nSupport for specifying multiple possible WAP. It can be added here: [wifi_configuration.h](main/wifi_configuration.h)\n\nYou can also specify your IP in the above file (We recommend using the static address binding feature of the router).\n\n![WIFI](https://user-images.githubusercontent.com/17078589/118365659-517e7880-b5d0-11eb-9a5b-afe43348c2ba.png)\n\n\nThere is built-in ipv4 only mDNS server. You can access the device using `dap.local`.\n\n\u003e The mDNS in ESP8266 only supports ipv4.\n\n![mDNS](https://user-images.githubusercontent.com/17078589/149659052-7b29533f-9660-4811-8125-f8f50490d762.png)\n\n\n\n### Debugger\n\n\n\u003cdetails\u003e\n\u003csummary\u003eESP8266\u003c/summary\u003e\n\n| SWD            |        |\n|----------------|--------|\n| SWCLK          | GPIO14 |\n| SWDIO          | GPIO13 |\n| TVCC           | 3V3    |\n| GND            | GND    |\n\n\n--------------\n\n\n| JTAG               |         |\n|--------------------|---------|\n| TCK                | GPIO14  |\n| TMS                | GPIO13  |\n| TDI                | GPIO4   |\n| TDO                | GPIO16  |\n| nTRST \\(optional\\) | GPIO0\\* |\n| nRESET             | GPIO5   |\n| TVCC               | 3V3     |\n| GND                | GND     |\n\n--------------\n\n| Other              |               |\n|--------------------|---------------|\n| LED\\_WIFI\\_STATUS  | GPIO15        |\n| Tx                 | GPIO2         |\n| Rx                 | GPIO3 (U0RXD) |\n\n\u003e Rx and Tx is used for uart bridge, not enabled by default.\n\n\u003c/details\u003e\n\n\n\u003cdetails\u003e\n\u003csummary\u003eESP32\u003c/summary\u003e\n\n| SWD            |        |\n|----------------|--------|\n| SWCLK          | GPIO14 |\n| SWDIO          | GPIO13 |\n| TVCC           | 3V3    |\n| GND            | GND    |\n\n\n--------------\n\n\n| JTAG               |         |\n|--------------------|---------|\n| TCK                | GPIO14  |\n| TMS                | GPIO13  |\n| TDI                | GPIO18  |\n| TDO                | GPIO19  |\n| nTRST \\(optional\\) | GPIO25  |\n| nRESET             | GPIO26  |\n| TVCC               | 3V3     |\n| GND                | GND     |\n\n--------------\n\n| Other              |               |\n|--------------------|---------------|\n| LED\\_WIFI\\_STATUS  | GPIO27        |\n| Tx                 | GPIO23        |\n| Rx                 | GPIO22        |\n\n\n\u003e Rx and Tx is used for uart bridge, not enabled by default.\n\n\n\u003c/details\u003e\n\n\n\u003cdetails\u003e\n\u003csummary\u003eESP32C3\u003c/summary\u003e\n\n| SWD            |        |\n|----------------|--------|\n| SWCLK          | GPIO6  |\n| SWDIO          | GPIO7  |\n| TVCC           | 3V3    |\n| GND            | GND    |\n\n\n--------------\n\n\n| JTAG               |         |\n|--------------------|---------|\n| TCK                | GPIO6   |\n| TMS                | GPIO7   |\n| TDI                | GPIO9   |\n| TDO                | GPIO8   |\n| nTRST \\(optional\\) | GPIO4   |\n| nRESET             | GPIO5   |\n| TVCC               | 3V3     |\n| GND                | GND     |\n\n--------------\n\n| Other              |               |\n|--------------------|---------------|\n| LED\\_WIFI\\_STATUS  | GPIO10        |\n| Tx                 | GPIO19        |\n| Rx                 | GPIO18        |\n\n\n\u003e Rx and Tx is used for uart bridge, not enabled by default.\n\n\n\u003c/details\u003e\n\n\n\u003cdetails\u003e\n\u003csummary\u003eESP32S3\u003c/summary\u003e\n\n| SWD            |        |\n|----------------|--------|\n| SWCLK          | GPIO12 |\n| SWDIO          | GPIO11 |\n| TVCC           | 3V3    |\n| GND            | GND    |\n\n\n--------------\n\n\n| JTAG               |        |\n|--------------------|--------|\n| TCK                | GPIO12 |\n| TMS                | GPIO11 |\n| TDI                | GPIO10 |\n| TDO                | GPIO9  |\n| nTRST \\(optional\\) | GPIO14 |\n| nRESET             | GPIO13 |\n| TVCC               | 3V3    |\n| GND                | GND    |\n\n\n\u003c/details\u003e\n\n----\n\n## Hardware Reference\n\nOnly a hardware reference for the ESP8266 is currently available.\n\n\nHere we provide a simple example for reference:\n\n![sch](https://user-images.githubusercontent.com/17078589/150284806-e6dff0fa-4fe1-4d86-ac45-3b657fbea6b7.png)\n\n\n***Alternatively, you can connect directly with wires as we gave at the beginning, without additional circuits.***\n\n\nIn addition, a complete hardware reference design is available from contributors, see [circuit](circuit)\n\n------\n\n\n## Build And Flash\n\nYou can build locally or use Github Action to build online and then download firmware to flash.\n\n### Build with Github Action Online\n\nSee: [Build with Github Action](https://github.com/windowsair/wireless-esp8266-dap/wiki/Build-with-Github-Action)\n\n\n### General build and Flash\n\n\u003cdetails\u003e\n\u003csummary\u003eESP8266\u003c/summary\u003e\n\n1. Get ESP8266 RTOS Software Development Kit\n\n    The SDK is already included in the project. Please don't use other versions of the SDK.\n\n2. Build \u0026 Flash\n\n    Build with ESP-IDF build system.\n    More information can be found at the following link: [Build System](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html \"Build System\")\n\nThe following example shows a possible way to build on Windows:\n\n```bash\n# Build\npython ./idf.py build\n# Flash\npython ./idf.py -p /dev/ttyS5 flash\n```\n\n\u003c/details\u003e\n\n\n\u003cdetails\u003e\n\u003csummary\u003eESP32/ESP32C3\u003c/summary\u003e\n\n1. Get esp-idf\n\n    For now, please use esp-idf v4.4.2 : https://github.com/espressif/esp-idf/releases/tag/v4.4.2\n\n2. Build \u0026 Flash\n\n    Build with ESP-IDF build system.\n    More information can be found at the following link: [Build System](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html \"Build System\")\n\nThe following example shows a possible way to build:\n\n```bash\n# Set build target\nidf.py set-target esp32\n# Build\nidf.py build\n# Flash\nidf.py -p /dev/ttyS5 flash\n```\n\n\u003e The `idf.py` in the project root directory is only applicable to the old ESP8266 target. Don't use it in ESP32.\n\n\u003c/details\u003e\n\n\n\u003e We also provided sample firmware for quick evaluation. See [Releases](https://github.com/windowsair/wireless-esp8266-dap/releases)\n\n\n## Usage\n\n1. Get USBIP project\n\n- Windows: [usbip-win](https://github.com/cezanne/usbip-win) .\n- Linux: Distributed as part of the Linux kernel, but we have not yet tested on Linux platform, and the following instructions are all under Windows platform.\n\n2. Start ESP chip and connect it to the device to be debugged\n\n3. Connect it with usbip:\n\n```bash\n# HID Mode only\n# for pre-compiled version on SourceForge\n# or usbip old version\n.\\usbip.exe -D -a \u003cyour-esp-device-ip-address\u003e  1-1\n\n# 👉 Recommend\n# HID Mode Or WinUSB Mode\n# for usbip-win 0.3.0 kmdf ude\n.\\usbip.exe attach_ude -r \u003cyour-esp-device-ip-address\u003e -b 1-1\n\n```\n\nIf all goes well, you should see your device connected.\n\n![image](https://user-images.githubusercontent.com/17078589/107849548-f903d780-6e36-11eb-846f-3eaf0c0dc089.png)\n\n\nHere, we use MDK for testing:\n\n![target](https://user-images.githubusercontent.com/17078589/73830040-eb3c6f00-483e-11ea-85ee-c40b68a836b2.png)\n\n\n------\n\n## FAQ\n\n### Keil is showing a \"RDDI-DAP ERROR\" or \"SWD/JTAG Communication Failure\" message.\n\n1. Check your line connection. Don't forget the 3v3 connection cable.\n2. Check that your network connection is stable.\n\n\n### DAP is slow or often abnormal.\n\nNote that this project is sensitive to the network environment. If you are using a hotspot on your computer, you can try using network analyzer such as wireshark to observe the status of your AP network. During the idle time, the network should stay silent, while in the working state, there should be no too much packet loss.\n\nSome LAN broadcast packets can cause serious impact, including:\n- DropBox LAN Sync\n- Logitech Arx Control\n- ...\n\nFor ESP8266, this is not far from UDP FLOOD...😰\n\nIt is also affected by the surrounding radio environment, your AP situation (some NICs have terrible AP performance), distance, etc.\n\n\n----\n\n## Document\n\n### Speed Strategy\n\nThe maximum rate of esp8266 pure IO is about 2MHz.\nWhen you select max clock, we will take the following actions:\n\n- `clock \u003c 2Mhz` : Similar to the clock speed you choose.\n- `2MHz \u003c= clock \u003c 10MHz` : Use the fastest pure IO speed.\n- `clock \u003e= 10MHz` : SPI acceleration using 40MHz clock.\n\n\u003e Note that the most significant speed constraint of this project is still the TCP connection speed.\n\n\n### For OpenOCD user\n\nThis project was originally designed to run on Keil, but now you can also perform firmware flash on OpenOCD.\n\n```bash\n\u003e halt\n\u003e flash write_image [erase] [unlock] filename [offset] [type]\n```\n\n\u003e pyOCD is now supported.\n\n### System OTA\n\nWhen this project is updated, you can update the firmware over the air.\n\nVisit the following website for OTA operations: [online OTA](http://corsacota.surge.sh/?address=dap.local:3241)\n\n\nFor most devices, you don't need to care about flash size. However, improper setting of the flash size may cause the OTA to fail. In this case, please change the flash size with `idf.py menuconfig`, or modify `sdkconfig`:\n\n```\n# Choose a flash size.\nCONFIG_ESPTOOLPY_FLASHSIZE_1MB=y\nCONFIG_ESPTOOLPY_FLASHSIZE_2MB=y\nCONFIG_ESPTOOLPY_FLASHSIZE_4MB=y\nCONFIG_ESPTOOLPY_FLASHSIZE_8MB=y\nCONFIG_ESPTOOLPY_FLASHSIZE_16MB=y\n\n# Then set a flash size\nCONFIG_ESPTOOLPY_FLASHSIZE=\"2MB\"\n```\n\nIf flash size is 2MB, the sdkconfig file might look like this:\n\n```\nCONFIG_ESPTOOLPY_FLASHSIZE_2MB=y\nCONFIG_ESPTOOLPY_FLASHSIZE=\"2MB\"\n```\n\n\nFor devices with 1MB flash size such as ESP8285, the following changes must be made:\n\n```\nCONFIG_PARTITION_TABLE_FILENAME=\"partitions_two_ota.1MB.csv\"\nCONFIG_ESPTOOLPY_FLASHSIZE_1MB=y\nCONFIG_ESPTOOLPY_FLASHSIZE=\"1MB\"\nCONFIG_ESP8266_BOOT_COPY_APP=y\n```\n\nThe flash size of the board can be checked with the esptool.py tool:\n\n```bash\nesptool.py -p (PORT) flash_id\n```\n\n### Uart TCP Bridge\n\nThis feature provides a bridge between TCP and Uart:\n```\nSend data   -\u003e  TCP  -\u003e  Uart TX -\u003e external devices\n\nRecv data   \u003c-  TCP  \u003c-  Uart Rx \u003c- external devices\n```\n\n![uart_tcp_bridge](https://user-images.githubusercontent.com/17078589/150290065-05173965-8849-4452-ab7e-ec7649f46620.jpg)\n\nWhen the TCP connection is established, bridge will try to resolve the text sent for the first packet. When the text is a valid baud rate, bridge will switch to it.\nFor example, sending the ASCII text `115200` will switch the baud rate to 115200.\n\n\nFor performance reasons, this feature is not enabled by default. You can modify [wifi_configuration.h](main/wifi_configuration.h) to turn it on.\n\n\n### elaphure-dap.js\n\nFor the ESP8266, this feature is turned off by default. You can turn it on in menuconfig:\n\n```\nCONFIG_USE_WEBSOCKET_DAP=y\n```\n\n----\n\n## Develop\n\nCheck other branches to know the latest development progress.\n\nAny kind of contribute is welcome, including but not limited to new features, ideas about circuits, documentation.\n\nYou can also ask questions to make this project better.\n\n- [New issues](https://github.com/windowsair/wireless-esp8266-dap/issues)\n- [New pull](https://github.com/windowsair/wireless-esp8266-dap/pulls)\n\n\n### Issue\n\n2020.12.1\n\nTCP transmission speed needs to be further improved.\n\n2020.11.11\n\nWinusb is now available, but it is very slow.\n\n\n2020.2.4\n\nDue to the limitation of USB-HID (I'm not sure if this is a problem with USBIP or Windows), now each URB packet can only reach 255 bytes (About 1MBps bandwidth), which has not reached the upper limit of ESP8266 transmission bandwidth.\n\nI now have an idea to construct a Man-in-the-middle between the two to forward traffic, thereby increasing the bandwidth of each transmission.\n\n2020.1.31\n\nAt present, the adaptation to WCID, WinUSB, etc. has all been completed. However, when transmitting data on the endpoint, we received an error message from USBIP. This is most likely a problem with the USBIP project itself.\n\nDue to the completeness of the USBIP protocol document, we have not yet understood its role in the Bulk transmission process, which may also lead to errors in subsequent processes.\n\nWe will continue to try to make it work on USB HID. Once the USBIP problem is solved, we will immediately transfer it to work on WinUSB\n\n\n------\n\n## Credit\n\n\nCredits to the following project, people and organizations:\n\n\u003e - https://github.com/thevoidnn/esp8266-wifi-cmsis-dap for adapter firmware based on CMSIS-DAP v1.0\n\u003e - https://github.com/ARM-software/CMSIS_5 for CMSIS\n\u003e - https://github.com/cezanne/usbip-win for usbip windows\n\n\n- [@HeavenSpree](https://www.github.com/HeavenSpree)\n- [@Zy19930907](https://www.github.com/Zy19930907)\n- [@caiguang1997](https://www.github.com/caiguang1997)\n- [@ZhuYanzhen1](https://www.github.com/ZhuYanzhen1)\n\n\n## License\n\n[MIT LICENSE](LICENSE)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwindowsair%2Fwireless-esp8266-dap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwindowsair%2Fwireless-esp8266-dap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwindowsair%2Fwireless-esp8266-dap/lists"}