mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-03 09:38:59 +00:00
5043fec54a
Since installation is handled through the `axis` package, we can remove references to the gi folder
93 lines
3.4 KiB
Markdown
93 lines
3.4 KiB
Markdown
---
|
|
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"
|
|
ha_iot_class: "Local Polling"
|
|
---
|
|
|
|
[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
|
|
include:
|
|
- camera
|
|
```
|
|
|
|
Configuration variables:
|
|
|
|
## {% 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.
|
|
- **port** (*Optional*): Configure port web server of device is accessible from. Default 80.
|
|
- **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 a 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.
|
|
|
|
A full configuration example could look like this:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
axis:
|
|
m1065lw:
|
|
host: IP ADDRESS
|
|
username: USERNAME
|
|
password: PASSWORD
|
|
include:
|
|
- camera
|
|
- motion
|
|
- pir
|
|
- sound
|
|
- daynight
|
|
trigger_time: 0
|
|
location: köket
|
|
```
|
|
|
|
<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>
|
|
|
|
## {% linkable_title Device services %}
|
|
Available services: `vapix_call`.
|
|
|
|
#### {% linkable_title Service `axis/vapix_call` %}
|
|
Send a command using [Vapix](https://www.axis.com/support/developer-support/vapix). For details please read the API specifications.
|
|
|
|
| Service data attribute | Optional | Description |
|
|
|---------------------------|----------|--------------------------------------------------|
|
|
| `name` | no | Name of device to communicate with. |
|
|
| `param` | no | What parameter to operate on. |
|
|
| `cgi` | yes | Which cgi to call on the device. Default is `param.cgi`. |
|
|
| `action` | yes | What type of call. Default is `update`. |
|
|
|
|
Response to call can be subscribed to on event `vapix_call_response`
|