You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/_components/camera.yi.markdown
+16-30Lines changed: 16 additions & 30 deletions
Original file line number
Diff line number
Diff line change
@@ -13,37 +13,25 @@ ha_release: 0.56
13
13
ha_iot_class: "Local Polling"
14
14
---
15
15
16
-
The `yi` camera platform allows you to utilize Yi Home Cameras within Home
17
-
Assistant. Specifically, this platform supports the line of Yi Home Cameras
18
-
that are based on the Hi3518e Chipset; these include:
16
+
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:
19
17
20
18
* Yi Home 17CN
21
19
* Yi 1080p Home
22
20
* Yi Dome
23
21
* Yi 1080p Dome
24
22
25
-
To successfully implement this platform, the Home Assistant host should be
26
-
capable of multiple simultaneous reads; for every concurrent Home Assistant
27
-
user, a connection will be made to the camera every 10 seconds.
28
-
This should normally not be a problem.
23
+
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.
29
24
30
25
## {% linkable_title Preparing the Device %}
31
26
32
27
### {% linkable_title Installing Alternative Firmware %}
33
28
34
-
In order to integrate the camera with Home Assitant, it is necessary to install
35
-
a custom firmware on the device. Instructions for doing so can be found via the
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).
37
30
38
-
Once installed, please ensure that you have enabled FTP and Telnet on your
39
-
device.
31
+
Once installed, please ensure that you have enabled FTP and Telnet on your device.
40
32
41
33
<pclass='note warning'>
42
-
Some alternative Yi firmwares enable an experimental RTSP server, which will
43
-
allow you to connect to your camera via other Home Assistant camera platforms.
44
-
However, this RTSP server disables the ability to use the supremely-useful Yi
45
-
Home app. In order to maintain both Home Assistant compatibility _and_ the native
46
-
app, this platform retrieves videos via FTP.
34
+
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.
47
35
</p>
48
36
49
37
### {% linkable_title Changing the FTP Password %}
@@ -59,39 +47,37 @@ server. To do so:
59
47
60
48
## {% linkable_title Configuring the Platform %}
61
49
62
-
To enable the platform, add the following lines to your
63
-
`configuration.yaml` file:
50
+
To enable the platform, add the following lines to your`configuration.yaml` file:
64
51
65
52
```yaml
66
53
camera:
67
54
- platform: yi
55
+
name: Camera
68
56
host: '192.168.1.100'
69
57
password: my_password_123
70
58
```
71
59
72
60
Configuration variables:
73
61
74
-
- **name** (*Required*): a human-friendly name for the camera
75
-
- **host** (*Required*): the IP address or hostname of the camera
76
-
- **password** (*Required*): the password to the FTP server on the camera (from above)
77
-
- **path** (*Optional*): the path to the raw MP4 files (default: `/tmp/sd/record`)
78
-
- **username** (*Optional*): the user that can access the FTP server (default: `root`)
79
-
- **ffmpeg_arguments** (*Optional*): extra options to pass to `ffmpeg` (e.g. image quality or video filter options)
62
+
- **name** (*Required*): A human-friendly name for the camera.
63
+
- **host** (*Required*): The IP address or hostname of the camera.
64
+
- **password** (*Required*): The password to the FTP server on the camera (from above).
65
+
- **path** (*Optional*): The path to the raw MP4 files. Defaults to `/tmp/sd/record`.
66
+
- **username** (*Optional*): The user that can access the FTP server. Ddefaults to `root`.
67
+
- **ffmpeg_arguments** (*Optional*): Extra options to pass to `ffmpeg` (e.g. image quality or video filter options).
80
68
81
69
## {% linkable_title Image quality %}
82
70
83
-
Any option supported by the `ffmpeg` client can be utilized via the
84
-
`ffmpeg_arguments`configuration parameter.
71
+
Any option supported by [`ffmpeg` camera](/components/camera.ffmpeg/) can be utilized via the `ffmpeg_arguments` configuration parameter.
85
72
86
-
One particularly useful adjustment deals with video size. Since Yi videos are
87
-
fairly large (especially on the 1080p cameras), the following configuration will
88
-
bring them down to a manageable size:
73
+
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:
0 commit comments