Build from source

🏠 Build

Homepoint is currently using ESP-IDF SDK v4.0.2

Please follow the steps in the ESP-IDF documentation to setup your toolchain.
Install the tools listed in the prerequisites before following the steps below.

Setting up ESP-IDF from Git (optional):

$ mkdir ~/esp
$ cd ~/esp
$ git clone -b v4.0.2 --recursive https://github.com/espressif/esp-idf.git
$ cd esp-idf
$ ./install.sh
$ . ~/esp/esp-idf/export.sh
$ cd ..

Clone and build HomePoint with the following commands:

$ git clone https://www.github.com/sieren/homepoint.git
$ cd homepoint
$ git submodule update --init --recursive
$ mkdir build && cd build
$ cmake ../
$ make spiffs_spiffs_bin
$ make -j 8 flash

For use with a Button-Based interface:

$ cmake -DBUTTONS=ON ../

For out-of-the-box use with M5STACK:

$ cmake -DM5STACK=ON ../

Configure the PINs and GPIOs in main/config/TFT_eSPI/Generic/User_Setup.h.
⚠️ This configuration file gets copied to main/libraries/TFT_eSPI every time CMake is run. ⚠️

Other Homepoint configuration settings like the Screensaver can be configured in main/config/Config.h.