lametric-py 1.0.2__tar.gz

lametric_py-1.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Caspar Weber
+
+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.

lametric_py-1.0.2/PKG-INFO

@@ -0,0 +1,189 @@
+Metadata-Version: 2.4
+Name: lametric-py
+Version: 1.0.2
+Author: Caspar Weber
+License: MIT
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: yarl>=1.0.0
+Requires-Dist: aiohttp>=3.0.0
+Requires-Dist: backoff>=2.0.0
+Requires-Dist: mashumaro>=3.0.0
+Requires-Dist: awesomeversion>=25.0.0
+Requires-Dist: orjson>=3.0.0
+Dynamic: license-file
+
+# lametric-py
+
+Async Python client for LaMetric devices and the LaMetric cloud API.
+
+The package wraps the documented local device API, notification models, and the
+LaMetric Streaming Protocol (LMSP) used by LaMetric SKY devices.
+
+## Features
+
+- Async local device client for display, audio, Bluetooth, apps, notifications, and streaming
+- Async cloud client for account and device lookup
+- Typed dataclass models for API payloads and responses
+- Notification builders for text, goal, and chart frames
+- LMSP helpers for starting a stream and sending RGB888 UDP frames
+
+## Requirements
+
+- Python 3.14+
+- A LaMetric device on the local network for device API features
+- A LaMetric developer token for cloud API features
+
+## Installation
+
+This repository is currently set up as a source install.
+
+```bash
+git clone <repository-url>
+cd lametric-py
+uv sync --dev
+```
+
+If you prefer `pip`:
+
+```bash
+pip install -e .
+```
+
+## Quick Start
+
+### Local Device Client
+
+```python
+import asyncio
+
+from src import LaMetricDevice
+
+
+async def main() -> None:
+	async with LaMetricDevice(host="192.168.1.42", api_key="device-api-key") as device:
+		state = await device.state
+		print(state.name)
+
+
+asyncio.run(main())
+```
+
+### Send a Notification
+
+```python
+import asyncio
+
+from src import (
+	BuiltinSound,
+	LaMetricDevice,
+	Notification,
+	NotificationData,
+	NotificationPriority,
+	NotificationSound,
+	SimpleFrame,
+)
+
+
+async def main() -> None:
+	notification = Notification(
+		priority=NotificationPriority.INFO,
+		model=NotificationData(
+			frames=[SimpleFrame(text="Deploy finished")],
+			sound=BuiltinSound(id=NotificationSound.POSITIVE1),
+		),
+	)
+
+	async with LaMetricDevice(host="192.168.1.42", api_key="device-api-key") as device:
+		notification_id = await device.send_notification(notification)
+		print(notification_id)
+
+
+asyncio.run(main())
+```
+
+### Query the Cloud API
+
+```python
+import asyncio
+
+from src import LaMetricCloud
+
+
+async def main() -> None:
+	async with LaMetricCloud(token="developer-token") as cloud:
+		user = await cloud.current_user
+		devices = await cloud.devices
+		print(user.email, len(devices))
+
+
+asyncio.run(main())
+```
+
+## Streaming Example
+
+```python
+import asyncio
+
+from src import (
+	CanvasFillType,
+	CanvasPostProcess,
+	CanvasPostProcessType,
+	CanvasRenderMode,
+	LaMetricDevice,
+	StreamConfig,
+)
+
+
+async def main() -> None:
+	config = StreamConfig(
+		fill_type=CanvasFillType.SCALE,
+		render_mode=CanvasRenderMode.PIXEL,
+		post_process=CanvasPostProcess(type=CanvasPostProcessType.NONE),
+	)
+
+	async with LaMetricDevice(host="192.168.1.42", api_key="device-api-key") as device:
+		session_id = await device.start_stream(config)
+		if session_id is None:
+			return
+
+		stream_state = await device.stream_state
+		frame = bytes(
+			[255, 0, 0]
+			* (stream_state.canvas.pixel.size.width * stream_state.canvas.pixel.size.height)
+		)
+		await device.send_stream_data(session_id, frame)
+		await device.stop_stream()
+
+
+asyncio.run(main())
+```
+
+## Public API
+
+The package currently re-exports its public surface from `src`.
+
+- Clients: `LaMetricDevice`, `LaMetricCloud`
+- Exceptions: `LaMetricApiError`, `LaMetricConnectionError`, `LaMetricAuthenticationError`, `LaMetricUnsupportedError`
+- Models: apps, notifications, state payloads, stream config/state types
+- Enums: notification, screensaver, display, and streaming constants
+
+## Documentation
+
+- `docs/usage.md` for the local device and cloud clients
+- `docs/streaming.md` for LMSP details and the packet format used by `send_stream_data`
+- `docs/development.md` for local development, linting, typing, and tests
+
+## Development
+
+Useful commands:
+
+```bash
+uv run ruff check .
+uv run ruff format .
+uv run mypy .
+uv run pytest
+```
+
+The CI workflow runs Ruff, mypy, pytest, coverage export, and semantic-release.

