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