Merge pull request #35 from iNavFlight/development

v1.1.5

README.md

@@ -1,18 +1,18 @@
-# SmartPort/INAV Telemetry Flight Status - v1.1.4
+# SmartPort/INAV Telemetry Flight Status - v1.1.5
 
 #### Taranis Q X7
-![sample](http://www.leethost.com/link_pics/iNav1.png "Launch-based model orientation and location indicators")
+![sample](http://www.leethost.com/link_pics/iNav1.png "launch/pilot-based model orientation and location indicators")
 ![sample](http://www.leethost.com/link_pics/iNav2.png "Compass-based direction indicator")
 
 #### Taranis X9D, X9D+ & X9E
-![sample](http://www.leethost.com/link_pics/iNav3.png "View on Taranis X9D, X9D+ & X9E")
+![sample](http://www.leethost.com/link_pics/iNav3.png?1 "View on Taranis X9D, X9D+ & X9E")
 
 ## Features
 
 * Launch/pilot-based model orientation and location indicators (great for lost orientation or if you lose site of your model)
 * Compass-based direction indicator
 * Bar gauges for Fuel (% battery mAh capacity remaining), Battery voltage, RSSI strength, Tx battery (and Altitude for X9D, X9D+ & X9E transmitters)
-* Display and voice alerts for flight modes and other flight status information (altitude hold, heading hold, etc.)
+* Display and voice alerts for flight modes and other flight status information (altitude hold, heading hold, home reset, etc.)
 * Voice notifications for % battery remaining (based on current), voltage low/critical, high altitude, lost GPS, ready to arm, armed, disarmed, etc.
 * GPS information: Satellites locked, GPS altitude, GPS coordinates
 * Display of current/maximum: Altitude, Distance, Speed and Current
@@ -22,23 +22,11 @@
 
 ## Requirements
 
-* [OpenTX v2.2.0+](http://www.open-tx.org/) running on Taranis Q X7, X9D, X9D+ & X9E
+* [OpenTX v2.2.0+](http://www.open-tx.org/) running on Taranis Q X7, X9D, X9D+ or X9E
 * SmartPort telemetry compatible receiver: X4R(SB), X8R, XSR, R-XSR, XSR-M, XSR-E, etc. (*NOT* D-series receivers)
 * [INAV v1.7.3+](https://github.com/iNavFlight/inav/releases) running on your flight controller
 * GPS, altimeter, and compass sensors
 
-## Notice
-
-> If you get the message **Script Panic not enough memory** you've run out of memory on your transmitter.
-> This happens if you have too many Lua scripts running (this includes model, function, and telemetry scripts).
-> It's also possible that you have less memory to work with when running firmware that uses more memory (for example, using firmware that includes multimodule support if you're not using it).
-> Using transmitter firmware with `luac` included will reduce memory usage and increase the telemetry screen speed.
-
-* Designed for multirotor models, but should be valuable for fixed wing (fixed wing feedback appreciated)
-* Optional amperage sensor needed for fuel and current displays
-* Uses Taranis settings for RSSI warning/critical levels for bar gauge range and audio/haptic warnings
-* Uses Taranis settings for transmitter voltage min/max for battery gauge in screen title
-
 ## Setup
 
 #### In INAV Configurator
@@ -50,37 +38,56 @@
 
 1. With battery connected and **after GPS fix** [discover telemetry sensors](https://www.youtube.com/watch?v=n09q26Gh858) so all telemetry sensors are discovered
 2. Telemetry distance sensor name must be changed from `0420` to `Dist`
+3. `Dist`, `Alt`, `GAlt` & `Gspd` sensors can be changed from meters/kmh to feet/mph
+4. **Don't** change `Tmp1` or `Tmp2` from celsius to fahrenheit, they're not really temperatures but used for flight modes and GPS information
 
 #### INAV Lua Telemetry Screen Setup
 
-1. Copy `iNav.lua` file to Taranis SD card's `\SCRIPTS\TELEMETRY\` folder
-2. Copy `iNav` folder to Taranis SD card's `\SCRIPTS\TELEMETRY\` folder
+1. Copy `iNav.lua` file to transmitter SD card's `\SCRIPTS\TELEMETRY\` folder
+2. Copy `iNav` folder to transmitter SD card's `\SCRIPTS\TELEMETRY\` folder
 3. In model setup, page to `DISPLAY`, set desired screen to `Script`, and select `iNav`
 
+## Notice
+
+If you get the message **Script Panic not enough memory** you've run out of memory on your transmitter.
+This happens if you have too many Lua scripts running (this includes model, function, and telemetry scripts).
+It's also possible that you have less memory to work with when running firmware that uses more memory (for example, using firmware that includes multimodule support if you're not using it).
+Using transmitter firmware with `luac` included will reduce memory usage and increase the telemetry screen speed.
+
 ## Usage
 
 #### Screen Description
 ![sample](http://www.leethost.com/link_pics/iNav4.png "Screen description")
 
-From the Taranis main screen, hold the `Page` button to show custom screens, then page to the screen you set to show iNav.
-Flashing values are either because there's no telemetry or a warning.
-To flip between max/min values and current values, use the dial or +/- buttons.
-To flip between compass-based direction and launch/pilot-based orientation and location, use the dial or +/- buttons.
-If model is further than 25 feet away, the launch/pilot direction view will show the direction of the model based upon launch/pilot position and orientation.
-This can be used to locate a lost model, using the launch/pilot-based model location indicator and distance.
-The launch/pilot-based orientation view is useful if model orientation is unknown.
-The script gives voice feedback for flight modes, battery levels, and warnings (no need to manually set this up for each model).
-Voice alerts will play in background even if iNav LuaTelemetry screen is not displayed.
+* From the transmitter's main screen, hold the `Page` button to show custom screens, then page to the screen you set to show iNav
+* Flashing values indicate a warning (for example: no telemetry, battery low, altitiude too high)
+* To flip between max/min values and current values, use the dial or +/- buttons
+* To flip between compass-based direction and launch/pilot-based orientation and location, use the dial or +/- buttons
+* The launch/pilot-based orientation view is useful if model orientation is unknown
+* If model is further than 25 feet away, the launch/pilot-based view will show the direction of the model based upon launch/pilot position and orientation (useful to locate a lost model)
+* The script gives voice feedback for flight modes, battery levels, and warnings (no need to manually set this up for each model)
+* Voice alerts will play in background even if iNav LuaTelemetry screen is not displayed
 
-## Tips
+## Tips & Notes
 
-* Between flights, long-press the Enter/dial and select `Reset telemetry`
+* Between flights (before armed), long-press the Enter/dial and select `Reset telemetry` to reset telemetry values
+* Designed for multirotor models, but should be valuable for fixed wing (fixed wing feedback appreciated)
+* Optional (but highly suggested) amperage sensor needed for fuel and current displays
+* Uses transmitter settings for RSSI warning/critical levels for bar gauge range and audio/haptic warnings
+* Uses transmitter settings for transmitter voltage min/max for battery gauge in screen title
+* INAV v1.8+ is required for `Home reset` voice notification
 
 ## Release History
 
+#### v1.1.5
+* Voice notification for `Home Reset` with INAV v1.8+
+* Moved head free warning on Q X7 to top center
+* Values convert from decimal to integer when larger to allow for more room
+* Better text centering and right justification technique
+* Cleaned up code saving more memory
 #### v1.1.4 - 10/13/2017
 * More accurate max altitude alerts and altitude flashes when above max altitude
-* Long-press <Enter> resets values
+* Long-press <Enter> resets values (suggest doing this between flights before armed)
 #### v1.1.3 - 10/10/2017
 * Shows metric or imperial values based on transmitter telemetry settings
 #### v1.1.2 - 10/06/2017