lametric_py-1.0.2/README.md

@@ -0,0 +1,173 @@
+# lametric-py
+
+Async Python client for LaMetric devices and the LaMetric cloud API.
+
+The package wraps the documented local device API, notification models, and the
+LaMetric Streaming Protocol (LMSP) used by LaMetric SKY devices.
+
+## Features
+
+- Async local device client for display, audio, Bluetooth, apps, notifications, and streaming
+- Async cloud client for account and device lookup
+- Typed dataclass models for API payloads and responses
+- Notification builders for text, goal, and chart frames
+- LMSP helpers for starting a stream and sending RGB888 UDP frames
+
+## Requirements
+
+- Python 3.14+
+- A LaMetric device on the local network for device API features
+- A LaMetric developer token for cloud API features
+
+## Installation
+
+This repository is currently set up as a source install.
+
+```bash
+git clone <repository-url>
+cd lametric-py
+uv sync --dev
+```
+
+If you prefer `pip`:
+
+```bash
+pip install -e .
+```
+
+## Quick Start
+
+### Local Device Client
+
+```python
+import asyncio
+
+from src import LaMetricDevice
+
+
+async def main() -> None:
+	async with LaMetricDevice(host="192.168.1.42", api_key="device-api-key") as device:
+		state = await device.state
+		print(state.name)
+
+
+asyncio.run(main())
+```
+
+### Send a Notification
+
+```python
+import asyncio
+
+from src import (
+	BuiltinSound,
+	LaMetricDevice,
+	Notification,
+	NotificationData,
+	NotificationPriority,
+	NotificationSound,
+	SimpleFrame,
+)
+
+
+async def main() -> None:
+	notification = Notification(
+		priority=NotificationPriority.INFO,
+		model=NotificationData(
+			frames=[SimpleFrame(text="Deploy finished")],
+			sound=BuiltinSound(id=NotificationSound.POSITIVE1),
+		),
+	)
+
+	async with LaMetricDevice(host="192.168.1.42", api_key="device-api-key") as device:
+		notification_id = await device.send_notification(notification)
+		print(notification_id)
+
+
+asyncio.run(main())
+```
+
+### Query the Cloud API
+
+```python
+import asyncio
+
+from src import LaMetricCloud
+
+
+async def main() -> None:
+	async with LaMetricCloud(token="developer-token") as cloud:
+		user = await cloud.current_user
+		devices = await cloud.devices
+		print(user.email, len(devices))
+
+
+asyncio.run(main())
+```
+
+## Streaming Example
+
+```python
+import asyncio
+
+from src import (
+	CanvasFillType,
+	CanvasPostProcess,
+	CanvasPostProcessType,
+	CanvasRenderMode,
+	LaMetricDevice,
+	StreamConfig,
+)
+
+
+async def main() -> None:
+	config = StreamConfig(
+		fill_type=CanvasFillType.SCALE,
+		render_mode=CanvasRenderMode.PIXEL,
+		post_process=CanvasPostProcess(type=CanvasPostProcessType.NONE),
+	)
+
+	async with LaMetricDevice(host="192.168.1.42", api_key="device-api-key") as device:
+		session_id = await device.start_stream(config)
+		if session_id is None:
+			return
+
+		stream_state = await device.stream_state
+		frame = bytes(
+			[255, 0, 0]
+			* (stream_state.canvas.pixel.size.width * stream_state.canvas.pixel.size.height)
+		)
+		await device.send_stream_data(session_id, frame)
+		await device.stop_stream()
+
+
+asyncio.run(main())
+```
+
+## Public API
+
+The package currently re-exports its public surface from `src`.
+
+- Clients: `LaMetricDevice`, `LaMetricCloud`
+- Exceptions: `LaMetricApiError`, `LaMetricConnectionError`, `LaMetricAuthenticationError`, `LaMetricUnsupportedError`
+- Models: apps, notifications, state payloads, stream config/state types
+- Enums: notification, screensaver, display, and streaming constants
+
+## Documentation
+
+- `docs/usage.md` for the local device and cloud clients
+- `docs/streaming.md` for LMSP details and the packet format used by `send_stream_data`
+- `docs/development.md` for local development, linting, typing, and tests
+
+## Development
+
+Useful commands:
+
+```bash
+uv run ruff check .
+uv run ruff format .
+uv run mypy .
+uv run pytest
+```
+
+The CI workflow runs Ruff, mypy, pytest, coverage export, and semantic-release.

