pysamsungnasa
A Python library to communicate with Samsung heat pumps, in theory both cool only and cool+heat units are supported, although only tested on an EHS unit (cool+heat)
Features
- Connect and disconnect from Samsung HVAC/EHS units via a serial connection over the F1/F2 connectors using SerialX (NasaClient).
- Discover new devices on the NASA network and manage known devices (SamsungNasa).
- Send commands to devices and handle responses (SamsungNasa, NasaClient).
- Parse incoming data packets from devices (NasaPacketParser, various message classes).
- Represent devices with attributes and control their functions (NasaDevice).
- Control DHW (Domestic Hot Water) settings like power, operation mode, and target temperature (DhwController).
- Control climate settings like power, mode, target temperature, fan speed, and more (ClimateController).
- Provide a mechanism for callbacks to be notified of device and packet updates (NasaDevice).
- Support reading device configurations (NasaDevice).
- Handle message construction and parsing based on message types (protocol.factory).
- Define specific message formats for indoor and outdoor units (protocol.factory.messages).
Future plans
These might not end up happening, but I would like to have a go at creating these one day.
- Simulate a remote controller for a "dummy" zone 2
- Send custom Z1/Z2 temperature readings to the master controller
- Implement TPI/load awareness/preditive model algorithms for an advanced complete custom controller
Installation
pip install pysamsungnasa
Usage
TODO
Configuration
TODO
Contributing
TODO
Thanks
This project utilizes or incorporates ideas, code and work from the following sources, and I would like to express my sincere gratitude to their creators and contributors:
- ESPHome Samsung HVAC Bus
- Samsung NASA MQTT Bridge
- Samsung ASHP NASA link MQTT bridge / Home Assistant
- OpenEnergyMonitoring Forum for all the shared wisdom on multiple threads.
- @betaphi for the EHS Wiki, which provided valuable insights into different messages. The protocol is mostly documented here as the NASA Protocol page is no longer on the wiki. More messages are defined within the parser classes from the latest version of S-Net.
None of this would have been possible without the above.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pysamsungnasa-2.0.0.tar.gz.
File metadata
- Download URL: pysamsungnasa-2.0.0.tar.gz
- Upload date:
- Size: 77.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ade4857ca8d8693f3abfe0b57a2aa0aede14dd530db21b5d6505a06478e668a6
|
|
| MD5 |
1521f98041a1e5595592564d20ef9635
|
|
| BLAKE2b-256 |
d059b872bf4642647af7ab8282bebd0c6d57cb13943a5f1b03baf0efc4c6c750
|
Provenance
The following attestation bundles were made for pysamsungnasa-2.0.0.tar.gz:
Publisher:
release.yml on pantherale0/pysamsungnasa
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pysamsungnasa-2.0.0.tar.gz -
Subject digest:
ade4857ca8d8693f3abfe0b57a2aa0aede14dd530db21b5d6505a06478e668a6 - Sigstore transparency entry: 2407508582
- Sigstore integration time:
-
Permalink:
pantherale0/pysamsungnasa@c51195b7623b31c7d9e466183b837ec334558c86 -
Branch / Tag:
refs/tags/2.0.0 - Owner: https://github.com/pantherale0
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@c51195b7623b31c7d9e466183b837ec334558c86 -
Trigger Event:
release
-
Statement type:
File details
Details for the file pysamsungnasa-2.0.0-py3-none-any.whl.
File metadata
- Download URL: pysamsungnasa-2.0.0-py3-none-any.whl
- Upload date:
- Size: 80.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
71478ff154231b7f715d7348a30fdafa2fc0efe417afc6d33293b85e778aa419
|
|
| MD5 |
0dd9c3f4e93cbcb71c31f40b90a32441
|
|
| BLAKE2b-256 |
4d08ef7497fdadf824962bdf4e11a2d2e76a00e1f74b1ab45fb67652a671eee9
|
Provenance
The following attestation bundles were made for pysamsungnasa-2.0.0-py3-none-any.whl:
Publisher:
release.yml on pantherale0/pysamsungnasa
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pysamsungnasa-2.0.0-py3-none-any.whl -
Subject digest:
71478ff154231b7f715d7348a30fdafa2fc0efe417afc6d33293b85e778aa419 - Sigstore transparency entry: 2407508647
- Sigstore integration time:
-
Permalink:
pantherale0/pysamsungnasa@c51195b7623b31c7d9e466183b837ec334558c86 -
Branch / Tag:
refs/tags/2.0.0 - Owner: https://github.com/pantherale0
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@c51195b7623b31c7d9e466183b837ec334558c86 -
Trigger Event:
release
-
Statement type:
