qslib 0.14.0-rc5

QSlib QuantStudio qPCR machine library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

from typing import List, Optional, Union

class QSConnection:
    """Connection to a QuantStudio machine for sending commands and receiving responses"""
    def __init__(self, host: str, port: int = 7443, connection_type: str = "Auto") -> None:
        """Create a new QSConnection
        
        Args:
            host: Hostname or IP address to connect to
            port: Port number (default: 7443) 
            connection_type: Connection type - "Auto", "SSL", or "TCP" (default: "Auto")
            
        Raises:
            ValueError: If connection_type is invalid or connection fails
        """
        ...
    
    def run_command(self, command: Union[str, bytes]) -> MessageResponse:
        """Send a command
        
        Args:
            command: Command string or bytes to send
            
        Returns:
            MessageResponse object to get the server's response
            
        Raises:
            ValueError: If command is invalid or connection error occurs
        """
        ...
        
    def run_command_bytes(self, bytes: bytes) -> MessageResponse:
        """Send a raw bytes command
        
        Args:
            bytes: Raw command bytes to send
            
        Returns:
            MessageResponse object to get the server's response
            
        Raises:
            ValueError: If command is invalid or connection error occurs
        """
        ...
        
    def subscribe_log(self, topics: List[str]) -> LogReceiver:
        """Subscribe to log messages for specified topics
        
        Args:
            topics: List of topic strings to subscribe to
            
        Returns:
            LogReceiver object to receive log messages
            
        Raises:
            ValueError: If subscription fails
        """
        ...
        
    def connected(self) -> bool:
        """Check if the connection is still active
        
        Returns:
            True if connected, False otherwise
        """
        ...

class MessageResponse:
    """Response handler for QuantStudio machine commands"""
    def get_response(self) -> str:
        """Get the response from the machine
        
        Returns:
            Response message from server
            
        Raises:
            ValueError: If response is an error or invalid
        """
        ...
        
    def __next__(self) -> str:
        """Get next response from server (alias for get_response)"""
        ...
        
    def get_ack(self) -> str:
        """Get acknowledgment from server
        
        Returns:
            Empty string on success
            
        Raises:
            ValueError: If response is not an acknowledgment
        """
        ...
        
    def get_response_with_timeout(self, timeout: int) -> str:
        """Get response from server with timeout
        
        Args:
            timeout: Timeout in seconds
            
        Returns:
            Response message from server
            
        Raises:
            TimeoutError: If timeout occurs
            ValueError: If response is an error or invalid
        """
        ...

class LogReceiver:
    """Receiver for subscribed log messages"""
    def __next__(self) -> LogMessage:
        """Get next log message
        
        Returns:
            LogMessage containing topic and message
            
        Raises:
            ValueError: If no message available
        """
        ...
        
    def next(self) -> LogMessage:
        """Get next log message (alias for __next__)"""
        ...

class LogMessage:
    """Log message from QuantStudio machine"""
    topic: str  # Topic the message was published to
    message: str  # Content of the log message