M5Stack

https://docs.m5stack.com/en/
Admin
M5Stack is a modular IoT development platform providing microcontroller-based hardware devices with...
Tokens:1,549,142
Snippets:15,328
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Arduino 'Hello World' Example

Source: https://docs.m5stack.com/en/arduino/m5dinmeter/program

A basic sketch to verify the M5DinMeter setup. It displays 'Hello World!' on the device screen and prints the same message to the Serial Monitor. Ensure M5Unified, M5GFX, and M5DinMeter libraries are installed.

```cpp
#include <M5Unified.h>

//––– Adjust these to position your text –––
static const int16_t X_POS = 0;   // horizontal pixel offset
static const int16_t Y_POS = 60;  // vertical pixel offset

void setup() {
  auto cfg = M5.config();
  M5.begin(cfg);

  M5.Display.setTextSize(2);
  M5.Display.setCursor(X_POS, Y_POS);
  M5.Display.println("Hello World!");

  Serial.begin(115200);
  Serial.println("Hello World!!!");
}

void loop() {
  // nothing here
}
```

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

### Full EzData Example

Source: https://docs.m5stack.com/en/uiflow2/blockly/ezdata/ezdata_blockly

This snippet demonstrates the complete setup and loop for EzData, including initialization, setting values, getting data, history, deletion, and listing keys. Ensure M5Stack firmware is up-to-date for error handling.

```python
import os, sys, io
import M5
from M5 import *
from ezdata import *

ez_0 = None
ez_item = None

def setup():
  global ez_0
  M5.begin()
  Widgets.fillScreen(0x222222)
  ez_0 = EzData('b1112ac5e9644f26af381c15c4a0e1da', 'age')
  ez_0.set("res/img/default.png", is_file=True)

def loop():
  global ez_0
  M5.update()
  ez_0.set(18, is_file=False)
  print(ez_0.get())
  ez_0.set([1, 2, 3], is_file=False)
  print(ez_0.history())
  ez_0.delete()
  for ez_item in get_key_list(device_token=_).iterms():
    print(ez_item[0])
    print(ez_item[1])

if __name__ == '__main__':
  try:
    setup()
    while True:
      loop()
  except (Exception, KeyboardInterrupt) as e:
    try:
      from utility import print_error_msg
      print_error_msg(e)
    except ImportError:
      print("please update to latest firmware")
```

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

### Arduino Quick Start for Atomic SPK Base

Source: https://docs.m5stack.com/en/atom/Atomic SPK Base

This example demonstrates the basic setup and usage of the Atomic SPK Base with Arduino. Ensure the M5Stack.h library is installed.

```cpp
#include "M5Stack.h"

void setup() {
  M5.begin();
  M5.Speaker.begin();
}

void loop() {
  M5.Speaker.playWav("/sd/test.wav");
  delay(1000);
}
```

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

### M5StickS3 Microphone Recording and Playback Example

Source: https://docs.m5stack.com/en/arduino/m5sticks3/mic

This example demonstrates how to record audio using the M5StickS3's microphone and play it back using the speaker. It includes setup for the display, microphone, and speaker, and handles the transition between recording and playback modes. Ensure M5Unified library version >= 0.2.12 and M5GFX library version >= 0.2.18 are installed.

```cpp
#include "M5Unified.h"

static constexpr const size_t record_number     = 256;
static constexpr const size_t record_length     = 256;
static constexpr const size_t record_size       = record_number * record_length;
static constexpr const size_t record_samplerate = 18000;
static size_t rec_record_idx  = 2;
static size_t draw_record_idx = 0;
static int16_t *rec_data;
static int32_t w;

static bool indicator_visible = true;
static uint32_t indicator_timer = 0;
static constexpr uint32_t indicator_interval = 500;//ms
static uint16_t indicator_color = RED;

static void updateIndicator(void) {
    uint32_t now = millis();
    if (now - indicator_timer >= indicator_interval) {
        indicator_timer = now;
        indicator_visible = !indicator_visible;
    }
    if (indicator_visible) {
        M5.Lcd.fillCircle(85, 10, 8, indicator_color);
    } else {
        M5.Lcd.fillCircle(85, 10, 8, BLACK);
    }
}

void setup(void) {
    M5.begin();
    M5.Lcd.setRotation(1);
    M5.Lcd.setTextDatum(middle_center);
    M5.Lcd.setTextColor(WHITE);
    M5.Lcd.setFont(&fonts::FreeMonoBold9pt7b);
    w = M5.Lcd.width();
    rec_data = (typeof(rec_data))heap_caps_malloc(record_size *sizeof(int16_t), MALLOC_CAP_8BIT);
    memset(rec_data, 0, record_size * sizeof(int16_t));
    M5.Speaker.setVolume(200);
    // Since the microphone and speaker cannot be used at the same time,
    // turn off the speaker here.
    M5.Speaker.end();
    M5.Mic.begin();
    indicator_color = RED;
    updateIndicator();
    M5.Lcd.drawString("REC", w / 2, 12);
    M5.Lcd.drawString("BtnA to play record", w / 2, 80);
}

void loop(void) {
    M5.update();
    if (M5.Mic.isEnabled()) {
        static constexpr int shift = 6;
        auto data = &rec_data[rec_record_idx * record_length];
        updateIndicator();
        if (M5.Mic.record(data, record_length, record_samplerate)) {
            data = &rec_data[draw_record_idx * record_length];
            M5.Lcd.display();
            updateIndicator();
            M5.Lcd.drawString("REC", w / 2, 12);
            M5.Lcd.drawString("BtnA to play record", w / 2, 80);
            if (++draw_record_idx >= record_number) {
                draw_record_idx = 0;
            }
            if (++rec_record_idx >= record_number) {
                rec_record_idx = 0;
            }
        }
    }
    if (M5.BtnA.wasPressed()) {
        if (M5.Speaker.isEnabled()) {
            while (M5.Mic.isRecording()) {
                delay(1);
            }
            M5.Lcd.clear();
            indicator_color = GREEN;
            indicator_visible = true;
            indicator_timer = millis();
            updateIndicator();
            M5.Lcd.drawString("PLAY", w / 2, 12);
            // Since the microphone and speaker cannot be used at the same time, 
            // turn off the microphone here.
            M5.Mic.end();
            M5.Speaker.begin();
            int start_pos = rec_record_idx * record_length;
            if (start_pos < record_size) {
                M5.Speaker.playRaw(&rec_data[start_pos],
                                       record_size - start_pos,
                                       record_samplerate, false, 1, 0);
            }
            if (start_pos > 0) {
                M5.Speaker.playRaw(rec_data, start_pos, record_samplerate,
                                       false, 1, 0);
            }
            do {
                delay(1);
                M5.update();
                updateIndicator();
            } while (M5.Speaker.isPlaying());
            // Since the microphone and speaker cannot be used at the same time, 
            // turn off the speaker here.
            M5.Speaker.end();
            M5.Mic.begin();
            M5.Lcd.clear();
            indicator_color = RED;
            indicator_visible = true;
            indicator_timer = millis();
            updateIndicator();
            M5.Lcd.drawString("REC", w / 2, 12);
        }
    }
}

```

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

### Select QuickStart Configuration Mode

Source: https://docs.m5stack.com/en/stackflow/ai_pyramid/openclaw

Choose 'QuickStart' for a simplified configuration process where details can be set later.

```bash
◆ Onboarding mode
│ ● QuickStart (Configure details later via openclaw configure.)
│ ○ Manual
```

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

### M5.begin() Migration Example

Source: https://docs.m5stack.com/en/arduino/m5unified/migration

Shows a diff example of migrating from older M5.begin() parameters to the new configuration structure in M5Unified. This example enables the internal IMU.

```diff
- M5.begin(true, true, true, true);
+ auto cfg = M5.config();
+ cfg.internal_imu = true;
+
+ M5.begin(cfg);
```

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

### Arduino Quick Start for Atom CAN Base

Source: https://docs.m5stack.com/en/atom/Atomic CAN Base

This snippet provides a basic setup for using the Atom CAN Base with Arduino. Ensure you have the necessary libraries installed.

```cpp
#include "M5Stack.h"
#include "CAN.h"

void setup() {
  Serial.begin(115200);
  Wire.begin();
  M5.begin();

  // Initialize CAN bus
  if (CAN.begin(1000E3) == 0) {
    Serial.println("CAN init failed!");
    while (1);
  }
  Serial.println("CAN init success!");
}

void loop() {
  // Example: Send a CAN message
  CAN.beginPacket(0x100);
  CAN.write('H');
  CAN.write('e');
  CAN.write('l');
  CAN.write('l');
  CAN.write('o');
  CAN.endPacket();
  delay(100);

  // Example: Receive CAN messages
  if (CAN.parsePacket()) {
    Serial.print("Received: ");
    while (CAN.available()) {
      Serial.print((char)CAN.read());
    }
    Serial.println();
  }
  delay(100);
}
```

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

### Sample Program

Source: https://docs.m5stack.com/en/arduino/m5gfx/m5gfx

Example usage of M5UnitOLED constructor, init, and setup functions.

```APIDOC
## Sample Program

### Description

This sample program demonstrates how to initialize and use the M5UnitOLED display.

### Code

```cpp
#include <M5UnitOLED.h>
M5UnitOLED display;

void setup() {
    display.init( 21, 22, 400000 );
    display.setup( 21, 22, 400000 );
    uint16_t x = display.width() / 2;
    uint16_t y = display.height() / 2;

    display.drawCenterString("M5Stack", x, y);
}

void loop() {
}
```
```

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

### Get Encoder Value (Arduino)

Source: https://docs.m5stack.com/en/unit/encoder

This example demonstrates how to read the value from the rotary encoder using the M5Core. Ensure the Unit Encoder library is installed.

```cpp
#include "M5UnitEncoder.h"

M5UnitEncoder encoder;

void setup() {
    Serial.begin(115200);
    Wire.begin();
    encoder.begin();
}

void loop() {
    int value = encoder.getValue();
    Serial.printf("Encoder Value: %d\n", value);
    delay(50);
}
```

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

### Hello World Example

Source: https://docs.m5stack.com/en/arduino/m5unified/helloworld

This basic example initializes the M5Stack device, displays 'Hello World!!!' on the screen and serial monitor, and then continuously increments and displays a counter on both the screen and serial monitor every second.

```cpp
#include <M5Unified.h>

// global variables (define variables to be used throughout the program)
uint32_t count;

// setup function is executed only once at startup.
// This function mainly describes the initialization process.
void setup()
{
    auto cfg = M5.config();  // Assign a structure for initializing M5Stack
    // If config is to be set, set it here
    // Example.
    // cfg.external_spk = true;

    M5.begin(cfg);  // initialize M5 device

    M5.Display.setTextSize(3);           // change text size
    M5.Display.print("Hello World!!!");  // display Hello World! and one line is displayed on the screen
    Serial.println("Hello World!!!");    // display Hello World! and one line on the serial monitor
    count = 0;                           // initialize count
}

// loop function is executed repeatedly for as long as it is running.
// loop function acquires values from sensors, rewrites the screen, etc.
void loop()
{
    M5.Display.setCursor(0, 20);              // set character drawing coordinates (cursor position)
    M5.Display.printf("COUNT: %d\n", count);  // display count on screen
    Serial.printf("COUNT: %d\n", count);      // display count serially
    count++;                                  // increase count by 1
    delay(1000);                              // wait 1 second(1,000msec)
}
```

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

### Prepare Immich Environment

Source: https://docs.m5stack.com/en/guide/ai_accelerator/llm-8850/m5_llm_8850_immich

Unzip the deployment files and copy the example environment configuration to create the actual environment file.

```bash
unzip docker-deploy.zip
cp example.env .env
```

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

### M5DinMeter Encoder Test Example

Source: https://docs.m5stack.com/en/arduino/m5dinmeter/encoder

This Arduino sketch demonstrates how to read and display encoder values on the M5DinMeter. It includes setup for the display, reading encoder position, and handling button presses for reset and setting encoder values. Ensure M5GFX and M5Unified libraries are installed.

```cpp
/**
 * @file encoder.ino
 * @author SeanKwok (shaoxiang@m5stack.com)
 * @brief M5DinMeter Encoder Test
 * @version 0.1
 * @date 2024-03-07
 *
 *
 * @Hardwares: M5DinMeter
 * @Platform Version: Arduino M5Stack Board Manager v2.1.1
 * @Dependent Library:
 * M5GFX: https://github.com/m5stack/M5GFX
 * M5Unified: https://github.com/m5stack/M5Unified
 */

#include "M5DinMeter.h"

void setup() {
    auto cfg = M5.config();
    DinMeter.begin(cfg, true);
    DinMeter.Display.setRotation(1);
    DinMeter.Display.setTextColor(GREEN);
    DinMeter.Display.setTextDatum(middle_center);
    DinMeter.Display.setTextFont(&fonts::Orbitron_Light_32);
    DinMeter.Display.setTextSize(2);
}

long oldPosition = -999;

void loop() {
    DinMeter.update();
    long newPosition = DinMeter.Encoder.read();
    if (newPosition != oldPosition) {
        DinMeter.Speaker.tone(8000, 20);
        DinMeter.Display.clear();
        oldPosition = newPosition;
        Serial.println(newPosition);
        DinMeter.Display.drawString(String(newPosition),
                                    DinMeter.Display.width() / 2,
                                    DinMeter.Display.height() / 2);
    }
    if (DinMeter.BtnA.wasPressed()) {
        DinMeter.Encoder.readAndReset();
    }
    if (DinMeter.BtnA.pressedFor(5000)) {
        DinMeter.Encoder.write(100);
    }
}
```

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

### HTTP Client Setup

Source: https://docs.m5stack.com/en/arduino/projects/unit/unit_cat1_cn

Includes necessary libraries for HTTP communication and initializes the modem and network connection. Sets up the HTTP client with server details and port.

```cpp
#include <M5Unified.h>
#define TINY_GSM_MODEM_ML307  // Specify to use ML307 module; TinyGsm library adapts instruction set based on this macro, must be placed here
#include <TinyGsmClient.h>
#include <StreamDebugger.h>
#include <ArduinoHttpClient.h>

#define SerialMon        Serial             // MCU -> PC for log output
#define MONITOR_BAUDRATE 115200
#define SerialAT         Serial1            // MCU <-> ML307 module communication
#define ML307_BAUDRATE   115200
#define ML307_RESET      -1
#define MCU_TX           17
#define MCU_RX           18

// If you need to see log detail, you can open the following macro definition
// #define DUMP_AT_COMMANDS  
// If you need to debug, you can open the following macro definition in TinyGsmClientSIM7028.h line 13
// #define TINY_GSM_DEBUG Serial
#ifdef DUMP_AT_COMMANDS
StreamDebugger debugger(SerialAT, SerialMon);
TinyGsm modem(debugger);
#else
TinyGsm modem(SerialAT);
#endif

// Server details
const char server[]   = "api.m5stack.com";
const char resource[] = "/v1"; // API endpoint path
const int port        = 80;    // HTTP port
TinyGsmClient client(modem); // Create TCP client based on TinyGsm (HTTP relies on TCP connection)
HttpClient http(client, server, port); // Create HTTP client instance (specify TCP client, server and port)

void modemConnect(void);// Initialize ML307 module and establish network connection

```

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

### M5Station RTC Setup and Time Display Example

Source: https://docs.m5stack.com/en/arduino/m5station/rtc

This example demonstrates initializing the RTC, connecting to WiFi, synchronizing time with an NTP server, setting the RTC, and then continuously displaying both RTC and ESP32 internal timer times (UTC and local). Ensure your WiFi credentials and timezone are correctly set.

```cpp
#if defined(ARDUINO)
#define WIFI_SSID     "YOUR WIFI SSID NAME"
#define WIFI_PASSWORD "YOUR WIFI PASSWORD"
#define NTP_TIMEZONE  "UTC-8"
#define NTP_SERVER1   "0.pool.ntp.org"
#define NTP_SERVER2   "1.pool.ntp.org"
#define NTP_SERVER3   "2.pool.ntp.org"
#include <WiFi.h>

// Different versions of the framework have different SNTP header file names and availability.
#if __has_include (<esp_sntp.h>)
#include <esp_sntp.h>
#define SNTP_ENABLED 1
#elif __has_include (<sntp.h>)
#include <sntp.h>
#define SNTP_ENABLED 1
#endif

#endif

#ifndef SNTP_ENABLED
#define SNTP_ENABLED 0
#endif

#include <M5Unified.h>

void setup(void) {
  M5.begin();
  Serial.begin(115200);

  M5.Display.setRotation(1);
  M5.Display.setTextFont(&fonts::FreeMonoBold9pt7b);
  if (!M5.Rtc.isEnabled()) {
    Serial.println("RTC not found.");
    M5.Display.println("RTC not found.");
    for (;;)
      {
        vTaskDelay(500);
      }
  }

  Serial.println("RTC found.");
  M5.Display.println("RTC found.\n");

  // It is recommended to set UTC for the RTC and ESP32 internal clocks.
  // setup RTC ( direct setting )
  ////                       YYYY  MM  DD      hh  mm  ss
  // M5.Rtc.setDateTime( { { 2021, 12, 31 }, { 12, 34, 56 } } );
  // setup RTC ( NTP auto setting )

  M5.Display.print("WiFi:");
  WiFi.begin(WIFI_SSID, WIFI_PASSWORD);
  while (WiFi.status() != WL_CONNECTED) {
    Serial.print('.');
    delay(500);
  }
  Serial.println("\r\n WiFi Connected.");
  M5.Display.print("Connected.");

  configTzTime(NTP_TIMEZONE, NTP_SERVER1, NTP_SERVER2, NTP_SERVER3);

#if SNTP_ENABLED
  while (sntp_get_sync_status() != SNTP_SYNC_STATUS_COMPLETED) {
    Serial.print('.');
    delay(1000);
  }
#else
  delay(1600);
  struct tm timeInfo;
  while (!getLocalTime(&timeInfo, 1000)) {
    Serial.print('.');
  };
#endif

  Serial.println("\r\n NTP Connected.");

  time_t t = time(nullptr) + 1;  // Advance one second.
  while (t > time(nullptr));     // Synchronization in seconds
  M5.Rtc.setDateTime(gmtime(&t));
  M5.Display.clear();
}

void loop(void) {
  static constexpr const char* const wd[7] = { "Sun", "Mon", "Tue", "Wed", "Thr", "Fri", "Sat" };

  delay(500);

  //RTC chip
  auto dt = M5.Rtc.getDateTime();
  Serial.printf("RTC   UTC  :%04d/%02d/%02d (%s)  %02d:%02d:%02d\r\n", dt.date.year, dt.date.month, dt.date.date,
                wd[dt.date.weekDay], dt.time.hours, dt.time.minutes, dt.time.seconds);
  M5.Display.setCursor(0, 0);
  M5.Display.printf("RTC   UTC  :%04d/%02d/%02d (%s)  %02d:%02d:%02d", dt.date.year, dt.date.month, dt.date.date,
                    wd[dt.date.weekDay], dt.time.hours, dt.time.minutes, dt.time.seconds);

  /// ESP32 internal timer
  auto t = time(nullptr);
  {
    auto tm = gmtime(&t);  // for UTC.
    Serial.printf("ESP32 UTC  :%04d/%02d/%02d (%s)  %02d:%02d:%02d\r\n", tm->tm_year + 1900, tm->tm_mon + 1,
                  tm->tm_mday, wd[tm->tm_wday], tm->tm_hour, tm->tm_min, tm->tm_sec);
    M5.Display.setCursor(0, 40);
    M5.Display.printf("ESP32 UTC  :%04d/%02d/%02d (%s)  %02d:%02d:%02d", tm->tm_year + 1900, tm->tm_mon + 1,
                      tm->tm_mday, wd[tm->tm_wday], tm->tm_hour, tm->tm_min, tm->tm_sec);
  }

  {
    auto tm = localtime(&t);  // for local timezone.
    Serial.printf("ESP32 %s:%04d/%02d/%02d (%s)  %02d:%02d:%02d\r\n", NTP_TIMEZONE, tm->tm_year + 1900,
                  tm->tm_mon + 1, tm->tm_mday, wd[tm->tm_wday], tm->tm_hour, tm->tm_min, tm->tm_sec);
    M5.Display.setCursor(0, 80);
    M5.Display.printf("ESP32 %s:%04d/%02d/%02d (%s)  %02d:%02d:%02d", NTP_TIMEZONE, tm->tm_year + 1900,
                      tm->tm_mon + 1, tm->tm_mday, wd[tm->tm_wday], tm->tm_hour, tm->tm_min, tm->tm_sec);
  }
}

```

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

### Skip Skills Installation

Source: https://docs.m5stack.com/en/stackflow/ai_pyramid/openclaw

Choose 'No' if you do not wish to install Skills at the current stage of the OpenClaw setup.

```bash
◆ Configure skills now? (recommended)
│ ○ Yes / ● No
```

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

### M5Tough SD Card Initialization and File Operations

Source: https://docs.m5stack.com/en/arduino/m5tough/sdcard

This example demonstrates initializing the SD card, writing to a text file, and checking for the presence of PNG files. It requires the M5Unified and M5GFX libraries and specific board manager versions.

```cpp
#include <Arduino.h>
#include <SPI.h>
#include <SD.h>
#include <M5Unified.h>
#include <M5GFX.h>

#define SD_SPI_CS_PIN    4
#define SD_SPI_SCK_PIN  18
#define SD_SPI_MOSI_PIN 23
#define SD_SPI_MISO_PIN 38

void setup() {
  M5.begin();

  M5.Display.setRotation(1);
  M5.Display.setFont(&fonts::FreeMono12pt7b);

  // SD Card Initialization
  SPI.begin(SD_SPI_SCK_PIN, SD_SPI_MISO_PIN, SD_SPI_MOSI_PIN, SD_SPI_CS_PIN);
  if (!SD.begin(SD_SPI_CS_PIN, SPI, 25000000)) {
    // Print a message if SD card initialization failed or if the SD card does not exist.
    M5.Display.print("\n SD card not detected\n");
    while (1)
      ;
  } else {
    M5.Display.print("\n SD card detected\n");
  }
  delay(1000);

  // Write TXT file
  M5.Display.print("\n SD card write test...\n");
  auto file = SD.open("/WriteTest.txt", FILE_WRITE, true);
  if (file) {
    file.print("Hello, world! \nSD card write success! \n");
    file.close();
    M5.Display.print(" SD card write success\n");
  } else {
    M5.Display.print(" Failed to create TXT file\n");
  }
  delay(1000);

  M5.Display.print("\n SD card read test...\n");
  if (SD.open("/TestPicture01.png", FILE_READ, false)) {
    M5.Display.print(" PNG file 01 detected\n");
  } else {
    M5.Display.print(" PNG file 01 not detected\n");
  }
  if (SD.open("/TestPicture02.png", FILE_READ, false)) {
    M5.Display.print(" PNG file 02 detected\n");
  } else {
    M5.Display.print(" PNG file 02 not detected\n");
  }
  delay(1000);
}

void loop() {
  // Read PNG file and draw picture
  M5.Display.drawPngFile(SD, "/TestPicture01.png");
  delay(500);
  M5.Display.drawPngFile(SD, "/TestPicture02.png");
  delay(500);
}
```

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

### Get XYZ Value AHRS Example (Arduino)

Source: https://docs.m5stack.com/en/unit/IMU Pro Mini Unit

This Arduino example demonstrates how to get XYZ values using the AHRS (Attitude and Heading Reference System) algorithm from the Unit Mini IMU-Pro. This provides orientation data.

```cpp
#include <M5_IMU_Pro.h>

M5_IMU_Pro IMU;

void setup() {
  Serial.begin(115200);
  Wire.begin();
  IMU.begin();
  IMU.set_ahrs_enable(true);
}

void loop() {
  IMU.get_ahrs_data();
  Serial.printf("Roll: %f Pitch: %f Yaw: %f\n", IMU.roll, IMU.pitch, IMU.yaw);
  delay(100);
}
```

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

### Launch core-config Tool

Source: https://docs.m5stack.com/en/guide/linux/coremp135/fdisk

Use the `core-config` utility to manage device configurations, including partition expansion.

```bash
core-config
```

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

### Arduino DAC Example

Source: https://docs.m5stack.com/en/unit/dac

This example demonstrates how to use the Unit DAC with the Arduino IDE. Ensure the M5Stack library is installed.

```cpp
#include <M5Stack.h>
#include <DAC_MCP4725.h>

DAC_MCP4725 dac;

void setup() {
  M5.begin();
  dac.begin();
}

void loop() {
  // Set DAC output to 1.5V (half of 3.3V range)
  dac.setVoltage(1.5);
  delay(1000);

  // Set DAC output to 3.0V
  dac.setVoltage(3.0);
  delay(1000);
}
```

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

### begin

Source: https://docs.m5stack.com/en/arduino/m5unified/led_class

Initializes the LED hardware. This method must be called before any other LED operations can be performed.

```APIDOC
## begin

### Description
Initializes the LED hardware. This method must be called before any other LED operations can be performed.

### Syntax
```cpp
bool begin(void);
```

### Parameters
- null

### Return
- **bool**: `true` if initialization succeeded, `false` otherwise.
```

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

### Arduino LoRaDuplex Example

Source: https://docs.m5stack.com/en/module/lora868

This Arduino sketch implements a full-duplex LoRa communication example. Ensure the M5-SX127x library is installed.

```cpp
#include "M5Stack.h"
#include "LoRa_IO.h"

void setup() {
  M5.begin();
  M5.Power.begin();
  Serial.begin(115200);
  LoRa_IO.begin();
  LoRa_IO.set_frequency(868);
  Serial.println("LoRa Duplex Start");
}

void loop() {
  int packetSize = LoRa_IO.parse_packet();
  if (packetSize) {
    String packet = LoRa_IO.read_string();
    Serial.println(packet);
  }
  LoRa_IO.send_data("Hello World", 11);
  delay(5000);
}
```

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

### Basic Scanning Example with M5ModuleQRCode

Source: https://docs.m5stack.com/en/arduino/projects/module/module13.2_qrcode

This example initializes the M5ModuleQRCode, sets communication pins and baud rate, configures light and trigger modes, and handles button presses to start/stop scanning. It displays decoded results on the screen. Ensure correct DIP switch settings for your host board.

```cpp
#include <Arduino.h>
#include <M5Unified.h>
#include <M5ModuleQRCode.h>

M5ModuleQRCode module_qrcode;

void setup()
{
    M5.begin();
    M5.Display.setFont(&fonts::efontCN_16);
    M5.Display.setTextScroll(true);

    /* Set module config */
    auto cfg     = module_qrcode.getConfig();
    cfg.pin_tx   = 12;
    cfg.pin_rx   = 34;
    cfg.baudrate = 115200;
    cfg.serial   = &Serial1;
    module_qrcode.setConfig(cfg);

    /* Init module */
    while (!module_qrcode.begin()) {
        M5.Display.setTextColor(TFT_RED);
        M5.Display.println(">> Init module failed, retry...");
        delay(1000);
    }
    M5.Display.setTextColor(TFT_WHITE);
    M5.Display.println(">> Init module success");

    /* Set light mode */
    M5.Display.println(">> Set lights mode");
    module_qrcode.setFillLightMode(QRCodeM14::FILL_LIGHT_ON_DECODE);
    module_qrcode.setPosLightMode(QRCodeM14::POS_LIGHT_ON_DECODE);

    /* Set trigger mode */
    M5.Display.println(">> Set trigger mode to continuous");
    module_qrcode.setTriggerMode(QRCodeM14::TRIGGER_MODE_CONTINUOUS);
    module_qrcode.stopDecode();

    M5.Display.println(">> Click BtnA to toggle scanning");
}

void loop()
{
    M5.update();

    static bool is_scanning = false;

    /* If BtnA was clicked */
    if (M5.BtnA.wasClicked()) {
        is_scanning = !is_scanning;

        if (is_scanning) {
            module_qrcode.startDecode();
        } else {
            module_qrcode.stopDecode();
        }

        M5.Display.setTextColor(TFT_WHITE);
        M5.Display.println(is_scanning ? ">> Start scanning..." : ">> Stop scanning");
    }

    /* Update module */
    module_qrcode.update();

    /* If scan result available */
    if (module_qrcode.available()) {
        auto result = module_qrcode.getScanResult();

        /* Display result */
        M5.Display.setTextColor(TFT_WHITE);
        M5.Display.println(">> Get code:");
        M5.Display.setTextColor(TFT_YELLOW);
        M5.Display.println(result.c_str());
    }
}
```

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

### Arduino LoRaSender Example

Source: https://docs.m5stack.com/en/module/lora

This example demonstrates how to send data using the LoRa module. Ensure the LoRa library is installed.

```arduino
#include "LoRa.h"

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

  Serial.println("LoRa Sender");

  if (!LoRa.begin(433E6)) {
    Serial.println("Starting LoRa failed!");
    while (1);
  }
}

void loop() {
  Serial.print("Sending packet: ");
  Serial.println(i);

  LoRa.beginPacket();
  LoRa.print("hello ");
  LoRa.print(i);
  LoRa.endPacket();

  i++;

  delay(5000);
}
```

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

### M5.begin() Parameters in Older Libraries

Source: https://docs.m5stack.com/en/arduino/m5unified/migration

Illustrates the device-specific parameters used with M5.begin() in earlier driver libraries for different M5Stack products.

```cpp
// M5Stack
M5.begin(bool LCDEnable = true, bool SDEnable = true, bool SerialEnable = true, bool I2CEnable = false);

// M5Core2
M5.begin(bool LCDEnable = true, bool SDEnable = true, bool SerialEnable = true, bool I2CEnable = false, mbus_mode_t mode = KMBusModeOutput);

// M5StickC
M5.begin(bool LCDEnable = true, bool PowerEnable = true, bool SerialEnable = true);

// M5StickCPlus
M5.begin(bool LCDEnable = true, bool PowerEnable = true, bool SerialEnable = true);

// M5Atom
M5.begin(bool SerialEnable = true, bool I2CEnable = true, bool DisplayEnable = false);
```

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

### Arduino Example for Module LTE

Source: https://docs.m5stack.com/en/module/lte

This example demonstrates how to use the Module LTE with an M5Core. It requires the appropriate libraries to be installed.

```arduino
#include "M5Stack.h"
#include "LTE.h"

void setup() {
  M5.begin();
  M5.Power.begin();
  Serial.begin(115200);
  
  // Initialize LTE module
  LTE_Init(115200, &Serial);
  
  Serial.println("LTE Module Initialized.");
}

void loop() {
  // Your loop code here
  delay(1000);
}
```

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

### SD Card Initialization and PNG Drawing Example

Source: https://docs.m5stack.com/en/arduino/m5gfx/m5gfx_image

This sample program demonstrates how to initialize an SD card and draw PNG images from it using M5GFX. It includes necessary includes for SD card operations and M5Unified.

```cpp
#include <Arduino.h>
#include <SPI.h>
#include <SD.h>
#include <M5Unified.h>
#include <M5GFX.h>

#define SD_SPI_CS_PIN   4
#define SD_SPI_SCK_PIN  18
#define SD_SPI_MISO_PIN 38
#define SD_SPI_MOSI_PIN 23

void setup() {
  M5.begin();

  M5.Display.setTextFont(&fonts::Orbitron_Light_24);
  M5.Display.setTextSize(1);

  // SD Card Initialization
  SPI.begin(SD_SPI_SCK_PIN, SD_SPI_MISO_PIN, SD_SPI_MOSI_PIN, SD_SPI_CS_PIN);
  if (!SD.begin(SD_SPI_CS_PIN, SPI, 25000000)) {
    // Print a message if SD card initialization failed or if the SD card does not exist.
    M5.Display.print("\n SD card not detected\n");
    while (1)
      ;
  } else {
    M5.Display.print("\n SD card detected\n");
  }
  delay(1000);

  M5.Display.print("\n SD card read test...\n");
  if (SD.open("/TestPicture01.png", FILE_READ, false)) {
    M5.Display.print(" PNG file 01 detected\n");
  } else {
    M5.Display.print(" PNG file 01 not detected\n");
  }
  if (SD.open("/TestPicture02.png", FILE_READ, false)) {
    M5.Display.print(" PNG file 02 detected\n");
  } else {
    M5.Display.print(" PNG file 02 not detected\n");
  }
}

void loop() {
  // Read image file and draw picture
  //         drawBmpFile
  //         drawJpgFile
  //         drawQoiFile
  M5.Display.drawPngFile(SD, "/TestPicture01.png");
  delay(1000);
  M5.Display.drawPngFile(SD, "/TestPicture02.png");
  delay(1000);
}
```

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

### Arduino Example for M5Core

Source: https://docs.m5stack.com/en/module/4relay

This example demonstrates how to use the 4-Relay Module with an M5Core. Ensure the M5Module-4Relay Arduino Library is installed.

```arduino
#include "M5Module_4Relay.h"

void setup() {
  M5.begin();
  M5.update();
  Relay.begin();
}

void loop() {
  Relay.set(0, RelayState::ON);
  delay(1000);
  Relay.set(0, RelayState::OFF);
  delay(1000);
  Relay.set(1, RelayState::ON);
  delay(1000);
  Relay.set(1, RelayState::OFF);
  delay(1000);
  Relay.set(2, RelayState::ON);
  delay(1000);
  Relay.set(2, RelayState::OFF);
  delay(1000);
  Relay.set(3, RelayState::ON);
  delay(1000);
  Relay.set(3, RelayState::OFF);
  delay(1000);
}
```

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

### ESP-NOW Initialization and Usage

Source: https://docs.m5stack.com/en/mpy/blockly/advanced/espnow

This snippet demonstrates the basic setup and usage of the ESP-NOW library. It covers initialization, setting the channel, getting the local MAC address, broadcasting messages, adding peers, sending messages to specific peers, and setting up callbacks for send and receive operations.

```python
import espnow

#  Initialization
espnow.init()

#  Set channel

#  Get local mac_addr
espnow.get_mac_addr()

#  Broadcast
espnow.broadcast(data='Hello')

#  Set peer list
espnow.add_peer(slave_mac_addr, id)

#  Send message
espnow.send(id, data='World')

#  Send message callback
def send_cb(flag):
  if flag:
    print('succeed')
  else:
    print('Failed')

espnow.send_cb(send_cb)

#  Receive message callback
def recv_cb():
    #  Get data
    sender_address, _, receive_data = espnow.recv_data(encoder='str')

espnow.recv_cb(recv_cb)
```

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

### Arduino RS485 Example

Source: https://docs.m5stack.com/en/hat/hat-rs485

Example code for using the RS485 HAT with Arduino. This snippet demonstrates basic communication setup.

```cpp
#include "M5StickC.h"
#include "RS485.h"

RS485 rs485;

void setup() {
    M5.begin();
    M5.Power.begin();
    Serial.begin(115200);
    rs485.begin(115200);
    pinMode(36, OUTPUT);
    pinMode(26, OUTPUT);
    digitalWrite(36, HIGH);
    digitalWrite(26, HIGH);
}

void loop() {
    // put your main code here, to run repeatedly:
    if (Serial.available()) {
        digitalWrite(36, LOW);
        digitalWrite(26, HIGH);
        delay(1);
        rs485.write(Serial.read());
        digitalWrite(36, HIGH);
        digitalWrite(26, LOW);
    }
    if (rs485.available()) {
        digitalWrite(36, HIGH);
        digitalWrite(26, LOW);
        delay(1);
        Serial.write(rs485.read());
        digitalWrite(36, LOW);
        digitalWrite(26, HIGH);
    }
}
```

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

### Arduino Test Example for Unit Mini CAN

Source: https://docs.m5stack.com/en/unit/Unit-Mini CAN

This example demonstrates how to use the Unit Mini CAN with an M5CoreS3. Ensure the library is installed before running.

```cpp
#include <M5EPD.h>
#include <Unit__CAN.h>

M5EPD display;

void setup() {
    Serial.begin(115200);
    display.begin();
    display.setRotation(1);
    display.fillScreen(EPD_WHITE);
    display.setTextSize(2);
    display.setCursor(10, 10);
    display.print("Unit Mini CAN Test");
    display.display();

    CAN_Unit.begin();
}

void loop() {
    CAN_Unit.sendMsg("Hello World");
    delay(1000);

    if (CAN_Unit.available()) {
        String data = CAN_Unit.read();
        Serial.print("Received: ");
        Serial.println(data);
        display.setCursor(10, 50);
        display.print("Received: ");
        display.println(data);
        display.display();
    }
    delay(1000);
}
```

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

### M5Core Basic/Gray Wakeup Example

Source: https://docs.m5stack.com/en/arduino/m5core/wakeup

This example demonstrates how to put the M5Core to sleep for a specified duration and wake it up using a button press. It initializes the M5Unified library, displays messages on the screen, and uses the Power.timerSleep() function for timed wake-up.

```cpp
#include <M5Unified.h>

void setup(void) {
  auto cfg = M5.config();
  M5.begin(cfg);

  M5.Display.setTextDatum(middle_center);
  M5.Display.setTextFont(&fonts::FreeSerifBold9pt7b);
  M5.Display.setTextSize(1);

  M5.Display.drawString("Press BtnA", M5.Display.width() / 2, M5.Display.height() / 2 - 20);
  M5.Display.drawString("to Sleep 5s", M5.Display.width() / 2, M5.Display.height() / 2 + 20);
}

void loop(void) {
  M5.update();

  if (M5.BtnA.wasPressed()) {
    M5.Display.clear();
    M5.Display.drawString("Sleep 5s", M5.Display.width() / 2, M5.Display.height() / 2 + 20);
    M5.Power.timerSleep(5);//sec
  }
}
```

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

### Arduino Example for Unit Color

Source: https://docs.m5stack.com/en/unit/COLOR

This example demonstrates how to use the Unit Color with the Arduino IDE. It requires the M5Stack library to be installed.

