python-samsung-mdc 1.14.2

Description:

pythonsamsungmdc 1.14.2

Samsung-MDC
This is implementation of Samsung MDC (Multiple Display Control) protocol on python3.7+ and asyncio with most comprehensive CLI (command line interface).
It allows you to control a variety of different sources (TV, Monitor) through the built-in RS-232C or Ethernet interface.
MDC Protocol specification - v15.0 2020-11-06

Implemented 82 commands
Easy to extend using simple declarative API - see samsung_mdc/commands.py
Detailed CLI help and parameters validation
Run commands async on numerous targets (using asyncio)
TCP and SERIAL mode (for RJ45 and RS232C connection types)
TCP over TLS mode ("Secured Protocol" using PIN)
script command for advanced usage
Python example

Not implemented: some more commands (PRs are welcome)
Also see: Samsung MDC Unified - Reference Application (GUI, Windows) with partially implemented functionality.
Install
# using pipx https://pypa.github.io/pipx/
pipx run python-samsung-mdc --help

# OR global install/upgrade
sudo pip3 install --upgrade python-samsung-mdc
samsung-mdc --help

# OR local
git clone https://github.com/vgavro/samsung-mdc
cd ./samsung-mdc
python3 -m venv venv
./venv/bin/pip3 install -e ./
./venv/bin/samsung-mdc --help

Windows install

Install Git && Git Bash: https://git-scm.com/download/win
Install Python 3 latest release (tested with 3.9): https://www.python.org/downloads/windows/
Run "Git Bash", type in console:

pip3 install --upgrade python-samsung-mdc

# NOTE: python "Scripts" folder is not in %PATH% in Windows by default,
# so you may want to create alias for Git Bash
echo alias samsung-mdc=\'python3 -m samsung_mdc\' >> ~/.bash_profile
source ~/.bash_profile

# test it
samsung-mdc --help

Usage
Usage: samsung-mdc [OPTIONS] TARGET COMMAND [ARGS]...

Try 'samsung-mdc --help COMMAND' for command info

For multiple targets commands will be running async, so result order may
differ.

TARGET may be:

DISPLAY_ID@IP[:PORT] (default port: 1515, example: [email protected]:1515)
FILENAME with target list (separated by newline)

For serial port connection:
DISPLAY_ID@PORT_NAME for Windows (example: 1@COM1)
DISPLAY_ID@PORT_PATH (example: 1@/dev/ttyUSB0)

We're trying to make autodetection of connection mode by port name, but you
may want to use --mode option.

Options:
--version Show the version and exit.
-v, --verbose
-m, --mode [auto|tcp|serial] default: auto
-p, --pin INTEGER 4-digit PIN for secured TLS connection. If PIN
provided, "Secured Protocol" must be enabled
on remote device.
-t, --timeout FLOAT read/write/connect timeout in seconds
(default: 5) (connect can be overridden with
separate option)
--connect-timeout FLOAT
-h, --help Show this message and exit.


Commands:

