a8938c60f6bd961f6972bf275be58004d75de025
[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 import sigrokdecode as srd
22
23 # ...
24 RX = 0
25 TX = 1
26
27 class Decoder(srd.Decoder):
28     api_version = 2
29     id = 'pan1321'
30     name = 'PAN1321'
31     longname = 'Panasonic PAN1321'
32     desc = 'Bluetooth RF module with Serial Port Profile (SPP).'
33     license = 'gplv2+'
34     inputs = ['uart']
35     outputs = ['pan1321']
36     annotations = (
37         ('text-verbose', 'Human-readable text (verbose)'),
38         ('text', 'Human-readable text'),
39         ('warnings', 'Human-readable warnings'),
40     )
41
42     def __init__(self):
43         self.cmd = ['', '']
44         self.ss_block = None
45
46     def start(self):
47         self.out_ann = self.register(srd.OUTPUT_ANN)
48
49     def putx(self, data):
50         self.put(self.ss_block, self.es_block, self.out_ann, data)
51
52     def handle_host_command(self, rxtx, s):
53         if s.startswith('AT+JAAC'):
54             # AT+JAAC=<auto_accept> (0 or 1)
55             p = s[s.find('=') + 1:]
56             if p not in ('0', '1'):
57                 self.putx([2, ['Warning: Invalid JAAC parameter "%s"' % p]])
58                 return
59             x = 'Auto' if (p == '1') else 'Don\'t auto'
60             self.putx([0, ['%s-accept new connections' % x]])
61             self.putx([1, ['%s-accept connections' % x]])
62         elif s.startswith('AT+JPRO'):
63             # AT+JPRO=<mode> (0 or 1)
64             p = s[s.find('=') + 1:]
65             if p not in ('0', '1'):
66                 self.putx([2, ['Warning: Invalid JPRO parameter "%s"' % p]])
67                 return
68             onoff = 'off' if (p == '0') else 'on'
69             x = 'Leaving' if (p == '0') else 'Entering'
70             self.putx([0, ['%s production mode' % x]])
71             self.putx([1, ['Production mode = %s' % onoff]])
72         elif s.startswith('AT+JRES'):
73             # AT+JRES
74             if s != 'AT+JRES': # JRES has no params.
75                 self.putx([2, ['Warning: Invalid JRES usage.']])
76                 return
77             self.putx([0, ['Triggering a software reset']])
78             self.putx([1, ['Reset']])
79         elif s.startswith('AT+JSDA'):
80             # AT+JSDA=<l>,<d> (l: length in bytes, d: data)
81             # l is (max?) 3 decimal digits and ranges from 1 to MTU size.
82             # Data can be ASCII or binary values (l bytes total).
83             l, d = s[s.find('=') + 1:].split(',')
84             if not l.isnumeric():
85                 self.putx([2, ['Warning: Invalid data length "%s".' % l]])
86             if int(l) != len(d):
87                 self.putx([2, ['Warning: Data length mismatch (%d != %d).' % \
88                           (int(l), len(d))]])
89             # TODO: Warn if length > MTU size (which is firmware-dependent
90             # and is negotiated by both Bluetooth devices upon connection).
91             b = ''.join(['%02x ' % ord(c) for c in d])[:-1]
92             self.putx([0, ['Sending %d data bytes: %s' % (int(l), b)]])
93             self.putx([1, ['Send %d = %s' % (int(l), b)]])
94         elif s.startswith('AT+JSEC'):
95             # AT+JSEC=<secmode>,<linkkey_info>,<pintype>,<pinlen>,<pin>
96             # secmode: Security mode 1 or 3 (default).
97             # linkkey_info: Must be 1 or 2. Has no function according to docs.
98             # pintype: 1: variable pin (default), 2: fixed pin.
99             # pinlen: PIN length (2 decimal digits). Max. PIN length is 16.
100             # pin: The Bluetooth PIN ('pinlen' chars). Used if pintype=2.
101             # Note: AT+JSEC (if used) must be the first command after reset.
102             # TODO: Parse all the other parameters.
103             pin = s[-4:]
104             self.putx([0, ['Host set the Bluetooth PIN to "' + pin + '"']])
105             self.putx([1, ['PIN = ' + pin]])
106         elif s.startswith('AT+JSLN'):
107             # AT+JSLN=<namelen>,<name>
108             # namelen: Friendly name length (2 decimal digits). Max. len is 18.
109             # name: The Bluetooth "friendly name" ('namelen' ASCII characters).
110             name = s[s.find(',') + 1:]
111             self.putx([0, ['Host set the Bluetooth name to "' + name + '"']])
112             self.putx([1, ['BT name = ' + name]])
113         else:
114             self.putx([0, ['Host sent unsupported command: %s' % s]])
115             self.putx([1, ['Unsupported command: %s' % s]])
116
117     def handle_device_reply(self, rxtx, s):
118         if s == 'ROK':
119             self.putx([0, ['Device initialized correctly']])
120             self.putx([1, ['Init']])
121         elif s == 'OK':
122             self.putx([0, ['Device acknowledged last command']])
123             self.putx([1, ['ACK']])
124         elif s.startswith('ERR'):
125             error = s[s.find('=') + 1:]
126             self.putx([0, ['Device sent error code ' + error]])
127             self.putx([1, ['ERR = ' + error]])
128         else:
129             self.putx([0, ['Device sent an unknown reply: %s' % s]])
130             self.putx([1, ['Unknown reply: %s' % s]])
131
132     def decode(self, ss, es, data):
133         ptype, rxtx, pdata = data
134
135         # For now, ignore all UART packets except the actual data packets.
136         if ptype != 'DATA':
137             return
138
139         # We're only interested in the byte value (not individual bits).
140         pdata = pdata[0]
141
142         # If this is the start of a command/reply, remember the start sample.
143         if self.cmd[rxtx] == '':
144             self.ss_block = ss
145
146         # Append a new (ASCII) byte to the currently built/parsed command.
147         self.cmd[rxtx] += chr(pdata)
148
149         # Get packets/bytes until an \r\n sequence is found (end of command).
150         if self.cmd[rxtx][-2:] != '\r\n':
151             return
152
153         # Handle host commands and device replies.
154         # We remove trailing \r\n from the strings before handling them.
155         self.es_block = es
156         if rxtx == RX:
157             self.handle_device_reply(rxtx, self.cmd[rxtx][:-2])
158         elif rxtx == TX:
159             self.handle_host_command(rxtx, self.cmd[rxtx][:-2])
160
161         self.cmd[rxtx] = ''