1.8.0-Release-notes.md

   1 Please read the release notes carefully and upgrade INAV Configurator available at [Chrome Store](https://chrome.google.com/webstore/detail/inav-configurator/fmaidjmgkdkpafmbnmigkpdnpdhopgel). You can also use [Configurator built as a native MacOS or Windows application](https://github.com/iNavFlight/inav-configurator/releases/tag/1.8.0).
   2
   3 INAV is and will remain open-source and free, but you are more than welcome to [support the development](https://inavflight.github.io/supporting-inav/).
   4
   5 This release was supported by our awesome sponsors [CarbonBird.com](http://www.CarbonBird.com), [Airbot](http://shop.myairbot.com/), [ADPM Drones](http://www.adpm.pro/) and a number of supporters on [Patreon](https://www.patreon.com/inavflight).
   6
   7 ## WARNINGS
   8
   9 * We've changed the way you select the receiver. Please make sure to select correct receiver after upgrading!
  10 * On OMNIBUS F4 targets LEDSTRIP is now moved to where it belongs - dedicated LEDSTRIP connector.
  11
  12 ## Known bugs
  13 * OSD blinking not always working
  14
  15 ## CLI parameter renaming / new parameters
  16
  17 New parameters have been introduced. Some CLI parameters were renamed to support new features or to better reflect their meaning:
  18
  19 | Name               | Description                                                    |
  20 |------------------------|----------------------------------------------------------------|
  21 | `feature RX_*` | RX type definition as been moved from a `FEATURE` to a setting `receiver_type`, with values of `NONE`, `PWM`, `PPM`, `SERIAL`, `MSP`, `SPI`. |
  22 | `nav_rth_allow_landing` | This now takes values of `NEVER`, `ALWAYS` (default), `FS_ONLY`. The latter is primarily for fixed wing, where an emergency landing is a better option than have the 'plane fall from altitude as the battery expires under failsafe. |
  23 | - | `totally_new_setting`                                      |
  24 | `tz_offset` | Time zone offset from UTC, in minutes. This is applied to the GPS time for logging and time-stamping of Blackbox logs |
  25 | `failsafe_min_distance` | If failsafe happens when craft is closer than this distance in centimetres from home, failsafe will not execute regular failsafe_procedure, but will execute procedure specified in failsafe_min_distance_procedure instead. 0 = Normal failsafe_procedure always taken. |
  26 | `failsafe_min_distance_procedure` | The failsafe procedure to initiate in Stage 2 when craft is closer to home than failsafe_min_distance. with values of `SET-THR`, `DROP`, `RTH`, `NONE`. See the Failsafe documentation. |
  27 | `smartport_fuel_percent` | Along with `battery_capacity` variable allows sending SmartPort telemetry Fuel as available battery percentage |
  28
  29 ## New boards
  30
  31 * Omnibus F4 Pro Corner
  32 * DYS F4 Pro
  33 * Matek F405 OSD. This requires slightly different firmware to the (also supported) Matek F405 AIO. Please see the board documentation.
  34 * CLRACINGF4 AIR board
  35 * Omnibus F7 V2
  36 * FuriousFPV WingF4
  37
  38 ## Discontinued boards
  39
  40 - CC3D
  41 - NAZE (all revisions)
  42
  43 ## Receiver type changes
  44
  45 For 1.7.3 and below receiver was chosen as a `feature` which was not very user friendly. In 1.8 this have changed to a single setting (`receiver_type`). Bear in mind that restoring pre-1.8 dumps will reset `receiver_type` to `NONE` leaving this to you to fix manually.
  46
  47 ## OSD related featured and fixes
  48
  49 OSD includes numerous updates, fixes as well as improvements and has received quite significant work for this update, so we're dedicating a whole section in the release notes to it.
  50
  51 Users **must to update the OSD font from the configurator** after upgrading to 1.8. Failing to do so will result in incorrectly displayed indicators, since a lot of new symbols have been added (a clear symptom will be blank spaces in the OSD where a decimal separator should appear).
  52
  53 ### General improvements and fixes
  54
  55 * Improved refresh rate.
  56 * Significantly reduced memory and CPU usage by the OSD subsystem.
  57 * Made all OSD numeric fields fixed width.
  58 * Make all OSD indicator previews look exactly the same in the configurator and in the actual OSD. This allows easily configuring all OSD indicators in a way they don't overlap.
  59 * Added support for hardware based blinking. Makes all elements blink in sync.
  60 * Screen is correctly cleared after exiting CMS and after hiding the stats shown after disarming.
  61 * Enabling GPS will draw the GPS indicators even if the GPS hardware hasn't been detected. This allows configuring GPS related fields in the OSD even if the GPS module is not powered on.
  62 * Improve artificial horizon drawing performance and fix flashing home direction arrow in its default position due to overlapping with the area cleared (but not actually used) by the indicator.
  63 * Flight modes which can be combined with ANGLE, HORIZON and ACRO are now displayed in a separate indicator. This includes ALTHOLD in multirotors (in fixed wing ALTHOLD implies ANGLE) and HEADFREE modes.
  64 * OSD now shows RTH (Return To Home) rather than RTL (Return To Launch) when RTH mode is active.
  65
  66 ### New OSD indicators
  67
  68 * Combined "On time" / "Fly time" indicator shows "On time" while the aircraft is unarmed and "Fly time" while it's armed. This indicator is now on by default and the old separated indicators are disabled (can still be enabled in the configurator in the OSD tab).
  69 * System messages indicator. Shows messages from several topics, including: additional flight mode information (AUTOTUNE and AUTOTRIM modes) reasons for not being able to arm, failsafe status when failsafe mode is active and navigation stages when the navigation system is controlling the aircraft.
  70 * Average cell voltage shows the average voltage of each cell rather than the voltage of the whole battery.
  71 * Time of the day indicator shows the current time. Use the new `tz_config` CLI variable to set your current timezone. It will show UTC time otherwise.
  72 * Throttle / Automatic Throttle indicator shows the stick throttle position when the user is directly controlling the throttle while showing the actual throttle value sent to the motors while the navigation system is controlling the throttle output.
  73 * Heading graph indicator shows the heading using a moving graph with the cardinal points rather than heading degrees.
  74 * VTX channel displays the VTX current band and channel. Requires a VTX with SmartAudio or Tramp support.
  75 * Efficiency indicator displays the current map drawn per travelled km. Requires a current sensor.
  76
  77 * Artificial horizon roll direction can now be reversed. This is an experimental feature not available in the configurator and must be enabled using the `osd_artificial_horizon_reverse_roll` CLI variable. Feedback regarding this feature is highly appreciated.
  78 * Artificial horizon crosshairs now has two different styles: the default crosshair or an aircraft symbol. This is an experimental feature not available in the configurator and must be configured using the `osd_crosshairs_style` CLI variable. Feedback regarding this feature is highly appreciated.
  79 * Artificial horizon sidebars now support scrolling. Each bar can be made to scroll depending on variations on either ground speed, altitude or distance to home. Also, optional arrows can be enabled on top/bottom of the sidebar while it's scrolling. This is an experimental feature not available in the configurator and must be enabled using the `osd_left_sidebar_scroll`, `osd_right_sidebar_scroll` and `osd_sidebar_scroll_arrows` CLI variables. Feedback regarding this feature is highly appreciated.
  80
  81 ### Alarms
  82
  83 * Added home distance alarm. Makes the home distance indicator blink over a certain distance.
  84 * Negative altitude alarm. Makes the altitude indicator blink when negative altitude becomes greater than a certain value. Useful when taking off from elevated places (like the top of a mountain).
  85
  86 ### New statistics
  87
  88 * Show current time and GPS home position in the armed screen (if available). Allows easily organising DVR recordings and matching them with BlackBox logs.
  89 * Total fly time added to stats screen.
  90 * Reason for disarming added to the stats screen. Can help diagnose hardware failures or other problems that might cause the aircraft to disarm automatically during a flight.
  91
  92 ## Other new features
  93
  94 * [SYSTEM] SmartAudio and Trump VTX support. Band, channel and transmitter power can be changed from CMS
  95 * [SYSTEM] Software emulated I2C made available for MATEK405 OSD board
  96 * [GPS] GPS time is handled by the FC, with the option of a user-defined time-zone correction (either statically from configuration, or dynamically applied via MSP from ground station software)
  97 * [RC] RC channels naming simplification. `AUX 1` renamed to `CH 5`, `AUX 2` to `CH 6` and so on. This means that restoring old `map` settings from the CLI will not work, for example TAER1234 is now TAER5678. The Configurator handles this transparently.
  98 * [TELEMETRY] Multiple SmartPort improvements including MSP over SmartPort to allow configuration from TX (requires support from LUA scrips)
  99 * [NAVIGATION] Automated navigation modes (RTH and WP) now  override MOTOR_STOP. Regardless of user throttle stick position motors will remain running in automated modes. This is intended to prevent disarm during failsafe RTH.
 100 * [RSSI] Change RSSI scale to be applicable to all RSSI sources
 101 * [BATTERY] Allowed setting `current_meter_offset` to negative values
 102 * [FAILSAFE] Add a minimum failsafe distance behavior that applies when the craft is close to home (distance configurable)
 103 * [BLACKBOX] Log raw rcData to blackbox
 104 * [BLACKBOX] Blackbox logs are automatically stamped with creation time from GPS data where available
 105 * [OMNIBUS F4] Moved LED_STRIP to a dedicated connector available on these boards.
 106
 107 ## Bugs fixed
 108
 109 * Fixed blinking in OSD indicators.
 110 * Fixed ghosting of OSD indicators when moving them around in the configurator. The video was showing at the same time the new element at the new position while not erasing it from its old position.
 111 * Fix bug with incorrect SPI bus speed causing suboptimal hardware performance
 112 * Non-working AIRPLANE/TRICOPTER/GIMBAL on SPRacingF4 EVO board
 113 * Fix drop out of the sky if RTH was initiated with throttle stick at zero (see new features)
 114 * Fix bug with CRSF telemetry now showing consumed mAh
 115 * Fix non-detected failsafe on KFC32 board with eLeReS receiver
 116 * Fix incorrect RTH initial climb condition
 117
 118 ## Development Environment
 119 * As introduced in 1.7.3, a ruby interpreter is required to build INAV
 120 * On Cygwin, it is advisable not to have spaces in the compiler path
 121 * The build environment is only tested on modern compilers (arm-none-eabi-gcc 6.3 and later). Use of older compilers such as 4.8 is not recommended, and may not even be possible.