apt-thorlabs 0.0.2__tar.gz

apt_thorlabs-0.0.2/.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+name: Publish Thorlabs APT
+
+on:
+    release:
+        types: [published]
+
+jobs:
+    publish:
+        runs-on: ubuntu-latest
+        environment: pypi
+
+        permissions:
+            contents: read
+            id-token: write
+            
+        steps:
+            
+            - uses: actions/checkout@v6
+              with:
+                  persist-credentials: false
+
+            - name: Install uv
+              uses: astral-sh/setup-uv@v6
+              
+            - name: Build package
+              run: uv build
+
+            - name: Publish to PyPI
+              uses: pypa/gh-action-pypi-publish@release/v1

apt_thorlabs-0.0.2/.github/workflows/test.yml

@@ -0,0 +1,92 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+env:
+  UV_USE_ACTIVE_ENV: 1
+
+jobs:
+  lint:
+    name: Linting
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          
+      - name: Install uv
+        uses: yezz123/setup-uv@v4
+        with:
+          uv-version: 0.12.5
+
+      - name: Install tox
+        run: pip install tox
+                  
+      - name: Run lint
+        run: tox -e lint
+
+  type:
+    name: Type check
+    runs-on: ubuntu-latest
+    needs: lint
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          
+      - name: Install uv
+        uses: yezz123/setup-uv@v4
+        with:
+          uv-version: 0.12.5
+
+      - name: Install tox
+        run: pip install tox
+                  
+      - name: Run type check
+        run: tox -e type
+
+  test:
+    name: Tests 
+    needs: type
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-latest
+          - windows-latest
+        python-version:          
+          - "3.12"
+          - "3.13"
+          - "3.14"
+          
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          
+      - name: Install uv
+        uses: yezz123/setup-uv@v4
+        with:
+          uv-version: 0.12.5
+
+      - name: Install tox
+        run: pip install tox
+                  
+      - name: Run tests
+        run: tox -e test
+  

apt_thorlabs-0.0.2/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

apt_thorlabs-0.0.2/LICENSE

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

apt_thorlabs-0.0.2/PKG-INFO

@@ -0,0 +1,14 @@
+Metadata-Version: 2.5
+Name: apt-thorlabs
+Version: 0.0.2
+Summary: Python implementation of the Thorlabs APT communication protocol.
+Author-email: David Bakker <david.bakker@tno.nl>
+License-File: LICENSE
+Keywords: control,device
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.12
+Requires-Dist: pyserial>=3.5
+Description-Content-Type: text/markdown
+
+# thorlabs-apt
+Python implementation of the Thorlabs APT communication protocol

apt_thorlabs-0.0.2/README.md

@@ -0,0 +1,2 @@
+# thorlabs-apt
+Python implementation of the Thorlabs APT communication protocol

apt_thorlabs-0.0.2/apps/thorlabs_apt_device.py

@@ -0,0 +1,55 @@
+from __future__ import annotations
+
+from thorlabs_apt.kpa101 import KPA101, OperationMode
+
+MGMSG_MOD_IDENTIFY = 0x0223
+
+MGMSG_HW_REQ_INFO = 0x0005
+MGMSG_HW_GET_INFO = 0x0006
+
+# K-Cube Position Aligner
+
+if __name__ == "__main__":
+    from thorlabs_apt.device import list_devices
+
+    print(list_devices())
+    # dev = KBD101(serial_number="28251738")
+    # print(dev._hw_info)
+    #
+    kpa = KPA101(serial_number="69252608A")
+    print(kpa._hw_info)
+
+    # dev.enable_channel(1)
+    # print(dev.get_velocity_params())
+    # d = dev.get_stage_params()
+
+    # print(dev.get_homing_params())
+    # dev.home()
+    # print(dev.position())
+    # dev.move_relative(1.0)
+
+    # print(dev.position())
+    # dev.move_relative(1.0)
+    # print(dev.position())
+
+    # dev.move_absolute(10.0)
+
+    # print(dev.position())
+
+    # kpa = KPA101(serial_number="69252738")
+
+    print(kpa.position_demand_params)
+
+    kpa.operation_mode = OperationMode.OPEN_LOOP
+    print(kpa.operation_mode)
+    print(kpa.status_bits)
+    print(kpa.display_settings)
+    # print(kpa.position)
+    # kpa.position = (1.0, 1.0)
+    # print(kpa.position)
+    print(kpa.readings)
+    print(kpa.loop_params_2)
+    print(kpa.trig_io_config)
+    # while True:
+    #     print(kpa.readings)
+

apt_thorlabs-0.0.2/pyproject.toml

