Skip to content

Dlazder/m5stick_crystal_firmware

Repository files navigation

M5Stick_Crystal

Firmware functions demonstration

Features

  • Wi-Fi: Scanner + deauth
  • NFC: read and write UID (PN532 moodule)
  • Bluetooth: Air mouse, presenter, Camera shutter (Enter button)
  • Settings: rotation, colors, brightness, status bar
  • Other: clock, battery level, level tool

Installation

You can install the firmware from m5burner or flash it yourself (by downloading the binary file first or compiling it yourself). See the instructions and documentation below.

Install from M5Burner

You can use the M5Burner for easiest firmware installation. This is the official tool to install firmwares on m5stack devices. Download m5Burner, select STICK in left side menu and start writing in the search line "Crystal". Click "Download", and then "Burn", select correct port.

Get latest build

Download the firmware file and flash it

Latest Release

Documentation

Simple, stable, customizible, and extensible

This firmware's structure follows the KISS principle. The code is extremely simple and structured. All functions use my wrappers, allowing you to quickly add new "programs" while focusing on the functionality itself, without wasting time interacting with the interface. As if you were using a framework.

Firmware architecture

You can easily add a new function using the documentation and by looking on already created funcs in functions/ folder.

❤️ Support my project with a star if you liked it. Contributing is welcome

I need your support and experience in contributing. Any form of assistance is welcome. Ask any questions through Issues or Disscusions.

🚀 Upcoming Features

  • Add clock setting
  • Add font style setting
  • New languages
  • Create new battery indicator
  • Level tool based on gyro (why not?)
  • Add NFC features
  • Add IR features

🛠 Project Maintenance

  • Structure functions, by the domain or by belonging to the category
  • Create PID categories (like http status codes)
  • Complete and structure the documentation
  • Set up linting
  • Rethract the web interface(beta)
  • Support new devices