Gx mipi i2c.sh user guide

gx_mipi_i2c.sh Shell scripts usage

1 Overview

The gx_mipi_i2c.sh script is a tool set for configuring GX MIPI series cameras through the I2C.

This script is essentially an access to registers. For registers, please refer to GX Series MIPI Camera Register Map.

2 Download

We provide download links for gx_mipi_i2c.sh for different embedded platforms.

Generally, these links can be found in the respective platform's GitHub repository.

Below is the list:

3 Prepare

cd gx_tools_rpi/sources/

./make.sh

cd ..

chmod +x *

4 gx_mipi_i2c.sh USAGE

$ ./gx_mipi_i2c.sh

Usage:  ./gx_mipi_i2c.sh [-r/w]  [function name] [param1] [param2 ] [param3] [param4] -b bus

options:

    -r                       read

    -w                       write

    [function name]       function name

    [param1]                        param1 of each function

    [param1]                        param2 of each function

    [param3]                        param3 of each function

    [param4]                        param4 of each function

    -b [i2c bus num]               i2c bus number

    -d [i2c addr]                  i2c addr if not default 0x3b

Please open this srcipt and read the COMMENT on top for support functions and samples

5 i2c bus number on different board

Please refer to the following article to determine which -b parameter you need to use.

i2c bus number on different boards

6 Functions list

6.1 Note

The camera has two states, standby and running, after the start of image acquisition into the running state.

There are some registers that are write-protected in the running state, which will be marked with an asterisk. For example: trgsrc* .

There are some parameters that have strict range restrictions, and it's a good idea to try reading them when you're in doubt.

6.2 Basic Parameters

6.2.1 manufacturer

./gx_mipi_i2c.sh -r manufacturer -b your_i2c_bus_number

Get the manufacturer name, which is VEYE.

6.2.2 model

./gx_mipi_i2c.sh -r model -b your_i2c_bus_number

Get the product model, such as GX-MIPI-IMX662.

6.2.3 version

./gx_mipi_i2c.sh -r version -b your_i2c_bus_number

Get the Controller version number and Logical version number.

The system has two main control chips that serve the control and logic functions respectively.

6.2.4 serialno

./gx_mipi_i2c.sh -r serialno -b your_i2c_bus_number

Get the unique serial number of this module.

6.2.5 timestamp

./gx_mipi_i2c.sh -r timestamp -b your_i2c_bus_number

Get the time since the system started, in milliseconds.

6.2.6 errcode

reserved

6.2.7 fmtcap

./gx_mipi_i2c.sh -r fmtcap -b your_i2c_bus_number

Get the Module supports data formats

Capbility of data formats supported by the camera.

bit0: Mono8

bit1: Mono10

bit2: Mono12

bit3: Mono14

bit4: UYVY

bit5: RGB888

bit6: Temp

bit7: YUYV

6.2.8 readmodecap

./gx_mipi_i2c.sh -r readmodecap -b your_i2c_bus_number

Get the Sensor reads out the capability set of patterns.

Capbility of read mode supported by the camera.

bit0: Normal

bit1: binning mode

bit2: subsampling mode

6.2.9 workmodecap

./gx_mipi_i2c.sh -r workmodecap -b your_i2c_bus_number

Get the Video streaming mode capability set

Capbility of trigger mode supported by the camera.

bit0: Video streaming mode

bit1: Normal trigger mode.

bit2: Rolling shutter multi-frame trigger mode.

bit3: Pulse trigger mode.

bit4: Multi-camera synchronization mode.

6.2.10 lanecap

./gx_mipi_i2c.sh -r lanecap -b your_i2c_bus_number

Get the number of MIPI Lanes supported by the camera

The number of MIPI lanes supported by the camera .

The lower to higher bits correspond to the supported capabilities for 1 lane, 2 lanes, 3 lanes, and 4 lanes, respectively.

For example, 0x2 indicates support for 2 lanes, and 0xA indicates support for both 2 lanes and 4 lanes.

6.2.11 cameramodel0-cameramodel7

./gx_mipi_i2c.sh -r cameramodel0 -b your_i2c_bus_number

Get the camera model, such as: cameramodel0 is 0x47582d4d(ascii is GX-M)

6.2.12 temp

./gx_mipi_i2c.sh -r temp -b your_i2c_bus_number

