Settings - alex-43/SoftRF GitHub Wiki

Mode

     Normal - Regular operation. GNSS module is in use as a source of positional information ;
     Bridge   - Raw data RF packets forwarding to and from a Wi-Fi client's application (Emulator) ;
     UAV      - for use with MAVLINK 1.0 compatible autopilot .

Protocol 1

     Legacy 2 - Air V6 ;
     OGNTP   - OGN Tracking Protocol ;
     P3I          - PilotAware ;
     FANET 3  - Skytraxx ;
     UAT 4      - ADS-B @ 978 MHz ;
     1090ES 5 - ADS-B @ 1090 MHz.

1 - protocol selection is available for SX1276/SX1262 (SoftRF LoRa, Prime MkII, Dongle, Mini, Badge, Academy, Lego) or CC1352 (Uni) radios only ;
2 - Legacy is the only protocol available for nRF905 radio. It is active by default in this case ;
3 - FANET protocol is not applicable for CC1352 (Uni) radio ;
4 - UAT protocol selection is applicable for CC1352 (Uni) radio only ;
5 - 1090ES protocol selection is applicable for SDR (ES Edition) radio only.

Region 6

     AUTO 7 - Auto-select regional RF ISM band settings based on your current GNSS location ;
     EU       - Europe (and United Kingdom), 868.2 MHz band. Applicable for: Legacy, OGNTP, FANET ;
     RU      - Russia, 868.8 MHz band ;
     CN      - China, 470 MHz band ;
     US/CA - USA and Canada, 915 MHz band ;
     NZ      - New Zealand, 869.25 MHz band ;
     UK      - United Kingdom (and Europe), 869.52 MHz band. Applicable for: P3I radio protocol only ;
     AU      - Australia, 921 MHz band ;
     IN       - India, 866 MHz band ;
     KR      - South Korea, 920.9 MHz band ;
     IL        - Israel, 916.2 MHz band.

6 - the region selection is applicable for ISM band radio protocols only. For North America ADS-B UAT (978 MHz) and worldwide ADS-B 1090ES (1090 MHz) ones - your are safe to leave the region value intact ;
7 - it is not recommended to use AUTO region setting right now. It may not work as expected.

Aircraft type

Your aircraft type.

     Glider
     Towplane
     Powered
     Helicopter
     UAV
     Hangglider
     Paraglider
     Balloon
     Static

Alarm trigger

     None      - do not issue any alarms ;
     Distance - issue a NMEA ($PFLAA) alarm sentence when traffic is in close proximity ;
     Vector    - issue a NMEA ($PFLAA) alarm sentence when traffic is short on intersecting course.

Tx Power

     Full - transmit position beacons at rated power (limited by regional regulations) ;
     Low - transmit position beacons at 2 dBm or less ;
     Off   - disable transmitter.

Volume

Control for volume level of Standalone Edition's built-in speaker.

     Loud
     Low 8
     Off

8 - Low volume level is applicable for ESP32 platform only.

LED ring direction

Applicable for Standalone Edition only.

     CoG Up    - your aircraft's course over the ground is up ;
     North Up - GNSS North is up ;
     Off           - disable LED ring operation.

Built-in Bluetooth 9

     Off - disable built-in Bluetooth operation ;
     SPP - operate the Bluetooth in Serial Port Profile mode ;
     LE  10 - operate the Bluetooth in Low Energy "Serial port emulation" mode (compatible with HM-10 module, and with XCSoar software as well).

9 - mode selection is available for SoftRF firmware running on ESP32 platform only.
10 - LE mode may not work properly with iOS devices.

NMEA sentences

     GNSS      - enable or disable NMEA GNSS sentences ;
     Private    - enable or disable SoftRF private NMEA sentences. Applicable for UART port only ;
     Legacy    - enable or disable FLARM dataport NMEA sentences ;
     Sensors   - enable or disable NMEA sentences from (optional) I2C sensors.

NMEA output

     Off            - do not deliver any of NMEA sentences ;
     Serial        - deliver selected NMEA sentences over UART ;
     UDP          - deliver selected NMEA sentences over Wi-Fi (UDP dest. port 10110) ;
     TCP           - deliver selected NMEA sentences over Wi-Fi (TCP source port 2000) ;
     Bluetooth - deliver selected NMEA sentences over built-in Bluetooth. 11

11 - Bluetooth output selection is applicable for SoftRF firmware running on ESP32 and nRF52 platforms only.

GDL90

     Off            - do not deliver Garmin GDL90 data ;
     Serial        - deliver Garmin GDL90 data over UART ;
     UDP          - deliver Garmin GDL90 data packets over Wi-Fi (UDP dest. port 4000) ;
     Bluetooth - deliver Garmin GDL90 data over built-in Bluetooth. 12

12 - Bluetooth output selection is applicable for SoftRF firmware running on ESP32 and nRF52 platforms only.

Dump1090

     Off            - do not deliver Dump1090 sentences ;
     Serial        - deliver Dump1090 sentences over UART ;
     Bluetooth - deliver Dump1090 sentences over built-in Bluetooth. 13

13 - Bluetooth output selection is applicable for SoftRF firmware running on ESP32 and nRF52 platforms only.

Power save

     Disabled                 - do not use any of power saving methods ;
     WiFi OFF (10 min.) - turn SoftRF Wi-Fi AP off in 10 minutes after last client has closed it's connection ;
     GNSS                      - use GNSS power save method when able ; 14
     No Receive             - disable radio receive feature to reduce device power consumption . 15

14 - this setting is currently applicable for Uni Edition only ;
15 - this setting is applicable for Bracelet Edition .

Stealth

Enable or disable 'Stealth' mode. Applicable for: Legacy, OGNTP protocols.

No track

Enable or disable a tracking permit for ground stations. Applicable for: Legacy, FANET protocols.

Radio CF correction 16

This option is for advanced users only. If you are not certain - make sure that this setting is equal to 0.

Apply a correction of RF carrier frequency. This is a method to compensate deviation of the frequency due to production faults, extreme temperatures and crystal resonator ageing.

Represented in kHz. Range: from -30 up to 30.

Most likely that you don't need to change anything here. This page contains measured frequency deviation of different radio modules been used.

16 - this setting is applicable for SX1276 radio only.

IGC key 17

A 128-bit hexadecimal key that is in use to encrypt an aircraft position information. This feature is designed to ensure secure data transfer through OGN network toward FAI server while FAI/IGC Category 1 sport event is taking place.

Use a key provided by your gliding contest organizer.
Read IGC secure flight data trackers document for more information.

This feature is available in recent Release 1.1.
It is applicable for certain platforms only:

  • ESP32
  • nRF52
  • CC1352R
  • RP2040

Access to the hexadecimal key on the ESP32 is provided through WebUI. For other platforms one should use NMEA command line method.

ATTENTION: Use of wrong key will make your device ignored by both air traffic and OGN ground stations. If you are uncertain - leave the key value to stay 00000000000000000000000000000000 (i.e. no encryption) all the time.

17 - this setting is applicable for OGNTP radio protocol only ;


Defaults

Below is an illustration of default settings for SoftRF firmware version 1.0



Backup and restore

To backup your settings - take a screenshot of the WebUI or SoftRF Tool settings page.
To restore your settings - manually set all necessary selectors, buttons and knobs of the WebUI or SoftRF Tool settings page while using earlier saved screenshot as a reference.

⚠️ **GitHub.com Fallback** ⚠️