decoders/pan1321/pan1321.py

   1 ##
   2 ## This file is part of the sigrok project.
   3 ##
   4 ## Copyright (C) 2012 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 # Annotation feed formats
  26 ANN_ASCII = 0
  27
  28 # ...
  29 RX = 0
  30 TX = 1
  31
  32 class Decoder(srd.Decoder):
  33     api_version = 1
  34     id = 'pan1321'
  35     name = 'PAN1321'
  36     longname = 'Panasonic PAN1321'
  37     desc = 'TODO.'
  38     license = 'gplv2+'
  39     inputs = ['uart']
  40     outputs = ['pan1321']
  41     probes = []
  42     optional_probes = []
  43     options = {}
  44     annotations = [
  45         ['ASCII', 'TODO: description'],
  46     ]
  47
  48     def __init__(self, **kwargs):
  49         self.cmd = ['', '']
  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 handle_host_command(self, ss, es, rxtx, s):
  59         if s.startswith('AT+JSEC'):
  60             pin = s[-4:]
  61             self.put(ss, es, self.out_ann,
  62                      [ANN_ASCII, ['Host set the Bluetooth PIN to ' + pin]])
  63         elif s.startswith('AT+JSLN'):
  64             name = s[s.find(',') + 1:]
  65             self.put(ss, es, self.out_ann,
  66                      [ANN_ASCII, ['Host set the Bluetooth name to ' + name]])
  67         else:
  68             self.put(ss, es, self.out_ann,
  69                      [ANN_ASCII, ['Host sent unsupported command: %s' % s]])
  70         self.cmd[rxtx] = ''
  71
  72     def handle_device_reply(self, ss, es, rxtx, s):
  73         if s == 'ROK':
  74             self.put(ss, es, self.out_ann,
  75                      [ANN_ASCII, ['Device initialized correctly']])
  76         elif s == 'OK':
  77             self.put(ss, es, self.out_ann,
  78                      [ANN_ASCII, ['Device acknowledged last command']])
  79         elif s.startswith('ERR'):
  80             error = s[s.find('=') + 1:]
  81             self.put(ss, es, self.out_ann,
  82                      [ANN_ASCII, ['Device sent error code ' + error]])
  83         else:
  84             self.put(ss, es, self.out_ann,
  85                      [ANN_ASCII, ['Device sent an unknown reply: %s' % s]])
  86         self.cmd[rxtx] = ''
  87
  88     def decode(self, ss, es, data):
  89         ptype, rxtx, pdata = data
  90
  91         # For now, ignore all UART packets except the actual data packets.
  92         if ptype != 'DATA':
  93             return
  94
  95         # Append a new (ASCII) byte to the currently built/parsed command.
  96         self.cmd[rxtx] += chr(pdata)
  97
  98         # Get packets/bytes until an \r\n sequence is found (end of command).
  99         if self.cmd[rxtx][-1:] != '\n':
 100             return
 101
 102         # Handle host commands and device replies.
 103         # We remove trailing \r\n from the strings before handling them.
 104         if rxtx == RX:
 105             self.handle_device_reply(ss, es, rxtx, self.cmd[rxtx][:-2])
 106         elif rxtx == TX:
 107             self.handle_host_command(ss, es, rxtx, self.cmd[rxtx][:-2])
 108         else:
 109             raise Exception('Invalid rxtx value: %d' % rxtx)
 110