Keyboard Device example

Yes

Description

This example implements a HID class device with mouse report descriptors. Key character reports are sent to the host by the device when buttons are pressed or the joystick is moved on the development board.

Compiler build configurations

The software that makes up this example is designed to run on many different development boards. Therefore the compiler must be configured to build an image that is targeted to the development board you are using. This section explains how to set these build configurations for each of the supported compilers.

LPCXpresso IDE

Configure projects

right click on the BSP project in the project explorer window
click Build Configurations->Set Active->(see configuration in table below)
repeat these steps with the CDL, nxpUSBlib, and Example_KeyboardDevice

Configure MCU

right click on the Example_KeyboardDevice project in the project explorer window
click Properties->C/C++ Build->MCU settings->(see configuration in table below)

Configure the indexer

click Window->Preferences->C/C++->Indexer->Use active build configuration

	BSP	CDL	nxpUSBlib	Example_KeyboardDevice	MCU
LPC1850 / Hitex	LPC18xx_HITEX	LPC18xx	LPC18xx_Device	LPC18xx	LPC1850
LPC4330 / Xplorer	LPC4330_Xplorer	LPC18xx	LPC18xx_Device	LPC18xx	LPC4330
LPC4350 / Element14	LPC1435_ELEMENT14	LPC18xx	LPC18xx_Device	LPC18xx	LPC4350
LPC11U14 / LPCXpresso	LPC11Uxx_LPCXpressoRevB	LPC11Uxx	LPC11Uxx_Device	LPC11Uxx	LPC11U14
LPC11U14 / MCB1000	LPC11u14_MCB1000	LPC11Uxx	LPC11Uxx_Device	LPC11Uxx	LPC11U14
LPC1768 / MCB1700	LPC1768_MCB1700	LPC17xx	LPC17xx_Device	LPC17xx	LPC1768
LPC1768 / LPCXpresso	LPC17xx_LPCXpressoRevB	LPC17xx	LPC17xx_Device	LPC17xx	LPC1768

NOTE: The LPC18xx CDL is used with boards that hold LPC43xx parts. This is done because the LPC43xx CDL is currently experimental. The LPC18xx USB library is used because both parts share the same controller.

Keil uVision 4 IDE

Configure a Batch Build

click on Project->Batch Build...
expand the BSP project to display a list of project targets
select the project target by checking the appropriate checkbox (see target list in table below)
repeat these steps with the CDL, nxpUSBlib_Device, and Example_KeyboardDevice

	BSP	CDL	nxpUSBlib_Device	Example_KeyboardDevice
LPC1850 / Hitex	HITEX1800	LPC18xx	LPC18xx_Device	HITEX1800
LPC1768 / MCB1700	MCB1700	LPC17xx	LPC17xx_Device	MCB1700
LPC11U14 / MCB1000	MCB1000	LPC11Uxx	LPC11Uxx_Device	MCB1000

Board connections and configurations

LPC18xx_HITEX (LPC1850 Hitex Evaluation Board) older A2 design

schematic ./BSP/schematics/HITEX_SCM_LPC1850EVA-A2-2.pdf

Connect the JTAG to the 20 pin receptacle marked X4 JTAG
Connect the type-B end of a USB cable to the receptacle marked X2. Plug the type-A end of this cable into a PC

LPC18xx_HITEX (LPC1850 Hitex Evaluation Board) newer A4 design

schematic ./BSP/schematics/HITEX_Final_LPC1850EVA-A3.pdf

LPC4330_Xplorer (NGX Xplorer Evaluation Board with LPC4330)

Connect the JTAG to the 10 pin receptacle marked J2
Connect the micro-b end of a USB cable to the receptacle marked USB0. Plug the type-A end of this cable into a PC

LPC1435_ELEMENT14 (Element 14 gaming board with LPC4350)

Connect the JTAG to the 10 pin receptacle marked J6
Connect one end of a type-A to type-A USB cable to the receptacle marked USB0. Plug the other end of this cable into a PC

LPC11u14_MCB1000 (Keil MCB1000 development board)

schematic: ./BSP/schematics/mcb1000-schematics.pdf

Jumpers:
J4 = 2-3      (UCON - PIO0_6 pulls D+ high)
J2 = 1-2          (VDD - core power)
J5 not installed (ISP - ISP via COMM)
J6 not installed (RST - ISP via COMM)
Connect the JTAG debugger to the 10 pin Cortex Debug connector labeled J3
Connect the type-B end of a USB cable to the type-B recepticle and the type-A end of the cable to the USB receptacle on a PC
Once the USB cable is connected to the board the following LEDs should be illuminated:
    Power
    All 8 LEDs in PIO2

