research/TCS/interface.py

   1 #!/usr/bin/python
   2
   3 # @file "interface.py"
   4 # @author Sam Moore
   5 # @purpose AVR Butterfly Datalogger control for Total Current Spectroscopy Measurements
   6 #       The AVR responds to a limited number of RS232 commands to read ADC channels and set the DAC
   7 #       This script can be used to control the DAC and monitor initial energy & sample current over RS232
   8
   9 import sys
  10 import os
  11 import time
  12 import serial
  13 import datetime
  14
  15
  16
  17 # TODO: Insert variables for calibration purposes here.
  18 calibrate = {
  19         "ADC_Counts" : [2**10,2**10,2**10,2**10,2**10,2**10,2**10], # Maxed counts on ADC channels (10 bits = 2**10 = 1024)
  20         "DAC_Counts" : 2**12, # Maxed counts on DAC channel (12 bits = 2**12 = 4096)
  21
  22         # Calibration data for DAC and ADC
  23         "DAC" : None,
  24         "ADC" : [None, None, None, None, None, None, None, None],
  25
  26         # Data used for rough calibration if above data is not present
  27         "Vref" : 3.3, # The output of the voltage regulator (Vref = Vcc) relative to signal ground
  28         "ADC_Rin" : [None, None, None, None, 15000, 1100, 1100, 1100],
  29         "ADC_Rvar" : [None, None, None, None, 1000, 5000, 10000, 50000],
  30         "DAC_Gain" : 1
  31 }
  32
  33 # TODO: Adjust aqcuisition parameters here
  34 aquire = { "DAC_Sweep" : "1500",#"0.0 + 50.0*step", # DAC Sweep value (t is in STEPS, not seconds!)
  35         "ADC_Averages" : 200,
  36         "ADC_Vi" : 5, # ADC channel to read back Vi (set by DAC) through
  37         "ADC_Is" : 4, # ADC channel to read back Is through
  38         "ADC_Ie" : 4, # ADC channel to read back Ie through
  39         "DAC_Settle" : 2.0, # Time in seconds to wait for DAC to stabilise
  40         #"response_wait" : 0.2, # Time to wait in seconds between sending data and reading back
  41         "start_date" : None
  42 }
  43
  44 #Setup the serial connection parameters
  45 ser = serial.Serial(
  46         port="/dev/ttyUSB0", # Modify as needed (note: in linux need to run `sudo chmod a+rw /dev/ttyUSBX' to set permissions)
  47
  48         # Do not change the values below here (unless AVR butterfly is reprogrammed to use different values)
  49         baudrate=4800,
  50         parity="N",
  51         stopbits=1,
  52         bytesize=8,
  53         timeout=None,
  54         xonxoff=0,
  55         rtscts=0
  56 )
  57
  58 parameters = {
  59         "Accelerating Voltage" : None,
  60         "Focus Voltage" : None,
  61         "Deflection Voltage" : None,
  62         "Venault Voltage" : None,
  63         "Initial Voltage" : None,
  64         "Heating Current" : None,
  65         "Heating Voltage" : None,
  66         "Chamber Pressure" : None,
  67         "602 0.1 Battery" : None,
  68         "602 0.03 Battery" : None,
  69         "602 0.01 Battery" : None,
  70         "602 0.003 Battery" : None,
  71         "602 0.001 Battery" : None
  72 }
  73
  74 def getTime():
  75         return str(datetime.datetime.now()).split(" ")[1].split(".")[0].replace(":","")
  76
  77 def getDate():
  78         return str(datetime.datetime.now()).split(" ")[0]
  79
  80 def init():
  81
  82
  83         aquire["start_date"] = getDate()
  84
  85
  86
  87         # Connect serial
  88         ser.open()
  89         ser.isOpen()
  90         print("Waiting for \"# hello\" from device...")
  91         while (ser.readline().strip("\r\n") != "# hello"):
  92                 pass
  93         #while (ser.readline().strip("\r\n ") != "#"):
  94         #       pass
  95         time.sleep(1.0)
  96
  97         ser.write("a "+str(aquire["ADC_Averages"]) + "\r\n")
  98         print(ser.readline().strip("\r\n"))
  99         print(ser.readline().strip("\r\n"))
 100         print(ser.readline().strip("\r\n"))
 101
 102         print("Writing config information to config.dat...")
 103         output = open("config.dat", "w", 1)
 104
 105         output.write("# Initialise " + str(datetime.datetime.now()) + "\n")
 106
 107         for field in calibrate:
 108                 output.write("# calibrate["+str(field)+"] = "+str(calibrate[field]) + "\n")
 109         output.write("\n")
 110         for field in aquire:
 111                 output.write("# aquire["+str(field)+"] = "+str(aquire[field]) + "\n")
 112
 113         output.write("# Ready " + str(datetime.datetime.now()) + "\n# EOF\n")
 114         output.close()
 115
 116 def main():
 117
 118         init()
 119
 120         if (loadCalibration_DAC() == False):
 121                 if (calibrateDAC() == False):
 122                         return -1
 123         if (loadCalibration_ADC(aquire["ADC_Is"]) == False):
 124                 if (calibrateADC_usingDAC(aquire["ADC_Is"], False) == False):
 125                         if (calibrateADC(aquire["ADC_Is"]) == False):
 126                                 return -1
 127
 128         if (loadCalibration_ADC(aquire["ADC_Vi"]) == False):
 129                 if (calibrateADC_usingDAC(aquire["ADC_Vi"], True) == False):
 130                         if (calibrateADC(aquire["ADC_Vi"]) == False):
 131                                 return -1
 132
 133
 134         # Make directory for today, backup calibration files
 135         os.system("mkdir -p " + getDate())
 136         os.system("cp *.dat " + getDate() +"/")
 137
 138         #checkList()
 139
 140
 141
 142
 143         # Experiment
 144         # TODO: Modify data to record here
 145         #sweep = 1
 146         record_data([4, 5], getDate()+"/"+str(getTime())+".dat", None, None, "Measure emission&sample current varying with time, constant initial energy.")
 147         #while True:
 148         #       os.system("mkdir -p " + getDate())
 149         #       record_data([4, 5], getDate()+"/"+str(getTime())+".dat", None, 2300, "Sweep " + str(sweep) + " (started on " + aquire["start_date"]+")")
 150         #       sweep += 1
 151
 152
 153 def checkList():
 154
 155         output = open(getDate()+"/checklist", "w", 0)
 156         for item in parameters:
 157                 sys.stdout.write("Enter value for \""+str(item)+"\": ")
 158                 parameters[item] = sys.stdin.readline().strip("\r\n ")
 159                 sys.stdout.write("\n")
 160                 output.write(str(parameters[item]) + "\n")
 161
 162
 163 def record_data(ADC_channels, output, pollTime = None, dac_max = None, comment = None):
 164         if (output != None):
 165                 output = [open(output, "w", 0), sys.stdout]
 166                 if (comment == None):
 167                         print("Enter a comment for the experiment.")
 168                         comment = sys.stdin.readline().strip("\r\n ")
 169                 output[0].write("# Comment: "+str(comment)+"\n")
 170         else:
 171                 output = [sys.stdout]
 172
 173         start_time = time.time()
 174
 175         for out in output:
 176                 out.write("# Experiment " + str(datetime.datetime.now()) + "\n")
 177                 out.write("# Polling for " + str(pollTime) + "s.\n")
 178                 out.write("# DAC = " + str(aquire["DAC_Sweep"]) + "\n")
 179                 out.write("# Data:\n")
 180                 out.write("# time\tDAC")
 181                 for channel in ADC_channels:
 182                         out.write("\tADC"+str(channel))
 183                 out.write("\n")
 184
 185         step = 0
 186         dacValue = int(eval(aquire["DAC_Sweep"]))
 187         if (setDAC(dacValue) == False):
 188                 setDAC(dacValue)
 189         while (pollTime == None or time.time() < start_time + pollTime):
 190                 if (aquire["DAC_Sweep"] != None):
 191                         nextDacValue = int(eval(aquire["DAC_Sweep"]))
 192                         if (nextDacValue != dacValue):
 193                                 dacValue = nextDacValue
 194                                 setDAC(dacValue)
 195                         step += 1
 196                 if (dac_max != None and dacValue == dac_max):
 197                         break
 198
 199                 measure_start = time.time()
 200
 201                 raw_adc = []
 202
 203                 for channel in ADC_channels:
 204                         read = readADC(channel)
 205                         if read == False:
 206                                 print("Abort data collection")
 207                                 return False
 208                         raw_adc.append((channel, read[0], read[1]))
 209
 210                 end_time = time.time()
 211
 212                 for out in output:
 213                         out.write(str((measure_start + (end_time - measure_start)/2.0 - start_time)))
 214                         out.write("\t"+str(dacValue))
 215                         for adc in raw_adc:
 216                                 out.write("\t" + str(adc[1]) + "\t" + str(adc[2]))
 217                         out.write("\n")
 218
 219         for out in output:
 220                 if out != sys.stdout:
 221                         out.close()
 222         return True
 223
 224 def loadCalibration_ADC(channel):
 225         try:
 226                 input_file = open("calibrateADC"+str(channel)+".dat")
 227         except:
 228                 print("Couldn't find calibration file for ADC " + str(channel))
 229                 return False
 230
 231         calibrate["ADC"][channel] = []
 232         for l in input_file:
 233                 l = l.split("#")[0].strip("\r\n ")
 234                 if (l == ""):
 235                         continue
 236                 else:
 237                         split_line = l.split("\t")
 238                         calibrate["ADC"][channel].append((float(split_line[0]), float(split_line[1])))
 239         input_file.close()
 240
 241         if (len(calibrate["ADC"][channel]) <= 0):
 242                 print("Empty calibration file for ADC " + str(channel))
 243                 return False
 244         return True
 245
 246 def loadCalibration_DAC():
 247         try:
 248                 input_file = open("calibrateDAC.dat")
 249         except:
 250                 print("Couldn't find calibration file for DAC")
 251                 return False
 252
 253         calibrate["DAC"] = []
 254         for l in input_file:
 255                 #print("Line is: "+str(l))
 256                 l = l.split("#")[0].strip("\r\n ")
 257                 if (l == ""):
 258                         continue
 259                 else:
 260                         split_line = l.split("\t")
 261                         if (len(split_line) >= 3):
 262                                 calibrate["DAC"].append((int(split_line[0]), float(split_line[1]), float(split_line[2])))
 263                         else:
 264                                 calibrate["DAC"].append((int(split_line[0]), float(split_line[1])))
 265
 266
 267         input_file.close()
 268
 269         if (len(calibrate["DAC"]) <= 0):
 270                 print("Empty calibration file for DAC")
 271                 return False
 272         return True
 273
 274 def getADC_Voltage(channel, counts):
 275         if (calibrate["ADC"][channel] == None or len(calibrate["ADC"][channel]) <= 0):
 276                 if (calibrate["ADC_Rin"][channel] != None and calibrate["ADC_Rvar"][channel] != None):
 277                         print("Warning: Using rough calibration for ADC"+str(channel) + " = " + str(counts))
 278                         ratio = float(calibrate["ADC_Rin"][channel]) / (float(calibrate["ADC_Rin"][channel]) + float(calibrate["ADC_Rvar"][channel]))
 279                         return ratio * (float(counts) / float(calibrate["ADC_Counts"][channel]) * Vref)
 280                 else:
 281                         print("Error: No calibration for ADC"+str(channel))
 282                         return False
 283
 284         c = calibrate["ADC"][channel]
 285         valueIndex = 1
 286         for i in range(0, len(c)-1):
 287                 if (c[i][0] <= counts and i + 1 < len(c)):
 288                         grad = (float(c[i+1][valueIndex]) - float(c[i][valueIndex])) / (float(c[i+1][0]) - float(c[i][0]))
 289                         value = float(c[i][valueIndex]) + grad * (float(counts) - float(c[i][0]))
 290                         return value
 291
 292
 293         print("Warning: Extrapolating outside calibration range for DAC = " + str(counts))
 294
 295         grad = (float(c[len(c)-1][valueIndex]) - float(c[len(c)-2][valueIndex])) / (float(c[len(c)-1][0]) -  float(c[len(c)-2][0]))
 296         value = float(c[len(c)-1][valueIndex]) + grad * (float(counts) - float(c[len(c)-1][0]))
 297
 298 def readADC(channel):
 299         #for i in range(0, aquire["ADC_Averages"]):
 300         #       ser.write("r "+str(channel)+"\r") # Send command to datalogger
 301                 #time.sleep(aquire["response_wait"])
 302         #       response = ser.readline().strip("#\r\n ")
 303         #       if (response != "r "+str(channel)):
 304         #               print("Received wierd response reading ADC ("+response+")")
 305         #               return False
 306                 #time.sleep(aquire["response_wait"])
 307         #       values.append(int(ser.readline().strip("\r\n ")))
 308         #       adc_sum += float(values[len(values)-1])
 309         ser.write("r "+str(channel)+"\r")
 310         response = ser.readline().strip("#\r\n")
 311         if (response != "r "+str(channel)):
 312                 print("Received wierd response reading ADC ("+response+")")
 313                 return False
 314         return ser.readline().strip("\r\n").split(" ")
 315
 316 def getDAC_Voltage(counts, gain = True):
 317         if (calibrate["DAC"] == None or len(calibrate["DAC"]) <= 0):
 318                 if (calibrate["DAC_Gain"] != None):
 319                         print("Warning: Using rough calibration for DAC = " + str(counts))
 320                         return float(counts) / float(calibrate["DAC_Counts"]) * float(calibrate["Vref"]) * float(calibrate["DAC_Gain"])
 321                 else:
 322                         print("Error: No calibrate for DAC")
 323                         return False
 324
 325         valueIndex = 1
 326         if (gain == False):
 327                 valueIndex = 2
 328                 if (len(calibrate["DAC"][0]) < 3):
 329                         print("Error: No data for unamplified DAC")
 330                         return False
 331
 332         c = calibrate["DAC"]
 333         if (len(c) == 1):
 334                 print("Warning: Only one point in calibration data!")
 335                 return float(c[0][valueIndex])
 336
 337         for i in range(0, len(c)-1):
 338                 if (c[i][0] <= counts and i + 1 < len(c)):
 339                         grad = (float(c[i+1][valueIndex]) - float(c[i][valueIndex])) / (float(c[i+1][0]) - float(c[i][0]))
 340                         value = float(c[i][valueIndex]) + grad * (float(counts) - float(c[i][0]))
 341                         return value
 342
 343
 344         print("Warning: Extrapolating outside calibration range for DAC = " + str(counts))
 345
 346         grad = (float(c[len(c)-1][valueIndex]) - float(c[len(c)-2][valueIndex])) / (float(c[len(c)-1][0]) -  float(c[len(c)-2][0]))
 347         value = float(c[len(c)-1][valueIndex]) + grad * (float(counts) - float(c[len(c)-1][0]))
 348         return value
 349
 350
 351 def setDAC(level):
 352
 353         ser.write("d "+str(level)+"\r")
 354
 355         response = ser.readline().strip("#\r\n ")
 356         if (response != "d "+str(level)):
 357                 print("Recieved wierd response setting DAC to "+str(level) + " ("+response+")")
 358                 return False
 359         #time.sleep(aquire["response_wait"])
 360         #time.sleep(aquire["DAC_Settle"])
 361         #time.sleep(aquire["DAC_Settle"])
 362         response = ser.readline().strip("#\r\n ")
 363         if (response != "DAC "+str(level)):
 364                 print("Recieved wierd response setting DAC to "+str(level) + " ("+response+")")
 365                 return False
 366         #time.sleep(aquire["response_wait"])
 367         time.sleep(aquire["DAC_Settle"])
 368
 369
 370 def calibrateADC_usingDAC(channel, gain = True):
 371         if (calibrate["DAC"] == None):
 372                 print("ERROR: DAC is not calibrated, can't use to calibrate ADC!")
 373                 return False
 374
 375         calibrate["ADC"][channel] = []
 376         outfile = open("calibrateADC"+str(channel)+".dat", "w", 1)
 377         outfile.write("# Calibrate ADC " + str(channel) + "\n")
 378         outfile.write("# Start " + str(datetime.datetime.now()) + "\n")
 379
 380         print("Connect DAC output to ADC " + str(channel) + " and press enter\n")
 381         sys.stdin.readline()
 382
 383         for dac in calibrate["DAC"]:
 384                 if (setDAC(dac[0]) == False):
 385                         return False
 386
 387                 value = readADC(channel)
 388                 if (value == False):
 389                         return False
 390                 canadd = (len(calibrate["ADC"][channel]) <= 0)
 391                 if (canadd == False):
 392                         canadd = True
 393                         for adc in calibrate["ADC"][channel]:
 394                                 if adc[0] == value[0]:
 395                                         canadd = False
 396                                         break
 397
 398                 if (canadd):
 399
 400                         if gain:
 401                                 input_value = dac[1]
 402                         else:
 403                                 input_value = dac[2]
 404
 405                         #input_value = getDAC_Voltage(dac[0], gain)
 406                         if (input_value == False):
 407                                 return False
 408
 409                         outfile.write(str(value[0]) + "\t" + str(input_value) + "\t" + str(value[1]) + "\n")
 410                         print(str(value[0]) + "\t" + str(input_value) + "\t" + str(value[1]))
 411
 412                         calibrate["ADC"][channel].append((value[0], input_value, value[1]))
 413
 414         outfile.write("# Stop " + str(datetime.datetime.now()) + "\n# EOF\n")
 415         outfile.close()
 416         if (setDAC(0) == False):
 417                 return False
 418         if (len(calibrate["ADC"][channel]) <= 0):
 419                 print("Error: No calibration points taken for ADC " + str(channel))
 420                 return False
 421         return True
 422
 423 def calibrateADC(channel):
 424         calibrate["ADC"][channel] = []
 425         outfile = open("calibrateADC"+str(channel)+".dat", "w", 1)
 426         outfile.write("# Calibrate ADC " + str(channel) + "\n")
 427         outfile.write("# Start " + str(datetime.datetime.now()) + "\n")
 428
 429         print("Calibrating ADC...\n")
 430         print("Enter measured voltage, empty line stops.\n")
 431
 432         while True:
 433                 read = sys.stdin.readline().strip("\r\n ")
 434                 if (read == ""):
 435                         break
 436                 input_value = float(read)
 437                 output_value = readADC(channel)
 438                 if (output_value == False):
 439                         return False
 440
 441                 calibrate["ADC"][channel].append((output_value[0], input_value))
 442                 print(str(output_value[0]) + "\t" + str(input_value))
 443
 444         calibrate["ADC"][channel].sort(lambda e : e[1], reverse = False)
 445
 446
 447
 448
 449         outfile.write("# Stop " + str(datetime.datetime.now()) + "\n# EOF\n")
 450         outfile.close()
 451         if (len(calibrate["ADC"][channel]) <= 0):
 452                 print("Error: No calibration points taken for ADC " + str(channel))
 453                 return False
 454
 455         return True
 456
 457 def calibrateDAC():
 458         calibrate["DAC"] = []
 459
 460         outfile = open("calibrateDAC.dat", "w", 1)
 461         outfile.write("# Calibrate DAC\n")
 462         outfile.write("# Start " + str(datetime.datetime.now()) + "\n")
 463
 464         print("Calibrating DAC...")
 465         sys.stdout.write("Number of counts to increment per step: ")
 466         read = sys.stdin.readline().strip("\r\n")
 467         if (read == ""):
 468                 return False
 469         stepSize = max(1, int(read))
 470         sys.stdout.write("\n")
 471
 472         outfile.write("# Increment by " + str(stepSize) + "\n")
 473         print("Input measured DAC voltage for each level; empty input ends calibration.")
 474         print("You may optionally input the DAC voltage before it is amplified too.")
 475
 476         level = 0
 477         while (level < calibrate["DAC_Counts"]):
 478
 479                 setDAC(level)
 480
 481                 sys.stdout.write(str(level) + " ?")
 482                 read = sys.stdin.readline().strip("\r\n ")
 483                 if (read == ""):
 484                         break
 485                 else:
 486                         read = read.split(" ")
 487                         if (len(calibrate["DAC"]) > 0 and len(calibrate["DAC"][len(calibrate["DAC"])-1]) != len(read)):
 488                                 print("Either give one value for EVERY point, or two values for EVERY point. Don't mess around.")
 489                                 return False
 490                         if (len(read) == 2):
 491                                 calibrate["DAC"].append((level, float(read[0]), float(read[1])))
 492                                 outfile.write(str(level) + "\t" + str(float(read[0])) + "\t" + str(float(read[1])) + "\n")
 493                         else:
 494                                 calibrate["DAC"].append((level, float(read[0])))
 495                                 outfile.write(str(level) + "\t" + str(float(read[0])) + "\n")
 496
 497
 498
 499                 level += stepSize
 500
 501         outfile.write("# Stop " + str(datetime.datetime.now()) + "\n# EOF\n")
 502         outfile.close()
 503         if (len(calibrate["DAC"]) <= 0):
 504                 print("Error: No calibration points taken for DAC")
 505                 return False
 506         return setDAC(0)
 507
 508 # Run the main function
 509 if __name__ == "__main__":
 510         sys.exit(main())