Protocol: camera settings - jdeananderson/Lumens-IP-Camera-Control GitHub Wiki

Camera settings here are defined as settings that alter the lens and CCD to capture an image, such as focus, exposure, etc. These camera settings are changed by passing parameters and values to vb.htm. Each parameter update should receive an “OK” response, followed by the parameter name. Multiple parameters can be altered on one command line by an “&” separator. If multiple parameters are submitted, multiple responses are returned each with their own “OK” status (or other status) followed by the parameter name.

All parameter updates are followed shortly thereafter by a paratest=reloadflag command:

http://[camera ip]/vb.htm?paratest=reloadflag&_=[UTS]

Focus

Controls focusing of the camera lens.

Function Command Variable Values Comments
Manual Focus http://[camera ip]/vb.htm?focusautoidx=0&afzoomtrackingidx=[ptz assist]&_=[UTS] [camera ip] Camera’s current ip
[UTS] Current Unix time stamp
[ptz assist] 0 PTZ assist disabled
1 PTZ assist enabled
Manual Focus Position http://[camera ip]/vb.htm?focuspositon=[position number]&_=[UTS] (see notes 2 and 3) [camera ip] Camera’s current ip
[UTS] Current Unix time stamp
[position number] 0 0 is the furthest focus position
... 0 through 963
963 963 is the closest focus position
Auto Focus http://[camera ip]/vb.htm?focusautoidx=1&afsensitivityidx=[af sensitivity]&afspeednameidx=[af speed] &afframenameidx=[af frame]&_=[UTS] [camera ip] Camera’s current ip
[UTS] Current Unix time stamp
[af sensitivity] 0 Auto focus sensitivity “low”
1 Auto focus sensitivity “Middle”
2 Auto focus sensitivity “high”
[af speed] 0 AF speed “Fast”
1 AF speed “Normal”
[af frame] 0 AF based on “Full Frame”
1 AF uses only “Center”
Zoom Tracking http://[camera ip]vb.htm?afzoomtrackingidx=[tracking state]&=[UTS] [camera ip] Camera’s current ip
[UTS] Current Unix time stamp
[tracking state] 1 Zoom tracking “on”
0 Zoom tracking “off”

Notes:

  • “Focus lock” can be obtained by changing the camera into manual focus mode with ptz assist disabled. Focus lock allows a camera operator to ensure that the autofocus mechanism won’t “hunt” around for exact focus during a live production.
  • Focuspositon IS misspelled in the Lumens command set, and is missing an “i”
  • To set manual focus to a particular position, it is necessary to put the camera in manual focus mode with ptz assist disabled prior to sending the focuspositon command.
  • Not all focus position numbers are available at all zoom levels. The camera can get very confused if focus is set to a number and the zoom level is changed to a number where the focus level is not valid. Even if presets are called, and zoom levels are changed, the camera may not recover. You must reboot the camera for it to recover. It is recommended to use autofocus, turn off autofocus to “lock” the zoom, and then change the zoom number in small increments to lock camera focus into position.
  • All parameter updates are followed shortly thereafter by a paratest=reloadflag command:
http://[camera ip]/vb.htm?paratest=reloadflag&_=[UTS]
  • Focus menu option names from ini.htm
          focusautoname=Manual;Auto
          afsensitivityname=Low;Middle;High
          afspeedname=Fast;Normal
          afframename=Full Frame;Center
          afzoomtrackingname=On;Off

White balance

Sets white balance, or color temperature of the image.

Function Command Variable Values Comments
White balance mode http://[camera ip]/vb.htm?wbmodeidx=[mode]&_=[UTS] [camera ip] Camera’s current ip
[UTS] Current Unix time stamp
[mode] 0 Auto
1 Indoor (3200K)
2 Outdoor
3 One Push WB (see “One Push”command below)
4 ATW
5 Manual (see cbgain and crgain commands below)
6 Sodium Lamp
7 3000K
8 4300K
9 5000K
10 6500K
11 8000K
12 Wide Auto
One push
(Only used in One Push WB mode) 		http://[camera ip]/vb.htm?wbonepushtrigger=1&_=[UTS] [camera ip] Camera’s current ip
[UTS] Current Unix time stamp
“1” Use as a “push button” in the UI. Place a piece of white paper in front of the camera, and send this command to tell the camera what the color white should look like.
Manual blue gain
(only used in manual [5] white balance mode)		 http://[camera ip]/vb.htm?cbgain=[gain]&_=[UTS} [camera ip] Camera’s current ip
[UTS] Current Unix time stamp
[gain] 0 Lowest cbgain value
... Cbgain values range between 0 and 128
128 Highest cbgain value
Manual red gain
(only used in manual [5] white balance mode) 		http://[camera ip]/vb.htm?crgain=[gain]&_=[UTS] [camera ip] Camera’s current ip
[UTS] Current Unix time stamp
[gain] 0 Lowest crgain value
... Crgain values range between 0 and 128
128 Highest crgain value

Notes:

  • All parameter updates are followed shortly thereafter by a paratest=reloadflag command:
http://[camera ip]/vb.htm?paratest=reloadflag&_=[UTS]

Mirror

Used to mirror and or flip the camera output if mounted upside down on the ceiling

Function Command Variable Values Comments
Mirror http://[camera ip/vb.htm?mirrornameidx=[number]&_=[UTS] [camera ip] Camera’s current ip
[UTS] Current Unix time stamp
[number] 0 Off
1 Mirror
2 Flip
3 Mirror + Flip

Notes:

  • Option names from Ini.htm: mirrorname=Off;Mirror;Flip;Mirror + Flip
⚠️ **GitHub.com Fallback** ⚠️