lametric_py-1.0.2/pyproject.toml

@@ -0,0 +1,79 @@
+[project]
+name = "lametric-py"
+version = "1.0.2"
+description = ""
+authors = [
+    { name = "Caspar Weber" }
+]
+dependencies = [
+    "yarl>=1.0.0",
+    "aiohttp>=3.0.0",
+    "backoff>=2.0.0",
+    "mashumaro>=3.0.0",
+    "awesomeversion>=25.0.0",
+    "orjson>=3.0.0",
+]
+requires-python = ">=3.14"
+readme = "README.md"
+license = { text = "MIT" }
+
+# ------------------------------------------------------------------------------
+# UV & DEV DEPENDENCIES
+# ------------------------------------------------------------------------------
+[dependency-groups]
+dev = [
+    "pytest>=8.0.0",
+    "pytest-cov>=4.1.0",
+    "mypy>=1.9.0",
+    "ruff>=0.3.0",
+    "pre-commit>=3.6.0",
+    "python-semantic-release>=9.0.0",
+    "commitizen>=3.0.0",
+]
+
+# ------------------------------------------------------------------------------
+# RUFF (Linter & Formatter)
+# ------------------------------------------------------------------------------
+[tool.ruff]
+target-version = "py314"
+line-length = 88
+
+[tool.ruff.lint]
+# E: Pycodestyle, F: Pyflakes, I: Isort (Imports), N: Naming, UP: Upgrade, B: Bugbear
+select = ["E", "F", "I", "N", "UP", "B"]
+ignore = []
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
+# ------------------------------------------------------------------------------
+# MYPY (Type Checking)
+# ------------------------------------------------------------------------------
+[tool.mypy]
+python_version = "3.14"
+strict = true
+ignore_missing_imports = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+
+# ------------------------------------------------------------------------------
+# PYTEST (Testing)
+# ------------------------------------------------------------------------------
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["."]
+addopts = "--cov=src --cov-report=term-missing"
+
+# ------------------------------------------------------------------------------
+# SEMANTIC RELEASE (Auto-Versioning)
+# ------------------------------------------------------------------------------
+[tool.semantic_release]
+version_toml = ["pyproject.toml:project.version"]
+major_on_zero = false
+
+[tool.semantic_release.changelog]
+exclude_commit_patterns = ["chore", "ci"]
+
+[tool.semantic_release.branches.main]
+match = "main"