Get the temp is 25K

6.2.13 videomodecap

./gx_mipi_i2c.sh -r videomodecap -b your_i2c_bus_number

Get the videomodecap is 2

value	description
bit0	ROI模式
bit1	Set the VideoMode mode as the default.

6.2.14 videomodenum

./gx_mipi_i2c.sh -r videomodenum -b your_i2c_bus_number

Get the videomodenum 1

6.2.15 vidoemodewh1-vidoemodewh8

./gx_mipi_i2c.sh -r videomodewh1 -b your_i2c_bus_number

Get the videomodewh1 is 0x7800438 (1920*1080)

In the first mode, the width is represented by the high 16 bits and the height by the low 16 bits.

6.2.16 videomodeparam1-videomodeparam8

./gx_mipi_i2c.sh -r videomode_param1 -b your_i2c_bus_number

Get the videomodeparam1 is 0x1003c

The frame rate and reading method of the first mode. The high 8-bit standby, the middle 8-bit is for reading mode, and the low 16-bit is for the maximum frame rate.

value	description
0	ordinary
1	binning
2	subsampling

6.2.17 factoryparam

./gx_mipi_i2c.sh -w factoryparam -b your_i2c_bus_number

All parameters restored to factory default values.

This operation will erase the system flash and rewrite it. Please ensure that the power is not interrupted during the operation.

Additionally, it is recommended not to perform frequent factoryparam operations.

6.2.18 paramsave

./gx_mipi_i2c.sh -w paramsave -b your_i2c_bus_number

Save all parameters to flash, and they will not be lost when power off.

This operation will erase the system flash and rewrite it. Please ensure that the power is not interrupted during the operation.

Additionally, it is recommended not to perform frequent paramsave operations.

6.2.19 reboot

./gx_mipi_i2c.sh -w reboot -b your_i2c_bus_number

Reboot the camera.

6.3 Image Acquisition

6.3.1 imgacq

./gx_mipi_i2c.sh -w imgacq [0/1] -b your_i2c_bus_number

Start/Stop acquisition

There is no image output after the camera is powered on, which means it is in the standby state.

After writing 1 to this register, it enters the running state and starts outputting images or waiting for the trigger signal.

Writing 0 will stop the output image and enter the standby state.

6.3.2 workmode

./gx_mipi_i2c.sh -w workmode [0，1，4] -b your_i2c_bus_number

./gx_mipi_i2c.sh -r workmode -b your_i2c_bus_number

value	description
0	Video streaming mode
1	Normal trigger mode
4	Multi-camera synchronization mode

See product manual for details.

6.3.3 trgsrc

./gx_mipi_i2c.sh -w trgsrc [0,1] -b your_i2c_bus_number

./gx_mipi_i2c.sh -r trgsrc -b your_i2c_bus_number

value	description
0	Software trigger
1	Hardware trigger

6.3.4 trgnum

./gx_mipi_i2c.sh -w trgnum [1,255] -b your_i2c_bus_number

./gx_mipi_i2c.sh -r trgnum -b your_i2c_bus_number

The number of image frames output by one trigger signal in trigger mode.

6.3.5 trginterval

./gx_mipi_i2c.sh -w trginterval [us] -b your_i2c_bus_number

./gx_mipi_i2c.sh -r trginterval -b your_i2c_bus_number

Trigger interval in normal trigger mode, in microseconds. Range:[0.0xFFFFFF].

6.3.6 trgone

./gx_mipi_i2c.sh -w trgone -b your_i2c_bus_number

Software trigger command.One execution will perform a soft trigger.

6.3.7 trgcount

./gx_mipi_i2c.sh -r trgcount -b your_i2c_bus_number

Trigger count statistics.

Get the total number of triggers and the number of trigger loss.

./gx_mipi_i2c.sh -w trgcountclr [1] -b your_i2c_bus_number

Clear trigger count.

6.3.8 i2caddr

./gx_mipi_i2c.sh -w i2caddr [new] -b your_i2c_bus_number

./gx_mipi_i2c.sh -r i2caddr -b your_i2c_bus_number
This module support i2c address changed by software, i2c address range[0x3,0x77].

Will really take effect only after paramsave and reboot .

6.3.9 nondiscontinuousmode

