jays0223/iot-sdk

readme

# IOT SDK

[![Documentation](https://img.shields.io/badge/Read-Documentation-blue)](https://docs.videosdk.live/iot/guide/video-and-audio-calling-api-sdk/concept-and-architectur)
[![Discord](https://img.shields.io/discord/876774498798551130?label=Join%20on%20Discord)](https://discord.gg/bGZtAbwvab)
[![Register](https://img.shields.io/badge/Contact-Know%20More-blue)](https://app.videosdk.live/signup)


At Video SDK, we’re building tools to help developers bring **real-time collaboration** to IoT and embedded devices. With the IoT SDK, you can integrate **live audio communication, meeting management, device-to-cloud connectivity, and session handling** directly into ESP32.

## Prerequisites

- Python >= 3.11
- A valid [Video SDK Account](https://app.videosdk.live/)

## Use IoT SDK Component

Follow these steps to use the IoT SDK component in your project:

### 1. Configure ESP-IDF enviorment 

- For setting up **ESP-IDF**, follow only **Step 1** from videosdk's [documentation](https://docs.videosdk.live/iot/guide/video-and-audio-calling-api-sdk/quickstart/quick-start#step-1-setup-for-esp-idf).
- Inside Step 1, you **do not need to run the project creation commands** — 
```
// Create an esp-idf project
cd ~/esp
idf.py create-project your-project-name
cd your-project-name
```
Once the tools and environment are set up, jump directly to **Step 2 in this README**.

### 2: Add IoT SDK component

Add the IoT SDK dependency to your ESP-IDF project. This includes all required libraries to use IoT SDK features in your project.  

``` js title="Terminal"
  idf.py add-dependency "videosdk/iot-sdk:^1.0.0"
```

### 3: Configure Dependencies

Open your `idf_component.yml` file and add the required dependencies. Place them below your existing ones:

```
  // Your Existing dependencies
  protocol_examples_common:
    path: ${IDF_PATH}/examples/common_components/protocol_examples_common
  ## Required IDF version
  idf:
    version: '=5.3.0'
```

## Documentation

- For more details, check out the [VideoSDK Documentation](https://docs.videosdk.live/iot/guide/video-and-audio-calling-api-sdk/concept-and-architecture)