puda-drivers 0.0.5__py3-none-any.whl → 0.0.6__py3-none-any.whl

puda_drivers/core/__init__.py

@@ -1,3 +1,4 @@
 from .serialcontroller import SerialController, list_serial_ports
+from .logging import setup_logging
 
-__all__ = ["SerialController", "list_serial_ports"]
+__all__ = ["SerialController", "list_serial_ports", "setup_logging"]

puda_drivers/core/logging.py

@@ -0,0 +1,73 @@
+"""
+Logging configuration utility.
+
+This module provides a function to configure logging with optional file output
+to a logs folder.
+"""
+
+import logging
+from datetime import datetime
+from pathlib import Path
+from typing import Optional
+
+
+def setup_logging(
+    enable_file_logging: bool = False,
+    log_level: int = logging.DEBUG,
+    logs_folder: str = "logs",
+    log_file_name: Optional[str] = None,
+) -> None:
+    """
+    Configure logging with optional file output to a logs folder.
+
+    Args:
+        enable_file_logging: If True, logs will be written to files in the logs folder.
+                           If False, logs will only be output to console.
+        log_level: Logging level constant from logging module (e.g., logging.DEBUG,
+                   logging.INFO, logging.WARNING, logging.ERROR, logging.CRITICAL).
+                   Defaults to logging.DEBUG.
+        logs_folder: Name of the folder to store log files (default: "logs")
+        log_file_name: Custom name for the log file. If None or empty string, uses
+                      timestamp-based name. If provided without .log extension, it will
+                      be added automatically.
+    """
+    # Create logs folder if file logging is enabled
+    if enable_file_logging:
+        log_dir = Path(logs_folder)
+        log_dir.mkdir(exist_ok=True)
+        
+        # Create a log file with custom name or timestamp
+        if log_file_name and log_file_name.strip():  # None or empty/whitespace strings use timestamp
+            # Ensure .log extension if not present
+            if not log_file_name.endswith(".log"):
+                log_file_name = f"{log_file_name}.log"
+            log_file = log_dir / log_file_name
+        else:
+            # Default: timestamp-based name
+            timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
+            log_file = log_dir / f"log_{timestamp}.log"
+        
+        # Configure logging with both console and file handlers
+        logging.basicConfig(
+            level=log_level,
+            format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
+            handlers=[
+                logging.StreamHandler(),  # Console output
+                logging.FileHandler(log_file, mode="w"),  # File output
+            ],
+        )
+        
+        # Log that file logging is enabled
+        logger = logging.getLogger(__name__)
+        logger.info("File logging enabled. Log file: %s", log_file)
+    else:
+        # Configure logging with only console handler
+        logging.basicConfig(
+            level=log_level,
+            format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
+            handlers=[logging.StreamHandler()],  # Console output only
+        )
+        
+        # Log that file logging is disabled
+        logger = logging.getLogger(__name__)
+        logger.info("File logging disabled. Logs will only be output to console.")

puda_drivers/core/serialcontroller.py

@@ -159,9 +159,13 @@ class SerialController(ABC):
                 # Read all available bytes
                 response += self._serial.read(self._serial.in_waiting)
 
-                # Check for expected response markers for early return
+                # Check for expected response markers for early return for qubot
                 if b"ok" in response or b"err" in response:
                     break
+                
+                # Check for expected response markers for early return for sartorius
+                if b"\xba\r" in response:
+                    break
             else:
                 time.sleep(0.1)
 
@@ -175,10 +179,12 @@ class SerialController(ABC):
         # Decode once and check the decoded string
         decoded_response = response.decode("utf-8", errors="ignore").strip()
         
-        if "ok" in decoded_response.lower():
+        if "ok" in decoded_response.lower(): # for qubot
             self._logger.debug("<- Received response: %r", decoded_response)
-        elif "err" in decoded_response.lower():
+        elif "err" in decoded_response.lower(): # for qubot
             self._logger.error("<- Received error: %r", decoded_response)
+        elif "º" in decoded_response: # for sartorius
+            self._logger.debug("<- Received response: %r", decoded_response)
         else:
             self._logger.warning(
                 "<- Received unexpected response (no 'ok' or 'err'): %r", decoded_response

{puda_drivers-0.0.5.dist-info → puda_drivers-0.0.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: puda-drivers
-Version: 0.0.5
+Version: 0.0.6
 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
@@ -27,6 +27,7 @@ Hardware drivers for the PUDA (Physical Unified Device Architecture) platform. T
 - **Gantry Control**: Control G-code compatible motion systems (e.g., QuBot)
 - **Liquid Handling**: Interface with Sartorius rLINE® pipettes and dispensers
 - **Serial Communication**: Robust serial port management with automatic reconnection
+- **Logging**: Configurable logging with optional file output to logs folder
 - **Cross-platform**: Works on Linux, macOS, and Windows
 
 ## Installation
@@ -47,6 +48,37 @@ pip install -e .
 
 ## Quick Start
 
+### Logging Configuration
+
+Configure logging for your application with optional file output:
+
+```python
+import logging
+from puda_drivers.core.logging import setup_logging
+
+# Configure logging with file output enabled
+setup_logging(
+    enable_file_logging=True,
+    log_level=logging.DEBUG,
+    logs_folder="logs", # Optional: default to logs
+    log_file_name="my_experiment"  # Optional: custom log file name
+)
+
+# Or disable file logging (console only)
+setup_logging(
+    enable_file_logging=False,
+    log_level=logging.INFO
+)
+```
+
+**Logging Options:**
+- `enable_file_logging`: If `True`, logs are written to files in the `logs/` folder. If `False`, logs only go to console (default: `False`)
+- `log_level`: Logging level constant (e.g., `logging.DEBUG`, `logging.INFO`, `logging.WARNING`, `logging.ERROR`, `logging.CRITICAL`) (default: `logging.DEBUG`)
+- `logs_folder`: Name of the folder to store log files (default: `"logs"`)
+- `log_file_name`: Custom name for the log file. If `None` or empty, uses timestamp-based name (e.g., `log_20250101_120000.log`). If provided without `.log` extension, it will be added automatically.
+
+When file logging is enabled, logs are saved to timestamped files (unless a custom name is provided) in the `logs/` folder. The logs folder is created automatically if it doesn't exist.
+
 ### Gantry Control (GCode)
 
 ```python
@@ -183,6 +215,29 @@ except ValueError as e:
 
 Validation errors are automatically logged at the ERROR level before the exception is raised.
 
+### Logging Best Practices
+
+For production applications, configure logging at the start of your script:
+
+```python
+import logging
+from puda_drivers.core.logging import setup_logging
+from puda_drivers.move import GCodeController
+
+# Configure logging first, before initializing devices
+setup_logging(
+    enable_file_logging=True,
+    log_level=logging.INFO,
+    log_file_name="gantry_operation"
+)
+
+# Now all device operations will be logged
+gantry = GCodeController(port_name="/dev/ttyACM0")
+# ... rest of your code
+```
+
+This ensures all device communication, movements, and errors are captured in log files for debugging and audit purposes.
+
 ## Finding Serial Ports
 
 To discover available serial ports on your system:

{puda_drivers-0.0.5.dist-info → puda_drivers-0.0.6.dist-info}/RECORD

@@ -1,7 +1,8 @@
 puda_drivers/__init__.py,sha256=rcF5xCkMgyLlJLN3gWwJnUoW0ShPyISeyENvaqwg4Ik,503
 puda_drivers/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-puda_drivers/core/__init__.py,sha256=JM6eWTelwcmjTGM3gprQlJWzPGEpIdRrDmbCHtGoKyM,119
-puda_drivers/core/serialcontroller.py,sha256=I7TsLNl45HPrO29LkhMRIQQ8fWdjdJUvIwQQ5swbMHM,7660
+puda_drivers/core/__init__.py,sha256=yYsOLXl32msFNRGrXLqhNVl_OfNPFR4ED7pmgn7rPU0,171
+puda_drivers/core/logging.py,sha256=prOeJ3CGEbm37TtMRyAOTQQiMU5_ImZTRXmcUJxkenc,2892
+puda_drivers/core/serialcontroller.py,sha256=9Vgz884MWmq4Z7rQzIQ7DtPzygMuzBeNWj0JiUpAhGA,7996
 puda_drivers/move/__init__.py,sha256=i7G5VKD5FgnmC21TLxoASVtC88IrPUTLDJrTnp99u-0,35
 puda_drivers/move/gcode.py,sha256=egZw3D5m9d1R8P32L1wd3lDwiWcFMDGPHsFMFIYXkRA,22069
 puda_drivers/move/grbl/__init__.py,sha256=vBeeti8DVN2dACi1rLmHN_UGIOdo0s-HZX6mIepLV5I,98
@@ -11,7 +12,7 @@ puda_drivers/transfer/liquid/sartorius/__init__.py,sha256=QGpKz5YUwa8xCdSMXeZ0iR
 puda_drivers/transfer/liquid/sartorius/api.py,sha256=jxwIJmY2k1K2ts6NC2ZgFTe4MOiH8TGnJeqYOqNa3rE,28250
 puda_drivers/transfer/liquid/sartorius/constants.py,sha256=mcsjLrVBH-RSodH-pszstwcEL9wwbV0vOgHbGNxZz9w,2770
 puda_drivers/transfer/liquid/sartorius/sartorius.py,sha256=iW3v-YHjj4ZAfGv0x0J-XV-Y0fAAhS6xmSg2ozQm4UI,13803
-puda_drivers-0.0.5.dist-info/METADATA,sha256=5VB_QiC_hcuV4-FEoXi-qEp637jAjQLiv5fipHX9QPg,6559
-puda_drivers-0.0.5.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-puda_drivers-0.0.5.dist-info/licenses/LICENSE,sha256=7EI8xVBu6h_7_JlVw-yPhhOZlpY9hP8wal7kHtqKT_E,1074
-puda_drivers-0.0.5.dist-info/RECORD,,
+puda_drivers-0.0.6.dist-info/METADATA,sha256=ELS1LZxhddh-dD-b0iKDrO5RnuJrrgITv6F6GeJ20wY,8598
+puda_drivers-0.0.6.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+puda_drivers-0.0.6.dist-info/licenses/LICENSE,sha256=7EI8xVBu6h_7_JlVw-yPhhOZlpY9hP8wal7kHtqKT_E,1074
+puda_drivers-0.0.6.dist-info/RECORD,,