Config flow for ONVIF (#34520)
This commit is contained in:
1 parent
e7157f2164
commit
850b5cb02b
14 files changed
+1292
-263
No files matched your search
@@ -1,7 +1,6 @@
|
||||
"""Support for ONVIF Cameras with FFmpeg as decoder."""
|
||||
import asyncio
|
||||
import datetime as dt
|
||||
import logging
|
||||
import os
|
||||
from typing import Optional
|
||||
|
||||
@@ -16,10 +15,9 @@ import voluptuous as vol
|
||||
from zeep.asyncio import AsyncTransport
|
||||
from zeep.exceptions import Fault
|
||||
|
||||
from homeassistant.components.camera import PLATFORM_SCHEMA, SUPPORT_STREAM, Camera
|
||||
from homeassistant.components.camera import SUPPORT_STREAM, Camera
|
||||
from homeassistant.components.ffmpeg import CONF_EXTRA_ARGUMENTS, DATA_FFMPEG
|
||||
from homeassistant.const import (
|
||||
ATTR_ENTITY_ID,
|
||||
CONF_HOST,
|
||||
CONF_NAME,
|
||||
CONF_PASSWORD,
|
||||
@@ -27,131 +25,85 @@ from homeassistant.const import (
|
||||
CONF_USERNAME,
|
||||
)
|
||||
from homeassistant.exceptions import PlatformNotReady
|
||||
from homeassistant.helpers import config_validation as cv, entity_platform
|
||||
from homeassistant.helpers.aiohttp_client import (
|
||||
async_aiohttp_proxy_stream,
|
||||
async_get_clientsession,
|
||||
)
|
||||
import homeassistant.helpers.config_validation as cv
|
||||
from homeassistant.helpers.service import async_extract_entity_ids
|
||||
import homeassistant.util.dt as dt_util
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
DEFAULT_NAME = "ONVIF Camera"
|
||||
DEFAULT_PORT = 5000
|
||||
DEFAULT_USERNAME = "admin"
|
||||
DEFAULT_PASSWORD = "888888"
|
||||
DEFAULT_ARGUMENTS = "-pred 1"
|
||||
DEFAULT_PROFILE = 0
|
||||
|
||||
CONF_PROFILE = "profile"
|
||||
CONF_RTSP_TRANSPORT = "rtsp_transport"
|
||||
|
||||
ATTR_PAN = "pan"
|
||||
ATTR_TILT = "tilt"
|
||||
ATTR_ZOOM = "zoom"
|
||||
ATTR_DISTANCE = "distance"
|
||||
ATTR_SPEED = "speed"
|
||||
ATTR_MOVE_MODE = "move_mode"
|
||||
ATTR_CONTINUOUS_DURATION = "continuous_duration"
|
||||
ATTR_PRESET = "preset"
|
||||
|
||||
DIR_UP = "UP"
|
||||
DIR_DOWN = "DOWN"
|
||||
DIR_LEFT = "LEFT"
|
||||
DIR_RIGHT = "RIGHT"
|
||||
ZOOM_OUT = "ZOOM_OUT"
|
||||
ZOOM_IN = "ZOOM_IN"
|
||||
PAN_FACTOR = {DIR_RIGHT: 1, DIR_LEFT: -1}
|
||||
TILT_FACTOR = {DIR_UP: 1, DIR_DOWN: -1}
|
||||
ZOOM_FACTOR = {ZOOM_IN: 1, ZOOM_OUT: -1}
|
||||
CONTINUOUS_MOVE = "ContinuousMove"
|
||||
RELATIVE_MOVE = "RelativeMove"
|
||||
ABSOLUTE_MOVE = "AbsoluteMove"
|
||||
GOTOPRESET_MOVE = "GotoPreset"
|
||||
|
||||
SERVICE_PTZ = "ptz"
|
||||
|
||||
DOMAIN = "onvif"
|
||||
ONVIF_DATA = "onvif"
|
||||
ENTITIES = "entities"
|
||||
|
||||
RTSP_TRANS_PROTOCOLS = ["tcp", "udp", "udp_multicast", "http"]
|
||||
|
||||
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
|
||||
{
|
||||
vol.Required(CONF_HOST): cv.string,
|
||||
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
||||
vol.Optional(CONF_PASSWORD, default=DEFAULT_PASSWORD): cv.string,
|
||||
vol.Optional(CONF_USERNAME, default=DEFAULT_USERNAME): cv.string,
|
||||
vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port,
|
||||
vol.Optional(CONF_EXTRA_ARGUMENTS, default=DEFAULT_ARGUMENTS): cv.string,
|
||||
vol.Optional(CONF_RTSP_TRANSPORT, default=RTSP_TRANS_PROTOCOLS[0]): vol.In(
|
||||
RTSP_TRANS_PROTOCOLS
|
||||
),
|
||||
vol.Optional(CONF_PROFILE, default=DEFAULT_PROFILE): vol.All(
|
||||
vol.Coerce(int), vol.Range(min=0)
|
||||
),
|
||||
}
|
||||
)
|
||||
|
||||
SERVICE_PTZ_SCHEMA = vol.Schema(
|
||||
{
|
||||
ATTR_ENTITY_ID: cv.entity_ids,
|
||||
vol.Optional(ATTR_PAN): vol.In([DIR_LEFT, DIR_RIGHT]),
|
||||
vol.Optional(ATTR_TILT): vol.In([DIR_UP, DIR_DOWN]),
|
||||
vol.Optional(ATTR_ZOOM): vol.In([ZOOM_OUT, ZOOM_IN]),
|
||||
ATTR_MOVE_MODE: vol.In(
|
||||
[CONTINUOUS_MOVE, RELATIVE_MOVE, ABSOLUTE_MOVE, GOTOPRESET_MOVE]
|
||||
),
|
||||
vol.Optional(ATTR_CONTINUOUS_DURATION, default=0.5): cv.small_float,
|
||||
vol.Optional(ATTR_DISTANCE, default=0.1): cv.small_float,
|
||||
vol.Optional(ATTR_SPEED, default=0.5): cv.small_float,
|
||||
vol.Optional(ATTR_PRESET, default="0"): cv.string,
|
||||
}
|
||||
from .const import (
|
||||
ABSOLUTE_MOVE,
|
||||
ATTR_CONTINUOUS_DURATION,
|
||||
ATTR_DISTANCE,
|
||||
ATTR_MOVE_MODE,
|
||||
ATTR_PAN,
|
||||
ATTR_PRESET,
|
||||
ATTR_SPEED,
|
||||
ATTR_TILT,
|
||||
ATTR_ZOOM,
|
||||
CONF_PROFILE,
|
||||
CONF_RTSP_TRANSPORT,
|
||||
CONTINUOUS_MOVE,
|
||||
DIR_DOWN,
|
||||
DIR_LEFT,
|
||||
DIR_RIGHT,
|
||||
DIR_UP,
|
||||
DOMAIN,
|
||||
ENTITIES,
|
||||
GOTOPRESET_MOVE,
|
||||
LOGGER,
|
||||
PAN_FACTOR,
|
||||
RELATIVE_MOVE,
|
||||
SERVICE_PTZ,
|
||||
TILT_FACTOR,
|
||||
ZOOM_FACTOR,
|
||||
ZOOM_IN,
|
||||
ZOOM_OUT,
|
||||
)
|
||||
|
||||
|
||||
async def async_setup_platform(hass, config, async_add_entities, discovery_info=None):
|
||||
"""Set up a ONVIF camera."""
|
||||
_LOGGER.debug("Setting up the ONVIF camera platform")
|
||||
async def async_setup_entry(hass, config_entry, async_add_entities):
|
||||
"""Set up the ONVIF camera video stream."""
|
||||
platform = entity_platform.current_platform.get()
|
||||
|
||||
async def async_handle_ptz(service):
|
||||
"""Handle PTZ service call."""
|
||||
pan = service.data.get(ATTR_PAN)
|
||||
tilt = service.data.get(ATTR_TILT)
|
||||
zoom = service.data.get(ATTR_ZOOM)
|
||||
distance = service.data[ATTR_DISTANCE]
|
||||
speed = service.data[ATTR_SPEED]
|
||||
move_mode = service.data.get(ATTR_MOVE_MODE)
|
||||
continuous_duration = service.data[ATTR_CONTINUOUS_DURATION]
|
||||
preset = service.data[ATTR_PRESET]
|
||||
all_cameras = hass.data[ONVIF_DATA][ENTITIES]
|
||||
entity_ids = await async_extract_entity_ids(hass, service)
|
||||
target_cameras = []
|
||||
if not entity_ids:
|
||||
target_cameras = all_cameras
|
||||
else:
|
||||
target_cameras = [
|
||||
camera for camera in all_cameras if camera.entity_id in entity_ids
|
||||
]
|
||||
for camera in target_cameras:
|
||||
await camera.async_perform_ptz(
|
||||
pan, tilt, zoom, distance, speed, move_mode, continuous_duration, preset
|
||||
)
|
||||
|
||||
hass.services.async_register(
|
||||
DOMAIN, SERVICE_PTZ, async_handle_ptz, schema=SERVICE_PTZ_SCHEMA
|
||||
# Create PTZ service
|
||||
platform.async_register_entity_service(
|
||||
SERVICE_PTZ,
|
||||
{
|
||||
vol.Optional(ATTR_PAN): vol.In([DIR_LEFT, DIR_RIGHT]),
|
||||
vol.Optional(ATTR_TILT): vol.In([DIR_UP, DIR_DOWN]),
|
||||
vol.Optional(ATTR_ZOOM): vol.In([ZOOM_OUT, ZOOM_IN]),
|
||||
vol.Optional(ATTR_DISTANCE, default=0.1): cv.small_float,
|
||||
vol.Optional(ATTR_SPEED, default=0.5): cv.small_float,
|
||||
vol.Optional(ATTR_MOVE_MODE, default=RELATIVE_MOVE): vol.In(
|
||||
[CONTINUOUS_MOVE, RELATIVE_MOVE, ABSOLUTE_MOVE, GOTOPRESET_MOVE]
|
||||
),
|
||||
vol.Optional(ATTR_CONTINUOUS_DURATION, default=0.5): cv.small_float,
|
||||
vol.Optional(ATTR_PRESET, default="0"): cv.string,
|
||||
},
|
||||
"async_perform_ptz",
|
||||
)
|
||||
|
||||
_LOGGER.debug("Constructing the ONVIFHassCamera")
|
||||
base_config = {
|
||||
CONF_NAME: config_entry.data[CONF_NAME],
|
||||
CONF_HOST: config_entry.data[CONF_HOST],
|
||||
CONF_PORT: config_entry.data[CONF_PORT],
|
||||
CONF_USERNAME: config_entry.data[CONF_USERNAME],
|
||||
CONF_PASSWORD: config_entry.data[CONF_PASSWORD],
|
||||
CONF_EXTRA_ARGUMENTS: config_entry.options[CONF_EXTRA_ARGUMENTS],
|
||||
CONF_RTSP_TRANSPORT: config_entry.options[CONF_RTSP_TRANSPORT],
|
||||
}
|
||||
|
||||
hass_camera = ONVIFHassCamera(hass, config)
|
||||
entities = []
|
||||
for profile in config_entry.data[CONF_PROFILE]:
|
||||
config = {**base_config, CONF_PROFILE: profile}
|
||||
camera = ONVIFHassCamera(hass, config)
|
||||
await camera.async_initialize()
|
||||
entities.append(camera)
|
||||
|
||||
await hass_camera.async_initialize()
|
||||
|
||||
async_add_entities([hass_camera])
|
||||
return
|
||||
async_add_entities(entities)
|
||||
return True
|
||||
|
||||
|
||||
class ONVIFHassCamera(Camera):
|
||||
@@ -161,9 +113,9 @@ class ONVIFHassCamera(Camera):
|
||||
"""Initialize an ONVIF camera."""
|
||||
super().__init__()
|
||||
|
||||
_LOGGER.debug("Importing dependencies")
|
||||
LOGGER.debug("Importing dependencies")
|
||||
|
||||
_LOGGER.debug("Setting up the ONVIF camera component")
|
||||
LOGGER.debug("Setting up the ONVIF camera component")
|
||||
|
||||
self._username = config.get(CONF_USERNAME)
|
||||
self._password = config.get(CONF_PASSWORD)
|
||||
@@ -172,13 +124,18 @@ class ONVIFHassCamera(Camera):
|
||||
self._name = config.get(CONF_NAME)
|
||||
self._ffmpeg_arguments = config.get(CONF_EXTRA_ARGUMENTS)
|
||||
self._profile_index = config.get(CONF_PROFILE)
|
||||
self._profile_token = None
|
||||
self._profile_name = None
|
||||
self._ptz_service = None
|
||||
self._input = None
|
||||
self._snapshot = None
|
||||
self.stream_options[CONF_RTSP_TRANSPORT] = config.get(CONF_RTSP_TRANSPORT)
|
||||
self._manufacturer = None
|
||||
self._model = None
|
||||
self._firmware_version = None
|
||||
self._mac = None
|
||||
|
||||
_LOGGER.debug(
|
||||
LOGGER.debug(
|
||||
"Setting up the ONVIF camera device @ '%s:%s'", self._host, self._port
|
||||
)
|
||||
|
||||
@@ -201,29 +158,39 @@ class ONVIFHassCamera(Camera):
|
||||
the camera. Also retrieves the ONVIF profiles.
|
||||
"""
|
||||
try:
|
||||
_LOGGER.debug("Updating service addresses")
|
||||
LOGGER.debug("Updating service addresses")
|
||||
await self._camera.update_xaddrs()
|
||||
|
||||
await self.async_obtain_device_info()
|
||||
await self.async_obtain_mac_address()
|
||||
await self.async_check_date_and_time()
|
||||
await self.async_obtain_profile_token()
|
||||
await self.async_obtain_input_uri()
|
||||
await self.async_obtain_snapshot_uri()
|
||||
self.setup_ptz()
|
||||
except ClientConnectionError as err:
|
||||
_LOGGER.warning(
|
||||
LOGGER.warning(
|
||||
"Couldn't connect to camera '%s', but will retry later. Error: %s",
|
||||
self._name,
|
||||
err,
|
||||
)
|
||||
raise PlatformNotReady
|
||||
except Fault as err:
|
||||
_LOGGER.error(
|
||||
LOGGER.error(
|
||||
"Couldn't connect to camera '%s', please verify "
|
||||
"that the credentials are correct. Error: %s",
|
||||
self._name,
|
||||
err,
|
||||
)
|
||||
|
||||
async def async_obtain_device_info(self):
|
||||
"""Obtain the MAC address of the camera to use as the unique ID."""
|
||||
devicemgmt = self._camera.create_devicemgmt_service()
|
||||
device_info = await devicemgmt.GetDeviceInformation()
|
||||
self._manufacturer = device_info.Manufacturer
|
||||
self._model = device_info.Model
|
||||
self._firmware_version = device_info.FirmwareVersion
|
||||
|
||||
async def async_obtain_mac_address(self):
|
||||
"""Obtain the MAC address of the camera to use as the unique ID."""
|
||||
devicemgmt = self._camera.create_devicemgmt_service()
|
||||
@@ -234,15 +201,15 @@ class ONVIFHassCamera(Camera):
|
||||
|
||||
async def async_check_date_and_time(self):
|
||||
"""Warns if camera and system date not synced."""
|
||||
_LOGGER.debug("Setting up the ONVIF device management service")
|
||||
LOGGER.debug("Setting up the ONVIF device management service")
|
||||
devicemgmt = self._camera.create_devicemgmt_service()
|
||||
|
||||
_LOGGER.debug("Retrieving current camera date/time")
|
||||
LOGGER.debug("Retrieving current camera date/time")
|
||||
try:
|
||||
system_date = dt_util.utcnow()
|
||||
device_time = await devicemgmt.GetSystemDateAndTime()
|
||||
if not device_time:
|
||||
_LOGGER.debug(
|
||||
LOGGER.debug(
|
||||
"""Couldn't get camera '%s' date/time.
|
||||
GetSystemDateAndTime() return null/empty""",
|
||||
self._name,
|
||||
@@ -260,7 +227,7 @@ class ONVIFHassCamera(Camera):
|
||||
cdate = device_time.LocalDateTime
|
||||
|
||||
if cdate is None:
|
||||
_LOGGER.warning("Could not retrieve date/time on this camera")
|
||||
LOGGER.warning("Could not retrieve date/time on this camera")
|
||||
else:
|
||||
cam_date = dt.datetime(
|
||||
cdate.Date.Year,
|
||||
@@ -275,19 +242,19 @@ class ONVIFHassCamera(Camera):
|
||||
|
||||
cam_date_utc = cam_date.astimezone(dt_util.UTC)
|
||||
|
||||
_LOGGER.debug("TimeZone for date/time: %s", tzone)
|
||||
LOGGER.debug("TimeZone for date/time: %s", tzone)
|
||||
|
||||
_LOGGER.debug("Camera date/time: %s", cam_date)
|
||||
LOGGER.debug("Camera date/time: %s", cam_date)
|
||||
|
||||
_LOGGER.debug("Camera date/time in UTC: %s", cam_date_utc)
|
||||
LOGGER.debug("Camera date/time in UTC: %s", cam_date_utc)
|
||||
|
||||
_LOGGER.debug("System date/time: %s", system_date)
|
||||
LOGGER.debug("System date/time: %s", system_date)
|
||||
|
||||
dt_diff = cam_date - system_date
|
||||
dt_diff_seconds = dt_diff.total_seconds()
|
||||
|
||||
if dt_diff_seconds > 5:
|
||||
_LOGGER.warning(
|
||||
LOGGER.warning(
|
||||
"The date/time on the camera (UTC) is '%s', "
|
||||
"which is different from the system '%s', "
|
||||
"this could lead to authentication issues",
|
||||
@@ -295,7 +262,7 @@ class ONVIFHassCamera(Camera):
|
||||
system_date,
|
||||
)
|
||||
except ServerDisconnectedError as err:
|
||||
_LOGGER.warning(
|
||||
LOGGER.warning(
|
||||
"Couldn't get camera '%s' date/time. Error: %s", self._name, err
|
||||
)
|
||||
|
||||
@@ -306,10 +273,10 @@ class ONVIFHassCamera(Camera):
|
||||
|
||||
profiles = await media_service.GetProfiles()
|
||||
|
||||
_LOGGER.debug("Retrieved '%d' profiles", len(profiles))
|
||||
LOGGER.debug("Retrieved '%d' profiles", len(profiles))
|
||||
|
||||
if self._profile_index >= len(profiles):
|
||||
_LOGGER.warning(
|
||||
LOGGER.warning(
|
||||
"ONVIF Camera '%s' doesn't provide profile %d."
|
||||
" Using the last profile.",
|
||||
self._name,
|
||||
@@ -317,51 +284,32 @@ class ONVIFHassCamera(Camera):
|
||||
)
|
||||
self._profile_index = -1
|
||||
|
||||
_LOGGER.debug("Using profile index '%d'", self._profile_index)
|
||||
LOGGER.debug("Using profile index '%d'", self._profile_index)
|
||||
|
||||
return profiles[self._profile_index].token
|
||||
self._profile_token = profiles[self._profile_index].token
|
||||
self._profile_name = profiles[self._profile_index].Name
|
||||
except exceptions.ONVIFError as err:
|
||||
_LOGGER.error(
|
||||
LOGGER.error(
|
||||
"Couldn't retrieve profile token of camera '%s'. Error: %s",
|
||||
self._name,
|
||||
err,
|
||||
)
|
||||
return None
|
||||
|
||||
async def async_obtain_input_uri(self):
|
||||
"""Set the input uri for the camera."""
|
||||
_LOGGER.debug(
|
||||
LOGGER.debug(
|
||||
"Connecting with ONVIF Camera: %s on port %s", self._host, self._port
|
||||
)
|
||||
|
||||
try:
|
||||
_LOGGER.debug("Retrieving profiles")
|
||||
|
||||
media_service = self._camera.create_media_service()
|
||||
|
||||
profiles = await media_service.GetProfiles()
|
||||
|
||||
_LOGGER.debug("Retrieved '%d' profiles", len(profiles))
|
||||
|
||||
if self._profile_index >= len(profiles):
|
||||
_LOGGER.warning(
|
||||
"ONVIF Camera '%s' doesn't provide profile %d."
|
||||
" Using the last profile.",
|
||||
self._name,
|
||||
self._profile_index,
|
||||
)
|
||||
self._profile_index = -1
|
||||
|
||||
_LOGGER.debug("Using profile index '%d'", self._profile_index)
|
||||
|
||||
_LOGGER.debug("Retrieving stream uri")
|
||||
LOGGER.debug("Retrieving stream uri")
|
||||
|
||||
# Fix Onvif setup error on Goke GK7102 based IP camera
|
||||
# where we need to recreate media_service #26781
|
||||
media_service = self._camera.create_media_service()
|
||||
|
||||
req = media_service.create_type("GetStreamUri")
|
||||
req.ProfileToken = profiles[self._profile_index].token
|
||||
req.ProfileToken = self._profile_token
|
||||
req.StreamSetup = {
|
||||
"Stream": "RTP-Unicast",
|
||||
"Transport": {"Protocol": "RTSP"},
|
||||
@@ -374,155 +322,143 @@ class ONVIFHassCamera(Camera):
|
||||
"rtsp://", f"rtsp://{self._username}:{self._password}@", 1
|
||||
)
|
||||
|
||||
_LOGGER.debug(
|
||||
LOGGER.debug(
|
||||
"ONVIF Camera Using the following URL for %s: %s",
|
||||
self._name,
|
||||
uri_for_log,
|
||||
)
|
||||
except exceptions.ONVIFError as err:
|
||||
_LOGGER.error("Couldn't setup camera '%s'. Error: %s", self._name, err)
|
||||
LOGGER.error("Couldn't setup camera '%s'. Error: %s", self._name, err)
|
||||
|
||||
async def async_obtain_snapshot_uri(self):
|
||||
"""Set the snapshot uri for the camera."""
|
||||
_LOGGER.debug(
|
||||
LOGGER.debug(
|
||||
"Connecting with ONVIF Camera: %s on port %s", self._host, self._port
|
||||
)
|
||||
|
||||
try:
|
||||
_LOGGER.debug("Retrieving profiles")
|
||||
|
||||
media_service = self._camera.create_media_service()
|
||||
|
||||
profiles = await media_service.GetProfiles()
|
||||
|
||||
_LOGGER.debug("Retrieved '%d' profiles", len(profiles))
|
||||
|
||||
if self._profile_index >= len(profiles):
|
||||
_LOGGER.warning(
|
||||
"ONVIF Camera '%s' doesn't provide profile %d."
|
||||
" Using the last profile.",
|
||||
self._name,
|
||||
self._profile_index,
|
||||
)
|
||||
self._profile_index = -1
|
||||
|
||||
_LOGGER.debug("Using profile index '%d'", self._profile_index)
|
||||
|
||||
_LOGGER.debug("Retrieving snapshot uri")
|
||||
LOGGER.debug("Retrieving snapshot uri")
|
||||
|
||||
# Fix Onvif setup error on Goke GK7102 based IP camera
|
||||
# where we need to recreate media_service #26781
|
||||
media_service = self._camera.create_media_service()
|
||||
|
||||
req = media_service.create_type("GetSnapshotUri")
|
||||
req.ProfileToken = profiles[self._profile_index].token
|
||||
req.ProfileToken = self._profile_token
|
||||
|
||||
try:
|
||||
snapshot_uri = await media_service.GetSnapshotUri(req)
|
||||
self._snapshot = snapshot_uri.Uri
|
||||
except ServerDisconnectedError as err:
|
||||
_LOGGER.debug("Camera does not support GetSnapshotUri: %s", err)
|
||||
LOGGER.debug("Camera does not support GetSnapshotUri: %s", err)
|
||||
|
||||
_LOGGER.debug(
|
||||
LOGGER.debug(
|
||||
"ONVIF Camera Using the following URL for %s snapshot: %s",
|
||||
self._name,
|
||||
self._snapshot,
|
||||
)
|
||||
except exceptions.ONVIFError as err:
|
||||
_LOGGER.error("Couldn't setup camera '%s'. Error: %s", self._name, err)
|
||||
LOGGER.error("Couldn't setup camera '%s'. Error: %s", self._name, err)
|
||||
|
||||
def setup_ptz(self):
|
||||
"""Set up PTZ if available."""
|
||||
_LOGGER.debug("Setting up the ONVIF PTZ service")
|
||||
LOGGER.debug("Setting up the ONVIF PTZ service")
|
||||
if self._camera.get_service("ptz", create=False) is None:
|
||||
_LOGGER.debug("PTZ is not available")
|
||||
LOGGER.debug("PTZ is not available")
|
||||
else:
|
||||
self._ptz_service = self._camera.create_ptz_service()
|
||||
_LOGGER.debug("Completed set up of the ONVIF camera component")
|
||||
LOGGER.debug("Completed set up of the ONVIF camera component")
|
||||
|
||||
async def async_perform_ptz(
|
||||
self, pan, tilt, zoom, distance, speed, move_mode, continuous_duration, preset
|
||||
self,
|
||||
distance,
|
||||
speed,
|
||||
move_mode,
|
||||
continuous_duration,
|
||||
preset,
|
||||
pan=None,
|
||||
tilt=None,
|
||||
zoom=None,
|
||||
):
|
||||
"""Perform a PTZ action on the camera."""
|
||||
if self._ptz_service is None:
|
||||
_LOGGER.warning("PTZ actions are not supported on camera '%s'", self._name)
|
||||
LOGGER.warning("PTZ actions are not supported on camera '%s'", self._name)
|
||||
return
|
||||
|
||||
if self._ptz_service:
|
||||
pan_val = distance * PAN_FACTOR.get(pan, 0)
|
||||
tilt_val = distance * TILT_FACTOR.get(tilt, 0)
|
||||
zoom_val = distance * ZOOM_FACTOR.get(zoom, 0)
|
||||
speed_val = speed
|
||||
preset_val = preset
|
||||
_LOGGER.debug(
|
||||
"Calling %s PTZ | Pan = %4.2f | Tilt = %4.2f | Zoom = %4.2f | Speed = %4.2f | Preset = %s",
|
||||
move_mode,
|
||||
pan_val,
|
||||
tilt_val,
|
||||
zoom_val,
|
||||
speed_val,
|
||||
preset_val,
|
||||
)
|
||||
try:
|
||||
req = self._ptz_service.create_type(move_mode)
|
||||
req.ProfileToken = await self.async_obtain_profile_token()
|
||||
if move_mode == CONTINUOUS_MOVE:
|
||||
req.Velocity = {
|
||||
"PanTilt": {"x": pan_val, "y": tilt_val},
|
||||
"Zoom": {"x": zoom_val},
|
||||
}
|
||||
pan_val = distance * PAN_FACTOR.get(pan, 0)
|
||||
tilt_val = distance * TILT_FACTOR.get(tilt, 0)
|
||||
zoom_val = distance * ZOOM_FACTOR.get(zoom, 0)
|
||||
speed_val = speed
|
||||
preset_val = preset
|
||||
LOGGER.debug(
|
||||
"Calling %s PTZ | Pan = %4.2f | Tilt = %4.2f | Zoom = %4.2f | Speed = %4.2f | Preset = %s",
|
||||
move_mode,
|
||||
pan_val,
|
||||
tilt_val,
|
||||
zoom_val,
|
||||
speed_val,
|
||||
preset_val,
|
||||
)
|
||||
try:
|
||||
req = self._ptz_service.create_type(move_mode)
|
||||
req.ProfileToken = self._profile_token
|
||||
if move_mode == CONTINUOUS_MOVE:
|
||||
req.Velocity = {
|
||||
"PanTilt": {"x": pan_val, "y": tilt_val},
|
||||
"Zoom": {"x": zoom_val},
|
||||
}
|
||||
|
||||
await self._ptz_service.ContinuousMove(req)
|
||||
await asyncio.sleep(continuous_duration)
|
||||
req = self._ptz_service.create_type("Stop")
|
||||
req.ProfileToken = await self.async_obtain_profile_token()
|
||||
await self._ptz_service.Stop({"ProfileToken": req.ProfileToken})
|
||||
elif move_mode == RELATIVE_MOVE:
|
||||
req.Translation = {
|
||||
"PanTilt": {"x": pan_val, "y": tilt_val},
|
||||
"Zoom": {"x": zoom_val},
|
||||
}
|
||||
req.Speed = {
|
||||
"PanTilt": {"x": speed_val, "y": speed_val},
|
||||
"Zoom": {"x": speed_val},
|
||||
}
|
||||
await self._ptz_service.RelativeMove(req)
|
||||
elif move_mode == ABSOLUTE_MOVE:
|
||||
req.Position = {
|
||||
"PanTilt": {"x": pan_val, "y": tilt_val},
|
||||
"Zoom": {"x": zoom_val},
|
||||
}
|
||||
req.Speed = {
|
||||
"PanTilt": {"x": speed_val, "y": speed_val},
|
||||
"Zoom": {"x": speed_val},
|
||||
}
|
||||
await self._ptz_service.AbsoluteMove(req)
|
||||
elif move_mode == GOTOPRESET_MOVE:
|
||||
req.PresetToken = preset_val
|
||||
req.Speed = {
|
||||
"PanTilt": {"x": speed_val, "y": speed_val},
|
||||
"Zoom": {"x": speed_val},
|
||||
}
|
||||
await self._ptz_service.GotoPreset(req)
|
||||
except exceptions.ONVIFError as err:
|
||||
if "Bad Request" in err.reason:
|
||||
self._ptz_service = None
|
||||
_LOGGER.debug("Camera '%s' doesn't support PTZ.", self._name)
|
||||
else:
|
||||
_LOGGER.debug("Camera '%s' doesn't support PTZ.", self._name)
|
||||
await self._ptz_service.ContinuousMove(req)
|
||||
await asyncio.sleep(continuous_duration)
|
||||
req = self._ptz_service.create_type("Stop")
|
||||
req.ProfileToken = self._profile_token
|
||||
await self._ptz_service.Stop({"ProfileToken": req.ProfileToken})
|
||||
elif move_mode == RELATIVE_MOVE:
|
||||
req.Translation = {
|
||||
"PanTilt": {"x": pan_val, "y": tilt_val},
|
||||
"Zoom": {"x": zoom_val},
|
||||
}
|
||||
req.Speed = {
|
||||
"PanTilt": {"x": speed_val, "y": speed_val},
|
||||
"Zoom": {"x": speed_val},
|
||||
}
|
||||
await self._ptz_service.RelativeMove(req)
|
||||
elif move_mode == ABSOLUTE_MOVE:
|
||||
req.Position = {
|
||||
"PanTilt": {"x": pan_val, "y": tilt_val},
|
||||
"Zoom": {"x": zoom_val},
|
||||
}
|
||||
req.Speed = {
|
||||
"PanTilt": {"x": speed_val, "y": speed_val},
|
||||
"Zoom": {"x": speed_val},
|
||||
}
|
||||
await self._ptz_service.AbsoluteMove(req)
|
||||
elif move_mode == GOTOPRESET_MOVE:
|
||||
req.PresetToken = preset_val
|
||||
req.Speed = {
|
||||
"PanTilt": {"x": speed_val, "y": speed_val},
|
||||
"Zoom": {"x": speed_val},
|
||||
}
|
||||
await self._ptz_service.GotoPreset(req)
|
||||
except exceptions.ONVIFError as err:
|
||||
if "Bad Request" in err.reason:
|
||||
self._ptz_service = None
|
||||
LOGGER.debug("Camera '%s' doesn't support PTZ.", self._name)
|
||||
else:
|
||||
LOGGER.error("Error trying to perform PTZ action: %s", err)
|
||||
|
||||
async def async_added_to_hass(self):
|
||||
"""Handle entity addition to hass."""
|
||||
_LOGGER.debug("Camera '%s' added to hass", self._name)
|
||||
LOGGER.debug("Camera '%s' added to hass", self._name)
|
||||
|
||||
if ONVIF_DATA not in self.hass.data:
|
||||
self.hass.data[ONVIF_DATA] = {}
|
||||
self.hass.data[ONVIF_DATA][ENTITIES] = []
|
||||
self.hass.data[ONVIF_DATA][ENTITIES].append(self)
|
||||
if DOMAIN not in self.hass.data:
|
||||
self.hass.data[DOMAIN] = {}
|
||||
self.hass.data[DOMAIN][ENTITIES] = []
|
||||
self.hass.data[DOMAIN][ENTITIES].append(self)
|
||||
|
||||
async def async_camera_image(self):
|
||||
"""Return a still image response from the camera."""
|
||||
_LOGGER.debug("Retrieving image from camera '%s'", self._name)
|
||||
LOGGER.debug("Retrieving image from camera '%s'", self._name)
|
||||
image = None
|
||||
|
||||
if self._snapshot is not None:
|
||||
@@ -537,7 +473,7 @@ class ONVIFHassCamera(Camera):
|
||||
if response.status_code < 300:
|
||||
return response.content
|
||||
except requests.exceptions.RequestException as error:
|
||||
_LOGGER.error(
|
||||
LOGGER.error(
|
||||
"Fetch snapshot image failed from %s, falling back to FFmpeg; %s",
|
||||
self._name,
|
||||
error,
|
||||
@@ -564,7 +500,7 @@ class ONVIFHassCamera(Camera):
|
||||
|
||||
async def handle_async_mjpeg_stream(self, request):
|
||||
"""Generate an HTTP MJPEG stream from the camera."""
|
||||
_LOGGER.debug("Handling mjpeg stream from camera '%s'", self._name)
|
||||
LOGGER.debug("Handling mjpeg stream from camera '%s'", self._name)
|
||||
|
||||
ffmpeg_manager = self.hass.data[DATA_FFMPEG]
|
||||
stream = CameraMjpeg(ffmpeg_manager.binary, loop=self.hass.loop)
|
||||
@@ -596,7 +532,7 @@ class ONVIFHassCamera(Camera):
|
||||
@property
|
||||
def name(self):
|
||||
"""Return the name of this camera."""
|
||||
return self._name
|
||||
return f"{self._name} - {self._profile_name}"
|
||||
|
||||
@property
|
||||
def unique_id(self) -> Optional[str]:
|
||||
@@ -604,3 +540,14 @@ class ONVIFHassCamera(Camera):
|
||||
if self._profile_index:
|
||||
return f"{self._mac}_{self._profile_index}"
|
||||
return self._mac
|
||||
|
||||
@property
|
||||
def device_info(self):
|
||||
"""Return a device description for device registry."""
|
||||
return {
|
||||
"identifiers": {(DOMAIN, self._mac)},
|
||||
"name": self._name,
|
||||
"manufacturer": self._manufacturer,
|
||||
"model": self._model,
|
||||
"sw_version": self._firmware_version,
|
||||
}
|
||||
Reference in new issue
Block a user