Skip to content

Latest commit

 

History

History
119 lines (86 loc) · 5.61 KB

README.md

File metadata and controls

119 lines (86 loc) · 5.61 KB
Raw

ESP32-Chimera-Core Library

arduino-library-badge PlatformIO Registry Arduino Build Platformio Build

Illustration By Jacopo Ligozzi

This library is a substitute of the original M5Stack library, with added support for the following devices:

It also implements a set of extra features:

  • Zero-config automatic device selection based on the Arduino Boards menu selection
  • Screenshots (BMP, JPG, PNG, GIF)
  • I2C Scanner

GFX implementation is a courtesy of @lovyan03 who (in the first days of this library) did a marvelous work of integrating his LovyanGFX library into his own ESP32-Chimera-Core fork. Since then, LovyanGFX has become an external dependency of this library and even given birth to M5Unified which has the same spirit as Chimera-Core but focuses on M5 products only.

LovyanGFX is an optimized display driver maintained by @lovyan03, it brings an average 30% speed improvement compared to other drivers along with more flexibility towards adding custom boards.

This library will forever be beta quality, but the tradeoff is really worth it!

See LovyanGFX Readme for an overview of those minor changes along with the new features such as shapes, arcs, polygon drawing and filling, and much more ...

Usage

Choose between managed install:

  • Get ESP32-Chimera-Core from the Arduino Library Manager
  • Let the Arduino Library Manager download the LovyanGFX library dependency

or manual install:

Developers

Replace this:

  #include <M5Stack.h>

by this:

  #include <ESP32-Chimera-Core.h>

You can use #if defined(_CHIMERA_CORE_) macros to isolate ESP32-Chimera-Core specific statements.

  #if defined(_CHIMERA_CORE_)
    M5.ScreenShot->init( &M5.Lcd, M5STACK_SD );
    M5.ScreenShot->begin();
    M5.ScreenShot->snap();
  #endif

Automatic board selection is based on the boards.txt definition, so changing the board from the Arduino Tools menu is enough to trigger the detection. Sketch compilation can eventually be tuned-up to a specific device by using macros.

  #if defined(_CHIMERA_CORE_)
    #if defined( ARDUINO_M5Stack_Core_ESP32 )
      #warning M5STACK CLASSIC DETECTED !!
    #elif defined( ARDUINO_M5STACK_FIRE )
      #warning M5STACK FIRE DETECTED !!
    #elif defined( ARDUINO_ODROID_ESP32 )
      #warning ODROID DETECTED !!
    #elif defined( ARDUINO_TTGO_T1 )
      #warning Lilygo TTGO-TS DETECTED !!
    #elif defined ( ARDUINO_ESP32_WROVER_KIT )
      #warning ESP32 WROVER Kit DETECTED !!
    #else
      #warning NOTHING DETECTED !!
    #endif
  #else
    #warning M5Stack legacy core detected
  #endif

Credits & Thanks