./gx_mipi_i2c.sh -r nondiscontinuousmode -b your_i2c_bus_number

Indicates whether the clock lan of the mipi signal is in continuous clock mode.

0: discontinuous mode

1: continuous mode

6.3.10 slavemode

./gx_mipi_i2c.sh -w slavemode [0/1] -b your_i2c_bus_number

./gx_mipi_i2c.sh -r slavemode -b your_i2c_bus_number

Whether the sensor is operating in slave mode. In slave mode, the camera relies on external signals to provide XVS and XHS.

Writing this parameter will cause the camera to automatically save the current settings and reboot.

Currently.

6.3.11 framecount

./gx_mipi_i2c.sh -r framecount -b your_i2c_bus_number
Get the Sensor_Frame_Count is 434 , Out_Frame_Count is 436

Sensor_Frame_Count:

The number of frames collected from the sensor is counted in a loop. Only accumulation is performed without clearing, and it is updated once per second.

Out_Frame_Count:

The number of frames output is counted in a loop. Only accumulation is performed without clearing, and it is updated once per second.

6.3.12 triggercyclemin

./gx_mipi_i2c.sh -r triggercyclemin -b your_i2c_bus_number

Get the Trigger_Cycle_Min is 0

6.3.13 daynightmode

./gx_mipi_i2c.sh -r daynightmode -b your_i2c_bus_number

Get the Day_night_mode is 2

6.3.14 ircutdir

./gx_mipi_i2c.sh -w ircutdir [0/1] -b your_i2c_bus_number

./gx_mipi_i2c.sh -r ircutdir -b your_i2c_bus_number

By default, if the voltage at port A is higher than that at port B (A > B), the IRCUT module will drive the filter to enter the optical path. When the direction is switched so that the voltage at port B becomes higher than that at port A (A < B), the polarity of the electromagnetic coil reverses, and the filter is driven to exit the optical path.

6.3.15 pinpolarity

./gx_mipi_i2c.sh -w pinpolarity [0/1] -b your_i2c_bus_number

./gx_mipi_i2c.sh -r pinpolarity -b your_i2c_bus_number

Trigger pin polarity reversal day and night. By default, a low level indicates night. After setting this value to 1, a high level indicates night.

6.3.16 ircuttimer

./gx_mipi_i2c.sh -w ircuttimer [0/1] -b your_i2c_bus_number

./gx_mipi_i2c.sh -r ircuttimer -b your_i2c_bus_number

Whether to enable IRCUT periodic control; If enabled, IRCUT control will be performed according to the default cycle. If not enabled, control will only be carried out once during mode switching.

6.4 Image Properties

6.4.1 testimg

./gx_mipi_i2c.sh -w testimg [0/1] -b your_i2c_bus_number

./gx_mipi_i2c.sh -r testimg -b your_i2c_bus_number

value	description
0	Common image
1	Vertical color stripes

6.4.2 pixelformat

./gx_mipi_i2c.sh -w pixelformat [4/5/6/7] -b your_i2c_bus_number

./gx_mipi_i2c.sh -r pixelformat -b your_i2c_bus_number

value	description
4	UYVY
5	RGB888
6	Temp
7	YUYV

6.4.3 maxwh

./gx_mipi_i2c.sh -r maxwh -b your_i2c_bus_number

Get the maximum width and height supported by the sensor

6.4.4 minwh

./gx_mipi_i2c.sh -r minwh -b your_i2c_bus_number

Get the minimum width and height supported by the camera.

6.4.5 maxfps

./gx_mipi_i2c.sh -r maxfps -b your_i2c_bus_number

The maximum frame rate supported in the current mode.

Depending on the configured ROI, the maximum frame rate will be different. This parameter supports decimals.

6.4.6 minfps

./gx_mipi_i2c.sh -r minfps -b your_i2c_bus_number

Read the minimum frame rate supported by the current module.

6.4.7 curwh

./gx_mipi_i2c.sh -r curwh -b your_i2c_bus_number

Get the current width and height

6.4.8 imgdir

./gx_mipi_i2c.sh -r imgdir -b your_i2c_bus_number

./gx_mipi_i2c.sh -w imgdir [0/1/2/3] -b your_i2c_bus_number

Image orientation：

value	description
0	normal
1	mirror
2	flip
3	flip&mirror

