aiometric 0.1.0__tar.gz

aiometric-0.1.0/PKG-INFO

@@ -0,0 +1,192 @@
+Metadata-Version: 2.4
+Name: aiometric
+Version: 0.1.0
+Summary: Asynchronous Python client for interacting with the LaMetric and the LaMetric Cloud API
+License: MIT
+Keywords: lametric,lametric sky,lametric time,lametric api,async,client
+Author: Caspar Weber
+Maintainer: Caspar Weber
+Requires-Python: >=3.11,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: aiohttp (>=3.0.0)
+Requires-Dist: awesomeversion (>=21.10.1)
+Requires-Dist: backoff (>=2.2.0)
+Requires-Dist: mashumaro (>=3.10)
+Requires-Dist: orjson (>=3.9.8)
+Requires-Dist: yarl (>=1.6.0)
+Project-URL: Bug Tracker, https://github.com/ElectroAttacks/aiometric/issues
+Project-URL: Changelog, https://github.com/ElectroAttacks/aiometric/releases
+Project-URL: Documentation, https://github.com/ElectroAttacks/aiometric
+Project-URL: Homepage, https://github.com/ElectroAttacks/aiometric
+Project-URL: Repository, https://github.com/ElectroAttacks/aiometric
+Description-Content-Type: text/markdown
+
+# aiometric
+
+Asynchronous Python client for the LaMetric local device API and LaMetric Cloud API.
+
+aiometric gives you typed models, async-first device/cloud clients, and practical helpers for common tasks such as reading device state, controlling display/audio, sending notifications, and querying cloud-connected devices.
+
+## Features
+
+- Async clients for local and cloud APIs
+- Typed request/response models (dataclasses)
+- Retries for transient connection failures
+- Clear error classes for auth, timeout, and API version issues
+- Optional streaming support via LMSP UDP frames
+
+## Requirements
+
+- Python 3.11+
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install aiometric
+```
+
+Or with Poetry:
+
+```bash
+poetry add aiometric
+```
+
+## Quick Start
+
+### Example 1: Connect to a local device and send a notification
+
+```python
+import asyncio
+
+from aiometric import (
+	LaMetricDevice,
+	Notification,
+	NotificationModel,
+	SimpleFrame,
+)
+
+
+async def main() -> None:
+	# Get API key from the LaMetric developer page / app settings.
+	host = "192.168.1.100"
+	api_key = "YOUR_DEVICE_API_KEY"
+
+	async with LaMetricDevice(host=host, api_key=api_key) as device:
+		state = await device.get_device_state()
+		print(f"Connected to: {state.name} ({state.model})")
+
+		# Update display brightness.
+		display = await device.get_or_set_display_state(brightness=40)
+		print(f"Brightness is now: {display.brightness}")
+
+		# Send a simple notification.
+		notification = Notification(
+			model=NotificationModel(
+				frames=[SimpleFrame(text="Hello from aiometric")],
+				cycles=1,
+				repeat=1,
+			)
+		)
+		notification_id = await device.notify(notification)
+		print(f"Notification sent: {notification_id}")
+
+
+asyncio.run(main())
+```
+
+### Example 2: Use LaMetric Cloud API
+
+```python
+import asyncio
+
+from aiometric import LaMetricCloud
+
+
+async def main() -> None:
+	token = "YOUR_CLOUD_ACCESS_TOKEN"
+
+	async with LaMetricCloud(token=token) as cloud:
+		user = await cloud.get_current_user()
+		print(f"User: {user.email}")
+
+		devices = await cloud.get_devices()
+		print(f"Cloud devices: {len(devices)}")
+		for device in devices:
+			print(f"- {device.id}: {device.name} ({device.state})")
+
+
+asyncio.run(main())
+```
+
+## Common Device Operations
+
+Local client methods in `LaMetricDevice` include:
+
+- `get_device_state()`
+- `get_or_set_display_state(...)`
+- `get_or_set_audio_state(...)`
+- `get_or_set_bluetooth_state(...)`
+- `get_wifi_state()`
+- `get_apps()`, `get_app(package)`
+- `notify(...)`, `get_notifications()`, `dismiss_notification(...)`
+- `get_streaming_state()`, `start_stream(...)`, `send_stream_frame(...)`
+
+Cloud client methods in `LaMetricCloud` include:
+
+- `get_current_user()`
+- `get_devices()`
+- `get_device(device_id)`
+
+## Error Handling
+
+aiometric raises specific exception types you can catch:
+
+- `LaMetricAuthenticationError`
+- `LaMetricConnectionTimeoutError`
+- `LaMetricConnectionError`
+- `LaMetricInvalidApiVersionError`
+- `LaMetricError` (base class)
+
+Example:
+
+```python
+from aiometric import LaMetricAuthenticationError, LaMetricConnectionTimeoutError
+
+try:
+	...
+except LaMetricAuthenticationError:
+	print("Invalid token or API key")
+except LaMetricConnectionTimeoutError:
+	print("Request timed out")
+```
+
+## Development
+
+Run tests:
+
+```bash
+poetry run pytest
+```
+
+Run all checks:
+
+```bash
+poetry run pre-commit run --all-files
+```
+
+## License
+
+MIT
+

aiometric-0.1.0/README.md

@@ -0,0 +1,158 @@
+# aiometric
+
+Asynchronous Python client for the LaMetric local device API and LaMetric Cloud API.
+
+aiometric gives you typed models, async-first device/cloud clients, and practical helpers for common tasks such as reading device state, controlling display/audio, sending notifications, and querying cloud-connected devices.
+
+## Features
+
+- Async clients for local and cloud APIs
+- Typed request/response models (dataclasses)
+- Retries for transient connection failures
+- Clear error classes for auth, timeout, and API version issues
+- Optional streaming support via LMSP UDP frames
+
+## Requirements
+
+- Python 3.11+
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install aiometric
+```
+
+Or with Poetry:
+
+```bash
+poetry add aiometric
+```
+
+## Quick Start
+
+### Example 1: Connect to a local device and send a notification
+
+```python
+import asyncio
+
+from aiometric import (
+	LaMetricDevice,
+	Notification,
+	NotificationModel,
+	SimpleFrame,
+)
+
+
+async def main() -> None:
+	# Get API key from the LaMetric developer page / app settings.
+	host = "192.168.1.100"
+	api_key = "YOUR_DEVICE_API_KEY"
+
+	async with LaMetricDevice(host=host, api_key=api_key) as device:
+		state = await device.get_device_state()
+		print(f"Connected to: {state.name} ({state.model})")
+
+		# Update display brightness.
+		display = await device.get_or_set_display_state(brightness=40)
+		print(f"Brightness is now: {display.brightness}")
+
+		# Send a simple notification.
+		notification = Notification(
+			model=NotificationModel(
+				frames=[SimpleFrame(text="Hello from aiometric")],
+				cycles=1,
+				repeat=1,
+			)
+		)
+		notification_id = await device.notify(notification)
+		print(f"Notification sent: {notification_id}")
+
+
+asyncio.run(main())
+```
+
+### Example 2: Use LaMetric Cloud API
+
+```python
+import asyncio
+
+from aiometric import LaMetricCloud
+
+
+async def main() -> None:
+	token = "YOUR_CLOUD_ACCESS_TOKEN"
+
+	async with LaMetricCloud(token=token) as cloud:
+		user = await cloud.get_current_user()
+		print(f"User: {user.email}")
+
+		devices = await cloud.get_devices()
+		print(f"Cloud devices: {len(devices)}")
+		for device in devices:
+			print(f"- {device.id}: {device.name} ({device.state})")
+
+
+asyncio.run(main())
+```
+
+## Common Device Operations
+
+Local client methods in `LaMetricDevice` include:
+
+- `get_device_state()`
+- `get_or_set_display_state(...)`
+- `get_or_set_audio_state(...)`
+- `get_or_set_bluetooth_state(...)`
+- `get_wifi_state()`
+- `get_apps()`, `get_app(package)`
+- `notify(...)`, `get_notifications()`, `dismiss_notification(...)`
+- `get_streaming_state()`, `start_stream(...)`, `send_stream_frame(...)`
+
+Cloud client methods in `LaMetricCloud` include:
+
+- `get_current_user()`
+- `get_devices()`
+- `get_device(device_id)`
+
+## Error Handling
+
+aiometric raises specific exception types you can catch:
+
+- `LaMetricAuthenticationError`
+- `LaMetricConnectionTimeoutError`
+- `LaMetricConnectionError`
+- `LaMetricInvalidApiVersionError`
+- `LaMetricError` (base class)
+
+Example:
+
+```python
+from aiometric import LaMetricAuthenticationError, LaMetricConnectionTimeoutError
+
+try:
+	...
+except LaMetricAuthenticationError:
+	print("Invalid token or API key")
+except LaMetricConnectionTimeoutError:
+	print("Request timed out")
+```
+
+## Development
+
+Run tests:
+
+```bash
+poetry run pytest
+```
+
+Run all checks:
+
+```bash
+poetry run pre-commit run --all-files
+```
+
+## License
+
+MIT

