Skip to content

Commit cf18cdd

Browse files
committed
README.md: More update for newest version
1 parent ec1bab2 commit cf18cdd

File tree

1 file changed

+20
-18
lines changed

1 file changed

+20
-18
lines changed

README.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,20 @@ ESP32-S2 and ESP32-S3 firmware images and devices.
1414
[Examples](#examples) | [Filesystem Operations](#filesystem-operations) | [OTA Updates](#ota-firmware-updates) | [Usage](#usage)**
1515

1616
```console
17-
$ mp-image-tool-esp32 ESP32_GENERIC-20231005-v1.21.0.bin
18-
Opening image file: ESP32_GENERIC-20231005-v1.21.0.bin...
19-
Chip type: esp32
20-
Flash size: 4MB
21-
Micropython App size: 0x186bb0 bytes (1,562 KB)
22-
Partition table (flash size: 4MB):
23-
# Name Type SubType Offset Size (End) Flags
24-
nvs data nvs 0x9000 0x6000 0xf000 0x0 (24.0 kB)
25-
phy_init data phy 0xf000 0x1000 0x10000 0x0 (4.0 kB)
26-
factory app factory 0x10000 0x1f0000 0x200000 0x0 (1.9 MB)
27-
vfs data fat 0x200000 0x200000 0x400000 0x0 (2.0 MB)
28-
Micropython app fills 78.8% of factory partition (421 kB free)
17+
mp-image-tool-esp32 ESP32_GENERIC-20240602-v1.23.0.bin
18+
Running mp-image-tool-esp32 v0.0.13 (Python 3.12.6).
19+
Opening ESP32_GENERIC-20240602-v1.23.0.bin...
20+
Found esp32 firmware file (4MB flash).
21+
Partition table (flash size: 4MB):
22+
╭──────────┬──────┬─────────┬──────────┬──────────┬──────────┬───────┬───────────╮
23+
│ Name │ Type │ SubType │ Offset │ Size │ End │ Flags │ │
24+
├──────────┼──────┼─────────┼──────────┼──────────┼──────────┼───────┼───────────┤
25+
│ nvs │ data │ nvs │ 0x9000 │ 0x6000 │ 0xf000 │ 0x0 │ (24.0 kB) │
26+
│ phy_init │ data │ phy │ 0xf000 │ 0x1000 │ 0x10000 │ 0x0 │ (4.0 kB) │
27+
│ factory │ app │ factory │ 0x10000 │ 0x1f0000 │ 0x200000 │ 0x0 │ (1.9 MB) │
28+
│ vfs │ data │ fat │ 0x200000 │ 0x200000 │ 0x400000 │ 0x0 │ (2.0 MB) │
29+
╰──────────┴──────┴─────────┴──────────┴──────────┴──────────┴───────┴───────────╯
30+
Micropython app fills 82.3% of factory partition (350 kB free)
2931
```
3032

3133
## Features
@@ -155,12 +157,12 @@ To run the tests: `uv run pytest` or `uv run tox`.
155157

156158
## Examples
157159

158-
#### Change the flash size of a firmware file and expand the vfs partition
160+
### Change the flash size of a firmware file and expand the vfs partition
159161

160162
```console
161163
mp-image-tool-esp32 ESP32_GENERIC-20240602-v1.23.0.bin -f 8M --resize vfs=0
162164
Running mp-image-tool-esp32 v0.0.13 (Python 3.12.6).
163-
Opening tests/data/ESP32_GENERIC-20240602-v1.23.0.bin...
165+
Opening ESP32_GENERIC-20240602-v1.23.0.bin...
164166
Found esp32 firmware file (4MB flash).
165167
Partition table (flash size: 4MB):
166168
╭──────────┬──────┬─────────┬──────────┬──────────┬──────────┬───────┬───────────╮
@@ -187,7 +189,7 @@ Writing partition table...
187189
Updating flash size (8MB) in bootloader header...
188190
```
189191

190-
#### Change the flash size of firmware on a device and write an OTA partition table
192+
### Change the flash size of firmware on a device and write an OTA partition table
191193

192194
```console
193195
mp-image-tool-esp32 u0 -f 8M --table ota
@@ -220,7 +222,7 @@ Erasing data partition: nvs...
220222
Erasing data partition: otadata...
221223
```
222224

223-
#### Perform an OTA firmware update
225+
### Perform an OTA firmware update
224226

225227
```console
226228
mp-image-tool-esp32 u0 --ota-update ESP32_GENERIC-20240602-v1.23.0.app-bin
@@ -276,8 +278,8 @@ filesystem partition other than `vfs`, eg. `--fs ls vfs2:/recordings`.
276278

277279
The `--fs` commands operate directly on the filesystem on the flash storage, and
278280
not through the micropython repl. Some operations may be much faster using
279-
this method, though the current implementation does not yet support block
280-
caching which should provide further performance improvements.
281+
this method, ~~though the current implementation does not yet support block
282+
caching which should provide further performance improvements~~.
281283

282284
Eg. `mp-image-tool-esp32 a0 --fs mkfs vfs --fs put ./rootfs/* /` will create
283285
a new littlefs filesystem on the 'vfs' partition and initialise it with the

0 commit comments

Comments
 (0)