meshtastic/docs/developers/firmware/build.md
2022-03-09 23:10:04 +11:00

1.4 KiB

id title sidebar_label
build Creating a build environment Building Meshtastic

Meshtastic uses the PlatformIO development environment, that enables easy multiplatform development and centralized tooling.

Setup

  1. Install PlatformIO, following the instructions available here.

  2. Clone the meshtastic-device repository located here. (Instructions on cloning)

  3. Clone the Submodules

    git submodule update --init
    
  4. Some utilities and scripts use the Python programming language, Downloads available here.

Building

  1. Open the newly cloned folder in Visual Studio Code.
  2. To select the device you you wish to build for, first open your command palette (Ctrl + Shift + P) and enter: platformio: Switch Project Environment and select your target.
  3. To build the firmware, simply run PlatformIO: Build from your command palette.
  4. Finally flashing the firmware to your device is as easy as running PlatformIO: Upload