ikalogic-at1000 0.2.0__tar.gz

ikalogic_at1000-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ikalogic SAS
+
+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.

ikalogic_at1000-0.2.0/PKG-INFO

@@ -0,0 +1,129 @@
+Metadata-Version: 2.4
+Name: ikalogic-at1000
+Version: 0.2.0
+Summary: Python SDK for Ikalogic AT1000 devices
+Keywords: at1000,ikalogic,test-sequencer,automated-testing,hardware,instrumentation,sdk,api
+Author: Corentin AZAIS, Vladislav KOSINOV
+Author-email: Corentin AZAIS <c.azais@ikalogic.com>, Vladislav KOSINOV <v.kosinov@ikalogic.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Manufacturing
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+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 :: Embedded Systems
+Classifier: Topic :: Scientific/Engineering
+Classifier: Typing :: Typed
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: websockets>=13.0
+Requires-Dist: zeroconf>=0.148.0
+Requires-Python: >=3.10
+Project-URL: Homepage, https://ikalogic.com/test-sequencers/at1000/intro/
+Project-URL: Documentation, https://ikalogic.com/kb/at1000-api/at1000_home/
+Description-Content-Type: text/markdown
+
+# ikalogic-at1000
+
+Official Python SDK for the Ikalogic AT1000 Series Test Sequencers.
+
+This package provides a high-level API to control and automate the Ikalogic [AT1000](https://ikalogic.com/test-sequencers/at1000/intro/), a test sequencer designed for functional testing of electronic devices, PCBs, and complex systems. It ships both a synchronous client (`ikalogic_at1000`) and an asynchronous client (`ikalogic_at1000.aio`).
+
+## Key Features
+
+- **32 Programmable I/Os:** Handle analog and digital signals within a ±25V range.
+- **8 Dry Contact Relays:** Control external circuits, with one relay equipped for high-precision current measurement.
+- **Programmable Power Supply:** Delivers 0 to 24V at up to 2A with precise current monitoring.
+- **Dual USB 3.0 Ports:** Feature power cycling (on/off control) and current measurement for testing USB devices.
+- **Communication Interfaces:** Includes Ethernet, RS232, RS485, CAN, SPI, I2C, and UART.
+- **Human-Machine Interface (HMI):** Onboard screen, rotary knob, and speaker for standalone operation and feedback.
+
+## Installation
+
+```bash
+pip install ikalogic-at1000
+```
+
+Or, with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add ikalogic-at1000
+```
+
+Requires Python 3.10 or newer.
+
+## Quick Start
+
+Connect to a device by hostname or IP, or discover devices on the local network:
+
+```python
+from ikalogic_at1000 import AT1000, find_devices
+
+# Discover AT1000 devices over mDNS
+for device in find_devices():
+    print(device)
+
+# Or connect directly
+device = AT1000("at1000.local")
+print(device.info.model, device.info.serial_number)
+
+device.reset()
+device.close()
+```
+
+## Asynchronous Usage
+
+The same API is available as coroutines under `ikalogic_at1000.aio`:
+
+```python
+import asyncio
+
+from ikalogic_at1000.aio import AT1000
+
+
+async def main():
+    device = await AT1000.create("at1000.local")
+    print(device.info.model, device.info.serial_number)
+
+    await device.reset()
+    await device.aclose()
+
+
+asyncio.run(main())
+```
+
+## Real-time Events
+
+Subscribe to live device state changes over a WebSocket. Connect, then register callbacks per event type (or `"*"` for all events):
+
+```python
+from ikalogic_at1000 import AT1000
+
+device = AT1000("at1000.local")
+device.events.connect()
+
+
+def on_gpio(event):
+    print(event.type, event.data)
+
+
+unsubscribe = device.events.subscribe("gpio.state", on_gpio)
+
+# later
+unsubscribe()
+device.close()
+```
+
+## Documentation
+
+Full API documentation is available at <https://ikalogic.com/kb/at1000-api/at1000_home/>.
+
+## License
+
+This package is distributed under the MIT License.

ikalogic_at1000-0.2.0/README.md

@@ -0,0 +1,98 @@
+# ikalogic-at1000
+
+Official Python SDK for the Ikalogic AT1000 Series Test Sequencers.
+
+This package provides a high-level API to control and automate the Ikalogic [AT1000](https://ikalogic.com/test-sequencers/at1000/intro/), a test sequencer designed for functional testing of electronic devices, PCBs, and complex systems. It ships both a synchronous client (`ikalogic_at1000`) and an asynchronous client (`ikalogic_at1000.aio`).
+
+## Key Features
+
+- **32 Programmable I/Os:** Handle analog and digital signals within a ±25V range.
+- **8 Dry Contact Relays:** Control external circuits, with one relay equipped for high-precision current measurement.
+- **Programmable Power Supply:** Delivers 0 to 24V at up to 2A with precise current monitoring.
+- **Dual USB 3.0 Ports:** Feature power cycling (on/off control) and current measurement for testing USB devices.
+- **Communication Interfaces:** Includes Ethernet, RS232, RS485, CAN, SPI, I2C, and UART.
+- **Human-Machine Interface (HMI):** Onboard screen, rotary knob, and speaker for standalone operation and feedback.
+
+## Installation
+
+```bash
+pip install ikalogic-at1000
+```
+
+Or, with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add ikalogic-at1000
+```
+
+Requires Python 3.10 or newer.
+
+## Quick Start
+
+Connect to a device by hostname or IP, or discover devices on the local network:
+
+```python
+from ikalogic_at1000 import AT1000, find_devices
+
+# Discover AT1000 devices over mDNS
+for device in find_devices():
+    print(device)
+
+# Or connect directly
+device = AT1000("at1000.local")
+print(device.info.model, device.info.serial_number)
+
+device.reset()
+device.close()
+```
+
+## Asynchronous Usage
+
+The same API is available as coroutines under `ikalogic_at1000.aio`:
+
+```python
+import asyncio
+
+from ikalogic_at1000.aio import AT1000
+
+
+async def main():
+    device = await AT1000.create("at1000.local")
+    print(device.info.model, device.info.serial_number)
+
+    await device.reset()
+    await device.aclose()
+
+
+asyncio.run(main())
+```
+
+## Real-time Events
+
+Subscribe to live device state changes over a WebSocket. Connect, then register callbacks per event type (or `"*"` for all events):
+
+```python
+from ikalogic_at1000 import AT1000
+
+device = AT1000("at1000.local")
+device.events.connect()
+
+
+def on_gpio(event):
+    print(event.type, event.data)
+
+
+unsubscribe = device.events.subscribe("gpio.state", on_gpio)
+
+# later
+unsubscribe()
+device.close()
+```
+
+## Documentation
+
+Full API documentation is available at <https://ikalogic.com/kb/at1000-api/at1000_home/>.
+
+## License
+
+This package is distributed under the MIT License.

ikalogic_at1000-0.2.0/pyproject.toml

@@ -0,0 +1,72 @@
+[project]
+name = "ikalogic-at1000"
+version = "0.2.0"
+description = "Python SDK for Ikalogic AT1000 devices"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [
+  { name = "Corentin AZAIS", email = "c.azais@ikalogic.com" },
+  { name = "Vladislav KOSINOV", email = "v.kosinov@ikalogic.com" },
+]
+keywords = [
+  "at1000",
+  "ikalogic",
+  "test-sequencer",
+  "automated-testing",
+  "hardware",
+  "instrumentation",
+  "sdk",
+  "api",
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "Intended Audience :: Manufacturing",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Topic :: Software Development :: Embedded Systems",
+  "Topic :: Scientific/Engineering",
+  "Typing :: Typed",
+]
+requires-python = ">=3.10"
+dependencies = [
+  "httpx>=0.28.1",
+  "pydantic>=2.12.5",
+  "websockets>=13.0",
+  "zeroconf>=0.148.0",
+]
+
+[project.urls]
+Homepage = "https://ikalogic.com/test-sequencers/at1000/intro/"
+Documentation = "https://ikalogic.com/kb/at1000-api/at1000_home/"
+
+[build-system]
+requires = ["uv_build>=0.11.24,<0.12.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+  "hypothesis>=6.150.2",
+  "pytest>=9.0.2",
+  "pytest-asyncio>=1.3.0",
+  "pytest-cov>=7.0.0",
+  "ruff>=0.14.13",
+]
+
+[tool.ruff.lint]
+extend-select = ["B", "N"]
+
+[tool.pytest.ini_options]
+addopts = [
+  "--import-mode=importlib",
+  "--maxfail=1",
+  "--cov=ikalogic_at1000",
+  "--cov-report=term-missing",
+]
+asyncio_mode = "auto"

ikalogic_at1000-0.2.0/src/ikalogic_at1000/__init__.py

@@ -0,0 +1,231 @@
+"""AT1000 Python SDK (synchronous client).
+
+The asynchronous client lives in :mod:`ikalogic_at1000.aio`.
+"""
+
+from importlib.metadata import PackageNotFoundError, version
+
+from ._core.errors import ApiError
+from ._core.events import DeviceEvent
+from ._core.models import (
+    AnalogInputConfiguration,
+    AnalogOutputConfiguration,
+    AnalogState,
+    AudioCapabilities,
+    BundleInfo,
+    CalibrationData,
+    CalibrationPoint,
+    CalibrationState,
+    Capabilities,
+    CanConfig,
+    CanConfigPatch,
+    CanFrame,
+    CanRxFilter,
+    ChannelCalibration,
+    Color,
+    CommunicationCapability,
+    CommunicationInterfaceType,
+    CreateProject,
+    CurrentMeasurementCapabilities,
+    CurrentMeasurementType,
+    CurrentRange,
+    CurrentTestResult,
+    DigitalInputConfiguration,
+    DigitalOutputConfiguration,
+    DigitalState,
+    DisplayCapabilities,
+    DutPsuCalibration,
+    EthernetCapability,
+    EthernetType,
+    HmiCapabilities,
+    I2cConfig,
+    I2cReadTransaction,
+    I2cWriteTransaction,
+    Information,
+    InputCapabilities,
+    InstallResponse,
+    InternalKnobEvent,
+    IoCapabilities,
+    KnobEvent,
+    ManagementVoltageRangeModel,
+    OpenDrainConfiguration,
+    PartialAnalogOutputConfiguration,
+    PartialDigitalInputConfiguration,
+    PartialDigitalOutputConfiguration,
+    PartialOpenDrainConfiguration,
+    PlaybackConfiguration,
+    PortMapping,
+    PowerDutConfiguration,
+    PowerDutState,
+    PowerSupplyCapabilities,
+    PowerUsbConfiguration,
+    PowerUsbState,
+    Progress,
+    ProgressValue,
+    Project,
+    ProjectEvent,
+    ProjectPatch,
+    Projects,
+    RebootResponse,
+    RelayAction,
+    RelayPowerState,
+    RelaysCapabilities,
+    RelayState,
+    RelayTestResult,
+    Rs232Config,
+    Rs485Config,
+    RunMode,
+    ScreenSize,
+    ScreenText,
+    SerialParity,
+    SerialStopBits,
+    SpiConfig,
+    SyncAction,
+    SyncConfiguration,
+    Text,
+    Time,
+    UartConfig,
+    UpdateStatus,
+    UsbCapability,
+    UsbDevice,
+    UsbInterface,
+    UsbState,
+    UsbTestResult,
+    UsbType,
+)
+from .at1000 import AT1000
+from .com import Can, ComApi, ComUsb, I2c, Rs232, Rs485, Spi, Uart
+from .discovery import find_devices
+from .events import EventsApi
+from .gpio import AnalogIO, DigitalIO, GpioApi
+from .hmi import Audio, HmiApi, Knob, Screen
+from .management import ManagementApi
+from .power import PowerApi, PowerDut, PowerUsb, RelayPower
+from .relays import Relay, RelaysApi
+
+try:
+    __version__ = version("ikalogic-at1000")
+except PackageNotFoundError:  # pragma: no cover
+    __version__ = "0.0.0"
+
+__all__ = [
+    "__version__",
+    "AT1000",
+    "ApiError",
+    "find_devices",
+    # gpio
+    "AnalogIO",
+    "AnalogInputConfiguration",
+    "AnalogOutputConfiguration",
+    "AnalogState",
+    "DigitalIO",
+    "DigitalInputConfiguration",
+    "DigitalOutputConfiguration",
+    "DigitalState",
+    "GpioApi",
+    "OpenDrainConfiguration",
+    "PartialAnalogOutputConfiguration",
+    "PartialDigitalInputConfiguration",
+    "PartialDigitalOutputConfiguration",
+    "PartialOpenDrainConfiguration",
+    "SyncAction",
+    "SyncConfiguration",
+    # power
+    "PowerApi",
+    "PowerDut",
+    "PowerDutConfiguration",
+    "PowerDutState",
+    "PowerUsb",
+    "PowerUsbConfiguration",
+    "PowerUsbState",
+    "RelayPower",
+    "RelayPowerState",
+    # com
+    "Can",
+    "CanConfig",
+    "CanConfigPatch",
+    "CanFrame",
+    "CanRxFilter",
+    "ComApi",
+    "ComUsb",
+    "I2c",
+    "I2cConfig",
+    "I2cReadTransaction",
+    "I2cWriteTransaction",
+    "Rs232",
+    "Rs232Config",
+    "Rs485",
+    "Rs485Config",
+    "SerialParity",
+    "SerialStopBits",
+    "Spi",
+    "SpiConfig",
+    "Uart",
+    "UartConfig",
+    "UsbDevice",
+    "UsbInterface",
+    "UsbState",
+    # hmi
+    "Audio",
+    "Color",
+    "HmiApi",
+    "InternalKnobEvent",
+    "Knob",
+    "KnobEvent",
+    "PlaybackConfiguration",
+    "Progress",
+    "ProgressValue",
+    "Screen",
+    "ScreenText",
+    "Text",
+    # relays
+    "Relay",
+    "RelayAction",
+    "RelayState",
+    "RelaysApi",
+    # events
+    "DeviceEvent",
+    "EventsApi",
+    # management
+    "AudioCapabilities",
+    "BundleInfo",
+    "CalibrationData",
+    "CalibrationPoint",
+    "CalibrationState",
+    "Capabilities",
+    "ChannelCalibration",
+    "CommunicationCapability",
+    "CommunicationInterfaceType",
+    "CreateProject",
+    "CurrentMeasurementCapabilities",
+    "CurrentMeasurementType",
+    "CurrentRange",
+    "CurrentTestResult",
+    "DisplayCapabilities",
+    "DutPsuCalibration",
+    "EthernetCapability",
+    "EthernetType",
+    "HmiCapabilities",
+    "Information",
+    "InputCapabilities",
+    "InstallResponse",
+    "IoCapabilities",
+    "ManagementApi",
+    "ManagementVoltageRangeModel",
+    "PortMapping",
+    "PowerSupplyCapabilities",
+    "Project",
+    "ProjectEvent",
+    "ProjectPatch",
+    "Projects",
+    "RebootResponse",
+    "RelayTestResult",
+    "RelaysCapabilities",
+    "RunMode",
+    "ScreenSize",
+    "Time",
+    "UpdateStatus",
+    "UsbCapability",
+    "UsbTestResult",
+    "UsbType",
+]

ikalogic_at1000-0.2.0/src/ikalogic_at1000/_core/__init__.py

@@ -0,0 +1 @@
+"""Concurrency-agnostic core shared by the sync and async AT1000 clients."""

ikalogic_at1000-0.2.0/src/ikalogic_at1000/_core/errors.py

@@ -0,0 +1,22 @@
+"""Structured API error mirroring the JavaScript SDK's ``ApiError``."""
+
+
+class ApiError(Exception):
+    """Error raised for AT1000 responses carrying ``{code, message, suggestion, path}``.
+
+    The string representation matches the JavaScript SDK exactly so callers can
+    rely on ``str(error)`` containing the offending ``path``.
+    """
+
+    def __init__(self, *, code: str, message: str, suggestion: str, path: str):
+        self.code = code
+        # Raw human-readable server message (without code/suggestion/path).
+        self.detail = message
+        self.suggestion = suggestion
+        self.path = path
+        formatted_suggestion = suggestion.replace("\n", "\n                ")
+        super().__init__(
+            f"{message} ({code})\n"
+            f"    Suggestion: {formatted_suggestion}\n"
+            f"    Path: {path}"
+        )