Skip to content

Commit 5bde1f9

Browse files
committed
Update readme for 1.2
1 parent 235fdfc commit 5bde1f9

File tree

1 file changed

+14
-21
lines changed

1 file changed

+14
-21
lines changed

package_README.md

Lines changed: 14 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,37 +2,30 @@
22

33
A full-featured self-balancing skateboard package.
44

5-
## New in 1.1
6-
- Haptic Feedback: Audible and vibrating feedback generated by the motor
7-
- Parking Brake: A strong stand-still brake on 6.05 firmware
8-
- Automatic backup and per-board backup in Settings -> Setup
9-
- Improved setpoint smoothing for ATR and Torque Tilt
10-
- Configurable order of LED strips and color order per strip
11-
- Improved tune handling in AppUI
12-
- Realtime Data Plotting and Recording: For developers and power users to analyze board behavior
13-
- Many minor features and fixes
14-
15-
For more details, read the [1.1 release post](https://pev.dev/t/refloat-version-1-1/2480).
5+
## New in 1.2
6+
- BMS alerting support (Pushback and Haptic)
7+
- Speed-based alerting (Pushback and Haptic)
8+
- Automatic config migration when updating the package
9+
- Support for per-cell High/Low Voltage Thresholds (no more needing to adjust them in Specs after a fresh install, 6.05+ only)
10+
- Groundworks for a new alerting system, for now only providing firmware fault reporting
11+
- New Rainbow Fade, Rainbow Cycle and Rainbow Roll LED effects
12+
13+
For more details, read the [1.2 release post](https://pev.dev/t/refloat-version-1-2/2795).
1614

1715
## Installation
1816
### Upgrading
19-
Back up your package config (either by **Backup Configs** on the Start page, or by saving the XML on **Refloat Cfg**), install the package and restore your config (**Restore Configs** or load the XML).
17+
Back up your package config (either by **Backup Configs** on the Start page, or by saving the XML on **Refloat Cfg**).
18+
19+
If upgrading from Refloat 1.1 to 1.2, an automatic config restore dialog should pop up. Confirm it to restore. This is the preferred way to update the config from now on, as it will also migrate any changed options to the new version. Other methods of restoring the config will not do that.
2020

21-
If you use Refloat for LED control, you'll need to re-configure a few options, these won't restore from your backup (make note of your current settings before upgrading):
22-
- _Specs -> LED Mode_: set Internal if your _LED Type_ was **RGB** or **RGBW**
23-
- _Specs -> Status / Front / Rear LED Color Order_
24-
- Pick an option with a **W** if your _LED Type_ was **RGBW**; Pick the RGB order that you had in your _LED Color Order_
25-
- Or, just keep trying them until the colors look correct (remember a restart is needed)
26-
- You need to set this for all of the three strips that you use
21+
In case the automatic config restore fails, restore it the traditional way and please report the issue, so that it can be fixed.
2722

2823
### Fresh Installation
2924
If doing a fresh board installation, you need to do the **motor** and **IMU** calibration and configuration. If you install the package before that, you need to disable the package before running the **motor** _calibration_ and re-enable it afterwards.
3025

3126
For a detailed guide, read the [Initial Board Setup guide on pev.dev](https://pev.dev/t/initial-board-setup-in-vesc-tool/2190).
3227

33-
To configure the package, you only need to set the **Low and High Tiltback voltages** on the **Specs** tab of **Refloat Cfg**. These need to be set according to your battery specs.
34-
35-
The options in the other tabs are set to good starting values that should provide you with a well behaving, rideable board.
28+
On 6.05+ firmware, the package should ride well without the need to configure anything in Refloat Cfg. On 6.02, the **Low and High Tiltback voltages** on the **Specs** tab of **Refloat Cfg** still need to be set according to your battery specs.
3629

3730
## Disclaimer
3831
**Use at your own risk!** Electric vehicles are inherently dangerous, authors of this package shall not be liable for any damage or harm caused by errors in the software. Not endorsed by the VESC project.

0 commit comments

Comments
 (0)