Skip to content

Commit 006ef8e

Browse files
frenckfrenck
committed
Merge branch 'current' into next
2 parents d479ce0 + 45f7090 commit 006ef8e

File tree

134 files changed

+812
-567
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

134 files changed

+812
-567
lines changed

‎source/_components/binary_sensor.ads.markdown

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,16 @@ binary_sensor:
2626
```
2727
2828
{% configuration %}
29-
adsvar:
30-
required: true
31-
description: The name of the variable which you want to access on the ADS device.
32-
type: string
33-
name:
34-
required: false
35-
description: An identifier for the light in the frontend.
36-
type: string
37-
device_class:
38-
required: false
39-
description: The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.
40-
type: string
29+
adsvar:
30+
description: The name of the variable which you want to access on the ADS device.
31+
required: true
32+
type: string
33+
name:
34+
description: An identifier for the light in the frontend.
35+
required: false
36+
type: string
37+
device_class:
38+
description: The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.
39+
required: false
40+
type: string
4141
{% endconfiguration %}

‎source/_components/binary_sensor.aurora.markdown

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,19 @@ binary_sensor:
3232
forecast_threshold:
3333
description: Provide your own threshold number above which the sensor will trigger.
3434
required: false
35-
default: 75
3635
type: integer
36+
default: 75
3737
name:
3838
description: The name of the sensor.
3939
required: false
40-
default: Aurora Visibility
4140
type: string
41+
default: Aurora Visibility
4242
{% endconfiguration %}
4343
44+
## {% linkable_title Full example %}
45+
4446
```yaml
45-
binary_sensor:
46-
- platform: aurora
47-
forecast_threshold: 50
47+
binary_sensor:
48+
- platform: aurora
49+
forecast_threshold: 50
4850
```

‎source/_components/binary_sensor.bayesian.markdown

Lines changed: 51 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ ha_release: 0.53
1414
ha_qa_scale: internal
1515
---
1616

17-
1817
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`.
1918

2019
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:
3635
to_state: 'on'
3736
```
3837
39-
Configuration variables:
40-
41-
- **prior** (*Required*): The prior probability of the event. At any point in time (ignoring all external influences) how likely is this event to occur?
42-
- **probability_threshold** (*Optional*): The probability at which the sensor should trigger to `on`.
43-
- **name** (*Optional*): Name of the sensor to use in the frontend. Defaults to `Bayesian Binary sensor`.
44-
- **observations** array (*Required*): The observations which should influence the likelihood that the given event has occurred.
45-
- **entity_id** (*Required*): Name of the entity to monitor.
46-
- **prob_given_true** (*Required*): The probability of the observation occurring, given the event is `true`.
47-
- **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`.
48-
- **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`.
49-
- **to_state** (*Required*): The target state.
38+
{% configuration %}
39+
prior:
40+
description: >
41+
The prior probability of the event. At any point in time
42+
(ignoring all external influences) how likely is this event to occur?
43+
required: true
44+
type: float
45+
probability_threshold:
46+
description: The probability at which the sensor should trigger to `on`.
47+
required: false
48+
type: float
49+
default: 0.5
50+
name:
51+
description: Name of the sensor to use in the frontend.
52+
required: false
53+
type: string
54+
default: Bayesian Binary Sensor
55+
observations:
56+
description: The observations which should influence the likelihood that the given event has occurred.
57+
required: true
58+
type: list
59+
keys:
60+
entity_id:
61+
description: Name of the entity to monitor.
62+
required: true
63+
type: string
64+
prob_given_true:
65+
description: The probability of the observation occurring, given the event is `true`.
66+
required: true
67+
type: float
68+
prob_given_false:
69+
description: The probability of the observation occurring, given the event is `false` can be set as well.
70+
required: false
71+
type: float
72+
default: "`1 - prob_given_true` if `prob_given_false` is not set"
73+
platform:
74+
description: >
75+
The only supported observation platforms are `state` and `numeric_state`,
76+
which are modeled after their corresponding triggers for automations,
77+
requiring `below` and/or `above` instead of `to_state`.
78+
required: true
79+
type: string
80+
to_state:
81+
description: The target state.
82+
required: true
83+
type: string
84+
{% endconfiguration %}
5085

5186
## {% linkable_title Full examples %}
5287

88+
The following is an example for the `state` observation platform.
89+
5390
```yaml
5491
# Example configuration.yaml entry
5592
binary_sensor:
@@ -78,6 +115,8 @@ binary_sensor:
78115
to_state: 'below_horizon'
79116
```
80117

118+
Next up an example which targets the `numeric_state` observation platform,
119+
as seen in the configuration it requires `below` and/or `above` instead of `to_state`.
81120

82121
```yaml
83122
# Example configuration.yaml entry