status (POWER_STATE VOLUME MUTE_STATE INPUT_SOURCE_STATE PICTURE_ASPECT_STATE N_TIME_NF F_TIME_NF)
video (CONTRAST BRIGHTNESS SHARPNESS COLOR TINT COLOR_TONE_STATE COLOR_TEMPERATURE _IGNORE)
rgb (CONTRAST BRIGHTNESS COLOR_TONE_STATE COLOR_TEMPERATURE _IGNORE RED_GAIN GREEN_GAIN BLUE_GAIN)
serial_number (SERIAL_NUMBER)
error_status (LAMP_ERROR_STATE TEMPERATURE_ERROR_STATE BRIGHTNESS_SENSOR_ERROR_STATE INPUT_SOURCE_ERROR_STATE TEMPERATURE FAN_ERROR_STATE)
software_version (SOFTWARE_VERSION)
model_number (MODEL_SPECIES MODEL_CODE TV_SUPPORT)
power [POWER_STATE]
volume [VOLUME]
mute [MUTE_STATE]
input_source [INPUT_SOURCE_STATE]
picture_aspect [PICTURE_ASPECT_STATE]
screen_mode [SCREEN_MODE_STATE]
screen_size (INCHES)
network_configuration [IP_ADDRESS SUBNET_MASK GATEWAY_ADDRESS DNS_SERVER_ADDRESS]
network_mode [NETWORK_MODE_STATE]
network_ap_config SSID PASSWORD
weekly_restart [WEEKDAY TIME]
magicinfo_channel CHANNEL_NUMBER
magicinfo_server [MAGICINFO_SERVER_URL]
magicinfo_content_orientation [ORIENTATION_MODE_STATE]
mdc_connection [MDC_CONNECTION_TYPE]
contrast [CONTRAST]
brightness [BRIGHTNESS]
sharpness [SHARPNESS]
color [COLOR]
tint [TINT]
h_position H_POSITION_MOVE_TO
v_position V_POSITION_MOVE_TO
auto_power [AUTO_POWER_STATE]
clear_menu
ir_state [IR_STATE]
rgb_contrast [CONTRAST]
rgb_brightness [BRIGHTNESS]
auto_adjustment_on
color_tone [COLOR_TONE_STATE]
color_temperature [HECTO_KELVIN]
standby [STANDBY_STATE]
auto_lamp [MAX_TIME MAX_LAMP_VALUE MIN_TIME MIN_LAMP_VALUE]
manual_lamp [LAMP_VALUE]
inverse [INVERSE_STATE]
video_wall_mode [VIDEO_WALL_MODE]
safety_lock [LOCK_STATE]
panel_lock [LOCK_STATE]
channel_change CHANGE_TO
volume_change CHANGE_TO
ticker [ON_OFF START_TIME END_TIME POS_HORIZ POS_VERTI MOTION_ON_OFF MOTION_DIR MOTION_SPEED FONT_SIZE FOREGROUND_COLOR BACKGROUND_COLOR FOREGROUND_OPACITY BACKGROUND_OPACITY MESSAGE]
device_name (DEVICE_NAME)
osd [OSD_ENABLED]
picture_mode [PICTURE_MODE_STATE]
sound_mode [SOUND_MODE_STATE]
all_keys_lock [LOCK_STATE]
panel_on_time (MIN10)
video_wall_state [VIDEO_WALL_STATE]
video_wall_model [MODEL SERIAL]
model_name (MODEL_NAME)
energy_saving [ENERGY_SAVING_STATE]
reset RESET_TARGET
osd_type [OSD_TYPE OSD_ENABLED]
timer_13 TIMER_ID [ON_TIME ON_ENABLED OFF_TIME OFF_ENABLED REPEAT MANUAL_WEEKDAY VOLUME INPUT_SOURCE_STATE HOLIDAY_APPLY]
timer_15 TIMER_ID [ON_TIME ON_ENABLED OFF_TIME OFF_ENABLED ON_REPEAT ON_MANUAL_WEEKDAY OFF_REPEAT OFF_MANUAL_WEEKDAY VOLUME INPUT_SOURCE_STATE HOLIDAY_APPLY]
clock_m [DATETIME]
holiday_set HOLIDAY_MANAGE START_MONTH START_DAY END_MONTH END_DAY
holiday_get [INDEX]
virtual_remote KEY_CODE
network_standby [NETWORK_STANDBY_STATE]
dst [DST_STATE START_MONTH START_WEEK START_WEEKDAY START_TIME END_MONTH END_WEEK END_WEEKDAY END_TIME OFFSET]
auto_id_setting [AUTO_ID_SETTING_STATE]
display_id DISPLAY_ID_STATE
clock_s [DATETIME]
launcher_play_via [PLAY_VIA_MODE]
launcher_url_address [URL_ADDRESS]
osd_menu_orientation [ORIENTATION_MODE_STATE]
osd_source_content_orientation [ORIENTATION_MODE_STATE]
osd_aspect_ratio [ASPECT_RATIO_STATE]
osd_pip_orientation [ORIENTATION_MODE_STATE]
osd_menu_size [MENU_SIZE_STATE]
auto_source_switch [AUTO_SOURCE_SWITCH_STATE]
auto_source [PRIMARY_SOURCE_RECOVERY PRIMARY_SOURCE SECONDARY_SOURCE]
panel [PANEL_STATE]
script [OPTIONS] SCRIPT_FILE
raw [OPTIONS] COMMAND [DATA]

status
Usage: samsung-mdc [OPTIONS] TARGET status

Get the device various state like power, volume, sound mute, input source,
picture aspect ratio.

Note: For no audio models volume and mute returns 0xFF (255).

N_TIME_NF, F_TIME_NF: OnTime/OffTime ON/OFF value (old type timer, now it's
always 0x00).

Data:
POWER_STATE OFF | ON | REBOOT
VOLUME int (0-100)
MUTE_STATE OFF | ON | NONE
INPUT_SOURCE_STATE NONE | S_VIDEO | COMPONENT | AV | AV2 | SCART1 | DVI |
PC | BNC | DVI_VIDEO | MAGIC_INFO | HDMI1 | HDMI1_PC |
HDMI2 | HDMI2_PC | DISPLAY_PORT_1 | DISPLAY_PORT_2 |
DISPLAY_PORT_3 | RF_TV | HDMI3 | HDMI3_PC | HDMI4 |
HDMI4_PC | TV_DTV | PLUG_IN_MODE | HD_BASE_T | OCM |
MEDIA_MAGIC_INFO_S | WIDI_SCREEN_MIRRORING |
INTERNAL_USB | URL_LAUNCHER | IWB | WEB_BROWSER |
REMOTE_WORKSPACE
PICTURE_ASPECT_STATE PC_16_9 | PC_4_3 | PC_ORIGINAL_RATIO | PC_21_9 |
PC_CUSTOM | VIDEO_AUTO_WIDE | VIDEO_16_9 | VIDEO_ZOOM
| VIDEO_ZOOM_1 | VIDEO_ZOOM_2 | VIDEO_SCREEN_FIT |
VIDEO_4_3 | VIDEO_WIDE_FIT | VIDEO_CUSTOM |
VIDEO_SMART_VIEW_1 | VIDEO_SMART_VIEW_2 |
VIDEO_WIDE_ZOOM | VIDEO_21_9
N_TIME_NF int
F_TIME_NF int

video
Usage: samsung-mdc [OPTIONS] TARGET video

Data:
CONTRAST int (0-100)
BRIGHTNESS int (0-100)
SHARPNESS int (0-100)
COLOR int (0-100)
TINT int (0-100)
COLOR_TONE_STATE COOL_2 | COOL_1 | NORMAL | WARM_1 | WARM_2 | OFF
COLOR_TEMPERATURE int
_IGNORE int (0-0)

rgb
Usage: samsung-mdc [OPTIONS] TARGET rgb

Data:
CONTRAST int (0-100)
BRIGHTNESS int (0-100)
COLOR_TONE_STATE COOL_2 | COOL_1 | NORMAL | WARM_1 | WARM_2 | OFF
COLOR_TEMPERATURE int
_IGNORE int (0-0)
RED_GAIN int
GREEN_GAIN int
BLUE_GAIN int

