]>
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 | ||
677d597b | 21 | import sigrokdecode as srd |
5cc2d7bb | 22 | |
d9c0d0a3 UH |
23 | # ... |
24 | RX = 0 | |
25 | TX = 1 | |
26 | ||
677d597b | 27 | class Decoder(srd.Decoder): |
12851357 | 28 | api_version = 2 |
5cc2d7bb | 29 | id = 'pan1321' |
3d3da57d UH |
30 | name = 'PAN1321' |
31 | longname = 'Panasonic PAN1321' | |
a465436e | 32 | desc = 'Bluetooth RF module with Serial Port Profile (SPP).' |
5cc2d7bb UH |
33 | license = 'gplv2+' |
34 | inputs = ['uart'] | |
35 | outputs = ['pan1321'] | |
da9bcbd9 BV |
36 | annotations = ( |
37 | ('text-verbose', 'Human-readable text (verbose)'), | |
38 | ('text', 'Human-readable text'), | |
39 | ('warnings', 'Human-readable warnings'), | |
40 | ) | |
5cc2d7bb UH |
41 | |
42 | def __init__(self, **kwargs): | |
5dd1c937 | 43 | self.cmd = ['', ''] |
f9b0356b | 44 | self.ss_block = None |
5cc2d7bb | 45 | |
8915b346 | 46 | def start(self): |
be465111 | 47 | self.out_ann = self.register(srd.OUTPUT_ANN) |
5cc2d7bb | 48 | |
f9b0356b UH |
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): | |
2d3f496e | 53 | if s.startswith('AT+JAAC'): |
84f33bc7 | 54 | # AT+JAAC=<auto_accept> (0 or 1) |
2d3f496e UH |
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'): | |
84f33bc7 | 63 | # AT+JPRO=<mode> (0 or 1) |
5b2b0b0d | 64 | p = s[s.find('=') + 1:] |
6bbd2a8a UH |
65 | if p not in ('0', '1'): |
66 | self.putx([2, ['Warning: Invalid JPRO parameter "%s"' % p]]) | |
6bbd2a8a | 67 | return |
5b2b0b0d UH |
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'): | |
84f33bc7 | 73 | # AT+JRES |
6bbd2a8a UH |
74 | if s != 'AT+JRES': # JRES has no params. |
75 | self.putx([2, ['Warning: Invalid JRES usage.']]) | |
6bbd2a8a | 76 | return |
5b2b0b0d UH |
77 | self.putx([0, ['Triggering a software reset']]) |
78 | self.putx([1, ['Reset']]) | |
b1f2d25f | 79 | elif s.startswith('AT+JSDA'): |
84f33bc7 UH |
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). | |
b1f2d25f UH |
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))]]) | |
84f33bc7 UH |
89 | # TODO: Warn if length > MTU size (which is firmware-dependent |
90 | # and is negotiated by both Bluetooth devices upon connection). | |
b1f2d25f UH |
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)]]) | |
5b2b0b0d | 94 | elif s.startswith('AT+JSEC'): |
84f33bc7 UH |
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. | |
fd4aa8aa | 103 | pin = s[-4:] |
5b2b0b0d | 104 | self.putx([0, ['Host set the Bluetooth PIN to "' + pin + '"']]) |
e1f5df5b | 105 | self.putx([1, ['PIN = ' + pin]]) |
5dd1c937 | 106 | elif s.startswith('AT+JSLN'): |
84f33bc7 UH |
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). | |
fd4aa8aa | 110 | name = s[s.find(',') + 1:] |
5b2b0b0d | 111 | self.putx([0, ['Host set the Bluetooth name to "' + name + '"']]) |
e1f5df5b | 112 | self.putx([1, ['BT name = ' + name]]) |
5dd1c937 | 113 | else: |
f9b0356b | 114 | self.putx([0, ['Host sent unsupported command: %s' % s]]) |
e1f5df5b | 115 | self.putx([1, ['Unsupported command: %s' % s]]) |
5dd1c937 | 116 | |
f9b0356b | 117 | def handle_device_reply(self, rxtx, s): |
fd4aa8aa | 118 | if s == 'ROK': |
f9b0356b | 119 | self.putx([0, ['Device initialized correctly']]) |
e1f5df5b | 120 | self.putx([1, ['Init']]) |
fd4aa8aa | 121 | elif s == 'OK': |
f9b0356b | 122 | self.putx([0, ['Device acknowledged last command']]) |
e1f5df5b | 123 | self.putx([1, ['ACK']]) |
5dd1c937 UH |
124 | elif s.startswith('ERR'): |
125 | error = s[s.find('=') + 1:] | |
f9b0356b | 126 | self.putx([0, ['Device sent error code ' + error]]) |
e1f5df5b | 127 | self.putx([1, ['ERR = ' + error]]) |
5dd1c937 | 128 | else: |
f9b0356b | 129 | self.putx([0, ['Device sent an unknown reply: %s' % s]]) |
e1f5df5b | 130 | self.putx([1, ['Unknown reply: %s' % s]]) |
5dd1c937 | 131 | |
5cc2d7bb | 132 | def decode(self, ss, es, data): |
d9c0d0a3 | 133 | ptype, rxtx, pdata = data |
5cc2d7bb UH |
134 | |
135 | # For now, ignore all UART packets except the actual data packets. | |
b9e44d1e | 136 | if ptype != 'DATA': |
5cc2d7bb UH |
137 | return |
138 | ||
f9b0356b UH |
139 | # If this is the start of a command/reply, remember the start sample. |
140 | if self.cmd[rxtx] == '': | |
141 | self.ss_block = ss | |
142 | ||
5dd1c937 UH |
143 | # Append a new (ASCII) byte to the currently built/parsed command. |
144 | self.cmd[rxtx] += chr(pdata) | |
5cc2d7bb UH |
145 | |
146 | # Get packets/bytes until an \r\n sequence is found (end of command). | |
72a6cad4 | 147 | if self.cmd[rxtx][-2:] != '\r\n': |
5cc2d7bb UH |
148 | return |
149 | ||
5dd1c937 | 150 | # Handle host commands and device replies. |
fd4aa8aa | 151 | # We remove trailing \r\n from the strings before handling them. |
db9ebbc2 | 152 | self.es_block = es |
5dd1c937 | 153 | if rxtx == RX: |
f9b0356b | 154 | self.handle_device_reply(rxtx, self.cmd[rxtx][:-2]) |
5dd1c937 | 155 | elif rxtx == TX: |
f9b0356b | 156 | self.handle_host_command(rxtx, self.cmd[rxtx][:-2]) |
5cc2d7bb | 157 | else: |
decde15e | 158 | raise Exception('Invalid rxtx value: %d' % rxtx) |
5cc2d7bb | 159 | |
db9ebbc2 UH |
160 | self.cmd[rxtx] = '' |
161 |