X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoders%2Fnunchuk.py;h=8bf0228e03b5b722970cd5c207422e1cd8b063ba;hp=409e120c458296082d0775bcb97753c72b49f875;hb=9a12a6e7af3d7091d8e35dd1c731402cb80a01b0;hpb=9c93add5aeca95c568afab7fe249c0586d8dec6b diff --git a/decoders/nunchuk.py b/decoders/nunchuk.py index 409e120..8bf0228 100644 --- a/decoders/nunchuk.py +++ b/decoders/nunchuk.py @@ -22,136 +22,154 @@ # Nintendo Wii Nunchuk decoder # +# # TODO: Description +# +# http://wiibrew.org/wiki/Wiimote/Extension_Controllers/Nunchuck +# http://todbot.com/blog/2008/02/18/wiichuck-wii-nunchuck-adapter-available/ +# https://www.sparkfun.com/products/9281 +# + +import sigrokdecode as srd + +# States +IDLE = 0 +START = 1 +NUNCHUK_SLAVE = 2 +INIT = 3 +INITIALIZED = 4 # FIXME: This is just some example input for testing purposes... example_packets = [ - # START condition. - {'type': 'S', 'range': (10, 11), 'data': None, 'ann': ''}, - - # Nunchuk init: Write 0x40,0x00 to slave address 0x54. - {'type': 'AW', 'range': (12, 13), 'data': 0x54, 'ann': ''}, - {'type': 'DW', 'range': (14, 15), 'data': 0x40, 'ann': ''}, - {'type': 'AW', 'range': (16, 17), 'data': 0x54, 'ann': ''}, - {'type': 'DW', 'range': (18, 19), 'data': 0x00, 'ann': ''}, - - # Get data: Read 6 bytes of data. - {'type': 'DR', 'range': (20, 21), 'data': 0x11, 'ann': ''}, - {'type': 'DR', 'range': (22, 23), 'data': 0x22, 'ann': ''}, - {'type': 'DR', 'range': (24, 25), 'data': 0x33, 'ann': ''}, - {'type': 'DR', 'range': (26, 27), 'data': 0x44, 'ann': ''}, - {'type': 'DR', 'range': (28, 29), 'data': 0x55, 'ann': ''}, - {'type': 'DR', 'range': (30, 31), 'data': 0x66, 'ann': ''}, - - # STOP condition. - {'type': 'P', 'range': (32, 33), 'data': None, 'ann': ''}, + # START condition. + {'type': 'S', 'range': (10, 11), 'data': None, 'ann': ''}, + + # Nunchuk init: Write 0x40,0x00 to slave address 0x54. + {'type': 'AW', 'range': (12, 13), 'data': 0x54, 'ann': ''}, + {'type': 'DW', 'range': (14, 15), 'data': 0x40, 'ann': ''}, + {'type': 'AW', 'range': (16, 17), 'data': 0x54, 'ann': ''}, + {'type': 'DW', 'range': (18, 19), 'data': 0x00, 'ann': ''}, + + # Get data: Read 6 bytes of data. + {'type': 'DR', 'range': (20, 21), 'data': 0x11, 'ann': ''}, + {'type': 'DR', 'range': (22, 23), 'data': 0x22, 'ann': ''}, + {'type': 'DR', 'range': (24, 25), 'data': 0x33, 'ann': ''}, + {'type': 'DR', 'range': (26, 27), 'data': 0x44, 'ann': ''}, + {'type': 'DR', 'range': (28, 29), 'data': 0x55, 'ann': ''}, + {'type': 'DR', 'range': (30, 31), 'data': 0x66, 'ann': ''}, + + # STOP condition. + {'type': 'P', 'range': (32, 33), 'data': None, 'ann': ''}, ] -def decode(inbuf): - """Nintendo Wii Nunchuk decoder""" - - # FIXME: Get the data in the correct format in the first place. - inbuf = [ord(x) for x in inbuf] - out = [] - o = {} - - # TODO: Pass in metadata. - - # States - IDLE, START, NUNCHUK_SLAVE, INIT, INITIALIZED = range(5) - state = IDLE # TODO: Can we assume a certain initial state? - - sx = sy = ax = ay = az = bz = bc = 0 - - databytecount = 0 - - # Loop over all I2C packets. - for p in example_packets: - if p['type'] == 'S': # TODO: Handle 'Sr' here, too? - state = START - - elif p['type'] == 'Sr': - pass # FIXME - - elif p['type'] == 'AR': - # TODO: Error/Warning, not supported, I think. - pass - - elif p['type'] == 'AW': - # The Wii Nunchuk always has slave address 0x54. - # TODO: Handle this stuff more correctly. - if p['data'] == 0x54: - pass # TODO - else: - pass # TODO: What to do here? Ignore? Error? - - elif p['type'] == 'DR' and state == INITIALIZED: - if databytecount == 0: - sx = p['data'] - elif databytecount == 1: - sy = p['data'] - elif databytecount == 2: - ax = p['data'] << 2 - elif databytecount == 3: - ay = p['data'] << 2 - elif databytecount == 4: - az = p['data'] << 2 - elif databytecount == 5: - bz = (p['data'] & (1 << 0)) >> 0 - bc = (p['data'] & (1 << 1)) >> 1 - ax |= (p['data'] & (3 << 2)) >> 2 - ay |= (p['data'] & (3 << 4)) >> 4 - az |= (p['data'] & (3 << 6)) >> 6 - # del o - o = {'type': 'D', 'range': (0, 0), 'data': []} - o['data'] = [sx, sy, ax, ay, az, bz, bc] - # sx = sy = ax = ay = az = bz = bc = 0 - else: - pass # TODO - - if 0 <= databytecount <= 5: - databytecount += 1 - - # TODO: If 6 bytes read -> save and reset - - # TODO - elif p['type'] == 'DR' and state != INITIALIZED: - pass - - elif p['type'] == 'DW': - if p['data'] == 0x40 and state == START: - state = INIT - elif p['data'] == 0x00 and state == INIT: - o = {'type': 'I', 'range': (0, 0), 'data': []} - o['data'] = [0x40, 0x00] - out.append(o) - state = INITIALIZED - else: - pass # TODO - - elif p['type'] == 'P': - out.append(o) - state = INITIALIZED - databytecount = 0 - - print out - - # FIXME - return '' - -def register(): - return { - 'id': 'nunchuk', - 'name': 'Nunchuk', - 'desc': 'Nintendo Wii Nunchuk decoder', - 'inputformats': ['i2c'], - 'ouputformats': ['nunchuk'], - } - -# Use psyco (if available) as it results in huge performance improvements. -try: - import psyco - psyco.bind(decode) -except ImportError: - pass +class Decoder(srd.Decoder): + id = 'nunchuk' + name = 'Nunchuk' + longname = 'Nintendo Wii Nunchuk decoder' + desc = 'Decodes the Nintendo Wii Nunchuk I2C-based protocol.' + longdesc = '...' + author = 'Uwe Hermann' + email = 'uwe@hermann-uwe.de' + license = 'gplv2+' + inputs = ['i2c'] + outputs = ['nunchuck'] + probes = [] # TODO + options = {} + annotations = [] + + def __init__(self, **kwargs): + self.state = IDLE # TODO: Can we assume a certain initial state? + + self.sx = self.sy = self.ax = self.ay = self.az = self.bz = self.bc = 0 + + self.databytecount = 0 + + def start(self, metadata): + # self.out_proto = self.add(srd.OUTPUT_PROTO, 'nunchuk') + self.out_ann = self.add(srd.OUTPUT_ANN, 'nunchuk') + + def report(self): + pass + + def decode(self, timeoffset, duration, data): + out = [] + o = {} + + # We should accept a list of samples and iterate... + for p in example_packets: # TODO + + # TODO: Eliminate the need for ord(). + # s = ord(sample.data) + + if p['type'] == 'S': # TODO: Handle 'Sr' here, too? + self.state = START + + elif p['type'] == 'Sr': + pass # FIXME + + elif p['type'] == 'AR': + # TODO: Error/Warning, not supported, I think. + pass + + elif p['type'] == 'AW': + # The Wii Nunchuk always has slave address 0x54. + # TODO: Handle this stuff more correctly. + if p['data'] == 0x54: + pass # TODO + else: + pass # TODO: What to do here? Ignore? Error? + + elif p['type'] == 'DR' and self.state == INITIALIZED: + if self.databytecount == 0: + self.sx = p['data'] + elif self.databytecount == 1: + self.sy = p['data'] + elif self.databytecount == 2: + self.ax = p['data'] << 2 + elif self.databytecount == 3: + self.ay = p['data'] << 2 + elif self.databytecount == 4: + self.az = p['data'] << 2 + elif self.databytecount == 5: + self.bz = (p['data'] & (1 << 0)) >> 0 + self.bc = (p['data'] & (1 << 1)) >> 1 + self.ax |= (p['data'] & (3 << 2)) >> 2 + self.ay |= (p['data'] & (3 << 4)) >> 4 + self.az |= (p['data'] & (3 << 6)) >> 6 + # del o + o = {'type': 'D', 'range': (0, 0), 'data': []} + o['data'] = [self.sx, self.sy, self.ax, self.ay, \ + self.az, self.bz, self.bc] + # sx = sy = ax = ay = az = bz = bc = 0 + else: + pass # TODO + + if 0 <= self.databytecount <= 5: + self.databytecount += 1 + + # TODO: If 6 bytes read -> save and reset + + # TODO + elif p['type'] == 'DR' and self.state != INITIALIZED: + pass + + elif p['type'] == 'DW': + if p['data'] == 0x40 and self.state == START: + self.state = INIT + elif p['data'] == 0x00 and self.state == INIT: + o = {'type': 'I', 'range': (0, 0), 'data': []} + o['data'] = [0x40, 0x00] + out.append(o) + self.state = INITIALIZED + else: + pass # TODO + + elif p['type'] == 'P': + out.append(o) + self.state = INITIALIZED + self.databytecount = 0 + + if out != []: + # self.put(0, 0, self.out_proto, out_proto) + self.put(0, 0, self.out_ann, out)