src/user_defines.txt

   1 ### The Legal Stuff ###
   2
   3 # The use and operation of this type of device may require a license and some countries may forbid its use entirely.
   4 # It is entirely up to the end user to ensure compliance with local regulations. No claim of regulatory compliance is made. In most cases a HAM license is required.
   5 # This is experimental software/hardware and there is no guarantee of stability or reliability. USE AT YOUR OWN RISK
   6
   7 # HOW TO USE THIS FILE: https://www.expresslrs.org/1.0/software/user-defines/
   8 # SIMPLY SEARCH WHICH DEFINE YOU NEED HELP WITH
   9
  10
  11 ### BINDING PHRASE: ###
  12 # Uncomment the line below to use a hardcoded binding phrase
  13 # Leave commented to use traditional binding
  14 #-DMY_BINDING_PHRASE="default ExpressLRS binding phrase"
  15
  16
  17 ### REGULATORY DOMAIN: ###
  18
  19 # Domain is used to define correct frequency band for 900MHz hardware.
  20 #-DRegulatory_Domain_AU_915
  21 #-DRegulatory_Domain_EU_868
  22 #-DRegulatory_Domain_IN_866
  23 #-DRegulatory_Domain_AU_433
  24 #-DRegulatory_Domain_EU_433
  25 #-DRegulatory_Domain_US_433
  26 #-DRegulatory_Domain_US_433_WIDE
  27 #-DRegulatory_Domain_FCC_915
  28 #-DRegulatory_Domain_ISM_2400
  29 #-DRegulatory_Domain_EU_CE_2400
  30
  31 ### PERFORMANCE OPTIONS: ###
  32
  33 -DLOCK_ON_FIRST_CONNECTION
  34
  35 # For TX devices with fans, FAN_MIN_RUNTIME keeps the fan running even after the power level has
  36 # dropped below the configured Fan Threshold. This prevents the fan from turning on and off every
  37 # few seconds if the power level is constantly changing.
  38 # Default is 30 seconds if not defined, value can be 0-254.
  39 #-DFAN_MIN_RUNTIME=30
  40
  41 ### COMPATIBILITY OPTIONS: ###
  42
  43 # Use a custom baud rate on the receiver for a KISS v1 FC (which runs at 400000) or any other oddball baud
  44 # Changing this will prevent flashing via_BetaflightPassthrough, which expects a 420000 baud RX
  45 # If not defined, will default to 420000
  46 #-DRCVR_UART_BAUD=400000
  47
  48 #-DTLM_REPORT_INTERVAL_MS=240LU
  49
  50 ### OTHER OPTIONS: ###
  51
  52 -DAUTO_WIFI_ON_INTERVAL=60
  53 #-DHOME_WIFI_SSID=""
  54 #-DHOME_WIFI_PASSWORD=""
  55
  56
  57 ### Debugging options ###
  58
  59 # Turn on debug messages, if disabled then all debugging options (starting with DEBUG_) are disabled
  60 #-DDEBUG_LOG
  61
  62 # For an ESP32S3 MCU, there are two options:
  63 # 1 - Pull-up on GPIO3, USB for JTAG (on MI_02), debug logging uses main UART.
  64 # 2 - Pull-down on GPIO3, Individual pins for JTAG (MTDI/MTMS/MTCK/MTDO), debug logging via USB for CDC UART (on MI_00)
  65 #-DESP32_S3_USB_JTAG_ENABLED
  66
  67 # Use DEBUG_LOG_VERBOSE instead (or both) to see verbose debug logging (spammy stuff)
  68 #-DDEBUG_LOG_VERBOSE
  69
  70 # Print a letter for each packet received or missed (RX debugging)
  71 #-DDEBUG_RX_SCOREBOARD
  72
  73 # Don't send RC msgs over UART
  74 #-DDEBUG_CRSF_NO_OUTPUT
  75
  76 # These debugging options send extra information to BetaFlight in the LinkStatistics packet
  77 #-DDEBUG_BF_LINK_STATS
  78
  79 # Prints a log line for every channels packet recieved at the RX:
  80 #    ID,Antenna,RSSI,LQ,SNR,PWR,FHSS,TimingOffset
  81 # The ID is generated on the TX side and overwrites CH1-CH4 and increments once for every
  82 # channels packet. Writes directly to Serial, does not require DEBUG_LOG.
  83 # Flash both TX & RX with this enbled to use it if the ID is required.
  84 #-DDEBUG_RCVR_LINKSTATS
  85
  86 # This debug option reports dual radio RSSI&SNR, which is useful for validating a TD receiver
  87 #-DDEBUG_RCVR_SIGNAL_STATS
  88
  89 # Enable reporting of RF FreqCorrection in RX's SNR LinkStatistics, also decreases packet rate
  90 # on Team2.4 for the additional time needed to include the packet header / enable FreqCorrection
  91 # Dynamic power must be off, else it will adjust based on the FreqCorrection reported in SNR
  92 #-DDEBUG_FREQ_CORRECTION
  93
  94 # Enable reporting offsets sent to Open/EdgeTX for packet synchronisation.
  95 # Also logs forced resyncs when a packet is delayed or missed.
  96 #-DDEBUG_OPENTX_SYNC
  97
  98 # Use an ELRS TX and RX as a transparent UART over the air
  99 #-DUSE_AIRPORT_AT_BAUD=9600