cc.scpi.generic_instrument

 1import socket
 2
 3from cc.serializer import SocketSerializer
 4
 5class GenericInstrument:
 6    """
 7    Generic instrument class.
 8    """
 9    
10    def __init__(self, ip_address, port=5025):
11        self._sock = None
12        self.ip_address = ip_address
13        self.port = port
14    
15    def connect(self):
16        """
17        Connect to the instrument.
18        """
19        self._sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
20        
21        addr = (self.ip_address, self.port)
22        try:
23            self._sock.connect(addr)
24        except socket.error as e:
25            print("failed to connect: ", addr)
26            print(e)
27        
28        return self._sock
29
30    def close(self):
31        """
32        Close the connection.
33        """
34        self._sock.close()
35    
36    def command(self, cmd: str):
37        """
38        Send a command to the instrument.
39        
40        Args:
41            cmd: the command to send
42        """
43        ser = SocketSerializer(self._sock, buffered_transmit=True)
44        ser.transmit(cmd.encode())
45    
46    def query(self, cmd: str):
47        """
48        Send a query to the instrument.
49
50        Args:
51            cmd: the command to send
52        
53        Returns:
54            the response from the instrument
55        """
56        ser = SocketSerializer(self._sock, buffered_transmit=True)
57        ser.transmit(cmd.encode())
58        data = ser.receive()
59        return data.decode()
60
61    def get_idn(self):
62        """
63        Get the instrument identification number
64
65        Returns:
66            the instrument identification
67        """
68        return self.query("*IDN?")
69
70    def get_instrument_identification(self):
71        """
72        Get the instrument identification number. This is an alias for `get_idn()`.
73
74        Returns:
75            the instrument identification
76        """
77        return self.get_idn()
78