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