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