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-06-26 12:06:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'current' into next

Browse Source
This commit is contained in:
Franck Nijhof 2018-10-23 19:47:25 +02:00
commit 006ef8ef66
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
134 changed files with 816 additions and 571 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
source/_components/binary_sensor.ads.markdown
View File

@ -26,16 +26,16 @@ binary_sensor:
```
{% configuration %}
adsvar:
required: true
description: The name of the variable which you want to access on the ADS device.
type: string
name:
required: false
description: An identifier for the light in the frontend.
type: string
device_class:
required: false
description: The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.
type: string
adsvar:
description: The name of the variable which you want to access on the ADS device.
required: true
type: string
name:
description: An identifier for the light in the frontend.
required: false
type: string
device_class:
description: The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.
required: false
type: string
{% endconfiguration %}

12
source/_components/binary_sensor.aurora.markdown
View File

@ -32,17 +32,19 @@ binary_sensor:
forecast_threshold:
description: Provide your own threshold number above which the sensor will trigger.
required: false
default: 75
type: integer
default: 75
name:
description: The name of the sensor.
required: false
default: Aurora Visibility
type: string
default: Aurora Visibility
{% endconfiguration %}
## {% linkable_title Full example %}
```yaml
binary_sensor:
- platform: aurora
forecast_threshold: 50
binary_sensor:
- platform: aurora
forecast_threshold: 50
```

63
source/_components/binary_sensor.bayesian.markdown
View File

@ -14,7 +14,6 @@ ha_release: 0.53
ha_qa_scale: internal
---
The `bayesian` binary sensor platform observes the state from multiple sensors and uses [Bayes' rule](https://en.wikipedia.org/wiki/Bayes%27_theorem) to estimate the probability that an event has occurred given the state of the observed sensors. If the estimated posterior probability is above the `probability_threshold`, the sensor is `on` otherwise it is `off`.
This allows for the detection of complex events that may not be readily observable, e.g., cooking, showering, in bed, the start of a morning routine, etc. It can also be used to gain greater confidence about events that _are_ directly observable, but for which the sensors can be unreliable, e.g., presence.
@ -36,20 +35,58 @@ binary_sensor:
to_state: 'on'
```
Configuration variables:
- **prior** (*Required*): The prior probability of the event. At any point in time (ignoring all external influences) how likely is this event to occur?
- **probability_threshold** (*Optional*): The probability at which the sensor should trigger to `on`.
- **name** (*Optional*): Name of the sensor to use in the frontend. Defaults to `Bayesian Binary sensor`.
- **observations** array (*Required*): The observations which should influence the likelihood that the given event has occurred.
- **entity_id** (*Required*): Name of the entity to monitor.
- **prob_given_true** (*Required*): The probability of the observation occurring, given the event is `true`.
- **prob_given_false** (*Optional*): The probability of the observation occurring, given the event is `false` can be set as well. If `prob_given_false` is not set, it will default to `1 - prob_given_true`.
- **platform** (*Required*): The only supported observation platforms are `state` and `numeric_state`, which are modeled after their corresponding triggers for automations, requiring `below` and/or `above` instead of `to_state`.
- **to_state** (*Required*): The target state.
{% configuration %}
prior:
description: >
The prior probability of the event. At any point in time
(ignoring all external influences) how likely is this event to occur?
required: true
type: float
probability_threshold:
description: The probability at which the sensor should trigger to `on`.
required: false
type: float
default: 0.5
name:
description: Name of the sensor to use in the frontend.
required: false
type: string
default: Bayesian Binary Sensor
observations:
description: The observations which should influence the likelihood that the given event has occurred.
required: true
type: list
keys:
entity_id:
description: Name of the entity to monitor.
required: true
type: string
prob_given_true:
description: The probability of the observation occurring, given the event is `true`.
required: true
type: float
prob_given_false:
description: The probability of the observation occurring, given the event is `false` can be set as well.
required: false
type: float
default: "`1 - prob_given_true` if `prob_given_false` is not set"
platform:
description: >
The only supported observation platforms are `state` and `numeric_state`,
which are modeled after their corresponding triggers for automations,
requiring `below` and/or `above` instead of `to_state`.
required: true
type: string
to_state:
description: The target state.
required: true
type: string
{% endconfiguration %}
## {% linkable_title Full examples %}
The following is an example for the `state` observation platform.
```yaml
# Example configuration.yaml entry
binary_sensor:
@ -78,6 +115,8 @@ binary_sensor:
to_state: 'below_horizon'
```
Next up an example which targets the `numeric_state` observation platform,
as seen in the configuration it requires `below` and/or `above` instead of `to_state`.
```yaml
# Example configuration.yaml entry

8
source/_components/binary_sensor.bbb_gpio.markdown
View File

@ -48,18 +48,18 @@ pins:
bouncetime:
description: Debounce time for reading input pin defined in milliseconds [ms].
required: false
default: 50
type: integer
default: 50
invert_logic:
description: If `true`, inverts the input logic to ACTIVE LOW
required: false
default: false
type: boolean
default: false
pull_mode:
description: Type of internal pull resistor connected to input. Options are `UP` - pull-up resistor and `DOWN` - pull-down resistor.
required: false
default: UP
type: string
type: string
default: UP
{% endconfiguration %}
For more details about the GPIO layout, visit the [article](http://elinux.org/Beagleboard:BeagleBoneBlack) about the BeagleBone Black.

13
source/_components/binary_sensor.command_line.markdown
View File

@ -13,7 +13,6 @@ ha_release: 0.12
ha_iot_class: "Local Polling"
---
The `command_line` binary sensor platform issues specific commands to get data.
## {% linkable_title Configuration %}
@ -33,10 +32,10 @@ command:
required: true
type: string
name:
description: Let you overwrite the name of the device. By default *name* from the device is used.
description: Let you overwrite the name of the device.
required: false
default: name
type: string
default: "*name* from the device"
device_class:
description: The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.
required: false
@ -44,13 +43,13 @@ device_class:
payload_on:
description: The payload that represents enabled state.
required: false
default: ON
type: string
default: ON
payload_off:
description: The payload that represents disabled state.
required: false
default: OFF
type: string
default: OFF
value_template:
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload.
required: false
@ -58,13 +57,13 @@ value_template:
scan_interval:
description: Defines number of seconds for polling interval.
required: false
default: 60
type: integer
default: 60
command_timeout:
description: Defines number of seconds for command timeout.
required: false
default: 15
type: integer
default: 15
{% endconfiguration %}
## {% linkable_title Examples %}

6
source/_components/binary_sensor.concord232.markdown
View File

@ -14,6 +14,8 @@ ha_release: 0.31
The `concord232` platform provides integration with GE, Interlogix (and other brands) alarm panels that support the RS-232 Automation Control Panel interface module (or have it built in). Supported panels include Concord 4.
## {% linkable_title Configuration %}
To enable this, add the following lines to your `configuration.yaml`:
```yaml
@ -26,11 +28,11 @@ binary_sensor:
host:
description: The host where the concord232 server process is running.
required: false
default: localhost
type: string
default: localhost
port:
description: The port where the Alarm panel is listening.
required: false
default: 5007
type: integer
default: 5007
{% endconfiguration %}

11
source/_components/binary_sensor.ffmpeg_motion.markdown
View File

