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, metadata):
  52         # self.out_proto = self.add(srd.OUTPUT_PROTO, 'pan1321')
  53         self.out_ann = self.add(srd.OUTPUT_ANN, 'pan1321')
  54
  55     def report(self):
  56         pass
  57
  58     def putx(self, data):
  59         self.put(self.ss_block, self.es_block, self.out_ann, data)
  60
  61     def handle_host_command(self, rxtx, s):
  62         if s.startswith('AT+JAAC'):
  63             # AT+JAAC=x (x can be 0 or 1)
  64             p = s[s.find('=') + 1:]
  65             if p not in ('0', '1'):
  66                 self.putx([2, ['Warning: Invalid JAAC parameter "%s"' % p]])
  67                 return
  68             x = 'Auto' if (p == '1') else 'Don\'t auto'
  69             self.putx([0, ['%s-accept new connections' % x]])
  70             self.putx([1, ['%s-accept connections' % x]])
  71         elif s.startswith('AT+JPRO'):
  72             p = s[s.find('=') + 1:]
  73             if p not in ('0', '1'):
  74                 self.putx([2, ['Warning: Invalid JPRO parameter "%s"' % p]])
  75                 return
  76             onoff = 'off' if (p == '0') else 'on'
  77             x = 'Leaving' if (p == '0') else 'Entering'
  78             self.putx([0, ['%s production mode' % x]])
  79             self.putx([1, ['Production mode = %s' % onoff]])
  80         elif s.startswith('AT+JRES'):
  81             if s != 'AT+JRES': # JRES has no params.
  82                 self.putx([2, ['Warning: Invalid JRES usage.']])
  83                 return
  84             self.putx([0, ['Triggering a software reset']])
  85             self.putx([1, ['Reset']])
  86         elif s.startswith('AT+JSDA'):
  87             # AT+JSDA=l,d (l: length in bytes, d: data)
  88             l, d = s[s.find('=') + 1:].split(',')
  89             if not l.isnumeric():
  90                 self.putx([2, ['Warning: Invalid data length "%s".' % l]])
  91             if int(l) != len(d):
  92                 self.putx([2, ['Warning: Data length mismatch (%d != %d).' % \
  93                           (int(l), len(d))]])
  94             # TODO: Warn if length > MTU size (which is firmware-dependent).
  95             b = ''.join(['%02x ' % ord(c) for c in d])[:-1]
  96             self.putx([0, ['Sending %d data bytes: %s' % (int(l), b)]])
  97             self.putx([1, ['Send %d = %s' % (int(l), b)]])
  98         elif s.startswith('AT+JSEC'):
  99             pin = s[-4:]
 100             self.putx([0, ['Host set the Bluetooth PIN to "' + pin + '"']])
 101             self.putx([1, ['PIN = ' + pin]])
 102         elif s.startswith('AT+JSLN'):
 103             name = s[s.find(',') + 1:]
 104             self.putx([0, ['Host set the Bluetooth name to "' + name + '"']])
 105             self.putx([1, ['BT name = ' + name]])
 106         else:
 107             self.putx([0, ['Host sent unsupported command: %s' % s]])
 108             self.putx([1, ['Unsupported command: %s' % s]])
 109
 110     def handle_device_reply(self, rxtx, s):
 111         if s == 'ROK':
 112             self.putx([0, ['Device initialized correctly']])
 113             self.putx([1, ['Init']])
 114         elif s == 'OK':
 115             self.putx([0, ['Device acknowledged last command']])
 116             self.putx([1, ['ACK']])
 117         elif s.startswith('ERR'):
 118             error = s[s.find('=') + 1:]
 119             self.putx([0, ['Device sent error code ' + error]])
 120             self.putx([1, ['ERR = ' + error]])
 121         else:
 122             self.putx([0, ['Device sent an unknown reply: %s' % s]])
 123             self.putx([1, ['Unknown reply: %s' % s]])
 124
 125     def decode(self, ss, es, data):
 126         ptype, rxtx, pdata = data
 127
 128         # For now, ignore all UART packets except the actual data packets.
 129         if ptype != 'DATA':
 130             return
 131
 132         # If this is the start of a command/reply, remember the start sample.
 133         if self.cmd[rxtx] == '':
 134             self.ss_block = ss
 135
 136         # Append a new (ASCII) byte to the currently built/parsed command.
 137         self.cmd[rxtx] += chr(pdata)
 138
 139         # Get packets/bytes until an \r\n sequence is found (end of command).
 140         if self.cmd[rxtx][-2:] != '\r\n':
 141             return
 142
 143         # Handle host commands and device replies.
 144         # We remove trailing \r\n from the strings before handling them.
 145         self.es_block = es
 146         if rxtx == RX:
 147             self.handle_device_reply(rxtx, self.cmd[rxtx][:-2])
 148         elif rxtx == TX:
 149             self.handle_host_command(rxtx, self.cmd[rxtx][:-2])
 150         else:
 151             raise Exception('Invalid rxtx value: %d' % rxtx)
 152
 153         self.cmd[rxtx] = ''
 154