Merge remote-tracking branch 'origin/main' into sri/config-assistant

Author: ramsrib

README.md

@@ -1,14 +1,171 @@
-# vapicon-2025-hardware-workshop
+# VapiCon 2025 Hardware Workshop
 
-## Platform/Device Support
+[Demo Video](https://www.youtube.com/watch?v=gPuNpaL9ig8)
 
-* [AtomS3R](https://docs.m5stack.com/en/core/AtomS3R)
-* [Atomic Echo Base](https://docs.m5stack.com/en/atom/Atomic%20Echo%20Base)
+## Prerequisites
 
-## Configuration
-Run `idf.py menuconfig` and navigate to `VapiCon 2025 Hardware Workshop Configuration`.
+1. **ESP-IDF**: Install ESP-IDF v5.5.1 or later
 
-Inside this you need to set your Wifi Name/Wifi Password and Bearer Token.
+   ### Quick Installation Steps
 
-## Flashing
-`idf.py flash monitor`, this installs your code and shows you the logs on the device. Useful for debugging/understanding what is happening.
+   #### macOS/Linux
+
+   ```bash
+   # Install prerequisites (macOS)
+   brew install cmake ninja dfu-util
+
+   # Install prerequisites (Ubuntu/Debian)
+   # sudo apt-get install git wget flex bison gperf python3 python3-venv cmake ninja-build ccache libffi-dev libssl-dev dfu-util libusb-1.0-0
+
+   # Clone ESP-IDF repository
+   mkdir -p ~/esp
+   cd ~/esp
+   git clone -b v5.5.1 --recursive https://github.com/espressif/esp-idf.git
+
+   # Install ESP-IDF tools
+   cd ~/esp/esp-idf
+   ./install.sh esp32s3
+
+   # Set up environment (run this each time you open a new terminal)
+   source ~/esp/esp-idf/export.sh
+   ```
+
+   #### Windows
+
+   ```powershell
+   # Download and run the ESP-IDF installer from:
+   # https://dl.espressif.com/dl/esp-idf/
+
+   # Or use the ESP-IDF command prompt installed by the installer
+   # Then run:
+   export.bat
+   ```
+
+   ### Verify Installation
+
+   ```bash
+   idf.py --version
+   # Should output something like: ESP-IDF v5.5.1
+   ```
+
+   ### Setting up Environment (Required for each terminal session)
+
+   ```bash
+   # Add this to your ~/.zshrc to avoid running it manually:
+   alias get_idf='. ~/esp/esp-idf/export.sh'
+
+   # Open a new terminal to apply the changes
+
+   # Then you can simply run:
+   get_idf
+   ```
+
+   **Full Documentation**: [Official ESP-IDF Installation Guide](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html)
+
+2. **Hardware**:
+   - [AtomS3R](https://docs.m5stack.com/en/core/AtomS3R) or
+   - [Atomic Echo Base](https://docs.m5stack.com/en/atom/Atomic%20Echo%20Base)
+   - [Atomic Battery Base](https://shop.m5stack.com/products/atomic-battery-base-200mah?srsltid=AfmBOoqrr_zX2RVCksgfggWRR2F-8hTZ4asWs7_DuLn3MWEXH9JYPSqN)
+
+## Project Setup
+
+### 1. Clone the Repository
+
+```bash
+git clone --recurse-submodules https://github.com/VapiAI/vapicon-2025-hardware-workshop.git
+cd vapicon-2025-hardware-workshop
+```
+
+### 2. Configuration
+
+Run the configuration menu to set up your WiFi credentials and Bearer Token:
+
+```bash
+idf.py menuconfig
+```
+
+Navigate to:
+
+- `VapiCon 2025 Hardware Workshop Configuration`
+- Set your **WiFi Name** and **WiFi Password**
+- Set your **Bearer Token** to `b3db41dc-f62e-4ca8-89dc-550eab564212` and press enter
+- Press `S` and enter to save
+- Press `Q` to quit.
+
+### Config values
+
+- `BEARER_TOKEN` - `b3db41dc-f62e-4ca8-89dc-550eab564212`
+
+## Building the Project
+
+### Build the firmware
+
+```bash
+idf.py build
+```
+
+## Flashing to Device
+
+### Flash and monitor
+
+```bash
+idf.py flash monitor
+```
+
+This command will:
+
+1. Flash the firmware to your connected ESP32-S3 device
+2. Open the serial monitor to view debug output
+
+To exit the monitor, press `Ctrl+]`.
+
+## Troubleshooting
+
+### Build Errors
+
+If you encounter compiler warnings treated as errors:
+
+1. **String truncation errors**: These may appear with GCC 13+ due to stricter checks
+
+2. **Missing enum cases**: This typically happens when using a different ESP-IDF version
+   - **Solution**: Ensure you're using ESP-IDF v5.5.1 as specified in the prerequisites
+   - Check your current version: `idf.py --version`
+   - If incorrect, reinstall ESP-IDF v5.5.1 following the installation steps above
+
+### Missing Dependencies
+
+If the build fails with missing `libpeer` files:
+
+- Ensure submodules are properly initialized: `git submodule update --init --recursive`
+- Check that `deps/libpeer/src/` directory contains source files
+
+### Device Connection
+
+If flashing fails:
+
+- Check the USB connection
+- Try different USB ports or cables
+- Ensure the correct port is detected (it should auto-detect, or specify with `-p PORT`)
+
+## Project Structure
+
+```
+vapicon-2025-hardware-workshop/
+├── main/                  # Main application source
+│   ├── http.h            # HTTP client for Vapi API
+│   ├── webrtc.h          # WebRTC implementation
+│   ├── wifi.h            # WiFi connection management
+│   └── m5-atom-s3.h      # Hardware abstraction
+├── deps/
+│   └── libpeer/          # WebRTC library (git submodule)
+├── components/
+│   └── peer/             # Peer connection component
+├── sdkconfig.defaults    # Default configuration values
+└── partitions.csv        # Flash partition table
+```
+
+## Additional Resources
+
+- [ESP-IDF Documentation](https://docs.espressif.com/projects/esp-idf/en/latest/)
+- [M5Stack AtomS3R Documentation](https://docs.m5stack.com/en/core/AtomS3R)
+- [Vapi Documentation](https://docs.vapi.ai/)

SETUP.md

@@ -8,4 +8,4 @@ idf_component_register(
 )
 
 add_definitions("-DESP32 -DCONFIG_USE_LWIP=1 -DCONFIG_DATA_BUFFER_SIZE=102400 -D__BYTE_ORDER=__LITTLE_ENDIAN")
-add_definitions("-DHTTP_DO_NOT_USE_CUSTOM_CONFIG -DMQTT_DO_NOT_USE_CUSTOM_CONFIG -DCONFIG_USE_USRSCTP=0 -DDISABLE_PEER_SIGNALING=0 -DCONFIG_KEEPALIVE_TIMEOUT=0")
+add_definitions("-DHTTP_DO_NOT_USE_CUSTOM_CONFIG -DMQTT_DO_NOT_USE_CUSTOM_CONFIG -DCONFIG_USE_USRSCTP=0 -DDISABLE_PEER_SIGNALING=0")

components/peer/CMakeLists.txt

@@ -130,6 +130,7 @@ void do_http_request(const char *offer, char *answer) {
   if (err != ESP_OK || esp_http_client_get_status_code(client) != 200) {
     ESP_LOGE(LOG_TAG_HTTP, "Error perform http request %s",
              esp_err_to_name(err));
+    esp_restart();
   }
 
   free(body);

main/http.h

@@ -17,6 +17,6 @@ extern "C" void app_main(void) {
   ESP_ERROR_CHECK(esp_event_loop_create_default());
   wifi_connect();
 
-  board->ShowLogs("Creating PeerConnection");
+  board->ShowLogs("WebRTC Create");
   webrtc_create(board);
 }