Guides

Integrated Agent: ESP32 v1.3.8

Suggest Edits

The Ayla ESP32 solution includes example host application source code, an Ayla Wi-Fi Integrated Agent, and Ayla extensions to the Espressif IoT Development Framework (IDF). These pieces link together to provide an Ayla edge solution for the ESP32 board. Learn more about Ayla Integrated Agents.

First steps

  1. Obtain an Espressif ESP32-DevKitC board.

  2. Create an Ayla user account. You will probably need to have your Ayla Customer Account admin or Ayla support create a user account for you with admin or developer access rights.

  3. Reserve a DSN. Browse to Ayla Dashboard Portal. On the sidebar, navigate to Factory Actions. Click the Reserve DSN button. For Model, select AY008ESP1. Click Submit, and then download the associated XML file. You will need DSN value and the key from the file.

  4. Browse to the Ayla Developer Portal, and create a template with the following details.

    Visibility:oem
    Name:ADA ESP v1.3.8
    Description:ADA ESP v1.3.8
    Registration:Dsn
    Model:ledevb
    Version:ada-esp-idf-src-1.3.8
    Type:Wifi

  5. After creating the template, copy & paste the following properties into a text file, and import the file.

    base_type,direction,name,scope
    boolean,output,Blue_button,user
    boolean,input,Blue_LED,user
    string,input,cmd,user
    decimal,input,decimal_in,user
    decimal,output,decimal_out,user
    boolean,input,Green_LED,user
    integer,input,input,user
    string,output,log,user
    integer,output,output,user
    string,output,version,user

  6. Finally, click the new version property, check Host SW Version, and click OK.

Build and Run

GCC/Ubuntu/Docker

This section provides directions for building an Ayla ESP32 Solution v1.5-beta using a GCC/Ubuntu/Docker development environment.

  1. Download Ayla source code (ada-esp-idf-src-1.3.8.tgz).

  2. Determine the computer-to-ESP32 serial port:

    1. List the serial ports on your computer (e.g. ls /dev/tty*).

    2. Connect an ESP32 board to your computer using a serial cable.

    3. List the serial ports again. The new serial port on the list is the one to use (e.g. /dev/ttyUSB0).

  3. Install a Docker Engine on your Windows, Mac, and/or Linux host OS.

  4. Create a Docker ubuntu container:

    $ docker run --net=host --name=esp -w /root -it --device=/dev/ttyUSB0 ubuntu bash

    You are root, and the current working directory is /root.

  5. Prepare your development environment:

    1. Update package list:

      # apt update

    2. Install miscellaneous packages:

      # apt install nano screen iputils-ping

    3. Install prerequisites for Espressif Standard Setup of Toolchain v3.2.2 for Linux.

      # apt install gcc git wget make libncurses-dev flex bison gperf \
python python-pip python-setuptools python-serial python-cryptography python-future

    4. Create an esp directory, and change directory:

      # mkdir esp
# cd esp

    5. Download ESP32 toolchain for Linux:

      # wget https://dl.espressif.com/dl/xtensa-esp32-elf-linux64-1.22.0-80-g6c4433a-5.2.0.tar.gz

    6. Extract the archive file:

      # tar -xzf xtensa-esp32-elf-linux64-1.22.0-80-g6c4433a-5.2.0.tar.gz

    7. Add to the PATH environment variable:

      # export PATH=$HOME/esp/xtensa-esp32-elf/bin:$PATH

    8. Clone the Espressif IoT Development Framework:

      # git clone -b v3.1-beta1 --recursive https://github.com/espressif/esp-idf.git esp-idf-v3.1-beta1

    9. Create the IDF_PATH environment variable:

      # export IDF_PATH=$HOME/esp/esp-idf-v3.1-beta1

  6. Test the development environment with the hello_world example:

    1. Change directory:

      # cd $IDF_PATH/examples/get-started/hello_world

    2. Customize configuration. (Defaults should be fine.)

      # make menuconfig

    3. Build, flash, and monitor:

      # make
# make flash
# make monitor

      Output appears similar to this:

      Toolchain path: /root/esp/xtensa-esp32-elf/bin/xtensa-esp32-elf-gcc
Toolchain version: esp32-2019r1
Compiler version: 8.2.0
...
...
Hello world!
This is ESP32 chip with 2 CPU cores, WiFi/BT/BLE, silicon revision 1, 4MB external flash
Restarting in 10 seconds...
Restarting in 9 seconds...
...
...

      Press Ctl + ] to exit the monitor.

  7. Install Ayla source code:

    1. In a host terminal, copy ada-esp-idf-src-1.3.8.tgz to your Docker container:

      $ docker cp /home/matt/Downloads/ada-esp-idf-src-1.3.8.tgz esp:/root/esp

    2. In your Docker terminal, extract the archive file:

      # cd /root/esp
# tar zxvf ada-esp-idf-src-1.3.8.tgz

    3. Copy the ada-esp-idf-src-1.3.8 directory on top of the esp-idf-v3.1-beta1 directory:

      # cp -R ada-esp-idf-src-1.3.8/* ./esp-idf-v3.1-beta1

      This diagram gives you an idea of where the Ayla files are copied:

  8. Configure and build the Ayla agent and host application:

    1. Change directory:

      # cd $IDF_PATH/examples/ayla_demo

    2. Edit ./main/conf.h. Set the following:

       #define DEMO_OEM_ID           "00000000" /* replace with your Ayla OEM ID */
