Dell UP3218K User Manual
Dell SDK for Monitors
Application Programming Interface Guide
for SDK version 1.4
Information in this document is subject to change without notice.
© 2017 Dell Inc. All rights reserved.
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 or registered trademarks of Microsoft
Corporation in the United States and/or other countries;
Other trademarks and trade names may be used in this document to refer to either the entities claiming the
marks and names or their products. Dell Inc. disclaims any proprietary interest in trademarks and trade names
other than its own.
2017 – 06 Rev. A00
Contents
Contents ................................................................................................................................................................... 3
Introduction ............................................................................................................................................................. 6
API Return Codes .................................................................................................................................................... 6
Monitor Management ............................................................................................................................................ 7
GetAvailableMonitors ......................................................................................................................................... 7
ConnectMonitor ................................................................................................................................................. 7
DisconnectMonitor ............................................................................................................................................ 7
SetAssetTag .......................................................................................................................................................... 7
GetAssetTag ......................................................................................................................................................... 7
GetMonitorName ................................................................................................................................................ 8
GetMonitorSerialNumber .................................................................................................................................. 8
GetBacklightHours ............................................................................................................................................. 8
Power Management ............................................................................................................................................... 9
GetPowerState .................................................................................................................................................... 9
SetPowerState ..................................................................................................................................................... 9
GetPowerLED ...................................................................................................................................................... 9
SetPowerLED ....................................................................................................................................................... 9
GetPowerUSB .................................................................................................................................................... 10
SetPowerUSB ..................................................................................................................................................... 10
Reset Power ....................................................................................................................................................... 10
Image Management ............................................................................................................................................. 11
GetBrightness .................................................................................................................................................... 11
SetBrightness ..................................................................................................................................................... 11
GetContrast ....................................................................................................................................................... 11
SetContrast ........................................................................................................................................................ 11
GetDynamicContrast ....................................................................................................................................... 12
SetDynamicContrast ........................................................................................................................................ 12
GetAspectRatio ................................................................................................................................................. 12
SetAspectRatio .................................................................................................................................................. 13
GetSharpness ..................................................................................................................................................... 13
SetSharpness ...................................................................................................................................................... 13
GetResponseTime ............................................................................................................................................ 13
SetResponseTime ............................................................................................................................................. 14
Color Management .............................................................................................................................................. 15
Contents | 3
GetSaturation ..................................................................................................................................................... 15
SetSaturation...................................................................................................................................................... 15
GetHue ................................................................................................................................................................ 15
SetHue ................................................................................................................................................................. 16
GetColorTempCaps ......................................................................................................................................... 16
GetColorTemp .................................................................................................................................................. 16
SetColorTemp ................................................................................................................................................... 17
GetColorSpaceCaps ......................................................................................................................................... 17
GetColorSpaceState ......................................................................................................................................... 17
SetColorSpaceState ......................................................................................................................................... 18
GetInputColorFormat ...................................................................................................................................... 18
SetInputColorFormat ....................................................................................................................................... 18
GetColorPresetCaps ........................................................................................................................................ 19
GetColorPreset ................................................................................................................................................. 19
SetColorPreset .................................................................................................................................................. 19
GetCustomColor ............................................................................................................................................. 20
SetCustomColor .............................................................................................................................................. 20
GetGammaMode .............................................................................................................................................. 21
SetGammaMode ............................................................................................................................................... 21
GetUniformityCompensation ....................................................................................................................... 22
SetUniformityCompensation ........................................................................................................................ 22
ResetColor ........................................................................................................................................................ 22
LUT Management ................................................................................................................................................ 23
GetCalibrationHours ....................................................................................................................................... 23
GetCalBrightness ............................................................................................................................................. 23
SetCalBrightness .............................................................................................................................................. 23
SetColorControl ............................................................................................................................................... 23
SetLUT ................................................................................................................................................................ 24
SetLUT2 .............................................................................................................................................................. 24
Video Input Management .................................................................................................................................. 26
GetAutoSelect .................................................................................................................................................. 26
SetAutoSelect ................................................................................................................................................... 26
GetVideoInputCaps ......................................................................................................................................... 26
GetVideoInput ................................................................................................................................................... 27
SetVideoInput .................................................................................................................................................... 27
PIP/PBP Management ......................................................................................................................................... 28
GetPxPMode ..................................................................................................................................................... 28
4 | Contents
SetPxPMode ...................................................................................................................................................... 28
GetPxPSubInput ............................................................................................................................................... 28
SetPxPSubInput ................................................................................................................................................ 29
GetPxPLocation ............................................................................................................................................... 29
SetPxPLocation ................................................................................................................................................ 30
OSD .......................................................................................................................................................................... 31
GetOSDTransparency ...................................................................................................................................... 31
SetOSDTransparency ....................................................................................................................................... 31
GetOSDLanguage ............................................................................................................................................. 31
SetOSDLanguage ............................................................................................................................................. 32
GetOSDRotation .............................................................................................................................................. 32
SetOSDRotation ............................................................................................................................................... 32
GetOSDTimer ................................................................................................................................................... 32
SetOSDTimer .................................................................................................................................................... 33
GetOSDButtonLock ........................................................................................................................................ 33
SetOSDButtonLock ......................................................................................................................................... 33
GetButtonSound .............................................................................................................................................. 34
SetButtonSound ............................................................................................................................................... 34
ResetOSD .......................................................................................................................................................... 34
System Management .......................................................................................................................................... 35
GetVersionFirmware ....................................................................................................................................... 35
GetVersionSDK ................................................................................................................................................. 35
GetMST .............................................................................................................................................................. 35
SetMST ............................................................................................................................................................... 36
GetLCDConditioning ...................................................................................................................................... 36
SetLCDConditioning ....................................................................................................................................... 36
FactoryReset ..................................................................................................................................................... 36
SetDebugLevel .................................................................................................................................................. 37
Contents | 5
Introduction
This document describes the APIs for supported Dell UltraSharp monitors on Linux(x86), OSX and
Windows platforms. These APIs are to be used for remote 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. UP2516D
2. UP2716D
3. UP3017
4. UP3218K
The API described in this document corresponds to SDK version 1.4.
API Return Codes
All APIs return a MONITOR_CODE as described below:
Return
MONITOR_CODE Code describing the result of the API call
0 Success
1 Timeout
2 Parameters Error
3 Connection error with monitor
4 Communications error with monitor
5 Wrong state for API call
6 API not supported by monitor
-1 Other Failure
6 | Introduction
Monitor Management
GetAvailableMonitors
Returns the number of supported monitor(s)
API
MONITOR_CODE GetAvailableMonitors(BYTE *pbCount)
Params
byMonitors[] Array for return values
Return
pbCount Number of supported monitors connected
ConnectMonitor
Connect to monitor and start session
API
MONITOR_CODE ConnectMonitor(BYTE iID)
Params
iID Index of monitor as returned by GetAvailableMonitors to connect to.
Index starts at 0 for the first monitor.
DisconnectMonitor
Disconnect to monitor and end session
API
MONITOR_CODE DisconnectMonitor(void)
Params
-
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)
GetAssetTag
Returns the monitor asset tag. Asset Tag will be empty until set by SetAssetTag.
Monitor Management | 7
API
MONITOR_CODE GetAssetTag(BYTE *pbyAssetTag)
Params
*pbyAssetTag Pointer to return asset tag ID string
Return
pbyAssetTag 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
pbyMonitorName Monitor name string (max 10 chars)
GetMonitorSerialNumber
Returns the monitor serial number
API
MONITOR_CODE GetMonitorSerialNumber(BYTE *pbySerialNumber)
Params
*pbySerialNumber Pointer to return monitor serial number
Return
pbySerialNumber Monitor serial number string (max 12 chars)
GetBacklightHours
Returns the monitor backlight hours
API
MONITOR_CODE GetBacklightHours(SWORD16 *ps16Val)
Params
*ps16Val Pointer to return monitor backlight hours
Return
ps16Val Monitor backlight hours
8 | Monitor Management
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
pu8Val Power State
0 Off
1 On
2 Standby
SetPowerState
Set the monitor on or standby
API
MONITOR_CODE SetPowerState(UBYTE u8Val)
Params
u8Val Power state to set
0 Off
1 On
2 Standby
GetPowerLED
Returns the power LED setting of the monitor
API
MONITOR_CODE GetPowerLED(UBYTE *pu8Val)
Params
*pu8Val Pointer to return power LED setting
Return
pu8Val Power LED Setting
0 Off during Active
1 On during Active
SetPowerLED
Set the power LED setting
API
Power Management | 9
MONITOR_CODE SetPowerLED(UBYTE u8Val)
Params
u8Val Power LED Setting
0 Off during Active
1 On during Active
GetPowerUSB
Returns the power USB setting of the monitor
API
MONITOR_CODE GetPowerUSB(UBYTE *pu8Val)
Params
*pu8Val Pointer to return power USB setting
Return
pu8Val Power USB Setting
0 Off during Standby
1 On during Standby
SetPowerUSB
Set the power USB setting
API
MONITOR_CODE SetPowerUSB(UBYTE u8Val)
Params
u8Val Power USB Setting
0 Off during Standby
1 On during Standby
Reset Power
Reset power to the monitor
API
MONITOR_CODE ResetPower(void)
Params
-
10 | Power Management
Image Management
GetBrightness
Returns the brightness level of the monitor
API
MONITOR_CODE GetBrightness(UBYTE *pu8Val)
Params
*pu8Val Pointer to return brightness value
Return
pu8Val Brightness value
Integer value 0 (dark) to 100 (bright)
Default 75
Values in increments of 1
SetBrightness
Set the brightness level of the monitor
API
MONITOR_CODE SetBrightness(UBYTE u8Val)
Params
u8Val Brightness value
Integer value 0 (dark) to 100 (bright)
Default 75
Values in increments of 1
GetContrast
Returns the contrast level of the monitor
API
MONITOR_CODE GetContrast(UBYTE *pu8Val)
Params
*pu8Val Pointer to return contrast value
Return
pu8Val Contrast value
Integer value 0 (minimal) to 100 (maximum)
Default 75
Values in increments of 1
SetContrast
Set the contrast level of the monitor.
Image Management | 11
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 (maximum)
Default 75
Values in increments of 1
GetDynamicContrast
Returns the dynamic contrast setting. Applicable for Movies and Gaming.
NOTE: Only works in Color Preset Game or Movie.
API
MONITOR_CODE GetDynamicContrast(UBYTE *pu8Val)
Params
*pu8Val Pointer to return dynamic contrast value
Return
pu8Val Dynamic Contrast
0 Off
1 On
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
GetAspectRatio
Returns the aspect ratio
API
MONITOR_CODE GetAspectRatio(UBYTE *pu8Val)
Params
*pu8Val Pointer to return aspect ratio
Return
pu8Val Aspect Ratio
0 Wide 16:9
12 | Image Management
Loading...