Home Assistant custom component for viewing IP cameras RTSP stream in real time using WebRTC technology

Home Assistant custom component for viewing IP cameras RTSP stream in real time using WebRTC technology.

Information

Category: Python / Video
Watchers: 2
Star: 24
Fork: 5
Last update: Sep 9, 2021

Resource links

https://github.com/AlexxIT/WebRTC

WebRTC Camera

Home Assistant custom component for viewing IP cameras RTSP stream in real time using WebRTC technology.

Based on:

Pion - pure Go implementation of WebRTC
RTSPtoWebRTC - Go app by @deepch and @vdalex25

Why WebRTC:

works in any modern browser, even on mobiles
the only browser technology with minimal camera stream delays (0.5 seconds and below)
works well with unstable channel
does not use transcoding and does not load the CPU
support camera stream with sound

FAQ

Q. I can't see video stream
A.

If your camera works with another integration - this don't mean it will work with this integration
If your camera works in VLC - this don't mean it will work with this integration
If your camera works remotely with another integration - this don't mean it will work remotely with this integration

In case of any problems, check:

Check that you have installed the integration on the "Configuration > Integrations" page
Check that you are on the same network as your Hass server
Check that you don't setup Hass server with forward only 8123 port (users with Virtual Machine or Docker installation or firewall), because WebRTC using 50000-50009 UDP ports for video streaming
Check that you don't have any erros in "Configuration > Logs" page
Check if default video with Bunny works:

type: 'custom:webrtc-camera'
url: 'rtsp://wowzaec2demo.streamlock.net/vod/mp4:BigBuckBunny_115k.mov'

PS. Some mobile browsers can't show stream without HTTPS. There are also problems with the stream in the Firefox browser.

Q. Error: Custom element doesn't exist: webrtc-camera.
A. Component automatically adds custom card /webrtc/webrtc-camera.js to your resources.

Check if you install component in "Integrations" page. And try to clear your browser cache. Also, you can try to add this card to your resources manually.

Q. How to setup exernal access?
A. External access will work only if you have public IP-address (without provider NAT). Dynamic address is also supported.

You need to forward UDP ports 50000-50009 to Hass server on your router.

50000-50009 ports are used only during video streaming. At each start of the streaming, a random port is occupied. The port is released when the streaming ends. The data should theoretically be encrypted, but I haven't tested :)

WebRTC can't work with external access via Nabu Casa or Dataplicity if you have private IP-address.

Q. Some streams are not loaded when there are many cameras on the page.
A. The default settings only support 10 simultaneous streams (from Hass server to app or browser). Go to "Configuration > Integrations > WebRTC Camera > Options" and increase port range. You also need forward new port range on your router if you want external access to cameras.

Q. Which codecs are supported?
A. WebRTC supported: AVC/H.264 for video and G.711 PCM (A-law), G.711 PCM (µ-law) for audio.

WebRTC technology don't support HEVC/H.265 for video and AAC for audio.

Install

You can install component with HACS custom repo: HACS > Integrations > 3 dots (upper top corner) > Custom repositories > URL: AlexxIT/WebRTC > Category: Integration

Or manually copy webrtc folder from latest release to custom_components folder in your config folder.

Config

Video DEMO

With GUI. Configuration > Integration > Add Integration > WebRTC Camera.

If the integration is not in the list, you need to clear the browser cache.

Component doesn't create devices/entities/services. It creates only lovelace custom card:

type: 'custom:webrtc-camera'
url: 'rtsp://rtsp:[email protected]:554/av_stream/ch0'

About

Supported clients:

macOS: Google Chrome, Safari
Windows: Google Chrome
Android: Google Chrome, Home Assistant Mobile App
iOS: Home Assistant Mobile App

Limitations:

works only with H.264 camaras
for external access you need a public IP-address (without provider NAT), dynamic IP is also supported

Known work cameras:

Sonoff GK-200MP2-B (support sound)
EZVIZ C3S
Hikvision: DS-2CD2T47G1-L, DS-2CD1321-I, DS-2CD2143G0-IS
Reolink: RLC-410, RLC-410W, E1 Pro, 4505MP
TP-Link: Tapo C200
Wyze Cam v2 (support sound)

4 Open More issues

Closed

webrtc broken after update to core 2022.7

after update to 2022.7, logged "login attempt failed"

bug

opened Jul 7, 2022 by Claudio1L 74

Closed

Stream not working with Version 2.0

Getting error message on new version. Tried on Safari Desktop and HA iOS App

bug

opened May 4, 2021 by weitheng 36

Closed

Error during setup of component (core-2021.12.0)

System Health

Home Assistant Community Store

AccuWeather

can_reach_server | ok -- | -- remaining_requests | 28

Home Assistant Cloud

Home Assistant Supervisor

Lovelace

This error originated from a custom integration.

