decoders/nunchuk/nunchuk.py

   1 ##
   2 ## This file is part of the sigrok project.
   3 ##
   4 ## Copyright (C) 2010-2012 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 # Nintendo Wii Nunchuk protocol decoder
  22
  23 import sigrokdecode as srd
  24
  25 class Decoder(srd.Decoder):
  26     api_version = 1
  27     id = 'nunchuk'
  28     name = 'Nunchuk'
  29     longname = 'Nintendo Wii Nunchuk'
  30     desc = 'Nintendo Wii Nunchuk controller protocol.'
  31     license = 'gplv2+'
  32     inputs = ['i2c']
  33     outputs = ['nunchuck']
  34     probes = []
  35     optional_probes = []
  36     options = {}
  37     annotations = [
  38         ['Text (verbose)', 'Human-readable text (verbose)'],
  39         ['Text', 'Human-readable text'],
  40     ]
  41
  42     def __init__(self, **kwargs):
  43         self.state = 'IDLE'
  44         self.sx = self.sy = self.ax = self.ay = self.az = self.bz = self.bc = 0
  45         self.databytecount = 0
  46         self.reg = 0x00
  47
  48     def start(self, metadata):
  49         # self.out_proto = self.add(srd.OUTPUT_PROTO, 'nunchuk')
  50         self.out_ann = self.add(srd.OUTPUT_ANN, 'nunchuk')
  51
  52     def report(self):
  53         pass
  54
  55     def putx(self, data):
  56         # Helper for annotations which span exactly one I2C packet.
  57         self.put(self.ss, self.es, self.out_ann, data)
  58
  59     def handle_reg_0x00(self, databyte):
  60         self.sx = databyte
  61         self.putx([0, ['Analog stick X position: 0x%02x' % self.sx]])
  62         self.putx([1, ['SX: 0x%02x' % self.sx]])
  63
  64     def handle_reg_0x01(self, databyte):
  65         self.sy = databyte
  66         self.putx([0, ['Analog stick Y position: 0x%02x' % self.sy]])
  67         self.putx([1, ['SY: 0x%02x' % self.sy]])
  68
  69     def handle_reg_0x02(self, databyte):
  70         self.ax = databyte << 2
  71         self.putx([0, ['Accelerometer X value bits[9:2]: 0x%03x' % self.ax]])
  72         self.putx([1, ['AX[9:2]: 0x%03x' % self.ax]])
  73
  74     def handle_reg_0x03(self, databyte):
  75         self.ay = databyte << 2
  76         self.putx([0, ['Accelerometer Y value bits[9:2]: 0x%03x' % self.ay]])
  77         self.putx([1, ['AY[9:2]: 0x%x' % self.ay]])
  78
  79     def handle_reg_0x04(self, databyte):
  80         self.az = databyte << 2
  81         self.putx([0, ['Accelerometer Z value bits[9:2]: 0x%03x' % self.az]])
  82         self.putx([1, ['AZ[9:2]: 0x%x' % self.az]])
  83
  84     # TODO: Bit-exact annotations.
  85     def handle_reg_0x05(self, databyte):
  86         self.bz = (databyte & (1 << 0)) >> 0 # Bits[0:0]
  87         self.bc = (databyte & (1 << 1)) >> 1 # Bits[1:1]
  88         ax_rest = (databyte & (3 << 2)) >> 2 # Bits[3:2]
  89         ay_rest = (databyte & (3 << 4)) >> 4 # Bits[5:4]
  90         az_rest = (databyte & (3 << 6)) >> 6 # Bits[7:6]
  91         self.ax |= ax_rest
  92         self.ay |= ay_rest
  93         self.az |= az_rest
  94
  95         s = '' if (self.bz == 0) else 'not '
  96         self.putx([0, ['Z button: %spressed' % s]])
  97         self.putx([1, ['BZ: %d' % self.bz]])
  98
  99         s = '' if (self.bc == 0) else 'not '
 100         self.putx([0, ['C button: %spressed' % s]])
 101         self.putx([1, ['BC: %d' % self.bc]])
 102
 103         self.putx([0, ['Accelerometer X value bits[1:0]: 0x%x' % ax_rest]])
 104         self.putx([1, ['AX[1:0]: 0x%x' % ax_rest]])
 105
 106         self.putx([0, ['Accelerometer Y value bits[1:0]: 0x%x' % ay_rest]])
 107         self.putx([1, ['AY[1:0]: 0x%x' % ay_rest]])
 108
 109         self.putx([0, ['Accelerometer Z value bits[1:0]: 0x%x' % az_rest]])
 110         self.putx([1, ['AZ[1:0]: 0x%x' % az_rest]])
 111
 112     def decode(self, ss, es, data):
 113         cmd, databyte = data
 114
 115         # Store the start/end samples of this I2C packet.
 116         self.ss, self.es = ss, es
 117
 118         # State machine.
 119         if self.state == 'IDLE':
 120             # Wait for an I2C START condition.
 121             if cmd != 'START':
 122                 return
 123             self.state = 'GET SLAVE ADDR'
 124             self.block_start_sample = ss
 125         elif self.state == 'GET SLAVE ADDR':
 126             # Wait for an address read operation.
 127             if cmd != 'ADDRESS READ':
 128                 return
 129             self.state = 'READ REGS'
 130         elif self.state == 'READ REGS':
 131             if cmd == 'DATA READ':
 132                 handle_reg = getattr(self, 'handle_reg_0x%02x' % self.reg)
 133                 handle_reg(databyte)
 134                 self.reg += 1
 135             elif cmd == 'STOP':
 136                 self.block_end_sample = es
 137
 138                 # TODO: Only works if host reads _all_ regs (0x00 - 0x05).
 139                 d = 'SX = 0x%02x, SY = 0x%02x, AX = 0x%02x, AY = 0x%02x, ' \
 140                     'AZ = 0x%02x, BZ = 0x%02x, BC = 0x%02x' % (self.sx, \
 141                     self.sy, self.ax, self.ay, self.az, self.bz, self.bc)
 142                 self.put(self.block_start_sample, self.block_end_sample,
 143                          self.out_ann, [0, [d]])
 144
 145                 self.sx = self.sy = self.ax = self.ay = self.az = 0
 146                 self.bz = self.bc = 0
 147
 148                 self.state = 'IDLE'
 149             else:
 150                 # self.putx([0, ['Ignoring: %s (data=%s)' % (cmd, databyte)]])
 151                 pass
 152         else:
 153             raise Exception('Invalid state: %s' % self.state)
 154