decoders/nunchuk.py

   1 ##
   2 ## This file is part of the sigrok project.
   3 ##
   4 ## Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
   5 ##
   6 ## This program is free software; you can redistribute it and/or modify
   7 ## it under the terms of the GNU General Public License as published by
   8 ## the Free Software Foundation; either version 2 of the License, or
   9 ## (at your option) any later version.
  10 ##
  11 ## This program is distributed in the hope that it will be useful,
  12 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 ## GNU General Public License for more details.
  15 ##
  16 ## You should have received a copy of the GNU General Public License
  17 ## along with this program; if not, write to the Free Software
  18 ## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19 ##
  20
  21 #
  22 # Nintendo Wii Nunchuk decoder
  23 #
  24
  25 #
  26 # TODO: Description
  27 #
  28 # http://wiibrew.org/wiki/Wiimote/Extension_Controllers/Nunchuck
  29 # http://todbot.com/blog/2008/02/18/wiichuck-wii-nunchuck-adapter-available/
  30 # https://www.sparkfun.com/products/9281
  31 #
  32
  33 import sigrok
  34
  35 # States
  36 IDLE = 0
  37 START = 1
  38 NUNCHUK_SLAVE = 2
  39 INIT = 3
  40 INITIALIZED = 4
  41
  42 # FIXME: This is just some example input for testing purposes...
  43 example_packets = [
  44     # START condition.
  45     {'type': 'S',  'range': (10, 11), 'data': None, 'ann': ''},
  46
  47     # Nunchuk init: Write 0x40,0x00 to slave address 0x54.
  48     {'type': 'AW', 'range': (12, 13), 'data': 0x54, 'ann': ''},
  49     {'type': 'DW', 'range': (14, 15), 'data': 0x40, 'ann': ''},
  50     {'type': 'AW', 'range': (16, 17), 'data': 0x54, 'ann': ''},
  51     {'type': 'DW', 'range': (18, 19), 'data': 0x00, 'ann': ''},
  52
  53     # Get data: Read 6 bytes of data.
  54     {'type': 'DR', 'range': (20, 21), 'data': 0x11, 'ann': ''},
  55     {'type': 'DR', 'range': (22, 23), 'data': 0x22, 'ann': ''},
  56     {'type': 'DR', 'range': (24, 25), 'data': 0x33, 'ann': ''},
  57     {'type': 'DR', 'range': (26, 27), 'data': 0x44, 'ann': ''},
  58     {'type': 'DR', 'range': (28, 29), 'data': 0x55, 'ann': ''},
  59     {'type': 'DR', 'range': (30, 31), 'data': 0x66, 'ann': ''},
  60
  61     # STOP condition.
  62     {'type': 'P',  'range': (32, 33), 'data': None, 'ann': ''},
  63 ]
  64
  65 class Sample():
  66     def __init__(self, data):
  67         self.data = data
  68     def probe(self, probe):
  69         s = self.data[int(probe / 8)] & (1 << (probe % 8))
  70         return True if s else False
  71
  72 def sampleiter(data, unitsize):
  73     for i in range(0, len(data), unitsize):
  74         yield(Sample(data[i:i+unitsize]))
  75
  76 class Decoder(sigrok.Decoder):
  77     id = 'nunchuk'
  78     name = 'Nunchuk'
  79     longname = 'Nintendo Wii Nunchuk decoder'
  80     desc = 'Decodes the Nintendo Wii Nunchuk I2C-based protocol.'
  81     longdesc = '...'
  82     author = 'Uwe Hermann'
  83     email = 'uwe@hermann-uwe.de'
  84     license = 'gplv2+'
  85     inputs = ['i2c']
  86     outputs = ['nunchuck']
  87     probes = {}
  88     options = {}
  89
  90     def __init__(self, **kwargs):
  91         self.probes = Decoder.probes.copy()
  92         self.output_protocol = None
  93         self.output_annotation = None
  94
  95         # TODO: Don't hardcode the number of channels.
  96         self.channels = 8
  97
  98         self.state = IDLE # TODO: Can we assume a certain initial state?
  99
 100         self.sx = self.sy = self.ax = self.ay = self.az = self.bz = self.bc = 0
 101
 102         self.databytecount = 0
 103
 104     def start(self, metadata):
 105         self.unitsize = metadata['unitsize']
 106         # self.output_protocol = self.output_new(2)
 107         self.output_annotation = self.output_new(1)
 108
 109     def report(self):
 110         pass
 111
 112     def decode(self, timeoffset, duration, data):
 113         out = []
 114         o = {}
 115
 116         # We should accept a list of samples and iterate...
 117         # for sample in sampleiter(data['data'], self.unitsize):
 118         for p in example_packets:
 119
 120             # TODO: Eliminate the need for ord().
 121             # s = ord(sample.data)
 122
 123             if p['type'] == 'S': # TODO: Handle 'Sr' here, too?
 124                 self.state = START
 125
 126             elif p['type'] == 'Sr':
 127                 pass # FIXME
 128
 129             elif p['type'] == 'AR':
 130                 # TODO: Error/Warning, not supported, I think.
 131                 pass
 132
 133             elif p['type'] == 'AW':
 134                 # The Wii Nunchuk always has slave address 0x54.
 135                 # TODO: Handle this stuff more correctly.
 136                 if p['data'] == 0x54:
 137                     pass # TODO
 138                 else:
 139                     pass # TODO: What to do here? Ignore? Error?
 140
 141             elif p['type'] == 'DR' and self.state == INITIALIZED:
 142                 if self.databytecount == 0:
 143                     self.sx = p['data']
 144                 elif self.databytecount == 1:
 145                     self.sy = p['data']
 146                 elif self.databytecount == 2:
 147                     self.ax = p['data'] << 2
 148                 elif self.databytecount == 3:
 149                     self.ay = p['data'] << 2
 150                 elif self.databytecount == 4:
 151                     self.az = p['data'] << 2
 152                 elif self.databytecount == 5:
 153                     self.bz =  (p['data'] & (1 << 0)) >> 0
 154                     self.bc =  (p['data'] & (1 << 1)) >> 1
 155                     self.ax |= (p['data'] & (3 << 2)) >> 2
 156                     self.ay |= (p['data'] & (3 << 4)) >> 4
 157                     self.az |= (p['data'] & (3 << 6)) >> 6
 158                     # del o
 159                     o = {'type': 'D', 'range': (0, 0), 'data': []}
 160                     o['data'] = [self.sx, self.sy, self.ax, self.ay, \
 161                                  self.az, self.bz, self.bc]
 162                     # sx = sy = ax = ay = az = bz = bc = 0
 163                 else:
 164                     pass # TODO
 165
 166                 if 0 <= self.databytecount <= 5:
 167                     self.databytecount += 1
 168
 169                 # TODO: If 6 bytes read -> save and reset
 170
 171             # TODO
 172             elif p['type'] == 'DR' and self.state != INITIALIZED:
 173                 pass
 174
 175             elif p['type'] == 'DW':
 176                 if p['data'] == 0x40 and self.state == START:
 177                     self.state = INIT
 178                 elif p['data'] == 0x00 and self.state == INIT:
 179                     o = {'type': 'I', 'range': (0, 0), 'data': []}
 180                     o['data'] = [0x40, 0x00]
 181                     out.append(o)
 182                     self.state = INITIALIZED
 183                 else:
 184                     pass # TODO
 185
 186             elif p['type'] == 'P':
 187                 out.append(o)
 188                 self.state = INITIALIZED
 189                 self.databytecount = 0
 190
 191         if out != []:
 192             # self.put(self.output_protocol, 0, 0, out_proto)
 193             self.put(self.output_annotation, 0, 0, out)
 194