flan/advanced-camera-card
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve WebRTC documentation slightly.

Browse Source
This commit is contained in:
Dermot Duffy
2021-08-23 20:43:58 -07:00
parent 70ca219268
commit a1701a40c0
1 changed files with 28 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+28 -3
View File
@@ -91,9 +91,9 @@ lovelace:
### WebRTC Options
WebRTC support allows the use of the ultra-realtime [WebRTC live view](https://github.com/AlexxIT/WebRTC) along with the event browsing of Frigate. A perfect combination!
Note: WebRTC must be installed and configured separately (see [details](https://github.com/AlexxIT/WebRTC)).
WebRTC support blends the use of the ultra-realtime [WebRTC live
view](https://github.com/AlexxIT/WebRTC) with convenient access to Frigate
events/snapshots/UI. A perfect combination!
<img src="https://raw.githubusercontent.com/dermotduffy/frigate-hass-card/main/images/webrtc.png" alt="Live viewing" width="400px">
@@ -103,6 +103,31 @@ Note: WebRTC must be installed and configured separately (see [details](https://
| `webrtc.entity` | | The RTSP entity to use with WebRTC.|
| `webrtc.*`| | Any other options in a `webrtc:` YAML dictionary are silently passed through to WebRTC. See [WebRTC Configuration](https://github.com/AlexxIT/WebRTC#configuration) for full details this external card provides.|
**Note**: WebRTC must be installed and configured separately (see [details](https://github.com/AlexxIT/WebRTC)) before it can be used with this card.
#### Specifying the WebRTC Camera
There are two ways to specify the WebRTC source camera:
* Manual setup of separate RTSP camera entities in Home Assistant. These entities will then be available for selection in the GUI card editor for the Frigate card under the WebRTC options, or can be manually specified with a `webrtc.entity` option in YAML:
```yaml
[rest of Frigate card configuration]
webrtc:
entity: 'camera.front_door_rstp`
```
* OR manually configuring the `url` parameter as part of a manual Frigate card configuration, like the following example:
```yaml
[rest of Frigate card configuration]
webrtc:
url: 'rtsp://USERNAME:PASSWORD@CAMERA:554/RTSP_PATH'
```
See [WebRTC configuration](https://github.com/AlexxIT/WebRTC#configuration) for full configuration options.
<a name="views"></a>
## Views