lametric_py-1.0.2/setup.cfg

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

lametric_py-1.0.2/src/__init__.py

@@ -0,0 +1,127 @@
+"""Public package exports for lametric-py."""
+
+from importlib.metadata import PackageNotFoundError, version
+
+from .cloud import CloudDevice, CloudUser, LaMetricCloud
+from .const import (
+    AlarmSound,
+    BrightnessMode,
+    CanvasFillType,
+    CanvasPostProcessEffectType,
+    CanvasPostProcessType,
+    CanvasRenderMode,
+    DeviceModels,
+    DeviceModes,
+    DisplayType,
+    IconType,
+    NotificationPriority,
+    NotificationSound,
+    NotificationType,
+    ScreensaverModes,
+    SoundCategory,
+)
+from .device import LaMetricDevice
+from .device_apps import App, Parameter, Widget
+from .device_configs import (
+    CanvasFadingPixelsEffectParameters,
+    CanvasPostProcess,
+    CanvasPostProcessParameters,
+    ScreensaverConfig,
+    ScreensaverConfigParams,
+    StreamConfig,
+)
+from .device_notifications import (
+    BuiltinSound,
+    GoalFrame,
+    GoalFrameData,
+    Notification,
+    NotificationData,
+    SimpleFrame,
+    SpikeChartFrame,
+    WebSound,
+)
+from .device_states import (
+    Canvas,
+    CanvasArea,
+    CanvasSize,
+    DeviceAudioState,
+    DeviceBluetoothState,
+    DeviceDisplayState,
+    DeviceSoftwareUpdate,
+    DeviceState,
+    DeviceWiFiState,
+    IntRange,
+    Screensaver,
+    StreamState,
+    TimeBasedScreensaverMode,
+    WhenDarkScreensaverMode,
+)
+from .exceptions import (
+    LaMetricApiError,
+    LaMetricAuthenticationError,
+    LaMetricConnectionError,
+    LaMetricUnsupportedError,
+)
+
+try:
+    __version__ = version("lametric-py")
+except PackageNotFoundError:
+    __version__ = "0.0.0"
+
+__all__ = [
+    "AlarmSound",
+    "App",
+    "BrightnessMode",
+    "BuiltinSound",
+    "Canvas",
+    "CanvasArea",
+    "CanvasFadingPixelsEffectParameters",
+    "CanvasFillType",
+    "CanvasPostProcess",
+    "CanvasPostProcessEffectType",
+    "CanvasPostProcessParameters",
+    "CanvasPostProcessType",
+    "CanvasRenderMode",
+    "CanvasSize",
+    "CloudDevice",
+    "CloudUser",
+    "DeviceAudioState",
+    "DeviceBluetoothState",
+    "DeviceDisplayState",
+    "DeviceModes",
+    "DeviceModels",
+    "DeviceSoftwareUpdate",
+    "DeviceState",
+    "DeviceWiFiState",
+    "DisplayType",
+    "GoalFrame",
+    "GoalFrameData",
+    "IconType",
+    "IntRange",
+    "LaMetricApiError",
+    "LaMetricAuthenticationError",
+    "LaMetricCloud",
+    "LaMetricConnectionError",
+    "LaMetricDevice",
+    "LaMetricUnsupportedError",
+    "Notification",
+    "NotificationData",
+    "NotificationPriority",
+    "NotificationSound",
+    "NotificationType",
+    "Parameter",
+    "Screensaver",
+    "ScreensaverConfig",
+    "ScreensaverConfigParams",
+    "ScreensaverModes",
+    "SimpleFrame",
+    "SoundCategory",
+    "SpikeChartFrame",
+    "StreamConfig",
+    "StreamState",
+    "TimeBasedScreensaverMode",
+    "WebSound",
+    "WhenDarkScreensaverMode",
+    "Widget",
+    "__version__",
+]