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