manualshive.com logo in svg

Kaya Instruments IRON SDI, User Manual

Share
Download
Kaya Instruments IRON SDI User Manual Download Page 14

2 0   H a M e s i l a   S t . ,   N e s h e r   3 6 8 8 5 2 0 ,   I s r a e l  

P O B   2 5 0 0 4 ,       H a i f a   3 1 2 5 0 0 1 ,   I s r a e l  

T e l : ( + 9 7 2 ) - 7 2 - 2 7 2 3 5 0 0     F a x : ( + 9 7 2 ) - 7 2 - 2 7 2 3 5 1 1  

 

 

 

 

 

 

 

  

www.kayainstruments.com

 

Page no. 14 | Appendix No. 1

  

 

 

8

 

Camera Operation 

 

8.1

 

SDIControlPoint 

 
KAYA  Instruments  provides  a  free,  open-source  camera  control  software  (named:  SDIControlPoint).  A 
downloadable file as well as the software’s user manual (KAYA SDIControlPoint Manual.pdf) are available at the 
following address for your convenience:  

cloud.kayainstruments.com/s/SDI

 

 

8.2

 

Terminal Usage 

 

8.2.1

 

Terminal 

 

The Iron SDI can be controlled via a simple terminal connection. All commands consist of ASCI characters. 
 

8.2.2

 

Terminal Settings 

 

The terminal interfaces are either RS232 or RS485 and are connected via the GPIO connector. The default interface 
settings are: 
 

 

115200 baud

 

 

8 bit data

 

 

no parity

 

 

1 stop bit

 

 

no flow control

 

 

The camera accepts commands in text form and responds in text messages. Every command is confirmed by either 
an "OK" or a "FAIL" to indicate whether it had been successfully implemented or not, respectably; errors have to 
be handled by the user or a host software which is used to control the device. Depending on the prompt setting 
one  may  receive  a  "=>"  prompt  after  start  up.  Commands  can  then  be  sent  to  control  the  device  or  receive 
information.  
 

8.2.3

 

General Command Format 

 

If the prompt command  is enabled  the  firmware will send  its prompt ("=> ")  when  awaiting  commands. Every 
command line is accepted as a single text line, terminated by either CR or LF. The command consists of a command 
string, possibly followed by one or more parameters separated by a single space. Depending of the command the 
parameters can come in one of these formats: 
 

 

Signed decimal : -323, 422 

 

Hexadecimal: 0x35ff34aa 

 

String : any_string 

 
The command will be executed and may produce some text output in a single line or more, followed by a single 
status line consisting of either "OK" or "FAIL". In case of failure an error code may be added in the same line, e.g. 
"FAIL 3".The lines sent by the firmware are terminated with both CR and LF. Most commands do have parameters. 
The parameters depend on the given command. 

 

Summary of Contents for IRON SDI

Page 1: ...H Geisenhausenerstr 18 81379 Munich Germany 49 89 780 2970 info skyblue de www skyblue de In Great Britain Zerif Technologies Ltd Winnington House 2 Woodberry Grove Finchley London N12 0DR 44 115 855 7883 info zerif co uk www zerif co uk International Distributors ...

Page 2: ...Terminal Usage 14 8 2 1 Terminal 14 8 2 2 Terminal Settings 14 8 2 3 General Command Format 14 8 3 Commands 15 8 3 1 Help Dialog 15 8 3 2 Set Functions 15 8 3 3 Get Functions 15 8 3 4 List of Commands 15 8 4 RS485 Interface 19 8 4 1 rs485_baud baud_rate 19 8 4 2 rs485_addr address 19 8 4 3 rs485_bc_addr address 20 8 4 4 rs485_bc_master address 20 8 5 Settings Handling 21 8 5 1 save_settings id 21 ...

Page 3: ...color_cross_offset red_offset green_offset blue_offset 33 8 8 24 color_conv c0 c8 33 8 8 25 color_space color space 34 8 8 26 stat_roi width height offsetX offsetY 34 8 8 27 stat_roi_info maxWidth maxHeight widthStep heightStep 34 8 8 28 cam_roi_offset offsetX offsetY 34 8 8 29 cam_roi_offset_info offsetXMax offsetYMax offsetXStep offsetYStep 34 8 9 Defect Pixel Correction 35 8 9 1 dpc flag 35 8 9...

Page 4: ...ode mode 42 8 12 Image statistic commands 42 8 12 1 stat_rgb 42 8 13 Auto Exposure 43 8 13 1 aec enable setPoint speed clmTolerance activeGain activeExposure activeApt maxExposure maxGain reserved 43 8 14 Genlock 45 8 14 1 genlock mode 45 8 14 2 genlock_status 45 8 14 3 genlock_lol_filter time_ms 45 8 14 4 genlock_offset v_offset 46 8 14 5 genlock_offset_info v_offset_phase 46 8 15 SDI Time Code 4...

Page 5: ... in relation to the origin 34 Figure 5 Defect pixel correction position 35 Figure 6 Pushing the Micro BNC connector into place 47 Figure 7 Twisting the connector and securing it in position 47 Figure 8 Serial communication example 48 Figure 9 Firmware terminal initiation 48 Figure 10 Firmware update fail 49 Figure 11 Firmware update process 49 Figure 12 Firmware update succession 49 1 2 List of Ta...

Page 6: ...5 2020 Added the Subsampling mode 1 2 31 12 2020 Added section no 6 Quick Startup Guide Added section no 7 Image Processing Flow Added appendix no 1 firmware update Section no 8 updated new commands and re ordered them 1 3 28 02 2021 Section no 8 added subsection 8 13 Genlock 2 0 02 05 2021 Added Region of Interest support Added RS485 interface support and Multi Camera Mode Added video output time...

Page 7: ... it may drop or fall resulting in injury to persons or the camera Do not use the product if dropped or damaged Otherwise a fire or electric shock may occur Do not touch the product with metallic objects Otherwise a fire or electric shock may occur Do not place the product in dusty or humid environments nor where water may splash Otherwise a fire or electric shock may occur Do not wet the product o...

Page 8: ...under other abnormal and or unreasonable conditions Secondary damages caused by the use of this product or its unusable state business interruption or others Use of this product in any manner that contradicts this manual or malfunctions that may occur due to connection to other devices Damage to this product that is out of our control or failure due to modification Accidents and or third parties t...

Page 9: ...aming can be easily achieved in few easy steps and require little configurations Control of the camera as well as advanced configurations are made easy using the SDIControlPoint software and terminal enabling enhanced streaming and image processing of the cameras outputs Hardware reference is covered in chapter 9 Hardware Reference It is important to note that some parameters might vary slightly c...

Page 10: ... supported formats Table 2 Supported SDI parameters Mode IIRON SDI 265 IRON SDI 305 Video Standard Resolutions supported Frame rates supported fps HD SDI V V ST 292 ST 274 1080i 10 bit 4 2 2 50 59 94 60 1080p 10 bit 4 2 2 RAW 23 98 24 25 29 97 30 ST 292 ST 2048 2 2K 10 bit 4 2 2 23 98 24 25 29 97 30 3G SDI ST 425 1 ST 274 1080p 10 bit 4 2 2 RAW 50 59 94 60 ST 425 1 ST 2048 2 2K 10 bit 4 2 2 47 95 ...

Page 11: ...lPoint application For more details see section 8 Camera Operation Computer With SDIControlPoint KAYA SDI Camera SDI Input Coaxial Cable RS232 Serial Cable Power Cable 12V Power Adapter Figure 1 Camera connections diagram 6 1 1 Power and Image Streaming 1 Connect the camera to an SDI Input using a coaxial cable 2 Connect the camera to a 7 18V power source 3 Video should start streaming to the SDI ...

Page 12: ...ure that the coaxial cable supports the proper output stream bandwidth 3G SDI for 2k video streaming 12G SDI for 4k video streaming 4 Check to see whether the LED on the back of the camera is blinking green The issue may be resolved by power cycling the camera turning power off and back on More LED indicators are described in section no 9 1 Status LED 5 Make sure the SDI input SDI capture card or ...

Page 13: ...oss color_cross_offset black_master color_conv color_space sdi_black sdi_white sdi_range post_bright post_cont post_sat post_hue cam_gain cam_exposure cam_info cam_roi_offset flip awb wb_preset RGB YCbCr gain_red gain_green gain_blue black_red black_green black_blue Defect Pixel Correction dpc dpc_add_pixel dpc_del_pixel dpc_save dpc_load video_mo de downscale aec stat_roi lut_enable lut_mode lut_...

Page 14: ...n OK or a FAIL to indicate whether it had been successfully implemented or not respectably errors have to be handled by the user or a host software which is used to control the device Depending on the prompt setting one may receive a prompt after start up Commands can then be sent to control the device or receive information 8 2 3 General Command Format If the prompt command is enabled the firmwar...

Page 15: ...his string can be parsed by external applications to extract the current settings out of the system Example Command video_mode Response video_mode 5 returned OK returned 8 3 4 List of Commands Command Parameters Description 1 help Gives a full list of supported commands 2 rs485_baud baud_rate Sets the baud rate of the serial communication 3 rs485_addr address Sets the unique device serial address ...

Page 16: ...e 32 wb_threshold threshold Sets wb maximum calculation threshold 33 awb flag Enable continuous white balance adjustment 34 wb_preset id Sets calibrated white balance presets 35 gain_red gain Sets gain factor for red component for selected output channel 36 gain_blue gain Sets gain factor for blue component for selected output channel 37 gain_green gain Sets gain factor for green component for sel...

Page 17: ...te Interpolates all look up tables based on the given sample point 65 lut_interpolate_red Interpolates the red look up table based on the given sample points 66 lut_interpolate_green Interpolates the green look up table based on the given sample points 67 lut_interpolate_blue Interpolates the blue look up table based on the given sample points 68 lut_reset_master Clears all color channels look up ...

Page 18: ...es in the unstable genlock signals 80 genlock_offset v_offset The vertical position offset that is added to the reference sync signal 81 genlock_offset_info v_offset_phase The vertical position offset that is added to the reference sync signal 82 timecode hour minute second Sets SDI time code which is embedded into the SDI signal 83 timecode_hold flag This command can be used to hold the timecode ...

Page 19: ...cation address command parameter 8 4 1 rs485_baud baud_rate Sets the baud rate for the RS485 terminal interface Possible baud rates are Baud Rate 1 9600 2 14400 3 19200 4 57600 5 115200 defualt Remarks 1 It is advised to leave the baud rate at 115200 default for faster device response 2 Setting RS485 baud rate will also change the RS232 interface baud rate 8 4 2 rs485_addr address Sets the address...

Page 20: ... broadcast group 8 to new broadcast address 9 8 rs485_bc_addr 9 8 4 4 rs485_bc_master address This command enables the broadcast master mode on a camera with a given device address If the command is transmitted as a get command without an argument it will reply with a flag 0 or 1 rather than the broadcast master address The flag indicates whether this camera currently is the broadcast master or no...

Page 21: ...mera settings There are 8 optional sets of settings available with an id range of 0 7 Only previously stored settings configuration will be applied and return an OK while other commands will return a FAIL Remarks 1 load_settings command with no parameters will load the first configuration Example load_settings 2 8 5 3 default_settings id The load_settings command selects the default settings confi...

Page 22: ...le should be uploaded using XMODEM protocol via standard serial port interface Please see Appendix 1 Firmware Update for a detailed explanation Remarks 1 Only official firmware update file provided by KAYA Instruments should be used to update camera Other binary files may or may not harm the camera and make it un usable 8 6 4 version Dumps a detailed version information about the system with syste...

Page 23: ...mmand must be used after a name change for it to take permanent effect Example name New_device_name_1 8 6 6 flip mode Sets the image flip or rotation mode Mode Function 0 reset Normal no flip 1 Vertical flip 2 Horizontal flip 3 Rotated by 180 8 6 7 temp sensor id Dumps camera temperature values in degree centigrade The output has the format temp id value name Temperature Sensor ID Function 0 Proce...

Page 24: ...0 8 7 2 cam_exposure time Sets the exposure time shutter width in microseconds µsec in which sensor is exposed to light Remarks 1 The exposure time might be adjusted if video mode is changed using video_mode command and the value exceeds the maximum allowed value for the new video mode 2 Exposure can be read at any time also when the auto exposure control is enabled Example Example to set exposure...

Page 25: ...85 bus by sending it to device address 100 the fail safe device address Each device will wait in turn before sending its ID string The higher value the RS485 address of the device the longer the device will wait before sending its stats this ensures that the bus does not get corrupted Each device will report the following parameters RS485 ID RS485 Broadcast Address and RS485 Broadcast Master Devic...

Page 26: ...FHD 59 94 14 1920x1080p FHD 59 94 15 2048x1080p 2K 30 16 2048x1080p 2K 25 17 2048x1080p 2K 24 18 2048x1080p 2K 23 98 19 2048x1080p 2K 29 97 20 2048x1080p 2K 50 21 2048x1080p 2K 60 22 2048x1080p 2K 59 94 23 2048x1080p 2K 48 24 2048x1080p 2K 47 96 25 3840x2160p UHD 30 26 3840x2160p UHD 25 27 3840x2160p UHD 24 28 3840x2160p UHD 23 98 29 3840x2160p UHD 29 97 30 3840x2160p UHD 50 31 3840x2160p UHD 60 3...

Page 27: ...ng table lists video modes which support the downscale Mode ID Mode 4 1920x1080p 30 5 1920x1080p 25 6 1920x1080p 24 7 1920x1080p 23 98 8 1920x1080p 29 97 9 1920x1080p 50 10 1920x1080p 60 11 1920x1080i 60 12 1920x1080i 50 13 1920x1080i 59 94 14 1920x1080p 59 94 15 2048x1080p 30 16 2048x1080p 25 17 2048x1080p 24 18 2048x1080p 23 98 19 2048x1080p 29 97 20 2048x1080p 50 21 2048x1080p 60 22 2048x1080p ...

Page 28: ...alue of 0 will result in an SDI white value of 940 SMTP conform When changing this value the white level on the SDI interface can be set different than 40 not SMTP conform This value changes the SDI range limiter and will stretch output values to adapt to the new range Value Reset Minimal Maximal offset 0 80 79 8 8 5 sdi_range flag Sets the SDI output range type Flag Mode Digital Code Range Note 0...

Page 29: ... 0 post_cont 157 8 8 8 post_sat factor Sets post processing color saturation Cb r_out Cb r factor 128 Neutral value is 128 Value Reset Minimal Maximal factor 128 0 255 Example Set a saturation value of 1 23 input value should be 157 round 1 23 128 0 post_sat 157 8 8 9 post_hue offset Sets post processing color hue offset angle Cb Cb cos offset 90 128 Cr sin offset 90 128 Cr Cb sin offset 90 128 Cr...

Page 30: ...alance adjustment Compensate sensor output colors to true colors The algorithm works on the assumption that average color of image in selected ROI is gray Enable Function 0 disable 1 enable 8 8 13 wb_preset id Sets calibrated white balance presets gains and color cross matrices List of calibrated presets are described in the following table ID Illumination Color temperature 0 disable preset 1 hori...

Page 31: ...set blue Sets the black level offset for red green and blue components for selected output channel The processing is done in linear RGB domain pre gamma red_out red_in offset red 4095 4095 offset red Value Reset Minimal Maximal offset 0 2047 2048 Example 1 Set black level for all components to 100 black_master 100 Example 2 Set black level for red to 10 for green to 20 and blue to 30 black_master ...

Page 32: ... 1 Set flare value of 0 1 10 input value should be 6554 round 0 1 65536 0 flare 6554 6554 6554 Example 2 Set same flare level for all components flare 6554 8 8 22 color_cross c0 c8 Sets the color cross talk matrix which can be used for correction of cross talk effects and color space shifts The cross talk compensation unit performs a regular RGB to R G B color space conversion to compensate the cr...

Page 33: ...set is applied after the matrix multiplication A value of zero is treated as no offset Value Reset Minimal Maximal red_offset 0 2048 2047 green_offset 0 2048 2047 blue_offset 0 2048 2047 8 8 24 color_conv c0 c8 Sets the color conversion matrix The following formula is used for the conversion Y c0 R c1 G c2 B 4096 64 Cb c3 R c4 G c5 B 4096 512 Cr c6 R c7 G c8 B 4096 512 Value Reset Minimal Maximal ...

Page 34: ...ault ROI defined to be the maximum possible area i e the horizontal and vertical offsets are 0 and the ROI width and height as the output image size 8 8 27 stat_roi_info maxWidth maxHeight widthStep heightStep Reports the maximum allowed values for stat_roi command parameters The values depend on the selected video mode 8 8 28 cam_roi_offset offsetX offsetY While the image resolution is defined by...

Page 35: ...ction for Mono and Color sensor is slightly different and described as follows The defect pixel 𝑃 𝑥 𝑦 value will be the average value of two pixels from both sides of pixel 𝑃 𝑥 𝑦 in the same row corresponding to the same Bayer color element Figure 5 Defect pixel correction position 8 9 1 dpc flag Enable deflect pixel correction Flag Function 0 No correction 1 reset Correction enabled 8 9 2 dpc_add...

Page 36: ...ave Saves defect pixel table to persistent memory 8 9 5 dpc_load Loads defect pixel table from persistent memory 8 10 Knee Function 8 10 1 knee flag knee_point knee_slope white_clip Knee function for highlight control 3 parameters can be set for the knee function Value Reset Minimal Maximal flag enable 0 off 0 1 knee_point 85 1 100 knee_slope 140 100 1600 white_clip 109 100 109 Example Enable knee...

Page 37: ...ific color Lookup table can be set in one of the following methods 1 LUTs can be programmed using up to 48 sample points All intermediate values are calculated with a spline interpolator see lut_sample_ channel commands 2 LUTs can be programmed by specifying a set of parameters which will be used to calculate and apply a gamma curve according to REC 709 standard see lut_fun_rec709 command 3 LUTs c...

Page 38: ...preset storage for the current LUT interpolator There are up to 5 presets which can be modified Index Factory preset 0 Linear 1 Linear 2 Linear 3 Linear 4 Linear Example Select lut preset 1 lut_preset 1 8 11 4 lut_sample_master xi_0 yi_0 xi_7 yi_7 Defines the sample points in a lookup table for all colors The x value is the input value the y value is output Value Minimal Maximal xi_n 0 5904 Yi_n 0...

Page 39: ...l in values between the specified samples lut_enable 0 1 enable lut 8 11 5 lut_sample_red xi_0 yi_0 xi_7 yi_7 Same as lut_sample_master but only for red component 8 11 6 lut_sample_green xi_0 yi_0 xi_7 yi_7 Same as lut_sample_master but only for green component 8 11 7 lut_sample_blue xi_0 yi_0 xi_7 yi_7 Same as lut_sample_master but only for red component 8 11 8 lut_interpolate Interpolates all lo...

Page 40: ... gamma curve for all color channels Value Minimal Maximal REC 709 Threshold 0 1000 18 Contrast linear 0 20000 4500 Brightness linear 1000 1000 0 Contrast non linear 0 10000 1099 Gamma non linear 1100 3000 2222 Brightness nonlinear 1000 1000 99 The following image shows the normalized REC 709 gamma curve and it s transition from linear to non linear power function part The linear part ranges from 0...

Page 41: ...ks 1 The values are normalized to a range from 0 0 to 1 0 and multiplied by a scaling coefficient of 1000 Example Compute LUT sample points according to REC 709 and store in preset 1 then start curve interpolation threshold 18 0 018 1000 linear contrast 4500 4 5 1000 linear brightness 0 0 1000 contrast 1099 1 099 1000 gamma 2222 2 222 1000 brightness 99 0 099 1000 lut_enable 0 0 disable lut lut_mo...

Page 42: ...e default REC 709 gamma curve Example lut_mode 1 select lut mode 1 Fast gamma mode lut_enable 0 1 make sure lut is enabled lut_fast_gamma 2222 8 11 18 lut_fixed_mode mode The fixed gamma mode contains three presets which are shown in the table below Mode Description 0 default REC 709 gamma curve 1 PQ gamma curve specified in ITU R BT 2100 which can be used for HDR content 2 HLG gamma curve specifi...

Page 43: ...nescence level whilst the activeGain enables the auto gain algorithm and the activeExposure enables the auto exposure algorithm The maxGain parameter can be used to change the maximum sensor gain used by the algorithm Notice the high maxGain may result in grainy saturate image Parameter Description Minimal Maximal Default Remarks enable Auto brightness compensation com 0 1 0 0 Disable 1 Enable set...

Page 44: ...in other parameters with same value aec 1 1234 Example 3 Enable aec with luminance 1234 Set speed at 25 input value be 250 round 0 25 1000 Set calculation tolerance at 90 input value should be 900 round 0 9 1000 All other parameters remain with the same value aec 1 1234 8 Example 4 Activate auto exposure AND auto gain Limit gain to 12 3x input value should be 12300 round 12 3 1000 Limit exposure t...

Page 45: ...ry to sync on external tri level sync signal Camera will not output any image unless genlock is synchronized The configured video mode see video_mode command must match the input sync signal for successful genlock operation 8 14 2 genlock_status This command is used to check the current genlock status Status Description 0 Genlock is disabled or genlock is enabled and successfully synchronized on e...

Page 46: ...e sync signal and can be adjusted 8 15 SDI Time Code 8 15 1 timecode hour minute second Sets SDI time code which is embedded into the SDI output The time code can be set manually Example 1 Command timecode get current system time Response timecode 0 57 24 OK Example 2 Command timecode 1 1 1 set sdi time code to 1h 1m 1s Response OK system acknowledgement 8 15 2 timecode_hold flag This command can ...

Page 47: ...BNC cable first need to align the pin on the male end with the L shaped track on the female connector of the Coaxial cable Once aligned the connector should be pushed in place see figure no 1 Only mild pressure should be applied to achieve this operation otherwise it may cause unnecessary damage to the cable or the card Figure 6 Pushing the Micro BNC connector into place Once pushed all the way th...

Page 48: ...firmware from KAYA s website 6 Please make sure to download the correct FW for the camera that you have as installing an incorrect FW may cause the camera to malfunction 7 Open serial emulated terminal usage of Tera Term terminal is recommended and set serial communication protocol to baud rate 115200 8bit data 1bit start 1bit stop and no flow control For example in the Tera Term terminal this sho...

Page 49: ...ult in an appropriate message Figure 12 Firmware update succession To apply the new firmware the camera should be power cycled by disconnecting the power supply from the camera and connecting it back after a few seconds After camera has been powered it should be kept at least 30 seconds with power before new firmware will be applied Sky Blue Microsystems GmbH Geisenhausenerstr 18 81379 Munich Germ...

Reviews:

No comments

Brands by name

Popular brands

Load more brands