Bluetooth HID Profile User Manual
Contents
1. connection is broken as the case when the power is cycled the device must re connect to the host The host will not initiate a connection Using DIR mode 4 default or pairing mode 6 allows the module to auto connect back to the last paired host Alternatively you can reconnect by sending the C command from command mode HID Flag Register The HID flag register 15 a bit mapped reregister that 15 configured while in command mode To set the register use the SH value command where value is a 4 character hex word The GH command returns the current value of the register The default factory setting is 0000 which corresponds to a keyboard www rovingnetworks com 3 RN HID UM 1 0r gt ROVN AIE Table 1 shows the HID flag register bits currently only the lower 9 bits are defined Table 1 HID Flag Register Bits Force HID mode if Toggle virtual Descriptor type Send output reports Indicates number of GPIO11 is high on keyboard on iOS over UART paired devices to which power up when first 0000 Keyboard the module can connected 0001 Game Pad reconnect 0010 Mouse COMBO JOYSTICK DIGITIZER 0011 0100 0101 0110 SENSOR 0111 USE CFG 1XXX Reserved Bit 9 Bit 9 is an enable bit that overrides the profile selection mode When this bit is set the firmware checks the level of GPIO11 on power if it is high the module switches to HID mode With this bit you can set the module s default profile2. to SPP mode allowing SPP and remote configuration for example from Bluetooth clients with SPP Then you can use GPIO11 to override SPP mode and enable HID mode Bit 8 Bit 8 enables the toggling of the virtual keyboard on iOS devices Bits 7 4 Bits 7 through 4 control the following settings The COD that is advertised by the module e The HID report descriptor and the available reports Bit 3 Bit 3 enables output reports which are sent by the host to the device over Bluetooth to the UART These reports are a feedback mechanism to the embedded microcontroller The output record is formatted as lt gt lt numberofbytes gt lt report OxFE 1 8 data For example the HID keyboard output reports the keyboard LED status as OxFE 0 2 0 1 lt LED status byte www rovingnetworks com 4 RN HID UM 1 0r NG Bits 2 0 Bits 2 through O define the number of paired hosts to which the module attempts to reconnect after power up After each successful pairing the link key is stored in the Bluetooth module Up to eight paired link keys are stored in FIFO fashion Upon power up the module tries to connect to the most recently paired device If it is not found the module attempts to connect to the next hosts depending upon the settings of bits 2 O in the HID register HID REPORTS The module interprets input on the UART and generates an HID report that is sent over the Bluetooth link to the host Input to
3. products documentation and services at any time Customers should obtain the latest relevant information before placing orders and should verify that such information is current and complete Roving Networks assumes no liability for applications assistance or customer s product design Customers are responsible for their products and applications which use Roving Networks components To minimize customer product risks customers should provide adequate design and operating safeguards Roving Networks products are not authorized for use in safety critical applications such as life support where a failure of the Roving Networks product would reasonably be expected to cause severe personal injury or death unless officers of the parties have executed an agreement specifically governing such use RN HID UM 1 0r 12
4. ID Report to Host Scan Codes NoEvent 00 ASCII Code ASCII 23 ASCII Return Return _ 28 ae Scroll Lock 47 Break Ctrl Pause 48 4 48 M N R S T U V W X Y Z 5 5 t V W X y 2 2 4 n u 1 3 5 REFERENCES 1 Bluetooth SG Human interface Profile overview URL https www bluetooth org Building HowTechnologyWorks ProfilesAndProtocols HID htm 2 USB org HID usage tables URL http www usb org developers devclass docs Hut1 12v2 pdf 3 USB org HID technology URL http www usb org developers hidpage RESOURCES amp RELATED DOCUMENTS For more information refer to the following sources which are available on the Support page on the Roving Networks website at http www rovingnetworks com support php Bluetooth Advanced User Manual e Bluetooth Evaluation Kit for Developing Accessories Compatible with 105 Devices User Manual www rovingnetworks com 11 Roving Networks Inc 102 Cooper Court Los Gatos CA 95032 1 408 395 5300 www rovingnetworks com www rovingnetworks com UU Copyright 2012 Roving Networks All rights reserved Roving Networks is registered trademark of Roving Networks Apple Inc iPhone iPad iTunes Made for iPhone are registered trademarks of Apple Computer Roving Networks reserves the right to make corrections modifications and other changes to its
5. RN HID UM SAAN Bluetooth HID Profile 2012 Roving Networks All rights reserved RN HID UM 1 Or Version 1 0r 1 17 2012 U S E R M A N U A L RN HID UM 1 0r S UNI OVERVIEW Roving Networks Bluetooth modules support a variety of Bluetooth profiles including human interface device HID serial port profile SPP DUN and iAP for use with iPad iPod and iPhone devices The Bluetooth HID profile enables customers to develop wireless products such as computer keyboards and keypads trackballs mice and other pointing devices and game controllers gamepads joysticks steering wheels etc Additionally Roving Networks has extended the basic HID capability to allow programmability and control of devices such as the iPad The HID Human Interface Device profile defines the protocol between e Device HID Services human data input and output to and from the host e Host Uses or requests the services of a Human Interface Device The Bluetooth HID profile allows users to control the HID descriptor which defines the device s feature set and the HID report which host uses to interpret the data as ASCII values movement etc The HID report format follows the standard universal serial bus USB HID protocol as to leverage existing host drivers NOTE This user manual focuses specifically on HID The Roving Networks Bluetooth Advanced User Manual and Apple User Manual cover the functionality of all support
6. e you must use a special build of firmware version 6 03 or later When you purchase a Roving Networks Bluetooth product you must specify that you wish to use this firmware version so that Roving Networks can load it into the module The part numbers for ordering modules with the HID profile are RN 41 HID and RN 42 HID NOTE This user guide assumes the reader has an understanding of Roving Networks standard Bluetooth firmware ASCII command interface and command set It is recommended that you refer to the Bluetooth Advanced User Manual prior to reading this document Profile Configuration The HID firmware supports Bluetooth HID and SPP You switch between these profiles using ASCII commands By default the HID profile is enabled in the HID firmware To switch between HID and SPP use the following commands 5 0 Enables SPP protocol R 1 Reboot to use SPP To switch back to HID use the following command S 6 Enables HID profile R 1 Reboot to use HID profile Device Discovery amp Pairing During pairing the module determines the HID device type As part of the Bluetooth protocol the HID device sends the type By default the Roving Networks modules running the HID profile are discoverable as a keyboard You can change the device type by setting the descriptor type using the HID flags register After first pairing the host to a device with the Bluetooth HID module the host initiates a connection However if the initial
7. ed Bluetooth profiles Because the HID profile is derived from Roving Network s standard firmware many of the concepts and commands found in the Advanced User Manual apply as well In a typical usage scenario such as a keyboard a device using the Roving Networks Bluetooth HID profile replaces the USB cable In this case the ASCII value of a key press is converted to a scan code in a raw HID report that the Bluetooth module sends over the Bluetooth link to the host The host driver software decodes the raw HID report and passes the key values to the application running on the PC Figure 1 shows some typical HID environments Figure 1 Typical HID Environments Typical HID cable environment HID Wireless environment ASCII Key Entered ASCII Key Entered Convert to HID Scan Code Convert to HID Scan Code Create USB Packet Create Bluetooth L2CAP Packet Send via Bluetooth Interface Convert to STD 1 0 Convert to STD 1 0 US Display ASCII in Application D iw Send via USB Cable Interface play pp Ee Display ASCII in Application A Recover HID Scan Code from USB Packet Recover HID Scan Code Ot Get via USB Cable Interface Get via Bluetooth Interface The type of HID device such as a keyboard mouse or joystick is defined by the HID descriptor in the raw HID report www rovingnetworks com 2 RN HID UM 1 0r n ADU NG FIRMWARE OVERVIEW To use Roving Networks Bluetooth HID profil
8. ommand S 5A00 Map Z key as the disconnect key Consumer Report You can use HID raw report to send additional keys as a consumer report The format 15 Table 4 shows the data byte format Table 4 Data Byte Format Consumer Key Function AC Home AL Email Reader AC Search AL Keyboard Layout Virtual Apple Keyboard Toggle Volume Up Volume Down Play Pause Scan Next Track Scan Previous Track Ejea Fast Forward Rewind Stop Eject AL Internet Browser For example to raise the volume send oes release the key send EEN www rovingnetworks com 9 RN HID UM 1 0r n ANU NG SCAN CODE TABLES UART ASCII TO HID REPORT Table 5 shows the UART to HID input conversion Table 5 UART to HID Scan Code UART mpat m rwge ________ __________ Discomectif Connected i 2 JJ O4A jHome 3 OB O 4 O4dC y deete y O 5 TOAD __ 6 O4E Lage down o OO 8 J1 OxX2 jBackspce 9 X ORB 32 120 Printable ASCII characters 0xE7 0xE8 0xEF OxFO OxFC OxFD o Rawrepot O OxFE e Shorthadreprt O OxFF Sendsoutputreportto UART ______ www rovingnetworks com 10 RN HID UM 1 0r n UU o CT Table 6 shows the ASCII to HID scan codes Table 6 ASCII to H
9. ort format in keyboard or combo mode is The joystick format is In combo mode it is possible to send both for a keyboard and mouse HID reports In this case if you wanted to enter an A and move the mouse you can use either of the following methods A e wo 000 ocn odo Or oxa ox2 oxo oxoa oxo oxo oxo oxo oxo oxo oxo oxo eo www rovingnetworks com RN HID UM 1 0r S UNI Special Reports amp Modes This section describes special modes and reports including output reports virtual keyboards a key map register etc Output Reports Because the host controls the modifier keys state the HID device must be able to request the current status The output report code is reserved to return the current status of the Caps Lock Num Lock and Scroll Lock keys over the UART Because an HID device can only toggle these keys it tells the device the state of the keys This functionality is particularly useful when multiple HID devices are in the system and the Bluetooth device needs to update the state of these keys The format is sent as Table 3 shows the status byte definitions Table 3 Status Byte Definitions Num Lock Scroll Lock Apple Virtual Keyboard When the module 15 connected to 105 device the virtual keyboard Is hidden However in some applications it is useful or required to display the keyboard for data en
10. that multiple keyboard keys can be sent with minimal characters over the UART which optimizes bandwidth because the module does not have to send a keyboard report Shorthand reports start with OxFE and have variable length The shorthand format is where Length O 2 3 4 5 6 or 7 depending on how many keys are sent For example shorthand for the a b and c keys is oxa oxo 0 05 lege The Bluetooth module converts this shorthand into the following raw HID reports that are sent over the Bluetooth link 0x9 oxo 0x04 025 oxe oxo oxo oxo oxo oxo oxo Shorthand to release all three keys is Raw Report Mode The start byte OxFD Indicates a raw HID report In the Bluetooth module the start byte is stripped and the following bytes are sent without interpretation The Raw HID report consists of a start byte length descriptor type which defines the type of HID device and data specified in scan codes or encoded values The format of the data depends on the descriptor type HID reports are sent one report at a time The raw report format 15 www rovingnetworks com 6 DY NI OT WANS RN HID UM 1 0r The keyboard report format is The modifier byte is a bit mask interpreted as shown below For example you can use Ox2 or Ox20 to turn a lower case a into an upper case A Left Left Left Alt Shift Ctrl The mouse raw report format is The consumer rep
11. the module is interpreted as shown in Table 2 Table 2 Data Interpretation e o See Scan Code Tables UART ASCII to HID Report on page 10 for a complete table of UART input to HID report OxEO 7 Sends modifier keys Left Shift Left Alt Right Shift etc Translation Mode Translation mode 15 the simplest way to send HID reports for printable ASCII characters When the Bluetooth module s UART receives a printable ASCII value it is converted into a keyboard raw HID report Two reports are sent for each character the first report indicates that the key is pressed and the second indicates that it is released For example a is translated into oro os wo wo o os wo o o key Press oro os wo wo os wo o oo wo o Koy Rees www rovingnetworks com S DY NI RN HID UM 1 0r A is translated into eo ws wo o os wo os wo Key Pe oro ws o wo 60 toe Notice that the scan code for A is the same as the previous raw report except the modifier byte indicates the left Shift key is pressed If multiple scan codes are sent the modifier applies to all of them Keyboard Shorthand Mode The Roving Networks HID profile supports shorthand for implementing keyboards The advantage of this mode is
12. try on the touch screen of the iOS device Toggling GPIOY displays or hides the virtual keyboard GPIO9 must go from low to high for at least 200 ms for the toggle to occur NOTE The virtual keyboard toggle must be enabled in the HID flag register for this feature to work Key Map Register This register allows you to replace any ASCII code with another ASCII code It is useful in cases where you want to toggle special keys that the device cannot generate For example the touch keyboard on an iOS device is Ox7F but the device cannot generate Ox7F If the register is non zero the upper byte is the key to replace and the lower is the replacement The command to set the register is Sz value where value is a 4 character hex word To obtain the current value of the register use the G command The value also shows up in the advanced settings using the E command The default factory setting is 0000 not enabled For example to use the tilda which is Oxfe to toggle the keyboard enter the command 5 7 71 www rovingnetworks com 8 RN HID UM 1 0r S UNI Disconnect Key A special hex key value OxOO zero causes a Bluetooth disconnect which allows you to control the connection by sending a single key To disconnect send OxO Combining the disconnect feature with the key map register any key can be used as a disconnect key For example to set the capital Z key hex 5A as the disconnect key use the following c
Download Pdf Manuals
Related Search