Skip to content

Commit 26851aa

Browse files
committed
chore: add descriptions for jetson
1 parent 92348a9 commit 26851aa

File tree

1 file changed

+14
-15
lines changed

1 file changed

+14
-15
lines changed

README.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
</h1>
88

99
<p align="center">
10-
Turn your Raspberry Pi into a real-time,<b> ~200ms low-latency</b> WebRTC camera.
10+
Turn Raspberry Pi or NVIDIA Jetson into a low-latency<b> ~200ms </b> WebRTC streaming platform.
1111
</p>
1212

1313

@@ -21,8 +21,9 @@ Turn your Raspberry Pi into a real-time,<b> ~200ms low-latency</b> WebRTC camera
2121

2222
<hr>
2323

24-
- Snapshot/video recording and WebRTC DataChannel messaging
25-
- Supports P2P, [SFU broadcasting](https://youtu.be/fuJ_EzwmlPM?si=66H8CgUIKo85leHI), and [Home Assistant](https://www.home-assistant.io) integration
24+
- Native WebRTC with hardware/software encoding
25+
- Support snapshot, recording and [broadcasting](https://youtu.be/fuJ_EzwmlPM?si=66H8CgUIKo85leHI)
26+
- Remote control and IoT messaging via WebRTC DataChannel
2627
- Signaling options:
2728

2829
**MQTT**
@@ -38,22 +39,20 @@ Turn your Raspberry Pi into a real-time,<b> ~200ms low-latency</b> WebRTC camera
3839
**WebSocket**
3940
* [picamera.js](https://github.com/TzuHuanTai/picamera.js?tab=readme-ov-file#watch-videos-via-the-sfu-server) - SFU signaling & broadcast
4041

41-
# Quick Start
42-
43-
Check out the [tutorial video](https://youtu.be/g5Npb6DsO-0) or follow these steps.
44-
4542
## Requirements
4643

4744
<img src="https://assets.raspberrypi.com/static/51035ec4c2f8f630b3d26c32e90c93f1/2b8d7/zero2-hero.webp" height="96">
4845

49-
- Raspberry Pi Zero 2W, 3B, 4B, or 5
50-
- CSI or USB camera (supports libcamera or V4L2)
46+
- **Raspberry Pi (Zero/3/4/5)** or **NVIDIA Jetson (Nano/NX/Orin)**
47+
- CSI or USB camera (supports libcamera, libargus or V4L2)
5148

52-
## Setup
49+
# Quick Start for Pi
50+
51+
Check out the [tutorial video](https://youtu.be/g5Npb6DsO-0) or follow these steps.
5352

5453
### 1. Flash Raspberry Pi OS
5554

56-
Use [Raspberry Pi Imager](https://www.raspberrypi.com/software/) to flash **Lite OS** (or full OS) to SD card.
55+
Use [Raspberry Pi Imager](https://www.raspberrypi.com/software/) to flash **Lite OS** to SD card.
5756

5857
### 2. Install Dependencies
5958

@@ -62,12 +61,12 @@ sudo apt update
6261
sudo apt install libcamera0.5 libmosquitto1 pulseaudio libavformat59 libswscale6 libprotobuf32
6362
```
6463

65-
### 3. Download App
64+
### 3. Download Binary
6665

6766
Get the latest [release binary](https://github.com/TzuHuanTai/RaspberryPi-WebRTC/releases) .
6867
```bash
69-
wget https://github.com/TzuHuanTai/RaspberryPi-WebRTC/releases/latest/download/pi-webrtc-v1.1.2_raspios-bookworm-arm64.tar.gz
70-
tar -xzf pi-webrtc-v1.1.2_raspios-bookworm-arm64.tar.gz
68+
wget https://github.com/TzuHuanTai/RaspberryPi-WebRTC/releases/latest/download/pi-webrtc-v1.2.0_raspios-bookworm-arm64.tar.gz
69+
tar -xzf pi-webrtc-v1.2.0_raspios-bookworm-arm64.tar.gz
7170
```
7271

7372
### 4. MQTT Signaling
@@ -101,7 +100,7 @@ Use [HiveMQ](https://www.hivemq.com), [EMQX](https://www.emqx.com/en), or a [sel
101100
```
102101

103102
> [!IMPORTANT]
104-
> Remove `--hw-accel` for Pi 5 or others without hardware encoder..
103+
> Remove `--hw-accel` for Pi 5 or others without hardware encoder.
105104

106105
# [Advanced Usage](https://github.com/TzuHuanTai/RaspberryPi_WebRTC/wiki/Advanced-Settings)
107106

0 commit comments

Comments
 (0)