Hiroh Satoh / keyboard Featured

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   BLE_API mbed-dev nRF51822

HIDController_BLE.cpp@37:4ce71fa47fc3, 2016-08-26 (annotated)

Committer:
cho45
Date:
Fri Aug 26 00:22:05 2016 +0000
Revision:
37:4ce71fa47fc3
Parent:
34:7da766a8aa96
Child:
38:115875b8cb6c
?????????????(?????)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
cho45 6:f1c3ea8bc850 1 #include "mbed.h"
cho45 6:f1c3ea8bc850 2 #include "BLE.h"
cho45 6:f1c3ea8bc850 3 #include "KeyboardService.h"
cho45 6:f1c3ea8bc850 4 #include "BatteryService.h"
cho45 6:f1c3ea8bc850 5 #include "DeviceInformationService.h"
cho45 15:70bf079d3ee1 6 #include "DFUService.h"
cho45 6:f1c3ea8bc850 7 #include "HIDController_BLE.h"
cho45 6:f1c3ea8bc850 8
cho45 6:f1c3ea8bc850 9 static const char MODEL_NAME[] = "keyboard";
cho45 6:f1c3ea8bc850 10 static const char SERIAL_NUMBER[] = "X00000";
cho45 6:f1c3ea8bc850 11 static const char HARDWARE_REVISION[] = "0.1";
cho45 6:f1c3ea8bc850 12 static const char FIRMWARE_REVISION[] = "0.1";
cho45 6:f1c3ea8bc850 13 static const char SOFTWARE_REVISION[] = "0.0";
cho45 6:f1c3ea8bc850 14
cho45 6:f1c3ea8bc850 15 static const uint8_t DEVICE_NAME[] = "my keyboard";
cho45 6:f1c3ea8bc850 16 static const uint8_t SHORT_DEVICE_NAME[] = "kbd1";
cho45 6:f1c3ea8bc850 17
cho45 6:f1c3ea8bc850 18 static const bool ENABLE_BONDING = true;
cho45 6:f1c3ea8bc850 19 static const bool REQUIRE_MITM = true;
cho45 6:f1c3ea8bc850 20 static const uint8_t PASSKEY[6] = {'1','2','3','4','5','6'}; // must be 6-digits number
cho45 6:f1c3ea8bc850 21
cho45 6:f1c3ea8bc850 22 static const uint16_t uuid16_list[] = {
cho45 6:f1c3ea8bc850 23 GattService::UUID_HUMAN_INTERFACE_DEVICE_SERVICE,
cho45 6:f1c3ea8bc850 24 GattService::UUID_DEVICE_INFORMATION_SERVICE,
cho45 6:f1c3ea8bc850 25 GattService::UUID_BATTERY_SERVICE
cho45 6:f1c3ea8bc850 26 };
cho45 6:f1c3ea8bc850 27
cho45 6:f1c3ea8bc850 28 static KeyboardService* keyboardService;
cho45 6:f1c3ea8bc850 29 static BatteryService* batteryService;
cho45 6:f1c3ea8bc850 30 static DeviceInformationService* deviceInformationService;
cho45 15:70bf079d3ee1 31 static DFUService* dfuService;
cho45 6:f1c3ea8bc850 32
cho45 13:b0ffdf2012b9 33 static BLEProtocol::Address_t peerAddress;
cho45 27:7370b8994603 34
cho45 27:7370b8994603 35 static volatile Status_t controllerStatus;
cho45 13:b0ffdf2012b9 36
cho45 6:f1c3ea8bc850 37 static void onConnect(const Gap::ConnectionCallbackParams_t *params) {
cho45 13:b0ffdf2012b9 38 peerAddress.type = params->peerAddrType;
cho45 13:b0ffdf2012b9 39 memcpy(peerAddress.address, params->peerAddr, Gap::ADDR_LEN);
cho45 34:7da766a8aa96 40 // TODO whitelist に peerAddr が含まれていない場合 securitySetupCompletedCallback を待ってから CONNECTED にすべき
cho45 29:ec548c473d50 41 controllerStatus = CONNECTED;
cho45 6:f1c3ea8bc850 42 }
cho45 6:f1c3ea8bc850 43
cho45 6:f1c3ea8bc850 44 static void onDisconnect(const Gap::DisconnectionCallbackParams_t *params) {
cho45 27:7370b8994603 45 controllerStatus = DISCONNECTED;
cho45 6:f1c3ea8bc850 46 BLE::Instance(BLE::DEFAULT_INSTANCE).gap().startAdvertising();
cho45 6:f1c3ea8bc850 47 }
cho45 6:f1c3ea8bc850 48
cho45 6:f1c3ea8bc850 49 static void onTimeout(const Gap::TimeoutSource_t source) {
cho45 32:6c0f43fda460 50 controllerStatus = TIMEOUT;
cho45 6:f1c3ea8bc850 51 BLE::Instance(BLE::DEFAULT_INSTANCE).gap().startAdvertising();
cho45 6:f1c3ea8bc850 52 }
cho45 6:f1c3ea8bc850 53
cho45 6:f1c3ea8bc850 54 static void passkeyDisplayCallback(Gap::Handle_t handle, const SecurityManager::Passkey_t passkey) {
cho45 29:ec548c473d50 55 /*
cho45 6:f1c3ea8bc850 56 printf("Input passKey: ");
cho45 6:f1c3ea8bc850 57 for (unsigned i = 0; i < Gap::ADDR_LEN; i++) {
cho45 6:f1c3ea8bc850 58 printf("%c", passkey[i]);
cho45 6:f1c3ea8bc850 59 }
cho45 6:f1c3ea8bc850 60 printf("\r\n");
cho45 29:ec548c473d50 61 */
cho45 6:f1c3ea8bc850 62 }
cho45 6:f1c3ea8bc850 63
cho45 6:f1c3ea8bc850 64 static void securitySetupCompletedCallback(Gap::Handle_t handle, SecurityManager::SecurityCompletionStatus_t status) {
cho45 6:f1c3ea8bc850 65 if (status == SecurityManager::SEC_STATUS_SUCCESS) {
cho45 29:ec548c473d50 66 /*
cho45 6:f1c3ea8bc850 67 printf("Security success %d\r\n", status);
cho45 13:b0ffdf2012b9 68 printf("Set whitelist\r\n");
cho45 29:ec548c473d50 69 */
cho45 13:b0ffdf2012b9 70 Gap::Whitelist_t whitelist;
cho45 13:b0ffdf2012b9 71 whitelist.size = 1;
cho45 13:b0ffdf2012b9 72 whitelist.capacity = 1;
cho45 13:b0ffdf2012b9 73 whitelist.addresses = &peerAddress;
cho45 13:b0ffdf2012b9 74
cho45 13:b0ffdf2012b9 75 BLE::Instance(BLE::DEFAULT_INSTANCE).gap().setWhitelist(whitelist);
cho45 29:ec548c473d50 76 //printf("Set Advertising Policy Mode\r\n");
cho45 13:b0ffdf2012b9 77 // BLE::Instance(BLE::DEFAULT_INSTANCE).gap().setAdvertisingPolicyMode(Gap::ADV_POLICY_FILTER_SCAN_REQS);
cho45 13:b0ffdf2012b9 78 // BLE::Instance(BLE::DEFAULT_INSTANCE).gap().setAdvertisingPolicyMode(Gap::ADV_POLICY_FILTER_CONN_REQS);
cho45 13:b0ffdf2012b9 79 BLE::Instance(BLE::DEFAULT_INSTANCE).gap().setAdvertisingPolicyMode(Gap::ADV_POLICY_FILTER_ALL_REQS);
cho45 6:f1c3ea8bc850 80 } else {
cho45 29:ec548c473d50 81 //printf("Security failed %d\r\n", status);
cho45 6:f1c3ea8bc850 82 }
cho45 6:f1c3ea8bc850 83 }
cho45 6:f1c3ea8bc850 84
cho45 6:f1c3ea8bc850 85 static void securitySetupInitiatedCallback(Gap::Handle_t, bool allowBonding, bool requireMITM, SecurityManager::SecurityIOCapabilities_t iocaps) {
cho45 29:ec548c473d50 86 // printf("Security setup initiated\r\n");
cho45 6:f1c3ea8bc850 87 }
cho45 6:f1c3ea8bc850 88
cho45 6:f1c3ea8bc850 89 static void bleInitComplete(BLE::InitializationCompleteCallbackContext *params) {
cho45 6:f1c3ea8bc850 90 // https://developer.mbed.org/compiler/#nav:/keyboard/BLE_API/ble/blecommon.h;
cho45 6:f1c3ea8bc850 91 ble_error_t error;
cho45 6:f1c3ea8bc850 92 BLE &ble = params->ble;
cho45 23:b31957ce64e9 93
cho45 27:7370b8994603 94 controllerStatus = DISCONNECTED;
cho45 16:345eebc4f259 95
cho45 16:345eebc4f259 96 /**< Minimum Connection Interval in 1.25 ms units, see BLE_GAP_CP_LIMITS.*/
cho45 29:ec548c473d50 97 uint16_t minConnectionInterval = Gap::MSEC_TO_GAP_DURATION_UNITS(20);
cho45 16:345eebc4f259 98 /**< Maximum Connection Interval in 1.25 ms units, see BLE_GAP_CP_LIMITS.*/
cho45 29:ec548c473d50 99 uint16_t maxConnectionInterval = Gap::MSEC_TO_GAP_DURATION_UNITS(40);
cho45 16:345eebc4f259 100 /**< Slave Latency in number of connection events, see BLE_GAP_CP_LIMITS.*/
cho45 29:ec548c473d50 101 uint16_t slaveLatency = 4;
cho45 16:345eebc4f259 102 /**< Connection Supervision Timeout in 10 ms units, see BLE_GAP_CP_LIMITS.*/
cho45 16:345eebc4f259 103 uint16_t connectionSupervisionTimeout = 32 * 100;
cho45 16:345eebc4f259 104 Gap::ConnectionParams_t connectionParams = {
cho45 16:345eebc4f259 105 minConnectionInterval,
cho45 16:345eebc4f259 106 maxConnectionInterval,
cho45 16:345eebc4f259 107 slaveLatency,
cho45 16:345eebc4f259 108 connectionSupervisionTimeout
cho45 16:345eebc4f259 109 };
cho45 16:345eebc4f259 110
cho45 6:f1c3ea8bc850 111 error = params->error;
cho45 6:f1c3ea8bc850 112 if (error != BLE_ERROR_NONE) {
cho45 6:f1c3ea8bc850 113 printf("error on ble.init() \r\n");
cho45 6:f1c3ea8bc850 114 goto return_error;
cho45 6:f1c3ea8bc850 115 }
cho45 6:f1c3ea8bc850 116
cho45 6:f1c3ea8bc850 117 ble.gap().onDisconnection(onDisconnect);
cho45 6:f1c3ea8bc850 118 ble.gap().onConnection(onConnect);
cho45 6:f1c3ea8bc850 119 ble.gap().onTimeout(onTimeout);
cho45 6:f1c3ea8bc850 120
cho45 17:3233ee19f716 121 // printf("setup ble security manager\r\n");
cho45 6:f1c3ea8bc850 122 ble.securityManager().onSecuritySetupInitiated(securitySetupInitiatedCallback);
cho45 6:f1c3ea8bc850 123 ble.securityManager().onPasskeyDisplay(passkeyDisplayCallback);
cho45 6:f1c3ea8bc850 124 ble.securityManager().onSecuritySetupCompleted(securitySetupCompletedCallback);
cho45 6:f1c3ea8bc850 125 // bonding with hard-coded passkey.
cho45 6:f1c3ea8bc850 126 error = ble.securityManager().init(ENABLE_BONDING, REQUIRE_MITM, SecurityManager::IO_CAPS_DISPLAY_ONLY, PASSKEY);
cho45 6:f1c3ea8bc850 127 if (error != BLE_ERROR_NONE) {
cho45 6:f1c3ea8bc850 128 printf("error on ble.securityManager().init()");
cho45 6:f1c3ea8bc850 129 goto return_error;
cho45 6:f1c3ea8bc850 130 }
cho45 16:345eebc4f259 131
cho45 6:f1c3ea8bc850 132
cho45 17:3233ee19f716 133 // printf("new KeyboardService\r\n");
cho45 6:f1c3ea8bc850 134 keyboardService = new KeyboardService(ble);
cho45 17:3233ee19f716 135 // printf("new DeviceInformationService\r\n");
cho45 6:f1c3ea8bc850 136 deviceInformationService = new DeviceInformationService(ble, "lowreal.net", MODEL_NAME, SERIAL_NUMBER, HARDWARE_REVISION, FIRMWARE_REVISION, SOFTWARE_REVISION);
cho45 17:3233ee19f716 137 // printf("new BatteryService\r\n");
cho45 6:f1c3ea8bc850 138 batteryService = new BatteryService(ble, 100);
cho45 37:4ce71fa47fc3 139 /** TODO
cho45 16:345eebc4f259 140 printf("new DFUService\r\n");
cho45 16:345eebc4f259 141 dfuService = new DFUService(ble);
cho45 16:345eebc4f259 142 */
cho45 16:345eebc4f259 143
cho45 17:3233ee19f716 144 //printf("setup connection params\r\n");
cho45 16:345eebc4f259 145
cho45 16:345eebc4f259 146 ble.gap().setPreferredConnectionParams(&connectionParams);
cho45 6:f1c3ea8bc850 147
cho45 17:3233ee19f716 148 // printf("general setup\r\n");
cho45 6:f1c3ea8bc850 149 error = ble.gap().accumulateAdvertisingPayload(
cho45 6:f1c3ea8bc850 150 GapAdvertisingData::BREDR_NOT_SUPPORTED |
cho45 6:f1c3ea8bc850 151 GapAdvertisingData::LE_GENERAL_DISCOVERABLE
cho45 6:f1c3ea8bc850 152 );
cho45 9:d1daefbf1fbd 153 // shoud be LE_LIMITED_DISCOVERABLE
cho45 9:d1daefbf1fbd 154 // error = ble.gap().accumulateAdvertisingPayload(
cho45 9:d1daefbf1fbd 155 // GapAdvertisingData::BREDR_NOT_SUPPORTED |
cho45 9:d1daefbf1fbd 156 // GapAdvertisingData::LE_LIMITED_DISCOVERABLE
cho45 9:d1daefbf1fbd 157 // );
cho45 6:f1c3ea8bc850 158 if (error != BLE_ERROR_NONE) goto return_error;
cho45 6:f1c3ea8bc850 159
cho45 17:3233ee19f716 160 // printf("set COMPLETE_LIST_16BIT_SERVICE_IDS\r\n");
cho45 6:f1c3ea8bc850 161 error = ble.gap().accumulateAdvertisingPayload(
cho45 6:f1c3ea8bc850 162 GapAdvertisingData::COMPLETE_LIST_16BIT_SERVICE_IDS,
cho45 6:f1c3ea8bc850 163 (uint8_t*)uuid16_list, sizeof(uuid16_list)
cho45 6:f1c3ea8bc850 164 );
cho45 6:f1c3ea8bc850 165 if (error != BLE_ERROR_NONE) goto return_error;
cho45 6:f1c3ea8bc850 166
cho45 17:3233ee19f716 167 // printf("set advertising\r\n");
cho45 6:f1c3ea8bc850 168 // see 5.1.2: HID over GATT Specification (pg. 25)
cho45 6:f1c3ea8bc850 169 ble.gap().setAdvertisingType(GapAdvertisingParams::ADV_CONNECTABLE_UNDIRECTED);
cho45 6:f1c3ea8bc850 170
cho45 17:3233ee19f716 171 // printf("set advertising interval\r\n");
cho45 28:1f843a3daab0 172 ble.gap().setAdvertisingInterval(20);
cho45 17:3233ee19f716 173 // printf("set advertising timeout\r\n");
cho45 9:d1daefbf1fbd 174 ble.gap().setAdvertisingTimeout(180);
cho45 28:1f843a3daab0 175
cho45 28:1f843a3daab0 176 /*
cho45 28:1f843a3daab0 177 ble.gap().setAdvertisingType(GapAdvertisingParams::ADV_CONNECTABLE_DIRECTED);
cho45 28:1f843a3daab0 178 ble.gap().setAdvertisingTimeout(1.28);
cho45 28:1f843a3daab0 179 */
cho45 6:f1c3ea8bc850 180
cho45 17:3233ee19f716 181 // printf("set keyboard\r\n");
cho45 6:f1c3ea8bc850 182 error = ble.gap().accumulateAdvertisingPayload(GapAdvertisingData::KEYBOARD);
cho45 6:f1c3ea8bc850 183 if (error != BLE_ERROR_NONE) goto return_error;
cho45 6:f1c3ea8bc850 184
cho45 17:3233ee19f716 185 // printf("set complete local name\r\n");
cho45 6:f1c3ea8bc850 186 error = ble.gap().accumulateAdvertisingPayload(
cho45 6:f1c3ea8bc850 187 GapAdvertisingData::COMPLETE_LOCAL_NAME,
cho45 6:f1c3ea8bc850 188 DEVICE_NAME, sizeof(DEVICE_NAME)
cho45 6:f1c3ea8bc850 189 );
cho45 6:f1c3ea8bc850 190 if (error != BLE_ERROR_NONE) goto return_error;
cho45 6:f1c3ea8bc850 191
cho45 17:3233ee19f716 192 // printf("set device name\r\n");
cho45 6:f1c3ea8bc850 193 error = ble.gap().setDeviceName(DEVICE_NAME);
cho45 6:f1c3ea8bc850 194 if (error != BLE_ERROR_NONE) goto return_error;
cho45 22:a78f0a91280a 195 /* (Valid values are -40, -20, -16, -12, -8, -4, 0, 4) */
cho45 19:cd7f2fe05ae4 196 ble.gap().setTxPower(0);
cho45 6:f1c3ea8bc850 197
cho45 32:6c0f43fda460 198 ble.gap().setAdvertisingPolicyMode(Gap::ADV_POLICY_IGNORE_WHITELIST);
cho45 23:b31957ce64e9 199
cho45 6:f1c3ea8bc850 200
cho45 32:6c0f43fda460 201 // printf("advertising\r\n");
cho45 6:f1c3ea8bc850 202 error = ble.gap().startAdvertising();
cho45 6:f1c3ea8bc850 203 if (error != BLE_ERROR_NONE) goto return_error;
cho45 32:6c0f43fda460 204 controllerStatus = ADVERTISING;
cho45 6:f1c3ea8bc850 205 return;
cho45 6:f1c3ea8bc850 206
cho45 6:f1c3ea8bc850 207 return_error:
cho45 6:f1c3ea8bc850 208 printf("error with %d\r\n", error);
cho45 6:f1c3ea8bc850 209 return;
cho45 6:f1c3ea8bc850 210 }
cho45 6:f1c3ea8bc850 211
cho45 20:d8840ac38434 212 bool HIDController::connected() {
cho45 27:7370b8994603 213 return controllerStatus == CONNECTED;
cho45 27:7370b8994603 214 }
cho45 27:7370b8994603 215
cho45 27:7370b8994603 216 Status_t HIDController::status() {
cho45 27:7370b8994603 217 return controllerStatus;
cho45 20:d8840ac38434 218 }
cho45 20:d8840ac38434 219
cho45 32:6c0f43fda460 220 const char* HIDController::statusString() {
cho45 32:6c0f43fda460 221 static const char* disconnected = "disconnected";
cho45 32:6c0f43fda460 222 static const char* connecting = "connecting";
cho45 32:6c0f43fda460 223 static const char* connected = "connected";
cho45 32:6c0f43fda460 224 static const char* timeout = "timeout";
cho45 32:6c0f43fda460 225 static const char* advertising = "advertising";
cho45 32:6c0f43fda460 226 static const char* unknown = "unknown";
cho45 32:6c0f43fda460 227
cho45 32:6c0f43fda460 228 return controllerStatus == DISCONNECTED ? disconnected:
cho45 32:6c0f43fda460 229 controllerStatus == CONNECTING ? connecting:
cho45 32:6c0f43fda460 230 controllerStatus == CONNECTED ? connected:
cho45 32:6c0f43fda460 231 controllerStatus == TIMEOUT ? timeout:
cho45 32:6c0f43fda460 232 controllerStatus == ADVERTISING ? advertising:
cho45 32:6c0f43fda460 233 unknown;
cho45 32:6c0f43fda460 234 }
cho45 32:6c0f43fda460 235
cho45 6:f1c3ea8bc850 236 void HIDController::init() {
cho45 6:f1c3ea8bc850 237 // https://github.com/jpbrucker/BLE_HID/blob/master/examples/examples_common.cpp
cho45 6:f1c3ea8bc850 238 printf("ble.init\r\n");
cho45 6:f1c3ea8bc850 239
cho45 6:f1c3ea8bc850 240 BLE& ble = BLE::Instance(BLE::DEFAULT_INSTANCE);
cho45 6:f1c3ea8bc850 241 ble.init(bleInitComplete);
cho45 6:f1c3ea8bc850 242
cho45 6:f1c3ea8bc850 243 while (!ble.hasInitialized()) { }
cho45 6:f1c3ea8bc850 244 printf("ble.hasIntialized\r\n");
cho45 6:f1c3ea8bc850 245 }
cho45 6:f1c3ea8bc850 246
cho45 22:a78f0a91280a 247
cho45 10:1aed2481a743 248 void HIDController::waitForEvent() {
cho45 6:f1c3ea8bc850 249 BLE& ble = BLE::Instance(BLE::DEFAULT_INSTANCE);
cho45 21:d801c32231b0 250 keyboardService->stopReportTicker();
cho45 6:f1c3ea8bc850 251 ble.waitForEvent();
cho45 6:f1c3ea8bc850 252 }
cho45 6:f1c3ea8bc850 253
cho45 6:f1c3ea8bc850 254 void HIDController::appendReportData(uint8_t key) {
cho45 6:f1c3ea8bc850 255 if (keyboardService) {
cho45 6:f1c3ea8bc850 256 keyboardService->appendReportData(key);
cho45 6:f1c3ea8bc850 257 }
cho45 6:f1c3ea8bc850 258 }
cho45 6:f1c3ea8bc850 259
cho45 6:f1c3ea8bc850 260 void HIDController::deleteReportData(uint8_t key) {
cho45 6:f1c3ea8bc850 261 if (keyboardService) {
cho45 6:f1c3ea8bc850 262 keyboardService->deleteReportData(key);
cho45 6:f1c3ea8bc850 263 }
cho45 6:f1c3ea8bc850 264 }
cho45 9:d1daefbf1fbd 265
cho45 9:d1daefbf1fbd 266 void HIDController::queueCurrentReportData() {
cho45 29:ec548c473d50 267 if (!connected()) return;
cho45 9:d1daefbf1fbd 268 if (keyboardService) {
cho45 30:f9ebc769118d 269 printf("Q\r\n");
cho45 9:d1daefbf1fbd 270 keyboardService->queueCurrentReportData();
cho45 9:d1daefbf1fbd 271 }
cho45 9:d1daefbf1fbd 272 }
cho45 37:4ce71fa47fc3 273
cho45 37:4ce71fa47fc3 274 void HIDController::updateBatteryLevel(uint8_t percentage) {
cho45 37:4ce71fa47fc3 275 if (!batteryService) return;
cho45 37:4ce71fa47fc3 276 batteryService->updateBatteryLevel(percentage);
cho45 37:4ce71fa47fc3 277 }
cho45 37:4ce71fa47fc3 278