alarmdecoder/pyad2usb/util.py

"""
Provides utility classes for the AD2USB devices.
"""

import ad2usb
import time
import traceback

class NoDeviceError(Exception):
    """
    No devices found.
    """
    pass

class CommError(Exception):
    """
    There was an error communicating with the device.
    """
    pass

class TimeoutError(Exception):
    """
    There was a timeout while trying to communicate with the device.
    """
    pass

class InvalidMessageError(Exception):
    """
    The format of the panel message was invalid.
    """
    pass

class Firmware(object):
    """
    Represents firmware for the AD2USB/AD2SERIAL devices.
    """

    # Constants
    STAGE_START = 0
    STAGE_WAITING = 1
    STAGE_BOOT = 2
    STAGE_LOAD = 3
    STAGE_UPLOADING = 4
    STAGE_DONE = 5

    def __init__(self):
        """
        Constructor
        """
        pass

    def __del__(self):
        """
        Destructor
        """
        pass

    @staticmethod
    def upload(dev, filename, progress_callback=None):
        """
        Uploads firmware to an AD2USB/AD2SERIAL device.
        """

        def do_upload():
            """
            Perform the actual firmware upload to the device.
            """
            with open(filename) as f:
                for line in f:
                    line = line.rstrip()

                    if line[0] == ':':
                        dev.write(line + "\r")
                        res = dev.read_line()

                        if progress_callback is not None:
                            progress_callback(Firmware.STAGE_UPLOADING)

                        time.sleep(0.05)

        def read_until(pattern, timeout=0.0):
            """
            Read characters until a specific pattern is found or the timeout is hit.
            """
            start_time = time.time()
            buf = ''
            position = 0

            while True:
                try:
                    char = dev.read()

                    if char is not None and char != '':
                        if char == pattern[position]:
                            position = position + 1
                            if position == len(pattern):
                                break
                        else:
                            position = 0

                except Exception, err:
                    traceback.print_exc(err)    # TEMP

                if timeout > 0 and time.time() - start_time > timeout:
                    raise TimeoutError('Timed out waiting for pattern: {0}'.format(pattern))

        def stage_callback(stage):
            if progress_callback is not None:
                progress_callback(stage)

        if dev is None:
            raise NoDeviceError('No device specified for firmware upload.')

        stage_callback(Firmware.STAGE_START)

        # Close the reader thread and wait for it to die, otherwise
        # it interferes with our reading.
        dev.close_reader()
        while dev._read_thread.is_alive():
            stage_callback(Firmware.STAGE_WAITING)
            time.sleep(1)

        try:
            # Reboot the device and wait for the boot loader.
            stage_callback(Firmware.STAGE_BOOT)
            dev.write("=")
            read_until('!boot', timeout=10.0)

            # Get ourselves into the boot loader and wait for indication
            # that it's ready for the firmware upload.
            stage_callback(Firmware.STAGE_LOAD)
            dev.write("=")
            read_until('!load', timeout=10.0)

            # And finally do the upload.
            do_upload()
            stage_callback(Firmware.STAGE_DONE)

        except TimeoutError, err:
            print traceback.print_exc(err)              # TEMP
            pass