Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.unifiprotect.binary_sensor Namespace Reference

Classes

class  MountableProtectDeviceBinarySensor
 
class  ProtectBinaryEntityDescription
 
class  ProtectBinaryEventEntityDescription
 
class  ProtectDeviceBinarySensor
 
class  ProtectDiskBinarySensor
 
class  ProtectEventBinarySensor
 

Functions

list[ProtectDeviceEntity_async_event_entities (ProtectData data, ProtectAdoptableDeviceModel|None ufp_device=None)
 
list[BaseProtectEntity_async_nvr_entities (ProtectData data)
 
None async_setup_entry (HomeAssistant hass, UFPConfigEntry entry, AddEntitiesCallback async_add_entities)
 

Variables

string _KEY_DOOR = "door"
 
tuple MODEL_DESCRIPTIONS_WITH_CLASS
 
dictionary MOUNT_DEVICE_CLASS_MAP
 

Detailed Description

Component providing binary sensors for UniFi Protect.

Function Documentation

◆ _async_event_entities()

list[ProtectDeviceEntity] homeassistant.components.unifiprotect.binary_sensor._async_event_entities ( ProtectData  data,
ProtectAdoptableDeviceModel | None   ufp_device = None 
)
private

Definition at line 740 of file binary_sensor.py.

◆ _async_nvr_entities()

list[BaseProtectEntity] homeassistant.components.unifiprotect.binary_sensor._async_nvr_entities ( ProtectData  data)
private

Definition at line 755 of file binary_sensor.py.

◆ async_setup_entry()

None homeassistant.components.unifiprotect.binary_sensor.async_setup_entry ( HomeAssistant  hass,
UFPConfigEntry  entry,
AddEntitiesCallback  async_add_entities 
)
Set up binary sensors for UniFi Protect integration.

Definition at line 769 of file binary_sensor.py.

Variable Documentation

◆ _KEY_DOOR

string homeassistant.components.unifiprotect.binary_sensor._KEY_DOOR = "door"
private

Definition at line 41 of file binary_sensor.py.

◆ MODEL_DESCRIPTIONS_WITH_CLASS

tuple homeassistant.components.unifiprotect.binary_sensor.MODEL_DESCRIPTIONS_WITH_CLASS
Initial value:
1 = (
2  (_MODEL_DESCRIPTIONS, ProtectDeviceBinarySensor),
3  (_MOUNTABLE_MODEL_DESCRIPTIONS, MountableProtectDeviceBinarySensor),
4 )

Definition at line 733 of file binary_sensor.py.

◆ MOUNT_DEVICE_CLASS_MAP

dictionary homeassistant.components.unifiprotect.binary_sensor.MOUNT_DEVICE_CLASS_MAP
Initial value:
1 = {
2  MountType.GARAGE: BinarySensorDeviceClass.GARAGE_DOOR,
3  MountType.WINDOW: BinarySensorDeviceClass.WINDOW,
4  MountType.DOOR: BinarySensorDeviceClass.DOOR,
5 }

Definition at line 58 of file binary_sensor.py.