6.4.9 videomode

./gx_mipi_i2c.sh -r videomode -b your_i2c_bus_number

./gx_mipi_i2c.sh -w videomode [1-8] -b your_i2c_bus_number

For cameras that use the VideoMode mode to select the frame rate of width and height, which mode should be chosen? The corresponding capability set is VideomodeCap. Range [1-8]

6.4.10 readmode

./gx_mipi_i2c.sh -r readmode -b your_i2c_bus_number

./gx_mipi_i2c.sh -w readmode [0/1/2] -b your_i2c_bus_number

image model:

value	description
0	normal mode
1	2x2binning mode
2	subsampling mode

6.4.11 lanenum

./gx_mipi_i2c.shsh -r lanenum -b your_i2c_bus_number

./gx_mipi_i2c.shh -w lanenum [0/1/2] -b your_i2c_bus_number

Configuration of the number of LANs outputting MIPI signals

value	description
2	2lane
4	4lane

6.4.12 mipidatarate

./gx_mipi_i2c.shh -r mipidatarate -b your_i2c_bus_number

The rate of each LAN in the MIPI system is measured in kbps.

6.4.13 minframerate

./gx_mipi_i2c.sh -r minframerate -b your_i2c_bus_number

Get the minimum frame rate supported in the current mode

6.4.14 fps

./gx_mipi_i2c.sh -r fps -b your_i2c_bus_number

./gx_mipi_i2c.sh -w fps -b [framerate] your_i2c_bus_number

Configure the actual frame rate of the camera in the current mode.

Range:(0,maxfps].

In video streaming mode, this parameter determines the actual frame rate.

In normal trigger mode, it is recommended to set the fps to the maxfps value to ensure the highest trigger signal responsiveness.

6.5 Image Processing

6.5.1 expmode

./gx_mipi_i2c.sh -r expmode -b your_i2c_bus_number

./gx_mipi_i2c.sh -w expmode [0/2] -b your_i2c_bus_number

Exposure type

value	description
0	manual exposure
2	auto exposure

6.5.2 aatarget

./gx_mipi_i2c.sh -r aatarget -b your_i2c_bus_number

./gx_mipi_i2c.sh -w aatarget [0,255] -b your_i2c_bus_number

The target brightness of AE and AG algorithm.

Within the set range, the algorithm will prioritize the increase in exposure time,

and increase the gain if the exposure time reaches the maximum and still cannot reach the set target brightness value.

6.5.3 aestrategy

./gx_mipi_i2c.sh -r aestrategy -b your_i2c_bus_number

./gx_mipi_i2c.sh -w aestrategy [0/1] -b your_i2c_bus_number

Automatic exposure strategy

value	description
0	Bright Area Priority mode (High Light priority
1	Dark zone priority mode (low light priority)

6.5.4 metime

./gx_mipi_i2c.sh -r metime -b your_i2c_bus_number

./gx_mipi_i2c.sh -w metime [us] -b your_i2c_bus_number

Range (0,1000000/fps].Because of Note1 and range limitation, please read back to confirm the real metime take effect.

Unit: microseconds.

6.5.5 aemaxtime

./gx_mipi_i2c.sh -r aemaxtime -b your_i2c_bus_number

./gx_mipi_i2c.sh -w aemaxtime [16,1000000/fps] -b your_i2c_bus_number

Maximum exposure time in AE mode.Range[16,1000000]. Note1.

Please read back to confirm the real aemaxtime take effect.

Unit: microseconds.

6.5.6 exptime

./gx_mipi_i2c.sh -r exptime -b your_i2c_bus_number

Get the current exposure time. This command is valid in any exposure mode.

Unit: microseconds.

6.5.7 curgain

./gx_mipi_i2c.sh -r curgain -b your_i2c_bus_number

Gets the current gain. This command is valid in any exposure mode.

6.5.8 mgain

./gx_mipi_i2c.sh -r mgain -b your_i2c_bus_number

./gx_mipi_i2c.sh -w mgain [gain] -b your_i2c_bus_number

The manual gain value, range and step size vary by model.

6.5.9 aemaxgain

./gx_mipi_i2c.sh -r aemaxgain -b your_i2c_bus_number

./gx_mipi_i2c.sh -w aemaxgain [0,maxgain] -b your_i2c_bus_number

Maximum value of auto gain. The range and step vary according to the model.

Most sensors have a gain step of 0.1dB, some are 0.3dB.

6.5.10 wbmode

./gx_mipi_i2c.sh -r wbmode -b your_i2c_bus_number

./gx_mipi_i2c.sh -w wbmode [0/2] -b your_i2c_bus_number

value	description
0	manual white balance
2	auto white balance

6.5.11 awbcolortempmin

./gx_mipi_i2c.sh -r awbcolortempmin -b your_i2c_bus_number

./gx_mipi_i2c.sh -w awbcolortempmin -b your_i2c_bus_number

White balance minimum color temperature (K)

6.5.12 awbcolortempmax

./gx_mipi_i2c.sh -r awbcolortempmax -b your_i2c_bus_number

./gx_mipi_i2c.sh -w awbcolortempmax -b your_i2c_bus_number

White balance maximum color temperature (K)

6.5.13 mwbbgain

./gx_mipi_i2c.sh -r mwbbgain -b your_i2c_bus_number

./gx_mipi_i2c.sh -w mwbbgain -b your_i2c_bus_number

Manual white balance B gain [0,4095]

6.5.14 mwbrgain

./gx_mipi_i2c.sh -r mwbrgain -b your_i2c_bus_number

./gx_mipi_i2c.sh -w mwbrgain [mwbrgain] -b your_i2c_bus_number

Manual white balance R gain [0,4095]

6.5.15 colortemp

./gx_mipi_i2c.sh -r colortemp -b your_i2c_bus_number

Current color temperature (k)

6.5.16 currgain

./gx_mipi_i2c.sh -r currgain -b your_i2c_bus_number

Current white balance R gain [0,4095]

6.5.17 curbgain

./gx_mipi_i2c.sh -r curbgain -b your_i2c_bus_number

Current white balance B gain [0,4095]

6.5.18 aemintime

./gx_mipi_i2c.sh -r aemintime -b your_i2c_bus_number

./gx_mipi_i2c.sh -w aemintime [aemintime] -b your_i2c_bus_number

Automatic minimum exposure time range: 16 to 1,000,000 (unit: microseconds)

6.5.19 gamma

./gx_mipi_i2c.sh -r gamma -b your_i2c_bus_number

./gx_mipi_i2c.sh -w gamma [gamma] -b your_i2c_bus_number

Range （0,4.0],accurate is 0.01.

For now, gamma only works on 8bit depth image

6.5.20 antiflicker

./gx_mipi_i2c.sh -r antiflicker -b your_i2c_bus_number

./gx_mipi_i2c.sh -w antiflicker [0/1] [50/60/100/120/200/240] -b your_i2c_bus_number

param1:Whether the antiflicker function is enabled [0/1]

param2:Frame rate [50/60/100/120/200/240]

6.5.21 wdrparam

./gx_mipi_i2c.sh -r wdrparam -b your_i2c_bus_number

./gx_mipi_i2c.sh -w wdrparam [0/1] [0,255] -b your_i2c_bus_number

param1:Whether the WDR function is enabled [0/1]

param2:WDR intensity [0-255]

6.5.22 sharppen

./gx_mipi_i2c.sh -r sharppen -b your_i2c_bus_number

./gx_mipi_i2c.sh -w sharppen [0,255] -b your_i2c_bus_number

Sharpening intensity [0-255]

6.5.23 denoise_strength_2D

./gx_mipi_i2c.sh -r denoise_strength_2D -b your_i2c_bus_number

./gx_mipi_i2c.sh -w denoise_strength_2D [0,255] -b your_i2c_bus_number

2D noise reduction intensity [0-255]

6.5.24 denoise_strength_3D

./gx_mipi_i2c.sh -r denoise_strength_3D -b your_i2c_bus_number

./gx_mipi_i2c.sh -w denoise_strength_3D [0,255] -b your_i2c_bus_number

3D noise reduction intensity [0-255]

6.5.25 saturation

./gx_mipi_i2c.sh -r saturation -b your_i2c_bus_number

./gx_mipi_i2c.sh -w saturation [0,100] -b your_i2c_bus_number

Saturation [0-100]

6.5.26 contrast

./gx_mipi_i2c.sh -r contrast -b your_i2c_bus_number

