From b871d5f9b57dd6ad1a439dfd7cbbf63d12a43b6c Mon Sep 17 00:00:00 2001 From: Raman Gupta <7243222+raman325@users.noreply.github.com> Date: Tue, 26 Nov 2019 08:40:05 -0500 Subject: [PATCH 1/3] move constants to const.py, update custom service name, move custom service to onvif domain --- homeassistant/components/camera/services.yaml | 16 ------ homeassistant/components/onvif/camera.py | 50 +++++++++---------- homeassistant/components/onvif/const.py | 28 +++++++++++ homeassistant/components/onvif/services.yaml | 2 +- 4 files changed, 52 insertions(+), 44 deletions(-) create mode 100644 homeassistant/components/onvif/const.py diff --git a/homeassistant/components/camera/services.yaml b/homeassistant/components/camera/services.yaml index 4c2d89db86d2dd..d876a75b0a8840 100644 --- a/homeassistant/components/camera/services.yaml +++ b/homeassistant/components/camera/services.yaml @@ -77,19 +77,3 @@ local_file_update_file_path: file_path: description: Path to the new image file. example: '/images/newimage.jpg' - -onvif_ptz: - description: Pan/Tilt/Zoom service for ONVIF camera. - fields: - entity_id: - description: Name(s) of entities to pan, tilt or zoom. - example: 'camera.living_room_camera' - pan: - description: "Direction of pan. Allowed values: LEFT, RIGHT." - example: 'LEFT' - tilt: - description: "Direction of tilt. Allowed values: DOWN, UP." - example: 'DOWN' - zoom: - description: "Zoom. Allowed values: ZOOM_IN, ZOOM_OUT" - example: "ZOOM_IN" diff --git a/homeassistant/components/onvif/camera.py b/homeassistant/components/onvif/camera.py index 3f244530dca679..29d4652a4ade4a 100644 --- a/homeassistant/components/onvif/camera.py +++ b/homeassistant/components/onvif/camera.py @@ -18,7 +18,6 @@ from zeep.exceptions import Fault from homeassistant.components.camera import PLATFORM_SCHEMA, SUPPORT_STREAM, Camera -from homeassistant.components.camera.const import DOMAIN from homeassistant.components.ffmpeg import CONF_EXTRA_ARGUMENTS, DATA_FFMPEG from homeassistant.const import ( ATTR_ENTITY_ID, @@ -33,35 +32,32 @@ import homeassistant.helpers.config_validation as cv from homeassistant.helpers.service import async_extract_entity_ids import homeassistant.util.dt as dt_util +from .const import ( + ATTR_PAN, + ATTR_TILT, + ATTR_ZOOM, + CONF_PROFILE, + DEFAULT_ARGUMENTS, + DEFAULT_NAME, + DEFAULT_PASSWORD, + DEFAULT_PORT, + DEFAULT_PROFILE, + DEFAULT_USERNAME, + DIR_DOWN, + DIR_LEFT, + DIR_RIGHT, + DIR_UP, + DOMAIN, + ENTITIES, + ONVIF_DATA, + PTZ_NONE, + SERVICE_PTZ, + ZOOM_IN, + ZOOM_OUT, +) _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" - -ATTR_PAN = "pan" -ATTR_TILT = "tilt" -ATTR_ZOOM = "zoom" - -DIR_UP = "UP" -DIR_DOWN = "DOWN" -DIR_LEFT = "LEFT" -DIR_RIGHT = "RIGHT" -ZOOM_OUT = "ZOOM_OUT" -ZOOM_IN = "ZOOM_IN" -PTZ_NONE = "NONE" - -SERVICE_PTZ = "onvif_ptz" - -ONVIF_DATA = "onvif" -ENTITIES = "entities" - PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend( { vol.Required(CONF_HOST): cv.string, diff --git a/homeassistant/components/onvif/const.py b/homeassistant/components/onvif/const.py new file mode 100644 index 00000000000000..008be28582014e --- /dev/null +++ b/homeassistant/components/onvif/const.py @@ -0,0 +1,28 @@ +"""Constants for the Onvif Camera component.""" +DOMAIN = "onvif" + +DEFAULT_NAME = "ONVIF Camera" +DEFAULT_PORT = 5000 +DEFAULT_USERNAME = "admin" +DEFAULT_PASSWORD = "888888" +DEFAULT_ARGUMENTS = "-pred 1" +DEFAULT_PROFILE = 0 + +CONF_PROFILE = "profile" + +ATTR_PAN = "pan" +ATTR_TILT = "tilt" +ATTR_ZOOM = "zoom" + +DIR_UP = "UP" +DIR_DOWN = "DOWN" +DIR_LEFT = "LEFT" +DIR_RIGHT = "RIGHT" +ZOOM_OUT = "ZOOM_OUT" +ZOOM_IN = "ZOOM_IN" +PTZ_NONE = "NONE" + +SERVICE_PTZ = "ptz" + +ONVIF_DATA = "onvif" +ENTITIES = "entities" diff --git a/homeassistant/components/onvif/services.yaml b/homeassistant/components/onvif/services.yaml index 667538f056a7fb..d85ed0a6999dbb 100644 --- a/homeassistant/components/onvif/services.yaml +++ b/homeassistant/components/onvif/services.yaml @@ -1,4 +1,4 @@ -onvif_ptz: +ptz: description: If your ONVIF camera supports PTZ, you will be able to pan, tilt or zoom your camera. fields: entity_id: From b14fed6e176e08e6cba5df3bf5de5a2ba4cbd1b7 Mon Sep 17 00:00:00 2001 From: Raman Gupta <7243222+raman325@users.noreply.github.com> Date: Tue, 26 Nov 2019 08:42:16 -0500 Subject: [PATCH 2/3] add onvif/const.py to .coveragerc --- .coveragerc | 1 + 1 file changed, 1 insertion(+) diff --git a/.coveragerc b/.coveragerc index 20be7adbd9455f..0cc2193820d317 100644 --- a/.coveragerc +++ b/.coveragerc @@ -475,6 +475,7 @@ omit = homeassistant/components/onewire/sensor.py homeassistant/components/onkyo/media_player.py homeassistant/components/onvif/camera.py + homeassistant/components/onvif/const.py homeassistant/components/opencv/* homeassistant/components/openevse/sensor.py homeassistant/components/openexchangerates/sensor.py From b5914b7f48580acd78229af31c19259cf45c199c Mon Sep 17 00:00:00 2001 From: Raman Gupta <7243222+raman325@users.noreply.github.com> Date: Tue, 26 Nov 2019 09:23:22 -0500 Subject: [PATCH 3/3] update docstring formatting --- homeassistant/components/onvif/const.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/homeassistant/components/onvif/const.py b/homeassistant/components/onvif/const.py index 008be28582014e..23133c9423801c 100644 --- a/homeassistant/components/onvif/const.py +++ b/homeassistant/components/onvif/const.py @@ -1,4 +1,4 @@ -"""Constants for the Onvif Camera component.""" +"""Constants for the ONVIF Camera component.""" DOMAIN = "onvif" DEFAULT_NAME = "ONVIF Camera"