Skip to content

Add docs for new ONVIF aux command. #25370

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
frenck merged 5 commits into from
Feb 3, 2023
Merged

Add docs for new ONVIF aux command. #25370

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6998fb4
Add docs for new ONVIF aux command.
partofthething Dec 20, 2022
cde92b7
Add docs for new ONVIF ImagingSetting service.
partofthething Jan 1, 2023
c95e02d
Fix example.
partofthething Jan 26, 2023
fe86475
Remove service docs since they were removed. Add switch docs.
partofthething Jan 28, 2023
d3b08bc
Update ha_platforms
frenck Feb 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 53 additions & 1 deletion source/_integrations/onvif.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -88,4 +90,54 @@ 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. |
Comment thread
MartinHjelmare marked this conversation as resolved.
Outdated

### 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`
Comment thread
MartinHjelmare marked this conversation as resolved.
Outdated

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