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