Axis documentation (#2549)

* First draft of Axis component documentation

* Small improvements

* Added information about lowest supported Axis firmware

* Trigger time better explains functionality than scan interval

* Simplified explanation of automatic discovery

* Rephrasing manually configuring device

* Keep first and second level variables separated for ease of reading

* Moved up dependency and used Hassbian paths as an example

* Indented include variables descriptions to clarify their relation

* Made configuration variables tile linkable

* Axis devices are part of the discovery mechanism

* Update axis.markdown

* Update binary_sensor.axis.markdown

* Update camera.axis.markdown
This commit is contained in:
Kane610 2017-05-12 18:07:53 +02:00 committed by Paulus Schoutsen
parent 2bbc81c18a
commit 42e53e9900
5 changed files with 122 additions and 0 deletions

View File

@ -0,0 +1,75 @@
---
layout: page
title: "Axis"
description: "Instructions on how to setup devices from Axis Communications within Home Assistant."
date: 2017-04-30 23:04
sidebar: true
comments: false
sharing: true
footer: true
logo: axis.png
ha_category: Hub
ha_release: "0.45"
---
[Axis Communications](https://www.axis.com/) devices are surveillance cameras and other security related network connected hardware. Sensor API works with firmware 5.50 and newer.
Home Assistant will automatically discover their presence on your network.
You can also manually configure your devices by adding the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
axis:
m1065lw:
host: IP ADDRESS
username: USERNAME
password: PASSWORD
include:
- camera
- motion
- pir
- audio
- daynight
trigger_time: 0
location: köket
```
## {% linkable_title Dependencies %}
```bash
sudo apt-get install python3-gi gir1.2-gstreamer-1.0
```
Depending on how you run Home Assistant you might be needed to symlink the `gi` module into your environment (e.g. in Hassbian):
```bash
ln -s /usr/lib/python3/dist-packages/gi /srv/homeassistant/lib/python3.4/site-packages
```
## {% linkable_title Configuration variables % }
- **device** (*Required*): Unique name
- **host** (*Required*): The IP address to your Axis device.
- **username** (*Optional*): The username to your Axis device. Default 'root'.
- **password** (*Optional*): The password to your Axis device. Default 'pass'.
- **trigger_time** (*Optional*): Minimum time (in seconds) a sensor should keep its positive value. Default 0.
- **location** (*Optional*): Physical location of your Axis device. Default not set.
- **include** (*Required*): This cannot be empty else there would be no use adding the device at all.
- **camera**: Stream MJPEG video to Home Assistant
- **motion**: The Built in motion detection in Axis cameras
- **vmd3**: ACAP Motion Detection app which has better algorithms for motion detection
- **pir**: PIR sensor that can trigger on motion
- **sound**: Sound detector
- **daynight**: Certain cameras have day/night mode if they have built-in IR lights
- **tampering**: signals when camera believes that it has been tampered with
- **input**: trigger on whatever you have connected to device input port
<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>

View File

@ -0,0 +1,28 @@
---
layout: page
title: "Axis Binary Sensor"
description: "Instructions how to integrate Axis binary sensors into Home Assistant."
date: 2017-04-01 19:00
sidebar: true
comments: false
sharing: true
footer: true
logo: axis.png
ha_category: Binary Sensor
ha_iot_class: "Local Push"
ha_release: "0.45"
---
The `Axis` platform allows you to get data from your [Axis](https://www.axis.com/) devices from within Home Assistant.
See the [Axis main component](/components/axis/) for configuration instructions.
The following sensor types are supported:
* Motion detection
* Passive IR motion detection
* Sound detection
* Day/night mode
* Tampering detection
* Input port

View File

@ -0,0 +1,17 @@
---
layout: page
title: "Axis Camera"
description: "Instructions how to setup Axis cameras within Home Assistant."
date: 2017-05-01 19:09
sidebar: true
comments: false
sharing: true
footer: true
logo: axis.png
ha_category: Camera
ha_release: "0.45"
---
The `Axis` camera platform allows you to stream video from your [Axis](https://www.axis.com/) cameras.
The requirement is that you have setup your [Axis camera](/components/axis/).

View File

@ -31,6 +31,7 @@ Home Assistant can discover and automatically configure zeroconf/mDNS and uPnP d
* Linn / Openhome
* Denon Network Receivers
* Bose Soundtouch speakers
* Axis Communications security devices
It will be able to add Google Chromecasts and Belkin WeMo switches automatically, for Philips Hue it will require some configuration from the user.
@ -64,6 +65,7 @@ Valid values for ignore are:
* flux_led: (Flux Led/MagicLight)
* apple_tv: (Apple TV)
* openhome: (Linn / Openhome)
* axis: (Axis Communications security devices)
<p class='note'>

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB