chore: lint fixes

- Make `mdlint` happy
- Trim extra newline from py
This commit is contained in:
karl
2024-03-06 09:37:38 -08:00
parent d2c2963b3b
commit 95b5116320
2 changed files with 32 additions and 20 deletions

View File

@@ -1,6 +1,7 @@
# Tag Flasher
You can use the following flasher-scripts to program various types of tags with the Tag-Flasher or AP-Flasher. The Tag-Flasher is the easiest to build; it uses only a Wemos S2-Mini or clone to program quite a few different tags. The tags below are the tags that can be programmed with this flasher.
* ZBS243-based tags
* nRF52-based tags
* 88MZ100-based tags
@@ -17,29 +18,31 @@ This is what it looks like with the wires connected. I've chosen to use 0.635mm
* R - required
* O - optional
Flasher Pin | Cable Pin | ESP32-S2 Pin | ZBS | nRF | 88mz100
:-------------------------:|:------:|:-----------------------:|:----:|:------:|:---:
VCC | 1 | 16, 17, 18, 21 | R | R | R
CS | 2 | 34 | R | |
GND | 3 | GND | R | R | R
CLK | 4 | 33 | R | R |
TXD | 5 | 36 | O | O | R
MISO | 6 | 35 | R | R |
TEST | 7 | 38 |
MOSI | 8 | 37 | R |
RXD | 9 | 40 | O | O | R
RSET | 10 | 39 | R | | O
| Flasher Pin | Cable Pin | ESP32-S2 Pin | ZBS | nRF | 88mz100 |
| :---------: | :-------: | :------------: | :---: | :---: | :-----: |
| VCC | 1 | 16, 17, 18, 21 | R | R | R |
| CS | 2 | 34 | R | | |
| GND | 3 | GND | R | R | R |
| CLK | 4 | 33 | R | R | |
| TXD | 5 | 36 | O | O | R |
| MISO | 6 | 35 | R | R | |
| TEST | 7 | 38 | | | |
| MOSI | 8 | 37 | R | | |
| RXD | 9 | 40 | O | O | R |
| RSET | 10 | 39 | R | | O |
Not all connections are required by all tags! If you want to solder fewer wires, skip the optional and unused ones.
## Flashing the flasher
Clone the [Tag_Flasher repo](https://github.com/jjwbruijn/OpenEPaperLink/tree/master/Tag_Flasher/ESP32_Flasher) and open into PlatformIO. Choose the correct COM-port and hit 'Upload'.
Also, the precompiled binaries are part of any [release](https://github.com/jjwbruijn/OpenEPaperLink/releases), and to make it even easier, you can use the web flasher on https://install.openepaperlink.de to even flash it without installing any extra software.
Also, the precompiled binaries are part of any [release](https://github.com/jjwbruijn/OpenEPaperLink/releases), and to make it even easier, you can use the web flasher on [https://install.openepaperlink.de](https://install.openepaperlink.de) to even flash it without installing any extra software.
## OEPL-Flasher.py
This script connects to the S2-mini's serial port and enables flashing to ZBS243 and nRF52811-based tags.
```
```shell
usage: OEPL-Flasher.py [-h] [-p PORT] [-f] [-i] [-n] [-z] [--internalap] [-e] [--altradio] [--pt] {read,write,autoflash,debug} [filename]
OpenEPaperLink Flasher for AP/Flasher board
@@ -63,34 +66,44 @@ options:
```
## 88MZ100-OEPL/Serial-Flasher.py
This script connects through a serial-TTL interface or OEPL - Tag_Flasher or AP-Flasher.
```
```shell
Example: COM1 read file.bin, or COM1 write file.bin, or COM1 write_flash file.bin
To create an OTA file use: img file.bin
```
## Solum ZBS243-based
Use with the -z option for ZBS243. Autoflash is currently not implemented on the Tag_Flasher/S2 version.
```
```shell
python3 OEPL-Flasher.py -e -z -p COM31 read blaat.bin --flash --pt
```
## Nordic nRF-based
Use with the -n option for nRF52811
```
```shell
python3 OEPL-Flasher.py -e -n -p COM31 read blaat.bin --flash --pt
```
**Note:** If something's gone wrong with the UICR partition on your nRF tag, you can use the [`nrf_uicr_mac_patcher.py`](nrf_uicr_mac_patcher.py) tool to patch a known good UICR partition dump with the MAC address of your broken tag.
## Marvell 88MZ100-based
Main article [here](https://github.com/jjwbruijn/OpenEPaperLink/wiki/88MZ100-Programming-and-interfacing).
The Tag-Flasher is used in serial passthrough-mode in order to flash the 88MZ100 with a modified flasher-script. A serial DTR/Reset line is used to reset the tag during the connection stage; this is however not strictly necessary! If you connect or reset the tag when prompted by the script, the flasher will work fine.
```
```shell
python3 .\88MZ100-OEPL-Flasher.py COM31 write_flash '0130c8144117.bin'
```
## Credits
Much code was reused from ATC1441's various flashers
* [ATC1441's ESP32-NRF52-SWD](https://github.com/atc1441/ESP32_nRF52_SWD)
* [ATC1441's ZBS-Flasher](https://github.com/atc1441/ZBS_Flasher)

View File

@@ -50,4 +50,3 @@ def main():
if __name__ == "__main__":
main()