@ -13,7 +13,6 @@ ha_release: 0.27
redirect_from: /components/binary_sensor.ffmpeg/
---
The `ffmpeg` platform allows you to use any video feed with [FFmpeg](http://www.ffmpeg.org/) for motion sensors in Home Assistant.
<p class='note'>
@ -47,28 +46,28 @@ name:
initial_state:
description: Start `ffmpeg` with Home Assistant.
required: false
default: true
type: boolean
default: true
changes:
description: How much needs to change between two frames to detect it as motion, value in percentage (a lower value is more sensitive).
required: false
default: 10%
type: integer
default: 10
reset:
description: The time to reset the state after no new motion is detected.
required: false
default: 20
type: integer
default: 20
repeat:
description: How many events need to be detected in *repeat_time* in order to trigger a motion, 0 repeats means deactivated.
required: false
default: 0
type: integer
default: 0
repeat_time:
description: The span of time *repeat* events need to occur in before triggering a motion, 0 seconds means deactivated.
required: false
default: 0
type: integer
default: 0
extra_arguments:
description: Extra options to pass to `ffmpeg`, e.g., video denoise filtering.
required: false

9
source/_components/binary_sensor.ffmpeg_noise.markdown
View File

@ -12,7 +12,6 @@ ha_category: Image Processing
ha_release: 0.27
---
The `ffmpeg` platform allows you to use any video or audio feed with [FFmpeg](http://www.ffmpeg.org/) for various sensors in Home Assistant.
<p class='note'>
@ -42,23 +41,23 @@ name:
initial_state:
description: Start ffmpeg with home-assistant.
required: false
default: true
type: boolean
default: true
peak:
description: The threshold of detecting noise, in dB. 0 is very loud and -100 is low.
required: false
default: -30
type: integer
default: -30
duration:
description: How long the noise needs to be over the peak to trigger the state.
required: false
default: 1
type: integer
default: 1
reset:
description: The time to reset the state after no new noise is over the peak.
required: false
default: 20
type: integer
default: 20
extra_arguments:
description: Extra options to pass to `ffmpeg`, like audio frequency filtering.
required: false

12
source/_components/binary_sensor.gc100.markdown
View File

@ -23,7 +23,11 @@ binary_sensor:
- '3:2': Garage Obstruction
```
Configuration variables:
- **ports** (*Required*): A list of module-address to name mappings in the format 'x:y': name, where x is module #, y is address.
{% configuration %}
ports:
description: >
A list of module-address to name mappings in the format `'x:y': name`,
where x is module #, y is address.
required: true
type: list
{% endconfiguration %}

8
source/_components/binary_sensor.knx.markdown
View File

@ -42,14 +42,16 @@ device_class:
significant_bit:
description: Specify which significant bit of the KNX value should be used.
required: false
default: 1
type: integer
default: 1
reset_after:
description: Reset back to OFF state after specified milliseconds.
required: false
type: integer
{% endconfiguration %}
### {% linkable_title Automation actions %}
You can also attach actions to binary sensors (e.g., to switch on a light when a switch was pressed). In this example, one light is switched on when the button was pressed once and two others when the button was pressed a second time.
```yaml
@ -81,13 +83,13 @@ name:
counter:
description: Set to 2 if your only want the action to be executed if the button was pressed twice. To 3 for three times button pressed.
required: false
default: 1
type: integer
default: 1
hook:
description: Indicates if the automation should be executed on what state of the binary sensor. Values are "on" or "off".
required: false
default: "on"
type: string
default: "on"
action:
description: Specify a list of actions analog to the [automation rules](/docs/automation/action/).
required: false

9
source/_components/binary_sensor.linode.markdown
View File

@ -28,9 +28,8 @@ binary_sensor:
```
{% configuration %}
nodes:
description: List of VPSs you want to control.
required: true
type: string
nodes:
description: List of VPSs you want to control.
required: true
type: string
{% endconfiguration %}

10
source/_components/binary_sensor.nx584.markdown
View File

@ -17,6 +17,8 @@ The `nx584` platform provides integration with GE, Caddx, Interlogix (and other
Enabling this sensor platform exposes all of your zones as binary sensors, which provides visibility through the UI as well as the ability to trigger automation actions instantly when something happens like a door opening, or a motion sensor trigger.
## {% linkable_title Configuration %}
To enable this feature, add the following lines to your `configuration.yaml`:
```yaml
@ -29,19 +31,19 @@ binary_sensor:
host:
description: This is the host where the nx584 server process is running. If unset, it is assumed to be `localhost`, which will work if the server process is running on the same system as Home Assistant.
required: false
default: localhost
type: string
default: localhost
port:
description: The port where the server process is running.
required: false
default: 5007
type: integer
default: 5007
exclude_zones:
description: This is a list of zone numbers that should be excluded. Use this to avoid exposing a zone that is of no interest, unconnected, etc.
required: false
type: [list, integer]
zone_types:
description: This is a list of zone numbers mapped to zone types. Use this to designate zones as doors, motion sensors, smoke detectors, etc. See the list of available zone types relevant to alarm zones below.
description: This is a list of zone numbers mapped to zone types. Use this to designate zones as doors, motion sensors, smoke detectors, etc. See the list of available zone types relevant to alarm zones below.
required: false
type: map
keys:
@ -59,6 +61,8 @@ zone_types:
description: Safety
{% endconfiguration %}
## {% linkable_title Full example %}
An extended configuration entry could look like this:
```yaml

13
source/_components/binary_sensor.octoprint.markdown
View File

@ -13,13 +13,13 @@ ha_release: 0.19
ha_iot_class: "Local Polling"
---
The `octoprint` sensor platform let you monitor various states of your 3D printer and its print jobs.
The `octoprint` binary sensor platform let you monitor if your 3D printer is printing or if there was a printing error.
<p class='note'>
You must have the [OctoPrint component](/components/octoprint/) configured to use this binary sensor. After configuring that component, binary sensors automatically appear.
</p>
<<<<<<< HEAD
=======
## {% linkable_title Configuration %}
To set it up, add the following information to your `configuration.yaml` file:
@ -42,9 +42,8 @@ monitored_conditions:
printing error:
description: Error while printing.
name:
description:
required: The name of the sensor.
default: OctoPrint
description: The name of the sensor.
required: false
type: string
default: OctoPrint
{% endconfiguration %}
>>>>>>> current

10
source/_components/binary_sensor.rfxtrx.markdown
View File

@ -21,7 +21,7 @@ them may be recognized under the X10 protocol but most of them are recognized
under the *Lighting4* protocol. The rfxtrx binary sensor component provides
some special options for them, while other rfxtrx protocols should work too.
# Setting up your devices
## {% linkable_title Setting up your devices %}
Once you have set up your [rfxtrx hub](/components/rfxtrx/), the easiest way
to find your binary sensors is to add this to your `configuration.yaml`:
@ -67,8 +67,8 @@ devices:
fire_event:
description: Fires an event even if the state is the same as before. Can be used for automations.
required: false
default: false
type: boolean
default: false
off_delay:
description: For sensors that only sends 'On' state updates, this variable sets a delay after which the sensor state will be updated back to 'Off'.
required: false
@ -88,8 +88,8 @@ devices:
automatic_add:
description: To enable the automatic addition of new binary sensors.
required: false
default: false
type: boolean
default: false
{% endconfiguration %}
<p class='note warning'>
@ -131,7 +131,7 @@ binary_sensor:
seconds: 5
```
## Options for PT-2262 devices under the Lighting4 protocol
### {% linkable_title Options for PT-2262 devices under the Lighting4 protocol %}
When a data packet is transmitted by a PT-2262 device using the Lighting4
protocol, there is no way to automatically extract the device identifier and the
@ -201,7 +201,7 @@ This automatic guess should work most of the time but there is
no guarantee on that. You should activate it only when you
want to configure your new devices and leave it off otherwise.
## Known working devices
### {% linkable_title Known working devices %}
The following devices are known to work with the rfxtrx binary sensor component.
There are too many other to list.

36
source/_components/binary_sensor.rpi_gpio.markdown
View File

@ -28,13 +28,33 @@ binary_sensor:
12: PIR Bedroom
```
Configuration variables:
- **ports** array (*Required*): Array of used ports.
- **port: name** (*Required*): Port numbers (BCM mode pin numbers) and corresponding names.
- **pull_mode** (*Optional*): The internal pull to use (UP or DOWN). Default is UP.
- **bouncetime** (*Optional*): The time in milliseconds for port debouncing. Default is 50ms.
- **invert_logic** (*Optional*): If true, inverts the output logic to ACTIVE LOW. Default is false (ACTIVE HIGH).
{% configuration %}
ports:
description: List of used ports.
required: true
type: map
keys:
"port: name":
description: The port numbers (BCM mode pin numbers) and corresponding names.
required: true
type: string
bouncetime:
description: The time in milliseconds for port debouncing.
required: false
type: integer
default: 50
invert_logic:
description: If `true`, inverts the output logic to ACTIVE LOW.
required: false
type: boolean
default: "`false` (ACTIVE HIGH)"
pull_mode:
description: >
Type of internal pull resistor to use.
Options are `UP` - pull-up resistor and `DOWN` - pull-down resistor.
required: false
type: string
default: "`UP`"
{% endconfiguration %}
For more details about the GPIO layout, visit the Wikipedia [article](https://en.wikipedia.org/wiki/Raspberry_Pi#GPIO_connector) about the Raspberry Pi.

34
source/_components/binary_sensor.rpi_pfio.markdown
View File

@ -32,11 +32,29 @@ binary_sensor:
settle_time: 50
```
Configuration variables:
- **ports** array (*Required*): Array of used ports.
- **num** (*Required*): Port number.
- **name** (*Required*): Port name.
- **settle_time** (*Optional*): The time in milliseconds for port debouncing. Default is 2 0ms.
- **invert_logic** (*Optional*): If true, inverts the output logic to ACTIVE LOW. Default is false (ACTIVE HIGH).
{% configuration %}
ports:
description: List of used ports.
required: true
type: map
keys:
num:
description: The port number.
required: true
type: map
keys:
name:
description: The port name.
required: true
type: string
settle_time:
description: The time in milliseconds for port debouncing.
required: false
type: integer
default: 20
invert_logic:
description: If `true`, inverts the output logic to ACTIVE LOW.
required: false
type: boolean
default: "`false` (ACTIVE HIGH)"
{% endconfiguration %}

4
source/_components/binary_sensor.skybell.markdown
View File

@ -30,9 +30,9 @@ binary_sensor:
{% configuration %}
monitored_conditions:
type: list
required: true
description: Conditions to display in the frontend. The following conditions can be monitored.
required: true
type: list
keys:
button:
description: Returns whether the doorbell button was pressed.

76
source/_components/binary_sensor.tcp.markdown
View File

@ -14,53 +14,57 @@ ha_release: 0.14
The TCP Binary Sensor is a type of [TCP Sensor](/components/sensor.tcp/) which is either "off" or "on". In order to use this sensor type, in addition to the configuration for the TCP Sensor, you must supply a `value_on` value to represent what is returned when the device is turned on.
## {% linkable_title Configuration %}
To enable this sensor, add the following lines to your `configuration.yaml`:
```yaml
binary_sensor:
# Example configuration.yaml entry
platform: tcp
name: TCP Binary Sensor
host: IP_ADDRESS
port: PORT
payload: "r State\n"
value_on: 1
timeout: 5
binary_sensor:
- platform: tcp
name: TCP Binary Sensor
host: IP_ADDRESS
port: PORT
payload: "r State\n"
value_on: 1
timeout: 5
```
Configuration options for the a TCP Sensor:
{% configuration %}
name:
required: true
description: The name you'd like to give the sensor in Home Assistant.
type: string
description: The name you'd like to give the sensor in Home Assistant.
required: false
type: string
default: TCP Sensor
host:
required: true
description: The hostname/IP address to connect to.
type: string
description: The hostname/IP address to connect to.
required: true
type: string
port:
required: true
description: The port to connect to the host on.
type: integer
description: The port to connect to the host on.
required: true
type: integer
payload:
required: true
description: What to send to the host in order to get the response we're interested in.
type: string
description: What to send to the host in order to get the response we're interested in.
required: true
type: string
value_on:
required: true
description: The value returned when the device is "on".
type: string
timeout:
required: false
description: How long in seconds to wait for a response from the service before giving up and disconnecting. Defaults to 10.
type: integer
description: The value returned when the device is "on".
required: true
type: string
value_template:
required: false
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the value. By default it's assumed that the entire response is the value.
type: string
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the value.
required: false
type: template
default: entire response is the value
buffer_size:
required: false
description: The size of the receive buffer in bytes. Set this to a larger value if you expect to receive a response larger than the default. Defaults to 1024.
type: integer
{% endconfiguration %}
description: The size of the receive buffer in bytes. Set this to a larger value if you expect to receive a response larger than the default.
required: false
type: integer
default: 1024
timeout:
description: How long in seconds to wait for a response from the service before giving up and disconnecting.
required: false
type: integer
default: 10
{% endconfiguration %}

2
source/_components/binary_sensor.template.markdown
View File

@ -18,6 +18,8 @@ The `template` platform supports sensors which break out the `state` and
`state_attributes` from other entities. The state of a Template Binary Sensor
can only be `on` or `off`.
## {% linkable_title Configuration %}
To enable Template Binary Sensors in your installation, add the following to
your `configuration.yaml` file:

2
source/_components/binary_sensor.vera.markdown
View File

@ -14,5 +14,5 @@ ha_release: pre 0.7
---
The `vera` platform allows you to get data from your [Vera](http://getvera.com/) binary sensors from within Home Assistant.
They will be automatically discovered if the vera component is loaded.

2
source/_components/binary_sensor.verisure.markdown
View File

@ -16,4 +16,4 @@ Integrates Verisure binary sensors into Home Assistant. See the [main component]
The following binary sensor types are supported:
Door & Window
- Door & Window

4
source/_components/binary_sensor.vultr.markdown
View File

@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling"
The `vultr` binary sensor platform allows you to monitor your [Vultr](https://www.vultr.com/) subscription to see if it is powered on or not.
## {% linkable_title Configuration %}
To use this binary sensor, you first have to set up your [Vultr hub](/components/vultr/).
<p class='note'>
@ -42,6 +44,7 @@ name:
type: string
{% endconfiguration %}
## {% linkable_title Full example %}
Full `configuration.yaml` (produces `binary_sensor.totally_awesome_server`):
@ -51,4 +54,3 @@ binary_sensor:
name: totally_awesome_server
subscription: 12345
```

3
source/_components/binary_sensor.wink.markdown
View File

@ -13,12 +13,10 @@ ha_release: 0.14
ha_iot_class: "Cloud Polling"
---
The Wink binary sensor platform allows you to get data from your [Wink](http://www.wink.com/) binary sensors.
The requirement is that you have setup [Wink](/components/wink/).
### {% linkable_title Supported Binary sensor devices %}
- Smoke and CO detectors (No Wink hub required for Nest)
@ -36,4 +34,3 @@ The requirement is that you have setup [Wink](/components/wink/).
<p class='note'>
The above devices are confirmed to work, but others may work as well.
</p>

1
source/_components/binary_sensor.wirelesstag.markdown
View File

@ -56,4 +56,3 @@ monitored_conditions:
battery:
description: On means tag battery is low, Off means normal.
{% endconfiguration %}

2
source/_components/binary_sensor.workday.markdown
View File

@ -82,6 +82,8 @@ If you use the sensor for Canada (`CA`) with Ontario (`ON`) as `province:` then
Otherwise the value is evaluated as `true` (check the YAML documentation for further details) and the sensor will not work.
</p>
## {% linkable_title Automation example %}
Example usage for automation:
```yaml

2
source/_components/binary_sensor.xiaomi_aqara.markdown
View File

@ -13,12 +13,10 @@ ha_release: "0.50"
ha_iot_class: "Local Push"
---
The `xiaomi aqara` binary sensor platform allows you to get data from your [Xiaomi](http://www.mi.com/en/) binary sensors.
The requirement is that you have setup the [`xiaomi aqara` component](/components/xiaomi_aqara/).
### {% linkable_title Type of sensors supported %}
| Name | ZigBee entity | Model no. | States | Event | Event key | Event values |

2
source/_components/binary_sensor.zigbee.markdown
View File

@ -15,6 +15,8 @@ ha_iot_class: "Local Polling"
A `zigbee` binary sensor in this context is a device connected to one of the digital input pins on a [ZigBee](http://www.zigbee.org/) module. The states reported by such a device are limited to `on` or `off`. By default, a binary sensor is considered `on` when the ZigBee device's digital input pin is held 'high' and considered `off` when it is held `low`. This behavior can be inverted by setting the `on_state` configuration variable to `low`.
## {% linkable_title Configuration %}
To enable a digital input pin as binary sensor in your installation, add the following lines to your `configuration.yaml`:
```yaml

2
source/_components/blink.markdown
View File

@ -129,4 +129,4 @@ homeassistant:
### {% linkable_title Other Services %}
In addition to the services mentioned above, there are generic `camera` and `alarm_control_panel` services available for use as well. The `camera.enable_motion_detection` and `camera.disable_motion_detection` services allow for individual cameras to be enabled and disabled, respectively, within the Blink system. The `alarm_control_panel.alarm_arm_away` and `alarm_control_panel.alarm_disarm` services allow for the whole system to be armed and disarmed, respectively.
In addition to the services mentioned above, there are generic `camera` and `alarm_control_panel` services available for use as well. The `camera.enable_motion_detection` and `camera.disable_motion_detection` services allow for individual cameras to be enabled and disabled, respectively, within the Blink system. The `alarm_control_panel.alarm_arm_away` and `alarm_control_panel.alarm_disarm` services allow for the whole system to be armed and disarmed, respectively.

10
source/_components/bmw_connected_drive.markdown
View File

@ -23,6 +23,8 @@ This component provides the following platforms:
- Lock: Control the lock of your car.
- Sensors: Mileage, remaining range, remaining fuel, charging time remaining (electric cars), charging status (electric cars), remaining range electric (electric cars).
## {% linkable_title Configuration %}
To enable this component in your installation, add the following to your
`configuration.yaml` file:
@ -78,13 +80,13 @@ The vehicle can be locked and unlocked via the lock component that is created au
The air condition of the vehicle can be activated with the service `bmw_connected_drive.activate_air_conditioning`.
What exactly is started here depends on the type of vehicle. It might range from just ventilation over auxiliary heating to real air conditioning. If your vehicle is equipped with auxiliary heating, only trigger this service if the vehicle is parked in a location where it is safe to use it (e.g., not in an underground parking or closed garage).
What exactly is started here depends on the type of vehicle. It might range from just ventilation over auxiliary heating to real air conditioning. If your vehicle is equipped with auxiliary heating, only trigger this service if the vehicle is parked in a location where it is safe to use it (e.g., not in an underground parking or closed garage).
The vehicle is identified via the parameter `vin`.
### {% linkable_title Sound the horn %}
The service `bmw_connected_drive.sound_horn` sounds the horn of the vehicle. This option is not available in some countries (among which the UK). Use this feature responsibly, as it might annoy your neighbors. The vehicle is identified via the parameter `vin`.
The service `bmw_connected_drive.sound_horn` sounds the horn of the vehicle. This option is not available in some countries (among which the UK). Use this feature responsibly, as it might annoy your neighbors. The vehicle is identified via the parameter `vin`.
### {% linkable_title Flash the lights %}
@ -92,10 +94,10 @@ The service `bmw_connected_drive.light_flash` flashes the lights of the vehicle.
### {% linkable_title Update the state %}
The service `bmw_connected_drive.update_state` fetches the last state of the vehicles of all your accounts from the BMW server. This does *not* trigger an update from the vehicle; it gets the data from the BMW servers. So this service does *not* interact with your vehicles.
The service `bmw_connected_drive.update_state` fetches the last state of the vehicles of all your accounts from the BMW server. This does *not* trigger an update from the vehicle; it gets the data from the BMW servers. So this service does *not* interact with your vehicles.
This service does not require any attributes.
## {% linkable_title Disclaimer %}
This software is not affiliated with or endorsed by BMW Group.
This software is not affiliated with or endorsed by BMW Group.

5
source/_components/browser.markdown
View File

@ -12,9 +12,10 @@ ha_category: Utility
ha_qa_scale: internal
---
The `browser` component provides a service to open URLs in the default browser on the host machine.
## {% linkable_title Configuration %}
To load this component, add the following lines to your `configuration.yaml`:
```yaml
@ -22,7 +23,7 @@ To load this component, add the following lines to your `configuration.yaml`:
browser:
```
#### {% linkable_title Service `browser/browse_url` %}
#### {% linkable_title Service `browser/browse_url` %}
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |

2
source/_components/calendar.google.markdown
View File

@ -177,7 +177,7 @@ Trigger as soon as an event starts:
to: 'on'
```
By using specific text in the event title, you can set conditions to initiate particular automation flows on designated events while other events will be ignored.
By using specific text in the event title, you can set conditions to initiate particular automation flows on designated events while other events will be ignored.
For example, the actions following this condition will only be executed for events named 'vacation':

2
source/_components/camera.amcrest.markdown
View File

@ -15,6 +15,8 @@ ha_release: 0.34
To get your [Amcrest](https://amcrest.com/) cameras working within Home Assistant, please follow the instructions for the general [Amcrest component](/components/amcrest).
## {% linkable_title Configuration %}
Once you have enabled the [Amcrest component](/components/amcrest), add the following to your `configuration.yaml` file:
```yaml

4
source/_components/camera.android_ip_webcam.markdown
View File

@ -13,9 +13,10 @@ ha_release: "0.40"
ha_iot_class: "Local Polling"
---
The `android_ip_webcam` component adds a camera by default if you choose not to use the component but still want to see the video feed then the [`mjpeg` camera](/components/camera.mjpeg/) platform can be used.
## {% linkable_title Configuration %}
To enable only the camera in your installation, add the following to your `configuration.yaml` file:
```yaml
@ -24,4 +25,3 @@ camera:
- platform: mjpeg
mjpeg_url: http://IP_ADDRESS:8080/video
```

2
source/_components/camera.arlo.markdown
View File

@ -17,6 +17,8 @@ To get your [Arlo](https://arlo.netgear.com/) cameras working within Home Assist
This component is not yet able to live stream from your Arlo camera, but it will be able to playback the last video capture.
## {% linkable_title Configuration %}
Once you have enabled the [Arlo component](/components/arlo), add the following to your `configuration.yaml` file:
```yaml

1
source/_components/camera.bloomsky.markdown
View File

@ -13,7 +13,6 @@ ha_release: 0.13
ha_iot_class: "Local Polling"
---
The `bloomsky` camera component allows you to view the current photo created by the camera in the [BloomSky](https://www.bloomsky.com) weather station. This can work in concert with [BloomSky sensors](/components/sensor.bloomsky).
## {% linkable_title Configuration %}

10
source/_components/camera.canary.markdown
View File

@ -17,6 +17,8 @@ The `canary` camera platform allows you to watch the live stream of your [Canary
To add `canary` camera to your installation, follow instructions in [Canary component](/components/canary/). Once you have [Canary component](/components/canary/) setup, your [Canary](https://canary.is) camera(s) should show up automatically.
## {% linkable_title Configuration %}
You can add the following to your `configuration.yaml` file to configure `canary` camera with optional settings:
```yaml
@ -25,8 +27,8 @@ camera:
```
{% configuration %}
ffmpeg_arguments:
description: Extra options to pass to `ffmpeg`, e.g., image quality or video filter options. More details in [FFmpeg component](/components/ffmpeg).
required: false
type: string
ffmpeg_arguments:
description: Extra options to pass to `ffmpeg`, e.g., image quality or video filter options. More details in [FFmpeg component](/components/ffmpeg).
required: false
type: string
{% endconfiguration %}

2
source/_components/camera.dispatcher.markdown
View File

@ -19,6 +19,8 @@ This platform is meant for developers only.
The `dispatcher` camera platform allows developers to create virtual camera's.
## {% linkable_title Configuration %}
You would normally not add this camera to your configuration directly but have it be discovered by one of the components that uses it.
```yaml

2
source/_components/camera.doorbird.markdown
View File

@ -19,6 +19,8 @@ The `doorbird` implementation allows you to view the live video and previous ima
You must have the [DoorBird component](/components/doorbird/) configured to use this camera.
</p>
## {% linkable_title Configuration %}
To enable the camera, add the following to your `configuration.yaml` file:
```yaml

4
source/_components/camera.ffmpeg.markdown
View File

@ -13,9 +13,10 @@ ha_release: 0.26
ha_iot_class: "Local Polling"
---
The `ffmpeg` platform allows you to use any video feed as a camera in Home Assistant via [FFmpeg](http://www.ffmpeg.org/). This video source must support multiple simultaneous reads, because for every concurrent Home Assistant user, a connection will be made to the source every 10 seconds. Normally this should not be a problem.
## {% linkable_title Configuration %}
To enable your FFmpeg feed in your installation, add the following to your `configuration.yaml` file:
```yaml
@ -44,5 +45,4 @@ extra_arguments:
You can control the image quality with [`extra_arguments`](https://www.ffmpeg.org/ffmpeg-codecs.html#jpeg2000) `-q:v 2-32` or with lossless option `-pred 1`.
If you are running into trouble with this sensor, please refer to the [Troubleshooting section](/components/ffmpeg/#troubleshooting).

1
source/_components/camera.foscam.markdown
View File

@ -12,7 +12,6 @@ ha_category: Camera
ha_iot_class: "Local Polling"
---
The `foscam` platform allows you to watch the live stream of your [Foscam](http://www.foscam.com/) IP camera in Home Assistant.
## {% linkable_title Configuration %}

3
source/_components/camera.generic.markdown
View File

@ -13,11 +13,12 @@ ha_release: pre 0.7
ha_iot_class: "depends"
---
The `generic` camera platform allows you to integrate any IP camera or other URL into Home Assistant. Templates can be used to generate the URLs on the fly.
Home Assistant will serve the images via its server, making it possible to view your IP cameras while outside of your network. The endpoint is `/api/camera_proxy/camera.[name]`.
## {% linkable_title Configuration %}
To enable this camera in your installation, add the following to your `configuration.yaml` file:
```yaml

2
source/_components/camera.local_file.markdown
View File

@ -17,6 +17,8 @@ The `local_file` camera platform allows you to integrate an image file from disk
The `local_file` camera can for example be used with various camera platforms that save a temporary images locally. It can also be used to display a graph that you render periodically and will then be displayed in Home Assistant.
## {% linkable_title Configuration %}
To enable this camera in your installation, add the following to your `configuration.yaml` file:
```yaml

2
source/_components/camera.logi_circle.markdown
View File

@ -35,8 +35,8 @@ camera:
scan_interval:
description: How frequently to query for new camera stills, value are in seconds.
required: false
default: 60
type: integer
default: 60
{% endconfiguration %}
### {% linkable_title Service `camera.logi_circle_livestream_record` %}

4
source/_components/camera.markdown
View File

@ -9,10 +9,9 @@ sharing: true
footer: true
---
The camera component allows you to use IP cameras with Home Assistant. With a little additional work you could use [USB cameras](/blog/2016/06/23/usb-webcams-and-home-assistant/) as well.
### {% linkable_title Service %}
### {% linkable_title Services %}
Once loaded, the `camera` platform will expose services that can be called to perform various actions.
@ -82,4 +81,3 @@ A simple way to test if you have set up your `camera` platform correctly, is to
"entity_id": "camera.living_room_camera"
}
```

2
source/_components/camera.mjpeg.markdown
View File

@ -16,6 +16,8 @@ ha_iot_class: "depends"
The `mjpeg` camera platform allows you to integrate IP cameras which are capable
to stream their video with MJPEG into Home Assistant.
## {% linkable_title Configuration %}
To enable this camera in your installation,
add the following to your `configuration.yaml` file:

30
source/_components/camera.mqtt.markdown
View File

@ -17,6 +17,8 @@ The `mqtt` camera platform allows you to integrate the content of an image file
This can be used with an application or a service capable of sending images through MQTT, for example [Zanzito](https://play.google.com/store/apps/details?id=it.barbaro.zanzito).
## {% linkable_title Configuration %}
To enable this camera in your installation, add the following to your `configuration.yaml` file:
```yaml
@ -27,18 +29,18 @@ camera:
```
{% configuration %}
topic:
description: MQTT topic to subscribe to.
required: true
type: string
name:
description: Name of the camera.
required: false
type: string
unique_id:
description: >
An ID that uniquely identifies this camera. If two cameras have the same unique ID
Home Assistant will raise an exception.
required: false
type: string
topic:
description: MQTT topic to subscribe to.
required: true
type: string
name:
description: Name of the camera.
required: false
type: string
unique_id:
description: >
An ID that uniquely identifies this camera. If two cameras
have the same unique ID Home Assistant will raise an exception.
required: false
type: string
{% endconfiguration %}

1
source/_components/camera.neato.markdown
View File

@ -13,7 +13,6 @@ ha_release: 0.42
ha_iot_class: "Cloud Polling"
---
The `neato` camera platform allows you to view the latest cleaning map of your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/).
To add `neato` camera to your installation, follow instructions in [Neato component](/components/neato/).

4
source/_components/camera.netatmo.markdown
View File

@ -13,10 +13,10 @@ ha_release: 0.22
ha_iot_class: "Local Polling"
---
### {% linkable_title Basic Configuration %}
The `netatmo` camera platform is consuming the information provided by a [Netatmo](https://www.netatmo.com) camera. This component allows you to view the current photo created by the Camera.
### {% linkable_title Basic configuration %}
To enable the Netatmo camera, you have to set up [netatmo](/components/netatmo/), this will use discovery to add your camera.
### {% linkable_title Advanced configuration %}

7
source/_components/camera.onvif.markdown
View File

@ -12,9 +12,10 @@ ha_category: Camera
ha_release: 0.47
---
The `onvif` camera platform allows you to use an ONVIF camera in Home Assistant. This requires the [`ffmpeg` component](/components/ffmpeg/) to be already configured.
## {% linkable_title Configuration %}
To enable your ONVIF camera in your installation, add the following to your `configuration.yaml` file:
```yaml
@ -44,13 +45,13 @@ password:
port:
description: The port for the camera.
required: false
default: 5000
type: integer
default: 5000
profile:
description: Video profile that will be used to obtain the stream, more details below.
required: false
default: 0
type: integer
default: 0
extra_arguments:
description: "Extra options to pass to `ffmpeg`, e.g., image quality or video filter options. More details in [FFmpeg component](/components/ffmpeg)."
required: false

80
source/_components/camera.proxy.markdown
View File

@ -11,13 +11,14 @@ ha_category: Camera
ha_release: 0.65
---
The `proxy` camera platform allows you to pass another camera's output through post-processing routines and generate a new camera with the post-processed output.
The current post-processing supports resizing the image/MJPEG as well as limiting the maximum refresh rate.
The current proxy capabilities are intended to reduce the camera bandwidth for slower internet connections.
## {% linkable_title Configuration %}
To enable this camera in your installation, you must first have an existing working camera configured in Home Assistant. Next, add the following to your `configuration.yaml` file:
```yaml
@ -30,47 +31,46 @@ camera:
```
{% configuration %}
entity_id:
description: The ID of another Home Assistant camera to post-process.
required: true
type: string
name:
description: This parameter allows you to override the name of your camera.
required: false
type: string
max_image_width:
description: The maximum width of single images taken from the camera (aspect ratio will be maintained).
required: false
type: integer
max_stream_width:
description: The maximum width of the MJPEG stream from the camera (aspect ratio will be maintained).
required: false
type: integer
image_quality:
description: The quality level used for resulting JPEG for snapshots.
required: false
type: integer
default: 75
stream_quality:
description: The quality level used for resulting MJPEG streams.
required: false
type: integer
default: 75
image_refresh_rate:
description: The minimum time in seconds between generating successive image snapshots.
required: false
type: float
force_resize:
description: Resize the image even if the resulting image would take up more bandwidth than the original.
required: false
type: boolean
cache_images:
description: Preserve the last image and re-send in the case the camera is not responding.
required: false
type: boolean
entity_id:
description: The ID of another Home Assistant camera to post-process.
required: true
type: string
name:
description: This parameter allows you to override the name of your camera.
required: false
type: string
max_image_width:
description: The maximum width of single images taken from the camera (aspect ratio will be maintained).
required: false
type: integer
max_stream_width:
description: The maximum width of the MJPEG stream from the camera (aspect ratio will be maintained).
required: false
type: integer
image_quality:
description: The quality level used for resulting JPEG for snapshots.
required: false
type: integer
default: 75
stream_quality:
description: The quality level used for resulting MJPEG streams.
required: false
type: integer
default: 75
image_refresh_rate:
description: The minimum time in seconds between generating successive image snapshots.
required: false
type: float
force_resize:
description: Resize the image even if the resulting image would take up more bandwidth than the original.
required: false
type: boolean
cache_images:
description: Preserve the last image and re-send in the case the camera is not responding.
required: false
type: boolean
{% endconfiguration %}
## {% linkable_title Examples %}
Example of using a Camera proxy along with a Foscam camera:

12
source/_components/camera.push.markdown
View File

@ -19,7 +19,7 @@ Optionally the Push Camera can **buffer** a given number of images, creating an
Images are cleared on new events, and events are separated by a soft (configurable) **timeout**.
## Integration with motionEye
## {% linkable_title Integration with motionEye %}
The `push` camera can as an example be used with [motionEye](https://github.com/ccrisan/motioneye/wiki) a web frontend for the motion daemon. motionEye is usually configured to save/record files ***only*** when motion is detected. It provides a hook to run a command whenever an image is saved, which can be used together with cURL to send the motion detected images to the `push` camera, as shown in this example:
@ -57,25 +57,25 @@ camera:
name:
description: The name you would like to give to the camera.
required: false
default: Push Camera
type: string
default: Push Camera
buffer:
description: Number of images to buffer per event. Be conservative, large buffers will starve your system memory.
required: false
default: 1
type: string
default: 1
timeout:
description: Amount of time after which the event is considered to have finished.
required: false
default: 5 seconds
type: time
default: 5 seconds
token:
description: User provided token acting as access control, should be a large string (more then 8 chars). Required if you can't use HA new auth system (0.77).
required: false
required: false
type: string
field:
description: HTTP POST field containing the image file
required: false
default: image
type: string
default: image
{% endconfiguration %}

2
source/_components/camera.ring.markdown
View File

@ -33,8 +33,8 @@ ffmpeg_arguments:
scan_interval:
description: How frequently to query for new video in seconds.
required: false
default: 90
type: integer
default: 90
{% endconfiguration %}
**Note:** To be able to playback the last capture, it is required to install the `ffmpeg` component. Make sure to follow the steps mentioned at [FFMPEG](/components/ffmpeg/) documentation.

22
source/_components/camera.rpi_camera.markdown
View File

@ -13,7 +13,6 @@ ha_iot_class: "Local Polling"
ha_release: 0.17
---
The `rpi_camera` platform allows you to integrate the Raspberry Pi camera into Home Assistant. This component uses the application [`raspistill`](https://www.raspberrypi.org/documentation/usage/camera/raspicam/raspistill.md) to store the image from camera.
## {% linkable_title Configuration %}
@ -30,49 +29,48 @@ camera:
image_width:
description: Set the image width.
required: false
default: 640
type: integer
default: 640
name:
description: Name of the camera.
required: false
default: Raspberry Pi Camera
type: string
default: Raspberry Pi Camera
image_height:
description: Set the image height.
required: false
default: 480
type: integer
default: 480
image_quality:
description: Set the image quality (from 0 to 100).
required: false
default: 7
type: integer
default: 7
image_rotation:
description: Set image rotation (0-359).
required: false
default: 0
type: integer
default: 0
horizontal_flip:
description: Set horizontal flip (0 to disable, 1 to enable).
required: false
default: 0
type: integer
default: 0
vertical_flip:
description: Set vertical flip (0 to disable, 1 to enable).
required: false
default: 0
type: integer
default: 0
timelapse:
description: Takes a picture every this many milliseconds (thousands of a second) - the default means one picture a second.
required: false
default: 1000
type: integer
default: 1000
file_path:
description: Save the picture in a custom file path.
required: false
default: A temporary file is used.
type: string
default: A temporary file is used.
{% endconfiguration %}
The given **file_path** must be an existing file because the camera platform setup performs a writeable check on it. Also, keep in mind that the path should be [whitelisted](/docs/configuration/basic/).
The given **file_path** must be an existing file because the camera platform setup performs a writeable check on it. Also, keep in mind that the path should be [whitelisted](/docs/configuration/basic/).

7
source/_components/camera.synology.markdown
View File

@ -13,7 +13,6 @@ ha_release: 0.31
ha_iot_class: "Local Polling"
---
　
The `synology` camera platform allows you to watch the live streams of your [Synology](https://www.synology.com/) Surveillance Station based IP cameras in Home Assistant.
## {% linkable_title Configuration %}
@ -33,8 +32,8 @@ camera:
name:
description: A name for this Synology camera.
required: false
default: Synology Camera
type: string
default: Synology Camera
url:
description: The URL to your Synology, including port.
required: true
@ -50,8 +49,8 @@ password:
timeout:
description: The timeout in seconds used when connecting to the Surveillance Station.
required: false
default: 5
type: integer
default: 5
whitelist:
description: A list of which cameras you want to add, the names must be the same as in Surveillance Station. If omitted all cameras are added.
required: false
@ -59,8 +58,8 @@ whitelist:
verify_ssl:
description: Verify SSL/TLS certificate for HTTPS request.
required: false
default: true
type: boolean
default: true
{% endconfiguration %}
## {% linkable_title Full example %}

3
source/_components/camera.usps.markdown
View File

@ -13,13 +13,14 @@ ha_release: 0.52
ha_iot_class: "Cloud Polling"
---
The `usps` camera component allows you to view the mail piece images made available through USPS via the Informed Delivery service. You must "Opt-In" to [Informed Delivery](https://informeddelivery.usps.com/box/pages/intro/start.action) to see mail images. This works in concert with [USPS sensors](/components/sensor.usps).
<p class='note'>
You must have the [USPS component](/components/usps/) configured to use this camera. The camera will be setup if the `usps` component is configured and the required configuration is set.
</p>
## {% linkable_title Configuration %}
To customize the interval that mail images are rotated in the mail camera you can edit your `configuration.yaml` file with the following settings:
```yaml
# Example configuration.yaml entry

1
source/_components/camera.uvc.markdown
View File

@ -56,4 +56,3 @@ password:
type: string
default: ubnt
{% endconfiguration %}

2
source/_components/camera.verisure.markdown
View File

@ -13,8 +13,6 @@ ha_release: 0.31
ha_iot_class: "Local Polling"
---
The `verisure` camera platform allows you to control your [Verisure](https://www.verisure.com/) cameras.
The requirement is that you have setup your [Verisure hub](/components/verisure/).

10
source/_components/camera.xeoma.markdown
View File

@ -15,6 +15,8 @@ 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.
## {% linkable_title Configuration %}
To enable Xeoma camera feeds, add the following lines to your `configuration.yaml`:
```yaml
@ -40,8 +42,8 @@ password:
new_version:
description: Set to false if the Xeoma server version is 17.5 or earlier.
required: false
default: true
type: boolean
default: true
cameras:
description: List of customizations for individual Xeoma cameras.
required: false
@ -54,16 +56,16 @@ cameras:
name:
description: The name to display in the frontend for this camera.
required: false
default: The `image_name` for this camera.
type: string
default: The `image_name` for this camera.
hide:
description: Don't show this camera in Home Assistant.
required: false
default: false
type: boolean
default: false
{% endconfiguration %}
## {% linkable_title Full examples %}
## {% linkable_title Full example %}
```yaml
# Example configuration.yaml entry

7
source/_components/camera.xiaomi.markdown
View File

@ -76,16 +76,15 @@ password:
path:
description: The path to the raw MP4 files.
required: false
default: /media/mmcblk0p1/record
type: string
default: /media/mmcblk0p1/record
username:
description: The user that can access the FTP server.
required: false
default: root
type: string
default: root
ffmpeg_arguments:
description: >
Extra options to pass to `ffmpeg`
description: Extra options to pass to `ffmpeg`.
required: false
type: string
{% endconfiguration %}

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

@ -81,13 +81,13 @@ password:
path:
description: The path to the raw MP4 files.
required: false
default: /media/mmcblk0p1/record
type: string
default: /media/mmcblk0p1/record
username:
description: The user that can access the FTP server.
required: false
default: root
type: string
default: root
ffmpeg_arguments:
description: Extra options to pass to `ffmpeg` (e.g., image quality or video filter options).
required: false

3
source/_components/camera.zoneminder.markdown
View File

@ -13,13 +13,14 @@ ha_release: 0.39
ha_iot_class: "Local Polling"
---
The `zoneminder` camera platform lets you monitor the current stream of your [ZoneMinder](https://www.zoneminder.com) cameras.
<p class='note'>
You must have the [ZoneMinder component](/components/zoneminder/) configured to view the camera stream.
</p>
## {% linkable_title Configuration %}
To set it up, add the following information to your `configuration.yaml` file:
```yaml

26
source/_components/canary.markdown
View File

@ -29,19 +29,19 @@ canary:
```
{% configuration %}
username:
description: The username for accessing your Canary account.
required: true
type: string
password:
description: The password for accessing your Canary account.
required: true
type: string
timeout:
description: Timeout to wait for connections.
required: false
type: integer
default: 10
username:
description: The username for accessing your Canary account.
required: true
type: string
password:
description: The password for accessing your Canary account.
required: true
type: string
timeout:
description: Timeout to wait for connections.
required: false
type: integer
default: 10
{% endconfiguration %}
Once loaded, your front end will have the following components:

4
source/_components/device_tracker.gpslogger.markdown
View File

@ -15,7 +15,7 @@ The `gpslogger` device tracker platform allows you to detect presence using [GPS
## {% linkable_title Auth change release 0.77 and above %}
Since release 0.77, we now have long-lived access tokens. These are setup under your profile.
Since release 0.77, we now have long-lived access tokens. These are setup under your profile and configured in the GPSLogger application on your smartphone as explained below.
```yaml
# Example configuration.yaml entry
@ -80,7 +80,7 @@ Add the above URL after you modified it with your settings into the **URL** fiel
- Use the domain that Home Assistant is available on the internet (or the public IP address if you have a static IP address). This can be a local IP address if you are using an always on VPN from your mobile device to your home network.
- Only remove `PORT` if your Home Assistant instance is using port 443. Otherwise set it to the port you're using.
- For Home Assistant only the above URL, as written, will work - do not add, remove, or change the order of any of the parameters.
- **0.77+** If you are using Long-Lived access tokens, then add `Authentication: Bearer LLAT` to the HTTP Headers setting
- **0.77+** If you are using Long-Lived access tokens, then add `Authentication: Bearer LLAT` to the HTTP Headers setting (replace `LLAT` with your Long Lived Access Token).
- **<0.77** Make sure to include your [API password](/components/http/) if you have configured a password. Add `&api_password=YOUR_PASSWORD` to the end of the URL.
- You can change the name of your device name by replacing `&device=%SER` with `&device=DEVICE_NAME`.

21
source/_components/media_player.soundtouch.markdown
View File

@ -43,11 +43,22 @@ media_player:
name: Soundtouch kitchen
```
Configuration variables:
- **host** (*Required*): The host name or address of the Soundtouch device.
- **name** (*Required*): The name of the device used in the frontend.
- **port** (*Optional*): The port number. Defaults to 8090.
{% configuration %}
host:
description: The host name or address of the Soundtouch device.
required: true
type: string
name:
description: The name of the device used in the frontend.
required: true
default: Bose Soundtouch
type: string
port:
description: The port number.
required: false
default: 8090
type: integer
{% endconfiguration %}
You can switch between one of your 6 pre-configured presets using ```media_player.play_media```

25
source/_components/media_player.squeezebox.markdown
View File

@ -25,12 +25,25 @@ media_player:
host: IP_ADDRESS
```
Configuration variables:
- **host** (*Required*): The host name or address of the Logitech Media Server, eg. 192.168.1.21.
- **port** (*Optional*): Web interface port to Logitech Media Server. Defaults to 9000.
- **username** (*Optional*): The username, if password protection is enabled.
- **password** (*Optional*): The password, if password protection is enabled.
{% configuration %}
host:
description: The host name or address of the Logitech Media Server, eg. 192.168.1.21.
required: true
type: string
port:
description: The web interface port to Logitech Media Server.
required: false
default: 9000
type: integer
username:
description: The username, if password protection is enabled.
required: false
type: string
password:
description: The password, if password protection is enabled.
required: false
type: string
{% endconfiguration %}
<p class='note'>This platform now uses the web interface of the Logitech Media Server to send commands. The default port of the web interface is 9000. It is the same port that you use to access the LMS through your web browser. Originally, this platform used the telnet interface, which defaults to 9090. If you previously specified the port in your configuration file, you will likely need to update it.</p>

2
source/_components/notify.clicksend.markdown
View File

@ -62,7 +62,7 @@ sender:
description: The name or number of the sender.
required: false
type: string
default: recipient
default: 'hass'
{% endconfiguration %}
To use notifications, please see the [getting started with automation page](/getting-started/automation/).

16
source/_components/proximity.markdown
View File

@ -43,7 +43,7 @@ proximity:
ignored_zones:
- twork
devices:
- device_tracker.nwaring_nickmobile
- device_tracker.car1
tolerance: 50
unit_of_measurement: mi
```
@ -63,20 +63,20 @@ To add multiple proximity components, simply use a list in your `configuration.y
proximity:
home:
ignored_zones:
- twork
- elschool
- work
- school
devices:
- device_tracker.nwaring_nickmobile
- device_tracker.eleanorsiphone
- device_tracker.tsiphone
- device_tracker.car1
- device_tracker.iphone1
- device_tracker.iphone2
tolerance: 50
unit_of_measurement: mi
home3:
devices:
- device_tracker.tsiphone
- device_tracker.iphone1
tolerance: 50
work:
devices:
- device_tracker.elanorsiphone
- device_tracker.iphone2
tolerance: 10
```

8
source/_components/sensor.mitemp_bt.markdown
View File

@ -19,12 +19,12 @@ The `mitemp_bt` sensor platform allows one to monitor room temperature and humid
Depending on the operating system you're running, you have to configure the proper Bluetooth backend on your system:
- On [Hass.io](/hassio/installation/): mitemp_bt will work out of the box.
- On [Hass.io](/hassio/installation/): `mitemp_bt` will work out of the box as long as the host supports Bluetooth (like the Raspberry Pi does).
- On a [generic Docker installation](https://www.home-assistant.io/docs/installation/docker/): Works out of the box with `--net=host` and properly configured Bluetooth on the host.
- On other Linux systems:
- Preferred solution: Install the `bluepy` and `btlewrap` library (via pip). When using a virtual environment, make sure to use install the library in the right one.
   - Fallback solution: Install `btlewrap` library (via pip) and `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth`, `bluez-deprecated`
- Windows and MacOS are currently not supported by the btlewrap library.
- Fallback solution: Install `btlewrap` library (via pip) and `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth` or `bluez-deprecated`.
- Windows and MacOS are currently not supported by the `btlewrap` library.
## {% linkable_title Configuration %}
@ -114,6 +114,8 @@ adapter:
Note that by default the sensor is only polled once every 5 minutes. This means with the `median: 3` setting will take as least 15 minutes before the sensor will report a value after a Home Assistant restart. Even though the hardware is able to provide new values every second, room temperatures don't change that quickly.
Reducing polling intervals will have a negative effect on the battery life.
## {% linkable_title Full example %}
A full configuration example could look like the one below:
```yaml

6
source/_components/tado.markdown
View File

@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling"
The `tado` component platform is used as an interface to the [my.tado.com](https://my.tado.com/webapp/#/account/sign-in) website. It adds climate devices for every tado zone and sensors for some additional information of the zones.
## {% linkable_title Configuration %}
To use your tado thermostats in your installation, add the following to your `configuration.yaml` file:
```yaml
@ -26,11 +28,11 @@ tado:
{% configuration %}
username:
description: Username for my.tado.com.
description: Your username for my.tado.com.
required: true
type: string
password:
description: Password for my.tado.com.
description: Your password for my.tado.com.
required: true
type: string
{% endconfiguration %}

9
source/_components/tahoma.markdown
View File

@ -13,9 +13,10 @@ ha_release: 0.59
ha_iot_class: "Cloud Polling"
---
The `Tahoma` component platform is used as an interface to the [tahomalink.com](https://www.tahomalink.com) website. It adds covers, scenes and a sun sensor from the Tahoma platform.
## {% linkable_title Configuration %}
To use your Tahoma devices in your installation, add the following to your `configuration.yaml` file:
```yaml
@ -28,15 +29,15 @@ tahoma:
{% configuration %}
username:
description: Username for tahomalink.com
description: Your username for tahomalink.com.
required: true
type: string
password:
description: Password for tahomalink.com
description: Your password for tahomalink.com.
required: true
type: string
exclude:
description: Excludes devices
description: List of devices to exclude.
required: false
type: list
{% endconfiguration %}

13
source/_components/telegram_bot.broadcast.markdown
View File

@ -14,11 +14,12 @@ ha_release: 0.48
Telegram implementation to support **sending messages only**. Your Home Assistant instance does not have to be exposed to the Internet and there is no polling to receive messages sent to the bot.
## {% linkable_title Configuration %}
To integrate this into Home Assistant, add the following section to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
telegram_bot:
- platform: broadcast
api_key: YOUR_API_KEY
@ -29,7 +30,7 @@ telegram_bot:
{% configuration %}
allowed_chat_ids:
description: A list of user in the `user_id` Telegram format enabled to interact to webhook
description: A list of users in the `user_id` Telegram format that are authorized to interact with the webhook.
required: true
type: list
api_key:
@ -37,16 +38,16 @@ api_key:
required: true
type: string
parse_mode:
description: "Default parser for messages if not explicit in message data: 'html' or 'markdown'."
description: Default parser for messages if not explicit in message data, either `html` or `markdown`.
required: false
default: markdown
type: string
default: "`markdown`"
proxy_url:
description: Proxy url if working behind one (`socks5://proxy_ip:proxy_port`)
description: Proxy url if working behind one (`socks5://proxy_ip:proxy_port`).
required: false
type: string
proxy_params:
description: Proxy configuration parameters, as dict, if working behind a proxy (`username`, `password`, etc.)
description: Proxy configuration parameters, as dict, if working behind a proxy (`username`, `password`, etc.).
required: false
type: string
{% endconfiguration %}

13
source/_components/telegram_bot.polling.markdown
View File

@ -16,11 +16,12 @@ Telegram chatbot polling implementation.
One of two bot implementations supported by Telegram. Your Home Assistant does not have to be exposed to the internet.
## {% linkable_title Configuration %}
To integrate this into Home Assistant, add the following section to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
telegram_bot:
- platform: polling
api_key: YOUR_API_KEY
@ -31,7 +32,7 @@ telegram_bot:
{% configuration %}
allowed_chat_ids:
description: A list of user in the `user_id` Telegram format enabled to interact to webhook
description: A list of users in the `user_id` Telegram format that are authorized to interact with the webhook.
required: true
type: list
api_key:
@ -39,16 +40,16 @@ api_key:
required: true
type: string
parse_mode:
description: "Default parser for messages if not explicit in message data: 'html' or 'markdown'."
description: Default parser for messages if not explicit in message data, either `html` or `markdown`.
required: false
default: markdown
type: string
default: "`markdown`"
proxy_url:
description: Proxy url if working behind one (`socks5://proxy_ip:proxy_port`)
description: Proxy url if working behind one (`socks5://proxy_ip:proxy_port`).
required: false
type: string
proxy_params:
description: Proxy configuration parameters, as dict, if working behind a proxy (`username`, `password`, etc.)
description: Proxy configuration parameters, as dict, if working behind a proxy (`username`, `password`, etc.).
required: false
type: string
{% endconfiguration %}

22
source/_components/telegram_bot.webhooks.markdown
View File

@ -18,6 +18,8 @@ Using Telegrams `setWebhook` method your bot's webhook URL should be set to `htt
This is one of two bot implementations supported by Telegram. Described by Telegram as the preferred implementation but requires your Home Assistant instance to be exposed to the internet.
## {% linkable_title Configuration %}
To integrate this into Home Assistant, add the following section to your `configuration.yaml` file:
```yaml
@ -43,33 +45,35 @@ api_key:
description: The API token of your bot.
required: true
type: string
trusted_networks:
description: Telegram server access ACL as list.
required: false
default: 149.154.167.197-233
type: string
parse_mode:
description: "Default parser for messages if not explicit in message data: 'html' or 'markdown'."
description: Default parser for messages if not explicit in message data, either `html` or `markdown`.
required: false
default: markdown
type: string
proxy_url:
description: Proxy url if working behind one (`socks5://proxy_ip:proxy_port`)
description: Proxy url if working behind one (`socks5://proxy_ip:proxy_port`).
required: false
type: string
proxy_params:
description: Proxy configuration parameters, as dict, if working behind a proxy (`username`, `password`, etc.)
description: Proxy configuration parameters, as dict, if working behind a proxy (`username`, `password`, etc.).
required: false
type: string
url:
description: Allow to overwrite the `base_url` from the [`http`](/components/http/) component for different configurations (`https://<public_url>:<port>`).
required: false
type: string
trusted_networks:
description: Telegram server access ACL as list.
required: false
type: string
default: 149.154.167.197-233
{% endconfiguration %}
To get your `chat_id` and `api_key` follow the instructions [here](/components/notify.telegram). As well as authorizing the chat, if you have added your bot to a group you will also need to authorize any user that will be interacting with the webhook. When an unauthorized user tries to interact with the webhook Home Assistant will raise an error ("Incoming message is not allowed"), you can easily obtain the users id by looking in the "from" section of this error message.
Full configuration sample:
## {% linkable_title Full configuration example %}
The configuration sample below shows how an entry can look like:
```yaml
# Example configuration.yaml entry

6
source/_components/tellduslive.markdown
View File

@ -21,6 +21,8 @@ If you are upgrading from 0.58 or older, you need to remove all Telldus configur
Home Assistant will automatically discover the presence of a Tellstick Net or Tellstick ZNet on your local network if the [discovery]({{site_root}}/components/discovery/) component is enabled. When discovery and the key exchange with Telldus Live have been completed, you will be presented with an option to integrate with the cloud or local API for direct communication with your hardware in your LAN. Local API supports only one device at this stage. Local API is only supported with the Znet Lite products, the older hardware (such as Tellstick Net) does not support local API.
## {% linkable_title Configuration %}
To manually integrate your Telldus Live with Home Assistant, e.g., if your device is on another network or in another location, add the following section to your `configuration.yaml` file:
```yaml
@ -34,10 +36,10 @@ host:
required: false
type: string
update_interval:
description: Interval (in seconds) for polling the Telldus Live server (or the local server).
description: Interval (in seconds) for polling the Telldus Live server (or the local server). Minimal value can't be less then 300.
required: false
default: 60
type: integer
default: 60
{% endconfiguration %}
The component will offer configuration through the Home Assistant user interface where it will let you associate it with your Telldus Live account.

4
source/_components/tellstick.markdown
View File

@ -11,7 +11,6 @@ logo: telldus_tellstick.png
ha_category: Hub
---
The `tellstick` component integrates [TellStick](http://www.telldus.se/products/tellstick) devices into Home Assistant. This integration allows users to add switches, lights, and sensors which are communicating with 433 MHz. There are a number of vendors (Capidi Elro, Intertechno, Nexa, Proove, Sartano, and Viking) who are selling products that work with TellStick. For more details, please check the TellStick [protocol list](http://developer.telldus.com/wiki/TellStick_conf).
## {% linkable_title Configuration %}
@ -23,6 +22,8 @@ To get started, add the devices to your `configuration.yaml` file.
tellstick:
```
For Hass.io users there is a [TellStick add-on](/addons/tellstick/) available.
```yaml
# Example configuration.yaml entry for Hass.io with the TellStick add-on
tellstick:
@ -35,6 +36,7 @@ signal_repetitions:
description: Because the TellStick sends its actions via radio and from most receivers it's impossible to know if the signal was received or not. Therefore you can configure the switch and light to try to send each signal repeatedly.
required: false
type: integer
default: 1
host:
description: If you run TellStick on another server or with the Hass.io add-on.
required: inclusive

5
source/_components/tesla.markdown
View File

@ -13,7 +13,6 @@ ha_release: 0.53
ha_iot_class: "Cloud Polling"
---
The `Tesla` component offers integration with the [Tesla](https://auth.tesla.com/login) cloud service and provides presence detection as well as sensors such as charger state and temperature.
This component provides the following platforms:
@ -24,6 +23,8 @@ This component provides the following platforms:
- Climate - HVAC control. Allow you to control (turn on/off, set target temperature) your Tesla's HVAC system.
- Switch - Charger and max range switch. Allow you to start/stop charging and set max range charging.
## {% linkable_title Configuration %}
To use Tesla in your installation, add the following to your `configuration.yaml` file:
```yaml
@ -45,6 +46,6 @@ password:
scan_interval:
description: API polling interval. Minimal value can't be less then 300.
required: false
default: 300
type: integer
default: 300
{% endconfiguration %}

21
source/_components/thethingsnetwork.markdown
View File

@ -23,7 +23,7 @@ The Things network support various integrations to make the data available:
| [Storage](https://www.thethingsnetwork.org/docs/applications/storage/) | [`thethingsnetwork`](/components/sensor.thethingsnetwork/) |
| [HTTP](https://www.thethingsnetwork.org/docs/applications/http/) | |
### {% linkable_title Setup %}
## {% linkable_title Setup %}
Visit the [The Things Network Console](https://console.thethingsnetwork.org/) website, log in with your The Things Network credentials, choose your application from **Applications**.
@ -41,6 +41,8 @@ You need an access key to be able to read the data from your application.
Access keys
</p>
## {% linkable_title Configuration %}
To enable this component, add the following lines to your `configuration.yaml`:
```yaml
@ -51,13 +53,12 @@ thethingsnetwork:
```
{% configuration %}
app_id:
description: The Application ID.
required: true
type: string
access_key:
description: The access key.
required: true
type: string
app_id:
description: The Application ID.
required: true
type: string
access_key:
description: The access key.
required: true
type: string
{% endconfiguration %}

2
source/_components/thingspeak.markdown
View File

@ -15,6 +15,8 @@ ha_release: 0.32
The `thingspeak` components makes Home Assistant communicate with the [ThingSpeak API](https://thingspeak.com/).
For now, it records exactly one entity at once, which is great for testing purposes. For long-time storage you should rely on the [InfluxDB component](/components/influxdb/).
## {% linkable_title Configuration %}
You will have to create a [new channel](https://thingspeak.com/channels/new) on ThingSpeak and grab your Write API Key from the "API Keys" tab of the channel you want to use.
To setup the ThingSpeak component in your installation, add the following to your `configuration.yaml` file:

9
source/_components/tibber.markdown
View File

@ -14,7 +14,6 @@ ha_qa_scale: silver
ha_iot_class: "Cloud Polling"
---
The `tibber` component provides a sensor with the current electricity price if you are a [Tibber](https://tibber.com/) customer.
If you have a Tibber Pulse it will also show the electricity consumption in real time.
@ -34,8 +33,8 @@ tibber:
```
{% configuration %}
access_token:
description: Your Tibber API token.
required: true
type: string
access_token:
description: Your Tibber API token.
required: true
type: string
{% endconfiguration %}

40
source/_components/timer.markdown
View File

@ -21,6 +21,8 @@ When a timer finishes or gets canceled the corresponding events are fired. This
With the current implementation timers don't persist over restarts. After a restart they will be idle again, together with their initial configuration.
</p>
## {% linkable_title Configuration %}
To add a timer to your installation, add the following to your `configuration.yaml` file:
```yaml
@ -30,12 +32,26 @@ timer:
duration: '00:01:00'
```
Configuration variables:
- **[alias]** (*Required*): Alias for the timer. Multiple entries are allowed.
- **name** (*Optional*): Friendly name of the timer.
- **duration** (*Optional*): Initial duration in seconds or `00:00:00` when Home Assistant starts. Defaults to 0.
- **icon** (*Optional*): Set a custom icon for the state card.
{% configuration %}
"[alias]":
description: Alias for the timer. Multiple entries are allowed.
required: true
type: map
keys:
name:
description: Friendly name of the timer.
required: false
type: string
duration:
description: Initial duration in seconds or `00:00:00` when Home Assistant starts.
required: false
type: [integer, time]
default: 0
icon:
description: Set a custom icon for the state card.
required: false
type: icon
{% endconfiguration %}
Pick an icon that you can find on [materialdesignicons.com](https://materialdesignicons.com/) to use for your timer and prefix the name with `mdi:`. For example `mdi:car`, `mdi:ambulance`, or `mdi:motorbike`.
@ -82,7 +98,6 @@ Manually finish a running timer earlier than scheduled. If no `entity_id` is giv
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | Name of the entity to take action, e.g., `timer.timer0`. |
### {% linkable_title Use the service %}
Select <img src='/images/screenshots/developer-tool-services-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> **Services** from the **Developer Tools**. Choose **timer** from the list of **Domains**, select the **Service**, enter something like the sample below into the **Service Data** field, and hit **CALL SERVICE**.
@ -95,7 +110,7 @@ Select <img src='/images/screenshots/developer-tool-services-icon.png' alt='serv
## {% linkable_title Examples %}
Set a timer called `test` to a duration of 30 seconds.
Set a timer called `test` to a duration of 30 seconds.
```yaml
# Example configuration.yaml entry
@ -110,8 +125,8 @@ timer:
# Example automations.yaml entry
- alias: Timerswitch
id: 'Timerstart'
# Timer is started when the switch pumprun is set to on.
trigger:
# Timer is started when the switch pumprun is set to on.
trigger:
- platform: state
entity_id: switch.pumprun
to: 'on'
@ -122,10 +137,10 @@ timer:
# When timer is stopped, the time run out, another message is sent
- alias: Timerstop
id: 'Timerstop'
trigger:
trigger:
- platform: event
event_type: timer.finished
event_data:
event_data:
entity_id: timer.test
action:
- service: notify.nma
@ -160,4 +175,3 @@ script:
- service: timer.finish
entity_id: timer.test
```

6
source/_components/toon.markdown
View File

@ -17,6 +17,8 @@ The `toon` component platform can be used to control your Toon thermostat. This
For the `toon` component to work, you'll need an active Toon subscription with Eneco. The component uses your Mijn Eneco credentials to control your thermostat through the [toonopafstand](https://toonopafstand.eneco.nl) domain.
## {% linkable_title Configuration %}
To use your Toon thermostat in your installation, add the following to your `configuration.yaml` file:
```yaml
@ -38,13 +40,13 @@ password:
gas:
description: With this option you can choose whether you want to measure gas consumption.
required: false
default: true
type: boolean
default: true
solar:
description: With this option you can choose whether you want to measure electricity production.
required: false
default: false
type: boolean
default: false
{% endconfiguration %}
Toon is a smart thermostat delivered by the Eneco power company in The Netherlands. It can measure energy consumption (power and gas), but also the amount of energy generated in case solar panels are connected to it. Toon also acts as a z-wave hub for supported devices like the wall plug and the smoke detector. This component uses the [toonlib library](https://github.com/costastf/toonlib) by Costas Tyfoxylos that connects to the unofficial API on [https://toonopafstand.eneco.nl](https://toonopafstand.eneco.nl).

2
source/_components/tradfri.markdown
View File

@ -44,7 +44,6 @@ allow_tradfri_groups:
default: false
{% endconfiguration %}
## {% linkable_title Troubleshooting %}
### {% linkable_title Firmware updates %}
@ -58,4 +57,3 @@ Please make sure you have `autoconf` installed (`$ sudo apt-get install autoconf
### {% linkable_title Setting the `api_key` %}
Do not use the `api_key` variable in `configuration.yaml`. The API key is only needed once at initial setup and will be stored.

1
source/_components/tts.amazon_polly.markdown
View File

@ -76,7 +76,6 @@ sample_rate:
default: 22050 for MP3 and Ogg Vorbis, 16000 for pcm
{% endconfiguration %}
## {% linkable_title Usage %}
Say to all `media_player` device entities:

5
source/_components/tts.baidu.markdown
View File

@ -14,6 +14,8 @@ ha_release: 0.59
The `baidu` text-to-speech platform uses [Baidu TTS engine](https://cloud.baidu.com/product/speech/tts) to read a text with natural sounding voices.
## {% linkable_title Configuration %}
To get started, add the following lines to your `configuration.yaml`:
```yaml
@ -54,9 +56,10 @@ volume:
type: integer
default: 5
person:
description: Voice type. You choose one from 0, 1, 3 or 4.
description: The voice type. You choose one from 0, 1, 3 or 4.
required: false
type: integer
default: 0
{% endconfiguration %}
At the moment, `zh` is the only supported language and therefore the default value.

42
source/_components/tts.marytts.markdown
View File

@ -14,27 +14,49 @@ ha_release: 0.43
The `marytts` text-to-speech platform uses [MaryTTS](http://mary.dfki.de/) Text-to-Speech engine to read a text with natural sounding voices.
## {% linkable_title Configuration %}
To enable text-to-speech with MaryTTS, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
tts:
- platform: marytts
host: 'localhost'
port: 59125
```
Configuration variables:
- **host** (*Optional*): MaryTTS server hostname or IP address. Default is `localhost`.
- **port** (*Optional*): MaryTTS server port. Default is 59125.
- **codec** (*Optional*): Audio codec. Default is `wav`. Supported are `aiff`, `au`, `wav`.
- **voice** (*Optional*): Speaker voice. Default is `cmu-slt-hsmm`.
- **language** (*Optional*): Language to use. Default is `en-US`. Supports 'de', 'en-GB', 'en-US', 'fr', 'it', 'lb', 'ru', 'sv', 'te', 'tr'.
{% configuration %}
host:
description: The MaryTTS server hostname or IP address.
required: false
type: string
default: localhost
port:
description: The MaryTTS server port.
required: false
type: integer
default: 59125
codec:
description: "The audio codec. Supported codecs are `aiff`, `au` and `wav`."
required: false
type: string
default: "`wav`"
voice:
description: The speaker voice.
required: false
type: string
default: "`cmu-slt-hsmm`"
language:
description: "The language to use. Supported languages are `de`, `en-GB`, `en-US`, `fr`, `it`, `lb`, `ru`, `sv`, `te` and `tr`."
required: false
type: string
default: "`en-US`"
{% endconfiguration %}
See [documentation](http://mary.dfki.de/documentation/index.html) for details.
A full configuration sample:
## {% linkable_title Full configuration example %}
A full configuration sample including optional variables:
```yaml
# Example configuration.yaml entry

19
source/_components/tts.microsoft.markdown
View File

@ -13,7 +13,9 @@ ha_release: 0.57
---
The `microsoft` text-to-speech platform uses [Microsoft Text-to-Speech engine](https://docs.microsoft.com/en-us/azure/cognitive-services/speech/home) to read a text with natural sounding voices. This component uses an API that is part of the Cognitive Services offering and is known as the Bing Speech API.
You will need an API key, which is free. You can use your [Azure subscription](https://azure.microsoft.com) or get an API key on the [Cognitive Services site](https://azure.microsoft.com/en-us/try/cognitive-services/).
You will need an API key, which is free. You can use your [Azure subscription](https://azure.microsoft.com) or get an API key on the [Cognitive Services site](https://azure.microsoft.com/en-us/try/cognitive-services/).
## {% linkable_title Configuration %}
To enable text-to-speech with Microsoft, add the following lines to your `configuration.yaml`:
@ -32,39 +34,42 @@ api_key:
language:
description: The language to use. Accepted values are listed in the documentation mentioned below. Note that if you set the language to anything other than the default, you will need to specify a matching voice type as well.
required: false
default: "`en-us`"
type: string
default: "`en-us`"
gender:
description: The gender you would like to use for the voice. Accepted values are `Female` and `Male`.
required: false
default: "`Female`"
type: string
default: "`Female`"
type:
description: "The voice type you want to use. Accepted values are listed as the service name mapping [in the documentation](https://docs.microsoft.com/en-us/azure/cognitive-services/Speech/api-reference-rest/bingvoiceoutput)."
required: false
default: "`ZiraRUS`"
type: string
default: "`ZiraRUS`"
rate:
description: "Change the rate of speaking in percentage. Example values: `25`, `50`."
required: false
default: 0
type: integer
default: 0
volume:
description: "Change the volume of the output in percentage. Example values: `-20`, `70`."
required: false
default: 0
type: integer
default: 0
pitch:
description: "Change the pitch of the output. Example values: `high`."
required: false
default: "`default`"
type: string
default: "`default`"
contour:
description: "Change the contour of the output in percentages. This overrides the pitch setting. See the [W3 SSML specification](http://www.w3.org/TR/speech-synthesis/#pitch_contour) for what it does. Example value: `(0,0) (100,100)`."
required: false
type: string
{% endconfiguration %}
## {% linkable_title Full configuration example %}
A full configuration sample including optional variables:
```yaml

10
source/_components/tts.picotts.markdown
View File

@ -16,6 +16,8 @@ The `picotts` text-to-speech platform uses offline pico Text-to-Speech engine to
This requires to install the pico tts library on the system, typically on debian just do `sudo apt-get install libttspico-utils`
On some Raspbian release, this package is missing but you can just copy the arm deb package from debian.
## {% linkable_title Configuration %}
To enable text-to-speech with Pico, add the following lines to your `configuration.yaml`:
```yaml
@ -26,13 +28,15 @@ tts:
{% configuration %}
language:
description: "The language to use. Supported languages : 'en-US', 'en-GB', 'de-DE', 'es-ES', 'fr-FR', 'it-IT'"
description: "The language to use. Supported languages are `en-US`, `en-GB`, `de-DE`, `es-ES`, `fr-FR` and `it-IT`."
required: false
default: "`en-US`"
type: string
default: "`en-US`"
{% endconfiguration %}
A full configuration sample:
## {% linkable_title Full configuration example %}
The configuration sample below shows how an entry can look like:
```yaml
# Example configuration.yaml entry

10
source/_components/tts.voicerss.markdown
View File

@ -33,25 +33,25 @@ api_key:
language:
description: The language to use.
required: false
default: "`en-us`"
type: string
default: "`en-us`"
codec:
description: The audio codec.
required: false
default: mp3
type: string
default: mp3
format:
description: The audio sample format.
required: false
default: 8khz_8bit_mono
type: string
default: 8khz_8bit_mono
{% endconfiguration %}
Check the [VoiceRSS API documentation](http://www.voicerss.org/api/documentation.aspx) for allow values.
Check the [VoiceRSS API documentation](http://www.voicerss.org/api/documentation.aspx) for allowed values.
## {% linkable_title Full configuration example %}
The configuration sample below show how a entry can look like:
The configuration sample below shows how an entry can look like:
```yaml
# Example configuration.yaml entry

18
source/_components/tts.yandextts.markdown
View File

@ -31,37 +31,37 @@ api_key:
required: true
type: string
language:
description: "The language to use. Supported `en-US`, `ru-RU`, `uk-UK`, `tr-TR`."
description: "The language to use. Supported languages are `en-US`, `ru-RU`, `uk-UK` and `tr-TR`."
required: false
type: string
default: "`en-US`"
type: string
codec:
description: "The audio codec. Supported us `mp3`, `wav`, `opus`."
description: "The audio codec. Supported codecs are `mp3`, `wav` and `opus`."
required: false
default: "`mp3`"
type: string
default: "`mp3`"
voice:
description: "The speaker voice. Supported female voices are `jane`, `oksana`, `alyss`, `omazh` and male voices are `zahar` and `ermil`."
required: false
type: string
default: "`zahar`"
type: string
emotion:
description: "The speaker emotional intonation. Also supported are `good` (friendly) and `evil` (angry)"
description: "The speaker emotional intonation. Supported emotions are `good` (friendly), `evil` (angry) and `neutral`"
required: false
default: "`neutral`"
type: string
default: "`neutral`"
speed:
description: The speech speed. Highest speed is `3` and lowest `0,1`
required: false
default: "`1`"
type: float
default: "`1`"
{% endconfiguration %}
Please check the [API documentation](https://tech.yandex.com/speechkit/cloud/doc/guide/concepts/tts-http-request-docpage/) for details. It seems that the English version of documentation is outdated. You could request an API key [by email](https://tech.yandex.com/speechkit/cloud/) or [online](https://developer.tech.yandex.ru/).
## {% linkable_title Full configuration example %}
The configuration sample below show how a entry can look like:
The configuration sample below shows how an entry can look like:
```yaml
# Example configuration.yaml entry

6
source/_components/tuya.markdown
View File

@ -28,15 +28,15 @@ tuya:
{% configuration %}
username:
description: Your username to login to Tuya. This may be your phone number.
description: Your username to log in to Tuya. This may be your phone number.
required: true
type: string
password:
description: Your password to login to Tuya.
description: Your password to log in to Tuya.
required: true
type: string
country_code:
description: "Your account [country code](https://www.countrycode.org/) (e.g., 1 for USA or 86 for China)."
description: "Your account [country code](https://www.countrycode.org/), e.g., 1 for USA or 86 for China."
required: true
type: string
platform:

2
source/_components/twilio.markdown
View File

@ -17,6 +17,8 @@ The `twilio` component enables the sending of notifications via SMS and the crea
Free trial account is available at [Twilio](https://twilio.com) website providing free calls to verified phone numbers.
Calls are limited to 10 minutes and will play a short trial message before your message runs. Upgraded accounts have no limitation.
## {% linkable_title Configuration %}
To use this notification component in your installation, add the following to your `configuration.yaml` file:
```yaml

1
source/_components/upcloud.markdown
View File

@ -13,7 +13,6 @@ logo: upcloud.png
ha_iot_class: Cloud Polling
---
The `upcloud` component allows you to access the information about your [UpCloud](https://www.upcloud.com/) servers from Home Assistant.
## {% linkable_title Setup %}

24
source/_components/updater.markdown
View File

@ -14,7 +14,9 @@ ha_qa_scale: internal
The `updater` component will check daily for new releases. It will show a badge in the frontend if a new version is found. As [Hass.io](/hassio/) has its own schedule for release it doesn't make sense to use this component on Hass.io.
The updater component will also collect basic information about the running Home Assistant instance and its environment. The information includes the current Home Assistant version, the time zone, Python version and operating system information. No identifiable information (i.e., IP address, GPS coordinates, etc.) will ever be collected. If you are concerned about your privacy, you are welcome to scrutinize the Python [source code](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/updater.py#L91). For further information about the Updater's data, please check the [detailed overview](/docs/backend/updater/).
The updater component will also collect basic information about the running Home Assistant instance and its environment. The information includes the current Home Assistant version, the time zone, Python version and operating system information. No identifiable information (i.e., IP address, GPS coordinates, etc.) will ever be collected. If you are concerned about your privacy, you are welcome to scrutinize the Python [source code](https://github.com/home-assistant/home-assistant/blob/dev/homeassistant/components/updater.py#L91).
## {% linkable_title Configuration %}
To integrate this into Home Assistant, add the following section to your `configuration.yaml` file:
@ -22,9 +24,22 @@ To integrate this into Home Assistant, add the following section to your `config
updater:
```
If you choose not to share any information when checking for updates, you can add `reporting: False`.
{% configuration %}
reporting:
description: Whether or not to share system information when checking for updates.
required: false
type: boolean
default: true
include_used_components:
description: Whether or not to report the components that you are using in Home Assistant.
required: false
type: boolean
default: false
{% endconfiguration %}
It is possible to report the components that you are using to the Home Assistant developers. This will help them focus on improving the popular ones. To enable this option, you have to add `include_used_components: True`.
For further information about the Updater's data, please check the [detailed overview](/docs/backend/updater/). If you choose not to share any information when checking for updates, you can set `reporting: false`.
It is possible to report the components that you are using to the Home Assistant developers. This will help them focus on improving the popular ones. To enable this option, you have to add `include_used_components: true`.
```json
"components": [
@ -41,7 +56,7 @@ It is possible to report the components that you are using to the Home Assistant
]
```
### {% linkable_title Notification %}
## {% linkable_title Notification %}
For an added bonus, an automation component can be created to send a message with a notifier when that state of this component's entity changes.
@ -57,4 +72,3 @@ automation:
data:
message: 'Update for Home Assistant is available.'
```

37
source/_components/upnp.markdown
View File

@ -33,20 +33,25 @@ upnp:
With the default settings only the sensors are added for statistics. If you wish to have port mapping done through IGD, add the option **port_mapping** and **ports**.
{% configuration binary_sensor.template %}
ports:
description: Map of ports to map from internal to external. Pass 'hass' as internal port to use the port Home Assistant runs on. Note that you have to enable port_mapping if you wish to map ports.
required: false
type: map
default: open same port on external router as that HASS runs locally and forwards it.
port_mapping:
description: If the component should try to map ports.
required: false
type: boolean
default: false
local_ip:
description: The local IP address of the computer running Home Assistant.
required: false
type: string
default: Try to auto-detect IP of host.
{% configuration %}
port_mapping:
description: If the component should try to map ports.
required: false
type: boolean
default: false
sensors:
description: If the component should enable the UPNP sensors.
required: false
type: boolean
default: true
local_ip:
description: The local IP address of the computer running Home Assistant.
required: false
type: string
default: Try to auto-detect IP of host.
ports:
description: Map of ports to map from internal to external. Pass 'hass' as internal port to use the port Home Assistant runs on. Note that you have to enable port_mapping if you wish to map ports.
required: false
type: map
default: Open same port on external router as that HASS runs locally and forwards it.
{% endconfiguration %}

4
source/_components/vacuum.dyson.markdown
View File

@ -15,7 +15,9 @@ ha_release: 0.51
The `dyson` vacuum platform allows you to control your Dyson 360 Eye robot vacuum.
You have first to setup the [Dyson component](/components/dyson/)
## {% linkable_title Configuration %}
You have to set up the [Dyson component](/components/dyson/) first.
### {% linkable_title Component services %}

4
source/_components/vacuum.ecovacs.markdown
View File

@ -15,7 +15,9 @@ ha_release: 0.77
The `ecovacs` vacuum platform allows you to monitor and control your Ecovacs Deebot vacuums.
You have first to setup the [Ecovacs component](/components/ecovacs/)
## {% linkable_title Configuration %}
You have to set up the [Ecovacs component](/components/ecovacs/) first.
### {% linkable_title Component Lifespans %}

2
source/_components/vacuum.markdown
View File

@ -11,6 +11,8 @@ footer: true
The `vacuum` component enables the ability to control home cleaning robots within Home Assistant.
## {% linkable_title Configuration %}
To use this component in your installation, add a `vacuum` platform to your `configuration.yaml` file, like the [Xiaomi](/components/vacuum.xiaomi_miio/).
```yaml

8
source/_components/vacuum.mqtt.markdown
View File

@ -14,6 +14,8 @@ ha_release: 0.54
The `mqtt` vacuum component allows you to control your MQTT-enabled vacuum.
## {% linkable_title Configuration %}
To add your MQTT vacuum to your installation, add the following to your `configuration.yaml` file:
```yaml
@ -229,6 +231,6 @@ MQTT payload:
}
```
### {% linkable_title Retrofitting a non-wifi Roomba with an ESP8266 %}
- [This repo](https://github.com/johnboiles/esp-roomba-mqtt) has MQTT client firmware for retrofitting your old Roomba.
### {% linkable_title Retrofitting a non-wifi vacuums %}
- Retrofitting your old Roomba with an ESP8266. [This repo](https://github.com/johnboiles/esp-roomba-mqtt) provides MQTT client firmware.
- In you own a non-wifi Neato, you can refer to [this repo](https://github.com/jeroenterheerdt/neato-serial) that uses a Raspberry Pi to retrofit an old Neato.

2
source/_components/vacuum.neato.markdown
View File

@ -21,6 +21,8 @@ The status will contain attributes on the robots last clean session.
If you notice the robot stops responding to commands check the state to see if the robot is "unavailable". If you see "unavailable" first try to restart the vacuum and wait about 5 minutes to see if it is no longer "unavailable". If you are still having issues check the Neato app and make sure your robot is connected and working. If it is not then follow the steps in the app to reset your robot and give it the same name as before then restart Home Assistant.
</p>
## {% linkable_title Configuration %}
To add `neato` vacuum to your installation, please follow instructions in [Neato component](/components/neato/).
Currently supported services are:

10
source/_components/vacuum.roomba.markdown
View File

@ -18,6 +18,8 @@ The `roomba` component allows you to control your [iRobot Roomba](http://www.iro
This platform has only been tested with an iRobot Roomba 980 but should work find with any Wi-Fi enabled Roomba like the 690, 890 or the 960.
</p>
## {% linkable_title Configuration %}
To add your Roomba vacuum to your installation, add the following to your `configuration.yaml` file:
```yaml
@ -31,7 +33,7 @@ vacuum:
{% configuration %}
host:
description: Hostname or IP address of the Roomba.
description: The hostname or IP address of the Roomba.
required: true
type: string
username:
@ -45,18 +47,18 @@ password:
name:
description: The name of the vacuum.
required: false
default: Roomba
type: string
default: Roomba
certificate:
description: Path to your certificate store.
required: false
default: /etc/ssl/certs/ca-certificates.crt
type: string
default: /etc/ssl/certs/ca-certificates.crt
continuous:
description: Whether to operate in continuous mode.
required: false
default: true
type: boolean
default: true
{% endconfiguration %}
<p class='note'>

Some files were not shown because too many files have changed in this diff Show More