ELEGOO

https://wiki.elegoo.com
Admin
ELEGOO develops and manufactures 3D printers, laser engravers, STEM robotics kits, and related...
Tokens:970,471
Snippets:9,046
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### setup() Function Implementation

Source: https://wiki.elegoo.com/oshw-parts-%26-accessories/esp32-dispaly-wifiserver

The complete setup function that initializes hardware, connects to WiFi, and starts the web server.

```cpp
void setup()
{
  Serial.begin(115200);

  pinMode(RED_PIN, OUTPUT);
  pinMode(GREEN_PIN, OUTPUT);
  pinMode(BLUE_PIN, OUTPUT);
  digitalWrite(RED_PIN, LED_OFF);
  digitalWrite(GREEN_PIN, LED_OFF);
  digitalWrite(BLUE_PIN, LED_OFF);

  my_lcd.begin();
  my_lcd.setRotation(0);
  my_lcd.fillScreen(TFT_WHITE);
  my_lcd.setTextColor(TFT_RED);

  WiFi.mode(WIFI_STA);
  WiFi.setSleep(false);
  my_lcd.drawString("Start connecting to WiFi...", 10,55,2);
  WiFi.begin(ssid, password);

  while(WiFi.status()!= WL_CONNECTED)
  {
      delay(500);
      Serial.print(".");
  }

  my_lcd.fillRect(10, 55, my_lcd.width()-1, 25,TFT_WHITE);
  my_lcd.setTextColor(TFT_GREEN);
  my_lcd.drawString("Connection WIFI successful!!!", 10,55,2);
  my_lcd.setTextColor(TFT_BLUE);
  sprintf(t_buf, "SSID : %s", ssid);
  my_lcd.drawString(t_buf, 10,75,2);
  sprintf(t_buf, "  IP : %s", WiFi.localIP().toString().c_str());
  my_lcd.drawString(t_buf, 10,95,2);
  sprintf(t_buf, " MAC : %s", WiFi.macAddress().c_str());
  my_lcd.drawString(t_buf, 10,115,2);

  server.begin();
  my_lcd.drawString("Waiting for client connection", 10,135,2);
}
```

--------------------------------

### setup() Function Implementation

Source: https://wiki.elegoo.com/oshw-parts-%26-accessories/esp32-dispaly-tcpserver

Initializes the serial interface, display, and WiFi connection, then starts the TCP server.

```cpp
void setup()
{
    Serial.begin(115200);
    my_lcd.begin();
    my_lcd.setRotation(0);
    my_lcd.fillScreen(TFT_WHITE);
    my_lcd.setTextColor(TFT_RED);
    WiFi.mode(WIFI_STA);
    WiFi.setSleep(false);
    my_lcd.drawString("Start connecting to WiFi ...", 10,55,2);
    WiFi.begin(ssid, password);
    while (WiFi.status() != WL_CONNECTED)
    {
        delay(500);
        Serial.print(".");
    }
    my_lcd.fillRect(10, 55, my_lcd.width()-1, 25,TFT_WHITE);
    my_lcd.setTextColor(TFT_GREEN);
    my_lcd.drawString("Connection WIFI successful!!!", 10,55,2);
    my_lcd.setTextColor(TFT_BLUE);
    sprintf(t_buf, "SSID : %s", ssid);
    my_lcd.drawString(t_buf, 10,75,2);
    sprintf(t_buf, "  IP : %s", WiFi.localIP().toString().c_str());
    my_lcd.drawString(t_buf, 10,95,2);
    sprintf(t_buf, " MAC : %s", WiFi.macAddress().c_str());
    my_lcd.drawString(t_buf, 10,115,2);
    sprintf(t_buf, " PORT : %d", port);
    my_lcd.drawString(t_buf, 10,135,2);
    my_lcd.setTextColor(TFT_RED);
    server.begin(); //Start server
    my_lcd.drawString("Waiting for client connection", 10,155,2);
}
```

--------------------------------

### Switch LVGL Demo in setup()