serial_number
Usage: samsung-mdc [OPTIONS] TARGET serial_number

Data:
SERIAL_NUMBER str

error_status
Usage: samsung-mdc [OPTIONS] TARGET error_status

Data:
LAMP_ERROR_STATE NORMAL | ERROR
TEMPERATURE_ERROR_STATE NORMAL | ERROR
BRIGHTNESS_SENSOR_ERROR_STATE NONE | ERROR | NORMAL
INPUT_SOURCE_ERROR_STATE NORMAL | ERROR | INVALID
TEMPERATURE int
FAN_ERROR_STATE NORMAL | ERROR | NONE

software_version
Usage: samsung-mdc [OPTIONS] TARGET software_version

Data:
SOFTWARE_VERSION str

model_number
Usage: samsung-mdc [OPTIONS] TARGET model_number

Data:
MODEL_SPECIES PDP | LCD | DLP | LED | CRT | OLED
MODEL_CODE int
TV_SUPPORT SUPPORTED | NOT_SUPPORTED

power
Usage: samsung-mdc [OPTIONS] TARGET power [POWER_STATE]

Data:
POWER_STATE OFF | ON | REBOOT

volume
Usage: samsung-mdc [OPTIONS] TARGET volume [VOLUME]

Data:
VOLUME int (0-100)

mute
Usage: samsung-mdc [OPTIONS] TARGET mute [MUTE_STATE]

Data:
MUTE_STATE OFF | ON | NONE

input_source
Usage: samsung-mdc [OPTIONS] TARGET input_source [INPUT_SOURCE_STATE]

Get/Set the device source which is shown on the screen.

DVI_VIDEO, HDMI1_PC, HDMI2_PC, HDMI3_PC, HDMI4_PC: get only.

URL_LAUNCHER, MAGIC_INFO, TV or some ports require support by model.

On TIMER functions, Do not use WIDI_SCREEN_MIRRORING.

Data:
INPUT_SOURCE_STATE NONE | S_VIDEO | COMPONENT | AV | AV2 | SCART1 | DVI |
PC | BNC | DVI_VIDEO | MAGIC_INFO | HDMI1 | HDMI1_PC |
HDMI2 | HDMI2_PC | DISPLAY_PORT_1 | DISPLAY_PORT_2 |
DISPLAY_PORT_3 | RF_TV | HDMI3 | HDMI3_PC | HDMI4 |
HDMI4_PC | TV_DTV | PLUG_IN_MODE | HD_BASE_T | OCM |
MEDIA_MAGIC_INFO_S | WIDI_SCREEN_MIRRORING |
INTERNAL_USB | URL_LAUNCHER | IWB | WEB_BROWSER |
REMOTE_WORKSPACE

picture_aspect
Usage: samsung-mdc [OPTIONS] TARGET picture_aspect [PICTURE_ASPECT_STATE]

Get/Set the device picture size (aspect ratio).

Working Condition: Will not work with VIDEO_WALL_STATE is ON.

Note: Some of the image sizes are not supported depending on input signals.

Data:
PICTURE_ASPECT_STATE PC_16_9 | PC_4_3 | PC_ORIGINAL_RATIO | PC_21_9 |
PC_CUSTOM | VIDEO_AUTO_WIDE | VIDEO_16_9 | VIDEO_ZOOM
| VIDEO_ZOOM_1 | VIDEO_ZOOM_2 | VIDEO_SCREEN_FIT |
VIDEO_4_3 | VIDEO_WIDE_FIT | VIDEO_CUSTOM |
VIDEO_SMART_VIEW_1 | VIDEO_SMART_VIEW_2 |
VIDEO_WIDE_ZOOM | VIDEO_21_9

screen_mode
Usage: samsung-mdc [OPTIONS] TARGET screen_mode [SCREEN_MODE_STATE]

Data:
SCREEN_MODE_STATE MODE_16_9 | MODE_ZOOM | MODE_4_3 | MODE_WIDE_ZOOM

screen_size
Usage: samsung-mdc [OPTIONS] TARGET screen_size

Data:
INCHES int (0-255)

network_configuration
Usage: samsung-mdc [OPTIONS] TARGET network_configuration [IP_ADDRESS
SUBNET_MASK GATEWAY_ADDRESS DNS_SERVER_ADDRESS]

Data:
IP_ADDRESS IP address
SUBNET_MASK IP address
GATEWAY_ADDRESS IP address
DNS_SERVER_ADDRESS IP address

network_mode
Usage: samsung-mdc [OPTIONS] TARGET network_mode [NETWORK_MODE_STATE]

Data:
NETWORK_MODE_STATE DYNAMIC | STATIC

network_ap_config
Usage: samsung-mdc [OPTIONS] TARGET network_ap_config SSID PASSWORD

Add new SSID info to device connection history with its password.

Note: device may change network and response may not be received.

Data:
SSID str
PASSWORD str

weekly_restart
Usage: samsung-mdc [OPTIONS] TARGET weekly_restart [WEEKDAY TIME]

Data:
WEEKDAY list(,) SUN | SAT | FRI | THU | WED | TUE | MON
TIME time (format: %H:%M)

magicinfo_channel
Usage: samsung-mdc [OPTIONS] TARGET magicinfo_channel CHANNEL_NUMBER

Set MagicInfo Channel by Direct Channel Number which is used by MagicInfo S
Player.

Data:
CHANNEL_NUMBER int

