pymacon 0.1.0__tar.gz

pymacon-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Stefan Slivinski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pymacon-0.1.0/PKG-INFO

@@ -0,0 +1,86 @@
+Metadata-Version: 2.4
+Name: pymacon
+Version: 0.1.0
+Summary: Async local client for the Macon Heat Pump Controller
+Author: Stefan Slivinski
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/sslivins/pymacon
+Project-URL: Issues, https://github.com/sslivins/pymacon/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Home Automation
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.11
+Requires-Dist: yarl>=1.9
+Provides-Extra: tests
+Requires-Dist: cryptography>=42; extra == "tests"
+Requires-Dist: mypy>=1.10; extra == "tests"
+Requires-Dist: pytest>=7; extra == "tests"
+Requires-Dist: pytest-asyncio>=0.23; extra == "tests"
+Requires-Dist: pytest-cov>=5; extra == "tests"
+Requires-Dist: ruff>=0.6; extra == "tests"
+Dynamic: license-file
+
+# pymacon
+
+Secure async REST and WebSocket client for the
+**Macon Heat Pump Controller**. It is the transport library used by the
+[Macon Home Assistant integration](https://github.com/sslivins/hass-macon).
+
+Each `MaconClient` owns the credential, pinned certificate,
+ordered state, reconnect loop, and reconciliation state for exactly one
+controller. Multiple controllers therefore remain fully isolated.
+
+## Install
+
+```bash
+pip install pymacon
+```
+
+## Usage
+
+```python
+from pymacon import MaconClient
+
+client = MaconClient(
+    "192.168.1.21",
+    token,
+    certificate_fingerprint,
+    # arctic-* is retained because it is the firmware wire-format ID.
+    device_id="arctic-001122334455",
+)
+client.subscribe(handle_snapshot)
+client.subscribe_status(handle_status)
+await client.start()
+```
+
+Call `await client.stop()` when unloading the owning config entry. Sessions
+passed into the constructor remain owned by the caller; sessions created by
+the client are closed automatically.
+
+Control methods acknowledge that a command was accepted, but they never
+optimistically mutate local state. Subscribe to snapshots to observe the
+controller's reported state:
+
+```python
+await client.async_set_cooling_setpoint(12)
+await client.async_set_power(False)
+```
+
+Only controls advertised by `client.capabilities` should be called. The
+firmware rejects unavailable, unsafe, or unsupported operations.
+
+## Development
+
+```bash
+python -m pip install -e ".[tests]"
+pytest
+ruff check src tests
+mypy src
+```

pymacon-0.1.0/README.md

@@ -0,0 +1,57 @@
+# pymacon
+
+Secure async REST and WebSocket client for the
+**Macon Heat Pump Controller**. It is the transport library used by the
+[Macon Home Assistant integration](https://github.com/sslivins/hass-macon).
+
+Each `MaconClient` owns the credential, pinned certificate,
+ordered state, reconnect loop, and reconciliation state for exactly one
+controller. Multiple controllers therefore remain fully isolated.
+
+## Install
+
+```bash
+pip install pymacon
+```
+
+## Usage
+
+```python
+from pymacon import MaconClient
+
+client = MaconClient(
+    "192.168.1.21",
+    token,
+    certificate_fingerprint,
+    # arctic-* is retained because it is the firmware wire-format ID.
+    device_id="arctic-001122334455",
+)
+client.subscribe(handle_snapshot)
+client.subscribe_status(handle_status)
+await client.start()
+```
+
+Call `await client.stop()` when unloading the owning config entry. Sessions
+passed into the constructor remain owned by the caller; sessions created by
+the client are closed automatically.
+
+Control methods acknowledge that a command was accepted, but they never
+optimistically mutate local state. Subscribe to snapshots to observe the
+controller's reported state:
+
+```python
+await client.async_set_cooling_setpoint(12)
+await client.async_set_power(False)
+```
+
+Only controls advertised by `client.capabilities` should be called. The
+firmware rejects unavailable, unsafe, or unsupported operations.
+
+## Development
+
+```bash
+python -m pip install -e ".[tests]"
+pytest
+ruff check src tests
+mypy src
+```

pymacon-0.1.0/pyproject.toml

@@ -0,0 +1,60 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pymacon"
+version = "0.1.0"
+description = "Async local client for the Macon Heat Pump Controller"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [
+    { name = "Stefan Slivinski" },
+]
+requires-python = ">=3.11"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Home Automation",
+]
+dependencies = [
+    "aiohttp>=3.11",
+    "yarl>=1.9",
+]
+
+[project.urls]
+Homepage = "https://github.com/sslivins/pymacon"
+Issues = "https://github.com/sslivins/pymacon/issues"
+
+[project.optional-dependencies]
+tests = [
+    "cryptography>=42",
+    "mypy>=1.10",
+    "pytest>=7",
+    "pytest-asyncio>=0.23",
+    "pytest-cov>=5",
+    "ruff>=0.6",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+pymacon = ["py.typed"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+
+[tool.mypy]
+python_version = "3.11"
+strict = true
+
+[tool.ruff]
+line-length = 88
+target-version = "py311"

pymacon-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pymacon-0.1.0/src/pymacon/__init__.py

@@ -0,0 +1,88 @@
+"""Async client for the Macon Heat Pump Controller."""
+
+from .client import (
+    ArcticControllerClient,
+    SnapshotCallback,
+    StatusCallback,
+)
+from .exceptions import (
+    ArcticAuthenticationError,
+    ArcticCertificateError,
+    ArcticCommandConflictError,
+    ArcticCommandValidationError,
+    ArcticConnectionError,
+    ArcticControllerError,
+    ArcticControlUnavailableError,
+    ArcticPairingError,
+    ArcticProtocolError,
+)
+from .models import (
+    PROTOCOL_VERSION,
+    ClientStatus,
+    CommandResult,
+    ComponentState,
+    ControllerCapabilities,
+    ControllerState,
+    ErrorState,
+    PairingResult,
+    ReadingState,
+    SetpointCapabilities,
+    SetpointRange,
+    SetpointState,
+    StateSnapshot,
+    TemperatureState,
+)
+
+# Keep the protocol-era names available while presenting Macon names to new
+# integrations and applications.
+MaconClient = ArcticControllerClient
+MaconControllerClient = ArcticControllerClient
+MaconAuthenticationError = ArcticAuthenticationError
+MaconCertificateError = ArcticCertificateError
+MaconCommandConflictError = ArcticCommandConflictError
+MaconCommandValidationError = ArcticCommandValidationError
+MaconConnectionError = ArcticConnectionError
+MaconControllerError = ArcticControllerError
+MaconControlUnavailableError = ArcticControlUnavailableError
+MaconPairingError = ArcticPairingError
+MaconProtocolError = ArcticProtocolError
+
+__all__ = [
+    "PROTOCOL_VERSION",
+    "ArcticAuthenticationError",
+    "ArcticCertificateError",
+    "ArcticCommandConflictError",
+    "ArcticCommandValidationError",
+    "ArcticConnectionError",
+    "ArcticControlUnavailableError",
+    "ArcticControllerClient",
+    "ArcticControllerError",
+    "ArcticPairingError",
+    "ArcticProtocolError",
+    "ClientStatus",
+    "CommandResult",
+    "ComponentState",
+    "ControllerCapabilities",
+    "ControllerState",
+    "ErrorState",
+    "MaconAuthenticationError",
+    "MaconCertificateError",
+    "MaconClient",
+    "MaconCommandConflictError",
+    "MaconCommandValidationError",
+    "MaconConnectionError",
+    "MaconControlUnavailableError",
+    "MaconControllerClient",
+    "MaconControllerError",
+    "MaconPairingError",
+    "MaconProtocolError",
+    "PairingResult",
+    "ReadingState",
+    "SetpointCapabilities",
+    "SetpointRange",
+    "SetpointState",
+    "SnapshotCallback",
+    "StateSnapshot",
+    "StatusCallback",
+    "TemperatureState",
+]