Release 0.1.0

.gitattributes

@@ -0,0 +1,3 @@
+components/third_party/* linguist-vendored
+components/livekit/protocol/*.c linguist-generated
+components/livekit/protocol/*.h linguist-generated

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: LiveKit Community Slack
+    url: https://livekit.io/join-slack
+    about: Get your questions answered

.github/workflows/build_examples.yml

@@ -0,0 +1,24 @@
+name: Build Examples
+on:
+  workflow_call: {}
+  workflow_dispatch: {}
+jobs:
+  build-examples:
+    name: Build Examples
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        target: [esp32s3]
+        idf_version: [release-v5.4, release-v5.5]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with: { submodules: recursive }
+      - name: Build All
+        uses: espressif/esp-idf-ci-action@v1
+        with:
+          esp_idf_version: ${{ matrix.idf_version }}
+          command: |
+            pip install idf-build-apps
+            idf-build-apps build -p ./examples --recursive --target ${{ matrix.target }}

.github/workflows/ci.yml

@@ -0,0 +1,16 @@
+name: CI
+on:
+  schedule:
+    - cron: 0 0 * * 1
+  workflow_dispatch:
+  pull_request:
+    types: [opened, reopened, synchronize]
+  push:
+    branches: [main]
+concurrency:
+  group: "ci"
+  cancel-in-progress: true
+jobs:
+  build-examples:
+    name: Build Examples
+    uses: ./.github/workflows/build_examples.yml

.github/workflows/docs.yml

@@ -0,0 +1,36 @@
+name: Build Documentation
+on:
+  workflow_dispatch:
+  push:
+    branches: [main]
+concurrency:
+  group: "docs"
+  cancel-in-progress: true
+jobs:
+  build-docs:
+    name: Build Documentation
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Doxygen
+        uses: mattnotmitt/doxygen-action@v1.12.0
+        with: { working-directory: docs }
+      - name: Configure Pages
+        uses: actions/configure-pages@v5
+      - name: Upload Generated Docs
+        uses: actions/upload-pages-artifact@v3
+        with: { path: docs/output }
+  deploy:
+    needs: build-docs
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,41 @@
+.config
+*.o
+*.pyc
+
+# gtags
+GTAGS
+GRTAGS
+GPATH
+
+# emacs
+.dir-locals.el
+
+# emacs temp file suffixes
+*~
+.#*
+\#*#
+# MacOS directory files
+.DS_Store
+
+# eclipse setting
+.settings
+
+# Example project files
+
+**/sdkconfig
+**/sdkconfig.old
+**/build
+**/managed_components
+**/dependencies.lock
+**/dist
+
+# gcov coverage reports
+*.gcda
+*.gcno
+coverage.info
+coverage_report/
+
+.vscode
+
+# Doxygen
+docs/output

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "components/third_party/esp-webrtc-solution"]
+	path = components/third_party/esp-webrtc-solution
+	url = https://github.com/espressif/esp-webrtc-solution

README.md