aiometric-0.1.0/pyproject.toml

@@ -0,0 +1,162 @@
+[tool.poetry]
+authors = ["Caspar Weber"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Framework :: AsyncIO",
+  "Intended Audience :: Developers",
+  "Natural Language :: English",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+]
+description = "Asynchronous Python client for interacting with the LaMetric and the LaMetric Cloud API"
+documentation = "https://github.com/ElectroAttacks/aiometric"
+homepage = "https://github.com/ElectroAttacks/aiometric"
+keywords = ["lametric","lametric sky", "lametric time", "lametric api", "async", "client"]
+license = "MIT"
+maintainers = ["Caspar Weber"]
+name = "aiometric"
+packages = [{ include = "aiometric", from = "src" }]
+readme = "README.md"
+repository = "https://github.com/ElectroAttacks/aiometric"
+version = "0.1.0"
+
+[tool.poetry.dependencies]
+aiohttp = ">=3.0.0"
+awesomeversion = ">=21.10.1"
+backoff = ">=2.2.0"
+mashumaro = ">=3.10"
+orjson = ">=3.9.8"
+python = "^3.11"
+yarl = ">=1.6.0"
+
+[tool.poetry.urls]
+"Bug Tracker" = "https://github.com/ElectroAttacks/aiometric/issues"
+Changelog = "https://github.com/ElectroAttacks/aiometric/releases"
+
+[tool.poetry.group.dev.dependencies]
+aresponses = "3.0.0"
+codespell = "2.4.2"
+covdefaults = "2.3.0"
+coverage = { version = "7.13.5", extras = ["toml"] }
+mypy = "1.19.1"
+pre-commit = "4.5.1"
+pre-commit-hooks = "6.0.0"
+pylint = "4.0.5"
+pytest = "9.0.2"
+pytest-asyncio = "1.3.0"
+pytest-cov = "7.1.0"
+ruff = "0.15.8"
+yamllint = "1.38.0"
+syrupy = "5.1.0"
+
+[tool.coverage.run]
+plugins = ["covdefaults"]
+source = ["aiometric"]
+
+[tool.coverage.report]
+fail_under = 90
+show_missing = true
+
+[tool.mypy]
+# Specify the target platform details in config, so your developers are
+# free to run mypy on Windows, Linux, or macOS and get consistent
+# results.
+platform = "linux"
+plugins = []
+python_version = "3.11"
+
+# flake8-mypy expects the two following for sensible formatting
+show_column_numbers = true
+
+# show error messages from unrelated files
+follow_imports = "normal"
+
+# suppress errors about unsatisfied imports
+ignore_missing_imports = true
+
+# be strict
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_subclassing_any = true
+disallow_untyped_calls = true
+disallow_untyped_decorators = true
+disallow_untyped_defs = true
+no_implicit_optional = true
+no_implicit_reexport = true
+strict_optional = true
+warn_incomplete_stub = true
+warn_no_return = true
+warn_redundant_casts = true
+warn_return_any = true
+warn_unused_configs = true
+warn_unused_ignores = true
+
+[tool.pylint.MASTER]
+ignore = ["tests"]
+
+[tool.pylint.BASIC]
+good-names = ["_", "ex", "fp", "i", "id", "j", "k", "on", "Run", "T", "wv"]
+
+[tool.pylint."MESSAGES CONTROL"]
+disable = [
+  "too-few-public-methods",
+  "duplicate-code",
+  "format",
+  "unsubscriptable-object",
+]
+
+[tool.pylint.SIMILARITIES]
+ignore-imports = true
+
+[tool.pylint.FORMAT]
+max-line-length = 88
+
+[tool.pylint.DESIGN]
+max-attributes = 20
+
+[tool.pytest.ini_options]
+addopts = "--cov"
+asyncio_mode = "auto"
+
+[tool.ruff.lint]
+ignore = [
+  "ANN401",  # Opinioated warning on disallowing dynamically typed expressions
+  "D203",    # Conflicts with other rules
+  "D213",    # Conflicts with other rules
+  "D417",    # False positives in some occasions
+  "PLR2004", # Just annoying, not really useful
+
+
+  # Conflicts with the Ruff formatter
+  "COM812",
+  "ISC001",
+]
+select = ["ALL"]
+
+[tool.ruff.lint.flake8-pytest-style]
+fixture-parentheses = false
+mark-parentheses = false
+
+[tool.ruff.lint.isort]
+known-first-party = ["aiometric"]
+
+[tool.ruff.lint.flake8-type-checking]
+runtime-evaluated-base-classes = [
+  "mashumaro.mixins.orjson.DataClassORJSONMixin",
+]
+
+[tool.ruff.lint.mccabe]
+max-complexity = 25
+
+[tool.ruff.lint.per-file-ignores]
+"src/demetriek/models.py" = ["TCH002", "TCH003"]
+"tests/**/*.py" = ["D103", "S101", "SLF001"]
+"tests/fixtures.py" = ["S105"]
+
+[build-system]
+build-backend = "poetry.core.masonry.api"
+requires = ["poetry-core>=1.0.0"]

