Skip to content

Commit

Permalink
docs readme: update document
Browse files Browse the repository at this point in the history
Signed-off-by: John Sanpe <[email protected]>
  • Loading branch information
sanpeqf committed Apr 30, 2024
1 parent 3b09bd5 commit 15b80c3
Showing 1 changed file with 50 additions and 0 deletions.
50 changes: 50 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,53 @@ This program can easily download firmware to w800 series devices, as well as mod
| [![build status](https://github.com/JohnSanpe/w80xprog/actions/workflows/macos.yml/badge.svg?branch=master)](https://github.com/JohnSanpe/w80xprog/actions/workflows/macos.yml?query=branch%3Amaster) | Build default config on Macos |
| [![build status](https://github.com/JohnSanpe/w80xprog/actions/workflows/windows.yml/badge.svg?branch=master)](https://github.com/JohnSanpe/w80xprog/actions/workflows/windows.yml?query=branch%3Amaster) | Build default config on Windows |
| [![build status](https://github.com/JohnSanpe/w80xprog/actions/workflows/codeql.yml/badge.svg?branch=master)](https://github.com/JohnSanpe/w80xprog/actions/workflows/codeql.yml?query=branch%3Amaster) | Code analyse on codeql |

## Usage

```
$ ./build/w80xprog
w80xprog v1.2
Copyright(c) 2021-2024 John Sanpe <[email protected]>
License GPLv2+: GNU GPL version 2 or later.
Usage: w80xprog [options]...
-h, --help display this message
-p, --port <device> set device path
-s, --speed <freq> set link baudrate
-n, --nspeed <freq> set new baudrate
-o, --secboot entry secboot mode
-i, --info read the chip info
-f, --flash <file> flash chip with data from filename
-e, --erase <offset:size> erase the specific flash
-b, --bt <mac> set bluetooth mac address
-w, --wifi <mac> set wifi mac address
-g, --gain <gain> set power amplifier gain
-r, --reset reset chip after operate
```

### Flash chip

```
$ ./build/w80xprog -p /dev/ttyUSB0 -n 921600 -orf ./flash.bin
w80xprog v1.2
Copyright(c) 2021-2024 John Sanpe <[email protected]>
License GPLv2+: GNU GPL version 2 or later.
Entry secboot:
Version: Secboot V0.6
Setting speed:
[0x06]: OK
Chip Flash:
100% [================================================] 30.902 KB, 9.639 KB/s
Chip reset...
```

## Build form source

```
$ git clone https://github.com/JohnSanpe/w80xprog.git
$ cd w80xprog
$ git submodule update --init --recursive
$ cmake -Bbuild
$ cmake --build build
```

0 comments on commit 15b80c3

Please sign in to comment.