User manual

ManualsBrandsCODE MERCENARIES ManualsDev KitsPCB design board KeyWarrior24-8-MOD

Code Mercenaries

1. Features

• USB low speed interface

• Full USB V1.1/2.0 compliance

• Full USB HID 1.1 compliance

• 64 keys in 8x8 matrix or three incremental

encoders and 9 keys

• Media control and application keys supported

• Two function shift keys to switch to a second

and third key table

• Up to 34 macros with up to 31 keys each

• Factory programmed keyboard layout

• Custom chips for volume production

• Support for Caps lock, Num lock and Scroll

lock LEDs on matrix chips

• Single +5V power supply

• Low power consumption: 40mA max.

• Available in 24 pin DIL and SOIC

1.1 Variants

KeyWarrior24 are available in three factory

programmed versions with a fixed keyboard

layout.

KeyWarrior24-8 and KeyWarrior24-8M support a

8x8 key matrix.

KeyWarrior24-8 is preprogrammed with general

keyboard layouts.

KeyWarrior24-8M is preprogrammed with media

control keys like "Mute", "Play/Pause" etc. and

general keyboard layouts.

KeyWarrior24-S3 supports nine direct connected

keys and three incremental encoders to produce

key strokes from jog wheels and similar devices.

KeyWarrior24-S3 is preprogammed with media

controls and other keys typically used for jog

wheels.

Custom variants are available for production

volumes.

KeyWarrior24-8

• Supports up to 64 keys in 8x8 matrix

• Preprogrammed with three layouts for general

use, POS, and gaming

• Support for Caps lock, Num lock and Scroll

lock LEDs

• Supports diodes in the key matrix

KeyWarrior24-8M

• Supports up to 64 keys in 8x8 matrix

• Preprogrammed with three layouts for media

control and general use

• Supports Mute, Eject, Play/Pause, Forward,

Backward,

• Support for Caps lock, Num lock and Scroll

lock LEDs

• Supports diodes in the key matrix

KeyWarrior24-S3

• Supports three incremental encoders

• Encoder pulses turned into key strokes

• Supports nine direct connected keys

• Supports Mute, Eject, Play/Pause, Forward,

Backward,

• Preprogrammed for media control and general

use

2. Functional Overview

KeyWarrior24 is a low cost variant of the

KeyWarrior family. It is primarily designed to

reduce hardware requirements and costs for

smaller keyboard designs that don't need the

complexity of the main KeyWarrior family line.

KeyWarrior24 supports USB only and uses a

factory programmed keyboard layout. This reduces

the external circuitry to almost zero.

The standard KeyWarrior24 chips are available as

off the shelf standard parts with a fixed keyboard

layout. For production volumes (>100) it is

possible to order KeyWarrior24 with a custom key

layout, including up to 34 macros.

KeyWarrior24 implements the KeyWarrior

Commander macro function, restricting the number

of macros to 34 (instead of 48), while retaining all

the other options, like using up to 31 keycodes per

macro and assigning each of the macros to any of

the 64 keys or three encoders and nine keys and

any of the three FN-levels.

V 1.1.2, December 2nd 2013, for chip revision 1.1.1.4/1.1.1.B and up

Summary of content (28 pages)

