Build Instructions

Collapse

• 1

  Wiring the components

  We'll start off by wiring the RGB LED to the ESP32:
  

  The diagram above shows a breadboard for clarity, but the RGB LED and ESP32 could be wired directly together using male-to-male jumpers if you choose.
  

  Take note of the GPIO pin numbers connected by red, blue, and green jumper wires to three of the LED legs, any GPIO that support digital output or pulse width modulation (PWM) will work; check your board's pinout to verify. Here we're using GPIO pins 15, 32, and 14. Those values will be important for configuring the development board in the Viam app and the Python code later. The jumper connecting the 3V pin on the ESP32 board to the LED will provide power to the component when the board is connected to your computer or the battery over USB.
  

• 2

  Flash and configure the ESP32 in Viam

  Next is creating a new robot in the Viam app and following the "Setup" instructions to flash the ESP32 with the micro-RDK.Once you've confirmed that it is connected to Viam (you should see a "Live" status under "Last online" in the header of the app), configure the board component  and relevant pins using the following JSON:
  
  

  {
    "components": [
      {
        "attributes": {
          "pins": [
            15,
            32,
            14
          ]
        },
        "depends_on": [],
        "name": "board",
        "model": "esp32",
        "type": "board",
        "namespace": "rdk"
      }
    ]
  }

   Remember to replace the numbers in the list of `pins` with the ones matching the physical wiring of the project.
  
  

  Restart the ESP32 to confirm a working configuration. If there is a "reset" button on the development board, use that; otherwise, unplugging and plugging in the board also works. You can look at the Control tab in the app to read and write the configured pin values to control the LED. Try setting all the pins to 1 or 0 or a floating number in between like 0.5 to see what happens.

• 3

  Web Application Setup

  Now to build the web application that will accept webhook requests from Zoom and control the light, we'll use the Viam Python SDK with the Starlette async web framework. Clone the working project from GitHub.
  

  git clone https://github.com/HipsterBrown/viam-on-air.git

  To configure the application with the required API key, API key ID, and location address for the Viam SDK and the secret token from Zoom, make a copy of the `.env.example` file and call it `.env`.

  Get the Viam API and location values from the "Code Sample" tab when viewing the machine details in the app. Toggle the "Include API Key" switch to reveal the API Key and API Key ID in the code where "<API-KEY>" and "<API-KEY-ID>" is seen initially.
  

  Get the Zoom secret token by creating a webhook-only app in the Zoom App Marketplace  and subscribing to the following events when adding an event subscription:

  Update the `.env` file with the relevant values, including the configured pins from Viam as `RGB_PINS` and your Zoom username to make sure the light only updates when you join or leave a meeting.

  
  With a working Python development environment, run the install command to get the dependencies in the cloned project repository:

  pip install -e . 

  Start the web application:

  python -m viam_on_air

  This will connect to the ESP32 and start a webserver on `0.0.0.0:8000` (a.k.a `localhost:8000`).

  ❯ python -m viam_on_air
  INFO: 	Started server process [96243]
  INFO: 	Waiting for application startup.
  2023-11-22 17:40:02,956     	INFO	viam.rpc.dial (dial.py:286) 	Connecting to socket: /tmp/proxy-LSL4xP2F.sock
  INFO: 	Application startup complete.
  INFO: 	Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)

View all 6 instructions