]> sigrok.org Git - libsigrokdecode.git/blob - decoders/pan1321/pd.py
pan1321: Support JSEC and JPRO.
[libsigrokdecode.git] / 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 # Panasonic PAN1321 Bluetooth module protocol decoder
22
23 import sigrokdecode as srd
24
25 # ...
26 RX = 0
27 TX = 1
28
29 class Decoder(srd.Decoder):
30     api_version = 1
31     id = 'pan1321'
32     name = 'PAN1321'
33     longname = 'Panasonic PAN1321'
34     desc = 'Bluetooth RF module with Serial Port Profile (SPP).'
35     license = 'gplv2+'
36     inputs = ['uart']
37     outputs = ['pan1321']
38     probes = []
39     optional_probes = []
40     options = {}
41     annotations = [
42         ['Text (verbose)', 'Human-readable text (verbose)'],
43         ['Text', 'Human-readable text'],
44     ]
45
46     def __init__(self, **kwargs):
47         self.cmd = ['', '']
48         self.ss_block = None
49
50     def start(self, metadata):
51         # self.out_proto = self.add(srd.OUTPUT_PROTO, 'pan1321')
52         self.out_ann = self.add(srd.OUTPUT_ANN, 'pan1321')
53
54     def report(self):
55         pass
56
57     def putx(self, data):
58         self.put(self.ss_block, self.es_block, self.out_ann, data)
59
60     def handle_host_command(self, rxtx, s):
61         if s.startswith('AT+JPRO'):
62             p = s[s.find('=') + 1:]
63             onoff = 'off' if (p == '0') else 'on'
64             x = 'Leaving' if (p == '0') else 'Entering'
65             self.putx([0, ['%s production mode' % x]])
66             self.putx([1, ['Production mode = %s' % onoff]])
67         elif s.startswith('AT+JRES'):
68             self.putx([0, ['Triggering a software reset']])
69             self.putx([1, ['Reset']])
70         elif s.startswith('AT+JSEC'):
71             pin = s[-4:]
72             self.putx([0, ['Host set the Bluetooth PIN to "' + pin + '"']])
73             self.putx([1, ['PIN = ' + pin]])
74         elif s.startswith('AT+JSLN'):
75             name = s[s.find(',') + 1:]
76             self.putx([0, ['Host set the Bluetooth name to "' + name + '"']])
77             self.putx([1, ['BT name = ' + name]])
78         else:
79             self.putx([0, ['Host sent unsupported command: %s' % s]])
80             self.putx([1, ['Unsupported command: %s' % s]])
81         self.cmd[rxtx] = ''
82
83     def handle_device_reply(self, rxtx, s):
84         if s == 'ROK':
85             self.putx([0, ['Device initialized correctly']])
86             self.putx([1, ['Init']])
87         elif s == 'OK':
88             self.putx([0, ['Device acknowledged last command']])
89             self.putx([1, ['ACK']])
90         elif s.startswith('ERR'):
91             error = s[s.find('=') + 1:]
92             self.putx([0, ['Device sent error code ' + error]])
93             self.putx([1, ['ERR = ' + error]])
94         else:
95             self.putx([0, ['Device sent an unknown reply: %s' % s]])
96             self.putx([1, ['Unknown reply: %s' % s]])
97         self.cmd[rxtx] = ''
98
99     def decode(self, ss, es, data):
100         ptype, rxtx, pdata = data
101
102         # For now, ignore all UART packets except the actual data packets.
103         if ptype != 'DATA':
104             return
105
106         # If this is the start of a command/reply, remember the start sample.
107         if self.cmd[rxtx] == '':
108             self.ss_block = ss
109
110         # Append a new (ASCII) byte to the currently built/parsed command.
111         self.cmd[rxtx] += chr(pdata)
112
113         # Get packets/bytes until an \r\n sequence is found (end of command).
114         if self.cmd[rxtx][-1:] != '\n':
115             return
116
117         # Handle host commands and device replies.
118         # We remove trailing \r\n from the strings before handling them.
119         if rxtx == RX:
120             self.es_block = es
121             self.handle_device_reply(rxtx, self.cmd[rxtx][:-2])
122         elif rxtx == TX:
123             self.es_block = es
124             self.handle_host_command(rxtx, self.cmd[rxtx][:-2])
125         else:
126             raise Exception('Invalid rxtx value: %d' % rxtx)
127