Source: https://wiki.elegoo.com/oshw-parts-%26-accessories/esp32-dispaly-lvgl

Uncomment the desired demo function and comment out others in setup(). The example shows lv_demo_benchmark() enabled while lv_demo_widgets() is commented out. Available demos include lv_demo_widgets(), lv_demo_benchmark(), lv_demo_keypad_encoder(), lv_demo_music(), and lv_demo_stress().

```cpp
// lv_demo_widgets();
lv_demo_benchmark();   // switch to benchmark
```

--------------------------------

### setup() Function - Initialization

Source: https://wiki.elegoo.com/oshw-getting-started-%26-kits/wifintp

Initializes serial, connects to WiFi with a double-check loop to work around a UNO R4 firmware bug, and starts UDP listening.

```cpp
void setup() {
  Serial.begin(9600);
  while (!Serial);

  // Connect to WiFi
  Serial.print("Connecting to WiFi: ");
  Serial.println(ssid);
  WiFi.begin(ssid, password);

  while (WiFi.status() != WL_CONNECTED || WiFi.localIP() == IPAddress(0,0,0,0)) {
    delay(500);
    Serial.print(".");
  }

  Serial.println("\nWiFi connected successfully!");
  Serial.print("IP Address: ");
  Serial.println(WiFi.localIP());

  Udp.begin(localPort);
  Serial.println("Waiting for NTP time sync...\n");
}

```

--------------------------------

### IR Receiver Setup Function (IR_Receiver.ino)

Source: https://wiki.elegoo.com/oshw-getting-started-%26-kits/receiver-transmitter

Initializes the LED pin as output, starts serial communication at 9600 baud, and initializes the IR receiver on RECV_PIN with DISABLE_LED_FEEDBACK to disable hardware LED feedback. This is part of the IR_Receiver.ino example.

```Arduino
void setup()  
 {  
 pinMode(LED, OUTPUT);  
 Serial.begin(9600);  
 IrReceiver.begin(RECV_PIN, DISABLE_LED_FEEDBACK);  
 }
```

--------------------------------

### Setup Function for Stepper Motor IR Control

Source: https://wiki.elegoo.com/oshw-getting-started-%26-kits/stepmotor

Initializes motor pins as OUTPUT, sets motor speed, configures IR pin as INPUT, and starts serial communication at 9600 baud. Prints a welcome message and operation guide.

```Arduino
void setup() {  
 // Initialize motor pins (explicitly set to OUTPUT for initial operation) (new)  
 pinMode(MOTOR_PIN1, OUTPUT);  
 pinMode(MOTOR_PIN2, OUTPUT);  
 pinMode(MOTOR_PIN3, OUTPUT);  
 pinMode(MOTOR_PIN4, OUTPUT);
// Initialize motor  
 myStepper.setSpeed(motorSpeed);
// Initialize IR pin  
 pinMode(IR_PIN, INPUT);
// Initialize serial communication (baud rate 9600)  
 Serial.begin(9600);  
 Serial.println("=== System Started Successfully ===");  
 Serial.println("Operation Guide:");  
 Serial.println("VOL+ → Motor Clockwise");  
 Serial.println("VOL- → Motor Counterclockwise");  
 Serial.println("Auto-stop after 3 seconds of inactivity, auto-sleep after 5 seconds");  
 Serial.println("-------------------");  
 }
```

--------------------------------

### Initialize System in setup()

Source: https://wiki.elegoo.com/oshw-getting-started-%26-kits/wifistable

Configures serial communication and performs the initial WiFi connection and UDP setup.

```cpp
void setup() {
  Serial.begin(9600);
  while (!Serial);

  Serial.println("=== Arduino UNO R4 WiFi Stability Optimization ===");
  Serial.println("System starting, initializing WiFi...");

  connectWiFi();    // First WiFi connection on boot (encapsulated as function)
  Udp.begin(localPort);
  Serial.println("UDP Initialized (For NTP Example)\n");
}
```

--------------------------------

### Start Advertising

