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_FCC_915
  26 #-DRegulatory_Domain_ISM_2400
  27 #-DRegulatory_Domain_EU_CE_2400
  28
  29 ### PERFORMANCE OPTIONS: ###
  30
  31 #unlocks >250mw output power for R9M and Happy Model ES915TX (Fan mod suggested: https://github.com/AlessandroAU/ExpressLRS/wiki/R9M-Fan-Mod-Cover)
  32 #-DUNLOCK_HIGHER_POWER
  33
  34 -DLOCK_ON_FIRST_CONNECTION
  35
  36 # For TX devices with fans, FAN_MIN_RUNTIME keeps the fan running even after the power level has
  37 # dropped below the configured Fan Threshold. This prevents the fan from turning on and off every
  38 # few seconds if the power level is constantly changing.
  39 # Default is 30 seconds if not defined, value can be 0-254.
  40 #-DFAN_MIN_RUNTIME=30
  41
  42 ### COMPATIBILITY OPTIONS: ###
  43
  44 # Invert the TX/RX half-duplex pin in the transmitter code. Handset external
  45 # modules are almost all inverted. ESP32/8286 targets only
  46 -DUART_INVERTED
  47
  48 # Use a custom baud rate on the receiver for a KISS v1 FC (which runs at 400000) or any other oddball baud
  49 # If not defined, will default to 420000
  50 #-DRCVR_UART_BAUD=400000
  51
  52 # Invert the TX pin in the receiver code to allow an inverted RX pin on the
  53 # FC to be used (usually labeled SBUS input or RXI). Inverted CRSF output.
  54 # RX pin (telemetry) is unaffected. Update via_BetaflightPassthrough will
  55 # not work, only via_Wifi. ESP8266/8285 targets only
  56 #-DRCVR_INVERT_TX
  57
  58 #-DTLM_REPORT_INTERVAL_MS=240LU
  59
  60 ### OTHER OPTIONS: ###
  61
  62 -DAUTO_WIFI_ON_INTERVAL=60
  63 #-DHOME_WIFI_SSID=""
  64 #-DHOME_WIFI_PASSWORD=""
  65
  66 # Enables code for talking to a connected ESP8266 backpack on the TX module, and associated Lua params
  67 # The device target should enable this automatically for devices that come with this, but can be added
  68 # to any device.
  69 #-DUSE_TX_BACKPACK
  70
  71 # Silence the buzzer
  72 #-DDISABLE_ALL_BEEPS
  73 # Disables the startup tune and crsf connect/disconnct do beep-boop
  74 #-DDISABLE_STARTUP_BEEP
  75 # Startup is beep-boop, and crsf connect/disconnct do similar
  76 #-DJUST_BEEP_ONCE
  77 # Startup plays you own custom tune and crsf connect/disconnct do beep-boop
  78 #-DMY_STARTUP_MELODY="B5 16 P16 B5 16 P16 B5 16 P16 B5 2 G5 2 A5 2 B5 8 P4 A5 8 B5 1|140|-3"
  79
  80 #If commented out the LED is RGB otherwise GRB
  81 #-DWS2812_IS_GRB
  82
  83 ### Debugging options ###
  84
  85 # Turn on debug messages, if disabled then all debugging options (starting with DEBUG_) are disabled
  86 #-DDEBUG_LOG
  87 # Use DEBUG_LOG_VERBOSE instead (or both) to see verbose debug logging (spammy stuff)
  88 #-DDEBUG_LOG_VERBOSE
  89
  90 # Print a letter for each packet received or missed (RX debugging)
  91 #-DDEBUG_RX_SCOREBOARD
  92
  93 # Don't send RC msgs over UART
  94 #-DDEBUG_CRSF_NO_OUTPUT
  95
  96 # These debugging options send extra information to BetaFlight in the LinkStatistics packet
  97 #-DDEBUG_BF_LINK_STATS
  98
  99 # Prints a log line for every channels packet recieved at the RX:
 100 #    ID,Antenna,RSSI,LQ,SNR,PWR,FHSS,TimingOffset
 101 # The ID is generated on the TX side and overwrites CH1-CH4 and increments once for every
 102 # channels packet. Writes directly to Serial, does not require DEBUG_LOG.
 103 # Flash both TX & RX with this enbled to use it if the ID is required.
 104 #-DDEBUG_RCVR_LINKSTATS
 105
 106 # Enable reporting of RF FreqCorrection in RX's SNR LinkStatistics, also decreases packet rate
 107 # on Team2.4 for the additional time needed to include the packet header / enable FreqCorrection
 108 # Dynamic power must be off, else it will adjust based on the FreqCorrection reported in SNR
 109 #-DDEBUG_FREQ_CORRECTION
 110
 111 # Enable reporting offsets sent to Open/EdgeTX for packet synchronisation.
 112 # Also logs forced resyncs when a packet is delayed or missed.
 113 #-DDEBUG_OPENTX_SYNC
 114
 115 # Use an ELRS TX and RX as a transparent UART over the air
 116 #-DUSE_AIRPORT_AT_BAUD=9600