homeassistant.components.onvif.device.ONVIFDevice Class Reference

Public Member Functions
None	__init__ (self, HomeAssistant hass, ConfigEntry config_entry)
None	async_check_date_and_time (self)
def	async_get_capabilities (self)
DeviceInfo	async_get_device_info (self)
list[Profile]	async_get_profiles (self)
str	async_get_stream_uri (self, Profile profile)
None	async_manually_set_date_and_time (self)
def	async_perform_ptz (self, Profile profile, distance, speed, move_mode, continuous_duration, preset, pan=None, tilt=None, zoom=None)
None	async_run_aux_command (self, Profile profile, str cmd)
None	async_set_imaging_settings (self, Profile profile, dict settings)
None	async_setup (self)
def	async_start_events (self)
def	async_stop (self, event=None)
str	host (self)
str	name (self)
str	password (self)
int	port (self)
str	username (self)

Public Attributes
	capabilities
	device
	events
	info
	max_resolution
	onvif_capabilities
	profiles

Private Member Functions
None	_async_log_time_out_of_sync (self, dt.datetime cam_date_utc, dt.datetime system_date)
None	_async_update_listener (self, HomeAssistant hass, ConfigEntry entry)

Private Attributes
	_dt_diff_seconds
	_original_options

Detailed Description

Manages an ONVIF device.

Definition at line 48 of file device.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.onvif.device.ONVIFDevice.__init__	(		self,
		HomeAssistant	hass,
		ConfigEntry	config_entry
	)

Initialize the device.

Definition at line 54 of file device.py.

Member Function Documentation

_async_log_time_out_of_sync()

None homeassistant.components.onvif.device.ONVIFDevice._async_log_time_out_of_sync (   self, dt.datetime  cam_date_utc, dt.datetime   system_date  )

private

Log a warning if the camera and system date/time are not synced.

Definition at line 305 of file device.py.

_async_update_listener()

None homeassistant.components.onvif.device.ONVIFDevice._async_update_listener (   self, HomeAssistant  hass, ConfigEntry   entry  )

private

Handle options update.

Definition at line 70 of file device.py.

async_check_date_and_time()

None homeassistant.components.onvif.device.ONVIFDevice.async_check_date_and_time

(

self

)

Warns if device and system date not synced.

Definition at line 229 of file device.py.

async_get_capabilities()

def homeassistant.components.onvif.device.ONVIFDevice.async_get_capabilities

(

self

)

Obtain information about the available services on the device.

Definition at line 364 of file device.py.

async_get_device_info()

DeviceInfo homeassistant.components.onvif.device.ONVIFDevice.async_get_device_info

(

self

)

Obtain information about this device.

Definition at line 320 of file device.py.

async_get_profiles()

list[Profile] homeassistant.components.onvif.device.ONVIFDevice.async_get_profiles

(

self

)

Obtain media profiles for this device.

Definition at line 405 of file device.py.

async_get_stream_uri()

str homeassistant.components.onvif.device.ONVIFDevice.async_get_stream_uri	(		self,
		Profile	profile
	)

Get the stream URI for a specified profile.

Definition at line 471 of file device.py.

async_manually_set_date_and_time()

None homeassistant.components.onvif.device.ONVIFDevice.async_manually_set_date_and_time

(

self

)

Set Date and Time Manually using SetSystemDateAndTime command.

Definition at line 179 of file device.py.

async_perform_ptz()

def homeassistant.components.onvif.device.ONVIFDevice.async_perform_ptz	(		self,
		Profile	profile,
			distance,
			speed,
			move_mode,
			continuous_duration,
			preset,
			pan = None,
			tilt = None,
			zoom = None
	)

Perform a PTZ action on the camera.

Definition at line 483 of file device.py.

async_run_aux_command()

None homeassistant.components.onvif.device.ONVIFDevice.async_run_aux_command	(		self,
		Profile	profile,
		str	cmd
	)

Execute a PTZ auxiliary command on the camera.

Definition at line 612 of file device.py.

async_set_imaging_settings()

None homeassistant.components.onvif.device.ONVIFDevice.async_set_imaging_settings	(		self,
		Profile	profile,
		dict	settings
	)

Set an imaging setting on the ONVIF imaging service.

Definition at line 639 of file device.py.

async_setup()

None homeassistant.components.onvif.device.ONVIFDevice.async_setup

(

self

)

Set up the device.

Definition at line 102 of file device.py.

async_start_events()

def homeassistant.components.onvif.device.ONVIFDevice.async_start_events

(

self

)

Start the event handler.

Definition at line 384 of file device.py.

async_stop()

def homeassistant.components.onvif.device.ONVIFDevice.async_stop	(		self,
			event = None
	)

Shut it all down.

Definition at line 173 of file device.py.

host()

str homeassistant.components.onvif.device.ONVIFDevice.host

(

self

)

Return the host of this device.

Definition at line 83 of file device.py.

name()

str homeassistant.components.onvif.device.ONVIFDevice.name

(

self

)

Return the name of this device.

Definition at line 78 of file device.py.

password()

str homeassistant.components.onvif.device.ONVIFDevice.password

(

self

)

Return the password of this device.

Definition at line 98 of file device.py.

port()

int homeassistant.components.onvif.device.ONVIFDevice.port

(

self

)

Return the port of this device.

Definition at line 88 of file device.py.

username()

str homeassistant.components.onvif.device.ONVIFDevice.username

(

self

)

Return the username of this device.

Definition at line 93 of file device.py.

Member Data Documentation

_dt_diff_seconds

homeassistant.components.onvif.device.ONVIFDevice._dt_diff_seconds

private

Definition at line 287 of file device.py.

_original_options

homeassistant.components.onvif.device.ONVIFDevice._original_options

private

Definition at line 58 of file device.py.

capabilities

homeassistant.components.onvif.device.ONVIFDevice.capabilities

Definition at line 138 of file device.py.

device

homeassistant.components.onvif.device.ONVIFDevice.device

Definition at line 104 of file device.py.

events

homeassistant.components.onvif.device.ONVIFDevice.events

Definition at line 123 of file device.py.

info

homeassistant.components.onvif.device.ONVIFDevice.info

Definition at line 126 of file device.py.

max_resolution

homeassistant.components.onvif.device.ONVIFDevice.max_resolution

Definition at line 153 of file device.py.

onvif_capabilities

homeassistant.components.onvif.device.ONVIFDevice.onvif_capabilities

Definition at line 117 of file device.py.

profiles

homeassistant.components.onvif.device.ONVIFDevice.profiles

Definition at line 141 of file device.py.

---

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

• core/homeassistant/components/onvif/device.py