Skip to content

Commit 52e2d84

Browse files
committed
docs: Update for elaphure-dap.js
1 parent dc41962 commit 52e2d84

File tree

2 files changed

+23
-13
lines changed

2 files changed

+23
-13
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ For Keil users, we now also support [elaphureLink](https://github.com/windowsair
4646
5. More..
4747
- [x] SWD protocol based on SPI acceleration (Up to 40MHz)
4848
- [x] Support for [elaphureLink](https://github.com/windowsair/elaphureLink), fast Keil debug without drivers
49+
- [x] Support for [elaphure-dap.js](https://github.com/windowsair/elaphure-dap.js), online ARM Cortex-M firmware flash
50+
- [x] Support for OpenOCD/pyOCD
4951
- [x] ...
5052

5153

@@ -384,18 +386,12 @@ When you select max clock, we will take the following actions:
384386

385387
This project was originally designed to run on Keil, but now you can also perform firmware flash on OpenOCD.
386388

387-
Note that if you want to use a 40MHz SPI acceleration, you need to specify the speed after the target device is connected, otherwise it will fail with the beginning.
388-
389389
```bash
390-
# Run before approaching the flash command
391-
> adapter speed 10000
392-
393390
> halt
394391
> flash write_image [erase] [unlock] filename [offset] [type]
395392
```
396393

397-
> Keil's timing handling is somewhat different from OpenOCD's. For example, OpenOCD lacks the SWD line reset sequence before reading the `IDCODE` registers.
398-
394+
> pyOCD is now supported.
399395
400396
### System OTA
401397

@@ -459,6 +455,14 @@ For example, sending the ASCII text `115200` will switch the baud rate to 115200
459455
For performance reasons, this feature is not enabled by default. You can modify [wifi_configuration.h](main/wifi_configuration.h) to turn it on.
460456

461457

458+
### elaphure-dap.js
459+
460+
For the ESP8266, this feature is turned off by default. You can turn it on in menuconfig:
461+
462+
```
463+
CONFIG_USE_WEBSOCKET_DAP=y
464+
```
465+
462466
----
463467

464468
## Develop

README_CN.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,9 @@
4141

4242
5. 其它
4343
- [x] 通过SPI接口加速的SWD协议(最高可达40MHz)
44-
- [x] 支持[elaphureLink](https://github.com/windowsair/elaphureLink),无需驱动的快速Keil调试
44+
- [x] 支持 [elaphureLink](https://github.com/windowsair/elaphureLink),无需驱动的快速Keil 调试
45+
- [x] 支持 [elaphure-dap.js](https://github.com/windowsair/elaphure-dap.js),网页端的 ARM Cortex-M 设备固件烧录调试
46+
- [x] 支持 OpenOCD/pyOCD
4547
- [x] ...
4648

4749
## 连接你的开发板
@@ -363,17 +365,13 @@ idf.py -p /dev/ttyS5 flash
363365
### 对于OpenOCD用户
364366

365367
这个项目最初是为在Keil上运行而设计的,但现在你也可以在OpenOCD上通过它来烧录程序。
366-
注意,如果你想使用40MHz的SPI加速器,你需要在连接目标设备后指定速度,否则会在开始时失败。
367368

368369
```bash
369-
# 在使用flash指令前需要先运行:
370-
> adapter speed 10000
371-
372370
> halt
373371
> flash write_image [erase] [unlock] filename [offset] [type]
374372
```
375373

376-
> Keil的操作时序与OpenOCD的有些不同。例如,OpenOCD在读取 "IDCODE "寄存器之前缺少SWD线复位序列。
374+
> 现已支持 pyOCD
377375
378376
### 系统 OTA
379377

@@ -431,6 +429,14 @@ esptool.py -p (PORT) flash_id
431429
当TCP连接建立后,ESP芯片将尝试解决首次发送的文本。当文本是一个有效的波特率时,转发器就会切换到该波特率。例如,发送ASCII文本`115200`会将波特率切换为115200。
432430
由于性能原因,该功能默认不启用。你可以修改 [wifi_configuration.h](main/wifi_configuration.h) 来打开它。
433431

432+
### elaphure-dap.js
433+
434+
对于 ESP8266 ,该功能默认关闭。可以在 menuconfig 中打开它:
435+
436+
```
437+
CONFIG_USE_WEBSOCKET_DAP=y
438+
```
439+
434440
----
435441

436442
## 开发

0 commit comments

Comments
 (0)