samsung-mdc(1)

💖 NAME 💖

okay so bestie, this is the manual for samsung-mdc(1) — and it's literally the Samsung Multiple Display Control Protocol. periodt. 💅

✨ SYNOPSIS ✨

Try `samsung-mdc --help COMMAND` for help on individual commands.

<cyan>TARGET</cyan> may be:

- `DISPLAY_ID@IP[:PORT]` — default port: `1515`, example: `0@192.168.0.10:1515`
- `FILENAME` with target list, separated by newline.

Commands run <purple>asynchronously</purple> when targeting multiple devices, so the order of operations may differ. 😭

To connect via serial port, use:

- `DISPLAY_ID@PORT_NAME` for Windows (example: `1@COM1`)
- `DISPLAY_ID@PORT_PATH` for Linux (example: `1@/dev/ttyUSB0`).

Samsung-MDC tries to determine the connection mode from the port name, but you may want to specify the mode using `--mode`.

---

# 🌸 DESCRIPTION 🌸

Samsung-MDC is an implementation of the Samsung Multiple Display Control Protocol using <yellow>python</yellow> and <yellow>asyncio</yellow>.

Samsung-MDC enables control of compatible Samsung displays through their built-in <mint>RS-232C</mint> or <mint>Ethernet</mint> interface.

## 🎀 Command-line options 🎀

- `--version` — Show program version and exit.
- `-v`, `--verbose` — Enable verbose output.
- `-m`, `--mode [auto|tcp|serial]` — Connection mode (default: auto).
- `-p`, `--pin INTEGER` — 4-digit PIN for secure TLS connection. If a PIN is provided, "Secured Protocol" must be enabled on the remote device.
- `-t`, `--timeout FLOAT` — Read/Write/Connect timeout in seconds (default: 5). Connect can be overridden with a separate option.
- `--connect-timeout FLOAT` — Connect timeout in seconds.
- `-h`, `--help` — Show this message and exit.

---

# 👑 OPTIONS 👑

okay bestie, here's the full command menu, <hotpink>no skips, no cap</hotpink>. every single one, with its exact args, in order. 💅

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

---

# 🐛 REPORTING BUGS 🐛

Samsung-MDC is maintained on GitHub. Please report all bugs to the issue tracker at <blue>`https://github.com/vgavro/samsung-mdc/issues`</blue>

---

and that's the whole manual, bestie! this iconic page is <rainbow>`samsung-mdc(1)`</rainbow>, dated <yellow>`2024-07-18`</yellow>. slay. 💅✨