TSYS01SPI

Complexity

Total Complexity

17

Size/Duplication

Total Lines	131
Duplicated Lines	0 %

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	readROM()	0	8	2
A	startADC()	0	8	2
A	diag()	0	12	1
A	readADC()	0	7	1
A	readRomAddr()	0	9	1
A	temperatureCelsius()	0	15	2
A	on_deactivate()	0	4	1
A	temperatureKelvin()	0	8	1
A	reset()	0	5	1
A	on_activate()	0	8	1
A	__init__()	0	5	1
A	get_process_unit()	0	6	1
A	get_process_value()	0	8	2

# -*- coding: utf-8 -*-
"""
A hardware module for acessing the Measurement Systems TSYS01 temperature
sensor chip via SPI.

Qudi is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

Qudi is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with Qudi. If not, see <http://www.gnu.org/licenses/>.

Copyright (c) the Qudi Developers. See the COPYRIGHT.txt file at the
top-level directory of this distribution and at <https://github.com/Ulm-IQO/qudi/>
"""

from core.module import Base, ConfigOption
from interface.process_interface import ProcessInterface
from core.util.mutex import Mutex

import spidev
import struct
import time


class TSYS01SPI(Base, ProcessInterface):
    """ Measurement Systems TSYS01 temperature sensor.
    """
    _modclass = 'TSYS01'
    _modtype = 'hardware'

    # config opts
    bus = ConfigOption('bus', 0, missing='warn')
    device = ConfigOption('device', 0, missing='warn')

    # commands to chip (constants)
    READ_ADC  = 0x00
    RESET     = 0x1E
    START_ADC = 0x48
    READ_ROM0 = 0xA0

    def __init__(self, **kwargs):
        super().__init__(**kwargs)

        #locking for thread safety
        self.threadlock = Mutex()

    def on_activate(self):
        """ Activate module.
        """
        self.rom = []
        self.spi = spidev.SpiDev()
        self.spi.open(self.bus, self.device)
        self.reset()
        self.readROM()

    def on_deactivate(self):
        """ Deactivate module.
        """
        self.spi.close()

    def diag(self):
        """ SPI bus diagnostic output.
        """
        print('==== SPI Diagnostics ====')
        print('Bits per word: {0:>10}'.format(self.spi.bits_per_word))
        print('CS is active high: {0!s:>6}'.format(self.spi.cshigh))
        print('Loopback: {0!s:>15}'.format(self.spi.loop))
        print('LSB first: {0!s:>14}'.format(self.spi.lsbfirst))
        print('Max clock speed: {0:>8}'.format(self.spi.max_speed_hz))
        print('Clock mode: {0:>13}'.format(self.spi.mode))
        print('SI/SO shared: {0!s:>11}'.format(self.spi.threewire))
        print('=========================')

    def reset(self):
        """ Reset the sensor chip.
        """
        rbuf = self.spi.xfer( [self.RESET], 8000, 3000 )
        time.sleep(0.003)

    def readRomAddr(self, addr):
        """ Read a 16bit rom address.

            @param int addr: momory address to read
            @return int: 16bit contents of rom at address
        """
        bytes = self.READ_ROM0 | 0x0F & ( addr << 1)
        rbuf = self.spi.xfer( [bytes, 0x00, 0x00] )
        return 2**8*rbuf[1] + rbuf[2]

    def readROM(self):
        """ Read the whole device ROM.

            @return list(int): contents of all 8 ROM registers
        """
        self.rom = []
        for i in range(8):
            self.rom.append(self.readRomAddr(i))

    def startADC(self):
        """ Start the temperature sensor ADC.
        """
        try:
            rbuf = self.spi.xfer([self.START_ADC])
        except OSError:
            pass
        time.sleep(0.010)

    def readADC(self):
        """ Read value from the ADC.

            @return int: raw ADC value
        """
        rbuf = self.spi.xfer([self.READ_ADC, 0x00, 0x00, 0x00] )
        return struct.unpack('>I', b'\0' + bytes(rbuf[1:]))[0]

    def temperatureCelsius(self, adcValue):
        """ Convert ADC value to degrees Celsius.

            @param int adcValue: raw ADC value

            @return float: temperature in degrees Celsius
        """
        if len(self.rom) < 8:
            self.readROM()
        adc16 = adcValue / 2**8
        return (-2.0 * self.rom[1] * 10**-21 * adc16**4
              +  4.0 * self.rom[2] * 10**-16 * adc16**3
              + -2.0 * self.rom[3] * 10**-11 * adc16**2
              +  1.0 * self.rom[4] * 10**-6  * adc16
              + -1.5 * self.rom[5] * 10**-2 );

    def temperatureKelvin(self, adcValue):
        """ Convert ADC value to Kelvin.

            @param int adcValue: raw ADC value

            @return float: temperature in Kelvin
        """
        return 273.15 + self.temperatureCelsius(adcValue)

    def get_process_value(self):
        """ Read ADC and return emperature in Kelvin.

            @return float: current temperature in Kelvin
        """
        with self.threadlock:
            self.startADC()
            return self.temperatureKelvin(self.readADC())

    def get_process_unit(self):
        """ Return Process unit, here Kelvin.

            @return tuple(str, str): short and text form of process unit
        """
        return ('K', 'kelvin')