{"id":15030980,"url":"https://github.com/m5stack/m5stack","last_synced_at":"2025-04-12T04:40:40.573Z","repository":{"id":37663784,"uuid":"89710200","full_name":"m5stack/M5Stack","owner":"m5stack","description":"M5Stack Arduino Library","archived":false,"fork":false,"pushed_at":"2025-01-16T09:24:46.000Z","size":12448,"stargazers_count":1269,"open_issues_count":30,"forks_count":442,"subscribers_count":123,"default_branch":"master","last_synced_at":"2025-04-05T02:01:37.167Z","etag":null,"topics":["arduino-esp32","m5stack","m5stick"],"latest_commit_sha":null,"homepage":null,"language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/m5stack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-04-28T13:47:48.000Z","updated_at":"2025-04-01T14:43:27.000Z","dependencies_parsed_at":"2023-02-16T03:30:56.657Z","dependency_job_id":"3a6b58d8-57b1-453c-917e-8779abf58349","html_url":"https://github.com/m5stack/M5Stack","commit_stats":{"total_commits":560,"total_committers":59,"mean_commits":9.491525423728813,"dds":0.6928571428571428,"last_synced_commit":"04bc51fdb70968172fe0dc39cd41f2dbf6695647"},"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m5stack%2FM5Stack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m5stack%2FM5Stack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m5stack%2FM5Stack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m5stack%2FM5Stack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/m5stack","download_url":"https://codeload.github.com/m5stack/M5Stack/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248519095,"owners_count":21117756,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["arduino-esp32","m5stack","m5stick"],"created_at":"2024-09-24T20:14:39.433Z","updated_at":"2025-04-12T04:40:40.544Z","avatar_url":"https://github.com/m5stack.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# M5Stack Library\n\n[![Arduino Lint](https://github.com/m5stack/M5Stack/actions/workflows/Arduino-Lint-Check.yml/badge.svg)](https://github.com/m5stack/M5Stack/actions/workflows/Arduino-Lint-Check.yml)\n[![Clang Format](https://github.com/m5stack/M5Stack/actions/workflows/clang-format-check.yml/badge.svg)](https://github.com/m5stack/M5Stack/actions/workflows/clang-format-check.yml)\n\nEnglish | [中文](docs/getting_started_cn.md) | [日本語](docs/getting_started_ja.md)\n\nThe M5Stack library provides access to the built-in hardware of the M5Stack Core (including Basic and Gray) controllers.\n\n## Recommendation\n**\u003cspan style=\"font-size: larger\"\u003eThis library is not recommended for new projects, nor for projects using M5Stack products other than _Basic_ and _Gray_.  See [M5Unified](https://github.com/M5Stack/M5Unified) and [M5GFX](https://github.com/M5Stack/M5GFX) for libraries that are more up-to-date and with support for many newer M5Stack products.\u003c/span\u003e**\n\n## Usage\nThis library's functionality is available through the M5Stack class, referenced as `M5`, including:\n- LCD display via `M5.Lcd`, a customized version of the [TFT_eSPI](https://github.com/Bodmer/TFT_eSPI) LCD library, adapted for Basic and Gray.  The display resolution is 320x240 supporting 262K colors.  Several fonts, graphics primitives, QR code rendering, and PNG/BMP/JPEG support are included.\n- Power control, including device shutoff and battery level detection via `M5.Power` and the IP5306 power management chip\n- Hardware buttons via `M5.BtnA`, `M5.BtnB`, `M5.BtnC`\n- Speaker, via `M5.Speaker`, supporting tones, volume control, and basic wave audio playback using ESP32's DAC function\n- Accelerometer, via `M5.Imu`, `M5.Mpu6886`, or `M5.Sh200Q` (accelerometer type depends on version of Basic/Gray) \n\nTo use the M5Stack library, `#include \"M5Stack.h\"` must appear at the top of your sketch.\n\nThe most productive way to become acquainted with the class is through the numerous included examples.  Additional documentation within this library:\n- [docs/Power_capabilities.md](docs/Power_capabilities.md)\n\nAdditional optional include files:\n- `M5Faces.h` for access to M5Stack Faces accessories (EOL)\n- `LoRaWan.h`\n\n\u003cimg src=\"https://static-cdn.m5stack.com/resource/docs/products/core/basic/basic_01.webp\" alt=\"basic\" width=\"350\" height=\"350\"\u003e\u003cimg src=\"https://static-cdn.m5stack.com/resource/docs/products/core/gray/gray_01.webp\" alt=\"gray\" width=\"350\" height=\"350\"\u003e\n\n* **Hardware documentation for [Gray v1.0 (EOL)](https://docs.m5stack.com/en/core/gray)**\n\n* **Hardware documentation for [Basic v1.0 (EOL)](https://docs.m5stack.com/en/core/basic)  [Basic v2.6 (EOL)](https://docs.m5stack.com/en/core/basic_v2.6)  [Basic v2.7](https://docs.m5stack.com/en/core/basic_v2.7)**.  The version number may be printed on the main circuit board next to the SD card slot.\n\n* **[Buy Basic](https://shop.m5stack.com/products/esp32-basic-core-iot-development-kit-v2-7)**\n\n*[Comparison of M5Stack controllers](https://docs.m5stack.com/en/products_selector/m5core_compare)*\n\n### M-BUS\n\u003cimg src=\"docs/M-BUS.jpg\" width=\"300\" /\u003e\n\n## More Information\n\n**UIFlow Quick Start**: [Click Here](https://docs.m5stack.com/en/quick_start/m5core/uiflow)\n\n**MicroPython API**: [Click Here](https://docs.m5stack.com/en/mpy/display/m5stack_lvgl)\n\n**Arduino IDE Development**: [Click Here](https://docs.m5stack.com/en/quick_start/m5core/arduino)\n\n**Gray PinMap**: [Click Here](https://docs.m5stack.com/en/core/gray)\n\n**Basic PinMap**: [v1.0 (EOL)](https://docs.m5stack.com/en/core/basic)  [v2.6 (EOL)](https://docs.m5stack.com/en/core/basic_v2.6)  [v2.7](https://docs.m5stack.com/en/core/basic_v2.7)**\n\n## USER CASES\n\n* [M5Stack-SD-Updater](https://github.com/tobozo/M5Stack-SD-Updater) - Customizable menu system for M5Stack - loads apps from the Micro SD\n  card\n\n* [M5StackSAM](https://github.com/tomsuch/M5StackSAM) - Simple Applications Menu Arduino Library for M5Stack\n\n* [cfGUI](https://github.com/JF002/cfGUI) - A simple GUI library for M5Stack (ESP32)\n\n* [GUIslice](https://github.com/ImpulseAdventure/GUIslice) - A lightweight GUI framework suitable for embedded displays\n\n* [M5ez](https://github.com/M5ez/M5ez) - The easy way to program on the M5Stack\n\n* [M5Stack MultiApp Advanced](https://github.com/botofancalin/M5Stack-MultiApp-Advanced) - A M5Stack firmware made on PlatformIO\n\n* [M5Stack ESP32 Oscilloscope](https://github.com/botofancalin/M5Stack-ESP32-Oscilloscope) - A fully functional oscilloscope based on ESP32 M5Stack\n\n* [M5Stack-Avatar](https://github.com/meganetaaan/m5stack-avatar) - An M5Stack library for rendering avatar faces\n\n* [M5Stack_CrackScreen](https://github.com/nomolk/M5Stack_CrackScreen) - Crack your M5Stack\n\n* [M5_Shuttle_Run](https://github.com/n0bisuke/M5_Shuttle_Run) - M5_Shuttle_Run\n\n* [nixietubeM5](https://github.com/drayde/nixietubeM5) - (Fake) Nixie Tube Display on a M5Stack\n\n* [M5Stack_BTCTicker](https://github.com/dankelley2/M5Stack_BTCTicker) - A small Bitcoin price ticker using an M5Stack (ESP32) and the Coindesk API\n\n* [M5Stack_ETHPrice](https://github.com/donma/M5StackWifiSettingWithETHPrice) - Dependence on example Wifi Setting to get ETH Price from Maicoin\n\n* [M5Stack-PacketMonitor](https://github.com/tobozo/M5Stack-PacketMonitor) - M5Stack ESP32 Packet Monitor\n\n* [M5-FFT](https://github.com/ElectroMagus/M5-FFT) - Graphic Equalizer on the M5Stack platform\n\n* [M5Stack_ESP32_radio](https://github.com/anton-b/M5Stack_ESP32_radio) - Playing mp3 stream out of internet using M5Stack prototype\n\n* [mp3-player-m5stack](https://github.com/dsiberia9s/mp3-player-m5stack) - MP3 player for M5Stack\n\n* [ArduinoWiFiPhotoBackup](https://github.com/moononournation/ArduinoWiFiPhotoBackup) - M5STACK Arduino WiFi Photo Backup device\n\n* [M5StackHIDCtrlAltDel](https://github.com/mhama/M5StackHIDCtrlAltDel) - You can send ctrl+alt+del to your PC via Bluetooth from M5Stack\n\n* [M5Stack Markdown Web Server](https://github.com/PartsandCircuits/M5Stack-MarkdownWebServer) - Markdown \u0026 icons loaded from an Micro SD card/TF card to run a web page\n\n* [M5Stack-Tetris](https://github.com/PartsandCircuits/M5Stack-Tetris) - Tetris for M5Stack Ported to M5Stack by macsbug - https://macsbug.wordpress.com/\n\n* [M5Stack_FlappyBird_game](https://github.com/pcelli85/M5Stack_FlappyBird_game) - M5Stack FlappyBird Playable\n\n* [M5Stack-SpaceShooter](https://github.com/PartsandCircuits/M5Stack-SpaceShooter) - Space Invaders knock-off for M5Stack\n\n* [M5Stack-Pacman-JoyPSP](https://github.com/tobozo/M5Stack-Pacman-JoyPSP) - Pacman on M5Stack/PSP Joypad, with sounds\n\n* [M5Stack-Thermal-Camera](https://github.com/hkoffer/M5Stack-Thermal-Camera-) - M5Stack Thermal Camera with AMG8833 thermal sensor\n\n* [truetype2gfx](https://github.com/ropg/truetype2gfx) - Converting fonts from TrueType to Adafruit GFX\n\n* [m5stack-onscreen-keyboard](https://github.com/yellowelise/m5stack-onscreen-keyboard) - Full size qwerty keyboard for M5Stack\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm5stack%2Fm5stack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fm5stack%2Fm5stack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm5stack%2Fm5stack/lists"}