]> git.donarmstrong.com Git - tmk_firmware.git/blob - protocol/iwrap/iWRAP4.txt
Fix rn42.h API
[tmk_firmware.git] / protocol / iwrap / iWRAP4.txt
1 Bulegiga WT12
2 =============
3 WT12 is a bluetooth module from Bluegiga. http://www.bluegiga.com/
4
5 iWRAP
6     higher layer interface for bluetooth firmware
7     communicate with UART
8
9 iWRAP HID
10 default setting
11     115200  8bit/n/1/n
12
13
14 TODO
15 ----
16 KiCAD circuit/PCB design
17 power saving
18     AVR sleep(15ms by watch dog timer)
19     WT12 sleep
20     measuring current consumption
21     measuring battery life of normal usage/idle/intensive usage
22 software reset/bootloarder
23 LED indicator(chaging/paring/connecting)
24 license confirmation of suart.c
25 consumer page is not working
26 authenticate method/SSP
27 SPP keyboard support
28 SPP debug console support
29 mouse wheel feature request to Bluegiga
30
31
32 Problems
33 --------
34 power consumption
35 no consumer page support(bug?)
36 no mouse wheel support
37 no paring management
38 no interactive auth method
39
40
41 UART hardware flow control
42 --------------------------
43 (iWRAP4 User Guide 9.5)
44 Hardware flow control is enabled by default and it should not be disabled unless mandatory, because without the hardware flow control the data transmission may not be reliable.
45 If the hardware flow control is enabled from PS-keys, but no flow control is used, the following steps should be implemented in the hardware design:
46 - CTS pin must be grounded
47 - RTS pin must be left floating
48
49
50 Power Saving
51 ------------
52 power consume
53     without opimization: 4hr to shutdown(310mAh)
54     2011/08/25: 9hr(310mAh) SNIFF MASTER sleep/WDTO_120MS
55
56 measure current consumption
57     HHKB keyswitch matrix board
58         idle
59         scanning
60     Bluegiga WT12 module
61         SLEEP command
62         deep sleep on/off in config bits
63
64 HHKB keyswich
65     how to power off
66         I/O pin configuration when sleeping
67         FET switch for 5V regulator
68
69 Bluetooth module
70     power off when in USB mode
71     power off by FET switch
72
73 AVR configuration
74     unused pins
75     ADC
76     
77
78
79 SET CONTROL CONFIG
80 ------------------
81     SET CONTROL CONFIG 4810
82     SET CONTROL CONFIG LIST
83     SET CONTROL CONFIG 0000 0000 4910 DEEP_SLEEP KLUDGE INTERACTIVE_PIN UART_LATENCY
84
85     Bit14   UART low latency
86     Bit11   Interactive pairing mode
87     Bit04   Deep sleep
88
89
90 Reconnection
91 ------------
92 SET CONTROL AUTOCALL 1124 5000 HID
93     1124    HID service class
94     5000    interval ms
95
96 HID profile
97 -----------
98 This is needed to configure only once.
99     SET PROFILE HID ON
100     RESET
101
102 HID class
103 ---------
104     SET BT CLASS 005C0  // keyboard/mouse combined devie
105
106 Pairing Security
107 ----------------
108 Secure Simple Pairing(SSP)
109     SET BT SSP 2 0  // Enables SSP for keyboard and Man-in-the-middle protection
110     SET BT SSP 3 0  // Enables SSP just works mode
111
112 for keyboard with SSP
113     SET BT AUTH * 0000
114     SET BT SSP 2 0
115     SET CONTROL CONFIG 800
116     RESET
117
118 for keyboard without SSP
119     SET BT AUTH * 0000
120     SET CONTROL CONFIG 800
121     RESET
122
123 AUTH
124     AUTH xx:xx:xx:xx:xx:xx?         // Pairing request event
125     AUTH xx:xx:xx:xx:xx:xx  0000
126
127     SSP PASSKEY 78:dd:08:b7:e4:a2 ?
128     SSP PASSKEY 78:dd:08:b7:e4:a2 xxxxx
129     (SSP COMPLETE 78:dd:08:b7:e4:a2 HCI_ERROR_AUTH_FAIL     // failed)
130     RING 0 78:dd:08:b7:e4:a2 11 HID
131
132 Connecton
133     RING xx:xx:xx:xx:xx:xx xx HID   // connection event
134
135     KILL xx:xx:xx:xx:xx:xx
136
137 Mode
138 ----
139 Command mode
140 Data mode
141     Raw mode
142     (Simple mode         not for a real keyboard)
143
144 Raw mode
145     Keyboard:
146     0x9f, length(10), 0xa1, 0x01, mods, 0x00, key1, key2, key3, key4, key5, key6
147
148     Mouse:
149     0x9f, length(5), 0xa1, 0x02, buttons, X, Y
150
151     Consumer page:
152     0x9f, length(5), 0xa1, 0x03, bitfield1, bitfield2, bitfield3
153
154     consumer page suage
155     Bitfield 1:
156         0x01 Volume Increment
157         0x02 Volume Decrement
158         0x04 Mute
159         0x08 Play/Pause
160         0x10 Scan Next Track
161         0x20 Scan Previous Track
162         0x40 Stop
163         0x80 Eject
164     Bitfield 2:
165         0x01 Email Reader
166         0x02 Application Control Search
167         0x04 AC Bookmarks
168         0x08 AC Home
169         0x10 AC Back
170         0x20 AC Forward
171         0x40 AC Stop
172         0x80 AC Refresh
173     Bitfield 3:
174         0x01 Application Launch Generic Consumer Control
175         0x02 AL Internet Browser
176         0x04 AL Calculator
177         0x08 AL Terminal Lock / Screensaver
178         0x10 AL Local Machine Browser
179         0x20 AC Minimize
180         0x40 Record
181         0x80 Rewind
182
183
184
185
186
187 2011/07/13
188 set
189 SET BT BDADDR 00:07:80:47:22:14
190 SET BT NAME HHKB pro BT
191 SET BT CLASS 0005c0
192 SET BT AUTH * 0000
193 SET BT IDENT BT:47 f000 4.1.0 Bluegiga iWRAP
194 SET BT LAP 9e8b33
195 SET BT PAGEMODE 4 2000 1
196 SET BT PAIR 78:dd:08:b7:e4:a2 a191189cd7e51030ad6a07848ce879bb
197 SET BT POWER 3 3 3
198 SET BT ROLE 0 f 7d00
199 SET BT SNIFF 0 20 1 8
200 SET BT SSP 2 1
201 SET BT MTU 667
202 SET CONTROL AUTOCALL 1124 3000 HID
203 SET CONTROL BAUD 38400,8n1
204 SET CONTROL CD 00 0
205 SET CONTROL ECHO 7
206 SET CONTROL ESCAPE 43 00 1
207 SET CONTROL GAIN 0 5
208 SET CONTROL INIT SET CONTROL MUX 0
209 SET CONTROL MSC DTE 00 00 00 00 00 00
210 SET CONTROL MUX 1
211 SET CONTROL PIO 00 00
212 SET CONTROL READY 00
213 SET PROFILE HID f HID
214 SET
215
216 info config
217
218 !!! THIS IS BETA RELEASE AND MAY BE USED FOR EVALUATION PURPOSES ONLY !!!
219
220 WRAP THOR AI (4.1.0 build 435)
221 Copyright (c) 2003-2011 Bluegiga Technologies Inc.
222 Compiled on Jun 28 2011 17:19:51, running on WT12-A module, psr v31
223         AVRCP BGIO FTP HFP HFP_AG HID HID_CONSUMER_PAGE HSP LEDS MAP OTA PBAP PIO=0x00fc SSP SUBRATE TEST VOLUME
224         - BOCK3 version 435 (Jun 28 2011 17:19:37) (max acl/sco 7/1)
225         - Bluetooth version 2.1, Power class 2
226         - Loader 4279, firmware 6297 (56-bit encryption), native execution mode
227         - up 0 days, 06:23, 2 connections (pool 2)
228         - User configuration:
229 &028a = 0001 0000 0000 0011 0024 0000 0000 0010 0000 0080 0000 0000 0080 005f 009b 0034 00fb 0006
230 &028b = 0000 0bb8
231 &028d = 0001
232 &0295 = 0000 0005 000b 0000 0003 0000 0000 0000 0000 0000 0000
233 &0298 = a006
234 &0299 = 0000 0000
235 &02a3 = 0030 0030 0030 0030
236 &02a4 = 009d 0000
237 &02a5 = 0053 0045 0054 0020 0043 004f 004e 0054 0052 004f 004c 0020 004d 0055 0058 0020 0030
238 &02a7 = 0000 05c0
239 &02a8 = 4910 0000 0000
240 &02aa = 0004 2000 0001 0033 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000 0000
241 &02ac = 0000 0000 002b 0000 0000 0000 0000 0000 0000 0000 0002 0000 0000 0000 0010 0000 0000 0000 0000 029b 0000 0000 0000 0000
242 &02ad = 4848 424b 7020 6f72 4220 0054
243 &02b3 = 0005 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003
244 &02b7 = 000f 4948 0044
245 &02bb = 8000
246 READY.
247
248
249
250
251 2011/07/07 settings:
252 set
253 SET BT BDADDR 00:07:80:47:22:14
254 SET BT NAME HHKB Pro BT
255 SET BT CLASS 0005c0
256 SET BT AUTH * 000
257 SET BT IDENT BT:47 f000 4.0.0 Bluegiga iWRAP
258 SET BT LAP 9e8b33
259 SET BT PAGEMODE 4 2000 1
260 SET BT PAIR 78:dd:08:b7:e4:a2 9e54d0aabb1b4d73cfccddb1ea4ef2d6
261 SET BT POWER 3 3 3
262 SET BT ROLE 0 f 7d00
263 SET BT SNIFF 0 20 1 8
264 SET BT SSP 3 0
265 SET BT MTU 667
266 SET CONTROL BAUD 38400,8n1
267 SET CONTROL CD 00 0
268 SET CONTROL ECHO 7
269 SET CONTROL ESCAPE 255 00 1
270 SET CONTROL GAIN 0 5
271 SET CONTROL INIT set control mux 0
272 SET CONTROL MSC DTE 00 00 00 00 00 00
273 SET CONTROL PREAMP 1 1
274 SET CONTROL READY 00
275 SET PROFILE HID HID
276 SET PROFILE SPP Bluetooth Serial Port
277 SET
278
279 info config
280 WRAP THOR AI (4.0.0 build 317)
281 Copyright (c) 2003-2010 Bluegiga Technologies Inc.
282 Compiled on Apr 20 2010 16:44:28, running on WT12-A module, psr v31
283         AVRCP FTP PBAP PIO=0x00fc SSP SUBRATE VOLUME
284         - BOCK3 version 317 (Apr 20 2010 16:44:21) (max acl/sco 7/1)
285         - Bluetooth version 2.1, Power class 2
286         - Loader 4279, firmware 6297 (56-bit encryption), native execution mode
287         - up 0 days, 00:00, 0 connections (pool 1)
288         - User configuration:
289 &028c = 0001 0020 0000 0001 0008 0000
290 &028d = 0000
291 &0296 = 0047 0001 f000 0400 6c42 6575 6967 6167 6920 5257 5041
292 &0298 = c006
293 &02a3 = 0030 0030 0030
294 &02a4 = 009d 0000
295 &02a5 = 0073 0065 0074 0020 0063 006f 006e 0074 0072 006f 006c 0020 006d 0075 0078 0020 0030
296 &02a7 = 0000 05c0
297 &02a8 = 0800 0000 0000
298 &02ac = 0000 0000 00ff 0000 0000 0000 0000 0000 0000 0000 0002 0000 0000 0000 0010 0000 0000 0000 0000 029b 0000 0000 0000 0000
299 &02ad = 4848 424b 5020 6f72 4220 0054
300 &02b3 = 0004 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003 0003
301 &02b7 = 0000
302 &02bb = 6c42 6575 6f74 746f 2068 6553 6972 6c61 5020 726f 0074
303 READY.
304
305
306
307 2011/08/23:
308 SET BT BDADDR 00:07:80:47:22:14
309 SET BT NAME HHKB pro BT
310 SET BT CLASS 0005c0
311 SET BT AUTH * 0000
312 SET BT IDENT BT:47 f000 4.1.0 Bluegiga iWRAP
313 SET BT LAP 9e8b33
314 SET BT PAGEMODE 4 2000 1
315 SET BT PAIRCOUNT 4
316 SET BT POWER 3 3 3
317 SET BT ROLE 1 f 12c0
318 SET BT SNIFF 10 2 1 8
319 SET BT SSP 3 0
320 SET BT MTU 667
321 SET CONTROL BAUD 38400,8n1
322 SET CONTROL CD 00 0
323 SET CONTROL ECHO 7
324 SET CONTROL ESCAPE 43 00 1
325 SET CONTROL GAIN 0 5
326 SET CONTROL INIT SET CONTROL MUX 0
327 SET CONTROL MSC DTE 00 00 00 00 00 00
328 SET CONTROL MUX 1
329 SET CONTROL PIO 00 00
330 SET CONTROL READY 00
331 SET PROFILE HID 7 HIDKeyboardMouse
332 SET
333
334 SET CONTROL CONFIG 0000 0004 481e CLOCK_CACHE INTERLACED_INQ INTERLACED_PAGE DEEP_SLEEP INTERACTIVE_PIN UART_LATENCY 23D_NOKLUDGE
335
336
337
338 2011/08/25:
339 SET BT BDADDR 00:07:80:47:22:14
340 SET BT NAME HHKB pro BT
341 SET BT CLASS 0005c0
342
343 SET BT IDENT BT:47 f000 4.1.0 Bluegiga iWRAP
344 SET BT LAP 9e8b33
345 SET BT PAGEMODE 4 2000 1
346 SET BT PAIRCOUNT 4
347 SET BT PAIR 78:dd:08:b7:e4:a2 0be83335a03fed8ededae42e99554e28
348 SET BT POWER 3 3 3
349 SET BT ROLE 1 f 12c0
350 SET BT SNIFF 100 20 1 8
351 SET BT SSP 3 0
352 SET BT MTU 667
353 SET CONTROL BAUD 38400,8n1
354 SET CONTROL CD 00 0
355 SET CONTROL ECHO 7
356 SET CONTROL ESCAPE - 20 1
357 SET CONTROL GAIN 0 5
358 SET CONTROL INIT SET CONTROL MUX 0
359 SET CONTROL MSC DTE 00 00 00 00 00 00
360 SET CONTROL MUX 1
361 SET CONTROL PIO 00 00
362 SET CONTROL READY 00
363 SET PROFILE HID f HIDKeyboardMouse
364 SET
365
366
367 SET CONTROL CONFIG 0000 0000 490e CLOCK_CACHE INTERLACED_INQ INTERLACED_PAGE KLUDGE INTERACTIVE_PIN UART_LATENCY
368
369
370 2011/09/08:
371 SET CONTROL CONFIG 0000 0000 410e CLOCK_CACHE INTERLACED_INQ INTERLACED_PAGE KLUDGE UART_LATENCY
372
373     Removed INTERACTIVE_PIN to avoid interactive auth and use SET BT AUTH pin(0000).
374
375
376 EOF