487 lines
19 KiB
HTML
487 lines
19 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>Axis - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions on how to setup devices from Axis Communications within Home Assistant.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/axis/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Axis">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/axis/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions on how to setup devices from Axis Communications 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="Axis">
|
||
<meta name="twitter:description" content="Instructions on how to setup devices from Axis Communications 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">
|
||
Axis
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p><a href="https://www.axis.com/">Axis Communications</a> devices are surveillance cameras and other security-related network connected hardware. Sensor API works with firmware 5.50 and newer.</p>
|
||
<p>Home Assistant will automatically discover their presence on your network.</p>
|
||
<p>You can also manually configure your devices by adding the following lines 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">axis</span><span class="pi">:</span>
|
||
<span class="s">m1065lw</span><span class="pi">:</span>
|
||
<span class="s">host</span><span class="pi">:</span> <span class="s">IP ADDRESS</span>
|
||
<span class="s">include</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">camera</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Configuration variables:</p>
|
||
<h2><a class="title-link" name="configuration-variables" href="#configuration-variables"></a> Configuration variables</h2>
|
||
<ul>
|
||
<li><strong>device</strong> (<em>Required</em>): Unique name</li>
|
||
<li><strong>host</strong> (<em>Required</em>): The IP address to your Axis device.</li>
|
||
<li><strong>username</strong> (<em>Optional</em>): The username to your Axis device. Default ‘root’.</li>
|
||
<li><strong>password</strong> (<em>Optional</em>): The password to your Axis device. Default ‘pass’.</li>
|
||
<li><strong>trigger_time</strong> (<em>Optional</em>): Minimum time (in seconds) a sensor should keep its positive value. Default 0.</li>
|
||
<li><strong>port</strong> (<em>Optional</em>): Configure port web server of device is accessible from. Default 80.</li>
|
||
<li><strong>location</strong> (<em>Optional</em>): Physical location of your Axis device. Default not set.</li>
|
||
<li><strong>include</strong> (<em>Required</em>): This cannot be empty else there would be no use adding the device at all.
|
||
<ul>
|
||
<li><strong>camera</strong>: Stream MJPEG video to Home Assistant.</li>
|
||
<li><strong>motion</strong>: The built-in motion detection in Axis cameras.</li>
|
||
<li><strong>vmd3</strong>: ACAP Motion Detection app which has better algorithms for motion detection.</li>
|
||
<li><strong>pir</strong>: PIR sensor that can trigger on a motion.</li>
|
||
<li><strong>sound</strong>: Sound detector.</li>
|
||
<li><strong>daynight</strong>: Certain cameras have day/night mode if they have built-in IR lights.</li>
|
||
<li><strong>tampering</strong>: Signals when camera believes that it has been tampered with.</li>
|
||
<li><strong>input</strong>: Trigger on whatever you have connected to device input port.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<p>A full configuration example could look like this:</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
||
<span class="s">axis</span><span class="pi">:</span>
|
||
<span class="s">m1065lw</span><span class="pi">:</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>
|
||
<span class="s">include</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">camera</span>
|
||
<span class="pi">-</span> <span class="s">motion</span>
|
||
<span class="pi">-</span> <span class="s">pir</span>
|
||
<span class="pi">-</span> <span class="s">sound</span>
|
||
<span class="pi">-</span> <span class="s">daynight</span>
|
||
<span class="s">trigger_time</span><span class="pi">:</span> <span class="s">0</span>
|
||
<span class="s">location</span><span class="pi">:</span> <span class="s">köket</span>
|
||
</code></pre>
|
||
</div>
|
||
<p class="note">
|
||
If you are using Python 3.6, you might need to replace the 34m with 36m in the _gi.*.so filename in the gi folder.
|
||
</p>
|
||
<p class="note">
|
||
Any specific levels for triggers needs to be configured on the device.
|
||
</p>
|
||
<p class="note">
|
||
It is recommended that you create a user on your Axis device specifically for Home Assistant. For all current functionality, it is enough to create a user belonging to user group viewer.
|
||
</p>
|
||
<h2><a class="title-link" name="device-services" href="#device-services"></a> Device services</h2>
|
||
<p>Available services: <code class="highlighter-rouge">vapix_call</code>.</p>
|
||
<h4><a class="title-link" name="service-axisvapix_call" href="#service-axisvapix_call"></a> Service <code class="highlighter-rouge">axis/vapix_call</code></h4>
|
||
<p>Send a command using <a href="https://www.axis.com/support/developer-support/vapix">Vapix</a>. For details please read the API specifications.</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Service data attribute</th>
|
||
<th>Optional</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">name</code></td>
|
||
<td>no</td>
|
||
<td>Name of device to communicate with.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">param</code></td>
|
||
<td>no</td>
|
||
<td>What parameter to operate on.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">cgi</code></td>
|
||
<td>yes</td>
|
||
<td>Which cgi to call on the device. Default is <code class="highlighter-rouge">param.cgi</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">action</code></td>
|
||
<td>yes</td>
|
||
<td>What type of call. Default is <code class="highlighter-rouge">update</code>.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Response to call can be subscribed to on event <code class="highlighter-rouge">vapix_call_response</code></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/axis.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/axis.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>: Local Polling
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.45
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class='title delta'>Related components</h1>
|
||
<ul class='divided'>
|
||
<li><a href='/components/binary_sensor.axis/'>
|
||
Axis Binary Sensor
|
||
</a></li>
|
||
<li><a href='/components/camera.axis/'>
|
||
Axis Camera
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Category Hub</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/apcupsd/'>APCUPSd</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/abode/'>Abode Home Security</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/alarmdecoder/'>AlarmDecoder Alarm</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/amcrest/'>Amcrest IP Camera</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/android_ip_webcam/'>Android IP Webcam</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/apple_tv/'>Apple TV</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/arlo/'>Arlo</a>
|
||
</li>
|
||
<li>
|
||
Axis
|
||
</li>
|
||
<li>
|
||
<a href='/components/wemo/'>Belkin WeMo</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/blink/'>Blink</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/bloomsky/'>BloomSky</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/digital_ocean/'>Digital Ocean</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/doorbird/'>DoorBird</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/dyson/'>Dyson</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/eight_sleep/'>Eight Sleep</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/emulated_hue/'>Emulated Hue Bridge</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/enocean/'>EnOcean</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/ffmpeg/'>FFmpeg</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/homematic/'>Homematic</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/tradfri/'>IKEA Trådfri (Tradfri)</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/isy994/'>ISY994 Controller</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/insteon_local/'>Insteon (local)</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/insteon_hub/'>Insteon Hub</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/insteon_plm/'>Insteon PLM</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/joaoapps_join/'>Joaoapps Join</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/juicenet/'>Juicenet</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/knx/'>KNX</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/kira/'>Kira</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/lametric/'>LaMetric</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/linode/'>Linode</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/litejet/'>LiteJet</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/lutron/'>Lutron</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/lutron_caseta/'>Lutron Caseta</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/mqtt/'>MQTT</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/raincloud/'>Melnor Raincloud</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/microsoft_face/'>Microsoft Face</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/mochad/'>Mochad</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/modbus/'>Modbus</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/mysensors/'>MySensors</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/neato/'>Neato Robotics</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/nest/'>Nest</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/netatmo/'>Netatmo</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/nuimo_controller/'>Nuimo controller</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/octoprint/'>OctoPrint</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/pilight/'>Pilight</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/qwikswitch/'>QwikSwitch QSUSB Hub</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/rflink/'>RFLink</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/rfxtrx/'>RFXtrx</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.rainbird/'>Rain Bird Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/ring/'>Ring</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/scsgate/'>SCSGate</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/spc/'>SPC</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/satel_integra/'>Satel Integra Alarm</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/skybell/'>Skybell</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sleepiq/'>SleepIQ</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/tado/'>Tado</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/telegram_bot/'>Telegram chatbot</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/tellstick/'>TellStick</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/tellduslive/'>Telldus Live</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/tesla/'>Tesla</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/thethingsnetwork/'>The Things Network</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/toon/'>Toon</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/twilio/'>Twilio</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/usps/'>USPS</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/velbus/'>Velbus</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/velux/'>Velux</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/vera/'>Vera</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/verisure/'>Verisure</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/volvooncall/'>Volvo On Call</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/wink/'>Wink</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/xiaomi_aqara/'>Xiaomi Gateway (Aqara)</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/zwave/'>Z-Wave</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/comfoconnect/'>Zehnder ComfoAir Q Ventilation</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/zha/'>Zigbee Home Automation</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/zoneminder/'>ZoneMinder</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/ecobee/'>ecobee</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/gc100/'>gc100</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>
|