1
0
Fork 0
mirror of https://github.com/on4kjm/FLEcli.git synced 2025-02-28 00:51:17 +01:00
FLEcli/README.md

90 lines
3.4 KiB
Markdown
Raw Normal View History

2020-05-26 22:16:47 +02:00
# FLEcli
2020-05-28 18:32:45 +02:00
Multi-platform "Fast Log Entry"(FLE) processing tool.
2020-05-26 22:27:11 +02:00
2020-07-21 13:27:17 +02:00
![Go Build & Test](https://github.com/jmMeessen/FLEcli/workflows/Go%20Build%20&%20Test/badge.svg)
2020-07-27 22:26:43 +02:00
[![codecov](https://codecov.io/gh/on4kjm/FLEcli/branch/master/graph/badge.svg)](https://codecov.io/gh/on4kjm/FLEcli)
2020-07-21 13:27:17 +02:00
["Fast Log Entry"](https://www.df3cb.com/fle/) is a nifty tool, written by DF3CB. It allows quick and efficient entry of radio amateur contacts made during DXpeditions, contests or SOTA/WWFF activation. It can export the listed contacts in ADIF format ready to be uploaded to eQSL/LOTW or submitted for SOTA and WWFF. The program is only available as a Windows executable which leaves the Mac or Linux users (like me) in the cold.
2020-05-27 21:29:23 +02:00
This tool is intended to process FLE formatted files on other platform than Windows. The FLE file format is described on https://www.df3cb.com/fle/documentation/
2020-05-28 18:32:45 +02:00
But is also the alibi to learn and explore GO.
2020-07-15 13:40:47 +02:00
2020-07-27 22:26:43 +02:00
------
2020-07-15 13:40:47 +02:00
2020-07-27 22:26:43 +02:00
## Installing
The tool is installed by downloading and unpacking the archive for your operating system.
2020-07-27 22:26:43 +02:00
A version is available for Windows, MacOS, Linux and ARM (RaspeberyPi).
Most of them are available as 32 or 64 bit applications.
A docker version is also available.
2020-07-27 22:26:43 +02:00
The releases can be downloaded from https://github.com/on4kjm/FLEcli/releases
2020-07-27 22:26:43 +02:00
Detailed installation instructions can be found [at this page](doc/install.md).
2020-07-15 13:40:47 +02:00
2020-07-27 22:26:43 +02:00
## Usage
2020-07-15 13:40:47 +02:00
2020-07-27 22:26:43 +02:00
Detailed explanations can be found [on this page](doc/usage.md).
2020-07-15 13:40:47 +02:00
2020-07-27 22:26:43 +02:00
Most comon use cases are described hereafter as examples.
2020-07-16 13:37:29 +02:00
### Example: validate the FLE syntax of a file
2020-07-15 13:40:47 +02:00
2020-07-27 22:26:43 +02:00
To load and validate the FLE formated file (`myActivation.txt`:
2020-07-15 13:40:47 +02:00
2020-07-15 23:02:31 +02:00
```
2020-07-29 08:22:13 +02:00
./FLEcli load myActivation.txt
2020-07-15 23:02:31 +02:00
```
2020-07-15 13:40:47 +02:00
This command will parse and display the QSOs in grid format.
Fields that couldn't be successfully parsed are prefixed with "*".
2020-07-15 23:02:31 +02:00
Parsing errors or doubts are listed at the end of the list.
2020-07-15 13:40:47 +02:00
### Example: generate an ADIF file
2020-07-15 23:02:31 +02:00
To generate an ADIF file based on `activation.txt`:
```
2020-07-29 08:22:13 +02:00
./FLEcli adif -i --overwrite activation.txt output/activation.adi
2020-07-15 23:02:31 +02:00
```
2020-07-29 08:22:13 +02:00
The second element after the input specifies the path and name of the output file.
If is omitted, the tool will generate a filename.
It is based on the input filename, just replacing the extension with `.adi`.
2020-07-15 23:02:31 +02:00
2020-07-29 08:22:13 +02:00
The `-o` or `--overwrite` flag indicates that, if the output file already exists, it should be overwritten.
2020-07-15 23:02:31 +02:00
2020-07-29 08:22:13 +02:00
The `-i` or `--interpolate` flag will interpolate the missing non-entered times based on the first and the last entered time.
2020-07-15 23:02:31 +02:00
2020-07-15 13:40:47 +02:00
### Example: generate an ADIF file for WWFF upload
2020-07-15 23:02:31 +02:00
2020-07-16 13:37:29 +02:00
To generate a WWFF-ready ADIF file:
2020-07-15 23:02:31 +02:00
```
2020-07-29 08:22:13 +02:00
./FLEcli adif -i --wwff ON4KJM@ONFF-025920200524.txt
2020-07-15 23:02:31 +02:00
```
The `--wwff` indicates the adif flavour to produce.
2020-07-16 13:37:29 +02:00
You can use the `--sota` switch to generate an ADIF file containing SOTA details.
The switch can be used together with `--wwff`
2020-07-15 23:02:31 +02:00
2020-07-16 13:57:20 +02:00
As we didn't provide an output filename, the default output, `ON4KJM@ONFF-025920200524.adi` will be used.
2020-07-15 23:02:31 +02:00
2020-07-15 13:40:47 +02:00
### Example: generate a SOTA csv file
2020-07-16 13:58:20 +02:00
To generate a CSV file that can be uploaded to https://www.sotadata.org.uk/ to report SOTA activations:
2020-07-16 13:37:29 +02:00
```
2020-07-29 08:22:13 +02:00
./FLEcli csv --interpolate --overwrite sotaActivation.txt
```
or the short form
```
./FLEcli csv -i -o sotaActivation.txt
2020-07-16 13:37:29 +02:00
```
2020-07-16 13:57:20 +02:00
This command will generate `sotaActivation.csv` based on the `sotaActivation.txt` FLE logfile.
2020-07-16 13:37:29 +02:00
If the output file exists, it will be overwritten as the `--overwrite` flag has been specified.
The `--interpolate` flag will interpolate the missing non-entered times based on the first and the last entered time.