Dell UP3017 Application Programming Interface Guide
Dell UP3017 Manual
![]() |
View all Dell UP3017 manuals
Add to My Manuals
Save this manual to your list of manuals |
Dell UP3017 manual content summary:
- Dell UP3017 | Application Programming Interface Guide - Page 1
Dell SDK for Monitors Application Programming Interface Guide for SDK version 1.3 - Dell UP3017 | Application Programming Interface Guide - Page 2
. Reproduction of these materials in any manner whatsoever without the written permission of Dell Inc. is strictly forbidden. Trademarks used in this text: Dell™, the DELL logo, and UltraShrap™ are trademarks of Dell Inc.; Microsoft®, Windows®, and the Windows start button logo are either trademarks - Dell UP3017 | Application Programming Interface Guide - Page 3
Contents Introduction 6 Monitor Management 7 GetAvailableMonitors 7 ConnectMonitor 7 DisconnectMonitor 8 SetAssetTag 8 GetAssetTag 9 GetMonitorName 9 GetMonitorSerialNumber 10 GetBacklightHours 10 Power Management 11 GetPowerState 11 SetPowerState 12 GetPowerLED 12 SetPowerLED 13 - Dell UP3017 | Application Programming Interface Guide - Page 4
25 SetColorTemp 26 GetColorSpaceCaps 27 GetColorSpaceState 27 SetColorSpaceState 28 GetInputColorFormat 29 SetInputColorFormat 29 GetColorPresetCaps 30 GetColorPreset 31 SetColorPreset 32 GetCustomColor 33 SetCustomColor 34 GetGammaMode 35 SetGammaMode 35 GetUniformityCompensation 36 - Dell UP3017 | Application Programming Interface Guide - Page 5
PIP/PBP Management 46 GetPxPMode 46 SetPxPMode 47 GetPxPSubInput 47 SetPxPSubInput 48 GetPxPLocation 49 SetPxPLocation 50 OSD 51 GetOSDTransparency 51 SetOSDTransparency 51 GetOSDLanguage 52 SetOSDLanguage 53 GetOSDRotation 54 SetOSDRotation 54 GetOSDTimer 55 SetOSDTimer 55 - Dell UP3017 | Application Programming Interface Guide - Page 6
display management and control from a Host PC to supported Dell UltraSharp monitors via a USB connection. A USB 3.0 A to B cable should be used for the connection between the host and the display. The following monitors are supported: 1. UP3017 The API described in this document corresponds to SDK - Dell UP3017 | Application Programming Interface Guide - Page 7
Code describing the result of the API call 0 Success 1 Timeout pbCount 2 Parameters Error 3 Not connected -1 Other Failure Number of supported monitors connected ConnectMonitor Connect to monitor and start session API MONITOR_CODE ConnectMonitor(BYTE iID) Params iID Return Index of - Dell UP3017 | Application Programming Interface Guide - Page 8
result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure SetAssetTag Set the asset tag of the monitor. API MONITOR_CODE SetAssetTag(BYTE *pbyAssetTag) Params *pbyAssetTag Pointer to asset tag ID string (max 10 chars) Return MONITOR_CODE Code - Dell UP3017 | Application Programming Interface Guide - Page 9
-1 Other Failure Asset tag ID string (max 10 chars) GetMonitorName Returns the monitor name API MONITOR_CODE GetMonitorName(BYTE *pbyMonitorName) Params *pbyMonitorName Pointer to return monitor name Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout - Dell UP3017 | Application Programming Interface Guide - Page 10
API call 0 Success 1 Timeout pbySerialNumber 2 Parameters Error 3 Not connected -1 Other Failure Monitor serial number string (max 12 chars) GetBacklightHours Returns the monitor backlight hours API MONITOR_CODE GetBacklightHours(SWORD16 *ps16Val) Params *ps16Val Pointer to return - Dell UP3017 | Application Programming Interface Guide - Page 11
Power Management GetPowerState Returns the current power state of the monitor API MONITOR_CODE GetPowerState(UBYTE *pu8Val) Params *pu8Val Pointer to return power state Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters - Dell UP3017 | Application Programming Interface Guide - Page 12
API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure GetPowerLED Returns the power LED setting of the monitor API MONITOR_CODE GetPowerLED(UBYTE *pu8Val) Params *pu8Val Pointer to return power LED setting Return MONITOR_CODE Code describing the result of - Dell UP3017 | Application Programming Interface Guide - Page 13
API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure GetPowerUSB Returns the power USB setting of the monitor API MONITOR_CODE GetPowerUSB(UBYTE *pu8Val) Params *pu8Val Pointer to return power USB setting Return MONITOR_CODE Code describing the result of - Dell UP3017 | Application Programming Interface Guide - Page 14
result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure Reset Power Reset power to the monitor API MONITOR_CODE ResetPower(void) Params Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error - Dell UP3017 | Application Programming Interface Guide - Page 15
Image Management GetBrightness Returns the brightness level of the monitor API MONITOR_CODE GetBrightness(UBYTE *pu8Val) Params *pu8Val Pointer to return brightness value Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout pu8Val 2 - Dell UP3017 | Application Programming Interface Guide - Page 16
of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure GetContrast Returns the contrast level of the monitor API MONITOR_CODE GetContrast(UBYTE *pu8Val) Params *pu8Val Pointer to return contrast value Return MONITOR_CODE Code describing the result of - Dell UP3017 | Application Programming Interface Guide - Page 17
SetContrast Set the contrast level of the monitor. NOTE: Uniformity Compensation must be turned off for this to work. API MONITOR_CODE SetContrast(UBYTE u8Val) Params u8Val Contrast value Integer value 0 (minimal) to 100 ( - Dell UP3017 | Application Programming Interface Guide - Page 18
pu8Val Dynamic Contrast 0 On 1 Off SetDynamicContrast Turns on/off the dynamic contrast setting. Applicable for Movies and Gaming. NOTE: Only works in Color Preset Game or Movie. API MONITOR_CODE SetDynamicContrast(UBYTE u8Val) Params u8Val Dynamic Contrast 0 Off 1 On Return - Dell UP3017 | Application Programming Interface Guide - Page 19
pu8Val Aspect Ratio 0 Wide 16:10 1 Auto Resize 2 4:3 3 1:1 SetAspectRatio Sets the aspect ratio API MONITOR_CODE SetAspectRatio(UBYTE u8Val) Params u8Val Aspect Ratio 0 Wide 16:10 1 Auto Resize 2 4:3 3 1:1 Return MONITOR_CODE Code describing the result of the API call 0 - Dell UP3017 | Application Programming Interface Guide - Page 20
GetSharpness Returns the sharpness level API MONITOR_CODE GetSharpness(UBYTE *pu8Val) Params *pu8Val Pointer to return sharpness value Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout pu8Val 2 Parameters Error 3 Not connected -1 Other Failure - Dell UP3017 | Application Programming Interface Guide - Page 21
GetResponseTime Returns the response time API MONITOR_CODE GetResponseTime(UBYTE *pu8Val) Params *pu8Val Pointer to return response time value Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout pu8Val 2 Parameters Error 3 Not connected -1 Other - Dell UP3017 | Application Programming Interface Guide - Page 22
Color Management GetSaturation Returns the color saturation level NOTE: Only works in Color Preset Game or Movie. API MONITOR_CODE GetSaturation(UBYTE *pu8Val) Params *pu8Val Pointer to return color saturation level Return MONITOR_CODE Code describing the result of the API call 0 Success - Dell UP3017 | Application Programming Interface Guide - Page 23
SetSaturation Sets the color saturation level NOTE: Only works in Color Preset Game or Movie. API MONITOR_CODE SetSaturation(UBYTE u8Val) Params u8Val Color Saturation level Integer value 0 to 100 Default 50 Values in increments of 1 Return MONITOR_CODE Code describing the result of the - Dell UP3017 | Application Programming Interface Guide - Page 24
pu8Val Color Saturation level Integer value 0 to 100 Default 50 Values in increments of 1 SetHue Sets the hue level NOTE: Only works in Color Preset Game or Movie. API MONITOR_CODE SetHue(UBYTE u8Val) Params u8Val Hue level Integer value 0 to 100 Default 50 Values in increments of 1 - Dell UP3017 | Application Programming Interface Guide - Page 25
GetColorTempCaps Returns the supported color temperatures of the monitor NOTE: Only works in Color Preset Color Temp. API MONITOR_CODE 10000K For example: 0x00000013 would indicate 5000K, 5700K and 9300K supported GetColorTemp Returns the current color temperature NOTE: Only works in - Dell UP3017 | Application Programming Interface Guide - Page 26
MONITOR_CODE pu32Val Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure Color temperature 0x00000001 5000K 0x00000002 5700K 0x00000004 6500K 0x00000008 7500K 0x00000010 9300K 0x00000020 10000K SetColorTemp Sets the - Dell UP3017 | Application Programming Interface Guide - Page 27
GetColorSpaceCaps Returns the supported color spaces of the monitor NOTE: Only works in Color Preset Color Space. API CAL 2 For example: 0x00000013 would indicate Adobe RGB, sRGB and CAL 1 supported GetColorSpaceState Returns the current color space state NOTE: Only works in Color Preset - Dell UP3017 | Application Programming Interface Guide - Page 28
MONITOR_CODE pu32Val Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure Color space 0x00000001 Adobe RGB 0x00000002 sRGB 0x00000004 Rec 709 0x00000008 DCI-P3 0x00000010 CAL 1 0x00000020 CAL 2 SetColorSpaceState Sets - Dell UP3017 | Application Programming Interface Guide - Page 29
GetInputColorFormat Returns the input color format API MONITOR_CODE GetInputColorFormat(UBYTE *pu8Val) Params *pu8Val Pointer to return response time value Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other - Dell UP3017 | Application Programming Interface Guide - Page 30
Parameters Error 3 Not connected -1 Other Failure Bitwise representation of supported color presets 0x00000001 Standard 0x00000002 Multimedia 0x00000004 Movie 0x00000008 Game 0x00000010 would indicate Standard, Multimedia and ComfortView presets available. 30 | Color Management - Dell UP3017 | Application Programming Interface Guide - Page 31
GetColorPreset Returns the current color preset API MONITOR_CODE GetColorPreset(UWORD32 *pu32Val) Params *pu32Val Pointer to return color preset Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout pu32Val 2 3 -1 Color preset 0x00000001 0x00000002 - Dell UP3017 | Application Programming Interface Guide - Page 32
SetColorPreset Sets the color preset API MONITOR_CODE SetColorPreset(UWORD32 u32Val) Params u32Val Color preset 0x00000001 Standard 0x00000002 Multimedia 0x00000004 Movie 0x00000008 Game 0x00000010 Paper 0x00000020 Color Temp. 0x00000040 Color Space 0x00000080 Custom Color 0x00000100 - Dell UP3017 | Application Programming Interface Guide - Page 33
GetCustomColor Returns the current custom color NOTE: Only works in Color Preset Custom Color. API MONITOR_CODE GetCustomColor(UBYTE u8Val, UBYTE *pu8ValR, UBYTE *pu8ValG, UBYTE *pu8ValB, UBYTE *pu8ValC, UBYTE *pu8ValM, UBYTE *pu8ValY) Params u8Val Custom color type to return values * - Dell UP3017 | Application Programming Interface Guide - Page 34
SetCustomColor Sets the custom color NOTE: Only works in Color Preset Custom Color. API MONITOR_CODE SetCustomColor (UBYTE u8Val, UBYTE u8ValR, UBYTE u8ValG, UBYTE u8ValB, UBYTE u8ValC, UBYTE u8ValM, UBYTE u8ValY) Params u8Val Custom color type 0 Gain 1 Offset 2 Hue 3 Saturation - Dell UP3017 | Application Programming Interface Guide - Page 35
GetGammaMode Returns the gamma mode API MONITOR_CODE GetGammaMode(UBYTE *pu8Val) Params *pu8Val Pointer to return gamma mode Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout u8Val 2 Parameters Error 3 Not connected -1 Other Failure Gamma Mode 0 - Dell UP3017 | Application Programming Interface Guide - Page 36
GetUniformityCompensation Returns the uniformity compensation setting API MONITOR_CODE GetUniformityCompensation(UBYTE *pu8Val) Params *pu8Val Pointer to return uniformity compensation setting Return MONITOR_CODE Code describing the result of the API call pu8Val 0 Success 1 Timeout 2 - Dell UP3017 | Application Programming Interface Guide - Page 37
ResetColor Reset all color settings to default API MONITOR_CODE ResetColor(void) Params - Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure Color Management | 37 - Dell UP3017 | Application Programming Interface Guide - Page 38
hours Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout ps16Val 2 Parameters Error 3 Not connected -1 Other Failure Monitor calibration hours GetCalBrightness Get the brightness level of CAL1 or CAL2. NOTE: Only works in Color Preset Color Space CAL1 - Dell UP3017 | Application Programming Interface Guide - Page 39
MONITOR_CODE pu8Val Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure CAL brightness value Integer value 0 (dark) to 100 (bright) Values in increments of 1 SetCalBrightness Set the brightness level of CAL1 or CAL2. NOTE - Dell UP3017 | Application Programming Interface Guide - Page 40
SetColorControl Enables or disables color engine for native color. NOTE: Only works in Color Preset Color Space CAL1 or CAL2. API MONITOR_CODE SetColorControl(UBYTE u8Val) Params u8Val 0 Disable 1 Enable Return MONITOR_CODE Code describing the result of the API call 0 Success 1 - Dell UP3017 | Application Programming Interface Guide - Page 41
arrColorMatrix Return MONITOR_CODE 2's complement values of the 3x3 16-bit color matrix, in the order from a1 to a9 Rout = (1+a1)Rin + a2Gin + a3Bin Gout = a4Rin + (1+a5)Gin + a6Bin Bout = a7Rin + a8Gin + (1+a9)Bin Code describing the result of the API call 0 Success 1 Timeout 2 Parameters - Dell UP3017 | Application Programming Interface Guide - Page 42
Video Input Management GetAutoSelect Returns the input source auto select setting API MONITOR_CODE GetAutoSelect(UBYTE *pu8Val) Params *pu8Val Pointer to return auto select setting Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout pu8Val 2 Parameters - Dell UP3017 | Application Programming Interface Guide - Page 43
MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure GetVideoInputCaps Returns the available video inputs API MONITOR_CODE GetVideoInputCaps(UWORD32 *pu32Val) Params *pu32Val Pointer to return available video - Dell UP3017 | Application Programming Interface Guide - Page 44
GetVideoInput Returns the current video input source API MONITOR_CODE GetVideoInput(UWORD32 *pu32Val) Params *pu32Val Pointer to return video input source Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout pu32Val 2 Parameters Error 3 Not connected - Dell UP3017 | Application Programming Interface Guide - Page 45
SetVideoInput Sets the video input source API MONITOR_CODE SetVideoInput(UWORD32 u32Val) Params u32Val Video Input Source 0x00000001 HDMI1 0x00000002 HDMI2 0x00000004 HDMI3 0x00000008 DP1 0x00000010 DP2 0x00000020 DP3 0x00000040 VGA1 0x00000080 VGA2 0x00000100 DVI1 0x00000200 DVI2 - Dell UP3017 | Application Programming Interface Guide - Page 46
PIP/PBP Management GetPxPMode Returns the current PIP/PBP mode API MONITOR_CODE GetPxPMode(UBYTE *pu8Val) Params *pu8Val Pointer to return PIP/PBP mode Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout pu8Val 2 Parameters Error 3 Not connected -1 - Dell UP3017 | Application Programming Interface Guide - Page 47
SetPxPMode Sets the PIP/PBP mode API MONITOR_CODE SetPxPMode(UBYTE u8Val) Params u8Val PIP/PBP Mode 0 Off 1 PIP Small 2 PIP Large 3 PBP Aspect Ratio 4 PBP Fill Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not - Dell UP3017 | Application Programming Interface Guide - Page 48
pu32Val Video Input Source 0x00000001 HDMI1 0x00000002 HDMI2 0x00000004 HDMI3 0x00000008 DP1 0x00000010 DP2 0x00000020 DP3 0x00000040 VGA1 0x00000080 VGA2 0x00000100 DVI1 0x00000200 DVI2 SetPxPSubInput Sets the PxP sub video input source API MONITOR_CODE SetPxPSubInput(UWORD32 u32Val) Params - Dell UP3017 | Application Programming Interface Guide - Page 49
GetPxPLocation Returns the current PIP/PBP location API MONITOR_CODE GetPxPLocation(UBYTE *pu8Val) Params *pu8Val Pointer to return PIP/PBP location Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout pu8Val 2 Parameters Error 3 Not connected -1 - Dell UP3017 | Application Programming Interface Guide - Page 50
SetPxPLocation Sets the PIP/PBP location API MONITOR_CODE SetPxPLocation(UBYTE u8Val) Params u8Val PIP/PBP Location 0 Top-Right 1 Top-Left 2 Bottom-Right 3 Bottom-Left Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not - Dell UP3017 | Application Programming Interface Guide - Page 51
OSD GetOSDTransparency Get the OSD Transparency API MONITOR_CODE GetOSDTransparency(UBYTE *pu8Val) Params *pu8Val Pointer to return OSD Transparency value Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout pu8Val 2 Parameters Error 3 Not connected - Dell UP3017 | Application Programming Interface Guide - Page 52
MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure GetOSDLanguage Get the OSD Language API MONITOR_CODE GetOSDLanguage(UBYTE *pu8Val) Params *pu8Val Pointer to return OSD Language value Return - Dell UP3017 | Application Programming Interface Guide - Page 53
SetOSDLanguage Set the OSD Language API MONITOR_CODE SetOSDLanguage(UBYTE u8Val) Params u8Val OSD Language 0 English 1 Espanol 2 Francais 3 Deutsch 4 Português (Brasil) 5 6 简体中文 Return 7 日本語 MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 - Dell UP3017 | Application Programming Interface Guide - Page 54
GetOSDRotation Get the OSD Rotation API MONITOR_CODE GetOSDRotation(UBYTE *pu8Val) Params *pu8Val Pointer to return OSD Rotation value Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout pu8Val 2 Parameters Error 3 Not connected -1 Other Failure OSD - Dell UP3017 | Application Programming Interface Guide - Page 55
GetOSDTimer Get the OSD Timer API MONITOR_CODE GetOSDTimer(UBYTE *pu8Val) Params *pu8Val Pointer to return OSD Timer value Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout pu8Val 2 Parameters Error 3 Not connected -1 Other Failure OSD Timer - Dell UP3017 | Application Programming Interface Guide - Page 56
GetOSDButtonLock Get the OSD Timer API MONITOR_CODE GetOSDButtonLock(UBYTE *pu8Val) Params *pu8Val Pointer to return OSD Timer value Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout pu8Val 2 Parameters Error 3 Not connected -1 Other Failure OSD - Dell UP3017 | Application Programming Interface Guide - Page 57
ResetOSD Reset OSD to default settings API MONITOR_CODE ResetOSD(void) Params - Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure OSD | 57 - Dell UP3017 | Application Programming Interface Guide - Page 58
System Management GetVersionFirmware Returns the firmware version of the monitor API MONITOR_CODE GetVersionFirmware(BYTE *ps16Val) Params *pbyFirmwareVersion Pointer to return OSD Transparency value Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout - Dell UP3017 | Application Programming Interface Guide - Page 59
GetMST Returns if the MST is on or off API MONITOR_CODE GetMST(UBYTE *pu8Val) Params *pu8Val Pointer to return MST value Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout pu8Val 2 Parameters Error 3 Not connected -1 Other Failure MST value 0 Off - Dell UP3017 | Application Programming Interface Guide - Page 60
GetLCDConditioning Returns if the LCD Conditioning is enabled or disabled API MONITOR_CODE GetLCDConditioning(UBYTE *pu8Val) Params *pu8Val Pointer to return LCD Conditioning value Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout pu8Val 2 Parameters - Dell UP3017 | Application Programming Interface Guide - Page 61
FactoryReset Reset to factory settings API MONITOR_CODE FactoryReset(void) Params - Return MONITOR_CODE Code describing the result of the API call 0 Success 1 Timeout 2 Parameters Error 3 Not connected -1 Other Failure SetDebugLevel Set the level of debug for the SDK API
![](/manual_guide/products/dell-up3017-application-programming-interface-guide-1236ee2/1.png)
Dell SDK for Monitors
Application Programming Interface
Guide
for SDK version 1.3