MK-HOME

This repository holds the firmware for home monitoring of MK's home

Prerequisites

The following are required to build this project:

1. CMake
2. Python
3. Ninja

Build

The following platforms are supported for this project:

1. ESP-IDF
2. Mbed OS

ESP-IDF platform prerequisites

This platform implements all the BSP requirements for various ports that use ESP-IDF.

ESP-IDF installation requirements

• ESP-IDF(version 5.2.3)

Mbed-OS platform prerequisites

This platform implements all the BSP requirements for various ports that use Mbed OS.

Mbed OS installation requirements

• Mbed OS(version 6.15.1)
• GNU Arm Embedded Toolchain(version 10.3-2021.10 )

The following ports are supported:

1. ESP32
2. STM32F429ZI

ESP32

Using ESP-IDF

Build

From the project root, run:

python3 build.py build-application -p ESP32 -pl ESP_IDF --compile

Flashing instructions

Connect the ESP32 to your computer and run:

python3 build.py build-application -p ESP32 -pl ESP_IDF --flash

STM32F429ZI

Using Mbed OS

Build instructions

From the project root, run:

python3 build.py build-application -p STM32F429ZI -pl mbed-os --compile

Flashing requirements

1. stlink(version 1.6.0)

Flashing instructions

Connect the STM32G070 to your computer and run:

python3 build.py build-application -p STM32F429ZI -pl mbed-os --flash

Documentation

The documentation will be found here