Updated 6.0.0 Release Notes (markdown)

[inav.wiki.git] / 2.4.0-Release-Notes.md

![](http://static.rcgroups.net/forums/attachments/6/1/0/3/7/6/a9088858-102-inav.png)

**Hello and welcome to INAV 2.4.0 Release!**

Please carefully read all of this document for the best possible experience and safety.

Get in touch with other pilots, share experiences, suggestions and ask for help on:

<table>
  <tbody>
    <tr>
      <td><img src="https://upload.wikimedia.org/wikipedia/commons/thumb/8/82/Telegram_logo.svg/1024px-Telegram_logo.svg.png" width="48"></td>
      <td><a href="https://t.me/INAVFlight">INAV Official on Telegram</a></td>
    </tr>
    <tr>
      <td><img src="https://upload.wikimedia.org/wikipedia/commons/c/cd/Facebook_logo_%28square%29.png" width="48"></td>
      <td><a href="https://www.facebook.com/groups/INAVOfficial">INAV Official on Facebook</a></td>
    </tr>
  </tbody>
</table>

Please continue to support developers, for free, by checking out from the following stores after having clicked on the following links:

<table>
  <tbody>
    <tr>
      <td><img src="https://lh3.googleusercontent.com/TiHXyUiZ2COk7OmceBgo1qeRN2APAjWL5qUydGc-U3LqkJb3n13EhYEJ8Dpz_IACNHU" width="55"></td>
      <td><a href="https://inavflight.com/shop/u/bg">Support us on Banggood</a></td>
    </tr>
  </tbody>
</table>

Your contribution from the past month has been very welcome! Thanks!

Tested and suggested hardware can be found [here](https://github.com/iNavFlight/inav/wiki/Welcome-to-INAV,-useful-links-and-products) 

## Important Notes

## Upgrading from 2.3.0 or 2.2.0

0. Download and install the new [configurator](https://github.com/iNavFlight/inav-configurator/releases)
1. Save to a file the current _diff all_ from the CLI.
2. Upgrade to INAV 2.4 using the Full Erase option in the configurator.
3. Upload your OSD font of choice from the OSD tab.
4. Find on your _diff all_ result the `min_throttle` line, and replace it by `throttle_idle`, setting the percentage of the idle throttle. The default is 15.
5. Go the CLI again and paste the contents on the file you previously create and write _save_ , press ENTER and done!
6. You should be ready, explore new 2.4 features and enjoy!

## Upgrading from 2.1.0 or older version

Please follow the instructions on [this](https://github.com/iNavFlight/inav/wiki/Upgrading-from-an-older-version-of-INAV-to-the-current-version) page.
 
## New targets:

* [Matek F722-PX](https://inavflight.com/shop/s/bg/1625181)
* [Holybro Kakute F7 HDV](https://inavflight.com/shop/s/bg/1541453)
* Mamba F405US Stack
* [Mamba F722S Stack](https://inavflight.com/shop/s/bg/1490805)
* F4BY (@Jingxian-Xiao)

## CLI:

### New commands

| Command | Description |
| ------- | ----------- |
| `msc`   | Enter USB Mass storage mode. See `docs/USB_Mass_Storage_(MSC)_mode.md` for usage information. |

| Setting | Description |
| ----    | ------ |
| `throttle_idle` | Previously `min_throttle` - Set the idle throttle percent. The percentage of the throttle range (`max_throttle` - `min_command`) above `min_command` used for minimum / idle throttle. Note that the default of 15% will most likely be too high for modern *shot ESCs. |
| `nav_rth_home_offset_distance` | Distance offset from GPS established home to "safe" position used for RTH (cm, 0 disables) |
| `nav_rth_home_offset_direction` |  Direction offset from GPS established home to "safe" position used for RTH (degrees, 0=N, 90=E, 180=S, 270=W, requires non-zero offset distance) |
| `gyro_stage2_lowpass_type`    | Defines the type of stage 2 gyro LPF filter. Possible values: `PT1`, `BIQUAD`. `PT1` offers faster filter response while `BIQUAD` better attenuation. Default value: `BIQUAD` |
| `rpm_gyro_filter_enabled`    | Enables gyro RPM filter. Turned `OFF` by default. Set to `ON` only when ESC telemetry is working and rotation speed of the motors is correctly reported to INAV |
| `rpm_dterm_filter_enabled`    | RPM filter for D-term. Experimental, probably will be removed in the next release |
| `rpm_gyro_harmonics`    | Number of harmonic frequencies to be covered by gyro RPM filter. Default value of `1` usually works just fine  |
| `rpm_gyro_min_hz`    | The lowest frequency for gyro RPM filter. Default `150` is fine for 5" mini-quads. On 7-inch drones you can lower even down to `60`-`70` |
| `rpm_gyro_q`    | Q factor for gyro RPM filter. Lower values give softer, wider attenuation. Usually there is no need to change this setting |
| `dterm_gyro_harmonics`    | Number of harmonic frequencies to be covered by D-term RPM filter. Default value of `1` usually works just fine |
| `rpm_dterm_min_hz`    | - |
| `rpm_dterm_q`    | - |
| `dterm_lpf_type`    | Defines the type of stage 1 D-term LPF filter. Possible values: `PT1`, `BIQUAD`. `PT1` offers faster filter response while `BIQUAD` better attenuation. Default value: `BIQUAD` |
| `dterm_lpf2_hz`    | Cutoff frequency for stage 2 D-term filter. Disabled by default `0` |
| `dterm_lpf2_type`    | Defines the type of stage 1 D-term LPF filter. Possible values: `PT1`, `BIQUAD`. `PT1` offers faster filter response while `BIQUAD` better attenuation. Default value: `BIQUAD` |
| `pidsum_limit_yaw`    | Replaces `yaw_jump_prevention_limit` and `yaw_p_limit` |
| `pid_type`    | Allows to set type of PID controller used in control loop. Possible values: `NONE`, `PID`, `PIFF`, `AUTO`. Change only in case of experimental platforms like VTOL, tailsitters, rovers, boats, etc. Airplanes should always use `PIFF` and multirotors `PID` |

### Removed settings

| Setting | Description |
| ----    | ------ |
| `min_throttle` | Replaced by `throttle_idle` |
| `yaw_jump_prevention_limit` | Replaced by `pidsum_limit_yaw` |
| `yaw_p_limit` | Replaced by `pidsum_limit_yaw` |

## New drivers and protocols

* BMP388 barometer ([@shellixyz], [@hydra])
* ICM20601 IMU ([@shellixyz])
* SBUS Fast ([@digitalentity])

## RPM Filters ([@DzikuVx])

INAV can now take determine where to place notch filters based on the rotation speed of the motors to attenuate noise being fed into PID. 
You need to connect BlHeli telemetry on a serial port and then enable RPM Filters.

## USB Mass Storage ([@fiam])

USB MSC (mass storage device class) SD card and internal flash access is enabled for F4 and F7 targets with suitable hardware. This means you can mount the FC (SD card / internal flash) as a host computer file system via USB to read BB logs (and delete them from an SD card). See `docs/USB_Mass_Storage_(MSC)_mode.md` for usage information.

## RTH Home Offset ([@stronnag])

Allows INAV RTH and failsafe RTH to not return the launch point but in a nearby area allowing not to violate a protected space which might be active in some flying fields. It's configurable via `nav_rth_home_offset_distance`  which sets the distance offset from GPS established home to "safe" position used for RTH and `nav_rth_home_offset_direction` which configure the direction offset from GPS established home to "safe" position used for RTH (degrees, 0=N, 90=E, 180=S, 270=W, requires non-zero offset distance) 

## Linear Climb and Dive on Waypoint Missions ([@hali9])

When flying a mission with different altitude waypoints, the old behaviour was INAV trying to reach the next waypoint altitude as soon as it can, constrained only by `nav_auto_climb_rate`, `nav_fw_climb_angle` and `nav_fw_dive_angle` CLI variables. Aircraft would use a lot of energy to reach the waypoint altitude, and then will keep that altitude for the rest of the way to the waypoint.

Now, INAV will try to climb or dive to the next waypoint altitude in a linearly manner, so it'll reach the next waypoint altitude only when it's almost reaching the waypoint itself. This way aircraft will consume less energy to climb since it'll be a less steep climb or will save energy by trading altitude for speed for more time when diving.

It works for all airframe types, fixed wing or multirotor.

## OSD improvements ([@fiam], [@shellixyz], [@DzikuVx])
Motors RPM can now displayed as a new item. There are minor bug fixes in the FrSky OSD driver.
Furthermore when you navigate the CMS (OSD menu) servos on your airplane will not move anymore.

## Support for DJI HD FPV ([@digitalentity])

INAV is now ready to embrace HD FPV with support for the [DJI HD FPV](https://inavflight.com/shop/s/bg/1540481) system. Just connect the DJI HD VTX to a spare UART, set that UART to have a DJI FPV function in the Configurator Ports tab and you're good to go.

If you want to use DJI remote controller as well, you can connect the S.Bus wire from DJI VTX to your FC as well and select "SBUS Fast" protocol (earlier known as  DJI HDL). INAV fully supports this protocol and will allow you to get 7ms contol latency (as advertised by DJI).



[@shellixyz]: https://github.com/shellixyz
[@digitalentity]: https://github.com/digitalentity 
[@DzikuVx]: https://github.com/DzikuVx
[@fiam]: https://github.com/fiam
[@giacomo892]: https://github.com/giacomo892
[@hali9]: https://github.com/hali9
[@stronnag]: https://github.com/stronnag
[@hydra]: https://github.com/hydra