% Class for controlling 4-channel Tektronix DPO scopes. 
% Tested with DPO4034, DPO3034
classdef MyDpo < MyScpiInstrument
    properties (SetAccess=protected, GetAccess=public)
        % List of the physical knobs, which can be rotated programmatically
        knob_list = {'GPKNOB1','GPKNOB2','HORZPos','HORZScale',...
            'TRIGLevel','PANKNOB1','VERTPOS','VERTSCALE','ZOOM'};
    end
    
    properties (Constant=true)
        N_CHANNELS = 4; % number of channels
    end
    
    methods (Access=public)
        function this=MyDpo(interface, address, varargin)
            this@MyScpiInstrument(interface, address, varargin{:});
            createCommandList(this);
            createCommandParser(this);
            connectDevice(this);
            % 2e7 is the maximum trace size of DPO4034-3034 
            %(10 mln point of 2-byte integers)
            this.Device.InputBufferSize = 2.1e7; %byte 
            this.Trace.name_x='Time';
            this.Trace.name_y='Voltage';
        end
        
        function readTrace(this)
            %set data format to be signed integer, reversed byte order
            fprintf(this.Device,'DATA:ENCDG SRIbinary');
            %2 bytes per measurement point
            fprintf(this.Device,'DATA:WIDTH 2');
            % read the entire trace
            fprintf(this.Device,'DATA:START 1;STOP %i;',this.point_no);
            fprintf(this.Device,'CURVE?');
            y_data = int16(binblockread(this.Device,'int16'));
            
            % Reading the relevant parameters from the scope
            readProperty(this,'unit_y','unit_x',...
                'step_x','step_y','x_zero');
                        
            % Calculating the y data
            y = double(y_data)*this.step_y; 
            n_points=length(y);
            % Calculating the x axis
            x = linspace(this.x_zero,...
                this.x_zero+this.step_x*(n_points-1),n_points);
            
            this.Trace.x = x;
            this.Trace.y = y;
            % Discard "" when assiging the Trace labels
            this.Trace.unit_x = this.unit_x(2:end-1);
            this.Trace.unit_y = this.unit_y(2:end-1);
            triggerNewData(this);
        end
        
        function acquireContinuous(this)
            openDevice(this);
            fprintf(this.Device,...
                'ACQuire:STOPAfter RUNSTop;:ACQuire:STATE ON');
            closeDevice(this);
        end
        
        function acquireSingle(this)
            openDevice(this);
            fprintf(this.Device,...
                'ACQuire:STOPAfter SEQuence;:ACQuire:STATE ON');
            closeDevice(this);
        end
        
        function turnKnob(this,knob,nturns)
            openDevice(this);
            fprintf(this.Device, sprintf('FPAnel:TURN %s,%i',knob,nturns));
            closeDevice(this);
        end
    end
    
    methods (Access=private)
        function createCommandList(this)
            % channel from which the data is transferred
            addCommand(this,'channel','DATa:SOUrce','default',1,...
                'str_spec','CH%i');
            % currently selected in the scope display channel
            addCommand(this, 'ctrl_channel', 'SELect:CONTROl',...
                'default',1, 'str_spec','CH%i');
            % units and scale for x and y waveform data
            addCommand(this,'unit_x','WFMOutpre:XUNit','access','r',...
                'classes',{'char'});
            addCommand(this,'unit_y','WFMOutpre:YUNit','access','r',...
                'classes',{'char'});
            addCommand(this,'step_y','WFMOutpre:YMUlt','access','r',...
                'classes',{'numeric'});
            addCommand(this,'step_x','WFMOutpre:XINcr','access','r',...
                'classes',{'numeric'});
            addCommand(this,'x_zero','WFMOutpre:XZEro','access','r',...
                'classes',{'numeric'});           
            % numbers of points
            addCommand(this, 'point_no','HORizontal:RECOrdlength',...
                'default', 100000,...
                'val_list', {1000, 10000, 100000, 1000000, 10000000},...
                'str_spec','%i');
            % time scale in s per div
            addCommand(this, 'time_scale','HORizontal:SCAle',...
                'default',10E-3,...
                'str_spec','%e');           
            % trigger level
            addCommand(this, 'trig_lev', 'TRIGger:A:LEVel',...
                'default',1,...
                'str_spec','%e');
            % trigger slope
            addCommand(this, 'trig_slope', 'TRIGger:A:EDGE:SLOpe',...
                'default', 'RISe', 'val_list',{'RISe','RIS','FALL'},...
                'str_spec','%s');
            % trigger source
            addCommand(this, 'trig_source', 'TRIGger:A:EDGE:SOUrce',...
                'default', 'AUX', 'val_list', {'CH1','CH2','CH3','CH4',...
                'AUX','EXT','LINE'},...
                'str_spec','%s');
            % trigger mode
            addCommand(this, 'trig_mode', 'TRIGger:A:MODe',...
                'default', 'AUTO', 'val_list',{'AUTO','NORMal','NORM'},...
                'str_spec','%s');
            % state of the data acquisition by the scope
            addCommand(this, 'acq_state', 'ACQuire:STATE',...
                'default',true, 'str_spec','%b');
            % acquisition mode
            addCommand(this, 'acq_mode', 'ACQuire:MODe',...
                'default', 'HIR', 'val_list',{'SAM','PEAK','HIR','AVE',...
                'ENV','SAMple','PEAKdetect','HIRes','AVErage','ENVelope'},...
                'str_spec','%s');
           
            % Parametric commands
            for i = 1:this.N_CHANNELS
                i_str = num2str(i);
                % coupling, AC, DC or GND
                addCommand(this,...
                    ['cpl',i_str],['CH',i_str,':COUP'],...
                    'default','DC', 'val_list', {'AC','DC','GND'},...
                    'str_spec','%s');              
                % impedances, 1MOhm or 50 Ohm
                addCommand(this,...
                    ['imp',i_str],['CH',i_str,':IMPedance'],...
                    'default','MEG', 'val_list', {'FIFty','FIF','MEG'},...
                    'str_spec','%s');
                % offset
                addCommand(this,...
                    ['offset',i_str],['CH',i_str,':OFFSet'],'default',0,...
                    'str_spec','%e');
                % scale, V/Div
                addCommand(this,...
                    ['scale',i_str],['CH',i_str,':SCAle'],'default',1,...
                    'str_spec','%e');
                % channel enabled
                addCommand(this,...
                    ['enable',i_str],['SEL:CH',i_str],'default',true,...
                    'str_spec','%b');
            end
        end
    end
end