qn_datawords.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "The datastream from the QuarkNet DAQ board output into an ASCII format where each line contains 16 words. \n",
    "\n",
    "For example:\n",
    "```\n",
    "687C4047 80 00 2B 00 00 00 00 00 67037CB8 000322.027 180516 A 03 0 +0053\n",
    "687C4047 00 00 00 00 3A 00 00 00 67037CB8 000322.027 180516 A 03 0 +0053\n",
    "687C4048 00 00 00 28 00 00 00 00 67037CB8 000322.027 180516 A 03 0 +0053\n",
    "687C4048 00 00 00 00 00 36 00 00 67037CB8 000322.027 180516 A 03 0 +0053\n",
    "```\n",
    "\n",
    "First let's define some classes for TMC counts, DAQ status, and DAQ lines:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 125,
   "metadata": {
    "collapsed": false
   },
   "outputs": [],
   "source": [
    "import string\n",
    "\n",
    "class TMCCount:\n",
    "    def __init__(self, word):\n",
    "        self.word = word\n",
    "        self.bin_word = format(int(word,16), '08b')\n",
    "        \n",
    "        # bits 0-4: TMC count of RE or FE\n",
    "        # bit 5: channel edge tag (1: valid edge, 0: no edge)\n",
    "        # bit 6: not used, always 0\n",
    "        # bit 7: [rising edge] trigger tag (1: new trigger; start of new event, 0: follow-up data of new event)\n",
    "        # bit 7: [falling edge] not used, always 0\n",
    "        \n",
    "        self.edge_count = self.bin_word[3:]\n",
    "        \n",
    "        if ( self.bin_word[2] == '1' ):\n",
    "            self.edge_valid = True\n",
    "        else:\n",
    "            self.edge_valid = False\n",
    "\n",
    "        self.bit_7 = self.bin_word[0]\n",
    "        \n",
    "    def dump(self):\n",
    "        output = ' TMCCount:'\n",
    "        output += '  edge_count=' + str(self.edge_count)\n",
    "        output += '  edge_valid=' + str(self.edge_valid)\n",
    "        output += '  bit_7=' + str(self.bit_7)\n",
    "        print(output)\n",
    "\n",
    "        \n",
    "class DAQStatus:\n",
    "    def __init__(self, word):\n",
    "        self.word = word\n",
    "        self.bin_word = format(int(word,16), '04b')\n",
    "        \n",
    "        # bit 0: 0: OK, 1: 1PPS interrupt pending\n",
    "        # bit 1: 0: OK, 1: trigger interrupt pending\n",
    "        # bit 2: 0: OK, 1: GPS data possibly corrupted while DAQ was busy\n",
    "        # bit 3: 0: OK, 1: current or last 1PPS rate is not within 25 CPLD clock ticks\n",
    "        self.bit_0 = self.bin_word[3]\n",
    "        self.bit_1 = self.bin_word[2]\n",
    "        self.bit_2 = self.bin_word[1]\n",
    "        self.bit_3 = self.bin_word[0]\n",
    "        \n",
    "        if ( (int(self.bit_0) + int(self.bit_1) + int(self.bit_2) + int(self.bit_3)) > 0 ):\n",
    "            self.is_ok = False\n",
    "        else:\n",
    "            self.is_ok = True\n",
    "    \n",
    "    \n",
    "class DAQLine:\n",
    "    def __init__(self, words):\n",
    "        self.words = words\n",
    "    \n",
    "        # count of rising edge at input 0\n",
    "        self.re_0 = TMCCount(words[1])\n",
    "        # count of falling edge at input 0\n",
    "        self.fe_0 = TMCCount(words[2])\n",
    "                        \n",
    "        # count of rising edge at input 1\n",
    "        self.re_1 = TMCCount(words[3])\n",
    "        # count of falling edge at input 1\n",
    "        self.fe_1 = TMCCount(words[4])\n",
    "        \n",
    "        # count of rising edge at input 2\n",
    "        self.re_2 = TMCCount(words[5])\n",
    "        # count of falling edge at input 2\n",
    "        self.fe_2 = TMCCount(words[6])\n",
    "        \n",
    "        # count of rising edge at input 3\n",
    "        self.re_3 = TMCCount(words[7])\n",
    "        # count of falling edge at input 3\n",
    "        self.fe_3 = TMCCount(words[8])\n",
    "    \n",
    "        # 32-bit trigger count of the 25 MHz \n",
    "        # CPLD clock\n",
    "        self.clock_count = words[0]\n",
    "    \n",
    "        # 32-bit CPLD count of the most recent 1 PPS\n",
    "        # time mark from the GPS\n",
    "        self.pps = words[9]\n",
    "    \n",
    "        # UTC time of most recent GPS receiver\n",
    "        # data update\n",
    "        # HHMMSS.mmm\n",
    "        self.utc_time = words[10]\n",
    "        \n",
    "        # UTC data of most recent GPS receiver\n",
    "        # data update\n",
    "        # DDMMYY\n",
    "        self.utc_date = words[11]\n",
    "        \n",
    "        # GPS valid/invalid flag\n",
    "        if words[12] == 'A':\n",
    "            self.gps_valid = True\n",
    "        elif words[12] == 'V':\n",
    "            self.gps_valid = False\n",
    "        \n",
    "        # Number of GPS satellites\n",
    "        self.n_gps = int(words[13])\n",
    "        \n",
    "        # DAQ status flag\n",
    "        self.daq_status = DAQStatus(words[14])\n",
    "        \n",
    "        # Time delay in milliseconds between\n",
    "        # the 1 PPS pulse and the GPS data interrupt\n",
    "        self.time_delay = words[15]\n",
    "\n",
    "    def dump(self):\n",
    "        output = 'DAQLine:'\n",
    "        output += ' clock_count=' + str(self.clock_count)\n",
    "        output += ' pps=' + str(self.pps)\n",
    "        output += ' utc_time=' + str(self.utc_time)\n",
    "        output += ' utc_date=' + str(self.utc_date)\n",
    "        output += ' gps_valid=' + str(self.gps_valid)\n",
    "        output += ' time_delay=' + str(self.time_delay)\n",
    "        print(output)\n",
    "        \n",
    "        print(' rising edge 0:')\n",
    "        self.re_0.dump()\n",
    "        print(' faling edge 0:')\n",
    "        self.fe_0.dump()\n",
    "        "
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Then open a file and output some information from the first 4 lines:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 126,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "DAQLine: clock_count=687C4047 pps=67037CB8 utc_time=000322.027 utc_date=180516 gps_valid=True time_delay=+0053\n",
      " rising edge 0:\n",
      " TMCCount:  edge_count=00000  edge_valid=False  bit_7=1\n",
      " faling edge 0:\n",
      " TMCCount:  edge_count=00000  edge_valid=False  bit_7=0\n",
      "DAQLine: clock_count=687C4047 pps=67037CB8 utc_time=000322.027 utc_date=180516 gps_valid=True time_delay=+0053\n",
      " rising edge 0:\n",
      " TMCCount:  edge_count=00000  edge_valid=False  bit_7=0\n",
      " faling edge 0:\n",
      " TMCCount:  edge_count=00000  edge_valid=False  bit_7=0\n",
      "DAQLine: clock_count=687C4048 pps=67037CB8 utc_time=000322.027 utc_date=180516 gps_valid=True time_delay=+0053\n",
      " rising edge 0:\n",
      " TMCCount:  edge_count=00000  edge_valid=False  bit_7=0\n",
      " faling edge 0:\n",
      " TMCCount:  edge_count=00000  edge_valid=False  bit_7=0\n",
      "DAQLine: clock_count=687C4048 pps=67037CB8 utc_time=000322.027 utc_date=180516 gps_valid=True time_delay=+0053\n",
      " rising edge 0:\n",
      " TMCCount:  edge_count=00000  edge_valid=False  bit_7=0\n",
      " faling edge 0:\n",
      " TMCCount:  edge_count=00000  edge_valid=False  bit_7=0\n"
     ]
    }
   ],
   "source": [
    "ifile = open('data/qn/6148.2016.0518.0', 'r')       \n",
    "\n",
    "for line in ifile.readlines()[0:4]:\n",
    "    \n",
    "    daq_line = DAQLine(string.split(line))\n",
    "    \n",
    "    if daq_line.daq_status.is_ok:\n",
    "        daq_line.dump()\n",
    "\n",
    "ifile.close()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Information taken from \"QuarkNet Cosmic Ray Muon Detector User's Manual Series 6000 DAQ\", January 2010 Version 1.1"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 2",
   "language": "python",
   "name": "python2"
  },
  "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.11"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 0
}