Kramer-electronics VP-790 Manuel d'utilisateur

KRAMER ELECTRONICS LTD. RS-232 PROTOCOL GUIDE VP-790 Protocol Document P/N: 2900-300172 Rev 2

6 VP-790 Protocol - Communication 16 = 0x10 bytes. The logical header (line 1) indicates a payload of 16 bytes application header plus 16 bytes of

96 VP-790 Protocol - API Functions 2.89.2 byOsdPtzAspectGet API index: 3238 Retrieves the Aspect Lock setting from cache or from the SPD. Input Pa

VP-790 Protocol – API Functions 97 2.90.2 395BbyOsdPtzEnableGet API index: 3221 Retrieves the PTZ enable setting from cache or from the SPD. Inpu

98 VP-790 Protocol - API Functions 2.91.3 byOsdPtzZoomHSave API index: 3233 Saves the horizontal zoom factor from cache into the SPD. Input Parame

VP-790 Protocol – API Functions 99 2.93 101BPTZ Settings Scope 2.93.1 402BbyOsdPtzSettingSet API index: 3222 Sets the scope of the PTZ settings

100 VP-790 Protocol - API Functions 2.94 PTZ Tilt 2.94.1 byOsdPtzTiltSet API index: 3228 Sets the Tilt position. Input Parameters Name Type Ra

VP-790 Protocol – API Functions 101 2.95 103BPTZ Vertical Zoom 2.95.1 408BbyOsdPtzZoomVSet API index: 3234 Zooms/Shrinks the image in vertical

102 VP-790 Protocol - API Functions 2.96 Reset Blend Width, Offset and Black Level Uplift 2.96.1 byOSDEdgeBlendReset API index: 3249 The blend wi

VP-790 Protocol – API Functions 103 2.98.2 414BbyOsdR/G/BOffsetGet API indices: 2810/2813/2816 Retrieves the R/G/B offset from either cache or th

104 VP-790 Protocol - API Functions 2.99.2 byOsdR/G/BGainGet API indices: 2801/2804/2807 Retrieves the gain value from either the cache or the SPD

VP-790 Protocol – API Functions 105 2.100.2 420BbyOsdRotationGet API index: 844 Retrieves the Pin/Barrel distortion value. Input Parameters Name

VP-790 Protocol – Communication 7 For the API call the data is 0 = 0x00 bytes long since there are no parameters passed. The data package (line 3)

106 VP-790 Protocol - API Functions 2.101.2 byOsdColorGet API index: 129 Retrieves the color saturation from either cache or the SPD. Input Parame

VP-790 Protocol – API Functions 107 2.103 111BS-Curve Value 2.103.1 426BbyOsdEdgeBlendScurveValueSet API index: 3115 Sets the S-curve value. Inp

108 VP-790 Protocol - API Functions 2.104 SDI Audio Channel Mapping 2.104.1 byOsdSdiAudioChannelSet API index: 3280 Sets the SDI audio channel ma

VP-790 Protocol – API Functions 109 2.105 113BSDI Audio SPDIF Routing 2.105.1 432BbyOsdSdiOnSpdifSet API index: 3283 Sets whether SDI audio is o

110 VP-790 Protocol - API Functions 2.106 SDI Output Data Map 2.106.1 byOsdSdiDataMapSet API index: 3265 Sets the SDI output mode. Input Parame

VP-790 Protocol – API Functions 111 2.107 115BSelect Warp Application 2.107.1 438BbyOsdProjectionAppsSet API index: 1645 Selects the embedded wa

112 VP-790 Protocol - API Functions 2.108 Select Warp Map Slot 2.108.1 byOsdUserMapSet API index: 139 Selects the embedded warp API. Input Parame

VP-790 Protocol – API Functions 113 2.109 117BSharpness 2.109.1 444BbyOsdSharpnessSet API index: 130 Sets the characteristic of the sharpness fi

114 VP-790 Protocol - API Functions 2.110 Sync Mode VGA Output 2.110.1 byOsdOutputSyncModeSet API index: 3246 Switches between separate, composit

VP-790 Protocol – API Functions 115 2.111 119BTest Pattern Selection 2.111.1 450BbyOsdTestPatternSet API index: 3320 Selects the test pattern to

8 VP-790 Protocol - Communication The return value(s) of this API function is the error code of BYTE type, i.e. a 1 byte value. It is 0x00 if the c

