cfwbuilder
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revision | |||
cfwbuilder [2022/10/24 19:23] – lothean | cfwbuilder [2022/10/24 19:23] (current) – old revision restored (2022/10/24 19:22) lothean | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== ScooterHacking Custom Firmware API documentation ====== | ||
+ | |||
+ | The ScooterHacking Custom Firmware API is available at api.cfw.sh. | ||
+ | |||
+ | Requests are formed as follow: api.cfw.sh/< | ||
+ | |||
+ | ===== Scooter models table ===== | ||
+ | |||
+ | ^Scooter model^Patcher state^< | ||
+ | |Ninebot ESx|[[https:// | ||
+ | |Ninebot Max|[[http:// | ||
+ | |Ninebot E2x|WIP|// | ||
+ | |Xiaomi M365|Discontinued|N/ | ||
+ | |Xiaomi M365 Pro|[[https:// | ||
+ | |Xiaomi 1S|Discontinued|1s| | ||
+ | |Xiaomi M365 Pro 2|[[http:// | ||
+ | |||
+ | ===== GET parameters ===== | ||
+ | |||
+ | To build your parameter chain, you can use any of the available GET parameters listed below.\\ | ||
+ | Some parameters requiring more details about their working behavior will have their own table of values. | ||
+ | |||
+ | **✅: live on production branch | ❌: no assignee/ | ||
+ | |||
+ | ^GET parameter^Display name^Type^Default value^Accepted values^Description^ESx^Max^1S^Pro2^Pro1| | ||
+ | |version|Firmware version|string|DRVxxx|DRVxxx|Base version. See [[: | ||
+ | |output|Output file|string|zip2|See [[: | ||
+ | |voltage|Voltage|integer|36|36; | ||
+ | |name|Filename|string|None|< | ||
+ | |version_spoofing|Version spoofing|bool|None|< | ||
+ | |region|Scooter region|string|auto|us, | ||
+ | |motor_power_constant|MPC|int|51575|10000→65535|Deprecated way of increasing output power. Won't be added to future patchers.| | ||
+ | |speed_normal_kmh|Max speed|int|(per model)|10→65|Sets Sports max speed for no region/US region.| | ||
+ | |speed_normal_kmh_eu|Max speed (EU)|int|27|10→65|Sets Drive max speed for US region and Sports max speed for EU region.| | ||
+ | |speed_normal_kmh_de|Max speed (DE)|int|22|10→65|Sets Drive max speed for EU region and Sports max speed for DE region.| | ||
+ | |p_sports|Sports battery current|int|(per model)|5000→65535|Sets battery current limit for all Sports modes.| | ||
+ | |p_drive|Drive battery current|int|(per model)|5000→65535|Sets battery current limit for all Drive modes.| | ||
+ | |p_eco|Eco battery current|int|(per model)|5000→65535|Sets battery current limit for Eco mode.| | ||
+ | |i_sports|Sports phase current|int|(per model)|10000→65535|Sets phase current limit for Sport mode| **⏳** | ||
+ | |i_drive|Drive phase current|int|(per model)|10000→65535|Sets phase current limit for Drive mode| **⏳** | ||
+ | |direct_power_control|Direct power control state|string|off|See [[: | ||
+ | |direct_power_control_curve|Direct power control curve type|string|flat|flat; | ||
+ | |current_raising_coefficient|Current raising coefficient|int|300|0→16000|How fast current will be applied. Affecting throttle speed up rate.| | ||
+ | |no_kers|No KERS|bool|None|< | ||
+ | |kers_min_spped|Minimum speed for engaging KERS|int|6|0→65|Sets minimum threshold for KERS activation| | ||
+ | |wheel_speed_const|Wheel Speed Multiplier|int|8": | ||
+ | |wheel_size|Wheel size in inches|int|8.5|0→30|Wheel size in inches, default 8.5", don't change if you use stock tires| | ||
+ | |error_raising_level|Error raising level|int|0|0→3|[[https:// | ||
+ | |brake_limit|Lever virtual limit|int|110|0→130|Sets brake lever virtual limit| | ||
+ | |brake_i_min|Minimum phase current|int|8000|1000→55000|Sets minimum phase current| | ||
+ | |brake_i_max|Maximum phase current|int|30000|1000→55000|Sets maximum phase current| | ||
+ | |brake_current_raising_coefficient|Brake current raising coefficient|int|500|0→16000|How fast current will be applied. Affecting brake speed up rate| ✅ | ✅ | ✅ | ✅ | ✅ | | ||
+ | |brake_min_speed|Minimum speed for applying brake|int|3|0→255|Minimum speed at which electronic brake can be applied| | ||
+ | |no_brake_light_flash|Static brake light|bool|None|< | ||
+ | |brake_light_mode|Brake light behavior|string|default|default; | ||
+ | ; | ||
+ | |cruise_control_delay|Cruise control delay|int|5|0→10|How many seconds it takes for cruise control to kick in.| ✅ | ✅ | ✅ | ✅ | ✅ | | ||
+ | |cruise_control_nobeep|No cruise control beep|bool|None|< | ||
+ | |motor_start_speed|Motor start speed|int|5|0→10|Minimum speed in km/h before the motor will start.| | ||
+ | |boot_workmode|Force boot power mode|int|3|0: | ||
+ | |remove_charging_mode|Remove charging mode|bool|None|< | ||
+ | |stay_on_locked|Stay on while locked|bool|None|< | ||
+ | |no_overspeed_limit|No overspeed limit|bool|None|< | ||
+ | |bms_uart_76800|Change ESC↔BMS baud rate to 76800|bool|None|< | ||
+ | |m365_compat|Pro1 FW on classic BLE|string|off|on; | ||
+ | |compat_patches|Removes SN check|bool|None|< | ||
+ | |||
+ | Please note that all parameters might not be listed. | ||
+ | |||
+ | ===== DRV versions table ===== | ||
+ | |||
+ | Current DRV firmware versions used throughout the production branch. | ||
+ | |||
+ | **Ninebot ESx**: DRV120 ; DRV133 ; DRV139 ; DRV150 ; DRV151(default) | ||
+ | |||
+ | **Ninebot Max**: DRV126 | ||
+ | |||
+ | **Xiaomi 1S**: DRV221 | ||
+ | |||
+ | **Xiaomi Pro 2**: DRV223 | ||
+ | |||
+ | If the **Version spoofing **patch is in use, the version number retrieved by apps will be shifted up by 400. This requires no modification to the " | ||
+ | ===== Direct power control state table ===== | ||
+ | |||
+ | Case sensitive. | ||
+ | |||
+ | **None/" | ||
+ | |||
+ | **" | ||
+ | |||
+ | **" | ||
+ | |||
+ | **" | ||
+ | ===== Output file formats table ===== | ||
+ | |||
+ | Case sensitive.\\ | ||
+ | Defaults to " | ||
+ | |||
+ | **" | ||
+ | |||
+ | **" | ||
+ | |||
+ | **" | ||
+ | |||
+ | **" | ||
+ | Most apps should support both versions of DownG ZIP, but using **zip2** is recommended especially on newer scooters to prevent a file from being flashed when it shouldn' | ||
+ | |||
+ | **" | ||
+ | |||
+ | All ZIP formats will be delivered with an archive comment consisting of the full request URL, the patcher branch and revision identifiers, | ||
===== DRV versions table ===== | ===== DRV versions table ===== | ||
Line 25: | Line 135: | ||
**" | **" | ||
+ | |||
+ | \\ | ||
cfwbuilder.1666639385.txt.gz · Last modified: 2022/10/24 19:23 by lothean