@@ -0,0 +1,117 @@
+[project]
+name = "apt-thorlabs"
+version = "0.0.2"
+description = "Python implementation of the Thorlabs APT communication protocol."
+authors = [
+    { name = "David Bakker", email = "david.bakker@tno.nl" },
+]
+readme = "README.md"
+requires-python = ">=3.12"
+keywords = ["device", "control"]
+dependencies = [
+    "pyserial>=3.5",    
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+]
+
+[dependency-groups]
+dev = [
+    "coverage>=7.6.0",
+    "ty>=0.0.69",
+    "tox>=4.52.0",
+    "pytest>=8.2.2",
+    "ruff>=0.5,<0.13"
+]
+
+[tool.ruff]
+line-length = 120
+target-version = "py312"
+exclude = ["apps"]
+
+[tool.ruff.lint]
+preview = true
+select = [
+    "A", # flake8-builtins
+    "ANN", # flake8-annotations
+    "ASYNC", # flake8-async
+    "B", # flake8-bugbear
+    "BLE", # flake8-blind-except
+    "COM", #flake8-commas
+    "C4", #flake8-comprehensions
+    "C90", # mccabe
+    #"D", # pydocstyle
+    "DTZ", # flake8-datetimez
+    "E", # pycodestyle (error)
+    "ERA", # eradicate
+    "EM", # flake8-errmsg
+    "EXE", # flake8-executable
+    "F", # Pyflakes
+    "FA", # flake8-future-annotations
+    "FBT", # flake8-boolean-trap
+    "FIX", # flake8-fixme
+    "FLY", # flynt
+    "G", # flake8-logging-format
+    "I", # isort
+    "ISC", # flake8-implicit-str-concat
+    "ICN", # flake8-import-conventions
+    "LOG", # flake8-logging
+    "N", # pep8-naming
+    "NPY", # NumPy-specific rules
+    "PD", # pandas-vet
+    "PERF", # Perflint
+    "PIE", # flake8-pie
+    "PT", # flake8-pytest-style
+    "PTH", # flake8-use-pathlib
+    "FURB", # refurb
+    "RET", # flake8-return
+    "RUF", # Ruff-specific rules
+    "RUF022",
+    "S", # flake8-bandit
+    "SIM", # flake8-simplify
+    "SLF", # flake8-self
+    "SLOT", # flake8-slots
+    "TCH", # flake8-type-checking
+    "TRY", # tryceratops
+    "T20", # flake8-print
+    "T100", # flake8-debugger
+    "UP", # pyupgrade
+    "W", # pycodestyle (warning)
+    "Q", # flake8-quotes
+    "YTT", # flake8-2020
+]
+ignore = [
+    "A005", # module shadowing a Python builtin module
+    "ANN401", # typing.Any can be useful (for example in __eq__)
+    "B027", # Ignore the rule for empty methods in abstract base classes
+    "COM812", # Conflicts with ruff format
+    "ISC001", # Possible conflicts with ruff format
+    "W605", # deprecated in Python 3.6
+    "A001", 
+    "A002",
+    "N801",
+    "FBT001",
+]
+isort.combine-as-imports = true
+pydocstyle.convention = "google"
+
+[tool.ruff.lint.extend-per-file-ignores]
+"*.py" = [
+    "S101", # asserts allowed everywhere
+]
+"tests/**/*.py" = [
+    "FBT", # Don't care about booleans as positional arguments in tests, e.g. via @pytest.mark.parametrize()
+    "D", # No doc requirements in tests
+    "SLF001", # Testing private functions is OK
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.hatch.build.targets.wheel]
+packages = ["thorlabs_apt"]
+

apt_thorlabs-0.0.2/tests/test_device.py