Logger: homeassistant.setup
Source: custom_components/webrtc/utils.py:74
Integration: webrtc (documentation, issues)
First occurred: 08:37:12 (1 occurrences)
Last logged: 08:37:12

Error during setup of component webrtc
Traceback (most recent call last):
  File "/usr/src/homeassistant/homeassistant/setup.py", line 254, in _async_setup_component
    result = await task
  File "/config/custom_components/webrtc/__init__.py", line 75, in async_setup
    utils.register_static_path(hass.http.app, url_path, path)
  File "/config/custom_components/webrtc/utils.py", line 74, in register_static_path
    app['allow_cors'](route)
  File "/usr/local/lib/python3.9/site-packages/aiohttp/web_app.py", line 186, in __getitem__
    return self._state[key]
KeyError: 'allow_cors'

bug

opened Nov 10, 2021 by r3mcos3 35

Closed

WebRTC stops working on HA 2022.7.0b0

The next Home Assistant release drops Python 3.9. This may be the cause?

https://rc.home-assistant.io/blog/2022/06/29/release-20227/

No error logs are visibile.

opened Jun 30, 2022 by tkdrob 34

Closed

Does not install, does not work after manuall install

I got “Custom element doesn’t exist: ‘webrtc-camera’” on lovelace dashboard

no webrtc in custom_elements found after installation. “Add Integrations” search does not find webrtc camera ok, I copied it manually, restarted, and added integration, but no card at lovelace present now.

question

opened Apr 12, 2021 by a-x- 31

Closed

[Bug]: custom shortcuts and title overlap

The new custom shortcuts added in PR #169 create a layout issue. They overlap with the title, if it is configured.

type: custom:webrtc-camera
entity: camera.sd
title: Dining Room
ui: true
shortcuts:
  - name: Record
    icon: mdi:record-circle-outline
    service: switch.toggle
    service_data:
      entity_id: switch.camera_record

bug

opened Dec 16, 2021 by amitkeret 27

Open

Extra language support

This adds more languages for WebRTC

opened Aug 1, 2022 by JxxIT 0

Open

Imou Ranger 2 4Mp Not Showing 4K stream

I tried Imou Ranger 2 Full HD - video has been perfectly loaded and PTZ controls was visible and operable. I switched to 4K version of that camera and since then, I see only black screen with "Loading video" icon at right top part of screen. PTZ controls are visible and camera can be operated. When load second, low quality stream, picture from camera is also visible. So, I assume only 4K video has problem. I checked logs and found only following:

.......

Stream Try Connect rtsp://xxx:[email protected]:554/cam/realmonitor?channel=1&subtype=1&unicast=true&proto=Onvif
WebRTC Ignore Audio Track codec not supported WebRTC support only PCM_ALAW or PCM_MULAW
muxerWebRTC.WritePacket WebRTC Client Offline
muxerWebRTC.WritePacket WebRTC Codec Not Supported
websocket.JSON.Receive EOF
Stream Exit On Demand No Viewer .......

Am I doing something wrong or is that 4K issue? Jirka

opened Jul 29, 2022 by Betacart 0

Open

maximum 1 camera view per page, camera some time not loaded until page refresh.

HA under Docker Home Assistant Core 2022.6.7

if i add more than 1 camera to lovelace in same page, only one of the camera successful loaded, and its was randomly. i also have issue with camera loading stuck until i tab to other page, than goes back camera will successfully loaded. chance was 50:50. it was frustrating when every time i open app or browser to check out camera event . some one have this issue ?

opened Jul 26, 2022 by xeonlee 0

Open

Feature request: picture-glance like integration

Hi!

It would be very nice if WebRTC could be somehow put into picture-glance card or the WebRTC card could have some features like the picture-glance.

The usecase i'm looking for is switching between 2 stream with different quality/resolution (1). So on my dashboard I have a low quality 4fps stream that goes my tablet as a central display for it 0-24h, of couse just to take a quick look you don't need 4k resolution or so, however It would be nice to have an alternate button/option to open a different stream in fullscreen, preferably with the ability to use with WebRTC and default stream (for full screen in 4k resolution i may make compromise with 5-6s delay of default stream, because some devices may not play 4k fluently)

I also really love the instant full screen button of the actual stream (2) :)

I will keep an eye on this addon as it is really promissing!

enhancement

opened Jul 16, 2022 by Stormrage-DJ 0

Open

Ability to change ratio of the card

Hi,

I would love to see an option allowing me to change the ratio of displayed video on the card so I can adjust the card to small screens like tablet.

Thanks Greg

question

opened Jul 14, 2022 by GregoryKowalik 3

Open

WebRTC causing incompatible cameras in media?

Greetings all.

After the incompatibility between HA release 2022.7 and WebRTC, I carried out the steps suggested by freirejc below which resolved the issue for me.