‎source/_components/binary_sensor.bbb_gpio.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,18 +48,18 @@ pins:
4848
bouncetime:
4949
description: Debounce time for reading input pin defined in milliseconds [ms].
5050
required: false
51-
default: 50
5251
type: integer
52+
default: 50
5353
invert_logic:
5454
description: If `true`, inverts the input logic to ACTIVE LOW
5555
required: false
56-
default: false
5756
type: boolean
57+
default: false
5858
pull_mode:
5959
description: Type of internal pull resistor connected to input. Options are `UP` - pull-up resistor and `DOWN` - pull-down resistor.
6060
required: false
61-
default: UP
62-
type: string
61+
type: string
62+
default: UP
6363
{% endconfiguration %}
6464

6565
For more details about the GPIO layout, visit the [article](http://elinux.org/Beagleboard:BeagleBoneBlack) about the BeagleBone Black.

‎source/_components/binary_sensor.command_line.markdown

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ ha_release: 0.12
1313
ha_iot_class: "Local Polling"
1414
---
1515

16-
1716
The `command_line` binary sensor platform issues specific commands to get data.
1817

1918
## {% linkable_title Configuration %}
@@ -33,38 +32,38 @@ command:
3332
required: true
3433
type: string
3534
name:
36-
description: Let you overwrite the name of the device. By default *name* from the device is used.
35+
description: Let you overwrite the name of the device.
3736
required: false
38-
default: name
3937
type: string
38+
default: "*name* from the device"
4039
device_class:
4140
description: The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.
4241
required: false
4342
type: string
4443
payload_on:
4544
description: The payload that represents enabled state.
4645
required: false
47-
default: ON
4846
type: string
47+
default: ON
4948
payload_off:
5049
description: The payload that represents disabled state.
5150
required: false
52-
default: OFF
5351
type: string
52+
default: OFF
5453
value_template:
5554
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload.
5655
required: false
5756
type: string
5857
scan_interval:
5958
description: Defines number of seconds for polling interval.
6059
required: false
61-
default: 60
6260
type: integer
61+
default: 60
6362
command_timeout:
6463
description: Defines number of seconds for command timeout.
6564
required: false
66-
default: 15
6765
type: integer
66+
default: 15
6867
{% endconfiguration %}
6968
7069
## {% linkable_title Examples %}

‎source/_components/binary_sensor.concord232.markdown

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ ha_release: 0.31
1414

1515
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.
1616

17+
## {% linkable_title Configuration %}
18+
1719
To enable this, add the following lines to your `configuration.yaml`:
1820

1921
```yaml
@@ -26,11 +28,11 @@ binary_sensor:
2628
host:
2729
description: The host where the concord232 server process is running.
2830
required: false
29-
default: localhost
3031
type: string
32+
default: localhost
3133
port:
3234
description: The port where the Alarm panel is listening.
3335
required: false
34-
default: 5007
3536
type: integer
37+
default: 5007
3638
{% endconfiguration %}

‎source/_components/binary_sensor.ffmpeg_motion.markdown

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ ha_release: 0.27
1313
redirect_from: /components/binary_sensor.ffmpeg/
1414
---
1515

16-
1716
The `ffmpeg` platform allows you to use any video feed with [FFmpeg](http://www.ffmpeg.org/) for motion sensors in Home Assistant.
1817

1918
<p class='note'>
@@ -47,28 +46,28 @@ name:
4746
initial_state:
4847
description: Start `ffmpeg` with Home Assistant.
4948
required: false
50-
default: true
5149
type: boolean
50+
default: true
5251
changes:
5352
description: How much needs to change between two frames to detect it as motion, value in percentage (a lower value is more sensitive).
5453
required: false
55-
default: 10%
5654
type: integer
55+
default: 10
5756
reset:
5857
description: The time to reset the state after no new motion is detected.
5958
required: false
60-
default: 20
6159
type: integer
60+
default: 20
6261
repeat:
6362
description: How many events need to be detected in *repeat_time* in order to trigger a motion, 0 repeats means deactivated.
6463
required: false
65-
default: 0
6664
type: integer
65+
default: 0
6766
repeat_time:
6867
description: The span of time *repeat* events need to occur in before triggering a motion, 0 seconds means deactivated.
6968
required: false
70-
default: 0
7169
type: integer
70+
default: 0
7271
extra_arguments:
7372
description: Extra options to pass to `ffmpeg`, e.g., video denoise filtering.
7473
required: false

‎source/_components/binary_sensor.ffmpeg_noise.markdown

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ ha_category: Image Processing
1212
ha_release: 0.27
1313
---
1414

15-
1615
The `ffmpeg` platform allows you to use any video or audio feed with [FFmpeg](http://www.ffmpeg.org/) for various sensors in Home Assistant.
1716

1817
<p class='note'>
@@ -42,23 +41,23 @@ name:
4241
initial_state:
4342
description: Start ffmpeg with home-assistant.
4443
required: false
45-
default: true
4644
type: boolean
45+
default: true
4746
peak:
4847
description: The threshold of detecting noise, in dB. 0 is very loud and -100 is low.
4948
required: false
50-
default: -30
5149
type: integer
50+
default: -30
5251
duration:
5352
description: How long the noise needs to be over the peak to trigger the state.
5453
required: false
55-
default: 1
5654
type: integer
55+
default: 1
5756
reset:
5857
description: The time to reset the state after no new noise is over the peak.
5958
required: false
60-
default: 20
6159
type: integer
60+
default: 20
6261
extra_arguments:
6362
description: Extra options to pass to `ffmpeg`, like audio frequency filtering.
6463
required: false

‎source/_components/binary_sensor.gc100.markdown

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,11 @@ binary_sensor:
2323
- '3:2': Garage Obstruction
2424
```
2525
26-
Configuration variables:
27-
28-
- **ports** (*Required*): A list of module-address to name mappings in the format 'x:y': name, where x is module #, y is address.
29-
26+
{% configuration %}
27+
ports:
28+
description: >
29+
A list of module-address to name mappings in the format `'x:y': name`,
30+
where x is module #, y is address.
31+
required: true
32+
type: list
33+
{% endconfiguration %}

‎source/_components/binary_sensor.knx.markdown

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,16 @@ device_class:
4242
significant_bit:
4343
description: Specify which significant bit of the KNX value should be used.
4444
required: false
45-
default: 1
4645
type: integer
46+
default: 1
4747
reset_after:
4848
description: Reset back to OFF state after specified milliseconds.
4949
required: false
5050
type: integer
5151
{% endconfiguration %}
5252
53+
### {% linkable_title Automation actions %}
54+
5355
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.
5456
5557
```yaml
@@ -81,13 +83,13 @@ name:
8183
counter:
8284
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.
8385
required: false
84-
default: 1
8586
type: integer
87+
default: 1
8688
hook:
8789
description: Indicates if the automation should be executed on what state of the binary sensor. Values are "on" or "off".
8890
required: false
89-
default: "on"
9091
type: string
92+
default: "on"
9193
action:
9294
description: Specify a list of actions analog to the [automation rules](/docs/automation/action/).
9395
required: false

‎source/_components/binary_sensor.linode.markdown

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,8 @@ binary_sensor:
2828
```
2929
3030
{% configuration %}
31-
nodes:
32-
description: List of VPSs you want to control.
33-
required: true
34-
type: string
31+
nodes:
32+
description: List of VPSs you want to control.
33+
required: true
34+
type: string
3535
{% endconfiguration %}
36-

0 commit comments

Comments
 (0)