Skip to main content

Async Samsung 2024+ TV control via the HTTPS JSON-RPC interface

Project description

py-samsungtv

py-samsungtv is an async Python library that talks to Samsung TVs over HTTPS JSON-RPC.

Why

Samsung, in their infinite wisdom, disabled ports 8001 and 8002. This breaks the existing Home Assistant integration/libraries for all 2024+ models. They still expose their JSON-RPC over port 1516/1515, but it is undocumented.

I got frustrated enough to do a clean-room implemenation of it here.

Installation

# pypi
pip install py-samsungtv

# local dev
just install

The package depends on aiohttp for HTTP/1.1 TLS transport. TLS verification is disabled by default because Samsung panels present self-signed certificates; set verify_ssl=True when the certificate chain is trusted on your host.

Usage

Check tests for example usage.

Every helper method corresponds to the JSON-RPC methods in the protocol notes (e.g. get_tv_states, direct_channel_control, volume_up_down, remote_key_control, sound_mode_control, etc). Each coroutine returns the parsed result body or raises a SamsungTVError subclass on transport/protocol failures. Custom RPCs can be issued with SamsungTVClient.send_request().

The optional on_update callback is invoked sequentially after every response. It receives the RPC method name and the parsed payload, making it easy to wire into Home Assistant's entity update routines.

Development

  • Install and run pre-commit (pip install pre-commit && pre-commit install) to ensure mypy and pytest pass locally before committing.
  • All code is typed and passes mypy using the configuration in pyproject.toml.
  • Run the test suite with pytest. Unit tests use fully mocked transports.
  • Integration tests require a real TV: set SAMSUNG_TV_HOST (plus optional SAMSUNG_TV_PORT and/or SAMSUNG_TV_TOKEN) and run pytest -m integration. If no token is supplied the first run will prompt for authorization and cache the returned token under .pytest_cache/samsung_tv_token for later runs.
  • A Justfile is included for convenience: just install, just install-tests, just test, just mypy, etc.
  • All command inputs are exposed as enums in samsungtv.enums (also re-exported at the package root) so you can rely on autocomplete/validation for things like InputSource, PictureMode, SoundMode, and RemoteKey.
  • Convenience helpers such as set_picture_mode, set_sound_mode, select_speaker, select_input_source, set_volume, mute()/unmute(), and art_mode_on()/art_mode_off() call the corresponding *_control RPCs for you.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

py_samsungtv-1.0.0.tar.gz (10.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

py_samsungtv-1.0.0-py3-none-any.whl (11.4 kB view details)

Uploaded Python 3

File details

Details for the file py_samsungtv-1.0.0.tar.gz.

File metadata

  • Download URL: py_samsungtv-1.0.0.tar.gz
  • Upload date:
  • Size: 10.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for py_samsungtv-1.0.0.tar.gz
Algorithm Hash digest
SHA256 8d6c24bbc80733beb38dcc4098ab6acd696c5ade1225db0cb14b9526a596405f
MD5 36fb408c43c3d35c162c02088f82e36a
BLAKE2b-256 48b540e9477151240da611ee9028404958432f44754f9bb7ec9ca90bd92b02d7

See more details on using hashes here.

Provenance

The following attestation bundles were made for py_samsungtv-1.0.0.tar.gz:

Publisher: publish.yaml on iloveicedgreentea/py-samsungtv

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file py_samsungtv-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: py_samsungtv-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 11.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for py_samsungtv-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1b9e354f901f83e384120ddcbf92c816277dc0257c90d72bd3d43dd72c4c3038
MD5 d1b90f424c381bdc78458fac462c2862
BLAKE2b-256 207f168773a54a2e5e5d17c324fdd0785284b41eb7e71cce80226e95fa755293

See more details on using hashes here.

Provenance

The following attestation bundles were made for py_samsungtv-1.0.0-py3-none-any.whl:

Publisher: publish.yaml on iloveicedgreentea/py-samsungtv

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page