Skip to content

Commit

Permalink
docs: Update for elaphure-dap.js
Browse files Browse the repository at this point in the history
  • Loading branch information
windowsair committed Jun 12, 2024
1 parent dc41962 commit 52e2d84
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 13 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ For Keil users, we now also support [elaphureLink](https://github.com/windowsair
5. More..
- [x] SWD protocol based on SPI acceleration (Up to 40MHz)
- [x] Support for [elaphureLink](https://github.com/windowsair/elaphureLink), fast Keil debug without drivers
- [x] Support for [elaphure-dap.js](https://github.com/windowsair/elaphure-dap.js), online ARM Cortex-M firmware flash
- [x] Support for OpenOCD/pyOCD
- [x] ...


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

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

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.

```bash
# Run before approaching the flash command
> adapter speed 10000

> halt
> flash write_image [erase] [unlock] filename [offset] [type]
```

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

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


### elaphure-dap.js

For the ESP8266, this feature is turned off by default. You can turn it on in menuconfig:

```
CONFIG_USE_WEBSOCKET_DAP=y
```

----

## Develop
Expand Down
18 changes: 12 additions & 6 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,9 @@

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

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

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

```bash
# 在使用flash指令前需要先运行:
> adapter speed 10000

> halt
> flash write_image [erase] [unlock] filename [offset] [type]
```

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

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

### elaphure-dap.js

对于 ESP8266 ,该功能默认关闭。可以在 menuconfig 中打开它:

```
CONFIG_USE_WEBSOCKET_DAP=y
```

----

## 开发
Expand Down

0 comments on commit 52e2d84

Please sign in to comment.