Factory firmware for the M5Stack Core2 for AWS IoT Kit. Use this repository to restore your device to the original program or to investigate and freely modify.This application was written to be easy to understand and replicate instead of efficiency. View the API reference for using the included board support package.
One firmware image runs on both the original Core2 for AWS and the Core2 for AWS v1.3. The Home, IMU, and Mic screens name the detected kit model, IMU (MPU6886 or BMI270), and microphone (SPM1423 or LMD4737T261), and the boot log also reports the LCD controller (ILI9342C or ILI9342E).
This repo uses Git Submodules to bring in dependent components.
Note: If you download the ZIP file provided by GitHub UI, you will not get the contents of the submodules. Since the downloaded zip will also not be a git repository, you will not be able to compile the code since that is a toolchain requirement. You must clone the repository using the instructions below.
If using Windows, because this repository and its submodules contain symbolic links, set core.symlinks to true with the following command:
git config --global core.symlinks trueIn addition to this, either enable Developer Mode or, whenever using a git command that writes to the system (e.g. git pull, git clone, and git submodule update --init --recursive), use a console elevated as administrator so that git can properly create symbolic links for this repository. Otherwise, symbolic links will be written as normal files with the symbolic links' paths in them as text. This gives more explanation.
To clone using HTTPS:
git clone https://github.com/m5stack/Factory_Firmware-Core2_for_AWS.git --recurse-submodulesUsing SSH:
git clone git@github.com:m5stack/Factory_Firmware-Core2_for_AWS.git --recurse-submodulesIf you have downloaded the repo without using the --recurse-submodules argument, you need to run:
git submodule update --init --recursiveThe project targets PlatformIO espressif32 7.1.3, which bundles ESP-IDF 6.1.0 and the GCC 15.2 toolchain. Build the firmware with:
pio run -e core2forawsManaged components are version-pinned in components/Core2-for-AWS-IoT-Kit/idf_component.yml. PlatformIO resolves them into the ignored managed_components directory during configuration.
ESP-IDF 6 no longer supports CryptoAuthLib's mbedTLS ALT integration. The BSP's signing and verification APIs use the supported direct ATECC608 CryptoAuthLib interface, and legacy CONFIG_ESP_TLS_USE_SECURE_ELEMENT integration is disabled.
Cloud-synced folders can interfere with the component manager while it replaces generated dependencies. If configuration reports a managed-component file disappearing during extraction, build from a local non-synced checkout.
See tests/README.md for native regressions and the on-device factory smoke script. The factory uses cooperative tab workers, an application-owned interrupt-driven UART console, and the independent screenshot component for middle-button long-press captures. Home's Status view reports internal/DMA memory and capture counters; display-capable startup failures offer a normal reboot retry. The optional UI-test and screenshot serial listeners remain disabled in the normal configuration.
This is the entry point for your application. Start by investigating and/or modifying this file for your needs.
This is the location of the board support package. It includes drivers and helper libraries for controlling the on-board peripherals on the device.
This generated directory contains Espressif's managed CryptoAuthLib component. Configure its version in the BSP's idf_component.yml; do not edit generated files under managed_components.
This is the partition table recommended for most applications. It provides sufficient file system sizes for storing Wi-Fi credentials, the user application, OTA updates, additional file storage, and storage for SPIFFS in the on-board flash. This utilizes the internal + external flash memory.
See CONTRIBUTING for more information.
This firmware and its BSP are licensed under the MIT License with attribution; Rashed Talukder's copyright is recorded from 2022. See each repository's LICENSE and the retained upstream notices. The screenshot and UI-test components also use MIT, and the Bosch BMI270 configuration file remains BSD-3-Clause. Datasheets and managed dependencies retain their own copyright and license terms.