116 VP-790 Protocol - API Functions 2.112 TRNR 2.112.1 byOsdTRNRSet API index: 239 Sets the level of the TRNR (temporal recursive noise reduction

VP-790 Protocol – API Functions 117 2.113 121BUser 2.113.1 456BbyOsdCurrentUserSet API index: 2947 Selectes the current user profile. Input Para

118 VP-790 Protocol - API Functions 2.114 User Name 2.114.1 byOsdUserRenameSet API index: 2953 Renames one of the user profiles. Input Parameters

VP-790 Protocol – API Functions 119 2.115 123BVertical Keystone 2.115.1 462BbyOsdVKeystoneSet API index: 336 Selects the embedded warp API. Inpu

120 VP-790 Protocol - API Functions 2.116 Vertical Position 2.116.1 byOsdMainVerticalSet API index: 365 Sets the vertical position of the input i

VP-790 Protocol – API Functions 121 2.117 125BVT Filter Recursion Setting 2.117.1 468BbyOsdVTRecursionSet API index: 3243 Switches the recursion

122 VP-790 Protocol - API Functions 2.118 VT Filter Strength 2.118.1 byOsdVTStrengthSet API index: 3240 Sets the strength of the vertical tempora

VP-790 Protocol – Communication 9 Direction RS232 data PC sends command 53 41 50 01 FF FF FF FF 00 00 00 20 00 00 00 00 54 50 01 00 00 00 00 00

10 VP-790 Protocol - Communication Direction RS232 data PC sends command 53 41 50 01 FF FF FF FF 00 00 00 2E 00 00 00 00 54 50 01 00 00 00 00

VP-790 Protocol – API Functions 11 2 API Functions APIs may have a “Get”, “Set” and “Save” function. “Get” reads values, “Set” writes values into

12 VP-790 Protocol - API Functions 2.1.3 byOsdSdiLevBStreamSave API index: 3264 Saves the Stream setting from cache into the SPD. Input Parameters

VP-790 Protocol – API Functions 13 2.3 11B4-Corner Lower Left Corner 2.3.1 138Bby4CornerX3SetValue API index: 784 Moves the x-position of the lo

14 VP-790 Protocol - API Functions 2.3.4 byOSD4CornerY3Get API index: 739 Retrieves the position. Input Parameters Name Type Range Description

VP-790 Protocol – API Functions 15 2.4.3 144Bby4CornerY4SetValue API index: 787 Moves the y-position of the lower right corner. The value is stor

VP-790 Protocol – Communication i Contents 1 Communication 1 1.1 API Call 1 1.2 Handshake 2 1.3 API Return 2 1.4 Data Types 3 1.5 UART

16 VP-790 Protocol - API Functions 2.5.2 byOsd4CornerX1Get API index: 734 Retrieves the position. Input Parameters Name Type Range Description

VP-790 Protocol – API Functions 17 2.6 14B4-Corner Upper Right Corner 2.6.1 150Bby4CornerX2SetValue API index: 782 Moves the x-position of the u

18 VP-790 Protocol - API Functions 2.6.4 byOSD4CornerY2Get API index: 737 Retrieves the position. Input Parameters Name Type Range Description

VP-790 Protocol – API Functions 19 2.8 16BAnnounce Data 2.8.1 157BbyOsdSetAnnounceAuxData API index: 4210. Defines a string to be sent. Input Pa

20 VP-790 Protocol - API Functions 2.9 Announce Server Port 2.9.1 byOsdSetAnnounceServerPort API index: 4207 Set the Announce Message server port

VP-790 Protocol – API Functions 21 2.10 18BAnnounce Data Repeat Period 2.10.1 163BbyOsdSetAnnounceRepeatPeriod API index: 4213 Set the period af

22 VP-790 Protocol - API Functions 2.11 Announce Server IP Address 2.11.1 byOsdSetAnnounceServerIPAddress API index: 4204 Set the IP address of t

VP-790 Protocol – API Functions 23 2.12 20BAuto Setup 2.12.1 169BbyOsdAutoConfigSet API index: 417 Initiates auto setup of VGA signal. Input Par

24 VP-790 Protocol - API Functions 2.13.3 byOsdMultipleUnitAutozoomSave API index: 3171 Saves the AutoZoom status from cache into the SPD. Input P

VP-790 Protocol – API Functions 25 2.15 23BBlack-Level 2.15.1 176BbyOsdBlackLevelSet API index: 104 (sic!) Sets the black level offset. Input Pa

ii VP-790 Protocol - Communication 2.43 Horizontal Keystone 53 2.44 Horizontal Position 54 2.45 Hue 55 2.46 Input 56 2.47 Input Gamma 57 2

26 VP-790 Protocol - API Functions 2.16 Black-Level Offset Compensation 2.16.1 byOsdBlackLevelOffsetSet API index: 148 Sets the black level offse

VP-790 Protocol – API Functions 27 2.17 25BBlack Level Uplift 2.17.1 182BbyOsdEdgeBlendBlackLevelTopl/Top/Topr/Midl/Mid/Midr/Botl/Bot/BotrSet AP

28 VP-790 Protocol - API Functions 2.18 CCS 2.18.1 byOsdCCSSet API index: 2975 Switches CCS (Cross Colour Suppression) filter on/off for the CVBS

VP-790 Protocol – API Functions 29 2.19 27BContrast 2.19.1 188BbyOsdContrastSet API index: 124 Sets the contrast (gain). Input Parameters Name

30 VP-790 Protocol - API Functions 2.20 Clock 2.20.1 byOsdAbsoluteClockSet API index: 2938 Sets the absolute clock value for sampling the VGA inp

VP-790 Protocol – API Functions 31 2.20.4 194BbyOsdAbsoluteClockSave API index: 2940 Saves the absolute clock value from cache into the SPD. Inpu

32 VP-790 Protocol - API Functions 2.21.3 byOsdColorTempSave API index: 350 Saves the color temperature value from the cache into the SPD. Input P

VP-790 Protocol – API Functions 33 2.23 31BComponent Type 2.23.1 201BbyOsdComponentTypeSet API index: 2962 Sets the component input type, i.e. c

34 VP-790 Protocol - API Functions 2.24 CTI Level 2.24.1 byOsdSTICTISet API index: 611 Sets the level of the CTI (chroma transient improvement) f

VP-790 Protocol – API Functions 35 2.25 33BDetail Enhancement 2.25.1 207BbyOsdDetailSet API index: 133 Sets the level of the detail enhancement

VP-790 Protocol – Communication iii 2.97 Reset Profile 102 2.98 R/G/B Bias 102 2.99 R/G/B Gain 103 2.100 Rotation 104 2.101 Saturation 1

36 VP-790 Protocol - API Functions 2.26 Display Mode 2.26.1 byOsdProcessingModeSet API index: 2965 Sets the processing mode. Input Parameters Nam

VP-790 Protocol – API Functions 37 2.27 35BDVI Equalization 2.27.1 213BbyOsdDVI1EQSet API index: 2832 Sets the DVI port equalization Input Param

38 VP-790 Protocol - API Functions 2.28 DVI Input Port configuration analog/digital 2.28.1 byOsdDVIIPortSet API index: 3300 Switches between proc

VP-790 Protocol – API Functions 39 2.29 37BDVI Output Color Space 2.29.1 219BbyOsdDviOutCscSet API index: 3250 Sets DVI Output Color Space. In

40 VP-790 Protocol - API Functions 2.30 DVI Output Range 2.30.1 byOsdDviOutRangeSet API index: 3253 Sets DVI Output Range. Input Parameters Nam

VP-790 Protocol – API Functions 41 2.31 39BEdge Blend Bottom Border 2.31.1 225BbyOsdEdgeBlendBotBorderSet API index: 3121 Sets the edge blend bo

42 VP-790 Protocol - API Functions 2.32 Edge Blend Bottom Border Offset 2.32.1 byOsdEdgeBlendBotOffsetSet API index: 3178 Sets the edge blend bo

VP-790 Protocol – API Functions 43 2.33 41BEdge Blend Left Border 2.33.1 231BbyOsdEdgeBlendLeftBorderSet API index: 3124 Sets the edge blend lef

44 VP-790 Protocol - API Functions 2.34 Edge Blend Left Border Offset 2.34.1 byOsdEdgeBlendLeftOffsetSet API index: 3181 Sets the edge blend left

VP-790 Protocol – API Functions 45 2.35 43BEdge Blend Right Border 2.35.1 237BbyOsdEdgeBlendRightBorderSet API index: 3127 Sets the edge blend r

VP-790 Protocol – Communication 1 1 Communication 1.1 2BAPI Call Communication between the PC and the Scaler Board is through remote API calls a

46 VP-790 Protocol - API Functions 2.36 Edge Blend Right Border Offset 2.36.1 byOsdEdgeBlendRightOffsetSet API index: 3184 Sets the edge blend ri

VP-790 Protocol – API Functions 47 2.37 45BEdge Blend Top Border 2.37.1 243BbyOsdEdgeBlendTopBorderSet API index: 3118 Sets the edge blend top b

48 VP-790 Protocol - API Functions 2.38 Edge Blend Top Border Offset 2.38.1 byOsdEdgeBlendTopOffsetSet API index: 3175 Sets the edge blend top bo

VP-790 Protocol – API Functions 49 2.39 47BEdge control 2.39.1 249BbyOsdLeft/Right/Top/BottomEdgeSet API indices: 2925/2928/2931/2934 Moves left

50 VP-790 Protocol - API Functions 2.40 Frame Rate Settings Availability Control 2.40.1 byOsdAllowedFrameRateSet API index: 3276 Makes 24/48Hz fr

VP-790 Protocol – API Functions 51 2.41 49BHDMI/DVI Input Color Space 2.41.1 255BbyOsdDviInCSpaceSet API index: 3256 Sets HDMI/DVI Input Color

52 VP-790 Protocol - API Functions 2.42 HDMI/DVI Input Range 2.42.1 byOsdDviInRangeSet API index: 3259 Sets HDMI/DVI Input Range. Input Paramet

VP-790 Protocol – API Functions 53 2.43 51BHorizontal Keystone 2.43.1 261BbyOsdHKeystoneSet API index: 332 Selects the embedded warp API. Input

54 VP-790 Protocol - API Functions 2.44 Horizontal Position 2.44.1 byOsdMainHorizontalSet API index: 362 Sets the horizontal position of the inpu

VP-790 Protocol – API Functions 55 2.45 53BHue 2.45.1 267BbyOsdHueSet API index: 151 Sets the hue value. Input Parameters Name Type Range Des

2 VP-790 Protocol - Communication The data to be sent is (hex): 53 41 50 01 FF FF FF FF 00 00 00 20 00 00 00 00 54 50 01 00 00 00 00 00 00 00 00

56 VP-790 Protocol - API Functions 2.46 Input 2.46.1 byOsdInputFormatSet API index: 318 Sets the main input channel given by the controlling appl

VP-790 Protocol – API Functions 57 2.46.3 272BbyOsdInputFormatSave API index: 319 Saves the main input channel from cache into the SPD. Input Par

58 VP-790 Protocol - API Functions 2.47.3 byOsdGammaInSave API index: 344 Saves the input gamma value from cache into the SPD. Input Parameters No

VP-790 Protocol – API Functions 59 2.49 57BI/O Lock 2.49.1 279BbyOSDIoLockSet API index: 2978 Sets the Lock Type between PLL modulation and free

60 VP-790 Protocol - API Functions 2.50 IP Address 2.50.1 bySetStaticIPAddr API index: 111 Sets the static IP address and saves the setting in th

VP-790 Protocol – API Functions 61 2.51.2 285BbyGetDHCPStatus API index: 84 Retrieves the IP address type from the SPD. Input Parameters Name Ty

62 VP-790 Protocol - API Functions 2.53 LED Screen Window Size 2.53.1 byOsdOutWinLeft/Right/Top/BottomEdgeSet API indices: 3308/3311/3314/3317 C

VP-790 Protocol – API Functions 63 2.54 62BLED Screen Window Size Enabling 2.54.1 292BbyOsdOutWinSizeEnableSetSave API index: 3306 Enable Window

64 VP-790 Protocol - API Functions 2.56 LTI Level 2.56.1 byOsdSTILTISet API index: 608 Sets the level of the LTI (Luma Transient Improvement) fil

VP-790 Protocol – API Functions 65 2.57 65BMenu Display Time 2.57.1 298BbyOsdMenuTimeSet API index: 2968 Sets menu display timeout. Input Parame

VP-790 Protocol – Communication 3 Example: The Scaler Board answers to the BYTE byOSDBrighntessSet(UWORD32 u32_value) API call. The return value i

66 VP-790 Protocol - API Functions 2.58 Menu Position 2.58.1 byOsdMenuPositionSet API index: 2971 Sets menu position on screen. Input Parameters

VP-790 Protocol – API Functions 67 2.59 67BMNR 2.59.1 304BbyOsdCNRSet API index: 251 Sets the level of the MNR (MPEG Codec noise reduction) algo

68 VP-790 Protocol - API Functions 2.60 Moving Test Pattern Background Color 2.60.1 byOsdTpgBgColSet API index: 3293 Sets the background color of

VP-790 Protocol – API Functions 69 If attempting to set foreground and background color to the same tone an error message is reported E_OUT_OF_R

70 VP-790 Protocol - API Functions 2.61.3 byOsdTpgFgColSave API index: 3292 Saves the foreground color of the moving test pattern. Input Parameter

VP-790 Protocol – API Functions 71 2.62.3 315BbyOsdTpgWidthSave API index: 3298 Saves the line thickness of the moving test pattern from cache in

72 VP-790 Protocol - API Functions 2.64 Multiple Unit Height 2.64.1 byOsdMultipleUnitHeightSet API index: 3103 Sets the number of units in vertic

VP-790 Protocol – API Functions 73 2.65 73BMultiple Unit Horizontal Set 2.65.1 322BbyOsdMultipleUnitHorizontalSet API index: 3106 Sets the horiz

74 VP-790 Protocol - API Functions 2.66 Multiple Unit Vertical Set 2.66.1 byOsdMultipleUnitVerticalSet API index: 3109 Sets the vertical address

VP-790 Protocol – API Functions 75 2.67 75BMultiple Unit Width 2.67.1 328BbyOsdMultipleUnitWidthSet API index: 3100 Sets the number of units in

4 VP-790 Protocol - Communication 1.5 UART Connector and UART Configuration The board UART connector is PL9 or SK18. PL9 Connector Type: 3-way 0.

76 VP-790 Protocol - API Functions 2.68 Native Color Temp 2.68.1 byOsdNativeColorTempSet API index: 2827 Sets the Color Temperature of the output

VP-790 Protocol – API Functions 77 2.69 77BNetmask 2.69.1 334BbySetSubnetMask API index: 113 Sets the netmask and saves the setting in the SPD i

78 VP-790 Protocol - API Functions 2.71 Optimize for Display 2.71.1 byOsdOptimiseSet API index: 2818 Activates communication with a display and s

VP-790 Protocol – API Functions 79 2.71.4 340BbyOsdEnableGet API index: 3374 Retrieves the OSD enabling setting. Input Parameters Name Type Ran

80 VP-790 Protocol - API Functions 2.72.2 byOsdLanguageGet API index: 447 Retrieves the OSD language setting from either cache or the SPD. Input P

VP-790 Protocol – API Functions 81 Name Type Range Description Status BYTE 0x00-0xFF 0 if successful, error code otherwise Value UWORD32 0

82 VP-790 Protocol - API Functions 2.75 Output Frame Rate 2.75.1 byOsdFrameRateSet API index: 2821 Sets the Ouput Mode Frame Rate. Input Paramete

VP-790 Protocol – API Functions 83 2.76 84BOutput Gamma 2.76.1 353BbyOsdGammaOutSet API index: 346 Sets the Ouput Gamma. Input Parameters Name

84 VP-790 Protocol - API Functions 2.77 Output Mode 2.77.1 byOsdOuputFormatSet API index: 324 Sets the Ouput Mode Resolution. Input Parameters Na

VP-790 Protocol – API Functions 85 2.77.3 358BbyOsdOutputFormatSave API index: 325 Saves the Output Mode Resolution setting from cache into the S

VP-790 Protocol – Communication 5 1.7 8BExamples The following examples are used to explain how the API calls and protocol work: • Change the Co

86 VP-790 Protocol - API Functions 2.78.3 byOsdOverscanSave API index: 2946 Saves the overscan setting from cache into the SPD. Input Parameters N

VP-790 Protocol – API Functions 87 2.80 88BPicture Format 2.80.1 365BbyOsdAspectRatioSet API index: 186 Sets the picture format / aspect ratio t

88 VP-790 Protocol - API Functions 2.81 Pin/Barrel 2.81.1 byOsdPinBarrelSet API index: 476 Sets the Pin/Barrel distortion value. Input Parameters

VP-790 Protocol – API Functions 89 2.82 90BPIP H-Pos 2.82.1 371BbyOsdPipXSet API index: 3211 Sets the PiP Horizontal Position. Input Parameters

90 VP-790 Protocol - API Functions 2.83 PIP Input 2.83.1 byOsdPipInputFormatSet API index: 321 Sets the PiP input channel. Input Parameters Name

VP-790 Protocol – API Functions 91 2.84 92BPIP Mode 2.84.1 377BbyOsdPipOnOffSet API index: 315 Sets the PiP mode. Input Parameters Name Type R

92 VP-790 Protocol - API Functions 2.85 PiP/Multiple Unit Operation Mode 2.85.1 byOsdPIPEBOperationModeSet API index: 3172 Switches between PiP m

VP-790 Protocol – API Functions 93 2.86 94BPIP Position 2.86.1 383BbyOsdPipPosSet API index: 368 Sets the PiP Position. Input Parameters Name T

94 VP-790 Protocol - API Functions 2.87 PIP Size 2.87.1 byOsdAbsolutePipSizeSetSave API index: 2974 Sets the PiP mode and saves the setting in th

VP-790 Protocol – API Functions 95 2.88.2 389BbyOsdPipYGet API index: 3215 Retrieves the PiP Vertical Position from either cache or the SPD. Inpu