mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-08 18:06:54 +00:00
Update binary_sensor.ffmpeg.markdown (#886)
Reworded a few places for grammar/readability. Also, I have never proposed a change to the documentation before, so I hope I am doing this in the proper way. Trying to be helpful, not step on anyone's feet! Please feel free to admonish me, if I am not following proper etiquette. :)
This commit is contained in:
parent
0f4f267306
commit
d882106301
@ -14,10 +14,10 @@ ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
|
||||
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*.
|
||||
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*.
|
||||
|
||||
<p class='note'>
|
||||
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.
|
||||
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.
|
||||
</p>
|
||||
|
||||
### {% linkable_title Noise %}
|
||||
@ -47,7 +47,7 @@ Configuration variables:
|
||||
- **duration** (*Optional*): Default 1 seconds. How long need the noise over the peak to trigger the state.
|
||||
- **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.
|
||||
- **output** (*Optional*): Allow you to send the audio output of this sensor to an icecast server or other ffmpeg supported output, eg. to stream with sonos after state is triggered.
|
||||
|
||||
For playing with values:
|
||||
|
||||
@ -57,7 +57,7 @@ $ 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 denoise filter to video if you want a realy small value for 'changes'.
|
||||
FFmpeg doesn't have a motion detection filter, so it uses a scene filter to detect a new scene/motion. In fact, you can set how big of an object or the size of an image that needs to change in order to detect motion. The option 'changes' is the percent value of change between frames. You can add a denoise filter to the video if you want a really small value for 'changes'.
|
||||
|
||||
To enable your FFmpeg with motion detection in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
@ -79,14 +79,14 @@ camera:
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **input** (*Required*): A ffmpeg compatible input file, stream or feed.
|
||||
- **input** (*Required*): A ffmpeg compatible input file, stream, or feed.
|
||||
- **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 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 before it trigger a motion.
|
||||
- **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.
|
||||
- **reset** (*Optional*): Default 20 seconds. The time to reset the state after no new motion is detected.
|
||||
- **repeat** (*Optional*): Default 0 repeats (deactivate). How many events need to be detected in *repeat_time* in order to trigger a motion.
|
||||
- **repeat_time** (*Optional*): Default 0 seconds (deactivate). The span of time *repeat* events need to occur in before triggering 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):
|
||||
|
Loading…
x
Reference in New Issue
Block a user