Skip to content

Commit

Permalink
changed manual and readme to V 2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
frank-sc committed Dec 26, 2023
1 parent 16fd4a7 commit b98f2fd
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 35 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
# F3F-Tool V1
This lua-app for Jeti transmitters is made for gps-based training of RC glider slope racing competitions (F3F) and also distance and speed tasks for F3B.

All program releases in this 'V1'-repository are made to be compatible with generation 1 Jeti transmitters (with monochrome display). Please consider the requirements for those transmitters mentioned in the [**F3F-Tool manual**](docs/F3F-Tool%20Manual.md), so only use the binary form of the program (.lc) and do not use other lua-apps at the same time.
# F3F-Tool V2
This lua-app for Jeti transmitters is made for gps-based training of RC glider slope racing competitions (F3F) and also distance and speed tasks for F3B.<br>
**All program releases in this 'V2'-repository are only compatible with generation 2 Jeti transmitters (with colour display)!**<br>
For generation 1 Jeti transmitters please use Version 1.x from repository [**F3F-Tool-V1**](https://github.com/frank-sc/F3F-Tool-V1)

## Program Installation
For installation of a stable release please download the zip-file and the corresponding manual of the newest release from the [**releases-page**](https://github.com/frank-sc/F3F-Tool-V1/releases), download of the 'source code' packages is not necessary. Copy all files and directories into your 'apps' directory on the transmitter, as described in the manual. Then please follow the further steps in the manual.<br>
For installation of a stable release please download the zip-file and the corresponding manual of the newest release from the [**releases-page**](https://github.com/frank-sc/F3F-Tool-V2/releases), download of the 'source code' packages is not necessary. Copy all files and directories into your 'apps' directory on the transmitter, as described in the manual. Then please follow the further steps in the manual.<br>
**Important: Please use newest Jeti Firmware (currently 5.06 LUA). Older Firmware Versions may cause problems!**

For installation of the current development version (HEAD) please refer to the [**wiki**](https://github.com/frank-sc/F3F-Tool-V1/wiki)
For installation of the current development version (HEAD) please refer to the [**wiki**](https://github.com/frank-sc/F3F-Tool-V2/wiki)

## Status
The tool in Version 1.4 is working quite well on the slope for F3F. For F3B-tasks there are some issues, especially with the very hight speed reached in the speed-task and with slightly inaccurate determination of the course bearing. See more detailed description in [**issues**](https://github.com/frank-sc/F3F-Tool-V1/issues).
The tool in Version 2.0 is functionally identical with V1.4 (in Repository [**F3F-Tool-V1**](https://github.com/frank-sc/F3F-Tool-V1), but memory optimization for Generation 1 transmitters was partly removed. Further development on this tool unfortunately can not be done for the old transmitters.

## News in V 1.41
- added french language configuration
## News in V 2.0
- added device check - will not work on "JETI DC-16", "JETI DS-16", "JETI DC-14", "JETI DS-14" with monochrome diaplay.

## Development notices
The main program file 'f3f_\<version\> and the working directory 'f3fTool-\<version\> are always renamed for a new upcoming version. This is to make sure that everything fits together and to allow several versions to run independently on one transmitter.

## Installation of GPS-sensor
Information about choosing a GPS-sensor and the Installation in the glider can be found in the [**wiki**](https://github.com/frank-sc/F3F-Tool-V1/wiki)
Information about choosing a GPS-sensor and the Installation in the glider can be found in the [**wiki**](https://github.com/frank-sc/F3F-Tool-V2/wiki)

## Project Support
If you like the tool you can support my work on the the project by making a donation, i appreciate :)<br><br>
Expand Down
32 changes: 7 additions & 25 deletions docs/F3F-Tool Manual.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
# F3F-Tool Version 1.4 / Installation guide and users manual
# F3F-Tool Version 2.0 / Installation guide and users manual
### This manual describes how to install, configure and use the F3F-Tool for training of F3F and F3B tasks.<br><br>
## Contents:
1. [General Description](#generalDescription)
2. [Program Installation](#programInstallation)
3. [Program Configuration](#programConfiguration)
4. [Usage](#usage)
5. [Pricing and License](#pricing)
6. [Changelog for Users of 1.3 Test Version](#changelog)<br><br>
5. [Pricing and License](#pricing)<br><br>
<a name="generalDescription"></a>
# 1. General Description
## 1.1. What it does
Expand All @@ -22,14 +21,12 @@ To use this app a GPS Sensor must be placed in the model and connected to Jeti t
to calculate the fly in signal accurately, so very short fly out / fly in at 50m is not possible.Depending on the speed of fly out the signal may be given at 60 or even 70 meters.
- somtimes there is a GPS-drift of given start point. In this case the whole course might drift to left or right some meters, because the turn positions are calculated in relation to start. To handle this effect the app includes a function to compensate the drift during the flight.
## 1.3. Requirements
- Generation 2 Jeti transmitter (with colour display).<br>
**This version can not be used with 'generation 1' Jeti-transmitters!** So it will not work with DC-16", "DS-16", "DC-14", "DS-14" with monochrome display. Please do not install!
- Newest generation GPS-Sensor must be placed in the glider, needed telemetry values are: **latitude, longitude, speed**
- If the sensor allows, not needed telemetry values should be disabled to speed up the telemetry transfer to transmitter. Also the usage of telemetry values from other sensors or from the receiver should be reduced.
- Please use the newest Firmware for your Jeti-transmitter. This tool was developed and tested with **firmware 5.06 LUA from May 26 2021**, older Versions may cause problems.

Special requirements for 'Generation 1' - transmitters with monochrome display:
- the newest LUA-enabled firmware must be installed on the transmitter (check: **'System / Info / Version'** – must end with 'LUA')
- **Safety Issue:
For the model you use with 'f3fTool' no other LUA Application must be installed to consider the given memory limitations!**
## 1.4. F3B Support
To enable this tool also for F3B Training, some features are provided:
- seperate length definitions for F3F / F3B course
Expand Down Expand Up @@ -176,21 +173,6 @@ If you like the tool and you are willing to support the project you are welcome
Link to paypal.me:<br>
**https://www.PayPal.Me/f3frank**

<a name="changelog"></a>
# 6. Changelog for Users of 1.3 Test Version
What is new in this Version 1.4?
- Instead of only two points now three points are scanned to define a slope. Also it must be specified, what is left and right.
This allows a greater distance between the left and right point to determine the slope bearing, what means more precision. Also the bearing is independent from the starting point definition.
If you want it to do like in Version 1.3, you can set left or right together with the starting point and then just define the remaining point.
- In F3F mode now the wind direction (90° to slope) is shown instead of direction of the slope edge
- A-Base is supported, can be toggled left /right with the multi switch
- The starting point can be redefined without affecting the slope bearing
- The 'Start Switch' now is a 'Multi Switch' with three functions (start, toggle A-Base left/right, redefine start point)
- The starting point can be adjusted in steps of 1m for compensation of GPS drift effects by a dedicated control
- The speed is now measured and announced 1.5 sec. after course entry instead of directly at course entry
- Countdown announcement now: 30, 25, 20, 15, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1 beep
- F3B Support mode with course definition not from center but from from A-Base, time measurement after 4 legs (speed) or count of legs (distance)
- Currently only english Version available
- Improved error management<br><br><br>

Copyright &copy; 2023 Frank Schreiber

#
Copyright &copy; 2023, 2024 Frank Schreiber
Binary file modified docs/images/Installed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/TeleWindow.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b98f2fd

Please sign in to comment.