@@ -0,0 +1,69 @@
+<!--BEGIN_BANNER_IMAGE-->
+<picture>
+    <source media="(prefers-color-scheme: dark)" srcset="/.github/banner_dark.png">
+    <source media="(prefers-color-scheme: light)" srcset="/.github/banner_light.png">
+    <img style="width:100%;" alt="The LiveKit icon, the name of the repository and some sample code in the background." src="https://raw.githubusercontent.com/livekit/client-sdk-esp32/main/.github/banner_light.png">
+</picture>
+<!--END_BANNER_IMAGE-->
+
+# ESP-32 SDK for LiveKit
+
+Use this SDK to add realtime video, audio and data features to your ESP-32 projects. By connecting to [LiveKit](https://livekit.io/) Cloud or a self-hosted server, you can quickly build applications such as multi-modal AI, live streaming, or video calls with minimal setup.
+
+> [!WARNING]
+> This SDK is currently in Developer Preview mode and not ready for production use.
+> There will be bugs and APIs may change during this period.
+
+## Features
+
+- **Supported chipsets**: ESP32-S3 and ESP32-P4
+- **Bidirectional audio**: Opus encoding, acoustic echo cancellation (AEC)
+- **Bidirectional video**: *coming soon*
+- **Real-time data**: data packets, remote method calls (RPC)
+
+## Installation
+
+In your application's IDF component manifest, add LiveKit as a Git dependency:
+
+```yaml
+dependencies:
+  livekit:
+    git: https://github.com/livekit/client-sdk-esp32.git
+    path: components/livekit
+    version: <current version tag>
+```
+
+Please be sure to pin to a specific version tag as subsequent 0.x.x releases may have breaking changes. In the future, this SDK will be added to the [ESP component registry](https://components.espressif.com).
+
+## Examples
+
+One of the best ways to get started with LiveKit is by reviewing the examples and choosing one as a starting point for your project:
+
+- [Voice Agent](./examples/voice_agent/README.md): conversational AI voice agent that interacts with hardware based on user requests.
+- *More examples coming soon*
+
+## Documentation
+
+Please refer to the [LiveKit Docs](https://docs.livekit.io/home/) for an introduction to the platform and its features, or to the API reference (*TODO: Not published yet*) for specifics about this SDK.
+
+## Known Issues
+
+- In some cases, a remote participant leaving the room can lead to lead to a disconnect.
+
+## Getting Help & Contributing
+
+We invite you to join the [LiveKit Community Slack](https://livekit.io/join-slack) to get your questions answered, suggest improvements, or discuss how you can best contribute to this SDK.
+
+<!--BEGIN_REPO_NAV-->
+<br/><table>
+<thead><tr><th colspan="2">LiveKit Ecosystem</th></tr></thead>
+<tbody>
+<tr><td>LiveKit SDKs</td><td><a href="https://github.com/livekit/client-sdk-js">Browser</a> · <a href="https://github.com/livekit/client-sdk-swift">iOS/macOS/visionOS</a> · <a href="https://github.com/livekit/client-sdk-android">Android</a> · <a href="https://github.com/livekit/client-sdk-flutter">Flutter</a> · <a href="https://github.com/livekit/client-sdk-react-native">React Native</a> · <a href="https://github.com/livekit/rust-sdks">Rust</a> · <a href="https://github.com/livekit/node-sdks">Node.js</a> · <a href="https://github.com/livekit/python-sdks">Python</a> · <a href="https://github.com/livekit/client-sdk-unity">Unity</a> · <a href="https://github.com/livekit/client-sdk-unity-web">Unity (WebGL)</a> · <b>ESP-32</b></td></tr><tr></tr>
+<tr><td>Server APIs</td><td><a href="https://github.com/livekit/node-sdks">Node.js</a> · <a href="https://github.com/livekit/server-sdk-go">Golang</a> · <a href="https://github.com/livekit/server-sdk-ruby">Ruby</a> · <a href="https://github.com/livekit/server-sdk-kotlin">Java/Kotlin</a> · <a href="https://github.com/livekit/python-sdks">Python</a> · <a href="https://github.com/livekit/rust-sdks">Rust</a> · <a href="https://github.com/agence104/livekit-server-sdk-php">PHP (community)</a> · <a href="https://github.com/pabloFuente/livekit-server-sdk-dotnet">.NET (community)</a></td></tr><tr></tr>
+<tr><td>UI Components</td><td><a href="https://github.com/livekit/components-js">React</a> · <a href="https://github.com/livekit/components-android">Android Compose</a> · <a href="https://github.com/livekit/components-swift">SwiftUI</a></td></tr><tr></tr>
+<tr><td>Agents Frameworks</td><td><a href="https://github.com/livekit/agents">Python</a> · <a href="https://github.com/livekit/agents-js">Node.js</a> · <a href="https://github.com/livekit/agent-playground">Playground</a></td></tr><tr></tr>
+<tr><td>Services</td><td><a href="https://github.com/livekit/livekit">LiveKit server</a> · <a href="https://github.com/livekit/egress">Egress</a> · <a href="https://github.com/livekit/ingress">Ingress</a> · <a href="https://github.com/livekit/sip">SIP</a></td></tr><tr></tr>
+<tr><td>Resources</td><td><a href="https://docs.livekit.io">Docs</a> · <a href="https://github.com/livekit-examples">Example apps</a> · <a href="https://livekit.io/cloud">Cloud</a> · <a href="https://docs.livekit.io/home/self-hosting/deployment">Self-hosting</a> · <a href="https://github.com/livekit/livekit-cli">CLI</a></td></tr>
+</tbody>
+</table>
+<!--END_REPO_NAV-->

components/livekit/CMakeLists.txt

@@ -0,0 +1,24 @@
+idf_component_register(
+    SRC_DIRS ./core ./protocol
+    PRIV_INCLUDE_DIRS ./core ./protocol
+    INCLUDE_DIRS ./include
+    REQUIRES
+        av_render
+        esp_capture
+    PRIV_REQUIRES
+        esp_codec_dev
+        esp_netif
+        esp_timer
+        esp_websocket_client
+        esp_webrtc
+        json
+        mbedtls
+        media_lib_sal
+        peer_default
+        webrtc_utils
+        nanopb
+        khash
+)
+
+idf_component_get_property(LIVEKIT_SDK_VERSION ${COMPONENT_NAME} COMPONENT_VERSION)
+target_compile_definitions(${COMPONENT_LIB} PUBLIC "LIVEKIT_SDK_VERSION=\"${LIVEKIT_SDK_VERSION}\"")

components/livekit/core/common.h

@@ -0,0 +1,34 @@
+
+#pragma once
+
+#include "esp_peer.h"
+#include "esp_capture.h"
+#include "av_render.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/// State of an engine component or the engine itself.
+typedef enum {
+    CONNECTION_STATE_DISCONNECTED = 0, /*!< Disconnected */
+    CONNECTION_STATE_CONNECTING   = 1, /*!< Establishing connection */
+    CONNECTION_STATE_CONNECTED    = 2, /*!< Connected */
+    CONNECTION_STATE_RECONNECTING = 3, /*!< Connection was previously established, but was lost */
+    CONNECTION_STATE_FAILED       = 4  /*!< Connection failed */
+} connection_state_t;
+
+typedef struct {
+    esp_peer_media_dir_t audio_dir;
+    esp_peer_media_dir_t video_dir;
+
+    esp_peer_audio_stream_info_t audio_info;
+    esp_peer_video_stream_info_t video_info;
+
+    esp_capture_handle_t capturer;
+    av_render_handle_t   renderer;
+} engine_media_options_t;
+
+#ifdef __cplusplus
+}
+#endif