jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update description and add links (#3812)

Browse Source
This commit is contained in:
Fabian Affolter 2017-10-28 17:36:25 +02:00 committed by GitHub
parent 7c5c8b3ab5
commit 4921e8b769
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
source/_components/camera.yi.markdown
View File

@ -13,37 +13,25 @@ ha_release: 0.56
ha_iot_class: "Local Polling"
---
The `yi` camera platform allows you to utilize Yi Home Cameras within Home
Assistant. Specifically, this platform supports the line of Yi Home Cameras
that are based on the Hi3518e Chipset; these include:
The `yi` camera platform allows you to utilize [Yi Home Cameras](https://www.yitechnology.com/) within Home Assistant. Specifically, this platform supports the line of Yi Home Cameras that are based on the Hi3518e Chipset. This includes:
* Yi Home 17CN
* Yi 1080p Home
* Yi Dome
* Yi 1080p Dome
To successfully implement this platform, the Home Assistant host should be
capable of multiple simultaneous reads; for every concurrent Home Assistant
user, a connection will be made to the camera every 10 seconds.
This should normally not be a problem.
To successfully implement this platform, the Home Assistant host should be capable of multiple simultaneous reads. For every concurrent Home Assistant user, a connection will be made to the camera every 10 seconds. This should normally not be a problem.
## {% linkable_title Preparing the Device %}
### {% linkable_title Installing Alternative Firmware %}
In order to integrate the camera with Home Assitant, it is necessary to install
a custom firmware on the device. Instructions for doing so can be found via the
[yi-hack-v3 GitHub project](https://github.com/shadow-1/yi-hack-v3).
In order to integrate the camera with Home Assitant, it is necessary to install a custom firmware on the device. Instructions for doing so can be found via the [yi-hack-v3 GitHub project](https://github.com/shadow-1/yi-hack-v3).
Once installed, please ensure that you have enabled FTP and Telnet on your
device.
Once installed, please ensure that you have enabled FTP and Telnet on your device.
<p class='note warning'>
Some alternative Yi firmwares enable an experimental RTSP server, which will
allow you to connect to your camera via other Home Assistant camera platforms.
However, this RTSP server disables the ability to use the supremely-useful Yi
Home app. In order to maintain both Home Assistant compatibility _and_ the native
app, this platform retrieves videos via FTP.
Some alternative Yi firmwares enable an experimental RTSP server, which will allow you to connect to your camera via other Home Assistant camera platforms. However, this RTSP server disables the ability to use the supremely-useful Yi Home app. In order to maintain both Home Assistant compatibility _and_ the native app, this platform retrieves videos via FTP.
</p>
### {% linkable_title Changing the FTP Password %}
@ -59,33 +47,30 @@ server. To do so:
## {% linkable_title Configuring the Platform %}
To enable the platform, add the following lines to your
`configuration.yaml` file:
To enable the platform, add the following lines to your`configuration.yaml` file:
```yaml
camera:
- platform: yi
name: Camera
host: '192.168.1.100'
password: my_password_123
```
Configuration variables:
- **name** (*Required*): a human-friendly name for the camera
- **host** (*Required*): the IP address or hostname of the camera
- **password** (*Required*): the password to the FTP server on the camera (from above)
- **path** (*Optional*): the path to the raw MP4 files (default: `/tmp/sd/record`)
- **username** (*Optional*): the user that can access the FTP server (default: `root`)
- **ffmpeg_arguments** (*Optional*): extra options to pass to `ffmpeg` (e.g. image quality or video filter options)
- **name** (*Required*): A human-friendly name for the camera.
- **host** (*Required*): The IP address or hostname of the camera.
- **password** (*Required*): The password to the FTP server on the camera (from above).
- **path** (*Optional*): The path to the raw MP4 files. Defaults to `/tmp/sd/record`.
- **username** (*Optional*): The user that can access the FTP server. Ddefaults to `root`.
- **ffmpeg_arguments** (*Optional*): Extra options to pass to `ffmpeg` (e.g. image quality or video filter options).
## {% linkable_title Image quality %}
Any option supported by the `ffmpeg` client can be utilized via the
`ffmpeg_arguments` configuration parameter.
Any option supported by [`ffmpeg` camera](/components/camera.ffmpeg/) can be utilized via the `ffmpeg_arguments` configuration parameter.
One particularly useful adjustment deals with video size. Since Yi videos are
fairly large (especially on the 1080p cameras), the following configuration will
bring them down to a manageable size:
One particularly useful adjustment deals with video size. Since Yi videos are fairly large (especially on the 1080p cameras), the following configuration will bring them down to a manageable size:
```yaml
camera:
@ -93,5 +78,6 @@ camera:
name: My Camera
host: '192.168.1.100'
password: my_password_123
path: /home/camera/feed
ffmpeg_arguments: '-vf scale=800:450'
```