vizion-ctl

vizion-ctl Functionality Overview

vizion-ctl, which imports VizionSDK, is a command-line tool designed for controlling video devices, offering various functionalities and options for convenient configuration and control.

General/Common Options

• -h : Display the options of vizion-ctl.

• -v, --version: Display vizion-ctl version information.

• -l, --list-devices: List all connected camera devices

• -d, --device <num>: Select device number <num>, default is 0.

• -i, --info: Display selected device information.

• -g, --get-ctrl <name>: Get the value of the controls. --all to show all controls.

• -s, --set-ctrl <ctrl=value>: Set the value of the controls.

• -f, --list-formats : List supported capture formats.

• -si, --save-image --path <filepath> : Save camera image.

• -hi, --header-info : Display ISP header information.

• -go, --get-osp : Get current OSP profile flag.

• -so, --set-osp <flag> : Set OSP profile flag. 0=Disable, 1=Enabled, 2=EnableAndSave

• -ro, --reset-osp : Reset OSP profile to default.

• -fu, --firmware-update : Update the device firmware. The --target option is optional for UVC firmware, with possible target flags: SPI (default), RAM, or I2C.

• -fd, --firmware-download : Download firmware in interactive mode.

• --get-timestamp: Get the timestamp.

• --reset-timestamp: Reset the timestamp. The function must be used when the camera is streaming.

• --get-framecount: Get the framecount.

• --reset-framecount: Reset the framecount. The function must be used when the camera is streaming.

• --debug : Enable debug level logging.

• --log-path : Set the log file path to store.

Control Parameters

Below are the parameters available for get/set controls:

Examples

Here are some examples illustrating the usage of vizionctl:

Display the vizion-ctl version information:

vizion-ctl -v
vizion-ctl --version

List all available video devices:

vizion-ctl -l
vizion-ctl --list-devices

Get the device information

vizion-ctl -d 0 -i
vizion-ctl -d 0 --info

Get the controls value

# Get All controls value
vizion-ctl -d 0 -g --all
vizion-ctl -d 0 --get-ctrl --all

# Get throughput value
vizion-ctl -d 0 -g throughput
vizion-ctl -d 0 --get-ctrl throughput

Set the control value

# Set throughput value to 500
vizion-ctl -d 0 -s throughput=500
vizion-ctl -d 0 --set-ctrl throughput=500

List the supported capture formats

vizion-ctl -d 0 -f
vizion-ctl -d 0 --list-formats

Save the image captured from device

Please ensure the destination path is set to a location with write permissions for normal users.

vizion-ctl -d 0 -si --path=path_to_img
vizion-ctl -d 0 --save-image --path=path_to_img

Get the ISP header information

vizion-ctl -d 0 -hi
vizion-ctl -d 0 --header-info

Get the current OSP profile flag

vizion-ctl -d 0 -go
vizion-ctl -d 0 --get-osp

Set the OSP profile flag

vizion-ctl -d 0 -so 1
vizion-ctl -d 0 --set-osp 1

Reset the OSP profile flag to default value

vizion-ctl -d 0 -ro
vizion-ctl -d 0 --reset-osp

Update the firmware

# update sensor
vizion-ctl -d 0 -fu sensor=firmware.bin
# update uvc
vizion-ctl -d 0 -fu uvc=firmware.img
# update uvc with target flag = RAM
vizion-ctl -d 0 -fu uvc=firmware.img --target RAM

Download the firmware

Please ensure the destination path is set to a location with write permissions for normal users.

vizion-ctl -d 0 -fd --path path_to_fw

Get the timestamp and framecount

vizion-ctl -d 0 --get-timestamp
vizion-ctl -d 0 --get-framcount

Reset the timestamp and framecount

Please ensure the device is streaming or not. The reset functions must be used when the camera is streaming.

vizion-ctl -d 0 --reset-timestamp
vizion-ctl -d 0 --reset-framecount

Set the debug level for vizion-ctl

vizion-ctl --debug

Set the log file path

Please ensure the destination path is set to a location with write permissions for normal users.

vizion-ctl --log-path path_to_log_file