Build instructions - WizBangCrash/esp-homekit-devices GitHub Wiki

Build Instructions

1. After cloning repo, initialize and sync all submodules (recursively):

   git submodule update --init --recursive
   

2. Install esp-open-sdk, build it with make toolchain esptool libhal STANDALONE=n, then edit your PATH and add the generated tool chain bin directory. The path will be something like /path/to/esp-open-sdk/xtensa-lx106-elf/bin.

3. Build:

   make -C devices/HAA all
   

4. Set ESPPORT environment variable pointing to USB device your ESP8266 is attached to (assuming your device is at /dev/ttyUSB0):

   export ESPPORT=/dev/ttyUSB0
   

5. Upload firmware to ESP and then run it:

   make -C devices/HAA test
   

Others:

• Flash firmware:

  make -C devices/HAA flash
  

• Show UART output of connected device (Same as capture log):

  make -C devices/HAA monitor
  

• Clean and build from scratch:

  make -C devices/HAA rebuild
  

• Erase flash:

  make -C devices/HAA erase_flash