#define DEMO_TEMPLATE_VERSION "ada-esp-idf-src-1.3.8"

    3. Build, flash, and monitor:

       # make
# make erase_flash
# make flash
# make monitor

    4. Configure networking and security (use log debug all for maximum visibility):

       # nvs-set ada.f.wifi/profile/0/ssid <ssid>
# nvs-set ada.f.wifi/profile/0/security <security_type> # 0=none, 3=wpa, 4=wpa2
# nvs-set ada.f.wifi/profile/0/key <passphrase>
# nvs-set ada.f.wifi/profile/0/enable 1
# nvs-set "ada.f.id/dev_id" AC000W000000001
# nvs-set "ada.f.id/key" MIIB... (long number)
# nvs-set ada.f.client/server/default 1
# esp-reboot

      # oem key 0123456789abcdef0123456789abcdef ledevb
# save

NOTE: Setting "ada.f.client/server/default" to 1 will force your devices to use the development servers. For production, please set this value to 0: "ada.f.client/server/default 0".

GCC/Windows

This page provides directions for building an Ayla ESP32 Solution v1.3.8 using a GCC/Windows development environment.

  1. Download Ayla source code (ada-esp-idf-src-1.3.8.tgz).

  2. Determine the computer-to-ESP32 COM port:

    1. Run Windows Device Manager, and expand Ports.

    2. Connect an ESP32 board to your computer using a serial cable.

    3. Note the new COM port (e.g. "Silicon Labs CP210x USB to UART Bridge (COM3)") on the list.

  3. Browse to Standard Setup of Toolchain for Windows, and complete "Toolchain Setup" and "Check it Out" only.

  4. Clone the Espressif IoT Development Framework:

    $ cd ~/esp
$ git clone -b v3.1-beta1 --recursive https://github.com/espressif/esp-idf.git esp-idf-v3.1-beta1

  5. Add IDF_PATH to user profile.

    1. Create a script file named export_idf_path.sh in C:/msys32/etc/profile.d/.

    2. Identify the path to ESP-IDF directory. It is specific to your system configuration and may look something like C:\msys32\home\user-name\esp\esp-idf-v3.1-beta1.

    3. Add the export command to the script file replacing backslashes with forward slashes, e.g.:

      $ export IDF_PATH="C:/msys32/home/user-name/esp/esp-idf-v3.1-beta1"

    4. Save the file, close the MSYS2 window, re-open it, and verify the IDF_PATH:

      $ printenv IDF_PATH

  6. Install Patching with MSYS2 run:

    $ pacman -S patch

  7. Test the development environment with the hello_world example:

    1. Change directory:

      # cd $IDF_PATH/examples/get-started/hello_world

    2. Customize configuration. (Defaults should be fine.)

      # make menuconfig

    3. Build, flash, and monitor:

      # make
# make flash
# make monitor

      Output appears similar to this:

      Toolchain path: /root/esp/xtensa-esp32-elf/bin/xtensa-esp32-elf-gcc
Toolchain version: esp32-2019r1
Compiler version: 8.2.0
...
...
Hello world!
This is ESP32 chip with 2 CPU cores, WiFi/BT/BLE, silicon revision 1, 4MB external flash
Restarting in 10 seconds...
Restarting in 9 seconds...
...
...

      Press Ctl + ] to exit the monitor.

  8. Install Ayla source code:

    1. Extract the archive file:

       # cd ~/esp
 # tar zxvf ada-esp-idf-src-1.3.8.tgz

    2. Copy the ada-esp-idf-src-1.3.8 directory on top of the esp-idf-v3.1-beta1 directory:

       # cp -R ada-esp-idf-src-1.3.8/* ./esp-idf-v3.1-beta1

      This diagram gives you an idea of where the Ayla files are copied:

  9. Configure and build the Ayla agent and host application:

    1. Change directory:

       # cd $IDF_PATH/examples/ayla_demo

    2. Edit ./main/conf.h. Set the following:

       #define DEMO_OEM_ID           "00000000" /* replace with your Ayla OEM ID */
#define DEMO_TEMPLATE_VERSION "ada-esp-idf-src-1.3.8"

    3. Run make menuconfig to set Serial flasher config > Default serial port to the correct COM port.

    4. Build, flash, and monitor:

       # make
# make erase_flash
# make flash
# make monitor

    5. Configure networking and security (use log debug all for maximum visibility):

       # nvs-set ada.f.wifi/profile/0/ssid <ssid>
# nvs-set ada.f.wifi/profile/0/security <security_type> # 0=none, 3=wpa, 4=wpa2
# nvs-set ada.f.wifi/profile/0/key <passphrase>
# nvs-set ada.f.wifi/profile/0/enable 1
# nvs-set "ada.f.id/dev_id" AC000W000000001
# nvs-set "ada.f.id/key" MIIB... (long number)
# nvs-set ada.f.client/server/default 1
# esp-reboot

       # oem key 0123456789abcdef0123456789abcdef ledevb
# save

Register your device

  1. Browse to the Ayla Dashboard Portal, click OEM Users in the sidebar, click your account, and copy your UUID (e.g. a0000000-0000-0000-0000-000000000000).

  2. Click Devices in the sidebar, and find the new device on the list:

  3. Click the device row. Then, in the Device > Settings table, paste your UUID, and click Register:

  4. View the device on the Devices list again. Note that the device is registered to you.

  5. View the device in the Ayla Developer Portal:

  6. View the device in the Aura Mobile App:

Updated over 2 years ago