#!/usr/bin/env python
# coding: utf-8

# # QCoDeS Example with Keysight 33500B

# In[1]:


import qcodes as qc
from qcodes.instrument_drivers.Keysight.KeysightAgilent_33XXX import WaveformGenerator_33XXX 


# In[2]:


ks = WaveformGenerator_33XXX('ks', 'TCPIP0::K-33522B-00256::inst0::INSTR')


# ## Basic usage

# In[20]:


# SET up a sawtooth
ks.ch1.function_type('RAMP')
ks.ch1.ramp_symmetry(100)
ks.ch1.amplitude_unit('VPP')
ks.ch1.amplitude(1)
ks.ch1.offset(0)
ks.ch1.frequency(2e3)
ks.sync.source(1)


# In[18]:


# Start it
ks.sync.output('ON')
ks.ch1.output('ON')


# In[21]:


ks.ch1.frequency(1e3)


# In[22]:


# stop it
ks.sync.output('OFF')
ks.ch1.output('OFF')


# ## Using burst mode

# In burst mode, the instrument starts running a task (e.g. a waveform generation) upon receiving a trigger
# 

# In[23]:


# TRIGGERING

# Can be 'EXT' (external), 'IMM' (immediate, internal),
# 'BUS' (software trigger), 'TIM' (timed)
ks.ch1.trigger_source('EXT')  

ks.ch1.trigger_count(1)
ks.ch1.trigger_delay(0)  # seconds

# for external triggering, a slope should be specified
ks.ch1.trigger_slope('POS')

# For timed triggering, the time between each trigger should be set
ks.ch1.trigger_timer(50e-3)

# BURSTING

ks.ch1.burst_state('ON')
ks.ch1.burst_mode('N Cycle')  # Can be 'N Cycle' or 'Gated'

# when in 'N Cycle' mode, the following options are available
ks.ch1.burst_ncycles(1)  # Can be 1, 2, 3,... , 'MIN', 'MAX', or 'INF'
ks.ch1.burst_phase(180)  # the starting phase (degrees)

# If in 'Gated' mode, the following should be specified
ks.ch1.burst_polarity('NORM')  # Can be 'NORM' or 'INV'


# ## Error handling

# In[24]:


# The instrument has an error queue of length up to 20 messages.
# The queue message retrieval is first-in-first-out

# The first (i.e. oldest) error message in the queue can be gotten (and thereby removed from the queue)
ks.error()


# In[25]:


# The entire queue can be flushed out

# generate a few errors
for ii in range(3):
    ks.write('gimme an error!')

ks.flush_error_queue()


# In[ ]: