codywon/M5Stack

M5Stack Arduino Library

M5Stack Library

Arduino Library for M5Stack Electronic Modules

How to use:

1. Download the source from the git https://github.com/m5stack/M5Stack

2. copy the M5Stack folder to your arduino default library. Your Arduino library folder should now look like this
   (on Windows): [arduino installation directory] Arduino\libraries
   (on MACOS): [arduino Package Contents] ~/Documents/Arduino/libraries/

3. Open the Arduino Application. (If it's already open, you will need to restart it to see changes.)

4. Click "File-> Examples". Here are some test programs in "M5Stack->"

5. Depending on the type of board you're using, you need to modify the header file to match. For example, if you're using a M5Stack. You just #include <M5Stack.h>

Arduino core for ESP32 install Instructions

1. Install the SiLabs CP2104 Driver

• Download the SiLabs CP2104 Driver

2. Using through Arduino IDE

Instructions for Windows

Instructions for Mac

• Install latest Arduino IDE from arduino.cc

• Open Terminal and execute the following command (copy->paste and hit enter):

  mkdir -p ~/Documents/Arduino/hardware/espressif && \
  cd ~/Documents/Arduino/hardware/espressif && \
  git clone https://github.com/espressif/arduino-esp32.git esp32 && \
  cd esp32/tools/ && \
  python get.py && \
  cd ~/Documents/Arduino/libraries && \
  git clone https://github.com/m5stack/M5Stack.git

• Restart Arduino IDE

Instructions for Debian/Ubuntu Linux

• Install latest Arduino IDE from arduino.cc

• Open Terminal and execute the following command (copy->paste and hit enter):

  sudo usermod -a -G dialout $USER && \
  sudo apt-get install git && \
  wget https://bootstrap.pypa.io/get-pip.py && \
  sudo python get-pip.py && \
  sudo pip install pyserial && \
  mkdir -p ~/Arduino/hardware/espressif && \
  cd ~/Arduino/hardware/espressif && \
  git clone https://github.com/espressif/arduino-esp32.git esp32 && \
  cd esp32/tools/ && \
  python get.py && \
  cd ~/Arduino/libraries && \
  git clone https://github.com/m5stack/M5Stack.git

• Restart Arduino IDE

Installing with Boards Manager(beta)

Starting with 1.6.4, Arduino allows installation of third-party platform packages using Boards Manager. We have packages available for Windows, Mac OS, and Linux (32 and 64 bit).

• Install Arduino 1.8.2 from the Arduino website.
• Start Arduino and open Preferences window.
• Enter http://www.m5stack.com/download/package_m5stack_index.json into Additional Board Manager URLs field. You can add multiple URLs, separating them with commas.
• Open Boards Manager from Tools > Board menu and install ESP32 platform (and don't forget to select your ESP32 board from Tools > Board menu after installation).