aiometric-0.1.0/src/aiometric/__init__.py

@@ -0,0 +1,118 @@
+"""Public package interface for lametric_websocket."""
+
+from .cloud import LaMetricCloud
+from .const import (
+    AlarmSound,
+    CanvasFillType,
+    CanvasRenderMode,
+    CloudDeviceState,
+    DeviceMode,
+    DeviceModel,
+    DisplayMode,
+    DisplayType,
+    EffectType,
+    IconType,
+    IpAddressMode,
+    NotificationPriority,
+    NotificationSound,
+    NotificationType,
+    PostProcessingType,
+    SoundCategory,
+    StreamingState,
+    WifiEncryptionType,
+)
+from .device import LaMetricDevice
+from .errors import (
+    LaMetricAuthenticationError,
+    LaMetricConnectionError,
+    LaMetricConnectionTimeoutError,
+    LaMetricError,
+    LaMetricInvalidApiVersionError,
+)
+from .models import (
+    ActionParameter,
+    App,
+    AppWidget,
+    AudioState,
+    BluetoothState,
+    BuiltinSound,
+    Canvas,
+    CanvasArea,
+    CloudDevice,
+    CloudUser,
+    DeviceState,
+    DisplayState,
+    FadingPixelsParameter,
+    GoalFrame,
+    GoalFrameData,
+    Notification,
+    NotificationModel,
+    PostProcessing,
+    PostProcessingParameter,
+    Screensaver,
+    SimpleFrame,
+    SpikeChartFrame,
+    StreamState,
+    TimeBasedScreensaver,
+    Update,
+    ValueRange,
+    WebSound,
+    WhenDarkScreensaver,
+    WifiState,
+)
+
+__all__ = [
+    "ActionParameter",
+    "AlarmSound",
+    "App",
+    "AppWidget",
+    "AudioState",
+    "BluetoothState",
+    "BuiltinSound",
+    "Canvas",
+    "CanvasArea",
+    "CanvasFillType",
+    "CanvasRenderMode",
+    "CloudDevice",
+    "CloudDeviceState",
+    "CloudUser",
+    "DeviceMode",
+    "DeviceModel",
+    "DeviceState",
+    "DisplayMode",
+    "DisplayState",
+    "DisplayType",
+    "EffectType",
+    "FadingPixelsParameter",
+    "GoalFrame",
+    "GoalFrameData",
+    "IconType",
+    "IpAddressMode",
+    "LaMetricAuthenticationError",
+    "LaMetricConnectionError",
+    "LaMetricConnectionTimeoutError",
+    "LaMetricDevice",
+    "LaMetricError",
+    "LaMetricInvalidApiVersionError",
+    "Notification",
+    "NotificationModel",
+    "NotificationPriority",
+    "NotificationSound",
+    "NotificationType",
+    "PostProcessing",
+    "PostProcessingParameter",
+    "PostProcessingType",
+    "Screensaver",
+    "SimpleFrame",
+    "SoundCategory",
+    "SpikeChartFrame",
+    "StreamState",
+    "StreamingState",
+    "TimeBasedScreensaver",
+    "Update",
+    "ValueRange",
+    "WebSound",
+    "WhenDarkScreensaver",
+    "WifiEncryptionType",
+    "WifiState",
+]