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