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 all 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
13 changes: 12 additions & 1 deletion source/_integrations/onvif.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ ha_platforms:
- camera
- diagnostics
- sensor
- switch
ha_integration_type: integration
---

Expand Down Expand Up @@ -72,6 +73,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 +91,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 |

If you are running into trouble with this sensor, please refer to the [Troubleshooting section](/integrations/ffmpeg/#troubleshooting).
### Supported Switches
Comment thread
frenck marked this conversation as resolved.

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.

| 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. |