You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+22-23Lines changed: 22 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,31 +16,28 @@
16
16
17
17
Turn your Raspberry Pi into a low-latency home security camera using the V4L2 DMA hardware encoder and WebRTC. [[demo video](https://www.youtube.com/watch?v=JZ5bcSAsXog)]
18
18
19
-
-Pure P2P-based camera allows video playback and download without a media server.
19
+
-Supports real-time adjustment of camera parameters and video recording download.
20
20
- Support [multiple users](doc/pi_4b_users_demo.gif) for simultaneous live streaming.
21
-
- Support signaling via [WHEP](https://www.ietf.org/archive/id/draft-ietf-wish-whep-02.html) or MQTT.
22
-
23
-
# How to use
24
-
25
-
To set up the environment, please check out the [tutorial video](https://youtu.be/g5Npb6DsO-0) or the steps below.
26
-
27
-
* Download and run the binary file from [Releases](https://github.com/TzuHuanTai/RaspberryPi_WebRTC/releases).
28
-
* Set up the network configuration and create a new client using one of the following options:
tar -xzf pi_webrtc-v1.0.5_MQTT_raspios-bookworm-arm64.tar.gz
72
70
```
73
71
74
-
### 4. Setup MQTT
72
+
### 4. Set Up MQTT
75
73
76
-
An MQTT server is required for communication between devices. For remote access, free cloud options include [HiveMQ](https://www.hivemq.com)and[EMQX](https://www.emqx.com/en).
74
+
You can use a free cloud MQTT service like [HiveMQ](https://www.hivemq.com)or[EMQX](https://www.emqx.com/en), or set up your own self-hosted broker.
77
75
78
76
<details>
79
77
<summary>
@@ -90,21 +88,22 @@ An MQTT server is required for communication between devices. For remote access,
90
88
* Run the command based on your network settings and `UID` on the Raspberry Pi:
91
89
```bash
92
90
./pi_webrtc \
93
-
--use_libcamera \
91
+
--camera=libcamera:0 \
94
92
--fps=30 \
95
93
--width=1280 \
96
94
--height=960 \
97
-
--hw_accel \
98
-
--no_audio \
99
95
--mqtt_host=your.mqtt.cloud \
100
96
--mqtt_port=8883 \
101
97
--mqtt_username=hakunamatata \
102
98
--mqtt_password=Wonderful \
103
-
--uid=your-custom-uid
99
+
--uid=your-custom-uid \
100
+
--no_audio \
101
+
--hw_accel # Only Pi Zero 2W, 3B, 4B support hw encoding
104
102
```
105
103
106
104
> [!IMPORTANT]
107
-
> The `--hw_accel` flag is used forPi Zero 2W, 3, 3B+, and 4B. For Pi 5 or other SBCs without a hardware encoder, run this commandin software encoding mode by removing the `--hw_accel` flag.
105
+
> Use `--hw_accel`for Pi Zero 2W, 3B, 3B+, and 4B. Remove for Pi 5 or devices without hardware encoding.
106
+
108
107
* Go to the Live page to enjoy real-time streaming!
109
108
110
109
<p align=center>
@@ -113,7 +112,7 @@ An MQTT server is required for communication between devices. For remote access,
0 commit comments