zip3
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
zip3 [2022/10/24 23:42] – lothean | zip3 [2023/03/19 06:51] – lothean | ||
---|---|---|---|
Line 9: | Line 9: | ||
This documentation covers the first released schema version of this format (v3.1). Any documentation to a more recent version will be linked here when available. | This documentation covers the first released schema version of this format (v3.1). Any documentation to a more recent version will be linked here when available. | ||
- | ===== \\ | + | ===== Content of a firmware package ===== |
- | Content of a firmware package ===== | + | |
All files must be placed at the root of the archive and no other files and folders than those required must be inside the archive. | All files must be placed at the root of the archive and no other files and folders than those required must be inside the archive. | ||
Line 16: | Line 15: | ||
==== info.json ==== | ==== info.json ==== | ||
- | === Example file ===< | + | === Example file === |
+ | < | ||
{ | { | ||
" | " | ||
Line 36: | Line 37: | ||
} | } | ||
- | </ | + | </ |
- | Details === | + | |
+ | === Details === | ||
The // | The // | ||
Line 44: | Line 46: | ||
The // | The // | ||
- | //The displayName// | + | //The displayName// |
- | The //model// key contains the model this firmware was originally made for, as a string. For a list of in-use values, see the List of models section. | + | The //model// key contains the model this firmware was originally made for, as a string. For a list of in-use values, see the [[: |
- | The // | + | The // |
- | The //type// key is a string that contains the target internal device the firmware is made for. In-use values are currently **BLE**, **DRV**, and **BMS ** (case sensitive). | + | The //type// key is a string that contains the target internal device the firmware is made for. In-use values are currently **BLE**, **DRV**, and **BMS ** (case-sensitive). |
- | The // | + | The // |
The // | The // | ||
Line 121: | Line 123: | ||
max_BMS_ST8\\ | max_BMS_ST8\\ | ||
esx_e_BMS_ST8\\ | esx_e_BMS_ST8\\ | ||
- | mi_BMS_ST8 (All supported Xiaomi scooters) | + | mi_BMS_ST8 |
+ | ===== Using & contributing ===== | ||
+ | |||
+ | Code examples to create & use ZIPv3 firmware packages can be found on our GitHub, [[https:// | ||
+ | You can discuss the standard, propose new ideas, or ask any related questions in the ScooterHacking development group on Telegram, [[https:// | ||
zip3.txt · Last modified: 2024/04/18 21:33 by lothean