Created OSD custom messages (markdown)

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

Hello and welcome to INAV 2.1.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>

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>

## Important Notes

1. INAV 2.1 is the last release of INAV that fully supports **F3** and especially **Omnibus F3** boards. Due to the lack of flash and RAM, future versions of INAV will either remove functions on F3 or not support those boards at all. STM32F3 are strongly discouraged for new builds and existing builds should be upgraded to F7 boards
2. Feature **AIRMODE** is enabled by default on all targets! There is no need to change that on _Fixed Wings_ at all. On _Multirotors_, if there a need to do so, users might disable it and enable _AIRMODE_ as a flight mode on a switch like before. In the majority of the cases, _AIRMODE_ can be enabled on _Multirotors_ all the time. The two cases when a user might make it conditional are: usage of MOTOR_STOP or disabling for landing.
3. ASYNC processing is gone. Gyro/Acc updates now happens in sync with the control loop.
4. **DSHOT** is one of the new features of INAV 2.1. A digital protocol, like what DSHOT is, can substain a certain amount of noise with no performance degradation and allows a very smooth motor output. This comes at the cost of not offering a way in between a perfectly working setup or a not working one! (Think for instance to you Digital Television!).
DSHOT requires a very clean setup and short ESC signal wires run. You might find your DSHOT setup perfectly working on the bench and failing when flying. If you are unsure about your setup just stick with analog protocols like ONESHOT or MULTISHOT. More on the topic can be found [here](https://www.youtube.com/watch?v=TVkBNhii9sw)
5. On fixed wing aircrafts, if a compass is present and enabled, it will used as the only source of heading ignoring GPS course on ground information. 

## Upgrading from 2.0.0

1. Be sure to run the latest INAV 2.1 Configuration release. Download from [here](https://github.com/iNavFlight/inav-configurator/releases).
2. Go to the CLI tab and copy and paste the `diff` output to a text file for later usage. 
3. Flash INAV 2.1.0 enabling **full chip erase** . Now you FC should run INAV 2.1.0 Connect again and check the firmware version.
4. Go to CLI tab and paste all the contents you previously saved into a text file and press enter. Wait for it to finish. Type `save` and you should be good to go!
5. Go to the OSD tab, Font Manager and upload a new font to the board if you use the OSD feature.
6. Enjoy INAV 2.1.0 and explore its new features!

## Upgrading from 1.9.X

1. Be sure to run the latest INAV 2.1 Configuration release. Download from [here](https://github.com/iNavFlight/inav-configurator/releases).
2. Go to the CLI tab and copy and paste the `diff` output to a text file for later usage. 
3. Go to the OSD tab and take a screenshot of the current layout
4. Flash INAV 2.1.0 enabling **full chip erase** . Now you FC should run INAV 2.0. Connect again and check the firmware version.
5. Go to the Mixer tab and load and apply your desired mixer.
6. Go back to your configuration text file and delete all lines starting with: mixer acczero accgain magzero osd. Adjust values to be adjusted noted in the release notes.
7. Open the CLI tab in the configurator and paste your cleaned up configuration in the text box and type `save` and press enter. The flight controller will now reboot.
8. Calibrate the accelerometer following the steps in the dedicated tab. Only first two steps need to be made in the right order.
9. Calibration of the magnetometer should be done at the field. The magnetic field indoors can be distorted and led to a bad calibration.
10. Restore manually your OSD layout using the screenshot and upload the font you like using the dedicated button.
11. Carefully check all the configuration and check on the bench without installed propellers if everything looks good. In particular, check if the model preview behaves correctly when you are moving your model and check surfaces movements for an airplane.
12. Enjoy INAV 2.1.0 and explore its new features!

## New targets:

* [Omnibus F4 Nano v6](https://inavflight.com/shop/s/bg/1320256)
* [Matek F722SE](https://inavflight.com/shop/s/bg/1379603)
* [Matek F722-WING](https://inavflight.com/shop/s/bg/1408793)
* [DYS F4Pro v2](https://inavflight.com/shop/s/bg/1136875)
* [Kakute F7](https://inavflight.com/shop/s/bg/1317570)
* [Matek F411 RSSI](https://inavflight.com/shop/p/MATEKF411WING)
* [Matek F411 with second software serial](https://inavflight.com/shop/p/MATEKF411WING)
* [Foxeer F405 AIO](https://inavflight.com/shop/s/bg/1309796)
* [Foxeer F722 DUAL](https://inavflight.com/shop/s/bg/1379605)
* [Betaflight F4 Nox](https://inavflight.com/shop/s/bg/1310419)
* [Wing FC](https://inavflight.com/shop/s/bg/1318626)
* SP Racing F7 Dual
* Kiss FC

## Temperature sensors support

It is now possible to measure temperatures with the help of the I²C LM75 and 1-Wire DS18B20 chips. The temperature values can be displayed on the OSD and also logged. Up to 8 sensors supported. The support is enabled by default on F4 and F7 FCs. To use with F3 FCs you need to build a custom firmware. See the [documentation](https://github.com/iNavFlight/inav/blob/master/docs/Temperature%20sensors.md) for more information.

## Servo mixer

The maximum rate for a servo mixer rule is now 1000% instead of 125%

## CLI:

### New

| Setting | Description |
| ----    | ------ |
| `rc_filter_frequency` | RC data biquad filter cutoff frequency. Lower cutoff frequencies result in smoother response at expense of command control delay. Practical values are 20-50. Set to zero to disable entirely and use unsmoothed RC stick values |
|`fw_iterm_limit_stick_position` |Iterm is not allowed to grow when stick position is above threshold. This solves the problem of bounceback or followthrough when full stick deflection is applied on poorely tuned fixed wings. In other words, stabilization is partialy disabled when pilot is actively controlling the aircraft and active when sticks are not touched. 0 mean stick is in center position, 1 means it is fully deflected to either side |
| `nav_mc_braking_speed_threshold` | min speed in cm/s above which braking can happen |
| `nav_mc_braking_disengage_speed` | braking is disabled when speed goes below this value |
| `nav_mc_braking_timeout` | timeout in ms for braking |
| `nav_mc_braking_boost_factor` | acceleration factor for BOOST phase |
| `nav_mc_braking_boost_timeout` |how long in ms BOOST phase can happen |
| `nav_mc_braking_boost_speed_threshold` | BOOST can be enabled when speed is above this value|
| `nav_mc_braking_boost_disengage_speed` | BOOST will be disabled when speed goes below this value |
| `nav_mc_braking_bank_angle` | max angle that MR is allowed to bank in BOOST mode |
| `osd_artificial_horizon_max_pitch` | Max pitch, in degrees, for OSD artificial horizon |
| `osd_failsafe_switch_layout` | If enabled the OSD automatically switches to the first layout during failsafe |
| `osd_imu_temp_alarm_min` | Temperature under which the IMU temperature OSD element will start blinking (decidegrees centigrade) |
| `osd_imu_temp_alarm_max` | Temperature above which the IMU temperature OSD element will start blinking (decidegrees centigrade) |
| `osd_baro_temp_alarm_min` | Temperature under which the baro temperature OSD element will start blinking (decidegrees centigrade) |
| `osd_baro_temp_alarm_max` | Temperature above which the baro temperature OSD element will start blinking (decidegrees centigrade) |
| `osd_temp_label_align` | Allows to chose between left and right alignment for the OSD temperature sensor labels |

### Removed

| Setting | Description |
| ----    | ------ |
| `acc_task_frequency` | |
| `attitude_task_frequency` | |
| `async_mode` | |
| `smix reverse` | input reverse can be done on the mixer level |

## Main changes

### DSHOT

INAV 2.1 supports DSHOT ESC protocol. It can be configured using `motor_pwm_protocol` CLI setting. The following versions of DSHOT are supported:

* DSHOT150
* DSHOT300
* DSHOT600
* DSHOT1200

There is no DSHOT telemetry or DSHOT commands support yet!

Be advised that DSHOT is not well tested on INAV and because of being digital protocol can totally fail on setups with high electrical noise without giving any sign of degradation or motor stuttering. 

DSHOT is enabled on following targets:
* AIRBOTF4
* ASGARD32F4
* ASGARD32F7
* COLIBRI_RACE
* FIREWORKSV2
* FOXEERF405
* FOXEERF722DUAL
* SPRACINGF7DUAL 
* MATEKF405 (CTR, STD, not WING)
* MATEKF722
* MATEKF722SE
* OMNIBUSF4
* OMNIBUSF7NXT
* REVO

### Multirotor braking mode

#### Requirements and setup

1. Multirotor has to be capable of running 3D Position Hold: GPS, Compass, and Baro are required
1. `MC BRAKING` flight mode has to be enabled
1. UAV has to be put into User Control Mode ***CRUISE***

![01](https://user-images.githubusercontent.com/966811/45925090-1c005a80-bf0f-11e8-85a1-fce9537ee3b8.PNG)

![02](https://user-images.githubusercontent.com/966811/45925091-1dca1e00-bf0f-11e8-8f20-416eb603107b.PNG)

#### Settings

* `nav_mc_braking_speed_threshold` - min speed in cm/s above which braking can happen
* `nav_mc_braking_disengage_speed` - braking is disabled when speed goes below this value
* `nav_mc_braking_timeout` - timeout in ms for braking
* `nav_mc_braking_boost_factor` - acceleration factor for `BOOST` phase
* `nav_mc_braking_boost_timeout` - how long in ms `BOOST` phase can happen
* `nav_mc_braking_boost_speed_threshold` - `BOOST` can be enabled when speed is above this value
* `nav_mc_braking_boost_disengage_speed` - `BOOST` will be disabled when speed goes below this value
* `nav_mc_braking_bank_angle` - max angle that MR is allowed to bank in BOOST mode

#### How it works:

1. There are two phases `BRAKE` and `BOOST`
1. `BRAKE` can be started then `MC BRAKING` mode is enabled, MR is in `CRUISE` mode, `3D PosHold` is enabled, MR is traveling above `nav_mc_braking_speed_threshold` and pilot releases sticks
1. INAV will store new PosHold position only when copter will stop, not when stricks are released
1. On top of that, `BOOST` phase can be enabled if MR is traveling above `nav_mc_braking_boost_speed_threshold`
1. in `BOOST` phase, MR is allowed to use higher acceleration and banking angle than normal. 
1. Because `BOOSTS` is limited in time, banking angle much higher than default should be fine

#### Tuning

Default values should be pretty safe to use. My 6" machine using following values:

```
set nav_mc_braking_speed_threshold = 100
set nav_mc_braking_disengage_speed = 50
set nav_mc_braking_timeout = 2000
set nav_mc_braking_boost_factor = 150
set nav_mc_braking_boost_timeout = 1000
set nav_mc_braking_boost_speed_threshold = 120
set nav_mc_braking_boost_disengage_speed = 75
set nav_mc_braking_bank_angle = 40
```

## All changes:

* [Run-time calibration more accurate and more reliable](https://github.com/iNavFlight/inav/pull/4202)
* [Temperature sensor improvements and BB logging](https://github.com/iNavFlight/inav/pull/4282)
* [Make VL53L0X rangefinder init more reliable](https://github.com/iNavFlight/inav/pull/4276)
* [Fix altitude drop bug when initiating failsafe-RTH](https://github.com/iNavFlight/inav/pull/4245)
* [Improve TIM/DMA reliability](https://github.com/iNavFlight/inav/pull/4235)
* [Fix non-working AGL altitude estimation](https://github.com/iNavFlight/inav/pull/4196)
* [Speed up GPS autobaud on UBLOX GPS modules](https://github.com/iNavFlight/inav/pull/4193)
* [FPV camera tilt compensation](https://github.com/iNavFlight/inav/pull/3037)
* [Support for FFPV 2.4GHz VTX protocol](https://github.com/iNavFlight/inav/pull/4147)
* [Pitot sensor improvements](https://github.com/iNavFlight/inav/pull/3977)
* [Make sure failsafe RTH is exited when failsafe condition ends](https://github.com/iNavFlight/inav/pull/4166)
* [RC Lowpass filtering replaces interpolation](https://github.com/iNavFlight/inav/pull/3740)
* [1.5s Throttle Rampup for Autolaunch](https://github.com/iNavFlight/inav/pull/4082)
* [option to switch to default OSD layout during failsafe](https://github.com/iNavFlight/inav/pull/4064)
* [debug raw accelerometer readouts](https://github.com/iNavFlight/inav/pull/4045)
* [log GPS velNED in Blackbox logs](https://github.com/iNavFlight/inav/pull/4044)
* [3D GPS speed in OSD](https://github.com/iNavFlight/inav/pull/3941)
* [On fixed wings limit Iterm based on stick position](https://github.com/iNavFlight/inav/pull/4023) 
* [PINIO support](https://github.com/iNavFlight/inav/pull/4011)
* [fix power level 5 to be a valid setting - allow setting max power on all VTXes](https://github.com/iNavFlight/inav/pull/4008)
* [default GPS baud rate bumped to 115200](https://github.com/iNavFlight/inav/pull/3995)
* [refactored SPI/SDCARD support](https://github.com/iNavFlight/inav/pull/3984)
* Gyro temperature in [OSD](https://github.com/iNavFlight/inav/pull/3978) and [Blackbox](https://github.com/iNavFlight/inav/pull/3979)
* [AK8975 enabled on OmnibusF4](https://github.com/iNavFlight/inav/pull/3966)
* [gyro_sync enabled by default on all supporting targets](https://github.com/iNavFlight/inav/pull/3931)
* [async gyro/acc/attitude tasks removed](https://github.com/iNavFlight/inav/pull/3930)
* [Crossfire telemetry updates](https://github.com/iNavFlight/inav/pull/3912)
* [DSHOT support](https://github.com/iNavFlight/inav/pull/3879)
* [Refactored Timer/DMA framework](https://github.com/iNavFlight/inav/pull/3833)
* [battery percentage based on sag compensated voltage](https://github.com/iNavFlight/inav/pull/3804)
* [CAMSTAB servo logic fixed](https://github.com/iNavFlight/inav/pull/3800)
* [refactored OSD flight time logic](https://github.com/iNavFlight/inav/pull/3790)
* [NMEA altitude bug fix](https://github.com/iNavFlight/inav/pull/3778)
* [Benewake TFmini lidar support](https://github.com/iNavFlight/inav/pull/3725)
* [Improved AHI](https://github.com/iNavFlight/inav/pull/3641)
* [Multirotor braking mode](https://github.com/iNavFlight/inav/pull/3159)
* [Increase servo mix max rate](https://github.com/iNavFlight/inav/pull/4306)