puda-drivers 0.0.16__tar.gz → 0.0.18__tar.gz

{puda_drivers-0.0.16 → puda_drivers-0.0.18}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: puda-drivers
-Version: 0.0.16
+Version: 0.0.18
 Summary: Hardware drivers for the PUDA platform.
-Project-URL: Homepage, https://github.com/zhao-bears/puda-drivers
-Project-URL: Issues, https://github.com/zhao-bears/puda-drivers/issues
+Project-URL: Homepage, https://github.com/PUDAP/puda
+Project-URL: Issues, https://github.com/PUDAP/puda/issues
 Author-email: zhao <20024592+agentzhao@users.noreply.github.com>
 License-Expression: MIT
 License-File: LICENSE
@@ -40,14 +40,6 @@ Hardware drivers for the PUDA (Physical Unified Device Architecture) platform. T
 pip install puda-drivers
 ```
 
-### From Source
-
-```bash
-git clone https://github.com/zhao-bears/puda-drivers.git
-cd puda-drivers
-pip install -e .
-```
-
 ## Quick Start
 
 ### Logging Configuration
@@ -197,28 +189,79 @@ sartorius_ports = list_serial_ports(filter_desc="Sartorius")
 
 ### Setup Development Environment
 
-First, install `uv` if you haven't already. See the [uv installation guide](https://docs.astral.sh/uv/getting-started/installation/) for platform-specific instructions.
+This package is part of a UV workspace monorepo. First, install `uv` if you haven't already. See the [uv installation guide](https://docs.astral.sh/uv/getting-started/installation/) for platform-specific instructions.
+
+**From the repository root:**
 
 ```bash
-# Create virtual environment
-uv venv
+# Or install dependencies for all workspace packages
+uv sync --all-packages
+```
+
+This will:
+- Create a virtual environment at the repository root (`.venv/`)
+- Install all dependencies for all workspace packages
+- Install `puda-drivers` and other workspace packages in editable mode automatically
 
-# Activate virtual environment
+**Using the package:**
+
+```bash
+# Run Python scripts with workspace context (recommended, works from anywhere in the workspace)
+uv run python your_script.py
+
+# Or activate the virtual environment (from repository root where .venv is located)
 source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+python your_script.py
+```
+
+**Adding dependencies:**
+
+```bash
+# From the package directory
+cd libs/drivers
+uv add some-package
+
+# Or from repository root
+uv add --package puda-drivers some-package
+```
+
+**Note:** Workspace packages are automatically installed in editable mode, so code changes are immediately available without reinstalling.
 
-# Install dependencies
-uv sync
+### Testing
+
+Run tests using pytest with `uv run`:
+
+```bash
+# Run all tests
+uv run pytest tests/
 
-# Install package in editable mode
-pip install -e .
+# Run a specific test file
+uv run pytest tests/test_deck.py
+
+# Run a specific test class
+uv run pytest tests/test_deck.py::TestDeckToDict
+
+# Run a specific test function
+uv run pytest tests/test_deck.py::TestDeckToDict::test_to_dict_empty_deck
+
+# Run with verbose output
+uv run pytest tests/ -v
+
+# Run with coverage report
+uv run pytest tests/ --cov=puda_drivers --cov-report=html
 ```
 
+**Note:** Make sure you're in the `libs/drivers` directory or use the full path to the tests directory when running pytest commands.
+
 ### Building and Publishing
 
 ```bash
 # Build distribution packages
 uv build
 
+# cd to puda project root
+cd ...
+
 # Publish to PyPI
 uv publish
 # Username: __token__

{puda_drivers-0.0.16 → puda_drivers-0.0.18}/README.md

@@ -18,14 +18,6 @@ Hardware drivers for the PUDA (Physical Unified Device Architecture) platform. T
 pip install puda-drivers
 ```
 
-### From Source
-
-```bash
-git clone https://github.com/zhao-bears/puda-drivers.git
-cd puda-drivers
-pip install -e .
-```
-
 ## Quick Start
 
 ### Logging Configuration
@@ -175,28 +167,79 @@ sartorius_ports = list_serial_ports(filter_desc="Sartorius")
 
 ### Setup Development Environment
 
-First, install `uv` if you haven't already. See the [uv installation guide](https://docs.astral.sh/uv/getting-started/installation/) for platform-specific instructions.
+This package is part of a UV workspace monorepo. First, install `uv` if you haven't already. See the [uv installation guide](https://docs.astral.sh/uv/getting-started/installation/) for platform-specific instructions.
+
+**From the repository root:**
 
 ```bash