magicinfo_server
Usage: samsung-mdc [OPTIONS] TARGET magicinfo_server [MAGICINFO_SERVER_URL]

MagicInfo Server URL.

Example: "http://example.com:80"

Data:
MAGICINFO_SERVER_URL str

magicinfo_content_orientation
Usage: samsung-mdc [OPTIONS] TARGET magicinfo_content_orientation
[ORIENTATION_MODE_STATE]

Data:
ORIENTATION_MODE_STATE LANDSCAPE_0 | PORTRAIT_270 | LANDSCAPE_180 |
PORTRAIT_90

mdc_connection
Usage: samsung-mdc [OPTIONS] TARGET mdc_connection [MDC_CONNECTION_TYPE]

Note: Depends on the product specification, if it is set as RJ45 then serial
MDC will not work.

Data:
MDC_CONNECTION_TYPE RS232C | RJ45

contrast
Usage: samsung-mdc [OPTIONS] TARGET contrast [CONTRAST]

Data:
CONTRAST int (0-100)

brightness
Usage: samsung-mdc [OPTIONS] TARGET brightness [BRIGHTNESS]

Data:
BRIGHTNESS int (0-100)

sharpness
Usage: samsung-mdc [OPTIONS] TARGET sharpness [SHARPNESS]

Data:
SHARPNESS int (0-100)

color
Usage: samsung-mdc [OPTIONS] TARGET color [COLOR]

Data:
COLOR int (0-100)

tint
Usage: samsung-mdc [OPTIONS] TARGET tint [TINT]

Control the device tint. Adjust the ratio of green to red tint level.

Red: TINT value, Green: ( 100 - TINT ) value.

Note: Tint could only be set in 50 Steps (0, 2, 4, 6... 100).

Data:
TINT int (0-100)

h_position
Usage: samsung-mdc [OPTIONS] TARGET h_position H_POSITION_MOVE_TO

Data:
H_POSITION_MOVE_TO LEFT | RIGHT

v_position
Usage: samsung-mdc [OPTIONS] TARGET v_position V_POSITION_MOVE_TO

Data:
V_POSITION_MOVE_TO UP | DOWN

auto_power
Usage: samsung-mdc [OPTIONS] TARGET auto_power [AUTO_POWER_STATE]

Data:
AUTO_POWER_STATE OFF | ON

clear_menu
Usage: samsung-mdc [OPTIONS] TARGET clear_menu

ir_state
Usage: samsung-mdc [OPTIONS] TARGET ir_state [IR_STATE]

Enables/disables IR (Infrared) receiving function (Remote Control).

Working Condition: * Can operate regardless of whether power is ON/OFF. (If
DPMS Situation in LFD, it operate Remocon regardless of set value).

Data:
IR_STATE DISABLED | ENABLED

rgb_contrast
Usage: samsung-mdc [OPTIONS] TARGET rgb_contrast [CONTRAST]

Data:
CONTRAST int (0-100)

rgb_brightness
Usage: samsung-mdc [OPTIONS] TARGET rgb_brightness [BRIGHTNESS]

Data:
BRIGHTNESS int (0-100)

auto_adjustment_on
Usage: samsung-mdc [OPTIONS] TARGET auto_adjustment_on

color_tone
Usage: samsung-mdc [OPTIONS] TARGET color_tone [COLOR_TONE_STATE]

Data:
COLOR_TONE_STATE COOL_2 | COOL_1 | NORMAL | WARM_1 | WARM_2 | OFF

color_temperature
Usage: samsung-mdc [OPTIONS] TARGET color_temperature [HECTO_KELVIN]

Color temperature function.

Unit is hectoKelvin (hK) (x*100 Kelvin) (example: 28 = 2800K).

Supported values - 28, 30, 35, 40... 160.

For older models: 0-10=(x*100K + 5000K), 253=2800K, 254=3000K, 255=4000K

Data:
HECTO_KELVIN int

standby
Usage: samsung-mdc [OPTIONS] TARGET standby [STANDBY_STATE]

Data:
STANDBY_STATE OFF | ON | AUTO

auto_lamp
Usage: samsung-mdc [OPTIONS] TARGET auto_lamp [MAX_TIME MAX_LAMP_VALUE
MIN_TIME MIN_LAMP_VALUE]

Auto Lamp function (backlight).

Note: When Manual Lamp Control is on, Auto Lamp Control will automatically
turn off.

Data:
MAX_TIME time (format: %H:%M)
MAX_LAMP_VALUE int (0-100)
MIN_TIME time (format: %H:%M)
MIN_LAMP_VALUE int (0-100)

manual_lamp
Usage: samsung-mdc [OPTIONS] TARGET manual_lamp [LAMP_VALUE]

Manual Lamp function (backlight).

Note: When Auto Lamp Control is on, Manual Lamp Control will automatically
turn off.

Data:
LAMP_VALUE int (0-100)

inverse
Usage: samsung-mdc [OPTIONS] TARGET inverse [INVERSE_STATE]

Data:
INVERSE_STATE OFF | ON

video_wall_mode
Usage: samsung-mdc [OPTIONS] TARGET video_wall_mode [VIDEO_WALL_MODE]

Get/Set the device in aspect ratio of the video wall.

FULL: stretch input source to fill display

NATURAL: Keep aspect ratio of input source; do not fill display.

Note: Needs VIDEO_WALL_STATE to be ON.

Data:
VIDEO_WALL_MODE NATURAL | FULL

safety_lock
Usage: samsung-mdc [OPTIONS] TARGET safety_lock [LOCK_STATE]