@@ -0,0 +1,134 @@
+from types import SimpleNamespace
+from unittest.mock import MagicMock
+
+import pytest
+import serial
+
+from thorlabs_apt.device import APTDevice, find_device, list_devices
+from thorlabs_apt.packet import (
+    MGMSG_HW_GET_INFO,
+    APTPacket,
+    HardwareInfo,
+    get_identify_packet,
+    request_hardware_info_packet,
+    set_channel_enable_state_packet,
+)
+
+
+@pytest.fixture
+def ports(monkeypatch: pytest.MonkeyPatch) -> list[SimpleNamespace]:
+    available_ports = [
+        SimpleNamespace(
+            device="COM3",
+            serial_number="12345678",
+            manufacturer="Thorlabs",
+            product="KDC101",
+            vid=0x1313,
+            pid=0x2019,
+        ),
+        SimpleNamespace(
+            device="COM4",
+            serial_number="87654321",
+            manufacturer=None,
+            product=None,
+            vid=None,
+            pid=None,
+        ),
+    ]
+    monkeypatch.setattr("thorlabs_apt.device.serial.tools.list_ports.comports", lambda: available_ports)
+    return available_ports
+
+
+class TestDeviceDiscovery:
+    def test_find_device_returns_port_for_matching_serial_number(self, ports: list[SimpleNamespace]) -> None:
+        assert find_device("87654321") == "COM4"
+
+    def test_find_device_returns_none_when_serial_number_is_not_found(self, ports: list[SimpleNamespace]) -> None:
+        assert find_device("missing") is None
+
+    def test_list_devices_formats_all_enumerated_ports(self, ports: list[SimpleNamespace]) -> None:
+        assert list_devices() == (
+            "device=COM3, manufacturer=Thorlabs, product=KDC101, vid=0x1313, pid=0x2019,serial_number=12345678\n"
+            "device=COM4, manufacturer=None, product=None, vid=None, pid=None,serial_number=87654321"
+        )
+
+
+def data_packet(message_id: int, data: bytes) -> bytes:
+    packet = APTPacket(message_id=message_id, destination=0x50, source=0x01)
+    packet.data_packet_length = len(data)
+    return packet.tobytes()
+
+
+@pytest.fixture
+def serial_port(monkeypatch: pytest.MonkeyPatch) -> MagicMock:
+    hardware_info = HardwareInfo(serial_number=12345678)
+    port = MagicMock()
+    port.read.side_effect = [data_packet(MGMSG_HW_GET_INFO, hardware_info.tobytes()), hardware_info.tobytes()]
+    port.write.side_effect = lambda data: len(data)
+    serial_constructor = MagicMock(return_value=port)
+    port.serial_constructor = serial_constructor
+    monkeypatch.setattr("thorlabs_apt.device.serial.Serial", serial_constructor)
+    return port
+
+
+@pytest.fixture
+def device(serial_port: MagicMock) -> APTDevice:
+    return APTDevice("COM3")
+
+
+class TestAPTDevice:
+    def test_initialization_configures_port_and_reads_hardware_info(
+        self, device: APTDevice, serial_port: MagicMock
+    ) -> None:
+        assert device.serial_number == 12345678
+        serial_port.serial_constructor.assert_called_once_with(
+            port="COM3",
+            baudrate=115200,
+            bytesize=serial.EIGHTBITS,
+            parity=serial.PARITY_NONE,
+            stopbits=serial.STOPBITS_ONE,
+            rtscts=True,
+            timeout=1.0,
+        )
+        serial_port.reset_input_buffer.assert_called_once()
+        serial_port.reset_output_buffer.assert_called_once()
+        serial_port.write.assert_called_once_with(request_hardware_info_packet().tobytes())
+        serial_port.flush.assert_called_once_with()
+        device._hw_info.serial_number = 12345678
+
+    def test_request_writes_packet_and_returns_data_payload(self, device: APTDevice, serial_port: MagicMock) -> None:
+        response_data = b"response"
+        serial_port.read.side_effect = [data_packet(0x1234, response_data), response_data]
+        packet = APTPacket(message_id=0x4321, destination=0x50, source=0x01)
+
+        assert device.request(packet) == response_data
+        serial_port.write.assert_called_with(packet.tobytes())
+
+    def test_set_marks_packet_as_data_packet_and_appends_payload(
+        self, device: APTDevice, serial_port: MagicMock
+    ) -> None:
+        packet = APTPacket(message_id=0x4321, destination=0x50, source=0x01)
+
+        device.set(packet, b"data")
+
+        assert serial_port.write.call_args.args == (b"!C\x04\x00\xd0\x01data",)
+
+    @pytest.mark.parametrize(
+        ("method_name", "expected_packet"),
+        [
+            ("identify", get_identify_packet(channel=2)),
+            ("enable_channel", set_channel_enable_state_packet(channel=2, enabled=True)),
+            ("disable_channel", set_channel_enable_state_packet(channel=2, enabled=False)),
+        ],
+    )
+    def test_channel_commands_write_expected_packets(
+        self, device: APTDevice, serial_port: MagicMock, method_name: str, expected_packet: APTPacket
+    ) -> None:
+        getattr(device, method_name)(2)
+
+        serial_port.write.assert_called_with(expected_packet.tobytes())
+
+    def test_get_channel_enable_state_reads_response_flag(self, device: APTDevice, serial_port: MagicMock) -> None:
+        serial_port.read.side_effect = [APTPacket(message_id=0x0212, param2=0x01).tobytes()]
+
+        assert device.get_channel_enable_state(2) is True