Neil Johnson / microbit-ARMBand

Official Sheffield ARMBand micro:bit program

microbit/microbit-dal/source/bluetooth/MicroBitButtonService.cpp@0:b9164b348919, 2016-10-17 (annotated)

Committer:
MrBedfordVan
Date:
Mon Oct 17 12:41:20 2016 +0000
Revision:
0:b9164b348919
Official Sheffield ARMBand Micro:bit program

Who changed what in which revision?

UserRevisionLine numberNew contents of line
MrBedfordVan 0:b9164b348919 1 /*
MrBedfordVan 0:b9164b348919 2 The MIT License (MIT)
MrBedfordVan 0:b9164b348919 3
MrBedfordVan 0:b9164b348919 4 Copyright (c) 2016 British Broadcasting Corporation.
MrBedfordVan 0:b9164b348919 5 This software is provided by Lancaster University by arrangement with the BBC.
MrBedfordVan 0:b9164b348919 6
MrBedfordVan 0:b9164b348919 7 Permission is hereby granted, free of charge, to any person obtaining a
MrBedfordVan 0:b9164b348919 8 copy of this software and associated documentation files (the "Software"),
MrBedfordVan 0:b9164b348919 9 to deal in the Software without restriction, including without limitation
MrBedfordVan 0:b9164b348919 10 the rights to use, copy, modify, merge, publish, distribute, sublicense,
MrBedfordVan 0:b9164b348919 11 and/or sell copies of the Software, and to permit persons to whom the
MrBedfordVan 0:b9164b348919 12 Software is furnished to do so, subject to the following conditions:
MrBedfordVan 0:b9164b348919 13
MrBedfordVan 0:b9164b348919 14 The above copyright notice and this permission notice shall be included in
MrBedfordVan 0:b9164b348919 15 all copies or substantial portions of the Software.
MrBedfordVan 0:b9164b348919 16
MrBedfordVan 0:b9164b348919 17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
MrBedfordVan 0:b9164b348919 18 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
MrBedfordVan 0:b9164b348919 19 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
MrBedfordVan 0:b9164b348919 20 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
MrBedfordVan 0:b9164b348919 21 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
MrBedfordVan 0:b9164b348919 22 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
MrBedfordVan 0:b9164b348919 23 DEALINGS IN THE SOFTWARE.
MrBedfordVan 0:b9164b348919 24 */
MrBedfordVan 0:b9164b348919 25
MrBedfordVan 0:b9164b348919 26 /**
MrBedfordVan 0:b9164b348919 27 * Class definition for the custom MicroBit Button Service.
MrBedfordVan 0:b9164b348919 28 * Provides a BLE service to remotely read the state of each button, and configure its behaviour.
MrBedfordVan 0:b9164b348919 29 */
MrBedfordVan 0:b9164b348919 30 #include "MicroBitConfig.h"
MrBedfordVan 0:b9164b348919 31 #include "ble/UUID.h"
MrBedfordVan 0:b9164b348919 32
MrBedfordVan 0:b9164b348919 33 #include "MicroBitButtonService.h"
MrBedfordVan 0:b9164b348919 34 #include "MicroBitButton.h"
MrBedfordVan 0:b9164b348919 35
MrBedfordVan 0:b9164b348919 36 /**
MrBedfordVan 0:b9164b348919 37 * Constructor.
MrBedfordVan 0:b9164b348919 38 * Create a representation of the ButtonService
MrBedfordVan 0:b9164b348919 39 * @param _ble The instance of a BLE device that we're running on.
MrBedfordVan 0:b9164b348919 40 */
MrBedfordVan 0:b9164b348919 41 MicroBitButtonService::MicroBitButtonService(BLEDevice &_ble) :
MrBedfordVan 0:b9164b348919 42 ble(_ble)
MrBedfordVan 0:b9164b348919 43 {
MrBedfordVan 0:b9164b348919 44 // Create the data structures that represent each of our characteristics in Soft Device.
MrBedfordVan 0:b9164b348919 45 GattCharacteristic buttonADataCharacteristic(MicroBitButtonAServiceDataUUID, (uint8_t *)&buttonADataCharacteristicBuffer, 0,
MrBedfordVan 0:b9164b348919 46 sizeof(buttonADataCharacteristicBuffer), GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_NOTIFY);
MrBedfordVan 0:b9164b348919 47
MrBedfordVan 0:b9164b348919 48 GattCharacteristic buttonBDataCharacteristic(MicroBitButtonBServiceDataUUID, (uint8_t *)&buttonBDataCharacteristicBuffer, 0,
MrBedfordVan 0:b9164b348919 49 sizeof(buttonBDataCharacteristicBuffer), GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_NOTIFY);
MrBedfordVan 0:b9164b348919 50
MrBedfordVan 0:b9164b348919 51
MrBedfordVan 0:b9164b348919 52 // Initialise our characteristic values.
MrBedfordVan 0:b9164b348919 53 buttonADataCharacteristicBuffer = 0;
MrBedfordVan 0:b9164b348919 54 buttonBDataCharacteristicBuffer = 0;
MrBedfordVan 0:b9164b348919 55
MrBedfordVan 0:b9164b348919 56 // Set default security requirements
MrBedfordVan 0:b9164b348919 57 buttonADataCharacteristic.requireSecurity(SecurityManager::MICROBIT_BLE_SECURITY_LEVEL);
MrBedfordVan 0:b9164b348919 58 buttonBDataCharacteristic.requireSecurity(SecurityManager::MICROBIT_BLE_SECURITY_LEVEL);
MrBedfordVan 0:b9164b348919 59
MrBedfordVan 0:b9164b348919 60 GattCharacteristic *characteristics[] = {&buttonADataCharacteristic, &buttonBDataCharacteristic};
MrBedfordVan 0:b9164b348919 61 GattService service(MicroBitButtonServiceUUID, characteristics, sizeof(characteristics) / sizeof(GattCharacteristic *));
MrBedfordVan 0:b9164b348919 62
MrBedfordVan 0:b9164b348919 63 ble.addService(service);
MrBedfordVan 0:b9164b348919 64
MrBedfordVan 0:b9164b348919 65 buttonADataCharacteristicHandle = buttonADataCharacteristic.getValueHandle();
MrBedfordVan 0:b9164b348919 66 buttonBDataCharacteristicHandle = buttonBDataCharacteristic.getValueHandle();
MrBedfordVan 0:b9164b348919 67
MrBedfordVan 0:b9164b348919 68 ble.gattServer().write(buttonADataCharacteristicHandle,(uint8_t *)&buttonADataCharacteristicBuffer, sizeof(buttonADataCharacteristicBuffer));
MrBedfordVan 0:b9164b348919 69 ble.gattServer().write(buttonBDataCharacteristicHandle,(uint8_t *)&buttonBDataCharacteristicBuffer, sizeof(buttonBDataCharacteristicBuffer));
MrBedfordVan 0:b9164b348919 70
MrBedfordVan 0:b9164b348919 71 if (EventModel::defaultEventBus)
MrBedfordVan 0:b9164b348919 72 {
MrBedfordVan 0:b9164b348919 73 EventModel::defaultEventBus->listen(MICROBIT_ID_BUTTON_A, MICROBIT_EVT_ANY, this, &MicroBitButtonService::buttonAUpdate, MESSAGE_BUS_LISTENER_IMMEDIATE);
MrBedfordVan 0:b9164b348919 74 EventModel::defaultEventBus->listen(MICROBIT_ID_BUTTON_B, MICROBIT_EVT_ANY, this, &MicroBitButtonService::buttonBUpdate, MESSAGE_BUS_LISTENER_IMMEDIATE);
MrBedfordVan 0:b9164b348919 75 }
MrBedfordVan 0:b9164b348919 76 }
MrBedfordVan 0:b9164b348919 77
MrBedfordVan 0:b9164b348919 78
MrBedfordVan 0:b9164b348919 79 /**
MrBedfordVan 0:b9164b348919 80 * Button B update callback
MrBedfordVan 0:b9164b348919 81 */
MrBedfordVan 0:b9164b348919 82 void MicroBitButtonService::buttonAUpdate(MicroBitEvent e)
MrBedfordVan 0:b9164b348919 83 {
MrBedfordVan 0:b9164b348919 84 if (ble.getGapState().connected)
MrBedfordVan 0:b9164b348919 85 {
MrBedfordVan 0:b9164b348919 86 if (e.value == MICROBIT_BUTTON_EVT_UP)
MrBedfordVan 0:b9164b348919 87 {
MrBedfordVan 0:b9164b348919 88 buttonADataCharacteristicBuffer = 0;
MrBedfordVan 0:b9164b348919 89 ble.gattServer().notify(buttonADataCharacteristicHandle,(uint8_t *)&buttonADataCharacteristicBuffer, sizeof(buttonADataCharacteristicBuffer));
MrBedfordVan 0:b9164b348919 90 }
MrBedfordVan 0:b9164b348919 91
MrBedfordVan 0:b9164b348919 92 if (e.value == MICROBIT_BUTTON_EVT_DOWN)
MrBedfordVan 0:b9164b348919 93 {
MrBedfordVan 0:b9164b348919 94 buttonADataCharacteristicBuffer = 1;
MrBedfordVan 0:b9164b348919 95 ble.gattServer().notify(buttonADataCharacteristicHandle,(uint8_t *)&buttonADataCharacteristicBuffer, sizeof(buttonADataCharacteristicBuffer));
MrBedfordVan 0:b9164b348919 96 }
MrBedfordVan 0:b9164b348919 97
MrBedfordVan 0:b9164b348919 98 if (e.value == MICROBIT_BUTTON_EVT_HOLD)
MrBedfordVan 0:b9164b348919 99 {
MrBedfordVan 0:b9164b348919 100 buttonADataCharacteristicBuffer = 2;
MrBedfordVan 0:b9164b348919 101 ble.gattServer().notify(buttonADataCharacteristicHandle,(uint8_t *)&buttonADataCharacteristicBuffer, sizeof(buttonADataCharacteristicBuffer));
MrBedfordVan 0:b9164b348919 102 }
MrBedfordVan 0:b9164b348919 103 }
MrBedfordVan 0:b9164b348919 104 }
MrBedfordVan 0:b9164b348919 105
MrBedfordVan 0:b9164b348919 106 /**
MrBedfordVan 0:b9164b348919 107 * Button A update callback
MrBedfordVan 0:b9164b348919 108 */
MrBedfordVan 0:b9164b348919 109 void MicroBitButtonService::buttonBUpdate(MicroBitEvent e)
MrBedfordVan 0:b9164b348919 110 {
MrBedfordVan 0:b9164b348919 111 if (ble.getGapState().connected)
MrBedfordVan 0:b9164b348919 112 {
MrBedfordVan 0:b9164b348919 113 if (e.value == MICROBIT_BUTTON_EVT_UP)
MrBedfordVan 0:b9164b348919 114 {
MrBedfordVan 0:b9164b348919 115 buttonBDataCharacteristicBuffer = 0;
MrBedfordVan 0:b9164b348919 116 ble.gattServer().notify(buttonBDataCharacteristicHandle,(uint8_t *)&buttonBDataCharacteristicBuffer, sizeof(buttonBDataCharacteristicBuffer));
MrBedfordVan 0:b9164b348919 117 }
MrBedfordVan 0:b9164b348919 118
MrBedfordVan 0:b9164b348919 119 if (e.value == MICROBIT_BUTTON_EVT_DOWN)
MrBedfordVan 0:b9164b348919 120 {
MrBedfordVan 0:b9164b348919 121 buttonBDataCharacteristicBuffer = 1;
MrBedfordVan 0:b9164b348919 122 ble.gattServer().notify(buttonBDataCharacteristicHandle,(uint8_t *)&buttonBDataCharacteristicBuffer, sizeof(buttonBDataCharacteristicBuffer));
MrBedfordVan 0:b9164b348919 123 }
MrBedfordVan 0:b9164b348919 124
MrBedfordVan 0:b9164b348919 125 if (e.value == MICROBIT_BUTTON_EVT_HOLD)
MrBedfordVan 0:b9164b348919 126 {
MrBedfordVan 0:b9164b348919 127 buttonBDataCharacteristicBuffer = 2;
MrBedfordVan 0:b9164b348919 128 ble.gattServer().notify(buttonBDataCharacteristicHandle,(uint8_t *)&buttonBDataCharacteristicBuffer, sizeof(buttonBDataCharacteristicBuffer));
MrBedfordVan 0:b9164b348919 129 }
MrBedfordVan 0:b9164b348919 130 }
MrBedfordVan 0:b9164b348919 131 }
MrBedfordVan 0:b9164b348919 132
MrBedfordVan 0:b9164b348919 133 const uint8_t MicroBitButtonServiceUUID[] = {
MrBedfordVan 0:b9164b348919 134 0xe9,0x5d,0x98,0x82,0x25,0x1d,0x47,0x0a,0xa0,0x62,0xfa,0x19,0x22,0xdf,0xa9,0xa8
MrBedfordVan 0:b9164b348919 135 };
MrBedfordVan 0:b9164b348919 136
MrBedfordVan 0:b9164b348919 137 const uint8_t MicroBitButtonAServiceDataUUID[] = {
MrBedfordVan 0:b9164b348919 138 0xe9,0x5d,0xda,0x90,0x25,0x1d,0x47,0x0a,0xa0,0x62,0xfa,0x19,0x22,0xdf,0xa9,0xa8
MrBedfordVan 0:b9164b348919 139 }
MrBedfordVan 0:b9164b348919 140 ;
MrBedfordVan 0:b9164b348919 141 const uint8_t MicroBitButtonBServiceDataUUID[] = {
MrBedfordVan 0:b9164b348919 142 0xe9,0x5d,0xda,0x91,0x25,0x1d,0x47,0x0a,0xa0,0x62,0xfa,0x19,0x22,0xdf,0xa9,0xa8
MrBedfordVan 0:b9164b348919 143 };