Attention

This is the documentation stub to the upcoming TBD V2 release.

It is incomplete and subject to future changes.

Building the Firmware

The TBD firmware is based on ESPHome to allow for configurable hardware specific builds. At the core of esphome builds is a hardware specific YAML config file. ESPHome will generate a PlatformIO project containing only the components required for a specific firmware flavour.

Manually Building the Firmware

First clone the TBD repository and navigate to the TBD root directory

git clone https://github.com/ctag-fh-kiel/ctag-tbd.git
cd ctag-tbd

If you want to build the latest testing version of TBD checkout the dev branch

git checkout dev

To manually build a TBD firmware you will need ESPHome alongside some additional python packages. The TBD repository comes with a pyproject.toml file for use with the Poetry package manager. To create a Python venv containing all required python packages use poetry install

poetry install

The tbd_core.cli module provides a wrapper to invoke ESPHome, without having to manually specify required parameters and environment variables. Build the firmware for a specific configuration with

poetry run tbd build <path-to-config-file>

or generate/refresh config specific build project using

poetry run tbd generate <path-to-config-file>