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, see <http://www.gnu.org/licenses/>.
  18 ##
  19
  20 import sigrokdecode as srd
  21
  22 # ...
  23 RX = 0
  24 TX = 1
  25
  26 class Decoder(srd.Decoder):
  27     api_version = 3
  28     id = 'pan1321'
  29     name = 'PAN1321'
  30     longname = 'Panasonic PAN1321'
  31     desc = 'Bluetooth RF module with Serial Port Profile (SPP).'
  32     license = 'gplv2+'
  33     inputs = ['uart']
  34     outputs = []
  35     tags = ['Wireless/RF']
  36     annotations = (
  37         ('text-verbose', 'Text (verbose)'),
  38         ('text', 'Text'),
  39         ('warning', 'Warning'),
  40     )
  41
  42     def __init__(self):
  43         self.reset()
  44
  45     def reset(self):
  46         self.cmd = ['', '']
  47         self.ss_block = None
  48
  49     def start(self):
  50         self.out_ann = self.register(srd.OUTPUT_ANN)
  51
  52     def putx(self, data):
  53         self.put(self.ss_block, self.es_block, self.out_ann, data)
  54
  55     def handle_host_command(self, rxtx, s):
  56         if s.startswith('AT+JAAC'):
  57             # AT+JAAC=<auto_accept> (0 or 1)
  58             p = s[s.find('=') + 1:]
  59             if p not in ('0', '1'):
  60                 self.putx([2, ['Warning: Invalid JAAC parameter "%s"' % p]])
  61                 return
  62             x = 'Auto' if (p == '1') else 'Don\'t auto'
  63             self.putx([0, ['%s-accept new connections' % x]])
  64             self.putx([1, ['%s-accept connections' % x]])
  65         elif s.startswith('AT+JPRO'):
  66             # AT+JPRO=<mode> (0 or 1)
  67             p = s[s.find('=') + 1:]
  68             if p not in ('0', '1'):
  69                 self.putx([2, ['Warning: Invalid JPRO parameter "%s"' % p]])
  70                 return
  71             onoff = 'off' if (p == '0') else 'on'
  72             x = 'Leaving' if (p == '0') else 'Entering'
  73             self.putx([0, ['%s production mode' % x]])
  74             self.putx([1, ['Production mode = %s' % onoff]])
  75         elif s.startswith('AT+JRES'):
  76             # AT+JRES
  77             if s != 'AT+JRES': # JRES has no params.
  78                 self.putx([2, ['Warning: Invalid JRES usage.']])
  79                 return
  80             self.putx([0, ['Triggering a software reset']])
  81             self.putx([1, ['Reset']])
  82         elif s.startswith('AT+JSDA'):
  83             # AT+JSDA=<l>,<d> (l: length in bytes, d: data)
  84             # l is (max?) 3 decimal digits and ranges from 1 to MTU size.
  85             # Data can be ASCII or binary values (l bytes total).
  86             l, d = s[s.find('=') + 1:].split(',')
  87             if not l.isnumeric():
  88                 self.putx([2, ['Warning: Invalid data length "%s".' % l]])
  89             if int(l) != len(d):
  90                 self.putx([2, ['Warning: Data length mismatch (%d != %d).' % \
  91                           (int(l), len(d))]])
  92             # TODO: Warn if length > MTU size (which is firmware-dependent
  93             # and is negotiated by both Bluetooth devices upon connection).
  94             b = ''.join(['%02x ' % ord(c) for c in d])[:-1]
  95             self.putx([0, ['Sending %d data bytes: %s' % (int(l), b)]])
  96             self.putx([1, ['Send %d = %s' % (int(l), b)]])
  97         elif s.startswith('AT+JSEC'):
  98             # AT+JSEC=<secmode>,<linkkey_info>,<pintype>,<pinlen>,<pin>
  99             # secmode: Security mode 1 or 3 (default).
 100             # linkkey_info: Must be 1 or 2. Has no function according to docs.
 101             # pintype: 1: variable pin (default), 2: fixed pin.
 102             # pinlen: PIN length (2 decimal digits). Max. PIN length is 16.
 103             # pin: The Bluetooth PIN ('pinlen' chars). Used if pintype=2.
 104             # Note: AT+JSEC (if used) must be the first command after reset.
 105             # TODO: Parse all the other parameters.
 106             pin = s[-4:]
 107             self.putx([0, ['Host set the Bluetooth PIN to "' + pin + '"']])
 108             self.putx([1, ['PIN = ' + pin]])
 109         elif s.startswith('AT+JSLN'):
 110             # AT+JSLN=<namelen>,<name>
 111             # namelen: Friendly name length (2 decimal digits). Max. len is 18.
 112             # name: The Bluetooth "friendly name" ('namelen' ASCII characters).
 113             name = s[s.find(',') + 1:]
 114             self.putx([0, ['Host set the Bluetooth name to "' + name + '"']])
 115             self.putx([1, ['BT name = ' + name]])
 116         else:
 117             self.putx([0, ['Host sent unsupported command: %s' % s]])
 118             self.putx([1, ['Unsupported command: %s' % s]])
 119
 120     def handle_device_reply(self, rxtx, s):
 121         if s == 'ROK':
 122             self.putx([0, ['Device initialized correctly']])
 123             self.putx([1, ['Init']])
 124         elif s == 'OK':
 125             self.putx([0, ['Device acknowledged last command']])
 126             self.putx([1, ['ACK']])
 127         elif s.startswith('ERR'):
 128             error = s[s.find('=') + 1:]
 129             self.putx([0, ['Device sent error code ' + error]])
 130             self.putx([1, ['ERR = ' + error]])
 131         else:
 132             self.putx([0, ['Device sent an unknown reply: %s' % s]])
 133             self.putx([1, ['Unknown reply: %s' % s]])
 134
 135     def decode(self, ss, es, data):
 136         ptype, rxtx, pdata = data
 137
 138         # For now, ignore all UART packets except the actual data packets.
 139         if ptype != 'DATA':
 140             return
 141
 142         # We're only interested in the byte value (not individual bits).
 143         pdata = pdata[0]
 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
 164         self.cmd[rxtx] = ''