BLE HID Keyboard example for Delta BLE platform

Fork of BLE_HeartRate_DELTA by Delta

This example demonstrates the HID over GATT profile for keyboard.

1. Running this application on Delta BLE platform 2. To connect and pair with device named "HID_Keyboard" in your mobile (iOS/Android) Settings>Bluetooth page 3. Open a text editing application on your mobile phone 4. On the PC, open the terminal tool (Putty or TeraTerm) and choose the correct COM/BaudRate 5. Enter any character from your PC, and it will be displayed in your mobile phone

Committer:
silviaChen
Date:
Mon Mar 27 09:58:38 2017 +0000
Revision:
2:9f46fa6237dd
Parent:
1:8bca989a70be
update mbed-os so both NNN50 and NQ620 (as well as NQ624 module) platform are supported; Add config in mbed_app.json to fix NQ620 use internal RC issue ; remove the unused shield folder; support both iOS and Android

Who changed what in which revision?

UserRevisionLine numberNew contents of line
silviaChen 0:c7bcc0b36b5e 1 /* mbed Microcontroller Library
silviaChen 0:c7bcc0b36b5e 2 * Copyright (c) 2006-2015 ARM Limited
silviaChen 0:c7bcc0b36b5e 3 *
silviaChen 0:c7bcc0b36b5e 4 * Licensed under the Apache License, Version 2.0 (the "License");
silviaChen 0:c7bcc0b36b5e 5 * you may not use this file except in compliance with the License.
silviaChen 0:c7bcc0b36b5e 6 * You may obtain a copy of the License at
silviaChen 0:c7bcc0b36b5e 7 *
silviaChen 0:c7bcc0b36b5e 8 * http://www.apache.org/licenses/LICENSE-2.0
silviaChen 0:c7bcc0b36b5e 9 *
silviaChen 0:c7bcc0b36b5e 10 * Unless required by applicable law or agreed to in writing, software
silviaChen 0:c7bcc0b36b5e 11 * distributed under the License is distributed on an "AS IS" BASIS,
silviaChen 0:c7bcc0b36b5e 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
silviaChen 0:c7bcc0b36b5e 13 * See the License for the specific language governing permissions and
silviaChen 0:c7bcc0b36b5e 14 * limitations under the License.
silviaChen 0:c7bcc0b36b5e 15 */
silviaChen 0:c7bcc0b36b5e 16
silviaChen 0:c7bcc0b36b5e 17 #include "mbed.h"
silviaChen 0:c7bcc0b36b5e 18 #include "ble/BLE.h"
silviaChen 0:c7bcc0b36b5e 19 #include "ble/services/BatteryService.h"
silviaChen 0:c7bcc0b36b5e 20 #include "ble/services/DeviceInformationService.h"
silviaChen 1:8bca989a70be 21 #include "HIDService.h"
silviaChen 0:c7bcc0b36b5e 22
silviaChen 1:8bca989a70be 23 //DigitalOut led1(LED1);
silviaChen 2:9f46fa6237dd 24 Serial uart(USBTX, USBRX, 115200);
silviaChen 0:c7bcc0b36b5e 25
silviaChen 2:9f46fa6237dd 26 BLE deltaBLE;
silviaChen 1:8bca989a70be 27 HIDService *hidService;
silviaChen 1:8bca989a70be 28 unsigned char keyData;
silviaChen 1:8bca989a70be 29 const static char DEVICE_NAME[] = "HID_Keyboard";
silviaChen 1:8bca989a70be 30 static const uint16_t uuid16_list[] = {GattService::UUID_HUMAN_INTERFACE_DEVICE_SERVICE,
silviaChen 2:9f46fa6237dd 31 GattService::UUID_BATTERY_SERVICE,
silviaChen 0:c7bcc0b36b5e 32 GattService::UUID_DEVICE_INFORMATION_SERVICE};
silviaChen 0:c7bcc0b36b5e 33 static volatile bool triggerSensorPolling = false;
silviaChen 1:8bca989a70be 34 bool isConnectionSecured = false;
silviaChen 2:9f46fa6237dd 35 bool isSecuritySetup = false;
silviaChen 2:9f46fa6237dd 36 static uint8_t key_press_scan_buff[50];
silviaChen 2:9f46fa6237dd 37 static uint8_t modifyKey[50];
silviaChen 2:9f46fa6237dd 38 char msg[25] = "";
silviaChen 2:9f46fa6237dd 39 int index_b = 0;
silviaChen 2:9f46fa6237dd 40 int index_w = 0;
silviaChen 2:9f46fa6237dd 41 unsigned char uart_buf[64];
silviaChen 2:9f46fa6237dd 42 unsigned int i = 0;
silviaChen 0:c7bcc0b36b5e 43
silviaChen 1:8bca989a70be 44 DeviceInformationService *deviceInfo;
silviaChen 2:9f46fa6237dd 45 BatteryService *batteryService;
silviaChen 0:c7bcc0b36b5e 46
silviaChen 1:8bca989a70be 47 void passkeyDisplayCallback(Gap::Handle_t handle, const SecurityManager::Passkey_t passkey)
silviaChen 1:8bca989a70be 48 {
silviaChen 1:8bca989a70be 49 uart.printf("Input passKey: ");
silviaChen 1:8bca989a70be 50 for (unsigned i = 0; i < Gap::ADDR_LEN; i++) {
silviaChen 1:8bca989a70be 51 uart.printf("%c ", passkey[i]);
silviaChen 1:8bca989a70be 52 }
silviaChen 1:8bca989a70be 53 uart.printf("\r\n");
silviaChen 1:8bca989a70be 54 }
silviaChen 2:9f46fa6237dd 55
silviaChen 2:9f46fa6237dd 56 void securitySetupInitiatedCallback(Gap::Handle_t, bool allowBonding, bool requireMITM, SecurityManager::SecurityIOCapabilities_t iocaps)
silviaChen 2:9f46fa6237dd 57 {
silviaChen 2:9f46fa6237dd 58 uart.printf("securitySetupInitiatedCallback\r\n");
silviaChen 2:9f46fa6237dd 59 isSecuritySetup = true;
silviaChen 2:9f46fa6237dd 60 }
silviaChen 1:8bca989a70be 61
silviaChen 1:8bca989a70be 62 void securitySetupCompletedCallback(Gap::Handle_t handle, SecurityManager::SecurityCompletionStatus_t status)
silviaChen 1:8bca989a70be 63 {
silviaChen 1:8bca989a70be 64 if (status == SecurityManager::SEC_STATUS_SUCCESS) {
silviaChen 1:8bca989a70be 65 uart.printf("Security success\r\n", status);
silviaChen 2:9f46fa6237dd 66 //isConnectionSecured = true;
silviaChen 1:8bca989a70be 67 } else {
silviaChen 1:8bca989a70be 68 uart.printf("Security failed\r\n", status);
silviaChen 1:8bca989a70be 69 }
silviaChen 1:8bca989a70be 70 }
silviaChen 1:8bca989a70be 71
silviaChen 1:8bca989a70be 72 void linkSecuredCallback(Gap::Handle_t handle, SecurityManager::SecurityMode_t securityMode)
silviaChen 1:8bca989a70be 73 {
silviaChen 1:8bca989a70be 74 uart.printf("linkSecuredCallback\r\n");
silviaChen 2:9f46fa6237dd 75 if (!isSecuritySetup) {
silviaChen 2:9f46fa6237dd 76 isConnectionSecured = true;
silviaChen 2:9f46fa6237dd 77 }
silviaChen 2:9f46fa6237dd 78 }
silviaChen 2:9f46fa6237dd 79
silviaChen 2:9f46fa6237dd 80 void securityContextStoredCallback(Gap::Handle_t handle) {
silviaChen 2:9f46fa6237dd 81 uart.printf("securityContextStoredCallback\r\n");
silviaChen 1:8bca989a70be 82 isConnectionSecured = true;
silviaChen 2:9f46fa6237dd 83 isSecuritySetup = false;
silviaChen 1:8bca989a70be 84 }
silviaChen 1:8bca989a70be 85
silviaChen 1:8bca989a70be 86 void onConnectionCallback(const Gap::ConnectionCallbackParams_t *params)
silviaChen 1:8bca989a70be 87 {
silviaChen 1:8bca989a70be 88 uart.printf("Connected\r\n");
silviaChen 1:8bca989a70be 89 }
silviaChen 0:c7bcc0b36b5e 90
silviaChen 0:c7bcc0b36b5e 91 void disconnectionCallback(const Gap::DisconnectionCallbackParams_t *params)
silviaChen 0:c7bcc0b36b5e 92 {
silviaChen 1:8bca989a70be 93 uart.printf("Disconnected\r\n");
silviaChen 1:8bca989a70be 94 isConnectionSecured = false;
silviaChen 2:9f46fa6237dd 95 deltaBLE.gap().startAdvertising(); // restart advertising
silviaChen 0:c7bcc0b36b5e 96 }
silviaChen 0:c7bcc0b36b5e 97
silviaChen 1:8bca989a70be 98 void onTimeoutCallback(Gap::TimeoutSource_t source)
silviaChen 1:8bca989a70be 99 {
silviaChen 1:8bca989a70be 100 switch (source) {
silviaChen 1:8bca989a70be 101 case Gap::TIMEOUT_SRC_ADVERTISING:
silviaChen 1:8bca989a70be 102 uart.printf("Advertising timeout\r\n");
silviaChen 1:8bca989a70be 103 break;
silviaChen 1:8bca989a70be 104 case Gap::TIMEOUT_SRC_SECURITY_REQUEST:
silviaChen 1:8bca989a70be 105 uart.printf("Security request timeout\r\n");
silviaChen 1:8bca989a70be 106 break;
silviaChen 1:8bca989a70be 107 case Gap::TIMEOUT_SRC_SCAN:
silviaChen 1:8bca989a70be 108 uart.printf("Scanning timeout\r\n");
silviaChen 1:8bca989a70be 109 break;
silviaChen 1:8bca989a70be 110 case Gap::TIMEOUT_SRC_CONN:
silviaChen 1:8bca989a70be 111 uart.printf("Connection timeout\r\n");
silviaChen 1:8bca989a70be 112 break;
silviaChen 1:8bca989a70be 113 }
silviaChen 1:8bca989a70be 114 }
silviaChen 1:8bca989a70be 115
silviaChen 0:c7bcc0b36b5e 116 void periodicCallback(void)
silviaChen 0:c7bcc0b36b5e 117 {
silviaChen 1:8bca989a70be 118 //led1 = !led1; /* Do blinky on LED1 while we're waiting for BLE events */
silviaChen 0:c7bcc0b36b5e 119
silviaChen 0:c7bcc0b36b5e 120 /* Note that the periodicCallback() executes in interrupt context, so it is safer to do
silviaChen 0:c7bcc0b36b5e 121 * heavy-weight sensor polling from the main thread. */
silviaChen 2:9f46fa6237dd 122 //triggerSensorPolling = true;
silviaChen 0:c7bcc0b36b5e 123 }
silviaChen 0:c7bcc0b36b5e 124
silviaChen 2:9f46fa6237dd 125 void CLI_execute() {
silviaChen 2:9f46fa6237dd 126 // if (i>=2)
silviaChen 2:9f46fa6237dd 127 // if (uart_buf[i-2] == 0x0D && uart_buf[i-1] == 0x0A){//detecting CR LF
silviaChen 2:9f46fa6237dd 128 if (uart.readable()) return;//retrun if it is not the end of packet
silviaChen 2:9f46fa6237dd 129
silviaChen 1:8bca989a70be 130 if (isConnectionSecured) {
silviaChen 2:9f46fa6237dd 131 for (int j=0; j<i; j++) {
silviaChen 2:9f46fa6237dd 132 keyData = uart_buf[j];
silviaChen 2:9f46fa6237dd 133
silviaChen 1:8bca989a70be 134 if(keyData <= 0x39 && keyData >= 0x30){ //number
silviaChen 1:8bca989a70be 135 if(keyData == 0x30){
silviaChen 1:8bca989a70be 136 modifyKey[index_b] = 0x00;
silviaChen 1:8bca989a70be 137 key_press_scan_buff[index_b] = 0x27;
silviaChen 1:8bca989a70be 138 index_b++;
silviaChen 1:8bca989a70be 139 key_press_scan_buff[index_b] = 0x73;
silviaChen 1:8bca989a70be 140 } else {
silviaChen 1:8bca989a70be 141 modifyKey[index_b] = 0x00;
silviaChen 1:8bca989a70be 142 key_press_scan_buff[index_b] = keyData-0x13;
silviaChen 1:8bca989a70be 143 index_b++;
silviaChen 1:8bca989a70be 144 key_press_scan_buff[index_b] = 0x73;
silviaChen 1:8bca989a70be 145 }
silviaChen 1:8bca989a70be 146 } else if(keyData <= 0x7a && keyData >= 0x61 ){ //lowercase letters
silviaChen 1:8bca989a70be 147 modifyKey[index_b] = 0x00;
silviaChen 1:8bca989a70be 148 key_press_scan_buff[index_b] = keyData-0x5d;
silviaChen 1:8bca989a70be 149 index_b++;
silviaChen 1:8bca989a70be 150 key_press_scan_buff[index_b] = 0x73;
silviaChen 1:8bca989a70be 151 } else if(keyData <= 0x5a && keyData >= 0x41){ //uppercase letters
silviaChen 1:8bca989a70be 152 modifyKey[index_b] = 0x02;
silviaChen 1:8bca989a70be 153 key_press_scan_buff[index_b] = keyData-0x3d;
silviaChen 1:8bca989a70be 154 index_b++;
silviaChen 1:8bca989a70be 155 key_press_scan_buff[index_b] = 0x73;
silviaChen 1:8bca989a70be 156 } else if (keyData == 0x20) { //space
silviaChen 1:8bca989a70be 157 modifyKey[index_b] = 0x00;
silviaChen 1:8bca989a70be 158 key_press_scan_buff[index_b] = 0x2c;
silviaChen 1:8bca989a70be 159 index_b++;
silviaChen 1:8bca989a70be 160 key_press_scan_buff[index_b] = 0x73;
silviaChen 2:9f46fa6237dd 161 } else if (keyData == 0x08) { //backspace
silviaChen 2:9f46fa6237dd 162 modifyKey[index_b] = 0x00;
silviaChen 2:9f46fa6237dd 163 key_press_scan_buff[index_b] = 0x2a;
silviaChen 2:9f46fa6237dd 164 index_b++;
silviaChen 2:9f46fa6237dd 165 key_press_scan_buff[index_b] = 0x73;
silviaChen 2:9f46fa6237dd 166 } else if (keyData == 0x0d) { //return
silviaChen 2:9f46fa6237dd 167 modifyKey[index_b] = 0x00;
silviaChen 2:9f46fa6237dd 168 key_press_scan_buff[index_b] = 0x28;
silviaChen 2:9f46fa6237dd 169 index_b++;
silviaChen 2:9f46fa6237dd 170 key_press_scan_buff[index_b] = 0x73;
silviaChen 1:8bca989a70be 171 } else {
silviaChen 1:8bca989a70be 172 modifyKey[index_b] = 0x00;
silviaChen 1:8bca989a70be 173 //key_press_scan_buff[index_b] = 0x73; //this is dummy data.
silviaChen 1:8bca989a70be 174 //msg[index_w+1] = '\0';
silviaChen 1:8bca989a70be 175 }
silviaChen 1:8bca989a70be 176 index_b++;
silviaChen 2:9f46fa6237dd 177 }
silviaChen 2:9f46fa6237dd 178
silviaChen 2:9f46fa6237dd 179 i=0;
silviaChen 1:8bca989a70be 180
silviaChen 2:9f46fa6237dd 181 for(int i = 0; i < index_b ; i++){
silviaChen 2:9f46fa6237dd 182 uart.printf("m[%x] k[%x] ", modifyKey[i], key_press_scan_buff[i]);
silviaChen 2:9f46fa6237dd 183 hidService->updateReport(modifyKey[i], key_press_scan_buff[i]);
silviaChen 2:9f46fa6237dd 184 //BLE::Instance(BLE::DEFAULT_INSTANCE).waitForEvent();
silviaChen 2:9f46fa6237dd 185 //wait(0.03);
silviaChen 0:c7bcc0b36b5e 186 }
silviaChen 2:9f46fa6237dd 187
silviaChen 2:9f46fa6237dd 188 index_b = 0;
silviaChen 2:9f46fa6237dd 189 index_w = 0;
silviaChen 2:9f46fa6237dd 190 memset(modifyKey, 0, 50);
silviaChen 2:9f46fa6237dd 191 memset(msg, 0, 25);
silviaChen 2:9f46fa6237dd 192 memset(key_press_scan_buff, 0, 50);
silviaChen 2:9f46fa6237dd 193
silviaChen 0:c7bcc0b36b5e 194 }
silviaChen 1:8bca989a70be 195
silviaChen 2:9f46fa6237dd 196 // }
silviaChen 2:9f46fa6237dd 197 }
silviaChen 2:9f46fa6237dd 198
silviaChen 2:9f46fa6237dd 199 void uart_interrupt() {
silviaChen 2:9f46fa6237dd 200 uart.printf("uart_interrupt\r\n");
silviaChen 2:9f46fa6237dd 201 uart_buf[i++] = uart.getc();
silviaChen 2:9f46fa6237dd 202 CLI_execute();
silviaChen 2:9f46fa6237dd 203 }
silviaChen 2:9f46fa6237dd 204
silviaChen 2:9f46fa6237dd 205 void bleInitComplete(BLE::InitializationCompleteCallbackContext *params)
silviaChen 2:9f46fa6237dd 206 {
silviaChen 2:9f46fa6237dd 207 BLE &ble = params->ble;
silviaChen 2:9f46fa6237dd 208 ble_error_t error = params->error;
silviaChen 2:9f46fa6237dd 209
silviaChen 2:9f46fa6237dd 210 if (error != BLE_ERROR_NONE) {
silviaChen 2:9f46fa6237dd 211 return;
silviaChen 2:9f46fa6237dd 212 }
silviaChen 2:9f46fa6237dd 213
silviaChen 2:9f46fa6237dd 214 bool enableBonding = true;
silviaChen 2:9f46fa6237dd 215 bool requireMITM = false;
silviaChen 2:9f46fa6237dd 216
silviaChen 2:9f46fa6237dd 217 //uint8_t pKey[6] = {'1', '1', '1', '1', '1', '1'}; //set the passkey
silviaChen 2:9f46fa6237dd 218 ble.securityManager().init(enableBonding, requireMITM, SecurityManager::IO_CAPS_NONE);
silviaChen 2:9f46fa6237dd 219 ble.securityManager().onPasskeyDisplay(passkeyDisplayCallback);
silviaChen 2:9f46fa6237dd 220 ble.securityManager().onSecuritySetupInitiated(securitySetupInitiatedCallback);
silviaChen 2:9f46fa6237dd 221 ble.securityManager().onSecuritySetupCompleted(securitySetupCompletedCallback);
silviaChen 2:9f46fa6237dd 222 ble.securityManager().onLinkSecured(linkSecuredCallback);
silviaChen 2:9f46fa6237dd 223 ble.securityManager().onSecurityContextStored(securityContextStoredCallback);
silviaChen 2:9f46fa6237dd 224 ble.gap().onDisconnection(disconnectionCallback);
silviaChen 2:9f46fa6237dd 225 ble.gap().onConnection(onConnectionCallback);
silviaChen 2:9f46fa6237dd 226 ble.gap().onTimeout(onTimeoutCallback);
silviaChen 2:9f46fa6237dd 227 //ble.gattServer().onDataRead(onDataReadCallback);
silviaChen 2:9f46fa6237dd 228
silviaChen 2:9f46fa6237dd 229 /* Setup primary service. */
silviaChen 2:9f46fa6237dd 230 hidService = new HIDService(ble);
silviaChen 2:9f46fa6237dd 231
silviaChen 2:9f46fa6237dd 232 /* Setup auxiliary service. */
silviaChen 2:9f46fa6237dd 233 batteryService = new BatteryService(ble, 100);
silviaChen 2:9f46fa6237dd 234 deviceInfo = new DeviceInformationService(ble, "DELTA", "NQ620", "SN1", "hw-rev1", "fw-rev1", "soft-rev1");
silviaChen 2:9f46fa6237dd 235
silviaChen 2:9f46fa6237dd 236 /* Setup advertising. */
silviaChen 2:9f46fa6237dd 237 ble.gap().accumulateAdvertisingPayload(GapAdvertisingData::BREDR_NOT_SUPPORTED | GapAdvertisingData::LE_GENERAL_DISCOVERABLE);
silviaChen 2:9f46fa6237dd 238 ble.gap().accumulateAdvertisingPayload(GapAdvertisingData::COMPLETE_LIST_16BIT_SERVICE_IDS, (uint8_t *)uuid16_list, sizeof(uuid16_list));
silviaChen 2:9f46fa6237dd 239 ble.gap().accumulateAdvertisingPayload(GapAdvertisingData::KEYBOARD);
silviaChen 2:9f46fa6237dd 240 ble.gap().accumulateAdvertisingPayload(GapAdvertisingData::COMPLETE_LOCAL_NAME, (uint8_t *)DEVICE_NAME, sizeof(DEVICE_NAME));
silviaChen 2:9f46fa6237dd 241 ble.gap().setAdvertisingType(GapAdvertisingParams::ADV_CONNECTABLE_UNDIRECTED);
silviaChen 2:9f46fa6237dd 242 ble.gap().setAdvertisingInterval(50); /* 50ms */
silviaChen 2:9f46fa6237dd 243 ble.gap().startAdvertising();
silviaChen 2:9f46fa6237dd 244 uart.printf("Start advertising\r\n");
silviaChen 2:9f46fa6237dd 245 }
silviaChen 2:9f46fa6237dd 246
silviaChen 2:9f46fa6237dd 247 int main(void)
silviaChen 2:9f46fa6237dd 248 {
silviaChen 2:9f46fa6237dd 249 //led1 = 1;
silviaChen 2:9f46fa6237dd 250 //Ticker ticker;
silviaChen 2:9f46fa6237dd 251 //ticker.attach(periodicCallback, 1); // blink LED every second
silviaChen 2:9f46fa6237dd 252
silviaChen 2:9f46fa6237dd 253 uart.attach(&uart_interrupt);
silviaChen 2:9f46fa6237dd 254 uart.printf("Srarting HID Service\r\n");
silviaChen 2:9f46fa6237dd 255
silviaChen 2:9f46fa6237dd 256 BLE &deltaBLE = BLE::Instance(BLE::DEFAULT_INSTANCE);
silviaChen 2:9f46fa6237dd 257 deltaBLE.init(bleInitComplete);
silviaChen 2:9f46fa6237dd 258
silviaChen 2:9f46fa6237dd 259 /* SpinWait for initialization to complete. This is necessary because the
silviaChen 2:9f46fa6237dd 260 * BLE object is used in the main loop below. */
silviaChen 2:9f46fa6237dd 261 while (deltaBLE.hasInitialized() == false) { /* spin loop */ }
silviaChen 2:9f46fa6237dd 262
silviaChen 2:9f46fa6237dd 263 // infinite loop
silviaChen 2:9f46fa6237dd 264 while (1) {
silviaChen 2:9f46fa6237dd 265 deltaBLE.waitForEvent();
silviaChen 0:c7bcc0b36b5e 266 }
silviaChen 0:c7bcc0b36b5e 267 }