Data:
LOCK_STATE OFF | ON

panel_lock
Usage: samsung-mdc [OPTIONS] TARGET panel_lock [LOCK_STATE]

Data:
LOCK_STATE OFF | ON

channel_change
Usage: samsung-mdc [OPTIONS] TARGET channel_change CHANGE_TO

Data:
CHANGE_TO UP | DOWN

volume_change
Usage: samsung-mdc [OPTIONS] TARGET volume_change CHANGE_TO

Data:
CHANGE_TO UP | DOWN

ticker
Usage: samsung-mdc [OPTIONS] TARGET ticker [ON_OFF START_TIME END_TIME
POS_HORIZ POS_VERTI MOTION_ON_OFF MOTION_DIR MOTION_SPEED
FONT_SIZE FOREGROUND_COLOR BACKGROUND_COLOR
FOREGROUND_OPACITY BACKGROUND_OPACITY MESSAGE]

Get/Set the device ticker. (Show text message overlay on the screen)

Note: POS_HORIZ or POS_VERT are NONE in GET response if unsupported by the
display.

Data:
ON_OFF bool
START_TIME time (format: %H:%M)
END_TIME time (format: %H:%M)
POS_HORIZ CENTER | LEFT | RIGHT | NONE
POS_VERTI MIDDLE | TOP | BOTTOM | NONE
MOTION_ON_OFF bool
MOTION_DIR LEFT | RIGHT | UP | DOWN
MOTION_SPEED NORMAL | SLOW | FAST
FONT_SIZE STANDARD | SMALL | LARGE
FOREGROUND_COLOR BLACK | WHITE | RED | GREEN | BLUE | YELLOW | MAGENTA |
CYAN
BACKGROUND_COLOR BLACK | WHITE | RED | GREEN | BLUE | YELLOW | MAGENTA |
CYAN
FOREGROUND_OPACITY FLASHING | FLASH_ALL | OFF
BACKGROUND_OPACITY SOLID | TRANSPARENT | TRANSLUCENT | UNKNOWN
MESSAGE str

device_name
Usage: samsung-mdc [OPTIONS] TARGET device_name

It reads the device name which user set up in network. Shows the information
about entered device name.

Data:
DEVICE_NAME str

osd
Usage: samsung-mdc [OPTIONS] TARGET osd [OSD_ENABLED]

Turns OSD (On-screen display) on/off.

Data:
OSD_ENABLED bool

picture_mode
Usage: samsung-mdc [OPTIONS] TARGET picture_mode [PICTURE_MODE_STATE]

Data:
PICTURE_MODE_STATE DYNAMIC | STANDARD | MOVIE | CUSTOM_TV | NATURAL |
CALIBRATION_TV | ENTERTAIN | INTERNET | TEXT | CUSTOM |
ADVERTISEMENT | INFORMATION | CALIBRATION |
SHOP_MALL_VIDEO | SHOP_MALL_TEXT | OFFICE_SCHOOL_VIDEO |
OFFICE_SCHOOL_TEXT | TERMINAL_STATION_VIDEO |
TERMINAL_STATION_TEXT | VIDEO_WALL_VIDEO |
VIDEO_WALL_TEXT | HDR_PLUS | OFF | RESERVED_OTHER

sound_mode
Usage: samsung-mdc [OPTIONS] TARGET sound_mode [SOUND_MODE_STATE]

Data:
SOUND_MODE_STATE STANDARD | MUSIC | MOVIE | SPEECH | CUSTOM | AMPLIFY |
OPTIMIZED

all_keys_lock
Usage: samsung-mdc [OPTIONS] TARGET all_keys_lock [LOCK_STATE]

Turns both REMOCON and Panel Key Lock function on/off.

Note: Can operate regardless of whether power is on/off.

Data:
LOCK_STATE OFF | ON

panel_on_time
Usage: samsung-mdc [OPTIONS] TARGET panel_on_time

Get the device panel on total time.

Return value increased every 10 mins. To get hours use "MIN10 / 6".

Data:
MIN10 int

video_wall_state
Usage: samsung-mdc [OPTIONS] TARGET video_wall_state [VIDEO_WALL_STATE]

Get/Set the device in video wall state. This will split the primary input
source into smaller N number of squares and display them instead.

Note: The device needs to be capable of this operation. Usually a primary
high resolution source signal is daisy chained to lower resolution displays
in a video wall using HDMI/DP.

Data:
VIDEO_WALL_STATE OFF | ON

video_wall_model
Usage: samsung-mdc [OPTIONS] TARGET video_wall_model [MODEL SERIAL]

Get/Set video wall model.

MODEL: Size of the wall in (x, y) coordinates; ie. "2,2" or "4,1"

SERIAL: Serial number - position of the display in the video wall, counting
from the first display.

Note: Needs VIDEO_WALL_STATE to be ON.

Data:
MODEL Video Wall model (format: X,Y eg. 4,5)
SERIAL int (1-255)

model_name
Usage: samsung-mdc [OPTIONS] TARGET model_name

Data:
MODEL_NAME str

energy_saving
Usage: samsung-mdc [OPTIONS] TARGET energy_saving [ENERGY_SAVING_STATE]

Data:
ENERGY_SAVING_STATE OFF | LOW | MEDIUM | HIGH | PICTURE_OFF

reset
Usage: samsung-mdc [OPTIONS] TARGET reset RESET_TARGET

Data:
RESET_TARGET PICTURE | SOUND | SETUP | ALL | SCREEN_DISPLAY

