Auxiliary section that allows you to prohibit the appointment of certain GPIOs when choosing the board type.
Values in this section are not included in myoptions.h
Here you need to mark the hardware that you want to connect / which is connected.
Values in this section are not included in myoptions.h
Language for the information shown on the display.
Parameter added to myoptions.h (default value specified):
#define L10N_LANGUAGE EN
Display model. See description/available values in
https://github.com/e2002/yoradio/wiki/Available-display-models
Parameter added to myoptions.h (default value specified):
#define DSP_MODEL DSP_DUMMY
Nextion displays can work in parallel with another display (or without a display, separately).
Specify the [ ]+NEXTION parameter and ask for a description below.
Depending on the selected display type above, its connection options are displayed here.
If you have any questions about choosing VSPI vs HSPI, please read this article or leave the default value of this setting.
ESP32-S3 and ESP32-C3 board have only one SPI to choose from, which is HSPI - but do not set DSP_HSPI to true in your config because it will cause compilation errors.
If you are using a module to create a configuration, the board definition will set the pins for SCK, MISO, MOSI. You can check your board definition here. Do not use those 3 pins for other purposes.
Parameters added to myoptions.h (default value specified):
SPI Displays
/* VSPI PINS.
SCL(SCK, CLK) must be connected to pin 18
SDA(MOSI, DIN, SDI) must be connected to pin 23 */
/* HSPI PINS. Set DSP_HSPI to true
/* HSPI PINS.
SCL(SCK, CLK) must be connected to pin 14
SDA(MOSI, DIN, SDI) must be connected to pin 13 */
#define DSP_HSPI false /* Use HSPI for display */
#define DSP_HSPI false /* must be false for ESP32-S3/C3 boards */
#define TFT_CS 5 /* SPI CS pin */
#define TFT_RST -1 /* SPI RST pin */
#define TFT_DC 4 /* SPI DC/RS pin */
#define BRIGHTNESS_PIN 255 /* BRIGHTNESS Pin */
I2C Displays
#define I2C_SDA 21 /* I2C SDA pin */
#define I2C_SCL 22 /* I2C SCL pin */
LCD Displays
#define LCD_RS 255 /* RS Pin */
#define LCD_E 255 /* E Pin */
#define LCD_D4 255 /* D4 Pin */
#define LCD_D5 255 /* D5 Pin */
#define LCD_D6 255 /* D6 Pin */
#define LCD_D7 255 /* D7 Pin */
If both parameters are equal to 255, the Nextion display is not used.
Parameters added to myoptions.h (default value specified):
#define NEXTION_RX 255 /* Nextion RX pin */
#define NEXTION_TX 255 /* Nextion TX pin */
This project works with three types of audio decoders:
external I2S DAC, VS1053 SPI DAC and ESP32 built-in I2S DAC.
Values in this section are not included in myoptions.h
If you want to generate mono sound, check the [ ]MONO option in this section.
This parameter added to myoptions.h (default value specified):
#define PLAYER_FORCE_MONO false
Depending on the selected audio decoder type above, its connection options are displayed here.
If you have any questions about choosing VSPI vs HSPI, please read this article or leave the default value of this setting.
ESP32-S3 and ESP32-C3 board have only one SPI to choose from, which is HSPI - but do not set DSP_HSPI to true in your config because it will cause compilation errors.
If you are using a module to create a configuration, the board definition will set the pins for SCK, MISO, MOSI. You can check your board definition here. Do not use those 3 pins for other purposes.
Parameters added to myoptions.h (default value specified):
VS1053B
/* VS1053 VSPI PINS.
VS1053 SCK must be connected to pin 18
VS1053 MISO must be connected to pin 19
VS1053 MOSI must be connected to pin 23 */
/* VS1053 HSPI PINS. Set VS_HSPI to true
/* VS1053 HSPI PINS.
VS1053 SCK must be connected to pin 14
VS1053 MISO must be connected to pin 12
VS1053 MOSI must be connected to pin 13 */
#define VS_HSPI false /* Use HSPI for VS */
#define VS_HSPI false /* must be false for ESP32-S3/C3 boards */
#define VS1053_CS 255 /* XCS pin */
#define VS1053_DCS 25 /* XDCS pin. */
#define VS1053_DREQ 26 /* DREQ pin. */
#define VS1053_RST -1 /* XRESET pin. */
External I2S DAC
#define I2S_DOUT 27 /* DIN connection */
#define I2S_BCLK 26 /* BCLK Bit clock */
#define I2S_LRC 25 /* WSEL Left Right Clock */
Internal I2S DAC
#define I2S_INTERNAL false /* If true - use esp32 internal DAC */
You can connect one or two encoders to control the device.
Encoder control logic is described on this page.
Values in this section are not included in myoptions.h
You can set up pins for encoders in the encoders pins section below.
Parameters added to myoptions.h (default value specified):
/* ENCODER */
#define ENC_BTNL 255 /* Left rotation (S2) */
#define ENC_BTNB 255 /* Encoder button (KEY) */
#define ENC_BTNR 255 /* Right rotation (S1) */
#define ENC_INTERNALPULLUP true /* Enable the weak pull up resistors */
#define ENC_HALFQUARD false /* Experiment with it */
/* ENCODER2 */
#define ENC2_BTNL 255 /* Left rotation (S2) */
#define ENC2_BTNB 255 /* Encoder button (KEY) */
#define ENC2_BTNR 255 /* Right rotation (S1) */
#define ENC2_INTERNALPULLUP true /* Enable the weak pull up resistors */
#define ENC2_HALFQUARD false /* (true, false, 255) Experiment with it */
Currently two touchscreen controllers are supported - XPT2046 and GT911
If you have any questions about choosing VSPI vs HSPI, please read this article or leave the default value of this setting.
ESP32-S3 and ESP32-C3 board have only one SPI to choose from, which is HSPI - but do not set DSP_HSPI to true in your config because it will cause compilation errors.
If you are using a module to create a configuration, the board definition will set the pins for SCK, MISO, MOSI. You can check your board definition here. Do not use those 3 pins for other purposes.
Parameters added to myoptions.h (default value specified):
Resistive SPI touch screen (XPT2046)
/* TS VSPI PINS.
CLK must be connected to pin 18
DIN must be connected to pin 23
DO must be connected to pin 19
IRQ - not connected */
/* TS HSPI PINS. Set TS_HSPI to true
/* TS HSPI PINS
CLK must be connected to pin 14
DIN must be connected to pin 13
DO must be connected to pin 12
IRQ - not connected */
#define TS_HSPI false /* Use HSPI for Touch screen */
#define TS_HSPI false /* must be false for ESP32-S3/C3 boards */
#define TS_CS 255 /* Touch screen CS pin */
#define TS_HSPI false /* Use HSPI for Touch screen */
Capacitive I2C touch screen (GT911)
#define TS_SDA 33
#define TS_SCL 32
#define TS_INT 21
#define TS_RST 25
The default value for TS_MODEL
#define TS_MODEL TS_MODEL_UNDEFINED
If you have any questions about choosing VSPI vs HSPI, please read this article or leave the default value of this setting.
ESP32-S3 and ESP32-C3 board have only one SPI to choose from, which is HSPI - but do not set DSP_HSPI to true in your config because it will cause compilation errors.
If you are using a module to create a configuration, the board definition will set the pins for SCK, MISO, MOSI. You can check your board definition here. Do not use those 3 pins for other purposes.
Parameters added to myoptions.h (default value specified):
/* MISO is the same as D0, MOSI is the same as D1 */
/* SD VSPI PINS.
SD SCK must be connected to pin 18
SD MISO must be connected to pin 19
SD MOSI must be connected to pin 23 */
/* SD HSPI PINS. Set SD_HSPI to true
/* SD HSPI PINS.
SD SCK must be connected to pin 14
SD MISO must be connected to pin 12
SD MOSI must be connected to pin 13 */
/* SD CUSTOM SPI.
#define SD_SPIPINS PIN, PIN, PIN /* SCK, MISO, MOSI */
#define SD_HSPI false /* Use HSPI for SD Card */
#define SD_HSPI false /* must be false for ESP32-S3/C3 boards */
#define SDC_CS 255 /* SDCARD CS pin */
Two RTC modules are currently supported - DS3231 and DS1307
Parameters added to myoptions.h (default value specified):
#define RTC_MODULE RTC_MODULE_UNDEFINED
#define RTC_SDA 255
#define RTC_SCL 255
Settings for built-in LED, IR receiver and other pins.
Parameters added to myoptions.h (default value specified):
#define LED_BUILTIN 255 /* Onboard LED Pin */
#define USE_BUILTIN_LED false /* Cancels Onboard LED Pin */
#define LED_BUILTIN_S3 255 /* Neopixel RGB LED (must be used with USE_BUILTIN_LED false) */
#define IR_PIN 255 /* More about IR Receiver */
#define MUTE_PIN 255 /* MUTE Pin */
#define WAKE_PIN 255 /* Wake Pin (for manual wakeup from sleep mode) */
/* can match with BTN_XXXX, ENC_BTNB, ENC2_BTNB. ESP32 must be one of: 0,2,4,12,13,14,15,25,26,27,32,33,34,35,36,39 */
#define LIGHT_SENSOR 255 /* Light sensor */
Settings currently not processed by the generator (you can specify them manually in the finished file myoptions.h:
Add them only if there is a real need.
Parameters added to myoptions.h (default value specified):
#define LED_INVERT false /* Invert Onboard LED? */
#define MUTE_VAL HIGH /* Write this to MUTE_PIN when player is stopped */
/* Autobacklight function. See options.h for example */
#define AUTOBACKLIGHT(x) *function*
/* IR_TIMEOUT. See kTimeout description in IRremoteESP8266 example */
#define IR_TIMEOUT 80
#define BTN_LONGPRESS_LOOP_DELAY 200 /* Delay between calling DuringLongPress event */
#define BTN_CLICK_TICKS 300 /* Event Timing https://github.com/mathertel/OneButton#event-timing */
#define BTN_PRESS_TICKS 500 /* Event Timing https://github.com/mathertel/OneButton#event-timing */
