testing.ipynb

{
 "cells": [
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {
    "collapsed": true,
    "ExecuteTime": {
     "end_time": "2023-09-01T15:08:12.764124200Z",
     "start_time": "2023-09-01T15:08:12.675766400Z"
    }
   },
   "outputs": [],
   "source": [
    "import pyvisa\n",
    "from qudi.util.mutex import Mutex\n",
    "from qudi.core.configoption import ConfigOption\n",
    "from qudi.interface.microwave_interface import MicrowaveInterface, MicrowaveConstraints\n",
    "from qudi.util.enums import SamplingOutputMode"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 12,
   "outputs": [],
   "source": [
    "class MicrowaveSynthNVPro():\n",
    "    \"\"\" Hardware class to controls a SynthNV Pro.\n",
    "\n",
    "    Example config for copy-paste:\n",
    "\n",
    "    mw_source_synthnv:\n",
    "        module.Class: 'microwave.mw_source_windfreak_synthnvpro.MicrowaveSynthNVPro'\n",
    "        options:\n",
    "            serial_port: 'COM3'\n",
    "            comm_timeout: 10  # in seconds\n",
    "            output_channel: 0  # either 0 or 1\n",
    "    \"\"\"\n",
    "\n",
    "    _serial_port = ConfigOption('serial_port', missing='error')\n",
    "    _comm_timeout = ConfigOption('comm_timeout', default=10, missing='warn')\n",
    "    _output_channel = ConfigOption('output_channel', 0, missing='info')\n",
    "\n",
    "    def __init__(self, *args, **kwargs):\n",
    "\n",
    "        self._thread_lock = Mutex()\n",
    "        self._rm = None\n",
    "        self._device = None\n",
    "        self._model = ''\n",
    "        self._constraints = None\n",
    "        self._scan_power = -20\n",
    "        self._scan_frequencies = None\n",
    "        self._scan_sample_rate = 0.\n",
    "        self._in_cw_mode = True\n",
    "\n",
    "    def on_activate(self):\n",
    "        \"\"\" Initialisation performed during activation of the module.\n",
    "        \"\"\"\n",
    "        # trying to load the visa connection to the module\n",
    "        self._rm = pyvisa.ResourceManager()\n",
    "        self._device = self._rm.open_resource(\"COM8\",\n",
    "                                              baud_rate=9600,\n",
    "                                              read_termination='\\n',\n",
    "                                              write_termination='\\n',\n",
    "                                              timeout=int(10 * 1000))\n",
    "        self._model = self._device.query('+')\n",
    "\n",
    "        ch = 0\n",
    "\n",
    "        # Generate constraints\n",
    "        self._constraints = MicrowaveConstraints(\n",
    "            power_limits=(-50, 18),\n",
    "            frequency_limits=(54e6, 14e9),\n",
    "            scan_size_limits=(2, 100),\n",
    "            sample_rate_limits=(0.1, 1e3/4),\n",
    "            scan_modes=(SamplingOutputMode.EQUIDISTANT_SWEEP,)\n",
    "        )\n",
    "\n",
    "        self._scan_power = -20\n",
    "        self._scan_frequencies = None\n",
    "        self._scan_sample_rate = self._constraints.max_sample_rate\n",
    "        self._in_cw_mode = True\n",
    "\n",
    "    def on_deactivate(self):\n",
    "        \"\"\" Cleanup performed during deactivation of the module.\n",
    "        \"\"\"\n",
    "        self.off()\n",
    "        self._device.close()\n",
    "        self._device = None\n",
    "        self._rm.close()\n",
    "        self._rm = None\n",
    "\n",
    "    @property\n",
    "    def constraints(self):\n",
    "        return self._constraints\n",
    "\n",
    "    @property\n",
    "    def is_scanning(self):\n",
    "        \"\"\"Read-Only boolean flag indicating if a scan is running at the moment. Can be used together with\n",
    "        module_state() to determine if the currently running microwave output is a scan or CW.\n",
    "        Should return False if module_state() is 'idle'.\n",
    "\n",
    "        @return bool: Flag indicating if a scan is running (True) or not (False)\n",
    "        \"\"\"\n",
    "        with self._thread_lock:\n",
    "            return (self.module_state() != 'idle') and not self._in_cw_mode\n",
    "\n",
    "    @property\n",
    "    def cw_power(self):\n",
    "        \"\"\"The CW microwave power in dBm. Must implement setter as well.\n",
    "\n",
    "        @return float: The currently set CW microwave power in dBm.\n",
    "        \"\"\"\n",
    "        with self._thread_lock:\n",
    "            return float(self._device.query('W?'))\n",
    "\n",
    "    @property\n",
    "    def cw_frequency(self):\n",
    "        \"\"\"The CW microwave frequency in Hz. Must implement setter as well.\n",
    "\n",
    "        @return float: The currently set CW microwave frequency in Hz.\n",
    "        \"\"\"\n",
    "        with self._thread_lock:\n",
    "            return float(self._device.query('f?')) * 1e6\n",
    "\n",
    "    @property\n",
    "    def scan_power(self):\n",
    "        \"\"\"The microwave power in dBm used for scanning. Must implement setter as well.\n",
    "\n",
    "        @return float: The currently set scanning microwave power in dBm\n",
    "        \"\"\"\n",
    "        with self._thread_lock:\n",
    "            return self._scan_power\n",
    "\n",
    "    @property\n",
    "    def scan_frequencies(self):\n",
    "        \"\"\"The microwave frequencies used for scanning. Must implement setter as well.\n",
    "\n",
    "        In case of scan_mode == SamplingOutputMode.JUMP_LIST, this will be a 1D numpy array.\n",
    "        In case of scan_mode == SamplingOutputMode.EQUIDISTANT_SWEEP, this will be a tuple\n",
    "        containing 3 values (freq_begin, freq_end, number_of_samples).\n",
    "        If no frequency scan has been specified, return None.\n",
    "\n",
    "        @return float[]: The currently set scanning frequencies. None if not set.\n",
    "        \"\"\"\n",
    "        with self._thread_lock:\n",
    "            return self._scan_frequencies\n",
    "\n",
    "    @property\n",
    "    def scan_mode(self):\n",
    "        \"\"\"Scan mode Enum. Must implement setter as well.\n",
    "\n",
    "        @return SamplingOutputMode: The currently set scan mode Enum\n",
    "        \"\"\"\n",
    "        with self._thread_lock:\n",
    "            return SamplingOutputMode.EQUIDISTANT_SWEEP\n",
    "\n",
    "    @property\n",
    "    def scan_sample_rate(self):\n",
    "        \"\"\"Read-only property returning the currently configured scan sample rate in Hz.\n",
    "\n",
    "        @return float: The currently set scan sample rate in Hz\n",
    "        \"\"\"\n",
    "        with self._thread_lock:\n",
    "            return self._scan_sample_rate\n",
    "\n",
    "    def set_cw(self, frequency, power):\n",
    "        \"\"\"Configure the CW microwave output. Does not start physical signal output, see also\n",
    "        \"cw_on\".\n",
    "\n",
    "        @param float frequency: frequency to set in Hz\n",
    "        @param float power: power to set in dBm\n",
    "        \"\"\"\n",
    "        with self._thread_lock:\n",
    "            if self.module_state() != 'idle':\n",
    "                raise RuntimeError('Unable to set CW parameters. Microwave output active.')\n",
    "            self._assert_cw_parameters_args(frequency, power)\n",
    "\n",
    "            self._device.write('X0')\n",
    "            self._device.write('c1')\n",
    "            # trigger mode: software\n",
    "            self._device.write('w0')\n",
    "            self._device.write(f'W{power:2.3f}')\n",
    "            self._device.write(f'[{power:2.3f}')\n",
    "            self._device.write(f']{power:2.3f}')\n",
    "            self._device.write(f'f{frequency / 1e6:5.7f}')\n",
    "            self._device.write(f'l{frequency / 1e6:5.7f}')\n",
    "            self._device.write(f'u{frequency / 1e6:5.7f}')\n",
    "\n",
    "    def configure_scan(self, power, frequencies, mode, sample_rate):\n",
    "        \"\"\"\n",
    "        \"\"\"\n",
    "        with self._thread_lock:\n",
    "            # Sanity checks\n",
    "            if self.module_state() != 'idle':\n",
    "                raise RuntimeError('Unable to configure frequency scan. Microwave output active.')\n",
    "            self._assert_scan_configuration_args(power, frequencies, mode, sample_rate)\n",
    "\n",
    "            # configure scan according to scan mode\n",
    "            self._scan_power = power\n",
    "            self._scan_frequencies = tuple(frequencies)\n",
    "            self._write_sweep()\n",
    "\n",
    "            self._device.write(f't{1000 * 0.75 / sample_rate:f}')\n",
    "            self._scan_sample_rate = float(self._device.query('t?')) / 1000\n",
    "\n",
    "\n",
    "    def off(self):\n",
    "        \"\"\"Switches off any microwave output (both scan and CW).\n",
    "        Must return AFTER the device has actually stopped.\n",
    "        \"\"\"\n",
    "        with self._thread_lock:\n",
    "            if self.module_state() != 'idle':\n",
    "                # disable sweep mode\n",
    "                self._device.write('g0')\n",
    "                # set trigger source to software\n",
    "                self._device.write('w0')\n",
    "                # turn off everything for the current channel\n",
    "\n",
    "                self.module_state.unlock()\n",
    "\n",
    "    def cw_on(self):\n",
    "        \"\"\" Switches on cw microwave output.\n",
    "\n",
    "        Must return AFTER the output is actually active.\n",
    "        \"\"\"\n",
    "        with self._thread_lock:\n",
    "            if self.module_state() != 'idle':\n",
    "                if self._in_cw_mode:\n",
    "                    return\n",
    "                raise RuntimeError(\n",
    "                    'Unable to start CW microwave output. Microwave output is currently active.'\n",
    "                )\n",
    "\n",
    "            self._in_cw_mode = True\n",
    "            # enable sweep mode and set to start frequency\n",
    "            self._device.write('g1')\n",
    "            self.module_state.lock()\n",
    "\n",
    "    def start_scan(self):\n",
    "        \"\"\"Switches on the microwave scanning.\n",
    "\n",
    "        Must return AFTER the output is actually active (and can receive triggers for example).\n",
    "        \"\"\"\n",
    "        with self._thread_lock:\n",
    "            if self.module_state() != 'idle':\n",
    "                if not self._in_cw_mode:\n",
    "                    return\n",
    "                raise RuntimeError('Unable to start frequency scan. CW microwave output is active.')\n",
    "            assert self._scan_frequencies is not None, \\\n",
    "                'No scan_frequencies set. Unable to start scan.'\n",
    "\n",
    "            self._in_cw_mode = False\n",
    "            # enable sweep mode and set to start frequency\n",
    "            self._device.write('g1')\n",
    "            self.module_state.lock()\n",
    "\n",
    "    def reset_scan(self):\n",
    "        \"\"\"Reset currently running scan and return to start frequency.\n",
    "        Does not need to stop and restart the microwave output if the device allows soft scan reset.\n",
    "        \"\"\"\n",
    "        with self._thread_lock:\n",
    "            if self.module_state() == 'idle':\n",
    "                return\n",
    "            if self._in_cw_mode:\n",
    "                raise RuntimeError('Can not reset frequency scan. CW microwave output active.')\n",
    "\n",
    "            # enable sweep mode and set to start frequency\n",
    "            self._device.write('g1')\n",
    "\n",
    "    def _write_sweep(self):\n",
    "        start, stop, points = self._scan_frequencies\n",
    "        step = (stop - start) / (points - 1)\n",
    "\n",
    "        # sweep mode: linear sweep, non-continuous\n",
    "        self._device.write('X0')\n",
    "        self._device.write('c0')\n",
    "\n",
    "        # trigger mode: single step\n",
    "        self._device.write('w2')\n",
    "\n",
    "        # sweep direction\n",
    "        if stop >= start:\n",
    "            self._device.write('^1')\n",
    "        else:\n",
    "            self._device.write('^0')\n",
    "\n",
    "        # sweep lower and upper frequency and steps\n",
    "        self._device.write(f'l{start / 1e6:5.7f}')\n",
    "        self._device.write(f'u{stop / 1e6:5.7f}')\n",
    "        self._device.write(f's{step / 1e6:5.7f}')\n",
    "\n",
    "        # set power\n",
    "        self._device.write(f'W{self._scan_power:2.3f}')\n",
    "        # set sweep lower end power\n",
    "        self._device.write(f'[{self._scan_power:2.3f}')\n",
    "        # set sweep upper end power\n",
    "        self._device.write(f']{self._scan_power:2.3f}')\n",
    "\n",
    "    def _off(self):\n",
    "        \"\"\" Turn the current channel off.\n",
    "\n",
    "        @return tuple: see _stat()\n",
    "        \"\"\"\n",
    "        self._device.write('E0r0h0')\n",
    "        return self._stat()\n",
    "\n",
    "    def _on(self):\n",
    "        \"\"\" Turn on the current channel.\n",
    "\n",
    "        @return tuple(bool): see _stat()\n",
    "        \"\"\"\n",
    "        self._device.write('E1r1h1')\n",
    "        return self._stat()\n",
    "\n",
    "    def _stat(self):\n",
    "        \"\"\" Return status of PLL, power amplifier and output power muting for current channel.\n",
    "\n",
    "        @return tuple(bool): PLL on, power amplifier on, output power muting on\n",
    "        \"\"\"\n",
    "        # PLL status\n",
    "        E = int(self._device.query('E?'))\n",
    "        # power amplifier status\n",
    "        r = int(self._device.query('r?'))\n",
    "        # hig/low power selector\n",
    "        h = int(self._device.query('h?'))\n",
    "        return E, r, h\n",
    "\n",
    "    def _is_running(self):\n",
    "        status = self._stat()\n",
    "        return (status[0] == 1) and (status[1] == 1) and (status[2] == 1)\n"
   ],
   "metadata": {
    "collapsed": false,
    "ExecuteTime": {
     "end_time": "2023-09-01T15:10:35.346342600Z",
     "start_time": "2023-09-01T15:10:35.336316200Z"
    }
   }
  },
  {
   "cell_type": "code",
   "execution_count": 13,
   "outputs": [],
   "source": [
    "mw = MicrowaveSynthNVPro()"
   ],
   "metadata": {
    "collapsed": false,
    "ExecuteTime": {
     "end_time": "2023-09-01T15:10:35.747115700Z",
     "start_time": "2023-09-01T15:10:35.738261400Z"
    }
   }
  },
  {
   "cell_type": "code",
   "execution_count": 14,
   "outputs": [],
   "source": [
    "mw.on_activate()"
   ],
   "metadata": {
    "collapsed": false,
    "ExecuteTime": {
     "end_time": "2023-09-01T15:10:41.431152200Z",
     "start_time": "2023-09-01T15:10:41.413114500Z"
    }
   }
  },
  {
   "cell_type": "code",
   "execution_count": 33,
   "outputs": [],
   "source": [
    "for i in range(5):\n",
    "    mw._device.query(\"f?\")"
   ],
   "metadata": {
    "collapsed": false,
    "ExecuteTime": {
     "end_time": "2023-09-01T15:12:22.298377500Z",
     "start_time": "2023-09-01T15:12:22.252018200Z"
    }
   }
  },
  {
   "cell_type": "code",
   "execution_count": 49,
   "outputs": [
    {
     "data": {
      "text/plain": "'1.000'"
     },
     "execution_count": 49,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "mw._device.query(\"t?\")"
   ],
   "metadata": {
    "collapsed": false,
    "ExecuteTime": {
     "end_time": "2023-09-01T15:14:09.566730800Z",
     "start_time": "2023-09-01T15:14:09.549361300Z"
    }
   }
  },
  {
   "cell_type": "code",
   "execution_count": 50,
   "outputs": [
    {
     "ename": "AttributeError",
     "evalue": "'MicrowaveSynthNVPro' object has no attribute 'module_state'",
     "output_type": "error",
     "traceback": [
      "\u001B[1;31m---------------------------------------------------------------------------\u001B[0m",
      "\u001B[1;31mAttributeError\u001B[0m                            Traceback (most recent call last)",
      "Cell \u001B[1;32mIn[50], line 1\u001B[0m\n\u001B[1;32m----> 1\u001B[0m \u001B[43mmw\u001B[49m\u001B[38;5;241;43m.\u001B[39;49m\u001B[43mon_deactivate\u001B[49m\u001B[43m(\u001B[49m\u001B[43m)\u001B[49m\n",
      "Cell \u001B[1;32mIn[12], line 61\u001B[0m, in \u001B[0;36mMicrowaveSynthNVPro.on_deactivate\u001B[1;34m(self)\u001B[0m\n\u001B[0;32m     58\u001B[0m \u001B[38;5;28;01mdef\u001B[39;00m \u001B[38;5;21mon_deactivate\u001B[39m(\u001B[38;5;28mself\u001B[39m):\n\u001B[0;32m     59\u001B[0m \u001B[38;5;250m    \u001B[39m\u001B[38;5;124;03m\"\"\" Cleanup performed during deactivation of the module.\u001B[39;00m\n\u001B[0;32m     60\u001B[0m \u001B[38;5;124;03m    \"\"\"\u001B[39;00m\n\u001B[1;32m---> 61\u001B[0m     \u001B[38;5;28;43mself\u001B[39;49m\u001B[38;5;241;43m.\u001B[39;49m\u001B[43moff\u001B[49m\u001B[43m(\u001B[49m\u001B[43m)\u001B[49m\n\u001B[0;32m     62\u001B[0m     \u001B[38;5;28mself\u001B[39m\u001B[38;5;241m.\u001B[39m_device\u001B[38;5;241m.\u001B[39mclose()\n\u001B[0;32m     63\u001B[0m     \u001B[38;5;28mself\u001B[39m\u001B[38;5;241m.\u001B[39m_device \u001B[38;5;241m=\u001B[39m \u001B[38;5;28;01mNone\u001B[39;00m\n",
      "Cell \u001B[1;32mIn[12], line 187\u001B[0m, in \u001B[0;36mMicrowaveSynthNVPro.off\u001B[1;34m(self)\u001B[0m\n\u001B[0;32m    183\u001B[0m \u001B[38;5;250m\u001B[39m\u001B[38;5;124;03m\"\"\"Switches off any microwave output (both scan and CW).\u001B[39;00m\n\u001B[0;32m    184\u001B[0m \u001B[38;5;124;03mMust return AFTER the device has actually stopped.\u001B[39;00m\n\u001B[0;32m    185\u001B[0m \u001B[38;5;124;03m\"\"\"\u001B[39;00m\n\u001B[0;32m    186\u001B[0m \u001B[38;5;28;01mwith\u001B[39;00m \u001B[38;5;28mself\u001B[39m\u001B[38;5;241m.\u001B[39m_thread_lock:\n\u001B[1;32m--> 187\u001B[0m     \u001B[38;5;28;01mif\u001B[39;00m \u001B[38;5;28;43mself\u001B[39;49m\u001B[38;5;241;43m.\u001B[39;49m\u001B[43mmodule_state\u001B[49m() \u001B[38;5;241m!=\u001B[39m \u001B[38;5;124m'\u001B[39m\u001B[38;5;124midle\u001B[39m\u001B[38;5;124m'\u001B[39m:\n\u001B[0;32m    188\u001B[0m         \u001B[38;5;66;03m# disable sweep mode\u001B[39;00m\n\u001B[0;32m    189\u001B[0m         \u001B[38;5;28mself\u001B[39m\u001B[38;5;241m.\u001B[39m_device\u001B[38;5;241m.\u001B[39mwrite(\u001B[38;5;124m'\u001B[39m\u001B[38;5;124mg0\u001B[39m\u001B[38;5;124m'\u001B[39m)\n\u001B[0;32m    190\u001B[0m         \u001B[38;5;66;03m# set trigger source to software\u001B[39;00m\n",
      "\u001B[1;31mAttributeError\u001B[0m: 'MicrowaveSynthNVPro' object has no attribute 'module_state'"
     ]
    }
   ],
   "source": [
    "mw.on_deactivate()"
   ],
   "metadata": {
    "collapsed": false,
    "ExecuteTime": {
     "end_time": "2023-09-01T15:16:28.392829200Z",
     "start_time": "2023-09-01T15:16:28.358411800Z"
    }
   }
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "outputs": [],
   "source": [],
   "metadata": {
    "collapsed": false
   }
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 2
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython2",
   "version": "2.7.6"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 0
}