mommocmoc/esp-homekit-demo

Demo of Apple HomeKit accessory server library

esp-homekit-demo

Demo of Apple HomeKit accessory server library.

Usage

1. Initialize and sync all submodules (recursively):

git submodule update --init --recursive

2. Copy wifi.h.sample -> wifi.h and edit it with correct WiFi SSID and password.

3. Install esp-open-sdk, build it with make toolchain esptool libhal STANDALONE=n, then edit your PATH and add the generated toolchain bin directory. The path will be something like /path/to/esp-open-sdk/xtensa-lx106-elf/bin. (Despite the similar name esp-open-sdk has different maintainers - but we think it's fantastic!)

4. Install esptool.py and make it available on your PATH. If you used esp-open-sdk then this is done already.

5. Checkout esp-open-rtos and set SDK_PATH environment variable pointing to it.

6. Configure settings:

   1. If you use ESP8266 with 4MB of flash (32m bit), then you're fine. If you have 1MB chip, you need to set following environment variables:

   export FLASH_SIZE=8
   export HOMEKIT_SPI_FLASH_BASE_ADDR=0x7a000

   2. If you're debugging stuff, or have troubles and want to file issue and attach log, please enable DEBUG output:

   export HOMEKIT_DEBUG=1

   3. Depending on your device, it might be required to change the flash mode:

   export FLASH_MODE=dout

   (see issue #80)

7. Build example:

make -C examples/led all

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

export ESPPORT=/dev/tty.SLAB_USBtoUART

9. To prevent any effects from previous firmware (e.g. firmware crashing right at start), highly recommend to erase flash:

    make -C examples/led erase_flash

10. Upload firmware to ESP:

    make -C examples/led test

or

    make -C examples/led flash
    make -C examples/led monitor

ESP32

1. Initialize and sync all submodules (recursively):

git submodule update --init --recursive

2. Copy wifi.h.sample -> wifi.h and edit it with correct WiFi SSID and password.

3. Install esp-idf by following instructions on esp-idf project page. At the end you should have xtensa-esp32-elf toolchain in your path and IDF_PATH environment variable pointing to esp-idf directory.

4. Configure project:

make -C examples/esp32/led menuconfig

There are many settings there, but at least you should configure "Serial flasher config -> Default serial port". Also, check "Components -> HomeKit" menu section.

5. Build example:

make -C examples/esp32/led all

6. To prevent any effects from previous firmware (e.g. firmware crashing right at start), highly recommend to erase flash:

    make -C examples/led erase_flash

7. Upload firmware to ESP32:

    make -C examples/led flash
    make -C examples/led monitor