./gx_mipi_i2c.sh -w contrast [0,100] -b your_i2c_bus_number

contrast[0-100]

6.5.27 hue

./gx_mipi_i2c.sh -r hue -b your_i2c_bus_number

./gx_mipi_i2c.sh -w hue [0-100] -b your_i2c_bus_number hue[0-100]

6.5.28 slowshutter

./gx_mipi_i2c.sh -r slowshutter -b your_i2c_bus_number

./gx_mipi_i2c.sh -w slowshutter [0/1] [200] -b your_i2c_bus_number

Is the automatic frame reduction function for parameter 1 enabled?

Parameter 2 sets the gain threshold for automatically reducing frames. The unit is 0.1 dB.

Note: This setting is only effective in the automatic exposure mode + video stream mode. It determines whether the Aemode is in the fixed frame rate mode or the automatic frame reduction mode.

6.6 IO Control

6.6.1 trgdelay

./gx_mipi_i2c.sh -r trgdelay -b your_i2c_bus_number

./gx_mipi_i2c.sh -w trgdelay [us] -b your_i2c_bus_number

Trigger delay, effective under both soft trigger and hard trigger mode.

range: 0 to 1000000 (unit: microsecond)

6.6.2 trgedge

./gx_mipi_i2c.sh -r trgedge -b your_i2c_bus_number

./gx_mipi_i2c.sh -w trgedge [0,1] -b your_i2c_bus_number

Effective trigger edge in hard trigger mode.

value	description
0	Rising edge
1	Falling edge

6.6.3 trgexp_delay

./gx_mipi_i2c.sh -r trgexp_delay -b your_i2c_bus_number

./gx_mipi_i2c.sh -w trgexp_delay [us] -b your_i2c_bus_number

Exposure delay, i.e. the time to turn on the Strobe signal in advance.

range: 0 to 1000000 (unit: microsecond)

The difference between trgexp_delay and trgdelay, see manual for details.

6.6.4 outio1_rvs

./gx_mipi_i2c.sh -r outio1_rvs -b your_i2c_bus_number

./gx_mipi_i2c.sh -w outio1_rvs [0,1] -b your_i2c_bus_number

Reverse OUT_IO1 high and low levels if set to 1.

6.7 Notes

Note1: All parameters of exposure time are in microseconds. However, due to the properties of the sensor, the actual exposure time unit of the sensor is 1 line, can not be accurate to 1us.

7 Configuration Method for Typical Application Scenarios:

7.1 Stream mode:

 ./gx_mipi_i2c.sh -w imgacq 1 -b your_i2c_bus_number

7.2 Trigger mode:

./gx_mipi_i2c.sh -w imgacq 0 -b your_i2c_bus_number

./gx_mipi_i2c.sh -w trgmode 1 -b your_i2c_bus_number

./gx_mipi_i2c.sh -w trgsrc 0 -b your_i2c_bus_number

./gx_mipi_i2c.sh -w trgnum 1 -b your_i2c_bus_number

./gx_mipi_i2c.sh -w trginterval 0 -b your_i2c_bus_number

./gx_mipi_i2c.sh -w trgone -b your_i2c_bus_number

According to the above command, you can take a picture.

7.2.1 Sync mode:

Note: The synchronous mode requires two cameras.

./gx_mipi_i2c.sh -w slavemode 0 -b your_i2c_bus_number

./gx_mipi_i2c.sh -w slavemode 1 -b your_i2c_bus_number

./gx_mipi_i2c.sh -w trgmode 4 -b your_i2c_bus_number

./gx_mipi_i2c.sh -w trgmode 4 -b your_i2c_bus_number

./gx_mipi_i2c.sh -w imgacq 1 -b your_i2c_bus_number

./gx_mipi_i2c.sh -w imgacq 1 -b your_i2c_bus_number

./veye_raspipreview -cs 1 -p '0,0,1000,520' -t -1

./veye_raspipreview -cs 0 -p '600,0,1280,720' -t -1

After completing the above configuration, you can proceed to start capturing images.

Please note that if you need to adjust the frame rate during the image acquisition process, you must first stop the acquisition before making the changes.  

After stopping the acquisition, the camera will still complete the capture of the current frame.

The newly set parameters will only take effect afterward.