307 lines
15 KiB
HTML
307 lines
15 KiB
HTML
<!doctype html>
|
|
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
|
|
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
|
|
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Ring Binary Camera - Home Assistant</title>
|
|
<meta name="author" content="Home Assistant">
|
|
<meta name="description" content="Instructions on how to integrate your Ring.com devices within Home Assistant.">
|
|
<meta name="viewport" content="width=device-width">
|
|
<link rel="canonical" href="https://home-assistant.io/components/camera.ring/">
|
|
<meta property="fb:app_id" content="338291289691179">
|
|
<meta property="og:title" content="Ring Binary Camera">
|
|
<meta property="og:site_name" content="Home Assistant">
|
|
<meta property="og:url" content="https://home-assistant.io/components/camera.ring/">
|
|
<meta property="og:type" content="article">
|
|
<meta property="og:description" content="Instructions on how to integrate your Ring.com devices within Home Assistant.">
|
|
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
|
|
<meta name="twitter:card" content="summary_large_image">
|
|
<meta name="twitter:site" content="@home_assistant">
|
|
<meta name="twitter:title" content="Ring Binary Camera">
|
|
<meta name="twitter:description" content="Instructions on how to integrate your Ring.com devices within Home Assistant.">
|
|
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
|
<link href="/stylesheets/screen.css" media="screen, projection, print" rel="stylesheet">
|
|
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
|
|
<link rel='shortcut icon' href='/images/favicon.ico' />
|
|
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
|
|
</head>
|
|
<body >
|
|
<header class='site-header'>
|
|
<div class="grid-wrapper">
|
|
<div class="grid">
|
|
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
|
|
<a href="/" class="site-title">
|
|
<img width='40' src='/demo/favicon-192x192.png'>
|
|
<span>Home Assistant</span>
|
|
</a>
|
|
</div>
|
|
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
|
|
<nav>
|
|
<input type="checkbox" id="toggle">
|
|
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
|
|
<ul class="menu pull-right">
|
|
<li><a href="/getting-started/">Getting started</a></li>
|
|
<li><a href="/components/">Components</a></li>
|
|
<li><a href="/docs/">Docs</a></li>
|
|
<li><a href="/cookbook/">Examples</a></li>
|
|
<li><a href="/developers/">Developers</a></li>
|
|
<li><a href="/blog/">Blog</a></li>
|
|
<li><a href="/help/">Need help?</a></li>
|
|
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
|
|
</ul>
|
|
</nav>
|
|
<div class='search-container' style='display: none'>
|
|
<div class='search'>
|
|
<i class="icon-search"></i>
|
|
<input id='search' placeholder='Search the docs…'>
|
|
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="grid-wrapper">
|
|
<div class="grid grid-center">
|
|
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
|
|
<article class="page">
|
|
<header>
|
|
<h1 class="title indent">
|
|
Ring Binary Camera
|
|
</h1>
|
|
</header>
|
|
<hr class="divider">
|
|
<p>To get your <a href="https://ring.com/">Ring.com</a> cameras working within Home Assistant, please follow the instructions for the general <a href="/components/ring">Ring component</a>.</p>
|
|
<p>Once you have enabled the <a href="/components/ring">Ring component</a>, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
|
|
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
|
<span class="s">camera</span><span class="pi">:</span>
|
|
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">ring</span>
|
|
</code></pre>
|
|
</div>
|
|
<p>Configuration variables:</p>
|
|
<ul>
|
|
<li><strong>ffmpeg_arguments</strong>: (<em>Optional</em>): Extra options to pass to ffmpeg, e.g., image quality or video filter options.</li>
|
|
<li><strong>scan_interval</strong>: (<em>Optional</em>): How frequently to query for new video. Defaults to 90 seconds.</li>
|
|
</ul>
|
|
<p><strong>Note:</strong> To be able to playback the last capture, it is required to install the <code class="highlighter-rouge">ffmpeg</code> component. Make sure to follow the steps mentioned at <a href="https://home-assistant.io/components/ffmpeg/">FFMPEG</a> documentation.</p>
|
|
<p>Currently it supports doorbell and stickup cameras.</p>
|
|
<h2><a class="title-link" name="saving-locally-the-videos-captured-by-your-ring-door-bell" href="#saving-locally-the-videos-captured-by-your-ring-door-bell"></a> Saving locally the videos captured by your Ring Door Bell</h2>
|
|
<p>You can save locally the latest video captured by your Ring Door Bell by enabling the <a href="/components/downloader">downloader</a> and the <a href="/components/python_script">python_scripts</a> components.</p>
|
|
<ul>
|
|
<li>Add to the <code class="highlighter-rouge">configuration.yaml</code> the <code class="highlighter-rouge">downloader</code> and <code class="highlighter-rouge">python_scripts</code>. Visit the component page for further details.</li>
|
|
</ul>
|
|
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="err">python_script:</span><span class="w">
|
|
</span><span class="err">downloader:</span><span class="w">
|
|
</span><span class="err">download_dir:</span><span class="w"> </span><span class="err">downloads</span><span class="w">
|
|
</span></code></pre>
|
|
</div>
|
|
<ul>
|
|
<li>Create a file <code class="highlighter-rouge">ring_downloader.py</code> in the folder <code class="highlighter-rouge"><config>/python_scripts</code> and give it this content:</li>
|
|
</ul>
|
|
<div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="c"># obtain ring doorbell camera object</span>
|
|
<span class="c"># replace the camera.front_door by your camera entity</span>
|
|
<span class="n">ring_cam</span> <span class="o">=</span> <span class="n">hass</span><span class="o">.</span><span class="n">states</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'camera.front_door'</span><span class="p">)</span>
|
|
|
|
<span class="n">subdir_name</span> <span class="o">=</span> <span class="s">'ring_{}'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">ring_cam</span><span class="o">.</span><span class="n">attributes</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'friendly_name'</span><span class="p">))</span>
|
|
|
|
<span class="c"># get video URL</span>
|
|
<span class="n">data</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s">'url'</span><span class="p">:</span> <span class="n">ring_cam</span><span class="o">.</span><span class="n">attributes</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'video_url'</span><span class="p">),</span>
|
|
<span class="s">'subdir'</span><span class="p">:</span> <span class="n">subdir_name</span><span class="p">,</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="c"># call downloader component to save the video</span>
|
|
<span class="n">hass</span><span class="o">.</span><span class="n">services</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="s">'downloader'</span><span class="p">,</span> <span class="s">'download_file'</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span>
|
|
</code></pre>
|
|
</div>
|
|
<ul>
|
|
<li>Start Home Assistant</li>
|
|
<li>Call the server <code class="highlighter-rouge">python_script/ring_downloader</code></li>
|
|
</ul>
|
|
<p>You should be able to see a video file saved under <code class="highlighter-rouge"><config>/<downloader_dir>/ring_<camera_name>/</code>.</p>
|
|
<p>You can also automate the process by integrating it with the (automation)[/components/automation) component.</p>
|
|
</article>
|
|
</div>
|
|
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
|
|
<div class="grid">
|
|
<section class="aside-module grid__item one-whole lap-one-half">
|
|
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/camera.ring.markdown'>Edit this page on GitHub</a></div>
|
|
<div class='brand-logo-container section'>
|
|
<img src='/images/supported_brands/ring.png' />
|
|
</div>
|
|
<div class='section'>
|
|
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Cloud Polling
|
|
</div>
|
|
<div class='section'>
|
|
Introduced in release: 0.57
|
|
</div>
|
|
<div class='section'>
|
|
Source:
|
|
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/camera/ring.py'>camera/ring.py</a>
|
|
</div>
|
|
<div class='section'>
|
|
This is a platform for
|
|
<a href='/components/camera/'>the Camera component</a>.
|
|
</div>
|
|
<div class='section'>
|
|
<h1 class='title delta'>Related components</h1>
|
|
<ul class='divided'>
|
|
<li><a href='/components/ring/'>
|
|
Ring
|
|
</a></li>
|
|
<li><a href='/components/binary_sensor.ring/'>
|
|
Ring Binary Sensor
|
|
</a></li>
|
|
<li><a href='/components/sensor.ring/'>
|
|
Ring Sensor
|
|
</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class='section'>
|
|
<h1 class="title delta">Category Camera</h1>
|
|
<ul class='divided'>
|
|
<li>
|
|
<a href='/components/camera.abode/'>Abode Camera</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/camera.amcrest/'>Amcrest IP Camera</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/camera.android_ip_webcam/'>Android IP Webcam Camera</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/camera.arlo/'>Arlo Camera</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/camera.axis/'>Axis Camera</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/camera.blink/'>Blink Camera</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/camera.bloomsky/'>BloomSky Camera</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/camera.dispatcher/'>Dispatcher IP Camera</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/camera.doorbird/'>DoorBird Camera</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/camera.ffmpeg/'>FFmpeg Camera</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/camera.foscam/'>Foscam IP Camera</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/camera.generic/'>Generic IP Camera</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/camera.mjpeg/'>Generic MJPEG IP Camera</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/camera.local_file/'>Local File</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/camera.mqtt/'>MQTT Camera</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/ifttt.manything/'>ManyThing</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/camera.neato/'>Neato Camera</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/camera.nest/'>Nest Camera</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/camera.netatmo/'>Netatmo Camera</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/camera.onvif/'>ONVIF Camera</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/camera.rpi_camera/'>Raspberry Pi Camera</a>
|
|
</li>
|
|
<li>
|
|
Ring Binary Camera
|
|
</li>
|
|
<li>
|
|
<a href='/components/camera.skybell/'>Skybell Camera</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/camera.synology/'>Synology Camera</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/camera.usps/'>USPS Camera</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/camera.uvc/'>UniFi Video Camera</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/camera.verisure/'>Verisure Camera</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/camera.yi/'>Yi Home Camera</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/camera.zoneminder/'>ZoneMinder Camera</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</aside>
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
<div class="grid-wrapper">
|
|
<div class="grid">
|
|
<div class="grid__item">
|
|
<div class="copyright">
|
|
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
|
|
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
|
|
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
|
|
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
|
|
<div class="credit">
|
|
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a> (no support!).<br>
|
|
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
|
|
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
|
|
</div>
|
|
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<script>
|
|
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
|
|
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
|
|
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
|
|
s.parentNode.insertBefore(g,s)}(document,'script'));
|
|
</script>
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
|
|
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
|
|
<script type="text/javascript">
|
|
docsearch({
|
|
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
|
|
indexName: 'home-assistant',
|
|
inputSelector: '#search',
|
|
debug: false // Set debug to true if you want to inspect the dropdown
|
|
});
|
|
document.querySelector('.search .close').addEventListener('click', function(ev) {
|
|
ev.preventDefault();
|
|
document.querySelector('.search-container').style.display = 'none';
|
|
});
|
|
document.querySelector('.show-search').addEventListener('click', function(ev) {
|
|
ev.preventDefault();
|
|
document.querySelector('.search-container').style.display = 'block';
|
|
document.getElementById('toggle').checked = false;
|
|
document.querySelector('.search-container input').focus();
|
|
});
|
|
</script>
|
|
</body>
|
|
</html>
|