homeassistant.components.ffmpeg_motion.binary_sensor Namespace Reference

Classes
class	FFmpegBinarySensor
class	FFmpegMotion

Functions
None	__init__ (self, _HAFFmpegT ffmpeg, dict[str, Any] config)
None	_async_callback (self, bool|None state)
None	async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None discovery_info=None)
bool|None	is_on (self)
str	name (self)

Variables
	_config
	_state
string	CONF_CHANGES = "changes"
string	CONF_REPEAT_TIME = "repeat_time"
string	CONF_RESET = "reset"
bool	DEFAULT_INIT_STATE = True
string	DEFAULT_NAME = "FFmpeg Motion"
	PLATFORM_SCHEMA

Detailed Description

Provides a binary sensor which is a collection of ffmpeg tools.

Function Documentation

__init__()

None homeassistant.components.ffmpeg_motion.binary_sensor.__init__	(		self,
		_HAFFmpegT	ffmpeg,
		dict[str, Any]	config
	)

A binary sensor which use FFmpeg for noise detection.

Init for the binary sensor noise detection.

Definition at line 76 of file binary_sensor.py.

_async_callback()

None homeassistant.components.ffmpeg_motion.binary_sensor._async_callback (   self, bool | None  state  )

private

HA-FFmpeg callback for noise detection.

Definition at line 85 of file binary_sensor.py.

async_setup_platform()

None homeassistant.components.ffmpeg_motion.binary_sensor.async_setup_platform	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	async_add_entities,
		DiscoveryInfoType | None	discovery_info = None
	)

Set up the FFmpeg binary motion sensor.

Definition at line 59 of file binary_sensor.py.

is_on()

bool | None homeassistant.components.ffmpeg_motion.binary_sensor.is_on

(

self

)

Return true if the binary sensor is on.

Definition at line 91 of file binary_sensor.py.

name()

str homeassistant.components.ffmpeg_motion.binary_sensor.name

(

self

)

Return the name of the entity.

Definition at line 96 of file binary_sensor.py.

Variable Documentation

_config

homeassistant.components.ffmpeg_motion.binary_sensor._config

private

Definition at line 81 of file binary_sensor.py.

_state

homeassistant.components.ffmpeg_motion.binary_sensor._state

private

Definition at line 87 of file binary_sensor.py.

CONF_CHANGES

string homeassistant.components.ffmpeg_motion.binary_sensor.CONF_CHANGES = "changes"

Definition at line 31 of file binary_sensor.py.

CONF_REPEAT_TIME

string homeassistant.components.ffmpeg_motion.binary_sensor.CONF_REPEAT_TIME = "repeat_time"

Definition at line 32 of file binary_sensor.py.

CONF_RESET

string homeassistant.components.ffmpeg_motion.binary_sensor.CONF_RESET = "reset"

Definition at line 30 of file binary_sensor.py.

DEFAULT_INIT_STATE

bool homeassistant.components.ffmpeg_motion.binary_sensor.DEFAULT_INIT_STATE = True

Definition at line 35 of file binary_sensor.py.

DEFAULT_NAME

string homeassistant.components.ffmpeg_motion.binary_sensor.DEFAULT_NAME = "FFmpeg Motion"

Definition at line 34 of file binary_sensor.py.

PLATFORM_SCHEMA

homeassistant.components.ffmpeg_motion.binary_sensor.PLATFORM_SCHEMA

Initial value:

=  BINARY_SENSOR_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_INPUT): cv.string,
        vol.Optional(CONF_INITIAL_STATE, default=DEFAULT_INIT_STATE): cv.boolean,
        vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
        vol.Optional(CONF_EXTRA_ARGUMENTS): cv.string,
        vol.Optional(CONF_RESET, default=10): vol.All(
            vol.Coerce(int), vol.Range(min=1)
        ),
        vol.Optional(CONF_CHANGES, default=10): vol.All(
            vol.Coerce(float), vol.Range(min=0, max=99)
        ),
        vol.Inclusive(CONF_REPEAT, "repeat"): vol.All(
            vol.Coerce(int), vol.Range(min=1)
        ),
        vol.Inclusive(CONF_REPEAT_TIME, "repeat"): vol.All(
            vol.Coerce(int), vol.Range(min=1)
        ),
    }
)

Definition at line 37 of file binary_sensor.py.