Atmel ATBTLC1000 BluSDK User manual

ATBTLC1000 BluSDK
HID Keyboard Device –Getting Started Guide
USER GUIDE
Introduction
This getting started guide describes the setup of Atmel®ATBTLC1000 with a supported platform
bringing-up an example profile supplied as part of BluSDK. This document explains the bring-up of
HOGP Keyboard device example application that is embedded as part of the software release
package.
Atmel-42529C-ATBTLC1000-BluSDK-HID-Keyboard-Device-Getting-Started-Guide_UserGuide_022016

HID Keyboard Device –Getting Started Guide [USER GUIDE]
Atmel-42529C-ATBTLC1000-BluSDK-HID-Keyboard-Device-Getting-Started-Guide_UserGuide_022016
2
2
Table of Contents
1Description...................................................................................................................3
2Demo Setup .................................................................................................................4
3Supported Hardware Platforms and IDEs..................................................................4
4Hardware Setup...........................................................................................................5
4.1 SAM L21 Xplained Pro HID Keyboard Device Setup ............................................................................5
4.2 SAM D21 Xplained Pro HID Keyboard Device Setup............................................................................5
4.3 SAM G55 Xplained Pro HID Keyboard Setup .......................................................................................6
4.4 SAM 4S Xplained Pro HID Keyboard Setup..........................................................................................6
5Configuration for HID Keyboard Application.............................................................7
6Software Setup ............................................................................................................9
6.1 Installation Steps...................................................................................................................................9
6.2 Build Procedure...................................................................................................................................10
7Console Display.........................................................................................................14
8Running the Demo.....................................................................................................14
9BluSDK Software Architecture.................................................................................17
10 ATMEL EVALUATION BOARD/KIT IMPORTANT NOTICE AND DISCLAIMER........18
11 Revision History........................................................................................................19

HID Keyboard Device –Getting Started Guide [USER GUIDE]
Atmel-42529C-ATBTLC1000-BluSDK-HID-Keyboard-Device-Getting-Started-Guide_UserGuide_022016
3
3
1 Description
The HID over GATT (HOGP) profile defined by the Bluetooth SIG enables support of HID services over
a Bluetooth Low Energy (BLE) protocol stack using Generic Attribute profile (GATT). This allows
devices like keyboard or mouse implementing HOGP to connect to a compatible HOGP/BLE host
device (e.g.: Mobile Phone, Tablet, TV, etc.).
This document explains the details about:
1. Getting started with the setup of supported platform.
2. Demonstration of HID device functionality using Notepad mobile application for Android and iOS.
The HOGP Keyboard device application example (referred as HID Keyboard device in this document)
supports the following features:
Advertisement
Pairing
Services: HID Service and Device Information Service
Report Mode (Keyboard)
The HID Keyboard device application example supports the following characteristics for HID service.
Protocol Mode
Report
Report Map
Boot Keyboard Input Report
Boot Keyboard Output Report
HID Information
HID Control Point
For the purpose of demonstration, the example application simulates a function of a keyboard. Once
the handshake and connection procedure between a mobile phone and the ATBTLC1000 emulating a
keyboard device example is completed, the simulated keyboard will send a pre-determined set of
characters is sent on a key press that can be seen on any standard text editor on the mobile phone.
(“Hello Atmel”.)

HID Keyboard Device –Getting Started Guide [USER GUIDE]
Atmel-42529C-ATBTLC1000-BluSDK-HID-Keyboard-Device-Getting-Started-Guide_UserGuide_022016
4
4
2 Demo Setup
Figure 2-1. Demo Setup of HID Keyboard Device Application on ATBTLC1000
BLE LINK
3 Supported Hardware Platforms and IDEs
Table 3-1. BluSDK –Supported Hardware and IDEs
Platform
MCU
Supported
BLE device
Supported evaluation kits
Supported IDEs
SAM L21 (MCU)
ATSAML21J18B
ATBTLC1000
ATBTLC1000-XSTK
(ATSAML21-XPRO-B + ATBTLC1000
XPRO)
Atmel Studio v7.0
SAM L21 (MCU)
ATSAML21J18A
ATBTLC1000
ATSAML21 XPRO + ATBTLC1000
XPRO
Atmel Studio v7.0
SAM D21 (MCU)
ATSAMD21J18A
ATBTLC1000
ATSAMD21-XPRO + ATBTLC1000
XPRO
Atmel Studio v7.0
SAM G55 (MCU)
ATSAMG55J19
ATBTLC1000
ATSAMG55-XPRO + ATBTLC1000
XPRO
Atmel Studio v7.0
SAM 4S (MCU)
ATSAM4SD32C
ATBTLC1000
ATSAM4S-XPRO + ATBTLC1000
XPRO
Atmel Studio v7.0
Android mobile phone
“Notepad text editor app”
(HOGP Host role)
ATBTLC1000+
Atmel Supported MCU
(HID Keyboard Device
Application)

