Skip to content

Commit 6e2668b

Browse files
committed
chore: update release version
1 parent d2a194b commit 6e2668b

File tree

1 file changed

+26
-12
lines changed

1 file changed

+26
-12
lines changed

README.md

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,14 @@ To set up the environment, please check out the [tutorial video](https://youtu.b
2626

2727
* Download and run the binary file from [Releases](https://github.com/TzuHuanTai/RaspberryPi_WebRTC/releases).
2828
* Set up the network configuration and create a new client using one of the following options:
29-
* [Pi Camera](https://github.com/TzuHuanTai/Pi-Camera) app (Android).
30-
* [Pi Camera Web](https://picamera.live).
31-
* Javascript client
32-
* [PiCamera.js](https://www.npmjs.com/package/picamera.js) (For MQTT).
33-
* [eyevinn/webrtc-player](https://www.npmjs.com/package/@eyevinn/webrtc-player) (For WHEP).
29+
30+
**MQTT**
31+
* [PiCamera.js](https://www.npmjs.com/package/picamera.js)
32+
* [Pi Camera App](https://github.com/TzuHuanTai/Pi-Camera) (Android)
33+
* [Pi Camera Web](https://picamera.live)
34+
35+
**WHEP**
36+
* [eyevinn/webrtc-player](https://www.npmjs.com/package/@eyevinn/webrtc-player)
3437

3538
## Hardware Requirements
3639

@@ -45,10 +48,15 @@ To set up the environment, please check out the [tutorial video](https://youtu.b
4548

4649
Use the [Raspberry Pi Imager](https://www.raspberrypi.com/software/) to install Raspberry Pi Lite OS on your microSD card.
4750

48-
> [!TIP]
49-
> **Can I use a regular Raspberry Pi OS, or does it have to be Lite?**<br/>
51+
<details>
52+
<summary>
53+
<b>💡 Can I use a regular Raspberry Pi OS, or does it have to be Lite?</b>
54+
</summary>
55+
5056
> You can use either the Lite or full Raspberry Pi OS (the official recommended versions), but Lite OS is generally more efficient.
5157
58+
</details>
59+
5260
### 2. Install essential libraries
5361

5462
```bash
@@ -58,20 +66,26 @@ sudo apt install libmosquitto1 pulseaudio libavformat59 libswscale6
5866
### 3. Download and unzip the binary file
5967

6068
```bash
61-
wget https://github.com/TzuHuanTai/RaspberryPi_WebRTC/releases/latest/download/pi_webrtc-1.0.4_pi-os-bookworm.tar.gz
62-
tar -xzf pi_webrtc-1.0.4_pi-os-bookworm.tar.gz
69+
wget https://github.com/TzuHuanTai/RaspberryPi_WebRTC/releases/latest/download/pi_webrtc-v1.0.5_MQTT_raspios-bookworm-arm64.tar.gz
70+
tar -xzf pi_webrtc-v1.0.5_MQTT_raspios-bookworm-arm64.tar.gz
6371
```
6472

6573
### 4. Setup MQTT
6674

6775
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).
68-
> [!TIP]
69-
> **Is MQTT registration necessary, and why is MQTT needed?**<br/>
76+
77+
<details>
78+
<summary>
79+
<b>💡 Is MQTT registration necessary, and why is MQTT needed?</b>
80+
</summary>
81+
7082
> MQTT is one option for signaling P2P connection information between your camera and the client UI. WHEP, on the other hand, runs an HTTP service locally and does not require a third-party server. It is only suitable for devices with a public hostname. If you choose to self-host an MQTT server (e.g., [Mosquitto](doc/SETUP_MOSQUITTO.md)) and need to access the signaling server remotely via mobile data, you may need to set up DDNS, port forwarding, and SSL/TLS.
7183
84+
</details>
85+
7286
## Running the Application
7387

74-
* Set up the MQTT settings on your [Pi Camera App](https://github.com/TzuHuanTai/Pi-Camera) or [Pi Camera Web](https://picamera.live), and create a new device in the settings to get a `UID`.
88+
* Set up the MQTT settings on your [Pi Camera App](https://github.com/TzuHuanTai/Pi-Camera-App) or [Pi Camera Web](https://picamera.live), and create a new device in the **Settings** page to get a `UID`.
7589
* Run the command based on your network settings and `UID` on the Raspberry Pi:
7690
```bash
7791
./pi_webrtc \

0 commit comments

Comments
 (0)