osd_type
Usage: samsung-mdc [OPTIONS] TARGET osd_type [OSD_TYPE OSD_ENABLED]

Turns OSD (On-screen display) specific message types on/off.

Data:
OSD_TYPE SOURCE | NOT_OPTIMUM_MODE | NO_SIGNAL | MDC | SCHEDULE_CHANNEL
OSD_ENABLED bool

timer_13
Usage: samsung-mdc [OPTIONS] TARGET timer_13 TIMER_ID [ON_TIME ON_ENABLED
OFF_TIME OFF_ENABLED REPEAT MANUAL_WEEKDAY VOLUME
INPUT_SOURCE_STATE HOLIDAY_APPLY]

Integrated timer function (13 data-length version).

Note: This depends on product and will not work on newer versions.

Data:
TIMER_ID int (1-7)
ON_TIME time (format: %H:%M)
ON_ENABLED bool
OFF_TIME time (format: %H:%M)
OFF_ENABLED bool
REPEAT ONCE | EVERYDAY | MON_FRI | MON_SAT | SAT_SUN |
MANUAL_WEEKDAY
MANUAL_WEEKDAY list(,) SUN | MON | TUE | WED | THU | FRI | SAT
VOLUME int (0-100)
INPUT_SOURCE_STATE NONE | S_VIDEO | COMPONENT | AV | AV2 | SCART1 | DVI |
PC | BNC | DVI_VIDEO | MAGIC_INFO | HDMI1 | HDMI1_PC |
HDMI2 | HDMI2_PC | DISPLAY_PORT_1 | DISPLAY_PORT_2 |
DISPLAY_PORT_3 | RF_TV | HDMI3 | HDMI3_PC | HDMI4 |
HDMI4_PC | TV_DTV | PLUG_IN_MODE | HD_BASE_T | OCM |
MEDIA_MAGIC_INFO_S | WIDI_SCREEN_MIRRORING |
INTERNAL_USB | URL_LAUNCHER | IWB | WEB_BROWSER |
REMOTE_WORKSPACE
HOLIDAY_APPLY DONT_APPLY_BOTH | APPLY_BOTH | ON_TIMER_ONLY_APPLY |
OFF_TIMER_ONLY_APPLY

timer_15
Usage: samsung-mdc [OPTIONS] TARGET timer_15 TIMER_ID [ON_TIME ON_ENABLED
OFF_TIME OFF_ENABLED ON_REPEAT ON_MANUAL_WEEKDAY OFF_REPEAT
OFF_MANUAL_WEEKDAY VOLUME INPUT_SOURCE_STATE HOLIDAY_APPLY]

Integrated timer function (15 data-length version).

Note: This depends on product and will not work on older versions.

ON_TIME/OFF_TIME: turn ON/OFF display at specific time of day

ON_ACTIVE/OFF_ACTIVE: if timer is not active, values are ignored, so there
may be only OFF timer, ON timer, or both.

REPEAT: On which day timer is enabled (combined with HOLIDAY_APPLY and
MANUAL_WEEKDAY)

Data:
TIMER_ID int (1-7)
ON_TIME time (format: %H:%M)
ON_ENABLED bool
OFF_TIME time (format: %H:%M)
OFF_ENABLED bool
ON_REPEAT ONCE | EVERYDAY | MON_FRI | MON_SAT | SAT_SUN |
MANUAL_WEEKDAY
ON_MANUAL_WEEKDAY list(,) SUN | MON | TUE | WED | THU | FRI | SAT
OFF_REPEAT ONCE | EVERYDAY | MON_FRI | MON_SAT | SAT_SUN |
MANUAL_WEEKDAY
OFF_MANUAL_WEEKDAY list(,) SUN | MON | TUE | WED | THU | FRI | SAT
VOLUME int (0-100)
INPUT_SOURCE_STATE NONE | S_VIDEO | COMPONENT | AV | AV2 | SCART1 | DVI |
PC | BNC | DVI_VIDEO | MAGIC_INFO | HDMI1 | HDMI1_PC |
HDMI2 | HDMI2_PC | DISPLAY_PORT_1 | DISPLAY_PORT_2 |
DISPLAY_PORT_3 | RF_TV | HDMI3 | HDMI3_PC | HDMI4 |
HDMI4_PC | TV_DTV | PLUG_IN_MODE | HD_BASE_T | OCM |
MEDIA_MAGIC_INFO_S | WIDI_SCREEN_MIRRORING |
INTERNAL_USB | URL_LAUNCHER | IWB | WEB_BROWSER |
REMOTE_WORKSPACE
HOLIDAY_APPLY DONT_APPLY_BOTH | APPLY_BOTH | ON_TIMER_ONLY_APPLY |
OFF_TIMER_ONLY_APPLY

clock_m
Usage: samsung-mdc [OPTIONS] TARGET clock_m [DATETIME]

Current time function (minute precision).

Note: This is for models developed until 2013. For newer models see CLOCK_S
function (seconds precision).

Data:
DATETIME datetime (format: %Y-%m-%dT%H:%M / %Y-%m-%d %H:%M)

holiday_set
Usage: samsung-mdc [OPTIONS] TARGET holiday_set HOLIDAY_MANAGE START_MONTH
START_DAY END_MONTH END_DAY

Add/Delete the device holiday schedule with the holiday schedule itself
start month/day and end month/day.

Note: On DELETE_ALL all parameters should be 0x00.

Data:
HOLIDAY_MANAGE ADD | DELETE | DELETE_ALL
START_MONTH int (0-12)
START_DAY int (0-31)
END_MONTH int (0-12)
END_DAY int (0-31)