-# Create virtual environment
-uv venv
+# Or install dependencies for all workspace packages
+uv sync --all-packages
+```
+
+This will:
+- Create a virtual environment at the repository root (`.venv/`)
+- Install all dependencies for all workspace packages
+- Install `puda-drivers` and other workspace packages in editable mode automatically
 
-# Activate virtual environment
+**Using the package:**
+
+```bash
+# Run Python scripts with workspace context (recommended, works from anywhere in the workspace)
+uv run python your_script.py
+
+# Or activate the virtual environment (from repository root where .venv is located)
 source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+python your_script.py
+```
+
+**Adding dependencies:**
+
+```bash
+# From the package directory
+cd libs/drivers
+uv add some-package
+
+# Or from repository root
+uv add --package puda-drivers some-package
+```
+
+**Note:** Workspace packages are automatically installed in editable mode, so code changes are immediately available without reinstalling.
 
-# Install dependencies
-uv sync
+### Testing
+
+Run tests using pytest with `uv run`:
+
+```bash
+# Run all tests
+uv run pytest tests/
 
-# Install package in editable mode
-pip install -e .
+# Run a specific test file
+uv run pytest tests/test_deck.py
+
+# Run a specific test class
+uv run pytest tests/test_deck.py::TestDeckToDict
+
+# Run a specific test function
+uv run pytest tests/test_deck.py::TestDeckToDict::test_to_dict_empty_deck
+
+# Run with verbose output
+uv run pytest tests/ -v
+
+# Run with coverage report
+uv run pytest tests/ --cov=puda_drivers --cov-report=html
 ```
 
+**Note:** Make sure you're in the `libs/drivers` directory or use the full path to the tests directory when running pytest commands.
+
 ### Building and Publishing
 
 ```bash
 # Build distribution packages
 uv build
 
+# cd to puda project root
+cd ...
+
 # Publish to PyPI
 uv publish
 # Username: __token__

{puda_drivers-0.0.16 → puda_drivers-0.0.18}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "puda-drivers"
-version = "0.0.16"
+version = "0.0.18"
 description = "Hardware drivers for the PUDA platform."
 readme = "README.md"
 authors = [
@@ -18,16 +18,21 @@ classifiers = [
 ]
 license = "MIT"
 license-files = ["LICEN[CS]E*"]
+
 dependencies = [
     "nats-py>=2.12.0",
     "opencv-python>=4.12.0.88",
     "pyserial~=3.5",
 ]
+[dependency-groups]
+dev = [
+    "pytest>=9.0.2",
+]
 
 [build-system]
 requires = ["hatchling >= 1.26"]
 build-backend = "hatchling.build"
 
 [project.urls]
-Homepage = "https://github.com/zhao-bears/puda-drivers"
-Issues = "https://github.com/zhao-bears/puda-drivers/issues"
+Homepage = "https://github.com/PUDAP/puda"
+Issues = "https://github.com/PUDAP/puda/issues"

{puda_drivers-0.0.16 → puda_drivers-0.0.18}/src/puda_drivers/core/serialcontroller.py

@@ -48,7 +48,7 @@ class SerialController(ABC):
         self._serial = None
         self.port_name = port_name
         self.baudrate = baudrate
-        self.timeout = timeout
+        self._timeout = timeout
         self._logger = logger
         
         # lock to prevent concurrent access to the serial port
@@ -75,7 +75,7 @@ class SerialController(ABC):
             self._serial = serial.Serial(
                 port=self.port_name,
                 baudrate=self.baudrate,
-                timeout=self.timeout,
+                timeout=self._timeout,
             )
             self._serial.flush()
             self._logger.info("Successfully connected to %s.", self.port_name)
@@ -107,19 +107,19 @@ class SerialController(ABC):
 
     def _send_command(self, command: str) -> None:
         """
-        Sends a custom protocol command.
+        Sends a command to the device.
         Note: This method should be called while holding self._lock to ensure
         atomic command/response pairing.
         """
+        self._logger.info("-> Sending: %r", command)
+
         if not self.is_connected or not self._serial:
             self._logger.error(
                 "Attempt to send command '%s' failed: Device not connected.",
                 command,
             )
             # Retain raising an error for being disconnected, as that's a connection state issue
-            raise serial.SerialException("Device not connected. Call connect() first.")
-
-        self._logger.info("-> Sending: %r", command)
+            raise serial.SerialException("Device disconnected. Call connect() first.")
 
         try:
             self._serial.reset_input_buffer()  # clear input buffer
@@ -140,7 +140,7 @@ class SerialController(ABC):
             )
             return None
 
-    def _read_response(self) -> str:
+    def _read_response(self, timeout: int = None) -> str:
         """
         Generic, blocking read that respects timeout and returns
         all data that arrived within the timeout period.
@@ -148,10 +148,13 @@ class SerialController(ABC):
         if not self.is_connected or not self._serial:
             raise serial.SerialException("Device not connected.")
 
+        if timeout is None:
+            timeout = self._timeout
+
         start_time = time.time()
         response = b""
 
-        while time.time() - start_time < self.timeout:
+        while time.time() - start_time < timeout:
             if self._serial.in_waiting > 0:
                 # Read all available bytes
                 response += self._serial.read(self._serial.in_waiting)
@@ -168,14 +171,12 @@ class SerialController(ABC):
 
         # Timeout reached - check what we got
         if not response:
-            self._logger.error("No response within %s seconds.", self.timeout)
+            self._logger.error("No response within %s seconds.", timeout)
             raise serial.SerialTimeoutException(
-                f"No response received within {self.timeout} seconds."
+                f"No response received within {timeout} seconds."
             )
 
-        # Decode once and check the decoded string
         decoded_response = response.decode("utf-8", errors="ignore").strip()
-        
         if "ok" in decoded_response.lower():
             self._logger.debug("<- Received response: %r", decoded_response)
         elif "err" in decoded_response.lower():
@@ -193,10 +194,12 @@ class SerialController(ABC):
     def _build_command(self, command: str, value: Optional[str] = None) -> str:
         """
         Build a command string according to the device protocol.
+        
+        There might be special starting and ending characters for devices
         """
-        pass
+        raise NotImplementedError
 
-    def execute(self, command: str, value: Optional[str] = None) -> str:
+    def execute(self, command: str, value: Optional[str] = None, timeout: int = None) -> str:
         """
         Send a command and read the response atomically.
         
@@ -218,22 +221,10 @@ class SerialController(ABC):
             serial.SerialException: If device is not connected or communication fails
             serial.SerialTimeoutException: If no response is received within timeout
         """
+        if timeout is None:
+            timeout = self._timeout
         # Hold the lock for the entire send+read operation to ensure atomicity
         # This prevents concurrent commands from mixing up responses
         with self._lock:
-            # Increase timeout by 60 seconds for G28 (homing) command
-            original_timeout = self.timeout
-            if "G28" in command.upper():
-                self.timeout = original_timeout + 60
-                # Also update the serial connection's timeout if connected
-                if self.is_connected and self._serial:
-                    self._serial.timeout = self.timeout
-            
-            try:
-                self._send_command(self._build_command(command, value))
-                return self._read_response()
-            finally:
-                # Restore original timeout
-                self.timeout = original_timeout
-                if self.is_connected and self._serial:
-                    self._serial.timeout = original_timeout
+            self._send_command(self._build_command(command, value))
+            return self._read_response(timeout=timeout)

{puda_drivers-0.0.16 → puda_drivers-0.0.18}/src/puda_drivers/labware/labware.py

@@ -3,9 +3,8 @@
 import json
 import inspect
 from pathlib import Path
-from typing import Dict, Any
+from typing import Dict, Any, List
 from abc import ABC
-from typing import List
 from puda_drivers.core import Position
 
 

{puda_drivers-0.0.16 → puda_drivers-0.0.18}/src/puda_drivers/labware/trash_bin.json

@@ -20,7 +20,8 @@
       "width": 10.0,
       "height": 10.0,
       "x": 60.0,
-      "y": 42.0
+      "y": 42.0,
+      "z": 0.0
     }
   },
   "groups": [