Skip to main content

Async client for old Samsung air conditioners using the DPLUG/AC14K protocol (TLS, port 2878)

Project description

pysamsung-dplug

Async Python client for old Samsung air conditioners that speak the legacy DPLUG / AC14K protocol over TLS on port 2878 (Wi-Fi modules such as SWL-B70F, used by the AR**HSFS generation, ~2013–2015).

These units were dropped by SmartThings. This library lets you control them locally again — no cloud. It is the protocol layer used by the samsung_ac_dplug Home Assistant integration, but works standalone.

Features

  • Mutual-TLS handshake with the bundled Samsung client certificate (legacy TLS 1.0 / weak ciphers handled for you).
  • Token acquisition (GetToken), authentication (AuthToken).
  • Read full device state (DeviceState) and send commands (DeviceControl).
  • Auto-discover the device id (DeviceList) and a passive async_probe().
  • Live push updates with auto-reconnect (SamsungAcStream), alongside the short-lived-connection SamsungAcClient.
  • On-device scheduling: read, create/edit and delete the unit's built-in schedules, with local↔UTC time conversion.
  • Capability decoding from AC_ADD2_OPTIONCODE (OptionCode), the device clock, firmware versions, and Wi-Fi provisioning for AP-mode onboarding.

Install

pip install pysamsung-dplug

Usage

import asyncio
from samsung_dplug import SamsungAcClient, build_ssl_context

async def main():
    ctx = build_ssl_context()                      # uses the bundled certificate
    client = SamsungAcClient("192.168.1.53", token="xxxxxxxx-....", ssl_context=ctx)
    state = await client.async_get_state()
    print("Power:", state["AC_FUN_POWER"], "Room:", state["AC_FUN_TEMPNOW"])
    await client.async_set("AC_FUN_POWER", "On")

asyncio.run(main())

Getting a token

The unit only issues a token at power-on (a physical proof-of-access step):

client = SamsungAcClient("192.168.1.53", ssl_context=ctx)
# turn the unit OFF, call this, then turn it ON within ~30 s:
token = await client.async_get_token()

build_ssl_context() does blocking file I/O; inside async frameworks run it in an executor (e.g. Home Assistant: await hass.async_add_executor_job(build_ssl_context)).

On-device schedules

The unit has a built-in scheduler that runs off its own clock, even with nothing connected. Times are stored in UTC; pass your local tzinfo and the library converts both ways.

from zoneinfo import ZoneInfo
from samsung_dplug import Schedule, EVERYWEEK, weekdays_to_mask

tz = ZoneInfo("Europe/Rome")
await client.async_get_schedules(tz=tz)            # -> list[Schedule] (local time)
await client.async_set_schedule(                   # turn on at 07:00 on weekdays
    Schedule(hour=7, minute=0, repeat=EVERYWEEK,
             days=weekdays_to_mask(range(5)),       # Mon–Fri
             attrs={"AC_FUN_POWER": "On"}),
    tz=tz,
)
await client.async_delete_schedule("0")

Protocol notes

Reverse-engineered from the official Smart Air Conditioner app and live devices. The unit greets with DPLUG-1.x, requires mutual TLS, and uses an XML request/response protocol. The DUID equals the Wi-Fi module MAC without separators. See the Home Assistant integration repo for the full write-up.

License

MIT

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

pysamsung_dplug-0.9.1.tar.gz (21.3 kB view details)

Uploaded Source

Built Distribution

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

pysamsung_dplug-0.9.1-py3-none-any.whl (24.0 kB view details)

Uploaded Python 3

File details

Details for the file pysamsung_dplug-0.9.1.tar.gz.

File metadata

  • Download URL: pysamsung_dplug-0.9.1.tar.gz
  • Upload date:
  • Size: 21.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pysamsung_dplug-0.9.1.tar.gz
Algorithm Hash digest
SHA256 483dc1a77e0a614b2721398f294f8ed6461e5f22e350c5af7eb9a7be0140bce0
MD5 9cd64c8f8a16dcf585f4e31ebac56d47
BLAKE2b-256 16e57c7af9a93d4fb67528133807ab866c01b530d130c0835ad9a85a91579e63

See more details on using hashes here.

Provenance

The following attestation bundles were made for pysamsung_dplug-0.9.1.tar.gz:

Publisher: publish.yml on porech/pysamsung-dplug

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

File details

Details for the file pysamsung_dplug-0.9.1-py3-none-any.whl.

File metadata

  • Download URL: pysamsung_dplug-0.9.1-py3-none-any.whl
  • Upload date:
  • Size: 24.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pysamsung_dplug-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 76a77f516a5ecd745c0274aebe3ebd7693583dfd80b30dc7b907cc741710f922
MD5 cebf117c2c2708271b55bf86025fbaae
BLAKE2b-256 1374d2d1cfeef9daaa22b7ddc2330dab79865c6e9e071e60dbded64029d962bb

See more details on using hashes here.

Provenance

The following attestation bundles were made for pysamsung_dplug-0.9.1-py3-none-any.whl:

Publisher: publish.yml on porech/pysamsung-dplug

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