Skip to content

Commit 383fa3e

Browse files
authored
Merge pull request home-assistant#969 from home-assistant/next
0.29
2 parents 071f90b + e2a5676 commit 383fa3e

File tree

77 files changed

+1657
-199
lines changed

Some content is hidden

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

77 files changed

+1657
-199
lines changed

font/fontawesome-webfont.eot

100755100644
File mode changed.

font/fontawesome-webfont.svg

100755100644
File mode changed.

font/fontawesome-webfont.ttf

100755100644
File mode changed.

font/fontawesome-webfont.woff

100755100644
File mode changed.

source/_components/binary_sensor.ffmpeg.markdown

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,6 @@ ha_iot_class: "Local Polling"
1616

1717
The `ffmpeg` platform allows you to use every video or audio feed with [FFmpeg](http://www.ffmpeg.org/) for various sensors in Home Assistant. Available are: **noise**, **motion**. If the `ffmpeg` process is broken, the sensor will be unavailable. To restart the instance, use the service *binary_sensor.ffmpeg_restart*.
1818

19-
<p class='note'>
20-
You need the `ffmpeg` binary in your system path. On Debain 8 you can install it from backports. If you want Hardware support on a Raspberry Pi you need to build it from source. Windows binary are avilable on [FFmpeg](http://www.ffmpeg.org/) homepage.
21-
</p>
22-
2319
### {% linkable_title Noise %}
2420

2521
To enable your FFmpeg with noise detection in your installation, add the following to your `configuration.yaml` file:
@@ -31,7 +27,6 @@ binary_sensor:
3127
tool: noise
3228
input: FFMPEG_SUPPORTED_INPUT
3329
name: FFmpeg Noise
34-
ffmpeg_bin: /usr/bin/ffmpeg
3530
peak: -30
3631
duration: 1
3732
reset: 20
@@ -42,7 +37,6 @@ Configuration variables:
4237
- **input** (*Required*): A ffmpeg compatible input file, stream or feed.
4338
- **tool** (*Required*): Is fix set to `noise`.
4439
- **name** (*Optional*): This parameter allows you to override the name of your camera.
45-
- **ffmpeg_bin** (*Optional*): Default `ffmpeg`.
4640
- **peak** (*Optional*): Default -30. A peak of dB to detect it as noise. 0 is very loud and -100 is low.
4741
- **duration** (*Optional*): Default 1 seconds. How long need the noise over the peak to trigger the state.
4842
- **reset** (*Optional*): Defaults to 20 seconds. The time to reset the state after none new noise is over the peak.
@@ -68,21 +62,19 @@ binary_sensor:
6862
tool: motion
6963
input: FFMPEG_SUPPORTED_INPUT
7064
name: FFmpeg Motion
71-
ffmpeg_bin: /usr/bin/ffmpeg
7265
changes: 10
7366
reset: 20
7467
# group feature / default not in use
7568
repeat: 0
7669
repeat_time: 0
77-
70+
7871
```
7972

8073
Configuration variables:
8174

8275
- **input** (*Required*): A ffmpeg compatible input file, stream, or feed.
8376
- **tool** (*Required*): Is fix set to `motion`.
8477
- **name** (*Optional*): This parameter allows you to override the name of your camera.
85-
- **ffmpeg_bin** (*Optional*): Default `ffmpeg`.
8678
- **changes** (*Optional*): Default 10 percent. A lower value is more sensitive. I use 4 / 3.5 on my cameras. It describes how much needs to change between two frames to detect it as motion. See on descripton.
8779
- **reset** (*Optional*): Default 20 seconds. The time to reset the state after no new motion is detected.
8880
- **repeat** (*Optional*): Default 0 repeats (deactivate). How many events need to be detected in *repeat_time* in order to trigger a motion.
@@ -95,4 +87,4 @@ For playing with values (changes/100 is the scene value on ffmpeg):
9587
$ ffmpeg -i YOUR_INPUT -an -filter:v select=gt(scene\,0.1) -f framemd5 -
9688
```
9789

98-
If you are running into trouble with this sensor, please refer to this [Troubleshooting section](/components/camera.ffmpeg/#troubleshooting).
90+
If you are running into trouble with this sensor, please refer to this [Troubleshooting section](/components/ffmpeg/#troubleshooting).
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
layout: page
3+
title: "ISY994 Binary Sensor"
4+
description: "Instructions how to integrate ISY994 binary sensors into Home Assistant."
5+
date: 2016-09-03 23:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: universal_devices.png
11+
ha_category: Binary Sensor
12+
ha_iot_class: "Local Push"
13+
---
14+
15+
The `isy994` platform allows you to get data from your [ISY994](https://www.universal-devices.com/residential/isy994i-series/) binary sensors from within Home Assistant.
16+
17+
They will be automatically discovered if the isy994 component is loaded.
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
layout: page
3+
title: "Modbus Binary Sensor"
4+
description: "Instructions on how to set up Modbus binary sensors within Home Assistant."
5+
date: 2016-09-13 12:02
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: modbus.png
11+
ha_category: Binary Sensor
12+
ha_release: 0.28
13+
---
14+
15+
The `modbus` binary sensor allows you to gather data from [Modbus](http://www.modbus.org/) coils.
16+
17+
To use your Modbus binary sensors in your installation, add the following to your `configuration.yaml` file:
18+
19+
```yaml
20+
# Example configuration.yml entry
21+
binary_sensor:
22+
platform: modbus
23+
coils:
24+
- name: Sensor1
25+
slave: 1
26+
coil: 100
27+
- name: Sensor2
28+
slave: 1
29+
coil: 110
30+
```
31+
32+
Configuration variables:
33+
34+
- **coils** array (*Required*): The array contains a list of coils to read from.
35+
- **name** (*Required*): Name of the sensor.
36+
- **slave** (*Required*): The number of the slave (Optional for tcp and upd Modbus).
37+
- **coil** (*Required*): Coil number.

source/_components/binary_sensor.nx584.markdown

Lines changed: 11 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -17,31 +17,14 @@ The `nx584` platform provides integration with GE, Caddx, Interlogix (and other
1717

1818
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.
1919

20-
To enable this, add the following lines to your `configuration.yaml`:
20+
To enable this feature, add the following lines to your `configuration.yaml`:
2121

2222
```yaml
2323
# Example configuration.yaml entry
2424
binary_sensor:
2525
platform: nx584
26-
host: ADDRESS
27-
exclude_zones:
28-
- ZONE ...
29-
zone_types:
30-
ZONE: TYPE
31-
```
32-
33-
Configuration variables:
34-
35-
- **host** (*Optional*): This is the host connection string (host:port) for the nx584 server process. If unset, it is assumed to be `localhost:5007`, which will work if the server process is running on the same system as home-assistant.
36-
- **exclude_zones** (*Optional*): 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.
37-
- **zone_types** (*Optional*): This is a list of zone numbers mapped to zone types. Use this to designate zones as doors, motion sensors, smoke detectors, etc. The list of available zone types relevant to alarm zones are: `opening`, `motion`, `gas`, `smoke`, `moisture`, `safety`.
38-
39-
Example configuration:
40-
41-
```yaml
42-
binary_sensor:
43-
platform: nx584
44-
host: 192.168.1.10:5007
26+
host: 192.168.1.10
27+
pport: 5007
4528
exclude_zones:
4629
- 3
4730
- 5
@@ -51,3 +34,11 @@ binary_sensor:
5134
4: motion
5235
6: moisture
5336
```
37+
38+
Configuration variables:
39+
40+
- **host** (*Optional*): 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.
41+
- **port** (*Optional*): The port where the server process is running. Defaults to `5007`.
42+
- **exclude_zones** (*Optional*): 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.
43+
- **zone_types** (*Optional*): This is a list of zone numbers mapped to zone types. Use this to designate zones as doors, motion sensors, smoke detectors, etc. The list of available zone types relevant to alarm zones are: `opening`, `motion`, `gas`, `smoke`, `moisture`, `safety`.
44+
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
layout: page
3+
title: "SleepIQ Binary Sensor"
4+
description: "Instructions for how to integrate SleepIQ sensors within Home Assistant."
5+
date: 2016-08-28 8:56
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: sleepiq
11+
ha_category: Binary Sensor
12+
ha_release: 0.29
13+
ha_iot_class: "Local Polling"
14+
---
15+
16+
To get your SleepIQ binary sensors working with Home Assistant, follow the instructions for the general [SleepIQ component](/components/sleepiq/).

source/_components/camera.ffmpeg.markdown

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,6 @@ ha_release: 0.26
1515

1616
The `ffmpeg` platform allows you to use every video feed with [FFmpeg](http://www.ffmpeg.org/) as camera in Home Assistant. The input for ffmpeg need to support that could have multiple connection to source (input) in same time. For every user in UI and all 10 seconds (snapshot image) it make a new connection/reading to source. Normally that should never be a trouble only in strange selfmade constructs can be make mistakes.
1717

18-
<p class='note'>
19-
You need a `ffmpeg` binary in your system path. On Debain 8 you can install it from backports. If you want Hardware support on a Raspberry Pi you need tobuild from source by yourself. Windows binary are avilable on the [FFmpeg](http://www.ffmpeg.org/) website.
20-
</p>
21-
2218
To enable your FFmpeg feed in your installation, add the following to your `configuration.yaml` file:
2319

2420
```yaml
@@ -27,33 +23,18 @@ camera:
2723
- platform: ffmpeg
2824
input: FFMPEG_SUPPORTED_INPUT
2925
name: FFmpeg
30-
ffmpeg_bin: /usr/bin/ffmpeg
3126
extra_arguments: -q:v 2
3227
```
3328
3429
Configuration variables:
3530
3631
- **input** (*Required*): A ffmpeg compatible input file, stream or feed.
3732
- **name** (*Optional*): This parameter allows you to override the name of your camera.
38-
- **ffmpeg_bin** (*Optional*): Default 'ffmpeg'.
3933
- **extra_arguments** (*Optional*): Extra option they will pass to `ffmpeg`. i.e. image quality or video filter options.
4034

4135
### {% linkable_title Image quality %}
4236

4337
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`.
4438

45-
### {% linkable_title Troubleshooting %}
46-
47-
In most of case, `ffmpeg` autodetect all needed options to read a video/audio stream or file. But it is possible in rare cases that's needed to set a option to help `ffmpeg`. Per default `ffmpeg` use 5 seconds to detect all options or abort.
48-
49-
First check, if your stream playable by `ffmpeg` with (use option `-an` or `-vn` to disable video or audio stream):
50-
51-
```
52-
$ ffmpeg -i INPUT -an -f null -
53-
```
54-
55-
Now you can see what going wrong. Following list could be help to solve your trouble:
56-
57-
- `[rtsp @ ...] UDP timeout, retrying with TCP`: You need to set RTSP transport in the configuration with: `input: -rtsp_transport tcp -i INPUT`
58-
- `[rtsp @ ...] Could not find codec parameters for stream 0 (Video: ..., none): unspecified size`: FFmpeg need more data or time for autodetect. You can set the `analyzeduration` and/or `probesize` option, play with this value. If you know the needed value you can set it with: `input: -analyzeduration xy -probesize xy -i INPUT`. More information about that can be found on [FFmpeg](https://www.ffmpeg.org/ffmpeg-formats.html#Description).
5939

40+
If you are running into trouble with this sensor, please refer to this [Troubleshooting section](/components/ffmpeg/#troubleshooting).

0 commit comments

Comments
 (0)