2 ## This file is part of the sigrok project.
4 ## Copyright (C) 2010-2012 Uwe Hermann <uwe@hermann-uwe.de>
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.
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.
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
21 # Nintendo Wii Nunchuk protocol decoder
23 import sigrokdecode as srd
25 class Decoder(srd.Decoder):
29 longname = 'Nintendo Wii Nunchuk'
30 desc = 'Nintendo Wii Nunchuk controller protocol.'
33 outputs = ['nunchuck']
38 ['Text (verbose)', 'Human-readable text (verbose)'],
39 ['Text', 'Human-readable text'],
42 def __init__(self, **kwargs):
44 self.sx = self.sy = self.ax = self.ay = self.az = self.bz = self.bc = -1
45 self.databytecount = 0
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')
56 # Helper for annotations which span exactly one I2C packet.
57 self.put(self.ss, self.es, self.out_ann, data)
59 def handle_reg_0x00(self, databyte):
61 self.putx([0, ['Analog stick X position: 0x%02x' % self.sx]])
62 self.putx([1, ['SX: 0x%02x' % self.sx]])
64 def handle_reg_0x01(self, databyte):
66 self.putx([0, ['Analog stick Y position: 0x%02x' % self.sy]])
67 self.putx([1, ['SY: 0x%02x' % self.sy]])
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]])
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]])
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]])
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]
95 s = '' if (self.bz == 0) else 'not '
96 self.putx([0, ['Z button: %spressed' % s]])
97 self.putx([1, ['BZ: %d' % self.bz]])
99 s = '' if (self.bc == 0) else 'not '
100 self.putx([0, ['C button: %spressed' % s]])
101 self.putx([1, ['BC: %d' % self.bc]])
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]])
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]])
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]])
112 def output_full_block_if_possible(self):
113 # For now, only output summary annotation if all values are available.
114 t = (self.sx, self.sy, self.ax, self.ay, self.az, self.bz, self.bc)
118 s = 'Analog stick X position: 0x%02x\n' % self.sx
119 s += 'Analog stick Y position: 0x%02x\n' % self.sy
120 s += 'Z button: %spressed\n' % ('' if (self.bz == 0) else 'not ')
121 s += 'C button: %spressed\n' % ('' if (self.bc == 0) else 'not ')
122 s += 'Accelerometer X value: 0x%03x\n' % self.ax
123 s += 'Accelerometer Y value: 0x%03x\n' % self.ay
124 s += 'Accelerometer Z value: 0x%03x\n' % self.az
125 self.put(self.block_start_sample, self.block_end_sample,
126 self.out_ann, [0, [s]])
128 s = 'SX = 0x%02x, SY = 0x%02x, AX = 0x%02x, AY = 0x%02x, ' \
129 'AZ = 0x%02x, BZ = 0x%02x, BC = 0x%02x' % (self.sx, \
130 self.sy, self.ax, self.ay, self.az, self.bz, self.bc)
131 self.put(self.block_start_sample, self.block_end_sample,
132 self.out_ann, [1, [s]])
134 def decode(self, ss, es, data):
137 # Store the start/end samples of this I2C packet.
138 self.ss, self.es = ss, es
141 if self.state == 'IDLE':
142 # Wait for an I2C START condition.
145 self.state = 'GET SLAVE ADDR'
146 self.block_start_sample = ss
147 elif self.state == 'GET SLAVE ADDR':
148 # Wait for an address read operation.
149 if cmd != 'ADDRESS READ':
151 self.state = 'READ REGS'
152 elif self.state == 'READ REGS':
153 if cmd == 'DATA READ':
154 handle_reg = getattr(self, 'handle_reg_0x%02x' % self.reg)
158 self.block_end_sample = es
159 self.output_full_block_if_possible()
160 self.sx = self.sy = self.ax = self.ay = self.az = -1
161 self.bz = self.bc = -1
164 # self.putx([0, ['Ignoring: %s (data=%s)' % (cmd, databyte)]])
167 raise Exception('Invalid state: %s' % self.state)