Update Xiaomi devices for Configuration variables (#6465)

* Configuration Variables Lifx light

* Update Xiaomi devices for Configuration variables

* ✏️ Tweaks

* ✏️ Tweaks

* 🚑 Quotes

* 🚑 Quotes

* 🚑 Quotes

* ✏️ Removed extra new line

* 🚑 Fixing build

* 🚑 Fixing build

* 🚑 Fixing Build

* 🚑 Fixing build

* 🚑 Fixing build

* 🚑 Fix build

* 🚀 Retrigger build
This commit is contained in:
Mryck 2018-10-03 19:43:23 +02:00 committed by Franck Nijhof
parent ed0a2bbc28
commit 9d76769e31
3 changed files with 62 additions and 23 deletions

View File

@ -53,18 +53,42 @@ camera:
name: Camera
host: '192.168.1.100'
model: 'yi'
password: my_password_123
password: YOUR_PASSWORD
```
Configuration variables:
- **name** (*Required*): A human-friendly name for the camera.
- **host** (*Required*): The IP address or hostname of the camera.
- **model** (*Required*): The model of Xiaomi Camera, currently supporting yi and xiaofang.
- **password** (*Required*): The password to the FTP server on the camera (from above), can be any string as the current firmware doesn't allow setting ftp passwords.
- **path** (*Optional*): The path to the raw MP4 files. Defaults to `/media/mmcblk0p1/record`.
- **username** (*Optional*): The user that can access the FTP server. Defaults to `root`.
- **ffmpeg_arguments** (*Optional*): Extra options to pass to `ffmpeg` (e.g., image quality or video filter options).
{% configuration %}
name:
description: A human-friendly name for the camera.
required: true
type: string
host:
description: The IP address or hostname of the camera.
required: true
type: string
model:
description: The model of Xiaomi Camera, currently supporting yi and xiaofang.
required: true
type: string
password:
description: The password to the FTP server on the camera (from above), can be any string as the current firmware doesn't allow setting ftp passwords.
required: true
type: string
path:
description: The path to the raw MP4 files.
required: false
default: /media/mmcblk0p1/record
type: string
username:
description: The user that can access the FTP server.
required: false
default: root
type: string
ffmpeg_arguments:
description: >
Extra options to pass to `ffmpeg`
required: false
type: string
{% endconfiguration %}
<p class='note'>
The default for `path:` will not work with all cameras. It may be needed that you add that key with the exact path for your device.
@ -82,7 +106,7 @@ camera:
name: My Camera
host: '192.168.1.100'
model: 'xiaofang'
password: my_password_123
password: YOUR_PASSWORD
path: /home/camera/feed
ffmpeg_arguments: '-vf scale=800:450'
```

View File

@ -12,7 +12,6 @@ ha_category: Presence Detection
ha_release: 0.36
---
The `xiaomi` platform offers presence detection by looking at connected devices to a [Xiaomi](http://miwifi.com) router.
To use an Xiaomi router in your installation, add the following to your `configuration.yaml` file:
@ -25,11 +24,20 @@ device_tracker:
password: YOUR_ADMIN_PASSWORD
```
Configuration variables:
- **host** (*Required*): The IP address of your router, eg. `192.168.0.1`.
- **username** (*Optional*: The admin username. By default `admin`.
- **password** (*Required*): The password for the admin account.
{% configuration %}
host:
description: "The IP address of your router, e.g., `192.168.0.1`."
required: true
type: string
username:
description: The admin username.
required: false
default: admin
type: string
password:
description: The password for the admin account.
required: true
type: string
{% endconfiguration %}
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

View File

@ -29,10 +29,17 @@ media_player:
When starting or restarting Home Assistant make sure your TV is off. This is a flaw in the TV itself.
</p>
Configuration variables:
- **host** (*Optional*): The IP of the Xiaomi TV, eg. 192.168.0.10
- **name** (*Optional*): The name to use on the frontend. Default is 'Xiaomi TV'.
{% configuration %}
host:
description: "The IP of the Xiaomi TV, e.g., `192.168.0.10`."
required: false
type: string
name:
description: The name to use on the frontend.
required: false
default: Xiaomi TV
type: string
{% endconfiguration %}
If you do not set a host in the configuration file, local TVs will automatically be discovered.