Source: https://wiki.elegoo.com/oshw-parts-%26-accessories/esp32-dispaly-bleserver

Gets the advertising object and starts advertising so the device can be discovered by scans.

```cpp
BLEAdvertising *pAdvertising = pServer->getAdvertising();
pAdvertising->start();
```

--------------------------------

### Initialize setup() function

Source: https://wiki.elegoo.com/oshw-parts-%26-accessories/esp32-dispaly-backlight

The setup function initializes the serial port, LCD, touch screen, draws the UI, and configures the PWM backlight control.

```cpp
void setup()
{
  Serial.begin(115200);
  my_lcd.begin();
  my_lcd.setRotation(1);
  my_touch.setCal(495, 3398, 721, 3448, 320, 240, 1);
  my_lcd.fillScreen(TFT_WHITE);
  my_lcd.setTextColor(TFT_BLACK, TFT_WHITE);
  my_lcd.setTextSize(2);
  my_lcd.setCursor(my_lcd.width()/2-150, 160);
  my_lcd.println("0");
  my_lcd.setCursor(my_lcd.width()/2+110, 160);
  my_lcd.println("255");
  my_lcd.fillRoundRect(my_lcd.width()/2-138, 130, 276, 21,10,0x07FF);
  my_lcd.fillCircle(my_lcd.width()/2+128, 140,10,TFT_MAGENTA);
  my_lcd.setTextColor(TFT_RED);
  my_lcd.drawNumber(255, my_lcd.width()/2-15, 65,2);
  ledcAttachChannel(BACKLIGHT_PIN, freq, resolution, channel);
  ledcWrite(BACKLIGHT_PIN, 255);
}
```

--------------------------------

### setup Function

Source: https://wiki.elegoo.com/oshw-getting-started-%26-kits/74h595-2560

Initializes the system by configuring the GPIO pins as outputs.

```cpp
void setup()  
 {  
 pinMode(latchPin, OUTPUT);
 pinMode(dataPin, OUTPUT);
 pinMode(clockPin, OUTPUT);
 }
```

--------------------------------

### Stepper motor IR remote control - Setup Function

Source: https://wiki.elegoo.com/oshw-getting-started-%26-kits/stepmotor-2560

The setup function starts the IR receiver to begin listening for IR signals.

```arduino
void setup()  
 {  
 irrecv.enableIRIn(); // Start the receiver  
 }
```

--------------------------------

### ESP32 setup() Initialization Function

Source: https://wiki.elegoo.com/oshw-getting-started-%26-kits/dualboard-esp32

The setup function initializes the serial port, configures the LED, creates a WiFi access point, and starts the TCP server. It runs once upon power-on.

```cpp
void setup() {
  Serial.begin(115200);
  delay(1000);

  pinMode(LED_PIN, OUTPUT);
  digitalWrite(LED_PIN, LOW);

  Serial.println();
  Serial.println("========================================");
  Serial.println("  ESP32 TCP Server — Starting up...");
  Serial.println("========================================");

  // Step 1: Create WiFi hotspot
  Serial.print("[SERVER] Creating AP hotspot: ");
  Serial.println(ap_ssid);
  WiFi.mode(WIFI_AP);
  WiFi.softAP(ap_ssid, ap_password);
  delay(1000);

  Serial.print("[SERVER] AP IP Address: ");
  Serial.println(WiFi.softAPIP());

  // Step 2: Start TCP server
  server.begin();
  Serial.print("[SERVER] TCP Server started on port: ");
  Serial.println(serverPort);
  Serial.println("[SERVER] Waiting for client connection...");
  Serial.println();
  Serial.println("[SERVER] Type a message and press Enter to send.");
  Serial.println();
}
```

--------------------------------

### Servo setup function with attach and write

Source: https://wiki.elegoo.com/oshw-getting-started-%26-kits/servo-r4

Initializes the servo by attaching it to pin 9 and moving it to the center position (90 degrees). This setup ensures the servo starts at a known position and prevents unexpected movement.

```Arduino
void setup(){  
 /*"attach" and "write" are both functions,  
 and they are members contained in the complex structure of "Servo".  
 We can only use them if we create the object "myservo" for the complex structure of "Servo".  
 */  
 myservo.attach(9);//connect pin 9 with the control line(the middle line of Servo)  
 myservo.write(90);// move servos to center position -> 90°  
 }
```

--------------------------------

### setup() Function

Source: https://wiki.elegoo.com/oshw-parts-%26-accessories/esp32-dispaly-desktopdisplay

The main initialization function that configures hardware, network, and display components.

```cpp
void setup()
{
  Serial.begin(115200);
  EEPROM.begin(1024);
  if (EEPROM.read(BL_addr) > 0 && EEPROM.read(BL_addr) < 100)
    LCD_BL_PWM = EEPROM.read(BL_addr);

  pinMode(LCD_BL_PIN, OUTPUT);
  analogWrite(LCD_BL_PIN, map(LCD_BL_PWM, 0, 100, 0, 255));

  tft.begin();
  tft.fillScreen(TFT_WHITE);
  tft.setTextColor(TFT_BLACK, bgColor);

  targetTime = millis() + 1000;

  TJpgDec.setJpgScale(1);
  TJpgDec.setSwapBytes(true);
  TJpgDec.setCallback(tft_output);

  connect_wifi();
  Udp.begin(localPort);
  setSyncProvider(getNtpTime);
  setSyncInterval(300);

  preferences.begin("weather", false);
  String savedCity = preferences.getString("city", DEFAULT_CITY);
  preferences.end();
  cityName = savedCity;

  tft.fillScreen(TFT_WHITE);
  TJpgDec.drawJpg(10, 193, temperature, sizeof(temperature));
  TJpgDec.drawJpg(10, 223, humidity, sizeof(humidity));

  getCityWeather();
}
```

--------------------------------

### IR Transmitter setup() Function

Source: https://wiki.elegoo.com/oshw-getting-started-%26-kits/receiver-transmitter

setup() function for the infrared transmitter example. Initializes serial communication at 9600 baud, initializes the infrared transmitter on the configured pin, and prints a startup message to the Serial Monitor.

```cpp
void setup()
{
Serial.begin(9600);
IrSender.begin(IR_SEND_PIN);
Serial.println("Infrared Transmitter Started, Sending 0x00 and 0x01 in Loop");
}
```

--------------------------------

### setup() Function Initialization

Source: https://wiki.elegoo.com/oshw-parts-%26-accessories/esp32-dispaly-bleserver

The setup function initializes the serial port, TFT screen, and BLE server, and displays initial text on the screen.

```cpp
void setup()
{
  Serial.begin(115200);
  my_lcd.begin();
  my_lcd.setRotation(0);
  my_lcd.fillScreen(TFT_WHITE);
  my_lcd.setTextFont(2);
  my_lcd.setTextColor(TFT_RED);
  setupBLE();
  my_lcd.drawString("BLE server start.", 10, 0);
  my_lcd.drawString("receive data :",10,16,2);
}
```

--------------------------------

### setup() Function Initialization

Source: https://wiki.elegoo.com/oshw-parts-%26-accessories/esp32-dispaly-key

Configures GPIO modes and initial states for the LEDs and the button during startup.

```cpp
void setup()
{
  //Initialize LED GPIO, turn off tricolor light
  pinMode(RED_PIN, OUTPUT);
  pinMode(GREEN_PIN, OUTPUT);
  pinMode(BLUE_PIN, OUTPUT);
  digitalWrite(RED_PIN, LED_OFF);  //RED
  digitalWrite(GREEN_PIN, LED_OFF); //GREEN
  digitalWrite(BLUE_PIN, LED_OFF); //GREEN
  //Initialize KEY GPIO
  pinMode(KEY_PIN,INPUT_PULLUP);
}
```

--------------------------------

### Implement HTTP Basic Auth in Web Server

Source: https://wiki.elegoo.com/oshw-getting-started-%26-kits/wifistable-esp32

