home-assistant.github.io/components/camera.amcrest/index.html
2017-04-23 12:07:40 +00:00

209 lines
11 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>Amcrest IP Camera - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate Amcrest IP cameras within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/camera.amcrest/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Amcrest IP Camera">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/camera.amcrest/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate Amcrest IP cameras 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="Amcrest IP Camera">
<meta name="twitter:description" content="Instructions how to integrate Amcrest IP cameras within Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection" 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>
<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>
</ul>
</nav>
</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">
Amcrest IP Camera
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">amcrest</code> platform allows you to integrate your <a href="https://amcrest.com/">Amcrest</a> IP camera in Home Assistant.</p>
<p>To enable your camera in your installation, 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">amcrest</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">IP_ADDRESS</span>
<span class="s">username</span><span class="pi">:</span> <span class="s">USERNAME</span>
<span class="s">password</span><span class="pi">:</span> <span class="s">PASSWORD</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Required</em>): The IP address or hostname of your camera. If using hostname, make sure the DNS works as expected.</li>
<li><strong>username</strong> (<em>Required</em>): The username for accessing your camera.</li>
<li><strong>password</strong> (<em>Required</em>): The password for accessing your camera.</li>
<li><strong>name</strong> (<em>Optional</em>): This parameter allows you to override the name of your camera. The default is “Amcrest Camera”.</li>
<li><strong>port</strong> (<em>Optional</em>): The port that the camera is running on. The default is 80.</li>
<li><strong>resolution</strong> (<em>Optional</em>): This parameter allows you to specify the camera resolution. For a high resolution (1080/720p), specify the option <code class="highlighter-rouge">high</code>. For VGA resolution (640x480p), specify the option <code class="highlighter-rouge">low</code>. If omitted, it defaults to <em>high</em>.</li>
<li><strong>stream_source</strong> (<em>Optional</em>): The data source for the live stream. <code class="highlighter-rouge">mjpeg</code> will use the cameras native MJPEG stream, whereas <code class="highlighter-rouge">snapshot</code> will use the cameras snapshot API to create a stream from still images. If omitted, it defaults to <em>mjpeg</em>.</li>
</ul>
<p><strong>Note:</strong> Amcrest cameras with newer firmwares no longer have the ability to stream <code class="highlighter-rouge">high</code> definition video with MJPEG encoding. You may need to use <code class="highlighter-rouge">low</code> resolution stream or the <code class="highlighter-rouge">snapshot</code> stream source instead. If the quality seems too poor, lower the <code class="highlighter-rouge">Frame Rate (FPS)</code> and max out the <code class="highlighter-rouge">Bit Rate</code> settings in your cameras configuration manager.</p>
<p>To check if your Amcrest camera is supported/tested, visit the <a href="https://github.com/tchellomello/python-amcrest#supportability-matrix">supportability matrix</a> link from the <code class="highlighter-rouge">python-amcrest</code> project.</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.amcrest.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/amcrest.png' />
</div>
<div class='section'>
Introduced in release: 0.34
</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/sensor.amcrest/'>
Amcrest IP Camera
</a></li>
</ul>
</div>
<div class='section'>
<h1 class="title delta">Category Camera</h1>
<ul class='divided'>
<li>
Amcrest IP Camera
</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.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.rpi_camera/'>Raspberry Pi Camera</a>
</li>
<li>
<a href='/components/camera.synology/'>Synology 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.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>.<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>
</body>
</html>