holiday_get
Usage: samsung-mdc [OPTIONS] TARGET holiday_get [INDEX]

Get the device holiday schedule.

If INDEX is not specified, returns total number of Holiday Information.

Data:
INDEX int

Response extra:
START_MONTH int
START_DAY int
END_MONTH int
END_DAY int

virtual_remote
Usage: samsung-mdc [OPTIONS] TARGET virtual_remote KEY_CODE

This function support that MDC command can work same as remote control.

Note: In a certain model, 0x79 CONTENT key works as HOME and 0x1F DISPLAY
key works as INFO.

Data:
KEY_CODE KEY_SOURCE | KEY_POWER | KEY_1 | KEY_2 | KEY_3 | KEY_VOLUME_UP |
KEY_4 | KEY_5 | KEY_6 | KEY_VOLUME_DOWN | KEY_7 | KEY_8 | KEY_9 |
KEY_MUTE | KEY_CHANNEL_DOWN | KEY_0 | KEY_CHANNEL_UP | KEY_GREEN |
KEY_YELLOW | KEY_CYAN | KEY_MENU | KEY_DISPLAY | KEY_DIGIT |
KEY_PIP_TV_VIDEO | KEY_EXIT | KEY_MAGICINFO | KEY_REW | KEY_STOP |
KEY_PLAY | KEY_FF | KEY_PAUSE | KEY_TOOLS | KEY_RETURN |
KEY_MAGICINFO_LITE | KEY_CURSOR_UP | KEY_CURSOR_DOWN |
KEY_CURSOR_RIGHT | KEY_CURSOR_LEFT | KEY_ENTER | KEY_RED |
KEY_LOCK | KEY_CONTENT | DISCRET_POWER_OFF | KEY_3D

network_standby
Usage: samsung-mdc [OPTIONS] TARGET network_standby [NETWORK_STANDBY_STATE]

Data:
NETWORK_STANDBY_STATE OFF | ON

dst
Usage: samsung-mdc [OPTIONS] TARGET dst [DST_STATE START_MONTH START_WEEK
START_WEEKDAY START_TIME END_MONTH END_WEEK END_WEEKDAY
END_TIME OFFSET]

Data:
DST_STATE OFF | AUTO | MANUAL
START_MONTH JAN | FEB | MAR | APR | MAY | JUN | JUL | AUG | SEP | OCT |
NOV | DEC
START_WEEK WEEK_1 | WEEK_2 | WEEK_3 | WEEK_4 | WEEK_LAST
START_WEEKDAY SUN | MON | TUE | WED | THU | FRI | SAT
START_TIME time (format: %H:%M)
END_MONTH JAN | FEB | MAR | APR | MAY | JUN | JUL | AUG | SEP | OCT |
NOV | DEC
END_WEEK WEEK_1 | WEEK_2 | WEEK_3 | WEEK_4 | WEEK_LAST
END_WEEKDAY SUN | MON | TUE | WED | THU | FRI | SAT
END_TIME time (format: %H:%M)
OFFSET PLUS_1_00 | PLUS_2_00

Response extra:
TUNER_SUPPORT bool

auto_id_setting
Usage: samsung-mdc [OPTIONS] TARGET auto_id_setting [AUTO_ID_SETTING_STATE]

Data:
AUTO_ID_SETTING_STATE START | END

display_id
Usage: samsung-mdc [OPTIONS] TARGET display_id DISPLAY_ID_STATE

Data:
DISPLAY_ID_STATE OFF | ON

clock_s
Usage: samsung-mdc [OPTIONS] TARGET clock_s [DATETIME]

Current time function (second precision).

Note: This is for models developed after 2013. For older models see CLOCK_M
function (minute precision).

Data:
DATETIME datetime (format: %Y-%m-%dT%H:%M:%S / %Y-%m-%d %H:%M:%S)

launcher_play_via
Usage: samsung-mdc [OPTIONS] TARGET launcher_play_via [PLAY_VIA_MODE]

Data:
PLAY_VIA_MODE MAGIC_INFO | URL_LAUNCHER | MAGIC_IWB

launcher_url_address
Usage: samsung-mdc [OPTIONS] TARGET launcher_url_address [URL_ADDRESS]

Data:
URL_ADDRESS str

osd_menu_orientation
Usage: samsung-mdc [OPTIONS] TARGET osd_menu_orientation
[ORIENTATION_MODE_STATE]

Data:
ORIENTATION_MODE_STATE LANDSCAPE_0 | PORTRAIT_270 | LANDSCAPE_180 |
PORTRAIT_90

osd_source_content_orientation
Usage: samsung-mdc [OPTIONS] TARGET osd_source_content_orientation
[ORIENTATION_MODE_STATE]

Data:
ORIENTATION_MODE_STATE LANDSCAPE_0 | PORTRAIT_270 | LANDSCAPE_180 |
PORTRAIT_90

osd_aspect_ratio
Usage: samsung-mdc [OPTIONS] TARGET osd_aspect_ratio [ASPECT_RATIO_STATE]

Get/Set the device aspect ratio under portrait mode which set the rotated
screen to be full or original.

Data:
ASPECT_RATIO_STATE FULL_SCREEN | ORIGINAL

osd_pip_orientation
Usage: samsung-mdc [OPTIONS] TARGET osd_pip_orientation
[ORIENTATION_MODE_STATE]

Data:
ORIENTATION_MODE_STATE LANDSCAPE_0 | PORTRAIT_270 | LANDSCAPE_180 |
PORTRAIT_90

