User Tools

Site Tools


zip3

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
zip3 [2022/10/25 00:06] lotheanzip3 [2024/04/18 21:33] (current) lothean
Line 38: Line 38:
  
 </code> </code>
 +
 === Details === === Details ===
  
Line 45: Line 46:
 The //firmware// object contains all of the following data. The //firmware// object contains all of the following data.
  
-//The displayName// key is pretty self-explanatory. It contains - as a string - the user-friendly name that should be displayed inside when the file is loaded. It's usually used to display the type + version of the loaded file.+//The displayName// key is pretty self-explanatory. It contains - as a string - the user-friendly name that should be displayed inside an app when the file is loaded. It's usually used to display the type + version of the loaded file.
  
-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 [[:zip3#list_of_models|List of models]] section.
  
-The //enforceModel// key is a boolean that tells the app if in addition to checking for compatible hardware, the current scooter model must match the model of the loaded file. (useful if we don't want the user to change his BLE beacon and thus detected model by flashing a compatible firmware that was made for another model)+The //enforceModel// key is a boolean that tells the app ifin addition to checking for compatible hardware, the current scooter model must match the model of the loaded file. (useful if we don't want the user to change his BLE beacon and thus detected model by flashing a compatible firmware that was made for another model)
  
-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 //compatible// object is an array of strings that contains each board compatible with this firmware. For a list of in-use values, see the List of boards section.+The //compatible// object is an array of strings that contains each board compatible with this firmware. For a list of in-use values, see the [[:zip3#list_of_boards|List of boards]] section.
  
 The //encryption// key is a string that indicates whether only the **encrypted** firmware file, only the **plain** firmware file, or **both** files are contained inside the package. Any other values than the words in bold aren't accepted (case sensitive). The //encryption// key is a string that indicates whether only the **encrypted** firmware file, only the **plain** firmware file, or **both** files are contained inside the package. Any other values than the words in bold aren't accepted (case sensitive).
Line 80: Line 81:
  
 Ninebot Max: //max// \\ Ninebot Max: //max// \\
 +Ninebot G2: //g2// \\
 +Ninebot G65: //g65// \\
 Ninebot ESx: //esx// \\ Ninebot ESx: //esx// \\
 Ninebot E-series: //e// \\ Ninebot E-series: //e// \\
Line 101: Line 104:
 max_DRV_STM32F103CxT6\\ max_DRV_STM32F103CxT6\\
 max_DRV_AT32F415CxT7\\ max_DRV_AT32F415CxT7\\
 +g2_DRV_AT32F415CxT7\\
 +g65_DRV_AT32F415CxT7\\
 f_DRV_STM32F103CxT6\\ f_DRV_STM32F103CxT6\\
 f_DRV_AT32F415CxT7\\ f_DRV_AT32F415CxT7\\
Line 115: Line 120:
 nb_BLE_ROUND //(ESx & E-series BLE)// \\ nb_BLE_ROUND //(ESx & E-series BLE)// \\
 t15_BLE\\ t15_BLE\\
 +g2_BLE\\
 +g65_BLE\\
 mi_BLE_LEGACY //(4 dots dashboard, M365)// \\ mi_BLE_LEGACY //(4 dots dashboard, M365)// \\
 mi_BLE_NRF51822QFAA //(M365 Pro)// \\ mi_BLE_NRF51822QFAA //(M365 Pro)// \\
Line 121: Line 128:
  
 max_BMS_ST8\\ max_BMS_ST8\\
 +max_BMS_STM32\\
 esx_e_BMS_ST8\\ esx_e_BMS_ST8\\
-mi_BMS_ST8 (All supported Xiaomi scooters)+mi_BMS_ST8 //(All supported Xiaomi scooters)// 
 +===== Using & contributing ===== 
 + 
 +Code examples to create & use ZIPv3 firmware packages can be found on our GitHub, [[https://github.com/scooterhacking/fw-zip-package-v3|here]].\\ 
 +You can discuss the standard, propose new ideas, or ask any related questions in the ScooterHacking development group on Telegram, [[https://t.me/scooterhackingassembly|@scooterhackingassembly]]
  
  
zip3.1666656413.txt.gz · Last modified: 2022/10/25 00:06 by lothean