bin/dmx.py
author Tero Marttila <terom@paivola.fi>
Fri, 11 Apr 2014 19:51:19 +0300
changeset 71 24f00b561a4a
child 73 3c25f32c92fa
permissions -rwxr-xr-x
dmx.py: --zero --start --stop --step ...
71
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     1
#!/usr/bin/env python
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     2
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     3
import serial
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     4
import time
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     5
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     6
import logging; log = logging.getLogger('dmx')
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     7
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     8
class DMXError (Exception) :
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     9
    def __init__ (self, **kwargs) :
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    10
        self.kwargs = kwargs
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    11
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    12
    def __str__ (self) :
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    13
        return self.__doc__.strip().format(**self.kwargs)
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    14
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    15
class DMXCommandError (DMXError) :
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    16
    """
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    17
        Command {cmd!r} failed: {out!r}
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    18
    """
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    19
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    20
class DMXUnknownCommandError (DMXError) :
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    21
    """
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    22
        Unknown command: {cmd!r}
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    23
    """
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    24
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    25
class DMX (object) :
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    26
    SERIAL = '/dev/arduino'
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    27
    SERIAL_BAUD = 9600
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    28
    SERIAL_TIMEOUT = 1.0
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    29
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    30
    @classmethod
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    31
    def open (cls, path, baud=SERIAL_BAUD, timeout=SERIAL_TIMEOUT) :
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    32
        return cls(serial.Serial(path, baud, timeout=timeout))
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    33
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    34
    def __init__ (self, io) :
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    35
        self.io = io
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    36
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    37
        # XXX: bug
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    38
        self.io.write('\r')
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    39
        self.io.flush()
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    40
        self.io.read(1)
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    41
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    42
    def __call__ (self, cmd, *args) :
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    43
        out = cmd + ' ' + ' '.join(str(arg) for arg in args) + '\r'
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    44
        
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    45
        log.info("%s", out)
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    46
        
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    47
        self.io.write(out)
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    48
        self.io.flush()
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    49
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    50
        ret = self.io.read(len(out))
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    51
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    52
        if '!' in ret :
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    53
            raise DMXCommandError(cmd=out, out=ret)
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    54
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    55
        elif '?' in ret :
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    56
            raise DMXUnknownCommandError(cmd=cmd)
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    57
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    58
    def clear (self) :
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    59
        """
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    60
            Set dmx = [ ]
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    61
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    62
            i.e. start transmitting zero-length DMX packets.
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    63
            For most lights, this seems to be equivalent to losing the DMX signal, and they retain their old state.
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    64
        """
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    65
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    66
        self('c')
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    67
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    68
    def zero (self) :
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    69
        """
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    70
            Set dmx = [0, ...]
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    71
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    72
            Uses the maximum DMX packet length available.
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    73
        """
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    74
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    75
        self('z')
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    76
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    77
    def out (self, *values) :
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    78
        """
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    79
            Set dmx = (value, ...)
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    80
        """
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    81
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    82
        self('o', *values)
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    83
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    84
    def set (self, start, *values) :
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    85
        """
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    86
            Set dmx[start:] = value
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    87
        """
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    88
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    89
        self('s', start, *values)
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    90
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    91
    def fill (self, start, end, *values) :
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    92
        """
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    93
            Set dmx[start:end] to repetitions of (value, ...)
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    94
        """
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    95
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    96
        self('f', start, end, *values)
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    97
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    98
    def range (self, start, stop, step, value) :
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    99
        """
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   100
            Set dmx[start:end:step] = value
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   101
        """
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   102
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   103
        self('r', start, stop, step, value)
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   104
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   105
import argparse
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   106
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   107
def main (argv) :
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   108
    parser = argparse.ArgumentParser()
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   109
    parser.add_argument('--serial', default=DMX.SERIAL,
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   110
            help="Path to /dev/tty*")
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   111
    parser.add_argument('--zero', action='store_true',
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   112
            help="Zero output before setting")
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   113
    parser.add_argument('--start', type=int,
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   114
            help="Set from start offset")
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   115
    parser.add_argument('--stop', type=int,
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   116
            help="Set to end offset")
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   117
    parser.add_argument('--step', type=int,
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   118
            help="Step")
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   119
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   120
    parser.add_argument('channels', nargs='*', type=int,
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   121
            help="Output channel values")
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   122
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   123
    options = parser.parse_args(argv[1:])
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   124
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   125
    logging.basicConfig(level=logging.DEBUG)
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   126
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   127
    dmx = DMX.open(options.serial)
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   128
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   129
    if options.zero :
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   130
        dmx.zero()
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   131
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   132
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   133
    if options.start and options.stop and options.step :
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   134
        dmx.range(options.start, options.stop, options.step, *options.channels)
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   135
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   136
    elif options.start and options.stop :
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   137
        dmx.fill(options.start, options.stop, *options.channels)
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   138
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   139
    elif options.start :
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   140
        dmx.set(options.start, *options.channels)
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   141
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   142
    elif options.channels :
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   143
        dmx.out(*options.channels)
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   144
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   145
if __name__ == '__main__':
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   146
    import sys
24f00b561a4a dmx.py: --zero --start --stop --step ...
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   147
    sys.exit(main(sys.argv))