homeassistant.components.hikvision.binary_sensor Namespace Reference

Classes
class	HikvisionBinarySensor
class	HikvisionData

Functions
None	setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback add_entities, DiscoveryInfoType|None discovery_info=None)

Variables
	_LOGGER = logging.getLogger(__name__)
string	ATTR_DELAY = "delay"
string	CONF_IGNORED = "ignored"
	CUSTOMIZE_SCHEMA
int	DEFAULT_DELAY = 0
bool	DEFAULT_IGNORED = False
int	DEFAULT_PORT = 80
dictionary	DEVICE_CLASS_MAP
	PLATFORM_SCHEMA

Detailed Description

Support for Hikvision event stream events represented as binary sensors.

Function Documentation

setup_platform()

None homeassistant.components.hikvision.binary_sensor.setup_platform	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	add_entities,
		DiscoveryInfoType | None	discovery_info = None
	)

Set up the Hikvision binary sensor devices.

Definition at line 92 of file binary_sensor.py.

Variable Documentation

_LOGGER

homeassistant.components.hikvision.binary_sensor._LOGGER = logging.getLogger(__name__)

private

Definition at line 36 of file binary_sensor.py.

ATTR_DELAY

string homeassistant.components.hikvision.binary_sensor.ATTR_DELAY = "delay"

Definition at line 44 of file binary_sensor.py.

CONF_IGNORED

string homeassistant.components.hikvision.binary_sensor.CONF_IGNORED = "ignored"

Definition at line 38 of file binary_sensor.py.

CUSTOMIZE_SCHEMA

homeassistant.components.hikvision.binary_sensor.CUSTOMIZE_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Optional(CONF_IGNORED, default=DEFAULT_IGNORED): cv.boolean,
        vol.Optional(CONF_DELAY, default=DEFAULT_DELAY): cv.positive_int,
    }
)

Definition at line 70 of file binary_sensor.py.

DEFAULT_DELAY

int homeassistant.components.hikvision.binary_sensor.DEFAULT_DELAY = 0

Definition at line 42 of file binary_sensor.py.

DEFAULT_IGNORED

bool homeassistant.components.hikvision.binary_sensor.DEFAULT_IGNORED = False

Definition at line 41 of file binary_sensor.py.

DEFAULT_PORT

int homeassistant.components.hikvision.binary_sensor.DEFAULT_PORT = 80

Definition at line 40 of file binary_sensor.py.

DEVICE_CLASS_MAP

dictionary homeassistant.components.hikvision.binary_sensor.DEVICE_CLASS_MAP

Initial value:

=  {
    "Motion": BinarySensorDeviceClass.MOTION,
    "Line Crossing": BinarySensorDeviceClass.MOTION,
    "Field Detection": BinarySensorDeviceClass.MOTION,
    "Tamper Detection": BinarySensorDeviceClass.MOTION,
    "Shelter Alarm": None,
    "Disk Full": None,
    "Disk Error": None,
    "Net Interface Broken": BinarySensorDeviceClass.CONNECTIVITY,
    "IP Conflict": BinarySensorDeviceClass.CONNECTIVITY,
    "Illegal Access": None,
    "Video Mismatch": None,
    "Bad Video": None,
    "PIR Alarm": BinarySensorDeviceClass.MOTION,
    "Face Detection": BinarySensorDeviceClass.MOTION,
    "Scene Change Detection": BinarySensorDeviceClass.MOTION,
    "I/O": None,
    "Unattended Baggage": BinarySensorDeviceClass.MOTION,
    "Attended Baggage": BinarySensorDeviceClass.MOTION,
    "Recording Failure": None,
    "Exiting Region": BinarySensorDeviceClass.MOTION,
    "Entering Region": BinarySensorDeviceClass.MOTION,
}

Definition at line 46 of file binary_sensor.py.

PLATFORM_SCHEMA

homeassistant.components.hikvision.binary_sensor.PLATFORM_SCHEMA

Initial value:

=  BINARY_SENSOR_PLATFORM_SCHEMA.extend(
    {
        vol.Optional(CONF_NAME): cv.string,
        vol.Required(CONF_HOST): cv.string,
        vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port,
        vol.Optional(CONF_SSL, default=False): cv.boolean,
        vol.Required(CONF_USERNAME): cv.string,
        vol.Required(CONF_PASSWORD): cv.string,
        vol.Optional(CONF_CUSTOMIZE, default={}): vol.Schema(
            {cv.string: CUSTOMIZE_SCHEMA}
        ),
    }
)

Definition at line 77 of file binary_sensor.py.