Example of wrapping the root handler with authentication in the web server setup.

```cpp
void setupWebServer() {
  server.on("/", HTTP_GET, []() {
    if (!server.authenticate("admin", "esp32pass")) {
      return server.requestAuthentication();
    }
    handleRoot();
  });
  // ... add protection to other routes too
}
```

--------------------------------

### Complete setup() function

Source: https://wiki.elegoo.com/oshw-parts-%26-accessories/esp32-dispaly-stamode

The setup function initializes the screen, configures WiFi, and attempts to connect to a network, handling both success and failure states.

```cpp
void setup()
{
  Serial.begin(115200);
  my_lcd.begin();
  my_lcd.setRotation(0);
  my_lcd.fillScreen(TFT_WHITE);
  my_lcd.setTextColor(TFT_RED);
  WiFi.mode(WIFI_STA);
  WiFi.setSleep(false);
  my_lcd.drawString("Start connecting to WiFi...", 22,85,2);
  WiFi.begin(ssid, password);
  while(WiFi.status()!= WL_CONNECTED)
  {
      i++;
      delay(500);
      Serial.print(".");
      if(i>360)
      {
        break;
      }
  }
  if(i>360)
  {
    while(1)
    {
      my_lcd.fillRect(22, 85, my_lcd.width()-1, 25,TFT_WHITE);
      delay(500);
      my_lcd.drawString("connection failed!!!", 22,85,2);
      delay(500);
    }
  }
  else
  {
     my_lcd.fillRect(22, 85, my_lcd.width()-1, 25,TFT_WHITE);
     my_lcd.setTextColor(TFT_GREEN);
     my_lcd.drawString("Connection successful!!!", 22,85,2);
     my_lcd.setTextColor(TFT_BLUE);
     sprintf(t_buf, "SSID : %s", ssid);
     my_lcd.drawString(t_buf, 22,105,2);
     sprintf(t_buf, "  IP : %s", WiFi.localIP().toString().c_str());
     my_lcd.drawString(t_buf, 22,125,2);
     sprintf(t_buf, " MAC : %s", WiFi.macAddress().c_str());
     my_lcd.drawString(t_buf, 22,145,2);
  }
}
```

--------------------------------

### setup() Function: Initialize Hardware and Draw UI

Source: https://wiki.elegoo.com/oshw-parts-%26-accessories/esp32-dispaly-phonecall

Initializes the touch IRQ pin, LCD, and touch screen, then draws the keypad UI by calling show_menu(). Sets LCD rotation to 0 (portrait mode) and fills the screen with blue.

```cpp
void setup(void)
{
  pinMode(RTP_IRQ, INPUT);
  my_lcd.init();
  my_lcd.setRotation(0);
  my_touch.setCal(495, 3398, 721, 3448, 320, 240, 1);
  my_touch.setRotation(0);
  my_lcd.fillScreen(BLUE);
  show_menu();
}
```

--------------------------------

### Initialize Encoder State in Setup

Source: https://wiki.elegoo.com/oshw-getting-started-%26-kits/rotary-encodemodule

Reads the initial logic levels of the CLK and DT pins to establish the starting state.

```cpp
lastState = (digitalRead(CLK) << 1) | digitalRead(DT);
```

--------------------------------

### ESP32 Simple Serial Program Example

Source: https://wiki.elegoo.com/oshw-getting-started-%26-kits/serial-2

A basic setup function that initializes the serial port and sends a welcome message to the terminal.

```cpp
void setup() {  
 // 1. Initialize serial port with baud rate 115200  
 Serial.begin(115200);  
 // Wait for serial port to connect (required for some boards)  
 while (!Serial);
// 2. Send welcome message  
 Serial.println(" ESP32 Simple Serial Program ");  
 Serial.println("Commands:");  
 Serial.println(" on - Turn on LED");  
 Serial.println(" off - Turn off LED");  
 Serial.println(" status - Check LED status");  
 Serial.println("====================================");  
 }  
 void loop()  
 {  
 }
```
Tokens:
Raw