From 6f794cbd1ae8e009ed03b85d46f30afebcbe0446 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Fri, 26 Aug 2016 12:28:44 +0200 Subject: [PATCH] Minor changes --- .../_components/binary_sensor.ffmpeg.markdown | 31 ++++++++++--------- 1 file changed, 17 insertions(+), 14 deletions(-) diff --git a/source/_components/binary_sensor.ffmpeg.markdown b/source/_components/binary_sensor.ffmpeg.markdown index 0233cafe5b0..5d9d9f433df 100644 --- a/source/_components/binary_sensor.ffmpeg.markdown +++ b/source/_components/binary_sensor.ffmpeg.markdown @@ -10,13 +10,14 @@ footer: true logo: ffmpeg.png ha_category: Binary Sensor ha_release: 0.27 +ha_iot_class: "Local Polling" --- -The `ffmpeg` platform allows you to use every video or audio feed with [FFmpeg](http://www.ffmpeg.org/) as varius sensors in Home Assistant. Avilable are: **noise**, **motion**. If ffmpeg process is brocken, sensor going to unavilable. It exists a service to restart a instance with *binary_sensor.ffmpeg_restart*. +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 brocken, the sensor going to unavailable. It exists a service to restart a instance with *binary_sensor.ffmpeg_restart*.

-You need a ffmpeg binary in your system path. On debain 8 you can install it from backports. If you want HW support on raspberry you need self build from source. Windows binary are avilable on ffmpeg homepage. +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 to build it from sourceby ourself. Windows binary are avilable on [FFmpeg](http://www.ffmpeg.org/) homepage.

### {% linkable_title Noise %} @@ -39,23 +40,24 @@ camera: Configuration variables: - **input** (*Required*): A ffmpeg compatible input file, stream or feed. -- **tool** (*Required*): is fix set to 'noise'. +- **tool** (*Required*): Is fix set to `noise`. - **name** (*Optional*): This parameter allows you to override the name of your camera. -- **ffmpeg_bin** (*Optional*): Default 'ffmpeg'. +- **ffmpeg_bin** (*Optional*): Default `ffmpeg`. - **peak** (*Optional*): Default -30. A peak of dB to detect it as noise. 0 is very loud and -100 is low. - **duration** (*Optional*): Default 1 seconds. How long need the noise over the peak to trigger the state. -- **reset** (*Optional*): Default 20 seconds. The time to reset the state after none new noise is over the peak. -- **extra_arguments** (*Optional*): Extra option they will pass to ffmpeg. i.e. audio frequence filtering. -- **output** (*Optional*): Allow you to send the audio output of this sensor to a icecast server or other ffmpeg supported output. i.e. to stream with sonos after state is trigger. +- **reset** (*Optional*): Defaults to 20 seconds. The time to reset the state after none new noise is over the peak. +- **extra_arguments** (*Optional*): Extra option they will pass to `ffmpeg`, like audio frequence filtering. +- **output** (*Optional*): Allow you to send the audio output of this sensor to a icecast server or other ffmpeg supported output, eg. to stream with sonos after state is trigger. For playing with values: + ```bash -ffmpeg -i YOUR_INPUT -vn -filter:a silencedetect=n=-30dB:d=1 -f null - +$ ffmpeg -i YOUR_INPUT -vn -filter:a silencedetect=n=-30dB:d=1 -f null - ``` ### {% linkable_title Motion %} -FFmpeg don't have a motion detection filter so it use a scene filter to detect a new scene/motion. In fact you can set how big a object or size of image they need change to detect a motion. The option 'changes' is the percent value of change between frames. You can add a denoice filter to video if you want a realy small value for 'changes'. +FFmpeg don't have a motion detection filter so it use a scene filter to detect a new scene/motion. In fact you can set how big a object or size of image they need change to detect a motion. The option 'changes' is the percent value of change between frames. You can add a denoise filter to video if you want a realy small value for 'changes'. To enable your FFmpeg with motion detection in your installation, add the following to your `configuration.yaml` file: @@ -78,16 +80,17 @@ camera: Configuration variables: - **input** (*Required*): A ffmpeg compatible input file, stream or feed. -- **tool** (*Required*): is fix set to 'motion'. +- **tool** (*Required*): Is fix set to `motion`. - **name** (*Optional*): This parameter allows you to override the name of your camera. -- **ffmpeg_bin** (*Optional*): Default 'ffmpeg'. -- **changes** (*Optional*): Default 10 percent. A lower value is more sensitive. I use 4 / 3.5 on my cameras. It describe how mutch of two frames need to change to detect it as motion. See on descripton. +- **ffmpeg_bin** (*Optional*): Default `ffmpeg`. +- **changes** (*Optional*): Default 10 percent. A lower value is more sensitive. I use 4 / 3.5 on my cameras. It describe how much of two frames need to change to detect it as motion. See on descripton. - **reset** (*Optional*): Default 20 seconds. The time to reset the state after none new motion is detect. - **repeat** (*Optional*): Default 0 repeats (deactivate). How many motion need to detect in *repeat_time* to trigger a motion. -- **repeat_time** (*Optional*): Default 0 seconds (deactivate). The time to repeats befor it trigger a motion. +- **repeat_time** (*Optional*): Default 0 seconds (deactivate). The time to repeats before it trigger a motion. - **extra_arguments** (*Optional*): Extra option they will pass to ffmpeg. i.e. video denoise filtering. For playing with values (changes/100 is the scene value on ffmpeg): + ```bash -ffmpeg -i YOUR_INPUT -an -filter:v select=gt(scene\,0.1) -f framemd5 - +$ ffmpeg -i YOUR_INPUT -an -filter:v select=gt(scene\,0.1) -f framemd5 - ```