```cpp
#include <M5Stack.h>

void setup() {
  M5.begin();
  M5.Power.begin();
  Serial.begin(115200);
  M5.In_I2C.begin();
}

void loop() {
  uint8_t r, g, b, c;
  if (M5.UnitColor.getColor(r, g, b, c)) {
    Serial.printf("R:%d G:%d B:%d C:%d\n", r, g, b, c);
  } else {
    Serial.println("Failed to read color");
  }
  delay(500);
}
```

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

### StackChan Touch Sensor Example

Source: https://docs.m5stack.com/en/arduino/stackchan/touchsensor

This example program initializes the StackChan, sets up the display, and then continuously checks for touch sensor events like clicks and swipes. Ensure M5Stack Board Manager Version >= 3.3.7, Development Board Selection = M5CoreS3, and M5StackChan Library Version >= 1.0.0 are met for compilation.

```cpp
#include <M5StackChan.h>

void setup()
{
    /* Init StackChan */
    M5StackChan.begin();

    /* Setup display */
    M5StackChan.Display().setTextSize(2);
    M5StackChan.Display().setTextScroll(true);
    M5StackChan.Display().setTextColor(TFT_ORANGE);
    M5StackChan.Display().printf("> Touch or swipe the top\n");
    M5StackChan.Display().setTextColor(TFT_GREEN);
}

void loop()
{
    /* Update touch sensor */
    M5StackChan.update();

    auto& ts = M5StackChan.TouchSensor;

    if (ts.wasClicked()) {
        M5StackChan.Display().printf("> Was clicked\n");
    }

    if (ts.wasSwipedForward()) {
        M5StackChan.Display().printf("> Was swiped forward\n");
    }

    if (ts.wasSwipedBackward()) {
        M5StackChan.Display().printf("> Was swiped backward\n");
    }

    delay(50);
}
```

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

### Unit 4Relay Arduino Example with M5Atom

Source: https://docs.m5stack.com/en/unit/4relay

This example demonstrates how to use the Unit 4Relay with an M5Atom. Ensure the M5Unit-RELAY library is installed.

```arduino
#include "M5Unit_RELAY.h"

M5Unit_RELAY relay;

void setup() {
  Serial.begin(115200);
  Wire.begin();
  relay.begin();
}

void loop() {
  relay.setRelay(0, true);
  delay(1000);
  relay.setRelay(0, false);
  delay(1000);
  relay.setRelay(1, true);
  delay(1000);
  relay.setRelay(1, false);
  delay(1000);
  relay.setRelay(2, true);
  delay(1000);
  relay.setRelay(2, false);
  delay(1000);
  relay.setRelay(3, true);
  delay(1000);
  relay.setRelay(3, false);
  delay(1000);
}
```

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

### M5GFX Image Display Example

Source: https://docs.m5stack.com/en/arduino/m5gfx/m5gfx_image

Demonstrates initializing the M5GFX display, setting color depth and rotation, clearing the screen, and drawing text. It also shows how to generate and push image data using swap565, pushImage, pushImageAffineWithAA, pushImageRotateZoom, and pushImageRotateZoomWithAA.

```cpp
#include <Arduino.h>
#include <M5GFX.h>
#include <M5Unified.h>

M5GFX display;
uint16_t PngData[1600];
static float Affine_mat[9] = {1, 0, 0,
                              0, 1, 60,
                              0, 0, 1  };

void setup() {
    display.begin();
    display.setColorDepth(24);
    display.setRotation(1);
    display.clear(TFT_WHITE);
    display.setTextFont(&fonts::FreeSansOblique12pt7b);
    display.setTextColor(0xF81F);
    delay(1000);
    uint16_t x = display.width() / 2;
    uint16_t y = display.height() / 2;
    // display.setSwapBytes(true);//If you want to directly assign a 16-bit color code in the lower code section, you need to enable this line of code.
    for (int i = 0; i < 1600; ++i) PngData[i] = display.swap565( 255, 0, 0);//After swapping, it becomes BGR565.

    display.drawCenterString("Push Image Test", x, 10);
    delay(2000);
    display.pushImage(0, y, 320, 5, PngData);
    // display.pushImageDMA(0, y, 320, 5, PngData);
    // Shift 60 units from the origin(0,0) using the affine matrix
    // display.pushImageAffine(Affine_mat, 320, 5, PngData, 80);
    display.pushImageAffineWithAA(Affine_mat, 320, 5, PngData, 40);
    // Rotate and Zoom, by comparing on the screen, you can see the effect of anti-aliasing.
    display.pushImageRotateZoom(x, y, 0, 0, 37, 2, 2, 320, 5, PngData);
    display.pushImageRotateZoomWithAA(x, y, 0, 4, 143, 2, 2, 320, 5, PngData);
}

void loop() {
}
```

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

### Arduino Servo Module Example

Source: https://docs.m5stack.com/en/module/servo

This example demonstrates how to use the Module Servo with an M5Core in Arduino. Ensure the M5Stack library is installed.

```cpp
#include <M5Stack.h>
#include <Servo.h>

Servo myservo;

void setup() {
  M5.begin();
  M5.Power.begin();
  myservo.attach(13, 0, 180, 500, 2500, 1500); // servo channel, min angle, max angle, min pulse, max pulse, initial angle
}

void loop() {
  myservo.write(90);
  delay(1000);
  myservo.write(0);
  delay(1000);
  myservo.write(180);
  delay(1000);
}
```

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

### Module13.2 Display Arduino Example

Source: https://docs.m5stack.com/en/module/Display Module 13.2

This snippet provides an example of how to use the Module13.2 Display with Arduino. Ensure you have the necessary libraries installed.

```arduino
// Placeholder for Arduino code example
// Actual code would go here to demonstrate usage of Module13.2 Display
```
Tokens:
Raw