osd_menu_size
Usage: samsung-mdc [OPTIONS] TARGET osd_menu_size [MENU_SIZE_STATE]

Data:
MENU_SIZE_STATE ORIGINAL | MEDIUM | SMALL

auto_source_switch
Usage: samsung-mdc [OPTIONS] TARGET auto_source_switch
[AUTO_SOURCE_SWITCH_STATE]

Data:
AUTO_SOURCE_SWITCH_STATE OFF | ON

auto_source
Usage: samsung-mdc [OPTIONS] TARGET auto_source [PRIMARY_SOURCE_RECOVERY
PRIMARY_SOURCE SECONDARY_SOURCE]

Data:
PRIMARY_SOURCE_RECOVERY OFF | ON
PRIMARY_SOURCE NONE | S_VIDEO | COMPONENT | AV | AV2 | SCART1 |
DVI | PC | BNC | DVI_VIDEO | MAGIC_INFO | HDMI1 |
HDMI1_PC | HDMI2 | HDMI2_PC | DISPLAY_PORT_1 |
DISPLAY_PORT_2 | DISPLAY_PORT_3 | RF_TV | HDMI3 |
HDMI3_PC | HDMI4 | HDMI4_PC | TV_DTV | PLUG_IN_MODE
| HD_BASE_T | OCM | MEDIA_MAGIC_INFO_S |
WIDI_SCREEN_MIRRORING | INTERNAL_USB | URL_LAUNCHER
| IWB | WEB_BROWSER | REMOTE_WORKSPACE
SECONDARY_SOURCE NONE | S_VIDEO | COMPONENT | AV | AV2 | SCART1 |
DVI | PC | BNC | DVI_VIDEO | MAGIC_INFO | HDMI1 |
HDMI1_PC | HDMI2 | HDMI2_PC | DISPLAY_PORT_1 |
DISPLAY_PORT_2 | DISPLAY_PORT_3 | RF_TV | HDMI3 |
HDMI3_PC | HDMI4 | HDMI4_PC | TV_DTV | PLUG_IN_MODE
| HD_BASE_T | OCM | MEDIA_MAGIC_INFO_S |
WIDI_SCREEN_MIRRORING | INTERNAL_USB | URL_LAUNCHER
| IWB | WEB_BROWSER | REMOTE_WORKSPACE

panel
Usage: samsung-mdc [OPTIONS] TARGET panel [PANEL_STATE]

Data:
PANEL_STATE ON | OFF

script
Usage: samsung-mdc [OPTIONS] TARGET script [OPTIONS] SCRIPT_FILE

Script file with commands to execute.

Commands for multiple targets will be running async, but commands order is
preserved for device (and is running on same connection), exit on first fail
unless retry options provided.

You may use jinja2 templating engine to {% include "other_script" %} or {{
VAR_KEY }} rendering in combination with --var VAR_KEY VAR_VALUE options.

It's highly recommended to use sleep option for virtual_remote!

Additional commands:
sleep SECONDS (FLOAT, --sleep option for this command is ignored)
disconnect

Format:
command1 [ARGS]...
command2 [ARGS]...

Example: samsung-mdc ./targets.txt script -s 3 -r 1 -v KEY enter ./commands.txt
# commands.txt content
power on
sleep 5
clear_menu
virtual_remote key_menu
virtual_remote key_down
virtual_remote {{ KEY }}
clear_menu

Arguments:
script_file Text file with commands, separated by newline.

Options:
-s, --sleep FLOAT Pause between commands (seconds)
--retry-command INTEGER Retry command if failed (count)
--retry-command-sleep FLOAT Sleep before command retry (seconds)
-r, --retry-script INTEGER Retry script if failed (count)
--retry-script-sleep FLOAT Sleep before script retry (seconds)
--ignore-nak Ignore negative acknowledgement errors
-v, --var NAME VALUE Variable "{{ NAME }}" in script will be
replaced by VALUE
--help Show this message and exit.

raw
Usage: samsung-mdc [OPTIONS] TARGET raw [OPTIONS] COMMAND [DATA]

Helper command to send raw data for test purposes.

Arguments:
command Command and (optionally) subcommand (example: a1 or a1:b2)
data Data payload if any (example: a1:b2)

Troubleshooting
Finding DISPLAY ID
On most devices it's usually 0 or 1. Some devices may use 255 (0xFF) or 254 (0xFE) as all/any display, but behavior in such cases for more than 1 display is undefined.
Display id can be found using remote control: Home -> ID Settings.
NAKError
If you receive NAK errors on some commands, you may try to:

Ensure that device is powered on and completely loaded
Switch to input source HDMI1
Reboot device
Reset all settings
Disable MagicINFO
Factory reset (using "Service Menu")

Python example
import asyncio
from samsung_mdc import MDC


async def main(ip, display_id):
async with MDC(ip, verbose=True) as mdc:
# First argument of command is always display_id
status = await mdc.status(display_id)
print(status) # Result is always tuple

if status[0] != MDC.power.POWER_STATE.ON:
# Command arguments are always Sequence (tuple, list)
await mdc.power(display_id, [MDC.power.POWER_STATE.ON])
await mdc.close() # Force reconnect on next command
await asyncio.sleep(15)

await mdc.display_id(display_id, [MDC.display_id.DISPLAY_ID_STATE.ON])
# You may also use names or values instead of enums
await mdc.display_id(display_id, ['ON']) # same
await mdc.display_id(display_id, [1]) # same


# If you see "Connected" and timeout error, try other display_id (0, 1)
asyncio.run(main('192.168.0.10', 1))