📝 docs(README): update documentation for clarity and accuracy

This commit is contained in:
Sergey Krashevich
2026-01-26 00:35:06 +03:00
parent a41185c22a
commit 5970dd2fe4
11 changed files with 93 additions and 93 deletions
+6 -6
View File
@@ -6,7 +6,7 @@ This source allows you to view cameras from the [Xiaomi Mi Home](https://home.mi
Since 2020, Xiaomi has introduced a unified protocol for cameras called `miss`. I think it means **Mi Secure Streaming**. Until this point, the camera protocols were in chaos. Almost every model had different authorization, encryption, command lists, and media packet formats.
Go2rtc support two formats: `xiaomi/mess` and `xiaomi/legacy`.
go2rtc supports two formats: `xiaomi/mess` and `xiaomi/legacy`.
And multiple P2P protocols: `cs2+udp`, `cs2+tcp`, several versions of `tutk+udp`.
Almost all cameras in the `xiaomi/mess` format and the `cs2` protocol work well.
@@ -16,7 +16,7 @@ The `tutk` protocol is the worst thing that's ever happened to the P2P world. It
**Important:**
1. **Not all cameras are supported**. The list of supported cameras is collected in [this issue](https://github.com/AlexxIT/go2rtc/issues/1982).
2. Each time you connect to the camera, you need internet access to obtain encryption keys.
2. Each time you connect to the camera, you need Internet access to obtain encryption keys.
3. Connection to the camera is local only.
**Features:**
@@ -28,7 +28,7 @@ The `tutk` protocol is the worst thing that's ever happened to the P2P world. It
## Setup
1. Goto go2rtc WebUI > Add > Xiaomi > Login with username and password
1. Go to go2rtc WebUI > Add > Xiaomi > Login with username and password
2. Receive verification code by email or phone if required.
3. Complete the captcha if required.
4. If everything is OK, your account will be added, and you can load cameras from it.
@@ -40,7 +40,7 @@ xiaomi:
1234567890: V1:***
streams:
xiaomi1: xiaomi://1234567890:cn@192.168.1.123?did=9876543210&model=isa.camera.hlc7
xiaomi1: xiaomi://1234567890:cn@192.168.1.123?did=9876543210&model=isa.camera.hlc7
```
## Configuration
@@ -49,14 +49,14 @@ Quality in the `miss` protocol is specified by a number from 0 to 5. Usually 0 m
Go2rtc by default sets quality to 2. But some new cameras have HD quality at number 3.
Old cameras may have broken codec settings at number 3, so this number should not be set for all cameras.
You can change camera's quality: `subtype=hd/sd/auto/0-5`.
You can change camera quality: `subtype=hd/sd/auto/0-5`.
```yaml
streams:
xiaomi1: xiaomi://***&subtype=sd
```
You can use second channel for Dual cameras: `channel=2`.
You can use a second channel for dual cameras: `channel=2`.
```yaml
streams: