|
1 | 1 | # Refloat |
2 | | -Self-balancing skateboard package based on the Float package by Mitch Lustig, Dado Mista and Nico Aleman: Float, Refactored. |
3 | 2 |
|
4 | | -The feature set of Refloat is the same as that of Float version 1.3, with the following features ported from Float 2.0: |
5 | | -- Floatwheel LCM support |
6 | | -- Negative ATR speed boost |
| 3 | +A full-featured self-balancing skateboard package. |
7 | 4 |
|
8 | | -Refloat 1.0 adds the following main features: |
9 | | -- **Separate Axis KP** |
10 | | -- **Brand new full-featured GUI in VESC Tool** |
11 | | -- **Advanced LED lighting control for LEDs connected directly to VESC** |
| 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 |
12 | 14 |
|
13 | | -Refloat configuration and tunes are 100% compatible with Float 1.3 (and hence also 2.0, apart from missing a few newly added options). Refloat also maintains compatibility with 3rd party apps (Floaty / Float Control), though it works best with its brand new VESC Tool interface. |
| 15 | +[1.1 release post](https://pev.dev/t/refloat-version-1-1/2480) |
14 | 16 |
|
15 | | -#### Separate Axis KP |
16 | | -The Mahony KP can now be configured separately for each IMU axis. This feature improves the way the board handles in turns and in a significant way improves the balance profile. |
| 17 | +## Installation |
| 18 | +### 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 | 20 |
|
18 | | -Technical explanation: High Mahony KP works very well for balancing, but it is only desirable on the pitch axis. The mellow response of high KP has unwanted effects on the roll axis, because when the board rotates in yaw (when turning), roll becomes pitch. The board leads into a turn angled in roll (more pronounced on rounder tires), and this angle translates into pitch and lingers there for an amount of time determined by the KP, causing the nose to be down for a time, until it balances back up. |
19 | | - |
20 | | -Lower roll KP makes the nose hold up better in turns. It makes the board more stable and "stiffer", especially in short carves. This means **the Turn Tilt feature may be less needed** and it may respond more aggressively. |
21 | | - |
22 | | -Mahony configuration in Firmware App Config -> IMU is now a setting independent from Refloat. It is used for general purpose pitch, roll and yaw only (this pitch is called "true pitch" in Float). It is recommended to use Mahony KP 0.4 and Mahony KI 0 there, and these values will be set automatically by Refloat if Mahony KP > 1 is encountered in the App Config -> IMU configuration. |
23 | | - |
24 | | -The Mahony KP setting has been renamed to Pitch KP (its effect is the same as of Mahony KP) and there is a new setting called Roll KP. These are now independent from Firmware App Config -> IMU. |
25 | | - |
26 | | -Read the descriptions of the new configuration options for more information. |
| 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 |
27 | 27 |
|
28 | 28 | ### Fresh Installation |
29 | | -It's best to configure your **motor** and **IMU** before installing the package. If you install the package first, a welcome dialog will navigate you to how to disable the package temporarily to configure the **motor**. You don't need to disable the package to configure the **IMU**, just make sure you don't activate the board before you do so, as it may and most likely will behave erratically. |
30 | | - |
31 | | -After the **motor** and **IMU** setup, install (or re-enable) the package and configure the **Low and High Tiltback voltages** on the **Specs** tab of **Refloat Cfg**. These need to be set according to your battery specs. |
32 | | - |
33 | | -The options in the other tabs are set to good starting values that should provide you with a well behaving, rideable board. If it acts weird, it's most likely a **motor** configuration or **IMU** calibration issue. |
34 | | - |
35 | | -### Migrating from Float |
36 | | -Backup your configuration by exporting the XML, install Refloat and load the backup. All options known to Refloat will be loaded, which entails all Float 1.3 options (with the small exception of the **Specs -> Disable** toggle, which will default to "Enabled"). |
| 29 | +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. |
37 | 30 |
|
38 | | -#### Tune Quicksaves |
39 | | -Tune quicksaves will be converted from Float to Refloat on first start. Your Float tunes won't be touched and if you go back to Float, you will find them unchanged. |
| 31 | +For a detailed guide, read the [Initial Board Setup guide on pev.dev](https://pev.dev/t/initial-board-setup-in-vesc-tool/2190). |
40 | 32 |
|
41 | | -IMU quicksaves were removed from Refloat. |
| 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. |
42 | 34 |
|
43 | | -#### Tune Archive |
44 | | -Refloat uses the same Tune archive as Float, the same tunes are available. |
| 35 | +The options in the other tabs are set to good starting values that should provide you with a well behaving, rideable board. |
45 | 36 |
|
46 | | -### Disclaimer |
47 | | -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. |
| 37 | +## Disclaimer |
| 38 | +**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. |
48 | 39 |
|
49 | | -### Credits |
| 40 | +## Credits |
50 | 41 | Author: Lukáš Hrázký |
51 | 42 |
|
52 | 43 | Original Float package authors: Mitch Lustig, Dado Mista, Nico Aleman |
53 | 44 |
|
54 | | -### Download and Changelog |
| 45 | +## Downloads and Changelogs |
55 | 46 | [https://github.com/lukash/refloat/releases](https://github.com/lukash/refloat/releases) |
0 commit comments