From 6998fb407e3c69ffc50069ff7b51b2a47c196d4f Mon Sep 17 00:00:00 2001 From: Nick Touran Date: Tue, 20 Dec 2022 11:56:44 -0800 Subject: [PATCH 1/5] Add docs for new ONVIF aux command. --- source/_integrations/onvif.markdown | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/source/_integrations/onvif.markdown b/source/_integrations/onvif.markdown index aa8b219f0f68..9b9d81e40af4 100644 --- a/source/_integrations/onvif.markdown +++ b/source/_integrations/onvif.markdown @@ -72,6 +72,8 @@ To help with development of this component, enable `info` level logging for `hom | Last Clock Synchronization | Sensor | Timestamp | When the device clock was last synchronized. | | Last Backup | Sensor | Timestamp | When the last backup of the device configuration has been retrieved. | +If you are running into trouble with this sensor, please refer to the [Troubleshooting section](/integrations/ffmpeg/#troubleshooting). + ### Service `onvif.ptz` If your ONVIF camera supports PTZ, you will be able to pan, tilt or zoom your camera. @@ -88,4 +90,11 @@ If your ONVIF camera supports PTZ, you will be able to pan, tilt or zoom your ca | `move_mode` | PTZ moving mode. Allowed values: `ContinuousMove`, `RelativeMove`, `AbsoluteMove`, `GotoPreset`, `Stop`. Default :`RelativeMove` | | `continuous_duration` | Set ContinuousMove delay in seconds before stopping the move. Allowed values: floating point numbers or integer. Default : 0.5 | -If you are running into trouble with this sensor, please refer to the [Troubleshooting section](/integrations/ffmpeg/#troubleshooting). +### Service `onvif.aux` + +If your ONVIF camera supports PTZ auxiliary commands (e.g. for running the wiper or turning on the heater), you will be able to run them with this service. + +| Service data attribute | Description | +| -----------------------| ----------- | +| `entity_id` | String or list of strings that point at `entity_id`s of cameras. Use `entity_id: all` to target all. | +| `cmd` | Command to send (e.g. `tt:Wiper|On`). Options depend on camera capability. | From cde92b71d0d55504d8bfe4023928811d7eceb95f Mon Sep 17 00:00:00 2001 From: Nick Touran Date: Sun, 1 Jan 2023 14:16:26 -0800 Subject: [PATCH 2/5] Add docs for new ONVIF ImagingSetting service. --- source/_integrations/onvif.markdown | 43 +++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/source/_integrations/onvif.markdown b/source/_integrations/onvif.markdown index 9b9d81e40af4..685da2947089 100644 --- a/source/_integrations/onvif.markdown +++ b/source/_integrations/onvif.markdown @@ -98,3 +98,46 @@ If your ONVIF camera supports PTZ auxiliary commands (e.g. for running the wiper | -----------------------| ----------- | | `entity_id` | String or list of strings that point at `entity_id`s of cameras. Use `entity_id: all` to target all. | | `cmd` | Command to send (e.g. `tt:Wiper|On`). Options depend on camera capability. | + +### Service `onvif.set_imaging_settings` + +Allos you to set various Imaging Settings as defined in [The ONVIF Imaging +Service Spec](https://www.onvif.org/specs/srv/img/ONVIF-Imaging-Service-Spec-v210.pdf). + +| Service data attribute | Description | +| -----------------------| ----------- | +| `entity_id` | String or list of strings that point at `entity_id`s of cameras. Use `entity_id: all` to target all. | +| `settings` | Command to send (e.g. `tt:Wiper|On`). Options depend on camera capability. | + +Valid setting keys depend on your camera capabilities, but may include: + +* `BacklightCompensation` +* `Brightness` +* `ColorSaturation` +* `Contrast` +* `Exposure` +* `Focus` +* `IrCutFilter` +* `Sharpness` +* `WideDynamicRange` +* `WhiteBalance` + +Some settings take simple values while others take data structures. For example, +to turn on auto-focus, you would run: + + service: onvif.set_imaging_settings + data: + settings: + Focus: + AutoFocusMode: AUTO + target: + entity_id: camera.skycam_media_profile1 + +To force the IR lamp to turn on, you would run: + + service: onvif.set_imaging_settings + data: + settings: + IrLampCutoff: OFF + target: + entity_id: camera.skycam_media_profile1 From c95e02dd66b2ebf6b0476fc397be38ef5096e28b Mon Sep 17 00:00:00 2001 From: Nick Touran Date: Wed, 25 Jan 2023 23:27:06 -0800 Subject: [PATCH 3/5] Fix example. --- source/_integrations/onvif.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/onvif.markdown b/source/_integrations/onvif.markdown index 685da2947089..49b793fad460 100644 --- a/source/_integrations/onvif.markdown +++ b/source/_integrations/onvif.markdown @@ -138,6 +138,6 @@ To force the IR lamp to turn on, you would run: service: onvif.set_imaging_settings data: settings: - IrLampCutoff: OFF + IrCutFilter: OFF target: entity_id: camera.skycam_media_profile1 From fe864752d994fdbce5429790fd09f38f843d484e Mon Sep 17 00:00:00 2001 From: Nick Touran Date: Fri, 27 Jan 2023 23:02:48 -0800 Subject: [PATCH 4/5] Remove service docs since they were removed. Add switch docs. --- source/_integrations/onvif.markdown | 56 ++++------------------------- 1 file changed, 7 insertions(+), 49 deletions(-) diff --git a/source/_integrations/onvif.markdown b/source/_integrations/onvif.markdown index 49b793fad460..a065bb80ef45 100644 --- a/source/_integrations/onvif.markdown +++ b/source/_integrations/onvif.markdown @@ -90,54 +90,12 @@ If your ONVIF camera supports PTZ, you will be able to pan, tilt or zoom your ca | `move_mode` | PTZ moving mode. Allowed values: `ContinuousMove`, `RelativeMove`, `AbsoluteMove`, `GotoPreset`, `Stop`. Default :`RelativeMove` | | `continuous_duration` | Set ContinuousMove delay in seconds before stopping the move. Allowed values: floating point numbers or integer. Default : 0.5 | -### Service `onvif.aux` +### Supported Switches -If your ONVIF camera supports PTZ auxiliary commands (e.g. for running the wiper or turning on the heater), you will be able to run them with this service. +This integration uses the ONVIF auxiliary command and imaging service to send certain settings and information to the camera via switch entities. Below is a list of currently supported switches. -| Service data attribute | Description | -| -----------------------| ----------- | -| `entity_id` | String or list of strings that point at `entity_id`s of cameras. Use `entity_id: all` to target all. | -| `cmd` | Command to send (e.g. `tt:Wiper|On`). Options depend on camera capability. | - -### Service `onvif.set_imaging_settings` - -Allos you to set various Imaging Settings as defined in [The ONVIF Imaging -Service Spec](https://www.onvif.org/specs/srv/img/ONVIF-Imaging-Service-Spec-v210.pdf). - -| Service data attribute | Description | -| -----------------------| ----------- | -| `entity_id` | String or list of strings that point at `entity_id`s of cameras. Use `entity_id: all` to target all. | -| `settings` | Command to send (e.g. `tt:Wiper|On`). Options depend on camera capability. | - -Valid setting keys depend on your camera capabilities, but may include: - -* `BacklightCompensation` -* `Brightness` -* `ColorSaturation` -* `Contrast` -* `Exposure` -* `Focus` -* `IrCutFilter` -* `Sharpness` -* `WideDynamicRange` -* `WhiteBalance` - -Some settings take simple values while others take data structures. For example, -to turn on auto-focus, you would run: - - service: onvif.set_imaging_settings - data: - settings: - Focus: - AutoFocusMode: AUTO - target: - entity_id: camera.skycam_media_profile1 - -To force the IR lamp to turn on, you would run: - - service: onvif.set_imaging_settings - data: - settings: - IrCutFilter: OFF - target: - entity_id: camera.skycam_media_profile1 +| Name | Entity Name | Description | +|----------|-------------|-------------| +| IR lamp | `ir_lamp` | Turn infrared lamp on and off via `IrCutFilter` ONVIF imaging setting. | +| Autofocus | `autofocus` | Turn autofocus on and off via `AutoFocusMode` ONVIF imaging setting. | +| Wiper | `wiper` | Turn on the lens wiper on and off via the `Wiper` ONVIF auxiliary command. | From d3b08bc6e60218c785afbdd18ef1dfdd96e82414 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Fri, 3 Feb 2023 17:30:48 +0100 Subject: [PATCH 5/5] Update ha_platforms --- source/_integrations/onvif.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_integrations/onvif.markdown b/source/_integrations/onvif.markdown index a065bb80ef45..c3297eee1a83 100644 --- a/source/_integrations/onvif.markdown +++ b/source/_integrations/onvif.markdown @@ -15,6 +15,7 @@ ha_platforms: - camera - diagnostics - sensor + - switch ha_integration_type: integration ---