ilt1000/ilt1000.py

#!/usr/bin/python3

import datetime
import serial
import time


class Error(Exception):
  pass


class UnsupportedCommand(Error):
  pass


class RequiredValueNotSet(Error):
  pass


class OutOfRange(Error):
  pass


class Saturated(Error):
  pass


class CommandError(Error):
  pass


# TODO commands:
# eraselogdata
# getlogdata
# setcurrentloop
# setsimpleirrcal
# setuserdark
# startlogdata
# stoplogdata
# usecalfactor
# erasecalfactor
# getcalfactor
# setcalfactor


class ILT1000(object):

  DARK_NONE = 0
  DARK_FACTORY = 1
  DARK_USER = 2

  DARK_NAMES = {
    0: 'None',
    1: 'Factory',
    2: 'User',
  }

  FEEDBACK_RES_AUTO = 0
  FEEDBACK_RES_LOW = 1
  FEEDBACK_RES_MEDIUM = 2
  FEEDBACK_RES_HIGH = 3

  AVERAGING_AUTO = 0
  AVERAGING_LOW = 1  # 5 ㎐
  AVERAGING_MEDIUM = 2  # 2 ㎐
  AVERAGING_HIGH = 3  # 0.5 ㎐

  LOG_OPTICAL_DENSITY = 1 << 0
  LOG_TRANSMISSION_PERCENT = 1 << 1
  LOG_SENSOR_CURRENT = 1 << 2
  LOG_SENSOR_VOLTAGE = 1 << 3
  LOG_CONTROLLER_TEMP = 1 << 4
  LOG_IRRADIANCE = 1 << 5
  LOG_REALTIME = 1 << 7

  # ILT1000 presents two FTDI serial devices, which become ttyUSB0 and ttyUSB1
  # if nothing else is attached. ttyUSB0 seems to be completely non-responsive.
  # We default to ttyUSB1

  def __init__(self, device='/dev/ttyUSB1', set_time=True):
    self._dev = serial.Serial(device, baudrate=115200)
    self._Clear()
    self._SendCommandOrDie('echooff')
    if set_time:
      self.SetDateTime()

  def _Clear(self):
    self._dev.timeout = 0.1
    self._dev.write(b'\r\n')
    self._dev.read(2 ** 16)
    self._dev.timeout = None

  def _GetLine(self):
    return self._dev.readline().rstrip().decode('ascii')

  def _SendCommand(self, command):
    self._dev.write(command.encode('ascii') + b'\r\n')
    ret = self._GetLine()
    if ret == '-999':
      raise UnsupportedCommand(command)
    if ret == '-500':
      raise RequiredValueNotSet(command)
    if ret == '-501':
      raise OutOfRange(command)
    if ret == '-502':
      raise Saturated(command)
    return ret

  def _SendCommandOrDie(self, command):
    ret = self._SendCommand(command)
    if int(ret) != 0:
      raise CommandError

  def GetModelName(self):
    return self._SendCommand('getmodelname')

  def GetGeneration(self):
    return int(self._SendCommand('getgeneration'))

  def GetFirmwareVersion(self):
    return self._SendCommand('getfwversion')

  def GetSerialNumber(self):
    return self._SendCommand('getserialnumber')

  def GetAuxSerialNumber(self):
    return self._SendCommand('getauxserialno')

  def SetAuxSerialNumber(self, serial):
    # SPEC ERROR
    # This is undocumented.
    self._SendCommandOrDie('setauxserialno %s' % serial)

  def GetControllerTempF(self):
    return int(self._SendCommand('gettemp'))

  def GetAmbientTempF(self):
    # SPEC ERROR
    # Protocol doc indicates that this is degrees F * 100, but actual values
    # look like just degrees F
    return int(self._SendCommand('getambienttemp'))

  def GetDateTime(self):
    ret = self._SendCommand('getdatetime')
    return datetime.datetime.fromtimestamp(int(ret.split()[2]))

  def SetDateTime(self, now=None):
    now = now or datetime.datetime.utcnow()
    timestr = now.strftime('%m/%d/%Y %H:%M:%S')
    self._SendCommandOrDie('setdatetime ' + timestr)

  def GetSensorCurrent(self):
    # SPEC ERROR
    # Protocol doc indicates that this is in pA, but actual values are in
    # scientific notation and appear to be A.
    ret = self._SendCommand('getcurrent')
    return float(ret)

  def GetSensorVoltage(self):
    ret = self._SendCommand('getvoltage')
    return float(ret) / 1000000

  def GetTransmissionPercent(self):
    ret = self._SendCommand('gettrans')
    return float(ret) / 10

  def Get100PercentVoltage(self):
    # SPEC ERROR
    # Spec says microvolts, but actual values appear to be in volts.
    ret = self._SendCommand('get100perc')
    return float(ret)

  def Set100PercentVoltage(self):
    # SPEC ERROR
    # Spec says microvolts, but actual values appear to be in volts.
    ret = self._SendCommand('set100perc')
    return float(ret)

  def GetOpticalDensity(self):
    ret = self._SendCommand('getod')
    return float(ret) / 100

  def GetIrradiance(self):
    ret = self._SendCommand('getirradiance')
    return float(ret) / 1000

  def GetDarkMode(self):
    return int(self._SendCommand('getdarkmode'))

  _DARK_MODE_COMMANDS = {
    DARK_NONE: 'usenodark',
    DARK_FACTORY: 'usefactorydark',
    DARK_USER: 'useuserdark',
  }

  def SetDarkMode(self, mode=DARK_FACTORY):
    self._SendCommandOrDie(self._DARK_MODE_COMMANDS[mode])

  def GetFactoryDarkVoltages(self):
    # SPEC ERROR
    # Actual return value sample:
    # R1 12149 9733 9251 R2 12476 10080 9604 R3 13940 11894 11435
    ret = self._SendCommand('getfactorydark')
    return [float(x) / 1000000 for x in ret.split()]

  def GetUserDarkVoltages(self):
    # SPEC ERROR
    # Actual return value sample:
    # R1 12149 9733 9251 R2 12476 10080 9604 R3 13940 11894 11435
    ret = self._SendCommand('getfactorydark')
    return [float(x) / 1000000 for x in ret.split()]

  def GetClockFrequencyHz(self):
    ret = self._SendCommand('getclockfreq')
    return float(ret) / 100

  def SetClockFrequency(self):
    # SPEC ERROR
    # Command returns -999 on my ILT1000-V02 3.0.7.7. Implementation below is
    # untested and likely wrong.
    self._SendCommandOrDie('setclockfreq')
    self._dev.write(b'A')
    time.sleep(60.0)
    self._dev.write(b'B')

  def GetFeedbackResistanceOhm(self):
    ret = self._SendCommand('getfeedbackres')
    return float(ret) * 100

  def SetFeedbackResistor(self, resistor=FEEDBACK_RES_AUTO):
    self._SendCommandOrDie('usefeedbackres %d' % resistor)

  _AVERAGING_COMMANDS = {
    AVERAGING_AUTO: 'setautaveraging',
    AVERAGING_LOW: 'setlowaveraging',
    AVERAGING_MEDIUM: 'setmedaveraging',
    AVERAGING_HIGH: 'sethiaveraging',
  }

  def SetAveraging(self, averaging=AVERAGING_AUTO):
    # SPEC WARNING
    # There does not appear to be a way to read this back.
    self._SendCommandOrDie(self._AVERAGING_COMMANDS[averaging])

  def SetSampleCount(self, sample_count=200):
    # SPEC WARNING
    # There does not appear to be a way to read this back.
    # SPEC ERROR
    # Returns -999 on my ILT1000-V02 3.0.7.7.
    self._SendCommandOrDie('setsamplecount %d' % sample_count)

  def StartLogging(self, mask, period_seconds):
    # SPEC ERROR
    # Spec says period units are seconds, but they appear to be tenths of
    # seconds
    # SPEC ERROR
    # Spec says that this immediately starts logging, but if we've already
    # started and stopped logging and erased data, logging won't restart until
    # power is cycled.
    self._SendCommandOrDie('startlogdata %d %d %d' % (mask, period_seconds * 10, time.time()))

  def StopLogging(self):
    self._SendCommandOrDie('stoplogdata')

  def EraseLogData(self):
    self._SendCommandOrDie('eraselogdata')

  def GetLogData(self):
    samples = int(self._SendCommand('getlogdata'))
    mask = int(self._GetLine())
    period = float(self._GetLine()) / 10
    ret = {
      'period_seconds': period,
      'samples': [],
    }
    fields = [
      'recorded',
    ]
    if mask & self.LOG_OPTICAL_DENSITY:
      fields.append('optical_density')
    if mask & self.LOG_TRANSMISSION_PERCENT:
      fields.append('transmission_percent')
    if mask & self.LOG_SENSOR_CURRENT:
      fields.append('sensor_current')
    if mask & self.LOG_SENSOR_VOLTAGE:
      fields.append('sensor_voltage')
    if mask & self.LOG_CONTROLLER_TEMP:
      fields.append('controller_temp')
    if mask & self.LOG_IRRADIANCE:
      fields.append('irradiance')

    for _ in range(samples):
      row = self._GetLine()
      values = row.split(',')
      sample = [
        datetime.datetime.fromtimestamp(int(values[0])),
      ]
      index = 1
      if mask & self.LOG_OPTICAL_DENSITY:
        sample.append(float(values[index]) / 100)
        index += 1
      if mask & self.LOG_TRANSMISSION_PERCENT:
        sample.append(float(values[index]) / 10)
        index += 1
      if mask & self.LOG_SENSOR_CURRENT:
        sample.append(float(values[index]))
        index += 1
      if mask & self.LOG_SENSOR_VOLTAGE:
        sample.append(float(values[index]) / 1000000)
        index += 1
      if mask & self.LOG_CONTROLLER_TEMP:
        sample.append(float(values[index]))
        index += 1
      if mask & self.LOG_IRRADIANCE:
        sample.append(float(values[index]) / 1000)
        index += 1
      ret['samples'].append(_Row(fields, sample))
    return ret


class _Row(object):

  def __init__(self, fields, values):
    self._fields = fields
    self._values = values

  def __getitem__(self, key):
    return self._values[self._fields.index(key)]

  def __str__(self):
    return str(self.AsDict())

  def __repr__(self):
    return repr(self.AsDict())

  def AsDict(self):
    return dict(zip(self._fields, self._values))