Skip to content

Commit

Permalink
Update readme about new features
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexxIT committed Aug 24, 2023
1 parent aa75a77 commit 69cbcda
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Component **doesn't create devices and entities**. It creates only two services
## Custom card
As a `url` you can use any protocol supported in go2rtc or specify the stream name from the go2rtc config.
As a `url` you can use any protocol supported in go2rtc or **specify the stream name** from the go2rtc config.
As a `entity` you can use almost any camera from Hass.

**Minimal**
Expand All @@ -93,6 +93,13 @@ url: 'rtsp://rtsp:[email protected]:554/av_stream/ch0'

**or**

```yaml
type: 'custom:webrtc-camera'
url: 'camera1' # stream name from go2rtc.yaml
```

**or**

```yaml
type: 'custom:webrtc-camera'
entity: camera.generic_stream # change to your camera entity_id
Expand All @@ -104,22 +111,28 @@ entity: camera.generic_stream # change to your camera entity_id
type: 'custom:webrtc-camera'
streams:
- url: go2rtc_stream_hd
name: HD
name: HD # name is optional
mode: webrtc # mode is optional
- url: go2rtc_stream_sd
name: SD
mode: mse
mode: mse
```

**Full**

**All settings are optional!** Only required setting - `url` or `entity` or `streams`.

```yaml
type: 'custom:webrtc-camera'
url: 'rtsp://rtsp:[email protected]:554/av_stream/ch0'
entity: camera.generic_stream
mode: webrtc,webrtc/tcp,mse,hls,mjpeg # stream technology, default all of them
server: http://192.168.1.123:1984/ # custom go2rtc server address, default empty
ui: true # custom video controls, default false
digital_ptz: # digital zoom and pan via mouse/touch. Defaults to:
digital_ptz: # digital zoom and pan via mouse/touch, defaults:
mouse_drag_pan: true
mouse_wheel_zoom: true
mouse_double_click_zoom: true
Expand All @@ -143,8 +156,6 @@ shortcuts: # custom shortcuts, default none
service: switch.toggle
service_data:
entity_id: switch.camera_record
mode: webrtc,mse,hls,mjpeg # also available - webrtc/tcp
```

Pan, tilt, zoom controls: [PTZ config examples](https://github.com/AlexxIT/WebRTC/wiki/PTZ-Config-Examples).
Expand Down

0 comments on commit 69cbcda

Please sign in to comment.