Component upload

.github/workflows/esp_registry.yml

@@ -12,6 +12,9 @@ jobs:
     runs-on: ubuntu-latest
     env:
       COMPONENTS: |
+        livekit:./components/livekit
+        sandbox_token:./components/sandbox_token
+        example_utils:./components/example_utils
         nanopb:./components/third_party/nanopb
         khash:./components/third_party/khash
     steps:
@@ -33,3 +36,10 @@ jobs:
           namespace: livekit
           api_token: ${{ secrets.ESP_REGISTRY_TOKEN }}
           dry_run: false
+      - name: Save Archives
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: archives
+          path: components/**/*.tgz
+          if-no-files-found: error

README.md

@@ -10,46 +10,55 @@
 
 # ESP32 SDK for LiveKit
 
-![API Reference](https://img.shields.io/badge/API_Reference-blue?link=https%3A%2F%2Flivekit.github.io%2Fclient-sdk-esp32%2F)
-![Latest Release](https://img.shields.io/github/v/release/livekit/client-sdk-esp32?include_prereleases&label=Release)
-![CI Status](https://img.shields.io/github/actions/workflow/status/livekit/client-sdk-esp32/ci.yml?label=CI)
+[![API Reference](https://img.shields.io/badge/API_Reference-blue)](https://livekit.github.io/client-sdk-esp32/)
+[![Component Registry](https://components.espressif.com/components/livekit/livekit/badge.svg)](https://components.espressif.com/components/livekit/livekit)
+[![CI Status](https://img.shields.io/github/actions/workflow/status/livekit/client-sdk-esp32/ci.yml?label=CI)](https://github.com/livekit/client-sdk-esp32/actions/workflows/ci.yml)
 
 Use this SDK to add realtime video, audio and data features to your ESP32 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]
+> [!IMPORTANT]
 > 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.
+> There may be bugs and APIs are subject to change during this period.
 
 ## Features
 
-- **Supported chipsets**: ESP32-S3 and ESP32-P4
+- **Supported chips**: ESP32-S3 and ESP32-P4
 - **Bidirectional audio**: Opus encoding, acoustic echo cancellation (AEC)
 - **Bidirectional video**: *video support coming soon*
+- **AI Agents**: interact with agents in the cloud built with [LiveKit Agents](https://docs.livekit.io/agents/)
 - **Real-time data**: data packets, remote method calls (RPC)
 
-## Examples
+## Getting Started
 
-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:
+Before you begin, please ensure you have ESP IDF v5.4 or higher installed on your system (see installation guide for [macOS/Linux](https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/get-started/linux-macos-setup.html) or [Windows](https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/get-started/windows-setup.html)).
 
-### [Voice AI Agent](./examples/voice_agent/README.md)
+### Examples
 
-Conversational AI voice agent that interacts with hardware based on user requests.
+One of the best ways to get started with LiveKit is by reviewing the [examples](./examples) and choosing one as a starting point for your project:
 
-## Basic usage
+- [**Voice AI Agent**](./examples/voice_agent/README.md): Conversational AI voice agent that interacts with hardware based on user requests.
+- [**Minimal**](./examples/minimal/README.md): Basic example of connecting to a LiveKit room with bidirectional audio.
+
+Once you have chosen an example to be your starting point, create a fresh project from it locally using the following command:
+
+```sh
+idf.py create-project-from-example "livekit/livekit=0.3.0:<example>"
+```
+
+Substitute *\<example\>* for the example's directory name.
 
 ### Installation
 
-In your application's IDF component manifest, add LiveKit as a Git dependency:
+If you would like to add LiveKit to your existing application, add it as a dependency using IDF:
 
-```yaml
-dependencies:
-  livekit:
-    git: https://github.com/livekit/client-sdk-esp32.git
-    path: components/livekit
-    version: <current version tag>
+```sh
+idf.py add-dependency "livekit/livekit=0.3.0"
 ```
 
-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).
+> [!IMPORTANT]
+> Be sure to pin to a specific version as shown in the command above, as subsequent v0.x.x releases may have breaking changes.
+
+## API Overview
 
 With LiveKit added as a dependency to your application, include the LiveKit header and invoke
 `livekit_system_init` early in your application's main function:
@@ -82,8 +91,6 @@ LiveKit for ESP32 puts your application in control of the media pipeline; your a
 - Playback audio over I2S, video on LCD displays supported by *esp_lcd*
 - After configuration, you will provide the `av_render_handle_t` when creating a room
 
-Please refer to the [examples](#examples) in this repository, which support many popular development boards via the Espressif [*codec_board*](./components/third_party/esp-webrtc-solution/components/codec_board/README.md) component.
-
 ### Create room
 
 Create a room object, specifying your capturer, renderer, and handlers for room events:
@@ -185,7 +192,7 @@ livekit_room_publish_data(room_handle, &options);
 
 ## Documentation
 
-Please refer to the [LiveKit Docs](https://docs.livekit.io/home/) for an introduction to the platform and its features, or see the [API Reference](https://livekit.github.io/client-sdk-esp32/) for specifics about this SDK.
+Please refer to the [LiveKit Docs](https://docs.livekit.io/home/) for an introduction to the platform and its features. For more detail about the APIs available in this SDK, please refer to the [API Reference](https://livekit.github.io/client-sdk-esp32/).
 
 ## Known Issues
 

components/example_utils/.gitignore

@@ -0,0 +1,7 @@
+# IDF
+**/sdkconfig
+**/sdkconfig.old
+**/build
+**/managed_components
+**/dependencies.lock
+**/dist

components/example_utils/CMakeLists.txt

@@ -0,0 +1,5 @@
+idf_component_register(
+    SRC_DIRS ./src
+    INCLUDE_DIRS ./include
+    PRIV_REQUIRES esp_netif esp_wifi nvs_flash
+)

components/example_utils/Kconfig.projbuild

@@ -0,0 +1,25 @@
+menu "LiveKit Example Utilities"
+    config LK_EXAMPLE_NETWORK_MAX_RETRIES
+        int "Maximum connection retries"
+        default 10
+            help
+                Maximum number of times to retry a failed connection.
+                Set to -1 for infinite retries.
+    choice LK_EXAMPLE_NETWORK_MODE
+        prompt "Choose network mode"
+        config LK_EXAMPLE_USE_WIFI
+            bool "WiFi"
+            help
+                Connect to the internet using WiFi.
+    endchoice
+    config LK_EXAMPLE_WIFI_SSID
+        depends on LK_EXAMPLE_USE_WIFI
+        string "WiFi SSID"
+        help
+            The SSID of the WiFi network to connect to.
+    config LK_EXAMPLE_WIFI_PASSWORD
+        depends on LK_EXAMPLE_USE_WIFI
+        string "WiFi password"
+        help
+            The password of the WiFi network to connect to.
+endmenu

components/example_utils/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

components/example_utils/README.md

@@ -0,0 +1,20 @@
+# LiveKit Example Utilities
+
+Common functionality required for example applications, used by the [LiveKit ESP32 SDK](https://github.com/livekit/client-sdk-esp32) for its examples.
+
+**Important**: this component is intended to reduce boilerplate in examples; it only handles basic use cases and and does not provide robust error handling. Therefore, use in production applications is not recommended.
+
+## Network Connection
+
+Establish a network connection with a single function call, configured via _Kconfig_.
+
+### Supported Interfaces
+
+- [x] WiFi
+- [ ] Ethernet (*TODO*)
+
+### Usage
+
+1. Configure network connection method and credentials using _Kconfig_
+2. Include the _livekit_example_utils.h_ header
+3. Invoke `lk_example_network_connect()` in your application's main function

components/example_utils/idf_component.yml

@@ -0,0 +1,12 @@
+version: "0.1.0"
+description: Utilities for reducing boilerplate code in examples
+tags: [Utilities, Network, WiFi]
+url: https://livekit.io/
+repository: https://github.com/livekit/client-sdk-esp32/
+issues: https://github.com/livekit/client-sdk-esp32/issues/
+discussion: https://livekit.io/join-slack/
+license: Apache-2.0
+dependencies:
+  idf: ">=5.4"
+files:
+  use_gitignore: true