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