home-assistant.io/source/_components/camera.xeoma.markdown
Jerad Meisner 6496e3ef21 Added documentation for Xeoma camera platform (#4405)
* Added documentation for Xeoma camera platform

* ✏️ Minor changes

* Add periods
2018-01-25 23:25:38 +01:00

90 lines
2.5 KiB
Markdown

---
layout: page
title: "Xeoma Camera"
description: "Instructions on how to integrate camera video feeds from a Xeoma server in Home Assistant"
date: 2018-01-12 20:05
sidebar: true
comments: false
sharing: true
footer: true
logo: xeoma.png
ha_category: Camera
ha_iot_class: "Local Polling"
ha_release: 0.62
---
The `Xeoma` camera platform allows you to view the video feeds from a [Xeoma](http://felenasoft.com/xeoma) video surveillance server.
To enable Xeoma camera feeds, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
camera:
- platform: xeoma
host: http://localhost:10090
```
{% configuration %}
host:
description: The URL of the Xeoma server's web interface.
required: true
type: string
username:
description: The username used to access the Xeoma server's web interface.
required: false
type: string
password:
description: The password used to access the Xeoma server's web interface.
required: false
type: string
new_version:
description: Set to false if the Xeoma server version is 17.5 or earlier.
required: false
default: true
type: boolean
cameras:
description: List of customizations for individual Xeoma cameras.
required: false
type: list
keys:
image_name:
description: The name of the JPEG image for this camera as configured in Xeoma (without .jpg extension).
required: true
type: string
name:
description: The name to display in the frontend for this camera.
required: false
default: The `image_name` for this camera.
type: string
hide:
description: Don't show this camera in Home Assistant.
required: false
default: false
type: boolean
{% endconfiguration %}
## {% linkable_title Full examples %}
```yaml
# Example configuration.yaml entry
camera:
- platform: xeoma
host: http://localhost:10090
username: user
password: secretpassword
new_version: false
cameras:
- image_name: front_porch
name: Front Porch
- image_name: back_patio
hide: true
```
To use this platform, you must have the Xeoma Web Server module enabled in at least one of your camera chains.
This platform will parse the Xeoma web interface to find all enabled cameras and add them all to Home Assistant. You can
hide individual cameras using the platform configuration.
The `image_name` configuration value for each camera should match the name supplied to the Xeoma Web Server configuration (under _Path to access images_) with the _.jpg_ extension removed.