.\" Text automatically generated by txt2man .TH ONVIF-UTIL 1 "09 November 2022" "" "" .SH NAME onvif-util - query and adjust onvif compatible cameras .SH SYNOPSIS .nf .fam C \fBonvif-util\fP [\fB-ah\fP] [\fB-u\fP ] [\fB-p\fP ] [\fIip_address\fP] .fam T .fi .fam T .fi .SH DESCRIPTION View and set parameters on onvif compatible IP cameras. The command may be used to find and identify cameras, and then to create an interactive session that can be used to query and set camera properties. .PP \fB-a\fP, \fB--all\fP show all cameras on the network .PP \fB-h\fP, \fB--help\fP show the help for this command .PP \fB-u\fP, \fB--user\fP set the username for the camera login .PP \fB-p\fP, \fB--password\fP set the password for the camera login .PP To view all cameras on the network: \fBonvif-util\fP \fB-a\fP .PP To login to a particular camera: \fBonvif-util\fP \fB-u\fP username \fB-p\fP password \fIip_address\fP .PP To login to a camera with safe mode disabled: \fBonvif-util\fP \fB-s\fP \fB-u\fP username \fB-p\fP password \fIip_address\fP .PP Once logged into the camera you can view data using the 'get' command followed by the data requested. The (n) indicates an optional profile index to apply the setting, otherwise the current profile is used .PP .nf .fam C Data Retrieval Commands (start with get) get rtsp 'pass'(optional) (n) - Get rtsp uri for camera, with optional password credential get capabilities get time get profiles get profile (n) get video (n) get video options (n) get imaging get imaging options get network Parameter Setting Commands (start with set) set resolution (n) - Resolution setting in the format widthxheight, must match option set framerate (n) set gov_length (n) set bitrate (n) set bightness value(required) set contrast value(required) set saturation value(required) set sharpness value(required) set ip_address value(required) set default_gateway value(required) set dns value(required) set dhcp value(required) - Accepted settings are 'on' and off' set password value(required) Maintenance Commands help safe - set safe mode on. Viewer and browser are disabled unsafe - set safe mode off. Viewer and browser are enabled browser - Use browser to access camera configurations view (n) - View the camera output using ffplay (ffplay must be installed in the path) view player (n) - View the camera output with user specified player e.g. view vlc sync_time 'zone'(optional) - Sync the camera time to the computer dump - Full set of raw data from camera configuration reboot To Exit Camera Session quit .fam T .fi .SH EXAMPLES A typical session would begin by finding the cameras on the network .PP > \fBonvif-util\fP \fB-a\fP .PP .nf .fam C Looking for cameras on the network\.\.\. Found 8 cameras 192.168.1.18 localhost(TV TV-IP319PI) 192.168.1.7 (IPC-BO IPC-122) 192.168.1.14 IPC(Dahua IPC-HDW4631C-A) 192.168.1.6 IPC(Amcrest IP2M-841EB) 192.168.1.12 (AXIS M1065-LW) 192.168.1.12 (AXIS M1065-LW) 192.168.1.2 IPC(Amcrest IP3M-HX2W) 192.168.1.11 R2(IPC-model) .fam T .fi To start a session with a camera, use the login credentials .PP > \fBonvif-util\fP \fB-u\fP admin \fB-p\fP admin123 192.168.1.12 .PP .nf .fam C found host: 192.168.1.12 successfully connected to host name: AXIS M1065-LW serial: ACCC8E99C915 .fam T .fi Get current settings for video .PP > get video .PP .nf .fam C Profile set to profile_1_h264 Resolution: 1920 x 1080 Frame Rate: 25 Gov Length: 30 Bit Rate: 4096 .fam T .fi Get available video settings .PP > get video options .PP .nf .fam C Available Resolutions 1920 x 1080 1280 x 720 640 x 480 320 x 240 Min Gov Length: 1 Max Gov Length: 32767 Min Frame Rate: 1 Max Frame Rate: 30 Min Bit Rate: 1 Max Bit Rate: 2147483647 .fam T .fi Set video resolution .PP > set resolution 1280x720 .PP .nf .fam C Resolution was set to 1280 x 720 .fam T .fi Exit session .PP > quit .SH COPYRIGHT Copyright (c) 2020 Stephen Rhodes .PP This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. .SH SEE ALSO There is a gui version of this program included with the libonvif package which will implement most of the same commands. It may be invoked using the 'onvif' command. The gui has the ability to view camera video output using a player such as ffplay, provided that the player executable is installed in the computer path. .SH NOTES Camera compliance with the onvif standard is often incomplete and in some cases incorrect. Success with the \fBonvif-util\fP may be limited in many cases. Cameras made by Hikvision will have the greatest level of compatibility with \fBonvif-util\fP. Cameras made by Dahua will have a close degree of compatibility with some notable exceptions regarding gateway and DNS settings. Time settings may not be reliable in some cases. If the time is set without the zone flag, the time appearing in the camera feed will be synced to the computer time. If the time zone flag is used, the displayed time may be set to an offset from the computer time based on the timezone setting of the camera. .PP If the camera DNS setting is properly onvif compliant, the IP address may be reliably set using \fBonvif-util\fP. Some cameras may not respond to the DNS setting requested by \fBonvif-util\fP due to non compliance. Note that the camera may reboot automatically under some conditions if the DNS setting is changed from off to on. .PP Video settings are reliable. The Admin Password setting is reliable, as well as sync_time and the reboot command. If there is an issue with a particular setting, it is recommended to connect to the camera using the browser command, as most cameras will have a web interface that will allow you to make the changes reliably. The gui version has a button on the Admin tab that will launch the web browser with the camera ip address automatically.