Newport 842-PE

lantz/drivers/newport/842PE.py

@@ -0,0 +1,325 @@
+# -*- coding: utf-8 -*-
+"""
+    lantz.drivers.newport.842PE
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+    Newport 842-PE powermeter
+
+    :copyright: 2013 by Lantz Authors, see AUTHORS for more details.
+    :license: BSD, see LICENSE for more details.
+"""
+import time
+from lantz import Action, Feat, DictFeat
+from lantz.serial import SerialDriver
+
+class Newport842PE(SerialDriver):
+    """Newport 842-PE powermeter
+    """
+
+    ENCODING = 'ascii'
+
+    RECV_DONE = 'ACK\r\n' #this string is return by the device when the action is done
+    RECV_TERMINATION = '\r\n'
+    SEND_TERMINATION = '\r\n'
+
+    BAUDRATE = 115200
+    BYTESIZE = 8
+    PARITY = 'none'
+    STOPBITS = 1
+
+#Display commands
+
+    @Action(values={'real-time':0, 'histogram':1, 'statistic':2, 'needle':3, 'lineplot':4})
+    def sdu(self, value):
+        """This command is used to change the device’s on-screen display mode.
+        """
+        self.sendCommand('*sdu {}'.format(value))
+
+    @Action(values=set(('auto', '1p', '3p', '10p', '30p', '100p', '300p', '1n', '3n', '10n', '30n', '100n', '300n', '1u', '3u', '10u', '30u', '100u', '300u', '1m', '3m', '10m', '30m', '100m', '300m', '1', '3', '10', '30', '100', '300', '1k', '3k', '10k', '30k', '100k', '300k', '1M', '3M', '10M', '30M', '100M', '300M',)))
+    def ssa(self, value):
+        """This command is used to force the display of the current data into a specific range.
+        """
+        self.sendCommand('*ssa {}'.format(value))
+
+    @Action(values={True:1, False:0})
+    def dbu(self, value):
+        """This command changes the on-screen display unit to dBm.
+        """
+        self.sendCommand('*dbu {}'.format(value))
+
+    @Action(values={True:1, False:0})
+    def shl(self, value):
+        """This command is used to add significant digits to the on-screen reading.
+        """
+        self.sendCommand('*shl {}'.format(value))
+
+#MEASUREMENT COMMANDS - DATA ACQUISITION
+
+    @Feat()
+    def cvu(self):
+        """This command is used to query the value that is currently being displayed on the device’s screen. The value is displayed in Watts or in Joules (not in dBm).
+        """
+        result = self.query('*cvu')
+        return float(result.replace('Current Value:','').strip())
+
+    @Feat(values={False:'New Data Not Available', True:'New Data Available'})
+    def nvu(self):
+        """This command is used to check whether a new value is available from the device. Though optional, its use is recommended when used with single pulse operations. 
+        """
+        return self.query('*nvu')
+
+    @Feat()
+    def vsu(self):
+        """This command is used to read all the statistics data, provided that the device has previously been set into statistic mode.
+        """
+        return self.query('*vsu')
+
+    @Action(values={'stop':0, 'start raw':1, 'start saving':2, 'save both':3,})
+    def Log(self, value):
+        """This command is used to log data on the 842-PE meter’s EEPROM.
+        """
+        self.sendCommand('*log {}'.format(value))
+
+    #Buggy
+    @Action()
+    def fdl(self, value):
+        """This command is used to retrieve a logged file from the device.
+        """
+#        return self.query('*fdl {}'.format(value))
+        return self.query('*fdl 0')
+
+    #Buggy
+    @Feat()
+    def cau(self):
+        """This command is used to send data to the serial port according to the data sampling setting. The maximum transfer speed is 200Hz. 
+        """
+        return self.query('*cau')
+
+#MEASUREMENT COMMANDS - SETUP
+
+    def swa(self):
+        """This command is used to specify the wavelength being used on the detector. 
+        """
+        self.sendCommand('*swa {}'.format(value))
+
+    @Action(values={True:1, False:0})
+    def atu(self,value):
+        """This command is used to adjust the processing of the meter with the readings of the detector, depending on whether the detector is using an external attenuator or not.
+        """
+        self.sendCommand('*atu {}'.format(value))
+
+    @Action(values=(set((1,2,)), None))
+    def smu(self,value,multiplier):
+       """This command is used to set the value of the multipliers. 
+       """
+       self.sendCommand('*smu {0} {1}'.format(value,multiplier))
+
+    @Action(values=(set((1,2,)), None))
+    def sou(self,value,multiplier):
+        """This command is used to set the value of the offsets.
+        """
+        self.sendCommand('*sou {0} {1}'.format(value,multiplier))
+
+    @Feat()    
+    def rds(self):
+       """This command is used to read the current data sampling settings.
+       """
+       return self.query('*rds')
+
+    SampleRateUnit = {'second':0, 'minute':1, 'hour':2, 'day':3, '%':4}
+    SamplePeriodUnit = {'second':0, 'minute':1, 'hour':2, 'day':3, 'week':4, 'pulse':5}
+    TotalDurationUnit = {'sample':0, 'second':1, 'minute':2, 'hour':3, 'day':4, 'week':5, 'continuous':6, 'predefinded':7}
+    TimeStamp = {True:1, False:0}
+    @Action(values=(None, SampleRateUnit, None, SamplePeriodUnit, None, TotalDurationUnit, TimeStamp,))
+    def dsu(self, sampleRate, sampleRateUnit, samplePeriod, samplePeriodUnit, totalDuration, totalDurationUnit, timeStamp,):
+        """
+        """
+        self.sendCommand('*dsu {} {} {} {} {} {} {}'.format(sampleRate, sampleRateUnit, samplePeriod, samplePeriodUnit, totalDuration, totalDurationUnit, timeStamp,))
+
+    @Action()
+    def tla(self, value=True):
+        """This command sets the internal trigger level when using the device in energy reading mode. 
+        """
+        self.sendCommand('*tla {}%'.format(value))
+
+#MEASUREMENT COMMANDS - MEASUREMENT CONTROL
+
+    @Action(values={'disable':0, 'enable':1, 'reset':2})
+    def esu(self, value=True):
+        """This command is used start, stop and reset the statistics calculating process on the data currently being acquisitioned.
+        """
+        self.sendCommand('*esu {}'.format(value))
+
+    @Action(values={True:1, False:0})
+    def sca(self,value):
+        """
+        """
+        self.sendCommand('*sca {}'.format(value))
+
+    @Action(values={True:1, False:0})
+    def eaa(self,value):
+        """
+        """
+        self.sendCommand('*eaa {}'.format(value))
+
+    @Action(values={'off':0, 'on':1, 'undo':2})
+    def eoa(self,value):
+        """
+        """
+        self.sendCommand('*eoa {}'.format(value))
+
+#INSTRUMENT AND DETECTOR INFORMATION COMMANDS 
+
+    @Feat()
+    def ver(self):
+        """This command is used to query the device to get information about the firmware version and the device type.
+        """
+        return self.query('*ver')
+
+    @Feat()
+    def hea(self):
+        """Model of the current head
+        """
+        return self.query('*hea')
+
+    #The device is a bit buggy for this one as it return the info with 3 \n\r. So the hack here repare it.
+    @Feat()
+    def sta(self):
+        """This command is used to view data that is relevant to the current detector head. 
+        """
+        out = ''
+        out += self.query('*sta')
+        out += '\t{}'.format(self.recv())
+        out += '\t{}'.format(self.recv())
+        return out
+
+    @Feat()
+    def bat(self):
+        """This command is used to query the device’s remaining battery power. 
+        """
+        return self.query('*bat')
+
+    day = set(range(1,32))
+    month = set(range(1,13))
+    year = set(range(1970,3000))
+    hour = set(range(24))
+    minute = set(range(59))
+    second = set(range(59))
+    AMPM = {'AM':0, 'PM':1}
+    @Action(values=(day, month, year, hour, minute, second, AMPM,))
+    def clk(self, Day, Month, Year, Hour, Minute, Second, aMPM,):
+        """
+        """
+        self.sendCommand('*clk {} {} {} {} {} {} {}'.format(Day, Month, Year, Hour, Minute, Second, aMPM,))
+
+#INSTRUMENT CONTROL COMMANDS
+
+    @Action(values={True:1, False:0})
+    def bkl(self, value=True):
+        """This command is used to turn the backlight of the device display on or off.
+        """
+        self.sendCommand('*bkl {}'.format(value))
+
+    @Action(values={True:1, False:0})
+    def ano(self, value=True):
+        """This command is used to enable or disable the output of the current value on the analog port of the meter. 
+        """
+        self.sendCommand('*ano {}'.format(value))
+
+#COMMUNICATIONS COMMANDS
+
+    @Action(values=set((2400, 9600, 14400, 19200, 38400, 155200)))
+    def brs(self, value=True):
+        """This command is used to change the current baud rate of the serial port of the device. 
+        """
+        self.sendCommand('*brs {}'.format(value))
+
+    def query(self, command, *, send_args=(None, None), recv_args=(None, None)):
+        answer = super().query(command, send_args=send_args, recv_args=recv_args)
+        if answer == 'ERROR':
+            raise InstrumentError
+        return answer
+
+    def sendCommand(self, s):
+        self.send(s)
+        self.waitInstrumentDone()        
+
+    def waitInstrumentDone(self, termination=None, encoding=None, recv_chunk=None):
+        """Wait for command completion by instrument.
+
+        :param termination: termination character (overrides class default)
+        :type termination: str
+        :param encoding: encoding to transform bytes to string (overrides class default)
+        :param recv_chunk: number of bytes to receive (overrides class default)
+        :return: string encoded from received bytes
+        """
+
+        termination = termination or self.RECV_DONE
+        encoding = encoding or self.ENCODING
+        recv_chunk = recv_chunk or self.RECV_CHUNK
+
+        if not termination:
+            return str(self.raw_recv(recv_chunk), encoding)
+
+        if self.TIMEOUT is None or self.TIMEOUT < 0:
+            stop = float('+inf')
+        else:
+            stop = time.time() + self.TIMEOUT
+
+        received = self._received
+        while not termination in received:
+            if time.time() > stop:
+                raise LantzTimeoutError
+            raw_received = self.raw_recv(recv_chunk)
+            received += str(raw_received, encoding)
+
+        self.log_debug('Received {!r} (len={})', received, len(received))
+
+if __name__ == '__main__':
+    import argparse
+    import lantz.log
+
+    parser = argparse.ArgumentParser(description='Newport 842-PE powermeter')
+    parser.add_argument('-i', '--interactive', action='store_true',
+                        default=False, help='Show interactive GUI')
+    parser.add_argument('-p', '--port', type=str, default='17',
+                        help='Serial port to connect to')
+
+    args = parser.parse_args()
+    lantz.log.log_to_screen(lantz.log.DEBUG)
+    with Newport842PE(args.port) as inst:
+        if args.interactive:
+            from lantz.ui.qtwidgets import start_test_app
+            start_test_app(inst)
+        else:
+            print('Non interactive mode')
+            inst.sdu('statistic')
+            print(inst.ver)
+#            inst.Log('save both')
+#            time.sleep(1)
+#            inst.Log('stop')
+#            print(inst.fdl(1))
+#            print(inst.cau)            
+#            while 1:
+#                time.sleep(.1)
+#                print(inst.cvu)
+
+            dataAvailable = inst.nvu
+            if inst.nvu:
+                print(inst.cvu)
+#            print(inst.fdl) #buggy
+#            print(inst.cau) #buggy
+            inst.ssa('100m')
+            inst.bkl(1)
+            inst.dbu(False)
+            inst.shl(False)
+
+#            print(inst.sta)
+            print(inst.hea)
+            print(inst.bat)
+#            print(inst.sta)
+            inst.eoa('on')
+            #inst.sta
+            #inst.clk(5,9,2013,17,58,00,'PM')
+            #inst.dsu(1,'second', 10,'second', 1,'sample', True)
+            print(inst.rds)

lantz/drivers/newport/__init__.py

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+"""
+    lantz.drivers.newport
+    ~~~~~~~~~~~~~~~~~~~
+
+    :company: Newport
+    :description: 
+    :website: http://www.newport.com
+
+    ----
+
+    :copyright: 2013 by Lantz Authors, see AUTHORS for more details.
+    :license: BSD, see LICENSE for more details.
+"""
+
+from .842PE import 842PE
+
+__all__ = ['842PE',]
+