samsungframetv 4.0.0__tar.gz

samsungframetv-4.0.0/LICENSE

@@ -0,0 +1,166 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
+

samsungframetv-4.0.0/PKG-INFO

@@ -0,0 +1,314 @@
+Metadata-Version: 2.4
+Name: samsungframetv
+Version: 4.0.0
+Summary: Samsung Smart TV and Frame TV art mode API (websocket, REST and IP Control)
+Author: Xchwarze
+Author-email: Nick Waterton <n.waterton@outlook.com>
+License-Expression: LGPL-3.0-only
+Project-URL: Homepage, https://github.com/NickWaterton/samsung-tv-ws-api
+Project-URL: Issues, https://github.com/NickWaterton/samsung-tv-ws-api/issues
+Keywords: samsung,frame,tv,art mode,tizen,websocket
+Classifier: Programming Language :: Python :: 3
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Home Automation
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: websocket-client>=0.57.0
+Requires-Dist: requests>=2.21.0
+Requires-Dist: aiohttp>=3.8.1
+Requires-Dist: websockets>=13
+Requires-Dist: async_timeout>=4.0.3
+Provides-Extra: async
+Provides-Extra: encrypted
+Requires-Dist: cryptography>=35.0.0; extra == "encrypted"
+Requires-Dist: py3rijndael>=0.3.3; extra == "encrypted"
+Dynamic: license-file
+
+<p align="center">
+    <img src="https://user-images.githubusercontent.com/5860071/47255992-611d9b00-d481-11e8-965d-d9816f254be2.png" width="300px" border="0" />
+    <br/>
+    <a href="https://pypi.org/project/samsungframetv/">
+        <img src="https://img.shields.io/pypi/v/samsungframetv.svg?style=flat-square" alt="Version">
+    </a>
+    Samsung Smart TV WS API wrapper
+</p>
+
+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
+
+Originally based on https://github.com/marysieek/samsung-tv-api work
+
+## Install
+
+This fork is intended to provide extended support for Frame TV's. From version 4.0.0 it is published on PyPI as `samsungframetv` (the `samsungtvws` name belongs to the original project):
+
+```bash
+pip install samsungframetv
+```
+
+With the optional extras:
+
+```bash
+pip install "samsungframetv[async,encrypted]"
+```
+
+Or install the latest code directly from git:
+
+```bash
+pip install git+https://github.com/NickWaterton/samsung-tv-ws-api.git
+```
+
+Or from a clone, in developer mode:
+
+```bash
+git clone https://github.com/NickWaterton/samsung-tv-ws-api.git
+cd samsung-tv-ws-api
+pip install --editable .
+```
+
+### Upgrading from samsungframetv
+
+The package was renamed from `samsungtvws` to `samsungframetv` in version 4.0.0. The API is unchanged, so new code only needs the new import:
+
+```python
+from samsungframetv import SamsungTVWS
+from samsungframetv.async_art import SamsungTVAsyncArt
+```
+
+If you have existing code (or an app you can't change) that does `import samsungtvws`, install the compatibility package as well. It maps every `samsungtvws` import onto `samsungframetv`:
+
+```bash
+pip uninstall samsungtvws
+pip install samsungframetv-compat
+```
+
+Uninstall `samsungtvws` first, as both packages provide a `samsungtvws` module. The compatibility package will be kept for at least the 4.x releases.
+
+### Install Original
+
+The original project, which this fork is based on, is available as:
+
+```bash
+pip install "samsungtvws[async,encrypted]"
+```
+
+### Extras
+
+`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`).
+
+## Usage
+
+### Basic
+
+```python
+import sys
+import os
+import logging
+import wakeonlan
+
+sys.path.append('../')
+
+from samsungframetv 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
+
+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.
+
+Older Frames (2017 and 2018, art API below 2, eg `0.97` or `1.07`) handle uploads and thumbnails differently. `upload()` sends the image in one binary websocket message, as the SmartThings app does, and `get_thumbnail()` reads thumbnails that arrive inline. This is chosen automatically from `get_api_version()`. `get_matte_list()` also accepts the 2018 reply format (`matte_types`). These paths are based on reports from 2017 and 2018 owners and have not been tested here, so please open an issue with debug logs if they don't work on your TV.
+
+If the TV rejects the connection with `ms.channel.timeOut`, the library raises `ChannelTimeoutError` (a `ConnectionFailure`). This usually means the token is missing, or belongs to another TV, so use a separate token file for each TV.
+
+If you use and like this library for art mode, [Buy me a coffee](https://paypal.me/NWaterton).
+
+TVs that support art mode (such as The Frame) can be controlled as follows:
+
+```python
+import sys
+import logging
+
+sys.path.append('../')
+
+from samsungframetv 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')
+```
+
+### Power State and IP Control
+
+`get_power_state()` returns one of `off`, `standby`, `tv`, `art`, or `on` (on, but art mode could not be determined). It combines the REST api, the art channel and, if you have paired it, Samsung IP Control.
+
+IP Control (JSON-RPC on port 1516, 1515 on pre 2020 TV's) is the most reliable source of power state, and can also switch inputs and power the TV on and off without SmartThings. Enable it on the TV in *Settings > General > Network > Expert Settings > IP Remote*. Pairing only works when the TV is on and **not** in art mode, press Allow on the TV.
+
+```python
+from samsungframetv import SamsungTVWS
+from samsungframetv.ipcontrol import SamsungTVIPControl
+
+ipc = SamsungTVIPControl('192.168.xxx.xxx', token_file='ipcontrol_token.txt')
+if not ipc.token:
+    ipc.pair()                      # press Allow on the TV
+
+tv = SamsungTVWS('192.168.xxx.xxx')
+print(tv.art().get_power_state(ipc))   # eg 'art'
+ipc.set_input_source('HDMI2')       # only works when watching TV, not in art mode
+```
+
+For asyncio use `SamsungTVAsyncIPControl` with `SamsungTVAsyncArt.get_power_state()`.
+
+Notes from testing 2021 and 2022 Frames: in standby the 2022 still answers IP Control with `powerOff` but keeps reporting art mode on, the 2021 refuses the connection. 2025 Frames report REST `PowerState: standby` while in art mode, `in_artmode()` and `get_power_state()` allow for this.
+
+### Async
+
+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`
+
+#### Timeouts and recovery (async)
+
+- Opening a connection gives up after `timeout` seconds (10 if not set), or 60 seconds when there is no token yet, so there is time to press Allow on the TV. A TV that accepts the connection and never answers raises `ConnectionFailure` instead of hanging.
+- If the TV drops the connection (common soon after standby), the next command reconnects once, resumes listening with the same callback, and resends.
+- An exception in your callback is logged, and the listener keeps running.
+- The art service can stop answering while the TV is otherwise fine (seen on 2022 Frames). After 3 art requests in a row get no answer, `SamsungTVAsyncArt` closes the connection, and for the next 30 seconds art requests raise `ArtServiceUnavailableError` straight away instead of waiting. If the TV still doesn't answer after that, the pause doubles each time, up to 4 minutes. `ArtServiceUnavailableError` is a subclass of `AssertionError`, so existing `except AssertionError` handlers still catch it.
+
+```python
+from samsungframetv.exceptions import ArtServiceUnavailableError
+
+if not tv.art_service_available:
+    print('art service is not answering')
+tv.reset_art_service()   # eg when you know the TV has just been turned on
+```
+
+### Encrypted API
+
+Examples are available in the examples folder: `encrypted_authenticator.py`, `encrypted_remote.py`
+
+## Supported TVs
+
+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
+
+## License
+
+LGPL-3.0