decoders/pan1321/pd.py

   1 ##
   2 ## This file is part of the libsigrokdecode project.
   3 ##
   4 ## Copyright (C) 2012-2013 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 # Panasonic PAN1321 Bluetooth module protocol decoder
  22
  23 import sigrokdecode as srd
  24
  25 # ...
  26 RX = 0
  27 TX = 1
  28
  29 class Decoder(srd.Decoder):
  30     api_version = 1
  31     id = 'pan1321'
  32     name = 'PAN1321'
  33     longname = 'Panasonic PAN1321'
  34     desc = 'Bluetooth RF module with Serial Port Profile (SPP).'
  35     license = 'gplv2+'
  36     inputs = ['uart']
  37     outputs = ['pan1321']
  38     probes = []
  39     optional_probes = []
  40     options = {}
  41     annotations = [
  42         ['Text (verbose)', 'Human-readable text (verbose)'],
  43         ['Text', 'Human-readable text'],
  44         ['Warnings', 'Human-readable warnings'],
  45     ]
  46
  47     def __init__(self, **kwargs):
  48         self.cmd = ['', '']
  49         self.ss_block = None
  50
  51     def start(self):
  52         # self.out_proto = self.register(srd.OUTPUT_PYTHON)
  53         self.out_ann = self.register(srd.OUTPUT_ANN)
  54
  55     def putx(self, data):
  56         self.put(self.ss_block, self.es_block, self.out_ann, data)
  57
  58     def handle_host_command(self, rxtx, s):
  59         if s.startswith('AT+JAAC'):
  60             # AT+JAAC=<auto_accept> (0 or 1)
  61             p = s[s.find('=') + 1:]
  62             if p not in ('0', '1'):
  63                 self.putx([2, ['Warning: Invalid JAAC parameter "%s"' % p]])
  64                 return
  65             x = 'Auto' if (p == '1') else 'Don\'t auto'
  66             self.putx([0, ['%s-accept new connections' % x]])
  67             self.putx([1, ['%s-accept connections' % x]])
  68         elif s.startswith('AT+JPRO'):
  69             # AT+JPRO=<mode> (0 or 1)
  70             p = s[s.find('=') + 1:]
  71             if p not in ('0', '1'):
  72                 self.putx([2, ['Warning: Invalid JPRO parameter "%s"' % p]])
  73                 return
  74             onoff = 'off' if (p == '0') else 'on'
  75             x = 'Leaving' if (p == '0') else 'Entering'
  76             self.putx([0, ['%s production mode' % x]])
  77             self.putx([1, ['Production mode = %s' % onoff]])
  78         elif s.startswith('AT+JRES'):
  79             # AT+JRES
  80             if s != 'AT+JRES': # JRES has no params.
  81                 self.putx([2, ['Warning: Invalid JRES usage.']])
  82                 return
  83             self.putx([0, ['Triggering a software reset']])
  84             self.putx([1, ['Reset']])
  85         elif s.startswith('AT+JSDA'):
  86             # AT+JSDA=<l>,<d> (l: length in bytes, d: data)
  87             # l is (max?) 3 decimal digits and ranges from 1 to MTU size.
  88             # Data can be ASCII or binary values (l bytes total).
  89             l, d = s[s.find('=') + 1:].split(',')
  90             if not l.isnumeric():
  91                 self.putx([2, ['Warning: Invalid data length "%s".' % l]])
  92             if int(l) != len(d):
  93                 self.putx([2, ['Warning: Data length mismatch (%d != %d).' % \
  94                           (int(l), len(d))]])
  95             # TODO: Warn if length > MTU size (which is firmware-dependent
  96             # and is negotiated by both Bluetooth devices upon connection).
  97             b = ''.join(['%02x ' % ord(c) for c in d])[:-1]
  98             self.putx([0, ['Sending %d data bytes: %s' % (int(l), b)]])
  99             self.putx([1, ['Send %d = %s' % (int(l), b)]])
 100         elif s.startswith('AT+JSEC'):
 101             # AT+JSEC=<secmode>,<linkkey_info>,<pintype>,<pinlen>,<pin>
 102             # secmode: Security mode 1 or 3 (default).
 103             # linkkey_info: Must be 1 or 2. Has no function according to docs.
 104             # pintype: 1: variable pin (default), 2: fixed pin.
 105             # pinlen: PIN length (2 decimal digits). Max. PIN length is 16.
 106             # pin: The Bluetooth PIN ('pinlen' chars). Used if pintype=2.
 107             # Note: AT+JSEC (if used) must be the first command after reset.
 108             # TODO: Parse all the other parameters.
 109             pin = s[-4:]
 110             self.putx([0, ['Host set the Bluetooth PIN to "' + pin + '"']])
 111             self.putx([1, ['PIN = ' + pin]])
 112         elif s.startswith('AT+JSLN'):
 113             # AT+JSLN=<namelen>,<name>
 114             # namelen: Friendly name length (2 decimal digits). Max. len is 18.
 115             # name: The Bluetooth "friendly name" ('namelen' ASCII characters).
 116             name = s[s.find(',') + 1:]
 117             self.putx([0, ['Host set the Bluetooth name to "' + name + '"']])
 118             self.putx([1, ['BT name = ' + name]])
 119         else:
 120             self.putx([0, ['Host sent unsupported command: %s' % s]])
 121             self.putx([1, ['Unsupported command: %s' % s]])
 122
 123     def handle_device_reply(self, rxtx, s):
 124         if s == 'ROK':
 125             self.putx([0, ['Device initialized correctly']])
 126             self.putx([1, ['Init']])
 127         elif s == 'OK':
 128             self.putx([0, ['Device acknowledged last command']])
 129             self.putx([1, ['ACK']])
 130         elif s.startswith('ERR'):
 131             error = s[s.find('=') + 1:]
 132             self.putx([0, ['Device sent error code ' + error]])
 133             self.putx([1, ['ERR = ' + error]])
 134         else:
 135             self.putx([0, ['Device sent an unknown reply: %s' % s]])
 136             self.putx([1, ['Unknown reply: %s' % s]])
 137
 138     def decode(self, ss, es, data):
 139         ptype, rxtx, pdata = data
 140
 141         # For now, ignore all UART packets except the actual data packets.
 142         if ptype != 'DATA':
 143             return
 144
 145         # If this is the start of a command/reply, remember the start sample.
 146         if self.cmd[rxtx] == '':
 147             self.ss_block = ss
 148
 149         # Append a new (ASCII) byte to the currently built/parsed command.
 150         self.cmd[rxtx] += chr(pdata)
 151
 152         # Get packets/bytes until an \r\n sequence is found (end of command).
 153         if self.cmd[rxtx][-2:] != '\r\n':
 154             return
 155
 156         # Handle host commands and device replies.
 157         # We remove trailing \r\n from the strings before handling them.
 158         self.es_block = es
 159         if rxtx == RX:
 160             self.handle_device_reply(rxtx, self.cmd[rxtx][:-2])
 161         elif rxtx == TX:
 162             self.handle_host_command(rxtx, self.cmd[rxtx][:-2])
 163         else:
 164             raise Exception('Invalid rxtx value: %d' % rxtx)
 165
 166         self.cmd[rxtx] = ''
 167