HID Keyboard Device –Getting Started Guide [USER GUIDE]
Atmel-42529C-ATBTLC1000-BluSDK-HID-Keyboard-Device-Getting-Started-Guide_UserGuide_022016
5
5
4 Hardware Setup
4.1 SAM L21 Xplained Pro HID Keyboard Device Setup
Figure 4-1. ATBTLC1000 Xplained Pro Extension Connected to a SAM L21 Xplained Pro
4.2 SAM D21 Xplained Pro HID Keyboard Device Setup
Figure 4-2. ATBTLC1000 Xplained Pro Extension Connected to a SAMD21 Xplained Pro

HID Keyboard Device –Getting Started Guide [USER GUIDE]
Atmel-42529C-ATBTLC1000-BluSDK-HID-Keyboard-Device-Getting-Started-Guide_UserGuide_022016
6
6
4.3 SAM G55 Xplained Pro HID Keyboard Setup
Figure 4-3. ATBTLC1000 Xplained Pro Extension Connected to a SAM G55 Xplained Pro
4.4 SAM 4S Xplained Pro HID Keyboard Setup
Figure 4-4. ATBTLC1000 Xplained Pro Extension Connected to a SAM 4S Xplained Pro

HID Keyboard Device –Getting Started Guide [USER GUIDE]
Atmel-42529C-ATBTLC1000-BluSDK-HID-Keyboard-Device-Getting-Started-Guide_UserGuide_022016
7
7
5 Configuration for HID Keyboard Application
The user may need to modify few macros in hid_device.h (HID Profile) for configuring the profile for
Keyboard application as per the desired application use-case.
Figure 5-1. HID Profile Code Hierarchy

HID Keyboard Device –Getting Started Guide [USER GUIDE]
Atmel-42529C-ATBTLC1000-BluSDK-HID-Keyboard-Device-Getting-Started-Guide_UserGuide_022016
8
8
List of macros that need to be modified by user based on the application use-case is mentioned below:
1. By default the application supports Report mode. In the case the application requires support for
only boot mode, the user can add the macro “BOOT_MODE”in the compiler/symbols tabs shown
below.
Figure 5-2. Enabling Boot Mode Support
1. User should configure the desired number of reports they want to support in application. Currently
the maximum number of reports supported is 10.
#define HID_NUM_OF_REPORT (1)
2. User should configure the desired number of service instances. Currently the maximum number of
service supported is 2.
#define HID_SERV_INST (1)

HID Keyboard Device –Getting Started Guide [USER GUIDE]
Atmel-42529C-ATBTLC1000-BluSDK-HID-Keyboard-Device-Getting-Started-Guide_UserGuide_022016
9
9
6 Software Setup
6.1 Installation Steps
1. Atmel Studio installation [Atmel Studio 7.0 (build 594) Installer –with .NET]
http://www.atmel.com/tools/atmelstudio.aspx
(Note: SAM L21 Rev B/SAM D21/SAM G55/SAM 4S part pack is built-in as part of Atmel Studio
7.0)
2. Atmel USB Driver Installer from http://www.atmel.com/tools/atmelstudio.aspx.
3. Install the standalone ASF package from
http://www.atmel.com/tools/AVRSOFTWAREFRAMEWORK.aspx.
Note: Refer to the BluSDK release notes for updates to version numbers of the components
mentioned above.
This ASF package will install the following examples within the Atmel Studio environment.
1. HID Profile Device Application for SAM L21.
2. HID Profile Device Application for SAM D21.
3. HID Profile Device Application for SAM G55.
4. HID Profile Device Application for SAM 4S.

HID Keyboard Device –Getting Started Guide [USER GUIDE]
Atmel-42529C-ATBTLC1000-BluSDK-HID-Keyboard-Device-Getting-Started-Guide_UserGuide_022016
1
0
10
6.2 Build Procedure
The following procedure is explained for SAM L21 application example. The same procedure is valid for
the case of all the other supported platforms (see Chapter 3) as well.
1. Select New Example Project.
Figure 6-1. Creating a New Project