PAGE 1
KeyWarrior24 Fixed Program USB Keyboard Controller Family Supplement to the KeyWarrior Data Sheet Code Mercenaries 1. Features • USB low speed interface • Full USB V1.1/2.0 compliance • Full USB HID 1.
PAGE 2
KeyWarrior24 Code Mercenaries 3.
PAGE 3
Code Mercenaries KeyWarrior24 4. Pin Descriptions KeyWarrior24-8/KeyWarrior24-8M Name I/O Type Pins Description D+, DY0, Y1, Y2, Y3, Y4, Y5, Y6, Y7 I/O O special open drain outputs 16, 15 1, 2, 3, 4, 24, 23, 22, 21 USB differential data lines Y lines for key matrix. These lines are periodically pulled low, between matrix scan they are high impedance.
PAGE 4
Code Mercenaries KeyWarrior24 4 Pin Descriptions 4.2 Pin Descriptions KeyWarrior24-8/KeyWarrior24-8M KeyWarrior24-S3 Name I/O Type Pins Description D+, DA0, B0, A1, B1, A2, B2 I/O I special inputs with internal pull ups 16, 15 1, 2, 3, 4, 24, 23, 22, 21 USB differential data lines A, B inputs for three encoders Sw0..
PAGE 5
Code Mercenaries KeyWarrior24 5. Device Operation KeyWarrior24 registers as a standard HID keyboard and supports boot protocol. It does not need any special drivers to be installed, standard system drivers are sufficient. The country code is 0 for not localized hardware, which allows to use a single version of the chip for all international keyboard layouts.
PAGE 6
KeyWarrior24 Code Mercenaries 5.6 Macros KeyWarrior24 supports the KeyWarrior Commander type macros. Up to 34 macros can be defined for custom controllers. Each macro can contain up to 31 key codes and can work either in a typing mode or stable mode. For more information on the macros please refer to the document "Creating Custom KeyWarrior Scancode Tables". 5.7 Media Control and Application Keys KeyWarrior24 supports the most commonly used subset of the USB HID class usage page $0C (Consumer Controls).
PAGE 7
Code Mercenaries KeyWarrior24 6. Key Tables of the Standard KeyWarrior24 Chips The standard layouts of the KeyWarrior24 chips are intended to be used as fixed selections set by hard wiring the corresponding FN key coordinate, not as optional layouts to be selected by an actual FN key. 6.
PAGE 8
Code Mercenaries KeyWarrior24-8 6.1.1 KeyWarrior24-8 Table with no FN key pressed / USB Usage Codes X0 X1 X2 X3 X4 X5 X6 X7 Y0 $24 $25 $26 $04 $05 $06 $07 $08 Y1 $21 $22 $23 $09 $0A $0B $0C $0D Y2 $1E $1F $20 $0E $0F $10 $11 $12 Y3 $2D $27 $2E $13 $14 $15 $16 $17 Y4 $36 $37 $38 $18 $19 $1A $1B $1C Y5 $30 $52 $31 $1D $2C $35 $E2 $E6 Y6 $50 $51 $4F $2F $33 $34 $E0 $64 Y7 FN1 FN2 $2B $2A $39 $29 $E1 $28 V 1.1.
PAGE 9
Code Mercenaries KeyWarrior24-8 6.1.2 KeyWarrior24-8 Table with FN1 key pressed Layout for hex, special function, or POS keyboard. X0 X1 num X2 X3 X4 X5 X6 X7 X5 X6 X7 num/ num* num- A F1 F2 F3 Y1 num7 num8 num9 num+ B F4 F5 F6 Y2 num4 num5 num6 Enter C F7 F8 F9 Y3 num1 num2 num3 num= D F10 F11 F12 Y4 num0 space num.
PAGE 10
Code Mercenaries KeyWarrior24-8 6.1.
PAGE 11
Code Mercenaries KeyWarrior24-8 6.1.4 KeyWarrior24-8 Table with FN2 key pressed Special layout for gaming and other applications. X0 X1 X2 X3 X4 X5 X6 X0 X1 X2 X3 X4 X5 Y0 1! 2@ 3# esc num num/ num* num- Y1 4$ 5% 6^ §± num7 num8 num9 num+ Y2 7& 8* 9( -_ num4 num5 num6 Enter Y3 0) tab del =+ num1 num2 num3 num. Y4 Q W E R T pause up num0 Y5 A S D F G left down right Y6 Z X C V B .
PAGE 12
Code Mercenaries KeyWarrior24-8 6.1.5 KeyWarrior24-8 Table with FN2 key pressed / USB Usage Codes X0 X1 X2 X3 X4 X5 X6 X7 Y0 $1E $1F $20 $29 $53 $54 $55 $56 Y1 $21 $22 $23 $35 $5F $60 $61 $57 Y2 $24 $25 $26 $2D $5C $5D $5E $58 Y3 $27 $2B $2A $2E $59 $5A $5B $63 Y4 $14 $1A $08 $15 $17 $48 $52 $62 Y5 $04 $16 $07 $09 $0A $50 $51 $4F Y6 $1D $1B $06 $19 $05 $37 $38 $2C Y7 FN1 FN2 $E1 $E0 $E2 $E6 $E4 $E5 V 1.1.
PAGE 13
Code Mercenaries KeyWarrior24 6.2 KeyWarrior24-8M Table with no FN key pressed Media control layout X0 Y0 Y1 Y2 eject X1 vol + X2 X3 X5 X6 X7 vol - play/ next mute pause track prev track fast fwd start start rewind stop brwsr.
PAGE 14
Code Mercenaries KeyWarrior24-8 6.2.
PAGE 15
Code Mercenaries KeyWarrior24-8 6.2.2 KeyWarrior24-8M Table with FN1 key pressed Layout for general use. X0 X1 X2 X3 X4 X5 X6 X7 X0 X1 X2 X3 X4 X5 X6 X7 Y0 7& 8* 9( A B C D E Y1 4$ 5% 6^ F G H I J Y2 1! 2@ 3# K L M N O Y3 -_ 0) =+ P Q R S T Y4 ,< .
PAGE 16
Code Mercenaries KeyWarrior24-8 6.2.3 KeyWarrior24-8M Table with FN1 key pressed / USB Usage Codes X0 X1 X2 X3 X4 X5 X6 X7 Y0 $24 $25 $26 $04 $05 $06 $07 $08 Y1 $21 $22 $23 $09 $0A $0B $0C $0D Y2 $1E $1F $20 $0E $0F $10 $11 $12 Y3 $2D $27 $2E $13 $14 $15 $16 $17 Y4 $36 $37 $38 $18 $19 $1A $1B $1C Y5 $30 $52 $31 $1D $2C $35 $E2 $E6 Y6 $50 $51 $4F $2F $33 $34 $E0 $64 Y7 FN1 FN2 $2B $2A $39 $29 $E1 $28 V 1.1.
PAGE 17
Code Mercenaries KeyWarrior24-8 6.2.4 KeyWarrior24-8M Table with FN2 key pressed Special layout for gaming and other applications. X0 X1 X2 X3 X4 X5 X6 X0 X1 X2 X3 X4 X5 Y0 1! 2@ 3# esc num num/ num* num- Y1 4$ 5% 6^ §± num7 num8 num9 num+ Y2 7& 8* 9( -_ num4 num5 num6 Enter Y3 0) tab del =+ num1 num2 num3 num. Y4 Q W E R T pause up num0 Y5 A S D F G left down right Y6 Z X C V B .
PAGE 18
Code Mercenaries KeyWarrior24-8 6.2.5 KeyWarrior24-8M Table with FN2 key pressed / USB Usage Codes X0 X1 X2 X3 X4 X5 X6 X7 Y0 $1E $1F $20 $29 $53 $54 $55 $56 Y1 $21 $22 $23 $35 $5F $60 $61 $57 Y2 $24 $25 $26 $2D $5C $5D $5E $58 Y3 $27 $2B $2A $2E $59 $5A $5B $63 Y4 $14 $1A $08 $15 $17 $48 $52 $62 Y5 $04 $16 $07 $09 $0A $50 $51 $4F Y6 $1D $1B $06 $19 $05 $37 $38 $2C Y7 FN1 FN2 $E1 $E0 $E2 $E6 $E4 $E5 V 1.1.
PAGE 19
Code Mercenaries KeyWarrior24-8 6.3 KeyWarrior24-S3 Table with no FN key pressed For simplicity of handling KW24S3 uses the same data format for storing the key table as the other KW24 variants. Though only the first two bytes of each level are used. The first line that usually holds the keys for the Y0 line does contain the codes for Sw0..7. In the second line, usually for Y1, the first six bytes contain the codes for the encoders, byte 7 is unused, byte 8 holds the code for Sw8.
PAGE 20
Code Mercenaries KeyWarrior24-8 6.3.2 KeyWarrior24-S3 Table with FN1 key pressed Sw0 Sw1 Sw2 Sw3 Sw4 Sw5 Sw6 Sw7 Y0 bksp numreturn enter space ins del B0=0 B0=1 B1=0 B1=1 B2=0 B2=1 Y1 tab shfttab num + num - 1 2 esc FN1 - Sw8 - FN2 6.3.3 KeyWarrior24-S3 Table with FN1 key pressed / USB Usage Codes Sw0 Sw1 Sw2 Sw3 Sw4 Sw5 Sw6 Sw7 Y0 $2A $28 $58 $2C $49 $4C B0=0 B0=1 B1=0 B1=1 B2=0 B2=1 Y1 $2B $E1 $2B $57 $56 V 1.1.0, May xxx 2011, for chip revision 1.1.1.
PAGE 21
Code Mercenaries KeyWarrior24-8 6.3.4 KeyWarrior24-S3 Table with FN2 key pressed This layout generates medial control and application control keys Sw0 Sw1 Sw2 Sw3 Sw4 Sw5 Sw6 Sw7 Y0 eject play/ mute pause stop fast fwd rewind space B0=0 B0=1 B1=0 B1=1 B2=0 B2=1 Y1 vol + vol - next track prev track fast fwd rewind FN1 - Sw8 - FN2 6.3.
PAGE 22
Code Mercenaries KeyWarrior24 7.
PAGE 23
KeyWarrior24 Code Mercenaries 7.2 Absolute Maximum Ratings Storage Temperature Ambient Operating Temperature Supply Voltage on Vcc relative to Vss DC Input Voltage Max. Output Current into any Pin Power Dissipation Static Discharge Voltage Latch-up Current V 1.1.2, December 2nd 2013, for chip revision 1.1.1.4/1.1.1.B and up -65°C to +150°C 0°C to +70°C -0.5V to +7.0V -0.5V + Vcc + 0.
PAGE 24
Code Mercenaries KeyWarrior24 8.
PAGE 25
KeyWarrior24 Code Mercenaries 9 Typical Application for KeyWarrior24-8/KeyWarrior24-8M R2...7 and T1...3 are only required if lock LEDs are used. V 1.1.2, December 2nd 2013, for chip revision 1.1.1.4/1.1.1.
PAGE 26
1 +5V 2 D3 D+ 4 GND V 1.1.0, May xxx 2011, for chip revision 1.1.1.4 DRAFT! Vss Vpp Sw7 Sw6 Sw5 Sw4 Sw3 Sw2 Sw1 Sw0 17 8 18 7 19 6 20 5 21 22 23 24 4 3 2 1 Close J1 to set full pulse resolution for encoders 15 16 D D+ VREG Full /EN Sw8 B2 A2 B1 A1 B0 A0 C2 10μF C i r c u i t : KeyWarrior24S3 V e r s i o n : 1.1 Date: 25.10.2011 Drawn by: Function: Page: Rev. Date By Change 1K3 R1 11 12 KeyWarrior24S3 Vcc 10 USB J1 NC 9 13 14 +5V B B Sign.
PAGE 27
KeyWarrior24 Code Mercenaries 10 Package Dimensions 24 Pin DIL 24 Pin SOIC V 1.1.2, December 2nd 2013, for chip revision 1.1.1.4/1.1.1.
PAGE 28
Code Mercenaries KeyWarrior24 11. ESD Considerations KeyWarrior has an internal ESD protection to withstand discharges of more than 2000V without permanent damage. However ESD may disrupt normal operation of the chip and cause it to exhibit erratic behaviour. For the typical office environment the 2000V protection is normally sufficient. Though for industrial use additional measures may be necessary. When adding ESD protection to the signals special care must be taken on the USB signal lines.