Skip to content

Commit 9b62405

Browse files
pvizelifabaff
authored andcommitted
Spliting doc for ffmpeg binary sensor (home-assistant#1924)
1 parent 623024e commit 9b62405

File tree

2 files changed

+54
-38
lines changed

2 files changed

+54
-38
lines changed

source/_components/binary_sensor.ffmpeg.markdown renamed to source/_components/binary_sensor.ffmpeg_motion.markdown

Lines changed: 6 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
3-
title: "FFmpeg Binary Sensor"
4-
description: "Instructions on how to integrate an FFmpeg-based binary sensor"
3+
title: "FFmpeg Motion Binary Sensor"
4+
description: "Instructions on how to integrate an FFmpeg-based motion binary sensor"
55
date: 2016-08-25 08:00
66
sidebar: true
77
comments: false
@@ -10,45 +10,15 @@ footer: true
1010
logo: ffmpeg.png
1111
ha_category: Binary Sensor
1212
ha_release: 0.27
13-
ha_iot_class: "Local Polling"
1413
---
1514

1615

17-
The `ffmpeg` platform allows you to use any video or audio feed with [FFmpeg](http://www.ffmpeg.org/) for various sensors in Home Assistant. Available are: **noise**, **motion**.
16+
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'>
20-
If the `ffmpeg` process is broken, the sensor will be unavailable. To controll the ffmpeg process of sensor, use the service *binary_sensor.ffmpeg_start*, *binary_sensor.ffmpeg_stop*, *binary_sensor.ffmpeg_restart*.
19+
If the `ffmpeg` process is broken, the sensor will be unavailable. To controll the ffmpeg process of sensor, use the service *ffmpeg.start*, *ffmpeg.stop*, *ffmpeg.restart*.
2120
</p>
2221

23-
### {% linkable_title Noise %}
24-
25-
To add FFmpeg with noise detection to your installation, add the following to your `configuration.yaml` file:
26-
27-
```yaml
28-
# Example configuration.yaml entry
29-
binary_sensor:
30-
- platform: ffmpeg
31-
tool: noise
32-
```
33-
34-
Configuration variables:
35-
36-
- **input** (*Required*): An FFmpeg-compatible input file, stream, or feed.
37-
- **tool** (*Required*): `noise`.
38-
- **name** (*Optional*): Override the name of your camera.
39-
- **initial_state** (*Optional*): Default true. Start ffmpeg with home-assistant.
40-
- **peak** (*Optional*): Default -30. The threshold of detecting noise, in dB. 0 is very loud and -100 is low.
41-
- **duration** (*Optional*): Default 1 second. How long the noise needs to be over the peak to trigger the state.
42-
- **reset** (*Optional*): Default 20 seconds. The time to reset the state after no new noise is over the peak.
43-
- **extra_arguments** (*Optional*): Extra options to pass to `ffmpeg`, like audio frequency filtering.
44-
- **output** (*Optional*): Allows you to send the audio output of this sensor to an Icecast server or other FFmpeg-supported output, e.g. to stream with Sonos after a state is triggered.
45-
46-
To experiment with values:
47-
48-
```bash
49-
$ ffmpeg -i YOUR_INPUT -vn -filter:a silencedetect=n=-30dB:d=1 -f null -
50-
```
51-
5222
### {% linkable_title Motion %}
5323

5424
FFmpeg doesn't have a motion detection filter, but can use a scene filter to detect a new scene/motion. You can set how much needs to change in order to detect motion with the option 'changes', the percent value of change between frames. If you want a really small value for 'changes', you can also add a denoise filter.
@@ -59,16 +29,14 @@ To add FFmpeg with motion detection to your installation, add the following to y
5929
# Example configuration.yaml entry
6030
binary_sensor:
6131
- platform: ffmpeg
62-
tool: motion
6332
input: FFMPEG_SUPPORTED_INPUT
6433
```
6534
6635
Configuration variables:
6736
6837
- **input** (*Required*): An FFmpeg-compatible input file, stream, or feed.
69-
- **tool** (*Required*): `motion`.
7038
- **name** (*Optional*): Override the name of your camera for the frontend.
71-
- **initial_state** (*Optional*): Start `ffmpeg` with Home Assistant. Defaults to `true`.
39+
- **initial_state** (*Optional*): Start `ffmpeg` with Home Assistant. Defaults to `true`.
7240
- **changes** (*Optional*): How much needs to change between two frames to detect it as motion (a lower value is more sensitive). Defaults to 10%.
7341
- **reset** (*Optional*): The time to reset the state after no new motion is detected. Defaults to 20 seconds.
7442
- **repeat** (*Optional*): How many events need to be detected in *repeat_time* in order to trigger a motion. Defaults to 0 repeats (deactivated).
@@ -85,7 +53,7 @@ If you are running into trouble with this sensor, please refer to the [troublesh
8553

8654
#### {% linkable_title Tipps %}
8755

88-
- Use motion only in a customer area with [crop filter](https://ffmpeg.org/ffmpeg-filters.html#crop):
56+
- Use motion only in a customer area with [crop filter](https://ffmpeg.org/ffmpeg-filters.html#crop):
8957

9058
```yaml
9159
extra_arguments: -filter:v "crop=100:100:12:34"
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
layout: page
3+
title: "FFmpeg Noise Binary Sensor"
4+
description: "Instructions on how to integrate an FFmpeg-based noise binary sensor"
5+
date: 2016-08-25 08:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: ffmpeg.png
11+
ha_category: Binary Sensor
12+
ha_release: 0.27
13+
---
14+
15+
16+
The `ffmpeg` platform allows you to use any video or audio feed with [FFmpeg](http://www.ffmpeg.org/) for various sensors in Home Assistant.
17+
18+
<p class='note'>
19+
If the `ffmpeg` process is broken, the sensor will be unavailable. To controll the ffmpeg process of sensor, use the service *ffmpeg.start*, *ffmpeg.stop*, *ffmpeg.restart*.
20+
</p>
21+
22+
### {% linkable_title Noise %}
23+
24+
To add FFmpeg with noise detection to your installation, add the following to your `configuration.yaml` file:
25+
26+
```yaml
27+
# Example configuration.yaml entry
28+
binary_sensor:
29+
- platform: ffmpeg
30+
input: FFMPEG_SUPPORTED_INPUT
31+
```
32+
33+
Configuration variables:
34+
35+
- **input** (*Required*): An FFmpeg-compatible input file, stream, or feed.
36+
- **name** (*Optional*): Override the name of your camera.
37+
- **initial_state** (*Optional*): Default true. Start ffmpeg with home-assistant.
38+
- **peak** (*Optional*): Default -30. The threshold of detecting noise, in dB. 0 is very loud and -100 is low.
39+
- **duration** (*Optional*): Default 1 second. How long the noise needs to be over the peak to trigger the state.
40+
- **reset** (*Optional*): Default 20 seconds. The time to reset the state after no new noise is over the peak.
41+
- **extra_arguments** (*Optional*): Extra options to pass to `ffmpeg`, like audio frequency filtering.
42+
- **output** (*Optional*): Allows you to send the audio output of this sensor to an Icecast server or other FFmpeg-supported output, e.g. to stream with Sonos after a state is triggered.
43+
44+
To experiment with values:
45+
46+
```bash
47+
$ ffmpeg -i YOUR_INPUT -vn -filter:a silencedetect=n=-30dB:d=1 -f null -
48+
```

0 commit comments

Comments
 (0)