]>
Commit | Line | Data |
---|---|---|
5cc2d7bb | 1 | ## |
50bd5d25 | 2 | ## This file is part of the libsigrokdecode project. |
5cc2d7bb | 3 | ## |
5b2b0b0d | 4 | ## Copyright (C) 2012-2013 Uwe Hermann <uwe@hermann-uwe.de> |
5cc2d7bb UH |
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 | ||
5dd1c937 | 21 | # Panasonic PAN1321 Bluetooth module protocol decoder |
5cc2d7bb | 22 | |
677d597b | 23 | import sigrokdecode as srd |
5cc2d7bb | 24 | |
d9c0d0a3 UH |
25 | # ... |
26 | RX = 0 | |
27 | TX = 1 | |
28 | ||
677d597b | 29 | class Decoder(srd.Decoder): |
a2c2afd9 | 30 | api_version = 1 |
5cc2d7bb | 31 | id = 'pan1321' |
3d3da57d UH |
32 | name = 'PAN1321' |
33 | longname = 'Panasonic PAN1321' | |
a465436e | 34 | desc = 'Bluetooth RF module with Serial Port Profile (SPP).' |
5cc2d7bb UH |
35 | license = 'gplv2+' |
36 | inputs = ['uart'] | |
37 | outputs = ['pan1321'] | |
9a12a6e7 | 38 | probes = [] |
b77614bc | 39 | optional_probes = [] |
9a12a6e7 | 40 | options = {} |
e97b6ef5 | 41 | annotations = [ |
e1f5df5b | 42 | ['Text (verbose)', 'Human-readable text (verbose)'], |
ee3e279c | 43 | ['Text', 'Human-readable text'], |
6bbd2a8a | 44 | ['Warnings', 'Human-readable warnings'], |
5cc2d7bb UH |
45 | ] |
46 | ||
47 | def __init__(self, **kwargs): | |
5dd1c937 | 48 | self.cmd = ['', ''] |
f9b0356b | 49 | self.ss_block = None |
5cc2d7bb UH |
50 | |
51 | def start(self, metadata): | |
56202222 UH |
52 | # self.out_proto = self.add(srd.OUTPUT_PROTO, 'pan1321') |
53 | self.out_ann = self.add(srd.OUTPUT_ANN, 'pan1321') | |
5cc2d7bb UH |
54 | |
55 | def report(self): | |
56 | pass | |
57 | ||
f9b0356b UH |
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): | |
2d3f496e | 62 | if s.startswith('AT+JAAC'): |
84f33bc7 | 63 | # AT+JAAC=<auto_accept> (0 or 1) |
2d3f496e UH |
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'): | |
84f33bc7 | 72 | # AT+JPRO=<mode> (0 or 1) |
5b2b0b0d | 73 | p = s[s.find('=') + 1:] |
6bbd2a8a UH |
74 | if p not in ('0', '1'): |
75 | self.putx([2, ['Warning: Invalid JPRO parameter "%s"' % p]]) | |
6bbd2a8a | 76 | return |
5b2b0b0d UH |
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'): | |
84f33bc7 | 82 | # AT+JRES |
6bbd2a8a UH |
83 | if s != 'AT+JRES': # JRES has no params. |
84 | self.putx([2, ['Warning: Invalid JRES usage.']]) | |
6bbd2a8a | 85 | return |
5b2b0b0d UH |
86 | self.putx([0, ['Triggering a software reset']]) |
87 | self.putx([1, ['Reset']]) | |
b1f2d25f | 88 | elif s.startswith('AT+JSDA'): |
84f33bc7 UH |
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). | |
b1f2d25f UH |
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))]]) | |
84f33bc7 UH |
98 | # TODO: Warn if length > MTU size (which is firmware-dependent |
99 | # and is negotiated by both Bluetooth devices upon connection). | |
b1f2d25f UH |
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)]]) | |
5b2b0b0d | 103 | elif s.startswith('AT+JSEC'): |
84f33bc7 UH |
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. | |
fd4aa8aa | 112 | pin = s[-4:] |
5b2b0b0d | 113 | self.putx([0, ['Host set the Bluetooth PIN to "' + pin + '"']]) |
e1f5df5b | 114 | self.putx([1, ['PIN = ' + pin]]) |
5dd1c937 | 115 | elif s.startswith('AT+JSLN'): |
84f33bc7 UH |
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). | |
fd4aa8aa | 119 | name = s[s.find(',') + 1:] |
5b2b0b0d | 120 | self.putx([0, ['Host set the Bluetooth name to "' + name + '"']]) |
e1f5df5b | 121 | self.putx([1, ['BT name = ' + name]]) |
5dd1c937 | 122 | else: |
f9b0356b | 123 | self.putx([0, ['Host sent unsupported command: %s' % s]]) |
e1f5df5b | 124 | self.putx([1, ['Unsupported command: %s' % s]]) |
5dd1c937 | 125 | |
f9b0356b | 126 | def handle_device_reply(self, rxtx, s): |
fd4aa8aa | 127 | if s == 'ROK': |
f9b0356b | 128 | self.putx([0, ['Device initialized correctly']]) |
e1f5df5b | 129 | self.putx([1, ['Init']]) |
fd4aa8aa | 130 | elif s == 'OK': |
f9b0356b | 131 | self.putx([0, ['Device acknowledged last command']]) |
e1f5df5b | 132 | self.putx([1, ['ACK']]) |
5dd1c937 UH |
133 | elif s.startswith('ERR'): |
134 | error = s[s.find('=') + 1:] | |
f9b0356b | 135 | self.putx([0, ['Device sent error code ' + error]]) |
e1f5df5b | 136 | self.putx([1, ['ERR = ' + error]]) |
5dd1c937 | 137 | else: |
f9b0356b | 138 | self.putx([0, ['Device sent an unknown reply: %s' % s]]) |
e1f5df5b | 139 | self.putx([1, ['Unknown reply: %s' % s]]) |
5dd1c937 | 140 | |
5cc2d7bb | 141 | def decode(self, ss, es, data): |
d9c0d0a3 | 142 | ptype, rxtx, pdata = data |
5cc2d7bb UH |
143 | |
144 | # For now, ignore all UART packets except the actual data packets. | |
b9e44d1e | 145 | if ptype != 'DATA': |
5cc2d7bb UH |
146 | return |
147 | ||
f9b0356b UH |
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 | ||
5dd1c937 UH |
152 | # Append a new (ASCII) byte to the currently built/parsed command. |
153 | self.cmd[rxtx] += chr(pdata) | |
5cc2d7bb UH |
154 | |
155 | # Get packets/bytes until an \r\n sequence is found (end of command). | |
72a6cad4 | 156 | if self.cmd[rxtx][-2:] != '\r\n': |
5cc2d7bb UH |
157 | return |
158 | ||
5dd1c937 | 159 | # Handle host commands and device replies. |
fd4aa8aa | 160 | # We remove trailing \r\n from the strings before handling them. |
db9ebbc2 | 161 | self.es_block = es |
5dd1c937 | 162 | if rxtx == RX: |
f9b0356b | 163 | self.handle_device_reply(rxtx, self.cmd[rxtx][:-2]) |
5dd1c937 | 164 | elif rxtx == TX: |
f9b0356b | 165 | self.handle_host_command(rxtx, self.cmd[rxtx][:-2]) |
5cc2d7bb | 166 | else: |
decde15e | 167 | raise Exception('Invalid rxtx value: %d' % rxtx) |
5cc2d7bb | 168 | |
db9ebbc2 UH |
169 | self.cmd[rxtx] = '' |
170 |