Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.hikvision.binary_sensor.HikvisionBinarySensor Class Reference
Inheritance diagram for homeassistant.components.hikvision.binary_sensor.HikvisionBinarySensor:
[legend]
Collaboration diagram for homeassistant.components.hikvision.binary_sensor.HikvisionBinarySensor:
[legend]

Public Member Functions

def __init__ (self, hass, sensor, channel, cam, delay)
 
def device_class (self)
 
def extra_state_attributes (self)
 
def is_on (self)
 
def name (self)
 
def unique_id (self)
 
- Public Member Functions inherited from homeassistant.components.binary_sensor.BinarySensorEntity
None async_internal_added_to_hass (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.Entity
None __init_subclass__ (cls, **Any kwargs)
 
str __repr__ (self)
 
None add_to_platform_abort (self)
 
None add_to_platform_finish (self)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
bool assumed_state (self)
 
None async_added_to_hass (self)
 
None async_device_update (self, bool warning=True)
 
None async_internal_will_remove_from_hass (self)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
None async_registry_entry_updated (self)
 
None async_remove (self, *bool force_remove=False)
 
None async_removed_from_registry (self)
 
None async_schedule_update_ha_state (self, bool force_refresh=False)
 
None async_set_context (self, Context context)
 
None async_update_ha_state (self, bool force_refresh=False)
 
None async_will_remove_from_hass (self)
 
None async_write_ha_state (self)
 
str|None attribution (self)
 
bool available (self)
 
dict[str, Any]|None capability_attributes (self)
 
DeviceInfo|None device_info (self)
 
bool enabled (self)
 
EntityCategory|None entity_category (self)
 
str|None entity_picture (self)
 
bool entity_registry_enabled_default (self)
 
bool entity_registry_visible_default (self)
 
bool force_update (self)
 
HassJobType get_hassjob_type (self, str function_name)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
bool has_entity_name (self)
 
str|None icon (self)
 
None schedule_update_ha_state (self, bool force_refresh=False)
 
bool should_poll (self)
 
StateType state (self)
 
dict[str, Any]|None state_attributes (self)
 
str|None suggested_object_id (self)
 
int|None supported_features (self)
 
str|None translation_key (self)
 
Mapping[str, strtranslation_placeholders (self)
 
str|None unit_of_measurement (self)
 
bool use_device_name (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None __init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
 
Any __new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)
 

Private Member Functions

def _sensor_last_update (self)
 
def _sensor_state (self)
 
def _update_callback (self, msg)
 

Private Attributes

 _cam
 
 _channel
 
 _delay
 
 _hass
 
 _id
 
 _name
 
 _sensor
 
 _timer
 

Static Private Attributes

bool _attr_should_poll = False
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.binary_sensor.BinarySensorEntity
 entity_category
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Static Public Attributes inherited from homeassistant.components.binary_sensor.BinarySensorEntity
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Representation of a Hikvision binary sensor.

Definition at line 199 of file binary_sensor.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.hikvision.binary_sensor.HikvisionBinarySensor.__init__ (   self,
  hass,
  sensor,
  channel,
  cam,
  delay 
)
Initialize the binary_sensor.

Definition at line 204 of file binary_sensor.py.

Member Function Documentation

◆ _sensor_last_update()

def homeassistant.components.hikvision.binary_sensor.HikvisionBinarySensor._sensor_last_update (   self)
private
Extract sensor last update time.

Definition at line 232 of file binary_sensor.py.

◆ _sensor_state()

def homeassistant.components.hikvision.binary_sensor.HikvisionBinarySensor._sensor_state (   self)
private
Extract sensor state.

Definition at line 228 of file binary_sensor.py.

◆ _update_callback()

def homeassistant.components.hikvision.binary_sensor.HikvisionBinarySensor._update_callback (   self,
  msg 
)
private
Update the sensor's state, if needed.

Definition at line 270 of file binary_sensor.py.

◆ device_class()

def homeassistant.components.hikvision.binary_sensor.HikvisionBinarySensor.device_class (   self)
Return the class of this sensor, from DEVICE_CLASSES.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 252 of file binary_sensor.py.

◆ extra_state_attributes()

def homeassistant.components.hikvision.binary_sensor.HikvisionBinarySensor.extra_state_attributes (   self)
Return the state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 261 of file binary_sensor.py.

◆ is_on()

def homeassistant.components.hikvision.binary_sensor.HikvisionBinarySensor.is_on (   self)
Return true if sensor is on.

Definition at line 247 of file binary_sensor.py.

◆ name()

def homeassistant.components.hikvision.binary_sensor.HikvisionBinarySensor.name (   self)
Return the name of the Hikvision sensor.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 237 of file binary_sensor.py.

◆ unique_id()

def homeassistant.components.hikvision.binary_sensor.HikvisionBinarySensor.unique_id (   self)
Return a unique ID.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 242 of file binary_sensor.py.

Member Data Documentation

◆ _attr_should_poll

bool homeassistant.components.hikvision.binary_sensor.HikvisionBinarySensor._attr_should_poll = False
staticprivate

Definition at line 202 of file binary_sensor.py.

◆ _cam

homeassistant.components.hikvision.binary_sensor.HikvisionBinarySensor._cam
private

Definition at line 207 of file binary_sensor.py.

◆ _channel

homeassistant.components.hikvision.binary_sensor.HikvisionBinarySensor._channel
private

Definition at line 209 of file binary_sensor.py.

◆ _delay

homeassistant.components.hikvision.binary_sensor.HikvisionBinarySensor._delay
private

Definition at line 219 of file binary_sensor.py.

◆ _hass

homeassistant.components.hikvision.binary_sensor.HikvisionBinarySensor._hass
private

Definition at line 206 of file binary_sensor.py.

◆ _id

homeassistant.components.hikvision.binary_sensor.HikvisionBinarySensor._id
private

Definition at line 216 of file binary_sensor.py.

◆ _name

homeassistant.components.hikvision.binary_sensor.HikvisionBinarySensor._name
private

Definition at line 212 of file binary_sensor.py.

◆ _sensor

homeassistant.components.hikvision.binary_sensor.HikvisionBinarySensor._sensor
private

Definition at line 208 of file binary_sensor.py.

◆ _timer

homeassistant.components.hikvision.binary_sensor.HikvisionBinarySensor._timer
private

Definition at line 223 of file binary_sensor.py.


The documentation for this class was generated from the following file: