qmsk/dmx/control.py
author Tero Marttila <terom@paivola.fi>
Fri, 11 Apr 2014 21:45:20 +0300
changeset 74 9031dafa39d6
child 83 136e210fce82
permissions -rw-r--r--
dmx: split into qmsk.dmx
74
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     1
import collections
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     2
import logging; log = logging.getLogger('qmsk.dmx.control')
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     3
import serial
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     4
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     5
class DMXError (Exception) :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     6
    def __init__ (self, **kwargs) :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     7
        self.kwargs = kwargs
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     8
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     9
    def __str__ (self) :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    10
        return self.__doc__.strip().format(**self.kwargs)
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    11
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    12
class DMXCommandError (DMXError) :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    13
    """
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    14
        Command {cmd!r} failed: {out!r}
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    15
    """
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    16
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    17
class DMXUnknownCommandError (DMXError) :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    18
    """
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    19
        Unknown command: {cmd!r}
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    20
    """
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    21
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    22
class DMX (object) :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    23
    """
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    24
        Arudino-based DMX controller using src/hello-dmx.c over the serial port.
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    25
    """
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    26
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    27
    SERIAL = '/dev/arduino'
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    28
    SERIAL_BAUD = 9600
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    29
    SERIAL_TIMEOUT = 1.0
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    30
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    31
    @classmethod
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    32
    def open (cls, path, baud=SERIAL_BAUD, timeout=SERIAL_TIMEOUT) :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    33
        return cls(serial.Serial(path, baud, timeout=timeout))
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    34
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    35
    def __init__ (self, io) :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    36
        self.io = io
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    37
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    38
        # XXX: bug
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    39
        self.io.write('\r')
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    40
        self.io.flush()
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    41
        self.io.read(1)
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    42
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    43
    def _arg (self, arg) :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    44
        if isinstance(arg, str) :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    45
            value, = arg
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    46
            value = ord(value)
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    47
        elif isinstance(arg, int) :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    48
            value = arg
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    49
        else :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    50
            raise ValueError(arg)
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    51
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    52
        if 0 <= value <= 255 :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    53
            return str(value)
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    54
        else :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    55
            raise ValueError(value)
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    56
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    57
    def __call__ (self, cmd, *args) :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    58
        out = cmd + ' ' + ' '.join(self._arg(arg) for arg in args) + '\r'
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    59
        
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    60
        log.info("%s", out)
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    61
        
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    62
        self.io.write(out)
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    63
        self.io.flush()
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    64
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    65
        ret = self.io.read(len(out))
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    66
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    67
        if '!' in ret :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    68
            raise DMXCommandError(cmd=out, out=ret)
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    69
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    70
        elif '?' in ret :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    71
            raise DMXUnknownCommandError(cmd=cmd)
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    72
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    73
    def clear (self) :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    74
        """
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    75
            Set dmx = [ ]
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    76
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    77
            i.e. start transmitting zero-length DMX packets.
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    78
            For most lights, this seems to be equivalent to losing the DMX signal, and they retain their old state.
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    79
        """
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    80
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    81
        self('c')
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    82
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    83
    def zero (self) :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    84
        """
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    85
            Set dmx = [0, ...]
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    86
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    87
            Uses the maximum DMX packet length available.
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    88
        """
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    89
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    90
        self('z')
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    91
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    92
    def out (self, *values) :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    93
        """
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    94
            Set dmx = (value, ...)
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    95
        """
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    96
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    97
        self('o', *values)
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    98
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    99
    def set (self, start, *values) :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   100
        """
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   101
            Set dmx[start:] = value
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   102
        """
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   103
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   104
        self('s', start, *values)
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   105
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   106
    def fill (self, start, end, *values) :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   107
        """
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   108
            Set dmx[start:end] to repetitions of (value, ...)
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   109
        """
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   110
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   111
        self('f', start, end, *values)
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   112
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   113
    def range (self, start, stop, step, value) :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   114
        """
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   115
            Set dmx[start:end:step] = value
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   116
        """
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   117
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   118
        self('r', start, stop, step, value)
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   119
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   120
    def __setitem__ (self, index, value) :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   121
        if isinstance(value, collections.Sequence) :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   122
            values = tuple(value)
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   123
        else :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   124
            values = (value, )
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   125
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   126
        if isinstance(index, slice) :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   127
            if index.start and index.stop and index.step :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   128
                # XXX: single
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   129
                self.range(index.start, index.stop, index.step, value)
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   130
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   131
            elif index.start and index.stop :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   132
                self.fill(index.start, index.stop, *values)
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   133
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   134
            elif index.start :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   135
                self.set(index.start, *values)
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   136
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   137
            else :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   138
                raise IndexError("invalid slice: %s" % (index, ))
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   139
        
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   140
        else :
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   141
            # simple set
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   142
            self.set(index, *values)
9031dafa39d6 dmx: split into qmsk.dmx
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   143