File Browser, change the file custom_components\webrtc\www[webrtc-camera.js]
replace all content to below RAW code:
https://raw.githubusercontent.com/skrobul/WebRTC/38c77b400f86f20a42e0b8103bb01f6a0a7377eb/custom_components/webrtc/www/webrtc-camera.js

Delete the .gz file located in custom_components\webrtc\www

Delete all files located in custom_components\webrtc_pycache_

Remove IP Ban (in case you have it)

Restart you HA and in the meantime you clear all the cash from your browser. Do not forget to clear the cash in your mobile phone app as well.

Try to see your cameras in your browser and in your mobile app.

If everything is working fine, turn on IP Ban again.

I also noticed that after doing the above, my cameras started appearing again under media (player).

However when I updated to the latest WebRTC release yesterday (2.3.1), the cameras had disappeared and were showing as 7 incompatible items hidden.

Is there something in the code that could be causing them to no longer be compatible with HA media?

question

opened Jul 14, 2022 by Vards0 2

v2.3.1(Jul 13, 2022)

Adds Polish translation @LukaszP2
Fix Hass v2022.7 support #321 #320 @skrobul

Source code(tar.gz)
Source code(zip)

v2.3.0(Apr 10, 2022)

Adds support for positioning shortcuts #214 @dmamontov
Adds a home button for PTZ #220 @SheaSmith
Adds RTSPS urls to be used #208 @jimcortez
Adds Italian translation #205 @roleoroleo
Add Brazilian Portuguese translation #247 @LeandroIssa
Add Catalan translation #277 @dtalens
Adds more cameras to readme #219 #229 #231 #261
Fix shortcuts #245 @dmamontov
Fix custom UI buttons when on a touch screen device #218 @SheaSmith
Fix background: black ha-card style #213 @amitkeret

Source code(tar.gz)
Source code(zip)

v2.2.0(Dec 13, 2021)

Adds Unsupported browser error to macOS app
Adds supports custom shortcuts #169 #172
Fix Hass v2021.12.0 support @Mincka #156 #175 #178 #179 #182 #184 #185 #186 #187 #188 #189 #191 #192 #193 #194 #197 #198 #199 #200 #202 #204
Fix PTZ control @Sian-Lee-SA #115 #183 #105
Fix appendBuffer errors in logs #120
Fix old iOS

Source code(tar.gz)
Source code(zip)

v2.1.1(Jun 16, 2021)

Fix fullscreen function for custom UI @idoaflalo #84 #87 #95

Source code(tar.gz)
Source code(zip)

v2.1.0(Jun 7, 2021)

Fix work in backgroud #62 @idoaflalo

Source code(tar.gz)
Source code(zip)

v2.0.2(May 6, 2021)

Added muted card config option (control default stream sound)
Added icons description to readme
Support ice_servers card config option (for users with private IP-address and own VPS server)
Improved resource usage when reconnecting
Improved reconnection delay
Fix WebRTC connection delay
Fix fullscreen for 4:3 with custom UI
Fix card black background on fullscreen with custom UI
Return the REST API for WebRTC SDP exchange for DIY

Source code(tar.gz)
Source code(zip)

Custom component - Tapo: Cameras Control - to add Tapo cameras into Home Assistant

ready-to-use RTSP server that allows to read and publish video and audio streams via UDP and TCP

rtsp-simple-proxy is a simple, ready-to-use and zero-dependency RTSP proxy

RTSP -> WebRTC Server that generates a CPU Usage report

WebRTC streamer for V4L2 capture devices, RTSP sources and Screen Capture

Library to stream in rtmp and rtsp for Android. All code in Java

Cameradar hacks its way into RTSP videosurveillance cameras

Even newer Custom Firmware for Xiaomi Cameras based on Hi3518ev200 Chipset. It includes free RTSP, ONVIF and other improvements based on the work by roleoroleo

A curated list of amazingly awesome Home Assistant resources.

🏠 By LRvdLinden -- My Home Assistant configuration. Be sure to 🌟 this repository for updates!

Lightweight, zero-dependency proxy and storage RTSP server

Realtime object detection on RTSP cameras with the Google Coral

Floorplan for Home Assistant

WebRTC command-line peer.

E-Paper display for viewing sensor data from Home Assistant.

Component for deep integration LedFx from Home Assistant.

RTMP/RTSP/HLS bridge for Wyze cams in a docker container

Pion WebRTC is a pure Go implementation of WebRTC.

Starter template for Next.js-based Home Assistant frontends.

:house_with_garden: Open source home automation that puts local control and privacy first

Example with WebRTC , AWS Rekognition :+1:

Share this repo

Related Repos

Video

User friendly Open Source screencaster for Linux written in GTK. Using free GStreamer modu...

This project is archived, it's no longer under development. If you would like to continue development, please feel free to fork the project according

Video

213

GIFs on the command line

givegif Find and display GIFs from the command line. Displaying the GIF inline requires iTerm >=2.9. Demo Usage Usage: givegif [-n|--no-preview] ([-s|