Merge pull request #9 from MideTechnology/master

Improved TDKLambdaZPlus support

Author: rambo

.gitignore

@@ -38,3 +38,4 @@ nosetests.xml
 .mr.developer.cfg
 .project
 .pydevproject
+/venv*/

scpi/devices/TDKLambdaZPlus.py

@@ -3,17 +3,273 @@
 
 @author: qmor
 '''
+import decimal
+
 from ..scpi import SCPIDevice
 from ..transports.tcp import TCPTransport
-from .generic import MultiMeter, PowerSupply
-class TDKLambdaZplus(PowerSupply, MultiMeter, SCPIDevice):
-    pass
+from .generic import PowerSupply
+
+
+class TDKSCPI(SCPIDevice):
+
+    async def set_power_on_status_clear(self, setting):
+        """
+        Set the Power-On Status Clear setting.
+        * ON/1/True - This choice enables the power-on clearing of the listed registers
+        * OFF/0/false - This choice disable the clearing of the listed registers and they retain
+                        their status when a power-on condition occurs
+        """
+        setting = str(setting).upper()
+        if setting in ("1", "ON", "TRUE"):
+            setting = "1"
+        elif setting in ("0", "OFF", "FALSE"):
+            setting = "0"
+        else:
+            raise ValueError
+        await super().set_power_on_status_clear(setting)
+
+
+    async def restore_state(self, state):
+        """
+        Restores the power supply to a state previously stored in memory by *SAV command.
+        """
+        state = int(state)
+        if state not in (1, 2, 3, 4):
+            raise ValueError
+
+        await super().restore_state(state)
+
+    async def save_state(self, state):
+        """
+        The SAV command saves all applied configuration settings.
+        """
+        state = int(state)
+        if state not in (1, 2, 3, 4):
+            raise ValueError
+
+        await super().save_state(state)
+
+    async def power_on_state(self, setting):
+        """
+        Set the power-on behavior of the system
+        * 1 - AUTO - The power supply output will return to its previous value
+                     when the latching fault condition is removed or to the
+                     stored value after AC recycle.
+        * 0 - SAFE - The power supply output will remain Off after the fault
+                     condition is removed or after AC recycle.
+        """
+        setting = str(setting).upper()
+        if setting in ("1", "ON", "TRUE"):
+            setting = "1"
+        elif setting in ("0", "OFF", "FALSE"):
+            setting = "0"
+        else:
+            raise ValueError
+        await super().power_on_state(setting)
+
+
+class TDKLambdaZplus(PowerSupply, TDKSCPI):
+
+    def __init__(self, protocol, use_safe_variants=True, voltage=20, current=10):
+        """
+        Initialize the device with voltage [V] and current [A] limits.
+        """
+
+        self.voltage_limit = voltage
+        self.current_limit = current
+
+        super().__init__(protocol, use_safe_variants=use_safe_variants)
+
+    async def measure_current(self, extra_params=""):
+        """
+        Returns the actual output current in amps.
+
+        extra_params: String to append to the command.  The only valid command
+                for this device is ":DC"
+        """
+
+        resp = await self.ask("MEAS:CURR%s?" % extra_params)
+        return decimal.Decimal(resp)
+
+    async def measure_voltage(self, extra_params=""):
+        """
+        Returns the actual output voltage in volts.
+
+        extra_params: String to append to the command.  The only valid command
+                for this device is ":DC"
+        """
+
+        resp = await self.ask("MEAS:VOLT%s?" % extra_params)
+        return decimal.Decimal(resp)
+
+    async def measure_power(self, extra_params=""):
+        """
+        Returns the actual output power in watts.
+
+        extra_params: String to append to the command.  The only valid command
+                for this device is ":DC"
+        """
+
+        resp = await self.ask("MEAS:POW%s?" % extra_params)
+        return decimal.Decimal(resp)
+
+    async def select_active_instrument(self, id):
+        """
+        Select the power supply for communication.
+
+        id: the ID of the power supply to select.  int from 1-31
+        """
+
+        _id = int(id)
+
+        if _id < 1 or id > 31:
+            raise ValueError('id %d is outside of the valid id range' % _id)
+
+        await self.command("INSTrument:NSELect %d" % _id)
+
+    async def query_active_instrument(self):
+        """
+        Returns the ID of the active instrument.
+        """
+
+        resp = await self.ask("INSTrument:NSELect?")
+        return decimal.Decimal(resp)
+
+    async def couple_mode(self, couple="NONE"):
+        """
+        Couple for all Z+ power supplies.
+        """
+
+        couple = couple.upper()
+
+        if couple in ("NONE", "ALL"):
+            await self.command("INSTrument:COUPle %s" % couple)
+        else:
+            raise ValueError("Argument '%s' not valid for INST:COUP" % couple)
+
+    async def set_voltage_protection(self, volts):
+        """
+        Set over-voltage protection level.
+        """
+
+        _volts = str(volts).upper()
+
+        await self.command("VOLTage:PROTection:LEVel")
+
+    async def query_voltage_protection(self, mode=None):
+        """
+        Query the voltage protection level.  Depending on mode, returns the current level, the
+        minimum level, or the maximum level.
+
+        mode: Which value to return.
+                - None (default): returns the current voltage protection level
+                - "MAX": returns the maximum possible voltage protection level
+                - "MIN": returns the minimum possible voltage protection level, approx. 105% the
+                         current voltage setting
+        """
+
+        if mode is None:
+            resp = await self.ask("VOLTage:PROTection:LEVel?")
+        else:
+            resp = await self.ask("VOLTage:PROTection:LEVel? %s" % mode)
+        return decimal.Decimal(resp)
+
+    async def flash_display(self, setting):
+        """
+        Make the front panel voltage and Current displays flash.
+        """
+
+        setting = str(setting).upper()
+        if setting in ("1", "ON", "TRUE"):
+            setting = "1"
+        elif setting in ("0", "OFF", "FALSE"):
+            setting = "0"
+        else:
+            raise ValueError
+        await self.command("DISPlay:FLASh %s" % setting)
+
+    async def global_enable(self, setting):
+        """
+        Set enable status of all units.
+        """
+
+        setting = str(setting).upper()
+        if setting in ("1", "ON", "TRUE"):
+            setting = "1"
+        elif setting in ("0", "OFF", "FALSE"):
+            setting = "0"
+        else:
+            raise ValueError
+        await self.command("GLOBal:OUTPut:STATe %s" % setting)
+
+    async def global_set_voltage(self, volts):
+        """
+        Set enable status of all units.
+        """
+
+        _volts = str(volts)
+
+        await self.command("GLOBal:VOLTage:AMPLitude %s" % _volts)
+
+    async def global_reset(self):
+        """
+        Reset all units.
+        """
+
+        await self.command("GLOBal:*RST")
+
+    async def set_voltage(self, millivolts, extra_params=""):
+        """
+        Sets the desired output voltage (but does not auto-enable outputs) in
+        millivolts, pass extra_params string to append to the command (like ":PROT")
+
+        Limited to five percent greater than the voltage limit of the unit.
+        """
+
+        if millivolts/1000. > 1.05*self.voltage_limit or millivolts < 0:
+            raise ValueError
+
+        await super().set_voltage(millivolts, extra_params=extra_params)
+
+    async def set_current(self, milliamps, extra_params=""):
+        """
+        Sets the desired output current (but does not auto-enable outputs) in
+        milliamps, pass extra_params string to append to the command (like ":TRIG")
+
+        Limited to five percent greater than the current limit of the unit.
+        """
+
+        if milliamps/1000. > 1.05*self.current_limit or milliamps < 0:
+            raise ValueError
+
+        await super().set_current(milliamps, extra_params=extra_params)
+
 
 def tcp(ip, port):
     """Quick helper to connect via TCP"""
     from ..transports.tcp import get as get_tcp
     from ..scpi import SCPIProtocol
-    transport = get_tcp(ip,port)
+    transport = get_tcp(ip, port)
+    protocol = SCPIProtocol(transport)
+    dev = TDKLambdaZplus(protocol)
+    return dev
+
+
+def serial(port, baudrate=9600):
+    """ Quick helper to connect via serial """
+    from ..transports.rs232 import RS232Transport
+    from ..scpi import SCPIProtocol
+    import serial
+    port = serial.Serial(port,
+                         baudrate=baudrate,
+                         bytesize=8,
+                         parity=serial.PARITY_NONE,
+                         stopbits=1,
+                         xonxoff=False,
+                         rtscts=False,
+                         dsrdtr=False,
+                         timeout=10)
+    transport = RS232Transport(port)
     protocol = SCPIProtocol(transport)
     dev = TDKLambdaZplus(protocol)
-    return dev
+    return dev

scpi/scpi.py

@@ -312,3 +312,51 @@ async def trigger(self):
         NOTE: For GPIB devices the Group Execute Trigger is way better, use it when possible
         however we do not do it transparently here since it triggers all devices on the bus"""
         await self.command("*TRG")
+
+    async def clear_status(self):
+        """
+        Sends a clear status command.
+        """
+        await self.command("*CLS")
+
+    async def operation_complete(self):
+        """
+        Sends an Operation Complete command.
+        """
+        await self.command("*OPC")
+
+    async def query_options(self):
+        """
+        Queries the model's options.
+        """
+        await self.ask("*OPT?")
+
+    async def set_power_on_status_clear(self, setting):
+        """
+        Set the Power-On Status Clear setting.
+        """
+        await self.command("*PSC %s" % setting)
+
+    async def save_state(self, state):
+        """
+        The SAV command saves all applied configuration settings.
+        """
+        state = int(state)
+        assert state in (1, 2, 3, 4)
+
+        await self.command("*SAV %d" % state)
+
+    async def restore_state(self, state):
+        """
+        Restores the power supply to a state previously stored in memory by *SAV command.
+        """
+        state = int(state)
+
+        await self.command("*RCL %d" % state)
+
+    async def power_on_state(self, setting):
+        """
+        Set the power-on behavior of the system
+        """
+        setting = str(setting).upper()
+        await self.command("*OUTP:PON %s" % setting)