From 95c9752b80464ed8bb2c56b3d9a3c8b6facd4183 Mon Sep 17 00:00:00 2001 From: sq2ips Date: Tue, 8 Apr 2025 20:43:45 +0200 Subject: [PATCH] Update README.md --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b9ee30f..f895b06 100644 --- a/README.md +++ b/README.md @@ -124,7 +124,19 @@ git clone https://github.com/sq2ips/m20-custom-firmware.git From github website "code" button, or directly from [here](https://github.com/sq2ips/m20-custom-firmware/archive/refs/heads/main.zip), and then unzip the file. # Configuration Before building the firmware you fist need to configure parameters located in the [`config.h`](https://github.com/sq2ips/m20-custom-firmware/blob/main/m20/Core/Inc/config.h) file. -TODO description +Parameters list: +| parameter | type (and unit) | description | +|-----------|------|-------------| +| `PAYLOAD_ID` | uint16 | Payload ID transmitted in Horus Binary frame, in order to conduct a flight you need to request one for your callsign, more information in the [Protocol documentation](https://github.com/projecthorus/horusdemodlib/wiki#how-do-i-transmit-it). For testing ID 256 is used | +| `TIME_PERIOD` | uint (in seconds) | Time between transmition of frames. Should not be lower than 4. | +| `GPS_TYPE` | uint | Type of GPS module, eather 1 for u-blox MAX-M10M, 2 for XM1110 module. For identifying the module see [GPS](https://github.com/sq2ips/m20-custom-firmware?tab=readme-ov-file#gps) section. | +| `QRG_FSK4` | uint (in Hz) | Frequency of 4FSK Horus transmition. | +| `PA_FSK4` | uint | Number from 0 to 63. TODO power levels measurements. | +| `RF_BOOST_ACTIVE` | bool | State of RF TX boost, amplifies signal by around 15dB. (In off state the boost cricut is attenuating the signal, when less output power is needed it's better to decrease `PA_FSK4` than turning it off.) | +| `ADF_FREQ_CORRECTION` | uint (multiples of 244Hz) | Frequency correction for transmitted signal | +| `LED_MODE` | uint | 0 - disabled, 1 - LED on while getting data before transmission, 2 - Fix type indication (1 flash for no fix, 2 flashes for 2D fix, 3 flashed 3D fix) | +| `LED_PERIOD` | uint | only for `LED_MODE` 3, time between fix indication | +| `LED_DISABLE_ALT` | uint (in meters) | only for `LED_MODE` 3, disables LED when prompted altitude is reached. | # Building the firmware Before flashing the firmware you need to build it first, there are a few ways you can do it depending on the platform: ## Building directly on Linux