This project is a library for remote controlling Samsung televisions via a TCP/IP connection.
It currently supports modern (post-2016) TVs with Ethernet or Wi-Fi connectivity. They should be all models with TizenOs.
This fork is based on https://github.com/xchwarze/samsung-tv-ws-api work
Origionally Based on https://github.com/marysieek/samsung-tv-api work
This fork is intened to provide extended support to Frame TV's.
First clone this repository to your local drive (make sure you have git installed):
git clone https://github.com/NickWaterton/samsung-tv-ws-api.git
Then change to the samsung-tv-ws-api directory:
cd samsung-tv-ws-api
Now run install:
python ./setup.py install
You can also install directly from git using pip (your command may be pip or pip3 depending on your setup):
pip install git+https://github.com/NickWaterton/samsung-tv-ws-api.gitOr from the git clone:
git clone https://github.com/NickWaterton/samsung-tv-ws-api.git
pip install "./samsung-tv-ws-api"$ pip3 install samsungtvws[async,encrypted]or
$ pip3 install "git+https://github.com/xchwarze/samsung-tv-ws-api.git#egg=samsungtvws[async,encrypted]"or...!
$ git clone https://github.com/xchwarze/samsung-tv-ws-api
$ pip3 install "./samsung-tv-ws-api[async,encrypted]"async is required if you wish to use asynchronous I/O for all communications with the TV (SamsungTVAsyncRest and SamsungTVWSAsyncRemote)
encrypted is required if you wish to communicate with a TV which only support the v1 API (some J and K models) for sending commands (SamsungTVEncryptedWSAsyncRemote and SamsungTVEncryptedWSAsyncAuthenticator).
import sys
import os
import logging
import wakeonlan
sys.path.append('../')
from samsungtvws import SamsungTVWS
# Increase debug level
logging.basicConfig(level=logging.INFO)
# Normal constructor
tv = SamsungTVWS('192.168.xxx.xxx')
# Autosave token to file
token_file = os.path.dirname(os.path.realpath(__file__)) + '/tv-token.txt'
tv = SamsungTVWS(host='192.168.xxx.xxx', port=8002, token_file=token_file)
# Toggle power
tv.shortcuts().power()
# Power On
wakeonlan.send_magic_packet('CC:6E:A4:xx:xx:xx')
# Open web in browser
tv.open_browser('https://duckduckgo.com/')
# View installed apps
apps = tv.app_list()
logging.info(apps)
# Open app (Spotify)
tv.run_app('3201606009684')
# Get app status (Spotify)
app = tv.rest_app_status('3201606009684')
logging.info(app)
# Open app (Spotify)
app = tv.rest_app_run('3201606009684')
logging.info(app)
# Close app (Spotify)
app = tv.rest_app_close('3201606009684')
logging.info(app)
# Install from official store (Spotify)
app = tv.rest_app_install('3201606009684')
logging.info(app)
# Get device info (device name, model, supported features..)
info = tv.rest_device_info()
logging.info(info)Art mode has been updated to support all Frame TV's including 2021/22/23 and 2024 models.
NOTE: The async library is more reliable/robust than the regular library, so I reccomend you use that if possible. See the async_art examples.
If you use and like this library for art mode, Buy me a coffee.
TVs that support art mode (such as The Frame) can be controlled as follows:
import sys
import logging
sys.path.append('../')
from samsungtvws import SamsungTVWS
# Increase debug level
logging.basicConfig(level=logging.INFO)
# Normal constructor
tv = SamsungTVWS('192.168.xxx.xxx')
# Is art mode supported?
info = tv.art().supported()
logging.info(info)
# List the art available on the device
info = tv.art().available()
logging.info(info)
# Retrieve information about the currently selected art
info = tv.art().get_current()
logging.info(info)
# Retrieve a thumbnail for a specific piece of art. Returns a JPEG.
thumbnail = tv.art().get_thumbnail('SAM-F0206')
# Set a piece of art
tv.art().select_image('SAM-F0206')
# Set a piece of art, but don't immediately show it if not in art mode
tv.art().select_image('SAM-F0201', show=False)
# Determine whether the TV is currently in art mode
info = tv.art().get_artmode()
logging.info(info)
# Switch art mode on or off
tv.art().set_artmode(True)
tv.art().set_artmode(False)
# Upload a picture
file = open('test.png', 'rb')
data = file.read()
tv.art().upload(data)
# If uploading a JPEG
tv.art().upload(data, file_type='JPEG')
# To set the matte to modern and apricot color
tv.art().upload(data, matte='modern_apricot')
# Delete an uploaded item
tv.art().delete('MY-F0020')
# Delete multiple uploaded items
tv.art().delete_list(['MY-F0020', 'MY-F0021'])
# List available photo filters
info = tv.art().get_photo_filter_list()
logging.info(info)
# Apply a filter to a specific piece of art
tv.art().set_photo_filter('SAM-F0206', 'ink')Examples are available in the examples folder: async_remote.py, async_rest.py
Frame TV art examples are available in async_art.py, async_art_slideshow_anything.py, async_art_update_from_directry.py
Examples are available in the examples folder: encrypted_authenticator.py, encrypted_remote.py
List of support TV models. https://developer.samsung.com/smarttv/develop/extension-libraries/smart-view-sdk/supported-device/supported-tvs.html
2024 : LS03D
2022/23 : LS03B/C
2021 : LS03A
2017 : M5500 and above
2016 : K4300, K5300 and above
2015 : J5500 and above (except J6203)
2014 : H4500, H5500 and above (except H6003/H6103/H6153/H6201/H6203)
Supported TV models may vary by region.
For complete list https://developer.samsung.com/smarttv/develop/specifications/tv-model-groups.html
LGPL-3.0