Skip to content

Commit a92e11d

Browse files
authored
Component upload (#35)
* Remove submodule * Remove unnecessary dependency * Remove redundant includes * Use registry components * Rename component * Remove common component * Update voice_agent example * Update minimal example * Update component manifest * Relocate examples under livekit component * Symlink examples to repo root * Update override paths for examples * Update sandbox_token component manifest * Update example READMEs * Add new components to CI * Update license check * Bump version for livekit component * Simplify sdkconfig for examples * Use hosted agent for voice agent example * Add local gitignores
1 parent 6b165b7 commit a92e11d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+1412
-1069
lines changed

.github/workflows/esp_registry.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ jobs:
1212
runs-on: ubuntu-latest
1313
env:
1414
COMPONENTS: |
15+
livekit:./components/livekit
16+
sandbox_token:./components/sandbox_token
17+
example_utils:./components/example_utils
1518
nanopb:./components/third_party/nanopb
1619
khash:./components/third_party/khash
1720
steps:
@@ -33,3 +36,10 @@ jobs:
3336
namespace: livekit
3437
api_token: ${{ secrets.ESP_REGISTRY_TOKEN }}
3538
dry_run: false
39+
- name: Save Archives
40+
if: always()
41+
uses: actions/upload-artifact@v4
42+
with:
43+
name: archives
44+
path: components/**/*.tgz
45+
if-no-files-found: error

.gitmodules

Lines changed: 0 additions & 3 deletions
This file was deleted.
File renamed without changes.

README.md

Lines changed: 29 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -10,46 +10,55 @@
1010

1111
# ESP32 SDK for LiveKit
1212

13-
![API Reference](https://img.shields.io/badge/API_Reference-blue?link=https%3A%2F%2Flivekit.github.io%2Fclient-sdk-esp32%2F)
14-
![Latest Release](https://img.shields.io/github/v/release/livekit/client-sdk-esp32?include_prereleases&label=Release)
15-
![CI Status](https://img.shields.io/github/actions/workflow/status/livekit/client-sdk-esp32/ci.yml?label=CI)
13+
[![API Reference](https://img.shields.io/badge/API_Reference-blue)](https://livekit.github.io/client-sdk-esp32/)
14+
[![Component Registry](https://components.espressif.com/components/livekit/livekit/badge.svg)](https://components.espressif.com/components/livekit/livekit)
15+
[![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)
1616

1717
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.
1818

19-
> [!WARNING]
19+
> [!IMPORTANT]
2020
> This SDK is currently in Developer Preview mode and not ready for production use.
21-
> There will be bugs and APIs may change during this period.
21+
> There may be bugs and APIs are subject to change during this period.
2222
2323
## Features
2424

25-
- **Supported chipsets**: ESP32-S3 and ESP32-P4
25+
- **Supported chips**: ESP32-S3 and ESP32-P4
2626
- **Bidirectional audio**: Opus encoding, acoustic echo cancellation (AEC)
2727
- **Bidirectional video**: *video support coming soon*
28+
- **AI Agents**: interact with agents in the cloud built with [LiveKit Agents](https://docs.livekit.io/agents/)
2829
- **Real-time data**: data packets, remote method calls (RPC)
2930

30-
## Examples
31+
## Getting Started
3132

32-
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:
33+
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)).
3334

34-
### [Voice AI Agent](./examples/voice_agent/README.md)
35+
### Examples
3536

36-
Conversational AI voice agent that interacts with hardware based on user requests.
37+
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:
3738

38-
## Basic usage
39+
- [**Voice AI Agent**](./examples/voice_agent/README.md): Conversational AI voice agent that interacts with hardware based on user requests.
40+
- [**Minimal**](./examples/minimal/README.md): Basic example of connecting to a LiveKit room with bidirectional audio.
41+
42+
Once you have chosen an example to be your starting point, create a fresh project from it locally using the following command:
43+
44+
```sh
45+
idf.py create-project-from-example "livekit/livekit=0.3.0:<example>"
46+
```
47+
48+
Substitute *\<example\>* for the example's directory name.
3949

4050
### Installation
4151

42-
In your application's IDF component manifest, add LiveKit as a Git dependency:
52+
If you would like to add LiveKit to your existing application, add it as a dependency using IDF:
4353

44-
```yaml
45-
dependencies:
46-
livekit:
47-
git: https://github.com/livekit/client-sdk-esp32.git
48-
path: components/livekit
49-
version: <current version tag>
54+
```sh
55+
idf.py add-dependency "livekit/livekit=0.3.0"
5056
```
5157

52-
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).
58+
> [!IMPORTANT]
59+
> Be sure to pin to a specific version as shown in the command above, as subsequent v0.x.x releases may have breaking changes.
60+
61+
## API Overview
5362

5463
With LiveKit added as a dependency to your application, include the LiveKit header and invoke
5564
`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
8291
- Playback audio over I2S, video on LCD displays supported by *esp_lcd*
8392
- After configuration, you will provide the `av_render_handle_t` when creating a room
8493
85-
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.
86-
8794
### Create room
8895
8996
Create a room object, specifying your capturer, renderer, and handlers for room events:
@@ -185,7 +192,7 @@ livekit_room_publish_data(room_handle, &options);
185192

186193
## Documentation
187194

188-
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.
195+
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/).
189196

190197
## Known Issues
191198

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# IDF
2+
**/sdkconfig
3+
**/sdkconfig.old
4+
**/build
5+
**/managed_components
6+
**/dependencies.lock
7+
**/dist
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
idf_component_register(
2+
SRC_DIRS ./src
3+
INCLUDE_DIRS ./include
4+
PRIV_REQUIRES esp_netif esp_wifi nvs_flash
5+
)
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
menu "LiveKit Example Utilities"
2+
config LK_EXAMPLE_NETWORK_MAX_RETRIES
3+
int "Maximum connection retries"
4+
default 10
5+
help
6+
Maximum number of times to retry a failed connection.
7+
Set to -1 for infinite retries.
8+
choice LK_EXAMPLE_NETWORK_MODE
9+
prompt "Choose network mode"
10+
config LK_EXAMPLE_USE_WIFI
11+
bool "WiFi"
12+
help
13+
Connect to the internet using WiFi.
14+
endchoice
15+
config LK_EXAMPLE_WIFI_SSID
16+
depends on LK_EXAMPLE_USE_WIFI
17+
string "WiFi SSID"
18+
help
19+
The SSID of the WiFi network to connect to.
20+
config LK_EXAMPLE_WIFI_PASSWORD
21+
depends on LK_EXAMPLE_USE_WIFI
22+
string "WiFi password"
23+
help
24+
The password of the WiFi network to connect to.
25+
endmenu
Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

components/example_utils/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# LiveKit Example Utilities
2+
3+
Common functionality required for example applications, used by the [LiveKit ESP32 SDK](https://github.com/livekit/client-sdk-esp32) for its examples.
4+
5+
**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.
6+
7+
## Network Connection
8+
9+
Establish a network connection with a single function call, configured via _Kconfig_.
10+
11+
### Supported Interfaces
12+
13+
- [x] WiFi
14+
- [ ] Ethernet (*TODO*)
15+
16+
### Usage
17+
18+
1. Configure network connection method and credentials using _Kconfig_
19+
2. Include the _livekit_example_utils.h_ header
20+
3. Invoke `lk_example_network_connect()` in your application's main function
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
version: "0.1.0"
2+
description: Utilities for reducing boilerplate code in examples
3+
tags: [Utilities, Network, WiFi]
4+
url: https://livekit.io/
5+
repository: https://github.com/livekit/client-sdk-esp32/
6+
issues: https://github.com/livekit/client-sdk-esp32/issues/
7+
discussion: https://livekit.io/join-slack/
8+
license: Apache-2.0
9+
dependencies:
10+
idf: ">=5.4"
11+
files:
12+
use_gitignore: true

0 commit comments

Comments
 (0)