LPC1768_MCB1700 (Keil MCB1700 development board)

schematic: ./BSP/schematics/mcb1700-schematics.pdf

Jumpers:
E/U    = 1-2 (Ethernet/USB)
UMODE = 1-2 (USB Device Mode)
D-     = Device
D+     = Device
VBUS   = 1-2
VDDIO = 1-2
VDDREG = 1-2

Connect the JTAG debugger to the 20 pin JTAG or 10 pin Cortex Debug connector.
Connect the type-B end of a USB cable to the type-B recepticle labeled 'Device' and the type-A end of the cable to the USB receptacle on a PC. Once the USB cable is connected to the board the following LEDs should be illuminated:
    Power
    100MHz
    USC (LED indicates a USB soft connect from P2.9)

LPC11Uxx_LPCXpressoRevB (LPCXpresso LPC11Uxx on the LPCXpresso Rev B base board)

schematic: ./BSP/schematics/lpcxpresso.lpc11u14.schematic.pdf

Running this example on the LPCXpresso LPC11U14 can be done one of two ways:

1. LPCXpresso LPC11U14 stand-alone
Connect the type-B end of a USB cable to the mini receptacle on the LPCXpresso board labeled J8 and the type-A end to the USB receptacle on a PC

2. LPCXpresso LPC11U14 plugged into the LPCXpresso base board Rev B
      Plug the LPCXpresso LPC11U14 board into the connector labeled J4 on a LPCXpresso base board Rev B
      Configure the base board according to the user's guide from Embedded Artists
      Connect the mini type-B end of a USB cable to the receptacle on the base board labeled X1 and the type-A end to the USB receptacle on a PC
      Once the USB cable is connected to the board the following LEDs should be illuminated:
          LED25 (vbus)
         LED26 (3.3v rail)

For both configurations the JTAG debugger is connected to the mini USB receptacle labeled J3 on the LPCXpresso LPC11U14 board

LPC17xx_LPCXpressoRevB (LPCXpresso LPC17xx on the LPCXpresso Rev B base board)

schematic: ./BSP/schematics/LPCXpressoLPC1769revB.pdf

Running this example on the LPCXpresso LPC1769 can be done one of two ways:

1. LPCXpresso LPC1769 stand-alone. Solder a type-B USB receptacle onto the board and wire it up. See included schematics for details. Connect the type-B end of a USB cable to the receptacle on the LPCXpresso board and the type-A end to the USB receptacle on a PC

2. LPCXpresso LPC1769 plugged into the LPCXpresso base board Rev B. Plug the LPCXpresso LPC1769 board into the connector labeled J4 on a LPCXpresso base board Rev B. Configure the base board according to the users guide from Embedded Artists. Connect the mini type-B end of a USB cable to the receptacle on the base board labeled X1 and the type-A end to the USB receptacle on a PC.

Once the USB cable is connected to the board the following LEDs should be illuminated:
      LED25 (vbus)
      LED26 (3.3v rail)

For both configurations the JTAG debugger is connected to the mini USB receptacle labeled J3 on the LPCXpresso LPC1769 board.

PC configuration

Use a PC running Windows XP, Vista or 7 Connect the type-A end of the USB cable that is connected to the board into one of the USB receptacles on the PC

Build and debug the example

LPCXpresso IDE

In the project explorer window of the IDE right click on the Example_KeyboardDevice project and select Debug As->C/C++ MCU Application
In the main window of the IDE click Run->Resume to start running the application

Keil uVision 4 IDE

In the Batch Build window, select the project targets as described in Compiler Build Configurations and then click Build
In the main window of the IDE click Debug->Start/Stop Debug Session click Debug->Run

How this example runs and what to look for

When the example is run and the board is connected to a PC with a USB cable it will enumerate on the PC as a HID Keyboard device. You should see the device appear in the "Device Manager" under "Keyboards". If you right click on HID Keyboard Device->Properties a window will appear called "HID Keyboard Device Properties". If you select the "Details" tab you will see a "Properties" drop down, click on it and select "Hardware Ids". You should see the below entries for Vendor Id and Product Id.

HID\VID_1FC9&PID_2042&REV_0001
HID\VID_1FC9&PID_2042

This information should match the data in the "Device Descriptor Structure" in the "Descriptors.c" file in the Example_KeyboardDevice project directory.

To demostrate the keyboard open an editing application such as Notepad or MS Word. Moving the joystick (SW2) on the Xpresso base board will output characters onto the editing application.