Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.hikvision.binary_sensor.HikvisionData Class Reference

Public Member Functions

def __init__ (self, hass, url, port, name, username, password)
 
def cam_id (self)
 
def get_attributes (self, sensor, channel)
 
def name (self)
 
def sensors (self)
 
def start_hik (self, event)
 
def stop_hik (self, event)
 
def type (self)
 

Public Attributes

 camdata
 

Private Attributes

 _name
 
 _password
 
 _port
 
 _url
 
 _username
 

Detailed Description

Hikvision device event stream object.

Definition at line 146 of file binary_sensor.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.hikvision.binary_sensor.HikvisionData.__init__ (   self,
  hass,
  url,
  port,
  name,
  username,
  password 
)
Initialize the data object.

Definition at line 149 of file binary_sensor.py.

Member Function Documentation

◆ cam_id()

def homeassistant.components.hikvision.binary_sensor.HikvisionData.cam_id (   self)
Return device id.

Definition at line 180 of file binary_sensor.py.

◆ get_attributes()

def homeassistant.components.hikvision.binary_sensor.HikvisionData.get_attributes (   self,
  sensor,
  channel 
)
Return attribute list for sensor/channel.

Definition at line 194 of file binary_sensor.py.

◆ name()

def homeassistant.components.hikvision.binary_sensor.HikvisionData.name (   self)
Return device name.

Definition at line 185 of file binary_sensor.py.

◆ sensors()

def homeassistant.components.hikvision.binary_sensor.HikvisionData.sensors (   self)
Return list of available sensors and their states.

Definition at line 175 of file binary_sensor.py.

◆ start_hik()

def homeassistant.components.hikvision.binary_sensor.HikvisionData.start_hik (   self,
  event 
)
Start Hikvision event stream thread.

Definition at line 170 of file binary_sensor.py.

◆ stop_hik()

def homeassistant.components.hikvision.binary_sensor.HikvisionData.stop_hik (   self,
  event 
)
Shutdown Hikvision subscriptions and subscription thread on exit.

Definition at line 166 of file binary_sensor.py.

◆ type()

def homeassistant.components.hikvision.binary_sensor.HikvisionData.type (   self)
Return device type.

Definition at line 190 of file binary_sensor.py.

Member Data Documentation

◆ _name

homeassistant.components.hikvision.binary_sensor.HikvisionData._name
private

Definition at line 153 of file binary_sensor.py.

◆ _password

homeassistant.components.hikvision.binary_sensor.HikvisionData._password
private

Definition at line 155 of file binary_sensor.py.

◆ _port

homeassistant.components.hikvision.binary_sensor.HikvisionData._port
private

Definition at line 152 of file binary_sensor.py.

◆ _url

homeassistant.components.hikvision.binary_sensor.HikvisionData._url
private

Definition at line 151 of file binary_sensor.py.

◆ _username

homeassistant.components.hikvision.binary_sensor.HikvisionData._username
private

Definition at line 154 of file binary_sensor.py.

◆ camdata

homeassistant.components.hikvision.binary_sensor.HikvisionData.camdata

Definition at line 158 of file binary_sensor.py.


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