diff --git a/source/_components/axis.markdown b/source/_components/axis.markdown index bf4736548d3..192c5774803 100644 --- a/source/_components/axis.markdown +++ b/source/_components/axis.markdown @@ -50,21 +50,23 @@ axis: Configuration variables: -- **device** (*Required*): Unique name for the Axis device. - - **host** (*Required*): The IP address to your Axis device. - - **username** (*Optional*): The username to your Axis device. Defaults to `root`. - - **password** (*Optional*): The password to your Axis device. Defaults to `pass`. - - **trigger_time** (*Optional*): Minimum time (in seconds) a sensor should keep its positive value. Defaults to 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. +## {% 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. A full configuration example could look like this: @@ -85,6 +87,10 @@ axis: location: köket ``` +

+If you are using Python3.6 you might need to replace the 34m with 36m in the _gi.*.so filename in the gi folder. +

+

Any specific levels for triggers needs to be configured on the device.

@@ -92,3 +98,18 @@ Any specific levels for triggers needs to be configured on the device.

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.

+ +## {% 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 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`