From 29861193f31221645a9b8c70fac8acc49e8ebb61 Mon Sep 17 00:00:00 2001 From: Paolo Calao Date: Mon, 2 Nov 2020 15:30:38 +0100 Subject: [PATCH 01/83] Add enhanced advertising examples While the old way of preparing advertising data is still supported, an alternative enhanced method to build advertising packets is now available. It consists in defining and configuring an object of type 'BLEAdvertisingData' to build the desired packet. When it has been configured, by setting the appropriate parameters, it can be used to populate the advertising data packet or the scan response data packet. Following this way, the user can decide in which packet each parameter should be put. Also, it is now possible to configure an advertising packet (advertising or scan response) by passing a raw data packet. If an advertising packet has a raw data parameter set, all its other parameters will be ignored. Also, advertising parameters such as manufacturer data, service data or raw data should have a GLOBAL scope, because they are passed as pointers and are not copied internally. --- .../EnhancedAdvertising.ino | 44 +++++++++++++++++++ .../RawDataAdvertising/RawDataAdvertising.ino | 41 +++++++++++++++++ 2 files changed, 85 insertions(+) create mode 100644 examples/Peripheral/Advertising/EnhancedAdvertising/EnhancedAdvertising.ino create mode 100644 examples/Peripheral/Advertising/RawDataAdvertising/RawDataAdvertising.ino diff --git a/examples/Peripheral/Advertising/EnhancedAdvertising/EnhancedAdvertising.ino b/examples/Peripheral/Advertising/EnhancedAdvertising/EnhancedAdvertising.ino new file mode 100644 index 00000000..979b69a8 --- /dev/null +++ b/examples/Peripheral/Advertising/EnhancedAdvertising/EnhancedAdvertising.ino @@ -0,0 +1,44 @@ +#include + +BLEService myService("fff0"); +BLEIntCharacteristic myCharacteristic("fff1", BLERead | BLEBroadcast); + +// Advertising parameters should have a global scope. Do NOT define them in 'setup' or in 'loop' +const uint8_t manufactData[4] = {0x01, 0x02, 0x03, 0x04}; +const uint8_t serviceData[3] = {0x00, 0x01, 0x02}; + +void setup() { + Serial.begin(9600); + while (!Serial); + + if (!BLE.begin()) { + Serial.println("failed to initialize BLE!"); + while (1); + } + + myService.addCharacteristic(myCharacteristic); + BLE.addService(myService); + + // Build scan response data packet + BLEAdvertisingData scanData; + // Set parameters for scan response packet + scanData.setLocalName("Test enhanced advertising"); + // Copy set parameters in the actual scan response packet + BLE.setScanResponseData(scanData); + + // Build advertising data packet + BLEAdvertisingData advData; + // Set parameters for advertising packet + advData.setManufacturerData(0x004C, manufactData, sizeof(manufactData)); + advData.setAdvertisedService(myService); + advData.setAdvertisedServiceData(0xfff0, serviceData, sizeof(serviceData)); + // Copy set parameters in the actual advertising packet + BLE.setAdvertisingData(advData); + + BLE.advertise(); + Serial.println("advertising ..."); +} + +void loop() { + BLE.poll(); +} diff --git a/examples/Peripheral/Advertising/RawDataAdvertising/RawDataAdvertising.ino b/examples/Peripheral/Advertising/RawDataAdvertising/RawDataAdvertising.ino new file mode 100644 index 00000000..d025dd62 --- /dev/null +++ b/examples/Peripheral/Advertising/RawDataAdvertising/RawDataAdvertising.ino @@ -0,0 +1,41 @@ +#include + +BLEService myService("fff0"); +BLEIntCharacteristic myCharacteristic("fff1", BLERead | BLEBroadcast); + +// Advertising parameters should have a global scope. Do NOT define them in 'setup' or in 'loop' +const uint8_t completeRawAdvertisingData[] = {0x02,0x01,0x06,0x09,0xff,0x01,0x01,0x00,0x01,0x02,0x03,0x04,0x05}; + +void setup() { + Serial.begin(9600); + while (!Serial); + + if (!BLE.begin()) { + Serial.println("failed to initialize BLE!"); + while (1); + } + + myService.addCharacteristic(myCharacteristic); + BLE.addService(myService); + + // Build advertising data packet + BLEAdvertisingData advData; + // If a packet has a raw data parameter, then all the other parameters of the packet will be ignored + advData.setRawData(completeRawAdvertisingData, sizeof(completeRawAdvertisingData)); + // Copy set parameters in the actual advertising packet + BLE.setAdvertisingData(advData); + + // Build scan response data packet + BLEAdvertisingData scanData; + scanData.setLocalName("Test advertising raw data"); + // Copy set parameters in the actual scan response packet + BLE.setScanResponseData(scanData); + + BLE.advertise(); + + Serial.println("advertising ..."); +} + +void loop() { + BLE.poll(); +} From c66379882f727276b74c319c1ec9fa824fc96bf1 Mon Sep 17 00:00:00 2001 From: unknownconstant Date: Fri, 1 Jan 2021 11:22:34 +0000 Subject: [PATCH 02/83] Initial - encrypted read --- src/ArduinoBLE.h | 1 + src/BLEProperty.h | 40 ++- src/local/BLELocalDevice.cpp | 4 + src/local/BLELocalDevice.h | 1 + src/utility/ATT.cpp | 132 +++++++- src/utility/ATT.h | 23 +- src/utility/HCI.cpp | 571 ++++++++++++++++++++++++++++----- src/utility/HCI.h | 37 ++- src/utility/L2CAPSignaling.cpp | 204 +++++++++++- src/utility/L2CAPSignaling.h | 22 ++ src/utility/btct.cpp | 322 +++++++++++++++++++ src/utility/btct.h | 26 ++ 12 files changed, 1301 insertions(+), 82 deletions(-) create mode 100644 src/utility/btct.cpp create mode 100644 src/utility/btct.h diff --git a/src/ArduinoBLE.h b/src/ArduinoBLE.h index dc6e8188..588d5cb1 100644 --- a/src/ArduinoBLE.h +++ b/src/ArduinoBLE.h @@ -24,5 +24,6 @@ #include "BLEProperty.h" #include "BLEStringCharacteristic.h" #include "BLETypedCharacteristics.h" +#include "utility/btct.h" #endif diff --git a/src/BLEProperty.h b/src/BLEProperty.h index 6cdd888f..aeee4c85 100644 --- a/src/BLEProperty.h +++ b/src/BLEProperty.h @@ -17,6 +17,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ +// #include + #ifndef _BLE_PROPERTY_H_ #define _BLE_PROPERTY_H_ @@ -26,7 +28,43 @@ enum BLEProperty { BLEWriteWithoutResponse = 0x04, BLEWrite = 0x08, BLENotify = 0x10, - BLEIndicate = 0x20 + BLEIndicate = 0x20, + BLEAuth = 1 << 6, + BLEExtProp = 1 << 7, +}; + +#define ESP_GATT_CHAR_PROP_BIT_BROADCAST (1 << 0) /* 0x01 */ /* relate to BTA_GATT_CHAR_PROP_BIT_BROADCAST in bta/bta_gatt_api.h */ +#define ESP_GATT_CHAR_PROP_BIT_READ (1 << 1) /* 0x02 */ /* relate to BTA_GATT_CHAR_PROP_BIT_READ in bta/bta_gatt_api.h */ +#define ESP_GATT_CHAR_PROP_BIT_WRITE_NR (1 << 2) /* 0x04 */ /* relate to BTA_GATT_CHAR_PROP_BIT_WRITE_NR in bta/bta_gatt_api.h */ +#define ESP_GATT_CHAR_PROP_BIT_WRITE (1 << 3) /* 0x08 */ /* relate to BTA_GATT_CHAR_PROP_BIT_WRITE in bta/bta_gatt_api.h */ +#define ESP_GATT_CHAR_PROP_BIT_NOTIFY (1 << 4) /* 0x10 */ /* relate to BTA_GATT_CHAR_PROP_BIT_NOTIFY in bta/bta_gatt_api.h */ +#define ESP_GATT_CHAR_PROP_BIT_INDICATE (1 << 5) /* 0x20 */ /* relate to BTA_GATT_CHAR_PROP_BIT_INDICATE in bta/bta_gatt_api.h */ +#define ESP_GATT_CHAR_PROP_BIT_AUTH (1 << 6) /* 0x40 */ /* relate to BTA_GATT_CHAR_PROP_BIT_AUTH in bta/bta_gatt_api.h */ +#define ESP_GATT_CHAR_PROP_BIT_EXT_PROP (1 << 7) /* 0x80 */ /* relate to BTA_GATT_CHAR_PROP_BIT_EXT_PROP in bta/bta_gatt_api.h */ + +#define ESP_GATT_PERM_READ (1 << 0) /* bit 0 - 0x0001 */ /* relate to BTA_GATT_PERM_READ in bta/bta_gatt_api.h */ +#define ESP_GATT_PERM_READ_ENCRYPTED (1 << 1) /* bit 1 - 0x0002 */ /* relate to BTA_GATT_PERM_READ_ENCRYPTED in bta/bta_gatt_api.h */ +#define ESP_GATT_PERM_READ_ENC_MITM (1 << 2) /* bit 2 - 0x0004 */ /* relate to BTA_GATT_PERM_READ_ENC_MITM in bta/bta_gatt_api.h */ +#define ESP_GATT_PERM_WRITE (1 << 4) /* bit 4 - 0x0010 */ /* relate to BTA_GATT_PERM_WRITE in bta/bta_gatt_api.h */ +#define ESP_GATT_PERM_WRITE_ENCRYPTED (1 << 5) /* bit 5 - 0x0020 */ /* relate to BTA_GATT_PERM_WRITE_ENCRYPTED in bta/bta_gatt_api.h */ +#define ESP_GATT_PERM_WRITE_ENC_MITM (1 << 6) /* bit 6 - 0x0040 */ /* relate to BTA_GATT_PERM_WRITE_ENC_MITM in bta/bta_gatt_api.h */ +#define ESP_GATT_PERM_WRITE_SIGNED (1 << 7) /* bit 7 - 0x0080 */ /* relate to BTA_GATT_PERM_WRITE_SIGNED in bta/bta_gatt_api.h */ +#define ESP_GATT_PERM_WRITE_SIGNED_MITM (1 << 8) /* bit 8 - 0x0100 */ /* relate to BTA_GATT_PERM_WRITE_SIGNED_MITM in bta/bta_gatt_api.h */ +#define ESP_GATT_PERM_READ_AUTHORIZATION (1 << 9) /* bit 9 - 0x0200 */ +#define ESP_GATT_PERM_WRITE_AUTHORIZATION (1 << 10) /* bit 10 - 0x0400 */ + +enum BLE_GATT_PERM_ { + READ = 1 << 0, + READ_ENCRYPTED = 1 << 1, + READ_ENC_MITM = 1 << 2, + WRITE = 1 << 4, + WRITE_ENCRYPTED = 1 << 5, + WRITE_ENC_MITM = 1 << 6, + WRITE_SIGNED = 1 << 7, + WRITE_SIGNED_MITM = 1 << 8, + READ_AUTHORIZATION = 1 << 9, + WRITE_AUTHORIZATION = 1 << 10, }; + #endif diff --git a/src/local/BLELocalDevice.cpp b/src/local/BLELocalDevice.cpp index 57477e23..e83c4b0d 100644 --- a/src/local/BLELocalDevice.cpp +++ b/src/local/BLELocalDevice.cpp @@ -107,6 +107,10 @@ int BLELocalDevice::begin() end(); return 0; } + if (HCI.setLeEventMask(0x00000000000001FF) != 0) { + end(); + return 0; + } uint16_t pktLen; uint8_t maxPkt; diff --git a/src/local/BLELocalDevice.h b/src/local/BLELocalDevice.h index 20837c14..1a927420 100644 --- a/src/local/BLELocalDevice.h +++ b/src/local/BLELocalDevice.h @@ -74,6 +74,7 @@ class BLELocalDevice { void debug(Stream& stream); void noDebug(); + uint8_t BDaddress[6]; private: }; diff --git a/src/utility/ATT.cpp b/src/utility/ATT.cpp index 2696960e..af0129a7 100644 --- a/src/utility/ATT.cpp +++ b/src/utility/ATT.cpp @@ -95,6 +95,7 @@ ATTClass::ATTClass() : memset(_peers[i].address, 0x00, sizeof(_peers[i].address)); _peers[i].mtu = 23; _peers[i].device = NULL; + _peers[i].encryption = 0x0; } memset(_eventHandlers, 0x00, sizeof(_eventHandlers)); @@ -267,12 +268,22 @@ void ATTClass::handleData(uint16_t connectionHandle, uint8_t dlen, uint8_t data[ uint16_t mtu = this->mtu(connectionHandle); +#ifdef _BLE_TRACE_ + Serial.print("data opcode: 0x"); + Serial.println(opcode, HEX); +#endif switch (opcode) { case ATT_OP_ERROR: +#ifdef _BLE_TRACE_ + Serial.println("[Info] data error"); +#endif error(connectionHandle, dlen, data); break; case ATT_OP_MTU_REQ: +#ifdef _BLE_TRACE_ + Serial.println("MTU"); +#endif mtuReq(connectionHandle, dlen, data); break; @@ -281,6 +292,9 @@ void ATTClass::handleData(uint16_t connectionHandle, uint8_t dlen, uint8_t data[ break; case ATT_OP_FIND_INFO_REQ: +#ifdef _BLE_TRACE_ + Serial.println("Find info"); +#endif findInfoReq(connectionHandle, mtu, dlen, data); break; @@ -293,6 +307,9 @@ void ATTClass::handleData(uint16_t connectionHandle, uint8_t dlen, uint8_t data[ break; case ATT_OP_READ_BY_TYPE_REQ: +#ifdef _BLE_TRACE_ + Serial.println("By type"); +#endif readByTypeReq(connectionHandle, mtu, dlen, data); break; @@ -319,6 +336,9 @@ void ATTClass::handleData(uint16_t connectionHandle, uint8_t dlen, uint8_t data[ case ATT_OP_WRITE_REQ: case ATT_OP_WRITE_CMD: +#ifdef _BLE_TRACE_ + Serial.println("Write req"); +#endif writeReqOrCmd(connectionHandle, mtu, opcode, dlen, data); break; @@ -346,6 +366,9 @@ void ATTClass::handleData(uint16_t connectionHandle, uint8_t dlen, uint8_t data[ case ATT_OP_READ_MULTI_REQ: case ATT_OP_SIGNED_WRITE_CMD: default: +#ifdef _BLE_TRACE_ + Serial.println("[Info] Unhandled dara"); +#endif sendError(connectionHandle, opcode, 0x00, ATT_ECODE_REQ_NOT_SUPP); break; } @@ -398,6 +421,10 @@ void ATTClass::removeConnection(uint16_t handle, uint8_t /*reason*/) _peers[peerIndex].addressType = 0x00; memset(_peers[peerIndex].address, 0x00, sizeof(_peers[peerIndex].address)); _peers[peerIndex].mtu = 23; + _peers[peerIndex].encryption = PEER_ENCRYPTION::NO_ENCRYPTION; + _peers[peerIndex].IOCap[0] = 0; + _peers[peerIndex].IOCap[1] = 0; + _peers[peerIndex].IOCap[2] = 0; if (_peers[peerIndex].device) { delete _peers[peerIndex].device; @@ -807,6 +834,14 @@ void ATTClass::readByGroupReq(uint16_t connectionHandle, uint16_t mtu, uint8_t d uint16_t endHandle; uint16_t uuid; } *readByGroupReq = (ReadByGroupReq*)data; +#ifdef _BLE_TRACE_ + Serial.print("readByGroupReq: start: 0x"); + Serial.println(readByGroupReq->startHandle,HEX); + Serial.print("readByGroupReq: end: 0x"); + Serial.println(readByGroupReq->endHandle,HEX); + Serial.print("readByGroupReq: UUID: 0x"); + Serial.println(readByGroupReq->uuid,HEX); +#endif if (dlen != sizeof(ReadByGroupReq) || (readByGroupReq->uuid != BLETypeService && readByGroupReq->uuid != 0x2801)) { sendError(connectionHandle, ATT_OP_READ_BY_GROUP_REQ, readByGroupReq->startHandle, ATT_ECODE_UNSUPP_GRP_TYPE); @@ -819,7 +854,10 @@ void ATTClass::readByGroupReq(uint16_t connectionHandle, uint16_t mtu, uint8_t d response[0] = ATT_OP_READ_BY_GROUP_RESP; response[1] = 0x00; responseLength = 2; - +#ifdef _BLE_TRACE_ + Serial.print("readByGroupReq: attrcount: "); + Serial.println(GATT.attributeCount()); +#endif for (uint16_t i = (readByGroupReq->startHandle - 1); i < GATT.attributeCount() && i <= (readByGroupReq->endHandle - 1); i++) { BLELocalAttribute* attribute = GATT.attribute(i); @@ -906,6 +944,8 @@ void ATTClass::readOrReadBlobReq(uint16_t connectionHandle, uint16_t mtu, uint8_ return; } } + /// if auth error, hold the response in a buffer. + bool holdResponse = false; uint16_t handle = *(uint16_t*)data; uint16_t offset = (opcode == ATT_OP_READ_REQ) ? 0 : *(uint16_t*)&data[sizeof(handle)]; @@ -962,6 +1002,11 @@ void ATTClass::readOrReadBlobReq(uint16_t connectionHandle, uint16_t mtu, uint8_ sendError(connectionHandle, opcode, handle, ATT_ECODE_READ_NOT_PERM); return; } + // If characteristic requires encryption send error & hold response until encrypted + if ((characteristic->properties() & BLEAuth) > 0 && (getPeerEncryption(connectionHandle) & PEER_ENCRYPTION::ENCRYPTED_AES)==0) { + holdResponse = true; + sendError(connectionHandle, opcode, handle, ATT_ECODE_INSUFF_ENC); + } uint16_t valueLength = characteristic->valueLength(); @@ -994,8 +1039,12 @@ void ATTClass::readOrReadBlobReq(uint16_t connectionHandle, uint16_t mtu, uint8_ memcpy(&response[responseLength], descriptor->value() + offset, valueLength); responseLength += valueLength; } - - HCI.sendAclPkt(connectionHandle, ATT_CID, responseLength, response); + if(holdResponse){ + memcpy(holdBuffer, response, responseLength); + holdBufferSize = responseLength; + }else{ + HCI.sendAclPkt(connectionHandle, ATT_CID, responseLength, response); + } } void ATTClass::readResp(uint16_t connectionHandle, uint8_t dlen, uint8_t data[]) @@ -1687,4 +1736,81 @@ void ATTClass::writeCmd(uint16_t connectionHandle, uint16_t handle, const uint8_ sendReq(connectionHandle, &writeReq, 3 + dataLen, NULL); } +// Set encryption state for a peer +int ATTClass::setPeerEncryption(uint16_t connectionHandle, uint8_t encryption){ + for(int i=0; i 0){ + return _peers[i].connectionHandle; + } + } + return ATT_MAX_PEERS + 1; +} +// Get the encryption state for a particular peer / connection handle +uint8_t ATTClass::getPeerEncryption(uint16_t connectionHandle) { + for(int i=0; i ", sizeof(aclHdr) + plen, txBuffer); } +#ifdef _BLE_TRACE_ + Serial.print("Data tx -> "); + for(int i=0; i< sizeof(aclHdr) + plen;i++){ + Serial.print(" 0x"); + Serial.print(txBuffer[i],HEX); + } + Serial.println("."); +#endif _pendingPkt++; HCITransport.write(txBuffer, sizeof(aclHdr) + plen); @@ -476,7 +521,15 @@ int HCIClass::sendCommand(uint16_t opcode, uint8_t plen, void* parameters) if (_debug) { dumpPkt("HCI COMMAND TX -> ", sizeof(pktHdr) + plen, txBuffer); } - +#ifdef _BLE_TRACE_ + Serial.print("Command tx -> "); + for(int i=0; i< sizeof(pktHdr) + plen;i++){ + Serial.print(" 0x"); + Serial.print(txBuffer[i],HEX); + + } + Serial.println(""); +#endif HCITransport.write(txBuffer, sizeof(pktHdr) + plen); _cmdCompleteOpcode = 0xffff; @@ -498,6 +551,9 @@ void HCIClass::handleAclDataPkt(uint8_t /*plen*/, uint8_t pdata[]) uint16_t cid; } *aclHdr = (HCIACLHdr*)pdata; +#ifdef _BLE_TRACE_ + Serial.println("Received data"); +#endif uint16_t aclFlags = (aclHdr->handle & 0xf000) >> 12; if ((aclHdr->dlen - 4) != aclHdr->len) { @@ -530,8 +586,18 @@ void HCIClass::handleAclDataPkt(uint8_t /*plen*/, uint8_t pdata[]) ATT.handleData(aclHdr->handle & 0x0fff, aclHdr->len, &_recvBuffer[1 + sizeof(HCIACLHdr)]); } } else if (aclHdr->cid == SIGNALING_CID) { +#ifdef _BLE_TRACE_ + Serial.println("Signalling"); +#endif L2CAPSignaling.handleData(aclHdr->handle & 0x0fff, aclHdr->len, &_recvBuffer[1 + sizeof(HCIACLHdr)]); - } else { + } else if (aclHdr->cid == SECURITY_CID){ + // Security manager +#ifdef _BLE_TRACE_ + Serial.println("Security data"); +#endif + L2CAPSignaling.handleSecurityData(aclHdr->handle & 0x0fff, aclHdr->len, &_recvBuffer[1 + sizeof(HCIACLHdr)]); + + }else { struct __attribute__ ((packed)) { uint8_t op; uint8_t id; @@ -540,6 +606,10 @@ void HCIClass::handleAclDataPkt(uint8_t /*plen*/, uint8_t pdata[]) uint16_t localCid; uint16_t remoteCid; } l2capRejectCid= { 0x01, 0x00, 0x006, 0x0002, aclHdr->cid, 0x0000 }; +#ifdef _BLE_TRACE_ + Serial.print("rejecting packet cid: 0x"); + Serial.println(aclHdr->cid,HEX); +#endif sendAclPkt(aclHdr->handle & 0x0fff, 0x0005, sizeof(l2capRejectCid), &l2capRejectCid); } @@ -560,8 +630,13 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) uint8_t evt; uint8_t plen; } *eventHdr = (HCIEventHdr*)pdata; +#ifdef _BLE_TRACE_ + Serial.print("HCI event: "); + Serial.println(eventHdr->evt, HEX); +#endif - if (eventHdr->evt == EVT_DISCONN_COMPLETE) { + if (eventHdr->evt == EVT_DISCONN_COMPLETE) + { struct __attribute__ ((packed)) DisconnComplete { uint8_t status; uint16_t handle; @@ -572,99 +647,447 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) L2CAPSignaling.removeConnection(disconnComplete->handle, disconnComplete->reason); HCI.leSetAdvertiseEnable(0x01); - } else if (eventHdr->evt == EVT_CMD_COMPLETE) { + } + else if (eventHdr->evt == EVT_ENCRYPTION_CHANGE) + { + struct __attribute__ ((packed)) EncryptionChange { + uint8_t status; + uint16_t connectionHandle; + uint8_t enabled; + } *encryptionChange = (EncryptionChange*)&pdata[sizeof(HCIEventHdr)]; +#ifdef _BLE_TRACE_ + Serial.println("[Info] Encryption changed"); + Serial.print("status : "); + btct.printBytes(&encryptionChange->status,1); + Serial.print("handle : "); + btct.printBytes((uint8_t*)&encryptionChange->connectionHandle,2); + Serial.print("enabled: "); + btct.printBytes(&encryptionChange->enabled,1); +#endif + if(encryptionChange->enabled>0){ + ATT.setPeerEncryption(encryptionChange->connectionHandle, PEER_ENCRYPTION::ENCRYPTED_AES); + }else{ + ATT.setPeerEncryption(encryptionChange->connectionHandle, PEER_ENCRYPTION::NO_ENCRYPTION); + } + if(ATT.holdBufferSize>0){ + HCI.sendAclPkt(encryptionChange->connectionHandle, ATT_CID, ATT.holdBufferSize, ATT.holdBuffer); + ATT.holdBufferSize = 0; + } + } + else if (eventHdr->evt == EVT_CMD_COMPLETE) + { struct __attribute__ ((packed)) CmdComplete { uint8_t ncmd; uint16_t opcode; uint8_t status; } *cmdCompleteHeader = (CmdComplete*)&pdata[sizeof(HCIEventHdr)]; - +#ifdef _BLE_TRACE_ + Serial.print("E ncmd: 0x"); + Serial.println(cmdCompleteHeader->ncmd,HEX); + Serial.print("E opcode: 0x"); + Serial.println(cmdCompleteHeader->opcode, HEX); + Serial.print("E status: 0x"); + Serial.println(cmdCompleteHeader->status, HEX); +#endif _cmdCompleteOpcode = cmdCompleteHeader->opcode; _cmdCompleteStatus = cmdCompleteHeader->status; _cmdResponseLen = pdata[1] - sizeof(CmdComplete); _cmdResponse = &pdata[sizeof(HCIEventHdr) + sizeof(CmdComplete)]; - } else if (eventHdr->evt == EVT_CMD_STATUS) { + } + else if (eventHdr->evt == EVT_CMD_STATUS) + { struct __attribute__ ((packed)) CmdStatus { uint8_t status; uint8_t ncmd; uint16_t opcode; } *cmdStatusHeader = (CmdStatus*)&pdata[sizeof(HCIEventHdr)]; +#ifdef _BLE_TRACE_ + Serial.print("F n cmd: 0x"); + Serial.println(cmdStatusHeader->ncmd, HEX); + Serial.print("F status: 0x"); + Serial.println(cmdStatusHeader->status, HEX); + Serial.print("F opcode: 0x"); + Serial.println(cmdStatusHeader->opcode, HEX); +#endif _cmdCompleteOpcode = cmdStatusHeader->opcode; _cmdCompleteStatus = cmdStatusHeader->status; _cmdResponseLen = 0; - } else if (eventHdr->evt == EVT_NUM_COMP_PKTS) { + } + else if (eventHdr->evt == EVT_NUM_COMP_PKTS) + { uint8_t numHandles = pdata[sizeof(HCIEventHdr)]; uint16_t* data = (uint16_t*)&pdata[sizeof(HCIEventHdr) + sizeof(numHandles)]; for (uint8_t i = 0; i < numHandles; i++) { handleNumCompPkts(data[0], data[1]); - +#ifdef _BLE_TRACE_ + Serial.print("Outstanding packets: "); + Serial.println(_pendingPkt); + Serial.print("Data[0]: 0x"); + Serial.println(data[0]); + Serial.print("Data[1]: 0x"); + Serial.println(data[1]); +#endif data += 2; } - } else if (eventHdr->evt == EVT_LE_META_EVENT) { + } + else if(eventHdr->evt == 0x10) + { + struct __attribute__ ((packed)) CmdHardwareError { + uint8_t hardwareCode; + } *cmdHardwareError = (CmdHardwareError*)&pdata[sizeof(HCIEventHdr)]; +#ifdef _BLE_TRACE_ + Serial.print("Bluetooth hardware error."); + Serial.print(" Code: 0x"); + Serial.println(cmdHardwareError->hardwareCode, HEX); +#endif + } + else if (eventHdr->evt == EVT_LE_META_EVENT) + { struct __attribute__ ((packed)) LeMetaEventHeader { uint8_t subevent; } *leMetaHeader = (LeMetaEventHeader*)&pdata[sizeof(HCIEventHdr)]; +#ifdef _BLE_TRACE_ + Serial.print("\tSubEvent: 0x"); + Serial.println(leMetaHeader->subevent,HEX); +#endif + switch((LE_META_EVENT)leMetaHeader->subevent){ + case CONN_COMPLETE:{ + struct __attribute__ ((packed)) EvtLeConnectionComplete { + uint8_t status; + uint16_t handle; + uint8_t role; + uint8_t peerBdaddrType; + uint8_t peerBdaddr[6]; + uint16_t interval; + uint16_t latency; + uint16_t supervisionTimeout; + uint8_t masterClockAccuracy; + } *leConnectionComplete = (EvtLeConnectionComplete*)&pdata[sizeof(HCIEventHdr) + sizeof(LeMetaEventHeader)]; + + if (leConnectionComplete->status == 0x00) { + ATT.addConnection(leConnectionComplete->handle, + leConnectionComplete->role, + leConnectionComplete->peerBdaddrType, + leConnectionComplete->peerBdaddr, + leConnectionComplete->interval, + leConnectionComplete->latency, + leConnectionComplete->supervisionTimeout, + leConnectionComplete->masterClockAccuracy); + + L2CAPSignaling.addConnection(leConnectionComplete->handle, + leConnectionComplete->role, + leConnectionComplete->peerBdaddrType, + leConnectionComplete->peerBdaddr, + leConnectionComplete->interval, + leConnectionComplete->latency, + leConnectionComplete->supervisionTimeout, + leConnectionComplete->masterClockAccuracy); + } + break; + } + case ADVERTISING_REPORT:{ + struct __attribute__ ((packed)) EvtLeAdvertisingReport { + uint8_t status; + uint8_t type; + uint8_t peerBdaddrType; + uint8_t peerBdaddr[6]; + uint8_t eirLength; + uint8_t eirData[31]; + } *leAdvertisingReport = (EvtLeAdvertisingReport*)&pdata[sizeof(HCIEventHdr) + sizeof(LeMetaEventHeader)]; + + if (leAdvertisingReport->status == 0x01) { + // last byte is RSSI + int8_t rssi = leAdvertisingReport->eirData[leAdvertisingReport->eirLength]; + + GAP.handleLeAdvertisingReport(leAdvertisingReport->type, + leAdvertisingReport->peerBdaddrType, + leAdvertisingReport->peerBdaddr, + leAdvertisingReport->eirLength, + leAdvertisingReport->eirData, + rssi); + } + break; + } + case LONG_TERM_KEY_REQUEST: + { + struct __attribute__ ((packed)) LTKRequest + { + uint8_t subEventCode; + uint16_t connectionHandle; + uint8_t randomNumber[8]; + uint8_t encryptedDiversifier[2]; + } *ltkRequest = (LTKRequest*)&pdata[sizeof(HCIEventHdr)]; +#ifdef _BLE_TRACE_ + Serial.println("LTK request received"); + Serial.print("Connection Handle: "); + btct.printBytes((uint8_t*)<kRequest->connectionHandle,2); + Serial.print("Random Number : "); + btct.printBytes(ltkRequest->randomNumber,8); + Serial.print("EDIV : "); + btct.printBytes(ltkRequest->encryptedDiversifier,2); +#endif - if (leMetaHeader->subevent == EVT_LE_CONN_COMPLETE) { - struct __attribute__ ((packed)) EvtLeConnectionComplete { - uint8_t status; - uint16_t handle; - uint8_t role; - uint8_t peerBdaddrType; - uint8_t peerBdaddr[6]; - uint16_t interval; - uint16_t latency; - uint16_t supervisionTimeout; - uint8_t masterClockAccuracy; - } *leConnectionComplete = (EvtLeConnectionComplete*)&pdata[sizeof(HCIEventHdr) + sizeof(LeMetaEventHeader)]; - - if (leConnectionComplete->status == 0x00) { - ATT.addConnection(leConnectionComplete->handle, - leConnectionComplete->role, - leConnectionComplete->peerBdaddrType, - leConnectionComplete->peerBdaddr, - leConnectionComplete->interval, - leConnectionComplete->latency, - leConnectionComplete->supervisionTimeout, - leConnectionComplete->masterClockAccuracy); - - L2CAPSignaling.addConnection(leConnectionComplete->handle, - leConnectionComplete->role, - leConnectionComplete->peerBdaddrType, - leConnectionComplete->peerBdaddr, - leConnectionComplete->interval, - leConnectionComplete->latency, - leConnectionComplete->supervisionTimeout, - leConnectionComplete->masterClockAccuracy); + // Send our LTK back + struct __attribute__ ((packed)) LTKReply + { + uint16_t connectionHandle; + uint8_t LTK[16]; + } ltkReply = {0,0}; + ltkReply.connectionHandle = ATT.getPeerEncrptingConnectionHandle(); + for(int i=0; i<16; i++) ltkReply.LTK[15-i] = HCI.LTK[i]; + int result = sendCommand(OGF_LE_CTL << 10 | LE_COMMAND::LONG_TERM_KEY_REPLY,sizeof(ltkReply), <kReply); + +#ifdef _BLE_TRACE_ + Serial.println("Sending LTK as: "); + btct.printBytes(ltkReply.LTK,16); +#endif + + if(result == 0){ + struct __attribute__ ((packed)) LTKReplyResult + { + uint8_t status; + uint16_t connectionHandle; + } ltkReplyResult = {0,0}; + memcpy(<kReplyResult, _cmdResponse, 3); + +#ifdef _BLE_TRACE_ + Serial.println("LTK send success"); + Serial.print("status : "); + btct.printBytes(<kReplyResult.status,1); + Serial.print("Conn Handle: "); + btct.printBytes((uint8_t*)<kReplyResult.connectionHandle,2); +#endif + }else{ +#ifdef _BLE_TRACE_ + Serial.print("Failed to send LTK...: "); + btct.printBytes((uint8_t*)&result,2); +#endif + } + break; } - } else if (leMetaHeader->subevent == EVT_LE_ADVERTISING_REPORT) { - struct __attribute__ ((packed)) EvtLeAdvertisingReport { - uint8_t status; - uint8_t type; - uint8_t peerBdaddrType; - uint8_t peerBdaddr[6]; - uint8_t eirLength; - uint8_t eirData[31]; - } *leAdvertisingReport = (EvtLeAdvertisingReport*)&pdata[sizeof(HCIEventHdr) + sizeof(LeMetaEventHeader)]; - - if (leAdvertisingReport->status == 0x01) { - // last byte is RSSI - int8_t rssi = leAdvertisingReport->eirData[leAdvertisingReport->eirLength]; - - GAP.handleLeAdvertisingReport(leAdvertisingReport->type, - leAdvertisingReport->peerBdaddrType, - leAdvertisingReport->peerBdaddr, - leAdvertisingReport->eirLength, - leAdvertisingReport->eirData, - rssi); + case REMOTE_CONN_PARAM_REQ: + { + struct __attribute__ ((packed)) RemoteConnParamReq { + uint8_t subEventCode; + uint16_t connectionHandle; + uint16_t intervalMin; + uint16_t intervalMax; + uint16_t latency; + uint16_t timeOut; + } *remoteConnParamReq = (RemoteConnParamReq*)&pdata[sizeof(HCIEventHdr)]; +#ifdef _BLE_TRACE_ + Serial.println("--- Remtoe conn param req"); + Serial.print("Handle : "); + btct.printBytes((uint8_t*)&remoteConnParamReq->connectionHandle,2); + Serial.print("Interval min: "); + btct.printBytes((uint8_t*)&remoteConnParamReq->intervalMin,2); + Serial.print("Interval max: "); + btct.printBytes((uint8_t*)&remoteConnParamReq->intervalMax,2); + Serial.print("Latency : "); + btct.printBytes((uint8_t*)&remoteConnParamReq->latency,2); + Serial.print("Timeout : "); + btct.printBytes((uint8_t*)&remoteConnParamReq->timeOut,2); +#endif + + struct __attribute__ ((packed)) RemoteConnParamReqReply { + uint16_t connectionHandle; + uint16_t intervalMin; + uint16_t intervalMax; + uint16_t latency; + uint16_t timeOut; + uint16_t minLength; + uint16_t maxLength; + } remoteConnParamReqReply; + memcpy(&remoteConnParamReqReply, &remoteConnParamReq->connectionHandle, sizeof(remoteConnParamReq-1)); + remoteConnParamReqReply.minLength = 0x000F; + remoteConnParamReqReply.maxLength = 0x0FFF; + sendCommand(OGF_LE_CTL << 10 | 0x20, sizeof(remoteConnParamReqReply), &remoteConnParamReqReply); + break; + } + case READ_LOCAL_P256_COMPLETE: + { + struct __attribute__ ((packed)) EvtReadLocalP256Complete{ + uint8_t subEventCode; + uint8_t status; + uint8_t localPublicKey[64]; + } *evtReadLocalP256Complete = (EvtReadLocalP256Complete*)&pdata[sizeof(HCIEventHdr)]; + if(evtReadLocalP256Complete->status == 0x0){ +#ifdef _BLE_TRACE_ + Serial.println("Key read success"); +#endif + struct __attribute__ ((packed)) PairingPublicKey + { + uint8_t code; + uint8_t publicKey[64]; + } pairingPublicKey = {CONNECTION_PAIRING_PUBLIC_KEY,0}; + memcpy(pairingPublicKey.publicKey,evtReadLocalP256Complete->localPublicKey,64); + + // Send the local public key to the remote + uint16_t connectionHandle = ATT.getPeerEncrptingConnectionHandle(); + if(connectionHandle>ATT_MAX_PEERS){ +#ifdef _BLE_TRACE_ + Serial.println("failed to find connection handle"); +#endif + break; + } + HCI.sendAclPkt(connectionHandle,SECURITY_CID,sizeof(PairingPublicKey),&pairingPublicKey); + uint8_t encryption = ATT.getPeerEncryption(connectionHandle) | PEER_ENCRYPTION::SENT_PUBKEY; + ATT.setPeerEncryption(connectionHandle, encryption); + + + uint8_t Z = 0; + for(int i=0; i<16; i++){ + Nb[i] = rand(); //// Should use ESP or ECCx08 + } +#ifdef _BLE_TRACE_ + Serial.print("nb: "); + btct.printBytes(Nb, 16); +#endif + struct __attribute__ ((packed)) F4Params + { + uint8_t U[32]; + uint8_t V[32]; + uint8_t Z; + } f4Params = {0,0,Z}; + for(int i=0; i<32; i++){ + f4Params.U[31-i] = pairingPublicKey.publicKey[i]; + f4Params.V[31-i] = HCI.remotePublicKeyBuffer[i]; + } + + struct __attribute__ ((packed)) PairingConfirm + { + uint8_t code; + uint8_t cb[16]; + } pairingConfirm = {CONNECTION_PAIRING_CONFIRM,0}; + + btct.AES_CMAC(Nb,(unsigned char *)&f4Params,sizeof(f4Params),pairingConfirm.cb); + +#ifdef _BLE_TRACE_ + Serial.print("cb: "); + btct.printBytes(pairingConfirm.cb, 16); +#endif + uint8_t cb_temp[sizeof(pairingConfirm.cb)]; + for(int i=0; istatus,HEX); + for(int i=0; i<64; i++){ + Serial.print(" 0x"); + Serial.print(evtReadLocalP256Complete->localPublicKey[i],HEX); + } + Serial.println("."); +#endif + } + break; + } + case GENERATE_DH_KEY_COMPLETE: + { + struct __attribute__ ((packed)) EvtLeDHKeyComplete{ + uint8_t subEventCode; + uint8_t status; + uint8_t DHKey[32]; + } *evtLeDHKeyComplete = (EvtLeDHKeyComplete*)&pdata[sizeof(HCIEventHdr)]; + if(evtLeDHKeyComplete->status == 0x0){ +#ifdef _BLE_TRACE_ + Serial.println("DH key generated"); +#endif + uint16_t connectionHandle = ATT.getPeerEncrptingConnectionHandle(); + if(connectionHandle>ATT_MAX_PEERS){ +#ifdef _BLE_TRACE_ + Serial.println("Failed to find connection handle DH key check"); +#endif + break; + } + + uint8_t encryption = ATT.getPeerEncryption(connectionHandle); + + for(int i=0; i<32; i++) DHKey[31-i] = evtLeDHKeyComplete->DHKey[i]; + +#ifdef _BLE_TRACE_ + Serial.println("Stored our DHKey:"); + btct.printBytes(DHKey,32); +#endif + encryption |= PEER_ENCRYPTION::DH_KEY_CALULATED; + ATT.setPeerEncryption(connectionHandle, encryption); +#ifdef _BLE_TRACE_ + if(encryption | PEER_ENCRYPTION::RECEIVED_DH_CHECK){ + Serial.println("Recieved DHKey check already so calculate f5, f6."); + }else{ + Serial.println("Waiting on other DHKey check before calculating."); + } + }else{ + Serial.print("Key generation error: 0x"); + Serial.println(evtLeDHKeyComplete->status, HEX); +#endif + } + break; + } + default: + { +#ifdef _BLE_TRACE_ + Serial.println("[Info] Unhandled meta event"); +#endif } } + }else{ +#ifdef _BLE_TRACE_ + Serial.println("[Info] Unhandled event"); +#endif } } +int HCIClass::leEncrypt(uint8_t* key, uint8_t* plaintext, uint8_t* status, uint8_t* ciphertext){ + struct __attribute__ ((packed)) LeEncryptCommand + { + uint8_t key[16]; + uint8_t plaintext[16]; + } leEncryptCommand = {0,0}; + for(int i=0; i<16; i++){ + leEncryptCommand.key[15-i] = key[i]; + leEncryptCommand.plaintext[15-i] = plaintext[i]; + } + + int res = sendCommand(OGF_LE_CTL << 10 | LE_COMMAND::ENCRYPT, sizeof(leEncryptCommand), &leEncryptCommand); + if(res == 0){ +#ifdef _BLE_TRACE_ + Serial.print("Copying from command Response length: "); + Serial.println(_cmdResponseLen); + Serial.println("."); + for(int i=0; i<20; i++){ + Serial.print(" 0x"); + Serial.print(_cmdResponse[i],HEX); + } + Serial.println("."); +#endif + for(int i=0; i<16; i++){ + ciphertext[15-i] = _cmdResponse[i]; + } + return 1; + } +#ifdef _BLE_TRACE_ + Serial.print("Error with AES: 0x"); + Serial.println(res, HEX); +#endif + return res; +} void HCIClass::dumpPkt(const char* prefix, uint8_t plen, uint8_t pdata[]) { diff --git a/src/utility/HCI.h b/src/utility/HCI.h index 86ec679c..c58b7572 100644 --- a/src/utility/HCI.h +++ b/src/utility/HCI.h @@ -22,6 +22,30 @@ #include +#define OGF_LINK_CTL 0x01 +#define OGF_HOST_CTL 0x03 +#define OGF_INFO_PARAM 0x04 +#define OGF_STATUS_PARAM 0x05 +#define OGF_LE_CTL 0x08 + +enum LE_COMMAND { + ENCRYPT = 0x0017, + LONG_TERM_KEY_REPLY = 0x001A, + READ_LOCAL_P256 = 0x0025, + GENERATE_DH_KEY_V1 = 0x0026, + GENERATE_DH_KEY_V2 = 0x005E +}; +enum LE_META_EVENT { + CONN_COMPLETE = 0x01, + ADVERTISING_REPORT = 0x02, + LONG_TERM_KEY_REQUEST = 0x05, + REMOTE_CONN_PARAM_REQ = 0x06, + READ_LOCAL_P256_COMPLETE = 0x08, + GENERATE_DH_KEY_COMPLETE = 0x09 +}; +String metaEventToString(LE_META_EVENT event); +String commandToString(LE_COMMAND command); + class HCIClass { public: HCIClass(); @@ -37,10 +61,12 @@ class HCIClass { int readLocalVersion(uint8_t& hciVer, uint16_t& hciRev, uint8_t& lmpVer, uint16_t& manufacturer, uint16_t& lmpSubVer); int readBdAddr(uint8_t addr[6]); + int readBdAddr(); int readRssi(uint16_t handle); int setEventMask(uint64_t eventMask); + int setLeEventMask(uint64_t leEventMask); int readLeBufferSize(uint16_t& pktLen, uint8_t& maxPkt); int leSetRandomAddress(uint8_t addr[6]); @@ -62,7 +88,7 @@ class HCIClass { int leConnUpdate(uint16_t handle, uint16_t minInterval, uint16_t maxInterval, uint16_t latency, uint16_t supervisionTimeout); int leCancelConn(); - + int leEncrypt(uint8_t* Key, uint8_t* plaintext, uint8_t* status, uint8_t* ciphertext); int sendAclPkt(uint16_t handle, uint8_t cid, uint8_t plen, void* data); @@ -71,8 +97,15 @@ class HCIClass { void debug(Stream& stream); void noDebug(); -private: + // TODO: Send command be private again & use ATT implementation within ATT. int sendCommand(uint16_t opcode, uint8_t plen = 0, void* parameters = NULL); + uint8_t remotePublicKeyBuffer[64]; + uint8_t Na[16]; + uint8_t Nb[16]; + uint8_t DHKey[32]; + uint8_t localAddr[6]; + uint8_t LTK[16]; +private: void handleAclDataPkt(uint8_t plen, uint8_t pdata[]); void handleNumCompPkts(uint16_t handle, uint16_t numPkts); diff --git a/src/utility/L2CAPSignaling.cpp b/src/utility/L2CAPSignaling.cpp index f650cab2..45208514 100644 --- a/src/utility/L2CAPSignaling.cpp +++ b/src/utility/L2CAPSignaling.cpp @@ -18,7 +18,8 @@ */ #include "HCI.h" - +#include "ATT.h" +#include "btct.h" #include "L2CAPSignaling.h" #define CONNECTION_PARAMETER_UPDATE_REQUEST 0x12 @@ -97,6 +98,207 @@ void L2CAPSignalingClass::handleData(uint16_t connectionHandle, uint8_t dlen, ui connectionParameterUpdateResponse(connectionHandle, identifier, length, data); } } +void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t dlen, uint8_t data[]) +{ + struct __attribute__ ((packed)) L2CAPSignalingHdr { + uint8_t code; + uint8_t data[64]; + } *l2capSignalingHdr = (L2CAPSignalingHdr*)data; +#ifdef _BLE_TRACE_ + Serial.print("dlen: "); + Serial.println(dlen); +#endif + uint8_t code = l2capSignalingHdr->code; + +#ifdef _BLE_TRACE_ + Serial.print("handleSecurityData: code: 0x"); + Serial.println(code, HEX); + Serial.print("rx security:"); + btct.printBytes(data,dlen); +#endif + if (code == CONNECTION_PAIRING_REQUEST) { + // 0x1 + struct __attribute__ ((packed)) PairingRequest { + uint8_t ioCapability; + uint8_t oobDataFlag; + uint8_t authReq; + uint8_t maxEncSize; + uint8_t initiatorKeyDistribution; + uint8_t responderKeyDistribution; + } *pairingRequest = (PairingRequest*)l2capSignalingHdr->data; + + uint8_t peerIOCap[3]; + peerIOCap[0] = pairingRequest->authReq; + peerIOCap[1] = pairingRequest->oobDataFlag; + peerIOCap[2] = pairingRequest->ioCapability; + ATT.setPeerIOCap(connectionHandle, peerIOCap); + + struct __attribute__ ((packed)) PairingResponse { + uint8_t code; + uint8_t ioCapability; + uint8_t oobDataFlag; + uint8_t authReq; + uint8_t maxEncSize; + uint8_t initiatorKeyDistribution; + uint8_t responderKeyDistribution; + } response = { CONNECTION_PAIRING_RESPONSE, LOCAL_IOCAP, 0, LOCAL_AUTHREQ, 0x10, 0b1011, 0b1011}; + + HCI.sendAclPkt(connectionHandle, 0x06, sizeof(response), &response); + } + else if (code == CONNECTION_PAIRING_RANDOM) + { + struct __attribute__ ((packed)) PairingRandom { + uint8_t Na[16]; + } *pairingRandom = (PairingRandom*)l2capSignalingHdr->data; + for(int i=0; i<16; i++){ + HCI.Na[15-i] = pairingRandom->Na[i]; + } +#ifdef _BLE_TRACE_ + Serial.println("[Info] Pairing random."); +#endif + struct __attribute__ ((packed)) PairingResponse { + uint8_t code; + uint8_t Nb[16]; + } response = { CONNECTION_PAIRING_RANDOM, 0}; + for(int i=0; i< 16; i++) response.Nb[15-i] = HCI.Nb[i]; + + HCI.sendAclPkt(connectionHandle, 0x06, sizeof(response), &response); + } + else if (code == CONNECTION_PAIRING_RESPONSE) + { + } + else if(code == CONNECTION_PAIRING_FAILED) + { + struct __attribute__ ((packed)) PairingFailed + { + uint8_t code; + uint8_t reason; + } *pairingFailed = (PairingFailed*)data; +#ifdef _BLE_TRACE_ + Serial.print("Pairing failed with code: 0x"); + Serial.println(pairingFailed->reason,HEX); +#endif + } + else if (code == CONNECTION_PAIRING_PUBLIC_KEY){ + /// Received a public key + struct __attribute__ ((packed)) ConnectionPairingPublicKey { + uint8_t x[32]; + uint8_t y[32]; + } *connectionPairingPublicKey = (ConnectionPairingPublicKey*)l2capSignalingHdr->data; + struct __attribute__ ((packed)) GenerateDHKeyCommand { + uint8_t x[32]; + uint8_t y[32]; + } generateDHKeyCommand = { + 0x00, + 0x00, + }; + memcpy(generateDHKeyCommand.x,connectionPairingPublicKey->x,32); + memcpy(generateDHKeyCommand.y,connectionPairingPublicKey->y,32); + struct __attribute__ ((packed)) ReadPublicKeyCommand { + uint8_t code; + } readPublicKeyCommand = { + LE_COMMAND::READ_LOCAL_P256, + }; + + if(ATT.setPeerEncryption(connectionHandle,PEER_ENCRYPTION::REQUESTED_ENCRYPTION)){ +#ifdef _BLE_TRACE_ + Serial.println("[Info] Pairing public key"); + Serial.println("Requested encryption stored."); +#endif + }else{ +#ifdef _BLE_TRACE_ + Serial.println("[Info] Pairing public key"); + Serial.print("Failed to store encryption request with handle: 0x"); + Serial.println(connectionHandle,HEX); +#endif + } + + memcpy(HCI.remotePublicKeyBuffer,&generateDHKeyCommand,sizeof(generateDHKeyCommand)); + HCI.sendCommand( (OGF_LE_CTL << 10 )| LE_COMMAND::READ_LOCAL_P256, 0); + } + else if(code == CONNECTION_PAIRING_DHKEY_CHECK) + { + uint8_t RemoteDHKeyCheck[16]; + uint8_t BD_ADDR_REMOTE[7]; + ATT.getPeerAddrWithType(connectionHandle, BD_ADDR_REMOTE); + for(int i=0; i<16; i++) RemoteDHKeyCheck[15-i] = l2capSignalingHdr->data[i]; + uint8_t encryptionState = ATT.getPeerEncryption(connectionHandle) | PEER_ENCRYPTION::RECEIVED_DH_CHECK; + + +#ifdef _BLE_TRACE_ + Serial.println("[Info] DH Key check"); + Serial.print("Remote DHKey Check: "); + btct.printBytes(RemoteDHKeyCheck, 16); +#endif + + HCI.readBdAddr(); + ATT.setPeerEncryption(connectionHandle, encryptionState); + if(encryptionState & PEER_ENCRYPTION::DH_KEY_CALULATED > 0){ + // We've already calculated the DHKey so we can calculate our check and send it. + + uint8_t MacKey[16]; + uint8_t localAddress[7]; + + memcpy(&localAddress[1],HCI.localAddr,6); + localAddress[0] = 0; // IOT 33 uses a static address + + btct.f5(HCI.DHKey,HCI.Na,HCI.Nb,BD_ADDR_REMOTE,localAddress,MacKey,HCI.LTK); + + uint8_t Ea[16]; + uint8_t Eb[16]; + uint8_t R[16]; + uint8_t MasterIOCap[3]; + uint8_t SlaveIOCap[3] = {LOCAL_AUTHREQ, 0x0, LOCAL_IOCAP}; + + ATT.getPeerIOCap(connectionHandle, MasterIOCap); + for(int i=0; i<16; i++) R[i] = 0; + + btct.f6(MacKey, HCI.Na,HCI.Nb,R, MasterIOCap, BD_ADDR_REMOTE, localAddress, Ea); + btct.f6(MacKey, HCI.Nb,HCI.Na,R, SlaveIOCap, localAddress, BD_ADDR_REMOTE, Eb); + + +#ifdef _BLE_TRACE_ + Serial.println("Calculate f5, f6:"); + Serial.print("DH : "); + btct.printBytes(HCI.DHKey,32); + Serial.println("Na : "); + btct.printBytes(HCI.Na,16); + Serial.println("Nb : "); + btct.printBytes(HCI.Nb,16); + Serial.print("MAC : "); + btct.printBytes(MacKey,16); + // Serial.print("Expected MAC: "); + // printBytes(EXPECTED_MAC, 16); + Serial.print("LTK : "); + btct.printBytes(HCI.LTK,16); + // Serial.print("Expected LTK: "); + // printBytes(EXPECTED_LTK, 16); + Serial.print("Expected Ex : "); + btct.printBytes(RemoteDHKeyCheck, 16); + Serial.print("Ea : "); + btct.printBytes(Ea, 16); + Serial.print("Eb : "); + btct.printBytes(Eb,16); + Serial.print("Local Addr : "); + btct.printBytes(localAddress, 7); + Serial.print("LocalIOCap : "); + btct.printBytes(SlaveIOCap, 3); + Serial.print("MasterAddr : "); + btct.printBytes(BD_ADDR_REMOTE, 7); + Serial.print("MasterIOCAP : "); + btct.printBytes(MasterIOCap, 3); + Serial.println("Send Eb Back."); +#endif + + uint8_t ret[17]; + ret[0] = 0x0d; + for(int i=0; i #define SIGNALING_CID 0x0005 +#define SECURITY_CID 0x0006 + + +#define CONNECTION_PAIRING_REQUEST 0x01 +#define CONNECTION_PAIRING_RESPONSE 0x02 +#define CONNECTION_PAIRING_CONFIRM 0x03 +#define CONNECTION_PAIRING_RANDOM 0x04 +#define CONNECTION_PAIRING_FAILED 0x05 +#define CONNECTION_ENCRYPTION_INFORMATION 0x06 +#define CONNECTION_MASTER_IDENTIFICATION 0x07 +#define CONNECTION_IDENTITY_INFORMATION 0x08 +#define CONNECTION_IDENTITY_ADDRESS 0x09 +#define CONNECTION_SIGNING_INFORMATION 0x0A +#define CONNECTION_SECURITY_REQUEST 0x0B +#define CONNECTION_PAIRING_PUBLIC_KEY 0x0C +#define CONNECTION_PAIRING_DHKEY_CHECK 0x0D +#define CONNECTION_PAIRING_KEYPRESS 0x0E + +#define LOCAL_AUTHREQ 0b00101101 +#define LOCAL_IOCAP 0x3 class L2CAPSignalingClass { public: @@ -36,6 +56,8 @@ class L2CAPSignalingClass { void handleData(uint16_t connectionHandle, uint8_t dlen, uint8_t data[]); + void handleSecurityData(uint16_t connectionHandle, uint8_t dlen, uint8_t data[]); + void removeConnection(uint8_t handle, uint16_t reason); void setConnectionInterval(uint16_t minInterval, uint16_t maxInterval); diff --git a/src/utility/btct.cpp b/src/utility/btct.cpp new file mode 100644 index 00000000..8fad5173 --- /dev/null +++ b/src/utility/btct.cpp @@ -0,0 +1,322 @@ +#include "btct.h" +#include +#include "HCI.h" +#include "ArduinoBLE.h" +BluetoothCryptoToolbox::BluetoothCryptoToolbox(){} +// In step 1, AES-128 with key K is applied to an all-zero input block. +// In step 2, K1 is derived through the following operation: +// If the most significant bit of L is equal to 0, K1 is the left-shift +// of L by 1 bit. +// Otherwise, K1 is the exclusive-OR of const_Rb and the left-shift of L +// by 1 bit. +// In step 3, K2 is derived through the following operation: +// If the most significant bit of K1 is equal to 0, K2 is the left-shift +// of K1 by 1 bit. +// Otherwise, K2 is the exclusive-OR of const_Rb and the left-shift of +// K1 by 1 bit. +// In step 4, (K1,K2) := Generate_Subkey(K) is returned. +unsigned char const_Rb[16] = { + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x87 + }; + +#define DHKEY_LENGTH 32 +#define N_LEN 16 +#define ADDR_LEN 6 +#define LEN_LTK 16 +#define LEN_MAC_KEY 16 + +void BluetoothCryptoToolbox::printBytes(uint8_t bytes[], uint8_t length){ + for(int i=0; i0){ + Serial.print(", 0x"); + }else{ + Serial.print("0x"); + } + Serial.print(bytes[i],HEX); + } + Serial.print('\n'); +} +int BluetoothCryptoToolbox::f5(uint8_t DHKey[],uint8_t N_master[], uint8_t N_slave[], + uint8_t BD_ADDR_master[], uint8_t BD_ADDR_slave[], uint8_t MacKey[], uint8_t LTK[]) +{ + uint8_t SALT[16] = {0x6C, 0x88, 0x83, 0x91, 0xAA, 0xF5, 0xA5, 0x38, 0x60, 0x37, 0x0B, 0xDB, 0x5A, 0x60, 0x83, 0xBE}; + uint8_t keyID[4] = {0x62, 0x74, 0x6c, 0x65}; + uint8_t length[2]; + length[0] = 0x01; + length[1] = 0x00; +#ifdef _BLE_TRACE_ + Serial.print("Starting f5 calculation"); + Serial.print("Using DHKey: "); + printBytes(DHKey, DHKEY_LENGTH); + Serial.print("Using N_Master: "); + printBytes(N_master, N_LEN); + Serial.print("Using N_Slave: "); + printBytes(N_slave, N_LEN); + + Serial.println("Using BD_ADDR_MASTER: "); + printBytes(BD_ADDR_master, ADDR_LEN); + Serial.println("Using BD_ADDR_SLAVE: "); + printBytes(BD_ADDR_slave, ADDR_LEN); +#endif + + uint8_t ADD_M[7]; + uint8_t ADD_S[7]; + uint8_t T[16]; + + for(int i=0; i<6; i++){ + ADD_M[1+i] = BD_ADDR_master[i]; + ADD_M[0] = 0x00; + ADD_S[i+1] = BD_ADDR_slave[i]; + ADD_S[0] = 0x00; + } + struct __attribute__ ((packed)) CmacInput + { + uint8_t counter; + uint8_t keyID[4]; + uint8_t N1[16]; + uint8_t N2[16]; + uint8_t A1[7]; + uint8_t A2[7]; + uint8_t length[2]; + } cmacInput = {0,0,0,0,0,0,0}; + cmacInput.counter = 0; + memcpy(cmacInput.keyID, keyID, 4); + memcpy(cmacInput.N1,N_master,16); + memcpy(cmacInput.N2,N_slave,16); + memcpy(cmacInput.A1,BD_ADDR_master,7); + memcpy(cmacInput.A2,BD_ADDR_slave,7); + memcpy(cmacInput.length,length,2); + AES_CMAC(SALT, DHKey, 32, T); + + AES_CMAC(T, (uint8_t*)&cmacInput,sizeof(cmacInput), MacKey); + cmacInput.counter=1; + AES_CMAC(T, (uint8_t*)&cmacInput, sizeof(cmacInput), LTK); + + return 1; +} +int BluetoothCryptoToolbox::f6(uint8_t W[], uint8_t N1[],uint8_t N2[],uint8_t R[], uint8_t IOCap[], uint8_t A1[], uint8_t A2[], uint8_t Ex[]) +{ + struct __attribute__ ((packed)) F6Input + { + uint8_t N1[16]; + uint8_t N2[16]; + uint8_t R[16]; + uint8_t IOCap[3]; + uint8_t A1[7]; + uint8_t A2[7]; + } f6Input = {0,0,0,0,0,0}; + + memcpy(f6Input.N1, N1, 16); + memcpy(f6Input.N2, N2, 16); + memcpy(f6Input.R, R, 16); + memcpy(f6Input.IOCap, IOCap, 3); + memcpy(f6Input.A1, A1, 7); + memcpy(f6Input.A2, A2, 7); + + + AES_CMAC(W, (uint8_t*)&f6Input, sizeof(f6Input),Ex); + return 1; +} +// AES_CMAC from RFC +void BluetoothCryptoToolbox::AES_CMAC ( unsigned char *key, unsigned char *input, int length, + unsigned char *mac ) +{ + unsigned char X[16],Y[16], M_last[16], padded[16]; + unsigned char K1[16], K2[16]; + int n, i, flag; + generateSubkey(key,K1,K2); + + n = (length+15) / 16; /* n is number of rounds */ + + if ( n == 0 ) { + n = 1; + flag = 0; + } else { + if ( (length%16) == 0 ) { /* last block is a complete block */ + flag = 1; + } else { /* last block is not complete block */ + flag = 0; + } + } + + if ( flag ) { /* last block is complete block */ + xor_128(&input[16*(n-1)],K1,M_last); + } else { + padding(&input[16*(n-1)],padded,length%16); + xor_128(padded,K2,M_last); + } + + for ( i=0; i<16; i++ ) X[i] = 0; + for ( i=0; i=0; i-- ) { + output[i] = input[i] << 1; + output[i] |= overflow; + overflow = (input[i] & 0x80)?1:0; + } + return; +} +// From RFC +void BluetoothCryptoToolbox::xor_128(unsigned char *a, unsigned char *b, unsigned char *out) +{ + int i; + for (i=0;i<16; i++) + { + out[i] = a[i] ^ b[i]; + } +} +BluetoothCryptoToolbox btct; \ No newline at end of file diff --git a/src/utility/btct.h b/src/utility/btct.h new file mode 100644 index 00000000..87e515af --- /dev/null +++ b/src/utility/btct.h @@ -0,0 +1,26 @@ +#ifndef _BTCT_H_ +#define _BTCT_H_ +#include + +// Implementation of functions defined in BTLE standard +class BluetoothCryptoToolbox{ +public: + BluetoothCryptoToolbox(); + void printBytes(uint8_t bytes[], uint8_t length); + void generateSubkey(uint8_t* K, uint8_t* K1, uint8_t* K2); + void AES_CMAC ( unsigned char *key, unsigned char *input, int length, + unsigned char *mac ); + int f5(uint8_t DHKey[],uint8_t N_master[], uint8_t N_slave[], + uint8_t BD_ADDR_master[], uint8_t BD_ADDR_slave[], uint8_t MacKey[], uint8_t LTK[]); + int f6(uint8_t W[], uint8_t N1[],uint8_t N2[],uint8_t R[], uint8_t IOCap[], uint8_t A1[], uint8_t A2[], uint8_t Ex[]); + void test(); + void testF5(); + void testF6(); +private: + int AES_128(uint8_t key[], uint8_t data_in[], uint8_t data_out[]); + void leftshift_onebit(unsigned char *input,unsigned char *output); + void xor_128(unsigned char *a, unsigned char *b, unsigned char *out); + void padding ( unsigned char *lastb, unsigned char *pad, int length ); +}; +extern BluetoothCryptoToolbox btct; +#endif \ No newline at end of file From 97571e37dfb16f84db83050d638af61f6b37f368 Mon Sep 17 00:00:00 2001 From: unknownconstant Date: Fri, 1 Jan 2021 14:41:48 +0000 Subject: [PATCH 03/83] With write encryptionn requirement --- src/utility/ATT.cpp | 59 +++++++++++++++++++++++++++++++++++++++++++-- src/utility/ATT.h | 3 +++ src/utility/HCI.cpp | 16 +++++++++--- 3 files changed, 72 insertions(+), 6 deletions(-) diff --git a/src/utility/ATT.cpp b/src/utility/ATT.cpp index 4c755615..5bd5e2aa 100644 --- a/src/utility/ATT.cpp +++ b/src/utility/ATT.cpp @@ -276,6 +276,8 @@ void ATTClass::handleData(uint16_t connectionHandle, uint8_t dlen, uint8_t data[ case ATT_OP_ERROR: #ifdef _BLE_TRACE_ Serial.println("[Info] data error"); + // Serial.print("Error: "); + // btct.printBytes(data, dlen); #endif error(connectionHandle, dlen, data); break; @@ -559,6 +561,7 @@ bool ATTClass::handleNotify(uint16_t handle, const uint8_t* value, int length) memcpy(¬ification[notificationLength], value, length); notificationLength += length; + /// TODO: Set encyption requirement on notify. HCI.sendAclPkt(_peers[i].connectionHandle, ATT_CID, notificationLength, notification); numNotifications++; @@ -1214,6 +1217,7 @@ void ATTClass::writeReqOrCmd(uint16_t connectionHandle, uint16_t mtu, uint8_t op uint8_t* value = &data[sizeof(handle)]; BLELocalAttribute* attribute = GATT.attribute(handle - 1); + bool holdResponse = false; if (attribute->type() == BLETypeCharacteristic) { BLELocalCharacteristic* characteristic = (BLELocalCharacteristic*)attribute; @@ -1226,10 +1230,33 @@ void ATTClass::writeReqOrCmd(uint16_t connectionHandle, uint16_t mtu, uint8_t op } return; } + // Check permssion + if((characteristic->properties() & BLEProperty::BLEAuth)> 0 && (getPeerEncryption(connectionHandle) & PEER_ENCRYPTION::ENCRYPTED_AES) == 0){ + holdResponse = true; + sendError(connectionHandle, ATT_OP_WRITE_REQ, handle, ATT_ECODE_INSUFF_ENC); + } for (int i = 0; i < ATT_MAX_PEERS; i++) { if (_peers[i].connectionHandle == connectionHandle) { - characteristic->writeValue(BLEDevice(_peers[i].addressType, _peers[i].address), value, valueLength); + if(holdResponse){ + + writeBufferSize = 0; + memcpy(writeBuffer, &handle, 2); + writeBufferSize+=2; + + writeBuffer[writeBufferSize++] = _peers[i].addressType; + + memcpy(&writeBuffer[writeBufferSize], _peers[i].address, sizeof(_peers[i].address)); + writeBufferSize += sizeof(_peers[i].address); + + writeBuffer[writeBufferSize] = valueLength; + writeBufferSize += sizeof(valueLength); + + memcpy(&writeBuffer[writeBufferSize], value, valueLength); + writeBufferSize += valueLength; + }else{ + characteristic->writeValue(BLEDevice(_peers[i].addressType, _peers[i].address), value, valueLength); + } break; } } @@ -1276,8 +1303,36 @@ void ATTClass::writeReqOrCmd(uint16_t connectionHandle, uint16_t mtu, uint8_t op response[0] = ATT_OP_WRITE_RESP; responseLength = 1; - HCI.sendAclPkt(connectionHandle, ATT_CID, responseLength, response); + if(holdResponse){ + memcpy(holdBuffer, response, responseLength); + holdBufferSize = responseLength; + }else{ + HCI.sendAclPkt(connectionHandle, ATT_CID, responseLength, response); + } + } +} +int ATTClass::processWriteBuffer(){ + if(writeBufferSize==0){ + return 0; } + + struct __attribute__ ((packed)) WriteBuffer { + uint16_t handle; + uint8_t addressType; + uint8_t address[6]; + uint8_t valueLength; + uint8_t value[]; + } *writeBufferStruct = (WriteBuffer*)&ATT.writeBuffer; + // uint8_t value[writeBufferStruct->valueLength]; + // memcpy(value, writeBufferStruct->value, writeBufferStruct->valueLength); + BLELocalAttribute* attribute = GATT.attribute(writeBufferStruct->handle-1); + BLELocalCharacteristic* characteristic = (BLELocalCharacteristic*)attribute; +#ifdef _BLE_TRACE_ + Serial.println("Writing value"); +#endif + characteristic->writeValue(BLEDevice(writeBufferStruct->addressType, writeBufferStruct->address), writeBufferStruct->value, writeBufferStruct->valueLength); + writeBufferSize = 0; + return 1; } void ATTClass::writeResp(uint16_t connectionHandle, uint8_t dlen, uint8_t data[]) diff --git a/src/utility/ATT.h b/src/utility/ATT.h index a7d802d1..09d396ca 100644 --- a/src/utility/ATT.h +++ b/src/utility/ATT.h @@ -95,7 +95,10 @@ class ATTClass { virtual int setPeerIOCap(uint16_t connectionHandle, uint8_t IOCap[]); virtual int getPeerIOCap(uint16_t connectionHandle, uint8_t IOCap[]); uint8_t holdBuffer[64]; + uint8_t writeBuffer[64]; uint8_t holdBufferSize; + uint8_t writeBufferSize; + virtual int processWriteBuffer(); private: virtual void error(uint16_t connectionHandle, uint8_t dlen, uint8_t data[]); virtual void mtuReq(uint16_t connectionHandle, uint8_t dlen, uint8_t data[]); diff --git a/src/utility/HCI.cpp b/src/utility/HCI.cpp index bd02764b..805a2c3d 100644 --- a/src/utility/HCI.cpp +++ b/src/utility/HCI.cpp @@ -666,13 +666,20 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) #endif if(encryptionChange->enabled>0){ ATT.setPeerEncryption(encryptionChange->connectionHandle, PEER_ENCRYPTION::ENCRYPTED_AES); + if(ATT.writeBufferSize > 0){ + ATT.processWriteBuffer(); + } + if(ATT.holdBufferSize>0){ +#ifdef _BLE_TRACE_ + Serial.print("Sending queued response size: "); + Serial.println(ATT.holdBufferSize); +#endif + HCI.sendAclPkt(encryptionChange->connectionHandle, ATT_CID, ATT.holdBufferSize, ATT.holdBuffer); + ATT.holdBufferSize = 0; + } }else{ ATT.setPeerEncryption(encryptionChange->connectionHandle, PEER_ENCRYPTION::NO_ENCRYPTION); } - if(ATT.holdBufferSize>0){ - HCI.sendAclPkt(encryptionChange->connectionHandle, ATT_CID, ATT.holdBufferSize, ATT.holdBuffer); - ATT.holdBufferSize = 0; - } } else if (eventHdr->evt == EVT_CMD_COMPLETE) { @@ -940,6 +947,7 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) uint8_t Z = 0; for(int i=0; i<16; i++){ + /// TODO: Implement secure random Nb[i] = rand(); //// Should use ESP or ECCx08 } #ifdef _BLE_TRACE_ From fa42bb26cf49216b359999df944df4b868ae137a Mon Sep 17 00:00:00 2001 From: unknownconstant Date: Sat, 2 Jan 2021 20:15:00 +0000 Subject: [PATCH 04/83] Write encryption & visible LTK / IRK --- .../EncryptedBatteryMonitor.ino | 209 ++++++++++++ src/BLECharacteristic.cpp | 8 +- src/BLECharacteristic.h | 4 +- src/BLEProperty.h | 11 +- src/BLETypedCharacteristic.h | 6 +- src/BLETypedCharacteristics.cpp | 28 +- src/BLETypedCharacteristics.h | 28 +- src/local/BLELocalCharacteristic.cpp | 18 +- src/local/BLELocalCharacteristic.h | 6 +- src/local/BLELocalDevice.cpp | 69 +++- src/local/BLELocalDevice.h | 7 +- src/remote/BLERemoteCharacteristic.cpp | 5 +- src/remote/BLERemoteCharacteristic.h | 4 +- src/utility/ATT.cpp | 45 ++- src/utility/ATT.h | 19 +- src/utility/HCI.cpp | 315 +++++++++++++++++- src/utility/HCI.h | 17 + src/utility/L2CAPSignaling.cpp | 45 ++- src/utility/btct.cpp | 32 ++ src/utility/btct.h | 2 + src/utility/keyDistribution.cpp | 24 ++ src/utility/keyDistribution.h | 29 ++ 22 files changed, 855 insertions(+), 76 deletions(-) create mode 100644 examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino create mode 100644 src/utility/keyDistribution.cpp create mode 100644 src/utility/keyDistribution.h diff --git a/examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino b/examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino new file mode 100644 index 00000000..338a374e --- /dev/null +++ b/examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino @@ -0,0 +1,209 @@ +/* + Battery Monitor + + This example creates a BLE peripheral with the standard battery service and + level characteristic. The A0 pin is used to calculate the battery level. + + The circuit: + - Arduino MKR WiFi 1010, Arduino Uno WiFi Rev2 board, Arduino Nano 33 IoT, + Arduino Nano 33 BLE, or Arduino Nano 33 BLE Sense board. + + You can use a generic BLE central app, like LightBlue (iOS and Android) or + nRF Connect (Android), to interact with the services and characteristics + created in this sketch. + + This example code is in the public domain. +*/ + +#include + + + // BLE Battery Service +BLEService batteryService("180F"); + +// BLE Battery Level Characteristic +BLEUnsignedCharCharacteristic batteryLevelChar("2A19", // standard 16-bit characteristic UUID + BLERead | BLENotify); // remote clients will be able to get notifications if this characteristic changes +BLEStringCharacteristic stringcharacteristic("183E", BLERead | BLEWrite, 31); + + +// Add BLEEncryption tag to require pairing. This controls the LED. +BLEUnsignedCharCharacteristic secretValue("2a3F", BLERead | BLEWrite | BLEEncryption); + +int oldBatteryLevel = 0; // last battery level reading from analog input +long previousMillis = 0; // last time the battery level was checked, in ms + +void setup() { + Serial.begin(9600); // initialize serial communication + while (!Serial); + + pinMode(LED_BUILTIN, OUTPUT); // initialize the built-in LED pin to indicate when a central is connected + + + Serial.println("Serial connected"); + + // IRKs are keys that identify the true owner of a random mac address. + // Add IRKs of devices you are bonded with. + BLE.setGetIRKs([](uint8_t* nIRKs, uint8_t** BADDR_TYPES, uint8_t*** BDAddrs, uint8_t*** IRKs){ + // Set to number of devices + *nIRKs = 2; + + *BDAddrs = new uint8_t*[*nIRKs]; + *IRKs = new uint8_t*[*nIRKs]; + *BADDR_TYPES = new uint8_t[*nIRKs]; + + // Set these to the mac and IRK for your bonded devices as printed in the serial console after bonding. + uint8_t iPhoneMac [6] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; + uint8_t iPhoneIRK[16] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; + + uint8_t iPadMac[6] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; + uint8_t iPadIRK[16] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, }; + + + (*BADDR_TYPES)[0] = 0; + (*IRKs)[0] = new uint8_t[16]; + memcpy((*IRKs)[0],iPhoneIRK,16); + (*BDAddrs)[0] = new uint8_t[6]; + memcpy((*BDAddrs)[0], iPhoneMac, 6); + + + (*BADDR_TYPES)[1] = 0; + (*IRKs)[1] = new uint8_t[16]; + memcpy((*IRKs)[1],iPadIRK,16); + (*BDAddrs)[1] = new uint8_t[6]; + memcpy((*BDAddrs)[1], iPadMac, 6); + + + return 1; + }); + // The LTK is the secret key which is used to encrypt bluetooth traffic + BLE.setGetLTK([](uint8_t* address, uint8_t* LTK){ + // address is input + Serial.print("Recieved request for address: "); + btct.printBytes(address,6); + + // Set these to the MAC and LTK of your devices after bonding. + uint8_t iPhoneMac [6] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; + uint8_t iPhoneLTK[16] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; + uint8_t iPadMac [6] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; + uint8_t iPadLTK[16] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; + + + if(memcmp(iPhoneMac, address, 6)==0){ + memcpy(LTK, iPhoneLTK, 16); + return 1; + }else if(memcmp(iPadMac, address, 6)==0){ + memcpy(LTK, iPadLTK, 16); + } + return 0; + }); + BLE.setStoreIRK([](uint8_t* address, uint8_t* IRK){ + Serial.print(F("New device with MAC : ")); + btct.printBytes(address,6); + Serial.print(F("Need to store IRK : ")); + btct.printBytes(IRK,16); + return 1; + }); + BLE.setStoreLTK([](uint8_t* address, uint8_t* LTK){ + Serial.print(F("New device with MAC : ")); + btct.printBytes(address,6); + Serial.print(F("Need to store LTK : ")); + btct.printBytes(LTK,16); + return 1; + }); + + while(1){// begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + delay(200); + continue; + } + Serial.println("BT init"); + delay(200); + + /* Set a local name for the BLE device + This name will appear in advertising packets + and can be used by remote devices to identify this BLE device + The name can be changed but maybe be truncated based on space left in advertisement packet + */ + + BLE.setDeviceName("Arduino"); + BLE.setLocalName("BatteryMonitor"); + + BLE.setAdvertisedService(batteryService); // add the service UUID + batteryService.addCharacteristic(batteryLevelChar); // add the battery level characteristic + batteryService.addCharacteristic(stringcharacteristic); + batteryService.addCharacteristic(secretValue); + + BLE.addService(batteryService); // Add the battery service + batteryLevelChar.writeValue(oldBatteryLevel); // set initial value for this characteristic + char* stringCharValue = new char[32]; + stringCharValue = "string"; + stringcharacteristic.writeValue(stringCharValue); + secretValue.writeValue(0); + + delay(1000); + + /* Start advertising BLE. It will start continuously transmitting BLE + advertising packets and will be visible to remote BLE central devices + until it receives a new connection */ + + // start advertising + if(!BLE.advertise()){ + Serial.println("failed to advertise bluetooth."); + BLE.stopAdvertise(); + delay(500); + }else{ + Serial.println("advertising..."); + break; + } + BLE.end(); + delay(100); + } +} + + +void loop() { + // wait for a BLE central + BLEDevice central = BLE.central(); + + // if a central is connected to the peripheral: + if (central) { + Serial.print("Connected to central: "); + // print the central's BT address: + Serial.println(central.address()); + + // check the battery level every 200ms + // while the central is connected: + while (central.connected()) { + long currentMillis = millis(); + // if 200ms have passed, check the battery level: + if (currentMillis - previousMillis >= 1000) { + previousMillis = currentMillis; + updateBatteryLevel(); + if(secretValue.value()>0){ + digitalWrite(13,HIGH); + }else{ + digitalWrite(13,LOW); + } + } + } + Serial.print("Disconnected from central: "); + Serial.println(central.address()); + } +} + +void updateBatteryLevel() { + /* Read the current voltage level on the A0 analog input pin. + This is used here to simulate the charge level of a battery. + */ + int battery = analogRead(A0); + int batteryLevel = map(battery, 0, 1023, 0, 100); + + if (batteryLevel != oldBatteryLevel) { // if the battery level has changed + // Serial.print("Battery Level % is now: "); // print it + // Serial.println(batteryLevel); + batteryLevelChar.writeValue(batteryLevel); // and update the battery level characteristic + oldBatteryLevel = batteryLevel; // save the level for next comparison + } +} diff --git a/src/BLECharacteristic.cpp b/src/BLECharacteristic.cpp index 9a07cb9d..1cfbf489 100644 --- a/src/BLECharacteristic.cpp +++ b/src/BLECharacteristic.cpp @@ -47,13 +47,13 @@ BLECharacteristic::BLECharacteristic(BLERemoteCharacteristic* remote) : } } -BLECharacteristic::BLECharacteristic(const char* uuid, uint8_t properties, int valueSize, bool fixedLength) : - BLECharacteristic(new BLELocalCharacteristic(uuid, properties, valueSize, fixedLength)) +BLECharacteristic::BLECharacteristic(const char* uuid, uint16_t permissions, int valueSize, bool fixedLength) : + BLECharacteristic(new BLELocalCharacteristic(uuid, permissions, valueSize, fixedLength)) { } -BLECharacteristic::BLECharacteristic(const char* uuid, uint8_t properties, const char* value) : - BLECharacteristic(new BLELocalCharacteristic(uuid, properties, value)) +BLECharacteristic::BLECharacteristic(const char* uuid, uint16_t permissions, const char* value) : + BLECharacteristic(new BLELocalCharacteristic(uuid, permissions, value)) { } diff --git a/src/BLECharacteristic.h b/src/BLECharacteristic.h index 2ac30b05..da9721e0 100644 --- a/src/BLECharacteristic.h +++ b/src/BLECharacteristic.h @@ -45,8 +45,8 @@ class BLERemoteCharacteristic; class BLECharacteristic { public: BLECharacteristic(); - BLECharacteristic(const char* uuid, uint8_t properties, int valueSize, bool fixedLength = false); - BLECharacteristic(const char* uuid, uint8_t properties, const char* value); + BLECharacteristic(const char* uuid, uint16_t permissions, int valueSize, bool fixedLength = false); + BLECharacteristic(const char* uuid, uint16_t permissions, const char* value); BLECharacteristic(const BLECharacteristic& other); virtual ~BLECharacteristic(); diff --git a/src/BLEProperty.h b/src/BLEProperty.h index aeee4c85..434bd2aa 100644 --- a/src/BLEProperty.h +++ b/src/BLEProperty.h @@ -29,10 +29,19 @@ enum BLEProperty { BLEWrite = 0x08, BLENotify = 0x10, BLEIndicate = 0x20, - BLEAuth = 1 << 6, + BLEAuthSignedWrite = 1 << 6, BLEExtProp = 1 << 7, }; +enum BLEPermission { + BLEEncryption = 1 << 9, + BLEAuthentication = 1 << 10, + BLEAuthorization = 1 << 11, + // BLEWriteEncryption = 1 << 11, + // BLEWriteAuthentication = 1 << 12, + // BLEWriteAuthorization = 1 << 13, +}; + #define ESP_GATT_CHAR_PROP_BIT_BROADCAST (1 << 0) /* 0x01 */ /* relate to BTA_GATT_CHAR_PROP_BIT_BROADCAST in bta/bta_gatt_api.h */ #define ESP_GATT_CHAR_PROP_BIT_READ (1 << 1) /* 0x02 */ /* relate to BTA_GATT_CHAR_PROP_BIT_READ in bta/bta_gatt_api.h */ #define ESP_GATT_CHAR_PROP_BIT_WRITE_NR (1 << 2) /* 0x04 */ /* relate to BTA_GATT_CHAR_PROP_BIT_WRITE_NR in bta/bta_gatt_api.h */ diff --git a/src/BLETypedCharacteristic.h b/src/BLETypedCharacteristic.h index d6e6e4a1..7777d360 100644 --- a/src/BLETypedCharacteristic.h +++ b/src/BLETypedCharacteristic.h @@ -25,7 +25,7 @@ template class BLETypedCharacteristic : public BLECharacteristic { public: - BLETypedCharacteristic(const char* uuid, unsigned char properties); + BLETypedCharacteristic(const char* uuid, unsigned int permissions); int writeValue(T value); int setValue(T value) { return writeValue(value); } @@ -43,8 +43,8 @@ template class BLETypedCharacteristic : public BLECharacteristic T byteSwap(T value); }; -template BLETypedCharacteristic::BLETypedCharacteristic(const char* uuid, unsigned char properties) : - BLECharacteristic(uuid, properties, sizeof(T), true) +template BLETypedCharacteristic::BLETypedCharacteristic(const char* uuid, unsigned int permissions) : + BLECharacteristic(uuid, permissions, sizeof(T), true) { T value; memset(&value, 0x00, sizeof(value)); diff --git a/src/BLETypedCharacteristics.cpp b/src/BLETypedCharacteristics.cpp index 976f6159..800574eb 100644 --- a/src/BLETypedCharacteristics.cpp +++ b/src/BLETypedCharacteristics.cpp @@ -21,72 +21,72 @@ #include "BLETypedCharacteristics.h" -BLEBoolCharacteristic::BLEBoolCharacteristic(const char* uuid, unsigned char properties) : +BLEBoolCharacteristic::BLEBoolCharacteristic(const char* uuid, unsigned int properties) : BLETypedCharacteristic(uuid, properties) { } -BLEBooleanCharacteristic::BLEBooleanCharacteristic(const char* uuid, unsigned char properties) : +BLEBooleanCharacteristic::BLEBooleanCharacteristic(const char* uuid, unsigned int properties) : BLETypedCharacteristic(uuid, properties) { } -BLECharCharacteristic::BLECharCharacteristic(const char* uuid, unsigned char properties) : +BLECharCharacteristic::BLECharCharacteristic(const char* uuid, unsigned int properties) : BLETypedCharacteristic(uuid, properties) { } -BLEUnsignedCharCharacteristic::BLEUnsignedCharCharacteristic(const char* uuid, unsigned char properties) : +BLEUnsignedCharCharacteristic::BLEUnsignedCharCharacteristic(const char* uuid, unsigned int properties) : BLETypedCharacteristic(uuid, properties) { } -BLEByteCharacteristic::BLEByteCharacteristic(const char* uuid, unsigned char properties) : +BLEByteCharacteristic::BLEByteCharacteristic(const char* uuid, unsigned int properties) : BLETypedCharacteristic(uuid, properties) { } -BLEShortCharacteristic::BLEShortCharacteristic(const char* uuid, unsigned char properties) : +BLEShortCharacteristic::BLEShortCharacteristic(const char* uuid, unsigned int properties) : BLETypedCharacteristic(uuid, properties) { } -BLEUnsignedShortCharacteristic::BLEUnsignedShortCharacteristic(const char* uuid, unsigned char properties) : +BLEUnsignedShortCharacteristic::BLEUnsignedShortCharacteristic(const char* uuid, unsigned int properties) : BLETypedCharacteristic(uuid, properties) { } -BLEWordCharacteristic::BLEWordCharacteristic(const char* uuid, unsigned char properties) : +BLEWordCharacteristic::BLEWordCharacteristic(const char* uuid, unsigned int properties) : BLETypedCharacteristic(uuid, properties) { } -BLEIntCharacteristic::BLEIntCharacteristic(const char* uuid, unsigned char properties) : +BLEIntCharacteristic::BLEIntCharacteristic(const char* uuid, unsigned int properties) : BLETypedCharacteristic(uuid, properties) { } -BLEUnsignedIntCharacteristic::BLEUnsignedIntCharacteristic(const char* uuid, unsigned char properties) : +BLEUnsignedIntCharacteristic::BLEUnsignedIntCharacteristic(const char* uuid, unsigned int properties) : BLETypedCharacteristic(uuid, properties) { } -BLELongCharacteristic::BLELongCharacteristic(const char* uuid, unsigned char properties) : +BLELongCharacteristic::BLELongCharacteristic(const char* uuid, unsigned int properties) : BLETypedCharacteristic(uuid, properties) { } -BLEUnsignedLongCharacteristic::BLEUnsignedLongCharacteristic(const char* uuid, unsigned char properties) : +BLEUnsignedLongCharacteristic::BLEUnsignedLongCharacteristic(const char* uuid, unsigned int properties) : BLETypedCharacteristic(uuid, properties) { } -BLEFloatCharacteristic::BLEFloatCharacteristic(const char* uuid, unsigned char properties) : +BLEFloatCharacteristic::BLEFloatCharacteristic(const char* uuid, unsigned int properties) : BLETypedCharacteristic(uuid, properties) { } -BLEDoubleCharacteristic::BLEDoubleCharacteristic(const char* uuid, unsigned char properties) : +BLEDoubleCharacteristic::BLEDoubleCharacteristic(const char* uuid, unsigned int properties) : BLETypedCharacteristic(uuid, properties) { } diff --git a/src/BLETypedCharacteristics.h b/src/BLETypedCharacteristics.h index 465fc046..df8482cf 100644 --- a/src/BLETypedCharacteristics.h +++ b/src/BLETypedCharacteristics.h @@ -24,72 +24,72 @@ class BLEBoolCharacteristic : public BLETypedCharacteristic { public: - BLEBoolCharacteristic(const char* uuid, unsigned char properties); + BLEBoolCharacteristic(const char* uuid, unsigned int permissions); }; class BLEBooleanCharacteristic : public BLETypedCharacteristic { public: - BLEBooleanCharacteristic(const char* uuid, unsigned char properties); + BLEBooleanCharacteristic(const char* uuid, unsigned int permissions); }; class BLECharCharacteristic : public BLETypedCharacteristic { public: - BLECharCharacteristic(const char* uuid, unsigned char properties); + BLECharCharacteristic(const char* uuid, unsigned int permissions); }; class BLEUnsignedCharCharacteristic : public BLETypedCharacteristic { public: - BLEUnsignedCharCharacteristic(const char* uuid, unsigned char properties); + BLEUnsignedCharCharacteristic(const char* uuid, unsigned int permissions); }; class BLEByteCharacteristic : public BLETypedCharacteristic { public: - BLEByteCharacteristic(const char* uuid, unsigned char properties); + BLEByteCharacteristic(const char* uuid, unsigned int permissions); }; class BLEShortCharacteristic : public BLETypedCharacteristic { public: - BLEShortCharacteristic(const char* uuid, unsigned char properties); + BLEShortCharacteristic(const char* uuid, unsigned int permissions); }; class BLEUnsignedShortCharacteristic : public BLETypedCharacteristic { public: - BLEUnsignedShortCharacteristic(const char* uuid, unsigned char properties); + BLEUnsignedShortCharacteristic(const char* uuid, unsigned int permissions); }; class BLEWordCharacteristic : public BLETypedCharacteristic { public: - BLEWordCharacteristic(const char* uuid, unsigned char properties); + BLEWordCharacteristic(const char* uuid, unsigned int permissions); }; class BLEIntCharacteristic : public BLETypedCharacteristic { public: - BLEIntCharacteristic(const char* uuid, unsigned char properties); + BLEIntCharacteristic(const char* uuid, unsigned int permissions); }; class BLEUnsignedIntCharacteristic : public BLETypedCharacteristic { public: - BLEUnsignedIntCharacteristic(const char* uuid, unsigned char properties); + BLEUnsignedIntCharacteristic(const char* uuid, unsigned int permissions); }; class BLELongCharacteristic : public BLETypedCharacteristic { public: - BLELongCharacteristic(const char* uuid, unsigned char properties); + BLELongCharacteristic(const char* uuid, unsigned int permissions); }; class BLEUnsignedLongCharacteristic : public BLETypedCharacteristic { public: - BLEUnsignedLongCharacteristic(const char* uuid, unsigned char properties); + BLEUnsignedLongCharacteristic(const char* uuid, unsigned int permissions); }; class BLEFloatCharacteristic : public BLETypedCharacteristic { public: - BLEFloatCharacteristic(const char* uuid, unsigned char properties); + BLEFloatCharacteristic(const char* uuid, unsigned int permissions); }; class BLEDoubleCharacteristic : public BLETypedCharacteristic { public: - BLEDoubleCharacteristic(const char* uuid, unsigned char properties); + BLEDoubleCharacteristic(const char* uuid, unsigned int permissions); }; #endif diff --git a/src/local/BLELocalCharacteristic.cpp b/src/local/BLELocalCharacteristic.cpp index 333d00b2..2cd801b2 100644 --- a/src/local/BLELocalCharacteristic.cpp +++ b/src/local/BLELocalCharacteristic.cpp @@ -29,20 +29,21 @@ #include "BLELocalCharacteristic.h" -BLELocalCharacteristic::BLELocalCharacteristic(const char* uuid, uint8_t properties, int valueSize, bool fixedLength) : +BLELocalCharacteristic::BLELocalCharacteristic(const char* uuid, uint16_t permissions, int valueSize, bool fixedLength) : BLELocalAttribute(uuid), - _properties(properties), + _properties((uint8_t)(permissions&0x000FF)), _valueSize(min(valueSize, 512)), _valueLength(0), _fixedLength(fixedLength), _handle(0x0000), _broadcast(false), _written(false), - _cccdValue(0x0000) + _cccdValue(0x0000), + _permissions((uint8_t)((permissions&0xFF00)>>8)) { memset(_eventHandlers, 0x00, sizeof(_eventHandlers)); - if (properties & (BLENotify | BLEIndicate)) { + if (permissions & (BLENotify | BLEIndicate)) { BLELocalDescriptor* cccd = new BLELocalDescriptor("2902", (uint8_t*)&_cccdValue, sizeof(_cccdValue)); _descriptors.add(cccd); @@ -51,12 +52,11 @@ BLELocalCharacteristic::BLELocalCharacteristic(const char* uuid, uint8_t propert _value = (uint8_t*)malloc(valueSize); } -BLELocalCharacteristic::BLELocalCharacteristic(const char* uuid, uint8_t properties, const char* value) : - BLELocalCharacteristic(uuid, properties, strlen(value)) +BLELocalCharacteristic::BLELocalCharacteristic(const char* uuid, uint16_t permissions, const char* value) : + BLELocalCharacteristic(uuid, permissions, strlen(value)) { writeValue(value); } - BLELocalCharacteristic::~BLELocalCharacteristic() { for (unsigned int i = 0; i < descriptorCount(); i++) { @@ -84,6 +84,10 @@ uint8_t BLELocalCharacteristic::properties() const return _properties; } +uint8_t BLELocalCharacteristic::permissions() const { + return _permissions; +} + int BLELocalCharacteristic::valueSize() const { return _valueSize; diff --git a/src/local/BLELocalCharacteristic.h b/src/local/BLELocalCharacteristic.h index ee42390a..331cdd5c 100644 --- a/src/local/BLELocalCharacteristic.h +++ b/src/local/BLELocalCharacteristic.h @@ -33,13 +33,14 @@ class BLELocalDescriptor; class BLELocalCharacteristic : public BLELocalAttribute { public: - BLELocalCharacteristic(const char* uuid, uint8_t properties, int valueSize, bool fixedLength = false); - BLELocalCharacteristic(const char* uuid, uint8_t properties, const char* value); + BLELocalCharacteristic(const char* uuid, uint16_t permissions, int valueSize, bool fixedLength = false); + BLELocalCharacteristic(const char* uuid, uint16_t permissions, const char* value); virtual ~BLELocalCharacteristic(); virtual enum BLEAttributeType type() const; uint8_t properties() const; + uint8_t permissions() const; int valueSize() const; const uint8_t* value() const; @@ -75,6 +76,7 @@ class BLELocalCharacteristic : public BLELocalAttribute { private: uint8_t _properties; + uint8_t _permissions; int _valueSize; uint8_t* _value; uint16_t _valueLength; diff --git a/src/local/BLELocalDevice.cpp b/src/local/BLELocalDevice.cpp index df11e971..49cc6603 100644 --- a/src/local/BLELocalDevice.cpp +++ b/src/local/BLELocalDevice.cpp @@ -108,7 +108,7 @@ int BLELocalDevice::begin() end(); return 0; } - if (HCI.setLeEventMask(0x00000000000001FF) != 0) { + if (HCI.setLeEventMask(0x00000000000003FF) != 0) { end(); return 0; } @@ -121,6 +121,59 @@ int BLELocalDevice::begin() return 0; } + /// The HCI should allow automatic address resolution. + + // // If we have callbacks to rememember bonded devices: + // if(HCI._getIRKs!=0){ + // uint8_t nIRKs = 0; + // uint8_t** BADDR_Type = new uint8_t*; + // uint8_t*** BADDRs = new uint8_t**; + // uint8_t*** IRKs = new uint8_t**; + // uint8_t* memcheck; + + + // if(!HCI._getIRKs(&nIRKs, BADDR_Type, BADDRs, IRKs)){ + // Serial.println("error"); + // } + // for(int i=0; i>8)), _valueHandle(valueHandle), _value(NULL), _valueLength(0), diff --git a/src/remote/BLERemoteCharacteristic.h b/src/remote/BLERemoteCharacteristic.h index d0ac09bc..b53ab031 100644 --- a/src/remote/BLERemoteCharacteristic.h +++ b/src/remote/BLERemoteCharacteristic.h @@ -29,10 +29,11 @@ class BLERemoteCharacteristic : public BLERemoteAttribute { public: - BLERemoteCharacteristic(const uint8_t uuid[], uint8_t uuidLen, uint16_t connectionHandle, uint16_t startHandle, uint8_t properties, uint16_t valueHandle); + BLERemoteCharacteristic(const uint8_t uuid[], uint8_t uuidLen, uint16_t connectionHandle, uint16_t startHandle, uint16_t permissions, uint16_t valueHandle); virtual ~BLERemoteCharacteristic(); uint8_t properties() const; + uint8_t permissions() const; const uint8_t* value() const; int valueLength() const; @@ -66,6 +67,7 @@ class BLERemoteCharacteristic : public BLERemoteAttribute { uint16_t _connectionHandle; uint16_t _startHandle; uint8_t _properties; + uint8_t _permissions; uint16_t _valueHandle; uint8_t* _value; diff --git a/src/utility/ATT.cpp b/src/utility/ATT.cpp index 5bd5e2aa..6ef6bc31 100644 --- a/src/utility/ATT.cpp +++ b/src/utility/ATT.cpp @@ -253,6 +253,15 @@ void ATTClass::addConnection(uint16_t handle, uint8_t role, uint8_t peerBdaddrTy _peers[peerIndex].mtu = 23; _peers[peerIndex].addressType = peerBdaddrType; memcpy(_peers[peerIndex].address, peerBdaddr, sizeof(_peers[peerIndex].address)); + uint8_t BDADDr[6]; + for(int i=0; i<6; i++) BDADDr[5-i] = peerBdaddr[i]; + if(HCI.tryResolveAddress(BDADDr,_peers[peerIndex].resolvedAddress)){ +#ifdef _BLE_TRACE_ + Serial.println("Found match."); +#endif + }else{ + memset(_peers[peerIndex].resolvedAddress, 0, 6); + } if (_eventHandlers[BLEConnected]) { _eventHandlers[BLEConnected](BLEDevice(peerBdaddrType, peerBdaddr)); @@ -515,6 +524,7 @@ bool ATTClass::disconnect() _peers[i].role = 0x00; _peers[i].addressType = 0x00; memset(_peers[i].address, 0x00, sizeof(_peers[i].address)); + memset(_peers[i].resolvedAddress, 0x00, sizeof(_peers[i].resolvedAddress)); _peers[i].mtu = 23; if (_peers[i].device) { @@ -1007,7 +1017,8 @@ void ATTClass::readOrReadBlobReq(uint16_t connectionHandle, uint16_t mtu, uint8_ return; } // If characteristic requires encryption send error & hold response until encrypted - if ((characteristic->properties() & BLEAuth) > 0 && (getPeerEncryption(connectionHandle) & PEER_ENCRYPTION::ENCRYPTED_AES)==0) { + if ((characteristic->permissions() & (BLEPermission::BLEEncryption >> 8)) > 0 && + (getPeerEncryption(connectionHandle) & PEER_ENCRYPTION::ENCRYPTED_AES)==0 ) { holdResponse = true; sendError(connectionHandle, opcode, handle, ATT_ECODE_INSUFF_ENC); } @@ -1231,7 +1242,8 @@ void ATTClass::writeReqOrCmd(uint16_t connectionHandle, uint16_t mtu, uint8_t op return; } // Check permssion - if((characteristic->properties() & BLEProperty::BLEAuth)> 0 && (getPeerEncryption(connectionHandle) & PEER_ENCRYPTION::ENCRYPTED_AES) == 0){ + if((characteristic->permissions() &( BLEPermission::BLEEncryption >> 8)) > 0 && + (getPeerEncryption(connectionHandle) & PEER_ENCRYPTION::ENCRYPTED_AES) == 0){ holdResponse = true; sendError(connectionHandle, ATT_OP_WRITE_REQ, handle, ATT_ECODE_INSUFF_ENC); } @@ -1817,7 +1829,7 @@ int ATTClass::setPeerIOCap(uint16_t connectionHandle, uint8_t IOCap[3]){ // Return the connection handle for the first peer that is requesting encryption uint16_t ATTClass::getPeerEncrptingConnectionHandle(){ for(int i=0; i 0){ + if((_peers[i].encryption & PEER_ENCRYPTION::REQUESTED_ENCRYPTION) > 0){ return _peers[i].connectionHandle; } } @@ -1861,7 +1873,7 @@ int ATTClass::getPeerAddrWithType(uint16_t connectionHandle, uint8_t peerAddr[]) peerAddr[6-k] = _peers[i].address[k]; } if(_peers[i].addressType){ - peerAddr[0] = 0x01; + peerAddr[0] = _peers[i].addressType; }else{ peerAddr[0] = 0x00; } @@ -1869,6 +1881,31 @@ int ATTClass::getPeerAddrWithType(uint16_t connectionHandle, uint8_t peerAddr[]) } return 0; } +// Get the resolved address for a peer if it exists +int ATTClass::getPeerResolvedAddress(uint16_t connectionHandle, uint8_t resolvedAddress[]){ + for(int i=0; i #include "BLEDevice.h" +#include "keyDistribution.h" #define ATT_CID 0x0004 #define BLE_CTL 0x0008 @@ -37,11 +38,12 @@ enum PEER_ENCRYPTION { NO_ENCRYPTION = 0, - REQUESTED_ENCRYPTION = 1 << 0, - SENT_PUBKEY = 1 << 1, - DH_KEY_CALULATED = 1 << 2, - RECEIVED_DH_CHECK = 1 << 3, - SENT_DH_CHECK = 1 << 4, + PAIRING_REQUEST = 1 << 0, + REQUESTED_ENCRYPTION = 1 << 1, + SENT_PUBKEY = 1 << 2, + DH_KEY_CALULATED = 1 << 3, + RECEIVED_DH_CHECK = 1 << 4, + SENT_DH_CHECK = 1 << 5, ENCRYPTED_AES = 1 << 7 }; @@ -94,11 +96,17 @@ class ATTClass { virtual int getPeerAddrWithType(uint16_t connectionHandle, uint8_t peerAddr[]); virtual int setPeerIOCap(uint16_t connectionHandle, uint8_t IOCap[]); virtual int getPeerIOCap(uint16_t connectionHandle, uint8_t IOCap[]); + virtual int getPeerResolvedAddress(uint16_t connectionHandle, uint8_t* resolvedAddress); uint8_t holdBuffer[64]; uint8_t writeBuffer[64]; uint8_t holdBufferSize; uint8_t writeBufferSize; virtual int processWriteBuffer(); + KeyDistribution remoteKeyDistribution; + KeyDistribution localKeyDistribution; + uint8_t peerIRK[16]; + /// This is just a random number... Not sure it has use unless privacy mode is active. + uint8_t localIRK[16] = {0x54,0x83,0x63,0x7c,0xc5,0x1e,0xf7,0xec,0x32,0xdd,0xad,0x51,0x89,0x4b,0x9e,0x07}; private: virtual void error(uint16_t connectionHandle, uint8_t dlen, uint8_t data[]); virtual void mtuReq(uint16_t connectionHandle, uint8_t dlen, uint8_t data[]); @@ -139,6 +147,7 @@ class ATTClass { uint8_t role; uint8_t addressType; uint8_t address[6]; + uint8_t resolvedAddress[6]; uint16_t mtu; BLERemoteDevice* device; uint8_t encryption; diff --git a/src/utility/HCI.cpp b/src/utility/HCI.cpp index 805a2c3d..c3d66848 100644 --- a/src/utility/HCI.cpp +++ b/src/utility/HCI.cpp @@ -34,6 +34,7 @@ #define EVT_CMD_COMPLETE 0x0e #define EVT_CMD_STATUS 0x0f #define EVT_NUM_COMP_PKTS 0x13 +#define EVT_RETURN_LINK_KEYS 0x15 #define EVT_UNKNOWN 0x10 #define EVT_LE_META_EVENT 0x3e @@ -449,6 +450,161 @@ int HCIClass::leConnUpdate(uint16_t handle, uint16_t minInterval, uint16_t maxIn return sendCommand(OGF_LE_CTL << 10 | OCF_LE_CONN_UPDATE, sizeof(leConnUpdateData), &leConnUpdateData); } +int HCIClass::saveNewAddress(uint8_t addressType, uint8_t* address, uint8_t* peerIrk, uint8_t* localIrk){ + if(_storeIRK!=0){ + _storeIRK(address, peerIrk); + } + // Again... this should work + // leAddResolvingAddress(addressType, address, peerIrk, localIrk); +} +int HCIClass::leAddResolvingAddress(uint8_t addressType, uint8_t* peerAddress, uint8_t* peerIrk, uint8_t* localIrk){ + leStopResolvingAddresses(); + + struct __attribute__ ((packed)) AddDevice { + uint8_t peerAddressType; + uint8_t peerAddress[6]; + uint8_t peerIRK[16]; + uint8_t localIRK[16]; + } addDevice; + addDevice.peerAddressType = addressType; + for(int i=0; i<6; i++) addDevice.peerAddress[5-i] = peerAddress[i]; + for(int i=0; i<16; i++) { + addDevice.peerIRK[15-i] = peerIrk[i]; + addDevice.localIRK[15-i] = localIrk[i]; + } + Serial.print("ADDTYPE :"); + btct.printBytes(&addDevice.peerAddressType,1); + Serial.print("adddddd :"); + btct.printBytes(addDevice.peerAddress,6); + Serial.print("Peer IRK :"); + btct.printBytes(addDevice.peerIRK,16); + Serial.print("localIRK :"); + btct.printBytes(addDevice.localIRK,16); + sendCommand(OGF_LE_CTL << 10 | 0x27, sizeof(addDevice), &addDevice); + + leStartResolvingAddresses(); +} +int HCIClass::leStopResolvingAddresses(){ + uint8_t enable = 0; + return HCI.sendCommand(OGF_LE_CTL << 10 | 0x2D, 1,&enable); // Disable address resolution +} +int HCIClass::leStartResolvingAddresses(){ + uint8_t enable = 1; + return HCI.sendCommand(OGF_LE_CTL << 10 | 0x2D, 1,&enable); // Disable address resolution +} +int HCIClass::leReadPeerResolvableAddress(uint8_t peerAddressType, uint8_t* peerIdentityAddress, uint8_t* peerResolvableAddress){ + struct __attribute__ ((packed)) Request { + uint8_t addressType; + uint8_t identityAddress[6]; + } request; + request.addressType = peerAddressType; + for(int i=0; i<6; i++) request.identityAddress[5-i] = peerIdentityAddress[i]; + + + int res = sendCommand(OGF_LE_CTL << 10 | 0x2B, sizeof(request), &request); + Serial.print("res: 0x"); + Serial.println(res, HEX); + if(res==0){ + struct __attribute__ ((packed)) Response { + uint8_t status; + uint8_t peerResolvableAddress[6]; + } *response = (Response*)_cmdResponse; + Serial.print("Address resolution status: 0x"); + Serial.println(response->status, HEX); + Serial.print("peer resolvable address: "); + btct.printBytes(response->peerResolvableAddress,6); + } + return res; +} + +int HCIClass::writeLK(uint8_t peerAddress[], uint8_t LK[]){ + struct __attribute__ ((packed)) StoreLK { + uint8_t nKeys; + uint8_t BD_ADDR[6]; + uint8_t LTK[16]; + } storeLK; + storeLK.nKeys = 1; + memcpy(storeLK.BD_ADDR, peerAddress, 6); + for(int i=0; i<16; i++) storeLK.LTK[15-i] = LK[i]; + HCI.sendCommand(OGF_HOST_CTL << 10 | 0x11, sizeof(storeLK), &storeLK); +} +int HCIClass::readStoredLKs(){ + uint8_t BD_ADDR[6]; + readStoredLK(BD_ADDR, 1); +} +int HCIClass::readStoredLK(uint8_t BD_ADDR[], uint8_t read_all ){ + struct __attribute__ ((packed)) Request { + uint8_t BD_ADDR[6]; + uint8_t read_a; + } request = {0,0}; + for(int i=0; i<6; i++) request.BD_ADDR[5-i] = BD_ADDR[i]; + request.read_a = read_all; + return sendCommand(OGF_HOST_CTL << 10 | 0xD, sizeof(request), &request); +} + +int HCIClass::tryResolveAddress(uint8_t* BDAddr, uint8_t* address){ + uint8_t iphone[16] = {0xA6, 0xD2, 0xD, 0xD3, 0x4F, 0x13, 0x42, 0x4F, 0xE1, 0xC1, 0xFD, 0x22, 0x2E, 0xC5, 0x6A, 0x2D}; + uint8_t irk[16]; + for(int i=0; i<16; i++) irk[15-i] = iphone[i]; + bool foundMatch = false; + if(HCI._getIRKs!=0){ + uint8_t nIRKs = 0; + uint8_t** BDAddrType = new uint8_t*; + uint8_t*** BADDRs = new uint8_t**; + uint8_t*** IRKs = new uint8_t**; + uint8_t* memcheck; + + + if(!HCI._getIRKs(&nIRKs, BDAddrType, BADDRs, IRKs)){ + Serial.println("error getting IRKs."); + } + for(int i=0; ienabled,1); #endif if(encryptionChange->enabled>0){ + // 0001 1110 + if((ATT.getPeerEncryption(encryptionChange->connectionHandle)&PEER_ENCRYPTION::PAIRING_REQUEST)>0){ + if(ATT.localKeyDistribution.EncKey()){ +#ifdef _BLE_TRACE_ + Serial.println("Enc key set but sould be ignored"); +#endif + }else{ +#ifdef _BLE_TRACE_ + Serial.println("No enc key distribution"); +#endif + } + // From page 1681 bluetooth standard - order matters + if(ATT.localKeyDistribution.IdKey()){ + /// We shall distribute IRK and address using identity information + { + uint8_t response[17]; + response[0] = CONNECTION_IDENTITY_INFORMATION; // Identity information. + for(int i=0; i<16; i++) response[16-i] = ATT.localIRK[i]; + HCI.sendAclPkt(encryptionChange->connectionHandle, SECURITY_CID, sizeof(response), response); +#ifdef _BLE_TRACE_ + Serial.println("Distribute ID Key"); +#endif + } + { + uint8_t response[8]; + response[0] = CONNECTION_IDENTITY_ADDRESS; // Identity address information + response[1] = 0x00; // Static local address + for(int i=0; i<6; i++) response[7-i] = HCI.localAddr[i]; + HCI.sendAclPkt(encryptionChange->connectionHandle, SECURITY_CID, sizeof(response), response); + } + } + if(ATT.localKeyDistribution.SignKey()){ + /// We shall distribut CSRK +#ifdef _BLE_TRACE_ + Serial.println("We shall distribute CSRK // not implemented"); +#endif + + }else{ + // Serial.println("We don't want to distribute CSRK"); + } + if(ATT.localKeyDistribution.LinkKey()){ +#ifdef _BLE_TRACE_ + Serial.println("We would like to use LTK to generate BR/EDR // not implemented"); +#endif + } + }else{ +#ifdef _BLE_TRACE_ + Serial.println("Reconnection, not pairing so no keys"); + Serial.println(ATT.getPeerEncryption(encryptionChange->connectionHandle),HEX); +#endif + } + ATT.setPeerEncryption(encryptionChange->connectionHandle, PEER_ENCRYPTION::ENCRYPTED_AES); if(ATT.writeBufferSize > 0){ ATT.processWriteBuffer(); @@ -740,6 +948,27 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) data += 2; } } + else if(eventHdr->evt == EVT_RETURN_LINK_KEYS) + { + uint8_t num_keys = (uint8_t)pdata[sizeof(HCIEventHdr)]; + // Serial.print("N keys: "); + // Serial.println(num_keys); + uint8_t BD_ADDRs[num_keys][6]; + uint8_t LKs[num_keys][16]; + auto nAddresss = [pdata](uint8_t nAddr)->uint8_t*{ + return (uint8_t*) &pdata[sizeof(HCIEventHdr)] + 1 + nAddr*6 + nAddr*16; + }; + auto nLK = [pdata](uint8_t nLK)->uint8_t*{ + return (uint8_t*) &pdata[sizeof(HCIEventHdr)] + 1 + (nLK+1)*6 + nLK*16; + }; + // Serial.println("Stored LKs are: "); + // for(int i=0; ievt == 0x10) { struct __attribute__ ((packed)) CmdHardwareError { @@ -761,6 +990,57 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) Serial.println(leMetaHeader->subevent,HEX); #endif switch((LE_META_EVENT)leMetaHeader->subevent){ + case 0x0A:{ + struct __attribute__ ((packed)) EvtLeConnectionComplete { + uint8_t status; + uint16_t handle; + uint8_t role; + uint8_t peerBdaddrType; + uint8_t peerBdaddr[6]; + uint8_t localResolvablePrivateAddress[6]; + uint8_t peerResolvablePrivateAddress[6]; + uint16_t interval; + uint16_t latency; + uint16_t supervisionTimeout; + uint8_t masterClockAccuracy; + } *leConnectionComplete = (EvtLeConnectionComplete*)&pdata[sizeof(HCIEventHdr) + sizeof(LeMetaEventHeader)]; + + if (leConnectionComplete->status == 0x00) { + ATT.addConnection(leConnectionComplete->handle, + leConnectionComplete->role, + leConnectionComplete->peerBdaddrType, + leConnectionComplete->peerBdaddr, + leConnectionComplete->interval, + leConnectionComplete->latency, + leConnectionComplete->supervisionTimeout, + leConnectionComplete->masterClockAccuracy); + + L2CAPSignaling.addConnection(leConnectionComplete->handle, + leConnectionComplete->role, + leConnectionComplete->peerBdaddrType, + leConnectionComplete->peerBdaddr, + leConnectionComplete->interval, + leConnectionComplete->latency, + leConnectionComplete->supervisionTimeout, + leConnectionComplete->masterClockAccuracy); + } + // uint8_t address[6]; + // uint8_t BDAddr[6]; + // for(int i=0; i<6; i++) BDAddr[5-i] = leConnectionComplete->peerBdaddr[i]; + // leReadPeerResolvableAddress(leConnectionComplete->peerBdaddrType,BDAddr,address); + // Serial.print("Resolving address: "); + // btct.printBytes(BDAddr, 6); + // Serial.print("BT answer : "); + // btct.printBytes(address, 6); + +#ifdef _BLE_TRACE_ + Serial.print("Resolved peer : "); + btct.printBytes(leConnectionComplete->peerResolvablePrivateAddress,6); + Serial.print("Resolved local : "); + btct.printBytes(leConnectionComplete->localResolvablePrivateAddress,6); +#endif + break; + } case CONN_COMPLETE:{ struct __attribute__ ((packed)) EvtLeConnectionComplete { uint8_t status; @@ -793,6 +1073,14 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) leConnectionComplete->supervisionTimeout, leConnectionComplete->masterClockAccuracy); } + uint8_t address[6]; + uint8_t BDAddr[6]; + for(int i=0; i<6; i++) BDAddr[5-i] = leConnectionComplete->peerBdaddr[i]; + // leReadPeerResolvableAddress(leConnectionComplete->peerBdaddrType,BDAddr,address); + // Serial.print("Resolving address: "); + // btct.printBytes(BDAddr, 6); + // Serial.print("BT answer : "); + // btct.printBytes(address, 6); break; } case ADVERTISING_REPORT:{ @@ -818,8 +1106,7 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) } break; } - case LONG_TERM_KEY_REQUEST: - { + case LONG_TERM_KEY_REQUEST:{ struct __attribute__ ((packed)) LTKRequest { uint8_t subEventCode; @@ -836,14 +1123,25 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) Serial.print("EDIV : "); btct.printBytes(ltkRequest->encryptedDiversifier,2); #endif - + // Load our LTK for this connection. + uint8_t peerAddr[7]; + uint8_t resolvableAddr[6]; + ATT.getPeerAddrWithType(ltkRequest->connectionHandle, peerAddr); + + if(ATT.getPeerResolvedAddress(ltkRequest->connectionHandle, resolvableAddr) + && !((ATT.getPeerEncryption(ltkRequest->connectionHandle) & PEER_ENCRYPTION::PAIRING_REQUEST)>0)){ + _getLTK(resolvableAddr, HCI.LTK); + }else{ + _getLTK(&peerAddr[1], HCI.LTK); + } + // } // Send our LTK back struct __attribute__ ((packed)) LTKReply { uint16_t connectionHandle; uint8_t LTK[16]; } ltkReply = {0,0}; - ltkReply.connectionHandle = ATT.getPeerEncrptingConnectionHandle(); + ltkReply.connectionHandle = ltkRequest->connectionHandle; for(int i=0; i<16; i++) ltkReply.LTK[15-i] = HCI.LTK[i]; int result = sendCommand(OGF_LE_CTL << 10 | LE_COMMAND::LONG_TERM_KEY_REPLY,sizeof(ltkReply), <kReply); @@ -875,8 +1173,7 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) } break; } - case REMOTE_CONN_PARAM_REQ: - { + case REMOTE_CONN_PARAM_REQ:{ struct __attribute__ ((packed)) RemoteConnParamReq { uint8_t subEventCode; uint16_t connectionHandle; @@ -914,8 +1211,7 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) sendCommand(OGF_LE_CTL << 10 | 0x20, sizeof(remoteConnParamReqReply), &remoteConnParamReqReply); break; } - case READ_LOCAL_P256_COMPLETE: - { + case READ_LOCAL_P256_COMPLETE:{ struct __attribute__ ((packed)) EvtReadLocalP256Complete{ uint8_t subEventCode; uint8_t status; @@ -1007,8 +1303,7 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) } break; } - case GENERATE_DH_KEY_COMPLETE: - { + case GENERATE_DH_KEY_COMPLETE:{ struct __attribute__ ((packed)) EvtLeDHKeyComplete{ uint8_t subEventCode; uint8_t status; diff --git a/src/utility/HCI.h b/src/utility/HCI.h index 0b9c8302..de15bdf8 100644 --- a/src/utility/HCI.h +++ b/src/utility/HCI.h @@ -90,6 +90,17 @@ class HCIClass { virtual int leCancelConn(); virtual int leEncrypt(uint8_t* Key, uint8_t* plaintext, uint8_t* status, uint8_t* ciphertext); + virtual int saveNewAddress(uint8_t addressType, uint8_t* address, uint8_t* peerIrk, uint8_t* remoteIrk); + virtual int leAddResolvingAddress(uint8_t addressType, uint8_t* address, uint8_t* peerIrk, uint8_t* remoteIrk); + virtual int leStopResolvingAddresses(); + virtual int leStartResolvingAddresses(); + virtual int leReadPeerResolvableAddress(uint8_t peerAddressType, uint8_t* peerIdentityAddress, uint8_t* peerResolvableAddress); + + virtual int readStoredLKs(); + virtual int readStoredLK(uint8_t BD_ADDR[], uint8_t read_all = 0); + virtual int writeLK(uint8_t peerAddress[], uint8_t LK[]); + virtual int tryResolveAddress(uint8_t* BDAddr, uint8_t* address); + virtual int sendAclPkt(uint16_t handle, uint8_t cid, uint8_t plen, void* data); virtual int disconnect(uint16_t handle); @@ -105,6 +116,12 @@ class HCIClass { uint8_t DHKey[32]; uint8_t localAddr[6]; uint8_t LTK[16]; + + int (*_storeIRK)(uint8_t* address, uint8_t* peerIrk); + int (*_getIRKs)(uint8_t* nIRKs,uint8_t** BADDR_type, uint8_t*** BADDRs, uint8_t*** IRKs); + int (*_storeLTK)(uint8_t*, uint8_t*); + int (*_getLTK)(uint8_t*, uint8_t*); + private: virtual void handleAclDataPkt(uint8_t plen, uint8_t pdata[]); diff --git a/src/utility/L2CAPSignaling.cpp b/src/utility/L2CAPSignaling.cpp index 3779eb29..512e7665 100644 --- a/src/utility/L2CAPSignaling.cpp +++ b/src/utility/L2CAPSignaling.cpp @@ -21,6 +21,7 @@ #include "ATT.h" #include "btct.h" #include "L2CAPSignaling.h" +#include "keyDistribution.h" #define CONNECTION_PARAMETER_UPDATE_REQUEST 0x12 #define CONNECTION_PARAMETER_UPDATE_RESPONSE 0x13 @@ -137,13 +138,22 @@ void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t uint8_t initiatorKeyDistribution; uint8_t responderKeyDistribution; } *pairingRequest = (PairingRequest*)l2capSignalingHdr->data; + + + ATT.remoteKeyDistribution = KeyDistribution(pairingRequest->initiatorKeyDistribution); + ATT.localKeyDistribution = KeyDistribution(pairingRequest->responderKeyDistribution); + KeyDistribution rkd(pairingRequest->responderKeyDistribution); uint8_t peerIOCap[3]; peerIOCap[0] = pairingRequest->authReq; peerIOCap[1] = pairingRequest->oobDataFlag; peerIOCap[2] = pairingRequest->ioCapability; ATT.setPeerIOCap(connectionHandle, peerIOCap); - + ATT.setPeerEncryption(connectionHandle, ATT.getPeerEncryption(connectionHandle) | PEER_ENCRYPTION::PAIRING_REQUEST); +#ifdef _BLE_TRACE_ + Serial.print("Peer encryption : 0b"); + Serial.print(ATT.getPeerEncryption(connectionHandle), BIN); +#endif struct __attribute__ ((packed)) PairingResponse { uint8_t code; uint8_t ioCapability; @@ -154,7 +164,7 @@ void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t uint8_t responderKeyDistribution; } response = { CONNECTION_PAIRING_RESPONSE, LOCAL_IOCAP, 0, LOCAL_AUTHREQ, 0x10, 0b1011, 0b1011}; - HCI.sendAclPkt(connectionHandle, 0x06, sizeof(response), &response); + HCI.sendAclPkt(connectionHandle, SECURITY_CID, sizeof(response), &response); } else if (code == CONNECTION_PAIRING_RANDOM) { @@ -173,7 +183,7 @@ void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t } response = { CONNECTION_PAIRING_RANDOM, 0}; for(int i=0; i< 16; i++) response.Nb[15-i] = HCI.Nb[i]; - HCI.sendAclPkt(connectionHandle, 0x06, sizeof(response), &response); + HCI.sendAclPkt(connectionHandle, SECURITY_CID, sizeof(response), &response); } else if (code == CONNECTION_PAIRING_RESPONSE) { @@ -190,6 +200,31 @@ void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t Serial.println(pairingFailed->reason,HEX); #endif } + else if (code == CONNECTION_IDENTITY_INFORMATION){ + struct __attribute__ ((packed)) IdentityInformation { + uint8_t code; + uint8_t PeerIRK[16]; + } *identityInformation = (IdentityInformation*)data; + for(int i=0; i<16; i++) ATT.peerIRK[15-i] = identityInformation->PeerIRK[i]; +#ifdef _BLE_TRACE_ + Serial.println("Saved peer IRK"); +#endif + } + else if (code == CONNECTION_IDENTITY_ADDRESS){ + struct __attribute__ ((packed)) IdentityAddress { + uint8_t code; + uint8_t addressType; + uint8_t address[6]; + } *identityAddress = (IdentityAddress*)data; + // we can save this information now. + uint8_t peerAddress[6]; + for(int i; i<6; i++) peerAddress[5-i] = identityAddress->address[i]; + + HCI.saveNewAddress(identityAddress->addressType, peerAddress, ATT.peerIRK, ATT.localIRK); + if(HCI._storeLTK!=0){ + HCI._storeLTK(peerAddress, HCI.LTK); + } + } else if (code == CONNECTION_PAIRING_PUBLIC_KEY){ /// Received a public key struct __attribute__ ((packed)) ConnectionPairingPublicKey { @@ -211,7 +246,7 @@ void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t LE_COMMAND::READ_LOCAL_P256, }; - if(ATT.setPeerEncryption(connectionHandle,PEER_ENCRYPTION::REQUESTED_ENCRYPTION)){ + if(ATT.setPeerEncryption(connectionHandle, ATT.getPeerEncryption(connectionHandle) | PEER_ENCRYPTION::REQUESTED_ENCRYPTION)){ #ifdef _BLE_TRACE_ Serial.println("[Info] Pairing public key"); Serial.println("Requested encryption stored."); @@ -244,7 +279,7 @@ void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t HCI.readBdAddr(); ATT.setPeerEncryption(connectionHandle, encryptionState); - if(encryptionState & PEER_ENCRYPTION::DH_KEY_CALULATED > 0){ + if((encryptionState & PEER_ENCRYPTION::DH_KEY_CALULATED) > 0){ // We've already calculated the DHKey so we can calculate our check and send it. uint8_t MacKey[16]; diff --git a/src/utility/btct.cpp b/src/utility/btct.cpp index 8fad5173..d78e328e 100644 --- a/src/utility/btct.cpp +++ b/src/utility/btct.cpp @@ -119,6 +119,38 @@ int BluetoothCryptoToolbox::f6(uint8_t W[], uint8_t N1[],uint8_t N2[],uint8_t R[ return 1; } // AES_CMAC from RFC +int BluetoothCryptoToolbox::ah(uint8_t k[16], uint8_t r[3], uint8_t* result) +{ + uint8_t r_[16]; + int i=0; + for(i=0; i<16; i++) r_[i] = 0; + for(i=0; i<3; i++) r_[i+13] = r[i]; + uint8_t intermediate[16]; + AES_128(k,r_,intermediate); + for(i=0; i<3; i++){ + result[i] = intermediate[i+13]; + } + return 1; +} +void BluetoothCryptoToolbox::testAh() +{ + uint8_t irk[16] = {0xec,0x02,0x34,0xa3,0x57,0xc8,0xad,0x05,0x34,0x10,0x10,0xa6,0x0a,0x39,0x7d,0x9b}; + uint8_t r[3] = {0x70,0x81,0x94}; + uint8_t expected_AES[16] = {0x15,0x9d,0x5f,0xb7,0x2e,0xbe,0x23,0x11,0xa4,0x8c,0x1b,0xdc,0xc4,0x0d,0xfb,0xaa}; + uint8_t expected_final[3] = {0x0d,0xfb,0xaa}; + + for(int i=0; i<3; i++) r[2-i] = expected_final[3+i]; + uint8_t ourResult[3]; + ah(irk, expected_final, ourResult); + + + Serial.print("Expected : "); + printBytes(&expected_final[3], 3); + Serial.print("Actual : "); + printBytes(ourResult, 3); +} + + void BluetoothCryptoToolbox::AES_CMAC ( unsigned char *key, unsigned char *input, int length, unsigned char *mac ) { diff --git a/src/utility/btct.h b/src/utility/btct.h index 87e515af..43c0b0d6 100644 --- a/src/utility/btct.h +++ b/src/utility/btct.h @@ -13,9 +13,11 @@ class BluetoothCryptoToolbox{ int f5(uint8_t DHKey[],uint8_t N_master[], uint8_t N_slave[], uint8_t BD_ADDR_master[], uint8_t BD_ADDR_slave[], uint8_t MacKey[], uint8_t LTK[]); int f6(uint8_t W[], uint8_t N1[],uint8_t N2[],uint8_t R[], uint8_t IOCap[], uint8_t A1[], uint8_t A2[], uint8_t Ex[]); + int ah(uint8_t k[16], uint8_t r[3], uint8_t result[3]); void test(); void testF5(); void testF6(); + void testAh(); private: int AES_128(uint8_t key[], uint8_t data_in[], uint8_t data_out[]); void leftshift_onebit(unsigned char *input,unsigned char *output); diff --git a/src/utility/keyDistribution.cpp b/src/utility/keyDistribution.cpp new file mode 100644 index 00000000..1a9fe099 --- /dev/null +++ b/src/utility/keyDistribution.cpp @@ -0,0 +1,24 @@ +#include "keyDistribution.h" + +KeyDistribution::KeyDistribution(){} +KeyDistribution::KeyDistribution(uint8_t octet):_octet(octet){} + +#define ENCKEY 0b00000001 +#define IDKEY 0b00000010 +#define SIGNKEY 0b00000100 +#define LINKKEY 0b00001000 +void KeyDistribution::setOctet( uint8_t octet){_octet = octet;} +uint8_t KeyDistribution::getOctet() {return _octet;} +// Ignored when SMP is on LE transport +bool KeyDistribution::EncKey(){ return (_octet & ENCKEY)>0;} +// Device shall distribute IRK using Identity information command followed by its address using Identity address information +bool KeyDistribution::IdKey(){ return (_octet & IDKEY)>0;} +// Device shall distribute CSRK using signing information command +bool KeyDistribution::SignKey(){ return (_octet & SIGNKEY)>0;} +// Device would like to derive BR/EDR from LTK +bool KeyDistribution::LinkKey(){ return (_octet & LINKKEY)>0;} + +void KeyDistribution::setEncKey(bool state) { _octet= state? _octet|ENCKEY : _octet&~ENCKEY;} +void KeyDistribution::setIdKey(bool state) { _octet= state? _octet|IDKEY : _octet&~IDKEY;} +void KeyDistribution::setSignKey(bool state){ _octet= state? _octet|SIGNKEY : _octet&~SIGNKEY;} +void KeyDistribution::setLinkKey(bool state){ _octet= state? _octet|LINKKEY : _octet&~LINKKEY;} \ No newline at end of file diff --git a/src/utility/keyDistribution.h b/src/utility/keyDistribution.h new file mode 100644 index 00000000..d78fcc1a --- /dev/null +++ b/src/utility/keyDistribution.h @@ -0,0 +1,29 @@ +#ifndef _KEY_DISTRIBUTION_H_ +#define _KEY_DISTRIBUTION_H_ +#include + +class KeyDistribution{ +public: + KeyDistribution(); + KeyDistribution(uint8_t octet); + void setOctet( uint8_t octet); + uint8_t getOctet(); + // Ignored when SMP is on LE transport + bool EncKey(); + // Device shall distribute IRK using Identity information command followed by its address using Identity address information + bool IdKey(); + // Device shall distribute CSRK using signing information command + bool SignKey(); + // Device would like to derive BR/EDR from LTK + bool LinkKey(); + + void setEncKey(bool state); + void setIdKey(bool state); + void setSignKey(bool state); + void setLinkKey(bool state); +private: + uint8_t _octet; + // 1. IRK by the slave2. BD ADDR by the slave3. CSRK by the slave4. IRK by the master5. BD_ADDR by the master6. CSRK by the master +}; + +#endif \ No newline at end of file From 1431f3de4f6a4d733b1438bb3fe72a3ea2b614d9 Mon Sep 17 00:00:00 2001 From: unknownconstant Date: Sat, 2 Jan 2021 23:08:27 +0000 Subject: [PATCH 05/83] Fixed packet fragmentation --- src/utility/HCI.cpp | 21 +++++++++++++---- src/utility/L2CAPSignaling.cpp | 13 +++++++++-- src/utility/bitDescriptions.cpp | 30 ++++++++++++++++++++++++ src/utility/bitDescriptions.h | 41 +++++++++++++++++++++++++++++++++ src/utility/keyDistribution.cpp | 2 +- 5 files changed, 100 insertions(+), 7 deletions(-) create mode 100644 src/utility/bitDescriptions.cpp create mode 100644 src/utility/bitDescriptions.h diff --git a/src/utility/HCI.cpp b/src/utility/HCI.cpp index c3d66848..376cfb9c 100644 --- a/src/utility/HCI.cpp +++ b/src/utility/HCI.cpp @@ -707,9 +707,7 @@ void HCIClass::handleAclDataPkt(uint8_t /*plen*/, uint8_t pdata[]) uint16_t cid; } *aclHdr = (HCIACLHdr*)pdata; -#ifdef _BLE_TRACE_ - Serial.println("Received data"); -#endif + uint16_t aclFlags = (aclHdr->handle & 0xf000) >> 12; if ((aclHdr->dlen - 4) != aclHdr->len) { @@ -729,6 +727,17 @@ void HCIClass::handleAclDataPkt(uint8_t /*plen*/, uint8_t pdata[]) } if ((aclHdr->dlen - 4) != aclHdr->len) { +#ifdef _BLE_TRACE_ + Serial.println("Don't have full packet yet"); + Serial.print("Handle: "); + btct.printBytes((uint8_t*)&aclHdr->handle,2); + Serial.print("dlen: "); + btct.printBytes((uint8_t*)&aclHdr->dlen,2); + Serial.print("len: "); + btct.printBytes((uint8_t*)&aclHdr->len,2); + Serial.print("cid: "); + btct.printBytes((uint8_t*)&aclHdr->cid,2); +#endif // don't have the full packet yet return; } @@ -751,7 +760,11 @@ void HCIClass::handleAclDataPkt(uint8_t /*plen*/, uint8_t pdata[]) #ifdef _BLE_TRACE_ Serial.println("Security data"); #endif - L2CAPSignaling.handleSecurityData(aclHdr->handle & 0x0fff, aclHdr->len, &_recvBuffer[1 + sizeof(HCIACLHdr)]); + if (aclFlags == 0x1){ + L2CAPSignaling.handleSecurityData(aclHdr->handle & 0x0fff, aclHdr->len, &_aclPktBuffer[sizeof(HCIACLHdr)]); + }else{ + L2CAPSignaling.handleSecurityData(aclHdr->handle & 0x0fff, aclHdr->len, &_recvBuffer[1 + sizeof(HCIACLHdr)]); + } }else { struct __attribute__ ((packed)) { diff --git a/src/utility/L2CAPSignaling.cpp b/src/utility/L2CAPSignaling.cpp index 512e7665..7d9c2c47 100644 --- a/src/utility/L2CAPSignaling.cpp +++ b/src/utility/L2CAPSignaling.cpp @@ -22,7 +22,7 @@ #include "btct.h" #include "L2CAPSignaling.h" #include "keyDistribution.h" - +#include "bitDescriptions.h" #define CONNECTION_PARAMETER_UPDATE_REQUEST 0x12 #define CONNECTION_PARAMETER_UPDATE_RESPONSE 0x13 @@ -143,6 +143,15 @@ void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t ATT.remoteKeyDistribution = KeyDistribution(pairingRequest->initiatorKeyDistribution); ATT.localKeyDistribution = KeyDistribution(pairingRequest->responderKeyDistribution); KeyDistribution rkd(pairingRequest->responderKeyDistribution); + AuthReq req(pairingRequest->authReq); +#ifdef _BLE_TRACE_ + Serial.print("Req has properties: "); + Serial.print(req.Bonding()?"bonding, ":"no bonding, "); + Serial.print(req.CT2()?"CT2, ":"no CT2, "); + Serial.print(req.KeyPress()?"KeyPress, ":"no KeyPress, "); + Serial.print(req.MITM()?"MITM, ":"no MITM, "); + Serial.print(req.SC()?"SC, ":"no SC, "); +#endif uint8_t peerIOCap[3]; peerIOCap[0] = pairingRequest->authReq; @@ -152,7 +161,7 @@ void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t ATT.setPeerEncryption(connectionHandle, ATT.getPeerEncryption(connectionHandle) | PEER_ENCRYPTION::PAIRING_REQUEST); #ifdef _BLE_TRACE_ Serial.print("Peer encryption : 0b"); - Serial.print(ATT.getPeerEncryption(connectionHandle), BIN); + Serial.println(ATT.getPeerEncryption(connectionHandle), BIN); #endif struct __attribute__ ((packed)) PairingResponse { uint8_t code; diff --git a/src/utility/bitDescriptions.cpp b/src/utility/bitDescriptions.cpp new file mode 100644 index 00000000..bf896bc1 --- /dev/null +++ b/src/utility/bitDescriptions.cpp @@ -0,0 +1,30 @@ +#include "bitDescriptions.h" + + +#define BONDING_BIT 0b00000001 +#define MITM_BIT 0b00000100 +#define SC_BIT 0b00001000 +#define KEYPRESS_BIT 0b00010000 +#define CT2_BIT 0b00100000 + + +AuthReq::AuthReq(){} +AuthReq::AuthReq(uint8_t octet):_octet(octet){} +bool AuthReq::Bonding(){ return (_octet & BONDING_BIT)>0;} +bool AuthReq::MITM(){ return (_octet & MITM_BIT)>0;} +bool AuthReq::SC(){ return (_octet & SC_BIT)>0;} +bool AuthReq::KeyPress(){ return (_octet & KEYPRESS_BIT)>0;} +bool AuthReq::CT2(){ return (_octet & CT2_BIT)>0;} + + +void AuthReq::setBonding(bool state) { _octet= state? _octet|BONDING_BIT : _octet&~BONDING_BIT;} +void AuthReq::setMITM(bool state) { _octet= state? _octet|MITM_BIT : _octet&~MITM_BIT;} +void AuthReq::setSC(bool state){ _octet= state? _octet|SC_BIT : _octet&~SC_BIT;} +void AuthReq::setKeyPress(bool state){ _octet= state? _octet|KEYPRESS_BIT : _octet&~KEYPRESS_BIT;} +void AuthReq::setCT2(bool state){ _octet= state? _octet|CT2_BIT : _octet&~CT2_BIT;} + +uint8_t _octet; + + +void AuthReq::setOctet( uint8_t octet){_octet = octet;} +uint8_t AuthReq::getOctet() {return _octet;} diff --git a/src/utility/bitDescriptions.h b/src/utility/bitDescriptions.h new file mode 100644 index 00000000..6d32c52a --- /dev/null +++ b/src/utility/bitDescriptions.h @@ -0,0 +1,41 @@ +#ifndef _BIT_DESCRIPTIONS_H_ +#define _BIT_DESCRIPTIONS_H_ +#include + +class AuthReq{ +public: + AuthReq(); + AuthReq(uint8_t octet); + void setOctet( uint8_t octet); + uint8_t getOctet(); + + + // The Bonding_Flags field is a 2-bit field that indicates the type of bonding being requested by the initiating device + bool Bonding(); + // The MITM field is a 1-bit flag that is set to one if the device is requesting MITM protection + bool MITM(); + // The SC field is a 1 bit flag. If LE Secure Connections pairing is supported by the device, then the SC field shall be set to 1, otherwise it shall be set to 0. + bool SC(); + // The keypress field is a 1-bit flag that is used only in the Passkey Entry protocol and shall be ignored in other protocols. + bool KeyPress(); + // The CT2 field is a 1-bit flag that shall be set to 1 upon transmission to indicate support for the h7 function. + bool CT2(); + + void setBonding(bool state); + void setMITM(bool state); + void setSC(bool state); + void setKeyPress(bool state); + void setCT2(bool state); +private: + uint8_t _octet; +}; + +enum IOCap { + DisplayOnly, + DisplayYesNo, + KeyboardOnly, + NoInputNoOutput, + KeyboardDisplay +}; + +#endif \ No newline at end of file diff --git a/src/utility/keyDistribution.cpp b/src/utility/keyDistribution.cpp index 1a9fe099..f754366c 100644 --- a/src/utility/keyDistribution.cpp +++ b/src/utility/keyDistribution.cpp @@ -1,6 +1,6 @@ #include "keyDistribution.h" -KeyDistribution::KeyDistribution(){} +KeyDistribution::KeyDistribution():_octet(0){} KeyDistribution::KeyDistribution(uint8_t octet):_octet(octet){} #define ENCKEY 0b00000001 From 6ef59a51a0bf12a12a76e4311ce6080a9f1bbfc4 Mon Sep 17 00:00:00 2001 From: unknownconstant Date: Sun, 3 Jan 2021 20:02:31 +0000 Subject: [PATCH 06/83] Android bugfix --- .../EncryptedBatteryMonitor.ino | 50 ++++++++++--------- src/utility/ATT.cpp | 5 +- src/utility/HCI.cpp | 7 +-- src/utility/L2CAPSignaling.cpp | 8 +-- 4 files changed, 39 insertions(+), 31 deletions(-) diff --git a/examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino b/examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino index 338a374e..d4953b03 100644 --- a/examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino +++ b/examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino @@ -44,34 +44,34 @@ void setup() { // IRKs are keys that identify the true owner of a random mac address. // Add IRKs of devices you are bonded with. - BLE.setGetIRKs([](uint8_t* nIRKs, uint8_t** BADDR_TYPES, uint8_t*** BDAddrs, uint8_t*** IRKs){ + BLE.setGetIRKs([](uint8_t* nIRKs, uint8_t** BDaddrTypes, uint8_t*** BDAddrs, uint8_t*** IRKs){ // Set to number of devices *nIRKs = 2; *BDAddrs = new uint8_t*[*nIRKs]; *IRKs = new uint8_t*[*nIRKs]; - *BADDR_TYPES = new uint8_t[*nIRKs]; + *BDaddrTypes = new uint8_t[*nIRKs]; // Set these to the mac and IRK for your bonded devices as printed in the serial console after bonding. - uint8_t iPhoneMac [6] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; - uint8_t iPhoneIRK[16] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; + uint8_t device1Mac[6] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; + uint8_t device1IRK[16] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; - uint8_t iPadMac[6] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; - uint8_t iPadIRK[16] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, }; + uint8_t device2Mac[6] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; + uint8_t device2IRK[16] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; - (*BADDR_TYPES)[0] = 0; - (*IRKs)[0] = new uint8_t[16]; - memcpy((*IRKs)[0],iPhoneIRK,16); + (*BDaddrTypes)[0] = 0; // Type 0 is for pubc address, type 1 is for static random (*BDAddrs)[0] = new uint8_t[6]; - memcpy((*BDAddrs)[0], iPhoneMac, 6); + (*IRKs)[0] = new uint8_t[16]; + memcpy((*IRKs)[0] , device1IRK,16); + memcpy((*BDAddrs)[0], device1Mac, 6); - (*BADDR_TYPES)[1] = 0; - (*IRKs)[1] = new uint8_t[16]; - memcpy((*IRKs)[1],iPadIRK,16); + (*BDaddrTypes)[1] = 0; (*BDAddrs)[1] = new uint8_t[6]; - memcpy((*BDAddrs)[1], iPadMac, 6); + (*IRKs)[1] = new uint8_t[16]; + memcpy((*IRKs)[1] , device2IRK,16); + memcpy((*BDAddrs)[1], device2Mac, 6); return 1; @@ -83,17 +83,18 @@ void setup() { btct.printBytes(address,6); // Set these to the MAC and LTK of your devices after bonding. - uint8_t iPhoneMac [6] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; - uint8_t iPhoneLTK[16] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; - uint8_t iPadMac [6] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; - uint8_t iPadLTK[16] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; + uint8_t device1Mac[6] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; + uint8_t device1LTK[16] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; + uint8_t device2Mac[6] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; + uint8_t device2LTK[16] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; - if(memcmp(iPhoneMac, address, 6)==0){ - memcpy(LTK, iPhoneLTK, 16); + if(memcmp(device1Mac, address, 6) == 0) { + memcpy(LTK, device1LTK, 16); + return 1; + }else if(memcmp(device2Mac, address, 6) == 0) { + memcpy(LTK, device2LTK, 16); return 1; - }else if(memcmp(iPadMac, address, 6)==0){ - memcpy(LTK, iPadLTK, 16); } return 0; }); @@ -112,7 +113,8 @@ void setup() { return 1; }); - while(1){// begin initialization + while(1){ + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); delay(200); @@ -135,7 +137,7 @@ void setup() { batteryService.addCharacteristic(stringcharacteristic); batteryService.addCharacteristic(secretValue); - BLE.addService(batteryService); // Add the battery service + BLE.addService(batteryService); // Add the battery service batteryLevelChar.writeValue(oldBatteryLevel); // set initial value for this characteristic char* stringCharValue = new char[32]; stringCharValue = "string"; diff --git a/src/utility/ATT.cpp b/src/utility/ATT.cpp index 6ef6bc31..18556413 100644 --- a/src/utility/ATT.cpp +++ b/src/utility/ATT.cpp @@ -260,7 +260,10 @@ void ATTClass::addConnection(uint16_t handle, uint8_t role, uint8_t peerBdaddrTy Serial.println("Found match."); #endif }else{ - memset(_peers[peerIndex].resolvedAddress, 0, 6); +#ifdef _BLE_TRACE_ + Serial.println("No matching MAC"); +#endif + memset(&_peers[peerIndex].resolvedAddress, 0, 6); } if (_eventHandlers[BLEConnected]) { diff --git a/src/utility/HCI.cpp b/src/utility/HCI.cpp index 376cfb9c..4dc78460 100644 --- a/src/utility/HCI.cpp +++ b/src/utility/HCI.cpp @@ -1218,10 +1218,11 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) uint16_t minLength; uint16_t maxLength; } remoteConnParamReqReply; - memcpy(&remoteConnParamReqReply, &remoteConnParamReq->connectionHandle, sizeof(remoteConnParamReq-1)); + memcpy(&remoteConnParamReqReply, &remoteConnParamReq->connectionHandle, sizeof(RemoteConnParamReq)-1); + remoteConnParamReqReply.minLength = 0x000F; remoteConnParamReqReply.maxLength = 0x0FFF; - sendCommand(OGF_LE_CTL << 10 | 0x20, sizeof(remoteConnParamReqReply), &remoteConnParamReqReply); + sendCommand(OGF_LE_CTL << 10 | 0x20, sizeof(RemoteConnParamReqReply), &remoteConnParamReqReply); break; } case READ_LOCAL_P256_COMPLETE:{ @@ -1381,7 +1382,7 @@ int HCIClass::leEncrypt(uint8_t* key, uint8_t* plaintext, uint8_t* status, uint8 leEncryptCommand.plaintext[15-i] = plaintext[i]; } - int res = sendCommand(OGF_LE_CTL << 10 | LE_COMMAND::ENCRYPT, sizeof(leEncryptCommand), &leEncryptCommand); + int res = sendCommand(OGF_LE_CTL << 10 | LE_COMMAND::ENCRYPT, 32, &leEncryptCommand); if(res == 0){ #ifdef _BLE_TRACE_ Serial.print("Copying from command Response length: "); diff --git a/src/utility/L2CAPSignaling.cpp b/src/utility/L2CAPSignaling.cpp index 7d9c2c47..f7f93b84 100644 --- a/src/utility/L2CAPSignaling.cpp +++ b/src/utility/L2CAPSignaling.cpp @@ -144,6 +144,8 @@ void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t ATT.localKeyDistribution = KeyDistribution(pairingRequest->responderKeyDistribution); KeyDistribution rkd(pairingRequest->responderKeyDistribution); AuthReq req(pairingRequest->authReq); + KeyDistribution responseKD = KeyDistribution(); + responseKD.setIdKey(true); #ifdef _BLE_TRACE_ Serial.print("Req has properties: "); Serial.print(req.Bonding()?"bonding, ":"no bonding, "); @@ -171,7 +173,7 @@ void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t uint8_t maxEncSize; uint8_t initiatorKeyDistribution; uint8_t responderKeyDistribution; - } response = { CONNECTION_PAIRING_RESPONSE, LOCAL_IOCAP, 0, LOCAL_AUTHREQ, 0x10, 0b1011, 0b1011}; + } response = { CONNECTION_PAIRING_RESPONSE, LOCAL_IOCAP, 0, LOCAL_AUTHREQ, 0x10, responseKD.getOctet(), responseKD.getOctet()}; HCI.sendAclPkt(connectionHandle, SECURITY_CID, sizeof(response), &response); } @@ -316,9 +318,9 @@ void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t Serial.println("Calculate f5, f6:"); Serial.print("DH : "); btct.printBytes(HCI.DHKey,32); - Serial.println("Na : "); + Serial.print("Na : "); btct.printBytes(HCI.Na,16); - Serial.println("Nb : "); + Serial.print("Nb : "); btct.printBytes(HCI.Nb,16); Serial.print("MAC : "); btct.printBytes(MacKey,16); From 0aa2e87a7c322931793657b8096afd8930a312d4 Mon Sep 17 00:00:00 2001 From: eltos Date: Sun, 3 Jan 2021 23:25:59 +0100 Subject: [PATCH 07/83] Handle remote DHKey confirmation before own DHKey --- src/utility/HCI.cpp | 74 +++++++++++++++++++++++++++++++++- src/utility/HCI.h | 1 + src/utility/L2CAPSignaling.cpp | 12 +++++- 3 files changed, 83 insertions(+), 4 deletions(-) diff --git a/src/utility/HCI.cpp b/src/utility/HCI.cpp index 4dc78460..014e25a3 100644 --- a/src/utility/HCI.cpp +++ b/src/utility/HCI.cpp @@ -1345,13 +1345,83 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) #endif encryption |= PEER_ENCRYPTION::DH_KEY_CALULATED; ATT.setPeerEncryption(connectionHandle, encryption); + + if((encryption & PEER_ENCRYPTION::RECEIVED_DH_CHECK) > 0){ +#ifdef _BLE_TRACE_ + Serial.println("Recieved DHKey check already so calculate f5, f6 now."); +#endif + + uint8_t BD_ADDR_REMOTE[7]; + ATT.getPeerAddrWithType(connectionHandle, BD_ADDR_REMOTE); + + + uint8_t MacKey[16]; + uint8_t localAddress[7]; + + memcpy(&localAddress[1],HCI.localAddr,6); + localAddress[0] = 0; // IOT 33 uses a static address + + btct.f5(HCI.DHKey,HCI.Na,HCI.Nb,BD_ADDR_REMOTE,localAddress,MacKey,HCI.LTK); + + uint8_t Ea[16]; + uint8_t Eb[16]; + uint8_t R[16]; + uint8_t MasterIOCap[3]; + uint8_t SlaveIOCap[3] = {LOCAL_AUTHREQ, 0x0, LOCAL_IOCAP}; + + ATT.getPeerIOCap(connectionHandle, MasterIOCap); + for(int i=0; i<16; i++) R[i] = 0; + + btct.f6(MacKey, HCI.Na,HCI.Nb,R, MasterIOCap, BD_ADDR_REMOTE, localAddress, Ea); + btct.f6(MacKey, HCI.Nb,HCI.Na,R, SlaveIOCap, localAddress, BD_ADDR_REMOTE, Eb); + + #ifdef _BLE_TRACE_ - if(encryption | PEER_ENCRYPTION::RECEIVED_DH_CHECK){ - Serial.println("Recieved DHKey check already so calculate f5, f6."); + Serial.println("Calculate f5, f6:"); + Serial.print("DH : "); + btct.printBytes(HCI.DHKey,32); + Serial.print("Na : "); + btct.printBytes(HCI.Na,16); + Serial.print("Nb : "); + btct.printBytes(HCI.Nb,16); + Serial.print("MAC : "); + btct.printBytes(MacKey,16); + // Serial.print("Expected MAC: "); + // printBytes(EXPECTED_MAC, 16); + Serial.print("LTK : "); + btct.printBytes(HCI.LTK,16); + // Serial.print("Expected LTK: "); + // printBytes(EXPECTED_LTK, 16); + Serial.print("Expected Ex : "); + btct.printBytes(HCI.remoteDHKeyCheckBuffer, 16); + Serial.print("Ea : "); + btct.printBytes(Ea, 16); + Serial.print("Eb : "); + btct.printBytes(Eb,16); + Serial.print("Local Addr : "); + btct.printBytes(localAddress, 7); + Serial.print("LocalIOCap : "); + btct.printBytes(SlaveIOCap, 3); + Serial.print("MasterAddr : "); + btct.printBytes(BD_ADDR_REMOTE, 7); + Serial.print("MasterIOCAP : "); + btct.printBytes(MasterIOCap, 3); + Serial.println("Send Eb Back."); +#endif + uint8_t ret[17]; + ret[0] = 0x0d; + for(int i=0; istatus, HEX); #endif diff --git a/src/utility/HCI.h b/src/utility/HCI.h index de15bdf8..4ed9e82e 100644 --- a/src/utility/HCI.h +++ b/src/utility/HCI.h @@ -111,6 +111,7 @@ class HCIClass { // TODO: Send command be private again & use ATT implementation within ATT. virtual int sendCommand(uint16_t opcode, uint8_t plen = 0, void* parameters = NULL); uint8_t remotePublicKeyBuffer[64]; + uint8_t remoteDHKeyCheckBuffer[16]; uint8_t Na[16]; uint8_t Nb[16]; uint8_t DHKey[32]; diff --git a/src/utility/L2CAPSignaling.cpp b/src/utility/L2CAPSignaling.cpp index f7f93b84..60152a7d 100644 --- a/src/utility/L2CAPSignaling.cpp +++ b/src/utility/L2CAPSignaling.cpp @@ -290,7 +290,14 @@ void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t HCI.readBdAddr(); ATT.setPeerEncryption(connectionHandle, encryptionState); - if((encryptionState & PEER_ENCRYPTION::DH_KEY_CALULATED) > 0){ + if((encryptionState & PEER_ENCRYPTION::DH_KEY_CALULATED) == 0){ +#ifdef _BLE_TRACE_ + Serial.println("DHKey not yet ready, will calculate f5, f6 later"); +#endif + // store RemoteDHKeyCheck for later check + memcpy(HCI.remoteDHKeyCheckBuffer,RemoteDHKeyCheck,16); + + } else { // We've already calculated the DHKey so we can calculate our check and send it. uint8_t MacKey[16]; @@ -312,7 +319,7 @@ void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t btct.f6(MacKey, HCI.Na,HCI.Nb,R, MasterIOCap, BD_ADDR_REMOTE, localAddress, Ea); btct.f6(MacKey, HCI.Nb,HCI.Na,R, SlaveIOCap, localAddress, BD_ADDR_REMOTE, Eb); - + #ifdef _BLE_TRACE_ Serial.println("Calculate f5, f6:"); @@ -353,6 +360,7 @@ void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t ret[sizeof(Eb)-i] = Eb[i]; } HCI.sendAclPkt(connectionHandle, 0x06, sizeof(ret), ret ); + ATT.setPeerEncryption(connectionHandle, encryptionState | PEER_ENCRYPTION::SENT_DH_CHECK); } } } From 750b7f179546520f6929db2485fd40ba747ebe2f Mon Sep 17 00:00:00 2001 From: eltos Date: Sun, 3 Jan 2021 23:45:38 +0100 Subject: [PATCH 08/83] Actually check remote DHKey --- src/utility/HCI.cpp | 35 +++++++++++++++++++++++++++------ src/utility/L2CAPSignaling.cpp | 36 +++++++++++++++++++++++++++------- 2 files changed, 58 insertions(+), 13 deletions(-) diff --git a/src/utility/HCI.cpp b/src/utility/HCI.cpp index 014e25a3..157ed7d3 100644 --- a/src/utility/HCI.cpp +++ b/src/utility/HCI.cpp @@ -24,6 +24,8 @@ #include "btct.h" #include "HCI.h" +//#define _BLE_TRACE_ + #define HCI_COMMAND_PKT 0x01 #define HCI_ACLDATA_PKT 0x02 #define HCI_EVENT_PKT 0x04 @@ -1408,13 +1410,34 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) btct.printBytes(MasterIOCap, 3); Serial.println("Send Eb Back."); #endif - uint8_t ret[17]; - ret[0] = 0x0d; - for(int i=0; i Date: Mon, 4 Jan 2021 11:07:36 +0100 Subject: [PATCH 09/83] Move LTK signaling and confirm to separate method --- src/utility/HCI.cpp | 89 +------------------ src/utility/HCI.h | 2 + src/utility/L2CAPSignaling.cpp | 150 +++++++++++++++------------------ src/utility/L2CAPSignaling.h | 6 ++ 4 files changed, 80 insertions(+), 167 deletions(-) diff --git a/src/utility/HCI.cpp b/src/utility/HCI.cpp index 157ed7d3..4c97f79d 100644 --- a/src/utility/HCI.cpp +++ b/src/utility/HCI.cpp @@ -1337,7 +1337,6 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) break; } - uint8_t encryption = ATT.getPeerEncryption(connectionHandle); for(int i=0; i<32; i++) DHKey[31-i] = evtLeDHKeyComplete->DHKey[i]; @@ -1345,98 +1344,14 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) Serial.println("Stored our DHKey:"); btct.printBytes(DHKey,32); #endif - encryption |= PEER_ENCRYPTION::DH_KEY_CALULATED; + uint8_t encryption = ATT.getPeerEncryption(connectionHandle) | PEER_ENCRYPTION::DH_KEY_CALULATED; ATT.setPeerEncryption(connectionHandle, encryption); if((encryption & PEER_ENCRYPTION::RECEIVED_DH_CHECK) > 0){ #ifdef _BLE_TRACE_ Serial.println("Recieved DHKey check already so calculate f5, f6 now."); #endif - - uint8_t BD_ADDR_REMOTE[7]; - ATT.getPeerAddrWithType(connectionHandle, BD_ADDR_REMOTE); - - - uint8_t MacKey[16]; - uint8_t localAddress[7]; - - memcpy(&localAddress[1],HCI.localAddr,6); - localAddress[0] = 0; // IOT 33 uses a static address - - btct.f5(HCI.DHKey,HCI.Na,HCI.Nb,BD_ADDR_REMOTE,localAddress,MacKey,HCI.LTK); - - uint8_t Ea[16]; - uint8_t Eb[16]; - uint8_t R[16]; - uint8_t MasterIOCap[3]; - uint8_t SlaveIOCap[3] = {LOCAL_AUTHREQ, 0x0, LOCAL_IOCAP}; - - ATT.getPeerIOCap(connectionHandle, MasterIOCap); - for(int i=0; i<16; i++) R[i] = 0; - - btct.f6(MacKey, HCI.Na,HCI.Nb,R, MasterIOCap, BD_ADDR_REMOTE, localAddress, Ea); - btct.f6(MacKey, HCI.Nb,HCI.Na,R, SlaveIOCap, localAddress, BD_ADDR_REMOTE, Eb); - - -#ifdef _BLE_TRACE_ - Serial.println("Calculate f5, f6:"); - Serial.print("DH : "); - btct.printBytes(HCI.DHKey,32); - Serial.print("Na : "); - btct.printBytes(HCI.Na,16); - Serial.print("Nb : "); - btct.printBytes(HCI.Nb,16); - Serial.print("MAC : "); - btct.printBytes(MacKey,16); - // Serial.print("Expected MAC: "); - // printBytes(EXPECTED_MAC, 16); - Serial.print("LTK : "); - btct.printBytes(HCI.LTK,16); - // Serial.print("Expected LTK: "); - // printBytes(EXPECTED_LTK, 16); - Serial.print("Expected Ex : "); - btct.printBytes(HCI.remoteDHKeyCheckBuffer, 16); - Serial.print("Ea : "); - btct.printBytes(Ea, 16); - Serial.print("Eb : "); - btct.printBytes(Eb,16); - Serial.print("Local Addr : "); - btct.printBytes(localAddress, 7); - Serial.print("LocalIOCap : "); - btct.printBytes(SlaveIOCap, 3); - Serial.print("MasterAddr : "); - btct.printBytes(BD_ADDR_REMOTE, 7); - Serial.print("MasterIOCAP : "); - btct.printBytes(MasterIOCap, 3); - Serial.println("Send Eb Back."); -#endif - // Check if RemoteDHKeyCheck = Ea - bool EaCheck = true; - for(int i = 0; i < 16; i++){ - if (Ea[i] != HCI.remoteDHKeyCheckBuffer[i]){ - EaCheck = false; - } - } - - if (EaCheck){ - // Send our confirmation value to complete authentication stage 2 - uint8_t ret[17]; - ret[0] = CONNECTION_PAIRING_DHKEY_CHECK; - for(int i=0; i +#include "L2CAPSignaling.h" + #define OGF_LINK_CTL 0x01 #define OGF_HOST_CTL 0x03 #define OGF_INFO_PARAM 0x04 diff --git a/src/utility/L2CAPSignaling.cpp b/src/utility/L2CAPSignaling.cpp index 322bd13d..4adeaa0d 100644 --- a/src/utility/L2CAPSignaling.cpp +++ b/src/utility/L2CAPSignaling.cpp @@ -278,11 +278,8 @@ void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t else if(code == CONNECTION_PAIRING_DHKEY_CHECK) { uint8_t RemoteDHKeyCheck[16]; - uint8_t BD_ADDR_REMOTE[7]; - ATT.getPeerAddrWithType(connectionHandle, BD_ADDR_REMOTE); for(int i=0; i<16; i++) RemoteDHKeyCheck[15-i] = l2capSignalingHdr->data[i]; - uint8_t encryptionState = ATT.getPeerEncryption(connectionHandle) | PEER_ENCRYPTION::RECEIVED_DH_CHECK; - + #ifdef _BLE_TRACE_ Serial.println("[Info] DH Key check"); @@ -290,7 +287,9 @@ void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t btct.printBytes(RemoteDHKeyCheck, 16); #endif - HCI.readBdAddr(); + + + uint8_t encryptionState = ATT.getPeerEncryption(connectionHandle) | PEER_ENCRYPTION::RECEIVED_DH_CHECK; ATT.setPeerEncryption(connectionHandle, encryptionState); if((encryptionState & PEER_ENCRYPTION::DH_KEY_CALULATED) == 0){ #ifdef _BLE_TRACE_ @@ -301,89 +300,80 @@ void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t } else { // We've already calculated the DHKey so we can calculate our check and send it. + smCalculateLTKandConfirm(connectionHandle, RemoteDHKeyCheck); - uint8_t MacKey[16]; - uint8_t localAddress[7]; - - memcpy(&localAddress[1],HCI.localAddr,6); - localAddress[0] = 0; // IOT 33 uses a static address + } + } +} - btct.f5(HCI.DHKey,HCI.Na,HCI.Nb,BD_ADDR_REMOTE,localAddress,MacKey,HCI.LTK); - - uint8_t Ea[16]; - uint8_t Eb[16]; - uint8_t R[16]; - uint8_t MasterIOCap[3]; - uint8_t SlaveIOCap[3] = {LOCAL_AUTHREQ, 0x0, LOCAL_IOCAP}; - - ATT.getPeerIOCap(connectionHandle, MasterIOCap); - for(int i=0; i<16; i++) R[i] = 0; - - btct.f6(MacKey, HCI.Na,HCI.Nb,R, MasterIOCap, BD_ADDR_REMOTE, localAddress, Ea); - btct.f6(MacKey, HCI.Nb,HCI.Na,R, SlaveIOCap, localAddress, BD_ADDR_REMOTE, Eb); - +void L2CAPSignalingClass::smCalculateLTKandConfirm(uint16_t handle, uint8_t expectedEa[]) +{ // Authentication stage 2: LTK Calculation + + uint8_t localAddress[7]; + uint8_t remoteAddress[7]; + ATT.getPeerAddrWithType(handle, remoteAddress); + + HCI.readBdAddr(); + memcpy(&localAddress[1],HCI.localAddr,6); + localAddress[0] = 0; // IOT 33 uses a static address // TODO: confirm for Nano BLE + + // Compute the LTK and MacKey + uint8_t MacKey[16]; + btct.f5(HCI.DHKey, HCI.Na, HCI.Nb, remoteAddress, localAddress, MacKey, HCI.LTK); + + // Compute Ea and Eb + uint8_t Ea[16]; + uint8_t Eb[16]; + uint8_t R[16]; + uint8_t MasterIOCap[3]; + uint8_t SlaveIOCap[3] = {LOCAL_AUTHREQ, 0x0, LOCAL_IOCAP}; + + ATT.getPeerIOCap(handle, MasterIOCap); + for(int i=0; i<16; i++) R[i] = 0; + + btct.f6(MacKey, HCI.Na,HCI.Nb,R, MasterIOCap, remoteAddress, localAddress, Ea); + btct.f6(MacKey, HCI.Nb,HCI.Na,R, SlaveIOCap, localAddress, remoteAddress, Eb); #ifdef _BLE_TRACE_ - Serial.println("Calculate f5, f6:"); - Serial.print("DH : "); - btct.printBytes(HCI.DHKey,32); - Serial.print("Na : "); - btct.printBytes(HCI.Na,16); - Serial.print("Nb : "); - btct.printBytes(HCI.Nb,16); - Serial.print("MAC : "); - btct.printBytes(MacKey,16); - // Serial.print("Expected MAC: "); - // printBytes(EXPECTED_MAC, 16); - Serial.print("LTK : "); - btct.printBytes(HCI.LTK,16); - // Serial.print("Expected LTK: "); - // printBytes(EXPECTED_LTK, 16); - Serial.print("Expected Ex : "); - btct.printBytes(RemoteDHKeyCheck, 16); - Serial.print("Ea : "); - btct.printBytes(Ea, 16); - Serial.print("Eb : "); - btct.printBytes(Eb,16); - Serial.print("Local Addr : "); - btct.printBytes(localAddress, 7); - Serial.print("LocalIOCap : "); - btct.printBytes(SlaveIOCap, 3); - Serial.print("MasterAddr : "); - btct.printBytes(BD_ADDR_REMOTE, 7); - Serial.print("MasterIOCAP : "); - btct.printBytes(MasterIOCap, 3); - Serial.println("Send Eb Back."); + Serial.println("Calculate and confirm LTK via f5, f6:"); + Serial.print("DHKey : "); btct.printBytes(HCI.DHKey,32); + Serial.print("Na : "); btct.printBytes(HCI.Na,16); + Serial.print("Nb : "); btct.printBytes(HCI.Nb,16); + Serial.print("MacKey : "); btct.printBytes(MacKey,16); + Serial.print("LTK : "); btct.printBytes(HCI.LTK,16); + Serial.print("Expected Ea: "); btct.printBytes(expectedEa, 16); + Serial.print("Ea : "); btct.printBytes(Ea, 16); + Serial.print("Eb : "); btct.printBytes(Eb,16); + Serial.print("Local Addr : "); btct.printBytes(localAddress, 7); + Serial.print("LocalIOCap : "); btct.printBytes(SlaveIOCap, 3); + Serial.print("MasterAddr : "); btct.printBytes(remoteAddress, 7); + Serial.print("MasterIOCAP: "); btct.printBytes(MasterIOCap, 3); #endif - // Check if RemoteDHKeyCheck = Ea - bool EaCheck = true; - for(int i = 0; i < 16; i++){ - if (Ea[i] != RemoteDHKeyCheck[i]){ - EaCheck = false; - } - } - - if (EaCheck){ - // Send our confirmation value to complete authentication stage 2 - uint8_t ret[17]; - ret[0] = CONNECTION_PAIRING_DHKEY_CHECK; - for(int i=0; i Date: Mon, 4 Jan 2021 12:20:06 +0100 Subject: [PATCH 10/83] Add method to control and query pairing --- .../EncryptedBatteryMonitor.ino | 67 +++++++---- keywords.txt | 3 + src/local/BLELocalDevice.cpp | 26 +++++ src/local/BLELocalDevice.h | 10 ++ src/utility/ATT.cpp | 26 +++++ src/utility/ATT.h | 2 + src/utility/L2CAPSignaling.cpp | 105 +++++++++++------- src/utility/L2CAPSignaling.h | 13 ++- 8 files changed, 190 insertions(+), 62 deletions(-) diff --git a/examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino b/examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino index d4953b03..fd40f5ee 100644 --- a/examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino +++ b/examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino @@ -18,6 +18,14 @@ #include +#define PAIR_BUTTON D3 // button for pairing +#define PAIR_LED 24 // LED used to signal pairing +#define PAIR_LED_ON LOW // Blue LED on Nano BLE has inverted logic +#define PAIR_INTERVAL 30000 // interval for pairing after button press in ms + +#define CTRL_LED LED_BUILTIN + + // BLE Battery Service BLEService batteryService("180F"); @@ -31,13 +39,17 @@ BLEStringCharacteristic stringcharacteristic("183E", BLERead | BLEWrite, 31); BLEUnsignedCharCharacteristic secretValue("2a3F", BLERead | BLEWrite | BLEEncryption); int oldBatteryLevel = 0; // last battery level reading from analog input -long previousMillis = 0; // last time the battery level was checked, in ms +unsigned long previousMillis = 0; // last time the battery level was checked, in ms +unsigned long pairingStarted = 0; // pairing start time when button is pressed +bool wasConnected = 0; void setup() { Serial.begin(9600); // initialize serial communication while (!Serial); - pinMode(LED_BUILTIN, OUTPUT); // initialize the built-in LED pin to indicate when a central is connected + pinMode(CTRL_LED, OUTPUT); // initialize the built-in LED pin to indicate when a central is connected + pinMode(PAIR_LED, OUTPUT); + pinMode(PAIR_BUTTON, INPUT_PULLUP); Serial.println("Serial connected"); @@ -145,6 +157,9 @@ void setup() { secretValue.writeValue(0); delay(1000); + + // prevent pairing until button is pressed (will show a pairing rejected message) + BLE.setPairable(false); /* Start advertising BLE. It will start continuously transmitting BLE advertising packets and will be visible to remote BLE central devices @@ -169,30 +184,44 @@ void loop() { // wait for a BLE central BLEDevice central = BLE.central(); + + // If button is pressed, allow pairing for 30 sec + if (!BLE.pairable() && digitalRead(PAIR_BUTTON) == LOW){ + pairingStarted = millis(); + BLE.setPairable(Pairable::ONCE); + Serial.println("Accepting pairing for 30s"); + } else if (BLE.pairable() && millis() > pairingStarted + PAIR_INTERVAL){ + BLE.setPairable(false); + Serial.println("No longer accepting pairing"); + } + // Make LED blink while pairing is allowed + digitalWrite(PAIR_LED, (BLE.pairable() ? (millis()%400)<200 : BLE.paired()) ? PAIR_LED_ON : !PAIR_LED_ON); + + // if a central is connected to the peripheral: - if (central) { - Serial.print("Connected to central: "); - // print the central's BT address: - Serial.println(central.address()); + if (central && central.connected()) { + if (!wasConnected){ + wasConnected = true; + Serial.print("Connected to central: "); + // print the central's BT address: + Serial.println(central.address()); + } // check the battery level every 200ms // while the central is connected: - while (central.connected()) { - long currentMillis = millis(); - // if 200ms have passed, check the battery level: - if (currentMillis - previousMillis >= 1000) { - previousMillis = currentMillis; - updateBatteryLevel(); - if(secretValue.value()>0){ - digitalWrite(13,HIGH); - }else{ - digitalWrite(13,LOW); - } - } + long currentMillis = millis(); + // if 200ms have passed, check the battery level: + if (currentMillis - previousMillis >= 1000) { + previousMillis = currentMillis; + updateBatteryLevel(); + digitalWrite(CTRL_LED, secretValue.value()>0 ? HIGH : LOW); } + } else if (wasConnected){ + wasConnected = false; Serial.print("Disconnected from central: "); Serial.println(central.address()); } + } void updateBatteryLevel() { @@ -208,4 +237,4 @@ void updateBatteryLevel() { batteryLevelChar.writeValue(batteryLevel); // and update the battery level characteristic oldBatteryLevel = batteryLevel; // save the level for next comparison } -} +} \ No newline at end of file diff --git a/keywords.txt b/keywords.txt index 464cac72..effdfbca 100644 --- a/keywords.txt +++ b/keywords.txt @@ -77,9 +77,12 @@ setEventHandler KEYWORD2 setAdvertisingInterval KEYWORD2 setConnectionInterval KEYWORD2 setConnectable KEYWORD2 +setPairable KEYWORD2 setTimeout KEYWORD2 debug KEYWORD2 noDebug KEYWORD2 +pairable KEYWORD2 +paired KEYWORD2 properties KEYWORD2 valueSize KEYWORD2 diff --git a/src/local/BLELocalDevice.cpp b/src/local/BLELocalDevice.cpp index 49cc6603..029fb488 100644 --- a/src/local/BLELocalDevice.cpp +++ b/src/local/BLELocalDevice.cpp @@ -214,6 +214,16 @@ bool BLELocalDevice::connected() const return ATT.connected(); } +/* + * Whether there is at least one paired device + */ +bool BLELocalDevice::paired() +{ + HCI.poll(); + + return ATT.paired(); +} + bool BLELocalDevice::disconnect() { return ATT.disconnect(); @@ -395,6 +405,22 @@ void BLELocalDevice::setTimeout(unsigned long timeout) ATT.setTimeout(timeout); } +/* + * Control whether pairing is allowed or rejected + * Use true/false or the Pairable enum + */ +void BLELocalDevice::setPairable(uint8_t pairable) +{ + L2CAPSignaling.setPairingEnabled(pairable); +} + +/* + * Whether pairing is currently allowed + */ +bool BLELocalDevice::pairable() +{ + return L2CAPSignaling.isPairingEnabled(); +} void BLELocalDevice::setGetIRKs(int (*getIRKs)(uint8_t* nIRKs, uint8_t** BADDR_type, uint8_t*** BADDRs, uint8_t*** IRKs)){ HCI._getIRKs = getIRKs; diff --git a/src/local/BLELocalDevice.h b/src/local/BLELocalDevice.h index 22a5f589..0c471938 100644 --- a/src/local/BLELocalDevice.h +++ b/src/local/BLELocalDevice.h @@ -24,6 +24,12 @@ #include "BLEService.h" #include "BLEAdvertisingData.h" +enum Pairable { + NO = 0, + YES = 1, + ONCE = 2, +}; + class BLELocalDevice { public: BLELocalDevice(); @@ -80,6 +86,10 @@ class BLELocalDevice { virtual void debug(Stream& stream); virtual void noDebug(); + + virtual void setPairable(uint8_t pairable); + virtual bool pairable(); + virtual bool paired(); /// TODO: Put in actual variable names virtual void setStoreIRK(int (*storeIRK)(uint8_t*, uint8_t*)); diff --git a/src/utility/ATT.cpp b/src/utility/ATT.cpp index 18556413..a5166217 100644 --- a/src/utility/ATT.cpp +++ b/src/utility/ATT.cpp @@ -497,6 +497,32 @@ bool ATTClass::connected(uint16_t handle) const return false; } +/* + * Return true if any of the known devices is paired (peer encrypted) + * Does not check if the paired device is also connected + */ +bool ATTClass::paired() const +{ + for(int i=0; i 0){ + return true; + } + } + return false; +} + +/* + * Return true if the specified device is paired (peer encrypted) + */ +bool ATTClass::paired(uint16_t handle) const +{ + for(int i=0; i 0; + } + return false; // unknown handle +} + uint16_t ATTClass::mtu(uint16_t handle) const { for (int i = 0; i < ATT_MAX_PEERS; i++) { diff --git a/src/utility/ATT.h b/src/utility/ATT.h index 1c8910c3..c9f007f9 100644 --- a/src/utility/ATT.h +++ b/src/utility/ATT.h @@ -75,6 +75,8 @@ class ATTClass { virtual bool connected() const; virtual bool connected(uint8_t addressType, const uint8_t address[6]) const; virtual bool connected(uint16_t handle) const; + virtual bool paired() const; + virtual bool paired(uint16_t handle) const; virtual uint16_t mtu(uint16_t handle) const; virtual bool disconnect(); diff --git a/src/utility/L2CAPSignaling.cpp b/src/utility/L2CAPSignaling.cpp index 4adeaa0d..622f2178 100644 --- a/src/utility/L2CAPSignaling.cpp +++ b/src/utility/L2CAPSignaling.cpp @@ -32,6 +32,7 @@ L2CAPSignalingClass::L2CAPSignalingClass() : _minInterval(0), _maxInterval(0), _supervisionTimeout(0) + ,_pairing_enabled(1) { } @@ -131,53 +132,64 @@ void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t btct.printBytes(data,dlen); #endif if (code == CONNECTION_PAIRING_REQUEST) { - // 0x1 - struct __attribute__ ((packed)) PairingRequest { - uint8_t ioCapability; - uint8_t oobDataFlag; - uint8_t authReq; - uint8_t maxEncSize; - uint8_t initiatorKeyDistribution; - uint8_t responderKeyDistribution; - } *pairingRequest = (PairingRequest*)l2capSignalingHdr->data; - - - ATT.remoteKeyDistribution = KeyDistribution(pairingRequest->initiatorKeyDistribution); - ATT.localKeyDistribution = KeyDistribution(pairingRequest->responderKeyDistribution); - KeyDistribution rkd(pairingRequest->responderKeyDistribution); - AuthReq req(pairingRequest->authReq); - KeyDistribution responseKD = KeyDistribution(); - responseKD.setIdKey(true); + + if (isPairingEnabled()){ + if (_pairing_enabled >= 2) _pairing_enabled = 0; // 2 = pair once only + + // 0x1 + struct __attribute__ ((packed)) PairingRequest { + uint8_t ioCapability; + uint8_t oobDataFlag; + uint8_t authReq; + uint8_t maxEncSize; + uint8_t initiatorKeyDistribution; + uint8_t responderKeyDistribution; + } *pairingRequest = (PairingRequest*)l2capSignalingHdr->data; + + + ATT.remoteKeyDistribution = KeyDistribution(pairingRequest->initiatorKeyDistribution); + ATT.localKeyDistribution = KeyDistribution(pairingRequest->responderKeyDistribution); + KeyDistribution rkd(pairingRequest->responderKeyDistribution); + AuthReq req(pairingRequest->authReq); + KeyDistribution responseKD = KeyDistribution(); + responseKD.setIdKey(true); #ifdef _BLE_TRACE_ - Serial.print("Req has properties: "); - Serial.print(req.Bonding()?"bonding, ":"no bonding, "); - Serial.print(req.CT2()?"CT2, ":"no CT2, "); - Serial.print(req.KeyPress()?"KeyPress, ":"no KeyPress, "); - Serial.print(req.MITM()?"MITM, ":"no MITM, "); - Serial.print(req.SC()?"SC, ":"no SC, "); + Serial.print("Req has properties: "); + Serial.print(req.Bonding()?"bonding, ":"no bonding, "); + Serial.print(req.CT2()?"CT2, ":"no CT2, "); + Serial.print(req.KeyPress()?"KeyPress, ":"no KeyPress, "); + Serial.print(req.MITM()?"MITM, ":"no MITM, "); + Serial.print(req.SC()?"SC, ":"no SC, "); #endif - uint8_t peerIOCap[3]; - peerIOCap[0] = pairingRequest->authReq; - peerIOCap[1] = pairingRequest->oobDataFlag; - peerIOCap[2] = pairingRequest->ioCapability; - ATT.setPeerIOCap(connectionHandle, peerIOCap); - ATT.setPeerEncryption(connectionHandle, ATT.getPeerEncryption(connectionHandle) | PEER_ENCRYPTION::PAIRING_REQUEST); + uint8_t peerIOCap[3]; + peerIOCap[0] = pairingRequest->authReq; + peerIOCap[1] = pairingRequest->oobDataFlag; + peerIOCap[2] = pairingRequest->ioCapability; + ATT.setPeerIOCap(connectionHandle, peerIOCap); + ATT.setPeerEncryption(connectionHandle, ATT.getPeerEncryption(connectionHandle) | PEER_ENCRYPTION::PAIRING_REQUEST); #ifdef _BLE_TRACE_ - Serial.print("Peer encryption : 0b"); - Serial.println(ATT.getPeerEncryption(connectionHandle), BIN); + Serial.print("Peer encryption : 0b"); + Serial.println(ATT.getPeerEncryption(connectionHandle), BIN); #endif - struct __attribute__ ((packed)) PairingResponse { - uint8_t code; - uint8_t ioCapability; - uint8_t oobDataFlag; - uint8_t authReq; - uint8_t maxEncSize; - uint8_t initiatorKeyDistribution; - uint8_t responderKeyDistribution; - } response = { CONNECTION_PAIRING_RESPONSE, LOCAL_IOCAP, 0, LOCAL_AUTHREQ, 0x10, responseKD.getOctet(), responseKD.getOctet()}; - - HCI.sendAclPkt(connectionHandle, SECURITY_CID, sizeof(response), &response); + struct __attribute__ ((packed)) PairingResponse { + uint8_t code; + uint8_t ioCapability; + uint8_t oobDataFlag; + uint8_t authReq; + uint8_t maxEncSize; + uint8_t initiatorKeyDistribution; + uint8_t responderKeyDistribution; + } response = { CONNECTION_PAIRING_RESPONSE, LOCAL_IOCAP, 0, LOCAL_AUTHREQ, 0x10, responseKD.getOctet(), responseKD.getOctet()}; + + HCI.sendAclPkt(connectionHandle, SECURITY_CID, sizeof(response), &response); + + } else { + // Pairing not enabled + uint8_t ret[2] = {CONNECTION_PAIRING_FAILED, 0x05}; // reqect pairing + HCI.sendAclPkt(connectionHandle, SECURITY_CID, sizeof(ret), ret); + ATT.setPeerEncryption(connectionHandle, NO_ENCRYPTION); + } } else if (code == CONNECTION_PAIRING_RANDOM) { @@ -392,6 +404,15 @@ void L2CAPSignalingClass::setSupervisionTimeout(uint16_t supervisionTimeout) _supervisionTimeout = supervisionTimeout; } +void L2CAPSignalingClass::setPairingEnabled(uint8_t enabled) +{ + _pairing_enabled = enabled; +} +bool L2CAPSignalingClass::isPairingEnabled() +{ + return _pairing_enabled > 0; +} + void L2CAPSignalingClass::connectionParameterUpdateRequest(uint16_t handle, uint8_t identifier, uint8_t dlen, uint8_t data[]) { struct __attribute__ ((packed)) L2CAPConnectionParameterUpdateRequest { diff --git a/src/utility/L2CAPSignaling.h b/src/utility/L2CAPSignaling.h index 7fc64d4f..f8a361ee 100644 --- a/src/utility/L2CAPSignaling.h +++ b/src/utility/L2CAPSignaling.h @@ -41,8 +41,15 @@ #define CONNECTION_PAIRING_DHKEY_CHECK 0x0D #define CONNECTION_PAIRING_KEYPRESS 0x0E +#define IOCAP_DISPLAY_ONLY 0x00 +#define IOCAP_DISPLAY_YES_NO 0x01 +#define IOCAP_KEYBOARD_ONLY 0x02 +#define IOCAP_NO_INPUT_NO_OUTPUT 0x03 +#define IOCAP_KEYBOARD_DISPLAY 0x04 + + #define LOCAL_AUTHREQ 0b00101101 -#define LOCAL_IOCAP 0x3 +#define LOCAL_IOCAP IOCAP_NO_INPUT_NO_OUTPUT // will use JustWorks pairing class L2CAPSignalingClass { public: @@ -63,6 +70,9 @@ class L2CAPSignalingClass { virtual void setConnectionInterval(uint16_t minInterval, uint16_t maxInterval); virtual void setSupervisionTimeout(uint16_t supervisionTimeout); + + virtual void setPairingEnabled(uint8_t enabled); + virtual bool isPairingEnabled(); @@ -78,6 +88,7 @@ class L2CAPSignalingClass { uint16_t _minInterval; uint16_t _maxInterval; uint16_t _supervisionTimeout; + uint8_t _pairing_enabled; }; extern L2CAPSignalingClass& L2CAPSignaling; From d9fb4bcfbf394d98aac93b9b3d4b087552cf4a22 Mon Sep 17 00:00:00 2001 From: unknownconstant Date: Mon, 4 Jan 2021 19:04:01 +0000 Subject: [PATCH 11/83] Secure random & reject unknown LTK --- src/local/BLELocalDevice.h | 18 +++-- src/utility/HCI.cpp | 132 +++++++++++++++++++++++---------- src/utility/HCI.h | 30 +++++--- src/utility/L2CAPSignaling.cpp | 18 +++-- 4 files changed, 137 insertions(+), 61 deletions(-) diff --git a/src/local/BLELocalDevice.h b/src/local/BLELocalDevice.h index 22a5f589..d06664da 100644 --- a/src/local/BLELocalDevice.h +++ b/src/local/BLELocalDevice.h @@ -81,11 +81,19 @@ class BLELocalDevice { virtual void debug(Stream& stream); virtual void noDebug(); -/// TODO: Put in actual variable names - virtual void setStoreIRK(int (*storeIRK)(uint8_t*, uint8_t*)); - virtual void setGetIRKs(int (*getIRKs)(uint8_t* nIRKs, uint8_t** BADDR_type, uint8_t*** BADDRs, uint8_t*** IRKs)); - virtual void setStoreLTK(int (*storeLTK)(uint8_t*, uint8_t*)); - virtual void setGetLTK(int (*getLTK)(uint8_t*, uint8_t*)); + // address - The mac to store + // IRK - The IRK to store with this mac + virtual void setStoreIRK(int (*storeIRK)(uint8_t* address, uint8_t* IRK)); + // nIRKs - the number of IRKs being provided. + // BDAddrType - an array containing the type of each address (0 public, 1 static random) + // BDAddrs - an array containing the list of addresses + virtual void setGetIRKs(int (*getIRKs)(uint8_t* nIRKs, uint8_t** BDAddrType, uint8_t*** BDAddrs, uint8_t*** IRKs)); + // address - the address to store [6 bytes] + // LTK - the LTK to store with this mac [16 bytes] + virtual void setStoreLTK(int (*storeLTK)(uint8_t* address, uint8_t* LTK)); + // address - The mac address needing its LTK + // LTK - 16 octet LTK for the mac address + virtual void setGetLTK(int (*getLTK)(uint8_t* address, uint8_t* LTK)); uint8_t BDaddress[6]; protected: diff --git a/src/utility/HCI.cpp b/src/utility/HCI.cpp index 4dc78460..1a604d79 100644 --- a/src/utility/HCI.cpp +++ b/src/utility/HCI.cpp @@ -23,6 +23,8 @@ #include "L2CAPSignaling.h" #include "btct.h" #include "HCI.h" +#include "bitDescriptions.h" +// #define _BLE_TRACE_ #define HCI_COMMAND_PKT 0x01 #define HCI_ACLDATA_PKT 0x02 @@ -1139,50 +1141,63 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) // Load our LTK for this connection. uint8_t peerAddr[7]; uint8_t resolvableAddr[6]; + uint8_t foundLTK; ATT.getPeerAddrWithType(ltkRequest->connectionHandle, peerAddr); - if(ATT.getPeerResolvedAddress(ltkRequest->connectionHandle, resolvableAddr) - && !((ATT.getPeerEncryption(ltkRequest->connectionHandle) & PEER_ENCRYPTION::PAIRING_REQUEST)>0)){ - _getLTK(resolvableAddr, HCI.LTK); + if((ATT.getPeerEncryption(ltkRequest->connectionHandle) & PEER_ENCRYPTION::PAIRING_REQUEST)>0){ + // Pairing request - LTK is one in buffer already + foundLTK = 1; }else{ - _getLTK(&peerAddr[1], HCI.LTK); + if(ATT.getPeerResolvedAddress(ltkRequest->connectionHandle, resolvableAddr)){ + foundLTK = getLTK(resolvableAddr, HCI.LTK); + }else{ + foundLTK = getLTK(&peerAddr[1], HCI.LTK); + } } - // } + // } //2d // Send our LTK back - struct __attribute__ ((packed)) LTKReply - { - uint16_t connectionHandle; - uint8_t LTK[16]; - } ltkReply = {0,0}; - ltkReply.connectionHandle = ltkRequest->connectionHandle; - for(int i=0; i<16; i++) ltkReply.LTK[15-i] = HCI.LTK[i]; - int result = sendCommand(OGF_LE_CTL << 10 | LE_COMMAND::LONG_TERM_KEY_REPLY,sizeof(ltkReply), <kReply); - -#ifdef _BLE_TRACE_ - Serial.println("Sending LTK as: "); - btct.printBytes(ltkReply.LTK,16); -#endif - - if(result == 0){ - struct __attribute__ ((packed)) LTKReplyResult + if(foundLTK){ + struct __attribute__ ((packed)) LTKReply { - uint8_t status; uint16_t connectionHandle; - } ltkReplyResult = {0,0}; - memcpy(<kReplyResult, _cmdResponse, 3); - -#ifdef _BLE_TRACE_ - Serial.println("LTK send success"); - Serial.print("status : "); - btct.printBytes(<kReplyResult.status,1); - Serial.print("Conn Handle: "); - btct.printBytes((uint8_t*)<kReplyResult.connectionHandle,2); -#endif + uint8_t LTK[16]; + } ltkReply = {0,0}; + ltkReply.connectionHandle = ltkRequest->connectionHandle; + for(int i=0; i<16; i++) ltkReply.LTK[15-i] = HCI.LTK[i]; + int result = sendCommand(OGF_LE_CTL << 10 | LE_COMMAND::LONG_TERM_KEY_REPLY,sizeof(ltkReply), <kReply); + + #ifdef _BLE_TRACE_ + Serial.println("Sending LTK as: "); + btct.printBytes(ltkReply.LTK,16); + #endif + + if(result == 0){ + struct __attribute__ ((packed)) LTKReplyResult + { + uint8_t status; + uint16_t connectionHandle; + } ltkReplyResult = {0,0}; + memcpy(<kReplyResult, _cmdResponse, 3); + + #ifdef _BLE_TRACE_ + Serial.println("LTK send success"); + Serial.print("status : "); + btct.printBytes(<kReplyResult.status,1); + Serial.print("Conn Handle: "); + btct.printBytes((uint8_t*)<kReplyResult.connectionHandle,2); + #endif + }else{ + #ifdef _BLE_TRACE_ + Serial.print("Failed to send LTK...: "); + btct.printBytes((uint8_t*)&result,2); + #endif + } }else{ + /// do LTK rejection #ifdef _BLE_TRACE_ - Serial.print("Failed to send LTK...: "); - btct.printBytes((uint8_t*)&result,2); + Serial.println("LTK not found, rejecting"); #endif + sendCommand(OGF_LE_CTL << 10 | LE_COMMAND::LONG_TERM_KEY_NEGATIVE_REPLY,2, <kRequest->connectionHandle); } break; } @@ -1256,10 +1271,10 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) uint8_t Z = 0; - for(int i=0; i<16; i++){ - /// TODO: Implement secure random - Nb[i] = rand(); //// Should use ESP or ECCx08 - } + + HCI.leRand(Nb); + HCI.leRand(&Nb[8]); + #ifdef _BLE_TRACE_ Serial.print("nb: "); btct.printBytes(Nb, 16); @@ -1405,6 +1420,47 @@ int HCIClass::leEncrypt(uint8_t* key, uint8_t* plaintext, uint8_t* status, uint8 #endif return res; } +int HCIClass::leRand(uint8_t rand[]){ + int res = sendCommand(OGF_LE_CTL << 10 | LE_COMMAND::RANDOM); + if(res == 0){ + memcpy(rand,_cmdResponse, 8); /// backwards but it's a random number + } + return res; +} +int HCIClass::getLTK(uint8_t* address, uint8_t* LTK){ + if(_getLTK!=0){ + return _getLTK(address, LTK); + }else{ + return 0; + } +} +int HCIClass::storeIRK(uint8_t* address, uint8_t* IRK){ + if(_storeIRK!=0){ + return _storeIRK(address, IRK); + }else{ + return 0; + } +} +int HCIClass::storeLTK(uint8_t* address, uint8_t* LTK){ + if(_storeLTK!=0){ + return _storeLTK(address, LTK); + }else{ + return 0; + } +} + +/// Stub function to generate parameters for local authreq +AuthReq HCIClass::localAuthreq(){ + // If get, set, IRK, LTK all set then we can bond. + AuthReq local = AuthReq(); + if(_storeIRK!=0 && _storeLTK!=0 && _getLTK!=0 && _getIRKs!=0){ + local.setBonding(true); + } + local.setSC(true); + local.setMITM(true); + local.setCT2(true); + return LOCAL_AUTHREQ; +} void HCIClass::dumpPkt(const char* prefix, uint8_t plen, uint8_t pdata[]) { diff --git a/src/utility/HCI.h b/src/utility/HCI.h index de15bdf8..b8671303 100644 --- a/src/utility/HCI.h +++ b/src/utility/HCI.h @@ -21,6 +21,7 @@ #define _HCI_H_ #include +#include "bitDescriptions.h" #define OGF_LINK_CTL 0x01 #define OGF_HOST_CTL 0x03 @@ -29,11 +30,13 @@ #define OGF_LE_CTL 0x08 enum LE_COMMAND { - ENCRYPT = 0x0017, - LONG_TERM_KEY_REPLY = 0x001A, - READ_LOCAL_P256 = 0x0025, - GENERATE_DH_KEY_V1 = 0x0026, - GENERATE_DH_KEY_V2 = 0x005E + ENCRYPT = 0x0017, + RANDOM = 0x0018, + LONG_TERM_KEY_REPLY = 0x001A, + LONG_TERM_KEY_NEGATIVE_REPLY = 0x1B, + READ_LOCAL_P256 = 0x0025, + GENERATE_DH_KEY_V1 = 0x0026, + GENERATE_DH_KEY_V2 = 0x005E }; enum LE_META_EVENT { CONN_COMPLETE = 0x01, @@ -89,6 +92,9 @@ class HCIClass { uint16_t latency, uint16_t supervisionTimeout); virtual int leCancelConn(); virtual int leEncrypt(uint8_t* Key, uint8_t* plaintext, uint8_t* status, uint8_t* ciphertext); + // Generate a 64 bit random number + virtual int leRand(uint8_t rand[]); + virtual AuthReq localAuthreq(); virtual int saveNewAddress(uint8_t addressType, uint8_t* address, uint8_t* peerIrk, uint8_t* remoteIrk); virtual int leAddResolvingAddress(uint8_t addressType, uint8_t* address, uint8_t* peerIrk, uint8_t* remoteIrk); @@ -108,7 +114,7 @@ class HCIClass { virtual void debug(Stream& stream); virtual void noDebug(); - // TODO: Send command be private again & use ATT implementation within ATT. + // TODO: Send command be private again & use ATT implementation of send command within ATT. virtual int sendCommand(uint16_t opcode, uint8_t plen = 0, void* parameters = NULL); uint8_t remotePublicKeyBuffer[64]; uint8_t Na[16]; @@ -116,11 +122,13 @@ class HCIClass { uint8_t DHKey[32]; uint8_t localAddr[6]; uint8_t LTK[16]; - - int (*_storeIRK)(uint8_t* address, uint8_t* peerIrk); - int (*_getIRKs)(uint8_t* nIRKs,uint8_t** BADDR_type, uint8_t*** BADDRs, uint8_t*** IRKs); - int (*_storeLTK)(uint8_t*, uint8_t*); - int (*_getLTK)(uint8_t*, uint8_t*); + virtual int getLTK(uint8_t* address, uint8_t* LTK); + virtual int storeLTK(uint8_t* address, uint8_t* LTK); + virtual int storeIRK(uint8_t* address, uint8_t* IRK); + int (*_storeIRK)(uint8_t* address, uint8_t* peerIrk) = 0; + int (*_getIRKs)(uint8_t* nIRKs,uint8_t** BADDR_type, uint8_t*** BADDRs, uint8_t*** IRKs) = 0; + int (*_storeLTK)(uint8_t*, uint8_t*) = 0; + int (*_getLTK)(uint8_t*, uint8_t*) = 0; private: diff --git a/src/utility/L2CAPSignaling.cpp b/src/utility/L2CAPSignaling.cpp index f7f93b84..9d9efd81 100644 --- a/src/utility/L2CAPSignaling.cpp +++ b/src/utility/L2CAPSignaling.cpp @@ -26,6 +26,9 @@ #define CONNECTION_PARAMETER_UPDATE_REQUEST 0x12 #define CONNECTION_PARAMETER_UPDATE_RESPONSE 0x13 + +// #define _BLE_TRACE_ + L2CAPSignalingClass::L2CAPSignalingClass() : _minInterval(0), _maxInterval(0), @@ -139,13 +142,14 @@ void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t uint8_t responderKeyDistribution; } *pairingRequest = (PairingRequest*)l2capSignalingHdr->data; - - ATT.remoteKeyDistribution = KeyDistribution(pairingRequest->initiatorKeyDistribution); - ATT.localKeyDistribution = KeyDistribution(pairingRequest->responderKeyDistribution); - KeyDistribution rkd(pairingRequest->responderKeyDistribution); - AuthReq req(pairingRequest->authReq); KeyDistribution responseKD = KeyDistribution(); responseKD.setIdKey(true); + + ATT.remoteKeyDistribution = responseKD;// KeyDistribution(pairingRequest->initiatorKeyDistribution); + ATT.localKeyDistribution = responseKD; //KeyDistribution(pairingRequest->responderKeyDistribution); + // KeyDistribution rkd(pairingRequest->responderKeyDistribution); + AuthReq req(pairingRequest->authReq); + #ifdef _BLE_TRACE_ Serial.print("Req has properties: "); Serial.print(req.Bonding()?"bonding, ":"no bonding, "); @@ -173,7 +177,7 @@ void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t uint8_t maxEncSize; uint8_t initiatorKeyDistribution; uint8_t responderKeyDistribution; - } response = { CONNECTION_PAIRING_RESPONSE, LOCAL_IOCAP, 0, LOCAL_AUTHREQ, 0x10, responseKD.getOctet(), responseKD.getOctet()}; + } response = { CONNECTION_PAIRING_RESPONSE, LOCAL_IOCAP, 0, HCI.localAuthreq().getOctet(), 0x10, responseKD.getOctet(), responseKD.getOctet()}; HCI.sendAclPkt(connectionHandle, SECURITY_CID, sizeof(response), &response); } @@ -305,7 +309,7 @@ void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t uint8_t Eb[16]; uint8_t R[16]; uint8_t MasterIOCap[3]; - uint8_t SlaveIOCap[3] = {LOCAL_AUTHREQ, 0x0, LOCAL_IOCAP}; + uint8_t SlaveIOCap[3] = {HCI.localAuthreq().getOctet(), 0x0, LOCAL_IOCAP}; ATT.getPeerIOCap(connectionHandle, MasterIOCap); for(int i=0; i<16; i++) R[i] = 0; From e2868a7108fec2bd6349c48ee556e5fe446daad0 Mon Sep 17 00:00:00 2001 From: unknownconstant Date: Thu, 7 Jan 2021 10:43:23 +0000 Subject: [PATCH 12/83] Pairing code & binary confirm callbacks --- src/local/BLELocalDevice.cpp | 6 ++++ src/local/BLELocalDevice.h | 3 ++ src/utility/ATT.cpp | 2 ++ src/utility/HCI.cpp | 15 +++++++++- src/utility/HCI.h | 4 +++ src/utility/L2CAPSignaling.cpp | 54 ++++++++++++++++++++++++++++++++-- src/utility/L2CAPSignaling.h | 2 +- src/utility/btct.cpp | 36 +++++++++++++++++++++++ src/utility/btct.h | 2 ++ 9 files changed, 120 insertions(+), 4 deletions(-) diff --git a/src/local/BLELocalDevice.cpp b/src/local/BLELocalDevice.cpp index 029fb488..d83c1cb3 100644 --- a/src/local/BLELocalDevice.cpp +++ b/src/local/BLELocalDevice.cpp @@ -434,6 +434,12 @@ void BLELocalDevice::setStoreLTK(int (*storeLTK)(uint8_t*, uint8_t*)){ void BLELocalDevice::setStoreIRK(int (*storeIRK)(uint8_t*, uint8_t*)){ HCI._storeIRK = storeIRK; } +void BLELocalDevice::setDisplayCode(void (*displayCode)(uint32_t confirmationCode)){ + HCI._displayCode = displayCode; +} +void BLELocalDevice::setBinaryConfirmPairing(bool (*binaryConfirmPairing)()){ + HCI._binaryConfirmPairing = binaryConfirmPairing; +} void BLELocalDevice::debug(Stream& stream) { diff --git a/src/local/BLELocalDevice.h b/src/local/BLELocalDevice.h index 75e7dc31..6c45c063 100644 --- a/src/local/BLELocalDevice.h +++ b/src/local/BLELocalDevice.h @@ -104,6 +104,9 @@ class BLELocalDevice { // address - The mac address needing its LTK // LTK - 16 octet LTK for the mac address virtual void setGetLTK(int (*getLTK)(uint8_t* address, uint8_t* LTK)); + + virtual void setDisplayCode(void (*displayCode)(uint32_t confirmationCode)); + virtual void setBinaryConfirmPairing(bool (*binaryConfirmPairing)()); uint8_t BDaddress[6]; protected: diff --git a/src/utility/ATT.cpp b/src/utility/ATT.cpp index a5166217..91ffeed0 100644 --- a/src/utility/ATT.cpp +++ b/src/utility/ATT.cpp @@ -81,6 +81,8 @@ #define ATT_ECODE_UNSUPP_GRP_TYPE 0x10 #define ATT_ECODE_INSUFF_RESOURCES 0x11 +// #define _BLE_TRACE_ + ATTClass::ATTClass() : _maxMtu(23), _timeout(5000), diff --git a/src/utility/HCI.cpp b/src/utility/HCI.cpp index 9bcec4e1..82303ed3 100644 --- a/src/utility/HCI.cpp +++ b/src/utility/HCI.cpp @@ -26,7 +26,6 @@ #include "bitDescriptions.h" // #define _BLE_TRACE_ -//#define _BLE_TRACE_ #define HCI_COMMAND_PKT 0x01 #define HCI_ACLDATA_PKT 0x02 @@ -1258,6 +1257,7 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) uint8_t publicKey[64]; } pairingPublicKey = {CONNECTION_PAIRING_PUBLIC_KEY,0}; memcpy(pairingPublicKey.publicKey,evtReadLocalP256Complete->localPublicKey,64); + memcpy(localPublicKeyBuffer, evtReadLocalP256Complete->localPublicKey,64); // Send the local public key to the remote uint16_t connectionHandle = ATT.getPeerEncrptingConnectionHandle(); @@ -1456,6 +1456,19 @@ int HCIClass::storeLTK(uint8_t* address, uint8_t* LTK){ return 0; } } +uint8_t HCIClass::localIOCap(){ + if(_displayCode!=0){ + /// We have a display + if(_binaryConfirmPairing!=0){ + return IOCAP_DISPLAY_YES_NO; + }else{ + return IOCAP_DISPLAY_ONLY; + } + }else{ + // We have no display + return IOCAP_NO_INPUT_NO_OUTPUT; + } +} /// Stub function to generate parameters for local authreq AuthReq HCIClass::localAuthreq(){ diff --git a/src/utility/HCI.h b/src/utility/HCI.h index f2bc535e..af46265a 100644 --- a/src/utility/HCI.h +++ b/src/utility/HCI.h @@ -97,6 +97,7 @@ class HCIClass { // Generate a 64 bit random number virtual int leRand(uint8_t rand[]); virtual AuthReq localAuthreq(); + virtual uint8_t localIOCap(); virtual int saveNewAddress(uint8_t addressType, uint8_t* address, uint8_t* peerIrk, uint8_t* remoteIrk); virtual int leAddResolvingAddress(uint8_t addressType, uint8_t* address, uint8_t* peerIrk, uint8_t* remoteIrk); @@ -119,6 +120,7 @@ class HCIClass { // TODO: Send command be private again & use ATT implementation of send command within ATT. virtual int sendCommand(uint16_t opcode, uint8_t plen = 0, void* parameters = NULL); uint8_t remotePublicKeyBuffer[64]; + uint8_t localPublicKeyBuffer[64]; uint8_t remoteDHKeyCheckBuffer[16]; uint8_t Na[16]; uint8_t Nb[16]; @@ -132,6 +134,8 @@ class HCIClass { int (*_getIRKs)(uint8_t* nIRKs,uint8_t** BADDR_type, uint8_t*** BADDRs, uint8_t*** IRKs) = 0; int (*_storeLTK)(uint8_t*, uint8_t*) = 0; int (*_getLTK)(uint8_t*, uint8_t*) = 0; + void (*_displayCode)(uint32_t confirmationCode) = 0; + bool (*_binaryConfirmPairing)() = 0; private: diff --git a/src/utility/L2CAPSignaling.cpp b/src/utility/L2CAPSignaling.cpp index f7712051..2ef08b62 100644 --- a/src/utility/L2CAPSignaling.cpp +++ b/src/utility/L2CAPSignaling.cpp @@ -180,7 +180,7 @@ void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t uint8_t maxEncSize; uint8_t initiatorKeyDistribution; uint8_t responderKeyDistribution; - } response = { CONNECTION_PAIRING_RESPONSE, LOCAL_IOCAP, 0, HCI.localAuthreq().getOctet(), 0x10, responseKD.getOctet(), responseKD.getOctet()}; + } response = { CONNECTION_PAIRING_RESPONSE, HCI.localIOCap(), 0, HCI.localAuthreq().getOctet(), 0x10, responseKD.getOctet(), responseKD.getOctet()}; HCI.sendAclPkt(connectionHandle, SECURITY_CID, sizeof(response), &response); @@ -209,6 +209,55 @@ void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t for(int i=0; i< 16; i++) response.Nb[15-i] = HCI.Nb[i]; HCI.sendAclPkt(connectionHandle, SECURITY_CID, sizeof(response), &response); + + // We now have all needed for compare value + uint8_t g2Result[4]; + uint8_t U[32]; + uint8_t V[32]; + + for(int i=0; i<32; i++){ + U[31-i] = HCI.remotePublicKeyBuffer[i]; + V[31-i] = HCI.localPublicKeyBuffer[i]; + } + + btct.g2(U,V,HCI.Na,HCI.Nb, g2Result); + uint32_t result = 0; + for(int i=0; i<4; i++) result += g2Result[3-i] << 8*i; + +#ifdef _BLE_TRACE_ + Serial.print("U : "); + btct.printBytes(U,32); + Serial.print("V : "); + btct.printBytes(V,32); + Serial.print("X : "); + btct.printBytes(X,16); + Serial.print("Y : "); + btct.printBytes(Y,16); + Serial.print("g2res : "); + btct.printBytes(g2Result,4); + Serial.print("Result : "); + Serial.println(result); +#endif + + if(HCI._displayCode!=0){ + HCI._displayCode(result%1000000); + } + if(HCI._binaryConfirmPairing!=0){ + if(!HCI._binaryConfirmPairing()){ +#ifdef _BLE_TRACE_ + Serial.println("User rejection"); +#endif + uint8_t rejection[2]; + rejection[0] = CONNECTION_PAIRING_FAILED; + rejection[1] = 0x0C; // Numeric comparison failed + HCI.sendAclPkt(connectionHandle, SECURITY_CID, 2, rejection); + ATT.setPeerEncryption(connectionHandle, PEER_ENCRYPTION::NO_ENCRYPTION); + }else{ +#ifdef _BLE_TRACE_ + Serial.println("User did confirm"); +#endif + } + } } else if (code == CONNECTION_PAIRING_RESPONSE) { @@ -224,6 +273,7 @@ void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t Serial.print("Pairing failed with code: 0x"); Serial.println(pairingFailed->reason,HEX); #endif + ATT.setPeerEncryption(connectionHandle, PEER_ENCRYPTION::NO_ENCRYPTION); } else if (code == CONNECTION_IDENTITY_INFORMATION){ struct __attribute__ ((packed)) IdentityInformation { @@ -338,7 +388,7 @@ void L2CAPSignalingClass::smCalculateLTKandConfirm(uint16_t handle, uint8_t expe uint8_t Eb[16]; uint8_t R[16]; uint8_t MasterIOCap[3]; - uint8_t SlaveIOCap[3] = {HCI.localAuthreq().getOctet(), 0x0, LOCAL_IOCAP}; + uint8_t SlaveIOCap[3] = {HCI.localAuthreq().getOctet(), 0x0, HCI.localIOCap()}; ATT.getPeerIOCap(handle, MasterIOCap); for(int i=0; i<16; i++) R[i] = 0; diff --git a/src/utility/L2CAPSignaling.h b/src/utility/L2CAPSignaling.h index f8a361ee..26042167 100644 --- a/src/utility/L2CAPSignaling.h +++ b/src/utility/L2CAPSignaling.h @@ -49,7 +49,7 @@ #define LOCAL_AUTHREQ 0b00101101 -#define LOCAL_IOCAP IOCAP_NO_INPUT_NO_OUTPUT // will use JustWorks pairing +// #define LOCAL_IOCAP IOCAP_DISPLAY_ONLY // will use JustWorks pairing class L2CAPSignalingClass { public: diff --git a/src/utility/btct.cpp b/src/utility/btct.cpp index d78e328e..b4faf053 100644 --- a/src/utility/btct.cpp +++ b/src/utility/btct.cpp @@ -150,6 +150,42 @@ void BluetoothCryptoToolbox::testAh() printBytes(ourResult, 3); } +int BluetoothCryptoToolbox::g2(uint8_t U[], uint8_t V[], uint8_t X[], uint8_t Y[], uint8_t out[4]) +{ + struct __attribute__ ((packed)) CmacInput { + uint8_t U[32]; + uint8_t V[32]; + uint8_t Y[16]; + } cmacInput= {0,0,0}; + memcpy(cmacInput.U,U,32); + memcpy(cmacInput.V,V,32); + memcpy(cmacInput.Y,Y,16); + uint8_t intermediate[16]; + AES_CMAC(X,(uint8_t*)&cmacInput,sizeof(CmacInput),intermediate); + memcpy(out,&intermediate[12],4); + return 1; +} +void BluetoothCryptoToolbox::testg2(){ + uint8_t U[32] = {0x20,0xb0,0x03,0xd2,0xf2,0x97,0xbe,0x2c,0x5e,0x2c,0x83,0xa7,0xe9,0xf9,0xa5,0xb9,0xef,0xf4,0x91,0x11,0xac,0xf4,0xfd,0xdb,0xcc,0x03,0x01,0x48,0x0e,0x35,0x9d,0xe6}; + uint8_t V[32] = {0x55,0x18,0x8b,0x3d,0x32,0xf6,0xbb,0x9a,0x90,0x0a,0xfc,0xfb,0xee,0xd4,0xe7,0x2a,0x59,0xcb,0x9a,0xc2,0xf1,0x9d,0x7c,0xfb,0x6b,0x4f,0xdd,0x49,0xf4,0x7f,0xc5,0xfd}; + uint8_t X[16] = {0xd5,0xcb,0x84,0x54,0xd1,0x77,0x73,0x3e,0xff,0xff,0xb2,0xec,0x71,0x2b,0xae,0xab}; + uint8_t Y[16] = {0xa6,0xe8,0xe7,0xcc,0x25,0xa7,0x5f,0x6e,0x21,0x65,0x83,0xf7,0xff,0x3d,0xc4,0xcf}; + uint8_t AES[16] = {0x15,0x36,0xd1,0x8d,0xe3,0xd2,0x0d,0xf9,0x9b,0x70,0x44,0xc1,0x2f,0x9e,0xd5,0xba}; + uint8_t out[4]; + + + uint32_t expected = 0; + g2(U,V,X,Y,out); + uint32_t result = 0; + for(int i=0; i<4; i++) result += out[i] << 8*i; + + Serial.print("Expected : "); + Serial.println(expected); + Serial.print("Result : "); + Serial.println(result); + Serial.println(); + +} void BluetoothCryptoToolbox::AES_CMAC ( unsigned char *key, unsigned char *input, int length, unsigned char *mac ) diff --git a/src/utility/btct.h b/src/utility/btct.h index 43c0b0d6..08f8f192 100644 --- a/src/utility/btct.h +++ b/src/utility/btct.h @@ -13,11 +13,13 @@ class BluetoothCryptoToolbox{ int f5(uint8_t DHKey[],uint8_t N_master[], uint8_t N_slave[], uint8_t BD_ADDR_master[], uint8_t BD_ADDR_slave[], uint8_t MacKey[], uint8_t LTK[]); int f6(uint8_t W[], uint8_t N1[],uint8_t N2[],uint8_t R[], uint8_t IOCap[], uint8_t A1[], uint8_t A2[], uint8_t Ex[]); + int g2(uint8_t U[], uint8_t V[], uint8_t X[], uint8_t Y[], uint8_t out[4]); int ah(uint8_t k[16], uint8_t r[3], uint8_t result[3]); void test(); void testF5(); void testF6(); void testAh(); + void testg2(); private: int AES_128(uint8_t key[], uint8_t data_in[], uint8_t data_out[]); void leftshift_onebit(unsigned char *input,unsigned char *output); From 6b08d21480d00d2842f6641cf06d7aa48a7ec219 Mon Sep 17 00:00:00 2001 From: unknownconstant Date: Thu, 7 Jan 2021 10:48:26 +0000 Subject: [PATCH 13/83] Updated example sketch --- .../EncryptedBatteryMonitor.ino | 27 ++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino b/examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino index fd40f5ee..dd3afbf6 100644 --- a/examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino +++ b/examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino @@ -18,7 +18,7 @@ #include -#define PAIR_BUTTON D3 // button for pairing +#define PAIR_BUTTON 3 // button for pairing #define PAIR_LED 24 // LED used to signal pairing #define PAIR_LED_ON LOW // Blue LED on Nano BLE has inverted logic #define PAIR_INTERVAL 30000 // interval for pairing after button press in ms @@ -42,6 +42,7 @@ int oldBatteryLevel = 0; // last battery level reading from analog input unsigned long previousMillis = 0; // last time the battery level was checked, in ms unsigned long pairingStarted = 0; // pairing start time when button is pressed bool wasConnected = 0; +bool acceptOrReject = true; void setup() { Serial.begin(9600); // initialize serial communication @@ -53,6 +54,30 @@ void setup() { Serial.println("Serial connected"); + + // Callback function with confirmation code when new device is pairing. + BLE.setDisplayCode([](uint32_t confirmCode){ + Serial.println("New device pairing request."); + Serial.print("Confirm code matches pairing device: "); + char code[6]; + sprintf(code, "%06d", confirmCode); + Serial.println(code); + }); + + // Callback to allow accepting or rejecting pairing + BLE.setBinaryConfirmPairing([&acceptOrReject](){ + Serial.print("Should we confirm pairing? "); + delay(5000); + if(acceptOrReject){ + acceptOrReject = false; + Serial.println("yes"); + return true; + }else{ + acceptOrReject = true; + Serial.println("no"); + return false; + } + }); // IRKs are keys that identify the true owner of a random mac address. // Add IRKs of devices you are bonded with. From 3dd53d1ba67450a26a80ec6768667a662d157496 Mon Sep 17 00:00:00 2001 From: unknownconstant Date: Sun, 24 Jan 2021 10:03:17 +0000 Subject: [PATCH 14/83] Spellcheck fixes --- .../EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino | 2 +- src/local/BLELocalDevice.cpp | 2 +- src/utility/ATT.cpp | 2 +- src/utility/HCI.cpp | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino b/examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino index dd3afbf6..9f9d453b 100644 --- a/examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino +++ b/examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino @@ -116,7 +116,7 @@ void setup() { // The LTK is the secret key which is used to encrypt bluetooth traffic BLE.setGetLTK([](uint8_t* address, uint8_t* LTK){ // address is input - Serial.print("Recieved request for address: "); + Serial.print("Received request for address: "); btct.printBytes(address,6); // Set these to the MAC and LTK of your devices after bonding. diff --git a/src/local/BLELocalDevice.cpp b/src/local/BLELocalDevice.cpp index d83c1cb3..8c1758b0 100644 --- a/src/local/BLELocalDevice.cpp +++ b/src/local/BLELocalDevice.cpp @@ -123,7 +123,7 @@ int BLELocalDevice::begin() /// The HCI should allow automatic address resolution. - // // If we have callbacks to rememember bonded devices: + // // If we have callbacks to remember bonded devices: // if(HCI._getIRKs!=0){ // uint8_t nIRKs = 0; // uint8_t** BADDR_Type = new uint8_t*; diff --git a/src/utility/ATT.cpp b/src/utility/ATT.cpp index 91ffeed0..f6ab392f 100644 --- a/src/utility/ATT.cpp +++ b/src/utility/ATT.cpp @@ -602,7 +602,7 @@ bool ATTClass::handleNotify(uint16_t handle, const uint8_t* value, int length) memcpy(¬ification[notificationLength], value, length); notificationLength += length; - /// TODO: Set encyption requirement on notify. + /// TODO: Set encryption requirement on notify. HCI.sendAclPkt(_peers[i].connectionHandle, ATT_CID, notificationLength, notification); numNotifications++; diff --git a/src/utility/HCI.cpp b/src/utility/HCI.cpp index 82303ed3..96948b85 100644 --- a/src/utility/HCI.cpp +++ b/src/utility/HCI.cpp @@ -841,7 +841,7 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) if((ATT.getPeerEncryption(encryptionChange->connectionHandle)&PEER_ENCRYPTION::PAIRING_REQUEST)>0){ if(ATT.localKeyDistribution.EncKey()){ #ifdef _BLE_TRACE_ - Serial.println("Enc key set but sould be ignored"); + Serial.println("Enc key set but should be ignored"); #endif }else{ #ifdef _BLE_TRACE_ @@ -1364,7 +1364,7 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) if((encryption & PEER_ENCRYPTION::RECEIVED_DH_CHECK) > 0){ #ifdef _BLE_TRACE_ - Serial.println("Recieved DHKey check already so calculate f5, f6 now."); + Serial.println("Received DHKey check already so calculate f5, f6 now."); #endif L2CAPSignaling.smCalculateLTKandConfirm(connectionHandle, HCI.remoteDHKeyCheckBuffer); From 55d5bf2c0dea092b8efbec9b444432a68a86c4f3 Mon Sep 17 00:00:00 2001 From: Tim Lossen Date: Sat, 26 Dec 2020 22:05:11 +0100 Subject: [PATCH 15/83] add access to raw advertisement data --- src/BLEDevice.cpp | 11 +++++++++++ src/BLEDevice.h | 2 ++ 2 files changed, 13 insertions(+) diff --git a/src/BLEDevice.cpp b/src/BLEDevice.cpp index fa806104..4fb2562d 100644 --- a/src/BLEDevice.cpp +++ b/src/BLEDevice.cpp @@ -184,6 +184,17 @@ String BLEDevice::advertisedServiceUuid(int index) const return serviceUuid; } +int BLEDevice::advertisementData(uint8_t value[], int length) +{ + if (_eirDataLength > length) return 0; // Check that buffer size is sufficient + + if (_eirDataLength) { + memcpy(value, _eirData, _eirDataLength); + } + + return _eirDataLength; +} + int BLEDevice::rssi() { uint16_t handle = ATT.connectionHandle(_addressType, _address); diff --git a/src/BLEDevice.h b/src/BLEDevice.h index cbe79c71..508d46c1 100644 --- a/src/BLEDevice.h +++ b/src/BLEDevice.h @@ -59,6 +59,8 @@ class BLEDevice { String advertisedServiceUuid() const; String advertisedServiceUuid(int index) const; + int advertisementData(uint8_t value[], int length); + virtual int rssi(); bool connect(); From a9550cf9a27334db6e71cbddc6be0348274bd541 Mon Sep 17 00:00:00 2001 From: Paolo Calao Date: Tue, 20 Apr 2021 17:24:22 +0200 Subject: [PATCH 16/83] Saturate length of retrieved advertisement data --- src/BLEDevice.cpp | 10 +++++----- src/BLEDevice.h | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/BLEDevice.cpp b/src/BLEDevice.cpp index 4fb2562d..4ac0785f 100644 --- a/src/BLEDevice.cpp +++ b/src/BLEDevice.cpp @@ -184,15 +184,15 @@ String BLEDevice::advertisedServiceUuid(int index) const return serviceUuid; } -int BLEDevice::advertisementData(uint8_t value[], int length) +int BLEDevice::advertisementData(uint8_t value[], int length) const { - if (_eirDataLength > length) return 0; // Check that buffer size is sufficient + if (length > _eirDataLength) length = _eirDataLength; - if (_eirDataLength) { - memcpy(value, _eirData, _eirDataLength); + if (length) { + memcpy(value, _eirData, length); } - return _eirDataLength; + return length; } int BLEDevice::rssi() diff --git a/src/BLEDevice.h b/src/BLEDevice.h index 508d46c1..84fb8f15 100644 --- a/src/BLEDevice.h +++ b/src/BLEDevice.h @@ -59,7 +59,7 @@ class BLEDevice { String advertisedServiceUuid() const; String advertisedServiceUuid(int index) const; - int advertisementData(uint8_t value[], int length); + int advertisementData(uint8_t value[], int length) const; virtual int rssi(); From bd492be549e05f48679d4fa797f99e1370bb7eaa Mon Sep 17 00:00:00 2001 From: Paolo Calao Date: Tue, 20 Apr 2021 17:34:37 +0200 Subject: [PATCH 17/83] Add advertisement data auxiliary functions --- src/BLEDevice.cpp | 10 ++++++++++ src/BLEDevice.h | 2 ++ 2 files changed, 12 insertions(+) diff --git a/src/BLEDevice.cpp b/src/BLEDevice.cpp index 4ac0785f..31fae719 100644 --- a/src/BLEDevice.cpp +++ b/src/BLEDevice.cpp @@ -184,6 +184,16 @@ String BLEDevice::advertisedServiceUuid(int index) const return serviceUuid; } +bool BLEDevice::hasAdvertisementData() const +{ + return (_eirDataLength > 0); +} + +int BLEDevice::advertisementDataLength() const +{ + return _eirDataLength; +} + int BLEDevice::advertisementData(uint8_t value[], int length) const { if (length > _eirDataLength) length = _eirDataLength; diff --git a/src/BLEDevice.h b/src/BLEDevice.h index 84fb8f15..054c49bc 100644 --- a/src/BLEDevice.h +++ b/src/BLEDevice.h @@ -59,6 +59,8 @@ class BLEDevice { String advertisedServiceUuid() const; String advertisedServiceUuid(int index) const; + bool hasAdvertisementData() const; + int advertisementDataLength() const; int advertisementData(uint8_t value[], int length) const; virtual int rssi(); From b5d1b738d2b28ee513e841e93cd3ea88dccaba28 Mon Sep 17 00:00:00 2001 From: per1234 Date: Wed, 28 Apr 2021 02:16:05 -0700 Subject: [PATCH 18/83] Add Nano RP2040 Connect to "smoke test" examples compilation CI workflow --- .github/workflows/compile-examples.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/compile-examples.yml b/.github/workflows/compile-examples.yml index abb566da..a14882ff 100644 --- a/.github/workflows/compile-examples.yml +++ b/.github/workflows/compile-examples.yml @@ -14,6 +14,7 @@ jobs: - arduino:samd:nano_33_iot - arduino:megaavr:uno2018:mode=on - arduino:mbed:nano33ble + - arduino:mbed_nano:nanorp2040connect steps: - uses: actions/checkout@v2 From e080601da73f5ec8cf8a6d999783c0c1c5593945 Mon Sep 17 00:00:00 2001 From: Paolo Calao Date: Tue, 20 Apr 2021 17:53:05 +0200 Subject: [PATCH 19/83] Add retrieval of manufacturer data --- src/BLEDevice.cpp | 43 +++++++++++++++++++++++++++++++++++++++++++ src/BLEDevice.h | 4 ++++ 2 files changed, 47 insertions(+) diff --git a/src/BLEDevice.cpp b/src/BLEDevice.cpp index 31fae719..5f64c1d6 100644 --- a/src/BLEDevice.cpp +++ b/src/BLEDevice.cpp @@ -205,6 +205,49 @@ int BLEDevice::advertisementData(uint8_t value[], int length) const return length; } +bool BLEDevice::hasManufacturerData() const +{ + return (manufacturerDataLength() > 0); +} + +int BLEDevice::manufacturerDataLength() const +{ + int length = 0; + + for (int i = 0; i < _eirDataLength;) { + int eirLength = _eirData[i++]; + int eirType = _eirData[i++]; + + if (eirType == 0xFF) { + length = (eirLength - 1); + break; + } + + i += (eirLength - 1); + } + + return length; +} + +int BLEDevice::manufacturerData(uint8_t value[], int length) const +{ + for (int i = 0; i < _eirDataLength;) { + int eirLength = _eirData[i++]; + int eirType = _eirData[i++]; + + if (eirType == 0xFF) { + if (length > (eirLength - 1)) length = (eirLength - 1); + + memcpy(value, &_eirData[i], length); + break; + } + + i += (eirLength - 1); + } + + return length; +} + int BLEDevice::rssi() { uint16_t handle = ATT.connectionHandle(_addressType, _address); diff --git a/src/BLEDevice.h b/src/BLEDevice.h index 054c49bc..bf710744 100644 --- a/src/BLEDevice.h +++ b/src/BLEDevice.h @@ -63,6 +63,10 @@ class BLEDevice { int advertisementDataLength() const; int advertisementData(uint8_t value[], int length) const; + bool hasManufacturerData() const; + int manufacturerDataLength() const; + int manufacturerData(uint8_t value[], int length) const; + virtual int rssi(); bool connect(); From e1b0d81c279f1d75ecb0cc87cc4daa88adf6a096 Mon Sep 17 00:00:00 2001 From: LiamAljundi <46995170+LiamAljundi@users.noreply.github.com> Date: Fri, 6 Aug 2021 11:43:08 +0200 Subject: [PATCH 20/83] moved BLE library to markdown --- docs/api.md | 3826 ++++++++++++++++++++++++++++++++++++++++++++++++ docs/readme.md | 91 ++ 2 files changed, 3917 insertions(+) create mode 100644 docs/api.md create mode 100644 docs/readme.md diff --git a/docs/api.md b/docs/api.md new file mode 100644 index 00000000..fc0e9c07 --- /dev/null +++ b/docs/api.md @@ -0,0 +1,3826 @@ +# ArduinoBLE library + +## BLE class + +Used to enable the BLE module. + +### `begin()` + +Initializes the BLE device. + +#### Syntax + +``` +BLE.begin() + +``` + +#### Parameters + +None + +Returns +1 on success, 0 on failure. + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } +… + +``` + +### `end()` + +Stops the BLE device. + +#### Syntax + +``` +BLE.end() + +``` + +#### Parameters + +None + +Returns +Nothing + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + // .... + + BLE.end(); +… + +``` + +### `poll()` + +Poll for BLE radio events and handle them. + +#### Syntax + +``` +BLE.poll() BLE.poll(timeout) + +``` + +#### Parameters + +**timeout**: optional timeout in ms, to wait for event. If not specified defaults to 0 ms. + +Returns +Nothing + +#### Example + +```Arduino +… + // assign event handlers for connected, disconnected to peripheral + BLE.setEventHandler(BLEConnected, blePeripheralConnectHandler); + BLE.setEventHandler(BLEDisconnected, blePeripheralDisconnectHandler); + + // … + + BLE.poll(); +… + +``` + +### `setEventHandler()` + +Set the event handler (callback) function that will be called when the specified event occurs. + +#### Syntax + +``` +BLE.setEventHandler(eventType, callback) + +``` + +#### Parameters + +**eventType**: event type (BLEConnected, BLEDisconnected) +**callback**: function to call when event occurs +Returns +Nothing. + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + // ... + + // assign event handlers for connected, disconnected to peripheral + BLE.setEventHandler(BLEConnected, blePeripheralConnectHandler); + BLE.setEventHandler(BLEDisconnected, blePeripheralDisconnectHandler); + + // … + + +void blePeripheralConnectHandler(BLEDevice central) { + // central connected event handler + Serial.print("Connected event, central: "); + Serial.println(central.address()); +} + +void blePeripheralDisconnectHandler(BLEDevice central) { + // central disconnected event handler + Serial.print("Disconnected event, central: "); + Serial.println(central.address()); +} +… + +``` + +### `connected()` + +Query if another BLE device is connected + +#### Syntax + +``` +BLE.connected() + +``` + +#### Parameters + +None + +Returns +**true** if another BLE device is connected, otherwise **false**. + +#### Example + +```Arduino +… + // while the central is still connected to peripheral: + while (BLE.connected()) { + + // ... + } +… + +``` + +### `disconnect()` + +Disconnect any BLE devices that are connected + +#### Syntax + +``` +BLE.disconnect() + +``` + +#### Parameters + +None + +Returns +**true** if any BLE device that was previously connected was disconnected, otherwise **false**. + +#### Example + +```Arduino +… + if (BLE.connected()) { + // … + + BLE.disconnect(); + } +… + +``` + +### `address()` + +Query the Bluetooth address of the BLE device. + +#### Syntax + +``` +BLE.address() + +``` + +#### Parameters + +None + +Returns +The **Bluetooth address** of the BLE device (as a String). + +#### Example + +```Arduino +… + **String** address = BLE.address(); + + Serial.print(“Local address is: “); + Serial.println(address); +… + +``` + +### `rssi()` + +Query the RSSI (Received signal strength indication) of the connected BLE device. + +#### Syntax + +``` +BLE.rssi() + +``` + +#### Parameters + +None + +Returns +The **RSSI** of the connected BLE device, 127 if no BLE device is connected. + +#### Example + +```Arduino +… + if (BLE.connected()) { + // … + + Serial.print(“RSSI = “); + Serial.println(BLE.rssi()); + } +… + +``` + +### `setAdvertisedServiceUuid()` + +Set the advertised service UUID used when advertising. + +#### Syntax + +``` +BLE.setAdvertisedServiceUuid(uuid) + +``` + +#### Parameters + +**uuid:** 16-bit or 128-bit BLE UUID in **String** format + +Returns +Nothing + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + BLE.setAdvertisedServiceUuid(“19B10000-E8F2-537E-4F6C-D104768A1214"); + + // ... + + // start advertising + BLE.advertise(); +… + +``` + +### `setAdvertisedService()` + +Set the advertised service UUID used when advertising to the value of the BLEService provided. + +#### Syntax + +``` +BLE.setAdvertisedService(bleService) + +``` + +#### Parameters + +**bleService:** BLEService to use UUID from + +Returns +Nothing + +#### Example + +```Arduino +… +BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // BLE LED Service + +// ... + + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + BLE.setAdvertisedService(ledService); + + // ... + + // start advertising + BLE.advertise(); +… + +``` + +### `setManufacturerData()` + +Set the manufacturer data value used when advertising. + +#### Syntax + +``` +BLE.setManufacturerData(data, length) + +``` + +#### Parameters + +**data:** byte array containing manufacturer data +**length:** length of manufacturer data array + +Returns +Nothing + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + byte data[5] = { 0x01, 0x02, 0x03, 0x04, 0x05}; + + BLE.setManufacturerData(data, 5); + + // ... + + // start advertising + BLE.advertise(); + +… + +``` + +### `setLocalName()` + +Set the local value used when advertising. + +#### Syntax + +``` +BLE.setLocalName(name) + +``` + +#### Parameters + +**name:** local name value to use when advertising + +Returns +Nothing + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + BLE.setLocalName("LED"); + + // ... + + // start advertising + BLE.advertise(); + +… + +``` + +### `setDeviceName()` + +Set the device name in the built in device name characteristic. If not set, the value defaults “Arduino”. + +#### Syntax + +``` +BLE.setDeviceName(name) + +``` + +#### Parameters + +**name:** device name value + +Returns +Nothing + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + BLE.setDeviceName("LED"); + + // ... + + // start advertising + BLE.advertise(); + +… + +``` + +### `setAppearance()` + +Set the appearance in the built in appearance characteristic. If not set, the value defaults 0x0000. + +#### Syntax + +``` +BLE.setAppearance(appearance) + +``` + +#### Parameters + +**appearance:** appearance value + +Returns +Nothing + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + BLE.setAppearance(0x8000); + + // ... + + // start advertising + BLE.advertise(); + +… + +``` + +### `addService()` + +Add a BLEService to the set of services the BLE device provides + +#### Syntax + +``` +BLE.addService(service) + +``` + +#### Parameters + +**service:** BLEService to add + +Returns +Nothing + +#### Example + +```Arduino +… +BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // BLE LED Service + +// … + + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + // ... + + BLE.addService(ledService); + + // ... +… + +``` + +### `advertise()` + +Start advertising. + +#### Syntax + +``` +BLE.advertise() + +``` + +#### Parameters + +None + +Returns +1 on success, 0 on failure. + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + // ... + + BLE.advertise(); + + // ... +… + +``` + +### `stopAdvertise()` + +Stop advertising. + +#### Syntax + +``` +BLE.stopAdvertise() + +``` + +#### Parameters + +None + +Returns +Nothing + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + // ... + + BLE.advertise(); + + // ... + + BLE.stopAdvertise(); +… + +``` + +### `central()` + +Query the central BLE device connected. + +#### Syntax + +``` +BLE.central() + +``` + +#### Parameters + +None + +Returns +**BLEDevice** representing the central. + +#### Example + +```Arduino +… + // listen for BLE peripherals to connect: + BLEDevice central = BLE.central(); + + // if a central is connected to peripheral: + if (central) { + Serial.print("Connected to central: "); + // print the central's MAC address: + Serial.println(central.address()); + + // … + } +… + +``` + +### `setAdvertisingInterval()` + +Set the advertising interval in units of 0.625 ms. Defaults to 100ms (160 * 0.625 ms) if not provided. + +#### Syntax + +``` +BLE.setAdvertisingInterval(advertisingInterval) + +``` + +#### Parameters + +**advertisingInterval:** advertising interval in units of 0.625 ms + +Returns +Nothing. + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + // ... + + BLE.setAdvertisingInterval(320); // 200 * 0.625 ms + + BLE.advertise(); +… + +``` + +### `setConnectionInterval()` + +Set the minimum and maximum desired connection intervals in units of 1.25 ms. + +#### Syntax + +``` +BLE.setConnectionInterval(minimum, maximum) + +``` + +#### Parameters + +**minimum:** minimum desired connection interval in units of 1.25 ms +**maximum:** maximum desired connection interval in units of 1.25 ms + +Returns +Nothing. + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + // ... + + BLE.setConnectionInterval(0x0006, 0x0c80); // 7.5 ms minimum, 4 s maximum + +… + +``` + +### `setConnectable()` + +Set if the device is connectable after advertising, defaults to **true**. + +#### Syntax + +``` +BLE.setConnectable(connectable) + +``` + +#### Parameters + +**true**: the device will be connectable when advertising +**false**: the device will NOT be connectable when advertising + +Returns +Nothing. + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + // ... + + BLE.setConnectable(false); // make the device unconnectable when advertising + +… + +``` + +### `scan()` + +Start scanning for BLE devices that are advertising. + +#### Syntax + +``` +BLE.scan() +BLE.scan(withDuplicates) + +``` + +#### Parameters + +**withDuplicates:** optional, defaults to **false**. If **true**, advertisements received more than once will not be filtered + +Returns +1 on success, 0 on failure. + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + Serial.println("BLE Central scan"); + + // start scanning for peripheral + BLE.scan(); + + // … + + BLEDevice peripheral = BLE.available(); + + if (peripheral) { + // ... + } +… + +``` + +### `scanForName()` + +Start scanning for BLE devices that are advertising with a particular (local) name. + +#### Syntax + +``` +BLE.scanForName(name) +BLE.scanForName(name, withDuplicates) + +``` + +#### Parameters + +**name:** (local) name of device (as a **String**) to filter for +**withDuplicates:** optional, defaults to **false**. If **true**, advertisements received more than once will not be filtered. + +Returns +1 on success, 0 on failure. + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + Serial.println("BLE Central scan"); + + // start scanning for peripheral + BLE.scanForName("LED"); + + // … + + BLEDevice peripheral = BLE.available(); + + if (peripheral) { + // ... + } +… + +``` + +### `scanForAddress()` + +Start scanning for BLE devices that are advertising with a particular (Bluetooth) address. + +#### Syntax + +``` +BLE.scanForAddress(address) +BLE.scanForAddress(address, withDuplicates) + +``` + +#### Parameters + +**address:** (Bluetooth) address (as a String) to filter for +**withDuplicates:** optional, defaults to **false**. If **true**, advertisements received more than once will not be filtered + +Returns +1 on success, 0 on failure. + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + Serial.println("BLE Central scan"); + + // start scanning for peripheral + BLE.scanForAddress("aa:bb:cc:ee:dd:ff"); + + // … + + BLEDevice peripheral = BLE.available(); + + if (peripheral) { + // ... + } +… + +``` + +### `scanForUuid()` + +Start scanning for BLE devices that are advertising with a particular (service) UUID. + +#### Syntax + +``` +BLE.scanForUuid(uuid) +BLE.scanForUuid(uuid, withDuplicates) + +``` + +#### Parameters + +**uuid:** (service) UUID (as a **String**) to filter for +**withDuplicates:** optional, defaults to **false**. If **true**, advertisements received more than once will not be filtered. + +Returns +1 on success, 0 on failure. + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + Serial.println("BLE Central scan"); + + // start scanning for peripheral + BLE.scanForUuid("aa10"); + + // … + + BLEDevice peripheral = BLE.available(); + + if (peripheral) { + // ... + } +… + +``` + +### `stopScan()` + +Stop scanning for BLE devices that are advertising. + +#### Syntax + +``` +BLE.stopScan() + +``` + +#### Parameters + +None + +Returns +Nothing + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + Serial.println("BLE Central scan"); + + // start scanning for peripheral + BLE.scan(); + + // … + BLE.stopScan(); +… + +``` + +### `available()` + +Query for a discovered BLE device that was found during scanning. + +#### Syntax + +``` +BLE.available() + +``` + +#### Parameters + +Nothing + +Returns +**BLEDevice** representing the discovered device. + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + Serial.println("BLE Central scan"); + + // start scanning for peripheral + BLE.scan(); + + // … + + BLEDevice peripheral = BLE.available(); + + if (peripheral) { + // ... + } +… + +``` + +## BLEDevice Class + +Used to get information about the devices connected or discovered while scanning + +### `poll()` + +Poll for BLE radio events for the specified BLE device and handle them. + +#### Syntax + +``` +bleDevice.poll() +bleDevice.poll(timeout) + +``` + +#### Parameters + +**timeout**: optional timeout in ms, to wait for event. If not specified defaults to 0 ms. + +Returns +Nothing + +#### Example + +```Arduino +… + // listen for BLE centrals to connect: + BLEDevice central = BLE.central(); + + // if a central is connected to peripheral: + if (central) { + // … + + central.poll(); + + // ... + } +… + +``` + +### `connected()` + +Query if a BLE device is connected + +#### Syntax + +``` +bleDevice.connected() + +``` + +#### Parameters + +None + +Returns +**true** if the BLE device is connected, otherwise **false**. + +#### Example + +```Arduino +… + // listen for BLE centrals to connect: + BLEDevice central = BLE.central(); + + // while the central is still connected + while (central.connected()) { + + // ... + } +… + +``` + +### `disconnect()` + +Disconnect the BLE device, if connected + +#### Syntax + +``` +bleDevice.disconnect() + +``` + +#### Parameters + +None + +Returns +**true** if the BLE device was disconnected, otherwise **false**. + +#### Example + +```Arduino +… + // listen for BLE centrals to connect: + BLEDevice central = BLE.central(); + + // … + + central.disconnect(); +… + +``` + +### `address()` + +Query the Bluetooth address of the BLE device. + +#### Syntax + +``` +bleDevice.address() + +``` + +#### Parameters + +None + +Returns +The **Bluetooth address** of the BLE device (as a String). + +#### Example + +```Arduino +… + // listen for BLE peripherals to connect: + BLEDevice central = BLE.central(); + + // if a central is connected to peripheral: + if (central) { + Serial.print("Connected to central: "); + // print the central's MAC address: + Serial.println(central.address()); + + // …. + } +… + +``` + +### `rssi()` + +Query the RSSI (Received signal strength indication) of the BLE device. + +#### Syntax + +``` +bleDevice.rssi() + +``` + +#### Parameters + +None + +Returns +The **RSSI** of the connected BLE device, 127 if the BLE device is not connected. + +#### Example + +```Arduino +… + if (bleDevice.connected()) { + // … + + Serial.print(“RSSI = “); + Serial.println(bleDevice.rssi()); + } +… + +``` + +### `characteristic()` + +Get a BLECharacteristic representing a BLE characteristic the device provides. + +#### Syntax + +``` +bleDevice.characteristic(index) +bleDevice.characteristic(uuid) +bleDevice.characteristic(uuid, index) + +``` + +#### Parameters + +**index**: index of characteristic +**uuid**: uuid (as a **String**) + +Returns +**BLECharacteristic** for provided parameters + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + Serial.println("BLE Central scan"); + + // start scanning for peripheral + BLE.scan(); + + // … + + BLEDevice peripheral = BLE.available(); + + if (peripheral) { + // ... + + Serial.println("Connecting ..."); + + if (peripheral.connect()) { + Serial.println("Connected"); + } else { + Serial.println("Failed to connect!"); + return; + } + + // discover peripheral attributes + Serial.println("Discovering attributes ..."); + if (peripheral.discoverAttributes()) { + Serial.println("Attributes discovered"); + } else { + Serial.println("Attribute discovery failed!"); + peripheral.disconnect(); + return; + } + + BLECharacteristic batteryLevelCharacterisic = peripheral.characteristic("2a19"); + + if (batteryLevelCharacterisic) { + // use the characteristic + } else { + Serial.println("Peripheral does NOT have battery level characteristic"); + } + + // ... + } +… + +``` + +### `discoverAttributes()` + +Discover all of the attributes of BLE device. + +#### Syntax + +``` +bleDevice.discoverAttributes() + +``` + +#### Parameters + +None + +Returns +**true**, if successful, **false** on failure. + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + Serial.println("BLE Central scan"); + + // start scanning for peripheral + BLE.scan(); + + // … + + BLEDevice peripheral = BLE.available(); + + if (peripheral) { + // ... + + Serial.println("Connecting ..."); + + if (peripheral.connect()) { + Serial.println("Connected"); + } else { + Serial.println("Failed to connect!"); + return; + } + + // discover peripheral attributes + Serial.println("Discovering attributes ..."); + if (peripheral.discoverAttributes()) { + Serial.println("Attributes discovered"); + } else { + Serial.println("Attribute discovery failed!"); + peripheral.disconnect(); + return; + } + + // ... + } +… + +``` + +### `discoverService()` + +Discover the attributes of a particular service on the BLE device. + +#### Syntax + +``` +bleDevice.discoverService(serviceUuid) + +``` + +#### Parameters + +**serviceUuid:** service UUID to discover (as a **String**) + +Returns +**true**, if successful, **false** on failure. + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + Serial.println("BLE Central scan"); + + // start scanning for peripheral + BLE.scan(); + + // … + + BLEDevice peripheral = BLE.available(); + + if (peripheral) { + // ... + + Serial.println("Connecting ..."); + + if (peripheral.connect()) { + Serial.println("Connected"); + } else { + Serial.println("Failed to connect!"); + return; + } + + // discover service attributes + Serial.println("Discovering service attributes ..."); + if (peripheral.serviceUuid("fffe")) { + Serial.println("Service attributes discovered"); + } else { + Serial.println("Service attribute discovery failed!"); + peripheral.disconnect(); + return; + } + + // ... + } +… + +``` + +### `deviceName()` + +Query the device name (BLE characteristic UUID 0x2a00) of a BLE device. + +#### Syntax + +``` +bleDevice.deviceName() + +``` + +#### Parameters + +None + +Returns +**Device name** (as a String). + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + Serial.println("BLE Central scan"); + + // start scanning for peripheral + BLE.scan(); + + // … + + BLEDevice peripheral = BLE.available(); + + if (peripheral) { + // ... + + Serial.println("Connecting ..."); + + if (peripheral.connect()) { + Serial.println("Connected"); + } else { + Serial.println("Failed to connect!"); + return; + } + + // discover peripheral attributes + Serial.println("Discovering attributes ..."); + if (peripheral.discoverAttributes()) { + Serial.println("Attributes discovered"); + } else { + Serial.println("Attribute discovery failed!"); + peripheral.disconnect(); + return; + } + + // read and print device name of peripheral + Serial.println(); + Serial.print("Device name: "); + Serial.println(peripheral.deviceName()); + Serial.print("Appearance: 0x"); + Serial.println(peripheral.appearance(), HEX); + Serial.println(); + + // ... + } +… + +``` + +### `appearance()` + +Query the appearance (BLE characteristic UUID 0x2a01) of a BLE device. + +#### Syntax + +``` +bleDevice.appearance() + +``` + +#### Parameters + +None + +Returns +**Appearance value** (as a number). + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + Serial.println("BLE Central scan"); + + // start scanning for peripheral + BLE.scan(); + + // … + + BLEDevice peripheral = BLE.available(); + + if (peripheral) { + // ... + + Serial.println("Connecting ..."); + + if (peripheral.connect()) { + Serial.println("Connected"); + } else { + Serial.println("Failed to connect!"); + return; + } + + // discover peripheral attributes + Serial.println("Discovering attributes ..."); + if (peripheral.discoverAttributes()) { + Serial.println("Attributes discovered"); + } else { + Serial.println("Attribute discovery failed!"); + peripheral.disconnect(); + return; + } + + // read and print device name of peripheral + Serial.println(); + Serial.print("Device name: "); + Serial.println(peripheral.deviceName()); + Serial.print("Appearance: 0x"); + Serial.println(peripheral.appearance(), HEX); + Serial.println(); + + // ... + } +… + +``` + +### `serviceCount()` + +Query the number of services discovered for the BLE device. + +#### Syntax + +``` +bleDevice.serviceCount() + +``` + +#### Parameters + +None + +Returns +The number of **services discovered** for the BLE device. + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + Serial.println("BLE Central scan"); + + // start scanning for peripheral + BLE.scan(); + + // … + + BLEDevice peripheral = BLE.available(); + + if (peripheral) { + // ... + + Serial.println("Connecting ..."); + + if (peripheral.connect()) { + Serial.println("Connected"); + } else { + Serial.println("Failed to connect!"); + return; + } + + // discover peripheral attributes + Serial.println("Discovering attributes ..."); + if (peripheral.discoverAttributes()) { + Serial.println("Attributes discovered"); + } else { + Serial.println("Attribute discovery failed!"); + peripheral.disconnect(); + return; + } + + int serviceCount = peripheral.serviceCount(); + + Serial.print(serviceCount); + Serial.println(" services discovered"); + + // ... + } +… + +``` + +### `hasService()` + +Query if the BLE device has a particular service. + +#### Syntax + +``` +bleDevice.hasService(uuid) +bleDevice.hasService(uuid, index) + +``` + +#### Parameters + +**uuid**: uuid to check (as a **String**) +**index**: optional, index of service to check if the device provides more than on. Defaults to 0, if not provided. + +Returns +**true**, if the device provides the service, **false** otherwise. + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + Serial.println("BLE Central scan"); + + // start scanning for peripheral + BLE.scan(); + + // … + + BLEDevice peripheral = BLE.available(); + + if (peripheral) { + // ... + + Serial.println("Connecting ..."); + + if (peripheral.connect()) { + Serial.println("Connected"); + } else { + Serial.println("Failed to connect!"); + return; + } + + // discover peripheral attributes + Serial.println("Discovering attributes ..."); + if (peripheral.discoverAttributes()) { + Serial.println("Attributes discovered"); + } else { + Serial.println("Attribute discovery failed!"); + peripheral.disconnect(); + return; + } + + if (peripheral.hasService("180f")) { + Serial.println("Peripheral has battery service"); + } + + // ... + } +… + +``` + +### `service()` + +Get a BLEService representing a BLE service the device provides. + +#### Syntax + +``` +bleDevice.service(index) +bleDevice.service(uuid) +bleDevice.service(uuid, index) + +``` + +#### Parameters + +**index**: index of service +**uuid**: uuid (as a **String**) + +Returns +**BLEService** for provided parameters + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + Serial.println("BLE Central scan"); + + // start scanning for peripheral + BLE.scan(); + + // … + + BLEDevice peripheral = BLE.available(); + + if (peripheral) { + // ... + + Serial.println("Connecting ..."); + + if (peripheral.connect()) { + Serial.println("Connected"); + } else { + Serial.println("Failed to connect!"); + return; + } + + // discover peripheral attributes + Serial.println("Discovering attributes ..."); + if (peripheral.discoverAttributes()) { + Serial.println("Attributes discovered"); + } else { + Serial.println("Attribute discovery failed!"); + peripheral.disconnect(); + return; + } + + BLEService batteryService = peripheral.service("180f"); + + if (batteryService) { + // use the service + } else { + Serial.println("Peripheral does NOT have battery service"); + } + + // ... + } +… + +``` + +### `characteristicCount()` + +Query the number of characteristics discovered for the BLE device. + +#### Syntax + +``` +bleDevice.characteristicCount() + +``` + +#### Parameters + +None + +Returns +The **number of characteristics** discovered for the BLE device. + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + Serial.println("BLE Central scan"); + + // start scanning for peripheral + BLE.scan(); + + // … + + BLEDevice peripheral = BLE.available(); + + if (peripheral) { + // ... + + Serial.println("Connecting ..."); + + if (peripheral.connect()) { + Serial.println("Connected"); + } else { + Serial.println("Failed to connect!"); + return; + } + + // discover peripheral attributes + Serial.println("Discovering attributes ..."); + if (peripheral.discoverAttributes()) { + Serial.println("Attributes discovered"); + } else { + Serial.println("Attribute discovery failed!"); + peripheral.disconnect(); + return; + } + + int characteristicCount = peripheral.characteristicCount(); + + Serial.print(characteristicCount); + Serial.println(" characteristis discovered"); + + // ... + } +… + +``` + +### `hasCharacteristic()` + +Query if the BLE device has a particular characteristic. + +#### Syntax + +``` +bleDevice.hasCharacteristic(uuid) +bleDevice.hasCharacteristic(uuid, index) + +``` + +#### Parameters + +**uuid**: uuid to check (as a **String**) +**index**: optional, index of characteristic to check if the device provides more than on. Defaults to 0, if not provided. + +Returns +**true**, if the device provides the characteristic, **false** otherwise. + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + Serial.println("BLE Central scan"); + + // start scanning for peripheral + BLE.scan(); + + // … + + BLEDevice peripheral = BLE.available(); + + if (peripheral) { + // ... + + Serial.println("Connecting ..."); + + if (peripheral.connect()) { + Serial.println("Connected"); + } else { + Serial.println("Failed to connect!"); + return; + } + + // discover peripheral attributes + Serial.println("Discovering attributes ..."); + if (peripheral.discoverAttributes()) { + Serial.println("Attributes discovered"); + } else { + Serial.println("Attribute discovery failed!"); + peripheral.disconnect(); + return; + } + + if (peripheral.hasCharacteristic("2a19")) { + Serial.println("Peripheral has battery level characteristic"); + } + + // ... + } +… + +``` + +### `hasLocalName()` + +Query if a discovered BLE device is advertising a local name. + +#### Syntax + +``` +bleDevice.hasLocalName() + +``` + +#### Parameters + +Nothing + +Returns +**true**, if the device is advertising a local name, **false** otherwise. + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + Serial.println("BLE Central scan"); + + // start scanning for peripheral + BLE.scan(); + + // … + + BLEDevice peripheral = BLE.available(); + + if (peripheral) { + // ... + + // print the local name, if present + if (peripheral.hasLocalName()) { + Serial.print("Local Name: "); + Serial.println(peripheral.localName()); + } + + // ... + } +… + +``` + +### `hasAdvertisedServiceUuid()` + +Query if a discovered BLE device is advertising a service UUID. + +#### Syntax + +``` +bleDevice.hasAdvertisedServiceUuid() +bleDevice.hasAdvertisedServiceUuid(index) + +``` + +#### Parameters + +**index**: optional, defaults to 0, the index of the service UUID, if the device is advertising more than one. + +Returns +**true**, if the device is advertising a service UUID, **false** otherwise. + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + Serial.println("BLE Central scan"); + + // start scanning for peripheral + BLE.scan(); + + // … + + BLEDevice peripheral = BLE.available(); + + if (peripheral) { + // ... + + // print the advertised service UUIDs, if present + if (peripheral.hasAdvertisedServiceUuid()) { + Serial.print("Service UUIDs: "); + for (int i = 0; i < peripheral.advertisedServiceUuidCount(); i++) { + Serial.print(peripheral.advertisedServiceUuid(i)); + Serial.print(" "); + } + Serial.println(); + } + + // ... + } +… + +``` + +### `advertisedServiceUuidCount()` + +Query the number of advertised services a discovered BLE device is advertising. + +#### Syntax + +``` +bleDevice.advertisedServiceUuidCount() + +``` + +#### Parameters + +None + +Returns +The **number of advertised services** a discovered BLE device is advertising. + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + Serial.println("BLE Central scan"); + + // start scanning for peripheral + BLE.scan(); + + // … + + BLEDevice peripheral = BLE.available(); + + if (peripheral) { + // ... + + // print the advertised service UUIDs, if present + if (peripheral.hasAdvertisedServiceUuid()) { + Serial.print("Service UUIDs: "); + for (int i = 0; i < peripheral.advertisedServiceUuidCount(); i++) { + Serial.print(peripheral.advertisedServiceUuid(i)); + Serial.print(" "); + } + Serial.println(); + } + + // ... + } +… + +``` + +### `localName()` + +Query the local name a discovered BLE device is advertising with. + +#### Syntax + +``` +bleDevice.localName() + +``` + +#### Parameters + +Nothing + +Returns +**Advertised local name** (as a String). + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + Serial.println("BLE Central scan"); + + // start scanning for peripheral + BLE.scan(); + + // … + + BLEDevice peripheral = BLE.available(); + + if (peripheral) { + // ... + + // print the local name, if present + if (peripheral.hasLocalName()) { + Serial.print("Local Name: "); + Serial.println(peripheral.localName()); + } + + // ... + } +… + +``` + +### `advertisedServiceUuid()` + +Query an advertised service UUID discovered BLE device is advertising. + +#### Syntax + +``` +bleDevice.advertisedServiceUuid() +bleDevice.advertisedServiceUuid(index) + +``` + +#### Parameters + +**index**: optional, defaults to 0, the index of the **service UUID**, if the device is advertising more than one. + +Returns +Advertised service **UUID** (as a String). + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + Serial.println("BLE Central scan"); + + // start scanning for peripheral + BLE.scan(); + + // … + + BLEDevice peripheral = BLE.available(); + + if (peripheral) { + // ... + + // print the advertised service UUIDs, if present + if (peripheral.hasAdvertisedServiceUuid()) { + Serial.print("Service UUIDs: "); + for (int i = 0; i < peripheral.advertisedServiceUuidCount(); i++) { + Serial.print(peripheral.advertisedServiceUuid(i)); + Serial.print(" "); + } + Serial.println(); + } + + // ... + } +… + +``` + +### `connect()` + +Connect to a BLE device. + +#### Syntax + +``` +bleDevice.connect() + +``` + +#### Parameters + +None + +Returns +**true**, if the connection was successful, **false** otherwise. + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + Serial.println("BLE Central scan"); + + // start scanning for peripheral + BLE.scan(); + + // … + + BLEDevice peripheral = BLE.available(); + + if (peripheral) { + // ... + + Serial.println("Connecting ..."); + + if (peripheral.connect()) { + Serial.println("Connected"); + } else { + Serial.println("Failed to connect!"); + return; + } + + // ... + } +… + +``` + +## BLEService Class + +Used to enable the services board provides or interact with services a remote board provides. + +### `BLEService()` + +Create a new BLE service. + +#### Syntax + +``` +BLEService(uuid) + +``` + +#### Parameters + +**uuid**: 16-bit or 128-bit UUID in **String** format + +Returns +New **BLEService** with the specified **UUID** + +#### Example + +```Arduino +… +BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // BLE LED Service +… + +``` + +### `uuid()` + +Query the UUID of the specified BLEService. + +#### Syntax + +``` +bleService.uuid() + +``` + +#### Parameters + +None + +Returns +UUID of the BLE service as a **String**. + +#### Example + +```Arduino +… +BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // BLE LED Service + +// … +Serial.print(“LED service UUID = “); +Serial.println(ledService.uuid()); + +… + +``` + +### `addCharacteristic()` + +Add a BLECharateristic to the BLE service. + +#### Syntax + +``` +bleService.addCharacteristic(bleCharacteristic) + +``` + +#### Parameters + +None + +Returns +Nothing + +#### Example + +```Arduino +… +BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // BLE LED Service + +// BLE LED Switch Characteristic - custom 128-bit UUID, readable and writable by central +BLECharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite, 1); + + +// … + +// add the characteristic to the service +ledService.addCharacteristic(switchCharacteristic); + +… + +``` + +### `characteristicCount()` + +Query the number of characteristics discovered for the BLE service. + +#### Syntax + +``` +bleService.characteristicCount() + +``` + +#### Parameters + +None + +Returns +The **number of characteristics** discovered for the BLE service. + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + Serial.println("BLE Central scan"); + + // start scanning for peripheral + BLE.scan(); + + // … + + BLEDevice peripheral = BLE.available(); + + if (peripheral) { + // ... + + Serial.println("Connecting ..."); + + if (peripheral.connect()) { + Serial.println("Connected"); + } else { + Serial.println("Failed to connect!"); + return; + } + + // discover peripheral attributes + Serial.println("Discovering attributes ..."); + if (peripheral.discoverAttributes()) { + Serial.println("Attributes discovered"); + } else { + Serial.println("Attribute discovery failed!"); + peripheral.disconnect(); + return; + } + + BLEService batteryService = peripheral.service("180f"); + + if (batteryService) { + // use the service + int characteristicCount = batteryService.characteristicCount(); + + Serial.print(characteristicCount); + Serial.println(" characteristics discovered in battery service"); + } else { + Serial.println("Peripheral does NOT have battery service"); + } + + // ... + } +… + +``` + +### `hasCharacteristic()` + +Query if the BLE service has a particular characteristic. + +#### Syntax + +``` +bleService.hasCharacteristic(uuid) +bleService.hasCharacteristic(uuid, index) + +``` + +#### Parameters + +**uuid**: uuid to check (as a **String**) +**index**: optional, index of characteristic to check if the device provides more than on. Defaults to 0, if not provided. + +Returns +**true**, if the service provides the characteristic, **false** otherwise. + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + Serial.println("BLE Central scan"); + + // start scanning for peripheral + BLE.scan(); + + // … + BLEDevice peripheral = BLE.available(); + + if (peripheral) { + // ... + + Serial.println("Connecting ..."); + + if (peripheral.connect()) { + Serial.println("Connected"); + } else { + Serial.println("Failed to connect!"); + return; + } + + // discover peripheral attributes + Serial.println("Discovering attributes ..."); + if (peripheral.discoverAttributes()) { + Serial.println("Attributes discovered"); + } else { + Serial.println("Attribute discovery failed!"); + peripheral.disconnect(); + return; + } + + BLEService batteryService = peripheral.service("180f"); + + if (batteryService) { + // use the service + if (batteryService.hasCharacteristic("2a19")) { + Serial.println("Battery service has battery level characteristic"); + } + } else { + Serial.println("Peripheral does NOT have battery service"); + } + + // ... + } +… + +``` + +### `characteristic()` + +Get a BLECharacteristic representing a BLE characteristic the service provides. + +#### Syntax + +``` +bleService.characteristic(index) +bleService.characteristic(uuid) +bleService.characteristic(uuid, index) + +``` + +#### Parameters + +**index**: index of characteristic +**uuid**: uuid (as a **String**) + +Returns +**BLECharacteristic** for provided parameters + +#### Example + +```Arduino +… + // begin initialization + if (!BLE.begin()) { + Serial.println("starting BLE failed!"); + + while (1); + } + + Serial.println("BLE Central scan"); + + // start scanning for peripheral + BLE.scan(); + + // … + + BLEDevice peripheral = BLE.available(); + + if (peripheral) { + // ... + + Serial.println("Connecting ..."); + + if (peripheral.connect()) { + Serial.println("Connected"); + } else { + Serial.println("Failed to connect!"); + return; + } + + // discover peripheral attributes + Serial.println("Discovering attributes ..."); + if (peripheral.discoverAttributes()) { + Serial.println("Attributes discovered"); + } else { + Serial.println("Attribute discovery failed!"); + peripheral.disconnect(); + return; + } + + BLEService batteryService = peripheral.service("180f"); + + if (batteryService) { + // use the service + BLECharacteristic batteryLevelCharacterisic = peripheral.characteristic("2a19"); + + if (batteryLevelCharacterisic) { + // use the characteristic + } else { + Serial.println("Peripheral does NOT have battery level characteristic"); + } + } else { + Serial.println("Peripheral does NOT have battery service"); + } + + // ... + } +… + +``` + +## BLECharacteristic Class + +Used to enable the characteristics board offers in a service or interact with characteristics a remote board provides. + +### `BLECharacteristic()` + +Create a new BLE characteristic. + +#### Syntax + +``` +BLECharacteristic(uuid, properties, value, valueSize) +BLECharacteristic(uuid, properties, stringValue) + +BLEBoolCharacteristic(uuid, properties) +BLEBooleanCharacteristic(uuid, properties) +BLECharCharacteristic(uuid, properties) +BLEUnsignedCharCharacteristic(uuid, properties) +BLEByteCharacteristic(uuid, properties) +BLEShortCharacteristic(uuid, properties) +BLEUnsignedShortCharacteristic(uuid, properties) +BLEWordCharacteristic(uuid, properties) +BLEIntCharacteristic(uuid, properties) +BLEUnsignedIntCharacteristic(uuid, properties) +BLELongCharacteristic(uuid, properties) +BLEUnsignedLongCharacteristic(uuid, properties) +BLEFloatCharacteristic(uuid, properties) +BLEDoubleCharacteristic(uuid, properties) +``` + +#### Parameters + +**uuid**: 16-bit or 128-bit UUID in **String** format +**properties**: mask of the properties (BLEBroadcast, BLERead, BLEWriteWithoutResponse, BLEWrite, BLENotify, BLEIndicate) +**valueSize**: (maximum) size of characteristic value +**stringValue**: value as a string + +Returns +New **BLECharacteristic** with the specified **UUID** and value + +#### Example + +```Arduino +… +// BLE Battery Level Characteristic +BLEUnsignedCharCharacteristic batteryLevelChar("2A19", // standard 16-bit characteristic UUID + BLERead | BLENotify); // remote clients will be able to get notifications if this characteristic changes + +… + +``` + +### `uuid()` + +Query the UUID of the specified BLECharacteristic. + +#### Syntax + +``` +bleCharacteristic.uuid() + +``` + +#### Parameters + +None + +Returns +**UUID** of the BLE service as a **String**. + +#### Example + +```Arduino +… +// BLE LED Switch Characteristic - custom 128-bit UUID, read and writable by central +BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); + +// … +Serial.print(“Switch characteristic UUID = “); +Serial.println(switchCharacteristic.uuid()); + +… + +``` + +### `properties()` + +Query the property mask of the specified BLECharacteristic. + +#### Syntax + +``` +bleCharacteristic.properties() + +``` + +#### Parameters + +None + +Returns +**Properties of the characteristic masked** (BLEBroadcast, BLERead, BLEWriteWithoutResponse, BLEWrite, BLENotify, BLEIndicate) + +#### Example + +```Arduino +… +// BLE LED Switch Characteristic - custom 128-bit UUID, read and writable by central +BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); + +// … +byte properties = switchCharacteristic.properties(); + +if (properties & BLERead) { + // characteristic is readable ... +} + +if (properties & (BLEWrite | BLEWriteWithoutResponse)) { + // characteristic is writable ... +} +… + +``` + +### `valueSize()` + +Query the maximum value size of the specified BLECharacteristic. + +#### Syntax + +``` +bleCharacteristic.valueSize() + +``` + +#### Parameters + +None + +Returns +The **maximum value** size of the characteristic (in bytes) + +#### Example + +```Arduino +… +// BLE LED Switch Characteristic - custom 128-bit UUID, read and writable by central +BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); + +// … + +Serial.print(“value size = “); +Serial.println(switchCharacteristic.valueSize()); +… + +``` + +### `value()` + +Query the current value of the specified BLECharacteristic. + +#### Syntax + +``` +bleCharacteristic.value() + +``` + +#### Parameters + +None + +Returns +The **current value** of the characteristic, value type depends on the constructor used + +#### Example + +```Arduino +… +// BLE LED Switch Characteristic - custom 128-bit UUID, read and writable by central +BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); + +// … + + if (switchCharacteristic.value()) { // any value other than 0 + Serial.println("LED on"); + digitalWrite(ledPin, HIGH); // will turn the LED on + } else { // a 0 value + Serial.println(F("LED off")); + digitalWrite(ledPin, LOW); // will turn the LED off + } + +… + +``` + +### `valueLength()` + +Query the current value size of the specified BLECharacteristic. + +#### Syntax + +``` +bleCharacteristic.valueLength() + +``` + +#### Parameters + +None + +Returns +The **current value** size of the characteristic (in bytes) + +#### Example + +```Arduino +… +// BLE LED Switch Characteristic - custom 128-bit UUID, read and writable by central +BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); + +// … + +Serial.print(“value length = “); +Serial.println(switchCharacteristic.valueLength()); +… + +``` + +### `readValue()` + +Read the current value of the characteristic. If the characteristic is on a remote device, a read request will be sent. + +#### Syntax + +``` +bleCharacteristic.readValue(buffer, length) +bleCharacteristic.readValue(value) + +``` + +#### Parameters + +**buffer:** byte array to read value into length: size of buffer argument in bytes +**value**: variable to read value into (by reference) + +Returns +Number of bytes read + +#### Example + +```Arduino +… + while (peripheral.connected()) { + // while the peripheral is connected + + // check if the value of the simple key characteristic has been updated + if (simpleKeyCharacteristic.valueUpdated()) { + // yes, get the value, characteristic is 1 byte so use byte value + byte value = 0; + + simpleKeyCharacteristic.readValue(value); + + if (value & 0x01) { + // first bit corresponds to the right button + Serial.println("Right button pressed"); + } + + if (value & 0x02) { + // second bit corresponds to the left button + Serial.println("Left button pressed"); + } + } + } +… + +``` + +### `writeValue()` + +Write the value of the characteristic. If the characteristic is on a remote device, a write request or command will be sent. + +#### Syntax + +``` +bleCharacteristic.writeValue(buffer, length) +bleCharacteristic.writeValue(value) + +``` + +#### Parameters + +**buffer**: byte array to write value with +**length**: number of bytes of the buffer argument to write +**value**: value to write + +Returns +1 on success, 0 on failure + +#### Example + +```Arduino +… + // read the button pin + int buttonState = digitalRead(buttonPin); + + if (oldButtonState != buttonState) { + // button changed + oldButtonState = buttonState; + + if (buttonState) { + Serial.println("button pressed"); + + // button is pressed, write 0x01 to turn the LED on + ledCharacteristic.writeValue((byte)0x01); + } else { + Serial.println("button released"); + + // button is released, write 0x00 to turn the LED off + ledCharacteristic.writeValue((byte)0x00); + } + } +… + +``` + +### `setEventHandler()` + +Set the event handler (callback) function that will be called when the specified event occurs. + +#### Syntax + +``` +bleCharacteristic.setEventHandler(eventType, callback) + +``` + +#### Parameters + +**eventType**: event type (BLESubscribed, BLEUnsubscribed, BLERead, BLEWritten) +**callback**: function to call when the event occurs + +Returns +Nothing + +#### Example + +```Arduino +… +// create switch characteristic and allow remote device to read and write +BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); + + +// … + + // assign event handlers for characteristic + switchCharacteristic.setEventHandler(BLEWritten, switchCharacteristicWritten); + +// … + +void switchCharacteristicWritten(BLEDevice central, BLECharacteristic characteristic) { + // central wrote new value to characteristic, update LED + Serial.print("Characteristic event, written: "); + + if (switchCharacteristic.value()) { + Serial.println("LED on"); + digitalWrite(ledPin, HIGH); + } else { + Serial.println("LED off"); + digitalWrite(ledPin, LOW); + } +} + + … + +``` + +### `broadcast()` + +Broadcast the characteristics value as service data when advertising. + +#### Syntax + +``` +bleCharacteristic.broadcast() + +``` + +#### Parameters + +None + +Returns +1 on success, 0 on failure + +#### Example + +```Arduino +… +// create button characteristic and allow remote device to get notifications +BLEByteCharacteristic buttonCharacteristic("19B10012-E8F2-537E-4F6C-D104768A1214", BLERead | BLENotify | BLEBroadcast); + +// … + +buttonCharacteristic.broadcast(); + +… + +``` + +### `written()` + +Query if the characteristic value has been written by another BLE device. + +#### Syntax + +``` +bleCharacteristic.written() + +``` + +#### Parameters + +None + +Returns +**true** if the characteristic value has been written by another BLE device, **false** otherwise + +#### Example + +```Arduino +… +// BLE LED Switch Characteristic - custom 128-bit UUID, read and writable by central +BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); + + +// … + + // listen for BLE peripherals to connect: + BLEDevice central = BLE.central(); + + // if a central is connected to peripheral: + if (central) { + Serial.print("Connected to central: "); + // print the central's MAC address: + Serial.println(central.address()); + + // while the central is still connected to peripheral: + while (central.connected()) { + // if the remote device wrote to the characteristic, + // use the value to control the LED: + if (switchCharacteristic.written()) { + if (switchCharacteristic.value()) { // any value other than 0 + Serial.println("LED on"); + digitalWrite(ledPin, HIGH); // will turn the LED on + } else { // a 0 value + Serial.println(F("LED off")); + digitalWrite(ledPin, LOW); // will turn the LED off + } + } + } + + // when the central disconnects, print it out: + Serial.print(F("Disconnected from central: ")); + Serial.println(central.address()); + } + + +… + +``` + +### `subscribed()` + +Query if the characteristic has been subscribed to by another BLE device. + +#### Syntax + +``` +bleCharacteristic.subscribed() + +``` + +#### Parameters + +None + +Returns +**true** if the characteristic value has been subscribed to by another BLE device, **false** otherwise + +#### Example + +```Arduino +… +// BLE Battery Level Characteristic +BLEUnsignedCharCharacteristic batteryLevelChar("2A19", // standard 16-bit characteristic UUID + BLERead | BLENotify); // remote clients will be able to get notifications if this characteristic changes + + + +// … + + if (batteryLevelChar.subscribed()) { + // set a new value , that well be pushed to subscribed BLE devices + batteryLevelChar.writeValue(0xab); + } +… + +``` + +### `addDescriptor()` + +Add a BLEDescriptor to the characteristic. + +#### Syntax + +``` +bleCharacteristic.addDescriptor(bleDescriptor) + +``` + +#### Parameters + +**bleDescriptor**: descriptor to add to the characteristic + +Returns +Nothing + +#### Example + +```Arduino +… +// BLE Battery Level Characteristic +BLEUnsignedCharCharacteristic batteryLevelChar("2A19", // standard 16-bit characteristic UUID + BLERead | BLENotify); // remote clients will be able to get notifications if this characteristic changes + +BLEDescriptor batteryLevelDescriptor("2901", "millis"); + + + +// … + + batteryLevelChar.addDescriptor(batteryLevelDescriptor); +… + +``` + +### `descriptorCount` + +Query the number of BLE descriptors discovered for the characteristic. + +#### Syntax + +``` +bleCharacteristic.descriptorCount() + +``` + +#### Parameters + +None + +Returns +The **number of BLE descriptors** discovered for the characteristic + +#### Example + +```Arduino +… + // loop the descriptors of the characteristic and explore each + for (int i = 0; i < characteristic.descriptorCount(); i++) { + BLEDescriptor descriptor = characteristic.descriptor(i); + + // ... + } +… + +``` + +### `hasDescriptor` + +Check if a characteristic has a particular descriptor. + +#### Syntax + +``` +bleCharacteristic.hasDescriptor(uuid) +bleCharacteristic.hasDescriptor(uuid, index) + +``` + +#### Parameters + +**index**: index of descriptor +**uuid**: uuid (as a **String**) + +Returns +**true**, if the characteristic has a matching descriptor, otherwise **false**. + +#### Example + +```Arduino +… + if (characteristic.hasDescriptor("2901")) { + Serial.println("characteristic has description descriptor"); + } +… + +``` + +### `descriptor()` + +Get a BLEDescriptor that represents a characteristics BLE descriptor. + +#### Syntax + +``` +bleCharacteristic.descriptor(index) +bleCharacteristic.descriptor(uuid) +bleCharacteristic.descriptor(uuid, index) + +``` + +#### Parameters + +**index**: index of descriptor +**uuid**: uuid (as a **String**) + +Returns +BLEDescriptor that represents a characteristics BLE descriptor + +#### Example + +```Arduino +… + if (characteristic.hasDescriptor("2901")) { + Serial.println("characteristic has description descriptor"); + } +… + +``` + +### `canRead()` + +Query if a BLE characteristic is readable. + +#### Syntax + +``` +bleCharacteristic.canRead() + +``` + +#### Parameters + +None + +Returns +**true**, if characteristic is readable, **false** otherwise + +#### Example + +```Arduino +… + if (characteristic.canRead("2901")) { + Serial.println("characteristic is readable"); + } +… + +``` + +read + +Perform a read request for the characteristic. + +#### Syntax + +``` +bleCharacteristic.read() + +``` + +#### Parameters + +None + +Returns +**true**, if successful, **false** on failure + +#### Example + +```Arduino +… + if (characteristic.read()) { + Serial.println("characteristic value read"); + + // ... + } else { + Serial.println("error reading characteristic value"); + } +… + +``` + +### `canWrite()` + +Query if a BLE characteristic is writable. + +#### Syntax + +``` +bleCharacteristic.canWrite() + +``` + +#### Parameters + +None + +Returns +**true**, if characteristic is writable, **false** otherwise + +#### Example + +```Arduino +… + if (characteristic.canWrite()) { + Serial.println("characteristic is writable"); + } +… + +``` + +### `canSubscribe()` + +Query if a BLE characteristic is subscribable. + +#### Syntax + +``` +bleCharacteristic.canSubscribe() + +``` + +#### Parameters + +None + +Returns +**true**, if characteristic is subscribable, **false** otherwise + +#### Example + +```Arduino +… + if (characteristic.canSubscribe()) { + Serial.println("characteristic is subscribable"); + } +… + +``` + +### `subscribe()` + +Subscribe to a BLE characteristics notification or indications. + +#### Syntax + +``` +bleCharacteristic.subscribe() + +``` + +#### Parameters + +None + +Returns +**true**, on success, **false** on failure + +#### Example + +```Arduino +… + // ... + + // retrieve the simple key characteristic + BLECharacteristic simpleKeyCharacteristic = peripheral.characteristic("ffe1"); + + // subscribe to the simple key characteristic + Serial.println("Subscribing to simple key characteristic ..."); + if (!simpleKeyCharacteristic) { + Serial.println("no simple key characteristic found!"); + peripheral.disconnect(); + return; + } else if (!simpleKeyCharacteristic.canSubscribe()) { + Serial.println("simple key characteristic is not subscribable!"); + peripheral.disconnect(); + return; + } else if (!simpleKeyCharacteristic.subscribe()) { + Serial.println("subscription failed!"); + peripheral.disconnect(); + return; + } + + // ... +… + +``` + +### `canUnsubscribe()` + +Query if a BLE characteristic is unsubscribable. + +#### Syntax + +``` +bleCharacteristic.canUnsubscribe() + +``` + +#### Parameters + +None + +Returns +**true**, if characteristic is unsubscribable, **false** otherwise + +#### Example + +```Arduino +… + if (characteristic.canUnsubscribe()) { + Serial.println("characteristic is unsubscribable"); + } +… + +``` + +### `unsubscribe()` + +Unsubscribe to a BLE characteristics notifications or indications. + +#### Syntax + +``` +bleCharacteristic.unsubscribe() + +``` + +#### Parameters + +None + +Returns +**true**, on success, **false** on failure + +#### Example + +```Arduino +… + // ... + + // retrieve the simple key characteristic + BLECharacteristic simpleKeyCharacteristic = peripheral.characteristic("ffe1"); + + // subscribe to the simple key characteristic + Serial.println("Subscribing to simple key characteristic ..."); + if (!simpleKeyCharacteristic) { + Serial.println("no simple key characteristic found!"); + peripheral.disconnect(); + return; + } else if (!simpleKeyCharacteristic.canSubscribe()) { + Serial.println("simple key characteristic is not subscribable!"); + peripheral.disconnect(); + return; + } else if (!simpleKeyCharacteristic.subscribe()) { + Serial.println("subscription failed!"); + peripheral.disconnect(); + return; + } + + // ... + + simpleKeyCharacteristic.unsubscribe(); +… + +``` + +### `valueUpdated()` + +Has the characteristics value been updated via a notification or indication. + +#### Syntax + +``` +bleCharacteristic.valueUpdated() + +``` + +#### Parameters + +None + +Returns +**true**, if the characteristics value been updated via a notification or indication + +#### Example + +```Arduino +… + while (peripheral.connected()) { + // while the peripheral is connected + + // check if the value of the simple key characteristic has been updated + if (simpleKeyCharacteristic.valueUpdated()) { + // yes, get the value, characteristic is 1 byte so use byte value + byte value = 0; + + simpleKeyCharacteristic.readValue(value); + + if (value & 0x01) { + // first bit corresponds to the right button + Serial.println("Right button pressed"); + } + + if (value & 0x02) { + // second bit corresponds to the left button + Serial.println("Left button pressed"); + } + } + } +… + +``` + +## BLEDescriptor Class + +Used to describe a characteristic the board offers + +### `BLEDescriptor()` + +Create a new BLE descriptor. + +#### Syntax + +``` +BLEDescriptor(uuid, value, valueSize) +BLEDescriptor(uuid, stringValue) + +``` + +#### Parameters + +**uuid**: 16-bit or 128-bit UUID in string format +**value**: byte array value +**valueSize**: size of byte array value +**stringValue**: value as a string + +Returns +New **BLEDescriptor** with the specified **UUID** and value + +#### Example + +```Arduino +… +BLEDescriptor millisLabelDescriptor("2901", "millis"); +… + +``` + +### `uuid()` + +Query the UUID of the specified BLEDescriptor. + +#### Syntax + +``` +bleDescriptor.uuid() + +``` + +#### Parameters + +None + +Returns +**UUID** of the BLE descriptor (as a String). + +#### Example + +```Arduino +… +BLEDescriptor millisLabelDescriptor("2901", "millis"); + +// … +Serial.print(“millis label descriptor UUID = “); +Serial.println(millisLabelDescriptor.uuid()); + +… + +``` + +### `valueSize()` + +Query the value size of the specified BLEDescriptor. + +#### Syntax + +``` +bleDescriptor.valueSize() + +``` + +#### Parameters + +None + +Returns +**Value size** (in bytes) of the BLE descriptor. + +#### Example + +```Arduino +… +BLEDescriptor millisLabelDescriptor("2901", "millis"); + +// … +Serial.print(“millis label descriptor value size = “); +Serial.println(millisLabelDescriptor.valueSize()); + +… + +``` + +### `valueLength()` + +Query the length, in bytes, of the descriptor current value. + +#### Syntax + +``` +bleDescriptor.valueLength() + +``` + +#### Parameters + +None + +Returns +**Length of descriptor** value in bytes. + +#### Example + +```Arduino +… + // read the descriptor value + descriptor.read(); + + // print out the value of the descriptor + Serial.print(", value 0x"); + printData(descriptor.value(), descriptor.valueLength()); + + // ... + + void printData(const unsigned char data[], int length) { + for (int i = 0; i < length; i++) { + unsigned char b = data[i]; + + if (b < 16) { + Serial.print("0"); + } + + Serial.print(b, HEX); + } + } +… + +``` + +### `value()` + +Query the value of the specified BLEDescriptor. + +#### Syntax + +``` +bleDescriptor.value() + +``` + +#### Parameters + +None + +Returns +Value byte array of the **BLE descriptor**. + +#### Example + +```Arduino +… +BLEDescriptor millisLabelDescriptor("2901", "millis"); + +// … + + int descriptorValueSize = millisLabelDescriptor.valueSize(); + byte descriptorValue[descriptorValueSize]; + + for (int i = 0; i < descriptorValueSize; i++) { + descriptorValue[i] = millisLabelDescriptor.value()[i]; + } + +… + +``` + +### `readValue()` + +Read the current value of the descriptor. If the descriptor is on a remote device, a read request will be sent. + +#### Syntax + +``` +bleDescriptor.readValue(buffer, length) +bleDescriptor.readValue(value) + +``` + +#### Parameters + +**buffer**: byte array to read value into +**length**: size of buffer argument in bytes +**value**: variable to read value into (by reference) + +Returns +**Number of bytes** read + +#### Example + +```Arduino +… + byte value = 0; + + /get the value, descriptor is 1 byte so use byte value + descriptor.readValue(value); +… + +``` + +### `read()` + +Perform a read request for the descriptor. + +#### Syntax + +``` +bleDescriptor.read() + +``` + +#### Parameters + +None + +Returns +**true**, if successful, **false** on failure + +#### Example + +```Arduino +… + if (descriptor.read()) { + Serial.println("descriptor value read"); + + // ... + } else { + Serial.println("error reading descriptor value"); + } +… +``` diff --git a/docs/readme.md b/docs/readme.md new file mode 100644 index 00000000..86949a50 --- /dev/null +++ b/docs/readme.md @@ -0,0 +1,91 @@ +# ArduinoBLE library + +This library supports all the Arduino boards that have the hardware enabled for BLE and Bluetooth 4.0 and above; these include Nano 33 BLE, Arduino NANO 33 IoT, Uno WiFi Rev 2, MKR WiFi 1010. + +To use this library +``#include `` + +## A quick introduction to BLE + +Bluetooth 4.0 includes both traditional Bluetooth, now labeled "Bluetooth Classic", and the Bluetooth Low Energy (Bluetooth LE, or BLE). BLE is optimized for low power use at low data rates, and was designed to operate from simple lithium coin cell batteries. + +Unlike standard bluetooth communication basically based on an asynchronous serial connection (UART) a Bluetooth LE radio acts like a community bulletin board. The computers that connect to it are like community members that read the bulletin board. Each radio acts as either the bulletin board or the reader. If your radio is a bulletin board (called a peripheral device in Bluetooth LE parlance) it posts data for all radios in the community to read. If your radio is a reader (called a central device in Blueooth LE terms) it reads from any of the bulletin boards (peripheral devices) that have information about which it cares. You can also think of peripheral devices as the servers in a client-server transaction, because they contain the information that reader radios ask for. Similarly, central devices are the clients of the Bluetooth LE world because they read information available from the peripherals. + +![Communication between central and peripheral devices](www.arduino.cc/en/uploads/Reference/ble-bulletin-board-model.png) + +Think of a Bluetooth LE peripheral device as a bulletin board and central devices as viewers of the board. Central devices view the services, get the data, then move on. Each transaction is quick (a few milliseconds), so multiple central devices can get data from one peripheral. + +The information presented by a peripheral is structured as **services**, each of which is subdivided into **characteristics**. You can think of services as the notices on a bulletin board, and characteristics as the individual paragraphs of those notices. If you're a peripheral device, you just update each service characteristic when it needs updating and don't worry about whether the central devices read them or not. If you're a central device, you connect to the peripheral then read the boxes you want. If a given characteristic is readable and writable, then the peripheral and central can both change it. + +## Notify + +The Bluetooth LE specification includes a mechanism known as **notify** that lets you know when data's changed. When notify on a characteristic is enabled and the sender writes to it, the new value is automatically sent to the receiver, without the receiver explicitly issuing a read command. This is commonly used for streaming data such as accelerometer or other sensor readings. There's a variation on this specification called **indicate** which works similarly, but in the indicate specification, the reader sends an acknowledgement of the pushed data. + +The client-server structure of Bluetooth LE, combined with the notify characteristic, is generally called a **publish-and-subscribe model**. + +## Update a characteristic + +Your peripheral should update characteristics when there's a significant change to them. For example, when a switch changes from off to on, update its characteristic. When an analog sensor changes by a significant amount, update its characteristic. + +Just as with writing to a characteristic, you could update your characteristics on a regular interval, but this wastes processing power and energy if the characteristic has not changed. + +## Central and Peripheral Devices + +**Central** devices are **clients**. They read and write data from peripheral devices. **Peripheral** devices are **servers**. They provide data from sensors as readable characteristics, and provide read/writable characteristics to control actuators like motors, lights, and so forth. + +## Services, characteristics, and UUIDs + +A BLE peripheral will provide **services**, which in turn provide **characteristics**. You can define your own services, or use [standard services](https://developer.bluetooth.org/gatt/services/Pages/ServicesHome.aspx). + +Services are identified by unique numbers known as UUIDs. You know about UUIDs from other contexts. Standard services have a 16-bit UUID and custom services have a 128-bit UUID. The ability to define services and characteristics depends on the radio you're using and its firmware. + +## Service design patterns + +A characteristic value can be up to 512 bytes long. This is a key constraint in designing services. Given this limit, you should consider how best to store data about your sensors and actuators most effectively for your application. The simplest design pattern is to store one sensor or actuator value per characteristic, in ASCII encoded values. + +|**Characteristic**|**Value**| +|------------------|---------| +|Accelerometer X|200| +|Accelerometer Y|134| +|Accelerometer Z|150| + +This is also the most expensive in memory terms, and would take the longest to read. But it's the simplest for development and debugging. + +You could also combine readings into a single characteristic, when a given sensor or actuator has multiple values associated with it. + +|**Characteristic**|**Value**| +|------------------|---------| +|Motor Speed, Direction|150,1| +|Accelerometer X, Y, Z|200,133,150| + +This is more efficient, but you need to be careful not to exceed the 512-byte limit. The accelerometer characteristic above, for example, takes 11 bytes as a ASCII-encoded string. + +## Read/write/notify/indicate + +There are 4 things a central device can do with a characteristic: + +- **Read:** ask the peripheral to send back the current value of the characteristic. Often used for characteristics that don't change very often, for example characteristics used for configuration, version numbers, etc. +- **Write:** modify the value of the characteristic. Often used for things that are like commands, for example telling the peripheral to turn a motor on or off. +- **Indicate** and **Notify:** ask the peripheral to continuously send updated values of the characteristic, without the central having to constantly ask for it. + +## Advertising and GAP + +BLE devices let other devices know that they exist by advertising using the **General Advertising Profile (GAP)**. Advertising packets can contain a device name, some other information, and also a list of the services it provides. + +Advertising packets have a limited size. You will only be able to fit a single 128-bit service UUID in the packet. Make sure the device name is not too long, or you won't even be able to fit that. + +You can provide additional services that are not advertised. Central devices will learn about these through the connection/bonding process. Non-advertised services cannot be used to discover devices, though. Sometimes this is not an issue. For example, you may have a custom peripheral device with a custom service, but in your central device app you may know that it also provides the Battery Service and other services. + +## GATT + +The Bluetooth LE protocol operates on multiple layers. **General Attribute Profile (GATT)** is the layer that defines services and characteristics and enables read/write/notify/indicate operations on them. When reading more about GATT, you may encounter GATT concepts of a "server" and "client". These don't always correspond to central and peripherals. In most cases, though, the peripheral is the GATT server (since it provides the services and characteristics), while the central is the GATT client. + +## Library structure + +As the library enables multiple types of functionality, there are a number of different classes. + +- BLE used to enable the BLE module. +- BLEDevice used to get information about the devices connected or discovered while scanning. +- BLEService used to enable the services board provides or interact with services a remote board provides. +- BLECharacteristic used to enable the characteristics board offers in a service or interact with characteristics a remote board provides. +- BLEDescriptor used to describe a characteristic the board offers. From ceb39326ec0c7801d8ff9a468057a616dfdcbbb8 Mon Sep 17 00:00:00 2001 From: LiamAljundi <46995170+LiamAljundi@users.noreply.github.com> Date: Mon, 23 Aug 2021 11:44:35 +0200 Subject: [PATCH 21/83] updated content --- docs/api.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/api.md b/docs/api.md index fc0e9c07..8356b310 100644 --- a/docs/api.md +++ b/docs/api.md @@ -3783,6 +3783,7 @@ Returns #### Example + ```Arduino … byte value = 0; From 21a332fa2a37be592c536da1f6e560276e92b321 Mon Sep 17 00:00:00 2001 From: LiamAljundi <46995170+LiamAljundi@users.noreply.github.com> Date: Tue, 24 Aug 2021 11:07:18 +0200 Subject: [PATCH 22/83] fixed suggestions from Karl's review --- docs/api.md | 782 ++++++++++++++++++++++++++-------------------------- 1 file changed, 391 insertions(+), 391 deletions(-) diff --git a/docs/api.md b/docs/api.md index 8356b310..dab294ab 100644 --- a/docs/api.md +++ b/docs/api.md @@ -19,20 +19,20 @@ BLE.begin() None -Returns +#### Returns 1 on success, 0 on failure. #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); while (1); } -… + ``` @@ -51,13 +51,13 @@ BLE.end() None -Returns +#### Returns Nothing #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -68,7 +68,7 @@ Nothing // .... BLE.end(); -… + ``` @@ -87,21 +87,21 @@ BLE.poll() BLE.poll(timeout) **timeout**: optional timeout in ms, to wait for event. If not specified defaults to 0 ms. -Returns +#### Returns Nothing #### Example -```Arduino -… +```arduino + // assign event handlers for connected, disconnected to peripheral BLE.setEventHandler(BLEConnected, blePeripheralConnectHandler); BLE.setEventHandler(BLEDisconnected, blePeripheralDisconnectHandler); - // … + BLE.poll(); -… + ``` @@ -120,13 +120,13 @@ BLE.setEventHandler(eventType, callback) **eventType**: event type (BLEConnected, BLEDisconnected) **callback**: function to call when event occurs -Returns +#### Returns Nothing. #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -140,7 +140,7 @@ Nothing. BLE.setEventHandler(BLEConnected, blePeripheralConnectHandler); BLE.setEventHandler(BLEDisconnected, blePeripheralDisconnectHandler); - // … + void blePeripheralConnectHandler(BLEDevice central) { @@ -154,7 +154,7 @@ void blePeripheralDisconnectHandler(BLEDevice central) { Serial.print("Disconnected event, central: "); Serial.println(central.address()); } -… + ``` @@ -173,19 +173,19 @@ BLE.connected() None -Returns +#### Returns **true** if another BLE device is connected, otherwise **false**. #### Example -```Arduino -… +```arduino + // while the central is still connected to peripheral: while (BLE.connected()) { // ... } -… + ``` @@ -204,19 +204,19 @@ BLE.disconnect() None -Returns +#### Returns **true** if any BLE device that was previously connected was disconnected, otherwise **false**. #### Example -```Arduino -… +```arduino + if (BLE.connected()) { - // … + BLE.disconnect(); } -… + ``` @@ -235,18 +235,18 @@ BLE.address() None -Returns +#### Returns The **Bluetooth address** of the BLE device (as a String). #### Example -```Arduino -… +```arduino + **String** address = BLE.address(); Serial.print(“Local address is: “); Serial.println(address); -… + ``` @@ -265,20 +265,20 @@ BLE.rssi() None -Returns +#### Returns The **RSSI** of the connected BLE device, 127 if no BLE device is connected. #### Example -```Arduino -… +```arduino + if (BLE.connected()) { - // … + Serial.print(“RSSI = “); Serial.println(BLE.rssi()); } -… + ``` @@ -297,13 +297,13 @@ BLE.setAdvertisedServiceUuid(uuid) **uuid:** 16-bit or 128-bit BLE UUID in **String** format -Returns +#### Returns Nothing #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -317,7 +317,7 @@ Nothing // start advertising BLE.advertise(); -… + ``` @@ -336,13 +336,13 @@ BLE.setAdvertisedService(bleService) **bleService:** BLEService to use UUID from -Returns +#### Returns Nothing #### Example -```Arduino -… +```arduino + BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // BLE LED Service // ... @@ -360,7 +360,7 @@ BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // BLE LED Servic // start advertising BLE.advertise(); -… + ``` @@ -380,13 +380,13 @@ BLE.setManufacturerData(data, length) **data:** byte array containing manufacturer data **length:** length of manufacturer data array -Returns +#### Returns Nothing #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -403,7 +403,7 @@ Nothing // start advertising BLE.advertise(); -… + ``` @@ -422,13 +422,13 @@ BLE.setLocalName(name) **name:** local name value to use when advertising -Returns +#### Returns Nothing #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -443,7 +443,7 @@ Nothing // start advertising BLE.advertise(); -… + ``` @@ -462,13 +462,13 @@ BLE.setDeviceName(name) **name:** device name value -Returns +#### Returns Nothing #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -483,7 +483,7 @@ Nothing // start advertising BLE.advertise(); -… + ``` @@ -502,13 +502,13 @@ BLE.setAppearance(appearance) **appearance:** appearance value -Returns +#### Returns Nothing #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -523,7 +523,7 @@ Nothing // start advertising BLE.advertise(); -… + ``` @@ -542,16 +542,16 @@ BLE.addService(service) **service:** BLEService to add -Returns +#### Returns Nothing #### Example -```Arduino -… +```arduino + BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // BLE LED Service -// … + // begin initialization if (!BLE.begin()) { @@ -565,7 +565,7 @@ BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // BLE LED Servic BLE.addService(ledService); // ... -… + ``` @@ -584,13 +584,13 @@ BLE.advertise() None -Returns +#### Returns 1 on success, 0 on failure. #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -603,7 +603,7 @@ Returns BLE.advertise(); // ... -… + ``` @@ -622,13 +622,13 @@ BLE.stopAdvertise() None -Returns +#### Returns Nothing #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -643,7 +643,7 @@ Nothing // ... BLE.stopAdvertise(); -… + ``` @@ -662,13 +662,13 @@ BLE.central() None -Returns +#### Returns **BLEDevice** representing the central. #### Example -```Arduino -… +```arduino + // listen for BLE peripherals to connect: BLEDevice central = BLE.central(); @@ -678,9 +678,9 @@ Returns // print the central's MAC address: Serial.println(central.address()); - // … + } -… + ``` @@ -699,13 +699,13 @@ BLE.setAdvertisingInterval(advertisingInterval) **advertisingInterval:** advertising interval in units of 0.625 ms -Returns +#### Returns Nothing. #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -718,7 +718,7 @@ Nothing. BLE.setAdvertisingInterval(320); // 200 * 0.625 ms BLE.advertise(); -… + ``` @@ -738,13 +738,13 @@ BLE.setConnectionInterval(minimum, maximum) **minimum:** minimum desired connection interval in units of 1.25 ms **maximum:** maximum desired connection interval in units of 1.25 ms -Returns +#### Returns Nothing. #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -756,7 +756,7 @@ Nothing. BLE.setConnectionInterval(0x0006, 0x0c80); // 7.5 ms minimum, 4 s maximum -… + ``` @@ -776,13 +776,13 @@ BLE.setConnectable(connectable) **true**: the device will be connectable when advertising **false**: the device will NOT be connectable when advertising -Returns +#### Returns Nothing. #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -794,7 +794,7 @@ Nothing. BLE.setConnectable(false); // make the device unconnectable when advertising -… + ``` @@ -814,13 +814,13 @@ BLE.scan(withDuplicates) **withDuplicates:** optional, defaults to **false**. If **true**, advertisements received more than once will not be filtered -Returns +#### Returns 1 on success, 0 on failure. #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -833,14 +833,14 @@ Returns // start scanning for peripheral BLE.scan(); - // … + BLEDevice peripheral = BLE.available(); if (peripheral) { // ... } -… + ``` @@ -861,13 +861,13 @@ BLE.scanForName(name, withDuplicates) **name:** (local) name of device (as a **String**) to filter for **withDuplicates:** optional, defaults to **false**. If **true**, advertisements received more than once will not be filtered. -Returns +#### Returns 1 on success, 0 on failure. #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -880,14 +880,14 @@ Returns // start scanning for peripheral BLE.scanForName("LED"); - // … + BLEDevice peripheral = BLE.available(); if (peripheral) { // ... } -… + ``` @@ -908,13 +908,13 @@ BLE.scanForAddress(address, withDuplicates) **address:** (Bluetooth) address (as a String) to filter for **withDuplicates:** optional, defaults to **false**. If **true**, advertisements received more than once will not be filtered -Returns +#### Returns 1 on success, 0 on failure. #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -927,14 +927,14 @@ Returns // start scanning for peripheral BLE.scanForAddress("aa:bb:cc:ee:dd:ff"); - // … + BLEDevice peripheral = BLE.available(); if (peripheral) { // ... } -… + ``` @@ -955,13 +955,13 @@ BLE.scanForUuid(uuid, withDuplicates) **uuid:** (service) UUID (as a **String**) to filter for **withDuplicates:** optional, defaults to **false**. If **true**, advertisements received more than once will not be filtered. -Returns +#### Returns 1 on success, 0 on failure. #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -974,14 +974,14 @@ Returns // start scanning for peripheral BLE.scanForUuid("aa10"); - // … + BLEDevice peripheral = BLE.available(); if (peripheral) { // ... } -… + ``` @@ -1000,13 +1000,13 @@ BLE.stopScan() None -Returns +#### Returns Nothing #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -1019,9 +1019,9 @@ Nothing // start scanning for peripheral BLE.scan(); - // … + BLE.stopScan(); -… + ``` @@ -1040,13 +1040,13 @@ BLE.available() Nothing -Returns +#### Returns **BLEDevice** representing the discovered device. #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -1059,14 +1059,14 @@ Returns // start scanning for peripheral BLE.scan(); - // … + BLEDevice peripheral = BLE.available(); if (peripheral) { // ... } -… + ``` @@ -1090,25 +1090,25 @@ bleDevice.poll(timeout) **timeout**: optional timeout in ms, to wait for event. If not specified defaults to 0 ms. -Returns +#### Returns Nothing #### Example -```Arduino -… +```arduino + // listen for BLE centrals to connect: BLEDevice central = BLE.central(); // if a central is connected to peripheral: if (central) { - // … + central.poll(); // ... } -… + ``` @@ -1127,13 +1127,13 @@ bleDevice.connected() None -Returns +#### Returns **true** if the BLE device is connected, otherwise **false**. #### Example -```Arduino -… +```arduino + // listen for BLE centrals to connect: BLEDevice central = BLE.central(); @@ -1142,7 +1142,7 @@ Returns // ... } -… + ``` @@ -1161,20 +1161,20 @@ bleDevice.disconnect() None -Returns +#### Returns **true** if the BLE device was disconnected, otherwise **false**. #### Example -```Arduino -… +```arduino + // listen for BLE centrals to connect: BLEDevice central = BLE.central(); - // … + central.disconnect(); -… + ``` @@ -1193,13 +1193,13 @@ bleDevice.address() None -Returns +#### Returns The **Bluetooth address** of the BLE device (as a String). #### Example -```Arduino -… +```arduino + // listen for BLE peripherals to connect: BLEDevice central = BLE.central(); @@ -1209,9 +1209,9 @@ The **Bluetooth address** of the BLE device (as a String). // print the central's MAC address: Serial.println(central.address()); - // …. + . } -… + ``` @@ -1230,20 +1230,20 @@ bleDevice.rssi() None -Returns +#### Returns The **RSSI** of the connected BLE device, 127 if the BLE device is not connected. #### Example -```Arduino -… +```arduino + if (bleDevice.connected()) { - // … + Serial.print(“RSSI = “); Serial.println(bleDevice.rssi()); } -… + ``` @@ -1265,13 +1265,13 @@ bleDevice.characteristic(uuid, index) **index**: index of characteristic **uuid**: uuid (as a **String**) -Returns +#### Returns **BLECharacteristic** for provided parameters #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -1284,7 +1284,7 @@ Returns // start scanning for peripheral BLE.scan(); - // … + BLEDevice peripheral = BLE.available(); @@ -1320,7 +1320,7 @@ Returns // ... } -… + ``` @@ -1339,13 +1339,13 @@ bleDevice.discoverAttributes() None -Returns +#### Returns **true**, if successful, **false** on failure. #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -1358,7 +1358,7 @@ Returns // start scanning for peripheral BLE.scan(); - // … + BLEDevice peripheral = BLE.available(); @@ -1386,7 +1386,7 @@ Returns // ... } -… + ``` @@ -1405,13 +1405,13 @@ bleDevice.discoverService(serviceUuid) **serviceUuid:** service UUID to discover (as a **String**) -Returns +#### Returns **true**, if successful, **false** on failure. #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -1424,7 +1424,7 @@ Returns // start scanning for peripheral BLE.scan(); - // … + BLEDevice peripheral = BLE.available(); @@ -1452,7 +1452,7 @@ Returns // ... } -… + ``` @@ -1471,13 +1471,13 @@ bleDevice.deviceName() None -Returns +#### Returns **Device name** (as a String). #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -1490,7 +1490,7 @@ Returns // start scanning for peripheral BLE.scan(); - // … + BLEDevice peripheral = BLE.available(); @@ -1526,7 +1526,7 @@ Returns // ... } -… + ``` @@ -1545,13 +1545,13 @@ bleDevice.appearance() None -Returns +#### Returns **Appearance value** (as a number). #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -1564,7 +1564,7 @@ Returns // start scanning for peripheral BLE.scan(); - // … + BLEDevice peripheral = BLE.available(); @@ -1600,7 +1600,7 @@ Returns // ... } -… + ``` @@ -1619,13 +1619,13 @@ bleDevice.serviceCount() None -Returns +#### Returns The number of **services discovered** for the BLE device. #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -1638,7 +1638,7 @@ The number of **services discovered** for the BLE device. // start scanning for peripheral BLE.scan(); - // … + BLEDevice peripheral = BLE.available(); @@ -1671,7 +1671,7 @@ The number of **services discovered** for the BLE device. // ... } -… + ``` @@ -1692,13 +1692,13 @@ bleDevice.hasService(uuid, index) **uuid**: uuid to check (as a **String**) **index**: optional, index of service to check if the device provides more than on. Defaults to 0, if not provided. -Returns +#### Returns **true**, if the device provides the service, **false** otherwise. #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -1711,7 +1711,7 @@ Returns // start scanning for peripheral BLE.scan(); - // … + BLEDevice peripheral = BLE.available(); @@ -1743,7 +1743,7 @@ Returns // ... } -… + ``` @@ -1765,13 +1765,13 @@ bleDevice.service(uuid, index) **index**: index of service **uuid**: uuid (as a **String**) -Returns +#### Returns **BLEService** for provided parameters #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -1784,7 +1784,7 @@ Returns // start scanning for peripheral BLE.scan(); - // … + BLEDevice peripheral = BLE.available(); @@ -1820,7 +1820,7 @@ Returns // ... } -… + ``` @@ -1839,13 +1839,13 @@ bleDevice.characteristicCount() None -Returns +#### Returns The **number of characteristics** discovered for the BLE device. #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -1858,7 +1858,7 @@ The **number of characteristics** discovered for the BLE device. // start scanning for peripheral BLE.scan(); - // … + BLEDevice peripheral = BLE.available(); @@ -1891,7 +1891,7 @@ The **number of characteristics** discovered for the BLE device. // ... } -… + ``` @@ -1912,13 +1912,13 @@ bleDevice.hasCharacteristic(uuid, index) **uuid**: uuid to check (as a **String**) **index**: optional, index of characteristic to check if the device provides more than on. Defaults to 0, if not provided. -Returns +#### Returns **true**, if the device provides the characteristic, **false** otherwise. #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -1931,7 +1931,7 @@ Returns // start scanning for peripheral BLE.scan(); - // … + BLEDevice peripheral = BLE.available(); @@ -1963,7 +1963,7 @@ Returns // ... } -… + ``` @@ -1982,13 +1982,13 @@ bleDevice.hasLocalName() Nothing -Returns +#### Returns **true**, if the device is advertising a local name, **false** otherwise. #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -2001,7 +2001,7 @@ Returns // start scanning for peripheral BLE.scan(); - // … + BLEDevice peripheral = BLE.available(); @@ -2016,7 +2016,7 @@ Returns // ... } -… + ``` @@ -2036,13 +2036,13 @@ bleDevice.hasAdvertisedServiceUuid(index) **index**: optional, defaults to 0, the index of the service UUID, if the device is advertising more than one. -Returns +#### Returns **true**, if the device is advertising a service UUID, **false** otherwise. #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -2055,7 +2055,7 @@ Returns // start scanning for peripheral BLE.scan(); - // … + BLEDevice peripheral = BLE.available(); @@ -2074,7 +2074,7 @@ Returns // ... } -… + ``` @@ -2093,13 +2093,13 @@ bleDevice.advertisedServiceUuidCount() None -Returns +#### Returns The **number of advertised services** a discovered BLE device is advertising. #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -2112,7 +2112,7 @@ The **number of advertised services** a discovered BLE device is advertising. // start scanning for peripheral BLE.scan(); - // … + BLEDevice peripheral = BLE.available(); @@ -2131,7 +2131,7 @@ The **number of advertised services** a discovered BLE device is advertising. // ... } -… + ``` @@ -2150,13 +2150,13 @@ bleDevice.localName() Nothing -Returns +#### Returns **Advertised local name** (as a String). #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -2169,7 +2169,7 @@ Returns // start scanning for peripheral BLE.scan(); - // … + BLEDevice peripheral = BLE.available(); @@ -2184,7 +2184,7 @@ Returns // ... } -… + ``` @@ -2204,13 +2204,13 @@ bleDevice.advertisedServiceUuid(index) **index**: optional, defaults to 0, the index of the **service UUID**, if the device is advertising more than one. -Returns +#### Returns Advertised service **UUID** (as a String). #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -2223,7 +2223,7 @@ Advertised service **UUID** (as a String). // start scanning for peripheral BLE.scan(); - // … + BLEDevice peripheral = BLE.available(); @@ -2242,7 +2242,7 @@ Advertised service **UUID** (as a String). // ... } -… + ``` @@ -2261,13 +2261,13 @@ bleDevice.connect() None -Returns +#### Returns **true**, if the connection was successful, **false** otherwise. #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -2280,7 +2280,7 @@ Returns // start scanning for peripheral BLE.scan(); - // … + BLEDevice peripheral = BLE.available(); @@ -2298,7 +2298,7 @@ Returns // ... } -… + ``` @@ -2321,15 +2321,15 @@ BLEService(uuid) **uuid**: 16-bit or 128-bit UUID in **String** format -Returns +#### Returns New **BLEService** with the specified **UUID** #### Example -```Arduino -… +```arduino + BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // BLE LED Service -… + ``` @@ -2348,20 +2348,20 @@ bleService.uuid() None -Returns +#### Returns UUID of the BLE service as a **String**. #### Example -```Arduino -… +```arduino + BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // BLE LED Service -// … + Serial.print(“LED service UUID = “); Serial.println(ledService.uuid()); -… + ``` @@ -2380,25 +2380,25 @@ bleService.addCharacteristic(bleCharacteristic) None -Returns +#### Returns Nothing #### Example -```Arduino -… +```arduino + BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // BLE LED Service // BLE LED Switch Characteristic - custom 128-bit UUID, readable and writable by central BLECharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite, 1); -// … + // add the characteristic to the service ledService.addCharacteristic(switchCharacteristic); -… + ``` @@ -2417,13 +2417,13 @@ bleService.characteristicCount() None -Returns +#### Returns The **number of characteristics** discovered for the BLE service. #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -2436,7 +2436,7 @@ The **number of characteristics** discovered for the BLE service. // start scanning for peripheral BLE.scan(); - // … + BLEDevice peripheral = BLE.available(); @@ -2476,7 +2476,7 @@ The **number of characteristics** discovered for the BLE service. // ... } -… + ``` @@ -2497,13 +2497,13 @@ bleService.hasCharacteristic(uuid, index) **uuid**: uuid to check (as a **String**) **index**: optional, index of characteristic to check if the device provides more than on. Defaults to 0, if not provided. -Returns +#### Returns **true**, if the service provides the characteristic, **false** otherwise. #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -2516,7 +2516,7 @@ Returns // start scanning for peripheral BLE.scan(); - // … + BLEDevice peripheral = BLE.available(); if (peripheral) { @@ -2554,7 +2554,7 @@ Returns // ... } -… + ``` @@ -2576,13 +2576,13 @@ bleService.characteristic(uuid, index) **index**: index of characteristic **uuid**: uuid (as a **String**) -Returns +#### Returns **BLECharacteristic** for provided parameters #### Example -```Arduino -… +```arduino + // begin initialization if (!BLE.begin()) { Serial.println("starting BLE failed!"); @@ -2595,7 +2595,7 @@ Returns // start scanning for peripheral BLE.scan(); - // … + BLEDevice peripheral = BLE.available(); @@ -2638,7 +2638,7 @@ Returns // ... } -… + ``` @@ -2679,18 +2679,18 @@ BLEDoubleCharacteristic(uuid, properties) **valueSize**: (maximum) size of characteristic value **stringValue**: value as a string -Returns +#### Returns New **BLECharacteristic** with the specified **UUID** and value #### Example -```Arduino -… +```arduino + // BLE Battery Level Characteristic BLEUnsignedCharCharacteristic batteryLevelChar("2A19", // standard 16-bit characteristic UUID BLERead | BLENotify); // remote clients will be able to get notifications if this characteristic changes -… + ``` @@ -2709,21 +2709,21 @@ bleCharacteristic.uuid() None -Returns +#### Returns **UUID** of the BLE service as a **String**. #### Example -```Arduino -… +```arduino + // BLE LED Switch Characteristic - custom 128-bit UUID, read and writable by central BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); -// … + Serial.print(“Switch characteristic UUID = “); Serial.println(switchCharacteristic.uuid()); -… + ``` @@ -2742,17 +2742,17 @@ bleCharacteristic.properties() None -Returns +#### Returns **Properties of the characteristic masked** (BLEBroadcast, BLERead, BLEWriteWithoutResponse, BLEWrite, BLENotify, BLEIndicate) #### Example -```Arduino -… +```arduino + // BLE LED Switch Characteristic - custom 128-bit UUID, read and writable by central BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); -// … + byte properties = switchCharacteristic.properties(); if (properties & BLERead) { @@ -2762,7 +2762,7 @@ if (properties & BLERead) { if (properties & (BLEWrite | BLEWriteWithoutResponse)) { // characteristic is writable ... } -… + ``` @@ -2781,21 +2781,21 @@ bleCharacteristic.valueSize() None -Returns +#### Returns The **maximum value** size of the characteristic (in bytes) #### Example -```Arduino -… +```arduino + // BLE LED Switch Characteristic - custom 128-bit UUID, read and writable by central BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); -// … + Serial.print(“value size = “); Serial.println(switchCharacteristic.valueSize()); -… + ``` @@ -2814,17 +2814,17 @@ bleCharacteristic.value() None -Returns +#### Returns The **current value** of the characteristic, value type depends on the constructor used #### Example -```Arduino -… +```arduino + // BLE LED Switch Characteristic - custom 128-bit UUID, read and writable by central BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); -// … + if (switchCharacteristic.value()) { // any value other than 0 Serial.println("LED on"); @@ -2834,7 +2834,7 @@ BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214 digitalWrite(ledPin, LOW); // will turn the LED off } -… + ``` @@ -2853,21 +2853,21 @@ bleCharacteristic.valueLength() None -Returns +#### Returns The **current value** size of the characteristic (in bytes) #### Example -```Arduino -… +```arduino + // BLE LED Switch Characteristic - custom 128-bit UUID, read and writable by central BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); -// … + Serial.print(“value length = “); Serial.println(switchCharacteristic.valueLength()); -… + ``` @@ -2888,13 +2888,13 @@ bleCharacteristic.readValue(value) **buffer:** byte array to read value into length: size of buffer argument in bytes **value**: variable to read value into (by reference) -Returns +#### Returns Number of bytes read #### Example -```Arduino -… +```arduino + while (peripheral.connected()) { // while the peripheral is connected @@ -2916,7 +2916,7 @@ Number of bytes read } } } -… + ``` @@ -2938,13 +2938,13 @@ bleCharacteristic.writeValue(value) **length**: number of bytes of the buffer argument to write **value**: value to write -Returns +#### Returns 1 on success, 0 on failure #### Example -```Arduino -… +```arduino + // read the button pin int buttonState = digitalRead(buttonPin); @@ -2964,7 +2964,7 @@ Returns ledCharacteristic.writeValue((byte)0x00); } } -… + ``` @@ -2984,23 +2984,23 @@ bleCharacteristic.setEventHandler(eventType, callback) **eventType**: event type (BLESubscribed, BLEUnsubscribed, BLERead, BLEWritten) **callback**: function to call when the event occurs -Returns +#### Returns Nothing #### Example -```Arduino -… +```arduino + // create switch characteristic and allow remote device to read and write BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); -// … + // assign event handlers for characteristic switchCharacteristic.setEventHandler(BLEWritten, switchCharacteristicWritten); -// … + void switchCharacteristicWritten(BLEDevice central, BLECharacteristic characteristic) { // central wrote new value to characteristic, update LED @@ -3015,7 +3015,7 @@ void switchCharacteristicWritten(BLEDevice central, BLECharacteristic characteri } } - … + ``` @@ -3034,21 +3034,21 @@ bleCharacteristic.broadcast() None -Returns +#### Returns 1 on success, 0 on failure #### Example -```Arduino -… +```arduino + // create button characteristic and allow remote device to get notifications BLEByteCharacteristic buttonCharacteristic("19B10012-E8F2-537E-4F6C-D104768A1214", BLERead | BLENotify | BLEBroadcast); -// … + buttonCharacteristic.broadcast(); -… + ``` @@ -3067,18 +3067,18 @@ bleCharacteristic.written() None -Returns +#### Returns **true** if the characteristic value has been written by another BLE device, **false** otherwise #### Example -```Arduino -… +```arduino + // BLE LED Switch Characteristic - custom 128-bit UUID, read and writable by central BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); -// … + // listen for BLE peripherals to connect: BLEDevice central = BLE.central(); @@ -3110,7 +3110,7 @@ BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214 } -… + ``` @@ -3129,26 +3129,26 @@ bleCharacteristic.subscribed() None -Returns +#### Returns **true** if the characteristic value has been subscribed to by another BLE device, **false** otherwise #### Example -```Arduino -… +```arduino + // BLE Battery Level Characteristic BLEUnsignedCharCharacteristic batteryLevelChar("2A19", // standard 16-bit characteristic UUID BLERead | BLENotify); // remote clients will be able to get notifications if this characteristic changes -// … + if (batteryLevelChar.subscribed()) { // set a new value , that well be pushed to subscribed BLE devices batteryLevelChar.writeValue(0xab); } -… + ``` @@ -3167,13 +3167,13 @@ bleCharacteristic.addDescriptor(bleDescriptor) **bleDescriptor**: descriptor to add to the characteristic -Returns +#### Returns Nothing #### Example -```Arduino -… +```arduino + // BLE Battery Level Characteristic BLEUnsignedCharCharacteristic batteryLevelChar("2A19", // standard 16-bit characteristic UUID BLERead | BLENotify); // remote clients will be able to get notifications if this characteristic changes @@ -3182,10 +3182,10 @@ BLEDescriptor batteryLevelDescriptor("2901", "millis"); -// … + batteryLevelChar.addDescriptor(batteryLevelDescriptor); -… + ``` @@ -3204,20 +3204,20 @@ bleCharacteristic.descriptorCount() None -Returns +#### Returns The **number of BLE descriptors** discovered for the characteristic #### Example -```Arduino -… +```arduino + // loop the descriptors of the characteristic and explore each for (int i = 0; i < characteristic.descriptorCount(); i++) { BLEDescriptor descriptor = characteristic.descriptor(i); // ... } -… + ``` @@ -3238,17 +3238,17 @@ bleCharacteristic.hasDescriptor(uuid, index) **index**: index of descriptor **uuid**: uuid (as a **String**) -Returns +#### Returns **true**, if the characteristic has a matching descriptor, otherwise **false**. #### Example -```Arduino -… +```arduino + if (characteristic.hasDescriptor("2901")) { Serial.println("characteristic has description descriptor"); } -… + ``` @@ -3270,17 +3270,17 @@ bleCharacteristic.descriptor(uuid, index) **index**: index of descriptor **uuid**: uuid (as a **String**) -Returns +#### Returns BLEDescriptor that represents a characteristics BLE descriptor #### Example -```Arduino -… +```arduino + if (characteristic.hasDescriptor("2901")) { Serial.println("characteristic has description descriptor"); } -… + ``` @@ -3299,17 +3299,17 @@ bleCharacteristic.canRead() None -Returns +#### Returns **true**, if characteristic is readable, **false** otherwise #### Example -```Arduino -… +```arduino + if (characteristic.canRead("2901")) { Serial.println("characteristic is readable"); } -… + ``` @@ -3328,13 +3328,13 @@ bleCharacteristic.read() None -Returns +#### Returns **true**, if successful, **false** on failure #### Example -```Arduino -… +```arduino + if (characteristic.read()) { Serial.println("characteristic value read"); @@ -3342,7 +3342,7 @@ Returns } else { Serial.println("error reading characteristic value"); } -… + ``` @@ -3361,17 +3361,17 @@ bleCharacteristic.canWrite() None -Returns +#### Returns **true**, if characteristic is writable, **false** otherwise #### Example -```Arduino -… +```arduino + if (characteristic.canWrite()) { Serial.println("characteristic is writable"); } -… + ``` @@ -3390,17 +3390,17 @@ bleCharacteristic.canSubscribe() None -Returns +#### Returns **true**, if characteristic is subscribable, **false** otherwise #### Example -```Arduino -… +```arduino + if (characteristic.canSubscribe()) { Serial.println("characteristic is subscribable"); } -… + ``` @@ -3419,13 +3419,13 @@ bleCharacteristic.subscribe() None -Returns +#### Returns **true**, on success, **false** on failure #### Example -```Arduino -… +```arduino + // ... // retrieve the simple key characteristic @@ -3448,7 +3448,7 @@ Returns } // ... -… + ``` @@ -3467,17 +3467,17 @@ bleCharacteristic.canUnsubscribe() None -Returns +#### Returns **true**, if characteristic is unsubscribable, **false** otherwise #### Example -```Arduino -… +```arduino + if (characteristic.canUnsubscribe()) { Serial.println("characteristic is unsubscribable"); } -… + ``` @@ -3496,13 +3496,13 @@ bleCharacteristic.unsubscribe() None -Returns +#### Returns **true**, on success, **false** on failure #### Example -```Arduino -… +```arduino + // ... // retrieve the simple key characteristic @@ -3527,7 +3527,7 @@ Returns // ... simpleKeyCharacteristic.unsubscribe(); -… + ``` @@ -3546,13 +3546,13 @@ bleCharacteristic.valueUpdated() None -Returns +#### Returns **true**, if the characteristics value been updated via a notification or indication #### Example -```Arduino -… +```arduino + while (peripheral.connected()) { // while the peripheral is connected @@ -3574,7 +3574,7 @@ Returns } } } -… + ``` @@ -3601,15 +3601,15 @@ BLEDescriptor(uuid, stringValue) **valueSize**: size of byte array value **stringValue**: value as a string -Returns +#### Returns New **BLEDescriptor** with the specified **UUID** and value #### Example -```Arduino -… +```arduino + BLEDescriptor millisLabelDescriptor("2901", "millis"); -… + ``` @@ -3628,20 +3628,20 @@ bleDescriptor.uuid() None -Returns +#### Returns **UUID** of the BLE descriptor (as a String). #### Example -```Arduino -… +```arduino + BLEDescriptor millisLabelDescriptor("2901", "millis"); -// … + Serial.print(“millis label descriptor UUID = “); Serial.println(millisLabelDescriptor.uuid()); -… + ``` @@ -3660,20 +3660,20 @@ bleDescriptor.valueSize() None -Returns +#### Returns **Value size** (in bytes) of the BLE descriptor. #### Example -```Arduino -… +```arduino + BLEDescriptor millisLabelDescriptor("2901", "millis"); -// … + Serial.print(“millis label descriptor value size = “); Serial.println(millisLabelDescriptor.valueSize()); -… + ``` @@ -3692,13 +3692,13 @@ bleDescriptor.valueLength() None -Returns +#### Returns **Length of descriptor** value in bytes. #### Example -```Arduino -… +```arduino + // read the descriptor value descriptor.read(); @@ -3719,7 +3719,7 @@ Returns Serial.print(b, HEX); } } -… + ``` @@ -3738,16 +3738,16 @@ bleDescriptor.value() None -Returns +#### Returns Value byte array of the **BLE descriptor**. #### Example -```Arduino -… +```arduino + BLEDescriptor millisLabelDescriptor("2901", "millis"); -// … + int descriptorValueSize = millisLabelDescriptor.valueSize(); byte descriptorValue[descriptorValueSize]; @@ -3756,7 +3756,7 @@ BLEDescriptor millisLabelDescriptor("2901", "millis"); descriptorValue[i] = millisLabelDescriptor.value()[i]; } -… + ``` @@ -3778,19 +3778,19 @@ bleDescriptor.readValue(value) **length**: size of buffer argument in bytes **value**: variable to read value into (by reference) -Returns +#### Returns **Number of bytes** read #### Example -```Arduino -… +```arduino + byte value = 0; /get the value, descriptor is 1 byte so use byte value descriptor.readValue(value); -… + ``` @@ -3809,13 +3809,13 @@ bleDescriptor.read() None -Returns +#### Returns **true**, if successful, **false** on failure #### Example -```Arduino -… +```arduino + if (descriptor.read()) { Serial.println("descriptor value read"); @@ -3823,5 +3823,5 @@ Returns } else { Serial.println("error reading descriptor value"); } -… + ``` From 236aeda3009545d9efa540b9b992843449d9a5a6 Mon Sep 17 00:00:00 2001 From: Andrea Richetta Date: Mon, 30 Aug 2021 10:27:39 +0200 Subject: [PATCH 23/83] updated library properties and readme added mbed_nicla as compatible architecture to avoid warning during compilation. updated readme adding compatibility with Nicla Sense ME --- .gitignore | 2 ++ docs/readme.md | 2 +- library.properties | 4 ++-- 3 files changed, 5 insertions(+), 3 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..9bea4330 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ + +.DS_Store diff --git a/docs/readme.md b/docs/readme.md index 86949a50..e9e36fc3 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -1,6 +1,6 @@ # ArduinoBLE library -This library supports all the Arduino boards that have the hardware enabled for BLE and Bluetooth 4.0 and above; these include Nano 33 BLE, Arduino NANO 33 IoT, Uno WiFi Rev 2, MKR WiFi 1010. +This library supports all the Arduino boards that have the hardware enabled for BLE and Bluetooth 4.0 and above; these include Nano 33 BLE, Arduino NANO 33 IoT, Uno WiFi Rev 2, MKR WiFi 1010, Nicla Sense ME. To use this library ``#include `` diff --git a/library.properties b/library.properties index b6d464cc..601474c6 100644 --- a/library.properties +++ b/library.properties @@ -2,9 +2,9 @@ name=ArduinoBLE version=1.2.1 author=Arduino maintainer=Arduino -sentence=Enables BLE connectivity on the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, Arduino Nano 33 IoT, and Arduino Nano 33 BLE. +sentence=Enables BLE connectivity on the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, Arduino Nano 33 IoT, Arduino Nano 33 BLE and Nicla Sense ME. paragraph=This library supports creating a BLE peripheral and BLE central mode. category=Communication url=https://www.arduino.cc/en/Reference/ArduinoBLE -architectures=samd,megaavr,mbed,apollo3,mbed_nano,mbed_portenta +architectures=samd,megaavr,mbed,apollo3,mbed_nano,mbed_portenta,mbed_nicla includes=ArduinoBLE.h From b15524683d8d0f66095e97f2ae1cbdaa08425918 Mon Sep 17 00:00:00 2001 From: Lukas Kvasnica Date: Wed, 8 Dec 2021 07:56:49 +0100 Subject: [PATCH 24/83] fix of bad indexing in ATTClass::handleNotifyOrInd which affected BLE in central mode --- src/utility/ATT.cpp | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/utility/ATT.cpp b/src/utility/ATT.cpp index a1028f76..bca006c5 100644 --- a/src/utility/ATT.cpp +++ b/src/utility/ATT.cpp @@ -1359,14 +1359,14 @@ void ATTClass::handleNotifyOrInd(uint16_t connectionHandle, uint8_t opcode, uint uint16_t handle; } *handleNotifyOrInd = (HandleNotifyOrInd*)data; - uint8_t handle = handleNotifyOrInd->handle; + uint16_t handle = handleNotifyOrInd->handle; - for (int i = 0; i < ATT_MAX_PEERS; i++) { - if (_peers[i].connectionHandle != connectionHandle) { + for (int peer = 0; peer < ATT_MAX_PEERS; peer++) { + if (_peers[peer].connectionHandle != connectionHandle) { continue; } - BLERemoteDevice* device = _peers[i].device; + BLERemoteDevice* device = _peers[peer].device; if (!device) { break; @@ -1384,7 +1384,7 @@ void ATTClass::handleNotifyOrInd(uint16_t connectionHandle, uint8_t opcode, uint BLERemoteCharacteristic* c = s->characteristic(j); if (c->valueHandle() == handle) { - c->writeValue(BLEDevice(_peers[i].addressType, _peers[i].address), &data[2], dlen - 2); + c->writeValue(BLEDevice(_peers[peer].addressType, _peers[peer].address), &data[2], dlen - 2); } } From c8de77559a95aca5a022e1bde7936a01223afd7b Mon Sep 17 00:00:00 2001 From: Frederic Pillon Date: Tue, 14 Dec 2021 13:13:38 +0100 Subject: [PATCH 25/83] Replace boolean with standard bool (#42) https://github.com/arduino/Arduino/issues/4673 Signed-off-by: Frederic Pillon --- examples/Peripheral/ButtonLED/ButtonLED.ino | 2 +- src/BLETypedCharacteristics.h | 2 +- src/utility/ATT.cpp | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/examples/Peripheral/ButtonLED/ButtonLED.ino b/examples/Peripheral/ButtonLED/ButtonLED.ino index bd373731..659d466a 100644 --- a/examples/Peripheral/ButtonLED/ButtonLED.ino +++ b/examples/Peripheral/ButtonLED/ButtonLED.ino @@ -72,7 +72,7 @@ void loop() { char buttonValue = digitalRead(buttonPin); // has the value changed since the last read - boolean buttonChanged = (buttonCharacteristic.value() != buttonValue); + bool buttonChanged = (buttonCharacteristic.value() != buttonValue); if (buttonChanged) { // button state changed, update characteristics diff --git a/src/BLETypedCharacteristics.h b/src/BLETypedCharacteristics.h index 465fc046..8bd98c78 100644 --- a/src/BLETypedCharacteristics.h +++ b/src/BLETypedCharacteristics.h @@ -27,7 +27,7 @@ class BLEBoolCharacteristic : public BLETypedCharacteristic { BLEBoolCharacteristic(const char* uuid, unsigned char properties); }; -class BLEBooleanCharacteristic : public BLETypedCharacteristic { +class BLEBooleanCharacteristic : public BLETypedCharacteristic { public: BLEBooleanCharacteristic(const char* uuid, unsigned char properties); }; diff --git a/src/utility/ATT.cpp b/src/utility/ATT.cpp index bca006c5..5e298081 100644 --- a/src/utility/ATT.cpp +++ b/src/utility/ATT.cpp @@ -1143,7 +1143,7 @@ void ATTClass::readByTypeResp(uint16_t connectionHandle, uint8_t dlen, uint8_t d void ATTClass::writeReqOrCmd(uint16_t connectionHandle, uint16_t mtu, uint8_t op, uint8_t dlen, uint8_t data[]) { - boolean withResponse = (op == ATT_OP_WRITE_REQ); + bool withResponse = (op == ATT_OP_WRITE_REQ); if (dlen < sizeof(uint16_t)) { if (withResponse) { From 14596d4154f5394214bb984fa17953401467bcf6 Mon Sep 17 00:00:00 2001 From: Alexander Entinger Date: Tue, 14 Dec 2021 13:15:24 +0100 Subject: [PATCH 26/83] Adding sync-labels workflow for sharing one set of labels across all repos. (#212) --- .github/workflows/sync-labels.yml | 138 ++++++++++++++++++++++++++++++ 1 file changed, 138 insertions(+) create mode 100644 .github/workflows/sync-labels.yml diff --git a/.github/workflows/sync-labels.yml b/.github/workflows/sync-labels.yml new file mode 100644 index 00000000..fe53570f --- /dev/null +++ b/.github/workflows/sync-labels.yml @@ -0,0 +1,138 @@ +# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/sync-labels.md +name: Sync Labels + +# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +on: + push: + paths: + - ".github/workflows/sync-labels.ya?ml" + - ".github/label-configuration-files/*.ya?ml" + pull_request: + paths: + - ".github/workflows/sync-labels.ya?ml" + - ".github/label-configuration-files/*.ya?ml" + schedule: + # Run daily at 8 AM UTC to sync with changes to shared label configurations. + - cron: "0 8 * * *" + workflow_dispatch: + repository_dispatch: + +env: + CONFIGURATIONS_FOLDER: .github/label-configuration-files + CONFIGURATIONS_ARTIFACT: label-configuration-files + +jobs: + check: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + - name: Download JSON schema for labels configuration file + id: download-schema + uses: carlosperate/download-file-action@v1.0.3 + with: + file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/arduino-tooling-gh-label-configuration-schema.json + location: ${{ runner.temp }}/label-configuration-schema + + - name: Install JSON schema validator + run: | + sudo npm install \ + --global \ + ajv-cli \ + ajv-formats + + - name: Validate local labels configuration + run: | + # See: https://github.com/ajv-validator/ajv-cli#readme + ajv validate \ + --all-errors \ + -c ajv-formats \ + -s "${{ steps.download-schema.outputs.file-path }}" \ + -d "${{ env.CONFIGURATIONS_FOLDER }}/*.{yml,yaml}" + + download: + needs: check + runs-on: ubuntu-latest + + strategy: + matrix: + filename: + # Filenames of the shared configurations to apply to the repository in addition to the local configuration. + # https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/sync-labels + - universal.yml + + steps: + - name: Download + uses: carlosperate/download-file-action@v1.0.3 + with: + file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/${{ matrix.filename }} + + - name: Pass configuration files to next job via workflow artifact + uses: actions/upload-artifact@v2 + with: + path: | + *.yaml + *.yml + if-no-files-found: error + name: ${{ env.CONFIGURATIONS_ARTIFACT }} + + sync: + needs: download + runs-on: ubuntu-latest + + steps: + - name: Set environment variables + run: | + # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable + echo "MERGED_CONFIGURATION_PATH=${{ runner.temp }}/labels.yml" >> "$GITHUB_ENV" + + - name: Determine whether to dry run + id: dry-run + if: > + github.event_name == 'pull_request' || + ( + ( + github.event_name == 'push' || + github.event_name == 'workflow_dispatch' + ) && + github.ref != format('refs/heads/{0}', github.event.repository.default_branch) + ) + run: | + # Use of this flag in the github-label-sync command will cause it to only check the validity of the + # configuration. + echo "::set-output name=flag::--dry-run" + + - name: Checkout repository + uses: actions/checkout@v2 + + - name: Download configuration files artifact + uses: actions/download-artifact@v2 + with: + name: ${{ env.CONFIGURATIONS_ARTIFACT }} + path: ${{ env.CONFIGURATIONS_FOLDER }} + + - name: Remove unneeded artifact + uses: geekyeggo/delete-artifact@v1 + with: + name: ${{ env.CONFIGURATIONS_ARTIFACT }} + + - name: Merge label configuration files + run: | + # Merge all configuration files + shopt -s extglob + cat "${{ env.CONFIGURATIONS_FOLDER }}"/*.@(yml|yaml) > "${{ env.MERGED_CONFIGURATION_PATH }}" + + - name: Install github-label-sync + run: sudo npm install --global github-label-sync + + - name: Sync labels + env: + GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + # See: https://github.com/Financial-Times/github-label-sync + github-label-sync \ + --labels "${{ env.MERGED_CONFIGURATION_PATH }}" \ + ${{ steps.dry-run.outputs.flag }} \ + ${{ github.repository }} From af4d848a7fbab355f3be1e12f5e45462f0b889ce Mon Sep 17 00:00:00 2001 From: per1234 Date: Mon, 20 Dec 2021 04:57:32 -0800 Subject: [PATCH 27/83] Use major version ref of `carlosperate/download-file-action` (#215) The `carlosperate/download-file-action` action is used in the GitHub Actions workflows as a convenient way to download external resources. A major version ref has been added to that repository. It will always point to the latest release of the "1" major version series. This means it is no longer necessary to do a full pin of the action version in use as before. Use of the major version ref will cause the workflow to use a stable version of the action, while also benefiting from ongoing development to the action up until such time as a new major release of an action is made. At that time we would need to evaluate whether any changes to the workflow are required by the breaking change that triggered the major release before manually updating the major ref (e.g., uses: `carlosperate/download-file-action@v2`). I think this approach strikes the right balance between stability and maintainability for these workflows. --- .github/workflows/sync-labels.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/sync-labels.yml b/.github/workflows/sync-labels.yml index fe53570f..3ee6febd 100644 --- a/.github/workflows/sync-labels.yml +++ b/.github/workflows/sync-labels.yml @@ -31,7 +31,7 @@ jobs: - name: Download JSON schema for labels configuration file id: download-schema - uses: carlosperate/download-file-action@v1.0.3 + uses: carlosperate/download-file-action@v1 with: file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/arduino-tooling-gh-label-configuration-schema.json location: ${{ runner.temp }}/label-configuration-schema @@ -65,7 +65,7 @@ jobs: steps: - name: Download - uses: carlosperate/download-file-action@v1.0.3 + uses: carlosperate/download-file-action@v1 with: file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/${{ matrix.filename }} From 95b24499a0946994ee5fe2eab6eec15c87c6fc76 Mon Sep 17 00:00:00 2001 From: per1234 Date: Mon, 20 Dec 2021 04:59:05 -0800 Subject: [PATCH 28/83] Configure Dependabot to check for outdated actions used in workflows (#216) Dependabot will periodically check the versions of all actions used in the repository's workflows. If any are found to be outdated, it will submit a pull request to update them. NOTE: Dependabot's PRs will occasionally propose to pin to the patch version of the action (e.g., updating `uses: foo/bar@v1` to `uses: foo/bar@v2.3.4`). When the action author has provided a major version ref, use that instead (e.g., `uses: foo/bar@v2`). Dependabot will automatically close its PR once the workflow has been updated. More information: https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot --- .github/dependabot.yml | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 .github/dependabot.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 00000000..f2bfa724 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,13 @@ +# See: https://docs.github.com/en/code-security/supply-chain-security/configuration-options-for-dependency-updates#about-the-dependabotyml-file +version: 2 + +updates: + # Configure check for outdated GitHub Actions actions in workflows. + # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/dependabot/README.md + # See: https://docs.github.com/en/code-security/supply-chain-security/keeping-your-actions-up-to-date-with-dependabot + - package-ecosystem: github-actions + directory: / # Check the repository's workflows under /.github/workflows/ + schedule: + interval: daily + labels: + - "topic: infrastructure" From 8d4d1dcca552f33871181fa18f6558b016ab16a2 Mon Sep 17 00:00:00 2001 From: BBear <13687227078@163.com> Date: Wed, 22 Dec 2021 13:52:58 +0800 Subject: [PATCH 29/83] fix potential arrary overflow problem of _recvBuffer (#214) * fix potential arrary overflow problem of _recvBuffer * Update src/utility/HCI.cpp make the code eaiser to read Co-authored-by: Alexander Entinger * optimize code of potential overflow _recvBuffer * add the debug msg when the _recvBuffer overflow Co-authored-by: Alexander Entinger --- src/utility/HCI.cpp | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/utility/HCI.cpp b/src/utility/HCI.cpp index 233dd1a5..f158d035 100644 --- a/src/utility/HCI.cpp +++ b/src/utility/HCI.cpp @@ -112,6 +112,13 @@ void HCIClass::poll(unsigned long timeout) while (HCITransport.available()) { byte b = HCITransport.read(); + + if (_recvIndex >= sizeof(_recvBuffer)) { + _recvIndex = 0; + if (_debug) { + _debug->println("_recvBuffer overflow"); + } + } _recvBuffer[_recvIndex++] = b; From ed61a17cbbffafb3dc77cfd0d70ad7da46c5c9cc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Karl=20S=C3=B6derby?= <35461661+karlsoderby@users.noreply.github.com> Date: Wed, 23 Feb 2022 16:27:14 +0100 Subject: [PATCH 30/83] Bluetooth trademark fix --- README.md | 4 +- docs/api.md | 279 +++++++++--------- docs/readme.md | 24 +- examples/Central/LedControl/LedControl.ino | 8 +- .../PeripheralExplorer/PeripheralExplorer.ino | 6 +- examples/Central/Scan/Scan.ino | 6 +- .../Central/ScanCallback/ScanCallback.ino | 6 +- .../SensorTagButton/SensorTagButton.ino | 6 +- .../BatteryMonitor/BatteryMonitor.ino | 20 +- examples/Peripheral/ButtonLED/ButtonLED.ino | 10 +- .../Peripheral/CallbackLED/CallbackLED.ino | 10 +- examples/Peripheral/LED/LED.ino | 12 +- library.properties | 4 +- 13 files changed, 198 insertions(+), 197 deletions(-) diff --git a/README.md b/README.md index b2f649ca..9ec934a3 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ [![Compile Examples Status](https://github.com/arduino-libraries/ArduinoBLE/workflows/Compile%20Examples/badge.svg)](https://github.com/arduino-libraries/ArduinoBLE/actions?workflow=Compile+Examples) [![Spell Check Status](https://github.com/arduino-libraries/ArduinoBLE/workflows/Spell%20Check/badge.svg)](https://github.com/arduino-libraries/ArduinoBLE/actions?workflow=Spell+Check) -Enables BLE connectivity on the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, Arduino Nano 33 IoT, and Arduino Nano 33 BLE. +Enables Bluetooth® Low Energy connectivity on the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, Arduino Nano 33 IoT, and Arduino Nano 33 BLE. -This library supports creating a BLE peripheral and BLE central mode. +This library supports creating a Bluetooth® Low Energy peripheral & central mode. For the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, and Arduino Nano 33 IoT boards, it requires the NINA module to be running [Arduino NINA-W102 firmware](https://github.com/arduino/nina-fw) v1.2.0 or later. diff --git a/docs/api.md b/docs/api.md index dab294ab..df285806 100644 --- a/docs/api.md +++ b/docs/api.md @@ -2,11 +2,11 @@ ## BLE class -Used to enable the BLE module. +Used to enable the Bluetooth® Low Energy module. ### `begin()` -Initializes the BLE device. +Initializes the Bluetooth® Low Energy device. #### Syntax @@ -28,7 +28,7 @@ None // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -38,7 +38,7 @@ None ### `end()` -Stops the BLE device. +Stops the Bluetooth® Low Energy device. #### Syntax @@ -60,7 +60,7 @@ Nothing // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -74,12 +74,13 @@ Nothing ### `poll()` -Poll for BLE radio events and handle them. +Poll for Bluetooth® Low Energy radio events and handle them. #### Syntax ``` -BLE.poll() BLE.poll(timeout) +BLE.poll() +BLE.poll(timeout) ``` @@ -129,7 +130,7 @@ Nothing. // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -160,7 +161,7 @@ void blePeripheralDisconnectHandler(BLEDevice central) { ### `connected()` -Query if another BLE device is connected +Query if another Bluetooth® Low Energy device is connected #### Syntax @@ -174,7 +175,7 @@ BLE.connected() None #### Returns -**true** if another BLE device is connected, otherwise **false**. +**true** if another Bluetooth® Low Energy device is connected, otherwise **false**. #### Example @@ -191,7 +192,7 @@ None ### `disconnect()` -Disconnect any BLE devices that are connected +Disconnect any Bluetooth® Low Energy devices that are connected #### Syntax @@ -205,7 +206,7 @@ BLE.disconnect() None #### Returns -**true** if any BLE device that was previously connected was disconnected, otherwise **false**. +**true** if any Bluetooth® Low Energy device that was previously connected was disconnected, otherwise **false**. #### Example @@ -222,7 +223,7 @@ None ### `address()` -Query the Bluetooth address of the BLE device. +Query the Bluetooth® address of the Bluetooth® Low Energy device. #### Syntax @@ -236,7 +237,7 @@ BLE.address() None #### Returns -The **Bluetooth address** of the BLE device (as a String). +The **Bluetooth® address** of the Bluetooth® Low Energy device (as a String). #### Example @@ -252,7 +253,7 @@ The **Bluetooth address** of the BLE device (as a String). ### `rssi()` -Query the RSSI (Received signal strength indication) of the connected BLE device. +Query the RSSI (Received signal strength indication) of the connected Bluetooth® Low Energy device. #### Syntax @@ -266,7 +267,7 @@ BLE.rssi() None #### Returns -The **RSSI** of the connected BLE device, 127 if no BLE device is connected. +The **RSSI** of the connected Bluetooth® Low Energy device, 127 if no Bluetooth® Low Energy device is connected. #### Example @@ -295,7 +296,7 @@ BLE.setAdvertisedServiceUuid(uuid) #### Parameters -**uuid:** 16-bit or 128-bit BLE UUID in **String** format +**uuid:** 16-bit or 128-bit Bluetooth® Low Energy UUID in **String** format #### Returns Nothing @@ -306,7 +307,7 @@ Nothing // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -343,13 +344,13 @@ Nothing ```arduino -BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // BLE LED Service +BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // Bluetooth® Low Energy LED Service // ... // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -389,7 +390,7 @@ Nothing // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -431,7 +432,7 @@ Nothing // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -471,7 +472,7 @@ Nothing // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -511,7 +512,7 @@ Nothing // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -529,7 +530,7 @@ Nothing ### `addService()` -Add a BLEService to the set of services the BLE device provides +Add a BLEService to the set of services the Bluetooth® Low Energy device provides #### Syntax @@ -549,13 +550,13 @@ Nothing ```arduino -BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // BLE LED Service +BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // Bluetooth® Low Energy LED Service // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -593,7 +594,7 @@ None // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -631,7 +632,7 @@ Nothing // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -649,7 +650,7 @@ Nothing ### `central()` -Query the central BLE device connected. +Query the central Bluetooth® Low Energy device connected. #### Syntax @@ -669,7 +670,7 @@ None ```arduino - // listen for BLE peripherals to connect: + // listen for Bluetooth® Low Energy peripherals to connect: BLEDevice central = BLE.central(); // if a central is connected to peripheral: @@ -708,7 +709,7 @@ Nothing. // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -747,7 +748,7 @@ Nothing. // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -785,7 +786,7 @@ Nothing. // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -800,7 +801,7 @@ Nothing. ### `scan()` -Start scanning for BLE devices that are advertising. +Start scanning for Bluetooth® Low Energy devices that are advertising. #### Syntax @@ -823,7 +824,7 @@ BLE.scan(withDuplicates) // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -846,7 +847,7 @@ BLE.scan(withDuplicates) ### `scanForName()` -Start scanning for BLE devices that are advertising with a particular (local) name. +Start scanning for Bluetooth® Low Energy devices that are advertising with a particular (local) name. #### Syntax @@ -870,7 +871,7 @@ BLE.scanForName(name, withDuplicates) // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -893,7 +894,7 @@ BLE.scanForName(name, withDuplicates) ### `scanForAddress()` -Start scanning for BLE devices that are advertising with a particular (Bluetooth) address. +Start scanning for Bluetooth® Low Energy devices that are advertising with a particular (Bluetooth®) address. #### Syntax @@ -905,7 +906,7 @@ BLE.scanForAddress(address, withDuplicates) #### Parameters -**address:** (Bluetooth) address (as a String) to filter for +**address:** (Bluetooth®) address (as a String) to filter for **withDuplicates:** optional, defaults to **false**. If **true**, advertisements received more than once will not be filtered #### Returns @@ -917,7 +918,7 @@ BLE.scanForAddress(address, withDuplicates) // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -940,7 +941,7 @@ BLE.scanForAddress(address, withDuplicates) ### `scanForUuid()` -Start scanning for BLE devices that are advertising with a particular (service) UUID. +Start scanning for Bluetooth® Low Energy devices that are advertising with a particular (service) UUID. #### Syntax @@ -964,7 +965,7 @@ BLE.scanForUuid(uuid, withDuplicates) // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -987,7 +988,7 @@ BLE.scanForUuid(uuid, withDuplicates) ### `stopScan()` -Stop scanning for BLE devices that are advertising. +Stop scanning for Bluetooth® Low Energy devices that are advertising. #### Syntax @@ -1009,7 +1010,7 @@ Nothing // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -1027,7 +1028,7 @@ Nothing ### `available()` -Query for a discovered BLE device that was found during scanning. +Query for a discovered Bluetooth® Low Energy device that was found during scanning. #### Syntax @@ -1049,7 +1050,7 @@ Nothing // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -1076,7 +1077,7 @@ Used to get information about the devices connected or discovered while scanning ### `poll()` -Poll for BLE radio events for the specified BLE device and handle them. +Poll for Bluetooth® Low Energy radio events for the specified Bluetooth® Low Energy device and handle them. #### Syntax @@ -1097,7 +1098,7 @@ Nothing ```arduino - // listen for BLE centrals to connect: + // listen for Bluetooth® Low Energy centrals to connect: BLEDevice central = BLE.central(); // if a central is connected to peripheral: @@ -1114,7 +1115,7 @@ Nothing ### `connected()` -Query if a BLE device is connected +Query if a Bluetooth® Low Energy device is connected #### Syntax @@ -1128,13 +1129,13 @@ bleDevice.connected() None #### Returns -**true** if the BLE device is connected, otherwise **false**. +**true** if the Bluetooth® Low Energy device is connected, otherwise **false**. #### Example ```arduino - // listen for BLE centrals to connect: + // listen for Bluetooth® Low Energy centrals to connect: BLEDevice central = BLE.central(); // while the central is still connected @@ -1148,7 +1149,7 @@ None ### `disconnect()` -Disconnect the BLE device, if connected +Disconnect the Bluetooth® Low Energy device, if connected #### Syntax @@ -1162,13 +1163,13 @@ bleDevice.disconnect() None #### Returns -**true** if the BLE device was disconnected, otherwise **false**. +**true** if the Bluetooth® Low Energy device was disconnected, otherwise **false**. #### Example ```arduino - // listen for BLE centrals to connect: + // listen for Bluetooth® Low Energy centrals to connect: BLEDevice central = BLE.central(); @@ -1180,7 +1181,7 @@ None ### `address()` -Query the Bluetooth address of the BLE device. +Query the Bluetooth® address of the Bluetooth® Low Energy device. #### Syntax @@ -1194,13 +1195,13 @@ bleDevice.address() None #### Returns -The **Bluetooth address** of the BLE device (as a String). +The **Bluetooth® address** of the Bluetooth® Low Energy device (as a String). #### Example ```arduino - // listen for BLE peripherals to connect: + // listen for Bluetooth® Low Energy peripherals to connect: BLEDevice central = BLE.central(); // if a central is connected to peripheral: @@ -1217,7 +1218,7 @@ The **Bluetooth address** of the BLE device (as a String). ### `rssi()` -Query the RSSI (Received signal strength indication) of the BLE device. +Query the RSSI (Received signal strength indication) of the Bluetooth® Low Energy device. #### Syntax @@ -1231,7 +1232,7 @@ bleDevice.rssi() None #### Returns -The **RSSI** of the connected BLE device, 127 if the BLE device is not connected. +The **RSSI** of the connected Bluetooth® Low Energy device, 127 if the Bluetooth® Low Energy device is not connected. #### Example @@ -1249,7 +1250,7 @@ The **RSSI** of the connected BLE device, 127 if the BLE device is not connected ### `characteristic()` -Get a BLECharacteristic representing a BLE characteristic the device provides. +Get a BLECharacteristic representing a Bluetooth® Low Energy characteristic the device provides. #### Syntax @@ -1274,7 +1275,7 @@ bleDevice.characteristic(uuid, index) // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -1326,7 +1327,7 @@ bleDevice.characteristic(uuid, index) ### `discoverAttributes()` -Discover all of the attributes of BLE device. +Discover all of the attributes of Bluetooth® Low Energy device. #### Syntax @@ -1348,7 +1349,7 @@ None // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -1392,7 +1393,7 @@ None ### `discoverService()` -Discover the attributes of a particular service on the BLE device. +Discover the attributes of a particular service on the Bluetooth® Low Energy device. #### Syntax @@ -1414,7 +1415,7 @@ bleDevice.discoverService(serviceUuid) // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -1458,7 +1459,7 @@ bleDevice.discoverService(serviceUuid) ### `deviceName()` -Query the device name (BLE characteristic UUID 0x2a00) of a BLE device. +Query the device name (BLE characteristic UUID 0x2a00) of a Bluetooth® Low Energy device. #### Syntax @@ -1480,7 +1481,7 @@ None // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -1532,7 +1533,7 @@ None ### `appearance()` -Query the appearance (BLE characteristic UUID 0x2a01) of a BLE device. +Query the appearance (BLE characteristic UUID 0x2a01) of a Bluetooth® Low Energy device. #### Syntax @@ -1554,7 +1555,7 @@ None // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -1606,7 +1607,7 @@ None ### `serviceCount()` -Query the number of services discovered for the BLE device. +Query the number of services discovered for the Bluetooth® Low Energy device. #### Syntax @@ -1620,7 +1621,7 @@ bleDevice.serviceCount() None #### Returns -The number of **services discovered** for the BLE device. +The number of **services discovered** for the Bluetooth® Low Energy device. #### Example @@ -1628,7 +1629,7 @@ The number of **services discovered** for the BLE device. // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -1677,7 +1678,7 @@ The number of **services discovered** for the BLE device. ### `hasService()` -Query if the BLE device has a particular service. +Query if the Bluetooth® Low Energy device has a particular service. #### Syntax @@ -1701,7 +1702,7 @@ bleDevice.hasService(uuid, index) // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -1749,7 +1750,7 @@ bleDevice.hasService(uuid, index) ### `service()` -Get a BLEService representing a BLE service the device provides. +Get a BLEService representing a Bluetooth® Low Energy service the device provides. #### Syntax @@ -1774,7 +1775,7 @@ bleDevice.service(uuid, index) // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -1826,7 +1827,7 @@ bleDevice.service(uuid, index) ### `characteristicCount()` -Query the number of characteristics discovered for the BLE device. +Query the number of characteristics discovered for the Bluetooth® Low Energy device. #### Syntax @@ -1840,7 +1841,7 @@ bleDevice.characteristicCount() None #### Returns -The **number of characteristics** discovered for the BLE device. +The **number of characteristics** discovered for the Bluetooth® Low Energy device. #### Example @@ -1848,7 +1849,7 @@ The **number of characteristics** discovered for the BLE device. // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -1897,7 +1898,7 @@ The **number of characteristics** discovered for the BLE device. ### `hasCharacteristic()` -Query if the BLE device has a particular characteristic. +Query if the Bluetooth® Low Energy device has a particular characteristic. #### Syntax @@ -1921,7 +1922,7 @@ bleDevice.hasCharacteristic(uuid, index) // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -1969,7 +1970,7 @@ bleDevice.hasCharacteristic(uuid, index) ### `hasLocalName()` -Query if a discovered BLE device is advertising a local name. +Query if a discovered Bluetooth® Low Energy device is advertising a local name. #### Syntax @@ -1991,7 +1992,7 @@ Nothing // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -2022,7 +2023,7 @@ Nothing ### `hasAdvertisedServiceUuid()` -Query if a discovered BLE device is advertising a service UUID. +Query if a discovered Bluetooth® Low Energy device is advertising a service UUID. #### Syntax @@ -2045,7 +2046,7 @@ bleDevice.hasAdvertisedServiceUuid(index) // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -2080,7 +2081,7 @@ bleDevice.hasAdvertisedServiceUuid(index) ### `advertisedServiceUuidCount()` -Query the number of advertised services a discovered BLE device is advertising. +Query the number of advertised services a discovered Bluetooth® Low Energy device is advertising. #### Syntax @@ -2094,7 +2095,7 @@ bleDevice.advertisedServiceUuidCount() None #### Returns -The **number of advertised services** a discovered BLE device is advertising. +The **number of advertised services** a discovered Bluetooth® Low Energy device is advertising. #### Example @@ -2102,7 +2103,7 @@ The **number of advertised services** a discovered BLE device is advertising. // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -2137,7 +2138,7 @@ The **number of advertised services** a discovered BLE device is advertising. ### `localName()` -Query the local name a discovered BLE device is advertising with. +Query the local name a discovered Bluetooth® Low Energy device is advertising with. #### Syntax @@ -2159,7 +2160,7 @@ Nothing // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -2190,7 +2191,7 @@ Nothing ### `advertisedServiceUuid()` -Query an advertised service UUID discovered BLE device is advertising. +Query an advertised service UUID discovered Bluetooth® Low Energy device is advertising. #### Syntax @@ -2213,7 +2214,7 @@ Advertised service **UUID** (as a String). // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -2248,7 +2249,7 @@ Advertised service **UUID** (as a String). ### `connect()` -Connect to a BLE device. +Connect to a Bluetooth® Low Energy device. #### Syntax @@ -2270,7 +2271,7 @@ None // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -2308,7 +2309,7 @@ Used to enable the services board provides or interact with services a remote bo ### `BLEService()` -Create a new BLE service. +Create a new Bluetooth® Low Energy service. #### Syntax @@ -2328,7 +2329,7 @@ New **BLEService** with the specified **UUID** ```arduino -BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // BLE LED Service +BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // Bluetooth® Low Energy LED Service ``` @@ -2349,13 +2350,13 @@ bleService.uuid() None #### Returns -UUID of the BLE service as a **String**. +UUID of the Bluetooth® Low Energy service as a **String**. #### Example ```arduino -BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // BLE LED Service +BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // Bluetooth® Low Energy LED Service Serial.print(“LED service UUID = “); @@ -2367,7 +2368,7 @@ Serial.println(ledService.uuid()); ### `addCharacteristic()` -Add a BLECharateristic to the BLE service. +Add a BLECharateristic to the Bluetooth® Low Energy service. #### Syntax @@ -2387,9 +2388,9 @@ Nothing ```arduino -BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // BLE LED Service +BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // Bluetooth® Low Energy LED Service -// BLE LED Switch Characteristic - custom 128-bit UUID, readable and writable by central +// Bluetooth® Low Energy LED Switch Characteristic - custom 128-bit UUID, readable and writable by central BLECharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite, 1); @@ -2404,7 +2405,7 @@ ledService.addCharacteristic(switchCharacteristic); ### `characteristicCount()` -Query the number of characteristics discovered for the BLE service. +Query the number of characteristics discovered for the Bluetooth® Low Energy service. #### Syntax @@ -2418,7 +2419,7 @@ bleService.characteristicCount() None #### Returns -The **number of characteristics** discovered for the BLE service. +The **number of characteristics** discovered for the Bluetooth® Low Energy service. #### Example @@ -2426,7 +2427,7 @@ The **number of characteristics** discovered for the BLE service. // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -2482,7 +2483,7 @@ The **number of characteristics** discovered for the BLE service. ### `hasCharacteristic()` -Query if the BLE service has a particular characteristic. +Query if the Bluetooth® Low Energy service has a particular characteristic. #### Syntax @@ -2506,7 +2507,7 @@ bleService.hasCharacteristic(uuid, index) // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -2560,7 +2561,7 @@ bleService.hasCharacteristic(uuid, index) ### `characteristic()` -Get a BLECharacteristic representing a BLE characteristic the service provides. +Get a BLECharacteristic representing a Bluetooth® Low Energy characteristic the service provides. #### Syntax @@ -2585,7 +2586,7 @@ bleService.characteristic(uuid, index) // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -2648,7 +2649,7 @@ Used to enable the characteristics board offers in a service or interact with ch ### `BLECharacteristic()` -Create a new BLE characteristic. +Create a new Bluetooth® Low Energy characteristic. #### Syntax @@ -2686,7 +2687,7 @@ New **BLECharacteristic** with the specified **UUID** and value ```arduino -// BLE Battery Level Characteristic +// Bluetooth® Low Energy Battery Level Characteristic BLEUnsignedCharCharacteristic batteryLevelChar("2A19", // standard 16-bit characteristic UUID BLERead | BLENotify); // remote clients will be able to get notifications if this characteristic changes @@ -2710,13 +2711,13 @@ bleCharacteristic.uuid() None #### Returns -**UUID** of the BLE service as a **String**. +**UUID** of the Bluetooth® Low Energy service as a **String**. #### Example ```arduino -// BLE LED Switch Characteristic - custom 128-bit UUID, read and writable by central +// Bluetooth® Low Energy LED Switch Characteristic - custom 128-bit UUID, read and writable by central BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); @@ -2749,7 +2750,7 @@ None ```arduino -// BLE LED Switch Characteristic - custom 128-bit UUID, read and writable by central +// Bluetooth® Low Energy LED Switch Characteristic - custom 128-bit UUID, read and writable by central BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); @@ -2788,7 +2789,7 @@ The **maximum value** size of the characteristic (in bytes) ```arduino -// BLE LED Switch Characteristic - custom 128-bit UUID, read and writable by central +// Bluetooth® Low Energy LED Switch Characteristic - custom 128-bit UUID, read and writable by central BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); @@ -2821,7 +2822,7 @@ The **current value** of the characteristic, value type depends on the construct ```arduino -// BLE LED Switch Characteristic - custom 128-bit UUID, read and writable by central +// Bluetooth® Low Energy LED Switch Characteristic - custom 128-bit UUID, read and writable by central BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); @@ -2860,7 +2861,7 @@ The **current value** size of the characteristic (in bytes) ```arduino -// BLE LED Switch Characteristic - custom 128-bit UUID, read and writable by central +// Bluetooth® Low Energy LED Switch Characteristic - custom 128-bit UUID, read and writable by central BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); @@ -3054,7 +3055,7 @@ buttonCharacteristic.broadcast(); ### `written()` -Query if the characteristic value has been written by another BLE device. +Query if the characteristic value has been written by another Bluetooth® Low Energy device. #### Syntax @@ -3068,19 +3069,19 @@ bleCharacteristic.written() None #### Returns -**true** if the characteristic value has been written by another BLE device, **false** otherwise +**true** if the characteristic value has been written by another Bluetooth® Low Energy device, **false** otherwise #### Example ```arduino -// BLE LED Switch Characteristic - custom 128-bit UUID, read and writable by central +// Bluetooth® Low Energy LED Switch Characteristic - custom 128-bit UUID, read and writable by central BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); - // listen for BLE peripherals to connect: + // listen for Bluetooth® Low Energy peripherals to connect: BLEDevice central = BLE.central(); // if a central is connected to peripheral: @@ -3116,7 +3117,7 @@ BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214 ### `subscribed()` -Query if the characteristic has been subscribed to by another BLE device. +Query if the characteristic has been subscribed to by another Bluetooth® Low Energy device. #### Syntax @@ -3130,13 +3131,13 @@ bleCharacteristic.subscribed() None #### Returns -**true** if the characteristic value has been subscribed to by another BLE device, **false** otherwise +**true** if the characteristic value has been subscribed to by another Bluetooth® Low Energy device, **false** otherwise #### Example ```arduino -// BLE Battery Level Characteristic +// Bluetooth® Low Energy Battery Level Characteristic BLEUnsignedCharCharacteristic batteryLevelChar("2A19", // standard 16-bit characteristic UUID BLERead | BLENotify); // remote clients will be able to get notifications if this characteristic changes @@ -3145,7 +3146,7 @@ BLEUnsignedCharCharacteristic batteryLevelChar("2A19", // standard 16-bit chara if (batteryLevelChar.subscribed()) { - // set a new value , that well be pushed to subscribed BLE devices + // set a new value , that well be pushed to subscribed Bluetooth® Low Energy devices batteryLevelChar.writeValue(0xab); } @@ -3174,7 +3175,7 @@ Nothing ```arduino -// BLE Battery Level Characteristic +// Bluetooth® Low Energy Battery Level Characteristic BLEUnsignedCharCharacteristic batteryLevelChar("2A19", // standard 16-bit characteristic UUID BLERead | BLENotify); // remote clients will be able to get notifications if this characteristic changes @@ -3191,7 +3192,7 @@ BLEDescriptor batteryLevelDescriptor("2901", "millis"); ### `descriptorCount` -Query the number of BLE descriptors discovered for the characteristic. +Query the number of Bluetooth® Low Energy descriptors discovered for the characteristic. #### Syntax @@ -3205,7 +3206,7 @@ bleCharacteristic.descriptorCount() None #### Returns -The **number of BLE descriptors** discovered for the characteristic +The **number of Bluetooth® Low Energy descriptors** discovered for the characteristic #### Example @@ -3254,7 +3255,7 @@ bleCharacteristic.hasDescriptor(uuid, index) ### `descriptor()` -Get a BLEDescriptor that represents a characteristics BLE descriptor. +Get a BLEDescriptor that represents a characteristics Bluetooth® Low Energy descriptor. #### Syntax @@ -3271,7 +3272,7 @@ bleCharacteristic.descriptor(uuid, index) **uuid**: uuid (as a **String**) #### Returns -BLEDescriptor that represents a characteristics BLE descriptor +BLEDescriptor that represents a characteristics Bluetooth® Low Energy descriptor #### Example @@ -3286,7 +3287,7 @@ BLEDescriptor that represents a characteristics BLE descriptor ### `canRead()` -Query if a BLE characteristic is readable. +Query if a Bluetooth® Low Energy characteristic is readable. #### Syntax @@ -3348,7 +3349,7 @@ None ### `canWrite()` -Query if a BLE characteristic is writable. +Query if a Bluetooth® Low Energy characteristic is writable. #### Syntax @@ -3377,7 +3378,7 @@ None ### `canSubscribe()` -Query if a BLE characteristic is subscribable. +Query if a Bluetooth® Low Energy characteristic is subscribable. #### Syntax @@ -3406,7 +3407,7 @@ None ### `subscribe()` -Subscribe to a BLE characteristics notification or indications. +Subscribe to a Bluetooth® Low Energy characteristics notification or indications. #### Syntax @@ -3454,7 +3455,7 @@ None ### `canUnsubscribe()` -Query if a BLE characteristic is unsubscribable. +Query if a Bluetooth® Low Energy characteristic is unsubscribable. #### Syntax @@ -3483,7 +3484,7 @@ None ### `unsubscribe()` -Unsubscribe to a BLE characteristics notifications or indications. +Unsubscribe to a Bluetooth® Low Energy characteristics notifications or indications. #### Syntax @@ -3584,7 +3585,7 @@ Used to describe a characteristic the board offers ### `BLEDescriptor()` -Create a new BLE descriptor. +Create a new Bluetooth® Low Energy descriptor. #### Syntax @@ -3629,7 +3630,7 @@ bleDescriptor.uuid() None #### Returns -**UUID** of the BLE descriptor (as a String). +**UUID** of the Bluetooth® Low Energy descriptor (as a String). #### Example @@ -3661,7 +3662,7 @@ bleDescriptor.valueSize() None #### Returns -**Value size** (in bytes) of the BLE descriptor. +**Value size** (in bytes) of the Bluetooth® Low Energy descriptor. #### Example diff --git a/docs/readme.md b/docs/readme.md index e9e36fc3..bfd1496b 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -1,27 +1,27 @@ # ArduinoBLE library -This library supports all the Arduino boards that have the hardware enabled for BLE and Bluetooth 4.0 and above; these include Nano 33 BLE, Arduino NANO 33 IoT, Uno WiFi Rev 2, MKR WiFi 1010, Nicla Sense ME. +This library supports all the Arduino boards that have the hardware enabled for Bluetooth® Low Energy and Bluetooth® 4.0 and above; these include Nano 33 BLE, Arduino NANO 33 IoT, Uno WiFi Rev 2, MKR WiFi 1010, Nicla Sense ME. To use this library ``#include `` ## A quick introduction to BLE -Bluetooth 4.0 includes both traditional Bluetooth, now labeled "Bluetooth Classic", and the Bluetooth Low Energy (Bluetooth LE, or BLE). BLE is optimized for low power use at low data rates, and was designed to operate from simple lithium coin cell batteries. +Bluetooth® 4.0 includes both traditional Bluetooth®, now labeled "Bluetooth® Classic", and the Bluetooth® Low Energy. Bluetooth® Low Energy is optimized for low power use at low data rates, and was designed to operate from simple lithium coin cell batteries. -Unlike standard bluetooth communication basically based on an asynchronous serial connection (UART) a Bluetooth LE radio acts like a community bulletin board. The computers that connect to it are like community members that read the bulletin board. Each radio acts as either the bulletin board or the reader. If your radio is a bulletin board (called a peripheral device in Bluetooth LE parlance) it posts data for all radios in the community to read. If your radio is a reader (called a central device in Blueooth LE terms) it reads from any of the bulletin boards (peripheral devices) that have information about which it cares. You can also think of peripheral devices as the servers in a client-server transaction, because they contain the information that reader radios ask for. Similarly, central devices are the clients of the Bluetooth LE world because they read information available from the peripherals. +Unlike standard Bluetooth® communication basically based on an asynchronous serial connection (UART) a Bluetooth® LE radio acts like a community bulletin board. The computers that connect to it are like community members that read the bulletin board. Each radio acts as either the bulletin board or the reader. If your radio is a bulletin board (called a peripheral device in Bluetooth® LE parlance) it posts data for all radios in the community to read. If your radio is a reader (called a central device in Blueooth LE terms) it reads from any of the bulletin boards (peripheral devices) that have information about which it cares. You can also think of peripheral devices as the servers in a client-server transaction, because they contain the information that reader radios ask for. Similarly, central devices are the clients of the Bluetooth® LE world because they read information available from the peripherals. ![Communication between central and peripheral devices](www.arduino.cc/en/uploads/Reference/ble-bulletin-board-model.png) -Think of a Bluetooth LE peripheral device as a bulletin board and central devices as viewers of the board. Central devices view the services, get the data, then move on. Each transaction is quick (a few milliseconds), so multiple central devices can get data from one peripheral. +Think of a Bluetooth® LE peripheral device as a bulletin board and central devices as viewers of the board. Central devices view the services, get the data, then move on. Each transaction is quick (a few milliseconds), so multiple central devices can get data from one peripheral. The information presented by a peripheral is structured as **services**, each of which is subdivided into **characteristics**. You can think of services as the notices on a bulletin board, and characteristics as the individual paragraphs of those notices. If you're a peripheral device, you just update each service characteristic when it needs updating and don't worry about whether the central devices read them or not. If you're a central device, you connect to the peripheral then read the boxes you want. If a given characteristic is readable and writable, then the peripheral and central can both change it. ## Notify -The Bluetooth LE specification includes a mechanism known as **notify** that lets you know when data's changed. When notify on a characteristic is enabled and the sender writes to it, the new value is automatically sent to the receiver, without the receiver explicitly issuing a read command. This is commonly used for streaming data such as accelerometer or other sensor readings. There's a variation on this specification called **indicate** which works similarly, but in the indicate specification, the reader sends an acknowledgement of the pushed data. +The Bluetooth® LE specification includes a mechanism known as **notify** that lets you know when data's changed. When notify on a characteristic is enabled and the sender writes to it, the new value is automatically sent to the receiver, without the receiver explicitly issuing a read command. This is commonly used for streaming data such as accelerometer or other sensor readings. There's a variation on this specification called **indicate** which works similarly, but in the indicate specification, the reader sends an acknowledgement of the pushed data. -The client-server structure of Bluetooth LE, combined with the notify characteristic, is generally called a **publish-and-subscribe model**. +The client-server structure of Bluetooth® LE, combined with the notify characteristic, is generally called a **publish-and-subscribe model**. ## Update a characteristic @@ -35,7 +35,7 @@ Just as with writing to a characteristic, you could update your characteristics ## Services, characteristics, and UUIDs -A BLE peripheral will provide **services**, which in turn provide **characteristics**. You can define your own services, or use [standard services](https://developer.bluetooth.org/gatt/services/Pages/ServicesHome.aspx). +A Bluetooth® Low Energy peripheral will provide **services**, which in turn provide **characteristics**. You can define your own services, or use [standard services](https://developer.bluetooth.org/gatt/services/Pages/ServicesHome.aspx). Services are identified by unique numbers known as UUIDs. You know about UUIDs from other contexts. Standard services have a 16-bit UUID and custom services have a 128-bit UUID. The ability to define services and characteristics depends on the radio you're using and its firmware. @@ -84,8 +84,8 @@ The Bluetooth LE protocol operates on multiple layers. **General Attribute Profi As the library enables multiple types of functionality, there are a number of different classes. -- BLE used to enable the BLE module. -- BLEDevice used to get information about the devices connected or discovered while scanning. -- BLEService used to enable the services board provides or interact with services a remote board provides. -- BLECharacteristic used to enable the characteristics board offers in a service or interact with characteristics a remote board provides. -- BLEDescriptor used to describe a characteristic the board offers. +- `BLE` used to enable the Bluetooth® Low Energy module. +- `BLEDevice` used to get information about the devices connected or discovered while scanning. +- `BLEService` used to enable the services board provides or interact with services a remote board provides. +- `BLECharacteristic` used to enable the characteristics board offers in a service or interact with characteristics a remote board provides. +- `BLEDescriptor` used to describe a characteristic the board offers. diff --git a/examples/Central/LedControl/LedControl.ino b/examples/Central/LedControl/LedControl.ino index 8301a311..953de7d8 100644 --- a/examples/Central/LedControl/LedControl.ino +++ b/examples/Central/LedControl/LedControl.ino @@ -1,9 +1,9 @@ /* LED Control - This example scans for BLE peripherals until one with the advertised service + This example scans for Bluetooth® Low Energy peripherals until one with the advertised service "19b10000-e8f2-537e-4f6c-d104768a1214" UUID is found. Once discovered and connected, - it will remotely control the BLE Peripheral's LED, when the button is pressed or released. + it will remotely control the Bluetooth® Low Energy peripheral's LED, when the button is pressed or released. The circuit: - Arduino MKR WiFi 1010, Arduino Uno WiFi Rev2 board, Arduino Nano 33 IoT, @@ -29,10 +29,10 @@ void setup() { // configure the button pin as input pinMode(buttonPin, INPUT); - // initialize the BLE hardware + // initialize the Bluetooth® Low Energy hardware BLE.begin(); - Serial.println("BLE Central - LED control"); + Serial.println("Bluetooth® Low Energy Central - LED control"); // start scanning for peripherals BLE.scanForUuid("19b10000-e8f2-537e-4f6c-d104768a1214"); diff --git a/examples/Central/PeripheralExplorer/PeripheralExplorer.ino b/examples/Central/PeripheralExplorer/PeripheralExplorer.ino index 100225d6..919cdde0 100644 --- a/examples/Central/PeripheralExplorer/PeripheralExplorer.ino +++ b/examples/Central/PeripheralExplorer/PeripheralExplorer.ino @@ -1,7 +1,7 @@ /* Peripheral Explorer - This example scans for BLE peripherals until one with a particular name ("LED") + This example scans for Bluetooth® Low Energy peripherals until one with a particular name ("LED") is found. Then connects, and discovers + prints all the peripheral's attributes. The circuit: @@ -22,12 +22,12 @@ void setup() { // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } - Serial.println("BLE Central - Peripheral Explorer"); + Serial.println("Bluetooth® Low Energy Central - Peripheral Explorer"); // start scanning for peripherals BLE.scan(); diff --git a/examples/Central/Scan/Scan.ino b/examples/Central/Scan/Scan.ino index 3126d1a6..162e3c07 100644 --- a/examples/Central/Scan/Scan.ino +++ b/examples/Central/Scan/Scan.ino @@ -1,7 +1,7 @@ /* Scan - This example scans for BLE peripherals and prints out their advertising details: + This example scans for Bluetooth® Low Energy peripherals and prints out their advertising details: address, local name, advertised service UUID's. The circuit: @@ -19,12 +19,12 @@ void setup() { // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } - Serial.println("BLE Central scan"); + Serial.println("Bluetooth® Low Energy Central scan"); // start scanning for peripheral BLE.scan(); diff --git a/examples/Central/ScanCallback/ScanCallback.ino b/examples/Central/ScanCallback/ScanCallback.ino index 28ab9e9e..2687a3b9 100644 --- a/examples/Central/ScanCallback/ScanCallback.ino +++ b/examples/Central/ScanCallback/ScanCallback.ino @@ -1,7 +1,7 @@ /* Scan Callback - This example scans for BLE peripherals and prints out their advertising details: + This example scans for Bluetooth® Low Energy peripherals and prints out their advertising details: address, local name, advertised service UUIDs. Unlike the Scan example, it uses the callback style APIs and disables filtering so the peripheral discovery is reported for every single advertisement it makes. @@ -21,12 +21,12 @@ void setup() { // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } - Serial.println("BLE Central scan callback"); + Serial.println("Bluetooth® Low Energy Central scan callback"); // set the discovered event handle BLE.setEventHandler(BLEDiscovered, bleCentralDiscoverHandler); diff --git a/examples/Central/SensorTagButton/SensorTagButton.ino b/examples/Central/SensorTagButton/SensorTagButton.ino index 72dad90b..a56504f6 100644 --- a/examples/Central/SensorTagButton/SensorTagButton.ino +++ b/examples/Central/SensorTagButton/SensorTagButton.ino @@ -1,7 +1,7 @@ /* SensorTag Button - This example scans for BLE peripherals until a TI SensorTag is discovered. + This example scans for Bluetooth® Low Energy peripherals until a TI SensorTag is discovered. It then connects to it, discovers the attributes of the 0xffe0 service, subscribes to the Simple Key Characteristic (UUID 0xffe1). When a button is pressed on the SensorTag a notification is received and the button state is @@ -23,12 +23,12 @@ void setup() { // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } - Serial.println("BLE Central - SensorTag button"); + Serial.println("Bluetooth® Low Energy Central - SensorTag button"); Serial.println("Make sure to turn on the device."); // start scanning for peripheral diff --git a/examples/Peripheral/BatteryMonitor/BatteryMonitor.ino b/examples/Peripheral/BatteryMonitor/BatteryMonitor.ino index 6c5d3d30..f013c6f5 100644 --- a/examples/Peripheral/BatteryMonitor/BatteryMonitor.ino +++ b/examples/Peripheral/BatteryMonitor/BatteryMonitor.ino @@ -1,14 +1,14 @@ /* Battery Monitor - This example creates a BLE peripheral with the standard battery service and + This example creates a Bluetooth® Low Energy peripheral with the standard battery service and level characteristic. The A0 pin is used to calculate the battery level. The circuit: - Arduino MKR WiFi 1010, Arduino Uno WiFi Rev2 board, Arduino Nano 33 IoT, Arduino Nano 33 BLE, or Arduino Nano 33 BLE Sense board. - You can use a generic BLE central app, like LightBlue (iOS and Android) or + You can use a generic Bluetooth® Low Energy central app, like LightBlue (iOS and Android) or nRF Connect (Android), to interact with the services and characteristics created in this sketch. @@ -17,10 +17,10 @@ #include - // BLE Battery Service + // Bluetooth® Low Energy Battery Service BLEService batteryService("180F"); -// BLE Battery Level Characteristic +// Bluetooth® Low Energy Battery Level Characteristic BLEUnsignedCharCharacteristic batteryLevelChar("2A19", // standard 16-bit characteristic UUID BLERead | BLENotify); // remote clients will be able to get notifications if this characteristic changes @@ -40,9 +40,9 @@ void setup() { while (1); } - /* Set a local name for the BLE device + /* Set a local name for the Bluetooth® Low Energy device This name will appear in advertising packets - and can be used by remote devices to identify this BLE device + and can be used by remote devices to identify this Bluetooth® Low Energy device The name can be changed but maybe be truncated based on space left in advertisement packet */ BLE.setLocalName("BatteryMonitor"); @@ -51,18 +51,18 @@ void setup() { BLE.addService(batteryService); // Add the battery service batteryLevelChar.writeValue(oldBatteryLevel); // set initial value for this characteristic - /* Start advertising BLE. It will start continuously transmitting BLE - advertising packets and will be visible to remote BLE central devices + /* Start advertising Bluetooth® Low Energy. It will start continuously transmitting Bluetooth® Low Energy + advertising packets and will be visible to remote Bluetooth® Low Energy central devices until it receives a new connection */ // start advertising BLE.advertise(); - Serial.println("Bluetooth device active, waiting for connections..."); + Serial.println("Bluetooth® device active, waiting for connections..."); } void loop() { - // wait for a BLE central + // wait for a Bluetooth® Low Energy central BLEDevice central = BLE.central(); // if a central is connected to the peripheral: diff --git a/examples/Peripheral/ButtonLED/ButtonLED.ino b/examples/Peripheral/ButtonLED/ButtonLED.ino index 659d466a..cbc14dd8 100644 --- a/examples/Peripheral/ButtonLED/ButtonLED.ino +++ b/examples/Peripheral/ButtonLED/ButtonLED.ino @@ -1,7 +1,7 @@ /* Button LED - This example creates a BLE peripheral with service that contains a + This example creates a Bluetooth® Low Energy peripheral with service that contains a characteristic to control an LED and another characteristic that represents the state of the button. @@ -10,7 +10,7 @@ Arduino Nano 33 BLE, or Arduino Nano 33 BLE Sense board. - Button connected to pin 4 - You can use a generic BLE central app, like LightBlue (iOS and Android) or + You can use a generic Bluetooth® Low Energy central app, like LightBlue (iOS and Android) or nRF Connect (Android), to interact with the services and characteristics created in this sketch. @@ -38,7 +38,7 @@ void setup() { // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -61,11 +61,11 @@ void setup() { // start advertising BLE.advertise(); - Serial.println("Bluetooth device active, waiting for connections..."); + Serial.println("Bluetooth® device active, waiting for connections..."); } void loop() { - // poll for BLE events + // poll for Bluetooth® Low Energy events BLE.poll(); // read the current button pin state diff --git a/examples/Peripheral/CallbackLED/CallbackLED.ino b/examples/Peripheral/CallbackLED/CallbackLED.ino index a874a77b..23f67bc3 100644 --- a/examples/Peripheral/CallbackLED/CallbackLED.ino +++ b/examples/Peripheral/CallbackLED/CallbackLED.ino @@ -1,7 +1,7 @@ /* Callback LED - This example creates a BLE peripheral with service that contains a + This example creates a Bluetooth® Low Energy peripheral with service that contains a characteristic to control an LED. The callback features of the library are used. @@ -9,7 +9,7 @@ - Arduino MKR WiFi 1010, Arduino Uno WiFi Rev2 board, Arduino Nano 33 IoT, Arduino Nano 33 BLE, or Arduino Nano 33 BLE Sense board. - You can use a generic BLE central app, like LightBlue (iOS and Android) or + You can use a generic Bluetooth® Low Energy central app, like LightBlue (iOS and Android) or nRF Connect (Android), to interact with the services and characteristics created in this sketch. @@ -33,7 +33,7 @@ void setup() { // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -61,11 +61,11 @@ void setup() { // start advertising BLE.advertise(); - Serial.println(("Bluetooth device active, waiting for connections...")); + Serial.println(("Bluetooth® device active, waiting for connections...")); } void loop() { - // poll for BLE events + // poll for Bluetooth® Low Energy events BLE.poll(); } diff --git a/examples/Peripheral/LED/LED.ino b/examples/Peripheral/LED/LED.ino index 1ede6535..2e6d6db9 100644 --- a/examples/Peripheral/LED/LED.ino +++ b/examples/Peripheral/LED/LED.ino @@ -1,14 +1,14 @@ /* LED - This example creates a BLE peripheral with service that contains a + This example creates a Bluetooth® Low Energy peripheral with service that contains a characteristic to control an LED. The circuit: - Arduino MKR WiFi 1010, Arduino Uno WiFi Rev2 board, Arduino Nano 33 IoT, Arduino Nano 33 BLE, or Arduino Nano 33 BLE Sense board. - You can use a generic BLE central app, like LightBlue (iOS and Android) or + You can use a generic Bluetooth® Low Energy central app, like LightBlue (iOS and Android) or nRF Connect (Android), to interact with the services and characteristics created in this sketch. @@ -17,9 +17,9 @@ #include -BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // BLE LED Service +BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // Bluetooth® Low Energy LED Service -// BLE LED Switch Characteristic - custom 128-bit UUID, read and writable by central +// Bluetooth® Low Energy LED Switch Characteristic - custom 128-bit UUID, read and writable by central BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); const int ledPin = LED_BUILTIN; // pin to use for the LED @@ -33,7 +33,7 @@ void setup() { // begin initialization if (!BLE.begin()) { - Serial.println("starting BLE failed!"); + Serial.println("starting Bluetooth® Low Energy module failed!"); while (1); } @@ -58,7 +58,7 @@ void setup() { } void loop() { - // listen for BLE peripherals to connect: + // listen for Bluetooth® Low Energy peripherals to connect: BLEDevice central = BLE.central(); // if a central is connected to peripheral: diff --git a/library.properties b/library.properties index 601474c6..8d8a9d1c 100644 --- a/library.properties +++ b/library.properties @@ -2,8 +2,8 @@ name=ArduinoBLE version=1.2.1 author=Arduino maintainer=Arduino -sentence=Enables BLE connectivity on the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, Arduino Nano 33 IoT, Arduino Nano 33 BLE and Nicla Sense ME. -paragraph=This library supports creating a BLE peripheral and BLE central mode. +sentence=Enables Bluetooth® Low Energy connectivity on the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, Arduino Nano 33 IoT, Arduino Nano 33 BLE and Nicla Sense ME. +paragraph=This library supports creating a Bluetooth® Low Energy peripheral & central mode. category=Communication url=https://www.arduino.cc/en/Reference/ArduinoBLE architectures=samd,megaavr,mbed,apollo3,mbed_nano,mbed_portenta,mbed_nicla From 57ce5149d944932740401ab7952d3f745bc9652a Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 2 Mar 2022 09:03:48 +0000 Subject: [PATCH 31/83] Bump actions/checkout from 2 to 3 Bumps [actions/checkout](https://github.com/actions/checkout) from 2 to 3. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v2...v3) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- .github/workflows/compile-examples.yml | 2 +- .github/workflows/spell-check.yml | 2 +- .github/workflows/sync-labels.yml | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/compile-examples.yml b/.github/workflows/compile-examples.yml index a14882ff..a1faf997 100644 --- a/.github/workflows/compile-examples.yml +++ b/.github/workflows/compile-examples.yml @@ -17,7 +17,7 @@ jobs: - arduino:mbed_nano:nanorp2040connect steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - uses: arduino/compile-sketches@v1 with: github-token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/spell-check.yml b/.github/workflows/spell-check.yml index 6c44bcfb..0cbdde58 100644 --- a/.github/workflows/spell-check.yml +++ b/.github/workflows/spell-check.yml @@ -8,7 +8,7 @@ jobs: steps: - name: Checkout - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: Spell check uses: arduino/actions/libraries/spell-check@master diff --git a/.github/workflows/sync-labels.yml b/.github/workflows/sync-labels.yml index 3ee6febd..4ea57559 100644 --- a/.github/workflows/sync-labels.yml +++ b/.github/workflows/sync-labels.yml @@ -27,7 +27,7 @@ jobs: steps: - name: Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: Download JSON schema for labels configuration file id: download-schema @@ -105,7 +105,7 @@ jobs: echo "::set-output name=flag::--dry-run" - name: Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: Download configuration files artifact uses: actions/download-artifact@v2 From c9bfd21ed1f927603460b3e00fc673009aad4330 Mon Sep 17 00:00:00 2001 From: "Ho Yun \"Bobby" Date: Fri, 18 Mar 2022 20:58:54 -0600 Subject: [PATCH 32/83] Update readme.md image from Arduino's assets folder not linking properly --- docs/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/readme.md b/docs/readme.md index bfd1496b..5a52d988 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -11,7 +11,7 @@ Bluetooth® 4.0 includes both traditional Bluetooth®, now labeled "Bluetooth® Unlike standard Bluetooth® communication basically based on an asynchronous serial connection (UART) a Bluetooth® LE radio acts like a community bulletin board. The computers that connect to it are like community members that read the bulletin board. Each radio acts as either the bulletin board or the reader. If your radio is a bulletin board (called a peripheral device in Bluetooth® LE parlance) it posts data for all radios in the community to read. If your radio is a reader (called a central device in Blueooth LE terms) it reads from any of the bulletin boards (peripheral devices) that have information about which it cares. You can also think of peripheral devices as the servers in a client-server transaction, because they contain the information that reader radios ask for. Similarly, central devices are the clients of the Bluetooth® LE world because they read information available from the peripherals. -![Communication between central and peripheral devices](www.arduino.cc/en/uploads/Reference/ble-bulletin-board-model.png) +![Communication between central and peripheral devices](https://www.arduino.cc/en/uploads/Reference/ble-bulletin-board-model.png) Think of a Bluetooth® LE peripheral device as a bulletin board and central devices as viewers of the board. Central devices view the services, get the data, then move on. Each transaction is quick (a few milliseconds), so multiple central devices can get data from one peripheral. From c925d8251ac31e715a19b63cbf279c7be2a576a1 Mon Sep 17 00:00:00 2001 From: giulcioffi Date: Thu, 24 Mar 2022 16:15:56 +0100 Subject: [PATCH 33/83] Add compatibility with Nicla Vision --- src/utility/HCICordioTransport.cpp | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/utility/HCICordioTransport.cpp b/src/utility/HCICordioTransport.cpp index 01788238..28eb97be 100644 --- a/src/utility/HCICordioTransport.cpp +++ b/src/utility/HCICordioTransport.cpp @@ -25,7 +25,7 @@ #include #include -#if defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) +#if defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) #include "ble/BLE.h" #include #endif @@ -181,7 +181,7 @@ HCICordioTransportClass::~HCICordioTransportClass() { } -#if defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) +#if defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) events::EventQueue eventQueue(10 * EVENTS_EVENT_SIZE); void scheduleMbedBleEvents(BLE::OnEventsToProcessCallbackContext *context) { eventQueue.call(mbed::Callback(&context->ble, &BLE::processEvents)); @@ -201,7 +201,7 @@ int HCICordioTransportClass::begin() init_wsf(bufPoolDesc); #endif -#if defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) +#if defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) BLE &ble = BLE::Instance(); ble.onEventsToProcess(scheduleMbedBleEvents); From c12774c09cb96cf91911ee73613783b5602d3161 Mon Sep 17 00:00:00 2001 From: giulcioffi Date: Thu, 24 Mar 2022 16:18:49 +0100 Subject: [PATCH 34/83] Release 1.2.2 --- library.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.properties b/library.properties index 8d8a9d1c..e8859d8e 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=ArduinoBLE -version=1.2.1 +version=1.2.2 author=Arduino maintainer=Arduino sentence=Enables Bluetooth® Low Energy connectivity on the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, Arduino Nano 33 IoT, Arduino Nano 33 BLE and Nicla Sense ME. From bfc3202668332c857c46c4502be5127cbe6da597 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jacob=20Hyl=C3=A9n?= <60390259+jacobhylen@users.noreply.github.com> Date: Thu, 31 Mar 2022 16:27:49 +0200 Subject: [PATCH 35/83] Update api.md --- docs/api.md | 162 ++++++++++++++++++++++++++-------------------------- 1 file changed, 81 insertions(+), 81 deletions(-) diff --git a/docs/api.md b/docs/api.md index df285806..b8fa1d5f 100644 --- a/docs/api.md +++ b/docs/api.md @@ -4,7 +4,7 @@ Used to enable the Bluetooth® Low Energy module. -### `begin()` +### `BLE.begin()` Initializes the Bluetooth® Low Energy device. @@ -36,7 +36,7 @@ None ``` -### `end()` +### `BLE.end()` Stops the Bluetooth® Low Energy device. @@ -72,7 +72,7 @@ Nothing ``` -### `poll()` +### `BLE.poll()` Poll for Bluetooth® Low Energy radio events and handle them. @@ -106,7 +106,7 @@ Nothing ``` -### `setEventHandler()` +### `BLE.setEventHandler()` Set the event handler (callback) function that will be called when the specified event occurs. @@ -159,7 +159,7 @@ void blePeripheralDisconnectHandler(BLEDevice central) { ``` -### `connected()` +### `BLE.connected()` Query if another Bluetooth® Low Energy device is connected @@ -190,7 +190,7 @@ None ``` -### `disconnect()` +### `BLE.disconnect()` Disconnect any Bluetooth® Low Energy devices that are connected @@ -221,7 +221,7 @@ None ``` -### `address()` +### `BLE.address()` Query the Bluetooth® address of the Bluetooth® Low Energy device. @@ -251,7 +251,7 @@ The **Bluetooth® address** of the Bluetooth® Low Energy device (as a String). ``` -### `rssi()` +### `BLE.rssi()` Query the RSSI (Received signal strength indication) of the connected Bluetooth® Low Energy device. @@ -283,7 +283,7 @@ The **RSSI** of the connected Bluetooth® Low Energy device, 127 if no Bluetooth ``` -### `setAdvertisedServiceUuid()` +### `BLE.setAdvertisedServiceUuid()` Set the advertised service UUID used when advertising. @@ -322,7 +322,7 @@ Nothing ``` -### `setAdvertisedService()` +### `BLE.setAdvertisedService()` Set the advertised service UUID used when advertising to the value of the BLEService provided. @@ -365,7 +365,7 @@ BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // Bluetooth® Lo ``` -### `setManufacturerData()` +### `BLE.setManufacturerData()` Set the manufacturer data value used when advertising. @@ -408,7 +408,7 @@ Nothing ``` -### `setLocalName()` +### `BLE.setLocalName()` Set the local value used when advertising. @@ -448,7 +448,7 @@ Nothing ``` -### `setDeviceName()` +### `BLE.setDeviceName()` Set the device name in the built in device name characteristic. If not set, the value defaults “Arduino”. @@ -488,7 +488,7 @@ Nothing ``` -### `setAppearance()` +### `BLE.setAppearance()` Set the appearance in the built in appearance characteristic. If not set, the value defaults 0x0000. @@ -528,7 +528,7 @@ Nothing ``` -### `addService()` +### `BLE.addService()` Add a BLEService to the set of services the Bluetooth® Low Energy device provides @@ -570,7 +570,7 @@ BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // Bluetooth® Lo ``` -### `advertise()` +### `BLE.advertise()` Start advertising. @@ -608,7 +608,7 @@ None ``` -### `stopAdvertise()` +### `BLE.stopAdvertise()` Stop advertising. @@ -648,7 +648,7 @@ Nothing ``` -### `central()` +### `BLE.central()` Query the central Bluetooth® Low Energy device connected. @@ -685,7 +685,7 @@ None ``` -### `setAdvertisingInterval()` +### `BLE.setAdvertisingInterval()` Set the advertising interval in units of 0.625 ms. Defaults to 100ms (160 * 0.625 ms) if not provided. @@ -723,7 +723,7 @@ Nothing. ``` -### `setConnectionInterval()` +### `BLE.setConnectionInterval()` Set the minimum and maximum desired connection intervals in units of 1.25 ms. @@ -761,7 +761,7 @@ Nothing. ``` -### `setConnectable()` +### `BLE.setConnectable()` Set if the device is connectable after advertising, defaults to **true**. @@ -799,7 +799,7 @@ Nothing. ``` -### `scan()` +### `BLE.scan()` Start scanning for Bluetooth® Low Energy devices that are advertising. @@ -845,7 +845,7 @@ BLE.scan(withDuplicates) ``` -### `scanForName()` +### `BLE.scanForName()` Start scanning for Bluetooth® Low Energy devices that are advertising with a particular (local) name. @@ -892,7 +892,7 @@ BLE.scanForName(name, withDuplicates) ``` -### `scanForAddress()` +### `BLE.scanForAddress()` Start scanning for Bluetooth® Low Energy devices that are advertising with a particular (Bluetooth®) address. @@ -939,7 +939,7 @@ BLE.scanForAddress(address, withDuplicates) ``` -### `scanForUuid()` +### `BLE.scanForUuid()` Start scanning for Bluetooth® Low Energy devices that are advertising with a particular (service) UUID. @@ -986,7 +986,7 @@ BLE.scanForUuid(uuid, withDuplicates) ``` -### `stopScan()` +### `BLE.stopScan()` Stop scanning for Bluetooth® Low Energy devices that are advertising. @@ -1026,7 +1026,7 @@ Nothing ``` -### `available()` +### `BLE.available()` Query for a discovered Bluetooth® Low Energy device that was found during scanning. @@ -1075,7 +1075,7 @@ Nothing Used to get information about the devices connected or discovered while scanning -### `poll()` +### `bleDevice.poll()` Poll for Bluetooth® Low Energy radio events for the specified Bluetooth® Low Energy device and handle them. @@ -1113,7 +1113,7 @@ Nothing ``` -### `connected()` +### `bleDevice.connected()` Query if a Bluetooth® Low Energy device is connected @@ -1147,7 +1147,7 @@ None ``` -### `disconnect()` +### `bleDevice.disconnect()` Disconnect the Bluetooth® Low Energy device, if connected @@ -1179,7 +1179,7 @@ None ``` -### `address()` +### `bleDevice.address()` Query the Bluetooth® address of the Bluetooth® Low Energy device. @@ -1216,7 +1216,7 @@ The **Bluetooth® address** of the Bluetooth® Low Energy device (as a String). ``` -### `rssi()` +### `bleDevice.rssi()` Query the RSSI (Received signal strength indication) of the Bluetooth® Low Energy device. @@ -1248,7 +1248,7 @@ The **RSSI** of the connected Bluetooth® Low Energy device, 127 if the Bluetoot ``` -### `characteristic()` +### `bleDevice.characteristic()` Get a BLECharacteristic representing a Bluetooth® Low Energy characteristic the device provides. @@ -1325,7 +1325,7 @@ bleDevice.characteristic(uuid, index) ``` -### `discoverAttributes()` +### `bleDevice.discoverAttributes()` Discover all of the attributes of Bluetooth® Low Energy device. @@ -1391,7 +1391,7 @@ None ``` -### `discoverService()` +### `bleDevice.discoverService()` Discover the attributes of a particular service on the Bluetooth® Low Energy device. @@ -1457,7 +1457,7 @@ bleDevice.discoverService(serviceUuid) ``` -### `deviceName()` +### `bleDevice.deviceName()` Query the device name (BLE characteristic UUID 0x2a00) of a Bluetooth® Low Energy device. @@ -1531,7 +1531,7 @@ None ``` -### `appearance()` +### `bleDevice.appearance()` Query the appearance (BLE characteristic UUID 0x2a01) of a Bluetooth® Low Energy device. @@ -1605,7 +1605,7 @@ None ``` -### `serviceCount()` +### `bleDevice.serviceCount()` Query the number of services discovered for the Bluetooth® Low Energy device. @@ -1676,7 +1676,7 @@ The number of **services discovered** for the Bluetooth® Low Energy device. ``` -### `hasService()` +### `bleDevice.hasService()` Query if the Bluetooth® Low Energy device has a particular service. @@ -1748,7 +1748,7 @@ bleDevice.hasService(uuid, index) ``` -### `service()` +### `bleDevice.service()` Get a BLEService representing a Bluetooth® Low Energy service the device provides. @@ -1825,7 +1825,7 @@ bleDevice.service(uuid, index) ``` -### `characteristicCount()` +### `bleDevice.characteristicCount()` Query the number of characteristics discovered for the Bluetooth® Low Energy device. @@ -1896,7 +1896,7 @@ The **number of characteristics** discovered for the Bluetooth® Low Energy devi ``` -### `hasCharacteristic()` +### `bleDevice.hasCharacteristic()` Query if the Bluetooth® Low Energy device has a particular characteristic. @@ -1968,7 +1968,7 @@ bleDevice.hasCharacteristic(uuid, index) ``` -### `hasLocalName()` +### `bleDevice.hasLocalName()` Query if a discovered Bluetooth® Low Energy device is advertising a local name. @@ -2021,7 +2021,7 @@ Nothing ``` -### `hasAdvertisedServiceUuid()` +### `bleDevice.hasAdvertisedServiceUuid()` Query if a discovered Bluetooth® Low Energy device is advertising a service UUID. @@ -2079,7 +2079,7 @@ bleDevice.hasAdvertisedServiceUuid(index) ``` -### `advertisedServiceUuidCount()` +### `bleDevice.advertisedServiceUuidCount()` Query the number of advertised services a discovered Bluetooth® Low Energy device is advertising. @@ -2136,7 +2136,7 @@ The **number of advertised services** a discovered Bluetooth® Low Energy device ``` -### `localName()` +### `bleDevice.localName()` Query the local name a discovered Bluetooth® Low Energy device is advertising with. @@ -2189,7 +2189,7 @@ Nothing ``` -### `advertisedServiceUuid()` +### `bleDevice.advertisedServiceUuid()` Query an advertised service UUID discovered Bluetooth® Low Energy device is advertising. @@ -2247,7 +2247,7 @@ Advertised service **UUID** (as a String). ``` -### `connect()` +### `bleDevice.connect()` Connect to a Bluetooth® Low Energy device. @@ -2334,7 +2334,7 @@ BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // Bluetooth® Lo ``` -### `uuid()` +### `bleService.uuid()` Query the UUID of the specified BLEService. @@ -2366,7 +2366,7 @@ Serial.println(ledService.uuid()); ``` -### `addCharacteristic()` +### `bleService.addCharacteristic()` Add a BLECharateristic to the Bluetooth® Low Energy service. @@ -2403,7 +2403,7 @@ ledService.addCharacteristic(switchCharacteristic); ``` -### `characteristicCount()` +### `bleService.characteristicCount()` Query the number of characteristics discovered for the Bluetooth® Low Energy service. @@ -2481,7 +2481,7 @@ The **number of characteristics** discovered for the Bluetooth® Low Energy serv ``` -### `hasCharacteristic()` +### `bleService.hasCharacteristic()` Query if the Bluetooth® Low Energy service has a particular characteristic. @@ -2559,7 +2559,7 @@ bleService.hasCharacteristic(uuid, index) ``` -### `characteristic()` +### `bleService.characteristic()` Get a BLECharacteristic representing a Bluetooth® Low Energy characteristic the service provides. @@ -2695,7 +2695,7 @@ BLEUnsignedCharCharacteristic batteryLevelChar("2A19", // standard 16-bit chara ``` -### `uuid()` +### `bleCharacteristic.uuid()` Query the UUID of the specified BLECharacteristic. @@ -2728,7 +2728,7 @@ Serial.println(switchCharacteristic.uuid()); ``` -### `properties()` +### `bleCharacteristic.properties()` Query the property mask of the specified BLECharacteristic. @@ -2767,7 +2767,7 @@ if (properties & (BLEWrite | BLEWriteWithoutResponse)) { ``` -### `valueSize()` +### `bleCharacteristic.valueSize()` Query the maximum value size of the specified BLECharacteristic. @@ -2800,7 +2800,7 @@ Serial.println(switchCharacteristic.valueSize()); ``` -### `value()` +### `bleCharacteristic.value()` Query the current value of the specified BLECharacteristic. @@ -2839,7 +2839,7 @@ BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214 ``` -### `valueLength()` +### `bleCharacteristic.valueLength()` Query the current value size of the specified BLECharacteristic. @@ -2872,7 +2872,7 @@ Serial.println(switchCharacteristic.valueLength()); ``` -### `readValue()` +### `bleCharacteristic.readValue()` Read the current value of the characteristic. If the characteristic is on a remote device, a read request will be sent. @@ -2921,7 +2921,7 @@ Number of bytes read ``` -### `writeValue()` +### `bleCharacteristic.writeValue()` Write the value of the characteristic. If the characteristic is on a remote device, a write request or command will be sent. @@ -2969,7 +2969,7 @@ bleCharacteristic.writeValue(value) ``` -### `setEventHandler()` +### `bleCharacteristic.setEventHandler()` Set the event handler (callback) function that will be called when the specified event occurs. @@ -3020,7 +3020,7 @@ void switchCharacteristicWritten(BLEDevice central, BLECharacteristic characteri ``` -### `broadcast()` +### `bleCharacteristic.broadcast()` Broadcast the characteristics value as service data when advertising. @@ -3053,7 +3053,7 @@ buttonCharacteristic.broadcast(); ``` -### `written()` +### `bleCharacteristic.written()` Query if the characteristic value has been written by another Bluetooth® Low Energy device. @@ -3115,7 +3115,7 @@ BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214 ``` -### `subscribed()` +### `bleCharacteristic.subscribed()` Query if the characteristic has been subscribed to by another Bluetooth® Low Energy device. @@ -3153,7 +3153,7 @@ BLEUnsignedCharCharacteristic batteryLevelChar("2A19", // standard 16-bit chara ``` -### `addDescriptor()` +### `bleCharacteristic.addDescriptor()` Add a BLEDescriptor to the characteristic. @@ -3190,7 +3190,7 @@ BLEDescriptor batteryLevelDescriptor("2901", "millis"); ``` -### `descriptorCount` +### `bleCharacteristic.descriptorCount` Query the number of Bluetooth® Low Energy descriptors discovered for the characteristic. @@ -3222,7 +3222,7 @@ The **number of Bluetooth® Low Energy descriptors** discovered for the characte ``` -### `hasDescriptor` +### `bleCharacteristic.hasDescriptor` Check if a characteristic has a particular descriptor. @@ -3253,7 +3253,7 @@ bleCharacteristic.hasDescriptor(uuid, index) ``` -### `descriptor()` +### `bleCharacteristic.descriptor()` Get a BLEDescriptor that represents a characteristics Bluetooth® Low Energy descriptor. @@ -3285,7 +3285,7 @@ BLEDescriptor that represents a characteristics Bluetooth® Low Energy descripto ``` -### `canRead()` +### `bleCharacteristic.canRead()` Query if a Bluetooth® Low Energy characteristic is readable. @@ -3347,7 +3347,7 @@ None ``` -### `canWrite()` +### `bleCharacteristic.canWrite()` Query if a Bluetooth® Low Energy characteristic is writable. @@ -3376,7 +3376,7 @@ None ``` -### `canSubscribe()` +### `bleCharacteristic.canSubscribe()` Query if a Bluetooth® Low Energy characteristic is subscribable. @@ -3405,7 +3405,7 @@ None ``` -### `subscribe()` +### `bleCharacteristic.subscribe()` Subscribe to a Bluetooth® Low Energy characteristics notification or indications. @@ -3453,7 +3453,7 @@ None ``` -### `canUnsubscribe()` +### `bleCharacteristic.canUnsubscribe()` Query if a Bluetooth® Low Energy characteristic is unsubscribable. @@ -3482,7 +3482,7 @@ None ``` -### `unsubscribe()` +### `bleCharacteristic.unsubscribe()` Unsubscribe to a Bluetooth® Low Energy characteristics notifications or indications. @@ -3532,7 +3532,7 @@ None ``` -### `valueUpdated()` +### `bleCharacteristic.valueUpdated()` Has the characteristics value been updated via a notification or indication. @@ -3614,7 +3614,7 @@ BLEDescriptor millisLabelDescriptor("2901", "millis"); ``` -### `uuid()` +### `bleDescriptor.uuid()` Query the UUID of the specified BLEDescriptor. @@ -3646,7 +3646,7 @@ Serial.println(millisLabelDescriptor.uuid()); ``` -### `valueSize()` +### `bleDescriptor.valueSize()` Query the value size of the specified BLEDescriptor. @@ -3678,7 +3678,7 @@ Serial.println(millisLabelDescriptor.valueSize()); ``` -### `valueLength()` +### `bleDescriptor.valueLength()` Query the length, in bytes, of the descriptor current value. @@ -3724,7 +3724,7 @@ None ``` -### `value()` +### `bleDescriptor.value()` Query the value of the specified BLEDescriptor. @@ -3761,7 +3761,7 @@ BLEDescriptor millisLabelDescriptor("2901", "millis"); ``` -### `readValue()` +### `bleDescriptor.readValue()` Read the current value of the descriptor. If the descriptor is on a remote device, a read request will be sent. @@ -3795,7 +3795,7 @@ bleDescriptor.readValue(value) ``` -### `read()` +### `bleDescriptor.read()` Perform a read request for the descriptor. From 4cf376eb39ae1ae623ade8d48f03f729aae44124 Mon Sep 17 00:00:00 2001 From: Maciej Klemarczyk Date: Thu, 7 Apr 2022 20:10:01 +0200 Subject: [PATCH 36/83] Unification of documentation --- docs/api.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api.md b/docs/api.md index b8fa1d5f..f3a7bc43 100644 --- a/docs/api.md +++ b/docs/api.md @@ -3190,7 +3190,7 @@ BLEDescriptor batteryLevelDescriptor("2901", "millis"); ``` -### `bleCharacteristic.descriptorCount` +### `bleCharacteristic.descriptorCount()` Query the number of Bluetooth® Low Energy descriptors discovered for the characteristic. @@ -3222,7 +3222,7 @@ The **number of Bluetooth® Low Energy descriptors** discovered for the characte ``` -### `bleCharacteristic.hasDescriptor` +### `bleCharacteristic.hasDescriptor()` Check if a characteristic has a particular descriptor. From 6438f81904d1cc4b63fcd2ca669c9893a9a950c5 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 11 Apr 2022 09:39:54 +0000 Subject: [PATCH 37/83] Bump actions/download-artifact from 2 to 3 Bumps [actions/download-artifact](https://github.com/actions/download-artifact) from 2 to 3. - [Release notes](https://github.com/actions/download-artifact/releases) - [Commits](https://github.com/actions/download-artifact/compare/v2...v3) --- updated-dependencies: - dependency-name: actions/download-artifact dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- .github/workflows/sync-labels.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/sync-labels.yml b/.github/workflows/sync-labels.yml index 4ea57559..e84e803e 100644 --- a/.github/workflows/sync-labels.yml +++ b/.github/workflows/sync-labels.yml @@ -108,7 +108,7 @@ jobs: uses: actions/checkout@v3 - name: Download configuration files artifact - uses: actions/download-artifact@v2 + uses: actions/download-artifact@v3 with: name: ${{ env.CONFIGURATIONS_ARTIFACT }} path: ${{ env.CONFIGURATIONS_FOLDER }} From 785ef5cbb3622dff711f619467b742641847df2c Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 11 Apr 2022 09:39:58 +0000 Subject: [PATCH 38/83] Bump actions/upload-artifact from 2 to 3 Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 2 to 3. - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](https://github.com/actions/upload-artifact/compare/v2...v3) --- updated-dependencies: - dependency-name: actions/upload-artifact dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- .github/workflows/sync-labels.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/sync-labels.yml b/.github/workflows/sync-labels.yml index 4ea57559..1d969d57 100644 --- a/.github/workflows/sync-labels.yml +++ b/.github/workflows/sync-labels.yml @@ -70,7 +70,7 @@ jobs: file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/${{ matrix.filename }} - name: Pass configuration files to next job via workflow artifact - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: path: | *.yaml From b94ff5f28e6d39fb39aa6de339113540bd3e294c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jacob=20Hyl=C3=A9n?= <60390259+jacobhylen@users.noreply.github.com> Date: Fri, 29 Apr 2022 11:23:39 +0200 Subject: [PATCH 39/83] Update api.md Bullet points in ### Parameters and ### Returns. --- docs/api.md | 287 +++++++++++++++++++++++++++++----------------------- 1 file changed, 159 insertions(+), 128 deletions(-) diff --git a/docs/api.md b/docs/api.md index df285806..1ed8e6bb 100644 --- a/docs/api.md +++ b/docs/api.md @@ -20,7 +20,8 @@ BLE.begin() None #### Returns -1 on success, 0 on failure. +- 1 on success +- 0 on failure #### Example @@ -119,8 +120,8 @@ BLE.setEventHandler(eventType, callback) #### Parameters -**eventType**: event type (BLEConnected, BLEDisconnected) -**callback**: function to call when event occurs +- **eventType**: event type (BLEConnected, BLEDisconnected) +- **callback**: function to call when event occurs #### Returns Nothing. @@ -175,7 +176,8 @@ BLE.connected() None #### Returns -**true** if another Bluetooth® Low Energy device is connected, otherwise **false**. +- **true** if another Bluetooth® Low Energy device is connected, +- otherwise **false**. #### Example @@ -206,7 +208,8 @@ BLE.disconnect() None #### Returns -**true** if any Bluetooth® Low Energy device that was previously connected was disconnected, otherwise **false**. +- **true** if any Bluetooth® Low Energy device that was previously connected was disconnected, +- otherwise **false**. #### Example @@ -237,7 +240,7 @@ BLE.address() None #### Returns -The **Bluetooth® address** of the Bluetooth® Low Energy device (as a String). +- The **Bluetooth® address** of the Bluetooth® Low Energy device (as a String). #### Example @@ -267,7 +270,7 @@ BLE.rssi() None #### Returns -The **RSSI** of the connected Bluetooth® Low Energy device, 127 if no Bluetooth® Low Energy device is connected. +- The **RSSI** of the connected Bluetooth® Low Energy device, 127 if no Bluetooth® Low Energy device is connected. #### Example @@ -296,7 +299,7 @@ BLE.setAdvertisedServiceUuid(uuid) #### Parameters -**uuid:** 16-bit or 128-bit Bluetooth® Low Energy UUID in **String** format +- **uuid:** 16-bit or 128-bit Bluetooth® Low Energy UUID in **String** format #### Returns Nothing @@ -335,7 +338,7 @@ BLE.setAdvertisedService(bleService) #### Parameters -**bleService:** BLEService to use UUID from +- **bleService:** BLEService to use UUID from #### Returns Nothing @@ -378,8 +381,8 @@ BLE.setManufacturerData(data, length) #### Parameters -**data:** byte array containing manufacturer data -**length:** length of manufacturer data array +- **data:** byte array containing manufacturer data +- **length:** length of manufacturer data array #### Returns Nothing @@ -421,7 +424,7 @@ BLE.setLocalName(name) #### Parameters -**name:** local name value to use when advertising +- **name:** local name value to use when advertising #### Returns Nothing @@ -461,7 +464,7 @@ BLE.setDeviceName(name) #### Parameters -**name:** device name value +- **name:** device name value #### Returns Nothing @@ -501,7 +504,7 @@ BLE.setAppearance(appearance) #### Parameters -**appearance:** appearance value +- **appearance:** appearance value #### Returns Nothing @@ -541,7 +544,7 @@ BLE.addService(service) #### Parameters -**service:** BLEService to add +- **service:** BLEService to add #### Returns Nothing @@ -586,7 +589,8 @@ BLE.advertise() None #### Returns -1 on success, 0 on failure. +- 1 on success, +- 0 on failure. #### Example @@ -664,7 +668,7 @@ BLE.central() None #### Returns -**BLEDevice** representing the central. +- **BLEDevice** representing the central. #### Example @@ -698,7 +702,7 @@ BLE.setAdvertisingInterval(advertisingInterval) #### Parameters -**advertisingInterval:** advertising interval in units of 0.625 ms +- **advertisingInterval:** advertising interval in units of 0.625 ms #### Returns Nothing. @@ -736,8 +740,8 @@ BLE.setConnectionInterval(minimum, maximum) #### Parameters -**minimum:** minimum desired connection interval in units of 1.25 ms -**maximum:** maximum desired connection interval in units of 1.25 ms +- **minimum:** minimum desired connection interval in units of 1.25 ms +- **maximum:** maximum desired connection interval in units of 1.25 ms #### Returns Nothing. @@ -774,8 +778,8 @@ BLE.setConnectable(connectable) #### Parameters -**true**: the device will be connectable when advertising -**false**: the device will NOT be connectable when advertising +- **true**: the device will be connectable when advertising +- **false**: the device will NOT be connectable when advertising #### Returns Nothing. @@ -813,10 +817,11 @@ BLE.scan(withDuplicates) #### Parameters -**withDuplicates:** optional, defaults to **false**. If **true**, advertisements received more than once will not be filtered +- **withDuplicates:** optional, defaults to **false**. If **true**, advertisements received more than once will not be filtered #### Returns -1 on success, 0 on failure. +- 1 on success, +- 0 on failure. #### Example @@ -859,11 +864,12 @@ BLE.scanForName(name, withDuplicates) #### Parameters -**name:** (local) name of device (as a **String**) to filter for -**withDuplicates:** optional, defaults to **false**. If **true**, advertisements received more than once will not be filtered. +- **name:** (local) name of device (as a **String**) to filter for +- **withDuplicates:** optional, defaults to **false**. If **true**, advertisements received more than once will not be filtered. #### Returns -1 on success, 0 on failure. +- 1 on success, +- 0 on failure. #### Example @@ -906,11 +912,12 @@ BLE.scanForAddress(address, withDuplicates) #### Parameters -**address:** (Bluetooth®) address (as a String) to filter for -**withDuplicates:** optional, defaults to **false**. If **true**, advertisements received more than once will not be filtered +- **address:** (Bluetooth®) address (as a String) to filter for +- **withDuplicates:** optional, defaults to **false**. If **true**, advertisements received more than once will not be filtered #### Returns -1 on success, 0 on failure. +- 1 on success, +- 0 on failure. #### Example @@ -953,11 +960,12 @@ BLE.scanForUuid(uuid, withDuplicates) #### Parameters -**uuid:** (service) UUID (as a **String**) to filter for -**withDuplicates:** optional, defaults to **false**. If **true**, advertisements received more than once will not be filtered. +- **uuid:** (service) UUID (as a **String**) to filter for +- **withDuplicates:** optional, defaults to **false**. If **true**, advertisements received more than once will not be filtered. #### Returns -1 on success, 0 on failure. +- 1 on success, +- 0 on failure. #### Example @@ -1042,7 +1050,7 @@ BLE.available() Nothing #### Returns -**BLEDevice** representing the discovered device. +- **BLEDevice** representing the discovered device. #### Example @@ -1089,7 +1097,7 @@ bleDevice.poll(timeout) #### Parameters -**timeout**: optional timeout in ms, to wait for event. If not specified defaults to 0 ms. +- **timeout**: optional timeout in ms, to wait for event. If not specified defaults to 0 ms. #### Returns Nothing @@ -1129,7 +1137,8 @@ bleDevice.connected() None #### Returns -**true** if the Bluetooth® Low Energy device is connected, otherwise **false**. +- **true** if the Bluetooth® Low Energy device is connected, +- otherwise **false**. #### Example @@ -1163,7 +1172,8 @@ bleDevice.disconnect() None #### Returns -**true** if the Bluetooth® Low Energy device was disconnected, otherwise **false**. +- **true** if the Bluetooth® Low Energy device was disconnected, +- otherwise **false**. #### Example @@ -1195,7 +1205,7 @@ bleDevice.address() None #### Returns -The **Bluetooth® address** of the Bluetooth® Low Energy device (as a String). +- **Bluetooth® address** of the Bluetooth® Low Energy device (as a String). #### Example @@ -1232,7 +1242,7 @@ bleDevice.rssi() None #### Returns -The **RSSI** of the connected Bluetooth® Low Energy device, 127 if the Bluetooth® Low Energy device is not connected. +- **RSSI** of the connected Bluetooth® Low Energy device, 127 if the Bluetooth® Low Energy device is not connected. #### Example @@ -1263,11 +1273,11 @@ bleDevice.characteristic(uuid, index) #### Parameters -**index**: index of characteristic -**uuid**: uuid (as a **String**) +- **index**: index of characteristic +- **uuid**: uuid (as a **String**) #### Returns -**BLECharacteristic** for provided parameters +- **BLECharacteristic** for provided parameters #### Example @@ -1341,7 +1351,8 @@ bleDevice.discoverAttributes() None #### Returns -**true**, if successful, **false** on failure. +- **true**, if successful, +- **false** on failure. #### Example @@ -1404,10 +1415,11 @@ bleDevice.discoverService(serviceUuid) #### Parameters -**serviceUuid:** service UUID to discover (as a **String**) +- **serviceUuid:** service UUID to discover (as a **String**) #### Returns -**true**, if successful, **false** on failure. +- **true**, if successful, +- **false** on failure. #### Example @@ -1473,7 +1485,7 @@ bleDevice.deviceName() None #### Returns -**Device name** (as a String). +- **Device name** (as a String). #### Example @@ -1547,7 +1559,7 @@ bleDevice.appearance() None #### Returns -**Appearance value** (as a number). +- **Appearance value** (as a number). #### Example @@ -1621,7 +1633,7 @@ bleDevice.serviceCount() None #### Returns -The number of **services discovered** for the Bluetooth® Low Energy device. +- The number of **services discovered** for the Bluetooth® Low Energy device. #### Example @@ -1690,11 +1702,12 @@ bleDevice.hasService(uuid, index) #### Parameters -**uuid**: uuid to check (as a **String**) -**index**: optional, index of service to check if the device provides more than on. Defaults to 0, if not provided. +- **uuid**: uuid to check (as a **String**) +- **index**: optional, index of service to check if the device provides more than on. Defaults to 0, if not provided. #### Returns -**true**, if the device provides the service, **false** otherwise. +- **true**, if the device provides the service, +- **false** otherwise. #### Example @@ -1763,11 +1776,11 @@ bleDevice.service(uuid, index) #### Parameters -**index**: index of service -**uuid**: uuid (as a **String**) +- **index**: index of service +- **uuid**: uuid (as a **String**) #### Returns -**BLEService** for provided parameters +- **BLEService** for provided parameters #### Example @@ -1841,7 +1854,7 @@ bleDevice.characteristicCount() None #### Returns -The **number of characteristics** discovered for the Bluetooth® Low Energy device. +- The **number of characteristics** discovered for the Bluetooth® Low Energy device. #### Example @@ -1910,11 +1923,12 @@ bleDevice.hasCharacteristic(uuid, index) #### Parameters -**uuid**: uuid to check (as a **String**) -**index**: optional, index of characteristic to check if the device provides more than on. Defaults to 0, if not provided. +- **uuid**: uuid to check (as a **String**) +- **index**: optional, index of characteristic to check if the device provides more than on. Defaults to 0, if not provided. #### Returns -**true**, if the device provides the characteristic, **false** otherwise. +- **true**, if the device provides the characteristic, +- **false** otherwise. #### Example @@ -1984,7 +1998,8 @@ bleDevice.hasLocalName() Nothing #### Returns -**true**, if the device is advertising a local name, **false** otherwise. +- **true**, if the device is advertising a local name, +- **false** otherwise. #### Example @@ -2035,10 +2050,11 @@ bleDevice.hasAdvertisedServiceUuid(index) #### Parameters -**index**: optional, defaults to 0, the index of the service UUID, if the device is advertising more than one. +- **index**: optional, defaults to 0, the index of the service UUID, if the device is advertising more than one. #### Returns -**true**, if the device is advertising a service UUID, **false** otherwise. +- **true**, if the device is advertising a service UUID, +- **false** otherwise. #### Example @@ -2095,7 +2111,7 @@ bleDevice.advertisedServiceUuidCount() None #### Returns -The **number of advertised services** a discovered Bluetooth® Low Energy device is advertising. +- The **number of advertised services** a discovered Bluetooth® Low Energy device is advertising. #### Example @@ -2152,7 +2168,7 @@ bleDevice.localName() Nothing #### Returns -**Advertised local name** (as a String). +- **Advertised local name** (as a String). #### Example @@ -2203,10 +2219,10 @@ bleDevice.advertisedServiceUuid(index) #### Parameters -**index**: optional, defaults to 0, the index of the **service UUID**, if the device is advertising more than one. +- **index**: optional, defaults to 0, the index of the **service UUID**, if the device is advertising more than one. #### Returns -Advertised service **UUID** (as a String). +- Advertised service **UUID** (as a String). #### Example @@ -2263,7 +2279,8 @@ bleDevice.connect() None #### Returns -**true**, if the connection was successful, **false** otherwise. +- **true**, if the connection was successful, +- **false** otherwise. #### Example @@ -2320,10 +2337,10 @@ BLEService(uuid) #### Parameters -**uuid**: 16-bit or 128-bit UUID in **String** format +- **uuid**: 16-bit or 128-bit UUID in **String** format #### Returns -New **BLEService** with the specified **UUID** +- New **BLEService** with the specified **UUID** #### Example @@ -2350,7 +2367,7 @@ bleService.uuid() None #### Returns -UUID of the Bluetooth® Low Energy service as a **String**. +- UUID of the Bluetooth® Low Energy service as a **String**. #### Example @@ -2419,7 +2436,7 @@ bleService.characteristicCount() None #### Returns -The **number of characteristics** discovered for the Bluetooth® Low Energy service. +- The **number of characteristics** discovered for the Bluetooth® Low Energy service. #### Example @@ -2495,11 +2512,12 @@ bleService.hasCharacteristic(uuid, index) #### Parameters -**uuid**: uuid to check (as a **String**) -**index**: optional, index of characteristic to check if the device provides more than on. Defaults to 0, if not provided. +- **uuid**: uuid to check (as a **String**) +- **index**: optional, index of characteristic to check if the device provides more than on. Defaults to 0, if not provided. #### Returns -**true**, if the service provides the characteristic, **false** otherwise. +- **true**, if the service provides the characteristic, +- **false** otherwise. #### Example @@ -2574,11 +2592,11 @@ bleService.characteristic(uuid, index) #### Parameters -**index**: index of characteristic -**uuid**: uuid (as a **String**) +- **index**: index of characteristic +- **uuid**: uuid (as a **String**) #### Returns -**BLECharacteristic** for provided parameters +- **BLECharacteristic** for provided parameters #### Example @@ -2675,13 +2693,13 @@ BLEDoubleCharacteristic(uuid, properties) #### Parameters -**uuid**: 16-bit or 128-bit UUID in **String** format -**properties**: mask of the properties (BLEBroadcast, BLERead, BLEWriteWithoutResponse, BLEWrite, BLENotify, BLEIndicate) -**valueSize**: (maximum) size of characteristic value -**stringValue**: value as a string +- **uuid**: 16-bit or 128-bit UUID in **String** format +- **properties**: mask of the properties (BLEBroadcast, BLERead, BLEWriteWithoutResponse, BLEWrite, BLENotify, BLEIndicate) +- **valueSize**: (maximum) size of characteristic value +- **stringValue**: value as a string #### Returns -New **BLECharacteristic** with the specified **UUID** and value +- New **BLECharacteristic** with the specified **UUID** and value #### Example @@ -2711,7 +2729,7 @@ bleCharacteristic.uuid() None #### Returns -**UUID** of the Bluetooth® Low Energy service as a **String**. +- **UUID** of the Bluetooth® Low Energy service as a **String**. #### Example @@ -2744,7 +2762,7 @@ bleCharacteristic.properties() None #### Returns -**Properties of the characteristic masked** (BLEBroadcast, BLERead, BLEWriteWithoutResponse, BLEWrite, BLENotify, BLEIndicate) +- **Properties of the characteristic masked** (BLEBroadcast, BLERead, BLEWriteWithoutResponse, BLEWrite, BLENotify, BLEIndicate) #### Example @@ -2783,7 +2801,7 @@ bleCharacteristic.valueSize() None #### Returns -The **maximum value** size of the characteristic (in bytes) +- The **maximum value** size of the characteristic (in bytes) #### Example @@ -2816,7 +2834,7 @@ bleCharacteristic.value() None #### Returns -The **current value** of the characteristic, value type depends on the constructor used +- The **current value** of the characteristic, value type depends on the constructor used #### Example @@ -2855,7 +2873,7 @@ bleCharacteristic.valueLength() None #### Returns -The **current value** size of the characteristic (in bytes) +- The **current value** size of the characteristic (in bytes) #### Example @@ -2886,11 +2904,11 @@ bleCharacteristic.readValue(value) #### Parameters -**buffer:** byte array to read value into length: size of buffer argument in bytes -**value**: variable to read value into (by reference) +- **buffer:** byte array to read value into length: size of buffer argument in bytes +- **value**: variable to read value into (by reference) #### Returns -Number of bytes read +- **Number of bytes** read #### Example @@ -2935,12 +2953,13 @@ bleCharacteristic.writeValue(value) #### Parameters -**buffer**: byte array to write value with -**length**: number of bytes of the buffer argument to write -**value**: value to write +- **buffer**: byte array to write value with +- **length**: number of bytes of the buffer argument to write +- **value**: value to write #### Returns -1 on success, 0 on failure +- 1 on success, +- 0 on failure #### Example @@ -2982,8 +3001,8 @@ bleCharacteristic.setEventHandler(eventType, callback) #### Parameters -**eventType**: event type (BLESubscribed, BLEUnsubscribed, BLERead, BLEWritten) -**callback**: function to call when the event occurs +- **eventType**: event type (BLESubscribed, BLEUnsubscribed, BLERead, BLEWritten) +- **callback**: function to call when the event occurs #### Returns Nothing @@ -3036,7 +3055,8 @@ bleCharacteristic.broadcast() None #### Returns -1 on success, 0 on failure +- 1 on success, +- 0 on failure #### Example @@ -3069,7 +3089,8 @@ bleCharacteristic.written() None #### Returns -**true** if the characteristic value has been written by another Bluetooth® Low Energy device, **false** otherwise +- **true** if the characteristic value has been written by another Bluetooth® Low Energy device, +- **false** otherwise #### Example @@ -3131,7 +3152,8 @@ bleCharacteristic.subscribed() None #### Returns -**true** if the characteristic value has been subscribed to by another Bluetooth® Low Energy device, **false** otherwise +- **true** if the characteristic value has been subscribed to by another Bluetooth® Low Energy device, +- **false** otherwise #### Example @@ -3166,7 +3188,7 @@ bleCharacteristic.addDescriptor(bleDescriptor) #### Parameters -**bleDescriptor**: descriptor to add to the characteristic +- **bleDescriptor**: descriptor to add to the characteristic #### Returns Nothing @@ -3206,7 +3228,7 @@ bleCharacteristic.descriptorCount() None #### Returns -The **number of Bluetooth® Low Energy descriptors** discovered for the characteristic +- The **number of Bluetooth® Low Energy descriptors** discovered for the characteristic #### Example @@ -3236,11 +3258,12 @@ bleCharacteristic.hasDescriptor(uuid, index) #### Parameters -**index**: index of descriptor -**uuid**: uuid (as a **String**) +- **index**: index of descriptor +- **uuid**: uuid (as a **String**) #### Returns -**true**, if the characteristic has a matching descriptor, otherwise **false**. +- **true**, if the characteristic has a matching descriptor, +- otherwise **false**. #### Example @@ -3268,11 +3291,11 @@ bleCharacteristic.descriptor(uuid, index) #### Parameters -**index**: index of descriptor -**uuid**: uuid (as a **String**) +- **index**: index of descriptor +- **uuid**: uuid (as a **String**) #### Returns -BLEDescriptor that represents a characteristics Bluetooth® Low Energy descriptor +- BLEDescriptor that represents a characteristics Bluetooth® Low Energy descriptor #### Example @@ -3301,7 +3324,8 @@ bleCharacteristic.canRead() None #### Returns -**true**, if characteristic is readable, **false** otherwise +- **true**, if characteristic is readable, +- **false** otherwise #### Example @@ -3330,7 +3354,8 @@ bleCharacteristic.read() None #### Returns -**true**, if successful, **false** on failure +- **true**, if successful, +- **false** on failure #### Example @@ -3363,7 +3388,8 @@ bleCharacteristic.canWrite() None #### Returns -**true**, if characteristic is writable, **false** otherwise +- **true**, if characteristic is writable, +- **false** otherwise #### Example @@ -3392,7 +3418,8 @@ bleCharacteristic.canSubscribe() None #### Returns -**true**, if characteristic is subscribable, **false** otherwise +- **true**, if characteristic is subscribable, +- **false** otherwise #### Example @@ -3421,7 +3448,8 @@ bleCharacteristic.subscribe() None #### Returns -**true**, on success, **false** on failure +- **true**, on success, +- **false** on failure #### Example @@ -3469,7 +3497,8 @@ bleCharacteristic.canUnsubscribe() None #### Returns -**true**, if characteristic is unsubscribable, **false** otherwise +- **true**, if characteristic is unsubscribable, +- **false** otherwise #### Example @@ -3498,7 +3527,8 @@ bleCharacteristic.unsubscribe() None #### Returns -**true**, on success, **false** on failure +- **true**, on success, +- **false** on failure #### Example @@ -3548,7 +3578,7 @@ bleCharacteristic.valueUpdated() None #### Returns -**true**, if the characteristics value been updated via a notification or indication +- **true**, if the characteristics value been updated via a notification or indication #### Example @@ -3597,13 +3627,13 @@ BLEDescriptor(uuid, stringValue) #### Parameters -**uuid**: 16-bit or 128-bit UUID in string format -**value**: byte array value -**valueSize**: size of byte array value -**stringValue**: value as a string +- **uuid**: 16-bit or 128-bit UUID in string format +- **value**: byte array value +- **valueSize**: size of byte array value +- **stringValue**: value as a string #### Returns -New **BLEDescriptor** with the specified **UUID** and value +- New **BLEDescriptor** with the specified **UUID** and value #### Example @@ -3630,7 +3660,7 @@ bleDescriptor.uuid() None #### Returns -**UUID** of the Bluetooth® Low Energy descriptor (as a String). +- **UUID** of the Bluetooth® Low Energy descriptor (as a String). #### Example @@ -3662,7 +3692,7 @@ bleDescriptor.valueSize() None #### Returns -**Value size** (in bytes) of the Bluetooth® Low Energy descriptor. +- **Value size** (in bytes) of the Bluetooth® Low Energy descriptor. #### Example @@ -3694,7 +3724,7 @@ bleDescriptor.valueLength() None #### Returns -**Length of descriptor** value in bytes. +- **Length of descriptor** value in bytes. #### Example @@ -3740,7 +3770,7 @@ bleDescriptor.value() None #### Returns -Value byte array of the **BLE descriptor**. +- Value byte array of the **BLE descriptor**. #### Example @@ -3775,12 +3805,12 @@ bleDescriptor.readValue(value) #### Parameters -**buffer**: byte array to read value into -**length**: size of buffer argument in bytes -**value**: variable to read value into (by reference) +- **buffer**: byte array to read value into +- **length**: size of buffer argument in bytes +- **value**: variable to read value into (by reference) #### Returns -**Number of bytes** read +- **Number of bytes** read #### Example @@ -3811,7 +3841,8 @@ bleDescriptor.read() None #### Returns -**true**, if successful, **false** on failure +- **true**, if successful, +- **false** on failure #### Example From b39ac7ebf27635ad418c2e5fc2a48c14ef7a2eaa Mon Sep 17 00:00:00 2001 From: giulcioffi Date: Tue, 21 Sep 2021 14:50:24 +0200 Subject: [PATCH 40/83] Add support for NICLA VISION --- src/local/BLELocalDevice.cpp | 9 ++++++--- src/utility/HCIUartTransport.cpp | 2 +- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/src/local/BLELocalDevice.cpp b/src/local/BLELocalDevice.cpp index 45d975a5..bb337a2b 100644 --- a/src/local/BLELocalDevice.cpp +++ b/src/local/BLELocalDevice.cpp @@ -29,6 +29,10 @@ #ifndef BT_REG_ON #define BT_REG_ON PJ_12 #endif +#elif defined(ARDUINO_NICLA_VISION) +#ifndef BT_REG_ON +#define BT_REG_ON PF_14 +#endif #endif BLELocalDevice::BLELocalDevice() @@ -61,7 +65,7 @@ int BLELocalDevice::begin() delay(100); digitalWrite(NINA_RESETN, HIGH); delay(750); -#elif defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) +#elif defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) // BT_REG_ON -> HIGH pinMode(BT_REG_ON, OUTPUT); digitalWrite(BT_REG_ON, HIGH); @@ -134,8 +138,7 @@ void BLELocalDevice::end() #elif defined(ARDUINO_SAMD_NANO_33_IOT) || defined(ARDUINO_NANO_RP2040_CONNECT) // disable the NINA digitalWrite(NINA_RESETN, LOW); -#elif defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) - // BT_REG_ON -> LOW +#elif defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) digitalWrite(BT_REG_ON, LOW); #endif } diff --git a/src/utility/HCIUartTransport.cpp b/src/utility/HCIUartTransport.cpp index 67bc173f..37ce95e7 100644 --- a/src/utility/HCIUartTransport.cpp +++ b/src/utility/HCIUartTransport.cpp @@ -27,7 +27,7 @@ // SerialHCI is already defined in the variant #elif defined(ARDUINO_PORTENTA_H7_M4) // SerialHCI is already defined in the variant -#elif defined(ARDUINO_PORTENTA_H7_M7) +#elif defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) #define SerialHCI Serial2 #else #error "Unsupported board selected!" From 58136fca11465a5b6703b386d9b1f0f1c13ccedf Mon Sep 17 00:00:00 2001 From: Alessandro Ranellucci Date: Thu, 12 May 2022 10:18:17 +0200 Subject: [PATCH 41/83] Bugfix: memory leak caused by variables not being deleted in end(). #192 --- src/utility/GATT.cpp | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/utility/GATT.cpp b/src/utility/GATT.cpp index 373213b9..50af4f6c 100644 --- a/src/utility/GATT.cpp +++ b/src/utility/GATT.cpp @@ -70,7 +70,12 @@ void GATTClass::begin() void GATTClass::end() { - _attributes.clear(); + delete(_genericAccessService); + delete(_deviceNameCharacteristic); + delete(_appearanceCharacteristic); + delete(_genericAttributeService); + delete(_servicesChangedCharacteristic); + clearAttributes(); } void GATTClass::setDeviceName(const char* deviceName) From 3c6a53ae7856ccf7189df7adc9f38079c8371432 Mon Sep 17 00:00:00 2001 From: Alessandro Ranellucci Date: Thu, 12 May 2022 14:01:21 +0200 Subject: [PATCH 42/83] Respect refcounting before freeing dynamically allocated variables --- src/utility/GATT.cpp | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/src/utility/GATT.cpp b/src/utility/GATT.cpp index 50af4f6c..5db7ec55 100644 --- a/src/utility/GATT.cpp +++ b/src/utility/GATT.cpp @@ -70,11 +70,21 @@ void GATTClass::begin() void GATTClass::end() { - delete(_genericAccessService); - delete(_deviceNameCharacteristic); - delete(_appearanceCharacteristic); - delete(_genericAttributeService); - delete(_servicesChangedCharacteristic); + if (_genericAccessService->release() <= 0) + delete(_genericAccessService); + + if (_deviceNameCharacteristic->release() <= 0) + delete(_deviceNameCharacteristic); + + if (_appearanceCharacteristic->release() <= 0) + delete(_appearanceCharacteristic); + + if (_genericAttributeService->release() <= 0) + delete(_genericAttributeService); + + if (_servicesChangedCharacteristic->release() <= 0) + delete(_servicesChangedCharacteristic); + clearAttributes(); } From 122319959ddeb317b2e76ffc4c350f4f2f5804d4 Mon Sep 17 00:00:00 2001 From: Alessandro Ranellucci Date: Thu, 12 May 2022 18:12:46 +0200 Subject: [PATCH 43/83] Call end() upon destruction --- src/utility/GATT.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/utility/GATT.cpp b/src/utility/GATT.cpp index 5db7ec55..3874fb6f 100644 --- a/src/utility/GATT.cpp +++ b/src/utility/GATT.cpp @@ -38,7 +38,7 @@ GATTClass::GATTClass() : GATTClass::~GATTClass() { - clearAttributes(); + end(); } void GATTClass::begin() From f24ba26576fdb74e6be4ec9f704042f059bdd6e6 Mon Sep 17 00:00:00 2001 From: Alessandro Ranellucci Date: Thu, 12 May 2022 15:12:16 +0200 Subject: [PATCH 44/83] Prevent double object deletion --- src/BLECharacteristic.cpp | 4 ++-- src/BLEDescriptor.cpp | 4 ++-- src/BLEService.cpp | 4 ++-- src/local/BLELocalCharacteristic.cpp | 2 +- src/local/BLELocalService.cpp | 2 +- src/remote/BLERemoteCharacteristic.cpp | 2 +- src/remote/BLERemoteDevice.cpp | 2 +- src/remote/BLERemoteService.cpp | 2 +- src/utility/GATT.cpp | 2 +- 9 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/BLECharacteristic.cpp b/src/BLECharacteristic.cpp index 1cfbf489..cb9783ce 100644 --- a/src/BLECharacteristic.cpp +++ b/src/BLECharacteristic.cpp @@ -72,11 +72,11 @@ BLECharacteristic::BLECharacteristic(const BLECharacteristic& other) BLECharacteristic::~BLECharacteristic() { - if (_local && _local->release() <= 0) { + if (_local && _local->release() == 0) { delete _local; } - if (_remote && _remote->release() <= 0) { + if (_remote && _remote->release() == 0) { delete _remote; } } diff --git a/src/BLEDescriptor.cpp b/src/BLEDescriptor.cpp index 7a6736b0..366b89aa 100644 --- a/src/BLEDescriptor.cpp +++ b/src/BLEDescriptor.cpp @@ -72,11 +72,11 @@ BLEDescriptor::BLEDescriptor(const BLEDescriptor& other) BLEDescriptor::~BLEDescriptor() { - if (_local && _local->release() <= 0) { + if (_local && _local->release() == 0) { delete _local; } - if (_remote && _remote->release() <= 0) { + if (_remote && _remote->release() == 0) { delete _remote; } } diff --git a/src/BLEService.cpp b/src/BLEService.cpp index 7b5df148..b3f33739 100644 --- a/src/BLEService.cpp +++ b/src/BLEService.cpp @@ -65,11 +65,11 @@ BLEService::BLEService(const BLEService& other) BLEService::~BLEService() { - if (_local && _local->release() <= 0) { + if (_local && _local->release() == 0) { delete _local; } - if (_remote && _remote->release() <= 0) { + if (_remote && _remote->release() == 0) { delete _remote; } } diff --git a/src/local/BLELocalCharacteristic.cpp b/src/local/BLELocalCharacteristic.cpp index 2cd801b2..63208b05 100644 --- a/src/local/BLELocalCharacteristic.cpp +++ b/src/local/BLELocalCharacteristic.cpp @@ -62,7 +62,7 @@ BLELocalCharacteristic::~BLELocalCharacteristic() for (unsigned int i = 0; i < descriptorCount(); i++) { BLELocalDescriptor* d = descriptor(i); - if (d->release() <= 0) { + if (d->release() == 0) { delete d; } } diff --git a/src/local/BLELocalService.cpp b/src/local/BLELocalService.cpp index 442c5422..58957342 100644 --- a/src/local/BLELocalService.cpp +++ b/src/local/BLELocalService.cpp @@ -33,7 +33,7 @@ BLELocalService::~BLELocalService() for (unsigned int i = 0; i < characteristicCount(); i++) { BLELocalCharacteristic* c = characteristic(i); - if (c->release() <= 0) { + if (c->release() == 0) { delete c; } } diff --git a/src/remote/BLERemoteCharacteristic.cpp b/src/remote/BLERemoteCharacteristic.cpp index e8ac733f..454438b6 100644 --- a/src/remote/BLERemoteCharacteristic.cpp +++ b/src/remote/BLERemoteCharacteristic.cpp @@ -44,7 +44,7 @@ BLERemoteCharacteristic::~BLERemoteCharacteristic() for (unsigned int i = 0; i < descriptorCount(); i++) { BLERemoteDescriptor* d = descriptor(i); - if (d->release() <= 0) { + if (d->release() == 0) { delete d; } } diff --git a/src/remote/BLERemoteDevice.cpp b/src/remote/BLERemoteDevice.cpp index 5a49f26f..1a4a67ab 100644 --- a/src/remote/BLERemoteDevice.cpp +++ b/src/remote/BLERemoteDevice.cpp @@ -50,7 +50,7 @@ void BLERemoteDevice::clearServices() for (unsigned int i = 0; i < serviceCount(); i++) { BLERemoteService* s = service(i); - if (s->release() <= 0) { + if (s->release() == 0) { delete s; } } diff --git a/src/remote/BLERemoteService.cpp b/src/remote/BLERemoteService.cpp index fd5c0ba6..f7461290 100644 --- a/src/remote/BLERemoteService.cpp +++ b/src/remote/BLERemoteService.cpp @@ -31,7 +31,7 @@ BLERemoteService::~BLERemoteService() for (unsigned int i = 0; i < characteristicCount(); i++) { BLERemoteCharacteristic* c = characteristic(i); - if (c->release() <= 0) { + if (c->release() == 0) { delete c; } } diff --git a/src/utility/GATT.cpp b/src/utility/GATT.cpp index 3874fb6f..35adb5f7 100644 --- a/src/utility/GATT.cpp +++ b/src/utility/GATT.cpp @@ -179,7 +179,7 @@ void GATTClass::clearAttributes() for (unsigned int i = 0; i < attributeCount(); i++) { BLELocalAttribute* a = attribute(i); - if (a->release() <= 0) { + if (a->release() == 0) { delete a; } } From 2b72c948b3f2da4287ce69488da9804bb4bb8e5f Mon Sep 17 00:00:00 2001 From: Martino Facchin Date: Mon, 23 May 2022 18:11:19 +0200 Subject: [PATCH 45/83] Don't double-free characteristics --- src/utility/GATT.cpp | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/utility/GATT.cpp b/src/utility/GATT.cpp index 35adb5f7..98d5f4ad 100644 --- a/src/utility/GATT.cpp +++ b/src/utility/GATT.cpp @@ -70,19 +70,19 @@ void GATTClass::begin() void GATTClass::end() { - if (_genericAccessService->release() <= 0) + if (_genericAccessService->release() == 0) delete(_genericAccessService); - if (_deviceNameCharacteristic->release() <= 0) + if (_deviceNameCharacteristic->release() == 0) delete(_deviceNameCharacteristic); - if (_appearanceCharacteristic->release() <= 0) + if (_appearanceCharacteristic->release() == 0) delete(_appearanceCharacteristic); - if (_genericAttributeService->release() <= 0) + if (_genericAttributeService->release() == 0) delete(_genericAttributeService); - if (_servicesChangedCharacteristic->release() <= 0) + if (_servicesChangedCharacteristic->release() == 0) delete(_servicesChangedCharacteristic); clearAttributes(); From afccc49f94fcac2d961e74309b100ba7c9e961d1 Mon Sep 17 00:00:00 2001 From: Martino Facchin Date: Mon, 23 May 2022 18:12:01 +0200 Subject: [PATCH 46/83] Don't terminate CordioHCIHook::getDriver() on end() for Murata chips --- src/utility/HCICordioTransport.cpp | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/utility/HCICordioTransport.cpp b/src/utility/HCICordioTransport.cpp index 28eb97be..4dc8d45e 100644 --- a/src/utility/HCICordioTransport.cpp +++ b/src/utility/HCICordioTransport.cpp @@ -234,7 +234,10 @@ void HCICordioTransportClass::end() delete bleLoopThread; bleLoopThread = NULL; } + +#if !defined(ARDUINO_PORTENTA_H7_M4) && !defined(ARDUINO_PORTENTA_H7_M7) && !defined(ARDUINO_NICLA_VISION) CordioHCIHook::getDriver().terminate(); +#endif _begun = false; } From f0747240daef118d8039280d0a87ab2b40f3d9ea Mon Sep 17 00:00:00 2001 From: Martino Facchin Date: Mon, 30 May 2022 14:55:10 +0200 Subject: [PATCH 47/83] Release 1.3.0 --- library.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.properties b/library.properties index e8859d8e..35afbfaf 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=ArduinoBLE -version=1.2.2 +version=1.3.0 author=Arduino maintainer=Arduino sentence=Enables Bluetooth® Low Energy connectivity on the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, Arduino Nano 33 IoT, Arduino Nano 33 BLE and Nicla Sense ME. From d5bc5b850636be9da59a6c6e147e9d2585433ee4 Mon Sep 17 00:00:00 2001 From: giulcioffi Date: Tue, 31 May 2022 11:37:52 +0200 Subject: [PATCH 48/83] Prepend 'BLE_GATT_' to READ and WRITE enums to avoid clashes with ArduinoIoTCloud lib --- src/BLEProperty.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/BLEProperty.h b/src/BLEProperty.h index 434bd2aa..b9238ba9 100644 --- a/src/BLEProperty.h +++ b/src/BLEProperty.h @@ -63,10 +63,10 @@ enum BLEPermission { #define ESP_GATT_PERM_WRITE_AUTHORIZATION (1 << 10) /* bit 10 - 0x0400 */ enum BLE_GATT_PERM_ { - READ = 1 << 0, + BLE_GATT_READ = 1 << 0, READ_ENCRYPTED = 1 << 1, READ_ENC_MITM = 1 << 2, - WRITE = 1 << 4, + BLE_GATT_WRITE = 1 << 4, WRITE_ENCRYPTED = 1 << 5, WRITE_ENC_MITM = 1 << 6, WRITE_SIGNED = 1 << 7, From f24f335c54311ef05c99102ba5714fe99340f2db Mon Sep 17 00:00:00 2001 From: Martino Facchin Date: Tue, 31 May 2022 18:19:56 +0200 Subject: [PATCH 49/83] Publish 1.3.1 --- library.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.properties b/library.properties index 35afbfaf..e2a3f15f 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=ArduinoBLE -version=1.3.0 +version=1.3.1 author=Arduino maintainer=Arduino sentence=Enables Bluetooth® Low Energy connectivity on the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, Arduino Nano 33 IoT, Arduino Nano 33 BLE and Nicla Sense ME. From 9bf21b767bbc380f69dbfad7168dcc4f469c93b6 Mon Sep 17 00:00:00 2001 From: Karthik <101386306+laviator98@users.noreply.github.com> Date: Thu, 9 Jun 2022 12:50:54 +0530 Subject: [PATCH 50/83] Fix Long Term Key Request Negative Reply Command Kindly See the Docs, https://www.bluetooth.com/specifications/specs/core-specification-4-2/ In Pg. No: 1316/2772, you Can See "7.8.26 LE Long Term Key Request Negative Reply Command". Kindly See the OFC Code, it is 0x001B. --- src/utility/HCI.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/utility/HCI.h b/src/utility/HCI.h index af46265a..b8f88538 100644 --- a/src/utility/HCI.h +++ b/src/utility/HCI.h @@ -35,7 +35,7 @@ enum LE_COMMAND { ENCRYPT = 0x0017, RANDOM = 0x0018, LONG_TERM_KEY_REPLY = 0x001A, - LONG_TERM_KEY_NEGATIVE_REPLY = 0x1B, + LONG_TERM_KEY_NEGATIVE_REPLY = 0x001B, READ_LOCAL_P256 = 0x0025, GENERATE_DH_KEY_V1 = 0x0026, GENERATE_DH_KEY_V2 = 0x005E From fae1e36beeadffadd01624c0c8355ecf0d216149 Mon Sep 17 00:00:00 2001 From: dominsch Date: Tue, 23 Aug 2022 05:46:47 -0300 Subject: [PATCH 51/83] Change non returning functions to void + spelling (#251) --- src/utility/ATT.cpp | 4 ++-- src/utility/HCI.cpp | 8 ++++---- src/utility/HCI.h | 8 ++++---- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/src/utility/ATT.cpp b/src/utility/ATT.cpp index 439b88e8..acdf5a9f 100644 --- a/src/utility/ATT.cpp +++ b/src/utility/ATT.cpp @@ -1272,7 +1272,7 @@ void ATTClass::writeReqOrCmd(uint16_t connectionHandle, uint16_t mtu, uint8_t op } return; } - // Check permssion + // Check permission if((characteristic->permissions() &( BLEPermission::BLEEncryption >> 8)) > 0 && (getPeerEncryption(connectionHandle) & PEER_ENCRYPTION::ENCRYPTED_AES) == 0){ holdResponse = true; @@ -1941,4 +1941,4 @@ int ATTClass::getPeerResolvedAddress(uint16_t connectionHandle, uint8_t resolved #if !defined(FAKE_ATT) ATTClass ATTObj; ATTClass& ATT = ATTObj; -#endif \ No newline at end of file +#endif diff --git a/src/utility/HCI.cpp b/src/utility/HCI.cpp index 773f4f18..bc7bc2da 100644 --- a/src/utility/HCI.cpp +++ b/src/utility/HCI.cpp @@ -460,14 +460,14 @@ int HCIClass::leConnUpdate(uint16_t handle, uint16_t minInterval, uint16_t maxIn return sendCommand(OGF_LE_CTL << 10 | OCF_LE_CONN_UPDATE, sizeof(leConnUpdateData), &leConnUpdateData); } -int HCIClass::saveNewAddress(uint8_t addressType, uint8_t* address, uint8_t* peerIrk, uint8_t* localIrk){ +void HCIClass::saveNewAddress(uint8_t addressType, uint8_t* address, uint8_t* peerIrk, uint8_t* localIrk){ if(_storeIRK!=0){ _storeIRK(address, peerIrk); } // Again... this should work // leAddResolvingAddress(addressType, address, peerIrk, localIrk); } -int HCIClass::leAddResolvingAddress(uint8_t addressType, uint8_t* peerAddress, uint8_t* peerIrk, uint8_t* localIrk){ +void HCIClass::leAddResolvingAddress(uint8_t addressType, uint8_t* peerAddress, uint8_t* peerIrk, uint8_t* localIrk){ leStopResolvingAddresses(); struct __attribute__ ((packed)) AddDevice { @@ -527,7 +527,7 @@ int HCIClass::leReadPeerResolvableAddress(uint8_t peerAddressType, uint8_t* peer return res; } -int HCIClass::writeLK(uint8_t peerAddress[], uint8_t LK[]){ +void HCIClass::writeLK(uint8_t peerAddress[], uint8_t LK[]){ struct __attribute__ ((packed)) StoreLK { uint8_t nKeys; uint8_t BD_ADDR[6]; @@ -538,7 +538,7 @@ int HCIClass::writeLK(uint8_t peerAddress[], uint8_t LK[]){ for(int i=0; i<16; i++) storeLK.LTK[15-i] = LK[i]; HCI.sendCommand(OGF_HOST_CTL << 10 | 0x11, sizeof(storeLK), &storeLK); } -int HCIClass::readStoredLKs(){ +void HCIClass::readStoredLKs(){ uint8_t BD_ADDR[6]; readStoredLK(BD_ADDR, 1); } diff --git a/src/utility/HCI.h b/src/utility/HCI.h index b8f88538..0a530ceb 100644 --- a/src/utility/HCI.h +++ b/src/utility/HCI.h @@ -99,15 +99,15 @@ class HCIClass { virtual AuthReq localAuthreq(); virtual uint8_t localIOCap(); - virtual int saveNewAddress(uint8_t addressType, uint8_t* address, uint8_t* peerIrk, uint8_t* remoteIrk); - virtual int leAddResolvingAddress(uint8_t addressType, uint8_t* address, uint8_t* peerIrk, uint8_t* remoteIrk); + virtual void saveNewAddress(uint8_t addressType, uint8_t* address, uint8_t* peerIrk, uint8_t* remoteIrk); + virtual void leAddResolvingAddress(uint8_t addressType, uint8_t* address, uint8_t* peerIrk, uint8_t* remoteIrk); virtual int leStopResolvingAddresses(); virtual int leStartResolvingAddresses(); virtual int leReadPeerResolvableAddress(uint8_t peerAddressType, uint8_t* peerIdentityAddress, uint8_t* peerResolvableAddress); - virtual int readStoredLKs(); + virtual void readStoredLKs(); virtual int readStoredLK(uint8_t BD_ADDR[], uint8_t read_all = 0); - virtual int writeLK(uint8_t peerAddress[], uint8_t LK[]); + virtual void writeLK(uint8_t peerAddress[], uint8_t LK[]); virtual int tryResolveAddress(uint8_t* BDAddr, uint8_t* address); virtual int sendAclPkt(uint16_t handle, uint8_t cid, uint8_t plen, void* data); From 991f0763bf172cebfebb7cdccbd289ccb2893263 Mon Sep 17 00:00:00 2001 From: dominsch Date: Tue, 23 Aug 2022 05:49:29 -0300 Subject: [PATCH 52/83] Support esp32, esp32-C3, esp32-S3 (#252) * add esp32 support * Update HCIVirtualTransport.cpp * Update HCIVirtualTransport.cpp add ESP32-C3 support * Revert "Update HCIVirtualTransport.cpp" This reverts commit 9af9bea9beb9bc63f9aab68893d414b9a22dacd6. * Update HCIVirtualTransport.cpp * Update library.properties * fix crash on restart * Update ATT.cpp spelling * support more espressif chips * Create compile-for-esp.yaml don't know what I'm doing * skip failing examples * Update compile-for-esp.yaml * Update compile-for-esp.yaml * Update compile-for-esp.yaml * Update compile-for-esp.yaml * Update compile-for-esp.yaml * Update compile-examples.yml * Delete compile-for-esp.yaml --- .github/workflows/compile-examples.yml | 33 ++++++ library.properties | 2 +- src/utility/HCIUartTransport.cpp | 2 +- src/utility/HCIVirtualTransport.cpp | 142 +++++++++++++++++++++++++ src/utility/HCIVirtualTransport.h | 50 +++++++++ 5 files changed, 227 insertions(+), 2 deletions(-) create mode 100644 src/utility/HCIVirtualTransport.cpp create mode 100644 src/utility/HCIVirtualTransport.h diff --git a/.github/workflows/compile-examples.yml b/.github/workflows/compile-examples.yml index a1faf997..b33d6c75 100644 --- a/.github/workflows/compile-examples.yml +++ b/.github/workflows/compile-examples.yml @@ -22,3 +22,36 @@ jobs: with: github-token: ${{ secrets.GITHUB_TOKEN }} fqbn: ${{ matrix.fqbn }} + + build-for-esp32: + runs-on: ubuntu-latest + + strategy: + matrix: + fqbn: + - esp32:esp32:esp32 + - esp32:esp32:esp32s3 + - esp32:esp32:esp32c3 + # future bluetooth chips + #- esp32:esp32:esp32c2 + #- esp32:esp32:esp32c6 + #- esp32:esp32:esp32h2 + + steps: + - uses: actions/checkout@v3 + - uses: arduino/compile-sketches@v1 + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + fqbn: ${{ matrix.fqbn }} + platforms: | + - name: esp32:esp32 + source-url: https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json + sketch-paths: | + - examples/Central/Scan + - examples/Central/PeripheralExplorer + - examples/Central/ScanCallback + - examples/Central/SensorTagButton + - examples/Peripheral/Advertising/EnhancedAdvertising + - examples/Peripheral/Advertising/RawDataAdvertising + cli-compile-flags: | + - --warnings="none" diff --git a/library.properties b/library.properties index e2a3f15f..467d9eaf 100644 --- a/library.properties +++ b/library.properties @@ -6,5 +6,5 @@ sentence=Enables Bluetooth® Low Energy connectivity on the Arduino MKR WiFi 101 paragraph=This library supports creating a Bluetooth® Low Energy peripheral & central mode. category=Communication url=https://www.arduino.cc/en/Reference/ArduinoBLE -architectures=samd,megaavr,mbed,apollo3,mbed_nano,mbed_portenta,mbed_nicla +architectures=samd,megaavr,mbed,apollo3,mbed_nano,mbed_portenta,mbed_nicla,esp32 includes=ArduinoBLE.h diff --git a/src/utility/HCIUartTransport.cpp b/src/utility/HCIUartTransport.cpp index 37ce95e7..1b1a513a 100644 --- a/src/utility/HCIUartTransport.cpp +++ b/src/utility/HCIUartTransport.cpp @@ -17,7 +17,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ -#if !defined(ARDUINO_ARCH_MBED) || defined(TARGET_NANO_RP2040_CONNECT) +#if !defined(ARDUINO_ARCH_MBED) && !defined(ESP32) || defined(TARGET_NANO_RP2040_CONNECT) #include "HCIUartTransport.h" diff --git a/src/utility/HCIVirtualTransport.cpp b/src/utility/HCIVirtualTransport.cpp new file mode 100644 index 00000000..046a0e72 --- /dev/null +++ b/src/utility/HCIVirtualTransport.cpp @@ -0,0 +1,142 @@ +/* + This file is part of the ArduinoBLE library. + Copyright (c) 2018 Arduino SA. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#if defined(ESP32) + +#include "HCIVirtualTransport.h" + +StreamBufferHandle_t rec_buffer; +StreamBufferHandle_t send_buffer; +TaskHandle_t bleHandle; + + +static void notify_host_send_available(void) +{ +} + +static int notify_host_recv(uint8_t *data, uint16_t length) +{ + xStreamBufferSend(rec_buffer,data,length,portMAX_DELAY); // !!!potentially waiting forever + return 0; +} + +static esp_vhci_host_callback_t vhci_host_cb = { + notify_host_send_available, + notify_host_recv +}; + +void bleTask(void *pvParameters) +{ + esp_vhci_host_register_callback(&vhci_host_cb); + size_t length; + uint8_t mybuf[258]; + + while(true){ + length = xStreamBufferReceive(send_buffer,mybuf,258,portMAX_DELAY); + while (!esp_vhci_host_check_send_available()) {} + esp_vhci_host_send_packet(mybuf, length); + } +} + + +HCIVirtualTransportClass::HCIVirtualTransportClass() +{ +} + +HCIVirtualTransportClass::~HCIVirtualTransportClass() +{ +} + +int HCIVirtualTransportClass::begin() +{ + btStarted(); // this somehow stops the arduino ide from initializing bluedroid + + rec_buffer = xStreamBufferCreate(258, 1); + send_buffer = xStreamBufferCreate(258, 1); + + esp_err_t ret = nvs_flash_init(); + if (ret == ESP_ERR_NVS_NO_FREE_PAGES || ret == ESP_ERR_NVS_NEW_VERSION_FOUND) { + ESP_ERROR_CHECK(nvs_flash_erase()); + ret = nvs_flash_init(); + } + esp_bt_controller_config_t bt_cfg = BT_CONTROLLER_INIT_CONFIG_DEFAULT(); + +#if CONFIG_IDF_TARGET_ESP32 + bt_cfg.mode = ESP_BT_MODE_BLE; //original esp32 chip +#else + bt_cfg.bluetooth_mode = ESP_BT_MODE_BLE; //different api for newer models +#endif + + esp_bt_controller_mem_release(ESP_BT_MODE_CLASSIC_BT); + esp_bt_controller_init(&bt_cfg); + esp_bt_controller_enable(ESP_BT_MODE_BLE); + xTaskCreatePinnedToCore(&bleTask, "bleTask", 2048, NULL, 5, &bleHandle, 0); + return 1; +} + +void HCIVirtualTransportClass::end() +{ + vStreamBufferDelete(rec_buffer); + vStreamBufferDelete(send_buffer); + esp_bt_controller_disable(); + esp_bt_controller_deinit(); + vTaskDelete(bleHandle); +} + +void HCIVirtualTransportClass::wait(unsigned long timeout) +{ + for (unsigned long start = (esp_timer_get_time() / 1000ULL); ((esp_timer_get_time() / 1000ULL) - start) < timeout;) { + if (available()) { + break; + } + } +} + +int HCIVirtualTransportClass::available() +{ + size_t bytes = xStreamBufferBytesAvailable(rec_buffer); + return bytes; +} + +// never called +int HCIVirtualTransportClass::peek() +{ + return -1; +} + +int HCIVirtualTransportClass::read() +{ + uint8_t c; + if(xStreamBufferReceive(rec_buffer, &c, 1, portMAX_DELAY)) { + return c; + } + return -1; +} + +size_t HCIVirtualTransportClass::write(const uint8_t* data, size_t length) +{ + size_t result = xStreamBufferSend(send_buffer,data,length,portMAX_DELAY); + return result; +} + +HCIVirtualTransportClass HCIVirtualTransport; + +HCITransportInterface& HCITransport = HCIVirtualTransport; + +#endif diff --git a/src/utility/HCIVirtualTransport.h b/src/utility/HCIVirtualTransport.h new file mode 100644 index 00000000..0da43cac --- /dev/null +++ b/src/utility/HCIVirtualTransport.h @@ -0,0 +1,50 @@ +/* + This file is part of the ArduinoBLE library. + Copyright (c) 2018 Arduino SA. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#include "HCITransport.h" +#include +#include +#include + +#include "freertos/FreeRTOS.h" +#include "freertos/task.h" +#include "freertos/stream_buffer.h" + +#include "esp_bt.h" +#include "nvs_flash.h" + +#include "esp32-hal-bt.h" // this is needed to disable bluedroid + + +class HCIVirtualTransportClass : public HCITransportInterface { +public: + HCIVirtualTransportClass(); + virtual ~HCIVirtualTransportClass(); + + virtual int begin(); + virtual void end(); + + virtual void wait(unsigned long timeout); + + virtual int available(); + virtual int peek(); + virtual int read(); + + virtual size_t write(const uint8_t* data, size_t length); +}; \ No newline at end of file From cd9cbad71af82c939455b8ad446da766adc17a71 Mon Sep 17 00:00:00 2001 From: Giuseppe Roberti Date: Tue, 30 Aug 2022 11:55:17 +0200 Subject: [PATCH 53/83] Fix hard fault when str is NULL --- src/utility/BLEUuid.cpp | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/utility/BLEUuid.cpp b/src/utility/BLEUuid.cpp index fba6244a..0465ea9a 100644 --- a/src/utility/BLEUuid.cpp +++ b/src/utility/BLEUuid.cpp @@ -30,6 +30,11 @@ BLEUuid::BLEUuid(const char * str) : memset(_data, 0x00, sizeof(_data)); _length = 0; + + if (str == NULL) { + return; + } + for (int i = strlen(str) - 1; i >= 0 && _length < BLE_UUID_MAX_LENGTH; i -= 2) { if (str[i] == '-') { i++; From 6e97bf2a3753ffff071b60a762f8178084f702b2 Mon Sep 17 00:00:00 2001 From: Martino Facchin Date: Wed, 31 Aug 2022 18:05:06 +0200 Subject: [PATCH 54/83] Fix memory leak on end() -> begin() -> end() Only tested in Peripheral mode, with services and characteristics allocated: * as global objects (arduino way) * in function stack * in heap On mbed-enabled platforms, the memory check can be activated via ``` .... mbed_stats_heap_t heap_stats; mbed_stats_heap_get(&heap_stats); Serial.print("Heap size: "); Serial.print(heap_stats.current_size); Serial.print(" / "); Serial.println(heap_stats.reserved_size); .... ``` --- src/BLEService.cpp | 7 +++++++ src/BLEService.h | 1 + src/local/BLELocalAttribute.cpp | 5 +++++ src/local/BLELocalAttribute.h | 1 + src/local/BLELocalCharacteristic.cpp | 1 + src/local/BLELocalService.cpp | 9 +++++++-- src/local/BLELocalService.h | 1 + src/utility/GATT.cpp | 9 ++++++++- src/utility/GATT.h | 1 + 9 files changed, 32 insertions(+), 3 deletions(-) diff --git a/src/BLEService.cpp b/src/BLEService.cpp index b3f33739..ed54f9ff 100644 --- a/src/BLEService.cpp +++ b/src/BLEService.cpp @@ -63,6 +63,13 @@ BLEService::BLEService(const BLEService& other) } } +void BLEService::clear() +{ + if (_local) { + _local->clear(); + } +} + BLEService::~BLEService() { if (_local && _local->release() == 0) { diff --git a/src/BLEService.h b/src/BLEService.h index a8d8b010..5b2440d8 100644 --- a/src/BLEService.h +++ b/src/BLEService.h @@ -33,6 +33,7 @@ class BLEService { virtual ~BLEService(); const char* uuid() const; + void clear(); void addCharacteristic(BLECharacteristic& characteristic); diff --git a/src/local/BLELocalAttribute.cpp b/src/local/BLELocalAttribute.cpp index ce3010a0..9929fa41 100644 --- a/src/local/BLELocalAttribute.cpp +++ b/src/local/BLELocalAttribute.cpp @@ -56,6 +56,11 @@ int BLELocalAttribute::retain() return _refCount; } +bool BLELocalAttribute::active() +{ + return _refCount > 0; +} + int BLELocalAttribute::release() { _refCount--; diff --git a/src/local/BLELocalAttribute.h b/src/local/BLELocalAttribute.h index 2af948c3..53a0abfe 100644 --- a/src/local/BLELocalAttribute.h +++ b/src/local/BLELocalAttribute.h @@ -44,6 +44,7 @@ class BLELocalAttribute int retain(); int release(); + bool active(); protected: friend class ATTClass; diff --git a/src/local/BLELocalCharacteristic.cpp b/src/local/BLELocalCharacteristic.cpp index 63208b05..ef19e726 100644 --- a/src/local/BLELocalCharacteristic.cpp +++ b/src/local/BLELocalCharacteristic.cpp @@ -46,6 +46,7 @@ BLELocalCharacteristic::BLELocalCharacteristic(const char* uuid, uint16_t permis if (permissions & (BLENotify | BLEIndicate)) { BLELocalDescriptor* cccd = new BLELocalDescriptor("2902", (uint8_t*)&_cccdValue, sizeof(_cccdValue)); + cccd->retain(); _descriptors.add(cccd); } diff --git a/src/local/BLELocalService.cpp b/src/local/BLELocalService.cpp index 58957342..7fda3cb4 100644 --- a/src/local/BLELocalService.cpp +++ b/src/local/BLELocalService.cpp @@ -28,6 +28,12 @@ BLELocalService::BLELocalService(const char* uuid) : { } +void BLELocalService::clear() { + _characteristics.clear(); + _startHandle = 0; + _endHandle = 0; +} + BLELocalService::~BLELocalService() { for (unsigned int i = 0; i < characteristicCount(); i++) { @@ -37,8 +43,7 @@ BLELocalService::~BLELocalService() delete c; } } - - _characteristics.clear(); + clear(); } enum BLEAttributeType BLELocalService::type() const diff --git a/src/local/BLELocalService.h b/src/local/BLELocalService.h index e0179a93..f17c610c 100644 --- a/src/local/BLELocalService.h +++ b/src/local/BLELocalService.h @@ -36,6 +36,7 @@ class BLELocalService : public BLELocalAttribute { virtual enum BLEAttributeType type() const; void addCharacteristic(BLECharacteristic& characteristic); + void clear(); protected: friend class ATTClass; diff --git a/src/utility/GATT.cpp b/src/utility/GATT.cpp index 98d5f4ad..be914f6f 100644 --- a/src/utility/GATT.cpp +++ b/src/utility/GATT.cpp @@ -149,6 +149,7 @@ void GATTClass::addService(BLELocalService* service) { service->retain(); _attributes.add(service); + _services.add(service); uint16_t startHandle = attributeCount(); @@ -160,6 +161,7 @@ void GATTClass::addService(BLELocalService* service) characteristic->setHandle(attributeCount()); // add the characteristic again to make space of the characteristic value handle + characteristic->retain(); _attributes.add(characteristic); for (unsigned int j = 0; j < characteristic->descriptorCount(); j++) { @@ -183,8 +185,13 @@ void GATTClass::clearAttributes() delete a; } } - _attributes.clear(); + + for (unsigned int i = 0; i < _services.size(); i++) { + _services.get(i)->clear(); + } + _services.clear(); + } #if !defined(FAKE_GATT) diff --git a/src/utility/GATT.h b/src/utility/GATT.h index fd916709..51d1537e 100644 --- a/src/utility/GATT.h +++ b/src/utility/GATT.h @@ -59,6 +59,7 @@ class GATTClass { private: BLELinkedList _attributes; + BLELinkedList _services; BLELocalService* _genericAccessService; BLELocalCharacteristic* _deviceNameCharacteristic; From b5fc368db01e67fc706e231d5fd70ee4ec50353d Mon Sep 17 00:00:00 2001 From: BBear <13687227078@163.com> Date: Wed, 31 Aug 2022 19:13:15 +0200 Subject: [PATCH 55/83] fix the potential overflow problem of leAdvertisingReport->eirData --- src/utility/HCI.cpp | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/utility/HCI.cpp b/src/utility/HCI.cpp index bc7bc2da..1902abe7 100644 --- a/src/utility/HCI.cpp +++ b/src/utility/HCI.cpp @@ -1116,6 +1116,10 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) uint8_t eirData[31]; } *leAdvertisingReport = (EvtLeAdvertisingReport*)&pdata[sizeof(HCIEventHdr) + sizeof(LeMetaEventHeader)]; + if(leAdvertisingReport->eirLength > sizeof(leAdvertisingReport->eirData)){ + return ; + } + if (leAdvertisingReport->status == 0x01) { // last byte is RSSI int8_t rssi = leAdvertisingReport->eirData[leAdvertisingReport->eirLength]; From dd56eb7e13213a477ad57171c2e334897892fad0 Mon Sep 17 00:00:00 2001 From: Martino Facchin Date: Mon, 5 Sep 2022 14:43:17 +0200 Subject: [PATCH 56/83] Release 1.3.2 --- library.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.properties b/library.properties index 467d9eaf..0648b56a 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=ArduinoBLE -version=1.3.1 +version=1.3.2 author=Arduino maintainer=Arduino sentence=Enables Bluetooth® Low Energy connectivity on the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, Arduino Nano 33 IoT, Arduino Nano 33 BLE and Nicla Sense ME. From 07d249acb64f07b2fa338355c7852d519d328b72 Mon Sep 17 00:00:00 2001 From: Steve Allasia <40604011+sallasia@users.noreply.github.com> Date: Mon, 3 Oct 2022 15:07:44 +0200 Subject: [PATCH 57/83] Fix BLE scanning block after few minutes --- src/utility/GAP.cpp | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/src/utility/GAP.cpp b/src/utility/GAP.cpp index f3ee32fa..08c9c3f0 100644 --- a/src/utility/GAP.cpp +++ b/src/utility/GAP.cpp @@ -22,7 +22,7 @@ #include "GAP.h" -#define GAP_MAX_DISCOVERED_QUEUE_SIZE 5 +#define GAP_MAX_DISCOVERED_QUEUE_SIZE 32 #define GAP_ADV_IND (0x00) #define GAP_ADV_SCAN_IND (0x02) @@ -86,8 +86,14 @@ int GAPClass::scan(bool withDuplicates) { HCI.leSetScanEnable(false, true); - // active scan, 10 ms scan interval (N * 0.625), 10 ms scan window (N * 0.625), public own address type, no filter - if (HCI.leSetScanParameters(0x01, 0x0010, 0x0010, 0x00, 0x00) != 0) { + // active scan, 20 ms scan interval (N * 0.625), 20 ms scan window (N * 0.625), public own address type, no filter + /* + Warning (from BLUETOOTH SPECIFICATION 5.x): + - scan interval: mandatory range from 0x0012 to 0x1000; only even values are valid + - scan window: mandatory range from 0x0011 to 0x1000 + - The scan window can only be less than or equal to the scan interval + */ + if (HCI.leSetScanParameters(0x01, 0x0020, 0x0020, 0x00, 0x00) != 0) { return false; } @@ -216,8 +222,11 @@ void GAPClass::handleLeAdvertisingReport(uint8_t type, uint8_t addressType, uint if (discoveredDevice == NULL) { if (_discoveredDevices.size() >= GAP_MAX_DISCOVERED_QUEUE_SIZE) { - // drop - return; + // delete data in first list posistion + BLEDevice* device_first = _discoveredDevices.remove(0); + if (device_first != NULL) { + delete device_first; + } } discoveredDevice = new BLEDevice(addressType, address); From c928892cc1eb89de2a112bdf0844fc5252067ccc Mon Sep 17 00:00:00 2001 From: Steve Allasia <40604011+sallasia@users.noreply.github.com> Date: Mon, 3 Oct 2022 15:26:48 +0200 Subject: [PATCH 58/83] Update GAP.cpp Removed comment --- src/utility/GAP.cpp | 1 - 1 file changed, 1 deletion(-) diff --git a/src/utility/GAP.cpp b/src/utility/GAP.cpp index 08c9c3f0..f1bf02fe 100644 --- a/src/utility/GAP.cpp +++ b/src/utility/GAP.cpp @@ -222,7 +222,6 @@ void GAPClass::handleLeAdvertisingReport(uint8_t type, uint8_t addressType, uint if (discoveredDevice == NULL) { if (_discoveredDevices.size() >= GAP_MAX_DISCOVERED_QUEUE_SIZE) { - // delete data in first list posistion BLEDevice* device_first = _discoveredDevices.remove(0); if (device_first != NULL) { delete device_first; From 1ec7d0046e20a8c78cf40d4bec5bbadfa4bb27bb Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 13 Oct 2022 08:41:37 +0000 Subject: [PATCH 59/83] Bump geekyeggo/delete-artifact from 1 to 2 Bumps [geekyeggo/delete-artifact](https://github.com/geekyeggo/delete-artifact) from 1 to 2. - [Release notes](https://github.com/geekyeggo/delete-artifact/releases) - [Commits](https://github.com/geekyeggo/delete-artifact/compare/v1...v2) --- updated-dependencies: - dependency-name: geekyeggo/delete-artifact dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- .github/workflows/sync-labels.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/sync-labels.yml b/.github/workflows/sync-labels.yml index 986bda6f..10abaeac 100644 --- a/.github/workflows/sync-labels.yml +++ b/.github/workflows/sync-labels.yml @@ -114,7 +114,7 @@ jobs: path: ${{ env.CONFIGURATIONS_FOLDER }} - name: Remove unneeded artifact - uses: geekyeggo/delete-artifact@v1 + uses: geekyeggo/delete-artifact@v2 with: name: ${{ env.CONFIGURATIONS_ARTIFACT }} From 8ae816ce7b45b801d58ec30241a6405fd3b3b4eb Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 25 Oct 2022 08:23:57 +0000 Subject: [PATCH 60/83] Bump carlosperate/download-file-action from 1 to 2 Bumps [carlosperate/download-file-action](https://github.com/carlosperate/download-file-action) from 1 to 2. - [Release notes](https://github.com/carlosperate/download-file-action/releases) - [Commits](https://github.com/carlosperate/download-file-action/compare/v1...v2) --- updated-dependencies: - dependency-name: carlosperate/download-file-action dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- .github/workflows/sync-labels.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/sync-labels.yml b/.github/workflows/sync-labels.yml index 10abaeac..94938f35 100644 --- a/.github/workflows/sync-labels.yml +++ b/.github/workflows/sync-labels.yml @@ -31,7 +31,7 @@ jobs: - name: Download JSON schema for labels configuration file id: download-schema - uses: carlosperate/download-file-action@v1 + uses: carlosperate/download-file-action@v2 with: file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/arduino-tooling-gh-label-configuration-schema.json location: ${{ runner.temp }}/label-configuration-schema @@ -65,7 +65,7 @@ jobs: steps: - name: Download - uses: carlosperate/download-file-action@v1 + uses: carlosperate/download-file-action@v2 with: file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/${{ matrix.filename }} From f852716d0bab16a5d0f87b0dc1bace871a38a686 Mon Sep 17 00:00:00 2001 From: Martino Facchin Date: Fri, 10 Mar 2023 15:11:01 +0100 Subject: [PATCH 61/83] Add compatibility with Giga --- library.properties | 2 +- src/local/BLELocalDevice.cpp | 8 ++++++-- src/utility/HCICordioTransport.cpp | 8 ++++---- 3 files changed, 11 insertions(+), 7 deletions(-) diff --git a/library.properties b/library.properties index 0648b56a..9135fc90 100644 --- a/library.properties +++ b/library.properties @@ -6,5 +6,5 @@ sentence=Enables Bluetooth® Low Energy connectivity on the Arduino MKR WiFi 101 paragraph=This library supports creating a Bluetooth® Low Energy peripheral & central mode. category=Communication url=https://www.arduino.cc/en/Reference/ArduinoBLE -architectures=samd,megaavr,mbed,apollo3,mbed_nano,mbed_portenta,mbed_nicla,esp32 +architectures=samd,megaavr,mbed,apollo3,mbed_nano,mbed_portenta,mbed_nicla,esp32,mbed_giga includes=ArduinoBLE.h diff --git a/src/local/BLELocalDevice.cpp b/src/local/BLELocalDevice.cpp index 91cc8695..20de8222 100644 --- a/src/local/BLELocalDevice.cpp +++ b/src/local/BLELocalDevice.cpp @@ -33,6 +33,10 @@ #ifndef BT_REG_ON #define BT_REG_ON PF_14 #endif +#elif defined(ARDUINO_GIGA) +#ifndef BT_REG_ON +#define BT_REG_ON PA_10 +#endif #endif BLELocalDevice::BLELocalDevice() @@ -65,7 +69,7 @@ int BLELocalDevice::begin() delay(100); digitalWrite(NINA_RESETN, HIGH); delay(750); -#elif defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) +#elif defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_GIGA) // BT_REG_ON -> HIGH pinMode(BT_REG_ON, OUTPUT); digitalWrite(BT_REG_ON, HIGH); @@ -195,7 +199,7 @@ void BLELocalDevice::end() #elif defined(ARDUINO_SAMD_NANO_33_IOT) || defined(ARDUINO_NANO_RP2040_CONNECT) // disable the NINA digitalWrite(NINA_RESETN, LOW); -#elif defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) +#elif defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_GIGA) digitalWrite(BT_REG_ON, LOW); #endif } diff --git a/src/utility/HCICordioTransport.cpp b/src/utility/HCICordioTransport.cpp index 4dc8d45e..0e67dae7 100644 --- a/src/utility/HCICordioTransport.cpp +++ b/src/utility/HCICordioTransport.cpp @@ -25,7 +25,7 @@ #include #include -#if defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) +#if defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_GIGA) #include "ble/BLE.h" #include #endif @@ -181,7 +181,7 @@ HCICordioTransportClass::~HCICordioTransportClass() { } -#if defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) +#if defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_GIGA) events::EventQueue eventQueue(10 * EVENTS_EVENT_SIZE); void scheduleMbedBleEvents(BLE::OnEventsToProcessCallbackContext *context) { eventQueue.call(mbed::Callback(&context->ble, &BLE::processEvents)); @@ -201,7 +201,7 @@ int HCICordioTransportClass::begin() init_wsf(bufPoolDesc); #endif -#if defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) +#if defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_GIGA) BLE &ble = BLE::Instance(); ble.onEventsToProcess(scheduleMbedBleEvents); @@ -235,7 +235,7 @@ void HCICordioTransportClass::end() bleLoopThread = NULL; } -#if !defined(ARDUINO_PORTENTA_H7_M4) && !defined(ARDUINO_PORTENTA_H7_M7) && !defined(ARDUINO_NICLA_VISION) +#if defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_GIGA) CordioHCIHook::getDriver().terminate(); #endif From 289d3d6335a3f85581fa937d148b0d72958cdc5d Mon Sep 17 00:00:00 2001 From: Martino Facchin Date: Fri, 10 Mar 2023 15:11:23 +0100 Subject: [PATCH 62/83] Publish version 1.3.3 --- library.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.properties b/library.properties index 9135fc90..547ddb7d 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=ArduinoBLE -version=1.3.2 +version=1.3.3 author=Arduino maintainer=Arduino sentence=Enables Bluetooth® Low Energy connectivity on the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, Arduino Nano 33 IoT, Arduino Nano 33 BLE and Nicla Sense ME. From a263bc760a0773eaad1ba3fa862726ee8ce3592b Mon Sep 17 00:00:00 2001 From: Martino Facchin Date: Mon, 27 Mar 2023 14:38:23 +0200 Subject: [PATCH 63/83] Restore logic for end() on STM32H7 boards (1DX module) Amends https://github.com/arduino-libraries/ArduinoBLE/commit/f852716d0bab16a5d0f87b0dc1bace871a38a686 and fixes https://github.com/arduino-libraries/ArduinoBLE/issues/292 --- src/utility/HCICordioTransport.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/utility/HCICordioTransport.cpp b/src/utility/HCICordioTransport.cpp index 0e67dae7..e78a44ea 100644 --- a/src/utility/HCICordioTransport.cpp +++ b/src/utility/HCICordioTransport.cpp @@ -235,7 +235,7 @@ void HCICordioTransportClass::end() bleLoopThread = NULL; } -#if defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_GIGA) +#if !defined(TARGET_STM32H7) CordioHCIHook::getDriver().terminate(); #endif From 55e7bb6a625f8ef8fab2a72e21ab1185dfcd70c0 Mon Sep 17 00:00:00 2001 From: Martino Facchin Date: Mon, 27 Mar 2023 14:39:44 +0200 Subject: [PATCH 64/83] Publish 1.3.4 --- library.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.properties b/library.properties index 547ddb7d..3da861aa 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=ArduinoBLE -version=1.3.3 +version=1.3.4 author=Arduino maintainer=Arduino sentence=Enables Bluetooth® Low Energy connectivity on the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, Arduino Nano 33 IoT, Arduino Nano 33 BLE and Nicla Sense ME. From 9aa695e95ef1fe39884bd49f8810afd50dcda01f Mon Sep 17 00:00:00 2001 From: Joso Eterovic Date: Sun, 28 May 2023 21:55:01 -0700 Subject: [PATCH 65/83] Fix warnings: - Reorder member initialization on BLELocalCharacteristic - Remove unused variables in: - HCIClass::tryResolveAddress - HCIClass::handleEventPkt (the whole else if statement did nothing) - L2CAPSignalingClass::handleSecurityData (one initialization should be inside of _BLE_TRACE_ - BluetoothCryptoToolbox::f5 - BluetoothCryptoToolbox::testAh - BluetoothCryptoToolbox::testg2 - Uninitialized variable in L2CAPSignalingClass::handleSecurityData --- src/local/BLELocalCharacteristic.cpp | 4 ++-- src/utility/HCI.cpp | 34 +--------------------------- src/utility/L2CAPSignaling.cpp | 9 ++------ src/utility/btct.cpp | 12 ---------- 4 files changed, 5 insertions(+), 54 deletions(-) diff --git a/src/local/BLELocalCharacteristic.cpp b/src/local/BLELocalCharacteristic.cpp index ef19e726..207425bd 100644 --- a/src/local/BLELocalCharacteristic.cpp +++ b/src/local/BLELocalCharacteristic.cpp @@ -32,14 +32,14 @@ BLELocalCharacteristic::BLELocalCharacteristic(const char* uuid, uint16_t permissions, int valueSize, bool fixedLength) : BLELocalAttribute(uuid), _properties((uint8_t)(permissions&0x000FF)), + _permissions((uint8_t)((permissions&0xFF00)>>8)), _valueSize(min(valueSize, 512)), _valueLength(0), _fixedLength(fixedLength), _handle(0x0000), _broadcast(false), _written(false), - _cccdValue(0x0000), - _permissions((uint8_t)((permissions&0xFF00)>>8)) + _cccdValue(0x0000) { memset(_eventHandlers, 0x00, sizeof(_eventHandlers)); diff --git a/src/utility/HCI.cpp b/src/utility/HCI.cpp index 1902abe7..af9ffad8 100644 --- a/src/utility/HCI.cpp +++ b/src/utility/HCI.cpp @@ -554,15 +554,12 @@ int HCIClass::readStoredLK(uint8_t BD_ADDR[], uint8_t read_all ){ int HCIClass::tryResolveAddress(uint8_t* BDAddr, uint8_t* address){ uint8_t iphone[16] = {0xA6, 0xD2, 0xD, 0xD3, 0x4F, 0x13, 0x42, 0x4F, 0xE1, 0xC1, 0xFD, 0x22, 0x2E, 0xC5, 0x6A, 0x2D}; - uint8_t irk[16]; - for(int i=0; i<16; i++) irk[15-i] = iphone[i]; bool foundMatch = false; if(HCI._getIRKs!=0){ uint8_t nIRKs = 0; uint8_t** BDAddrType = new uint8_t*; uint8_t*** BADDRs = new uint8_t**; uint8_t*** IRKs = new uint8_t**; - uint8_t* memcheck; if(!HCI._getIRKs(&nIRKs, BDAddrType, BADDRs, IRKs)){ @@ -971,33 +968,12 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) data += 2; } } - else if(eventHdr->evt == EVT_RETURN_LINK_KEYS) - { - uint8_t num_keys = (uint8_t)pdata[sizeof(HCIEventHdr)]; - // Serial.print("N keys: "); - // Serial.println(num_keys); - uint8_t BD_ADDRs[num_keys][6]; - uint8_t LKs[num_keys][16]; - auto nAddresss = [pdata](uint8_t nAddr)->uint8_t*{ - return (uint8_t*) &pdata[sizeof(HCIEventHdr)] + 1 + nAddr*6 + nAddr*16; - }; - auto nLK = [pdata](uint8_t nLK)->uint8_t*{ - return (uint8_t*) &pdata[sizeof(HCIEventHdr)] + 1 + (nLK+1)*6 + nLK*16; - }; - // Serial.println("Stored LKs are: "); - // for(int i=0; ievt == 0x10) { +#ifdef _BLE_TRACE_ struct __attribute__ ((packed)) CmdHardwareError { uint8_t hardwareCode; } *cmdHardwareError = (CmdHardwareError*)&pdata[sizeof(HCIEventHdr)]; -#ifdef _BLE_TRACE_ Serial.print("Bluetooth hardware error."); Serial.print(" Code: 0x"); Serial.println(cmdHardwareError->hardwareCode, HEX); @@ -1096,9 +1072,6 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) leConnectionComplete->supervisionTimeout, leConnectionComplete->masterClockAccuracy); } - uint8_t address[6]; - uint8_t BDAddr[6]; - for(int i=0; i<6; i++) BDAddr[5-i] = leConnectionComplete->peerBdaddr[i]; // leReadPeerResolvableAddress(leConnectionComplete->peerBdaddrType,BDAddr,address); // Serial.print("Resolving address: "); // btct.printBytes(BDAddr, 6); @@ -1325,11 +1298,6 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) // Send Pairing confirm response HCI.sendAclPkt(connectionHandle, SECURITY_CID, sizeof(pairingConfirm), &pairingConfirm); - // Start calculating DH Key - uint8_t remotePublicKeyReversed[sizeof(HCI.remotePublicKeyBuffer)]; - for(int i=0; ireason,HEX); #endif @@ -293,7 +293,7 @@ void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t } *identityAddress = (IdentityAddress*)data; // we can save this information now. uint8_t peerAddress[6]; - for(int i; i<6; i++) peerAddress[5-i] = identityAddress->address[i]; + for(int i=0; i<6; i++) peerAddress[5-i] = identityAddress->address[i]; HCI.saveNewAddress(identityAddress->addressType, peerAddress, ATT.peerIRK, ATT.localIRK); if(HCI._storeLTK!=0){ @@ -315,11 +315,6 @@ void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t }; memcpy(generateDHKeyCommand.x,connectionPairingPublicKey->x,32); memcpy(generateDHKeyCommand.y,connectionPairingPublicKey->y,32); - struct __attribute__ ((packed)) ReadPublicKeyCommand { - uint8_t code; - } readPublicKeyCommand = { - LE_COMMAND::READ_LOCAL_P256, - }; if(ATT.setPeerEncryption(connectionHandle, ATT.getPeerEncryption(connectionHandle) | PEER_ENCRYPTION::REQUESTED_ENCRYPTION)){ #ifdef _BLE_TRACE_ diff --git a/src/utility/btct.cpp b/src/utility/btct.cpp index b4faf053..6829494c 100644 --- a/src/utility/btct.cpp +++ b/src/utility/btct.cpp @@ -60,16 +60,8 @@ int BluetoothCryptoToolbox::f5(uint8_t DHKey[],uint8_t N_master[], uint8_t N_sla printBytes(BD_ADDR_slave, ADDR_LEN); #endif - uint8_t ADD_M[7]; - uint8_t ADD_S[7]; uint8_t T[16]; - for(int i=0; i<6; i++){ - ADD_M[1+i] = BD_ADDR_master[i]; - ADD_M[0] = 0x00; - ADD_S[i+1] = BD_ADDR_slave[i]; - ADD_S[0] = 0x00; - } struct __attribute__ ((packed)) CmacInput { uint8_t counter; @@ -135,11 +127,8 @@ int BluetoothCryptoToolbox::ah(uint8_t k[16], uint8_t r[3], uint8_t* result) void BluetoothCryptoToolbox::testAh() { uint8_t irk[16] = {0xec,0x02,0x34,0xa3,0x57,0xc8,0xad,0x05,0x34,0x10,0x10,0xa6,0x0a,0x39,0x7d,0x9b}; - uint8_t r[3] = {0x70,0x81,0x94}; - uint8_t expected_AES[16] = {0x15,0x9d,0x5f,0xb7,0x2e,0xbe,0x23,0x11,0xa4,0x8c,0x1b,0xdc,0xc4,0x0d,0xfb,0xaa}; uint8_t expected_final[3] = {0x0d,0xfb,0xaa}; - for(int i=0; i<3; i++) r[2-i] = expected_final[3+i]; uint8_t ourResult[3]; ah(irk, expected_final, ourResult); @@ -170,7 +159,6 @@ void BluetoothCryptoToolbox::testg2(){ uint8_t V[32] = {0x55,0x18,0x8b,0x3d,0x32,0xf6,0xbb,0x9a,0x90,0x0a,0xfc,0xfb,0xee,0xd4,0xe7,0x2a,0x59,0xcb,0x9a,0xc2,0xf1,0x9d,0x7c,0xfb,0x6b,0x4f,0xdd,0x49,0xf4,0x7f,0xc5,0xfd}; uint8_t X[16] = {0xd5,0xcb,0x84,0x54,0xd1,0x77,0x73,0x3e,0xff,0xff,0xb2,0xec,0x71,0x2b,0xae,0xab}; uint8_t Y[16] = {0xa6,0xe8,0xe7,0xcc,0x25,0xa7,0x5f,0x6e,0x21,0x65,0x83,0xf7,0xff,0x3d,0xc4,0xcf}; - uint8_t AES[16] = {0x15,0x36,0xd1,0x8d,0xe3,0xd2,0x0d,0xf9,0x9b,0x70,0x44,0xc1,0x2f,0x9e,0xd5,0xba}; uint8_t out[4]; From 1dfbf629d6b86d9e58a594d3588d5d0850783856 Mon Sep 17 00:00:00 2001 From: Joso Eterovic Date: Sun, 28 May 2023 21:58:22 -0700 Subject: [PATCH 66/83] Remove another unused variable --- src/utility/HCI.cpp | 1 - 1 file changed, 1 deletion(-) diff --git a/src/utility/HCI.cpp b/src/utility/HCI.cpp index af9ffad8..e9743758 100644 --- a/src/utility/HCI.cpp +++ b/src/utility/HCI.cpp @@ -553,7 +553,6 @@ int HCIClass::readStoredLK(uint8_t BD_ADDR[], uint8_t read_all ){ } int HCIClass::tryResolveAddress(uint8_t* BDAddr, uint8_t* address){ - uint8_t iphone[16] = {0xA6, 0xD2, 0xD, 0xD3, 0x4F, 0x13, 0x42, 0x4F, 0xE1, 0xC1, 0xFD, 0x22, 0x2E, 0xC5, 0x6A, 0x2D}; bool foundMatch = false; if(HCI._getIRKs!=0){ uint8_t nIRKs = 0; From 0ad2d7dce3ec9d3541c09fe9404dab97d8c02073 Mon Sep 17 00:00:00 2001 From: Martino Facchin Date: Tue, 4 Apr 2023 18:51:34 +0200 Subject: [PATCH 67/83] Support C33 --- src/local/BLELocalDevice.cpp | 20 ++++++++++++++++++++ src/utility/HCIUartTransport.cpp | 2 ++ 2 files changed, 22 insertions(+) diff --git a/src/local/BLELocalDevice.cpp b/src/local/BLELocalDevice.cpp index 20de8222..79e43bf5 100644 --- a/src/local/BLELocalDevice.cpp +++ b/src/local/BLELocalDevice.cpp @@ -73,6 +73,26 @@ int BLELocalDevice::begin() // BT_REG_ON -> HIGH pinMode(BT_REG_ON, OUTPUT); digitalWrite(BT_REG_ON, HIGH); +#elif defined(ARDUINO_PORTENTA_C33) +#define NINA_GPIO0 (100) +#define NINA_RESETN (101) + pinMode(NINA_GPIO0, OUTPUT); + pinMode(NINA_RESETN, OUTPUT); + Serial5.begin(921600); + + digitalWrite(NINA_GPIO0, HIGH); + delay(100); + digitalWrite(NINA_RESETN, HIGH); + digitalWrite(NINA_RESETN, LOW); + digitalWrite(NINA_RESETN, HIGH); + auto _start = millis(); + while (millis() - _start < 500) { + if (Serial5.available()) { + Serial5.read(); + } + } + //pinMode(94, OUTPUT); + //digitalWrite(94, LOW); #endif diff --git a/src/utility/HCIUartTransport.cpp b/src/utility/HCIUartTransport.cpp index 1b1a513a..1cd44495 100644 --- a/src/utility/HCIUartTransport.cpp +++ b/src/utility/HCIUartTransport.cpp @@ -29,6 +29,8 @@ // SerialHCI is already defined in the variant #elif defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) #define SerialHCI Serial2 +#elif defined(ARDUINO_PORTENTA_C33) +#define SerialHCI Serial5 #else #error "Unsupported board selected!" #endif From 0753ec0fe43c22600df09c7b8eb7e7a0b870500b Mon Sep 17 00:00:00 2001 From: per1234 Date: Sun, 2 Jul 2023 07:39:28 -0700 Subject: [PATCH 68/83] Fix broken image embed in documentation The file previously targeted by the embed has been lost or moved. Experience shows that this is is a common occurrence with the files hosted by Arduino, and will be especially problematic in cases like this where the file may appear to be superfluous to the website maintainers due to the lack of any internal references to it, so the only way to ensure the file will continue to be available is by hosting alongside the documentation content in the repository. I was able to recover the lost file from the Internet Archive Wayback Machine's 2023-06-18 archive of the previous URL: https://web.archive.org/web/20230618230604/https://www.arduino.cc/en/uploads/Reference/ble-bulletin-board-model.png The absolute URL of the file was intentionally used in the markup instead of what would normally be the best practices of using the relative path. The reason is because the documentation content will be published at https://reference.arduino.cc/reference/en/libraries/arduinoble/ and the publishing system doesn't have any capability for handling asset files. --- docs/assets/ble-bulletin-board-model.png | Bin 0 -> 41914 bytes docs/readme.md | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) create mode 100644 docs/assets/ble-bulletin-board-model.png diff --git a/docs/assets/ble-bulletin-board-model.png b/docs/assets/ble-bulletin-board-model.png new file mode 100644 index 0000000000000000000000000000000000000000..409ae9e89385b0c27d8331f7d52fff2a8f71e097 GIT binary patch literal 41914 zcmc$`WmuJ6*Y6Fulu}Akx_f~%NO!1!(%nc)mz2`o9nzqHbayw>B_J)GO3ORf<#pfk zKF{8tw+C|ImeJM``iSO0Q>e14f#-o4#UEkWrsLaYH5>dnSzoQ4Est zRzUFgrEwC!FNuvwuVSRs3NIBvVJLx(`r*C7H1aWqLU)^@xWxKGs0H#tG3Uu*@=cHW z((Go<^sMQD$80S+m)lef_hE#!jtO*))Qp6OaJ zBuK^}4|6)vZ2d>C$>mYS>kEUYjIkXrmIGa$kDOLM3}?mj{$dj^0Z*-NmGmZRub60W zPkn0R%|*-X5{c*Q8-ZT8E9E1a-H~*W&~)`B%iSWDCS15*R2nJ770q$VaFtdMgx8mg z3wx#UHWAzCmvq{P=y; zBB4eozFw2dUie(JhyTexcok}85PNL|;KV5JQCSPQA$aU)Vmw9ZZEk#1 z9QDOMg3ays<|QerR{!fwCen={+Ly zW`BEckqpk)TN>kD{5_~Nf|)R+TtsjNEWxKU@J=7h-@;A!xP67Ze9!gvffhuy_0e0@ zhu%`cDE@77tniCIW=QW3F>ta(K1Jf@peKn=VGwE{xr&J>@L=ET5(|pNh!(#1N>hN( z@ZnRYn1aA5rNfhYB<&BE9}&NjaXh$z_wdC`L>Sk9Gy_-dJzM&W2uZ4a;JdgBPAVc^ z>-@58Ev_J1O*`H);UOH8pKf~$l5j85y-`UuB*G(c(MUBacuaDOD2g0}LW$%^v>d{^ zFzG1UwR;Z&GW8Sjak~jt1Jpy84OH}}3}jg+6Acqpp5twBnP9N{T)fXUm@Lavqb(A0 zLgvCu31jY5(TmX2EKMl8H>1D%j0ml#m0*SFt!FL17MnF^38V&nI<&!ir{mEw&5=tZ z!y@*gs?XkNx(%lK2_y`rK|s`OEkF{jX`5uj-zkLlwxlCr~B7uJz4 zp~@iBrAChyQi!Fa!IqaLk`SGJ$tznY>?-Ukmiy{af%Syir^Na+4f!T<4_OZusTlTz zlZ4g2;+W4-7I8ZX?$q+J(+SQAy3h<-U2-qk-+9-y2#RgOZLfW@OI0!@mn+)^{A47O zv*HW_4U!Fl3_h%Ib}3RfM*Bq9V96H>ZZ3lhr5r3089&bA9t!^Q%ed=dh9d5$E)gG+mC{ zwd;WG()u8`+Dr4F9oquiF;9}8G(RDDqWmO*qnnc;**du|c|CcPqo?wX25J>VV_jpj zN{2NrX@5}3gt{VxH?z28FQ0i-FlXVjK(S##g_>#h%ZlO0+R;!=ZjlAQ6Gm0~ETBKSuz4}|flFjLbh@`X?WCmxp=%?#vFB?*RiuydtkgbvZteeNM z+BWz|a8;A0G$>6bS|+UT#p{`gMJ2uZk;;*W78`G9I6iYW^kkKOQ&%sNochSy!QcBX z+co8a5mg{WEhG(h0aur4kLfk@4il+5z50DMtIF-t%Z|CuWD9LWj~;*XRl|zmyoHUb z;zH&nr73%Ct08%BPi{i3*{xq6By5a1HfgmyOL;6&Hp>oJMB^JBSo_$YK0 zk=C8IY+NRPDNTKte)!RFHtIvXL%a!Qe7jNGAz8$9kng!f@qq zohAFEx+Es0UP!o0BuL05s4=NmtVxDygp%b6;F1#JxKlaV6`qYP$OWwKuAr>$L)o?B zD|YAXs@4k!MoJ=e+th6tNC-)ZmoRRF9=8{+KQB4et#e+7Ovf|?Tt#noGj4_*X`dTk zM?n&N%Y8@16FRkn3}s4WaAZ~yYklM#g5-vlosQ4w?B@o>z{GQtJno zGHSC6&^EDjaAdQJ)%TlC?khje5+03uPG_%f(vTSb`}t4lP^uK_59+8D=H-i~QpOqm zii4ONr)$Y;)&sDB(^e1NEW#+FlC7Y;N%o7m)MWm4&bH5!h~$l?ZTFhJw7H)7>6RrcuW|UW zdtHcvB-liaUcF}u7R4e~UHadai#kSjvbO76Oucly#P_6+qDG|rq;h-OBOE86O-yqa zaL01Bhedant=jh3+m0TW>3F;#Z5qo9}yUUTR;lEdHwZSP#EVBfJ;#;Bp_@?0&2BO<>Do@n#gU z5M4)T(2eKj&5hyiY8EYuJVW{?q2im#^J$a9rqkVz(|RKnfu<4uwPGx{aTj0YJMNDZ zjxb7AN^VOPOO1qHgf6(1opv1#geHuy`nAyiu0D$!{hZ&QND|sEwT|%Tr!nUKUn17B)6!@C38H ztF?o^3$wL7<)2FaQ;)c@y`i1iTL&{6Ycg29`UWi&deB$`k%L-{`>abvVWiFXMqj;jv@Y7`JYl? zWf+X5V%Fr19Ih>{EZZW>}E_T)v2ZdrE0jBsd^ej8RpmJ%afaPXxn zrUZu`o{DBcU4wT#FtI_{S@I6EI$-lmV3 z?hg*9a*gnw4LUErHu3TIW#`4jfdBi|8zme?mQ(e{0Z&uTWb=+2y84`$4q};qacGXqjKTt#tjJ($BQU*#|jSa zpTSZQ|F^>m%Mgq(9=wR%Y{K@@8)|AF`A!MitWP1Nd9zM z{38kSyQ{sL>aU`xevc?aPzT+N6hFDgdo$r|5sld%oe!|IK;SRN<%RqdQWGBkXEqZv z;NrV8yngdOJXzU(j|#=FuhNztCKWYZAtQq)K_8XdU^lss_n-08 zww~BUN#G)L2Y)mYlkUff@P-&2&1~S49Prn z^QD75=dmIsq*65zkfaCqLcKaK&sQUal5fS9$4R9gSs$Bd)1`Fo1D=V z>G6bs#mYzpbWmYC5;fIGK%5^K4U-KV^^l)t^ zYV+6Me`QE!FG(BmuWd0xp{I)%R7%LbE2=2q8~ZTteP61$#rssZ50kX=U#1P#q&Y9n zzU14Ya^J7pWOE&H^ZefGqyEJ{s-{7w$&GXC3oi+Y$Ejk&_xGq9A@A)|Y?|x#N;}Y| ziZ!{PoqiSDtD4qH8POG_h1RWMT}`+Aj+4i@!1>2=1qukKb9F8`v?KR(iXyuhSsnH9 zBCK?tzMgGrZwOo?rHHxOtr*!|a9(<$<9X0@RwS1I{k8r1%Ut;YG=)E7pe+!SGWoPy zXn8P+J>_(o2t8E)Vk5-{){Fc!r{ukg5y9oTd7Boi9wPhDw0FmS)dSFm!A+rr$5KSL zzEzg9YKev>U3hBErr3UsSFfW(b1a0oOckSg@!&#WjoO4g2+G+)g{Ns$m-8=8rq zJMPYmUY>3ll6qa+vZZUGP3d}h5I%FV#E9D$(!TuC^1Ghc<8*YNdiU&`{RnIKX;H;+ zx$~kcZK_x;8a`_)*W4S*ozd)o7fEc?1T@->eIa~*j;#VD1b&v;tnS3%UbRQ2qPV>% zj9TJ3s4~AX%j>*uua=hC5Ozx%_RFiS<~16e_I58eGipY&rRKqIA^x58Yu-j^-t%hD zDvWcg)HL0-TSdop{kzvzZo*6d&F>8d%@y<34MY3j2aFNj+e_7F+XdOXzzj&ge_xDv zJrKH<3>_vSu;fJw*YaX7qUh6w8;Xy#^65kn$`7Bm%5^Nuy4p4Lbv-YPdE}Ej{2x^~ zPO0~l)NMSuS_xqhRlRvE&mZ+vXJ78+Kj+U!J0zDH$J07`Fv$Z_xVC=!fGRW!_U$r3S> zlU80l`m*$A)2>s0ACdD4ua7)ESs&82%7daB-H-dMdOG1z&qNVU;&pxGkno<>{bD^~ zZ_eV&qiI+6ld|_}`?%T;qm|3A4l~vSp6~Fe7 zxDP^`PRG6)H*O?bJSh9tD;6%){QJ^EQ{NA#eDUD-)q%~lwsYEE^VR+@FywiGvv1>c zPTfg%8HWxv-|PnbI`Z}hZY)^-Y%3iEC{drEkk~*<_ME&nLivLM{HVa6td3I-b`f$LiFxzRrJH6#}jAEqy>?lytqSy|#62$|uDwpnY6xxkc$+*6n#ZDzz+F znkq@`swax2qEZyDn83VPAVmD{ohsafsetG7D4yrBNaF4a&AaZCb%rsT7s=RD;|Qn~ zX|6HZ^Smhov;y%cWa&nrOUKu&eh~%{`iI> z<8}KB4FOLxwG3%=N74m8e6(a(bgFej#xMAD;K2`6ybJ1uN;w(7ANB(ExULl0)lL~phV}+KYvBhw>HXrU9 z-bZ_Q&+h1P?{D!iA%QM6QG_~_9tZV)Remff!L2T4k`&n%`XlLchn2EImpUlzzZmmV z5`e>^EdRg_8`o&UZr{p_gg+nvzHg_3n=(z+`^R3z*P8#>6)+Kpgm6V^3PsM&zqiys z2o#1SEzH%PNqV>J1>h>n;K-7@T*U#XX%;EK^DbL~3K7cbMeCveb_!Of13qY-**zTN< zBfX0@#^n0k%|9@cMIL~kKPip&g?rO-vQ7H9!|$8qU$9XcI(qwSi+9mQ2N4GCd-L~G)tWn%Q zbL!lIT>Vf9tPoavWRxSoYU=KL#sgZg!JTK|L@i@wq z@FA1IdH%lGJY?%5W~%-EzO8;uw4B#Dw>ppal;N3W*?e+;v->(!7fj;?)@Qw2C&b?n66S+Z=)i`Ngw+fCAIhFH z2GyK#UT6LK%`hsbR>}OGjSG+LgTkDHP@(*g{JVPQ;@4ssJg%u8aMO?S3!G(pIAVPy zD&wIbAwcabLlqV`&U|V0B6E#FDE0QB=VDCp!nv3TR~A@C!43!arRc|Y6sqoBY&oPz z2|R2h>25(;;cm6J#^Kxlfxr~J`~3}dpbmRv73*_YcigA@)iWWd^c|vo%4$5IGmMe= z6(2D4Iz$7%hP*}+?-CXiBkdLAtTP|5A+mHO_&BUk(pA9iwiTEi%fJ|JP{kSNn9%=1 z3yf%$LcQBXi~l$>NAZg>xq{@Nv0S~HXsb=HM9ws!xD*YyaXmORd?tg2`8{AC%>H0k{@4kui<^g^bH z#|G9ef9+WWmIsh}&g{3`dIC1t+Xe8}yVmsagikSw0mM$FFzRyK z;q=fNtj^18o7@_b5uTE6n=Z#tv#Ofht=}oBn5{6KmNr{=ChWpSSnKS9!^Nx7Gws*E z`n6{T5U+0lU~a_CGP;-a@8+$%lp=sb)yw{ba|Mdo(VJIi2R2_Ck7Zpjc|iB}8c&8% z+lK}82>6$MAGeQuK;!F`pVzc$G6wkBWL4IM>(q%Ug}*bgjQ^QauhlzpDqhpt%%=Im zge{cx@Q{?_P2_DQb%GXK=+X1^f}?vy5tgIX-ifT`ZxT>h*;Bynj? z_xPnw$ZMCA<}_z!tM@sWCwO5>=|04m%@ph;-t15BBB~f5D%y_977O)`>v+OZc4|!I z7(-CUo*ncovKT_aceTU-M*NZ90Vm*zt2@}DR;NEkf1QrY2UvZpwH1L|**X~!s>u`! znB(0{ee7!t{Eb~;TRH!h)$nKU71lbzrXU(-FAN9(Fr#bD(tMufc(AzeQt0ON?H-JH ztEMytbi8gH8-8Eze5j?mO(J?I&%2Ht56Y$r`3=@@KT*EX#e-u^;As+7{)OGRXjWb&yTsi6@6t zn|R1~Pi{LjL%zpp`~^2>w+Qfs(z%R!F`gZ^-rLKL5Jb@d%fSNBQxS93#H;E-wgCXS z#3s&59?opZ>?8c+fNd8JQ3t84b)^-P z#SAc4H=&KC)qFK4$*(P<_#NP85v+Ja&)sZw!gZP#NzN}e>;k)YZ1Y1Zp3El;-E7G( zulu?6**4XJo%yr<%i{iPKw7fjNRbvl+RIhZLCilEpw#Qw`1sMjBuoFUs8sz4jNqZasF!a^-%Qe9147-p@E5 z%zvJyUhTmlC{)r_ZBjAB#jX<%C_1G6$-OP({&eR3Y8uUjv8rv#QiY$!>b%3^WS1im zq_=5(LYtTfmJYNO5d02*443~Pt%xh51V(L$;6%2l_mQn13VcLLnUdh}(8%P~BB4Fc z+N->-m7ie6_?PJ`GA;sUC9RL^Q%&Kr+J#a2RI}Fc*L?X5GPbgZ`!!3RC->Vv;aBO^ z2T0&)bExsszD!NLR?5%~*)QWaAaC0K^m*F}K_ylywMPg2_1WxLL0+|g!eg!J674W$ zc>H)p^l;elc6@^NpRxmb7_>D1C0m8;lgu2*&`<_CAsEV?Gl0MIa6dOe2PNjUOO#$+ zD%i1;zh(?04u8hbrn|In45tyAROU5I7FW+PgytI!uAU#QZl09?oYI_s+C%iXNSLvt z)*#Wh19jLqLEGfneyt%!0+fG5;7se;<&W$SrKf=l3R5dj}xMV>a zvP->X&C-E^Ixd62RO>W7r_4AkJP z_@yos)^bDqWoD!goy&KOoh#MBb0p@X%SlgBa5}p z|FU{o$K8(y-<`lwUf^f!i$qp(CeBVfF-vfsgt(2`Mj@`rru&TEG2eJtF^( zQh!{6a8(uO;JN8B9*g9lv`Nt(*d(uX0%f%!46&^U$T1!pRV)k~<5ls@-S`x1YV+Yx zp>AuBo1fE?XXvPJxRu3+kTYbES`$Y!ma|03Ql(FNisP6yjJV8KX_b*&lxBUsuL^qv z(Dmw_Rn_$GYdXyuf2cJP5bKAuH30<%H#C>`XWn;loKh-Cu(D0^Ytv7K#hJu;v^nYV zhx96G^b&qwHX0M&%a@Hs-Y-`(`b?!$^dU(L+CJK0@;F>kNRcr*!&G-SUvn4|pBR{kMt$LF9Z z996gG4uSh&M0zv%Cb$2sPM8=*r>pJL#eacbm>ggRYGxkmU+!1v0Yy8thmLpr0|g|| z577ep(7%)py5Q=nK zq95ONDG!Ol9nrz7r`L-$6-wq;=e^5S8M1nDQ9!@`9JI?GRakL?g|N75Yu1$enEmbdR>_v1lE@eX^Y605hHlsTV)npQ&qCKc#5F$%>d&C*SOhv! z*mbKI^ciTu+@gFMLz|f!jMpwf7$=v7T#tr4(#ubRN!x8Jw|cjHz`vErL#@M@QACF*lDIsGMtED7@dTF2Hf!^gsghr zd*F^({?_Pv(tZF_{{T@X4Gy3SUF*3YG}Q zJpc1lp3(jK9q7E*?aiYyUW=)s$OoP>F^v?mWkpbM#gh*vTa*y|T6ElN|COKNiE`!v z7T`QMRNpK#INMM~i*-7lOId}@CG!>iQg$A=jMbmSQNLhI{fzNl#G{Wo!55KP^m{O4 zNofIwF#q9KlW((6EQ&De(J>KJwH@P%ft-qqgYaLeQ1m;HwWk?Xa5c_QMiz?`5LdK3}*z9$@*P>q$ukZn+6E$%_|h!ryZ30UOo;rA>}}WTF_T zt$;|!LoY?~kE?%Vg$(0iM@e%Ftnwqr$W8wOJBPF=b%Nj$W@#p ziF3(rpMOp|w_rt1s+t%Nl=%vqoMIs)&60g>x!QlGY1cb-vqEI z9N$P|Y;bj4^bJ=Yg}-yrX%D)+(I=woV1!}wTYni5;2OP~kkcml42-?|zl<#``Y{sa zxii#I(VAGI5t^ad#P~mMTd0XtEXd6RW(1Jo!0N9IMr_5?D36b03#v8(&3+#{2?8wtfG17MkLq zzv1yiL)J3UJd~FvIFuSPgqs7{wxOj)(P%L}wTQf^hSE2=V&J5EawD%q<8vSD-k29* zlunXs(S_D%areDwMEnH@2UN<$M2Y?<&M$Bj?K|!z1{l5G5=W&-!wA%ociz2tj)Smu zZ3hL8=}jwxGSc?|_wO1?A9GNACTiJkUeZDicSOCR{Yp~Y#?7K+gzhDyKkM637=0bF zF=-s?*a-0zci&TSlGa`SI;N{!jFPNw+>A!NpidR%`qlM`d%b|&+yeJu2l*=tS%7_o zt`S$xW!vuGE{dwojeLr#u$V`0iYmusUGsfs`lJqXhUda)0y*i@vdM#jrLHTj7x>bq zX-0B2qWFcm;0F^0)uU2le^GpWhhT0o#;&9plO8f0AMV{P93Niw3hO^XR}7zI5M5P& z+*OeBH>~b61_Lr;i`+X9#VG>lh9+2%`;J_jO9@`(o07c)QReRfq`bh+wif*hRZLz`*(;I(@;ygAk4fY$hLr|Ad(SM7h&I zKZ+Ad_vQcg!+-|Fk=Yd_{-cZoW~+J$Ml~g;c6O)iDPZ7Gf`Y972BtB5G-$ypHB_DXHK`qQDwdQW9hlvPJhsJ0AXu3 z?D`=QPwA-5P49Cs&n8^;6bS1uPJel+oLKGa?JL|o`3pGj)tHo$GeGjwmlwRqfeD1w zfN*CImpjCi>^Fz2Y+7!(mfjei2)P~`T>*C(HP{AVMg^!pzpoTvqdTS0VdTI|VHn`- za*C@CyZ~nTMy(*RC5MzKgS4irk13a+<5tMruv<>fYB8E-*H1r{Efry8B=q|{JI!HC zrcHFV%0kusWQeuLiW-^WY)A9>|r@<>9tjY&>j$ zX^-pinlvZJKop-@bU&~{7dVY{+!~{v@XJqk>n~}(+{W17`O;D?hQ>>!)iHMoC~FR& ztWq6}WfGC~ z4R|3-BS|A+AGaKWu<;WErfrNU0LPBU6Topc08%7-kq?kavb5dzs+Q;Oq4Vp3?2X13 z$sB#@t{VjIt6|*H3qxv;0?>%fH&g9j{y@k80c4;gv~`0JGEzgjfcxA`nV}d=D@g@@ zfz_|h$MU|lAak?}PuCI{ARp**j^sq?BYZndnjq4@3-U>7!1x3M`EXk#2crXm9@EZ& zXN-ZI-a^i0I+Tnv*2-cQttw6*KMCsK_f@wa;_O&#DAAtz4V2C0W|o#~J9kihvHRJ6 zn7CbFE!u5Cv7+YdfXU`luU4MHV1pWe+y0z%Tj}k~)wp};?V*?RM=0cxo z8isL-o{@`w|Ma<}+;LiaI!jcqFgL!u1q8!IkWxV&19)_RsUnp4-CS2RIF5`_VLk zoJ?99i0m*-kcSs)!lLho12(>Eh56}EI_X*p9|tx#?1TBN28)}1EvbI8+Da41Z^??f zNMehyK=j3X3aqU>(^Oi0yRA7`@a98Y4Bv-m-@Wfy!g4oQ_T8RkR&Nlz)_iSK)qJ_H zico&pUu4M}kI@^dBTB|j2)P6+-c$}+XGAHlc6tuA`xKJiaqQf79}luDU&A^jJzS>= z^vi43T>@??XI^w&NSb_W;!{Ka;`;4RGA)gXIra{@BdNUOZfE;xjf1>8R2Y#~bCoiT zBu9-fQ7Rz=sIIdh*@OhbXh>DTdmQJ6KEPa~RZZq-3qoNV1}d5{Nns_i@!*&@b5(UT z2h<%R4|pTc{oVGlll}EK$5fC-uTa2vfN<kYrTX+#-v^LF*;LNz3m9c5c~*EaX~@Kocx-;e>2WH-P>kZb2W4<#hlEuX!k9#Zs$fu#0xS3CrV1aty6DkS)pc(VwM zk0Hv|o(Q34IYec<%LREnK_y_ZJo~!B zd3}JsDomgQ+n2uV&r$dQa%byoAFIKPt@^)=jfLO`vd`@aQ0sx_?pvZ?~Y0K zKx{}E!M9z&+HmnBI|41n7Mxd~E0-~nLsgCa+1Wp7R$H2Z(EQU4r>aSniWgk7RD*Mp zGZ!Jq?4L1Xdx)L24nuHaWSD`k?fxUa`$>G^z%$7C66shrVTx^CsF#r>*8tA)4=htB zo*2KZaN86R)>3ytHk{&FbsFJW4J}Bh=U36puFiupdd4kO)|Y-RYVA*2D8SJBhC7AT zovZ)CyuS`ZkLU@mpvk()V+2(l*IfM|qj-jPG6sm690vJUFo>_z1ULw456d9ra2NoAFvE-;miQIl<_8Fq#-wUk5@1c6qpYhZd+THHgnE{sEGaHWcdbXZCc6?#f#*%Sw8;S^a8@f-sUxQJp*@jnFNuqnS~`;0#-JIAA& z7ij299pjM5-!0IqjxV;&LJULuA6{8($V`#=k-z5yPx}WAhc<()IY}blP!vw++r8;51ZriZ zobI?SXFhUoU9dbA^Z4rNPjC=sXY9jDrg2o%$cwTASu+RXW?KUd@Tdwede>_bq%wbo zbCjk`Vs!?&=o1lHu z+&Go~XVjf91>e&;PFZt^6p3sRJ(5x4U&(jenc8aPa)nL?ufdli>vf;@1+V2);`wX< zSc*x{oJ&5{a;SCyAXx5D6c_zhuA6{>doGzya>4g+S!_5sHMZ0kssHAY79fL|8mD4t zJ@Vf&IvBi-m8rzq z>B5}$s!jAB9!J=ps}>7}U6A8Fb&DPIPIF=npfIH=Qwh=Y{F6^A(wdy`Pa0i=<1c*K zAoH|JL|A*KN-?}1^-i}4K)0eZRYdP}fe_ZMY$8XzJ7sL3ThwC3zIVFC1<-Cvl6M<= zr_2bvD(A0({BN!!$aoaC0-#tFW;daIM;Yz|uf{*D!n)%*%#nTc>jbT)c;NlZza~A| zNXN9T)8v)4cE7)2XYs)>RkyCNn4a`Xm7a{$!VpY7a4RBqlKc z?>1+>(tIuWt17X)zSN>j$x;5!NW{TNBz!*?{F`11V^LhdqEiNi+y9X1zeW!PBMCuL zRlK8JGXwdfsO#0Fz@5=yf>&`dOS1k=pM@c>28=vIay8z&kJbB8dlyjw`&3GP0%^TU zbimjs%!#r?Q-%=&Ca~nBmuY!iOq7=G^h-P`JDFo_WA^%t{Y4w7iQ>F|%L|FZP4h!AETlNL<%20l{@yo*yogXVuwn&H<=R(am{!na=N8?g8%Y`(3rO zCMmOmSG(gzGq50Z6sb!u7;UEOkASDZx4+#fmkvON!A!#v2+7kWeW_V=8>j~S zKM(Zq-9XB4y3dI(O=J-%6#O6)Qw7C^?dF=!>d+)_hh-#vys*Fykj&Bt!=Td5wqbvy zI>XzR6#r+Yvs=E^HC|%S)l4$s-=Pi%X?RV#4LflSTU)pyHKk4b8miH zMco)j^KIMxjwz5!ZYWk;n!rd5@B8lc(klU=;aUO504-_GB*p4|>1u!`J-vN>KHUhO zj!WB=nqk=YgtFM3k_KxY>&Z`X+K!XT%ZX3J{y;49e<7B@KB!i1bHDk@+8yM#il+Cy zp0Bn7jA&L3RO0~Fz+n(Bc4+>{@y%hJeK>}-&cOpSBUA zNegyeGR?5nc~*$(XqL2dC9di7m$SUf}n1 z6VgqQ*F(yTh#e;sr^=1xG~ZI>26V> zwf|&o?4`t5xB3HKW%oZa zZ$57iK1e_N$&}{Oc><8mSWU$J=QfUx5k^sH)Zj+1>bAfk1r?AgB86ZW(H72=2r_tF5~Xb1!G+4k#U#w%NMPENSPpWY+kmFI{PliN zqysz_4#TL60}+eQ9b`5H4x3YH<!L8yB9+)t$E`7hIp_@I0o7d`zr3jC;XR^zZ-weS#;m)WcCeIIUAS}k4MdV zx$OUl5VxDbF4TCU=jpLKfJ{rOZH(f&K`g1FdLf#n!?E@mEv>xEZXShhM^C`NZKN^p z!-4<*wnzwELKm0{04Ql%o=`5WlPM^nQgL_Q!`q=W)Nnz{0Es!vZL()Zg8Lvwg@#K` zV@zZ}_>`P3>%Lr$v+3sJjOz_~Z`(puEnB}mkj9+ZfEy+5%t293-!miaPyY2L)Gwls zC)D}HCPp$KQRC8=C*`d+CX%a(bRAftAf6voWwRuxMv){FW@z#=l3eV4RdgSd+S8<{ zp(3lI$Y%$Q_NB61#y&;`kcAl-mR5WLzp|6yVcHx->)|6v^BJlgg5})fpY<_W9uN7F zfc#aTYj7zmYQ}gKD+a!LtVX8a72;u)TJRHdxp#)WlTthCd7cZP-Q-ICynAhy3*gLS zamXI?>k}i^_YM?~^}Q z1h1F^%c$ekDBSpV$~MQl)Ko@-Lbkd!-SE{EH>`6{PheKmIrR4su51y$cx8zerrAIq#E$}v6;D7ae7R@huueAC3pq3y>g=wmRM z!n6In`Z7H{bS`<@#$qhaB6TwuVCA48bGPyY)Y8WC+hy-DBlwKK8<7>va|hEiIWla>Ne5a-z70}Gp60UJIju>yT{`jx@g- znFre=6=}Svp&(8Dzw84$%oJi}I0AXOiarSXJb>?0V7@dq^Rta-T#QZC(8 zf($caF*g)n>?=8iI$RvV%n)Ye?d5dKdz_Qjd+5)HWxK|tlX=FBRk(1$v9be;Rj*+A z5a1;El0%z)+d1(*M(`g?v+SK+ezV%bO_OeQoVJ7;*n)mwafk>%IaI{q?h?tZOqpNBhNBDJU>aUad2XtkvoZq z-BK!oByGzM;~kO#ULsO=0p+!drd3>Hdi^5#V{hcx!Ahm|>4HMPEG&gm#EW1HxAVy6-=7PNzN{@?N zef2o=?0Y}^R&RKM3ZJeh8_@#VRo)l`}b2?z@`j7!ix8)xC5(3 zxM>$mc_Tn@jpcC+fjArie6Mv_lpwVnE8=<#Lpv91UG`Wh)qwuZ4r-YGRiH2JsokazFN%mWs0YFS`Eb0}N6vKQ zn%X=qBw0c=es%IRXY0#$5zJ-k6azvBKM_s{Qf!Lw?vAjX*l+)>70jprmmCYc&l%N?6uY@Yx8jF4YJYDE-OiE#VT|>tOK4eA%Q9!#K$(J#P)7TXbnb$L{X#e|SgLtG zgqa`4+A!lLv^d(0z zMReE+FkN*R;m{**!}rfop4;Vxx6 zCVXFgWU6VldrHY(fwvY&CHb&E*3gU@X{komL`XQ==eQzVbjj1ZLirlyj{CF(0h>}J znSl&5Tl66Yu<=bN=p=lO;p(`fg%IWmMU+QXD`##b8F#11|I z-wnm!C>|^v0;8`GTQjFiMEJX;A;N?j4H)s6~JHTT~lPf5}Z)J^2P_0DRUpryS zsB*+hk&?>%P89zjbWKK)O=#=l@{7c|-(xHPuP+}c9EF6fEF5i$7ZoUi7ZE7oS#cIt zVy!zD5X1&WLtaG~8^Oe-J;G=G5rKp)-g?XJp{qcJqJ#sXGh{JcQkCeAlL2>PFf~Ss zcW8y8Ibc7gR*c-A-&30oc9zq3ev;6`p5spN>*-k39ZM$6Z%@d8GnPrZ#FYxqa-RTlDjqkY6y^1ES-82E{n z2y7V--MWkp4A`EeLoJ;5r@bsPlHiIO;q_R^Ba@Ulwdr#)$e3?$$8U8wC!;S;WO>KX zTvEKz!&l#$TdaIkbG5~;C@ySlP!3O)`_7#^^(_(QVa7gr+`g92==2L#(~Uy95E+8G*<$6($VqRO!}RaRLq zxHabvuV6=fYs&vpopUP1&~3u252&bLE~)fQGk3*H_^4s$jC03}x-Hr`%WK_mZe zMhPuoNk_!pjqoH6wg|-5wPw^F5pn!lQmjR>m}R`7yL}wN{C22Vc2SZe!MjH+&Gx9E zIRKw^MJbAD z``s``-EKfgYJ0hg1sxvm9&~>JC5TRMm78#yUU%++4I|1>SpY4xiqr2ElMTU!vFLRSg!H{Pb5QY8w&Mj?qRmnh*hd-FNVl4Q ztylA-?G1>vc4;YLD5yZm=-G9UUKK~$uBlkPAi|a-l{&p$&}D6G#@@-zK6Ng{mV<=V<<3%;MX(wXBR&PRe#31**IQbHAK z7VdCu;gtkCtCEv?k!L{etmBX)Y)-X$VRoQY8228iTl91ZWRGkns3Ed&4M;Mva!BGk zk3>6)L)H*&zqez42A33+#6uT?9n6M~FnXNbhynh)3C)BVKq4)>DXaV>Rh&baYR#qV zZ!G$qYh>#ZVbY3BjkxXjM=3%_WFIV_h^I+!F5+a7B5&T*UrXX&@@`{hjnWR2LF=GL zNQM2jP$Uco%UD7}gXsD-!r#d|1%x_6{LD=b90}%T9Z~~dVqu+q^|!PCA9a5jRaN_i z52LUJDUl8VDG4P76i^X1k^<6_0+LFIBHbX;DM+b=G}0)kgfxOkmxM@nm()8K&+m!< zd&YUk8RyFx=L=)7VXb|yxbJ(;YhKqiLm#K2pOd0kz36R8)5%d?xl#GSb&qfVo_Hbr za5LW$ujO*Z27{V@wMrNd^N^ay@mtHi;CiV=-1Y3dKpzY9$;+C$YQvw^EgGT7t8G=s z8e(uK`RX7~B0j-IrOQ;9UH%`%4pZ;cN}=C5v+*pP@0fhVKoPMQDDd5`S7h04z+(FW zok9YwD^*Z$LYAyo(t)M*o0sf7N<@~K3{lqCtL=o}>f}A@I@l-m!QcF?&{sZ7QCwfVd0=G#s> z4fk$07VWzDB$cn0+<5n#a8YE`bIWmSut0NiY}M!XbhGGizmxOxdx}{6h|*m$1OG=4 zZs)^;dK7_bZ_rd3`K(XFWNw=Kf(D-pHyZC+oBGmWGY|DcO_?T ztc@qu81czb)rgI}^IvV1xOvj}O*eo2Cg-lfw@R5|tB%Iq#Mts(kAktph{U8#mxY1f zinmtwx{E%PR>l&M)i7<}yYaUdfWgkZ;O`Coc6R;!JYED{)fgMQx^^~xIPPGT=JWKv zwg16ZC{CPE1l@r%YQH{DwZcjJk4H6aUKiQ%uMHgGgSnd|pk2$MW zUNyTtSU6E$Sati&k!i3%(XrcG@OX4{e2Ft}<+}gd@!-|BWU+Pqh@PE>XR)`5aodr5 z%w_BAG|^Ko$LgyN++(&?BRvR)_D)4%s4^h;^+D#!zI4LoJ^KPxxvVue$wm62&X~#; zE)fl1a_sxc|-v<3a5>{y;-xqR33)a2Ka$$Z{Hq!Eyc8n;|@txjfSN9~gah}IUN zyVvB=GxA0JM?c;Q@tT~Qm>c!4E_g|ovvU8=6>@f>X#L$F+kv3_SjA*nSvUS5y5c<0 zGdMt@`O%M({2=sMlt{yTe*-EIJ0O7f8t*E|Ok`i5%aYtCtT?E?+GvgArlymaMv zBI+)qoE>_c8YC@>$thS<KcW3!kYLX(HLIv1B9&Cy^L z!6qK=02JAoa8IZdDMHjXrq;Y?y2*dTPhK+53CNmCm)4yCp3#Ov|BG!?i1=F{|M^QA z6|@Z1I)|xOGQ+?Yd<4WagN;9MgO*>CDdN@;-JDCF+W)_!u~!#F!^HobIeQM*{0X3n zJK!3?R-Z=y&Uq$Y@Np-jE=0C!ynS0wJP(J63Iaz z$f}sn1;0tM$a0m!PHqX7u5G-uOtT#lOCji|Uv+YPAn3ODY;mOGBhY4bP8C526IOpl z_{T>A9~7-&DrIYmsW7RH6mAQ^+UyuQ7TM`{`T^0qyEt5uV{`h36T4eZG6+OXCanRD zgNS(z&|b@_<^O8(1#_ox(R7p-a=n255XQtcKl~X8mXQ;yz|~_Uzp)OmX8wbH6An0y#awY$fvgaSe^F9lb~SG4{*M~VjpPA?eyp}E$MprID|rU za$QfrxPWl+FzI+Jvy5v&B0gt7%Z|yFKsnq0Wq=@T;s)4F^#ka)t$GYMdZ7~B4 zy=PTH8dd*|3}Fd~v1QH?ng5{0)SpMbSjl8rY?=(JmO-UutGrPQ?F1Q6?MbNkEGK${xtUen= za1CMY+DHmJfj2y*Tf=gkdF1^yrr}>-Y(8j~yZe-qQr^$fFbf^>M_!5VsmpsK=|uUF zG56bM?Qzm$&dCDj?|m$yHS7wf!jL!f=N+=&Q z#am5UN8i_2uV*|2tdRZfHFH%hDKF2B7;as*0$cPMO2T@0|8;o|dj#%!v*wO;5j*Xc zCe{BAtet)mMJT=xEP6lTfXw~`q4JSOJf=G5=@Scj-AliyON>r7`hOplrhP(=#c$v1 z8g{6|y^`~OrH^^nZN(hmREw#E3UXM|JmxU(nD8AM!HrV-^M1hp{T&5qlb=w3t`BzY zmLMVeBFaRsx5RV^ege025y50uYFM#lenmzr-PPQek0^Eny?tVDxjYL@Dsb2jRxA=N zS9ZXRA9i1ENEsdUr+Xfd)US_abg8zSr^!}|-IDKBu(jzi=Kib*6aj2kc$zFau-*|0 z4%R;YqIxlSDpOa_tAJ;nI8oTfXhY3C+i?G$$0|rP3)kQB#esPQK}<)Kl4!iz^ZR#_ zhZpoYH0Tw+)E4GOzQa{##?=3Pfj1yRZnsr!*xkkVD)|?n78t&}_2koMF?hGc-70HG zfaaSEm12(@F}F`-#-4;?zq&SG+2QDWCPvJ}iM%PyIP3=76k%66IMZNHN^`~EBfC5F zxv4*HXnM^S%2BR@}=vCkYxNM_#CmIr*e=#`8SZII~t(4m2ocT*ckDm9vC# z>sRayKC&o(`028kw~Vm-713ynZmnN)DFH!kwm)t=iW0D#Z~`yO^Z8E@A|f(Wfxu?< z?&y=x!wU!#<59TipU0$JlMF&bCQ-S(B6ok>B=*K<@w(dZ@EL3aXD6g+>FlZVsWZcf zT@Tlrx$R}U?y@J4SB9M&&Wh32Cm@nF!o+pqzCY9nR}s4GS(13ZXE6le=TTiGhw9hJ zjc-^S9XvkQM*1aL-n0a5wotuu>pkt;>st%yZyQ#154wrbEE`SI16NP1zGNE_eu1)y z#M!v4I#Mx_%k#zc!`F2c}EpAnYY%hFG;P?kaJRwav*n zID!-eXE90l>V*$=0%!dLBuAv0Mfu%=PWW7^@oiq#<2wW42P+lz6ApKs7z zP?HssStysXj{6ZeK?&ux!XG=$<6Fg{H@*_hr-OK($c$}iO^J7x7Skz&L2OLpA6b`l zi!xh$WtInl-eIasw(BRQPin6vs>IMyW9eC5hJt>R2&nKueFm7v6V637~ZODj!MSsdJzpr=8=qW8So$%*Zu zo$;B}7;KXa*Ma?RlG>Ybt<%hOx2*&xsJEjOMV{YY;S)^E*ol@;ezTA$_L?I$<2f5D zTD-PqnEZPvtq<`l*l%>TDty+1aoa%@(+R}Cs;u2F;o1~0?@LlERls7;ZjjFx7GYLd zl`Y{21oGl{Dt za=h%&q!k$x+&|Nhz+*LpWl}mckbR-gYDt~>5BJ~XROKgF4>~IX8sq{3Oz_?#$_(wY z%>vIOPA$Gb0Sk8)?stywg*acy{wl_mU9H}EY9O-_wG&}&mC;3}_#eFLL$sGJ7KuYO z0{Ab|3e)4pA?jOk~lrwYzKD7T4*BYWJJg>s)7-@;q|2aNxafYC;@-!%JJXw*)P zR>bLt|F;->CafHBK92&ZeiK~p9e)_pu$HK(I z$L!digPQhmFhe@AyrNz@v9;{S+hgnF0!{)?g;&Bk3_Z-#UO*b=BMn;;F!V44zPRFKKra zIA%l!Aj&zv__OROZgXs}*2$~yQrW?>RQWdik9Y3;M#TDrKxI2OX0pu06t`!H9U@)WjmnTpms2|J+f{i|qKJ<-G)ywld#@w@<4FSYw_sta zS1Ri*zsI#0wYzbA=*BywxvJs)7PR>-c>pnFnOg)ka6_P;K z;<(Yl@01ZhY4|ew3_NwoL?8_-zYUR#AsdO1EBNVL=g4uZEEsoLSI-h z^?*W&UrfwJ)JAJ}u>SlWkNElnam#u@?Kai&>gzByMI!Zbr}Pp@G7sY@O1lX49O~H) z5cdp&s>%>ol-~uO5bfeEgf%x2bra))pjF%`Y%x2lo+m#cd5JX%{VI3EVM&V?JZbg< z_P{N}2w~^i&vkz7fS~c$>O0#GJd7fi?xQMLad3K`KQzzY;IV?r3g zt$X%R-6UOOrPv^3Kl#p%uGjgYXkXx#Zmf-^MAf~c6hI~DTBrQJ?k0-CA6~`I^k3r+a#?{wX)Q~NcVB8rC_vje+ zz8MeXUIGpE{;mJ1HYIoCChI+5tPC(&x|Bl17ceHyQf%mM;><8!9*gL{4`*m-f(dJ2 z#b}bYV`dCwDEg*xj%0`na~}!Hi(%ir#~(xT;%S0?KVE-5s3~u_nfddqW*IB6j8|sd zdME116%BlCt+f}jBS0gG9Gho5`LkG%hv-{MNzcg6FN^^f#3u>L;k@&jIR8T6%6G9; zu~}m7tky~6GUMu9W2V;r3Ai~^m~qEPCKf$3Gnyn7w`ERY$!OH|V-uR+iOiqk>O$NU zKTyDv)4*Jz=V5x9=h(%`OR3gCXD1ND^gaL)eZA-?L;tNh$;I>H`|vBy;Jco^>+Gpj ze}m!ZbdqP7f%@We6_X;gvxSVz990Kzc&zDCNZL{yRW4DxPtrBxs{VdPz+yvLe-yKc zG8%{dTO#Xj6r1m{D^3xt{C-1sw9b%(fig`lPU`g)y!M=mn+l(VD?b!z0TE-x5c8gy zRT9uyE2J-Z{^xoHQTgrg{wjaiuRLTBr0tIS`EOnGh+ok5mSIi7Ap@t6p z4BKOcQ>pqJnG6dhi}!ET{od2FDnm0H6WXxUmCM9zzyCap<0?HleKX1c%8eyo%+46< zHL$eBbgXaFcDLEx){B$7CBynvGW0&^hARx6nY9qP=ETn!J_?oeQHQ1dK%Yw|5&LU1 zNtNU$Sw;09YH>dn&C>8@9~KB`43AekZ|?BCeLfbspnqdtNNm|6-}QUV!9w`^?w>dt zn&v!7vkx-9G_$FgcOsBbCPg?)2jm3?w|UoPg?k+YZOVaJ^QcOZ?m08DkT(!}+iyCq zSS8%FFSZ`790Fd`g(l3X^LKD^oGM0u%WVbbDcGz(RJCEhwC2w(=vko0IZrp|KTH+x zwJ_#6fa}oy!Bz3jfgG!sR-1kO<%vacew(wCq{d7`&z5e?(()GU{kZP2ONEm&h-E?- zuR_PHOo*iwX3-EpGC`XLf)5kw@wRdbQM2&+ppeF@2i6F91i3fWYZ2qP3j-ssKf@A7 z>+J3SU>z@OB|dwFq9*Z*?*>V&PAlbdVD&ey4ND zpH8)vawDWLg2)h$z+(A*K*hx zpZzkvl8NtY)&!VMSnL5%Kuc<{XD+MtiiTA0eTY)1K=zw3&hudvYh$n{(vse}da3QL zb!9eF5r??M@6ESgm44H%5rTE2f^apgaI~bOKU>!Ve|QM8G-#E_5GNA`uB`bX-aChi zxCMTayALFOM@`1g15LrT5m1gy#EB>~ zjDBTYI21Z5!R>8Qaly@95soFb;=_sPrj4m zqO4wTdE`1JnH-5*c$O;X%wEb)qR@hC<%OXx+rYA0@>)AwhD_&12i@*_*{*0cGA_hj z6?eQLugx@f=xHJS`{x=GhjnwJcoR~Avo{FdF;k`;U3u+Tp9G%_zbvVbq`HIya-UdM z7tCDE0{v1KBNW|>z8V^e_5QgCxAd_y1moWtCD8V~0y2G7?N)YDSV7{9f&?s+S%o(X zllR5}rjmBPXV*q!DPXk!kc)~)iq5#9@XcC<#0V7P>sJp}KJ$k3R05J$e%{IK)Yctt2gjg9hF;^PA9EalMl$gMZwicyL>j~~js#UnyvD2Qx zcj`G$s=}}xfaHMCdV`kVB!H0ST2?mWgy*|J`sa;I$#CB}e^9}-xxuylW+M*v+WNZZ zMn;>{1RB~`?d(LoK$AP$6>$GmL4Rkc%)l1ti!Z)pB*T8@7DoKO1$_d^{pAP7>+21J zwT0^Vqh7GqN3Wx&$^6y{eAGe3Yi{MgR;voWa>51B5#(=YEdv19gqIn>Fb@WzDmy3^1mCdM&)4I*NGb64C= z63s)8`r!J(b-kCRks0-!omieqP(Geb#7+T zux-F5&iu^^f#7$U4C;jh42@^ig|Fi<$SN&K?rJrYyt;RzNtzy*mhTTP5HJX&I*ZHw z#fd}I8OyvL0s=JtQb{MQ)&0HI?yiVVERs^rOv9K@5(D72>90Y7rimvE{p!;Midw8k zw#oC|GY>#XUEg*g#{IZvpTYEhqUhNZzME&>{v{hJY~m+)>$Z7vnTiOr?{;66lSQNv z3Frv|rsc1Ngvzy_Crl!lGW4^5b;NMI=3m$#yM;Na4P;oKWk@y7$4DLal=%HJ=EsOS zM=BtGY792sr`T>mm~xHpqiuD*5PggtPDW*eRri{g(rtslnj&UCVSR%XbN%^-udf2x zy7&U`O$Xo^2k=$Pyvf;gtE9H%cu=_>L+^LfhuEGoJ!zJ{obo%B#@*`F;a)7p@cLaX z&YsYs2AaFWT5M_;dF{V!?eFTU6=WVHgx($~EMJhnR`W`2RBiMiPq24aCB2NuCR(vn zkU#(0Mj$&SK^oB;C9XV@m#L1+uSgisVo*isY@ChX#KUzHq76PrdC@FN8t34%LDT); zUv$H)t-0Rj2G6edxHmr{9p#f&P{azl_wZDmfhS3&o8NJw*}dN^7uV6%2^Dq^oigi$ z4$G)nAjqLi$!hJUXD`veZGS1!E`zpzD#|kPazWpP=O!o0hAhDJ9LuPAd5_{PZnv|c zD*}!Rxf7T#w|{}xE5V&t*0;`XOcICSHUn@uR_VB!Nd9u-_sMamee)TTV3sIMt!Miu z$EznVuKQv~*l6)+kCZqKa2a#Kdj%t~PBY*CQ1#*DWK+P|1A-OpGtj@dMfaDT674plB2Ki?RVaFyn` z9P^%xp@l%a^VtI_#~kZ}%?;+~Og81%&xb_|Hl;aBe&Do&O{<5xWr5>|#kVKd2dXT7 zKgj)};c`Gc;QlBl(eUy z;RshXAf4b=4a>Cdzx+bUc9W0d=?6_re66h{~#F%(2o=v*A@;Q)Kl~r zBuUK*CKZrds_V8 z|LP`A{^?S4v_qgdxcQm%9hM2}>lYiR9!P&({uQh*2QDC7#?{<=Cono>XB_+UE;{Bj z*6Zs3j^-KYRkdb25}tta6JIm-@1jukh$5mNPTu;@eIvw-S)GT9Nh;^zj9WzlmPv&? zdj3Be6mSPvv8;J;Wpt1A~yt&pYT${P@Gca4LtRP$^bg>`SmR{rhjq zW~d4~16Rtnp-^tj`Sj!}Tyk`BVr;?{jMx_qvJiGi#|6n@alAz5j}9b`K6fydN4s1B ze9W2H32IPvyLWH>-~5({>%q9$|q zHjN4Xv=aCUaW74h!e%hGRqA;NGuV?W9~rJsT{iElx=eUc^OiRtP)GW0+fS_UWO*@{ zr5I&UB8C5`b8sn{M5kY?<4U!0r%-}o*~5K^k_^{OciK@NGb4lz-i;Kcbd>HwBkKmip;FpE$( zkm4Q~u6iJaU}8V9r&ZfAPhfVIHd5*ilE~1hXz(SptB2BMtz@tC$=>gOlExJAbhkuC zrPO+PiO z21AKExMoK2H>#)oGjF=l!^i$&M>5L#Yp3u4DCCE}) zPYZ7G32V2y;;yk&`q7$!kFy7RWejZx2uhy4o3pSUgg?_l1-i`-`V&+ztyknIKPrzS zenJR5cdNDLB&bM&j~0P+L( zQf|5^oQ2d|)RGA&inz0WFP~XCf%2e!8o>MO&Z{aX^I=F{Kfmeu^`sdjPQ=Fsq`%9( zpYxWfjlQJ|LfaRNTrU#sDcIU!8c;<9FSMjaS2b5d4@tt-((MRXYukXzIwj7?H2CIl zYY5!$t>LEG1lYfQQd$JwPr`JcqxqSHLsnY;=b40!h~De$n^ZwkR5=k>#0}<7_l3+=!U%3t9pJWAIU*`>5ex?NT zyrF6De_;E)^IkYb^#7AK2mcZhZNFX62MY*QeblGjbDS37DAxa|8K@?aw`KNc1|J!N zP2ku4v)qF1z)ylfra8yCBtCn@eG{5t}z6ih$re`xwv$WU#7(W8V4kw68 zAzT<<_1OK~=?6uB-gBIC-$_OXxbPKS$6vbwJEC4WD_bp-t%{UqK&p{X)vCCat+mjX zz6GUy`G#+fE(%_byiv$^3>8u&WbM|^7BzCsSgq6%@Sb~t2)^*gsEOiRyM!OubxAn@ zI^}m2YJZ7{0PX87P_X~jvCNCU;v^hyN@8;ZU~yfOS5h?lrdB3`{`Rk%!U#F%lf`|w zx~?a3%NDA~Z2rvE7SKFHb$^$iidp0NX~L7fg$3dlr_bPkYXwGU0xs#)JsliWUm6Ys zYHg!`ELk?iBf6JTsBj}J9trYKn<4kv6IHdDJOx7c^pHA5M073WD~}OBh{B}_k{rew z?Qd)rPZX$Hp)&di-Z0DZ2CHSHoN9hwVLOSs;4$vmQ)?#dVjyfcJr{?mYl(|k0V4%- z;h86nP_u8Ha~QE{mL}4Wh^?3c!fwO+q@X*jrHjg?J_{{d1v z$8RQMQ@ENNUL8X7UkNYePhf?*fB_u^$CL-#(ib>)T>< zDbP*9?#bGJXaEZEvRe58*S^TpEt=S!6`U00{k+6)Ji`95uvKVu_4zunGGqk7nQT{L zjL3dTy_vY18!4{48aBr0h;UElf->@CsF{i9?Ng4Vu|xrQp4fkZG39#hcZXgmMS zk#%dE!|sFaAD+iO)TIsI7~Kzc2y+}dMFq%%qJ_0CUgG=O6ZLe*1Ji8j+AT^c2=laF zIgw3xhusfaQGSVvV$)W9!s?PuP&%efz8cXRQnb`RkJWnZqPiPy;IQ8y^ZCxCL*g&u7|0xh+ zQ=q#;E<-z)(S4=Kp0{V_km%9p6FX-OxC8QLhY}hpV3mX;~4KI^XDmS6K9gNbg!lJN?Z)}m5uHc;-H3^`XrY<@02g;CUtlyn| ztepCrL@ZCYOmViP)fQAl-k@Wz+=yRe(iDLde17P|O8RWd$8^?TCrNgiG8cKLzC7+0 z^?>T&*N5UiLT@$6NMB@dtlh7y-#Tmhe9KxY32)1($gDugq`g@<@=EBObEtPncW2SR zVeGXiFW$+fLA#iBo91$drq{-jXkoVgPC{m)_ss|k@AE+6Q;P@gy&q|51AK~R&pm~T zSoo5X=O49RU8`o&h@$uEfA;`_;Oyc1w{a!5`!3Xz=jU~r-pKA=GvG0vBb@Aye^@{J z%>AMoTi-PZ7K?8-)tnry?td|!Xz05Co%piZi^<=m=nn+99`-T(E1(Go#~{NcaSa(4 zoeUAU(~z6p#;$J@qHDs%+<&JsLkQZZfPb}9dCW3Vj^5SkS9n4%@7lYyc(+EnJ&z4n zxT?4TJ~2f7-yihHD}?g)JiV9FDw*+ec9Po5pl(USO4a6ByCbtiV_jBVh^etbpwCol z!2R8nYadq2-z@5HcZG>H0~C05<&~+sR*6rbS9aKY2ocH6UDonDdoS?iFFxkH?PE9IpFbF+`Z6RNIcopJxoV(_S^bez zyf=nHgb`s2*ka%G3C~a>q7~%IW!eX`lWWTr0iq_}T+9!o{u7C-puQAdn@u+bS0e%g zN?q{6N$rX`)S_&OyrlW!pRj!U&MySK?l&_Lx2ZO`Xzw=grsM)BaxEd2`~no)Da)ptNk`3nTcrN|lyXR-iJCf@9Afct)ySW@-- zD3q-^b=xN5kVZJ8q8$HyQCfU!|MvP^zh@QGw~pP27fgX{6yn#6?oZ`h2MGUaWd>q_ z!ia@<>P57J%=+B>mPf?}PW&nY&V9XE z0mLb7#F5hD(90&eT>GP$@9ohMEx`lmlth05>i4=wq(1%)3=QUVij*zFmpRV=`ygeR zYOyYifF#=t>P1M47Z&%cMSe=uVL-Y;Ja`z%i&#V5%l?25G!<2g)*HtcCm{_NYy4)#7+4axf3OeMz~31AE2aIF+(qI7oQv* zF5Nn*sMj-FNr=BS+kPPORl4YETIJ;E8r~lr$A3piEBNVS$4$jIiDcZz?C6=+vgGKeo#{F!%H{;%0D=_TZL8{w6fgEx~7n--;r3l9+lBb-c zmst*U08DrBcp%?85$xn&dS13Kc7AexNO)&U67M*FK#_Z4@55ZRo3F=GUznERlk52Q zP>Nyjtr@4VXIOL)y{S|LeyV+S_o+&G-gQ-k=<9n*>?M;*fu%@~Wy)>O*0wnQqg39q{zVgCrK%RILI@GySan`g-? zxL6d67!Ah}qZwyVSS@jyR~scxe}x~#+-R@%(#wngd|n4fUW|K}&! zU{vmMC)g}B7xaebMvWQigM3v$L@jvl8Xg_&mXRq6e?3b`V^VWC&08PEp^i0br5Dbf zlQ#hgZ5cvN(s}C%UJ>=FV;^+(AkVujAip8-vd!%)4i<4sHU=ht=9gSLIAu$s7rnm& z6%;rd1fPz*t0FWj&p^E0`t$YPPN*8R=gWKvrRGcd zX37BeLHwI7KA4zT8@zB6YHsLC!caf3CKuX4Qt97(!vfpo#Wyf_e$o=b6u1o(e{K<4 zP43q&VJpCdq^wqp-35CwG9BKUaiyfmVKU?VgZS3~N?zPyo5703o0l{sFfI69P)ELNLP}mky<&$e3Tx{d3w% z3>@;K24lOsRT1utRac6XAV3Fdm)#(8S%zo}w{2b}A2B%|&n`jYNW`7*QN~gKM~~|} z&f8xM7?1`Mw_xHgL-bJ!MWF(X`cJE5##p~O;5l1JZ~iHT1KqA#-SC1C(=1>7!q=Gh&6MoV7U%lF)N|b2P@uF^AMgjZr##B zp!OiF7^Xo&Sma=aU+CY23~LY}PI(?J8q`;kA8vU-NeRh8K7&(5-Sap5nl*o-fm`|= z@%#G>B`k@oo=F-Cvl1c#DxOcs7#yHF6jzs#IGZEBY4LVg(^s`5ccEfdXC~R_JihU2 z<<7&;u)->@j33Sj?d;Z^AiY=~u(9}4Y~rABP40O;GJF&oNx=k*Nd*OX=E*#^&$Z$N zE0BD|>)0@+zi`BOckgBJ-rnA1^TxUXN)Dd6X!M;9>{s>TZ0eC5(IWcJ@$%| zNbioBJ}m6kq{At8rjUh?9Tn>3oKNG#JgZOJn;qo3FLb{5;Wnrqfo+65MrF>bH>*oO zn1kiRTm8H&9kzu0Wyq%ZK0Qa)enWRit1}Y7^TajpEgmjo#6?V$i36QB0jzuxw%(N7 zI)ebo=B1^jwU_p$XqK&vU6gC>>D_PyROlz9eN>f2eKgtTqIUD$jpKerJpC$;&d~ls zA}7gUyXyJ09O7S1wh8k=WLq5o)6*MD?(bSpa;#rW*XUk#Uv*{L(I9ZY^h-WPpw6FTw^k!&N1xTPcnDLej$DuYnt6BHl(thi21=Ve8Jj;iE*D(3iCfaWDs7)u zOjF(hMDdPe-kr#NRgHjLi_VHyWbBIPMt@jL^h9?-$i(T$hy5J@iSNCn*}-aC+M3dq zoxc2)zMX*F8G?T}5%;UgNFAU2T*MSv!ZMx5OocNezoq~FPYYiWz$fqInB3=%075_E z=pbTpS^h^y(`3;>il&z}Kc~L$X1p7AX~)mQ?E=pyH&@j(4J~Wz#fi?KaHph`J7#BV z4^Qr1tr$9MnRf?$5;f4e{zv9M_nC#rZn6HGHtxWuGwo3OV02&V=z7?Co`;@!u0{dq ze|&WZvnnxpEk@ozTH3%<$x9|Z5+H98}@rzc@fhI#@YR{PjtDXvVC;e?T^zssO~vtwO4nB zSJ|~u&+ccX4rlA>Fj_Vzz83p`q!)Hc|8~;o(^<;>(&|wv272hRjGH@mDk<1+Q_CNnF_JZ^#ej zd<@Lu2b65c7yb2L>MUrlTv@;QzmLH{P2&^)e{-5zcSg=g!<)#Ak-;1lQ{nYHB>0u+ zXHl2a8Gi?53bcOQo0Y`Acf99KL^Zxw-u^N1! zz!_tNtZ1hrtRQ7X&&b7W|8oI+6pZMm|6iVDMlTucybRxpb{w29{Q3niE37Kf{asmT z>_?_?9EMl{f+!>ArFVcK`UA^iku&zk6DzbRm_HNmS-H#jy5gyGFSE=yTmq%N=l~ z>q{-W?5ek5`~FZPHd;djJ#iZxaHU!woOYqOOXCxAlzSyw#591uH(O`#Y< z%0VPPgrfKk(2aG>&9jln5#|epcVwd{Rn-{HwZ{*EMqCUNr1{NtOEbjM4JttK896*v z6vYvBsTTgmyp_$5d&8^dzI~ikp=3l$SL_V#@}pYCe&JK$)6z@7xn^zz8R188N%J$^ zO1Kk*ngWpQ2`uxb{f+*^B+9}H`5z-ANiByzWnZ@*5$=tx-dvF^SREefDc0R~U#C%*(2{W=EW~vG8VzcjabheNa2b0Xg_L3dtbUC!f|<_xyrEKuM~Dt;>&muzBc7q zVIN73u zFUh#?&sY(yqW7NW+Pyq&i@uE&OKe%cVXC#ObC?R=D)!Tus`eQt#A&5>`i~Pmi*S(p zOcuW?1DD?}-%g6#`@joB+qRyjK>WnXe9b0QQ>%ec0e+1%=d;H9r7 zGs*d+pQ6hFDLkvH?nYOhlU?Q;vQ3{GN(^qIOqK`42hSYsJ(fKt=_X27 zB6zxY2KF5!!rvk7Tund0sr6JMSQd+SUAAjrCx+feDErz>Kba%nU&p@jnh|A}*}}I) zw{2%E%>p;DW_~0+g}jDf*Me*HU_o)ShD>K{{9rKizT;?x4$nSykKkdseB#QgZ3$6s z*$gVXIo`8h%O~8jnzcV7->aPh_vm#@)+oE+=yPdvQMl&bn3Kt=6Iaz|TQw}LWyxLn z3%3$*W=0DSsiO_NSAH9RPv31#YBPw;j>nx7rh`ZW3=VEaHFhTscxG|ZWLBk!bj&r! zg_oFzRf%YzV+8Ma@y+&p{B%Jh%G)ccJ7pYwBq%*CT6BS&PxT`yBSBW>7E#m*wu+a+ z`S3rOs!qMm4?UOylIk_lQkPrw?jAD@oX_y!X-Np{R0J9~Q>N>p*q~^~d{gn4jb3B! zZQB^3=7nOeU(N5rKYnr1i1qebK!Np9 zI&tiatt!5B7Fl)Cd3bX|s=QB4RJ=mE-Hj{>dHiYF&@;qBQTJWFdJWE(@PDvZ;Z0iE z{kqvNvtkez$g??f2c2hrQ`)|rAK8j3C}l;z%hyD?WM_7GGHmNtIsOs4yScC%#pDPp z&B#zjmD$B9dh#Pr%|C|yzwYhO)Aez*9uf3pm^RVjKLB*a0Su{!ps|f@IfX_j>;!I1 z5r?r@$l;T)##(S23o2w6$}!7>3bJLG4&}D0vVw=rNu9#Ac%cE* zO+owV?HAYtxlsGB7^7Q6vdkA=Wp_RlHPSvHr-9f~IXhPLzzv3UQTP*jrbBS@`l8pa z$m)q}w*m2y?;6jO)yjT1(WgzcMwnO@mkS?vF(WQ~5YgxPSsK|OspoCXBc4C)} zM~>ZMi??1FyJTFC55~|YtK#Cx@zL{E_Qc#8J3&3pJ-O%X#UgA*l5qdN?k@niihx7S z%CqrdCrFDJ39!($K872sX&yq`y4kT~mYuGCBlw-Z3A*DU11ot!9_Q0Eeob^~#vCRn z8Hb#1j_48W$TMkUnbqnZb;cfHD3poEyPOgVqNwU;3y+dIs845)w-LGQ`PYqF$HQC# zn8kwILxTV8wc?nHqyZ1pi`sB|W6-d;BO=NXZ~)rzUOwGzd#fRK*jeM#bEtz5Z*x_~!#*vu*)LrgC~(2>rEfkDM~S5jPE)z}O< zPa^6Qy6L0-6^g&d9U%Zm+Df+tosIz(2yZ6{U?#N-UL$epDI(Ak4+-_7Pr20Id$@Ga z&af0Rh&}Rv$kQ;X7dB+=OQMw0jK?VO{VtxzUqadp9s8!gJdHTa@rW6FjEvZ@f;7Ec z#VDVSsy&C(CNo21BE_#DgW=7HND~mspwH=S!9d|*T2DqL|04W*gkI>IFzAfb29bY* zEIc^;#S5W-KbVJYrANhx9xF)sAyf-XA9tlNbKQ`VhWkpKB?m){CLX_}oQ6Vr1tPtY zxVpR5tdQ&T{)SZ^kimbkS|V8%TTWg+5Ax(4$V0S1W*wyNZFC60@jm}22Zmw0B1Ax6q4-(*t8`ujy97r%SuG_XbA!z#!B%;v%sj1Iwq;KCFU z1p(^%V_~3xAvIEk{Pdn!5x^$R{q4`+L-dX#==8m~iJ#&0_Yl#g5E%?nn!5kqh3{c%w*_A8r`}@Hmkd?p_%l%cDnwnt_(^=5L@g=FN%eae>oEie|hI*T_-# z2#c93f`*O)_xckkSqEy!5=GLJ+i$KxXRjgXZHi*Pn5Z7LlP}e=^()tp(+N0__nu z0{;~(SA@L2vQ>{x=LVWl+snYugmCN6 zs~E0z}OGljFu*^Z}4X?9NE=kjk0YZ(wG4yE3gEhRqN{gnGn3DaE7OF zBTK;@zmw*=1-ZUOpgL!o{{LQCV#XV1i375{{AChSvwmgS(#gxq*AssAKX<_h_$V6b zqx}>Vx}!q|#~ZPTO(Q|xt58}Y!IC>J0cjM)%r`QS+0%HbR_a=#+Q92;eklA`3zZsP zz4DkFK-vF+M5(O;Mv6Q&9M}9(^VLvc6RS zYYaoV;S)`?T$>nJE4;t2_EmjxcbSCQQnIZMZXB8mCSXyPG`@-zivIVZ#;q~myiErC zA2Rmh117>#5fXJSy(!tj&p&w}W6W)>)TTULrjgKpZh(pPvMQ$UjjF>1OQKgU8TO`S zOLzU{+bnO>GgcA2b-k03+KjAa=tCsBE-;p(HujzZpTsLxL&fRycjDfh)6rjC-(;Xr zEa4`~yRI$NcDjK`8hBw`IJ%jJCB^Z}yF(&P2akgJmfak2er-Np8&dG=49d1=D-*TQ zr6Fgza5{Bi&Bf6EVz1O{%=nA@1-`@aLRYFkw52PPPJatcBFt|u(C-pF7PA@TzC2(k?9H}fVRawK zcFuZ#!m{ftS^1HryF2GMu3KhZ0yyYPTCW0w8fcJeJ@OdvGyL~90DhF3eW&TU<|~J- zFuJHxc68%+z@^h>CMiD`&>s!4|=;ij0gT<~gbkwRo@2xJBy&BFj8M>yh%pkTM-X%YLqxa-n_LD|wI= zW!pP(nvkriN}irg4(34guQdvkFVC-8F&C$;W*QFRg(`mqYz1F=q6m&y9R~LszEZx@ z*h(b|9Fi_Msi=$@HLu=3)PL<8jOgd*7-3lyqvE?ExiBJwErTtakdV@u8G9$WvLfn? z31q4gj-SfV9O#AgwJgSY?ub8Qx(w#tA#-2rtdS|N4JoeKh1Y#d5lWa(4b^MaIN!fW ztt@n})S3*qkQ@ zNL&NZz9@R~zTvEhS)Ve+jI*+yr6n_J1Zic89FiPY|H!{rTfMHgxJD_P7mEqUL1b`p z()bmHiN(yBoNr1qmI6{sJ@2_e^JU<|qRlf8K(kf?Fr) z#=)o4$@el$rv@FvBmgaI;lN~n8DA;){y~F?oDu3lfqRuZB67Gf5c!z`J2lM5$;fDsuB^=^*qT(4ImA*i0VDaNwiWW4r@-7D? zQN`2A_H}3dXzeL3?#abE9kl}z8RpAfAx60pIK^!}C8w<7)a}6y<*7dneHkx8oOl{x zG4m+vqq&~yGz7PP( zpc3M7Q5A*U?9*ck;KqG<{*mvW5B~q*B*{D2Q1760sB12%ky*k#jc0mc=BVWG?NE8s z;3GC1{qH4kT<6~VTa>d=p2i`UHN0=SiZTS1ti7g%oPrue#?WD?5$PJOTmHAe*aUe9>LI{VFRTTUH^Rt$k43X60EjQLRmLMJQa1G_63nbt zYn0i;cRqpi>^*Cw^-_Sw<?BYr1K4u8~wI@deV(1OVKjz~_kx(EUY@^Q5Wzvw- zB!nLVWPUR487bJZvquN?&s7%bz2G~&v25^$D13^ef(_vHfcvu4goRb?!_)jNA|K8- zFUQ9K=gZ1E7!Lku+C~XBQBiq1B^);1p`OkE%iuP!9(!{s`I_T4$R?+(Sn?V{u2t7J zIHEoxMSc1@t3$|?D;Kaz5>Spdg|EN%@7Ldidz^_RB9iLKAK+NZ(LtWC|M%&^p?rV0 zgeutjpOJ;ZHgl16MjS3@9$3{~b4?C-O{e$!pX7j8#oO+4L6sBehOmrJpZo_H=3k@8 zLRZ2lMC^@;sIUHCyGoJv~R-ff(vrP}g36?s{Qu|rdi(JF0@Z{##7 zW3^$EU0PvDI?Y5O#5-#dx_FgS7)5fbxR~S=!<u#%BM3y{`4+T;_W{*LdTkh%sn(8VQkR#BQpH70 zyM4e&Vv|<#Q7kiMd6_g+d3Qv0P_+d3!$%kATTb}_IJ_|a1Uto!;mkPF{~dpnU9^hq zHaEP8!JC0LDvmMWQ+0<`3Eh!97By!Xxh5*<`oWKZfSlvbn?gOe9Jo^l0r0zBVH|ll z-unLrZ)!eDFk9xe7bO)udS?)(FGWn`PCq94B$8^f28h`YwNeM`=m#HNwI(D>7vgb? zNvvYhOo9rKSKs^DvN^3FYHt@5N4UfycNW8(R9<^U#PPAdDpSTGb&K#=^0Z{^d0WK+ z191wqkU9U~-%#zmLc`9GQc0#8Q7LXxfj8{$VAkICs$JQGwx1*`W0)naSBMVu7dF9Y zo4CR!*AFJ|L}BU79O|uYr6wL=>3CIw!`Q8~#lw%NPe|VITzHhmM;o)`f;OWYO$>7O zcpSPqbSVnSZ2i~ynM*b6eN6=V=ExfzYvgESIn5D#B=iuQ+EO%(R^}=(;un5>1^f00 zVK@@*_$O!KXK?5ucV&(Lz;e(F7w9wr#=%zK4ovw(Q%da1_M5sK5+McCvXLtm^6*9IfIM;naX#^9c9(-r{>&~Hy;oj!Y zL_wwQo6|}S`}b+bC8Sh?ajlv#4KLh`fT5vSy{nFiIowjk4N)^AYj$U|vOPGx4@1YU zFLt>zqK>uh>hR{=p8V8AP#ulFyzr&6C=e(VnJrXlSpI0ywuWsd)~jVTyz!>C5L1$+ znBHvc$PhptCX&9QqHNDmnJQ5l2t=6Aj5oiH7%QS69nqTQ1y)w{WwUNE)N z_}$)~ybu@z5u#_7BakRR=P=p1b92&9r(I-@J&F`G1xB~e==d9(X8xJ7g;0EBY#9mj zvKlL5a66`tH?dU`OmPGI%#J|*Z%1!t5y)A@6)+0cAvJTR3vK6Z9d5M^$!ybcE7xa6 zgKz_(6^~+cq3gi%m8)!DeP0NbJu;Y%GP5Tev=jZ_G$Z&R)=n2$om=lbey(2LU|N*< z{8cEY5Ckxbm=mNw#`M0;Q<|HPllJr0%X{|tI_2eNyBK`iAWQF>LG`+U)jxPY@uPYW zBJ9i^9rD_Sq!i^srzcU8KLJymkI9Zw7~k+P6XD;tz$@c}Ss~SKZ~Vro{UnummI%pM z18<|cXCq4#?tn9Xc~bkOMb177Vq{fZP8djR-&-kBP16?Q)_O>O?l8P(lw+7-6$7SO z`oPw+D4Wmk?3f@Uc_oB1muE@W{fU0Ve)X+Pocl1zRBn8^suw#s65JseWcMB>RFdM$w+LBnW^d zy;H$(R6LS-`3%9WFryfN$Y!lT0M~(cV2XRMbqg~0jJl28SP$!Eudvz5JukD*o4$Zcx83fBza*u8Uln&H=fXjt8BBoXTeU@5Rc;=ohhC z`iNEG!2A<1BmK);57&GzHJj-9w#EexY(#mn*#44}b?G*PfS zs;MEqRaOA%g6%1P?NJlnD`rS`?)dBdS?2DKxj}n}O| Date: Sun, 2 Jul 2023 07:46:33 -0700 Subject: [PATCH 69/83] Fix broken link in documentation The previous target of this link is no longer available. I found that there is no longer an authoritative web page that provides a list of standard GATT service UUIDs, equivalent to the previous target of that link: https://web.archive.org/web/20160305021019/https://developer.bluetooth.org/gatt/services/Pages/ServicesHome.aspx The Bluetooth Special Interest Group has since moved this information into the "Assigned Numbers" pdf, so I replaced the broken link with a link to the download page for that document and noted its location in that document. --- docs/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/readme.md b/docs/readme.md index 7451e015..5ba0dfb4 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -35,7 +35,7 @@ Just as with writing to a characteristic, you could update your characteristics ## Services, characteristics, and UUIDs -A Bluetooth® Low Energy peripheral will provide **services**, which in turn provide **characteristics**. You can define your own services, or use [standard services](https://developer.bluetooth.org/gatt/services/Pages/ServicesHome.aspx). +A Bluetooth® Low Energy peripheral will provide **services**, which in turn provide **characteristics**. You can define your own services, or use standard services (see section 3.4 in the [Assigned Numbers document](https://www.bluetooth.com/specifications/assigned-numbers/)). Services are identified by unique numbers known as UUIDs. You know about UUIDs from other contexts. Standard services have a 16-bit UUID and custom services have a 128-bit UUID. The ability to define services and characteristics depends on the radio you're using and its firmware. From 8ca541559676bc88dce841a889d80ba557fb0399 Mon Sep 17 00:00:00 2001 From: Martino Facchin Date: Tue, 11 Jul 2023 15:13:48 +0200 Subject: [PATCH 70/83] Update library.properties --- library.properties | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/library.properties b/library.properties index 3da861aa..a08e251c 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ name=ArduinoBLE -version=1.3.4 +version=1.3.5 author=Arduino maintainer=Arduino sentence=Enables Bluetooth® Low Energy connectivity on the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, Arduino Nano 33 IoT, Arduino Nano 33 BLE and Nicla Sense ME. paragraph=This library supports creating a Bluetooth® Low Energy peripheral & central mode. category=Communication url=https://www.arduino.cc/en/Reference/ArduinoBLE -architectures=samd,megaavr,mbed,apollo3,mbed_nano,mbed_portenta,mbed_nicla,esp32,mbed_giga +architectures=samd,megaavr,mbed,apollo3,mbed_nano,mbed_portenta,mbed_nicla,esp32,mbed_giga,renesas,renesas_portenta includes=ArduinoBLE.h From c0cd781374c36bf1309529d09ad88c098fdbf45a Mon Sep 17 00:00:00 2001 From: Giampaolo Mancini Date: Thu, 24 Aug 2023 11:49:50 +0200 Subject: [PATCH 71/83] Add support for OPTA --- library.properties | 2 +- src/local/BLELocalDevice.cpp | 6 +++--- src/utility/HCICordioTransport.cpp | 6 +++--- src/utility/HCIUartTransport.cpp | 2 ++ 4 files changed, 9 insertions(+), 7 deletions(-) diff --git a/library.properties b/library.properties index a08e251c..929fa0fd 100644 --- a/library.properties +++ b/library.properties @@ -6,5 +6,5 @@ sentence=Enables Bluetooth® Low Energy connectivity on the Arduino MKR WiFi 101 paragraph=This library supports creating a Bluetooth® Low Energy peripheral & central mode. category=Communication url=https://www.arduino.cc/en/Reference/ArduinoBLE -architectures=samd,megaavr,mbed,apollo3,mbed_nano,mbed_portenta,mbed_nicla,esp32,mbed_giga,renesas,renesas_portenta +architectures=samd,megaavr,mbed,apollo3,mbed_nano,mbed_portenta,mbed_nicla,esp32,mbed_giga,renesas,renesas_portenta,mbed_opta includes=ArduinoBLE.h diff --git a/src/local/BLELocalDevice.cpp b/src/local/BLELocalDevice.cpp index 79e43bf5..146d99b9 100644 --- a/src/local/BLELocalDevice.cpp +++ b/src/local/BLELocalDevice.cpp @@ -25,7 +25,7 @@ #include "BLELocalDevice.h" -#if defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) +#if defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_OPTA) #ifndef BT_REG_ON #define BT_REG_ON PJ_12 #endif @@ -69,7 +69,7 @@ int BLELocalDevice::begin() delay(100); digitalWrite(NINA_RESETN, HIGH); delay(750); -#elif defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_GIGA) +#elif defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_GIGA) || defined(ARDUINO_OPTA) // BT_REG_ON -> HIGH pinMode(BT_REG_ON, OUTPUT); digitalWrite(BT_REG_ON, HIGH); @@ -219,7 +219,7 @@ void BLELocalDevice::end() #elif defined(ARDUINO_SAMD_NANO_33_IOT) || defined(ARDUINO_NANO_RP2040_CONNECT) // disable the NINA digitalWrite(NINA_RESETN, LOW); -#elif defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_GIGA) +#elif defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_GIGA) || defined(ARDUINO_OPTA) digitalWrite(BT_REG_ON, LOW); #endif } diff --git a/src/utility/HCICordioTransport.cpp b/src/utility/HCICordioTransport.cpp index e78a44ea..947378cf 100644 --- a/src/utility/HCICordioTransport.cpp +++ b/src/utility/HCICordioTransport.cpp @@ -25,7 +25,7 @@ #include #include -#if defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_GIGA) +#if defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_GIGA) || defined(ARDUINO_OPTA) #include "ble/BLE.h" #include #endif @@ -181,7 +181,7 @@ HCICordioTransportClass::~HCICordioTransportClass() { } -#if defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_GIGA) +#if defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_GIGA) || defined(ARDUINO_OPTA) events::EventQueue eventQueue(10 * EVENTS_EVENT_SIZE); void scheduleMbedBleEvents(BLE::OnEventsToProcessCallbackContext *context) { eventQueue.call(mbed::Callback(&context->ble, &BLE::processEvents)); @@ -201,7 +201,7 @@ int HCICordioTransportClass::begin() init_wsf(bufPoolDesc); #endif -#if defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_GIGA) +#if defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_GIGA) || defined(ARDUINO_OPTA) BLE &ble = BLE::Instance(); ble.onEventsToProcess(scheduleMbedBleEvents); diff --git a/src/utility/HCIUartTransport.cpp b/src/utility/HCIUartTransport.cpp index 1cd44495..3219268d 100644 --- a/src/utility/HCIUartTransport.cpp +++ b/src/utility/HCIUartTransport.cpp @@ -29,6 +29,8 @@ // SerialHCI is already defined in the variant #elif defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) #define SerialHCI Serial2 +#elif defined(ARDUINO_OPTA) +#define SerialHCI Serial3 #elif defined(ARDUINO_PORTENTA_C33) #define SerialHCI Serial5 #else From 2a35e72af28904a247f01d4a18a6d1e5a1daea62 Mon Sep 17 00:00:00 2001 From: Martino Facchin Date: Mon, 3 Jul 2023 20:03:55 +0200 Subject: [PATCH 72/83] wip: add support for UNO R4 WiFi Needs UNOR4USBBridge firmware >= 0.2.0 --- src/utility/HCIUartTransport.cpp | 2 +- src/utility/HCIVirtualTransportAT.cpp | 112 ++++++++++++++++++++++++++ src/utility/HCIVirtualTransportAT.h | 42 ++++++++++ 3 files changed, 155 insertions(+), 1 deletion(-) create mode 100644 src/utility/HCIVirtualTransportAT.cpp create mode 100644 src/utility/HCIVirtualTransportAT.h diff --git a/src/utility/HCIUartTransport.cpp b/src/utility/HCIUartTransport.cpp index 3219268d..d3c44d8f 100644 --- a/src/utility/HCIUartTransport.cpp +++ b/src/utility/HCIUartTransport.cpp @@ -17,7 +17,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ -#if !defined(ARDUINO_ARCH_MBED) && !defined(ESP32) || defined(TARGET_NANO_RP2040_CONNECT) +#if !defined(ARDUINO_ARCH_MBED) && !defined(ESP32) && !defined(ARDUINO_UNOR4_WIFI) || defined(TARGET_NANO_RP2040_CONNECT) #include "HCIUartTransport.h" diff --git a/src/utility/HCIVirtualTransportAT.cpp b/src/utility/HCIVirtualTransportAT.cpp new file mode 100644 index 00000000..7b3a24a9 --- /dev/null +++ b/src/utility/HCIVirtualTransportAT.cpp @@ -0,0 +1,112 @@ +/* + This file is part of the ArduinoBLE library. + Copyright (c) 2018 Arduino SA. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#if defined(ARDUINO_UNOR4_WIFI) + +#include "HCIVirtualTransportAT.h" + +extern ModemClass modem; + +HCIVirtualTransportATClass::HCIVirtualTransportATClass() +{ +} + +HCIVirtualTransportATClass::~HCIVirtualTransportATClass() +{ +} + +static RingBufferN<258> buf; + +int HCIVirtualTransportATClass::begin() +{ + // TODO: add this helper + //modem.debug(Serial); + buf.clear(); + //modem.debug(true); + std::string res = ""; + modem.begin(); + if (modem.write(std::string(PROMPT(_HCI_BEGIN)), res, CMD(_HCI_BEGIN))) { + return 1; + } + return 0; +} + +void HCIVirtualTransportATClass::end() +{ +} + +void HCIVirtualTransportATClass::wait(unsigned long timeout) +{ + std::string res = ""; + modem.write(std::string(PROMPT(_HCI_WAIT)), res, "%d\n\r", CMD_WRITE(_HCI_WAIT), timeout); +} + +int HCIVirtualTransportATClass::available() +{ + std::string res = ""; + if (buf.available()) { + return buf.available(); + } + if (modem.write(std::string(PROMPT(_HCI_AVAILABLE)), res, CMD_READ(_HCI_AVAILABLE))) { + return atoi(res.c_str()); + } + + return 0; +} + +// never called +int HCIVirtualTransportATClass::peek() +{ + return -1; +} + +int HCIVirtualTransportATClass::read() +{ + uint8_t c; + std::string res = ""; + if (buf.available()) { + return buf.read_char(); + } + modem.avoid_trim_results(); + modem.read_using_size(); + if (modem.write(std::string(PROMPT(_HCI_READ)), res, CMD(_HCI_READ))) { + for(int i = 0; i < res.size(); i++) { + buf.store_char((uint8_t)res[i]); + } + return buf.read_char(); + } + + return -1; +} + +size_t HCIVirtualTransportATClass::write(const uint8_t* data, size_t length) +{ + std::string res = ""; + modem.write_nowait(std::string(PROMPT(_HCI_WRITE)), res, "%s%d\r\n" , CMD_WRITE(_HCI_WRITE), length); + if(modem.passthrough(data, length)) { + return length; + } + return 0; +} + +HCIVirtualTransportATClass HCIVirtualTransportAT; + +HCITransportInterface& HCITransport = HCIVirtualTransportAT; + +#endif diff --git a/src/utility/HCIVirtualTransportAT.h b/src/utility/HCIVirtualTransportAT.h new file mode 100644 index 00000000..8e29801d --- /dev/null +++ b/src/utility/HCIVirtualTransportAT.h @@ -0,0 +1,42 @@ +/* + This file is part of the ArduinoBLE library. + Copyright (c) 2018 Arduino SA. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#include "HCITransport.h" +#include +#include +#include + +#include "WiFiS3.h" + +class HCIVirtualTransportATClass : public HCITransportInterface { +public: + HCIVirtualTransportATClass(); + virtual ~HCIVirtualTransportATClass(); + + virtual int begin(); + virtual void end(); + + virtual void wait(unsigned long timeout); + + virtual int available(); + virtual int peek(); + virtual int read(); + + virtual size_t write(const uint8_t* data, size_t length); +}; \ No newline at end of file From 742ba783a17fce4ce8d3ddf8992573718f99d37f Mon Sep 17 00:00:00 2001 From: Martino Facchin Date: Tue, 11 Jul 2023 09:30:29 +0200 Subject: [PATCH 73/83] unor4wifi: fix metadata and gh action --- .github/workflows/compile-examples.yml | 1 + README.md | 4 +++- library.properties | 4 ++-- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/.github/workflows/compile-examples.yml b/.github/workflows/compile-examples.yml index b33d6c75..81e843dd 100644 --- a/.github/workflows/compile-examples.yml +++ b/.github/workflows/compile-examples.yml @@ -15,6 +15,7 @@ jobs: - arduino:megaavr:uno2018:mode=on - arduino:mbed:nano33ble - arduino:mbed_nano:nanorp2040connect + - arduino:renesas_uno:unor4wifi steps: - uses: actions/checkout@v3 diff --git a/README.md b/README.md index 9ec934a3..6808502c 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,14 @@ [![Compile Examples Status](https://github.com/arduino-libraries/ArduinoBLE/workflows/Compile%20Examples/badge.svg)](https://github.com/arduino-libraries/ArduinoBLE/actions?workflow=Compile+Examples) [![Spell Check Status](https://github.com/arduino-libraries/ArduinoBLE/workflows/Spell%20Check/badge.svg)](https://github.com/arduino-libraries/ArduinoBLE/actions?workflow=Spell+Check) -Enables Bluetooth® Low Energy connectivity on the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, Arduino Nano 33 IoT, and Arduino Nano 33 BLE. +Enables Bluetooth® Low Energy connectivity on the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, Arduino Nano 33 IoT, Arduino Nano 33 BLE, Arduino Portenta H7, Arduino Giga R1 and Arduino UNO R4 WiFi. This library supports creating a Bluetooth® Low Energy peripheral & central mode. For the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, and Arduino Nano 33 IoT boards, it requires the NINA module to be running [Arduino NINA-W102 firmware](https://github.com/arduino/nina-fw) v1.2.0 or later. +For the Arduino UNO R4 WiFi, it requires the ESP32-S3 module to be running [firmware](https://github.com/arduino/uno-r4-wifi-usb-bridge) v0.2.0 or later. + For more information about this library please visit us at: https://www.arduino.cc/en/Reference/ArduinoBLE diff --git a/library.properties b/library.properties index 929fa0fd..718b6066 100644 --- a/library.properties +++ b/library.properties @@ -2,9 +2,9 @@ name=ArduinoBLE version=1.3.5 author=Arduino maintainer=Arduino -sentence=Enables Bluetooth® Low Energy connectivity on the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, Arduino Nano 33 IoT, Arduino Nano 33 BLE and Nicla Sense ME. +sentence=Enables Bluetooth® Low Energy connectivity on the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, Arduino Nano 33 IoT, Arduino Nano 33 BLE, Nicla Sense ME and UNO R4 WiFi. paragraph=This library supports creating a Bluetooth® Low Energy peripheral & central mode. category=Communication url=https://www.arduino.cc/en/Reference/ArduinoBLE -architectures=samd,megaavr,mbed,apollo3,mbed_nano,mbed_portenta,mbed_nicla,esp32,mbed_giga,renesas,renesas_portenta,mbed_opta +architectures=samd,megaavr,mbed,apollo3,mbed_nano,mbed_portenta,mbed_nicla,esp32,mbed_giga,renesas,renesas_portenta,mbed_opta,renesas_uno includes=ArduinoBLE.h From 56dbfb33aef47489cfbfb26a4e32c8e6d123c9ff Mon Sep 17 00:00:00 2001 From: Martino Facchin Date: Wed, 30 Aug 2023 14:43:44 +0200 Subject: [PATCH 74/83] Publish 1.3.6 --- library.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.properties b/library.properties index 718b6066..5f238fde 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=ArduinoBLE -version=1.3.5 +version=1.3.6 author=Arduino maintainer=Arduino sentence=Enables Bluetooth® Low Energy connectivity on the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, Arduino Nano 33 IoT, Arduino Nano 33 BLE, Nicla Sense ME and UNO R4 WiFi. From 304386172a90c47c474e6416151fb69c942ee846 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 5 Sep 2023 08:16:41 +0000 Subject: [PATCH 75/83] Bump actions/checkout from 3 to 4 Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v3...v4) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- .github/workflows/compile-examples.yml | 4 ++-- .github/workflows/spell-check.yml | 2 +- .github/workflows/sync-labels.yml | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/compile-examples.yml b/.github/workflows/compile-examples.yml index 81e843dd..7f2ed318 100644 --- a/.github/workflows/compile-examples.yml +++ b/.github/workflows/compile-examples.yml @@ -18,7 +18,7 @@ jobs: - arduino:renesas_uno:unor4wifi steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - uses: arduino/compile-sketches@v1 with: github-token: ${{ secrets.GITHUB_TOKEN }} @@ -39,7 +39,7 @@ jobs: #- esp32:esp32:esp32h2 steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - uses: arduino/compile-sketches@v1 with: github-token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/spell-check.yml b/.github/workflows/spell-check.yml index 0cbdde58..94b57020 100644 --- a/.github/workflows/spell-check.yml +++ b/.github/workflows/spell-check.yml @@ -8,7 +8,7 @@ jobs: steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Spell check uses: arduino/actions/libraries/spell-check@master diff --git a/.github/workflows/sync-labels.yml b/.github/workflows/sync-labels.yml index 94938f35..9cde1acc 100644 --- a/.github/workflows/sync-labels.yml +++ b/.github/workflows/sync-labels.yml @@ -27,7 +27,7 @@ jobs: steps: - name: Checkout repository - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Download JSON schema for labels configuration file id: download-schema @@ -105,7 +105,7 @@ jobs: echo "::set-output name=flag::--dry-run" - name: Checkout repository - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Download configuration files artifact uses: actions/download-artifact@v3 From d49c7f38102244d709dd9c04be28d26e13a42bf7 Mon Sep 17 00:00:00 2001 From: AresMaster Date: Tue, 17 Oct 2023 19:00:02 +0200 Subject: [PATCH 76/83] Squashed commit of the following: MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit commit f9e5019ee9e9afd783f2e656240bd277ab299b3c Merge: 2017ab4 2a070fa Author: Frederic Pillon Date: Mon Jul 24 15:43:42 2023 +0200 Merge pull request #60 from fpistm/payload_reset fix: TL_Evt_t payload size for reset commit 2a070faebcae906ff48c7329b0c2de2b2d64744d Author: Frederic Pillon Date: Mon Jul 24 11:19:27 2023 +0200 fix: regenerate STM32Cube_FW patches Signed-off-by: Frederic Pillon commit 819cebd2bed57448f925d34d50d8df51cbe58c04 Author: Frederic Pillon Date: Mon Jul 24 10:55:20 2023 +0200 fix: TL_Evt_t payload size for reset Within last CubeWB update TL_Evt_t payload size was reduced. This produce a warning -Warray-bounds due to the reset management which require 4 bytes. Signed-off-by: Frederic Pillon commit 2017ab4ec04e3f17b09aa8427092d016d8453fbe Merge: eab1891 370e108 Author: Frederic Pillon Date: Tue Jul 18 11:25:24 2023 +0200 Merge pull request #59 from fpistm/stm32CubeWB_1.17.0 chore: update to STM32Cube_FW v1.17.0 commit 370e1082edae9b69d50f824db85b5cbe3b786e79 Author: Frederic Pillon Date: Mon Dec 12 17:29:27 2022 +0100 chore: add support for customize app_conf_default.h Signed-off-by: Frederic Pillon commit 5d07a0e5c0463965f8cf8dde6076b5cf2c779e90 Author: Frederic Pillon Date: Thu Jul 13 17:16:40 2023 +0200 fix: include a timeout when waiting for the cmd_resp Signed-off-by: Frederic Pillon commit 542e007fa5a1b53664d2efb5f01d67767123a357 Author: Frederic Pillon Date: Thu Jul 13 17:08:05 2023 +0200 chore: adapt STM32Cube_FW sources Signed-off-by: Frederic Pillon commit 61b8a3b295f6a01b3efefe937683a89cf0559da4 Author: Frederic Pillon Date: Mon Jul 17 11:34:26 2023 +0200 chore: update STM32Cube_FW from Cube version v1.17.0 Signed-off-by: Frederic Pillon commit eab189123182abdf7dc1f628da54c6952e789f54 Author: Frederic Pillon Date: Mon Jul 17 11:30:41 2023 +0200 fix(doc): wrong version Signed-off-by: Frederic Pillon commit 98e8e3f1441509437c7b72cd4f887af09b93967f Author: Frederic Pillon Date: Thu Jul 13 18:28:25 2023 +0200 fix: regenerate STM32Cube_FW patches Prepare update to version 1.17.0 Signed-off-by: Frederic Pillon commit a93bdadef5ed1408a7cdfb7f65eea19568dc0b09 Author: Frederic Pillon Date: Thu Jul 13 16:49:37 2023 +0200 chore(editorconfig): do not apply change to patch files Signed-off-by: Frederic Pillon commit bc085c13d09be0c565b2ac1dbb3afdca7e4a6b9c Author: Frederic Pillon Date: Thu Jul 13 15:45:56 2023 +0200 chore: bump library version to 1.2.5 Signed-off-by: Frederic Pillon commit cf77ef0349afcec3cdd8ec231405d41670645ac2 Merge: df96671 a9bef0c Author: Frederic Pillon Date: Wed Apr 5 15:28:50 2023 +0200 Merge pull request #55 from fpistm/CubeWB_v1.16.0 chore: update to STM32Cube_FW v1.16.0 commit a9bef0cf0ed3b7ee6a2cabca2bfe82b783be0104 Author: Frederic Pillon Date: Wed Apr 5 11:40:47 2023 +0200 chore: add new field initalizer for SHCI_C2_Ble_Init_Cmd_Packet_t Signed-off-by: Frederic Pillon commit 1ec4563f20df1bc36ac489706a3123b0fd1ce653 Author: Frederic Pillon Date: Wed Feb 8 16:50:46 2023 +0100 fix: warning outside array bounds array subscript 'TL_CcEvt_t[0]' is partly outside array bounds Signed-off-by: Frederic Pillon commit 9b421c27d620e27334f6b1cb2e55a6c75ef6055d Author: Frederic Pillon Date: Mon Dec 12 17:29:27 2022 +0100 chore: add support for customize app_conf_default.h Signed-off-by: Frederic Pillon commit 751295300e5fb7fc1f277410e8aa76f4e29f7302 Author: Frederic Pillon Date: Mon Dec 12 17:17:48 2022 +0100 fix: include a timeout when waiting for the cmd_resp Signed-off-by: Frederic Pillon commit d758a661f9f2c033209219a1d86fccad7a2a8ef3 Author: Frederic Pillon Date: Wed Apr 5 10:18:52 2023 +0200 chore: adapt STM32Cube_FW sources Compare to previous patch, do the minimum changes required to ease further update. Signed-off-by: Frederic Pillon commit a903124433f4caacb07997a4856cfc4fc71948f8 Author: Frederic Pillon Date: Wed Apr 5 14:37:41 2023 +0200 chore: update STM32Cube_FW from Cube version v1.16.0 Signed-off-by: Frederic Pillon commit df966713d625f9f2c16ba126e3075f63d72985d2 Author: Frederic Pillon Date: Wed Apr 5 14:32:40 2023 +0200 fix: regenerate STM32Cube_FW patches Prepare update to version 1.16.0 Signed-off-by: Frederic Pillon commit bd27383c8f197387ac7a828ea23cb15efcea88d5 Author: Carlo Parata Date: Thu Mar 30 16:15:07 2023 +0200 Update library.properties Signed-off-by: Carlo Parata commit 1356fac000eefdd05a250d48f8fb299f5548bad5 Merge: a5e0fed 902a770 Author: Carlo Parata Date: Thu Mar 30 16:14:41 2023 +0200 Merge pull request #54 from elle-bi/main Add support for latest firmware in BLUENRG-M2SP chips. commit 902a770a9d2deb7d807d891ad8c0974e55290511 Author: Lorenzo Bini Date: Thu Mar 30 12:03:37 2023 +0200 Add support for latest firmware in BLUENRG-M2SP chips. This requires changing the SPI dummy package to 0x00 due to signaling over the MOSI pin commit a5e0fed7d1dd3a5553d8b2ffda878cc22f23b88e Author: Frederic Pillon Date: Wed Mar 29 10:05:59 2023 +0200 examples: add P_NUCLEO_WB55_USB_DONGLE support Signed-off-by: Frederic Pillon commit 929b540b051eeb8621ad681c6922806cf9501a23 Author: Frederic Pillon Date: Wed Feb 8 16:50:46 2023 +0100 fix: warning outside array bounds array subscript 'TL_CcEvt_t[0]' is partly outside array bounds Signed-off-by: Frederic Pillon commit b0a1849df65d570672be178dffdbcfa7aa144b09 Author: Carlo Parata Date: Fri Mar 17 09:57:50 2023 +0100 Update library.properties Signed-off-by: Carlo Parata commit 02fd64f8c4e4fd58f0770fc29fe0c5908cbb3cec Merge: 616f2fb 240590a Author: Carlo Parata Date: Wed Mar 15 09:17:32 2023 +0100 Merge pull request #52 from elle-bi/main Add API to get random address commit 240590a0f52da596fa24a042e1fa2956a931c61c Author: Lorenzo Bini Date: Tue Mar 14 17:19:12 2023 +0100 Add API to get random address commit 616f2fb58d0a3acd6d61762c19759501852c31b4 Author: Frederic Pillon Date: Mon Jan 9 11:54:49 2023 +0100 chore: bump library version Warning: not aligned with ArduinoBLE one Signed-off-by: Frederic Pillon commit b5a70eb5cab31e4f768310157c2e25da0c582c13 Author: Frederic Pillon Date: Mon Jan 9 11:49:52 2023 +0100 chore(examples): update circuit description Signed-off-by: Frederic Pillon commit ce6cc8fa0691b983917d7638e32b32da838a51dc Author: Frederic Pillon Date: Mon Jan 9 11:31:16 2023 +0100 fix: regenerate STM32Cube_FW patches due to STM32WB15xx support addition Signed-off-by: Frederic Pillon commit ceb1e6258a8ec86a56f2b3aea273d2a67a927569 Author: Frederic Pillon Date: Mon Jan 9 11:12:06 2023 +0100 fix(examples): aligned comments between all examples Signed-off-by: Frederic Pillon commit 3a116161880f2578617536a76fac0b2ded9fc5b3 Author: Frederic Pillon Date: Mon Jan 9 11:04:22 2023 +0100 chore(examples): use USER_BTN if defined Signed-off-by: Frederic Pillon commit 40dd5bd39392dfac0c4bb90ee7797e0817563461 Author: Frederic Pillon Date: Mon Jan 9 10:36:33 2023 +0100 chore: update examples to support Nucleo WB15CC Will be available within stm32 core version higher than 2.4.0. Signed-off-by: Frederic Pillon commit 0fe8e71a68e537f84acb1b580f61292f5a631467 Author: Frederic Pillon Date: Mon Jan 9 10:33:24 2023 +0100 chore: update app_conf default for STM32WB15xx Signed-off-by: Frederic Pillon commit b232c9a45146a5253f39addd93490af8df193bda Merge: 777b4a4 daa8475 Author: Frederic Pillon Date: Thu Dec 15 11:48:47 2022 +0100 Merge pull request #48 from fpistm/updateWB chore: update STM32Cube_FW from Cube version v1.15.0 commit daa84754ced0f6f9d8d2aad8c05eedb2ea8eea00 Author: Frederic Pillon Date: Thu Dec 15 11:01:08 2022 +0100 ci(codespell): skip STM32Cube_FW directory Signed-off-by: Frederic Pillon commit 9b49cd60f423b3f1bd545acf959ffda19ae1961c Author: Frederic Pillon Date: Thu Dec 15 10:52:49 2022 +0100 fix: allows space at the end of line of markdown files Signed-off-by: Frederic Pillon commit 731440bb7d96cbad541b60f73392739484a406e9 Author: Frederic Pillon Date: Thu Dec 15 10:51:31 2022 +0100 doc: reference STM32WBxx Signed-off-by: Frederic Pillon commit 23e7407673113b849b598ab0ec592dc5cdd55090 Author: Frederic Pillon Date: Tue Dec 13 10:48:35 2022 +0100 chore: add new field initalizer for SHCI_C2_Ble_Init_Cmd_Packet_t Signed-off-by: Frederic Pillon commit 45e49a6ab86ceb9c1a1cc69e411f552a75b26c18 Author: Frederic Pillon Date: Tue Dec 13 10:16:08 2022 +0100 chore: rename CFG_BLE_LSE_SOURCE to CFG_BLE_LS_SOURCE Signed-off-by: Frederic Pillon commit fb82a698e41bd8e75507e6886e7b03e71d0e53c8 Author: Frederic Pillon Date: Mon Dec 12 17:29:27 2022 +0100 chore: add support for customize app_conf_default.h Signed-off-by: Frederic Pillon commit a3c689a99506126587dfd7285c4b198db4a790e5 Author: Frederic Pillon Date: Mon Dec 12 17:17:48 2022 +0100 fix: include a timeout when waiting for the cmd_resp Signed-off-by: Frederic Pillon commit 70812b4e3a184585354f979472a75a648266f53f Author: Frederic Pillon Date: Mon Dec 12 17:15:26 2022 +0100 chore: clean up and adapt STM32Cube_FW sources for STM32duino Signed-off-by: Frederic Pillon commit 2d60f4511b08f8ffa4cc2414a57aa12b96337208 Author: Frederic Pillon Date: Tue Dec 13 15:34:50 2022 +0100 chore: update STM32Cube_FW from Cube version v1.15.0 Signed-off-by: Frederic Pillon commit 777b4a40f72e588000e609b79d24a78c7a7695ea Author: Frederic Pillon Date: Tue Dec 13 15:20:56 2022 +0100 fix: regenerate STM32Cube_FW patches Prepare update to version 1.15.0 Signed-off-by: Frederic Pillon commit ec0d56802bcea692eea78f98db08a2602d74ed07 Author: Frederic Pillon Date: Tue Dec 13 11:15:53 2022 +0100 feat: adding gitattributes and editor config files Signed-off-by: Frederic Pillon commit 6ecff2be25fb83eeb6ee8acef35ee1af30d405f1 Author: Frederic Pillon Date: Fri Dec 9 17:28:57 2022 +0100 fix: wrong release version Signed-off-by: Frederic Pillon commit 75ea6f44f51913ab7f6df5044d66545d4ddf5579 Author: Frederic Pillon Date: Thu Nov 24 10:01:39 2022 +0100 ci: replace deprecated spellcheck by codespell commit 1b61aa7f2c22e15b0cc18032a6a432831e69c0e8 Merge: f8d947b 8f40c2f Author: Frederic Pillon Date: Mon Nov 21 16:19:25 2022 +0100 Merge pull request #47 from ABOSTM/WB_FIX_HCI_ONLY_FW_COMPATIBILITY fix: HCI only Firmware not supporting ACI_GAP_INIT ACI_GATT_INIT commit 8f40c2f3f68f301456ecad73c39287ff1a390d56 Author: Alexandre Bourdiol Date: Tue Oct 25 18:28:48 2022 +0200 fix: CI spell check Signed-off-by: Alexandre Bourdiol commit 1c8974d88f88d764e3b2aa9d045bcd61f0e0a4c5 Author: Alexandre Bourdiol Date: Mon Oct 24 11:35:21 2022 +0200 fix: HCI only Firmware not supporting ACI_GAP_INIT ACI_GATT_INIT On STM32WB, Cube FW version 1.14.1, messages ACI_GATT_INIT and ACI_GAP_INIT are not available on HCI only BLE firmware (stm32wb5x_BLE_HCILayer_fw.bin) This imply to move Random Address to host instead of relying on controller Signed-off-by: Alexandre Bourdiol commit f8d947bb6f3bd978cddd331bb9a2554ce1399c4c Merge: 543f6a5 93af438 Author: Carlo Parata Date: Mon Oct 17 10:45:30 2022 +0200 Merge pull request #45 from grobx/bluenrg-lp-pr BlueNRG-LP Support commit 543f6a554f1ce6de65dbf5df6562d0a4788cb615 Merge: 54af742 f4c2607 Author: Frederic Pillon Date: Tue Oct 11 17:15:44 2022 +0200 Merge pull request #46 from ABOSTM/UPDATE_BLE_1.14.1 Update BLE to Cube version 1.14.1 commit f4c26072f6fa09225d3c7ae0ece8dbfc94b3c9d5 Author: Alexandre Bourdiol Date: Tue Aug 30 13:32:30 2022 +0200 fix: implement BLE debug based on core_debug() Signed-off-by: Alexandre Bourdiol commit f77db6b5fc4400c89b54abcb498822a2bf619ea2 Author: Alexandre Bourdiol Date: Fri Sep 2 14:59:07 2022 +0200 Fix: Move EvtPool array from MB_MEM2 to MB_MEM1 MB_MEM1 and MB_MEM2 ae now respectively in SRAM2a and SRAM2b SRAM2a being too small to put all shared memory variables Warning depends on split made on core: variants/STM32WBxx/WB55R(C-E-G)V/ldscript.ld Signed-off-by: Alexandre Bourdiol commit 3f234253695437855f6e5a2fc9b5e884f33ee749 Author: Alexandre Bourdiol Date: Wed Aug 31 17:18:16 2022 +0200 Fix: Remove compilation warning about uninitialized struct field Signed-off-by: Alexandre Bourdiol commit 4eb33a136d8f59874fa112df868f8b025d128c83 Author: Alexandre Bourdiol Date: Tue Aug 30 13:31:31 2022 +0200 Added support for custom app_conf.h Signed-off-by: Alexandre Bourdiol commit 882addad6a096adf402041d662f4edb941b80071 Author: Alexandre Bourdiol Date: Tue Aug 30 13:19:36 2022 +0200 fix: include a timeout when waiting for the cmd_resp Signed-off-by: Alexandre Bourdiol commit 4a9f4ae6b3e00b0bae34f806466b208919955afa Author: Alexandre Bourdiol Date: Tue Aug 30 11:28:41 2022 +0200 chore: clean up and adapt STM32Cube_FW sources for STM32duino Signed-off-by: Alexandre Bourdiol commit 2cc9f0f8152e49918ef3f352310930c9dfd869da Author: Alexandre Bourdiol Date: Tue Aug 30 10:56:46 2022 +0200 Update STM32Cube_FW from Cube version 1.14.1 Signed-off-by: Alexandre Bourdiol commit 69a6b5fa1f2785d67e52d7e9b03771e215e437b6 Author: Alexandre Bourdiol Date: Tue Aug 30 13:50:51 2022 +0200 fix: Regenrate BLE patches prepare Update STM32Cube_FW Prepare update to version 1.14.0 Signed-off-by: Alexandre Bourdiol commit 93af438927ffc0119caf0b2b4d4c300da3dee364 Author: Giuseppe Roberti Date: Tue Aug 30 14:51:20 2022 +0200 Enable STEVAL-MKBOXPRO support in examples commit 831e996f17f82efec25149e39ca8655f65dbdb05 Author: Giuseppe Roberti Date: Tue Aug 9 16:32:20 2022 +0200 LP only differ in cmd, not procedure commit 9cf284f8ce05446b1e0064bff07fd4e83b0075f5 Author: Giuseppe Roberti Date: Tue Aug 9 13:34:06 2022 +0200 Ugly fix delay commit 6e951334cbf0a703c6a5a61972c9ed0de1fb4509 Author: Giuseppe Roberti Date: Tue Aug 9 10:17:09 2022 +0200 Support BlueNRG-LP commit 54af742d90e1dd791352a9e0032a4e37e7c917a1 Merge: 061ec8e 381c3ca Author: Carlo Parata Date: Wed Aug 31 08:33:07 2022 +0200 Merge pull request #44 from grobx/main Fix hard fault when str is NULL commit 381c3ca61658983c9836545603869a185f04eee8 Author: Giuseppe Roberti Date: Tue Aug 30 11:55:17 2022 +0200 Fix hard fault when str is NULL commit 061ec8e7902ab1754a65264787f704d4bb265766 Author: Alexandre Bourdiol Date: Fri Apr 8 15:01:59 2022 +0200 Update STM32Cube_FW from Cube version v1.13.3 Signed-off-by: Alexandre Bourdiol commit 1f3c8760109948a09f8cbf84c167b0f702ba9f99 Merge: 331c39a abeaf9a Author: Frederic Pillon Date: Fri Dec 10 10:02:28 2021 +0100 Merge pull request #39 from ABOSTM/BLE_PATCHES Update BLE library with STM32WB Cube version v1.13.0 commit abeaf9a760ec5937bb3a66e45dc3125d63fc2373 Author: Alexandre Bourdiol Date: Tue Dec 7 14:27:27 2021 +0100 Stub OutputDbgTrace() function Signed-off-by: Alexandre Bourdiol commit 55aa462a677c26d8a4f6f86b2efacdb6b82e77b4 Author: Alexandre Bourdiol Date: Mon Dec 6 18:59:38 2021 +0100 Added support for custom app_conf.h (#35) commit 0d821e8bef7b962d09f54088426fe99250953ee4 Author: Alexandre Bourdiol Date: Mon Dec 6 11:18:02 2021 +0100 fix: include a timeout when waiting for the cmd_resp Signed-off-by: Francois Ramu Signed-off-by: Alexandre Bourdiol commit 6eb25bcc5bbc4c2299d6d3fe3a4452e94d82520e Author: Alexandre Bourdiol Date: Mon Dec 6 11:08:32 2021 +0100 chore: clean up and adapt STM32Cube_FW sources for STM32duino Signed-off-by: Frederic Pillon Signed-off-by: Alexandre Bourdiol commit ab9e2f90350292d2390f58abe9f4b8e5a18ab851 Author: Alexandre Bourdiol Date: Mon Dec 6 19:17:44 2021 +0100 Update STM32Cube_FW from Cube version v1.13.0 Signed-off-by: Alexandre Bourdiol commit 8ce1025219060f97cdd5575ed3cae1044aedcef4 Author: Alexandre Bourdiol Date: Thu Dec 2 10:23:30 2021 +0100 Add patch files to be applied on stm32wb Cube update Patches correspond to somes commits of PR #38 Signed-off-by: Alexandre Bourdiol commit 331c39a9580374061464f562f0df92e6a3002eb5 Author: Frederic Pillon Date: Wed Dec 8 11:14:45 2021 +0100 Update spell-check.yml commit a36ed33ac795f449ec6e46dba9137650490d12c9 Author: Frederic Pillon Date: Wed Dec 8 11:03:29 2021 +0100 Update spell-check.yml commit e1a92dd73e7bec11ac51d2b2b8d59bfc4713ce9a Merge: 095fe18 14c0f73 Author: Frederic Pillon Date: Mon Dec 6 17:45:05 2021 +0100 Merge pull request #38 Rework the STM32CubeWB FW files to ease update commit 14c0f7381f919d618c4a3f98e236bc9f86d7bdfd Author: KMeldgaard <36625114+KMeldgaard@users.noreply.github.com> Date: Mon Nov 15 14:54:07 2021 +0100 Added support for custom app_conf.h (#35) commit 09680e7e3f4b7d04de1c4ef6eb9ab45c734cd8fa Author: Frederic Pillon Date: Wed Dec 1 18:42:57 2021 +0100 fix: include a timeout when waiting for the cmd_resp Signed-off-by: Francois Ramu commit 108f46f8eeee221646a87f9823ac58ddec3252f6 Author: Frederic Pillon Date: Wed Dec 1 18:38:39 2021 +0100 fix: [-Waddress-of-packed-member] warning Signed-off-by: Frederic Pillon commit 4d9fd3129ba4818d3ee4890b5d488c0f374ff81f Author: Francois Ramu Date: Thu Nov 12 13:21:31 2020 +0100 fix: missing IPCC enable for C2 in several examples from stm32CubeWB This fix is coming from https://github.com/STMicroelectronics/STM32CubeWB/issues/19 Signed-off-by: Francois Ramu commit ac3469e5f51cd684d75e85510319922c0530da05 Author: Frederic Pillon Date: Wed Dec 1 15:13:05 2021 +0100 chore: clean up and adapt STM32Cube_FW sources for STM32duino Signed-off-by: Frederic Pillon commit 370b06da90ebfa990d15b34787fd1e9002b520fa Author: Frederic Pillon Date: Wed Dec 1 11:15:00 2021 +0100 chore: include STM32Cube_FW to support the BLE of the stm32wb55 Orignal file from the v1.8.0: https://github.com/STMicroelectronics/STM32CubeWB/releases/tag/v1.8.0 Signed-off-by: Frederic Pillon commit ce7cb45b33e9590d3bdf6268dbda3d60cb2a8e06 Author: Frederic Pillon Date: Wed Dec 1 10:38:58 2021 +0100 Revert "Include the STM32Cube_FW to support the BLE of the stm32wb55" This reverts commit 3019930966782e57d119e62b64248b0fee36d20f. commit 98952728fec94cebb2db5ccbffbcefb3c5fb66ba Author: Frederic Pillon Date: Wed Dec 1 10:38:36 2021 +0100 Revert "This BLE RF configuration has many unused define values" This reverts commit 732ffed41b4b4ff32e9a8a23fd53fc0cc3867387. commit 643daea841c8eae8c96133a694fb8b0bd6ce0bda Author: Frederic Pillon Date: Wed Dec 1 10:29:17 2021 +0100 Revert "Missing IPCC enable for C2 in several examples from stm32CubeWB" This reverts commit 163bd85bf724a6d4f17c48ae051bd6ca1a108c3d. commit a5260674fd145fa82d3871b7339439594ad6f9fa Author: Francois Ramu Date: Thu Nov 19 19:07:13 2020 +0100 Revert "Fix [-Waddress-of-packed-member] warning" commit b64df412e90a7cd61966115560077d2479c9abd5 Author: Frederic Pillon Date: Wed Dec 1 10:22:00 2021 +0100 Revert "Include a timeout when waiting for the cmd_resp" This reverts commit 3a063dff2f8d4159ced2c98e7d866973dbaf6eec. commit 6a6c5505cfe72d11d42979324ff4f98aef4c6af0 Author: Frederic Pillon Date: Wed Dec 1 10:21:53 2021 +0100 Revert "Added support for custom app_conf.h (#35)" This reverts commit 095fe1802f363865f631133e0f2c01fa3f9325a8. commit 095fe1802f363865f631133e0f2c01fa3f9325a8 Author: KMeldgaard <36625114+KMeldgaard@users.noreply.github.com> Date: Mon Nov 15 14:54:07 2021 +0100 Added support for custom app_conf.h (#35) commit 1cf1da0d5fbd1b43626249c430c69c92b8de3be5 Author: Frederic Pillon Date: Tue Oct 5 16:04:46 2021 +0200 ci: change to main branch Signed-off-by: Frederic Pillon commit 4350cf09ec7e9d491b666e491f22e62541629111 Merge: ee4927f b22266f Author: Frederic Pillon Date: Thu Jul 8 15:21:22 2021 +0200 Merge tag '1.2.1' Signed-off-by: Frederic Pillon commit ee4927f2cbc75992fae365ad260eebe03f8b2310 Merge: 23053fb faffc11 Author: Frederic Pillon Date: Thu Jul 8 14:44:31 2021 +0200 Merge pull request #32 from fpistm/STM32WB5MM_DK examples: add STM32WB5MM-DK support commit faffc11b61b3b56e91914c0f9accba11c7fcac97 Author: Frederic Pillon Date: Thu Jul 8 14:33:34 2021 +0200 examples: add STM32WB5MM-DK support Signed-off-by: Frederic Pillon commit ac6431e9e3c83f137defe794dc2bcdfe51ef83ad Author: Frederic Pillon Date: Thu Jul 8 14:31:58 2021 +0200 fix: remove specific include Correct CMSIS devide header already included by the core. Signed-off-by: Frederic Pillon commit 23053fbc16d9dd69e5fc9902d764530cfac3cb66 Author: Frederic Pillon Date: Wed May 5 15:17:35 2021 +0200 Update library.properties commit 9b7107bf7f0b6fe92523b5d1a0bc9403f6f8885e Merge: b7a5d16 4031a6a Author: Frederic Pillon Date: Tue May 4 17:33:55 2021 +0200 Merge pull request #29 from fpistm/ci Update CI with new maintainer name Workflow also synced with upstream repo. commit 4031a6a84f260e3a7a395439453fda951d12305a Author: Frederic Pillon Date: Tue May 4 17:20:49 2021 +0200 fix: ci: update with new maintainer name Signed-off-by: Frederic Pillon commit e3bdb384002e8592a2472972d4ed19299254c92a Author: Frederic Pillon Date: Tue May 4 16:06:31 2021 +0200 Use consistent indent size in Compile Examples workflow The initial single space indent made the workflow difficult to edit and harmed readability. commit 4342fe888041b6e7c6e8d21c3c62e5fc7eba57a5 Author: per1234 Date: Sat Sep 26 16:18:05 2020 -0700 Use consistent formatting style in Compile Examples CI action The previous inconsistent markup style, although perfectly valid, made the workflow harder to understand. commit 04bcd680bf44d43cb42d4d39ae2ae107175c950f Author: per1234 Date: Sat Sep 26 16:15:51 2020 -0700 Update name of action used to compile examples in CI workflow The action has been moved to a dedicated repository, where all future development work will happen. commit f03924fcb0319e99cd82ad49267d9539fb927e55 Author: per1234 Date: Sat Sep 26 16:13:57 2020 -0700 Update version of actions/checkout action used in Compile Examples CI workflow The action now has a default fetch-depth value of 1, so there is no need to specify this input. commit b7a5d16a587daf01091d73945690fa7066357181 Merge: ee32ef2 4c149a2 Author: Frederic Pillon Date: Tue May 4 15:27:40 2021 +0200 Merge tag '1.2.0' Signed-off-by: Frederic Pillon commit ee32ef2412f985f6f1f79a845ce8f97c670eec62 Merge: 5512049 fc7c4c6 Author: Frederic Pillon Date: Tue Mar 30 17:16:19 2021 +0200 Merge pull request #21 from fpistm/B_L475E_IOT01A Use B_L475E_IOT01A official name and fix P_NUCLEO_WB55RG commit fc7c4c65d1901b1532ee7727004125766c184edd Author: Frederic Pillon Date: Tue Mar 30 16:47:42 2021 +0200 Fix P_NUCLEO_WB55RG official name Signed-off-by: Frederic Pillon commit becff9ed3a00a08965cbd4334ec915896a333b1a Author: Frederic Pillon Date: Thu Jan 14 14:24:16 2021 +0100 Use B_L475E_IOT01A official name Since STM32 core version 2.0.0, the board name has been updated from DISCO_L475VG_IOT to B_L475E_IOT01A. Signed-off-by: Frederic Pillon commit 551204985c23febcf90a425fc292cbe1d5013649 Merge: 9297570 15e8789 Author: Carlo Parata Date: Thu Feb 11 15:07:20 2021 +0100 Merge pull request #28 from FRASTM/mbox_write mbox_write returns the nb of bytes actually written commit 15e87896745c8618ca5bcbc3ab3f1691b97f2f83 Author: Francois Ramu Date: Thu Feb 11 10:16:50 2021 +0100 mbox_write returns the nb of bytes actually written Check the value which is returned by the mbox_write function, if it differs from the len of data to be sent, this is an error Signed-off-by: Francois Ramu commit 9297570911fa4dc17e8bc8174f0cce9748966e83 Merge: ed10763 ec6547b Author: Carlo Parata Date: Wed Feb 10 15:56:34 2021 +0100 Merge pull request #27 from cparata/master Add static random address support for all ST BLE chips commit ec6547b50aab2c353c1992e6acaa70bfa9763f27 Author: Carlo Parata Date: Tue Feb 9 16:34:29 2021 +0100 Fix button issue on WB55 commit c1c7d1acbbc3a98cf668f3775f0ddfb1c9f06056 Author: Carlo Parata Date: Tue Feb 9 15:35:13 2021 +0100 Add the possibility to choose the ownAddressType in the Arduino stack commit d1535a02b79afc3d1b9443e2f91a5b7dda1dc738 Author: Carlo Parata Date: Mon Feb 8 16:42:53 2021 +0100 Fix typo commit 9ec4d798943885f5bbd8e068456c67f03a2ad673 Author: Carlo Parata Date: Mon Feb 8 16:25:43 2021 +0100 Fix code spelling issues commit 439eca03d4351e24a5f94f48e765ed95ead8db68 Author: Carlo Parata Date: Mon Feb 8 16:11:26 2021 +0100 Add static random address support for all ST BLE chips commit ed10763818ee8e76fd68aec821465903332ad48e Merge: 39406aa afeccd3 Author: Carlo Parata Date: Mon Feb 8 15:49:43 2021 +0100 Merge pull request #25 from FRASTM/wb55_sem Activate default clocks on the stm32wb commit 39406aaf8fdfea3d3b3e2b02fef942a1bf7b3437 Merge: 5ceaf45 870c91e Author: Carlo Parata Date: Mon Feb 8 15:49:01 2021 +0100 Merge pull request #26 from FRASTM/wb55_otp Set a bd address from OTP for the BLE device stm32wb55 commit 870c91ee0b5836b324809e2b93fd289558149f35 Author: Francois Ramu Date: Thu Feb 4 10:38:12 2021 +0100 Set a new bd address for the BLE device In case the bd address cannot be computed from the flash then the otp is read to provide a valid one in a OTP_BT_t Signed-off-by: Francois Ramu commit afeccd3c7f9c6a6164e2dbd76886537dd8699a40 Author: Francois Ramu Date: Tue Feb 2 12:36:53 2021 +0100 Activate default clocks on the STM32WB Signed-off-by: Francois Ramu commit 5ceaf455576fe058f79d94f0f328d5ec312ff66a Merge: 4867274 3a063df Author: Carlo Parata Date: Wed Feb 3 17:19:16 2021 +0100 Merge pull request #23 from FRASTM/wb55_ble Timeout returned when configuring BLE stack for SharedMem transport commit 3a063dff2f8d4159ced2c98e7d866973dbaf6eec Author: Francois Ramu Date: Thu Jan 28 16:40:56 2021 +0100 Include a timeout when waiting for the cmd_resp Signed-off-by: Francois Ramu commit 48672743e8efe0aa8367ac613daed02b2fb88aa7 Merge: 60d2609 fc7162e Author: Carlo Parata Date: Tue Feb 2 13:26:01 2021 +0100 Merge pull request #24 from cparata/master Sync with official ArduinoBLE repo commit fc7162ebc1e0a952672b5f684fe4f87c2c771381 Merge: 60d2609 be365c9 Author: Carlo Parata Date: Fri Jan 29 15:41:24 2021 +0100 Synch with ArduinoBLE official repo commit 60d26092cd8c419cea94df1ac911a0eb113f3534 Merge: 3813996 8f0e116 Author: Carlo Parata Date: Tue Dec 1 09:54:14 2020 +0100 Merge pull request #17 from FRASTM/wb55_BLE BLE on the stm32wb55 commit 8f0e11671858e011a75eec01801f669d50ed1b88 Author: Francois Ramu Date: Fri Sep 25 13:39:19 2020 +0200 Modify the examples to run on the nucleo_wb55rg board Signed-off-by: Francois Ramu commit 0660a9497d27bd25cfe22ff4a5a6febe99988ab1 Author: Francois Ramu Date: Thu Nov 19 19:07:13 2020 +0100 Fix [-Waddress-of-packed-member] warning Signed-off-by: Francois Ramu commit 19df1cb134e1e63f2151c7224eb9ceb224e82a4f Author: Francois Ramu Date: Thu Nov 5 18:41:53 2020 +0100 Add shared memory transport layer for the stm32wb55 to use connection and services the BLE RF through IPM SharedMem The Rx data are stored in a fifo to manage connection, and ACL packets with context section to protect index when receiving data. The BLE init set the device address and power settings just after the HCI_RESET command sent The LSE clock is used for the RF and WakeUp capability by the variant. There is no BLEChip enum as only one chip at this time. Debug is activated with CONFIG_DEBUG enabled Signed-off-by: Francois Ramu commit 163bd85bf724a6d4f17c48ae051bd6ca1a108c3d Author: Francois Ramu Date: Thu Nov 12 13:21:31 2020 +0100 Missing IPCC enable for C2 in several examples from stm32CubeWB This fix is coming from https://github.com/STMicroelectronics/STM32CubeWB/issues/19 Signed-off-by: Francois Ramu commit 732ffed41b4b4ff32e9a8a23fd53fc0cc3867387 Author: Francois Ramu Date: Thu Nov 12 12:25:50 2020 +0100 This BLE RF configuration has many unused define values which are removed there Signed-off-by: Francois Ramu commit 3019930966782e57d119e62b64248b0fee36d20f Author: Francois Ramu Date: Tue Oct 13 17:03:40 2020 +0200 Include the STM32Cube_FW to support the BLE of the stm32wb55 Only in case STM32WBxx device defined Signed-off-by: Francois Ramu commit f7dbf187386fa29ef7a2577b83ec49faa2d9e71f Author: Francois Ramu Date: Wed Nov 4 16:44:37 2020 +0100 Support of the shared memory transport layer for the stm32wb55 with STM32WB built-in chip (STM32WB_RF) It also Allows HCI SPI Transport with STM32WBxx Signed-off-by: Francois Ramu commit 38139967c3a72c2c5440d2164cbabe1e5f1d1a02 Merge: d952a0f e6d0635 Author: Carlo Parata Date: Wed Sep 30 16:55:40 2020 +0200 Merge pull request #19 from cparata/master Update comment and restore B_L4S5I_IOT01A support commit e6d06350b5879837c769f25f47c2b6d7941331c0 Author: Carlo Parata Date: Wed Sep 30 16:48:09 2020 +0200 Update comment and restore B_L4S5I_IOT01A support commit d952a0f04dd2e2530ab0ad864a4e81f5cf136566 Merge: 61138fc 0d936a4 Author: Carlo Parata Date: Wed Sep 30 15:56:53 2020 +0200 Merge pull request #18 from cparata/master Add support to X-NUCLEO-IDB05A2 commit 0d936a4f7c6452f0b5ffc7968d6baad7af579652 Author: Carlo Parata Date: Wed Sep 30 15:37:58 2020 +0200 Add support to X-NUCLEO-IDB05A2 commit 61138fc4b4aab5272231b75b7e889c30d4a900d5 Merge: e7e1bf7 14fd996 Author: Carlo Parata Date: Thu Sep 24 15:32:23 2020 +0200 Merge pull request #16 from cparata/master Align STM32duinoBLE to current ArduinoBLE master commit 14fd996cf56952864e2b9860e04bbe379cb4e169 Author: Carlo Parata Date: Thu Sep 24 15:20:31 2020 +0200 Fix compilation warning commit ec83c8ac03355ee1eaec6e9fcd4364c29cf131ff Merge: 73a4e1a 524b3a6 Author: Carlo Parata Date: Thu Sep 24 14:33:36 2020 +0200 Align to ArduinoBLE master commit e7e1bf7274b2e12b82d8d2cbe68bf28a28d0424a Author: Francois Ramu Date: Mon Sep 7 16:16:46 2020 +0200 add stm32L4+ discovery kit for BLE access of all examples B_L4S5I_IOT01A is using same pins for Bluetooth and SPI3 as the discovery kit B-L475E-IOT01A1 Signed-off-by: Francois Ramu commit 3559592f40065edb97d259a0d4304b5b1ee4ca11 Author: Frederic Pillon Date: Thu Sep 10 10:18:59 2020 +0200 Fix typo commit 93c68879590edd00a8763fb43fe7eaae60145a8c Author: Frederic Pillon Date: Thu Sep 10 10:18:19 2020 +0200 Fix Typo commit be2ed7ee77e53d83957db96427a7cd874cbd0a66 Merge: 3df2192 73a4e1a Author: Carlo Parata Date: Wed Mar 25 19:18:34 2020 +0100 Merge pull request #14 from cparata/master Update README commit 73a4e1a4db194450db7ead841a926efb9a2d73c5 Author: Carlo Parata Date: Wed Mar 25 19:17:06 2020 +0100 Update README commit 3df2192da28e45d14938a454fef80e784ec44853 Merge: dbc9cd1 3499bfa Author: Carlo Parata Date: Mon Feb 17 12:36:58 2020 +0100 Merge pull request #13 from cparata/master Update CHANGELOG commit 3499bfa232198913761683f8ff5405c0da7f3a20 Author: Carlo Parata Date: Mon Feb 17 12:35:36 2020 +0100 Update CHANGELOG commit dbc9cd1c72089ef0ff29ee2e7d82400ab140f125 Merge: 04a895f 742e409 Author: Carlo Parata Date: Mon Feb 17 12:25:17 2020 +0100 Merge pull request #12 from cparata/master Replace ArduinoBLE.h with STM32duinoBLE.h and create a new release fo… commit 742e409953bbd2ee46f0fcb75fa3b1ea7e30a3ae Author: Carlo Parata Date: Mon Feb 17 12:23:56 2020 +0100 Replace ArduinoBLE.h with STM32duinoBLE.h and create a new release for publication commit 04a895f42f0e01160bd662538e9df910d3260a1b Merge: 495b941 bd1b0e0 Author: Carlo Parata Date: Mon Feb 17 11:40:04 2020 +0100 Merge pull request #11 from cparata/master Improve STM32duinoBLE robustness and flexibility commit bd1b0e0eb5c82e9ad0072cadd340ac1c2841de61 Author: Carlo Parata Date: Mon Feb 17 11:34:49 2020 +0100 Update keywords.txt with new classes, methods and constants commit 5d789c63edcc99c463714a75fbe5ae1dc414e98a Author: Carlo Parata Date: Mon Feb 17 11:11:51 2020 +0100 Improve check when BLE chip is not supported commit e53282b2c1b537e098c107b97424f504a57c19f2 Author: Carlo Parata Date: Mon Feb 17 10:41:21 2020 +0100 Update examples/Peripheral/LED/LED.ino Co-Authored-By: Frederic Pillon commit d4bb5d87ce8f0cc48b44a0f97b2db0fb24471359 Author: Carlo Parata Date: Mon Feb 17 10:41:08 2020 +0100 Update examples/Peripheral/LED/LED.ino Co-Authored-By: Frederic Pillon commit 11bb9499910485b2f8b6cec100cfafb0f832fd42 Author: Carlo Parata Date: Mon Feb 17 10:40:55 2020 +0100 Update examples/Peripheral/CallbackLED/CallbackLED.ino Co-Authored-By: Frederic Pillon commit da2c4fdad68d4963f049efefd6f126c17036afa5 Author: Carlo Parata Date: Mon Feb 17 10:40:44 2020 +0100 Update examples/Peripheral/CallbackLED/CallbackLED.ino Co-Authored-By: Frederic Pillon commit b95942fe54cc07f5e41e57a34eaf048036483b4a Author: Carlo Parata Date: Mon Feb 17 10:40:33 2020 +0100 Update examples/Peripheral/ButtonLED/ButtonLED.ino Co-Authored-By: Frederic Pillon commit fafde937b1b5322af7433dbf25ab21754d8207c2 Author: Carlo Parata Date: Mon Feb 17 10:40:23 2020 +0100 Update examples/Peripheral/ButtonLED/ButtonLED.ino Co-Authored-By: Frederic Pillon commit 18e0ca187283face9db991e610113bbdc0ed3ecb Author: Carlo Parata Date: Mon Feb 17 10:40:13 2020 +0100 Update examples/Central/SensorTagButton/SensorTagButton.ino Co-Authored-By: Frederic Pillon commit aa6e1b30e8a3ebe426231107c4bc0b1a3f15c538 Author: Carlo Parata Date: Mon Feb 17 10:40:00 2020 +0100 Update examples/Central/SensorTagButton/SensorTagButton.ino Co-Authored-By: Frederic Pillon commit b598a3fa8d0fa3d8c180e9625add9db3409aa775 Author: Carlo Parata Date: Mon Feb 17 10:39:48 2020 +0100 Update examples/Central/ScanCallback/ScanCallback.ino Co-Authored-By: Frederic Pillon commit c9f4239e46a53a7b9e40705b2065ef1d14bef8d6 Author: Carlo Parata Date: Mon Feb 17 10:39:37 2020 +0100 Update examples/Central/ScanCallback/ScanCallback.ino Co-Authored-By: Frederic Pillon commit f7d45fad296b21b29e087affbf47592b4ccb41e4 Author: Carlo Parata Date: Mon Feb 17 10:39:25 2020 +0100 Update examples/Central/Scan/Scan.ino Co-Authored-By: Frederic Pillon commit 775a60aaaec40cf98bcaf354e4baaa965123a361 Author: Carlo Parata Date: Mon Feb 17 10:39:13 2020 +0100 Update examples/Central/Scan/Scan.ino Co-Authored-By: Frederic Pillon commit 9f4679794b399a99b9cfd2077cd342ab774d80f5 Author: Carlo Parata Date: Mon Feb 17 10:39:06 2020 +0100 Update examples/Central/LedControl/LedControl.ino Co-Authored-By: Frederic Pillon commit 81ff00b5579f7bb3583fd4de23afb3a1d59c1eef Author: Carlo Parata Date: Mon Feb 17 10:38:57 2020 +0100 Update examples/Central/LedControl/LedControl.ino Co-Authored-By: Frederic Pillon commit 19ce6152cd33e9201f9704a6fdfcf6e3cc1ed9ed Author: Carlo Parata Date: Mon Feb 17 10:38:49 2020 +0100 Update examples/Central/PeripheralExplorer/PeripheralExplorer.ino Co-Authored-By: Frederic Pillon commit ab1df57890c5e6d94e989c1efc17244c9782f3de Author: Carlo Parata Date: Mon Feb 17 10:38:38 2020 +0100 Update examples/Central/PeripheralExplorer/PeripheralExplorer.ino Co-Authored-By: Frederic Pillon commit 94a834a0199275b3d7785a8d6913551100dad203 Merge: c4f359a 7e7cf88 Author: Carlo Parata Date: Mon Feb 17 10:25:33 2020 +0100 Merge pull request #1 from fpistm/pr-11 STM32duinoBLE enhancement commit 7e7cf887cf24410e50ce25d55bb2a3c312687ea1 Author: Frederic Pillon Date: Mon Feb 17 10:08:13 2020 +0100 Fix workflow to build ST targets Signed-off-by: Frederic Pillon commit 2f22ce95979cc609a23dcfac3bd67650cef763e9 Author: Frederic Pillon Date: Tue Nov 19 12:07:36 2019 +0100 Replace boolean with standard bool https://github.com/arduino/Arduino/issues/4673 Signed-off-by: Frederic Pillon commit 02ff3a64f54b21ce815460964c8ec508e6f15ac4 Author: Frederic Pillon Date: Mon Feb 17 09:00:30 2020 +0100 SPISettings managements Signed-off-by: Frederic Pillon commit c4f359a90e97b3574dc524b2821f35eb9ac32806 Author: Carlo Parata Date: Fri Feb 7 11:20:49 2020 +0100 Improve STM32duinoBLE robustness and flexibility commit 495b94157025ba15121321227cf423954c5e733f Merge: 4734253 83671f4 Author: Carlo Parata Date: Tue Dec 3 13:43:51 2019 +0100 Merge pull request #10 from cparata/master Sync with ArduinoBLE commit 83671f448a24e3c14d36cfa95de43a61a4998b5c Merge: 41cf4bc 8dc4290 Author: Carlo Parata Date: Tue Dec 3 11:34:54 2019 +0100 Merge remote-tracking branch 'upstream/master' commit 4734253cf5d29897c7e790a53b696c86234a408b Merge: 5d4475a 41cf4bc Author: Carlo Parata Date: Fri Nov 15 18:05:18 2019 +0100 Merge pull request #9 from cparata/master Align to ArduinoBLE 1.1.2 commit 41cf4bcf6ac69150948182f530f4108ef6cfc811 Merge: fa813f0 ac85dae Author: Carlo Parata Date: Fri Nov 15 18:03:05 2019 +0100 Align to ArduinoBLE 1.1.2 commit 5d4475a7a4511189a076300d7937cf1bc9bf3418 Merge: 33a8c3b fa813f0 Author: Carlo Parata Date: Tue Nov 12 14:04:30 2019 +0100 Merge pull request #8 from cparata/master Replace typo STBTLE with SPBTLE commit fa813f01247e94ff29b4c4bb8ed28bb364fe72b2 Author: Carlo Parata Date: Tue Nov 12 14:00:26 2019 +0100 Replace typo STBTLE with SPBTLE commit 33a8c3b9b99717aff57dff88673d9cb11ae94b0c Merge: b530dec 0c59e94 Author: Carlo Parata Date: Thu Oct 10 12:32:24 2019 +0200 Merge pull request #6 from cparata/master Sync with ArduinoBLE library commit 0c59e945ab798acd48a0492085b42f4c6c92f026 Merge: e37e3aa 226ced5 Author: Carlo Parata Date: Thu Oct 10 12:17:25 2019 +0200 Solve conflicts commit b530dec1c575ef3071570a917dcd5e718fb8e862 Merge: d54c075 e37e3aa Author: Carlo Parata Date: Wed Sep 25 14:53:50 2019 +0200 Merge pull request #5 from cparata/master Update README and Library properties files commit e37e3aae8969768aec14db0f8029c9530ee8109d Author: Carlo Parata Date: Wed Sep 25 14:51:27 2019 +0200 Update README and Library properties commit 1b0d04ebeef3ed8ece929a133c544fbeece8cef1 Merge: d556640 d6fba6a Author: Carlo Parata Date: Fri Sep 20 15:48:48 2019 +0200 Merge remote-tracking branch 'upstream/master' commit d54c075fd806ee1e5f1dbb3e1587a2c47ee7bdd0 Merge: 7db8cef d556640 Author: Carlo Parata Date: Fri Sep 20 11:46:16 2019 +0200 Merge pull request #4 from cparata/master Fix issue on Disconnection event commit d5566408ce6b06fb5932f6a297c5e2904cf1310d Author: Carlo Parata Date: Fri Sep 20 11:44:53 2019 +0200 Fix issue on Disconnection event commit 7db8cefdb4cacf5c0bd6e97600ddebc95ff41056 Merge: 5e44386 137c830 Author: Carlo Parata Date: Fri Sep 20 10:39:28 2019 +0200 Merge pull request #3 from cparata/master Add support to STBTLE-RF and STBTLE-1S modules commit 137c8300d0cc4c07765c0fc68d3b9e8806299331 Author: Carlo Parata Date: Fri Sep 20 10:29:45 2019 +0200 Update README and library properties for STM32duinoBLE commit 3474eab9c415dfe340fe726df2f6f3029ee45a19 Merge: 8527443 5e44386 Author: Carlo Parata Date: Fri Sep 20 09:40:30 2019 +0200 Merge remote-tracking branch 'upstream/master' commit 8527443f3749f77592b3801f31a614131f341237 Author: Carlo Parata Date: Thu Sep 19 10:33:53 2019 +0200 Add support to STBTLE-RF and STBTLE-1S --- .editorconfig | 26 + .gitattributes | 42 + .github/workflows/codespell.yml | 28 + .github/workflows/compile-examples.yml | 44 +- CHANGELOG | 5 +- README.md | 33 +- examples/Central/LedControl/LedControl.ino | 143 +- .../PeripheralExplorer/PeripheralExplorer.ino | 116 +- examples/Central/Scan/Scan.ino | 106 +- .../Central/ScanCallback/ScanCallback.ino | 104 +- .../SensorTagButton/SensorTagButton.ino | 130 +- examples/Peripheral/ButtonLED/ButtonLED.ino | 103 +- .../Peripheral/CallbackLED/CallbackLED.ino | 95 +- examples/Peripheral/LED/LED.ino | 94 +- ...001-chore-adapt-STM32Cube_FW-sources.patch | 327 ++++ ...imeout-when-waiting-for-the-cmd_resp.patch | 41 + ...ort-for-customize-app_conf_default.h.patch | 195 +++ ...-fix-TL_Evt_t-payload-size-for-reset.patch | 30 + keywords.txt | 22 +- library.properties | 18 +- src/{ArduinoBLE.h => STM32duinoBLE.h} | 9 +- src/local/BLELocalDevice.cpp | 130 +- src/local/BLELocalDevice.h | 14 +- src/utility/ATT.cpp | 5 +- src/utility/ATT.h | 5 + src/utility/GAP.cpp | 37 +- src/utility/GAP.h | 5 +- src/utility/HCI.cpp | 74 +- src/utility/HCI.h | 7 +- src/utility/HCICordioTransport.h | 54 - src/utility/HCISharedMemTransport.cpp | 774 ++++++++++ src/utility/HCISharedMemTransport.h | 93 ++ src/utility/HCISpiTransport.cpp | 1353 ++++++++++++++++ src/utility/HCISpiTransport.h | 83 + src/utility/HCIUartTransport.h | 46 - src/utility/STM32Cube_FW/LICENSE.md | 80 + src/utility/STM32Cube_FW/README.md | 6 + src/utility/STM32Cube_FW/app_conf.h | 20 + src/utility/STM32Cube_FW/app_conf_default.h | 735 +++++++++ src/utility/STM32Cube_FW/ble_bufsize.h | 182 +++ src/utility/STM32Cube_FW/hw.h | 114 ++ src/utility/STM32Cube_FW/hw_ipcc.c | 670 ++++++++ src/utility/STM32Cube_FW/mbox_def.h | 280 ++++ src/utility/STM32Cube_FW/shci.c | 742 +++++++++ src/utility/STM32Cube_FW/shci.h | 1372 +++++++++++++++++ src/utility/STM32Cube_FW/shci_tl.c | 270 ++++ src/utility/STM32Cube_FW/shci_tl.h | 173 +++ src/utility/STM32Cube_FW/stm32_wpan_common.h | 171 ++ src/utility/STM32Cube_FW/stm_list.c | 209 +++ src/utility/STM32Cube_FW/stm_list.h | 55 + src/utility/STM32Cube_FW/tl.h | 372 +++++ src/utility/STM32Cube_FW/tl_dbg_conf.h | 140 ++ src/utility/STM32Cube_FW/tl_mbox.c | 853 ++++++++++ 53 files changed, 10473 insertions(+), 362 deletions(-) create mode 100644 .editorconfig create mode 100644 .gitattributes create mode 100644 .github/workflows/codespell.yml create mode 100644 extras/STM32Cube_FW/0001-chore-adapt-STM32Cube_FW-sources.patch create mode 100644 extras/STM32Cube_FW/0002-fix-include-a-timeout-when-waiting-for-the-cmd_resp.patch create mode 100644 extras/STM32Cube_FW/0003-chore-add-support-for-customize-app_conf_default.h.patch create mode 100644 extras/STM32Cube_FW/0004-fix-TL_Evt_t-payload-size-for-reset.patch rename src/{ArduinoBLE.h => STM32duinoBLE.h} (85%) delete mode 100644 src/utility/HCICordioTransport.h create mode 100644 src/utility/HCISharedMemTransport.cpp create mode 100644 src/utility/HCISharedMemTransport.h create mode 100644 src/utility/HCISpiTransport.cpp create mode 100644 src/utility/HCISpiTransport.h delete mode 100644 src/utility/HCIUartTransport.h create mode 100644 src/utility/STM32Cube_FW/LICENSE.md create mode 100644 src/utility/STM32Cube_FW/README.md create mode 100644 src/utility/STM32Cube_FW/app_conf.h create mode 100644 src/utility/STM32Cube_FW/app_conf_default.h create mode 100644 src/utility/STM32Cube_FW/ble_bufsize.h create mode 100644 src/utility/STM32Cube_FW/hw.h create mode 100644 src/utility/STM32Cube_FW/hw_ipcc.c create mode 100644 src/utility/STM32Cube_FW/mbox_def.h create mode 100644 src/utility/STM32Cube_FW/shci.c create mode 100644 src/utility/STM32Cube_FW/shci.h create mode 100644 src/utility/STM32Cube_FW/shci_tl.c create mode 100644 src/utility/STM32Cube_FW/shci_tl.h create mode 100644 src/utility/STM32Cube_FW/stm32_wpan_common.h create mode 100644 src/utility/STM32Cube_FW/stm_list.c create mode 100644 src/utility/STM32Cube_FW/stm_list.h create mode 100644 src/utility/STM32Cube_FW/tl.h create mode 100644 src/utility/STM32Cube_FW/tl_dbg_conf.h create mode 100644 src/utility/STM32Cube_FW/tl_mbox.c diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 00000000..47433680 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,26 @@ +[*] +end_of_line = lf +insert_final_newline = true +indent_style = space +indent_size = 2 +trim_trailing_whitespace = true + +[*.patch] +insert_final_newline = unset +indent_style = unset +indent_size = unset +trim_trailing_whitespace = unset + +[*.md] +trim_trailing_whitespace = false + +[*.sh] +# like -i=2 +indent_style = space +indent_size = 2 + +#shell_variant = posix # like -ln=posix +#binary_next_line = true # like -bn +switch_case_indent = true # like -ci +space_redirects = true # like -sr +#keep_padding = true # like -kp diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 00000000..422ae6f5 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,42 @@ +# Set the default behavior, in case people don't have core.autocrlf set. +* text=auto + +# Explicitly declare text files you want to always be normalized and converted +# to native line endings on checkout. +.editorconfig text eol=lf +.flake8 text eol=lf +.gitattributes text eol=lf +.gitignore text eol=lf + +*.adoc text eol=lf +*.c text eol=lf +*.cmake text eol=lf +*.cpp text eol=lf +*.css text eol=lf +*.dtsi text eol=lf +*.gv text eol=lf +*.h text eol=lf +*.html text eol=lf +*.in text eol=lf +*.ino text eol=lf +*.json text eol=lf +*.ld text eol=lf +*.md text eol=lf +*.MD text eol=lf +*.old text eol=lf +*.patch text eol=lf +*.pde text eol=lf +*.properties text eol=lf +*.py text eol=lf +*.s text eol=lf +*.S text eol=lf +*.sh text eol=lf +*.spec text eol=lf +*.txt text eol=lf +*.yml text eol=lf + +# Denote all files that are truly binary and should not be modified. +*.jpg binary +*.pdf binary +*.png binary + diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml new file mode 100644 index 00000000..744a6d2e --- /dev/null +++ b/.github/workflows/codespell.yml @@ -0,0 +1,28 @@ +name: codespell + +on: + push: + branches: + - main + pull_request: + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: +jobs: + codespell: + name: Check for spelling errors + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@main + + # See: https://github.com/codespell-project/actions-codespell/blob/master/README.md + - name: Spell check + uses: codespell-project/actions-codespell@master + with: + check_filenames: true + check_hidden: true + # In the event of a false positive, add the word in all lower case to this file: + # ignore_words_file: ./extras/codespell-ignore-words-list.txt + skip: src/utility/STM32Cube_FW + path: src diff --git a/.github/workflows/compile-examples.yml b/.github/workflows/compile-examples.yml index 7f2ed318..f4ce9e1c 100644 --- a/.github/workflows/compile-examples.yml +++ b/.github/workflows/compile-examples.yml @@ -10,33 +10,10 @@ jobs: strategy: matrix: fqbn: - - arduino:samd:mkrwifi1010 - - arduino:samd:nano_33_iot - - arduino:megaavr:uno2018:mode=on - - arduino:mbed:nano33ble - - arduino:mbed_nano:nanorp2040connect - - arduino:renesas_uno:unor4wifi - - steps: - - uses: actions/checkout@v4 - - uses: arduino/compile-sketches@v1 - with: - github-token: ${{ secrets.GITHUB_TOKEN }} - fqbn: ${{ matrix.fqbn }} - - build-for-esp32: - runs-on: ubuntu-latest - - strategy: - matrix: - fqbn: - - esp32:esp32:esp32 - - esp32:esp32:esp32s3 - - esp32:esp32:esp32c3 - # future bluetooth chips - #- esp32:esp32:esp32c2 - #- esp32:esp32:esp32c6 - #- esp32:esp32:esp32h2 + - STMicroelectronics:stm32:Eval:pnum=STEVAL_MKSBOX1V1,usb=CDCgen + - STMicroelectronics:stm32:Nucleo_64:pnum=NUCLEO_L476RG + - STMicroelectronics:stm32:Disco:pnum=B_L475E_IOT01A + - STMicroelectronics:stm32:Nucleo_64:pnum=P_NUCLEO_WB55RG steps: - uses: actions/checkout@v4 @@ -45,14 +22,5 @@ jobs: github-token: ${{ secrets.GITHUB_TOKEN }} fqbn: ${{ matrix.fqbn }} platforms: | - - name: esp32:esp32 - source-url: https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json - sketch-paths: | - - examples/Central/Scan - - examples/Central/PeripheralExplorer - - examples/Central/ScanCallback - - examples/Central/SensorTagButton - - examples/Peripheral/Advertising/EnhancedAdvertising - - examples/Peripheral/Advertising/RawDataAdvertising - cli-compile-flags: | - - --warnings="none" + - source-url: https://github.com/stm32duino/BoardManagerFiles/raw/main/package_stmicroelectronics_index.json + name: STMicroelectronics:stm32 diff --git a/CHANGELOG b/CHANGELOG index a29f8598..4844008e 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,4 +1,7 @@ -ArduinoBLE ?.?.? - ????.??.?? +STM32duinoBLE 1.2.0 - 2020.02.17 +* Added support to X-NUCLEO-BNRG2A1 +* Renamed ArduinoBLE as STM32duinoBLE +* Moved the SPI Transport instance in the application code to improve portability ArduinoBLE 1.1.2 - 2019.11.12 diff --git a/README.md b/README.md index 6808502c..b6e9de98 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,37 @@ -# ArduinoBLE +# STM32duinoBLE -[![Compile Examples Status](https://github.com/arduino-libraries/ArduinoBLE/workflows/Compile%20Examples/badge.svg)](https://github.com/arduino-libraries/ArduinoBLE/actions?workflow=Compile+Examples) [![Spell Check Status](https://github.com/arduino-libraries/ArduinoBLE/workflows/Spell%20Check/badge.svg)](https://github.com/arduino-libraries/ArduinoBLE/actions?workflow=Spell+Check) +This library is a fork of ArduinoBLE library to add the support of STM32WBxx, SPBTLE-RF and SPBTLE-1S BLE modules. +It was successfully tested with the NUCLEO-WB15CC, P-NUCELO_WB55RG, STM32WB5MM-DK, X-NUCLEO-IDB05A2 or +X-NUCLEO-IDB05A1 or X-NUCLEO-BNRG2A1 expansion board and a NUCLEO-F401RE or NUCLEO-L476RG or NUCLEO-L053R8, +with B-L475E-IOT01A and with STEVAL-MKSBOX1V1. -Enables Bluetooth® Low Energy connectivity on the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, Arduino Nano 33 IoT, Arduino Nano 33 BLE, Arduino Portenta H7, Arduino Giga R1 and Arduino UNO R4 WiFi. + - In order to use this library with SM32WBxx series, you need to update the STM32WB Copro Wireless Binaries +with stm32wbxx_BLE_HCILayer_fw.bin depending of your mcu: +https://github.com/STMicroelectronics/STM32CubeWB/tree/master/Projects/STM32WB_Copro_Wireless_Binaries + Each subdirectories contains binaries and Release_Notes.html which explain how to update it. -This library supports creating a Bluetooth® Low Energy peripheral & central mode. + - In order to use this library with STEVAL-MKSBOX1V1, you need to update the firmware of the SPBTLE-1S BLE module +mounted on that board as described in the following wiki page: +https://github.com/stm32duino/wiki/wiki/STM32duinoBLE#stm32duinoble-with-steval_mksbox1v1 -For the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, and Arduino Nano 33 IoT boards, it requires the NINA module to be running [Arduino NINA-W102 firmware](https://github.com/arduino/nina-fw) v1.2.0 or later. +- In order to use this library with X-NUCLEO-BNRG2A1, you need to update the firmware of the BLUENRG-M2SP BLE module +mounted on that expansion board as described in the following wiki page: +https://github.com/stm32duino/wiki/wiki/STM32duinoBLE#stm32duinoble-with-x-nucleo-bnrg2a1 -For the Arduino UNO R4 WiFi, it requires the ESP32-S3 module to be running [firmware](https://github.com/arduino/uno-r4-wifi-usb-bridge) v0.2.0 or later. +For more information about ArduinoBLE library please visit the official web page at: +https://github.com/arduino-libraries/ArduinoBLE - -For more information about this library please visit us at: -https://www.arduino.cc/en/Reference/ArduinoBLE +# Configuration +STM32Cube_WPAN has several configuration options, which are set in the `app_conf.h`. +This package has a default configuration named `app_conf_default.h`. +The user can include the file `app_conf_custom.h` to customize the BLE application. +Options wrapped in `#ifndef`, `#endif` in `app_conf_default.h` can be overwritten. +Additional options can be added. ## License ``` +Copyright (c) 2019 STMicroelectronics. All rights reserved. Copyright (c) 2019 Arduino SA. All rights reserved. This library is free software; you can redistribute it and/or diff --git a/examples/Central/LedControl/LedControl.ino b/examples/Central/LedControl/LedControl.ino index 953de7d8..af1265d7 100644 --- a/examples/Central/LedControl/LedControl.ino +++ b/examples/Central/LedControl/LedControl.ino @@ -6,9 +6,17 @@ it will remotely control the Bluetooth® Low Energy peripheral's LED, when the button is pressed or released. The circuit: - - Arduino MKR WiFi 1010, Arduino Uno WiFi Rev2 board, Arduino Nano 33 IoT, - Arduino Nano 33 BLE, or Arduino Nano 33 BLE Sense board. - - Button with pull-up resistor connected to pin 2. + - Boards with integrated BLE or Nucleo board plus one of BLE X-Nucleo shield:: + - B-L475E-IOT01A1 + - B_L4S5I_IOT01A + - STEVAL-MKBOXPRO + - STEVAL-MKSBOX1V1, + - NUCLEO-WB15CC + - P-NUCLEO-WB55RG + - STM32WB5MM-DK + - X-NUCLEO-IDB05A2 + - X-NUCLEO-IDB05A1 + - X-NUCLEO-BNRG2A1 You can use it with another board that is compatible with this library and the Peripherals -> LED example. @@ -16,26 +24,121 @@ This example code is in the public domain. */ -#include +#include + +#ifdef USER_BTN +const int buttonPin = USER_BTN; // set buttonPin to on-board user button +#else +const int buttonPin = PC13; // set buttonPin to digital pin PC13 */ +#endif + +#if defined(ARDUINO_STEVAL_MKBOXPRO) +/* STEVAL-MKBOXPRO */ +SPIClass SpiHCI(PA7, PA6, PA5); +HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_LP, PA2, PB11, PD4, 1000000, SPI_MODE3); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#elif defined(ARDUINO_STEVAL_MKSBOX1V1) +/* STEVAL-MKSBOX1V1 */ +SPIClass SpiHCI(PC3, PD3, PD1); +HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_1S, PD0, PD4, PA8, 1000000, SPI_MODE1); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#elif defined(ARDUINO_B_L475E_IOT01A) || defined(ARDUINO_B_L4S5I_IOT01A) +/* B-L475E-IOT01A1 or B_L4S5I_IOT01A */ +SPIClass SpiHCI(PC12, PC11, PC10); +HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, PD13, PE6, PA8, 8000000, SPI_MODE0); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#elif defined(ARDUINO_NUCLEO_WB15CC) || defined(ARDUINO_P_NUCLEO_WB55RG) ||\ + defined(ARDUINO_STM32WB5MM_DK) || defined(P_NUCLEO_WB55_USB_DONGLE) +HCISharedMemTransportClass HCISharedMemTransport; +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISharedMemTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#else +/* Shield IDB05A2 with SPI clock on D3 */ +SPIClass SpiHCI(D11, D12, D3); +HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M0, A1, A0, D7, 8000000, SPI_MODE0); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +/* Shield IDB05A2 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M0, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield IDB05A1 with SPI clock on D3 */ +// SPIClass SpiHCI(D11, D12, D3); +// HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield IDB05A1 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield BNRG2A1 with SPI clock on D3 */ +// SPIClass SpiHCI(D11, D12, D3); +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M2SP, A1, A0, D7, 1000000, SPI_MODE1); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield BNRG2A1 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M2SP, A1, A0, D7, 1000000, SPI_MODE1); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +#endif // variables for button -const int buttonPin = 2; int oldButtonState = LOW; +int initialButtonState = LOW; void setup() { - Serial.begin(9600); + Serial.begin(115200); while (!Serial); // configure the button pin as input - pinMode(buttonPin, INPUT); + pinMode(buttonPin, INPUT_PULLUP); // initialize the Bluetooth® Low Energy hardware BLE.begin(); + // Get initial button state + initialButtonState = digitalRead(buttonPin); + oldButtonState = initialButtonState; + Serial.println("Bluetooth® Low Energy Central - LED control"); // start scanning for peripherals - BLE.scanForUuid("19b10000-e8f2-537e-4f6c-d104768a1214"); + int ret = 1; + do + { + ret = BLE.scanForUuid("19b10000-e8f2-537e-4f6c-d104768a1214"); + if (ret == 0) + { + BLE.end(); + BLE.begin(); + } + } while(ret == 0); } void loop() { @@ -57,12 +160,30 @@ void loop() { } // stop scanning - BLE.stopScan(); + int ret = 1; + do + { + ret = BLE.stopScan(); + if (ret == 0) + { + BLE.end(); + BLE.begin(); + } + } while(ret == 0); controlLed(peripheral); // peripheral disconnected, start scanning again - BLE.scanForUuid("19b10000-e8f2-537e-4f6c-d104768a1214"); + ret = 1; + do + { + ret = BLE.scanForUuid("19b10000-e8f2-537e-4f6c-d104768a1214"); + if (ret == 0) + { + BLE.end(); + BLE.begin(); + } + } while(ret == 0); } } @@ -110,7 +231,7 @@ void controlLed(BLEDevice peripheral) { // button changed oldButtonState = buttonState; - if (buttonState) { + if (buttonState != initialButtonState) { Serial.println("button pressed"); // button is pressed, write 0x01 to turn the LED on diff --git a/examples/Central/PeripheralExplorer/PeripheralExplorer.ino b/examples/Central/PeripheralExplorer/PeripheralExplorer.ino index 919cdde0..44896813 100644 --- a/examples/Central/PeripheralExplorer/PeripheralExplorer.ino +++ b/examples/Central/PeripheralExplorer/PeripheralExplorer.ino @@ -5,8 +5,17 @@ is found. Then connects, and discovers + prints all the peripheral's attributes. The circuit: - - Arduino MKR WiFi 1010, Arduino Uno WiFi Rev2 board, Arduino Nano 33 IoT, - Arduino Nano 33 BLE, or Arduino Nano 33 BLE Sense board. + - Boards with integrated BLE or Nucleo board plus one of BLE X-Nucleo shield:: + - B-L475E-IOT01A1 + - B_L4S5I_IOT01A + - STEVAL-MKBOXPRO + - STEVAL-MKSBOX1V1, + - NUCLEO-WB15CC + - P-NUCLEO-WB55RG + - STM32WB5MM-DK + - X-NUCLEO-IDB05A2 + - X-NUCLEO-IDB05A1 + - X-NUCLEO-BNRG2A1 You can use it with another board that is compatible with this library and the Peripherals -> LED example. @@ -14,10 +23,87 @@ This example code is in the public domain. */ -#include +#include + +#if defined(ARDUINO_STEVAL_MKBOXPRO) +/* STEVAL-MKBOXPRO */ +SPIClass SpiHCI(PA7, PA6, PA5); +HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_LP, PA2, PB11, PD4, 1000000, SPI_MODE3); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +const int buttonPin = PC13; // set buttonPin to digital pin PC13 +#elif defined(ARDUINO_STEVAL_MKSBOX1V1) +/* STEVAL-MKSBOX1V1 */ +SPIClass SpiHCI(PC3, PD3, PD1); +HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_1S, PD0, PD4, PA8, 1000000, SPI_MODE1); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#elif defined(ARDUINO_B_L475E_IOT01A) || defined(ARDUINO_B_L4S5I_IOT01A) +/* B-L475E-IOT01A1 or B_L4S5I_IOT01A */ +SPIClass SpiHCI(PC12, PC11, PC10); +HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, PD13, PE6, PA8, 8000000, SPI_MODE0); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#elif defined(ARDUINO_NUCLEO_WB15CC) || defined(ARDUINO_P_NUCLEO_WB55RG) ||\ + defined(ARDUINO_STM32WB5MM_DK) || defined(P_NUCLEO_WB55_USB_DONGLE) +HCISharedMemTransportClass HCISharedMemTransport; +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISharedMemTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#else +/* Shield IDB05A2 with SPI clock on D3 */ +SPIClass SpiHCI(D11, D12, D3); +HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M0, A1, A0, D7, 8000000, SPI_MODE0); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +/* Shield IDB05A2 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M0, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield IDB05A1 with SPI clock on D3 */ +// SPIClass SpiHCI(D11, D12, D3); +// HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield IDB05A1 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield BNRG2A1 with SPI clock on D3 */ +// SPIClass SpiHCI(D11, D12, D3); +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M2SP, A1, A0, D7, 1000000, SPI_MODE1); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield BNRG2A1 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M2SP, A1, A0, D7, 1000000, SPI_MODE1); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +#endif void setup() { - Serial.begin(9600); + Serial.begin(115200); while (!Serial); // begin initialization @@ -30,7 +116,16 @@ void setup() { Serial.println("Bluetooth® Low Energy Central - Peripheral Explorer"); // start scanning for peripherals - BLE.scan(); + int ret = 1; + do + { + ret = BLE.scan(); + if (ret == 0) + { + BLE.end(); + BLE.begin(); + } + } while(ret == 0); } void loop() { @@ -50,7 +145,16 @@ void loop() { // see if peripheral is a LED if (peripheral.localName() == "LED") { // stop scanning - BLE.stopScan(); + int ret = 1; + do + { + ret = BLE.stopScan(); + if (ret == 0) + { + BLE.end(); + BLE.begin(); + } + } while(ret == 0); explorerPeripheral(peripheral); diff --git a/examples/Central/Scan/Scan.ino b/examples/Central/Scan/Scan.ino index 162e3c07..551c54b3 100644 --- a/examples/Central/Scan/Scan.ino +++ b/examples/Central/Scan/Scan.ino @@ -5,16 +5,101 @@ address, local name, advertised service UUID's. The circuit: - - Arduino MKR WiFi 1010, Arduino Uno WiFi Rev2 board, Arduino Nano 33 IoT, - Arduino Nano 33 BLE, or Arduino Nano 33 BLE Sense board. + - Boards with integrated BLE or Nucleo board plus one of BLE X-Nucleo shield:: + - B-L475E-IOT01A1 + - B_L4S5I_IOT01A + - STEVAL-MKBOXPRO + - STEVAL-MKSBOX1V1, + - NUCLEO-WB15CC + - P-NUCLEO-WB55RG + - STM32WB5MM-DK + - X-NUCLEO-IDB05A2 + - X-NUCLEO-IDB05A1 + - X-NUCLEO-BNRG2A1 This example code is in the public domain. */ -#include +#include + +#if defined(ARDUINO_STEVAL_MKBOXPRO) +/* STEVAL-MKBOXPRO */ +SPIClass SpiHCI(PA7, PA6, PA5); +HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_LP, PA2, PB11, PD4, 1000000, SPI_MODE3); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#elif defined(ARDUINO_STEVAL_MKSBOX1V1) +/* STEVAL-MKSBOX1V1 */ +SPIClass SpiHCI(PC3, PD3, PD1); +HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_1S, PD0, PD4, PA8, 1000000, SPI_MODE1); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#elif defined(ARDUINO_B_L475E_IOT01A) || defined(ARDUINO_B_L4S5I_IOT01A) +/* B-L475E-IOT01A1 or B_L4S5I_IOT01A */ +SPIClass SpiHCI(PC12, PC11, PC10); +HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, PD13, PE6, PA8, 8000000, SPI_MODE0); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#elif defined(ARDUINO_NUCLEO_WB15CC) || defined(ARDUINO_P_NUCLEO_WB55RG) ||\ + defined(ARDUINO_STM32WB5MM_DK) || defined(P_NUCLEO_WB55_USB_DONGLE) +HCISharedMemTransportClass HCISharedMemTransport; +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISharedMemTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#else +/* Shield IDB05A2 with SPI clock on D3 */ +SPIClass SpiHCI(D11, D12, D3); +HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M0, A1, A0, D7, 8000000, SPI_MODE0); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +/* Shield IDB05A2 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M0, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield IDB05A1 with SPI clock on D3 */ +// SPIClass SpiHCI(D11, D12, D3); +// HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield IDB05A1 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield BNRG2A1 with SPI clock on D3 */ +// SPIClass SpiHCI(D11, D12, D3); +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M2SP, A1, A0, D7, 1000000, SPI_MODE1); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield BNRG2A1 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M2SP, A1, A0, D7, 1000000, SPI_MODE1); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +#endif void setup() { - Serial.begin(9600); + Serial.begin(115200); while (!Serial); // begin initialization @@ -26,8 +111,17 @@ void setup() { Serial.println("Bluetooth® Low Energy Central scan"); - // start scanning for peripheral - BLE.scan(); + // start scanning for peripherals + int ret = 1; + do + { + ret = BLE.scan(); + if (ret == 0) + { + BLE.end(); + BLE.begin(); + } + } while(ret == 0); } void loop() { diff --git a/examples/Central/ScanCallback/ScanCallback.ino b/examples/Central/ScanCallback/ScanCallback.ino index 2687a3b9..81f34879 100644 --- a/examples/Central/ScanCallback/ScanCallback.ino +++ b/examples/Central/ScanCallback/ScanCallback.ino @@ -7,16 +7,101 @@ reported for every single advertisement it makes. The circuit: - - Arduino MKR WiFi 1010, Arduino Uno WiFi Rev2 board, Arduino Nano 33 IoT, - Arduino Nano 33 BLE, or Arduino Nano 33 BLE Sense board. + - Boards with integrated BLE or Nucleo board plus one of BLE X-Nucleo shield:: + - B-L475E-IOT01A1 + - B_L4S5I_IOT01A + - STEVAL-MKBOXPRO + - STEVAL-MKSBOX1V1, + - NUCLEO-WB15CC + - P-NUCLEO-WB55RG + - STM32WB5MM-DK + - X-NUCLEO-IDB05A2 + - X-NUCLEO-IDB05A1 + - X-NUCLEO-BNRG2A1 This example code is in the public domain. */ -#include +#include + +#if defined(ARDUINO_STEVAL_MKBOXPRO) +/* STEVAL-MKBOXPRO */ +SPIClass SpiHCI(PA7, PA6, PA5); +HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_LP, PA2, PB11, PD4, 1000000, SPI_MODE3); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#elif defined(ARDUINO_STEVAL_MKSBOX1V1) +/* STEVAL-MKSBOX1V1 */ +SPIClass SpiHCI(PC3, PD3, PD1); +HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_1S, PD0, PD4, PA8, 1000000, SPI_MODE1); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#elif defined(ARDUINO_B_L475E_IOT01A) || defined(ARDUINO_B_L4S5I_IOT01A) +/* B-L475E-IOT01A1 or B_L4S5I_IOT01A */ +SPIClass SpiHCI(PC12, PC11, PC10); +HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, PD13, PE6, PA8, 8000000, SPI_MODE0); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#elif defined(ARDUINO_NUCLEO_WB15CC) || defined(ARDUINO_P_NUCLEO_WB55RG) ||\ + defined(ARDUINO_STM32WB5MM_DK) || defined(P_NUCLEO_WB55_USB_DONGLE) +HCISharedMemTransportClass HCISharedMemTransport; +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISharedMemTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#else +/* Shield IDB05A2 with SPI clock on D3 */ +SPIClass SpiHCI(D11, D12, D3); +HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M0, A1, A0, D7, 8000000, SPI_MODE0); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +/* Shield IDB05A2 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M0, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield IDB05A1 with SPI clock on D3 */ +// SPIClass SpiHCI(D11, D12, D3); +// HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield IDB05A1 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield BNRG2A1 with SPI clock on D3 */ +// SPIClass SpiHCI(D11, D12, D3); +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M2SP, A1, A0, D7, 1000000, SPI_MODE1); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield BNRG2A1 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M2SP, A1, A0, D7, 1000000, SPI_MODE1); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +#endif void setup() { - Serial.begin(9600); + Serial.begin(115200); while (!Serial); // begin initialization @@ -32,7 +117,16 @@ void setup() { BLE.setEventHandler(BLEDiscovered, bleCentralDiscoverHandler); // start scanning for peripherals with duplicates - BLE.scan(true); + int ret = 1; + do + { + ret = BLE.scan(true); + if (ret == 0) + { + BLE.end(); + BLE.begin(); + } + } while(ret == 0); } void loop() { diff --git a/examples/Central/SensorTagButton/SensorTagButton.ino b/examples/Central/SensorTagButton/SensorTagButton.ino index a56504f6..e3d563f7 100644 --- a/examples/Central/SensorTagButton/SensorTagButton.ino +++ b/examples/Central/SensorTagButton/SensorTagButton.ino @@ -8,17 +8,102 @@ outputted to the Serial Monitor when one is pressed. The circuit: - - Arduino MKR WiFi 1010, Arduino Uno WiFi Rev2 board, Arduino Nano 33 IoT, - Arduino Nano 33 BLE, or Arduino Nano 33 BLE Sense board. + - Boards with integrated BLE or Nucleo board plus one of BLE X-Nucleo shield:: + - B-L475E-IOT01A1 + - B_L4S5I_IOT01A + - STEVAL-MKBOXPRO + - STEVAL-MKSBOX1V1, + - NUCLEO-WB15CC + - P-NUCLEO-WB55RG + - STM32WB5MM-DK + - X-NUCLEO-IDB05A2 + - X-NUCLEO-IDB05A1 + - X-NUCLEO-BNRG2A1 - TI SensorTag This example code is in the public domain. */ -#include +#include + +#if defined(ARDUINO_STEVAL_MKBOXPRO) +/* STEVAL-MKBOXPRO */ +SPIClass SpiHCI(PA7, PA6, PA5); +HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_LP, PA2, PB11, PD4, 1000000, SPI_MODE3); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#elif defined(ARDUINO_STEVAL_MKSBOX1V1) +/* STEVAL-MKSBOX1V1 */ +SPIClass SpiHCI(PC3, PD3, PD1); +HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_1S, PD0, PD4, PA8, 1000000, SPI_MODE1); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#elif defined(ARDUINO_B_L475E_IOT01A) || defined(ARDUINO_B_L4S5I_IOT01A) +/* B-L475E-IOT01A1 or B_L4S5I_IOT01A */ +SPIClass SpiHCI(PC12, PC11, PC10); +HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, PD13, PE6, PA8, 8000000, SPI_MODE0); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#elif defined(ARDUINO_NUCLEO_WB15CC) || defined(ARDUINO_P_NUCLEO_WB55RG) ||\ + defined(ARDUINO_STM32WB5MM_DK) || defined(P_NUCLEO_WB55_USB_DONGLE) +HCISharedMemTransportClass HCISharedMemTransport; +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISharedMemTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#else +/* Shield IDB05A2 with SPI clock on D3 */ +SPIClass SpiHCI(D11, D12, D3); +HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M0, A1, A0, D7, 8000000, SPI_MODE0); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +/* Shield IDB05A2 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M0, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield IDB05A1 with SPI clock on D3 */ +// SPIClass SpiHCI(D11, D12, D3); +// HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield IDB05A1 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield BNRG2A1 with SPI clock on D3 */ +// SPIClass SpiHCI(D11, D12, D3); +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M2SP, A1, A0, D7, 1000000, SPI_MODE1); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield BNRG2A1 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M2SP, A1, A0, D7, 1000000, SPI_MODE1); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +#endif void setup() { - Serial.begin(9600); + Serial.begin(115200); while (!Serial); // begin initialization @@ -31,8 +116,17 @@ void setup() { Serial.println("Bluetooth® Low Energy Central - SensorTag button"); Serial.println("Make sure to turn on the device."); - // start scanning for peripheral - BLE.scan(); + // start scanning for peripherals + int ret = 1; + do + { + ret = BLE.scan(); + if (ret == 0) + { + BLE.end(); + BLE.begin(); + } + } while(ret == 0); } void loop() { @@ -53,12 +147,30 @@ void loop() { // "CC2650 SensorTag" if (peripheral.localName() == "CC2650 SensorTag") { // stop scanning - BLE.stopScan(); + int ret = 1; + do + { + ret = BLE.stopScan(); + if (ret == 0) + { + BLE.end(); + BLE.begin(); + } + } while(ret == 0); monitorSensorTagButtons(peripheral); // peripheral disconnected, start scanning again - BLE.scan(); + ret = 1; + do + { + ret = BLE.scan(); + if (ret == 0) + { + BLE.end(); + BLE.begin(); + } + } while(ret == 0); } } } @@ -114,7 +226,7 @@ void monitorSensorTagButtons(BLEDevice peripheral) { if (simpleKeyCharacteristic.valueUpdated()) { // yes, get the value, characteristic is 1 byte so use byte value byte value = 0; - + simpleKeyCharacteristic.readValue(value); if (value & 0x01) { diff --git a/examples/Peripheral/ButtonLED/ButtonLED.ino b/examples/Peripheral/ButtonLED/ButtonLED.ino index cbc14dd8..a733a2b1 100644 --- a/examples/Peripheral/ButtonLED/ButtonLED.ino +++ b/examples/Peripheral/ButtonLED/ButtonLED.ino @@ -6,9 +6,17 @@ represents the state of the button. The circuit: - - Arduino MKR WiFi 1010, Arduino Uno WiFi Rev2 board, Arduino Nano 33 IoT, - Arduino Nano 33 BLE, or Arduino Nano 33 BLE Sense board. - - Button connected to pin 4 + - Boards with integrated BLE or Nucleo board plus one of BLE X-Nucleo shield:: + - B-L475E-IOT01A1 + - B_L4S5I_IOT01A + - STEVAL-MKBOXPRO + - STEVAL-MKSBOX1V1, + - NUCLEO-WB15CC + - P-NUCLEO-WB55RG + - STM32WB5MM-DK + - X-NUCLEO-IDB05A2 + - X-NUCLEO-IDB05A1 + - X-NUCLEO-BNRG2A1 You can use a generic Bluetooth® Low Energy central app, like LightBlue (iOS and Android) or nRF Connect (Android), to interact with the services and characteristics @@ -17,10 +25,91 @@ This example code is in the public domain. */ -#include +#include + +#ifdef USER_BTN +const int buttonPin = USER_BTN; // set buttonPin to on-board user button +#else +const int buttonPin = PC13; // set buttonPin to digital pin PC13 */ +#endif + +#if defined(ARDUINO_STEVAL_MKBOXPRO) +/* STEVAL-MKBOXPRO */ +SPIClass SpiHCI(PA7, PA6, PA5); +HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_LP, PA2, PB11, PD4, 1000000, SPI_MODE3); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#elif defined(ARDUINO_STEVAL_MKSBOX1V1) +/* STEVAL-MKSBOX1V1 */ +SPIClass SpiHCI(PC3, PD3, PD1); +HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_1S, PD0, PD4, PA8, 1000000, SPI_MODE1); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#elif defined(ARDUINO_B_L475E_IOT01A) || defined(ARDUINO_B_L4S5I_IOT01A) +/* B-L475E-IOT01A1 or B_L4S5I_IOT01A */ +SPIClass SpiHCI(PC12, PC11, PC10); +HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, PD13, PE6, PA8, 8000000, SPI_MODE0); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#elif defined(ARDUINO_NUCLEO_WB15CC) || defined(ARDUINO_P_NUCLEO_WB55RG) ||\ + defined(ARDUINO_STM32WB5MM_DK) || defined(P_NUCLEO_WB55_USB_DONGLE) +HCISharedMemTransportClass HCISharedMemTransport; +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISharedMemTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#else +/* Shield IDB05A2 with SPI clock on D3 */ +SPIClass SpiHCI(D11, D12, D3); +HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M0, A1, A0, D7, 8000000, SPI_MODE0); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +/* Shield IDB05A2 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M0, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield IDB05A1 with SPI clock on D3 */ +// SPIClass SpiHCI(D11, D12, D3); +// HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield IDB05A1 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield BNRG2A1 with SPI clock on D3 */ +// SPIClass SpiHCI(D11, D12, D3); +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M2SP, A1, A0, D7, 1000000, SPI_MODE1); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield BNRG2A1 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M2SP, A1, A0, D7, 1000000, SPI_MODE1); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +#endif const int ledPin = LED_BUILTIN; // set ledPin to on-board LED -const int buttonPin = 4; // set buttonPin to digital pin 4 BLEService ledService("19B10010-E8F2-537E-4F6C-D104768A1214"); // create service @@ -30,11 +119,11 @@ BLEByteCharacteristic ledCharacteristic("19B10011-E8F2-537E-4F6C-D104768A1214", BLEByteCharacteristic buttonCharacteristic("19B10012-E8F2-537E-4F6C-D104768A1214", BLERead | BLENotify); void setup() { - Serial.begin(9600); + Serial.begin(115200); while (!Serial); pinMode(ledPin, OUTPUT); // use the LED as an output - pinMode(buttonPin, INPUT); // use button pin as an input + pinMode(buttonPin, INPUT_PULLUP); // use button pin as an input // begin initialization if (!BLE.begin()) { diff --git a/examples/Peripheral/CallbackLED/CallbackLED.ino b/examples/Peripheral/CallbackLED/CallbackLED.ino index 23f67bc3..74c4de0e 100644 --- a/examples/Peripheral/CallbackLED/CallbackLED.ino +++ b/examples/Peripheral/CallbackLED/CallbackLED.ino @@ -6,8 +6,17 @@ library are used. The circuit: - - Arduino MKR WiFi 1010, Arduino Uno WiFi Rev2 board, Arduino Nano 33 IoT, - Arduino Nano 33 BLE, or Arduino Nano 33 BLE Sense board. + - Boards with integrated BLE or Nucleo board plus one of BLE X-Nucleo shield:: + - B-L475E-IOT01A1 + - B_L4S5I_IOT01A + - STEVAL-MKBOXPRO + - STEVAL-MKSBOX1V1, + - NUCLEO-WB15CC + - P-NUCLEO-WB55RG + - STM32WB5MM-DK + - X-NUCLEO-IDB05A2 + - X-NUCLEO-IDB05A1 + - X-NUCLEO-BNRG2A1 You can use a generic Bluetooth® Low Energy central app, like LightBlue (iOS and Android) or nRF Connect (Android), to interact with the services and characteristics @@ -16,7 +25,83 @@ This example code is in the public domain. */ -#include +#include + +#if defined(ARDUINO_STEVAL_MKBOXPRO) +/* STEVAL-MKBOXPRO */ +SPIClass SpiHCI(PA7, PA6, PA5); +HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_LP, PA2, PB11, PD4, 1000000, SPI_MODE3); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#elif defined(ARDUINO_STEVAL_MKSBOX1V1) +/* STEVAL-MKSBOX1V1 */ +SPIClass SpiHCI(PC3, PD3, PD1); +HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_1S, PD0, PD4, PA8, 1000000, SPI_MODE1); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#elif defined(ARDUINO_B_L475E_IOT01A) || defined(ARDUINO_B_L4S5I_IOT01A) +/* B-L475E-IOT01A1 or B_L4S5I_IOT01A */ +SPIClass SpiHCI(PC12, PC11, PC10); +HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, PD13, PE6, PA8, 8000000, SPI_MODE0); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#elif defined(ARDUINO_NUCLEO_WB15CC) || defined(ARDUINO_P_NUCLEO_WB55RG) ||\ + defined(ARDUINO_STM32WB5MM_DK) || defined(P_NUCLEO_WB55_USB_DONGLE) +HCISharedMemTransportClass HCISharedMemTransport; +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISharedMemTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#else +/* Shield IDB05A2 with SPI clock on D3 */ +SPIClass SpiHCI(D11, D12, D3); +HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M0, A1, A0, D7, 8000000, SPI_MODE0); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +/* Shield IDB05A2 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M0, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield IDB05A1 with SPI clock on D3 */ +// SPIClass SpiHCI(D11, D12, D3); +// HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield IDB05A1 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield BNRG2A1 with SPI clock on D3 */ +// SPIClass SpiHCI(D11, D12, D3); +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M2SP, A1, A0, D7, 1000000, SPI_MODE1); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield BNRG2A1 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M2SP, A1, A0, D7, 1000000, SPI_MODE1); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +#endif BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // create service @@ -26,9 +111,9 @@ BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214 const int ledPin = LED_BUILTIN; // pin to use for the LED void setup() { - Serial.begin(9600); + Serial.begin(115200); while (!Serial); - + pinMode(ledPin, OUTPUT); // use the LED pin as an output // begin initialization diff --git a/examples/Peripheral/LED/LED.ino b/examples/Peripheral/LED/LED.ino index 2e6d6db9..d92dfd6d 100644 --- a/examples/Peripheral/LED/LED.ino +++ b/examples/Peripheral/LED/LED.ino @@ -5,8 +5,17 @@ characteristic to control an LED. The circuit: - - Arduino MKR WiFi 1010, Arduino Uno WiFi Rev2 board, Arduino Nano 33 IoT, - Arduino Nano 33 BLE, or Arduino Nano 33 BLE Sense board. + - Boards with integrated BLE or Nucleo board plus one of BLE X-Nucleo shield:: + - B-L475E-IOT01A1 + - B_L4S5I_IOT01A + - STEVAL-MKBOXPRO + - STEVAL-MKSBOX1V1, + - NUCLEO-WB15CC + - P-NUCLEO-WB55RG + - STM32WB5MM-DK + - X-NUCLEO-IDB05A2 + - X-NUCLEO-IDB05A1 + - X-NUCLEO-BNRG2A1 You can use a generic Bluetooth® Low Energy central app, like LightBlue (iOS and Android) or nRF Connect (Android), to interact with the services and characteristics @@ -14,8 +23,83 @@ This example code is in the public domain. */ - -#include +#include + +#if defined(ARDUINO_STEVAL_MKBOXPRO) +/* STEVAL-MKBOXPRO */ +SPIClass SpiHCI(PA7, PA6, PA5); +HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_LP, PA2, PB11, PD4, 1000000, SPI_MODE3); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#elif defined(ARDUINO_STEVAL_MKSBOX1V1) +/* STEVAL-MKSBOX1V1 */ +SPIClass SpiHCI(PC3, PD3, PD1); +HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_1S, PD0, PD4, PA8, 1000000, SPI_MODE1); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#elif defined(ARDUINO_B_L475E_IOT01A) || defined(ARDUINO_B_L4S5I_IOT01A) +/* B-L475E-IOT01A1 or B_L4S5I_IOT01A */ +SPIClass SpiHCI(PC12, PC11, PC10); +HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, PD13, PE6, PA8, 8000000, SPI_MODE0); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#elif defined(ARDUINO_NUCLEO_WB15CC) || defined(ARDUINO_P_NUCLEO_WB55RG) ||\ + defined(ARDUINO_STM32WB5MM_DK) || defined(P_NUCLEO_WB55_USB_DONGLE) +HCISharedMemTransportClass HCISharedMemTransport; +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISharedMemTransport); +BLELocalDevice& BLE = BLEObj; +#endif +#else +/* Shield IDB05A2 with SPI clock on D3 */ +SPIClass SpiHCI(D11, D12, D3); +HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M0, A1, A0, D7, 8000000, SPI_MODE0); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice& BLE = BLEObj; +#endif +/* Shield IDB05A2 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M0, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield IDB05A1 with SPI clock on D3 */ +// SPIClass SpiHCI(D11, D12, D3); +// HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield IDB05A1 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield BNRG2A1 with SPI clock on D3 */ +// SPIClass SpiHCI(D11, D12, D3); +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M2SP, A1, A0, D7, 1000000, SPI_MODE1); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield BNRG2A1 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M2SP, A1, A0, D7, 1000000, SPI_MODE1); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +#endif BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // Bluetooth® Low Energy LED Service @@ -25,7 +109,7 @@ BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214 const int ledPin = LED_BUILTIN; // pin to use for the LED void setup() { - Serial.begin(9600); + Serial.begin(115200); while (!Serial); // set LED pin to output mode diff --git a/extras/STM32Cube_FW/0001-chore-adapt-STM32Cube_FW-sources.patch b/extras/STM32Cube_FW/0001-chore-adapt-STM32Cube_FW-sources.patch new file mode 100644 index 00000000..48a28137 --- /dev/null +++ b/extras/STM32Cube_FW/0001-chore-adapt-STM32Cube_FW-sources.patch @@ -0,0 +1,327 @@ +From 542e007fa5a1b53664d2efb5f01d67767123a357 Mon Sep 17 00:00:00 2001 +From: Frederic Pillon +Date: Thu, 13 Jul 2023 17:08:05 +0200 +Subject: [PATCH 1/4] chore: adapt STM32Cube_FW sources + +Signed-off-by: Frederic Pillon +--- + src/utility/STM32Cube_FW/app_conf_default.h | 46 ++++++++++++++++----- + src/utility/STM32Cube_FW/ble_bufsize.h | 7 ++++ + src/utility/STM32Cube_FW/hw.h | 13 +++++- + src/utility/STM32Cube_FW/hw_ipcc.c | 5 ++- + src/utility/STM32Cube_FW/shci.c | 3 +- + src/utility/STM32Cube_FW/shci_tl.c | 18 +++++++- + src/utility/STM32Cube_FW/stm_list.c | 7 +++- + src/utility/STM32Cube_FW/tl_mbox.c | 7 +++- + 8 files changed, 86 insertions(+), 20 deletions(-) + +diff --git a/src/utility/STM32Cube_FW/app_conf_default.h b/src/utility/STM32Cube_FW/app_conf_default.h +index 51bd33a..1c6dd91 100644 +--- a/src/utility/STM32Cube_FW/app_conf_default.h ++++ b/src/utility/STM32Cube_FW/app_conf_default.h +@@ -1,9 +1,9 @@ + /* USER CODE BEGIN Header */ + /** + ****************************************************************************** +- * @file app_conf.h ++ * @file app_conf_default.h + * @author MCD Application Team +- * @brief Application configuration file for STM32WPAN Middleware. ++ * @brief Default application configuration file for STM32WPAN Middleware. + ****************************************************************************** + * @attention + * +@@ -19,18 +19,38 @@ + /* USER CODE END Header */ + + /* Define to prevent recursive inclusion -------------------------------------*/ +-#ifndef APP_CONF_H +-#define APP_CONF_H +- ++#ifndef APP_CONF_DEFAULT_H ++#define APP_CONF_DEFAULT_H ++#if 0 + #include "hw.h" + #include "hw_conf.h" + #include "hw_if.h" + #include "ble_bufsize.h" +- ++#endif + /****************************************************************************** + * Application Config + ******************************************************************************/ + ++/**< generic parameters ******************************************************/ ++/* HCI related defines */ ++ ++#define ACI_HAL_SET_TX_POWER_LEVEL 0xFC0F ++#define ACI_WRITE_CONFIG_DATA_OPCODE 0xFC0C ++#define ACI_READ_CONFIG_DATA_OPCODE 0xFC0D ++#define MAX_HCI_ACL_PACKET_SIZE (sizeof(TL_PacketHeader_t) + 5 + 251) ++#define HCI_RESET 0x0C03 ++ ++#ifndef BLE_SHARED_MEM_BYTE_ORDER ++ #define BLE_SHARED_MEM_BYTE_ORDER MSBFIRST ++#endif ++#define BLE_MODULE_SHARED_MEM_BUFFER_SIZE 128 ++ ++/** ++ * Define Tx Power ++ */ ++#define CFG_TX_POWER (0x18) /* -0.15dBm */ ++ ++#if 0 + /** + * Define Secure Connections Support + */ +@@ -104,7 +124,7 @@ + #define CFG_FW_SUBVERSION (1) + #define CFG_FW_BRANCH (0) + #define CFG_FW_BUILD (0) +- ++#endif + /****************************************************************************** + * BLE Stack + ******************************************************************************/ +@@ -152,13 +172,15 @@ + * Prepare Write List size in terms of number of packet + * This parameter is ignored by the CPU2 when CFG_BLE_OPTIONS has SHCI_C2_BLE_INIT_OPTIONS_LL_ONLY flag set + */ +-#define CFG_BLE_PREPARE_WRITE_LIST_SIZE BLE_PREP_WRITE_X_ATT(CFG_BLE_MAX_ATT_MTU) ++// #define CFG_BLE_PREPARE_WRITE_LIST_SIZE BLE_PREP_WRITE_X_ATT(CFG_BLE_MAX_ATT_MTU) ++#define CFG_BLE_PREPARE_WRITE_LIST_SIZE (0x3A) + + /** + * Number of allocated memory blocks + * This parameter is overwritten by the CPU2 with an hardcoded optimal value when the parameter CFG_BLE_OPTIONS has SHCI_C2_BLE_INIT_OPTIONS_LL_ONLY flag set + */ +-#define CFG_BLE_MBLOCK_COUNT (BLE_MBLOCKS_CALC(CFG_BLE_PREPARE_WRITE_LIST_SIZE, CFG_BLE_MAX_ATT_MTU, CFG_BLE_NUM_LINK)) ++//#define CFG_BLE_MBLOCK_COUNT (BLE_MBLOCKS_CALC(CFG_BLE_PREPARE_WRITE_LIST_SIZE, CFG_BLE_MAX_ATT_MTU, CFG_BLE_NUM_LINK)) ++#define CFG_BLE_MBLOCK_COUNT (0x79) + + /** + * Enable or disable the Extended Packet length feature. Valid values are 0 or 1. +@@ -250,7 +272,7 @@ + * 0: LE Power Class 2-3 + * other bits: complete with Options_extension flag + */ +-#define CFG_BLE_OPTIONS (SHCI_C2_BLE_INIT_OPTIONS_LL_HOST | SHCI_C2_BLE_INIT_OPTIONS_WITH_SVC_CHANGE_DESC | SHCI_C2_BLE_INIT_OPTIONS_DEVICE_NAME_RW | SHCI_C2_BLE_INIT_OPTIONS_EXT_ADV | SHCI_C2_BLE_INIT_OPTIONS_CS_ALGO2 | SHCI_C2_BLE_INIT_OPTIONS_FULL_GATTDB_NVM | SHCI_C2_BLE_INIT_OPTIONS_GATT_CACHING_NOTUSED | SHCI_C2_BLE_INIT_OPTIONS_POWER_CLASS_2_3) ++#define CFG_BLE_OPTIONS (SHCI_C2_BLE_INIT_OPTIONS_LL_ONLY) + + /** + * BLE stack Options_extension flags to be configured with: +@@ -323,6 +345,7 @@ + + #define CFG_BLE_CORE_VERSION (SHCI_C2_BLE_INIT_BLE_CORE_5_3) + ++#if 0 + /****************************************************************************** + * Transport Layer + ******************************************************************************/ +@@ -658,4 +681,5 @@ typedef enum + + #define CFG_OTP_END_ADRESS OTP_AREA_END_ADDR + +-#endif /*APP_CONF_H */ ++#endif ++#endif /*APP_CONF_DEFAULT_H */ +diff --git a/src/utility/STM32Cube_FW/ble_bufsize.h b/src/utility/STM32Cube_FW/ble_bufsize.h +index b9935c0..d4d2890 100644 +--- a/src/utility/STM32Cube_FW/ble_bufsize.h ++++ b/src/utility/STM32Cube_FW/ble_bufsize.h +@@ -75,6 +75,13 @@ + ((pw) + MAX(BLE_MEM_BLOCK_X_MTU(mtu, n_link), \ + BLE_MBLOCKS_SECURE_CONNECTIONS)) + ++/* ++ * BLE_DEFAULT_MBLOCKS_COUNT: default memory blocks count ++ */ ++#define BLE_DEFAULT_MBLOCKS_COUNT(n_link) \ ++ BLE_MBLOCKS_CALC(BLE_DEFAULT_PREP_WRITE_LIST_SIZE, \ ++ BLE_DEFAULT_MAX_ATT_MTU, n_link) ++ + /* + * BLE_FIXED_BUFFER_SIZE_BYTES: + * A part of the RAM, is dynamically allocated by initializing all the pointers +diff --git a/src/utility/STM32Cube_FW/hw.h b/src/utility/STM32Cube_FW/hw.h +index 651e1f1..1472a5e 100644 +--- a/src/utility/STM32Cube_FW/hw.h ++++ b/src/utility/STM32Cube_FW/hw.h +@@ -26,14 +26,23 @@ extern "C" { + #endif + + /* Includes ------------------------------------------------------------------*/ ++#include "stm32_def.h" ++#include "stm32wbxx_ll_bus.h" ++#include "stm32wbxx_ll_exti.h" ++#include "stm32wbxx_ll_system.h" ++#include "stm32wbxx_ll_rcc.h" ++#include "stm32wbxx_ll_ipcc.h" ++#include "stm32wbxx_ll_cortex.h" ++#include "stm32wbxx_ll_utils.h" ++#include "stm32wbxx_ll_pwr.h" + + /****************************************************************************** + * HW IPCC + ******************************************************************************/ + void HW_IPCC_Enable( void ); + void HW_IPCC_Init( void ); +- void HW_IPCC_Rx_Handler( void ); +- void HW_IPCC_Tx_Handler( void ); ++#define HW_IPCC_Rx_Handler IPCC_C1_RX_IRQHandler ++#define HW_IPCC_Tx_Handler IPCC_C1_TX_IRQHandler + + void HW_IPCC_BLE_Init( void ); + void HW_IPCC_BLE_SendCmd( void ); +diff --git a/src/utility/STM32Cube_FW/hw_ipcc.c b/src/utility/STM32Cube_FW/hw_ipcc.c +index fd620b8..c730482 100644 +--- a/src/utility/STM32Cube_FW/hw_ipcc.c ++++ b/src/utility/STM32Cube_FW/hw_ipcc.c +@@ -17,9 +17,9 @@ + ****************************************************************************** + */ + /* USER CODE END Header */ +- ++#if defined(STM32WBxx) + /* Includes ------------------------------------------------------------------*/ +-#include "app_common.h" ++#include "hw.h" + #include "mbox_def.h" + + /* Global variables ---------------------------------------------------------*/ +@@ -667,3 +667,4 @@ static void HW_IPCC_TRACES_EvtHandler( void ) + } + + __weak void HW_IPCC_TRACES_EvtNot( void ){}; ++#endif /* STM32WBxx */ +diff --git a/src/utility/STM32Cube_FW/shci.c b/src/utility/STM32Cube_FW/shci.c +index eaa35d7..4525656 100644 +--- a/src/utility/STM32Cube_FW/shci.c ++++ b/src/utility/STM32Cube_FW/shci.c +@@ -16,7 +16,7 @@ + ****************************************************************************** + */ + +- ++#if defined(STM32WBxx) + /* Includes ------------------------------------------------------------------*/ + #include "stm32_wpan_common.h" + +@@ -739,3 +739,4 @@ SHCI_CmdStatus_t SHCI_GetWirelessFwInfo( WirelessFwInfo_t* pWirelessInfo ) + + return (SHCI_Success); + } ++#endif /* STM32WBxx */ +diff --git a/src/utility/STM32Cube_FW/shci_tl.c b/src/utility/STM32Cube_FW/shci_tl.c +index 0f60430..e343809 100644 +--- a/src/utility/STM32Cube_FW/shci_tl.c ++++ b/src/utility/STM32Cube_FW/shci_tl.c +@@ -16,12 +16,13 @@ + ****************************************************************************** + */ + +- ++#if defined(STM32WBxx) + /* Includes ------------------------------------------------------------------*/ + #include "stm32_wpan_common.h" + + #include "stm_list.h" + #include "shci_tl.h" ++#include "stm32_def.h" + + /* Private typedef -----------------------------------------------------------*/ + typedef enum +@@ -168,6 +169,20 @@ void shci_send( uint16_t cmd_code, uint8_t len_cmd_payload, uint8_t * p_cmd_payl + return; + } + ++void shci_notify_asynch_evt(void *pdata) ++{ ++ UNUSED(pdata); ++ /* Need to parse data in future version */ ++ shci_user_evt_proc(); ++} ++ ++void shci_register_io_bus(tSHciIO *fops) ++{ ++ /* Register IO bus services */ ++ fops->Init = TL_SYS_Init; ++ fops->Send = TL_SYS_SendCmd; ++} ++ + /* Private functions ---------------------------------------------------------*/ + static void TlInit( TL_CmdPacket_t * p_cmdbuffer ) + { +@@ -250,3 +265,4 @@ __WEAK void shci_cmd_resp_release(uint32_t flag) + + return; + } ++#endif /* STM32WBxx */ +diff --git a/src/utility/STM32Cube_FW/stm_list.c b/src/utility/STM32Cube_FW/stm_list.c +index 4c92864..4e8c364 100644 +--- a/src/utility/STM32Cube_FW/stm_list.c ++++ b/src/utility/STM32Cube_FW/stm_list.c +@@ -16,11 +16,13 @@ + ****************************************************************************** + */ + +- ++#if defined(STM32WBxx) + /****************************************************************************** + * Include Files + ******************************************************************************/ +-#include "utilities_common.h" ++#include "stdint.h" ++#include "cmsis_gcc.h" ++#include "stm32_wpan_common.h" + + #include "stm_list.h" + +@@ -204,3 +206,4 @@ void LST_get_prev_node (tListNode * ref_node, tListNode ** node) + + __set_PRIMASK(primask_bit); /**< Restore PRIMASK bit*/ + } ++#endif /* STM32WBxx */ +diff --git a/src/utility/STM32Cube_FW/tl_mbox.c b/src/utility/STM32Cube_FW/tl_mbox.c +index 27a998a..1139316 100644 +--- a/src/utility/STM32Cube_FW/tl_mbox.c ++++ b/src/utility/STM32Cube_FW/tl_mbox.c +@@ -16,6 +16,7 @@ + ****************************************************************************** + */ + ++#if defined(STM32WBxx) + /* Includes ------------------------------------------------------------------*/ + #include "stm32_wpan_common.h" + #include "hw.h" +@@ -51,9 +52,10 @@ PLACE_IN_SECTION("MB_MEM1") ALIGN(4) static MB_BleLldTable_t TL_BleLldTable; + PLACE_IN_SECTION("MB_MEM1") ALIGN(4) static MB_SysTable_t TL_SysTable; + PLACE_IN_SECTION("MB_MEM1") ALIGN(4) static MB_MemManagerTable_t TL_MemManagerTable; + PLACE_IN_SECTION("MB_MEM1") ALIGN(4) static MB_TracesTable_t TL_TracesTable; ++#if 0 + PLACE_IN_SECTION("MB_MEM1") ALIGN(4) static MB_Mac_802_15_4_t TL_Mac_802_15_4_Table; + PLACE_IN_SECTION("MB_MEM1") ALIGN(4) static MB_ZigbeeTable_t TL_Zigbee_Table; +- ++#endif + /**< tables */ + PLACE_IN_SECTION("MB_MEM1") ALIGN(4) static tListNode FreeBufQueue; + PLACE_IN_SECTION("MB_MEM1") ALIGN(4) static tListNode TracesEvtQueue; +@@ -97,8 +99,10 @@ void TL_Init( void ) + TL_RefTable.p_sys_table = &TL_SysTable; + TL_RefTable.p_mem_manager_table = &TL_MemManagerTable; + TL_RefTable.p_traces_table = &TL_TracesTable; ++#if 0 + TL_RefTable.p_mac_802_15_4_table = &TL_Mac_802_15_4_Table; + TL_RefTable.p_zigbee_table = &TL_Zigbee_Table; ++#endif + HW_IPCC_Init(); + + return; +@@ -846,3 +850,4 @@ static void OutputDbgTrace(TL_MB_PacketType_t packet_type, uint8_t* buffer) + + return; + } ++#endif /* STM32WBxx */ +-- +2.38.0.windows.1 + diff --git a/extras/STM32Cube_FW/0002-fix-include-a-timeout-when-waiting-for-the-cmd_resp.patch b/extras/STM32Cube_FW/0002-fix-include-a-timeout-when-waiting-for-the-cmd_resp.patch new file mode 100644 index 00000000..07ce6e6e --- /dev/null +++ b/extras/STM32Cube_FW/0002-fix-include-a-timeout-when-waiting-for-the-cmd_resp.patch @@ -0,0 +1,41 @@ +From 5d07a0e5c0463965f8cf8dde6076b5cf2c779e90 Mon Sep 17 00:00:00 2001 +From: Frederic Pillon +Date: Thu, 13 Jul 2023 17:16:40 +0200 +Subject: [PATCH 2/4] fix: include a timeout when waiting for the cmd_resp + +Signed-off-by: Frederic Pillon +--- + src/utility/STM32Cube_FW/shci_tl.c | 10 ++++++---- + 1 file changed, 6 insertions(+), 4 deletions(-) + +diff --git a/src/utility/STM32Cube_FW/shci_tl.c b/src/utility/STM32Cube_FW/shci_tl.c +index e343809..6038025 100644 +--- a/src/utility/STM32Cube_FW/shci_tl.c ++++ b/src/utility/STM32Cube_FW/shci_tl.c +@@ -23,6 +23,7 @@ + #include "stm_list.h" + #include "shci_tl.h" + #include "stm32_def.h" ++#include "wiring_time.h" + + /* Private typedef -----------------------------------------------------------*/ + typedef enum +@@ -250,10 +251,11 @@ static void TlUserEvtReceived(TL_EvtPacket_t *shcievt) + /* Weak implementation ----------------------------------------------------------------*/ + __WEAK void shci_cmd_resp_wait(uint32_t timeout) + { +- (void)timeout; +- +- while(CmdRspStatusFlag != SHCI_TL_CMD_RESP_RELEASE); +- ++ for (unsigned long start = millis(); (millis() - start) < timeout;) { ++ if (CmdRspStatusFlag == SHCI_TL_CMD_RESP_RELEASE) { ++ break; ++ } ++ } + return; + } + +-- +2.38.0.windows.1 + diff --git a/extras/STM32Cube_FW/0003-chore-add-support-for-customize-app_conf_default.h.patch b/extras/STM32Cube_FW/0003-chore-add-support-for-customize-app_conf_default.h.patch new file mode 100644 index 00000000..e23d54c8 --- /dev/null +++ b/extras/STM32Cube_FW/0003-chore-add-support-for-customize-app_conf_default.h.patch @@ -0,0 +1,195 @@ +From 370e1082edae9b69d50f824db85b5cbe3b786e79 Mon Sep 17 00:00:00 2001 +From: Frederic Pillon +Date: Mon, 12 Dec 2022 17:29:27 +0100 +Subject: [PATCH 3/4] chore: add support for customize app_conf_default.h + +Signed-off-by: Frederic Pillon +--- + src/utility/STM32Cube_FW/app_conf_default.h | 86 ++++++++++++++++----- + 1 file changed, 68 insertions(+), 18 deletions(-) + +diff --git a/src/utility/STM32Cube_FW/app_conf_default.h b/src/utility/STM32Cube_FW/app_conf_default.h +index 1c6dd91..d39492e 100644 +--- a/src/utility/STM32Cube_FW/app_conf_default.h ++++ b/src/utility/STM32Cube_FW/app_conf_default.h +@@ -48,7 +48,9 @@ + /** + * Define Tx Power + */ +-#define CFG_TX_POWER (0x18) /* -0.15dBm */ ++#ifndef CFG_TX_POWER ++ #define CFG_TX_POWER (0x18) /* -0.15dBm */ ++#endif + + #if 0 + /** +@@ -132,13 +134,25 @@ + * Maximum number of simultaneous connections that the device will support. + * Valid values are from 1 to 8 + */ +-#define CFG_BLE_NUM_LINK 8 ++#ifndef CFG_BLE_NUM_LINK ++#ifdef STM32WB15xx ++ #define CFG_BLE_NUM_LINK 3 ++#else ++ #define CFG_BLE_NUM_LINK 8 ++#endif ++#endif + + /** + * Maximum number of Services that can be stored in the GATT database. + * Note that the GAP and GATT services are automatically added so this parameter should be 2 plus the number of user services + */ +-#define CFG_BLE_NUM_GATT_SERVICES 8 ++#ifndef CFG_BLE_NUM_GATT_SERVICES ++#ifdef STM32WB15xx ++ #define CFG_BLE_NUM_GATT_SERVICES 4 ++#else ++ #define CFG_BLE_NUM_GATT_SERVICES 8 ++#endif ++#endif + + /** + * Maximum number of Attributes +@@ -147,13 +161,21 @@ + * Note that certain characteristics and relative descriptors are added automatically during device initialization + * so this parameters should be 9 plus the number of user Attributes + */ +-#define CFG_BLE_NUM_GATT_ATTRIBUTES 68 ++#ifndef CFG_BLE_NUM_GATT_ATTRIBUTES ++#ifdef STM32WB15xx ++ #define CFG_BLE_NUM_GATT_ATTRIBUTES 30 ++#else ++ #define CFG_BLE_NUM_GATT_ATTRIBUTES 68 ++#endif ++#endif + + /** + * Maximum supported ATT_MTU size + * This parameter is ignored by the CPU2 when CFG_BLE_OPTIONS has SHCI_C2_BLE_INIT_OPTIONS_LL_ONLY flag set + */ +-#define CFG_BLE_MAX_ATT_MTU (156) ++#ifndef CFG_BLE_MAX_ATT_MTU ++ #define CFG_BLE_MAX_ATT_MTU (156) ++#endif + + /** + * Size of the storage area for Attribute values +@@ -166,14 +188,22 @@ + * The total amount of memory needed is the sum of the above quantities for each attribute. + * This parameter is ignored by the CPU2 when CFG_BLE_OPTIONS has SHCI_C2_BLE_INIT_OPTIONS_LL_ONLY flag set + */ +-#define CFG_BLE_ATT_VALUE_ARRAY_SIZE (1344) ++#ifndef CFG_BLE_ATT_VALUE_ARRAY_SIZE ++#ifdef STM32WB15xx ++ #define CFG_BLE_ATT_VALUE_ARRAY_SIZE (1290) ++#else ++ #define CFG_BLE_ATT_VALUE_ARRAY_SIZE (1344) ++#endif ++#endif + + /** + * Prepare Write List size in terms of number of packet + * This parameter is ignored by the CPU2 when CFG_BLE_OPTIONS has SHCI_C2_BLE_INIT_OPTIONS_LL_ONLY flag set + */ + // #define CFG_BLE_PREPARE_WRITE_LIST_SIZE BLE_PREP_WRITE_X_ATT(CFG_BLE_MAX_ATT_MTU) +-#define CFG_BLE_PREPARE_WRITE_LIST_SIZE (0x3A) ++#ifndef CFG_BLE_PREPARE_WRITE_LIST_SIZE ++ #define CFG_BLE_PREPARE_WRITE_LIST_SIZE (0x3A) ++#endif + + /** + * Number of allocated memory blocks +@@ -185,12 +215,16 @@ + /** + * Enable or disable the Extended Packet length feature. Valid values are 0 or 1. + */ +-#define CFG_BLE_DATA_LENGTH_EXTENSION 1 ++#ifndef CFG_BLE_DATA_LENGTH_EXTENSION ++ #define CFG_BLE_DATA_LENGTH_EXTENSION 1 ++#endif + + /** + * Sleep clock accuracy in Slave mode (ppm value) + */ +-#define CFG_BLE_SLAVE_SCA 500 ++#ifndef CFG_BLE_SLAVE_SCA ++ #define CFG_BLE_SLAVE_SCA 500 ++#endif + + /** + * Sleep clock accuracy in Master mode +@@ -203,7 +237,9 @@ + * 6 : 21 ppm to 30 ppm + * 7 : 0 ppm to 20 ppm + */ +-#define CFG_BLE_MASTER_SCA 0 ++#ifndef CFG_BLE_MASTER_SCA ++ #define CFG_BLE_MASTER_SCA 0 ++#endif + + /** + * LsSource +@@ -212,21 +248,27 @@ + * - bit 1: 1: STM32WB5M Module device 0: Other devices as STM32WBxx SOC, STM32WB1M module + * - bit 2: 1: HSE/1024 Clock config 0: LSE Clock config + */ +-#if defined(STM32WB5Mxx) +- #define CFG_BLE_LS_SOURCE (SHCI_C2_BLE_INIT_CFG_BLE_LS_NOCALIB | SHCI_C2_BLE_INIT_CFG_BLE_LS_MOD5MM_DEV | SHCI_C2_BLE_INIT_CFG_BLE_LS_CLK_LSE) +-#else +- #define CFG_BLE_LS_SOURCE (SHCI_C2_BLE_INIT_CFG_BLE_LS_NOCALIB | SHCI_C2_BLE_INIT_CFG_BLE_LS_OTHER_DEV | SHCI_C2_BLE_INIT_CFG_BLE_LS_CLK_LSE) ++#ifndef CFG_BLE_LS_SOURCE ++ #if defined(STM32WB5Mxx) ++ #define CFG_BLE_LS_SOURCE (SHCI_C2_BLE_INIT_CFG_BLE_LS_NOCALIB | SHCI_C2_BLE_INIT_CFG_BLE_LS_MOD5MM_DEV | SHCI_C2_BLE_INIT_CFG_BLE_LS_CLK_LSE) ++ #else ++ #define CFG_BLE_LS_SOURCE (SHCI_C2_BLE_INIT_CFG_BLE_LS_NOCALIB | SHCI_C2_BLE_INIT_CFG_BLE_LS_OTHER_DEV | SHCI_C2_BLE_INIT_CFG_BLE_LS_CLK_LSE) ++ #endif + #endif + + /** + * Start up time of the high speed (16 or 32 MHz) crystal oscillator in units of 625/256 us (~2.44 us) + */ +-#define CFG_BLE_HSE_STARTUP_TIME 0x148 ++#ifndef CFG_BLE_HSE_STARTUP_TIME ++ #define CFG_BLE_HSE_STARTUP_TIME 0x148 ++#endif + + /** + * Maximum duration of the connection event when the device is in Slave mode in units of 625/256 us (~2.44 us) + */ +-#define CFG_BLE_MAX_CONN_EVENT_LENGTH (0xFFFFFFFF) ++#ifndef CFG_BLE_MAX_CONN_EVENT_LENGTH ++ #define CFG_BLE_MAX_CONN_EVENT_LENGTH (0xFFFFFFFF) ++#endif + + /** + * Viterbi Mode +@@ -314,7 +356,11 @@ + * This parameter is considered by the CPU2 when CFG_BLE_OPTIONS has SHCI_C2_BLE_INIT_OPTIONS_EXT_ADV flag set + */ + +-#define CFG_BLE_MAX_ADV_SET_NBR (8) ++#if defined(STM32WB15xx) ++ #define CFG_BLE_MAX_ADV_SET_NBR (3) ++#else ++ #define CFG_BLE_MAX_ADV_SET_NBR (8) ++#endif + + /* Maximum advertising data length (in bytes) + * Range: 31 .. 1650 with limitation: +@@ -323,7 +369,11 @@ + * This parameter is considered by the CPU2 when CFG_BLE_OPTIONS has SHCI_C2_BLE_INIT_OPTIONS_EXT_ADV flag set + */ + +-#define CFG_BLE_MAX_ADV_DATA_LEN (207) ++#if defined(STM32WB15xx) ++ #define CFG_BLE_MAX_ADV_DATA_LEN (414) ++#else ++ #define CFG_BLE_MAX_ADV_DATA_LEN (207) ++#endif + + /* RF TX Path Compensation Value (16-bit signed integer). Units: 0.1 dB. + * Range: -1280 .. 1280 +-- +2.38.0.windows.1 + diff --git a/extras/STM32Cube_FW/0004-fix-TL_Evt_t-payload-size-for-reset.patch b/extras/STM32Cube_FW/0004-fix-TL_Evt_t-payload-size-for-reset.patch new file mode 100644 index 00000000..c239749f --- /dev/null +++ b/extras/STM32Cube_FW/0004-fix-TL_Evt_t-payload-size-for-reset.patch @@ -0,0 +1,30 @@ +From b294edcaee311c15dfb307ea1298ae88b16a92bf Mon Sep 17 00:00:00 2001 +From: Frederic Pillon +Date: Mon, 24 Jul 2023 10:55:20 +0200 +Subject: [PATCH 4/4] fix: TL_Evt_t payload size for reset + +Within STM32CubeWB v1.17.0 update TL_Evt_t payload size was reduced. +This produce a warning -Warray-bounds due to the reset management +which require 4 bytes. + +Signed-off-by: Frederic Pillon +--- + src/utility/STM32Cube_FW/tl.h | 2 +- + 1 file changed, 1 insertion(+), 1 deletion(-) + +diff --git a/src/utility/STM32Cube_FW/tl.h b/src/utility/STM32Cube_FW/tl.h +index 8e8c6cb..7452087 100644 +--- a/src/utility/STM32Cube_FW/tl.h ++++ b/src/utility/STM32Cube_FW/tl.h +@@ -108,7 +108,7 @@ typedef PACKED_STRUCT + { + uint8_t evtcode; + uint8_t plen; +- uint8_t payload[2]; ++ uint8_t payload[4]; + } TL_Evt_t; + + typedef PACKED_STRUCT +-- +2.38.0.windows.1 + diff --git a/keywords.txt b/keywords.txt index effdfbca..4f5bed56 100644 --- a/keywords.txt +++ b/keywords.txt @@ -1,13 +1,12 @@ ####################################### -# Syntax Coloring Map For ArduinoBLE +# Syntax Coloring Map For STM32duinoBLE ####################################### ####################################### # Datatypes (KEYWORD1) ####################################### -ArduinoBLE KEYWORD1 -BLE KEYWORD1 +STM32duinoBLE KEYWORD1 BLEDevice KEYWORD1 BLECharacteristic KEYWORD1 @@ -30,6 +29,9 @@ BLEFloatCharacteristic KEYWORD1 BLEDoubleCharacteristic KEYWORD1 BLEStringCharacteristic KEYWORD1 +HCISpiTransportClass KEYWORD1 +HCITransportInterface KEYWORD1 + ####################################### # Methods and Functions (KEYWORD2) ####################################### @@ -83,6 +85,7 @@ debug KEYWORD2 noDebug KEYWORD2 pairable KEYWORD2 paired KEYWORD2 +setTransport KEYWORD2 properties KEYWORD2 valueSize KEYWORD2 @@ -114,7 +117,11 @@ setValueBE KEYWORD2 valueBE KEYWORD2 uuid KEYWORD2 -addCharacteristic KEYWORD +addCharacteristic KEYWORD2 + +wait KEYWORD2 +peek KEYWORD2 +write KEYWORD2 ####################################### # Constants (LITERAL1) @@ -134,5 +141,10 @@ BLEIndicate LITERAL1 BLESubscribed LITERAL1 BLEUnsubscribed LITERAL1 BLEWritten LITERAL1 -BLEUpdated LITERAL1 +BLEUpdated LITERAL1 +SPBTLE_RF LITERAL1 +SPBTLE_1S LITERAL1 +BLUENRG_M2SP LITERAL1 +BLUENRG_LP LITERAL1 +BLEChip_t LITERAL1 diff --git a/library.properties b/library.properties index 5f238fde..35083868 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ -name=ArduinoBLE -version=1.3.6 -author=Arduino -maintainer=Arduino -sentence=Enables Bluetooth® Low Energy connectivity on the Arduino MKR WiFi 1010, Arduino UNO WiFi Rev.2, Arduino Nano 33 IoT, Arduino Nano 33 BLE, Nicla Sense ME and UNO R4 WiFi. -paragraph=This library supports creating a Bluetooth® Low Energy peripheral & central mode. +name=STM32duinoBLE +version=1.2.5 +author=Arduino, SRA +maintainer=stm32duino +sentence=Fork of ArduinoBLE library to add the support of STM32WB, SPBTLE-RF, SPBTLE-1S, BLUENRG-M2SP and BLUENRG-M0 BLE modules. +paragraph=This library supports creating a BLE peripheral and BLE central mode. category=Communication -url=https://www.arduino.cc/en/Reference/ArduinoBLE -architectures=samd,megaavr,mbed,apollo3,mbed_nano,mbed_portenta,mbed_nicla,esp32,mbed_giga,renesas,renesas_portenta,mbed_opta,renesas_uno -includes=ArduinoBLE.h +url=https://github.com/stm32duino/STM32duinoBLE +architectures=stm32 +includes=STM32duinoBLE.h diff --git a/src/ArduinoBLE.h b/src/STM32duinoBLE.h similarity index 85% rename from src/ArduinoBLE.h rename to src/STM32duinoBLE.h index 588d5cb1..4ad826bc 100644 --- a/src/ArduinoBLE.h +++ b/src/STM32duinoBLE.h @@ -17,8 +17,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ -#ifndef _ARDUINO_BLE_H_ -#define _ARDUINO_BLE_H_ +#ifndef _STM32DUINO_BLE_H_ +#define _STM32DUINO_BLE_H_ #include "local/BLELocalDevice.h" #include "BLEProperty.h" @@ -26,4 +26,9 @@ #include "BLETypedCharacteristics.h" #include "utility/btct.h" +#if defined(STM32WBxx) +#include "utility/HCISharedMemTransport.h" +#endif +#include "utility/HCISpiTransport.h" + #endif diff --git a/src/local/BLELocalDevice.cpp b/src/local/BLELocalDevice.cpp index 146d99b9..7b9e876a 100644 --- a/src/local/BLELocalDevice.cpp +++ b/src/local/BLELocalDevice.cpp @@ -18,28 +18,14 @@ */ #include "utility/ATT.h" -#include "utility/HCI.h" #include "utility/GAP.h" #include "utility/GATT.h" #include "utility/L2CAPSignaling.h" #include "BLELocalDevice.h" -#if defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_OPTA) -#ifndef BT_REG_ON -#define BT_REG_ON PJ_12 -#endif -#elif defined(ARDUINO_NICLA_VISION) -#ifndef BT_REG_ON -#define BT_REG_ON PF_14 -#endif -#elif defined(ARDUINO_GIGA) -#ifndef BT_REG_ON -#define BT_REG_ON PA_10 -#endif -#endif - -BLELocalDevice::BLELocalDevice() +BLELocalDevice::BLELocalDevice(HCITransportInterface *HCITransport, uint8_t ownBdaddrType) : + _HCITransport(HCITransport), _ownBdaddrType(ownBdaddrType) { _advertisingData.setFlags(BLEFlagsGeneralDiscoverable | BLEFlagsBREDRNotSupported); } @@ -50,63 +36,7 @@ BLELocalDevice::~BLELocalDevice() int BLELocalDevice::begin() { -#if defined(ARDUINO_SAMD_MKRWIFI1010) || defined(ARDUINO_AVR_UNO_WIFI_REV2) || defined(ARDUINO_SAMD_NANO_33_IOT) || defined(ARDUINO_NANO_RP2040_CONNECT) - // reset the NINA in BLE mode - pinMode(SPIWIFI_SS, OUTPUT); - pinMode(NINA_RESETN, OUTPUT); - - digitalWrite(SPIWIFI_SS, LOW); -#endif - -#if defined(ARDUINO_SAMD_MKRWIFI1010) || defined(ARDUINO_AVR_UNO_WIFI_REV2) - digitalWrite(NINA_RESETN, HIGH); - delay(100); - digitalWrite(NINA_RESETN, LOW); - delay(750); -#elif defined(ARDUINO_SAMD_NANO_33_IOT) || defined(ARDUINO_NANO_RP2040_CONNECT) - // inverted reset - digitalWrite(NINA_RESETN, LOW); - delay(100); - digitalWrite(NINA_RESETN, HIGH); - delay(750); -#elif defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_GIGA) || defined(ARDUINO_OPTA) - // BT_REG_ON -> HIGH - pinMode(BT_REG_ON, OUTPUT); - digitalWrite(BT_REG_ON, HIGH); -#elif defined(ARDUINO_PORTENTA_C33) -#define NINA_GPIO0 (100) -#define NINA_RESETN (101) - pinMode(NINA_GPIO0, OUTPUT); - pinMode(NINA_RESETN, OUTPUT); - Serial5.begin(921600); - - digitalWrite(NINA_GPIO0, HIGH); - delay(100); - digitalWrite(NINA_RESETN, HIGH); - digitalWrite(NINA_RESETN, LOW); - digitalWrite(NINA_RESETN, HIGH); - auto _start = millis(); - while (millis() - _start < 500) { - if (Serial5.available()) { - Serial5.read(); - } - } - //pinMode(94, OUTPUT); - //digitalWrite(94, LOW); -#endif - - -#ifdef ARDUINO_AVR_UNO_WIFI_REV2 - // set SS HIGH - digitalWrite(SPIWIFI_SS, HIGH); - - // set RTS HIGH - pinMode(NINA_RTS, OUTPUT); - digitalWrite(NINA_RTS, HIGH); - - // set CTS as input - pinMode(NINA_CTS, INPUT); -#endif + HCI.setTransport(_HCITransport); if (!HCI.begin()) { end(); @@ -121,6 +51,29 @@ int BLELocalDevice::begin() return 0; } + uint8_t randomNumber[8]; + if (HCI.leRand(randomNumber) != 0) { + end(); + return 0; + } + /* Random address only requires 6 bytes (48 bits) + * Force both MSB bits to b00 in order to define Static Random Address + */ + randomNumber[5] |= 0xC0; + + // Copy the random address in private variable as it will be sent to the BLE chip + randomAddress [0] = randomNumber[0]; + randomAddress [1] = randomNumber[1]; + randomAddress [2] = randomNumber[2]; + randomAddress [3] = randomNumber[3]; + randomAddress [4] = randomNumber[4]; + randomAddress [5] = randomNumber[5]; + + if (HCI.leSetRandomAddress((uint8_t*)randomNumber) != 0) { + end(); + return 0; + } + uint8_t hciVer; uint16_t hciRev; uint8_t lmpVer; @@ -204,6 +157,10 @@ int BLELocalDevice::begin() GATT.begin(); + GAP.setOwnBdaddrType(_ownBdaddrType); + + ATT.setOwnBdaddrType(_ownBdaddrType); + return 1; } @@ -212,16 +169,16 @@ void BLELocalDevice::end() GATT.end(); HCI.end(); +} -#if defined(ARDUINO_SAMD_MKRWIFI1010) || defined(ARDUINO_AVR_UNO_WIFI_REV2) - // disable the NINA - digitalWrite(NINA_RESETN, HIGH); -#elif defined(ARDUINO_SAMD_NANO_33_IOT) || defined(ARDUINO_NANO_RP2040_CONNECT) - // disable the NINA - digitalWrite(NINA_RESETN, LOW); -#elif defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_GIGA) || defined(ARDUINO_OPTA) - digitalWrite(BT_REG_ON, LOW); -#endif +void BLELocalDevice::getRandomAddress(uint8_t buff[6]) +{ + buff [0] = randomAddress[0]; + buff [1] = randomAddress[1]; + buff [2] = randomAddress[2]; + buff [3] = randomAddress[3]; + buff [4] = randomAddress[4]; + buff [5] = randomAddress[5]; } void BLELocalDevice::poll() @@ -379,9 +336,9 @@ int BLELocalDevice::scanForAddress(String address, bool withDuplicates) return GAP.scanForAddress(address, withDuplicates); } -void BLELocalDevice::stopScan() +int BLELocalDevice::stopScan() { - GAP.stopScan(); + return GAP.stopScan(); } BLEDevice BLELocalDevice::central() @@ -477,8 +434,3 @@ void BLELocalDevice::noDebug() { HCI.noDebug(); } - -#if !defined(FAKE_BLELOCALDEVICE) -BLELocalDevice BLEObj; -BLELocalDevice& BLE = BLEObj; -#endif diff --git a/src/local/BLELocalDevice.h b/src/local/BLELocalDevice.h index 6c45c063..dd114eb4 100644 --- a/src/local/BLELocalDevice.h +++ b/src/local/BLELocalDevice.h @@ -20,6 +20,7 @@ #ifndef _BLE_LOCAL_DEVICE_H_ #define _BLE_LOCAL_DEVICE_H_ +#include "utility/HCI.h" #include "BLEDevice.h" #include "BLEService.h" #include "BLEAdvertisingData.h" @@ -29,10 +30,14 @@ enum Pairable { YES = 1, ONCE = 2, }; +#define PUBLIC_ADDR (0) +#define STATIC_RANDOM_ADDR (1) +#define RESOLVABLE_PRIVATE_ADDR (2) +#define NON_RESOLVABLE_PRIVATE_ADDR (3) class BLELocalDevice { public: - BLELocalDevice(); + BLELocalDevice(HCITransportInterface *HCITransport, uint8_t ownBdaddrType = STATIC_RANDOM_ADDR); virtual ~BLELocalDevice(); virtual int begin(); @@ -70,7 +75,7 @@ class BLELocalDevice { virtual int scanForName(String name, bool withDuplicates = false); virtual int scanForUuid(String uuid, bool withDuplicates = false); virtual int scanForAddress(String address, bool withDuplicates = false); - virtual void stopScan(); + virtual int stopScan(); virtual BLEDevice central(); virtual BLEDevice available(); @@ -84,6 +89,8 @@ class BLELocalDevice { virtual void setTimeout(unsigned long timeout); + virtual void getRandomAddress(uint8_t buff[6]); + virtual void debug(Stream& stream); virtual void noDebug(); @@ -114,8 +121,11 @@ class BLELocalDevice { virtual BLEAdvertisingData& getScanResponseData(); private: + uint8_t randomAddress[6]; + HCITransportInterface *_HCITransport; BLEAdvertisingData _advertisingData; BLEAdvertisingData _scanResponseData; + uint8_t _ownBdaddrType; }; extern BLELocalDevice& BLE; diff --git a/src/utility/ATT.cpp b/src/utility/ATT.cpp index acdf5a9f..0ff92a84 100644 --- a/src/utility/ATT.cpp +++ b/src/utility/ATT.cpp @@ -112,7 +112,7 @@ ATTClass::~ATTClass() bool ATTClass::connect(uint8_t peerBdaddrType, uint8_t peerBdaddr[6]) { - if (HCI.leCreateConn(0x0060, 0x0030, 0x00, peerBdaddrType, peerBdaddr, 0x00, + if (HCI.leCreateConn(0x0060, 0x0030, 0x00, peerBdaddrType, peerBdaddr, _ownBdaddrType, 0x0006, 0x000c, 0x0000, 0x00c8, 0x0004, 0x0006) != 0) { return false; } @@ -1936,6 +1936,9 @@ int ATTClass::getPeerResolvedAddress(uint16_t connectionHandle, uint8_t resolved return 1; } return 0; +void ATTClass::setOwnBdaddrType(uint8_t ownBdaddrType) +{ + _ownBdaddrType = ownBdaddrType; } #if !defined(FAKE_ATT) diff --git a/src/utility/ATT.h b/src/utility/ATT.h index c9f007f9..e061a68b 100644 --- a/src/utility/ATT.h +++ b/src/utility/ATT.h @@ -109,6 +109,9 @@ class ATTClass { uint8_t peerIRK[16]; /// This is just a random number... Not sure it has use unless privacy mode is active. uint8_t localIRK[16] = {0x54,0x83,0x63,0x7c,0xc5,0x1e,0xf7,0xec,0x32,0xdd,0xad,0x51,0x89,0x4b,0x9e,0x07}; + + void setOwnBdaddrType(uint8_t ownBdaddrType); + private: virtual void error(uint16_t connectionHandle, uint8_t dlen, uint8_t data[]); virtual void mtuReq(uint16_t connectionHandle, uint8_t dlen, uint8_t data[]); @@ -170,6 +173,8 @@ class ATTClass { } _pendingResp; BLEDeviceEventHandler _eventHandlers[2]; + + uint8_t _ownBdaddrType; }; extern ATTClass& ATT; diff --git a/src/utility/GAP.cpp b/src/utility/GAP.cpp index f1bf02fe..695b1c99 100644 --- a/src/utility/GAP.cpp +++ b/src/utility/GAP.cpp @@ -54,7 +54,7 @@ int GAPClass::advertise(uint8_t* advData, uint8_t advDataLen, uint8_t* scanData, stopAdvertise(); - if (HCI.leSetAdvertisingParameters(_advertisingInterval, _advertisingInterval, type, 0x00, 0x00, directBdaddr, 0x07, 0) != 0) { + if (HCI.leSetAdvertisingParameters(_advertisingInterval, _advertisingInterval, type, _ownBdaddrType, 0x00, directBdaddr, 0x07, 0) != 0) { return 0; } @@ -84,16 +84,15 @@ void GAPClass::stopAdvertise() int GAPClass::scan(bool withDuplicates) { - HCI.leSetScanEnable(false, true); - - // active scan, 20 ms scan interval (N * 0.625), 20 ms scan window (N * 0.625), public own address type, no filter - /* - Warning (from BLUETOOTH SPECIFICATION 5.x): - - scan interval: mandatory range from 0x0012 to 0x1000; only even values are valid - - scan window: mandatory range from 0x0011 to 0x1000 - - The scan window can only be less than or equal to the scan interval - */ - if (HCI.leSetScanParameters(0x01, 0x0020, 0x0020, 0x00, 0x00) != 0) { + if(_scanning) { + // Check if the HCI command fails + if (HCI.leSetScanEnable(false, true) != 0) { + return 0; + } + } + + // active scan, 10 ms scan interval (N * 0.625), 10 ms scan window (N * 0.625), public or static random own address type, no filter + if (HCI.leSetScanParameters(0x01, 0x0010, 0x0010, _ownBdaddrType, 0x00) != 0) { return false; } @@ -133,9 +132,14 @@ int GAPClass::scanForAddress(String address, bool withDuplicates) return scan(withDuplicates); } -void GAPClass::stopScan() +int GAPClass::stopScan() { - HCI.leSetScanEnable(false, false); + if(_scanning) { + // Check if the HCI command fails + if (HCI.leSetScanEnable(false, false) != 0) { + return 0; + } + } _scanning = false; @@ -146,6 +150,8 @@ void GAPClass::stopScan() } _discoveredDevices.clear(); + + return 1; } BLEDevice GAPClass::available() @@ -266,6 +272,11 @@ bool GAPClass::matchesScanFilter(const BLEDevice& device) return true; } +void GAPClass::setOwnBdaddrType(uint8_t ownBdaddrType) +{ + _ownBdaddrType = ownBdaddrType; +} + #if !defined(FAKE_GAP) GAPClass GAPObj; GAPClass& GAP = GAPObj; diff --git a/src/utility/GAP.h b/src/utility/GAP.h index 2ea22938..c79a2aa7 100644 --- a/src/utility/GAP.h +++ b/src/utility/GAP.h @@ -37,7 +37,7 @@ class GAPClass { virtual int scanForName(String name, bool withDuplicates); virtual int scanForUuid(String uuid, bool withDuplicates); virtual int scanForAddress(String address, bool withDuplicates); - virtual void stopScan(); + virtual int stopScan(); virtual BLEDevice available(); virtual void setAdvertisingInterval(uint16_t advertisingInterval); @@ -45,6 +45,8 @@ class GAPClass { virtual void setEventHandler(BLEDeviceEvent event, BLEDeviceEventHandler eventHandler); + void setOwnBdaddrType(uint8_t ownBdaddrType); + protected: friend class HCIClass; @@ -67,6 +69,7 @@ class GAPClass { String _scanNameFilter; String _scanUuidFilter; String _scanAddressFilter; + uint8_t _ownBdaddrType; }; extern GAPClass& GAP; diff --git a/src/utility/HCI.cpp b/src/utility/HCI.cpp index e9743758..c351c21c 100644 --- a/src/utility/HCI.cpp +++ b/src/utility/HCI.cpp @@ -19,7 +19,6 @@ #include "ATT.h" #include "GAP.h" -#include "HCITransport.h" #include "L2CAPSignaling.h" #include "btct.h" #include "HCI.h" @@ -71,6 +70,7 @@ #define OCF_LE_CREATE_CONN 0x000d #define OCF_LE_CANCEL_CONN 0x000e #define OCF_LE_CONN_UPDATE 0x0013 +#define OCF_LE_RAND 0x0018 #define HCI_OE_USER_ENDED_CONNECTION 0x13 @@ -100,8 +100,10 @@ String commandToString(LE_COMMAND command){ HCIClass::HCIClass() : _debug(NULL), _recvIndex(0), - _pendingPkt(0) + _pendingPkt(0), + _HCITransport(0) { + } HCIClass::~HCIClass() @@ -112,12 +114,12 @@ int HCIClass::begin() { _recvIndex = 0; - return HCITransport.begin(); + return _HCITransport->begin(); } void HCIClass::end() { - HCITransport.end(); + _HCITransport->end(); } void HCIClass::poll() @@ -127,16 +129,12 @@ void HCIClass::poll() void HCIClass::poll(unsigned long timeout) { -#ifdef ARDUINO_AVR_UNO_WIFI_REV2 - digitalWrite(NINA_RTS, LOW); -#endif - if (timeout) { - HCITransport.wait(timeout); + _HCITransport->wait(timeout); } - while (HCITransport.available()) { - byte b = HCITransport.read(); + while (_HCITransport->available()) { + byte b = _HCITransport->read(); if (_recvIndex >= sizeof(_recvBuffer)) { _recvIndex = 0; @@ -152,35 +150,23 @@ void HCIClass::poll(unsigned long timeout) if (_debug) { dumpPkt("HCI ACLDATA RX <- ", _recvIndex, _recvBuffer); } -#ifdef ARDUINO_AVR_UNO_WIFI_REV2 - digitalWrite(NINA_RTS, HIGH); -#endif + int pktLen = _recvIndex - 1; _recvIndex = 0; handleAclDataPkt(pktLen, &_recvBuffer[1]); - -#ifdef ARDUINO_AVR_UNO_WIFI_REV2 - digitalWrite(NINA_RTS, LOW); -#endif } } else if (_recvBuffer[0] == HCI_EVENT_PKT) { if (_recvIndex > 3 && _recvIndex >= (3 + _recvBuffer[2])) { if (_debug) { dumpPkt("HCI EVENT RX <- ", _recvIndex, _recvBuffer); } -#ifdef ARDUINO_AVR_UNO_WIFI_REV2 - digitalWrite(NINA_RTS, HIGH); -#endif + // received full event int pktLen = _recvIndex - 1; _recvIndex = 0; handleEventPkt(pktLen, &_recvBuffer[1]); - -#ifdef ARDUINO_AVR_UNO_WIFI_REV2 - digitalWrite(NINA_RTS, LOW); -#endif } } else { _recvIndex = 0; @@ -190,10 +176,6 @@ void HCIClass::poll(unsigned long timeout) } } } - -#ifdef ARDUINO_AVR_UNO_WIFI_REV2 - digitalWrite(NINA_RTS, HIGH); -#endif } int HCIClass::reset() @@ -288,9 +270,7 @@ int HCIClass::readLeBufferSize(uint16_t& pktLen, uint8_t& maxPkt) pktLen = leBufferSize->pktLen; _maxPkt = maxPkt = leBufferSize->maxPkt; -#ifndef __AVR__ ATT.setMaxMtu(pktLen - 9); // max pkt len - ACL header size -#endif } return result; @@ -612,6 +592,17 @@ int HCIClass::tryResolveAddress(uint8_t* BDAddr, uint8_t* address){ return 0; } +int HCIClass::leRand(uint8_t randomNumber[8]) +{ + int result = sendCommand(OGF_LE_CTL << 10 | OCF_LE_RAND); + + if (result == 0) { + memcpy(randomNumber, _cmdResponse, 8); + } + + return result; +} + int HCIClass::sendAclPkt(uint16_t handle, uint8_t cid, uint8_t plen, void* data) { while (_pendingPkt >= _maxPkt) { @@ -643,7 +634,7 @@ int HCIClass::sendAclPkt(uint16_t handle, uint8_t cid, uint8_t plen, void* data) #endif _pendingPkt++; - HCITransport.write(txBuffer, sizeof(aclHdr) + plen); + _HCITransport->write(txBuffer, sizeof(aclHdr) + plen); return 0; } @@ -692,7 +683,8 @@ int HCIClass::sendCommand(uint16_t opcode, uint8_t plen, void* parameters) } Serial.println(""); #endif - HCITransport.write(txBuffer, sizeof(pktHdr) + plen); + + _HCITransport->write(txBuffer, sizeof(pktHdr) + plen); _cmdCompleteOpcode = 0xffff; _cmdCompleteStatus = -1; @@ -821,7 +813,10 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) ATT.removeConnection(disconnComplete->handle, disconnComplete->reason); L2CAPSignaling.removeConnection(disconnComplete->handle, disconnComplete->reason); - HCI.leSetAdvertiseEnable(0x01); + if (GAP.advertising()) + { + HCI.leSetAdvertiseEnable(0x01); + } } else if (eventHdr->evt == EVT_ENCRYPTION_CHANGE) { @@ -907,9 +902,9 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) }else{ ATT.setPeerEncryption(encryptionChange->connectionHandle, PEER_ENCRYPTION::NO_ENCRYPTION); } - } - else if (eventHdr->evt == EVT_CMD_COMPLETE) - { + + + } else if (eventHdr->evt == EVT_CMD_COMPLETE) { struct __attribute__ ((packed)) CmdComplete { uint8_t ncmd; uint16_t opcode; @@ -1481,6 +1476,11 @@ void HCIClass::dumpPkt(const char* prefix, uint8_t plen, uint8_t pdata[]) } } +void HCIClass::setTransport(HCITransportInterface *HCITransport) +{ + _HCITransport = HCITransport; +} + #if !defined(FAKE_HCI) HCIClass HCIObj; HCIClass& HCI = HCIObj; diff --git a/src/utility/HCI.h b/src/utility/HCI.h index 0a530ceb..cb6170b6 100644 --- a/src/utility/HCI.h +++ b/src/utility/HCI.h @@ -22,7 +22,7 @@ #include #include "bitDescriptions.h" - +#include "HCITransport.h" #include "L2CAPSignaling.h" #define OGF_LINK_CTL 0x01 @@ -118,6 +118,9 @@ class HCIClass { virtual void noDebug(); // TODO: Send command be private again & use ATT implementation of send command within ATT. + void setTransport(HCITransportInterface *HCITransport); + +private: virtual int sendCommand(uint16_t opcode, uint8_t plen = 0, void* parameters = NULL); uint8_t remotePublicKeyBuffer[64]; uint8_t localPublicKeyBuffer[64]; @@ -159,6 +162,8 @@ class HCIClass { uint8_t _pendingPkt; uint8_t _aclPktBuffer[255]; + + HCITransportInterface *_HCITransport; }; extern HCIClass& HCI; diff --git a/src/utility/HCICordioTransport.h b/src/utility/HCICordioTransport.h deleted file mode 100644 index b8d0596a..00000000 --- a/src/utility/HCICordioTransport.h +++ /dev/null @@ -1,54 +0,0 @@ -/* - This file is part of the ArduinoBLE library. - Copyright (c) 2019 Arduino SA. All rights reserved. - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -*/ - -#ifndef _HCI_CORDIO_TRANSPORT_H_ -#define _HCI_CORDIO_TRANSPORT_H_ - -#include - -#include "api/RingBuffer.h" - -#include "HCITransport.h" - -class HCICordioTransportClass : public HCITransportInterface { -public: - HCICordioTransportClass(); - virtual ~HCICordioTransportClass(); - - virtual int begin(); - virtual void end(); - - virtual void wait(unsigned long timeout); - - virtual int available(); - virtual int peek(); - virtual int read(); - - virtual size_t write(const uint8_t* data, size_t length); - -private: - static void onDataReceived(uint8_t* data, uint8_t len); - void handleRxData(uint8_t* data, uint8_t len); - -private: - bool _begun; - RingBufferN<256> _rxBuf; -}; - -#endif diff --git a/src/utility/HCISharedMemTransport.cpp b/src/utility/HCISharedMemTransport.cpp new file mode 100644 index 00000000..0db95041 --- /dev/null +++ b/src/utility/HCISharedMemTransport.cpp @@ -0,0 +1,774 @@ +/* + This file is part of the STM32duinoBLE library. + Copyright (c) 2019 STMicroelectronics. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ +#if defined(STM32WBxx) + +#include "HCISharedMemTransport.h" +#include "STM32Cube_FW/hw.h" +#include "otp.h" + +/* Private variables ---------------------------------------------------------*/ +PLACE_IN_SECTION("MB_MEM1") ALIGN(4) static TL_CmdPacket_t BleCmdBuffer; + +PLACE_IN_SECTION("MB_MEM1") ALIGN(4) static uint8_t EvtPool[POOL_SIZE]; +PLACE_IN_SECTION("MB_MEM2") ALIGN(4) static TL_CmdPacket_t SystemCmdBuffer; +PLACE_IN_SECTION("MB_MEM2") ALIGN(4) static uint8_t +SystemSpareEvtBuffer[sizeof(TL_PacketHeader_t) + TL_EVT_HDR_SIZE + 255]; +PLACE_IN_SECTION("MB_MEM2") ALIGN(4) static uint8_t +BleSpareEvtBuffer[sizeof(TL_PacketHeader_t) + TL_EVT_HDR_SIZE + 255]; +PLACE_IN_SECTION("MB_MEM2") ALIGN(4) static uint8_t +HciAclDataBuffer[sizeof(TL_PacketHeader_t) + 5 + 251]; + + +/* global var used as semaphore to control incoming events */ +volatile bool sys_event; /* true : M0 core is already up and running */ +volatile bool acl_data_on; /* true : sending ACL data in progress, false : send is possible */ +volatile bool data_overflow; + +/* buffer to store the received packets */ +volatile uint8_t _rxbuff[BLE_MODULE_SHARED_MEM_BUFFER_SIZE]; +volatile uint16_t _read_index; /* fifo position when reading */ +volatile uint16_t _write_index; /* fifo position when receiving */ + +/* var of different device steps during init and receiving */ +volatile bool phase_bd_addr; +volatile bool phase_tx_power; +volatile bool phase_reset; +volatile bool phase_running; + + +/** Bluetooth Device Address */ +static uint8_t bd_addr_udn[CONFIG_DATA_PUBADDR_LEN]; + +/* Private functions ---------------------------------------------------------*/ +/** + * TL Mailbox synchronisation means + */ + +/* returns true if sys_event was received, false otherwise */ +static bool sysevt_wait(void) +{ + /* sys_event remains false until event is received */ + for (unsigned long start = millis(); (millis() - start) < BLE_IPCC_TIMEOUT;) { + /* Wait for 10sec max - if not return an error */ + if (sys_event) { + break; + } + } + + if (!sys_event) { +#if defined(PRINT_IPCC_INFO) + printf("ERROR: sys_evt timeout\r\n"); +#endif /*(PRINT_IPCC_INFO)*/ + /* no event received, timeout occurs */ + return false; + } + /* release immediately, now that M0 runs */ + return true; +} + +/* WEAK callbacks from the BLE TL driver - will be called under Interrupt */ +static void sysevt_received(void *pdata) +{ + UNUSED(pdata); + /* For now only READY event is received, so we know this is it */ + __disable_irq(); + sys_event = true; + __enable_irq(); + /* But later on ... we'll have to parse the answer */ +} + +/* returns true if sysevt was already received, which means M0 core is + * already up and running */ +static bool sysevt_check(void) +{ + /* Check if system is UP and running already */ + for (unsigned long start = millis(); (millis() - start) < 10;) { + /* Wait for 10ms max - if not return an error */ + if (sys_event) { + break; + } + } + if (sys_event) { + /* release immediately as M0 already runs */ + return true; + } + return false; +} + +static void acl_data_ack(void) +{ + /** + * The current implementation assumes the taskGUI will not send a new HCI ACL DATA packet before this ack is received + * ( which means the CPU2 has handled the previous packet ) + * In order to implement a secure mechanism, it is required either + * - a flow control with the stack + * - a local pool of buffer to store packets received from the stack + */ + __disable_irq(); + acl_data_on = false; + __enable_irq(); +} + +static bool acl_data_wait(void) +{ + /* Wait 10 sec for previous ACL command to be ack'ed by Low Layers + * before sending the next one */ + for (unsigned long start = millis(); (millis() - start) < BLE_IPCC_TIMEOUT;) { + /* Wait for 10sec max - if not return an error */ + if (!acl_data_on) { + break; + } + } + if (acl_data_on) { + /* no event received, timeout occurs */ +#if defined(PRINT_IPCC_INFO) + printf("ERROR: acl data timeout\r\n"); +#endif /*(PRINT_IPCC_INFO)*/ + return false; + } + /* release immediately, now that M0 runs */ + __disable_irq(); + acl_data_on = false; + __enable_irq(); + return true; +} + +static void syscmd_status_not(SHCI_TL_CmdStatus_t status) +{ +#if defined(PRINT_IPCC_INFO) + printf("syscmd_status_not, status:%d\r\n", status); +#else + UNUSED(status); +#endif /*(PRINT_IPCC_INFO)*/ +} + +/* to received BLE packet from the SharedMem */ +void evt_received(TL_EvtPacket_t *hcievt) +{ + uint16_t len = 0; + + /* We need to memcpy the data before passing to higher layers. + * The received packet is copied in the _rxbuff + * but it must not exceed the BLE_MODULE_SHARED_MEM_BUFFER_SIZE + */ + switch (hcievt->evtserial.type) { + case TL_BLEEVT_PKT_TYPE: { + /* before starting the running_phase', a RESET command (0x0C03) is sent + * by the HCI. Then this evt packet is temporarily kept in the _rxbuff + * the set_bd_address (0xFC0C) and the set_tw_power (0xFC0F) commands are sent. + * Only when both evt are received (not store in the _rxbuffer), + * the Reset packet is handled at HCI layer : the running_phase begins + */ + if (phase_running == false) { + /* check the Rx event of complete the previous bd_addr or random address opcode 0xFC0C */ + if ((hcievt->evtserial.evt.evtcode == TL_BLEEVT_CC_OPCODE) && + (hcievt->evtserial.evt.payload[0] == 0x01) && + (hcievt->evtserial.evt.payload[1] == 0x0C) && + (hcievt->evtserial.evt.payload[2] == 0xFC)) { + /* First setting must be global address + */ + phase_bd_addr = true; + + if (hcievt->evtserial.evt.payload[3] != 0) { +#if defined(PRINT_IPCC_INFO) + printf("Error: wrong BD Addr\r\n"); +#endif /*(PRINT_IPCC_INFO)*/ + } + /* rx data is no more useful : not stored in the _rxbuff */ + break; + } + /* check the Rx event of complete the previous tx power opcode 0xFC0F */ + if ((hcievt->evtserial.evt.evtcode == TL_BLEEVT_CC_OPCODE) && + (hcievt->evtserial.evt.payload[0] == 0x01) && + (hcievt->evtserial.evt.payload[1] == 0x0F) && + (hcievt->evtserial.evt.payload[2] == 0xFC)) { + phase_tx_power = true; + if (hcievt->evtserial.evt.payload[3] != 0) { +#if defined(PRINT_IPCC_INFO) + printf("Error: wrong Tx power\r\n"); +#endif /*(PRINT_IPCC_INFO)*/ + } + /* rx data is no more useful : not stored in the _rxbuff */ + break; + } + + /* check if the reset phase is in progress (opcode is 0x0C03) */ + if ((hcievt->evtserial.evt.evtcode == TL_BLEEVT_CC_OPCODE) && + (hcievt->evtserial.evt.payload[0] == 0x01) && + (hcievt->evtserial.evt.payload[1] == 0x03) && + (hcievt->evtserial.evt.payload[2] == 0x0C)) { + phase_reset = true; +#if defined(PRINT_IPCC_INFO) + if (hcievt->evtserial.evt.payload[3] != 0) { + printf("Error: wrong reset\r\n"); + } +#endif /*(PRINT_IPCC_INFO)*/ + } + } + __disable_irq(); + /* store received data in the _rxbuff buffer */ + len = hcievt->evtserial.evt.plen + TL_EVT_HDR_SIZE; + if (len < BLE_MODULE_SHARED_MEM_BUFFER_SIZE - _write_index) { + /* at the position of the _write_index */ + memcpy((uint8_t *)&_rxbuff[_write_index], (uint8_t *)&hcievt->evtserial, len); + /* move index */ + _write_index += len; + } else { + data_overflow = true; + } + __enable_irq(); + } + break; + case TL_ACL_DATA_PKT_TYPE: { + TL_AclDataSerial_t *acl = &(((TL_AclDataPacket_t *)hcievt)->AclDataSerial); + __disable_irq(); + len = acl->length + 5; + if (len < BLE_MODULE_SHARED_MEM_BUFFER_SIZE - _write_index) { + memcpy((uint8_t *)&_rxbuff[_write_index], (uint8_t *)acl, len); + /* move index */ + _write_index += len; + } else { + data_overflow = true; + } + __enable_irq(); + } + break; + default: + /* should not happen */ +#if defined(PRINT_IPCC_INFO) + printf("BLE TL evt_received, wrong type:%d\r\n", hcievt->evtserial.type); + while (1); /* let's block to check */ +#endif /*(PRINT_IPCC_INFO)*/ + break; + } +#if defined(PRINT_IPCC_INFO) + if (data_overflow) { + printf("Error: data read overflow\r\n"); + } +#endif /*(PRINT_IPCC_INFO)*/ + + /* In case Event belongs to the Evt Pool we need to inform */ + if (((uint8_t *)hcievt >= EvtPool) && ((uint8_t *)hcievt < (EvtPool + POOL_SIZE))) { + /* Free the message from shared memory */ + TL_MM_EvtDone(hcievt); + } +} + +/* to send BLE packet to the SharedMem : return nb of bytes actually written */ +uint16_t mbox_write(uint8_t type, uint16_t len, const uint8_t *pData) +{ + TL_CmdPacket_t *bleCmdBuf = &BleCmdBuffer; + // Note: Until enum is available + // type 01 Command + // type 02 ACL DATA + // type 03 SCO Voice (not supported) + // type 04 event - uplink (not supported) + switch (type) { + case 1: { //BLE command + bleCmdBuf->cmdserial.type = type; // for now this param is overwritten in TL_BLE_SendCmd + bleCmdBuf->cmdserial.cmd.plen = len; + memcpy((void *) &bleCmdBuf->cmdserial.cmd, pData, len); + /* We're tracing here the command, after copy in shared mem but before M0 trigger. */ + TL_BLE_SendCmd(NULL, 0); // unused parameters for now + } + break; + case 2: { //ACL DATA + if (!acl_data_wait()) { +#if defined(PRINT_IPCC_INFO) + printf("ERROR: previous ACL message not ACK'd\r\n"); +#endif /*(PRINT_IPCC_INFO)*/ + /* return number of bytes sent, 0 in this error case */ + return 0; + } + TL_AclDataSerial_t *aclDataSerial = (TL_AclDataSerial_t *)(HciAclDataBuffer + sizeof(TL_PacketHeader_t)); + aclDataSerial->type = type; // for now this param is overwritten in TL_BLE_SendCmd + memcpy(HciAclDataBuffer + sizeof(TL_PacketHeader_t) + sizeof(type), pData, len); + TL_BLE_SendAclData(NULL, 0); // unused parameters for now + __disable_irq(); + acl_data_on = true; /* data being send */ + __enable_irq(); + } + break; + default: +#if defined(PRINT_IPCC_INFO) + printf("ERROR: not supported type\r\n"); +#endif /*(PRINT_IPCC_INFO)*/ + /* return number of bytes sent, 0 in this error case */ + len = 0; + break; + } + return len; +} + +/** + * Few utilities functions + */ +/* This function fills in a BD address table */ +static bool get_bd_address(uint8_t *bd_addr) +{ + uint32_t udn; + uint32_t company_id; + uint32_t device_id; + bool bd_found; + + udn = LL_FLASH_GetUDN(); + + if (udn != 0xFFFFFFFF) { + /* "Found Unique Device Number: %#06x", udn) */ + + company_id = LL_FLASH_GetSTCompanyID(); + device_id = LL_FLASH_GetDeviceID(); + + bd_addr[0] = (uint8_t)(udn & 0x000000FF); + bd_addr[1] = (uint8_t)((udn & 0x0000FF00) >> 8); + bd_addr[2] = (uint8_t)device_id; + bd_addr[3] = (uint8_t)(company_id & 0x000000FF); + bd_addr[4] = (uint8_t)((company_id & 0x0000FF00) >> 8); + bd_addr[5] = (uint8_t)((company_id & 0x00FF0000) >> 16); + + bd_found = true; + } else { + OTP_BT_t *p_otp = (OTP_BT_t *)OTP_Read(0); + if (p_otp) { + memcpy(bd_addr, p_otp->bd_address, CONFIG_DATA_PUBADDR_LEN); + bd_found = true; + } else { + bd_found = false; + } + } + + return bd_found; +} + +static void init_debug(void) +{ + /* In case of debug profile, configure debugger support */ + +#if defined(CONFIG_DEBUG) +#if defined(PRINT_IPCC_INFO) + printf("init_debug ENABLED\r\n"); +#endif /*(PRINT_IPCC_INFO)*/ + /** + * Keep debugger enabled while in any low power mode + */ + HAL_DBGMCU_EnableDBGSleepMode(); + HAL_DBGMCU_EnableDBGStopMode(); + HAL_DBGMCU_EnableDBGStandbyMode(); + + /* Enable debugger: Debug power up request wakeup EXTI line 48 */ + LL_EXTI_EnableIT_32_63(LL_EXTI_LINE_48); + LL_C2_EXTI_EnableIT_32_63(LL_EXTI_LINE_48); + +#endif /* CONFIG_DEBUG */ +} + +/* Class definition ----------------------------------------------------------*/ + +HCISharedMemTransportClass::HCISharedMemTransportClass() +{ + _read_index = 0; /* fifo position when reading */ + _write_index = 0; /* fifo position when receiving */ + + memset((void *)_rxbuff, 0, sizeof(_rxbuff)); + + sys_event = false; + acl_data_on = false; + + data_overflow = false; + + phase_bd_addr = false; + phase_tx_power = false; + phase_reset = false; + phase_running = false; +} + +HCISharedMemTransportClass::~HCISharedMemTransportClass() +{ +} + +int HCISharedMemTransportClass::begin() +{ + int status = 1; + /* clean data Rx variables */ + _read_index = 0; + _write_index = 0; + + memset((void *)_rxbuff, 0, sizeof(_rxbuff)); + + /* Check whether M0 sub-system was started already by + * checking if the system event was already received + * before. If it was not, then go thru all init. */ + if (!sysevt_check()) { + start_ble_rf(); + init_debug(); + /* Take BLE out of reset */ + stm32wb_reset(); + /* "C2 unlocking" */ + transport_init(); + /* At this stage, we got the ready event, + * passed thru TL_SYS_EvtReceived */ + + WirelessFwInfo_t wireless_info_instance; + WirelessFwInfo_t *p_wireless_info = &wireless_info_instance; + SHCI_GetWirelessFwInfo(p_wireless_info); +#if defined(PRINT_IPCC_INFO) + printf("WB copro FW version = %d.%d.%d\r\n", p_wireless_info->VersionMajor, p_wireless_info->VersionMinor, p_wireless_info->VersionSub); +#endif /*(PRINT_IPCC_INFO)*/ + + /* Now start BLE service on firmware side, using Vendor specific + * command on the System Channel + */ + status = stm32wb_start_ble(); + + /* Once reset complete event is received we will need + * to send a few more commands: + * set bd addr with bt_ipm_set_addr(); + * during the HCI rest command */ + } + /* IPM Channel is now open */ +#if defined(PRINT_IPCC_INFO) + printf("IPM Channel Open Completed\r\n"); +#endif /*(PRINT_IPCC_INFO)*/ + + return status; +} + +void HCISharedMemTransportClass::end() +{ + /* M0 sub-system is already on (sys_event) */ + acl_data_on = false; + data_overflow = false; + + /* the HCI RESET command ready to be processed again */ + phase_bd_addr = false; + phase_tx_power = false; + phase_reset = false; + phase_running = false; +} + +void HCISharedMemTransportClass::wait(unsigned long timeout) +{ + for (unsigned long start = millis(); (millis() - start) < timeout;) { + if (available()) { + break; + } + } +} + +int HCISharedMemTransportClass::available() +{ + /* assuming the reset is already achieved, + * the LL-only mode is already configured. */ + + if (_read_index != _write_index) { + return 1; + } else if (data_overflow) { + __disable_irq(); + data_overflow = false; + __enable_irq(); + if (_read_index != _write_index) { + return 1; + } + } + + return 0; +} + +int HCISharedMemTransportClass::peek() +{ + int peek_val = -1; + __disable_irq(); + if (_read_index != _write_index) { + peek_val = _rxbuff[_read_index]; + } + __enable_irq(); + return peek_val; +} + +int HCISharedMemTransportClass::read() +{ + int read_val = -1; + __disable_irq(); + if (_read_index != _write_index) { + read_val = _rxbuff[_read_index]; + _read_index++; + if (_read_index == _write_index) { + /* Reset buffer index */ + _read_index = 0; + _write_index = 0; + } + } + __enable_irq(); + return read_val; +} + +size_t HCISharedMemTransportClass::write(const uint8_t *data, size_t length) +{ + const uint8_t *msg_data; + msg_data = &data[1]; + + /* capture the HCI reset send command opcode = 0x0C03 + * After HCI reset event complete in the evt_received(), + * the bd_addr and tx_power must be sent + * before the phase_running begins. + */ + if (phase_running) { + return mbox_write(data[0], (length - 1), msg_data);; + } + if ((data[1] == 0x03) && (data[2] == 0x0C)) { + phase_reset = false; + + if (mbox_write(data[0], (length - 1), msg_data) != (length - 1)) { + /* Error: no data are written */ + return 0; + } + /* capture event after HCI_RESET */ + while (!phase_reset); + + /* set the bd add */ + if (!bt_ipm_set_addr()) { + /* in case of error, no data are written */ + return 0; + } + /* wait for the Rx complete */ + while (!phase_bd_addr); + /* this sequence is now complete */ + + /* set the Tx power */ + bt_ipm_set_power(); + /* wait for the Rx complete */ + while (!phase_tx_power); + + /* this sequence is now complete */ + phase_running = true; + + return (length - 1); /* mbox_size of the HCI reset command */ + } + return 0; /* Error: no data written */ +} + +//private: +void HCISharedMemTransportClass::start_ble_rf(void) +{ + /* Set the DBP bit in the Power control register 1 (PWR_CR1) */ + LL_PWR_EnableBkUpAccess(); + + /* LSE belongs to the back-up domain, enable access.*/ + while (!LL_PWR_IsEnabledBkUpAccess()) { + /* Wait for Backup domain access */ + } + LL_RCC_ForceBackupDomainReset(); + LL_RCC_ReleaseBackupDomainReset(); + + /* Enable LSE Oscillator (32.768 kHz) */ + LL_RCC_LSE_Enable(); + while (!LL_RCC_LSE_IsReady()) { + /* Wait for LSE ready */ + } + + LL_PWR_DisableBkUpAccess(); + + /* Switch OFF LSI as LSE is the source clock */ + LL_RCC_LSI2_Disable(); +} + +void HCISharedMemTransportClass::stm32wb_reset(void) +{ + // Reset IPCC + LL_AHB3_GRP1_EnableClock(LL_AHB3_GRP1_PERIPH_IPCC); + + LL_C1_IPCC_ClearFlag_CHx( + IPCC, + LL_IPCC_CHANNEL_1 | LL_IPCC_CHANNEL_2 | LL_IPCC_CHANNEL_3 | LL_IPCC_CHANNEL_4 + | LL_IPCC_CHANNEL_5 | LL_IPCC_CHANNEL_6); + + LL_C2_IPCC_ClearFlag_CHx( + IPCC, + LL_IPCC_CHANNEL_1 | LL_IPCC_CHANNEL_2 | LL_IPCC_CHANNEL_3 | LL_IPCC_CHANNEL_4 + | LL_IPCC_CHANNEL_5 | LL_IPCC_CHANNEL_6); + + LL_C1_IPCC_DisableTransmitChannel( + IPCC, + LL_IPCC_CHANNEL_1 | LL_IPCC_CHANNEL_2 | LL_IPCC_CHANNEL_3 | LL_IPCC_CHANNEL_4 + | LL_IPCC_CHANNEL_5 | LL_IPCC_CHANNEL_6); + + LL_C2_IPCC_DisableTransmitChannel( + IPCC, + LL_IPCC_CHANNEL_1 | LL_IPCC_CHANNEL_2 | LL_IPCC_CHANNEL_3 | LL_IPCC_CHANNEL_4 + | LL_IPCC_CHANNEL_5 | LL_IPCC_CHANNEL_6); + + LL_C1_IPCC_DisableReceiveChannel( + IPCC, + LL_IPCC_CHANNEL_1 | LL_IPCC_CHANNEL_2 | LL_IPCC_CHANNEL_3 | LL_IPCC_CHANNEL_4 + | LL_IPCC_CHANNEL_5 | LL_IPCC_CHANNEL_6); + + LL_C2_IPCC_DisableReceiveChannel( + IPCC, + LL_IPCC_CHANNEL_1 | LL_IPCC_CHANNEL_2 | LL_IPCC_CHANNEL_3 | LL_IPCC_CHANNEL_4 + | LL_IPCC_CHANNEL_5 | LL_IPCC_CHANNEL_6); + + /* IPCC default IRQ handlers: IPCC_C1_TX_IRQHandler & IPCC_C1_RX_IRQHandler + * are mapped in the flash mem area, so that NVIC does not need to SetVector + */ +} + +int HCISharedMemTransportClass::stm32wb_start_ble(void) +{ + SHCI_C2_Ble_Init_Cmd_Packet_t ble_init_cmd_packet = { + 0, 0, 0, /**< Header unused */ + 0, /** pBleBufferAddress not used */ + 0, /** BleBufferSize not used */ + CFG_BLE_NUM_GATT_ATTRIBUTES, + CFG_BLE_NUM_GATT_SERVICES, + CFG_BLE_ATT_VALUE_ARRAY_SIZE, + CFG_BLE_NUM_LINK, + CFG_BLE_DATA_LENGTH_EXTENSION, + CFG_BLE_PREPARE_WRITE_LIST_SIZE, + CFG_BLE_MBLOCK_COUNT, + CFG_BLE_MAX_ATT_MTU, + CFG_BLE_SLAVE_SCA, + CFG_BLE_MASTER_SCA, + CFG_BLE_LS_SOURCE, + CFG_BLE_MAX_CONN_EVENT_LENGTH, + CFG_BLE_HSE_STARTUP_TIME, + CFG_BLE_VITERBI_MODE, + CFG_BLE_OPTIONS, + 0, /** TODO Should be read from HW */ + CFG_BLE_MAX_COC_INITIATOR_NBR, + CFG_BLE_MIN_TX_POWER, + CFG_BLE_MAX_TX_POWER, + CFG_BLE_RX_MODEL_CONFIG, + CFG_BLE_MAX_ADV_SET_NBR, + CFG_BLE_MAX_ADV_DATA_LEN, + CFG_BLE_TX_PATH_COMPENS, + CFG_BLE_RX_PATH_COMPENS, + CFG_BLE_CORE_VERSION, + CFG_BLE_OPTIONS_EXT + }; + /** + * Starts the BLE Stack on CPU2 + */ + if (SHCI_C2_BLE_Init(&ble_init_cmd_packet) == SHCI_Success) { + return 1; + } + return 0; +} + +void HCISharedMemTransportClass::transport_init(void) +{ + TL_MM_Config_t tl_mm_config; + TL_BLE_InitConf_t tl_ble_config; + /* STM32WB offers a System Channel HCI interface for + offering system services, with proprietary commands. + System Channel must be used as well for starting up + BLE service so we need to initialize it. */ + SHCI_TL_HciInitConf_t shci_init_config; + + /**< Reference table initialization */ + TL_Init(); + + /**< System channel initialization */ + shci_init_config.p_cmdbuffer = (uint8_t *)&SystemCmdBuffer; + shci_init_config.StatusNotCallBack = syscmd_status_not; + shci_init(sysevt_received, (void *) &shci_init_config); + + /**< Memory Manager channel initialization */ + tl_mm_config.p_BleSpareEvtBuffer = BleSpareEvtBuffer; + tl_mm_config.p_SystemSpareEvtBuffer = SystemSpareEvtBuffer; + tl_mm_config.p_AsynchEvtPool = EvtPool; + tl_mm_config.AsynchEvtPoolSize = POOL_SIZE; + TL_MM_Init(&tl_mm_config); + + TL_Enable(); + + /* At this stage, we'll need to wait for ready event, + * passed thru TL_SYS_EvtReceived */ + if (!sysevt_wait()) { +#if defined(PRINT_IPCC_INFO) + printf("ERROR booting WB controller\r\n"); +#endif /*(PRINT_IPCC_INFO)*/ + } else { + /**< BLE channel initialization */ + tl_ble_config.p_cmdbuffer = (uint8_t *)&BleCmdBuffer; + tl_ble_config.p_AclDataBuffer = HciAclDataBuffer; + tl_ble_config.IoBusEvtCallBack = evt_received; + tl_ble_config.IoBusAclDataTxAck = acl_data_ack; + TL_BLE_Init((void *)&tl_ble_config); + } +} + +int HCISharedMemTransportClass::bt_ipm_set_addr(void) +{ + /* the specific table for set addr is 8 bytes: + * one byte for config_offset + * one byte for length + * 6 bytes for payload */ + uint8_t data[4 + 8]; + + phase_bd_addr = false; + + if (get_bd_address(bd_addr_udn)) { + /* create ACI_HAL_WRITE_CONFIG_DATA */ + + data[0] = BT_BUF_CMD; + data[1] = uint8_t(ACI_WRITE_CONFIG_DATA_OPCODE & 0x000000FF); /* OCF */ + data[2] = uint8_t((ACI_WRITE_CONFIG_DATA_OPCODE & 0x0000FF00) >> 8); /* OGF */ + data[3] = 8; /* length of parameters */ + /* fill the ACI_HAL_WRITE_CONFIG_DATA with the addr*/ + data[4] = CONFIG_DATA_PUBADDR_OFFSET; /* the offset */ + data[5] = 6; /* is the length of the bd_addr table */ + memcpy(data + 6, bd_addr_udn, 6); + /* send the ACI_HAL_WRITE_CONFIG_DATA */ + if (mbox_write(data[0], 11, &data[1]) != 11) { + /* Error: no data are written */ + return 0; + } + /* now wait for the corresponding Rx event */ + return 1; /* success */ + } + return 0; /* Error */ +} + + +int HCISharedMemTransportClass::bt_ipm_set_power(void) +{ + /* the specific table for power is 2 bytes: + * En_High_Power byte, PA_level byte */ + uint8_t data[4 + 2]; + + phase_tx_power = false; + + data[0] = BT_BUF_CMD; /* the type */ + data[1] = (uint8_t)(ACI_HAL_SET_TX_POWER_LEVEL & 0x000000FF); /* the OPCODE */ + data[2] = (uint8_t)((ACI_HAL_SET_TX_POWER_LEVEL & 0x0000FF00) >> 8); + data[3] = 2; /* the length */ + /* fill the SET_POWER */ + data[4] = 0x01; /* En_High_Power */ + data[5] = CFG_TX_POWER; /* PA_level */ + + /* send the SET_POWER */ + if (mbox_write(data[0], 5, &data[1]) != 5) { + /* Error: no data are written */ + return 0; + } + /* now wait for the corresponding Rx event */ + return 1; /* success */ +} + +#endif /* STM32WBxx */ diff --git a/src/utility/HCISharedMemTransport.h b/src/utility/HCISharedMemTransport.h new file mode 100644 index 00000000..58fb871d --- /dev/null +++ b/src/utility/HCISharedMemTransport.h @@ -0,0 +1,93 @@ +/* + This file is part of the STM32duinoBLE library. + Copyright (c) 2019 STMicroelectronics. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#ifndef _HCI_SHARED_MEM_TRANSPORT_H_ +#define _HCI_SHARED_MEM_TRANSPORT_H_ + +#include "HCITransport.h" + +/* STM32WB include files */ +#include "stm32wbxx_ll_rcc.h" +#include "stm32wbxx_ll_ipcc.h" +#include "stm32wbxx_ll_system.h" +#include "STM32Cube_FW/tl.h" +#include "STM32Cube_FW/shci.h" +#include "STM32Cube_FW/shci_tl.h" +#include "STM32Cube_FW/app_conf.h" + +/* this one is for printing info content when HW serial enabled */ +//#define PRINT_IPCC_INFO + +/* this CONFIG_DEBUG must be defined for -Og option */ +//#define CONFIG_DEBUG + +/****************************************************************************** + * BLE config parameters + ******************************************************************************/ +/* Defined from WB Cube reference SW */ +#define CFG_TLBLE_EVT_QUEUE_LENGTH 5 +#define CFG_TLBLE_MOST_EVENT_PAYLOAD_SIZE 255 /**< Set to 255 with the memory manager and the mailbox */ +#define TL_BLE_EVENT_FRAME_SIZE ( TL_EVT_HDR_SIZE + CFG_TLBLE_MOST_EVENT_PAYLOAD_SIZE ) +#define POOL_SIZE (CFG_TLBLE_EVT_QUEUE_LENGTH*4*DIVC(( sizeof(TL_PacketHeader_t) + TL_BLE_EVENT_FRAME_SIZE ), 4)) + +#define CONFIG_DATA_PUBADDR_OFFSET (0x00) /**< Bluetooth public address */ +#define CONFIG_DATA_PUBADDR_LEN (6) + +#define BT_BUF_CMD 1 +#define BT_BUF_ACL_OUT 2 + +/* timeout (in ms) to wait for an incoming event */ +#define BLE_IPCC_TIMEOUT 10000 + +/* to received BLE packet from the SharedMem */ +void evt_received(TL_EvtPacket_t *hcievt); + +/* to send BLE packet to the SharedMem */ +uint16_t mbox_write(uint8_t type, uint16_t len, const uint8_t *pData); + +class HCISharedMemTransportClass : public HCITransportInterface { + public: + HCISharedMemTransportClass(); + virtual ~HCISharedMemTransportClass(); + + virtual int begin(); + virtual void end(); + + virtual void wait(unsigned long timeout); + + virtual int available(); + virtual int peek(); + virtual int read(); + + virtual size_t write(const uint8_t *data, size_t length); + + private: + + /* method to initialize the BLE device */ + void transport_init(void); + void start_ble_rf(void); + void stm32wb_reset(void); + int stm32wb_start_ble(void); + int bt_ipm_set_addr(void); + int bt_ipm_set_power(void); + + uint8_t _random_addr[6]; +}; + +#endif /* _HCI_SHARED_MEM_TRANSPORT_H_ */ diff --git a/src/utility/HCISpiTransport.cpp b/src/utility/HCISpiTransport.cpp new file mode 100644 index 00000000..ac9b4814 --- /dev/null +++ b/src/utility/HCISpiTransport.cpp @@ -0,0 +1,1353 @@ +/* + This file is part of the STM32duinoBLE library. + Copyright (c) 2019 STMicroelectronics. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#include "HCISpiTransport.h" + +volatile int data_avail = 0; + +HCISpiTransportClass::HCISpiTransportClass(SPIClass &spi, BLEChip_t ble_chip, uint8_t cs_pin, uint8_t spi_irq, uint8_t ble_rst, uint32_t frequency, uint8_t spi_mode) : + _spi(&spi), + _ble_chip(ble_chip), + _cs_pin(cs_pin), + _spi_irq(spi_irq), + _ble_rst(ble_rst) +{ + _spiSettings = SPISettings(frequency, (BitOrder)BLE_SPI_BYTE_ORDER, spi_mode); + _read_index = 0; + _write_index = 0; + _write_index_initial = 0; + _initial_phase = 1; + _random_addr_done = false; +} + +HCISpiTransportClass::~HCISpiTransportClass() +{ +} + +extern "C" void SPI_Irq_Callback(void) +{ + data_avail = 1; +} + +int HCISpiTransportClass::begin() +{ + _read_index = 0; + _write_index = 0; + _write_index_initial = 0; + _initial_phase = 1; + memset(_rxbuff, 0, sizeof(_rxbuff)); + pinMode(_cs_pin, OUTPUT); + digitalWrite(_cs_pin, HIGH); + + _spi->begin(); + + pinMode(_spi_irq, INPUT); + attachInterrupt(_spi_irq, SPI_Irq_Callback, RISING); + + // Reset chip + pinMode(_ble_rst, OUTPUT); + digitalWrite(_ble_rst, LOW); + delay(5); + digitalWrite(_ble_rst, HIGH); + delay(5); + + if (_ble_chip == SPBTLE_RF || _ble_chip == BLUENRG_M0 || _ble_chip == BLUENRG_LP || _ble_chip == BLUENRG_M2SP) { + // Wait for Blue Initialize + wait_for_blue_initialize(); + } else if (_ble_chip == SPBTLE_1S) { + // Wait a while for the reset of the BLE module + delay(300); + } else { + // BLE chip not supported + return 0; + } + + return 1; +} + +void HCISpiTransportClass::end() +{ + detachInterrupt(_spi_irq); + _spi->end(); +} + +void HCISpiTransportClass::wait(unsigned long timeout) +{ + for (unsigned long start = millis(); (millis() - start) < timeout;) { + if (available()) { + break; + } + } +} + +int HCISpiTransportClass::available() +{ + if (_ble_chip != SPBTLE_RF && _ble_chip != SPBTLE_1S && _ble_chip != BLUENRG_M2SP && _ble_chip != BLUENRG_M0 && _ble_chip != BLUENRG_LP) { + return 0; + } + + if (_read_index != _write_index) { + return 1; + } else if (data_avail) { + int ble_reset = 0; + + if (digitalRead(_spi_irq) == 0) { + return 0; + } + + data_avail = 0; + + // Wait for BlueNRG-LP to be ready (needs to be done after each HCI RESET) + if (_ble_chip == BLUENRG_LP && _initial_phase) { + delay(100); + } + + while (digitalRead(_spi_irq) == 1 && _write_index != BLE_MODULE_SPI_BUFFER_SIZE) { + uint8_t header_master[5] = {0x0b, 0x00, 0x00, 0x00, 0x00}; + + if (_ble_chip == SPBTLE_1S || _ble_chip == BLUENRG_M2SP || _ble_chip == BLUENRG_LP) { + detachInterrupt(_spi_irq); + } + + _spi->beginTransaction(_spiSettings); + + digitalWrite(_cs_pin, LOW); + + /* Write the header */ + _spi->transfer(header_master, 5); + + if (_ble_chip == SPBTLE_RF || _ble_chip == BLUENRG_M0) { + /* device is ready */ + if (header_master[0] == 0x02) { + uint16_t byte_count = (header_master[4] << 8) | header_master[3]; + + if (byte_count > 0) { + if (_initial_phase) { + /* avoid to read more data that available size of the buffer */ + if (byte_count > (BLE_MODULE_SPI_BUFFER_SIZE - _write_index_initial)) { + byte_count = (BLE_MODULE_SPI_BUFFER_SIZE - _write_index_initial); + } + + /* Read the response */ + for (int j = 0; j < byte_count; j++) { + _rxbuff[_write_index_initial] = _spi->transfer(0x00); + _write_index_initial++; + } + + /* Check if the message is a Blue Initialize */ + /* If so we need to send the command to enable LL_ONLY */ + if (byte_count == 6) { + if (_rxbuff[_write_index_initial - 6] == 0x04 && + _rxbuff[_write_index_initial - 5] == 0xFF && + _rxbuff[_write_index_initial - 4] == 0x03 && + _rxbuff[_write_index_initial - 3] == 0x01 && + _rxbuff[_write_index_initial - 2] == 0x00 && + _rxbuff[_write_index_initial - 1] == 0x01) { + ble_reset = 1; + } + } + } else { + /* avoid to read more data that available size of the buffer */ + if (byte_count > (BLE_MODULE_SPI_BUFFER_SIZE - _write_index)) { + byte_count = (BLE_MODULE_SPI_BUFFER_SIZE - _write_index); + /* SPI buffer is full but we still have data to store, so we set the data_avail flag to true */ + data_avail = 1; + } + + /* Read the response */ + for (int j = 0; j < byte_count; j++) { + _rxbuff[_write_index] = _spi->transfer(0x00); + _write_index++; + } + } + } + } + } else if (_ble_chip == SPBTLE_1S || _ble_chip == BLUENRG_M2SP || _ble_chip == BLUENRG_LP) { + uint16_t byte_count = (header_master[4] << 8) | header_master[3]; + + if (byte_count > 0) { + if (_initial_phase) { + /* avoid to read more data that available size of the buffer */ + if (byte_count > (BLE_MODULE_SPI_BUFFER_SIZE - _write_index_initial)) { + byte_count = (BLE_MODULE_SPI_BUFFER_SIZE - _write_index_initial); + } + + /* Read the response */ + for (int j = 0; j < byte_count; j++) { + _rxbuff[_write_index_initial] = _spi->transfer(0x00); + _write_index_initial++; + } + + /* Check if the message is a CMD_COMPLETE */ + /* We suppose that the first CMD is always a HCI_RESET */ + if (byte_count == 7) { + if (_rxbuff[_write_index_initial - 7] == 0x04 && + _rxbuff[_write_index_initial - 6] == 0x0E && + _rxbuff[_write_index_initial - 5] == 0x04 && + _rxbuff[_write_index_initial - 4] == 0x01 && + _rxbuff[_write_index_initial - 3] == 0x03 && + _rxbuff[_write_index_initial - 2] == 0x0C && + _rxbuff[_write_index_initial - 1] == 0x00) { + ble_reset = 1; + } + } + } else { + /* avoid to read more data that available size of the buffer */ + if (byte_count > (BLE_MODULE_SPI_BUFFER_SIZE - _write_index)) { + byte_count = (BLE_MODULE_SPI_BUFFER_SIZE - _write_index); + /* SPI buffer is full but we still have data to store, so we set the data_avail flag to true */ + data_avail = 1; + } + + /* Read the response */ + for (int j = 0; j < byte_count; j++) { + _rxbuff[_write_index] = _spi->transfer(0x00); + _write_index++; + } + } + } + } + + digitalWrite(_cs_pin, HIGH); + + _spi->endTransaction(); + + if (_ble_chip == SPBTLE_1S || _ble_chip == BLUENRG_M2SP || _ble_chip == BLUENRG_LP) { + attachInterrupt(_spi_irq, SPI_Irq_Callback, RISING); + } + } + + if (ble_reset) { + if (_ble_chip == BLUENRG_M2SP) { + wait_for_blue_initialize(); + } + + if (_ble_chip == SPBTLE_RF || _ble_chip == BLUENRG_M0 || _ble_chip == BLUENRG_LP || _ble_chip == BLUENRG_M2SP) { + /* BLE chip was reset: we need to enable LL_ONLY */ + enable_ll_only(); + wait_for_enable_ll_only(); + } else if (_ble_chip == SPBTLE_1S) { + /* BLE chip was reset: we need to wait for a while */ + delay(300); + } + + /* Call Gatt Init and Gap Init to activate the random BLE address */ + if (!_random_addr_done) { + aci_gatt_init(); + wait_for_aci_gatt_init(); + aci_gap_init(); + wait_for_aci_gap_init(); + /* Call Read Config Parameter to retrieve the random BLE address */ + aci_read_config_parameter(); + wait_for_aci_read_config_parameter(); + if (_ble_chip == BLUENRG_LP) { + hci_reset(); + _read_index = _write_index = _write_index_initial = 0; + _initial_phase = 1; + } else { + /* Now we can update the write index and close the initial phase */ + _write_index = _write_index_initial; + _initial_phase = 0; + _write_index_initial = 0; + } + } else { + set_address(); + wait_for_set_address(); + /* Now we can update the write index and close the initial phase */ + _write_index = _write_index_initial; + _initial_phase = 0; + _write_index_initial = 0; + } + } + + if (_read_index != _write_index) { + return 1; + } else { + return 0; + } + } else { + return 0; + } +} + +int HCISpiTransportClass::peek() +{ + int peek_val = -1; + + if (_read_index != _write_index) { + peek_val = _rxbuff[_read_index]; + } + + return peek_val; +} + +int HCISpiTransportClass::read() +{ + int read_val = -1; + + if (_read_index != _write_index) { + read_val = _rxbuff[_read_index]; + _read_index++; + if (_read_index == _write_index) { + /* Reset buffer index */ + _read_index = 0; + _write_index = 0; + } + } + + return read_val; +} + +size_t HCISpiTransportClass::write(const uint8_t *data, size_t length) +{ + uint8_t header_master[5] = {0x0a, 0x00, 0x00, 0x00, 0x00}; + void *my_data = (void *)data; + int result = 0; + uint32_t tickstart = millis(); + + if (_ble_chip != SPBTLE_RF && _ble_chip != SPBTLE_1S && _ble_chip != BLUENRG_M2SP && _ble_chip != BLUENRG_M0 && _ble_chip != BLUENRG_LP) { + return 0; + } + + do { + if (_ble_chip == SPBTLE_RF || _ble_chip == BLUENRG_M0) { + result = 0; + + _spi->beginTransaction(_spiSettings); + + digitalWrite(_cs_pin, LOW); + + /* Write the header */ + _spi->transfer(header_master, 5); + + /* device is ready */ + if (header_master[0] == 0x02) { + if (header_master[1] >= length) { + /* Write the data */ + _spi->transfer(my_data, length); + } else { + result = -2; + } + } else { + result = -1; + } + + digitalWrite(_cs_pin, HIGH); + + _spi->endTransaction(); + + if ((millis() - tickstart) > 1000) { + result = -3; + break; + } + } else if (_ble_chip == SPBTLE_1S || _ble_chip == BLUENRG_M2SP || _ble_chip == BLUENRG_LP) { + uint32_t tickstart_data_available = millis(); + result = 0; + + detachInterrupt(_spi_irq); + + _spi->beginTransaction(_spiSettings); + + digitalWrite(_cs_pin, LOW); + + /* + * Wait until BlueNRG-1 is ready. + * When ready it will raise the IRQ pin. + */ + while (!(digitalRead(_spi_irq) == 1)) { + if ((millis() - tickstart_data_available) > 1000) { + result = -3; + break; + } + } + + if (result == -3) { + digitalWrite(_cs_pin, HIGH); + _spi->endTransaction(); + attachInterrupt(_spi_irq, SPI_Irq_Callback, RISING); + break; + } + + /* Write the header */ + _spi->transfer(header_master, 5); + + if ((int)((((uint16_t)header_master[2]) << 8) | ((uint16_t)header_master[1])) >= (int)length) { + /* Write the data */ + _spi->transfer(my_data, length); + } else { + result = -2; + } + + digitalWrite(_cs_pin, HIGH); + + _spi->endTransaction(); + + attachInterrupt(_spi_irq, SPI_Irq_Callback, RISING); + + if ((millis() - tickstart) > 1000) { + result = -3; + break; + } + } + } while (result < 0); + + if (result < 0) { + return 0; + } else { + return length; + } +} + +void HCISpiTransportClass::wait_for_blue_initialize() +{ + int event_blue_initialize = 0; + uint8_t event[16]; + + do { + while (!data_avail); + + if (digitalRead(_spi_irq) == 0) { + continue; + } + + data_avail = 0; + while (digitalRead(_spi_irq) == 1) { + uint8_t header_master[5] = {0x0b, 0x00, 0x00, 0x00, 0x00}; + + if (_ble_chip == SPBTLE_1S || _ble_chip == BLUENRG_M2SP || _ble_chip == BLUENRG_LP) { + detachInterrupt(_spi_irq); + } + + _spi->beginTransaction(_spiSettings); + + digitalWrite(_cs_pin, LOW); + + /* Write the header */ + _spi->transfer(header_master, 5); + + if (_ble_chip == SPBTLE_RF || _ble_chip == BLUENRG_M0) { + /* device is ready */ + if (header_master[0] == 0x02) { + /* device is ready */ + uint16_t byte_count = (header_master[4] << 8) | header_master[3]; + + if (byte_count > 0) { + /* Read the response */ + if (byte_count == 6) { + for (int j = 0; j < byte_count; j++) { + event[j] = _spi->transfer(0x00); + } + + if (event[0] == 0x04 && + event[1] == 0xFF && + event[2] == 0x03 && + event[3] == 0x01 && + event[4] == 0x00 && + event[5] == 0x01) { + event_blue_initialize = 1; + } + } else { + for (int j = 0; j < byte_count; j++) { + _spi->transfer(0x00); + } + } + } + } + } else if (_ble_chip == SPBTLE_1S || _ble_chip == BLUENRG_M2SP) { + uint16_t byte_count = (header_master[4] << 8) | header_master[3]; + + if (byte_count > 0) { + /* Read the response */ + if (byte_count == 6) { + for (int j = 0; j < byte_count; j++) { + event[j] = _spi->transfer(0x00); + } + + if (event[0] == 0x04 && + event[1] == 0xFF && + event[2] == 0x03 && + event[3] == 0x01 && + event[4] == 0x00 && + event[5] == 0x01) { + event_blue_initialize = 1; + } + } else { + for (int j = 0; j < byte_count; j++) { + _spi->transfer(0x00); + } + } + } + } else if (_ble_chip == BLUENRG_LP) { + uint8_t byte_count = (header_master[4] << 8) | header_master[3]; + + if (byte_count > 0) { + /* Read the response */ + if (byte_count == 7) { + for (int j = 0; j < byte_count; j++) { + event[j] = _spi->transfer(0x00); + } + + if (event[0] == 0x82 && + event[1] == 0xFF && + event[2] == 0x03 && + event[3] == 0x00 && + event[4] == 0x01 && + event[5] == 0x00 && + event[6] == 0x01) { + event_blue_initialize = 1; + } + } else { + for (int j = 0; j < byte_count; j++) { + _spi->transfer(0x00); + } + } + } + } + + digitalWrite(_cs_pin, HIGH); + + _spi->endTransaction(); + + if (_ble_chip == SPBTLE_1S || _ble_chip == BLUENRG_M2SP || _ble_chip == BLUENRG_LP) { + attachInterrupt(_spi_irq, SPI_Irq_Callback, RISING); + } + } + } while (!event_blue_initialize); +} + +void HCISpiTransportClass::wait_for_enable_ll_only() +{ + uint8_t data[8]; + int status = 0; + + do { + while (!data_avail); + + if (digitalRead(_spi_irq) == 0) { + continue; + } + + data_avail = 0; + while (digitalRead(_spi_irq) == 1) { + uint8_t header_master[5] = {0x0b, 0x00, 0x00, 0x00, 0x00}; + + if (_ble_chip == SPBTLE_1S || _ble_chip == BLUENRG_M2SP || _ble_chip == BLUENRG_LP) { + detachInterrupt(_spi_irq); + } + + _spi->beginTransaction(_spiSettings); + + digitalWrite(_cs_pin, LOW); + + /* Write the header */ + _spi->transfer(header_master, 5); + + if (_ble_chip == SPBTLE_RF || _ble_chip == BLUENRG_M0) { + /* device is ready */ + if (header_master[0] == 0x02) { + /* device is ready */ + uint16_t byte_count = (header_master[4] << 8) | header_master[3]; + + if (byte_count > 0) { + /* Read the response */ + for (int j = 0; j < byte_count; j++) { + data[j] = _spi->transfer(0x00); + } + + if (byte_count >= 7) { + if (data[0] == 0x04 && + data[1] == 0x0E && + data[2] == 0x04 && + data[3] == 0x01 && + data[4] == 0x0C && + data[5] == 0xFC && + data[6] == 0x00) { + status = 1; + } + } + } + } + } else if (_ble_chip == SPBTLE_1S || _ble_chip == BLUENRG_M2SP || _ble_chip == BLUENRG_LP) { + uint16_t byte_count = (header_master[4] << 8) | header_master[3]; + + if (byte_count > 0) { + /* Read the response */ + for (int j = 0; j < byte_count; j++) { + data[j] = _spi->transfer(0x00); + } + + if (byte_count >= 7) { + if (data[0] == 0x04 && + data[1] == 0x0E && + data[2] == 0x04 && + data[3] == 0x01 && + data[4] == 0x0C && + data[5] == 0xFC && + data[6] == 0x00) { + status = 1; + } + } + } + } + + digitalWrite(_cs_pin, HIGH); + + _spi->endTransaction(); + + if (_ble_chip == SPBTLE_1S || _ble_chip == BLUENRG_M2SP || _ble_chip == BLUENRG_LP) { + attachInterrupt(_spi_irq, SPI_Irq_Callback, RISING); + } + } + } while (!status); +} + +void HCISpiTransportClass::enable_ll_only() +{ + uint8_t header_master[5] = {0x0a, 0x00, 0x00, 0x00, 0x00}; + uint8_t cmd[7] = {0x01, 0x0C, 0xFC, 0x03, 0x2C, 0x01, 0x01}; // Enable LL_ONLY + int result = 0; + + do { + if (_ble_chip == SPBTLE_RF || _ble_chip == BLUENRG_M0) { + result = 0; + + _spi->beginTransaction(_spiSettings); + + digitalWrite(_cs_pin, LOW); + + /* Write the header */ + _spi->transfer(header_master, 5); + + /* device is ready */ + if (header_master[0] == 0x02) { + /* Write the data */ + if (header_master[1] >= 7) { + /* Write the data */ + _spi->transfer((void *)cmd, 7); + } else { + result = -2; + } + } else { + result = -1; + } + + digitalWrite(_cs_pin, HIGH); + + _spi->endTransaction(); + } else if (_ble_chip == SPBTLE_1S || _ble_chip == BLUENRG_M2SP || _ble_chip == BLUENRG_LP) { + uint32_t tickstart_data_available = millis(); + result = 0; + + detachInterrupt(_spi_irq); + + _spi->beginTransaction(_spiSettings); + + digitalWrite(_cs_pin, LOW); + + while (!(digitalRead(_spi_irq) == 1)) { + if ((millis() - tickstart_data_available) > 1000) { + result = -3; + break; + } + } + + if (result == -3) { + digitalWrite(_cs_pin, HIGH); + _spi->endTransaction(); + attachInterrupt(_spi_irq, SPI_Irq_Callback, RISING); + break; + } + + /* Write the header */ + _spi->transfer(header_master, 5); + + if ((int)((((uint16_t)header_master[2]) << 8) | ((uint16_t)header_master[1])) >= 7) { + /* Write the data */ + _spi->transfer((void *)cmd, 7); + } else { + result = -2; + } + + digitalWrite(_cs_pin, HIGH); + + _spi->endTransaction(); + + attachInterrupt(_spi_irq, SPI_Irq_Callback, RISING); + } + } while (result < 0); +} + +void HCISpiTransportClass::wait_for_aci_gatt_init() +{ + uint8_t data[8]; + int status = 0; + + do { + while (!data_avail); + + if (digitalRead(_spi_irq) == 0) { + continue; + } + + data_avail = 0; + while (digitalRead(_spi_irq) == 1) { + uint8_t header_master[5] = {0x0b, 0x00, 0x00, 0x00, 0x00}; + + if (_ble_chip == SPBTLE_1S || _ble_chip == BLUENRG_M2SP || _ble_chip == BLUENRG_LP) { + detachInterrupt(_spi_irq); + } + + _spi->beginTransaction(_spiSettings); + + digitalWrite(_cs_pin, LOW); + + /* Write the header */ + _spi->transfer(header_master, 5); + + if (_ble_chip == SPBTLE_RF || _ble_chip == BLUENRG_M0) { + /* device is ready */ + if (header_master[0] == 0x02) { + /* device is ready */ + uint16_t byte_count = (header_master[4] << 8) | header_master[3]; + + if (byte_count > 0) { + /* Read the response */ + for (int j = 0; j < byte_count; j++) { + data[j] = _spi->transfer(0x00); + } + + if (byte_count >= 7) { + if (data[0] == 0x04 && + data[1] == 0x0E && + data[2] == 0x04 && + data[3] == 0x01 && + data[4] == 0x01 && + data[5] == 0xFD && + data[6] == 0x00) { + status = 1; + } + } + } + } + } else if (_ble_chip == SPBTLE_1S || _ble_chip == BLUENRG_M2SP || _ble_chip == BLUENRG_LP) { + uint16_t byte_count = (header_master[4] << 8) | header_master[3]; + + if (byte_count > 0) { + /* Read the response */ + for (int j = 0; j < byte_count; j++) { + data[j] = _spi->transfer(0x00); + } + + if (byte_count >= 7) { + if (data[0] == 0x04 && + data[1] == 0x0E && + data[2] == 0x04 && + data[3] == 0x01 && + data[4] == 0x01 && + data[5] == 0xFD && + data[6] == 0x00) { + status = 1; + } + } + } + } + + digitalWrite(_cs_pin, HIGH); + + _spi->endTransaction(); + + if (_ble_chip == SPBTLE_1S || _ble_chip == BLUENRG_M2SP || _ble_chip == BLUENRG_LP) { + attachInterrupt(_spi_irq, SPI_Irq_Callback, RISING); + } + } + } while (!status); +} + +void HCISpiTransportClass::aci_gatt_init() +{ + uint8_t header_master[5] = {0x0a, 0x00, 0x00, 0x00, 0x00}; + uint8_t cmd[4] = {0x01, 0x01, 0xFD, 0x00}; // ACI_GATT_INIT + int result = 0; + + do { + if (_ble_chip == SPBTLE_RF || _ble_chip == BLUENRG_M0) { + result = 0; + + _spi->beginTransaction(_spiSettings); + + digitalWrite(_cs_pin, LOW); + + /* Write the header */ + _spi->transfer(header_master, 5); + + /* device is ready */ + if (header_master[0] == 0x02) { + /* Write the data */ + if (header_master[1] >= 4) { + /* Write the data */ + _spi->transfer((void *)cmd, 4); + } else { + result = -2; + } + } else { + result = -1; + } + + digitalWrite(_cs_pin, HIGH); + + _spi->endTransaction(); + } else if (_ble_chip == SPBTLE_1S || _ble_chip == BLUENRG_M2SP || _ble_chip == BLUENRG_LP) { + uint32_t tickstart_data_available = millis(); + result = 0; + + detachInterrupt(_spi_irq); + + _spi->beginTransaction(_spiSettings); + + digitalWrite(_cs_pin, LOW); + + while (!(digitalRead(_spi_irq) == 1)) { + if ((millis() - tickstart_data_available) > 1000) { + result = -3; + break; + } + } + + if (result == -3) { + digitalWrite(_cs_pin, HIGH); + _spi->endTransaction(); + attachInterrupt(_spi_irq, SPI_Irq_Callback, RISING); + break; + } + + /* Write the header */ + _spi->transfer(header_master, 5); + + if ((int)((((uint16_t)header_master[2]) << 8) | ((uint16_t)header_master[1])) >= 4) { + /* Write the data */ + _spi->transfer((void *)cmd, 4); + } else { + result = -2; + } + + digitalWrite(_cs_pin, HIGH); + + _spi->endTransaction(); + + attachInterrupt(_spi_irq, SPI_Irq_Callback, RISING); + } + } while (result < 0); +} + +void HCISpiTransportClass::wait_for_aci_gap_init() +{ + uint8_t data[14]; + int status = 0; + + do { + while (!data_avail); + + if (digitalRead(_spi_irq) == 0) { + continue; + } + + data_avail = 0; + while (digitalRead(_spi_irq) == 1) { + uint8_t header_master[5] = {0x0b, 0x00, 0x00, 0x00, 0x00}; + + if (_ble_chip == SPBTLE_1S || _ble_chip == BLUENRG_M2SP || _ble_chip == BLUENRG_LP) { + detachInterrupt(_spi_irq); + } + + _spi->beginTransaction(_spiSettings); + + digitalWrite(_cs_pin, LOW); + + /* Write the header */ + _spi->transfer(header_master, 5); + + if (_ble_chip == SPBTLE_RF || _ble_chip == BLUENRG_M0) { + /* device is ready */ + if (header_master[0] == 0x02) { + /* device is ready */ + uint16_t byte_count = (header_master[4] << 8) | header_master[3]; + + if (byte_count > 0) { + /* Read the response */ + for (int j = 0; j < byte_count; j++) { + data[j] = _spi->transfer(0x00); + } + + if (byte_count >= 13) { + if (data[0] == 0x04 && + data[1] == 0x0E && + data[2] == 0x0A && + data[3] == 0x01 && + data[4] == 0x8A && + data[5] == 0xFC && + data[6] == 0x00) { + status = 1; + } + } + } + } + } else if (_ble_chip == SPBTLE_1S || _ble_chip == BLUENRG_M2SP || _ble_chip == BLUENRG_LP) { + uint16_t byte_count = (header_master[4] << 8) | header_master[3]; + + if (byte_count > 0) { + /* Read the response */ + for (int j = 0; j < byte_count; j++) { + data[j] = _spi->transfer(0x00); + } + + if (byte_count >= 13) { + if (data[0] == 0x04 && + data[1] == 0x0E && + data[2] == 0x0A && + data[3] == 0x01 && + data[4] == 0x8A && + data[5] == 0xFC && + data[6] == 0x00) { + status = 1; + } + } + } + } + + digitalWrite(_cs_pin, HIGH); + + _spi->endTransaction(); + + if (_ble_chip == SPBTLE_1S || _ble_chip == BLUENRG_M2SP || _ble_chip == BLUENRG_LP) { + attachInterrupt(_spi_irq, SPI_Irq_Callback, RISING); + } + } + } while (!status); +} + +void HCISpiTransportClass::aci_gap_init() +{ + uint8_t header_master[5] = {0x0a, 0x00, 0x00, 0x00, 0x00}; + uint8_t cmd_lp[8] = {0x01, 0x8A, 0xFC, 0x04, 0x0F, 0x00, 0x00, 0x00}; // ACI_GAP_INIT + uint8_t cmd_others[7] = {0x01, 0x8A, 0xFC, 0x03, 0x0F, 0x00, 0x00}; // ACI_GAP_INIT + uint8_t *cmd, cmd_size; + if (_ble_chip == BLUENRG_LP) { + cmd = cmd_lp; + cmd_size = 8; + } else { + cmd = cmd_others; + cmd_size = 7; + } + int result = 0; + + do { + if (_ble_chip == SPBTLE_RF || _ble_chip == BLUENRG_M0) { + result = 0; + + _spi->beginTransaction(_spiSettings); + + digitalWrite(_cs_pin, LOW); + + /* Write the header */ + _spi->transfer(header_master, 5); + + /* device is ready */ + if (header_master[0] == 0x02) { + /* Write the data */ + if (header_master[1] >= cmd_size) { + /* Write the data */ + _spi->transfer((void *)cmd, cmd_size); + } else { + result = -2; + } + } else { + result = -1; + } + + digitalWrite(_cs_pin, HIGH); + + _spi->endTransaction(); + } else if (_ble_chip == SPBTLE_1S || _ble_chip == BLUENRG_M2SP || _ble_chip == BLUENRG_LP) { + uint32_t tickstart_data_available = millis(); + result = 0; + + detachInterrupt(_spi_irq); + + _spi->beginTransaction(_spiSettings); + + digitalWrite(_cs_pin, LOW); + + while (!(digitalRead(_spi_irq) == 1)) { + if ((millis() - tickstart_data_available) > 1000) { + result = -3; + break; + } + } + + if (result == -3) { + digitalWrite(_cs_pin, HIGH); + _spi->endTransaction(); + attachInterrupt(_spi_irq, SPI_Irq_Callback, RISING); + break; + } + + /* Write the header */ + _spi->transfer(header_master, 5); + + if ((int)((((uint16_t)header_master[2]) << 8) | ((uint16_t)header_master[1])) >= cmd_size) { + /* Write the data */ + _spi->transfer((void *)cmd, cmd_size); + } else { + result = -2; + } + + digitalWrite(_cs_pin, HIGH); + + _spi->endTransaction(); + + attachInterrupt(_spi_irq, SPI_Irq_Callback, RISING); + } + } while (result < 0); +} + +void HCISpiTransportClass::wait_for_aci_read_config_parameter() +{ + uint8_t data[15]; + int status = 0; + + do { + while (!data_avail); + + if (digitalRead(_spi_irq) == 0) { + continue; + } + + data_avail = 0; + while (digitalRead(_spi_irq) == 1) { + uint8_t header_master[5] = {0x0b, 0x00, 0x00, 0x00, 0x00}; + + if (_ble_chip == SPBTLE_1S || _ble_chip == BLUENRG_M2SP || _ble_chip == BLUENRG_LP) { + detachInterrupt(_spi_irq); + } + + _spi->beginTransaction(_spiSettings); + + digitalWrite(_cs_pin, LOW); + + /* Write the header */ + _spi->transfer(header_master, 5); + + if (_ble_chip == SPBTLE_RF || _ble_chip == BLUENRG_M0) { + /* device is ready */ + if (header_master[0] == 0x02) { + /* device is ready */ + uint16_t byte_count = (header_master[4] << 8) | header_master[3]; + + if (byte_count > 0) { + /* Read the response */ + for (int j = 0; j < byte_count; j++) { + data[j] = _spi->transfer(0x00); + } + + if (byte_count >= 13) { + if (data[0] == 0x04 && + data[1] == 0x0E && + data[2] == 0x0A && + data[3] == 0x01 && + data[4] == 0x0D && + data[5] == 0xFC && + data[6] == 0x00) { + memcpy(_random_addr, &data[7], 6); + status = 1; + } + } + } + } + } else if (_ble_chip == SPBTLE_1S || _ble_chip == BLUENRG_M2SP || _ble_chip == BLUENRG_LP) { + uint16_t byte_count = (header_master[4] << 8) | header_master[3]; + + if (byte_count > 0) { + /* Read the response */ + for (int j = 0; j < byte_count; j++) { + data[j] = _spi->transfer(0x00); + } + + if (byte_count >= 14) { + if (data[0] == 0x04 && + data[1] == 0x0E && + data[2] == 0x0B && + data[3] == 0x01 && + data[4] == 0x0D && + data[5] == 0xFC && + data[6] == 0x00) { + memcpy(_random_addr, &data[8], 6); + status = 1; + _random_addr_done = true; + } + } + } + } + + digitalWrite(_cs_pin, HIGH); + + _spi->endTransaction(); + + if (_ble_chip == SPBTLE_1S || _ble_chip == BLUENRG_M2SP || _ble_chip == BLUENRG_LP) { + attachInterrupt(_spi_irq, SPI_Irq_Callback, RISING); + } + } + } while (!status); +} + +void HCISpiTransportClass::aci_read_config_parameter() +{ + uint8_t header_master[5] = {0x0a, 0x00, 0x00, 0x00, 0x00}; + uint8_t cmd[5] = {0x01, 0x0D, 0xFC, 0x01, 0x80}; // ACI_READ_CONFIG_PARAMETER + int result = 0; + + do { + if (_ble_chip == SPBTLE_RF || _ble_chip == BLUENRG_M0) { + result = 0; + + _spi->beginTransaction(_spiSettings); + + digitalWrite(_cs_pin, LOW); + + /* Write the header */ + _spi->transfer(header_master, 5); + + /* device is ready */ + if (header_master[0] == 0x02) { + /* Write the data */ + if (header_master[1] >= 5) { + /* Write the data */ + _spi->transfer((void *)cmd, 5); + } else { + result = -2; + } + } else { + result = -1; + } + + digitalWrite(_cs_pin, HIGH); + + _spi->endTransaction(); + } else if (_ble_chip == SPBTLE_1S || _ble_chip == BLUENRG_M2SP || _ble_chip == BLUENRG_LP) { + uint32_t tickstart_data_available = millis(); + result = 0; + + detachInterrupt(_spi_irq); + + _spi->beginTransaction(_spiSettings); + + digitalWrite(_cs_pin, LOW); + + while (!(digitalRead(_spi_irq) == 1)) { + if ((millis() - tickstart_data_available) > 1000) { + result = -3; + break; + } + } + + if (result == -3) { + digitalWrite(_cs_pin, HIGH); + _spi->endTransaction(); + attachInterrupt(_spi_irq, SPI_Irq_Callback, RISING); + break; + } + + /* Write the header */ + _spi->transfer(header_master, 5); + + if ((int)((((uint16_t)header_master[2]) << 8) | ((uint16_t)header_master[1])) >= 5) { + /* Write the data */ + _spi->transfer((void *)cmd, 5); + } else { + result = -2; + } + + digitalWrite(_cs_pin, HIGH); + + _spi->endTransaction(); + + attachInterrupt(_spi_irq, SPI_Irq_Callback, RISING); + } + } while (result < 0); +} + +void HCISpiTransportClass::hci_reset() +{ + uint8_t header_master[5] = {0x0a, 0x00, 0x00, 0x00, 0x00}; + uint8_t cmd[4] = {0x01, 0x03, 0x0C, 0x00}; // HCI_RESET + int result = 0; + + do { + if (_ble_chip == BLUENRG_LP) { + uint32_t tickstart_data_available = millis(); + result = 0; + + detachInterrupt(_spi_irq); + + _spi->beginTransaction(_spiSettings); + + digitalWrite(_cs_pin, LOW); + + while (!(digitalRead(_spi_irq) == 1)) { + if ((millis() - tickstart_data_available) > 1000) { + result = -3; + break; + } + } + + if (result == -3) { + digitalWrite(_cs_pin, HIGH); + _spi->endTransaction(); + attachInterrupt(_spi_irq, SPI_Irq_Callback, RISING); + break; + } + + /* Write the header */ + _spi->transfer(header_master, 5); + + if ((int)((((uint16_t)header_master[2]) << 8) | ((uint16_t)header_master[1])) >= 4) { + /* Write the data */ + _spi->transfer((void *)cmd, 4); + } else { + result = -2; + } + + digitalWrite(_cs_pin, HIGH); + + _spi->endTransaction(); + + attachInterrupt(_spi_irq, SPI_Irq_Callback, RISING); + } + } while (result < 0); +} + +void HCISpiTransportClass::set_address() +{ + uint8_t header_master[5] = {0x0a, 0x00, 0x00, 0x00, 0x00}; + uint8_t cmd[10] = {0x01, 0x05, 0x20, 0x06}; // SET ADDR + int result = 0; + memcpy(&cmd[4], _random_addr, 6); + + do { + if (_ble_chip == BLUENRG_LP) { + uint32_t tickstart_data_available = millis(); + result = 0; + + detachInterrupt(_spi_irq); + + _spi->beginTransaction(_spiSettings); + + digitalWrite(_cs_pin, LOW); + + while (!(digitalRead(_spi_irq) == 1)) { + if ((millis() - tickstart_data_available) > 1000) { + result = -3; + break; + } + } + + if (result == -3) { + digitalWrite(_cs_pin, HIGH); + _spi->endTransaction(); + attachInterrupt(_spi_irq, SPI_Irq_Callback, RISING); + break; + } + + /* Write the header */ + _spi->transfer(header_master, 5); + + if ((int)((((uint16_t)header_master[2]) << 8) | ((uint16_t)header_master[1])) >= 10) { + /* Write the data */ + _spi->transfer((void *)cmd, 10); + } else { + result = -2; + } + + digitalWrite(_cs_pin, HIGH); + + _spi->endTransaction(); + + attachInterrupt(_spi_irq, SPI_Irq_Callback, RISING); + } + } while (result < 0); +} + +void HCISpiTransportClass::wait_for_set_address() +{ + uint8_t data[15]; + int status = 0; + + if (_ble_chip != BLUENRG_LP) { + return; + } + + do { + while (!data_avail); + + if (digitalRead(_spi_irq) == 0) { + continue; + } + + data_avail = 0; + while (digitalRead(_spi_irq) == 1) { + uint8_t header_master[5] = {0x0b, 0x00, 0x00, 0x00, 0x00}; + uint16_t byte_count = 0; + + detachInterrupt(_spi_irq); + + _spi->beginTransaction(_spiSettings); + + digitalWrite(_cs_pin, LOW); + + /* Write the header */ + _spi->transfer(header_master, 5); + + byte_count = (header_master[4] << 8) | header_master[3]; + + if (byte_count > 0) { + /* Read the response */ + for (int j = 0; j < byte_count; j++) { + data[j] = _spi->transfer(0x00); + } + + if (byte_count >= 7) { // 040E0401052000 + if (data[0] == 0x04 && + data[1] == 0x0E && + data[2] == 0x04 && + data[3] == 0x01 && + data[4] == 0x05 && + data[5] == 0x20 && + data[6] == 0x00) { + status = 1; + } + } + } + + digitalWrite(_cs_pin, HIGH); + + _spi->endTransaction(); + + attachInterrupt(_spi_irq, SPI_Irq_Callback, RISING); + } + } while (!status); +} diff --git a/src/utility/HCISpiTransport.h b/src/utility/HCISpiTransport.h new file mode 100644 index 00000000..34af1aa9 --- /dev/null +++ b/src/utility/HCISpiTransport.h @@ -0,0 +1,83 @@ +/* + This file is part of the STM32duinoBLE library. + Copyright (c) 2019 STMicroelectronics. All rights reserved. + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#ifndef _HCI_SPI_TRANSPORT_H_ +#define _HCI_SPI_TRANSPORT_H_ + +#include "HCITransport.h" +#include "SPI.h" + +typedef enum BLEChip_s { + SPBTLE_RF, + SPBTLE_1S, + BLUENRG_M2SP, + BLUENRG_M0, + BLUENRG_LP +} BLEChip_t; + +#ifndef BLE_SPI_BYTE_ORDER + #define BLE_SPI_BYTE_ORDER MSBFIRST +#endif +#define BLE_MODULE_SPI_BUFFER_SIZE 128 + +class HCISpiTransportClass : public HCITransportInterface { + public: + HCISpiTransportClass(SPIClass &spi, BLEChip_t ble_chip, uint8_t cs_pin, uint8_t spi_irq, uint8_t ble_rst, uint32_t frequency, uint8_t spi_mode); + virtual ~HCISpiTransportClass(); + + virtual int begin(); + virtual void end(); + + virtual void wait(unsigned long timeout); + + virtual int available(); + virtual int peek(); + virtual int read(); + + virtual size_t write(const uint8_t *data, size_t length); + + private: + void wait_for_blue_initialize(); + void wait_for_enable_ll_only(); + void enable_ll_only(); + void wait_for_aci_gatt_init(); + void aci_gatt_init(); + void wait_for_aci_gap_init(); + void aci_gap_init(); + void wait_for_aci_read_config_parameter(); + void aci_read_config_parameter(); + void hci_reset(); + void set_address(); + void wait_for_set_address(); + SPIClass *_spi; + SPISettings _spiSettings; + BLEChip_t _ble_chip; + uint8_t _cs_pin; + uint8_t _spi_irq; + uint8_t _ble_rst; + uint8_t _rxbuff[BLE_MODULE_SPI_BUFFER_SIZE]; + uint16_t _read_index; + uint16_t _write_index; + uint16_t _write_index_initial; + uint8_t _initial_phase; + uint8_t _random_addr[6]; + bool _random_addr_done; +}; + +#endif /* _HCI_SPI_TRANSPORT_H_ */ diff --git a/src/utility/HCIUartTransport.h b/src/utility/HCIUartTransport.h deleted file mode 100644 index ba70dff4..00000000 --- a/src/utility/HCIUartTransport.h +++ /dev/null @@ -1,46 +0,0 @@ -/* - This file is part of the ArduinoBLE library. - Copyright (c) 2018 Arduino SA. All rights reserved. - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -*/ - -#ifndef _HCI_UART_TRANSPORT_H_ -#define _HCI_UART_TRANSPORT_H_ - -#include "HCITransport.h" - -class HCIUartTransportClass : public HCITransportInterface { -public: - HCIUartTransportClass(HardwareSerial& uart, unsigned long baudrate); - virtual ~HCIUartTransportClass(); - - virtual int begin(); - virtual void end(); - - virtual void wait(unsigned long timeout); - - virtual int available(); - virtual int peek(); - virtual int read(); - - virtual size_t write(const uint8_t* data, size_t length); - -private: - HardwareSerial* _uart; - unsigned long _baudrate; -}; - -#endif diff --git a/src/utility/STM32Cube_FW/LICENSE.md b/src/utility/STM32Cube_FW/LICENSE.md new file mode 100644 index 00000000..1af52330 --- /dev/null +++ b/src/utility/STM32Cube_FW/LICENSE.md @@ -0,0 +1,80 @@ +SLA0044 Rev5/February 2018 + +## Software license agreement + +### __ULTIMATE LIBERTY SOFTWARE LICENSE AGREEMENT__ + +BY INSTALLING, COPYING, DOWNLOADING, ACCESSING OR OTHERWISE USING THIS SOFTWARE +OR ANY PART THEREOF (AND THE RELATED DOCUMENTATION) FROM STMICROELECTRONICS +INTERNATIONAL N.V, SWISS BRANCH AND/OR ITS AFFILIATED COMPANIES +(STMICROELECTRONICS), THE RECIPIENT, ON BEHALF OF HIMSELF OR HERSELF, OR ON +BEHALF OF ANY ENTITY BY WHICH SUCH RECIPIENT IS EMPLOYED AND/OR ENGAGED AGREES +TO BE BOUND BY THIS SOFTWARE LICENSE AGREEMENT. + +Under STMicroelectronics’ intellectual property rights, the redistribution, +reproduction and use in source and binary forms of the software or any part +thereof, with or without modification, are permitted provided that the following +conditions are met: + +1. Redistribution of source code (modified or not) must retain any copyright +notice, this list of conditions and the disclaimer set forth below as items 10 +and 11. + +2. Redistributions in binary form, except as embedded into microcontroller or +microprocessor device manufactured by or for STMicroelectronics or a software +update for such device, must reproduce any copyright notice provided with the +binary code, this list of conditions, and the disclaimer set forth below as +items 10 and 11, in documentation and/or other materials provided with the +distribution. + +3. Neither the name of STMicroelectronics nor the names of other contributors to +this software may be used to endorse or promote products derived from this +software or part thereof without specific written permission. + +4. This software or any part thereof, including modifications and/or derivative +works of this software, must be used and execute solely and exclusively on or in +combination with a microcontroller or microprocessor device manufactured by or +for STMicroelectronics. + +5. No use, reproduction or redistribution of this software partially or totally +may be done in any manner that would subject this software to any Open Source +Terms. “Open Source Terms” shall mean any open source license which requires as +part of distribution of software that the source code of such software is +distributed therewith or otherwise made available, or open source license that +substantially complies with the Open Source definition specified at +www.opensource.org and any other comparable open source license such as for +example GNU General Public License (GPL), Eclipse Public License (EPL), Apache +Software License, BSD license or MIT license. + +6. STMicroelectronics has no obligation to provide any maintenance, support or +updates for the software. + +7. The software is and will remain the exclusive property of STMicroelectronics +and its licensors. The recipient will not take any action that jeopardizes +STMicroelectronics and its licensors' proprietary rights or acquire any rights +in the software, except the limited rights specified hereunder. + +8. The recipient shall comply with all applicable laws and regulations affecting +the use of the software or any part thereof including any applicable export +control law or regulation. + +9. Redistribution and use of this software or any part thereof other than as +permitted under this license is void and will automatically terminate your +rights under this license. + +10. THIS SOFTWARE IS PROVIDED BY STMICROELECTRONICS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS, IMPLIED OR STATUTORY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NON-INFRINGEMENT OF THIRD PARTY INTELLECTUAL PROPERTY RIGHTS, WHICH ARE +DISCLAIMED TO THE FULLEST EXTENT PERMITTED BY LAW. IN NO EVENT SHALL +STMICROELECTRONICS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR +PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF +ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +11. EXCEPT AS EXPRESSLY PERMITTED HEREUNDER, NO LICENSE OR OTHER RIGHTS, WHETHER +EXPRESS OR IMPLIED, ARE GRANTED UNDER ANY PATENT OR OTHER INTELLECTUAL PROPERTY +RIGHTS OF STMICROELECTRONICS OR ANY THIRD PARTY. diff --git a/src/utility/STM32Cube_FW/README.md b/src/utility/STM32Cube_FW/README.md new file mode 100644 index 00000000..0d39a3ef --- /dev/null +++ b/src/utility/STM32Cube_FW/README.md @@ -0,0 +1,6 @@ + +## Source + +[STMicroelectronics/STM32CubeWB Release v1.17.0](https://github.com/STMicroelectronics/STM32CubeWB/releases/tag/v1.17.0) +- Application: [BLE_TransparentMode](https://github.com/STMicroelectronics/STM32CubeWB/tree/v1.17.0/Projects/P-NUCLEO-WB55.Nucleo/Applications/BLE/BLE_TransparentMode) + diff --git a/src/utility/STM32Cube_FW/app_conf.h b/src/utility/STM32Cube_FW/app_conf.h new file mode 100644 index 00000000..3246393f --- /dev/null +++ b/src/utility/STM32Cube_FW/app_conf.h @@ -0,0 +1,20 @@ +//----------------------------- +// @file app_conf.h +// @author Kasper Meldgaard +// @brief Wrapper for BLE app configuration based on comment by fpistm +// (https://github.com/stm32duino/STM32duinoBLE/issues/34). +// @date 15-11-2021 +// @copyright Copyright (c) 2021 + +#ifndef APP_CONF_H +#define APP_CONF_H + +#include "hw.h" +#include "ble_bufsize.h" + +#if __has_include("app_conf_custom.h") + #include "app_conf_custom.h" +#endif +#include "app_conf_default.h" + +#endif /* APP_CONF_H */ diff --git a/src/utility/STM32Cube_FW/app_conf_default.h b/src/utility/STM32Cube_FW/app_conf_default.h new file mode 100644 index 00000000..d39492ea --- /dev/null +++ b/src/utility/STM32Cube_FW/app_conf_default.h @@ -0,0 +1,735 @@ +/* USER CODE BEGIN Header */ +/** + ****************************************************************************** + * @file app_conf_default.h + * @author MCD Application Team + * @brief Default application configuration file for STM32WPAN Middleware. + ****************************************************************************** + * @attention + * + * Copyright (c) 2020-2021 STMicroelectronics. + * All rights reserved. + * + * This software is licensed under terms that can be found in the LICENSE file + * in the root directory of this software component. + * If no LICENSE file comes with this software, it is provided AS-IS. + * + ****************************************************************************** + */ +/* USER CODE END Header */ + +/* Define to prevent recursive inclusion -------------------------------------*/ +#ifndef APP_CONF_DEFAULT_H +#define APP_CONF_DEFAULT_H +#if 0 +#include "hw.h" +#include "hw_conf.h" +#include "hw_if.h" +#include "ble_bufsize.h" +#endif +/****************************************************************************** + * Application Config + ******************************************************************************/ + +/**< generic parameters ******************************************************/ +/* HCI related defines */ + +#define ACI_HAL_SET_TX_POWER_LEVEL 0xFC0F +#define ACI_WRITE_CONFIG_DATA_OPCODE 0xFC0C +#define ACI_READ_CONFIG_DATA_OPCODE 0xFC0D +#define MAX_HCI_ACL_PACKET_SIZE (sizeof(TL_PacketHeader_t) + 5 + 251) +#define HCI_RESET 0x0C03 + +#ifndef BLE_SHARED_MEM_BYTE_ORDER + #define BLE_SHARED_MEM_BYTE_ORDER MSBFIRST +#endif +#define BLE_MODULE_SHARED_MEM_BUFFER_SIZE 128 + +/** + * Define Tx Power + */ +#ifndef CFG_TX_POWER + #define CFG_TX_POWER (0x18) /* -0.15dBm */ +#endif + +#if 0 +/** + * Define Secure Connections Support + */ +#define CFG_SECURE_NOT_SUPPORTED (0x00) +#define CFG_SECURE_OPTIONAL (0x01) +#define CFG_SECURE_MANDATORY (0x02) + +#define CFG_SC_SUPPORT CFG_SECURE_OPTIONAL + +/** + * Define Keypress Notification Support + */ +#define CFG_KEYPRESS_NOT_SUPPORTED (0x00) +#define CFG_KEYPRESS_SUPPORTED (0x01) + +#define CFG_KEYPRESS_NOTIFICATION_SUPPORT CFG_KEYPRESS_NOT_SUPPORTED + +/** + * Numeric Comparison Answers + */ +#define YES (0x01) +#define NO (0x00) + +/** + * Device name configuration for Generic Access Service + */ +#define CFG_GAP_DEVICE_NAME "TEMPLATE" +#define CFG_GAP_DEVICE_NAME_LENGTH (8) + +/** +* Identity root key used to derive LTK and CSRK +*/ +#define CFG_BLE_IRK {0x12, 0x34, 0x56, 0x78, 0x9A, 0xBC, 0xDE, 0xF0, 0x12, 0x34, 0x56, 0x78, 0x9A, 0xBC, 0xDE, 0xF0} + +/** +* Encryption root key used to derive LTK and CSRK +*/ +#define CFG_BLE_ERK {0xFE, 0xDC, 0xBA, 0x09, 0x87, 0x65, 0x43, 0x21, 0xFE, 0xDC, 0xBA, 0x09, 0x87, 0x65, 0x43, 0x21} + +/** + * SMPS supply + * SMPS not used when Set to 0 + * SMPS used when Set to 1 + */ +#define CFG_USE_SMPS 0 + +/* USER CODE BEGIN Generic_Parameters */ +/* USER CODE END Generic_Parameters */ + +/**< specific parameters */ +/*****************************************************/ + +/* USER CODE BEGIN Specific_Parameters */ +#define PUSH_BUTTON_SW1_EXTI_IRQHandler EXTI4_IRQHandler + +/* USER CODE END Specific_Parameters */ + +/****************************************************************************** + * Information Table + * + * Version + * [0:3] = Build - 0: Untracked - 15:Released - x: Tracked version + * [4:7] = branch - 0: Mass Market - x: ... + * [8:15] = Subversion + * [16:23] = Version minor + * [24:31] = Version major + * + ******************************************************************************/ +#define CFG_FW_MAJOR_VERSION (0) +#define CFG_FW_MINOR_VERSION (0) +#define CFG_FW_SUBVERSION (1) +#define CFG_FW_BRANCH (0) +#define CFG_FW_BUILD (0) +#endif +/****************************************************************************** + * BLE Stack + ******************************************************************************/ +/** + * Maximum number of simultaneous connections that the device will support. + * Valid values are from 1 to 8 + */ +#ifndef CFG_BLE_NUM_LINK +#ifdef STM32WB15xx + #define CFG_BLE_NUM_LINK 3 +#else + #define CFG_BLE_NUM_LINK 8 +#endif +#endif + +/** + * Maximum number of Services that can be stored in the GATT database. + * Note that the GAP and GATT services are automatically added so this parameter should be 2 plus the number of user services + */ +#ifndef CFG_BLE_NUM_GATT_SERVICES +#ifdef STM32WB15xx + #define CFG_BLE_NUM_GATT_SERVICES 4 +#else + #define CFG_BLE_NUM_GATT_SERVICES 8 +#endif +#endif + +/** + * Maximum number of Attributes + * (i.e. the number of characteristic + the number of characteristic values + the number of descriptors, excluding the services) + * that can be stored in the GATT database. + * Note that certain characteristics and relative descriptors are added automatically during device initialization + * so this parameters should be 9 plus the number of user Attributes + */ +#ifndef CFG_BLE_NUM_GATT_ATTRIBUTES +#ifdef STM32WB15xx + #define CFG_BLE_NUM_GATT_ATTRIBUTES 30 +#else + #define CFG_BLE_NUM_GATT_ATTRIBUTES 68 +#endif +#endif + +/** + * Maximum supported ATT_MTU size + * This parameter is ignored by the CPU2 when CFG_BLE_OPTIONS has SHCI_C2_BLE_INIT_OPTIONS_LL_ONLY flag set + */ +#ifndef CFG_BLE_MAX_ATT_MTU + #define CFG_BLE_MAX_ATT_MTU (156) +#endif + +/** + * Size of the storage area for Attribute values + * This value depends on the number of attributes used by application. In particular the sum of the following quantities (in octets) should be made for each attribute: + * - attribute value length + * - 5, if UUID is 16 bit; 19, if UUID is 128 bit + * - 2, if server configuration descriptor is used + * - 2*DTM_NUM_LINK, if client configuration descriptor is used + * - 2, if extended properties is used + * The total amount of memory needed is the sum of the above quantities for each attribute. + * This parameter is ignored by the CPU2 when CFG_BLE_OPTIONS has SHCI_C2_BLE_INIT_OPTIONS_LL_ONLY flag set + */ +#ifndef CFG_BLE_ATT_VALUE_ARRAY_SIZE +#ifdef STM32WB15xx + #define CFG_BLE_ATT_VALUE_ARRAY_SIZE (1290) +#else + #define CFG_BLE_ATT_VALUE_ARRAY_SIZE (1344) +#endif +#endif + +/** + * Prepare Write List size in terms of number of packet + * This parameter is ignored by the CPU2 when CFG_BLE_OPTIONS has SHCI_C2_BLE_INIT_OPTIONS_LL_ONLY flag set + */ +// #define CFG_BLE_PREPARE_WRITE_LIST_SIZE BLE_PREP_WRITE_X_ATT(CFG_BLE_MAX_ATT_MTU) +#ifndef CFG_BLE_PREPARE_WRITE_LIST_SIZE + #define CFG_BLE_PREPARE_WRITE_LIST_SIZE (0x3A) +#endif + +/** + * Number of allocated memory blocks + * This parameter is overwritten by the CPU2 with an hardcoded optimal value when the parameter CFG_BLE_OPTIONS has SHCI_C2_BLE_INIT_OPTIONS_LL_ONLY flag set + */ +//#define CFG_BLE_MBLOCK_COUNT (BLE_MBLOCKS_CALC(CFG_BLE_PREPARE_WRITE_LIST_SIZE, CFG_BLE_MAX_ATT_MTU, CFG_BLE_NUM_LINK)) +#define CFG_BLE_MBLOCK_COUNT (0x79) + +/** + * Enable or disable the Extended Packet length feature. Valid values are 0 or 1. + */ +#ifndef CFG_BLE_DATA_LENGTH_EXTENSION + #define CFG_BLE_DATA_LENGTH_EXTENSION 1 +#endif + +/** + * Sleep clock accuracy in Slave mode (ppm value) + */ +#ifndef CFG_BLE_SLAVE_SCA + #define CFG_BLE_SLAVE_SCA 500 +#endif + +/** + * Sleep clock accuracy in Master mode + * 0 : 251 ppm to 500 ppm + * 1 : 151 ppm to 250 ppm + * 2 : 101 ppm to 150 ppm + * 3 : 76 ppm to 100 ppm + * 4 : 51 ppm to 75 ppm + * 5 : 31 ppm to 50 ppm + * 6 : 21 ppm to 30 ppm + * 7 : 0 ppm to 20 ppm + */ +#ifndef CFG_BLE_MASTER_SCA + #define CFG_BLE_MASTER_SCA 0 +#endif + +/** + * LsSource + * Some information for Low speed clock mapped in bits field + * - bit 0: 1: Calibration for the RF system wakeup clock source 0: No calibration for the RF system wakeup clock source + * - bit 1: 1: STM32WB5M Module device 0: Other devices as STM32WBxx SOC, STM32WB1M module + * - bit 2: 1: HSE/1024 Clock config 0: LSE Clock config + */ +#ifndef CFG_BLE_LS_SOURCE + #if defined(STM32WB5Mxx) + #define CFG_BLE_LS_SOURCE (SHCI_C2_BLE_INIT_CFG_BLE_LS_NOCALIB | SHCI_C2_BLE_INIT_CFG_BLE_LS_MOD5MM_DEV | SHCI_C2_BLE_INIT_CFG_BLE_LS_CLK_LSE) + #else + #define CFG_BLE_LS_SOURCE (SHCI_C2_BLE_INIT_CFG_BLE_LS_NOCALIB | SHCI_C2_BLE_INIT_CFG_BLE_LS_OTHER_DEV | SHCI_C2_BLE_INIT_CFG_BLE_LS_CLK_LSE) + #endif +#endif + +/** + * Start up time of the high speed (16 or 32 MHz) crystal oscillator in units of 625/256 us (~2.44 us) + */ +#ifndef CFG_BLE_HSE_STARTUP_TIME + #define CFG_BLE_HSE_STARTUP_TIME 0x148 +#endif + +/** + * Maximum duration of the connection event when the device is in Slave mode in units of 625/256 us (~2.44 us) + */ +#ifndef CFG_BLE_MAX_CONN_EVENT_LENGTH + #define CFG_BLE_MAX_CONN_EVENT_LENGTH (0xFFFFFFFF) +#endif + +/** + * Viterbi Mode + * 1 : enabled + * 0 : disabled + */ +#define CFG_BLE_VITERBI_MODE 1 + +/** + * BLE stack Options flags to be configured with: + * - SHCI_C2_BLE_INIT_OPTIONS_LL_ONLY + * - SHCI_C2_BLE_INIT_OPTIONS_LL_HOST + * - SHCI_C2_BLE_INIT_OPTIONS_NO_SVC_CHANGE_DESC + * - SHCI_C2_BLE_INIT_OPTIONS_WITH_SVC_CHANGE_DESC + * - SHCI_C2_BLE_INIT_OPTIONS_DEVICE_NAME_RO + * - SHCI_C2_BLE_INIT_OPTIONS_DEVICE_NAME_RW + * - SHCI_C2_BLE_INIT_OPTIONS_EXT_ADV + * - SHCI_C2_BLE_INIT_OPTIONS_NO_EXT_ADV + * - SHCI_C2_BLE_INIT_OPTIONS_CS_ALGO2 + * - SHCI_C2_BLE_INIT_OPTIONS_NO_CS_ALGO2 + * - SHCI_C2_BLE_INIT_OPTIONS_REDUC_GATTDB_NVM + * - SHCI_C2_BLE_INIT_OPTIONS_FULL_GATTDB_NVM + * - SHCI_C2_BLE_INIT_OPTIONS_GATT_CACHING_USED + * - SHCI_C2_BLE_INIT_OPTIONS_GATT_CACHING_NOTUSED + * - SHCI_C2_BLE_INIT_OPTIONS_POWER_CLASS_1 + * - SHCI_C2_BLE_INIT_OPTIONS_POWER_CLASS_2_3 + * which are used to set following configuration bits: + * (bit 0): 1: LL only + * 0: LL + host + * (bit 1): 1: no service change desc. + * 0: with service change desc. + * (bit 2): 1: device name Read-Only + * 0: device name R/W + * (bit 3): 1: extended advertizing supported + * 0: extended advertizing not supported + * (bit 4): 1: CS Algo #2 supported + * 0: CS Algo #2 not supported + * (bit 5): 1: Reduced GATT database in NVM + * 0: Full GATT database in NVM + * (bit 6): 1: GATT caching is used + * 0: GATT caching is not used + * (bit 7): 1: LE Power Class 1 + * 0: LE Power Class 2-3 + * other bits: complete with Options_extension flag + */ +#define CFG_BLE_OPTIONS (SHCI_C2_BLE_INIT_OPTIONS_LL_ONLY) + +/** + * BLE stack Options_extension flags to be configured with: + * - SHCI_C2_BLE_INIT_OPTIONS_APPEARANCE_WRITABLE + * - SHCI_C2_BLE_INIT_OPTIONS_APPEARANCE_READONLY + * - SHCI_C2_BLE_INIT_OPTIONS_ENHANCED_ATT_SUPPORTED + * - SHCI_C2_BLE_INIT_OPTIONS_ENHANCED_ATT_NOTSUPPORTED + * which are used to set following configuration bits: + * (bit 0): 1: appearance Writable + * 0: appearance Read-Only + * (bit 1): 1: Enhanced ATT supported + * 0: Enhanced ATT not supported + * other bits: reserved (shall be set to 0) + */ +#define CFG_BLE_OPTIONS_EXT (SHCI_C2_BLE_INIT_OPTIONS_APPEARANCE_READONLY | SHCI_C2_BLE_INIT_OPTIONS_ENHANCED_ATT_NOTSUPPORTED) + +#define CFG_BLE_MAX_COC_INITIATOR_NBR (32) + +#define CFG_BLE_MIN_TX_POWER (-40) + +#define CFG_BLE_MAX_TX_POWER (6) + +/** + * BLE Rx model configuration flags to be configured with: + * - SHCI_C2_BLE_INIT_RX_MODEL_AGC_RSSI_LEGACY + * - SHCI_C2_BLE_INIT_RX_MODEL_AGC_RSSI_BLOCKER + * which are used to set following configuration bits: + * (bit 0): 1: agc_rssi model improved vs RF blockers + * 0: Legacy agc_rssi model + * other bits: reserved (shall be set to 0) + */ + +#define CFG_BLE_RX_MODEL_CONFIG (SHCI_C2_BLE_INIT_RX_MODEL_AGC_RSSI_LEGACY) + +/* Maximum number of advertising sets. + * Range: 1 .. 8 with limitation: + * This parameter is linked to CFG_BLE_MAX_ADV_DATA_LEN such as both compliant with allocated Total memory computed with BLE_EXT_ADV_BUFFER_SIZE based + * on Max Extended advertising configuration supported. + * This parameter is considered by the CPU2 when CFG_BLE_OPTIONS has SHCI_C2_BLE_INIT_OPTIONS_EXT_ADV flag set + */ + +#if defined(STM32WB15xx) + #define CFG_BLE_MAX_ADV_SET_NBR (3) +#else + #define CFG_BLE_MAX_ADV_SET_NBR (8) +#endif + + /* Maximum advertising data length (in bytes) + * Range: 31 .. 1650 with limitation: + * This parameter is linked to CFG_BLE_MAX_ADV_SET_NBR such as both compliant with allocated Total memory computed with BLE_EXT_ADV_BUFFER_SIZE based + * on Max Extended advertising configuration supported. + * This parameter is considered by the CPU2 when CFG_BLE_OPTIONS has SHCI_C2_BLE_INIT_OPTIONS_EXT_ADV flag set + */ + +#if defined(STM32WB15xx) + #define CFG_BLE_MAX_ADV_DATA_LEN (414) +#else + #define CFG_BLE_MAX_ADV_DATA_LEN (207) +#endif + + /* RF TX Path Compensation Value (16-bit signed integer). Units: 0.1 dB. + * Range: -1280 .. 1280 + */ + +#define CFG_BLE_TX_PATH_COMPENS (0) + + /* RF RX Path Compensation Value (16-bit signed integer). Units: 0.1 dB. + * Range: -1280 .. 1280 + */ + +#define CFG_BLE_RX_PATH_COMPENS (0) + + /* BLE core version (16-bit signed integer). + * - SHCI_C2_BLE_INIT_BLE_CORE_5_2 + * - SHCI_C2_BLE_INIT_BLE_CORE_5_3 + * which are used to set: 11(5.2), 12(5.3). + */ + +#define CFG_BLE_CORE_VERSION (SHCI_C2_BLE_INIT_BLE_CORE_5_3) + +#if 0 +/****************************************************************************** + * Transport Layer + ******************************************************************************/ +/** + * Queue length of BLE Event + * This parameter defines the number of asynchronous events that can be stored in the HCI layer before + * being reported to the application. When a command is sent to the BLE core coprocessor, the HCI layer + * is waiting for the event with the Num_HCI_Command_Packets set to 1. The receive queue shall be large + * enough to store all asynchronous events received in between. + * When CFG_TLBLE_MOST_EVENT_PAYLOAD_SIZE is set to 27, this allow to store three 255 bytes long asynchronous events + * between the HCI command and its event. + * This parameter depends on the value given to CFG_TLBLE_MOST_EVENT_PAYLOAD_SIZE. When the queue size is to small, + * the system may hang if the queue is full with asynchronous events and the HCI layer is still waiting + * for a CC/CS event, In that case, the notification TL_BLE_HCI_ToNot() is called to indicate + * to the application a HCI command did not receive its command event within 30s (Default HCI Timeout). + */ +#define CFG_TLBLE_EVT_QUEUE_LENGTH 5 +/** + * This parameter should be set to fit most events received by the HCI layer. It defines the buffer size of each element + * allocated in the queue of received events and can be used to optimize the amount of RAM allocated by the Memory Manager. + * It should not exceed 255 which is the maximum HCI packet payload size (a greater value is a lost of memory as it will + * never be used) + * It shall be at least 4 to receive the command status event in one frame. + * The default value is set to 27 to allow receiving an event of MTU size in a single buffer. This value maybe reduced + * further depending on the application. + */ +#define CFG_TLBLE_MOST_EVENT_PAYLOAD_SIZE 255 /**< Set to 255 with the memory manager and the mailbox */ + +#define TL_BLE_EVENT_FRAME_SIZE ( TL_EVT_HDR_SIZE + CFG_TLBLE_MOST_EVENT_PAYLOAD_SIZE ) +/****************************************************************************** + * UART interfaces + ******************************************************************************/ + +/** + * Select UART interfaces + */ +#define CFG_UART_GUI hw_uart1 +#define CFG_DEBUG_TRACE_UART 0 +/****************************************************************************** + * USB interface + ******************************************************************************/ + +/** + * Enable/Disable USB interface + */ +#define CFG_USB_INTERFACE_ENABLE 0 + +/****************************************************************************** + * IPCC interface + ******************************************************************************/ + +/** + * The IPCC is dedicated to the communication between the CPU2 and the CPU1 + * and shall not be modified by the application + * The two following definitions shall not be modified + */ +#define HAL_IPCC_TX_IRQHandler(...) HW_IPCC_Tx_Handler( ) +#define HAL_IPCC_RX_IRQHandler(...) HW_IPCC_Rx_Handler( ) + +/****************************************************************************** + * Low Power + ******************************************************************************/ +/** + * When set to 1, the low power mode is enable + * When set to 0, the device stays in RUN mode + */ +#define CFG_LPM_SUPPORTED 1 + +/****************************************************************************** + * RTC interface + ******************************************************************************/ +#define HAL_RTCEx_WakeUpTimerIRQHandler(...) HW_TS_RTC_Wakeup_Handler( ) + +/****************************************************************************** + * Timer Server + ******************************************************************************/ +/** + * CFG_RTC_WUCKSEL_DIVIDER: This sets the RTCCLK divider to the wakeup timer. + * The lower is the value, the better is the power consumption and the accuracy of the timerserver + * The higher is the value, the finest is the granularity + * + * CFG_RTC_ASYNCH_PRESCALER: This sets the asynchronous prescaler of the RTC. It should as high as possible ( to output + * clock as low as possible) but the output clock should be equal or higher frequency compare to the clock feeding + * the wakeup timer. A lower clock speed would impact the accuracy of the timer server. + * + * CFG_RTC_SYNCH_PRESCALER: This sets the synchronous prescaler of the RTC. + * When the 1Hz calendar clock is required, it shall be sets according to other settings + * When the 1Hz calendar clock is not needed, CFG_RTC_SYNCH_PRESCALER should be set to 0x7FFF (MAX VALUE) + * + * CFG_RTCCLK_DIVIDER_CONF: + * Shall be set to either 0,2,4,8,16 + * When set to either 2,4,8,16, the 1Hhz calendar is supported + * When set to 0, the user sets its own configuration + * + * The following settings are computed with LSI as input to the RTC + */ + +#define CFG_RTCCLK_DIVIDER_CONF 0 + +#if (CFG_RTCCLK_DIVIDER_CONF == 0) +/** + * Custom configuration + * It does not support 1Hz calendar + * It divides the RTC CLK by 16 + */ + +#define CFG_RTCCLK_DIV (16) +#define CFG_RTC_WUCKSEL_DIVIDER (0) +#define CFG_RTC_ASYNCH_PRESCALER (0x0F) +#define CFG_RTC_SYNCH_PRESCALER (0x7FFF) + +#else + +#if (CFG_RTCCLK_DIVIDER_CONF == 2) +/** + * It divides the RTC CLK by 2 + */ +#define CFG_RTC_WUCKSEL_DIVIDER (3) +#endif + +#if (CFG_RTCCLK_DIVIDER_CONF == 4) +/** + * It divides the RTC CLK by 4 + */ +#define CFG_RTC_WUCKSEL_DIVIDER (2) +#endif + +#if (CFG_RTCCLK_DIVIDER_CONF == 8) +/** + * It divides the RTC CLK by 8 + */ +#define CFG_RTC_WUCKSEL_DIVIDER (1) +#endif + +#if (CFG_RTCCLK_DIVIDER_CONF == 16) +/** + * It divides the RTC CLK by 16 + */ +#define CFG_RTC_WUCKSEL_DIVIDER (0) +#endif + +#define CFG_RTCCLK_DIV CFG_RTCCLK_DIVIDER_CONF +#define CFG_RTC_ASYNCH_PRESCALER (CFG_RTCCLK_DIV - 1) +#define CFG_RTC_SYNCH_PRESCALER (DIVR( LSE_VALUE, (CFG_RTC_ASYNCH_PRESCALER+1) ) - 1 ) + +#endif + +/** tick timer values */ +#define CFG_TS_TICK_VAL DIVR( (CFG_RTCCLK_DIV * 1000000), LSE_VALUE ) +#define CFG_TS_TICK_VAL_PS DIVR( ((uint64_t)CFG_RTCCLK_DIV * 1e12), (uint64_t)LSE_VALUE ) + +typedef enum +{ + CFG_TIM_PROC_ID_ISR, + /* USER CODE BEGIN CFG_TimProcID_t */ + + /* USER CODE END CFG_TimProcID_t */ +} CFG_TimProcID_t; + +/****************************************************************************** + * Debug + ******************************************************************************/ +/** + * When set, this resets some hw resources to set the device in the same state than the power up + * The FW resets only register that may prevent the FW to run properly + * + * This shall be set to 0 in a final product + * + */ +#define CFG_HW_RESET_BY_FW 1 + +/** + * keep debugger enabled while in any low power mode when set to 1 + * should be set to 0 in production + */ +#define CFG_DEBUGGER_SUPPORTED 0 + +/** + * When set to 1, the traces are enabled in the BLE services + */ +#define CFG_DEBUG_BLE_TRACE 0 + +/** + * Enable or Disable traces in application + */ +#define CFG_DEBUG_APP_TRACE 0 + +#if (CFG_DEBUG_APP_TRACE != 0) +#define APP_DBG_MSG PRINT_MESG_DBG +#else +#define APP_DBG_MSG PRINT_NO_MESG +#endif + +#if ( (CFG_DEBUG_BLE_TRACE != 0) || (CFG_DEBUG_APP_TRACE != 0) ) +#define CFG_DEBUG_TRACE 1 +#endif + +#if (CFG_DEBUG_TRACE != 0) +#undef CFG_LPM_SUPPORTED +#undef CFG_DEBUGGER_SUPPORTED +#define CFG_LPM_SUPPORTED 0 +#define CFG_DEBUGGER_SUPPORTED 1 +#endif + +/** + * When CFG_DEBUG_TRACE_FULL is set to 1, the trace are output with the API name, the file name and the line number + * When CFG_DEBUG_TRACE_LIGHT is set to 1, only the debug message is output + * + * When both are set to 0, no trace are output + * When both are set to 1, CFG_DEBUG_TRACE_FULL is selected + */ +#define CFG_DEBUG_TRACE_LIGHT 0 +#define CFG_DEBUG_TRACE_FULL 0 + +#if (( CFG_DEBUG_TRACE != 0 ) && ( CFG_DEBUG_TRACE_LIGHT == 0 ) && (CFG_DEBUG_TRACE_FULL == 0)) +#undef CFG_DEBUG_TRACE_FULL +#undef CFG_DEBUG_TRACE_LIGHT +#define CFG_DEBUG_TRACE_FULL 0 +#define CFG_DEBUG_TRACE_LIGHT 1 +#endif + +#if ( CFG_DEBUG_TRACE == 0 ) +#undef CFG_DEBUG_TRACE_FULL +#undef CFG_DEBUG_TRACE_LIGHT +#define CFG_DEBUG_TRACE_FULL 0 +#define CFG_DEBUG_TRACE_LIGHT 0 +#endif + +/** + * When not set, the traces is looping on sending the trace over UART + */ +#define DBG_TRACE_USE_CIRCULAR_QUEUE 1 + +/** + * max buffer Size to queue data traces and max data trace allowed. + * Only Used if DBG_TRACE_USE_CIRCULAR_QUEUE is defined + */ +#define DBG_TRACE_MSG_QUEUE_SIZE 4096 +#define MAX_DBG_TRACE_MSG_SIZE 1024 + +/* USER CODE BEGIN Defines */ +#define CFG_LED_SUPPORTED 1 +#define CFG_BUTTON_SUPPORTED 1 + +#define PUSH_BUTTON_SW1_EXTI_IRQHandler EXTI4_IRQHandler +#define PUSH_BUTTON_SW2_EXTI_IRQHandler EXTI0_IRQHandler +#define PUSH_BUTTON_SW3_EXTI_IRQHandler EXTI1_IRQHandler +/* USER CODE END Defines */ + +/****************************************************************************** + * Scheduler + ******************************************************************************/ + +/** + * These are the lists of task id registered to the scheduler + * Each task id shall be in the range [0:31] + * This mechanism allows to implement a generic code in the API TL_BLE_HCI_StatusNot() to comply with + * the requirement that a HCI/ACI command shall never be sent if there is already one pending + */ + +/**< Add in that list all tasks that may send a ACI/HCI command */ +typedef enum +{ + CFG_TASK_BLE_HCI_CMD_ID, + CFG_TASK_SYS_HCI_CMD_ID, + CFG_TASK_HCI_ACL_DATA_ID, + CFG_TASK_SYS_LOCAL_CMD_ID, + CFG_TASK_TX_TO_HOST_ID, + /* USER CODE BEGIN CFG_Task_Id_With_HCI_Cmd_t */ + CFG_TASK_SW1_BUTTON_PUSHED_ID, + CFG_TASK_SW2_BUTTON_PUSHED_ID, + CFG_TASK_SW3_BUTTON_PUSHED_ID, + /* USER CODE END CFG_Task_Id_With_HCI_Cmd_t */ + CFG_LAST_TASK_ID_WITH_HCICMD, /**< Shall be LAST in the list */ +} CFG_Task_Id_With_HCI_Cmd_t; + +/**< Add in that list all tasks that never send a ACI/HCI command */ +typedef enum +{ + CFG_FIRST_TASK_ID_WITH_NO_HCICMD = CFG_LAST_TASK_ID_WITH_HCICMD - 1, /**< Shall be FIRST in the list */ + CFG_TASK_SYSTEM_HCI_ASYNCH_EVT_ID, + /* USER CODE BEGIN CFG_Task_Id_With_NO_HCI_Cmd_t */ + + /* USER CODE END CFG_Task_Id_With_NO_HCI_Cmd_t */ + CFG_LAST_TASK_ID_WITH_NO_HCICMD /**< Shall be LAST in the list */ +} CFG_Task_Id_With_NO_HCI_Cmd_t; + +#define CFG_TASK_NBR CFG_LAST_TASK_ID_WITH_NO_HCICMD + +/** + * This is the list of priority required by the application + * Each Id shall be in the range 0..31 + */ +typedef enum +{ + CFG_SCH_PRIO_0, + /* USER CODE BEGIN CFG_SCH_Prio_Id_t */ + + /* USER CODE END CFG_SCH_Prio_Id_t */ +} CFG_SCH_Prio_Id_t; + +/** + * This is a bit mapping over 32bits listing all events id supported in the application + */ +typedef enum +{ + CFG_IDLEEVT_SYSTEM_HCI_CMD_EVT_RSP_ID, + /* USER CODE BEGIN CFG_IdleEvt_Id_t */ + + /* USER CODE END CFG_IdleEvt_Id_t */ +} CFG_IdleEvt_Id_t; + +/****************************************************************************** + * LOW POWER + ******************************************************************************/ +/** + * Supported requester to the MCU Low Power Manager - can be increased up to 32 + * It list a bit mapping of all user of the Low Power Manager + */ +typedef enum +{ + CFG_LPM_APP, + CFG_LPM_APP_BLE, + /* USER CODE BEGIN CFG_LPM_Id_t */ + + /* USER CODE END CFG_LPM_Id_t */ +} CFG_LPM_Id_t; + +/****************************************************************************** + * OTP manager + ******************************************************************************/ +#define CFG_OTP_BASE_ADDRESS OTP_AREA_BASE + +#define CFG_OTP_END_ADRESS OTP_AREA_END_ADDR + +#endif +#endif /*APP_CONF_DEFAULT_H */ diff --git a/src/utility/STM32Cube_FW/ble_bufsize.h b/src/utility/STM32Cube_FW/ble_bufsize.h new file mode 100644 index 00000000..d4d28907 --- /dev/null +++ b/src/utility/STM32Cube_FW/ble_bufsize.h @@ -0,0 +1,182 @@ +/***************************************************************************** + * @file ble_bufsize.h + * @author MDG + * @brief Definition of BLE stack buffers size + ***************************************************************************** + * @attention + * + * Copyright (c) 2018-2023 STMicroelectronics. + * All rights reserved. + * + * This software is licensed under terms that can be found in the LICENSE file + * in the root directory of this software component. + * If no LICENSE file comes with this software, it is provided AS-IS. + * + ***************************************************************************** + */ + +#ifndef BLE_BUFSIZE_H__ +#define BLE_BUFSIZE_H__ + + +/* + * BLE_DEFAULT_ATT_MTU: minimum MTU value that GATT must support. + */ +#define BLE_DEFAULT_ATT_MTU 23 + +/* + * BLE_DEFAULT_MAX_ATT_SIZE: maximum attribute size. + */ +#define BLE_DEFAULT_MAX_ATT_SIZE 512 + +/* + * BLE_PREP_WRITE_X_ATT: compute how many Prepare Write Request are needed to + * write a characteristic with size 'max_att' when the used ATT_MTU value is + * equal to BLE_DEFAULT_ATT_MTU (23). + */ +#define BLE_PREP_WRITE_X_ATT(max_att) \ + (DIVC(max_att, BLE_DEFAULT_ATT_MTU - 5) * 2) + +/* + * BLE_DEFAULT_PREP_WRITE_LIST_SIZE: default minimum Prepare Write List size. + */ +#define BLE_DEFAULT_PREP_WRITE_LIST_SIZE \ + BLE_PREP_WRITE_X_ATT(BLE_DEFAULT_MAX_ATT_SIZE) + +/* + * BLE_MEM_BLOCK_X_MTU: compute how many memory blocks are needed to compose + * an ATT packet with ATT_MTU=mtu. + */ +#define BLE_MEM_BLOCK_SIZE 32 + +#define BLE_MEM_BLOCK_X_TX(mtu) \ + (DIVC((mtu) + 4U, BLE_MEM_BLOCK_SIZE) + 1U) + +#define BLE_MEM_BLOCK_X_RX(mtu, n_link) \ + ((DIVC((mtu) + 4U, BLE_MEM_BLOCK_SIZE) + 2U) * (n_link) + 1) + +#define BLE_MEM_BLOCK_X_MTU(mtu, n_link) \ + (BLE_MEM_BLOCK_X_TX(mtu) + BLE_MEM_BLOCK_X_RX(mtu, n_link)) + +/* + * BLE_MBLOCKS_SECURE_CONNECTIONS: minimum number of blocks required for + * secure connections + */ +#define BLE_MBLOCKS_SECURE_CONNECTIONS 4 + +/* + * BLE_MBLOCKS_CALC: minimum number of buffers needed by the stack. + * This is the minimum racomanded value and depends on: + * - pw: size of Prepare Write List + * - mtu: ATT_MTU size + * - n_link: maximum number of simultaneous connections + */ +#define BLE_MBLOCKS_CALC(pw, mtu, n_link) \ + ((pw) + MAX(BLE_MEM_BLOCK_X_MTU(mtu, n_link), \ + BLE_MBLOCKS_SECURE_CONNECTIONS)) + +/* + * BLE_DEFAULT_MBLOCKS_COUNT: default memory blocks count + */ +#define BLE_DEFAULT_MBLOCKS_COUNT(n_link) \ + BLE_MBLOCKS_CALC(BLE_DEFAULT_PREP_WRITE_LIST_SIZE, \ + BLE_DEFAULT_MAX_ATT_MTU, n_link) + +/* + * BLE_FIXED_BUFFER_SIZE_BYTES: + * A part of the RAM, is dynamically allocated by initializing all the pointers + * defined in a global context variable "mem_alloc_ctx_p". + * This initialization is made in the Dynamic_allocator functions, which + * assign a portion of RAM given by the external application to the above + * mentioned "global pointers". + * + * The size of this Dynamic RAM is made of 2 main components: + * - a part that is parameters-dependent (num of links, GATT buffers, ...), + * and which value is made explicit by the following macro; + * - a part, that may be considered "fixed", i.e. independent from the above + * mentioned parameters. +*/ +#if (BEACON_ONLY != 0) +#define BLE_FIXED_BUFFER_SIZE_BYTES 4092 /* Beacon only */ +#elif (LL_ONLY_BASIC != 0) +#define BLE_FIXED_BUFFER_SIZE_BYTES 5788 /* LL only Basic*/ +#elif (LL_ONLY != 0) +#define BLE_FIXED_BUFFER_SIZE_BYTES 6036 /* LL only Full */ +#elif (SLAVE_ONLY != 0) +#define BLE_FIXED_BUFFER_SIZE_BYTES 6300 /* Peripheral only */ +#elif (BASIC_FEATURES != 0) +#define BLE_FIXED_BUFFER_SIZE_BYTES 6632 /* Basic Features */ +#else +#define BLE_FIXED_BUFFER_SIZE_BYTES 7152 /* Full stack */ +#endif + +/* + * BLE_PER_LINK_SIZE_BYTES: additional memory size used per link + */ +#if (BEACON_ONLY != 0) +#define BLE_PER_LINK_SIZE_BYTES 112 /* Beacon only */ +#elif (LL_ONLY_BASIC != 0) +#define BLE_PER_LINK_SIZE_BYTES 244 /* LL only Basic */ +#elif (LL_ONLY != 0) +#define BLE_PER_LINK_SIZE_BYTES 244 /* LL only Full */ +#elif (SLAVE_ONLY != 0) +#define BLE_PER_LINK_SIZE_BYTES 344 /* Peripheral only */ +#elif (BASIC_FEATURES != 0) +#define BLE_PER_LINK_SIZE_BYTES 420 /* Basic Features */ +#else +#define BLE_PER_LINK_SIZE_BYTES 432 /* Full stack */ +#endif + +/* + * BLE_TOTAL_BUFFER_SIZE: this macro returns the amount of memory, in bytes, + * needed for the storage of data structures (except GATT database elements) + * whose size depends on the number of supported connections. + * + * @param n_link: Maximum number of simultaneous connections that the device + * will support. Valid values are from 1 to 8. + * + * @param mblocks_count: Number of memory blocks allocated for packets. + */ +#define BLE_TOTAL_BUFFER_SIZE(n_link, mblocks_count) \ + (16 + BLE_FIXED_BUFFER_SIZE_BYTES + \ + (BLE_PER_LINK_SIZE_BYTES * (n_link)) + \ + ((BLE_MEM_BLOCK_SIZE + 12) * (mblocks_count))) + +/* + * BLE_EXT_ADV_BUFFER_SIZE + * additional memory size used for Extended advertising; + * It has to be added to BLE_TOTAL_BUFFER_SIZE() if the Extended advertising + * feature is used. + * + * @param set_nbr: Maximum number of advertising sets. + * Valid values are from 1 to 8. + * + * @param data_len: Maximum size of advertising data. + * Valid values are from 31 to 1650. + */ +#define BLE_EXT_ADV_BUFFER_SIZE(set_nbr, data_len) \ + (2512 + ((892 + (DIVC(data_len, 207) * 244)) * (set_nbr))) + +/* + * BLE_TOTAL_BUFFER_SIZE_GATT: this macro returns the amount of memory, + * in bytes, needed for the storage of GATT database elements. + * + * @param num_gatt_attributes: Maximum number of Attributes (i.e. the number + * of characteristic + the number of characteristic values + the number of + * descriptors, excluding the services) that can be stored in the GATT + * database. Note that certain characteristics and relative descriptors are + * added automatically during device initialization so this parameters should + * be 9 plus the number of user Attributes + * + * @param num_gatt_services: Maximum number of Services that can be stored in + * the GATT database. Note that the GAP and GATT services are automatically + * added so this parameter should be 2 plus the number of user services + * + * @param att_value_array_size: Size of the storage area for Attribute values. + */ +#define BLE_TOTAL_BUFFER_SIZE_GATT(num_gatt_attributes, num_gatt_services, att_value_array_size) \ + (((((att_value_array_size) - 1) | 3) + 1) + \ + (40 * (num_gatt_attributes)) + (48 * (num_gatt_services))) + + +#endif /* BLE_BUFSIZE_H__ */ diff --git a/src/utility/STM32Cube_FW/hw.h b/src/utility/STM32Cube_FW/hw.h new file mode 100644 index 00000000..1472a5e8 --- /dev/null +++ b/src/utility/STM32Cube_FW/hw.h @@ -0,0 +1,114 @@ +/** + ****************************************************************************** + * @file hw.h + * @author MCD Application Team + * @brief Hardware + ****************************************************************************** + * @attention + * + * Copyright (c) 2018-2021 STMicroelectronics. + * All rights reserved. + * + * This software is licensed under terms that can be found in the LICENSE file + * in the root directory of this software component. + * If no LICENSE file comes with this software, it is provided AS-IS. + * + ****************************************************************************** + */ + + +/* Define to prevent recursive inclusion -------------------------------------*/ +#ifndef __HW_H +#define __HW_H + +#ifdef __cplusplus +extern "C" { +#endif + + /* Includes ------------------------------------------------------------------*/ +#include "stm32_def.h" +#include "stm32wbxx_ll_bus.h" +#include "stm32wbxx_ll_exti.h" +#include "stm32wbxx_ll_system.h" +#include "stm32wbxx_ll_rcc.h" +#include "stm32wbxx_ll_ipcc.h" +#include "stm32wbxx_ll_cortex.h" +#include "stm32wbxx_ll_utils.h" +#include "stm32wbxx_ll_pwr.h" + + /****************************************************************************** + * HW IPCC + ******************************************************************************/ + void HW_IPCC_Enable( void ); + void HW_IPCC_Init( void ); +#define HW_IPCC_Rx_Handler IPCC_C1_RX_IRQHandler +#define HW_IPCC_Tx_Handler IPCC_C1_TX_IRQHandler + + void HW_IPCC_BLE_Init( void ); + void HW_IPCC_BLE_SendCmd( void ); + void HW_IPCC_MM_SendFreeBuf( void (*cb)( void ) ); + void HW_IPCC_BLE_RxEvtNot( void ); + void HW_IPCC_BLE_SendAclData( void ); + void HW_IPCC_BLE_AclDataAckNot( void ); + + void HW_IPCC_SYS_Init( void ); + void HW_IPCC_SYS_SendCmd( void ); + void HW_IPCC_SYS_CmdEvtNot( void ); + void HW_IPCC_SYS_EvtNot( void ); + + void HW_IPCC_THREAD_Init( void ); + void HW_IPCC_OT_SendCmd( void ); + void HW_IPCC_CLI_SendCmd( void ); + void HW_IPCC_THREAD_SendAck( void ); + void HW_IPCC_OT_CmdEvtNot( void ); + void HW_IPCC_CLI_CmdEvtNot( void ); + void HW_IPCC_THREAD_EvtNot( void ); + void HW_IPCC_THREAD_CliSendAck( void ); + void HW_IPCC_THREAD_CliEvtNot( void ); + + + void HW_IPCC_LLDTESTS_Init( void ); + void HW_IPCC_LLDTESTS_SendCliCmd( void ); + void HW_IPCC_LLDTESTS_ReceiveCliRsp( void ); + void HW_IPCC_LLDTESTS_SendCliRspAck( void ); + void HW_IPCC_LLDTESTS_ReceiveM0Cmd( void ); + void HW_IPCC_LLDTESTS_SendM0CmdAck( void ); + + + void HW_IPCC_BLE_LLD_Init( void ); + void HW_IPCC_BLE_LLD_SendCliCmd( void ); + void HW_IPCC_BLE_LLD_ReceiveCliRsp( void ); + void HW_IPCC_BLE_LLD_SendCliRspAck( void ); + void HW_IPCC_BLE_LLD_ReceiveM0Cmd( void ); + void HW_IPCC_BLE_LLD_SendM0CmdAck( void ); + void HW_IPCC_BLE_LLD_SendCmd( void ); + void HW_IPCC_BLE_LLD_ReceiveRsp( void ); + void HW_IPCC_BLE_LLD_SendRspAck( void ); + + + void HW_IPCC_TRACES_Init( void ); + void HW_IPCC_TRACES_EvtNot( void ); + + void HW_IPCC_MAC_802_15_4_Init( void ); + void HW_IPCC_MAC_802_15_4_SendCmd( void ); + void HW_IPCC_MAC_802_15_4_SendAck( void ); + void HW_IPCC_MAC_802_15_4_CmdEvtNot( void ); + void HW_IPCC_MAC_802_15_4_EvtNot( void ); + + void HW_IPCC_ZIGBEE_Init( void ); + + void HW_IPCC_ZIGBEE_SendM4RequestToM0(void); /* M4 Request to M0 */ + void HW_IPCC_ZIGBEE_RecvAppliAckFromM0(void); /* Request ACK from M0 */ + + void HW_IPCC_ZIGBEE_RecvM0NotifyToM4(void); /* M0 Notify to M4 */ + void HW_IPCC_ZIGBEE_SendM4AckToM0Notify(void); /* Notify ACK from M4 */ + void HW_IPCC_ZIGBEE_RecvM0RequestToM4(void); /* M0 Request to M4 */ + void HW_IPCC_ZIGBEE_SendM4AckToM0Request(void); /* Request ACK from M4 */ + + +#ifdef __cplusplus +} +#endif + +#endif /*__HW_H */ + diff --git a/src/utility/STM32Cube_FW/hw_ipcc.c b/src/utility/STM32Cube_FW/hw_ipcc.c new file mode 100644 index 00000000..c7304823 --- /dev/null +++ b/src/utility/STM32Cube_FW/hw_ipcc.c @@ -0,0 +1,670 @@ +/* USER CODE BEGIN Header */ +/** + ****************************************************************************** + * @file hw_ipcc.c + * @author MCD Application Team + * @brief Hardware IPCC source file for STM32WPAN Middleware. + ****************************************************************************** + * @attention + * + * Copyright (c) 2020-2021 STMicroelectronics. + * All rights reserved. + * + * This software is licensed under terms that can be found in the LICENSE file + * in the root directory of this software component. + * If no LICENSE file comes with this software, it is provided AS-IS. + * + ****************************************************************************** + */ +/* USER CODE END Header */ +#if defined(STM32WBxx) +/* Includes ------------------------------------------------------------------*/ +#include "hw.h" +#include "mbox_def.h" + +/* Global variables ---------------------------------------------------------*/ +/* Private defines -----------------------------------------------------------*/ +#define HW_IPCC_TX_PENDING( channel ) ( !(LL_C1_IPCC_IsActiveFlag_CHx( IPCC, channel )) ) && (((~(IPCC->C1MR)) & (channel << 16U))) +#define HW_IPCC_RX_PENDING( channel ) (LL_C2_IPCC_IsActiveFlag_CHx( IPCC, channel )) && (((~(IPCC->C1MR)) & (channel << 0U))) + +/* Private macros ------------------------------------------------------------*/ +/* Private typedef -----------------------------------------------------------*/ +/* Private variables ---------------------------------------------------------*/ +static void (*FreeBufCb)( void ); + +/* Private function prototypes -----------------------------------------------*/ +static void HW_IPCC_BLE_EvtHandler( void ); +static void HW_IPCC_BLE_AclDataEvtHandler( void ); +static void HW_IPCC_MM_FreeBufHandler( void ); +static void HW_IPCC_SYS_CmdEvtHandler( void ); +static void HW_IPCC_SYS_EvtHandler( void ); +static void HW_IPCC_TRACES_EvtHandler( void ); + +#ifdef THREAD_WB +static void HW_IPCC_OT_CmdEvtHandler( void ); +static void HW_IPCC_THREAD_NotEvtHandler( void ); +static void HW_IPCC_THREAD_CliNotEvtHandler( void ); +#endif + +#ifdef LLD_TESTS_WB +static void HW_IPCC_LLDTESTS_ReceiveCliRspHandler( void ); +static void HW_IPCC_LLDTESTS_ReceiveM0CmdHandler( void ); +#endif +#ifdef LLD_BLE_WB +/*static void HW_IPCC_LLD_BLE_ReceiveCliRspHandler( void );*/ +static void HW_IPCC_LLD_BLE_ReceiveRspHandler( void ); +static void HW_IPCC_LLD_BLE_ReceiveM0CmdHandler( void ); +#endif + +#ifdef MAC_802_15_4_WB +static void HW_IPCC_MAC_802_15_4_CmdEvtHandler( void ); +static void HW_IPCC_MAC_802_15_4_NotEvtHandler( void ); +#endif + +#ifdef ZIGBEE_WB +static void HW_IPCC_ZIGBEE_CmdEvtHandler( void ); +static void HW_IPCC_ZIGBEE_StackNotifEvtHandler( void ); +static void HW_IPCC_ZIGBEE_StackM0RequestHandler( void ); +#endif + +/* Public function definition -----------------------------------------------*/ + +/****************************************************************************** + * INTERRUPT HANDLER + ******************************************************************************/ +void HW_IPCC_Rx_Handler( void ) +{ + if (HW_IPCC_RX_PENDING( HW_IPCC_SYSTEM_EVENT_CHANNEL )) + { + HW_IPCC_SYS_EvtHandler(); + } +#ifdef MAC_802_15_4_WB + else if (HW_IPCC_RX_PENDING( HW_IPCC_MAC_802_15_4_NOTIFICATION_ACK_CHANNEL )) + { + HW_IPCC_MAC_802_15_4_NotEvtHandler(); + } +#endif /* MAC_802_15_4_WB */ +#ifdef THREAD_WB + else if (HW_IPCC_RX_PENDING( HW_IPCC_THREAD_NOTIFICATION_ACK_CHANNEL )) + { + HW_IPCC_THREAD_NotEvtHandler(); + } + else if (HW_IPCC_RX_PENDING( HW_IPCC_THREAD_CLI_NOTIFICATION_ACK_CHANNEL )) + { + HW_IPCC_THREAD_CliNotEvtHandler(); + } +#endif /* THREAD_WB */ +#ifdef LLD_TESTS_WB + else if (HW_IPCC_RX_PENDING( HW_IPCC_LLDTESTS_CLI_RSP_CHANNEL )) + { + HW_IPCC_LLDTESTS_ReceiveCliRspHandler(); + } + else if (HW_IPCC_RX_PENDING( HW_IPCC_LLDTESTS_M0_CMD_CHANNEL )) + { + HW_IPCC_LLDTESTS_ReceiveM0CmdHandler(); + } +#endif /* LLD_TESTS_WB */ +#ifdef LLD_BLE_WB + else if (HW_IPCC_RX_PENDING( HW_IPCC_LLD_BLE_RSP_CHANNEL )) + { + HW_IPCC_LLD_BLE_ReceiveRspHandler(); + } + else if (HW_IPCC_RX_PENDING( HW_IPCC_LLD_BLE_M0_CMD_CHANNEL )) + { + HW_IPCC_LLD_BLE_ReceiveM0CmdHandler(); + } +#endif /* LLD_TESTS_WB */ +#ifdef ZIGBEE_WB + else if (HW_IPCC_RX_PENDING( HW_IPCC_ZIGBEE_APPLI_NOTIF_ACK_CHANNEL )) + { + HW_IPCC_ZIGBEE_StackNotifEvtHandler(); + } + else if (HW_IPCC_RX_PENDING( HW_IPCC_ZIGBEE_M0_REQUEST_CHANNEL )) + { + HW_IPCC_ZIGBEE_StackM0RequestHandler(); + } +#endif /* ZIGBEE_WB */ + else if (HW_IPCC_RX_PENDING( HW_IPCC_BLE_EVENT_CHANNEL )) + { + HW_IPCC_BLE_EvtHandler(); + } + else if (HW_IPCC_RX_PENDING( HW_IPCC_TRACES_CHANNEL )) + { + HW_IPCC_TRACES_EvtHandler(); + } + + return; +} + +void HW_IPCC_Tx_Handler( void ) +{ + if (HW_IPCC_TX_PENDING( HW_IPCC_SYSTEM_CMD_RSP_CHANNEL )) + { + HW_IPCC_SYS_CmdEvtHandler(); + } +#ifdef MAC_802_15_4_WB + else if (HW_IPCC_TX_PENDING( HW_IPCC_MAC_802_15_4_CMD_RSP_CHANNEL )) + { + HW_IPCC_MAC_802_15_4_CmdEvtHandler(); + } +#endif /* MAC_802_15_4_WB */ +#ifdef THREAD_WB + else if (HW_IPCC_TX_PENDING( HW_IPCC_THREAD_OT_CMD_RSP_CHANNEL )) + { + HW_IPCC_OT_CmdEvtHandler(); + } +#endif /* THREAD_WB */ +#ifdef LLD_TESTS_WB +// No TX handler for LLD tests +#endif /* LLD_TESTS_WB */ +#ifdef ZIGBEE_WB + if (HW_IPCC_TX_PENDING( HW_IPCC_ZIGBEE_CMD_APPLI_CHANNEL )) + { + HW_IPCC_ZIGBEE_CmdEvtHandler(); + } +#endif /* ZIGBEE_WB */ + else if (HW_IPCC_TX_PENDING( HW_IPCC_MM_RELEASE_BUFFER_CHANNEL )) + { + HW_IPCC_MM_FreeBufHandler(); + } + else if (HW_IPCC_TX_PENDING( HW_IPCC_HCI_ACL_DATA_CHANNEL )) + { + HW_IPCC_BLE_AclDataEvtHandler(); + } + + return; +} +/****************************************************************************** + * GENERAL + ******************************************************************************/ +void HW_IPCC_Enable( void ) +{ + /** + * Such as IPCC IP available to the CPU2, it is required to keep the IPCC clock running + * when FUS is running on CPU2 and CPU1 enters deep sleep mode + */ + LL_C2_AHB3_GRP1_EnableClock(LL_C2_AHB3_GRP1_PERIPH_IPCC); + + /** + * When the device is out of standby, it is required to use the EXTI mechanism to wakeup CPU2 + */ + LL_EXTI_EnableRisingTrig_32_63( LL_EXTI_LINE_41 ); + /* It is required to have at least a system clock cycle before a SEV after LL_EXTI_EnableRisingTrig_32_63() */ + LL_C2_EXTI_EnableEvent_32_63( LL_EXTI_LINE_41 ); + + /** + * In case the SBSFU is implemented, it may have already set the C2BOOT bit to startup the CPU2. + * In that case, to keep the mechanism transparent to the user application, it shall call the system command + * SHCI_C2_Reinit( ) before jumping to the application. + * When the CPU2 receives that command, it waits for its event input to be set to restart the CPU2 firmware. + * This is required because once C2BOOT has been set once, a clear/set on C2BOOT has no effect. + * When SHCI_C2_Reinit( ) is not called, generating an event to the CPU2 does not have any effect + * So, by default, the application shall both set the event flag and set the C2BOOT bit. + */ + __SEV( ); /* Set the internal event flag and send an event to the CPU2 */ + __WFE( ); /* Clear the internal event flag */ + LL_PWR_EnableBootC2( ); + + return; +} + +void HW_IPCC_Init( void ) +{ + LL_AHB3_GRP1_EnableClock( LL_AHB3_GRP1_PERIPH_IPCC ); + + LL_C1_IPCC_EnableIT_RXO( IPCC ); + LL_C1_IPCC_EnableIT_TXF( IPCC ); + + HAL_NVIC_EnableIRQ(IPCC_C1_RX_IRQn); + HAL_NVIC_EnableIRQ(IPCC_C1_TX_IRQn); + + return; +} + +/****************************************************************************** + * BLE + ******************************************************************************/ +void HW_IPCC_BLE_Init( void ) +{ + LL_C1_IPCC_EnableReceiveChannel( IPCC, HW_IPCC_BLE_EVENT_CHANNEL ); + + return; +} + +void HW_IPCC_BLE_SendCmd( void ) +{ + LL_C1_IPCC_SetFlag_CHx( IPCC, HW_IPCC_BLE_CMD_CHANNEL ); + + return; +} + +static void HW_IPCC_BLE_EvtHandler( void ) +{ + HW_IPCC_BLE_RxEvtNot(); + + LL_C1_IPCC_ClearFlag_CHx( IPCC, HW_IPCC_BLE_EVENT_CHANNEL ); + + return; +} + +void HW_IPCC_BLE_SendAclData( void ) +{ + LL_C1_IPCC_SetFlag_CHx( IPCC, HW_IPCC_HCI_ACL_DATA_CHANNEL ); + LL_C1_IPCC_EnableTransmitChannel( IPCC, HW_IPCC_HCI_ACL_DATA_CHANNEL ); + + return; +} + +static void HW_IPCC_BLE_AclDataEvtHandler( void ) +{ + LL_C1_IPCC_DisableTransmitChannel( IPCC, HW_IPCC_HCI_ACL_DATA_CHANNEL ); + + HW_IPCC_BLE_AclDataAckNot(); + + return; +} + +__weak void HW_IPCC_BLE_AclDataAckNot( void ){}; +__weak void HW_IPCC_BLE_RxEvtNot( void ){}; + +/****************************************************************************** + * SYSTEM + ******************************************************************************/ +void HW_IPCC_SYS_Init( void ) +{ + LL_C1_IPCC_EnableReceiveChannel( IPCC, HW_IPCC_SYSTEM_EVENT_CHANNEL ); + + return; +} + +void HW_IPCC_SYS_SendCmd( void ) +{ + LL_C1_IPCC_SetFlag_CHx( IPCC, HW_IPCC_SYSTEM_CMD_RSP_CHANNEL ); + LL_C1_IPCC_EnableTransmitChannel( IPCC, HW_IPCC_SYSTEM_CMD_RSP_CHANNEL ); + + return; +} + +static void HW_IPCC_SYS_CmdEvtHandler( void ) +{ + LL_C1_IPCC_DisableTransmitChannel( IPCC, HW_IPCC_SYSTEM_CMD_RSP_CHANNEL ); + + HW_IPCC_SYS_CmdEvtNot(); + + return; +} + +static void HW_IPCC_SYS_EvtHandler( void ) +{ + HW_IPCC_SYS_EvtNot(); + + LL_C1_IPCC_ClearFlag_CHx( IPCC, HW_IPCC_SYSTEM_EVENT_CHANNEL ); + + return; +} + +__weak void HW_IPCC_SYS_CmdEvtNot( void ){}; +__weak void HW_IPCC_SYS_EvtNot( void ){}; + +/****************************************************************************** + * MAC 802.15.4 + ******************************************************************************/ +#ifdef MAC_802_15_4_WB +void HW_IPCC_MAC_802_15_4_Init( void ) +{ + LL_C1_IPCC_EnableReceiveChannel( IPCC, HW_IPCC_MAC_802_15_4_NOTIFICATION_ACK_CHANNEL ); + + return; +} + +void HW_IPCC_MAC_802_15_4_SendCmd( void ) +{ + LL_C1_IPCC_SetFlag_CHx( IPCC, HW_IPCC_MAC_802_15_4_CMD_RSP_CHANNEL ); + LL_C1_IPCC_EnableTransmitChannel( IPCC, HW_IPCC_MAC_802_15_4_CMD_RSP_CHANNEL ); + + return; +} + +void HW_IPCC_MAC_802_15_4_SendAck( void ) +{ + LL_C1_IPCC_ClearFlag_CHx( IPCC, HW_IPCC_MAC_802_15_4_NOTIFICATION_ACK_CHANNEL ); + LL_C1_IPCC_EnableReceiveChannel( IPCC, HW_IPCC_MAC_802_15_4_NOTIFICATION_ACK_CHANNEL ); + + return; +} + +static void HW_IPCC_MAC_802_15_4_CmdEvtHandler( void ) +{ + LL_C1_IPCC_DisableTransmitChannel( IPCC, HW_IPCC_MAC_802_15_4_CMD_RSP_CHANNEL ); + + HW_IPCC_MAC_802_15_4_CmdEvtNot(); + + return; +} + +static void HW_IPCC_MAC_802_15_4_NotEvtHandler( void ) +{ + LL_C1_IPCC_DisableReceiveChannel( IPCC, HW_IPCC_MAC_802_15_4_NOTIFICATION_ACK_CHANNEL ); + + HW_IPCC_MAC_802_15_4_EvtNot(); + + return; +} +__weak void HW_IPCC_MAC_802_15_4_CmdEvtNot( void ){}; +__weak void HW_IPCC_MAC_802_15_4_EvtNot( void ){}; +#endif + +/****************************************************************************** + * THREAD + ******************************************************************************/ +#ifdef THREAD_WB +void HW_IPCC_THREAD_Init( void ) +{ + LL_C1_IPCC_EnableReceiveChannel( IPCC, HW_IPCC_THREAD_NOTIFICATION_ACK_CHANNEL ); + LL_C1_IPCC_EnableReceiveChannel( IPCC, HW_IPCC_THREAD_CLI_NOTIFICATION_ACK_CHANNEL ); + + return; +} + +void HW_IPCC_OT_SendCmd( void ) +{ + LL_C1_IPCC_SetFlag_CHx( IPCC, HW_IPCC_THREAD_OT_CMD_RSP_CHANNEL ); + LL_C1_IPCC_EnableTransmitChannel( IPCC, HW_IPCC_THREAD_OT_CMD_RSP_CHANNEL ); + + return; +} + +void HW_IPCC_CLI_SendCmd( void ) +{ + LL_C1_IPCC_SetFlag_CHx( IPCC, HW_IPCC_THREAD_CLI_CMD_CHANNEL ); + + return; +} + +void HW_IPCC_THREAD_SendAck( void ) +{ + LL_C1_IPCC_ClearFlag_CHx( IPCC, HW_IPCC_THREAD_NOTIFICATION_ACK_CHANNEL ); + LL_C1_IPCC_EnableReceiveChannel( IPCC, HW_IPCC_THREAD_NOTIFICATION_ACK_CHANNEL ); + + return; +} + +void HW_IPCC_THREAD_CliSendAck( void ) +{ + LL_C1_IPCC_ClearFlag_CHx( IPCC, HW_IPCC_THREAD_CLI_NOTIFICATION_ACK_CHANNEL ); + LL_C1_IPCC_EnableReceiveChannel( IPCC, HW_IPCC_THREAD_CLI_NOTIFICATION_ACK_CHANNEL ); + + return; +} + +static void HW_IPCC_OT_CmdEvtHandler( void ) +{ + LL_C1_IPCC_DisableTransmitChannel( IPCC, HW_IPCC_THREAD_OT_CMD_RSP_CHANNEL ); + + HW_IPCC_OT_CmdEvtNot(); + + return; +} + +static void HW_IPCC_THREAD_NotEvtHandler( void ) +{ + LL_C1_IPCC_DisableReceiveChannel( IPCC, HW_IPCC_THREAD_NOTIFICATION_ACK_CHANNEL ); + + HW_IPCC_THREAD_EvtNot(); + + return; +} + +static void HW_IPCC_THREAD_CliNotEvtHandler( void ) +{ + LL_C1_IPCC_DisableReceiveChannel( IPCC, HW_IPCC_THREAD_CLI_NOTIFICATION_ACK_CHANNEL ); + + HW_IPCC_THREAD_CliEvtNot(); + + return; +} + +__weak void HW_IPCC_OT_CmdEvtNot( void ){}; +__weak void HW_IPCC_CLI_CmdEvtNot( void ){}; +__weak void HW_IPCC_THREAD_EvtNot( void ){}; + +#endif /* THREAD_WB */ + +/****************************************************************************** + * LLD TESTS + ******************************************************************************/ +#ifdef LLD_TESTS_WB +void HW_IPCC_LLDTESTS_Init( void ) +{ + LL_C1_IPCC_EnableReceiveChannel( IPCC, HW_IPCC_LLDTESTS_CLI_RSP_CHANNEL ); + LL_C1_IPCC_EnableReceiveChannel( IPCC, HW_IPCC_LLDTESTS_M0_CMD_CHANNEL ); + return; +} + +void HW_IPCC_LLDTESTS_SendCliCmd( void ) +{ + LL_C1_IPCC_SetFlag_CHx( IPCC, HW_IPCC_LLDTESTS_CLI_CMD_CHANNEL ); + return; +} + +static void HW_IPCC_LLDTESTS_ReceiveCliRspHandler( void ) +{ + LL_C1_IPCC_DisableReceiveChannel( IPCC, HW_IPCC_LLDTESTS_CLI_RSP_CHANNEL ); + HW_IPCC_LLDTESTS_ReceiveCliRsp(); + return; +} + +void HW_IPCC_LLDTESTS_SendCliRspAck( void ) +{ + LL_C1_IPCC_ClearFlag_CHx( IPCC, HW_IPCC_LLDTESTS_CLI_RSP_CHANNEL ); + LL_C1_IPCC_EnableReceiveChannel( IPCC, HW_IPCC_LLDTESTS_CLI_RSP_CHANNEL ); + return; +} + +static void HW_IPCC_LLDTESTS_ReceiveM0CmdHandler( void ) +{ + LL_C1_IPCC_DisableReceiveChannel( IPCC, HW_IPCC_LLDTESTS_M0_CMD_CHANNEL ); + HW_IPCC_LLDTESTS_ReceiveM0Cmd(); + return; +} + +void HW_IPCC_LLDTESTS_SendM0CmdAck( void ) +{ + LL_C1_IPCC_ClearFlag_CHx( IPCC, HW_IPCC_LLDTESTS_M0_CMD_CHANNEL ); + LL_C1_IPCC_EnableReceiveChannel( IPCC, HW_IPCC_LLDTESTS_M0_CMD_CHANNEL ); + return; +} +__weak void HW_IPCC_LLDTESTS_ReceiveCliRsp( void ){}; +__weak void HW_IPCC_LLDTESTS_ReceiveM0Cmd( void ){}; +#endif /* LLD_TESTS_WB */ + +/****************************************************************************** + * LLD BLE + ******************************************************************************/ +#ifdef LLD_BLE_WB +void HW_IPCC_LLD_BLE_Init( void ) +{ + LL_C1_IPCC_EnableReceiveChannel( IPCC, HW_IPCC_LLD_BLE_RSP_CHANNEL ); + LL_C1_IPCC_EnableReceiveChannel( IPCC, HW_IPCC_LLD_BLE_M0_CMD_CHANNEL ); + return; +} + +void HW_IPCC_LLD_BLE_SendCliCmd( void ) +{ + LL_C1_IPCC_SetFlag_CHx( IPCC, HW_IPCC_LLD_BLE_CLI_CMD_CHANNEL ); + return; +} + +/*static void HW_IPCC_LLD_BLE_ReceiveCliRspHandler( void ) +{ + LL_C1_IPCC_DisableReceiveChannel( IPCC, HW_IPCC_LLD_BLE_CLI_RSP_CHANNEL ); + HW_IPCC_LLD_BLE_ReceiveCliRsp(); + return; +}*/ + +void HW_IPCC_LLD_BLE_SendCliRspAck( void ) +{ + LL_C1_IPCC_ClearFlag_CHx( IPCC, HW_IPCC_LLD_BLE_CLI_RSP_CHANNEL ); + LL_C1_IPCC_EnableReceiveChannel( IPCC, HW_IPCC_LLD_BLE_CLI_RSP_CHANNEL ); + return; +} + +static void HW_IPCC_LLD_BLE_ReceiveM0CmdHandler( void ) +{ + //LL_C1_IPCC_DisableReceiveChannel( IPCC, HW_IPCC_LLD_BLE_M0_CMD_CHANNEL ); + HW_IPCC_LLD_BLE_ReceiveM0Cmd(); + return; +} + +void HW_IPCC_LLD_BLE_SendM0CmdAck( void ) +{ + LL_C1_IPCC_ClearFlag_CHx( IPCC, HW_IPCC_LLD_BLE_M0_CMD_CHANNEL ); + //LL_C1_IPCC_EnableReceiveChannel( IPCC, HW_IPCC_LLD_BLE_M0_CMD_CHANNEL ); + return; +} +__weak void HW_IPCC_LLD_BLE_ReceiveCliRsp( void ){}; +__weak void HW_IPCC_LLD_BLE_ReceiveM0Cmd( void ){}; + +/* Transparent Mode */ +void HW_IPCC_LLD_BLE_SendCmd( void ) +{ + LL_C1_IPCC_SetFlag_CHx( IPCC, HW_IPCC_LLD_BLE_CMD_CHANNEL ); + return; +} + +static void HW_IPCC_LLD_BLE_ReceiveRspHandler( void ) +{ + LL_C1_IPCC_DisableReceiveChannel( IPCC, HW_IPCC_LLD_BLE_RSP_CHANNEL ); + HW_IPCC_LLD_BLE_ReceiveRsp(); + return; +} + +void HW_IPCC_LLD_BLE_SendRspAck( void ) +{ + LL_C1_IPCC_ClearFlag_CHx( IPCC, HW_IPCC_LLD_BLE_RSP_CHANNEL ); + LL_C1_IPCC_EnableReceiveChannel( IPCC, HW_IPCC_LLD_BLE_RSP_CHANNEL ); + return; +} + +#endif /* LLD_BLE_WB */ + +/****************************************************************************** + * ZIGBEE + ******************************************************************************/ +#ifdef ZIGBEE_WB +void HW_IPCC_ZIGBEE_Init( void ) +{ + LL_C1_IPCC_EnableReceiveChannel( IPCC, HW_IPCC_ZIGBEE_APPLI_NOTIF_ACK_CHANNEL ); + LL_C1_IPCC_EnableReceiveChannel( IPCC, HW_IPCC_ZIGBEE_M0_REQUEST_CHANNEL ); + + return; +} + +void HW_IPCC_ZIGBEE_SendM4RequestToM0( void ) +{ + LL_C1_IPCC_SetFlag_CHx( IPCC, HW_IPCC_ZIGBEE_CMD_APPLI_CHANNEL ); + LL_C1_IPCC_EnableTransmitChannel( IPCC, HW_IPCC_ZIGBEE_CMD_APPLI_CHANNEL ); + + return; +} + +void HW_IPCC_ZIGBEE_SendM4AckToM0Notify( void ) +{ + LL_C1_IPCC_ClearFlag_CHx( IPCC, HW_IPCC_ZIGBEE_APPLI_NOTIF_ACK_CHANNEL ); + LL_C1_IPCC_EnableReceiveChannel( IPCC, HW_IPCC_ZIGBEE_APPLI_NOTIF_ACK_CHANNEL ); + + return; +} + +static void HW_IPCC_ZIGBEE_CmdEvtHandler( void ) +{ + LL_C1_IPCC_DisableTransmitChannel( IPCC, HW_IPCC_ZIGBEE_CMD_APPLI_CHANNEL ); + + HW_IPCC_ZIGBEE_RecvAppliAckFromM0(); + + return; +} + +static void HW_IPCC_ZIGBEE_StackNotifEvtHandler( void ) +{ + LL_C1_IPCC_DisableReceiveChannel( IPCC, HW_IPCC_ZIGBEE_APPLI_NOTIF_ACK_CHANNEL ); + + HW_IPCC_ZIGBEE_RecvM0NotifyToM4(); + + return; +} + +static void HW_IPCC_ZIGBEE_StackM0RequestHandler( void ) +{ + LL_C1_IPCC_DisableReceiveChannel( IPCC, HW_IPCC_ZIGBEE_M0_REQUEST_CHANNEL ); + + HW_IPCC_ZIGBEE_RecvM0RequestToM4(); + + return; +} + +void HW_IPCC_ZIGBEE_SendM4AckToM0Request( void ) +{ + LL_C1_IPCC_ClearFlag_CHx( IPCC, HW_IPCC_ZIGBEE_M0_REQUEST_CHANNEL ); + LL_C1_IPCC_EnableReceiveChannel( IPCC, HW_IPCC_ZIGBEE_M0_REQUEST_CHANNEL ); + + return; +} + +__weak void HW_IPCC_ZIGBEE_RecvAppliAckFromM0( void ){}; +__weak void HW_IPCC_ZIGBEE_RecvM0NotifyToM4( void ){}; +__weak void HW_IPCC_ZIGBEE_RecvM0RequestToM4( void ){}; +#endif /* ZIGBEE_WB */ + +/****************************************************************************** + * MEMORY MANAGER + ******************************************************************************/ +void HW_IPCC_MM_SendFreeBuf( void (*cb)( void ) ) +{ + if ( LL_C1_IPCC_IsActiveFlag_CHx( IPCC, HW_IPCC_MM_RELEASE_BUFFER_CHANNEL ) ) + { + FreeBufCb = cb; + LL_C1_IPCC_EnableTransmitChannel( IPCC, HW_IPCC_MM_RELEASE_BUFFER_CHANNEL ); + } + else + { + cb(); + + LL_C1_IPCC_SetFlag_CHx( IPCC, HW_IPCC_MM_RELEASE_BUFFER_CHANNEL ); + } + + return; +} + +static void HW_IPCC_MM_FreeBufHandler( void ) +{ + LL_C1_IPCC_DisableTransmitChannel( IPCC, HW_IPCC_MM_RELEASE_BUFFER_CHANNEL ); + + FreeBufCb(); + + LL_C1_IPCC_SetFlag_CHx( IPCC, HW_IPCC_MM_RELEASE_BUFFER_CHANNEL ); + + return; +} + +/****************************************************************************** + * TRACES + ******************************************************************************/ +void HW_IPCC_TRACES_Init( void ) +{ + LL_C1_IPCC_EnableReceiveChannel( IPCC, HW_IPCC_TRACES_CHANNEL ); + + return; +} + +static void HW_IPCC_TRACES_EvtHandler( void ) +{ + HW_IPCC_TRACES_EvtNot(); + + LL_C1_IPCC_ClearFlag_CHx( IPCC, HW_IPCC_TRACES_CHANNEL ); + + return; +} + +__weak void HW_IPCC_TRACES_EvtNot( void ){}; +#endif /* STM32WBxx */ diff --git a/src/utility/STM32Cube_FW/mbox_def.h b/src/utility/STM32Cube_FW/mbox_def.h new file mode 100644 index 00000000..68b71f9c --- /dev/null +++ b/src/utility/STM32Cube_FW/mbox_def.h @@ -0,0 +1,280 @@ +/** + ****************************************************************************** + * @file mbox_def.h + * @author MCD Application Team + * @brief Mailbox definition + ****************************************************************************** + * @attention + * + * Copyright (c) 2018-2021 STMicroelectronics. + * All rights reserved. + * + * This software is licensed under terms that can be found in the LICENSE file + * in the root directory of this software component. + * If no LICENSE file comes with this software, it is provided AS-IS. + * + ****************************************************************************** + */ + + +/* Define to prevent recursive inclusion -------------------------------------*/ +#ifndef __MBOX_H +#define __MBOX_H + +#ifdef __cplusplus +extern "C" { +#endif + +#include "stm32_wpan_common.h" + + /** + * This file shall be identical between the CPU1 and the CPU2 + */ + + /** + ********************************************************************************* + * TABLES + ********************************************************************************* + */ + + /** + * Version + * [0:3] = Build - 0: Untracked - 15:Released - x: Tracked version + * [4:7] = branch - 0: Mass Market - x: ... + * [8:15] = Subversion + * [16:23] = Version minor + * [24:31] = Version major + * + * Memory Size + * [0:7] = Flash ( Number of 4k sector) + * [8:15] = Reserved ( Shall be set to 0 - may be used as flash extension ) + * [16:23] = SRAM2b ( Number of 1k sector) + * [24:31] = SRAM2a ( Number of 1k sector) + */ + typedef PACKED_STRUCT + { + uint32_t Version; + } MB_SafeBootInfoTable_t; + + typedef PACKED_STRUCT + { + uint32_t Version; + uint32_t MemorySize; + uint32_t FusInfo; + } MB_FusInfoTable_t; + + typedef PACKED_STRUCT + { + uint32_t Version; + uint32_t MemorySize; + uint32_t InfoStack; + uint32_t Reserved; + } MB_WirelessFwInfoTable_t; + + typedef struct + { + MB_SafeBootInfoTable_t SafeBootInfoTable; + MB_FusInfoTable_t FusInfoTable; + MB_WirelessFwInfoTable_t WirelessFwInfoTable; + } MB_DeviceInfoTable_t; + + typedef struct + { + uint8_t *pcmd_buffer; + uint8_t *pcs_buffer; + uint8_t *pevt_queue; + uint8_t *phci_acl_data_buffer; + } MB_BleTable_t; + + typedef struct + { + uint8_t *notack_buffer; + uint8_t *clicmdrsp_buffer; + uint8_t *otcmdrsp_buffer; + uint8_t *clinot_buffer; + } MB_ThreadTable_t; + + typedef struct + { + uint8_t *clicmdrsp_buffer; + uint8_t *m0cmd_buffer; + } MB_LldTestsTable_t; + + typedef struct + { + uint8_t *cmdrsp_buffer; + uint8_t *m0cmd_buffer; + } MB_BleLldTable_t; + + typedef struct + { + uint8_t *notifM0toM4_buffer; + uint8_t *appliCmdM4toM0_buffer; + uint8_t *requestM0toM4_buffer; + } MB_ZigbeeTable_t; + /** + * msg + * [0:7] = cmd/evt + * [8:31] = Reserved + */ + typedef struct + { + uint8_t *pcmd_buffer; + uint8_t *sys_queue; + } MB_SysTable_t; + + typedef struct + { + uint8_t *spare_ble_buffer; + uint8_t *spare_sys_buffer; + uint8_t *blepool; + uint32_t blepoolsize; + uint8_t *pevt_free_buffer_queue; + uint8_t *traces_evt_pool; + uint32_t tracespoolsize; + } MB_MemManagerTable_t; + + typedef struct + { + uint8_t *traces_queue; + } MB_TracesTable_t; + + typedef struct + { + uint8_t *p_cmdrsp_buffer; + uint8_t *p_notack_buffer; + uint8_t *evt_queue; + } MB_Mac_802_15_4_t; + + typedef struct + { + MB_DeviceInfoTable_t *p_device_info_table; + MB_BleTable_t *p_ble_table; + MB_ThreadTable_t *p_thread_table; + MB_SysTable_t *p_sys_table; + MB_MemManagerTable_t *p_mem_manager_table; + MB_TracesTable_t *p_traces_table; + MB_Mac_802_15_4_t *p_mac_802_15_4_table; + MB_ZigbeeTable_t *p_zigbee_table; + MB_LldTestsTable_t *p_lld_tests_table; + MB_BleLldTable_t *p_ble_lld_table; +} MB_RefTable_t; + +/** + * This table shall be used only in the case the CPU2 runs the FUS. + * It is used by the command SHCI_GetWirelessFwInfo() + */ +typedef struct +{ + uint32_t DeviceInfoTableState; + uint8_t Reserved1; + uint8_t LastFusActiveState; + uint8_t LastWirelessStackState; + uint8_t CurrentWirelessStackType; + uint32_t SafeBootVersion; + uint32_t FusVersion; + uint32_t FusMemorySize; + uint32_t WirelessStackVersion; + uint32_t WirelessStackMemorySize; + uint32_t WirelessFirmwareBleInfo; + uint32_t WirelessFirmwareThreadInfo; + uint32_t Reserved2; + uint64_t UID64; + uint16_t DeviceId; +} MB_FUS_DeviceInfoTable_t ; + +#ifdef __cplusplus +} +#endif + +/** + ********************************************************************************* + * IPCC CHANNELS + ********************************************************************************* + */ + +/* CPU1 CPU2 + * | (SYSTEM) | + * |----HW_IPCC_SYSTEM_CMD_RSP_CHANNEL-------------->| + * | | + * |<---HW_IPCC_SYSTEM_EVENT_CHANNEL-----------------| + * | | + * | (ZIGBEE) | + * |----HW_IPCC_ZIGBEE_CMD_APPLI_CHANNEL------------>| + * | | + * |----HW_IPCC_ZIGBEE_CMD_CLI_CHANNEL-------------->| + * | | + * |<---HW_IPCC_ZIGBEE_APPLI_NOTIF_ACK_CHANNEL-------| + * | | + * |<---HW_IPCC_ZIGBEE_CLI_NOTIF_ACK_CHANNEL---------| + * | | + * | (THREAD) | + * |----HW_IPCC_THREAD_OT_CMD_RSP_CHANNEL----------->| + * | | + * |----HW_IPCC_THREAD_CLI_CMD_CHANNEL-------------->| + * | | + * |<---HW_IPCC_THREAD_NOTIFICATION_ACK_CHANNEL------| + * | | + * |<---HW_IPCC_THREAD_CLI_NOTIFICATION_ACK_CHANNEL--| + * | | + * | (BLE) | + * |----HW_IPCC_BLE_CMD_CHANNEL--------------------->| + * | | + * |----HW_IPCC_HCI_ACL_DATA_CHANNEL---------------->| + * | | + * |<---HW_IPCC_BLE_EVENT_CHANNEL--------------------| + * | | + * | (BLE LLD) | + * |----HW_IPCC_BLE_LLD_CMD_CHANNEL----------------->| + * | | + * |<---HW_IPCC_BLE_LLD_RSP_CHANNEL------------------| + * | | + * |<---HW_IPCC_BLE_LLD_M0_CMD_CHANNEL---------------| + * | | + * | (MAC) | + * |----HW_IPCC_MAC_802_15_4_CMD_RSP_CHANNEL-------->| + * | | + * |<---HW_IPCC_MAC_802_15_4_NOTIFICATION_ACK_CHANNEL| + * | | + * | (BUFFER) | + * |----HW_IPCC_MM_RELEASE_BUFFER_CHANNE------------>| + * | | + * | (TRACE) | + * |<----HW_IPCC_TRACES_CHANNEL----------------------| + * | | + * + * + * + */ + + + +/** CPU1 */ +#define HW_IPCC_BLE_CMD_CHANNEL LL_IPCC_CHANNEL_1 +#define HW_IPCC_SYSTEM_CMD_RSP_CHANNEL LL_IPCC_CHANNEL_2 +#define HW_IPCC_THREAD_OT_CMD_RSP_CHANNEL LL_IPCC_CHANNEL_3 +#define HW_IPCC_ZIGBEE_CMD_APPLI_CHANNEL LL_IPCC_CHANNEL_3 +#define HW_IPCC_MAC_802_15_4_CMD_RSP_CHANNEL LL_IPCC_CHANNEL_3 +#define HW_IPCC_MM_RELEASE_BUFFER_CHANNEL LL_IPCC_CHANNEL_4 +#define HW_IPCC_THREAD_CLI_CMD_CHANNEL LL_IPCC_CHANNEL_5 +#define HW_IPCC_LLDTESTS_CLI_CMD_CHANNEL LL_IPCC_CHANNEL_5 +#define HW_IPCC_BLE_LLD_CLI_CMD_CHANNEL LL_IPCC_CHANNEL_5 +#define HW_IPCC_BLE_LLD_CMD_CHANNEL LL_IPCC_CHANNEL_5 +#define HW_IPCC_HCI_ACL_DATA_CHANNEL LL_IPCC_CHANNEL_6 + +/** CPU2 */ +#define HW_IPCC_BLE_EVENT_CHANNEL LL_IPCC_CHANNEL_1 +#define HW_IPCC_SYSTEM_EVENT_CHANNEL LL_IPCC_CHANNEL_2 +#define HW_IPCC_THREAD_NOTIFICATION_ACK_CHANNEL LL_IPCC_CHANNEL_3 +#define HW_IPCC_ZIGBEE_APPLI_NOTIF_ACK_CHANNEL LL_IPCC_CHANNEL_3 +#define HW_IPCC_MAC_802_15_4_NOTIFICATION_ACK_CHANNEL LL_IPCC_CHANNEL_3 +#define HW_IPCC_LLDTESTS_M0_CMD_CHANNEL LL_IPCC_CHANNEL_3 +#define HW_IPCC_BLE_LLD_M0_CMD_CHANNEL LL_IPCC_CHANNEL_3 +#define HW_IPCC_TRACES_CHANNEL LL_IPCC_CHANNEL_4 +#define HW_IPCC_THREAD_CLI_NOTIFICATION_ACK_CHANNEL LL_IPCC_CHANNEL_5 +#define HW_IPCC_LLDTESTS_CLI_RSP_CHANNEL LL_IPCC_CHANNEL_5 +#define HW_IPCC_BLE_LLD_CLI_RSP_CHANNEL LL_IPCC_CHANNEL_5 +#define HW_IPCC_BLE_LLD_RSP_CHANNEL LL_IPCC_CHANNEL_5 +#define HW_IPCC_ZIGBEE_M0_REQUEST_CHANNEL LL_IPCC_CHANNEL_5 +#endif /*__MBOX_H */ + diff --git a/src/utility/STM32Cube_FW/shci.c b/src/utility/STM32Cube_FW/shci.c new file mode 100644 index 00000000..4525656e --- /dev/null +++ b/src/utility/STM32Cube_FW/shci.c @@ -0,0 +1,742 @@ +/** + ****************************************************************************** + * @file shci.c + * @author MCD Application Team + * @brief HCI command for the system channel + ****************************************************************************** + * @attention + * + * Copyright (c) 2018-2021 STMicroelectronics. + * All rights reserved. + * + * This software is licensed under terms that can be found in the LICENSE file + * in the root directory of this software component. + * If no LICENSE file comes with this software, it is provided AS-IS. + * + ****************************************************************************** + */ + +#if defined(STM32WBxx) +/* Includes ------------------------------------------------------------------*/ +#include "stm32_wpan_common.h" + +#include "shci_tl.h" +#include "shci.h" +#include "stm32wbxx.h" + +/* Private typedef -----------------------------------------------------------*/ +/* Private defines -----------------------------------------------------------*/ +/* Private macros ------------------------------------------------------------*/ +/* Private variables ---------------------------------------------------------*/ +/* Global variables ----------------------------------------------------------*/ +/* Private function prototypes -----------------------------------------------*/ +/* Local Functions Definition ------------------------------------------------------*/ +/* Public Functions Definition ------------------------------------------------------*/ + +/** + * C2 COMMAND + * These commands are sent to the CPU2 + */ +uint8_t SHCI_C2_FUS_GetState( SHCI_FUS_GetState_ErrorCode_t *p_error_code ) +{ + /** + * Buffer is large enough to hold command complete with payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE + 1]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + shci_send( SHCI_OPCODE_C2_FUS_GET_STATE, + 0, + 0, + p_rsp ); + + if(p_error_code != 0) + { + *p_error_code = (SHCI_FUS_GetState_ErrorCode_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[1]); + } + + return (((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_FUS_FwUpgrade( uint32_t fw_src_add, uint32_t fw_dest_add ) +{ + /** + * TL_BLEEVT_CC_BUFFER_SIZE is 16 bytes so it is large enough to hold the 8 bytes of command parameters + * Buffer is large enough to hold command complete without payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE]; + TL_EvtPacket_t * p_rsp; + uint32_t *p_cmd; + uint8_t cmd_length; + + p_cmd = (uint32_t*)local_buffer; + cmd_length = 0; + + if(fw_src_add != 0) + { + *p_cmd = fw_src_add; + cmd_length += 4; + } + + if(fw_dest_add != 0) + { + *(p_cmd+1) = fw_dest_add; + cmd_length += 4; + } + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + shci_send( SHCI_OPCODE_C2_FUS_FW_UPGRADE, + cmd_length, + local_buffer, + p_rsp ); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_FUS_FwDelete( void ) +{ + /** + * Buffer is large enough to hold command complete without payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + shci_send( SHCI_OPCODE_C2_FUS_FW_DELETE, + 0, + 0, + p_rsp ); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_FUS_UpdateAuthKey( SHCI_C2_FUS_UpdateAuthKey_Cmd_Param_t *pParam ) +{ + /** + * Buffer is large enough to hold command complete without payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + shci_send( SHCI_OPCODE_C2_FUS_UPDATE_AUTH_KEY, + sizeof( SHCI_C2_FUS_UpdateAuthKey_Cmd_Param_t ), + (uint8_t*)pParam, + p_rsp ); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_FUS_LockAuthKey( void ) +{ + /** + * Buffer is large enough to hold command complete without payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + shci_send( SHCI_OPCODE_C2_FUS_LOCK_AUTH_KEY, + 0, + 0, + p_rsp ); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_FUS_StoreUsrKey( SHCI_C2_FUS_StoreUsrKey_Cmd_Param_t *pParam, uint8_t *p_key_index ) +{ + /** + * Buffer is large enough to hold command complete with payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE + 1]; + TL_EvtPacket_t * p_rsp; + uint8_t local_payload_len; + + if(pParam->KeyType == KEYTYPE_ENCRYPTED) + { + /** + * When the key is encrypted, the 12 bytes IV Key is included in the payload as well + * The IV key is always 12 bytes + */ + local_payload_len = pParam->KeySize + 2 + 12; + } + else + { + local_payload_len = pParam->KeySize + 2; + } + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + shci_send( SHCI_OPCODE_C2_FUS_STORE_USR_KEY, + local_payload_len , + (uint8_t*)pParam, + p_rsp ); + + *p_key_index = (((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[1]); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_FUS_LoadUsrKey( uint8_t key_index ) +{ + /** + * Buffer is large enough to hold command complete without payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + local_buffer[0] = key_index; + + shci_send( SHCI_OPCODE_C2_FUS_LOAD_USR_KEY, + 1, + local_buffer, + p_rsp ); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_FUS_StartWs( void ) +{ + /** + * Buffer is large enough to hold command complete without payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + shci_send( SHCI_OPCODE_C2_FUS_START_WS, + 0, + 0, + p_rsp ); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_FUS_LockUsrKey( uint8_t key_index ) +{ + /** + * Buffer is large enough to hold command complete without payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + local_buffer[0] = key_index; + + shci_send( SHCI_OPCODE_C2_FUS_LOCK_USR_KEY, + 1, + local_buffer, + p_rsp ); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_FUS_UnloadUsrKey( uint8_t key_index ) +{ + /** + * Buffer is large enough to hold command complete without payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + local_buffer[0] = key_index; + + shci_send( SHCI_OPCODE_C2_FUS_UNLOAD_USR_KEY, + 1, + local_buffer, + p_rsp ); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_FUS_ActivateAntiRollback( void ) +{ + /** + * Buffer is large enough to hold command complete without payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + shci_send( SHCI_OPCODE_C2_FUS_ACTIVATE_ANTIROLLBACK, + 0, + 0, + p_rsp ); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_BLE_Init( SHCI_C2_Ble_Init_Cmd_Packet_t *pCmdPacket ) +{ + /** + * Buffer is large enough to hold command complete without payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + shci_send( SHCI_OPCODE_C2_BLE_INIT, + sizeof( SHCI_C2_Ble_Init_Cmd_Param_t ), + (uint8_t*)&pCmdPacket->Param, + p_rsp ); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_THREAD_Init( void ) +{ + /** + * Buffer is large enough to hold command complete without payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + shci_send( SHCI_OPCODE_C2_THREAD_INIT, + 0, + 0, + p_rsp ); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_LLDTESTS_Init( uint8_t param_size, uint8_t * p_param ) +{ + /** + * Buffer is large enough to hold command complete without payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + shci_send( SHCI_OPCODE_C2_LLD_TESTS_INIT, + param_size, + p_param, + p_rsp ); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_BLE_LLD_Init( uint8_t param_size, uint8_t * p_param ) +{ + /** + * Buffer is large enough to hold command complete without payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + shci_send( SHCI_OPCODE_C2_BLE_LLD_INIT, + param_size, + p_param, + p_rsp ); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_ZIGBEE_Init( void ) +{ + /** + * Buffer is large enough to hold command complete without payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + shci_send( SHCI_OPCODE_C2_ZIGBEE_INIT, + 0, + 0, + p_rsp ); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_DEBUG_Init( SHCI_C2_DEBUG_Init_Cmd_Packet_t *pCmdPacket ) +{ + /** + * Buffer is large enough to hold command complete without payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + shci_send( SHCI_OPCODE_C2_DEBUG_INIT, + sizeof( SHCI_C2_DEBUG_init_Cmd_Param_t ), + (uint8_t*)&pCmdPacket->Param, + p_rsp ); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_FLASH_EraseActivity( SHCI_EraseActivity_t erase_activity ) +{ + /** + * Buffer is large enough to hold command complete without payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + local_buffer[0] = erase_activity; + + shci_send( SHCI_OPCODE_C2_FLASH_ERASE_ACTIVITY, + 1, + local_buffer, + p_rsp ); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_CONCURRENT_SetMode( SHCI_C2_CONCURRENT_Mode_Param_t Mode ) +{ + /** + * Buffer is large enough to hold command complete without payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + local_buffer[0] = Mode; + + shci_send( SHCI_OPCODE_C2_CONCURRENT_SET_MODE, + 1, + local_buffer, + p_rsp ); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_CONCURRENT_GetNextBleEvtTime( SHCI_C2_CONCURRENT_GetNextBleEvtTime_Param_t *pParam ) +{ + /** + * Buffer is large enough to hold command complete with payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE+4]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + shci_send( SHCI_OPCODE_C2_CONCURRENT_GET_NEXT_BLE_EVT_TIME, + 0, + 0, + p_rsp ); + + memcpy((void*)&(pParam->relative_time), (void*)&((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[1], sizeof(pParam->relative_time)); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_CONCURRENT_EnableNext_802154_EvtNotification( void ) +{ + /** + * Buffer is large enough to hold command complete without payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + shci_send( SHCI_OPCODE_C2_CONCURRENT_ENABLE_NEXT_802154_EVT_NOTIFICATION, + 0, + 0, + p_rsp ); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_FLASH_StoreData( SHCI_C2_FLASH_Ip_t Ip ) +{ + /** + * Buffer is large enough to hold command complete without payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + local_buffer[0] = Ip; + + shci_send( SHCI_OPCODE_C2_FLASH_STORE_DATA, + 1, + local_buffer, + p_rsp ); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_FLASH_EraseData( SHCI_C2_FLASH_Ip_t Ip ) +{ + /** + * Buffer is large enough to hold command complete without payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + local_buffer[0] = Ip; + + shci_send( SHCI_OPCODE_C2_FLASH_ERASE_DATA, + 1, + local_buffer, + p_rsp ); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_RADIO_AllowLowPower( SHCI_C2_FLASH_Ip_t Ip,uint8_t FlagRadioLowPowerOn) +{ + /** + * Buffer is large enough to hold command complete without payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + local_buffer[0] = Ip; + local_buffer[1] = FlagRadioLowPowerOn; + + shci_send( SHCI_OPCODE_C2_RADIO_ALLOW_LOW_POWER, + 2, + local_buffer, + p_rsp ); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_MAC_802_15_4_Init( void ) +{ + /** + * Buffer is large enough to hold command complete without payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + shci_send( SHCI_OPCODE_C2_MAC_802_15_4_INIT, + 0, + 0, + p_rsp ); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_Reinit( void ) +{ + /** + * Buffer is large enough to hold command complete without payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + shci_send( SHCI_OPCODE_C2_REINIT, + 0, + 0, + p_rsp ); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_ExtpaConfig(uint32_t gpio_port, uint16_t gpio_pin_number, uint8_t gpio_polarity, uint8_t gpio_status) +{ + /** + * TL_BLEEVT_CC_BUFFER_SIZE is 16 bytes so it is large enough to hold the 8 bytes of command parameters + * Buffer is large enough to hold command complete without payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + ((SHCI_C2_EXTPA_CONFIG_Cmd_Param_t*)local_buffer)->gpio_port = gpio_port; + ((SHCI_C2_EXTPA_CONFIG_Cmd_Param_t*)local_buffer)->gpio_pin_number = gpio_pin_number; + ((SHCI_C2_EXTPA_CONFIG_Cmd_Param_t*)local_buffer)->gpio_polarity = gpio_polarity; + ((SHCI_C2_EXTPA_CONFIG_Cmd_Param_t*)local_buffer)->gpio_status = gpio_status; + + shci_send( SHCI_OPCODE_C2_EXTPA_CONFIG, + 8, + local_buffer, + p_rsp ); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_SetFlashActivityControl(SHCI_C2_SET_FLASH_ACTIVITY_CONTROL_Source_t Source) +{ + /** + * TL_BLEEVT_CC_BUFFER_SIZE is 16 bytes so it is large enough to hold the 1 byte of command parameter + * Buffer is large enough to hold command complete without payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + local_buffer[0] = (uint8_t)Source; + + shci_send( SHCI_OPCODE_C2_SET_FLASH_ACTIVITY_CONTROL, + 1, + local_buffer, + p_rsp ); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_Config(SHCI_C2_CONFIG_Cmd_Param_t *pCmdPacket) +{ + /** + * Buffer is large enough to hold command complete without payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + shci_send( SHCI_OPCODE_C2_CONFIG, + sizeof(SHCI_C2_CONFIG_Cmd_Param_t), + (uint8_t*)pCmdPacket, + p_rsp ); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +SHCI_CmdStatus_t SHCI_C2_802_15_4_DeInit( void ) +{ + /** + * Buffer is large enough to hold command complete without payload + */ + uint8_t local_buffer[TL_BLEEVT_CC_BUFFER_SIZE]; + TL_EvtPacket_t * p_rsp; + + p_rsp = (TL_EvtPacket_t *)local_buffer; + + shci_send( SHCI_OPCODE_C2_802_15_4_DEINIT, + 0, + 0, + p_rsp ); + + return (SHCI_CmdStatus_t)(((TL_CcEvt_t*)(p_rsp->evtserial.evt.payload))->payload[0]); +} + +/** + * Local System COMMAND + * These commands are NOT sent to the CPU2 + */ + +SHCI_CmdStatus_t SHCI_GetWirelessFwInfo( WirelessFwInfo_t* pWirelessInfo ) +{ + uint32_t ipccdba = 0; + MB_RefTable_t * p_RefTable = NULL; + uint32_t wireless_firmware_version = 0; + uint32_t wireless_firmware_memorySize = 0; + uint32_t wireless_firmware_infoStack = 0; + MB_FUS_DeviceInfoTable_t * p_fus_device_info_table = NULL; + uint32_t fus_version = 0; + uint32_t fus_memorySize = 0; + + ipccdba = READ_BIT( FLASH->IPCCBR, FLASH_IPCCBR_IPCCDBA ); + + /** + * The Device Info Table mapping depends on which firmware is running on CPU2. + * If the FUS is running on CPU2, FUS_DEVICE_INFO_TABLE_VALIDITY_KEYWORD shall be written in the table. + * Otherwise, it means the Wireless Firmware is running on the CPU2 + */ + p_fus_device_info_table = (MB_FUS_DeviceInfoTable_t*)(*(uint32_t*)((ipccdba<<2) + SRAM2A_BASE)); + + if(p_fus_device_info_table->DeviceInfoTableState == FUS_DEVICE_INFO_TABLE_VALIDITY_KEYWORD) + { + /* The FUS is running on CPU2 */ + /** + * Retrieve the WirelessFwInfoTable + * This table is stored in RAM at startup during the TL (transport layer) initialization + */ + wireless_firmware_version = p_fus_device_info_table->WirelessStackVersion; + wireless_firmware_memorySize = p_fus_device_info_table->WirelessStackMemorySize; + wireless_firmware_infoStack = p_fus_device_info_table->WirelessFirmwareBleInfo; + + /** + * Retrieve the FusInfoTable + * This table is stored in RAM at startup during the TL (transport layer) initialization + */ + fus_version = p_fus_device_info_table->FusVersion; + fus_memorySize = p_fus_device_info_table->FusMemorySize; + } + else + { + /* The Wireless Firmware is running on CPU2 */ + p_RefTable = (MB_RefTable_t*)((ipccdba<<2) + SRAM2A_BASE); + + /** + * Retrieve the WirelessFwInfoTable + * This table is stored in RAM at startup during the TL (transport layer) initialization + */ + wireless_firmware_version = p_RefTable->p_device_info_table->WirelessFwInfoTable.Version; + wireless_firmware_memorySize = p_RefTable->p_device_info_table->WirelessFwInfoTable.MemorySize; + wireless_firmware_infoStack = p_RefTable->p_device_info_table->WirelessFwInfoTable.InfoStack; + + /** + * Retrieve the FusInfoTable + * This table is stored in RAM at startup during the TL (transport layer) initialization + */ + fus_version = p_RefTable->p_device_info_table->FusInfoTable.Version; + fus_memorySize = p_RefTable->p_device_info_table->FusInfoTable.MemorySize; + } + + /** + * Retrieve the WirelessFwInfoTable + * This table is stored in RAM at startup during the TL (transport layer) initialization + */ + pWirelessInfo->VersionMajor = ((wireless_firmware_version & INFO_VERSION_MAJOR_MASK) >> INFO_VERSION_MAJOR_OFFSET); + pWirelessInfo->VersionMinor = ((wireless_firmware_version & INFO_VERSION_MINOR_MASK) >> INFO_VERSION_MINOR_OFFSET); + pWirelessInfo->VersionSub = ((wireless_firmware_version & INFO_VERSION_SUB_MASK) >> INFO_VERSION_SUB_OFFSET); + pWirelessInfo->VersionBranch = ((wireless_firmware_version & INFO_VERSION_BRANCH_MASK) >> INFO_VERSION_BRANCH_OFFSET); + pWirelessInfo->VersionReleaseType = ((wireless_firmware_version & INFO_VERSION_TYPE_MASK) >> INFO_VERSION_TYPE_OFFSET); + + pWirelessInfo->MemorySizeSram2B = ((wireless_firmware_memorySize & INFO_SIZE_SRAM2B_MASK) >> INFO_SIZE_SRAM2B_OFFSET); + pWirelessInfo->MemorySizeSram2A = ((wireless_firmware_memorySize & INFO_SIZE_SRAM2A_MASK) >> INFO_SIZE_SRAM2A_OFFSET); + pWirelessInfo->MemorySizeSram1 = ((wireless_firmware_memorySize & INFO_SIZE_SRAM1_MASK) >> INFO_SIZE_SRAM1_OFFSET); + pWirelessInfo->MemorySizeFlash = ((wireless_firmware_memorySize & INFO_SIZE_FLASH_MASK) >> INFO_SIZE_FLASH_OFFSET); + + pWirelessInfo->StackType = ((wireless_firmware_infoStack & INFO_STACK_TYPE_MASK) >> INFO_STACK_TYPE_OFFSET); + + /** + * Retrieve the FusInfoTable + * This table is stored in RAM at startup during the TL (transport layer) initialization + */ + pWirelessInfo->FusVersionMajor = ((fus_version & INFO_VERSION_MAJOR_MASK) >> INFO_VERSION_MAJOR_OFFSET); + pWirelessInfo->FusVersionMinor = ((fus_version & INFO_VERSION_MINOR_MASK) >> INFO_VERSION_MINOR_OFFSET); + pWirelessInfo->FusVersionSub = ((fus_version & INFO_VERSION_SUB_MASK) >> INFO_VERSION_SUB_OFFSET); + + pWirelessInfo->FusMemorySizeSram2B = ((fus_memorySize & INFO_SIZE_SRAM2B_MASK) >> INFO_SIZE_SRAM2B_OFFSET); + pWirelessInfo->FusMemorySizeSram2A = ((fus_memorySize & INFO_SIZE_SRAM2A_MASK) >> INFO_SIZE_SRAM2A_OFFSET); + pWirelessInfo->FusMemorySizeFlash = ((fus_memorySize & INFO_SIZE_FLASH_MASK) >> INFO_SIZE_FLASH_OFFSET); + + return (SHCI_Success); +} +#endif /* STM32WBxx */ diff --git a/src/utility/STM32Cube_FW/shci.h b/src/utility/STM32Cube_FW/shci.h new file mode 100644 index 00000000..750fa972 --- /dev/null +++ b/src/utility/STM32Cube_FW/shci.h @@ -0,0 +1,1372 @@ +/** + ****************************************************************************** + * @file shci.h + * @author MCD Application Team + * @brief HCI command for the system channel + ****************************************************************************** + * @attention + * + * Copyright (c) 2018-2021 STMicroelectronics. + * All rights reserved. + * + * This software is licensed under terms that can be found in the LICENSE file + * in the root directory of this software component. + * If no LICENSE file comes with this software, it is provided AS-IS. + * + ****************************************************************************** + */ + + +/* Define to prevent recursive inclusion -------------------------------------*/ +#ifndef __SHCI_H +#define __SHCI_H + +#ifdef __cplusplus +extern "C" { +#endif + + /* Includes ------------------------------------------------------------------*/ +#include "mbox_def.h" /* Requested to expose the MB_WirelessFwInfoTable_t structure */ + + /* Exported types ------------------------------------------------------------*/ + + /* SYSTEM EVENT */ + typedef enum + { + WIRELESS_FW_RUNNING = 0x00, + FUS_FW_RUNNING = 0x01, + } SHCI_SysEvt_Ready_Rsp_t; + + /* ERROR CODES + * + * These error codes are detected on CPU2 side and are send back to the CPU1 via a system + * notification message. It is up to the application running on CPU1 to manage these errors + * + * These errors can be generated by all layers (low level driver, stack, framework infrastructure, etc..) + */ + typedef enum + { + ERR_BLE_INIT = 0, /* This event is currently not reported by the CPU2 */ + ERR_THREAD_LLD_FATAL_ERROR = 125, /* The LLD driver used on 802_15_4 detected a fatal error */ + ERR_THREAD_UNKNOWN_CMD = 126, /* The command send by the CPU1 to control the Thread stack is unknown */ + ERR_ZIGBEE_UNKNOWN_CMD = 200, /* The command send by the CPU1 to control the Zigbee stack is unknown */ + } SCHI_SystemErrCode_t; + +#define SHCI_EVTCODE ( 0xFF ) +#define SHCI_SUB_EVT_CODE_BASE ( 0x9200 ) + + /** + * THE ORDER SHALL NOT BE CHANGED TO GUARANTEE COMPATIBILITY WITH THE CPU1 DEFINITION + */ + typedef enum + { + SHCI_SUB_EVT_CODE_READY = SHCI_SUB_EVT_CODE_BASE, + SHCI_SUB_EVT_ERROR_NOTIF, + SHCI_SUB_EVT_BLE_NVM_RAM_UPDATE, + SHCI_SUB_EVT_THREAD_NVM_RAM_UPDATE, + SHCI_SUB_EVT_NVM_START_WRITE, + SHCI_SUB_EVT_NVM_END_WRITE, + SHCI_SUB_EVT_NVM_START_ERASE, + SHCI_SUB_EVT_NVM_END_ERASE, + SHCI_SUB_EVT_CODE_CONCURRENT_802154_EVT, + } SHCI_SUB_EVT_CODE_t; + + /** + * SHCI_SUB_EVT_CODE_READY + * This notifies the CPU1 that the CPU2 is now ready to receive commands + * It reports as well which firmware is running on CPU2 : The wireless stack of the FUS (previously named RSS) + */ + typedef PACKED_STRUCT{ + SHCI_SysEvt_Ready_Rsp_t sysevt_ready_rsp; + } SHCI_C2_Ready_Evt_t; + + /** + * SHCI_SUB_EVT_ERROR_NOTIF + * This reports to the CPU1 some error form the CPU2 + */ + typedef PACKED_STRUCT{ + SCHI_SystemErrCode_t errorCode; + } SHCI_C2_ErrorNotif_Evt_t; + + /** + * SHCI_SUB_EVT_BLE_NVM_RAM_UPDATE + * This notifies the CPU1 which part of the BLE NVM RAM has been updated so that only the modified + * section could be written in Flash/NVM + * StartAddress : Start address of the section that has been modified + * Size : Size (in bytes) of the section that has been modified + */ + typedef PACKED_STRUCT{ + uint32_t StartAddress; + uint32_t Size; + } SHCI_C2_BleNvmRamUpdate_Evt_t; + + /** + * SHCI_SUB_EVT_THREAD_NVM_RAM_UPDATE + * This notifies the CPU1 which part of the OT NVM RAM has been updated so that only the modified + * section could be written in Flash/NVM + * StartAddress : Start address of the section that has been modified + * Size : Size (in bytes) of the section that has been modified + */ + typedef PACKED_STRUCT{ + uint32_t StartAddress; + uint32_t Size; + } SHCI_C2_ThreadNvmRamUpdate_Evt_t; + + /** + * SHCI_SUB_EVT_NVM_START_WRITE + * This notifies the CPU1 that the CPU2 has started a write procedure in Flash + * NumberOfWords : The number of 64bits data the CPU2 needs to write in Flash. + * For each 64bits data, the algorithm as described in AN5289 is executed. + * When this number is reported to 0, it means the Number of 64bits to be written + * was unknown when the procedure has started. + * When all data are written, the SHCI_SUB_EVT_NVM_END_WRITE event is reported + */ + typedef PACKED_STRUCT{ + uint32_t NumberOfWords; + } SHCI_C2_NvmStartWrite_Evt_t; + + /** + * SHCI_SUB_EVT_NVM_END_WRITE + * This notifies the CPU1 that the CPU2 has written all expected data in Flash + */ + + /** + * SHCI_SUB_EVT_NVM_START_ERASE + * This notifies the CPU1 that the CPU2 has started a erase procedure in Flash + * NumberOfSectors : The number of sectors the CPU2 needs to erase in Flash. + * For each sector, the algorithm as described in AN5289 is executed. + * When this number is reported to 0, it means the Number of sectors to be erased + * was unknown when the procedure has started. + * When all sectors are erased, the SHCI_SUB_EVT_NVM_END_ERASE event is reported + */ + typedef PACKED_STRUCT{ + uint32_t NumberOfSectors; + } SHCI_C2_NvmStartErase_Evt_t; + + /** + * SHCI_SUB_EVT_NVM_END_ERASE + * This notifies the CPU1 that the CPU2 has erased all expected flash sectors + */ + + /* SYSTEM COMMAND */ + typedef PACKED_STRUCT + { + /** + * MetaData holds : + * 2*32bits for chaining list + * 1*32bits with BLE header (type + Opcode + Length) + */ + uint32_t MetaData[3]; + } SHCI_Header_t; + + typedef enum + { + SHCI_Success = 0x00, + SHCI_UNKNOWN_CMD = 0x01, + SHCI_MEMORY_CAPACITY_EXCEEDED_ERR_CODE= 0x07, + SHCI_ERR_UNSUPPORTED_FEATURE = 0x11, + SHCI_ERR_INVALID_HCI_CMD_PARAMS = 0x12, + SHCI_ERR_INVALID_PARAMS = 0x42, /* only used for release < v1.13.0 */ + SHCI_ERR_INVALID_PARAMS_V2 = 0x92, /* available for release >= v1.13.0 */ + SHCI_FUS_CMD_NOT_SUPPORTED = 0xFF, + } SHCI_CmdStatus_t; + + typedef enum + { + SHCI_8BITS = 0x01, + SHCI_16BITS = 0x02, + SHCI_32BITS = 0x04, + } SHCI_Busw_t; + +#define SHCI_OGF ( 0x3F ) +#define SHCI_OCF_BASE ( 0x50 ) + + /** + * THE ORDER SHALL NOT BE CHANGED TO GUARANTEE COMPATIBILITY WITH THE CPU2 DEFINITION + */ + typedef enum + { + SHCI_OCF_C2_RESERVED1 = SHCI_OCF_BASE, + SHCI_OCF_C2_RESERVED2, + SHCI_OCF_C2_FUS_GET_STATE, + SHCI_OCF_C2_FUS_RESERVED1, + SHCI_OCF_C2_FUS_FW_UPGRADE, + SHCI_OCF_C2_FUS_FW_DELETE, + SHCI_OCF_C2_FUS_UPDATE_AUTH_KEY, + SHCI_OCF_C2_FUS_LOCK_AUTH_KEY, + SHCI_OCF_C2_FUS_STORE_USR_KEY, + SHCI_OCF_C2_FUS_LOAD_USR_KEY, + SHCI_OCF_C2_FUS_START_WS, + SHCI_OCF_C2_FUS_RESERVED2, + SHCI_OCF_C2_FUS_RESERVED3, + SHCI_OCF_C2_FUS_LOCK_USR_KEY, + SHCI_OCF_C2_FUS_UNLOAD_USR_KEY, + SHCI_OCF_C2_FUS_ACTIVATE_ANTIROLLBACK, + SHCI_OCF_C2_FUS_RESERVED7, + SHCI_OCF_C2_FUS_RESERVED8, + SHCI_OCF_C2_FUS_RESERVED9, + SHCI_OCF_C2_FUS_RESERVED10, + SHCI_OCF_C2_FUS_RESERVED11, + SHCI_OCF_C2_FUS_RESERVED12, + SHCI_OCF_C2_BLE_INIT, + SHCI_OCF_C2_THREAD_INIT, + SHCI_OCF_C2_DEBUG_INIT, + SHCI_OCF_C2_FLASH_ERASE_ACTIVITY, + SHCI_OCF_C2_CONCURRENT_SET_MODE, + SHCI_OCF_C2_FLASH_STORE_DATA, + SHCI_OCF_C2_FLASH_ERASE_DATA, + SHCI_OCF_C2_RADIO_ALLOW_LOW_POWER, + SHCI_OCF_C2_MAC_802_15_4_INIT, + SHCI_OCF_C2_REINIT, + SHCI_OCF_C2_ZIGBEE_INIT, + SHCI_OCF_C2_LLD_TESTS_INIT, + SHCI_OCF_C2_EXTPA_CONFIG, + SHCI_OCF_C2_SET_FLASH_ACTIVITY_CONTROL, + SHCI_OCF_C2_BLE_LLD_INIT, + SHCI_OCF_C2_CONFIG, + SHCI_OCF_C2_CONCURRENT_GET_NEXT_BLE_EVT_TIME, + SHCI_OCF_C2_CONCURRENT_ENABLE_NEXT_802154_EVT_NOTIFICATION, + SHCI_OCF_C2_802_15_4_DEINIT, + } SHCI_OCF_t; + +#define SHCI_OPCODE_C2_FUS_GET_STATE (( SHCI_OGF << 10) + SHCI_OCF_C2_FUS_GET_STATE) +/** No command parameters */ +/** Response parameters*/ +/** It responds a 1 byte value holding FUS State error code when the FUS State value is 0xFF (FUS_STATE_VALUE_ERROR) */ + typedef enum + { + FUS_STATE_ERROR_NO_ERROR = 0x00, + FUS_STATE_ERROR_IMG_NOT_FOUND = 0x01, + FUS_STATE_ERROR_IMG_CORRUPT = 0x02, + FUS_STATE_ERROR_IMG_NOT_AUTHENTIC = 0x03, + FUS_STATE_ERROR_IMG_NOT_ENOUGH_SPACE = 0x04, + FUS_STATE_ERROR_IMAGE_USRABORT = 0x05, + FUS_STATE_ERROR_IMAGE_ERSERROR = 0x06, + FUS_STATE_ERROR_IMAGE_WRTERROR = 0x07, + FUS_STATE_ERROR_AUTH_TAG_ST_NOTFOUND = 0x08, + FUS_STATE_ERROR_AUTH_TAG_CUST_NOTFOUND = 0x09, + FUS_STATE_ERROR_AUTH_KEY_LOCKED = 0x0A, + FUS_STATE_ERROR_FW_ROLLBACK_ERROR = 0x11, + FUS_STATE_ERROR_STATE_NOT_RUNNING = 0xFE, + FUS_STATE_ERROR_ERR_UNKNOWN = 0xFF, + } SHCI_FUS_GetState_ErrorCode_t; + + enum + { + FUS_STATE_VALUE_IDLE = 0x00, + FUS_STATE_VALUE_FW_UPGRD_ONGOING = 0x10, + FUS_STATE_VALUE_FW_UPGRD_ONGOING_END = 0x1F, /* All values between 0x10 and 0x1F has the same meaning */ + FUS_STATE_VALUE_FUS_UPGRD_ONGOING = 0x20, + FUS_STATE_VALUE_FUS_UPGRD_ONGOING_END = 0x2F, /* All values between 0x20 and 0x2F has the same meaning */ + FUS_STATE_VALUE_SERVICE_ONGOING = 0x30, + FUS_STATE_VALUE_SERVICE_ONGOING_END = 0x3F, /* All values between 0x30 and 0x3F has the same meaning */ + FUS_STATE_VALUE_ERROR = 0xFF, + }; + +#define SHCI_OPCODE_C2_FUS_RESERVED1 (( SHCI_OGF << 10) + SHCI_OCF_C2_FUS_RESERVED1) +/** No command parameters */ +/** No response parameters*/ + +#define SHCI_OPCODE_C2_FUS_FW_UPGRADE (( SHCI_OGF << 10) + SHCI_OCF_C2_FUS_FW_UPGRADE) + /** No structure for command parameters */ + /** No response parameters*/ + +#define SHCI_OPCODE_C2_FUS_FW_DELETE (( SHCI_OGF << 10) + SHCI_OCF_C2_FUS_FW_DELETE) +/** No command parameters */ +/** No response parameters*/ + +#define SHCI_OPCODE_C2_FUS_UPDATE_AUTH_KEY (( SHCI_OGF << 10) + SHCI_OCF_C2_FUS_UPDATE_AUTH_KEY) + typedef PACKED_STRUCT{ + uint8_t KeySize; + uint8_t KeyData[64]; + } SHCI_C2_FUS_UpdateAuthKey_Cmd_Param_t; + + /** No response parameters*/ + +#define SHCI_OPCODE_C2_FUS_LOCK_AUTH_KEY (( SHCI_OGF << 10) + SHCI_OCF_C2_FUS_LOCK_AUTH_KEY) +/** No command parameters */ +/** No response parameters*/ + +#define SHCI_OPCODE_C2_FUS_STORE_USR_KEY (( SHCI_OGF << 10) + SHCI_OCF_C2_FUS_STORE_USR_KEY) + /** Command parameters */ + /* List of supported key type */ + enum + { + KEYTYPE_NONE = 0x00, + KEYTYPE_SIMPLE = 0x01, + KEYTYPE_MASTER = 0x02, + KEYTYPE_ENCRYPTED = 0x03, + }; + + /* List of supported key size */ + enum + { + KEYSIZE_16 = 16, + KEYSIZE_32 = 32, + }; + + typedef PACKED_STRUCT{ + uint8_t KeyType; + uint8_t KeySize; + uint8_t KeyData[32 + 12]; + } SHCI_C2_FUS_StoreUsrKey_Cmd_Param_t; + + /** Response parameters*/ + /** It responds a 1 byte value holding the index given for the stored key */ + +#define SHCI_OPCODE_C2_FUS_LOAD_USR_KEY (( SHCI_OGF << 10) + SHCI_OCF_C2_FUS_LOAD_USR_KEY) + /** Command parameters */ + /** 1 byte holding the key index value */ + + /** No response parameters*/ + +#define SHCI_OPCODE_C2_FUS_START_WS (( SHCI_OGF << 10) + SHCI_OCF_C2_FUS_START_WS) +/** No command parameters */ +/** No response parameters*/ + +#define SHCI_OPCODE_C2_FUS_RESERVED2 (( SHCI_OGF << 10) + SHCI_OCF_C2_FUS_RESERVED2) +/** No command parameters */ +/** No response parameters*/ + +#define SHCI_OPCODE_C2_FUS_RESERVED3 (( SHCI_OGF << 10) + SHCI_OCF_C2_FUS_RESERVED3) +/** No command parameters */ +/** No response parameters*/ + +#define SHCI_OPCODE_C2_FUS_LOCK_USR_KEY (( SHCI_OGF << 10) + SHCI_OCF_C2_FUS_LOCK_USR_KEY) + /** Command parameters */ + /** 1 byte holding the key index value */ + + /** No response parameters*/ + +#define SHCI_OPCODE_C2_FUS_UNLOAD_USR_KEY (( SHCI_OGF << 10) + SHCI_OCF_C2_FUS_UNLOAD_USR_KEY) +/** No command parameters */ +/** 1 byte holding the key index value */ + +#define SHCI_OPCODE_C2_FUS_ACTIVATE_ANTIROLLBACK (( SHCI_OGF << 10) + SHCI_OCF_C2_FUS_ACTIVATE_ANTIROLLBACK) +/** No command parameters */ +/** No response parameters*/ + +#define SHCI_OPCODE_C2_FUS_RESERVED7 (( SHCI_OGF << 10) + SHCI_OCF_C2_FUS_RESERVED7) +/** No command parameters */ +/** No response parameters*/ + +#define SHCI_OPCODE_C2_FUS_RESERVED8 (( SHCI_OGF << 10) + SHCI_OCF_C2_FUS_RESERVED8) +/** No command parameters */ +/** No response parameters*/ + +#define SHCI_OPCODE_C2_FUS_RESERVED9 (( SHCI_OGF << 10) + SHCI_OCF_C2_FUS_RESERVED9) +/** No command parameters */ +/** No response parameters*/ + +#define SHCI_OPCODE_C2_FUS_RESERVED10 (( SHCI_OGF << 10) + SHCI_OCF_C2_FUS_RESERVED10) +/** No command parameters */ +/** No response parameters*/ + +#define SHCI_OPCODE_C2_FUS_RESERVED11 (( SHCI_OGF << 10) + SHCI_OCF_C2_FUS_RESERVED11) +/** No command parameters */ +/** No response parameters*/ + +#define SHCI_OPCODE_C2_FUS_RESERVED12 (( SHCI_OGF << 10) + SHCI_OCF_C2_FUS_RESERVED12) +/** No command parameters */ +/** No response parameters*/ + +#define SHCI_OPCODE_C2_BLE_INIT (( SHCI_OGF << 10) + SHCI_OCF_C2_BLE_INIT) + /** THE ORDER SHALL NOT BE CHANGED */ + typedef PACKED_STRUCT{ + uint8_t* pBleBufferAddress; /**< NOT USED - shall be set to 0 */ + uint32_t BleBufferSize; /**< NOT USED - shall be set to 0 */ + + /** + * NumAttrRecord + * Maximum number of attribute records related to all the required characteristics (excluding the services) + * that can be stored in the GATT database, for the specific BLE user application. + * For each characteristic, the number of attribute records goes from two to five depending on the characteristic properties: + * - minimum of two (one for declaration and one for the value) + * - add one more record for each additional property: notify or indicate, broadcast, extended property. + * The total calculated value must be increased by 9, due to the records related to the standard attribute profile and + * GAP service characteristics, and automatically added when initializing GATT and GAP layers + * - Min value: + 9 + * - Max value: depending on the GATT database defined by user application + */ + uint16_t NumAttrRecord; + + /** + * NumAttrServ + * Defines the maximum number of services that can be stored in the GATT database. Note that the GAP and GATT services + * are automatically added at initialization so this parameter must be the number of user services increased by two. + * - Min value: + 2 + * - Max value: depending GATT database defined by user application + */ + uint16_t NumAttrServ; + + /** + * AttrValueArrSize + * NOTE: This parameter is ignored by the CPU2 when the parameter "Options" is set to "LL_only" ( see Options description in that structure ) + * + * Size of the storage area for the attribute values. + * Each characteristic contributes to the attrValueArrSize value as follows: + * - Characteristic value length plus: + * + 5 bytes if characteristic UUID is 16 bits + * + 19 bytes if characteristic UUID is 128 bits + * + 2 bytes if characteristic has a server configuration descriptor + * + 2 bytes * NumOfLinks if the characteristic has a client configuration descriptor + * + 2 bytes if the characteristic has extended properties + * Each descriptor contributes to the attrValueArrSize value as follows: + * - Descriptor length + */ + uint16_t AttrValueArrSize; + + /** + * NumOfLinks + * Maximum number of BLE links supported + * - Min value: 1 + * - Max value: 8 + */ + uint8_t NumOfLinks; + + /** + * ExtendedPacketLengthEnable + * Disable/enable the extended packet length BLE 5.0 feature + * - Disable: 0 + * - Enable: 1 + */ + uint8_t ExtendedPacketLengthEnable; + + /** + * PrWriteListSize + * NOTE: This parameter is ignored by the CPU2 when the parameter "Options" is set to "LL_only" ( see Options description in that structure ) + * + * Maximum number of supported �prepare write request� + * - Min value: given by the macro DEFAULT_PREP_WRITE_LIST_SIZE + * - Max value: a value higher than the minimum required can be specified, but it is not recommended + */ + uint8_t PrWriteListSize; + + /** + * MblockCount + * NOTE: This parameter is overwritten by the CPU2 with an hardcoded optimal value when the parameter "Options" is set to "LL_only" + * ( see Options description in that structure ) + * + * Number of allocated memory blocks for the BLE stack + * - Min value: given by the macro MBLOCKS_CALC + * - Max value: a higher value can improve data throughput performance, but uses more memory + */ + uint8_t MblockCount; + + /** + * AttMtu + * NOTE: This parameter is ignored by the CPU2 when the parameter "Options" is set to "LL_only" ( see Options description in that structure ) + * + * Maximum ATT MTU size supported + * - Min value: 23 + * - Max value: 512 + */ + uint16_t AttMtu; + + /** + * SlaveSca + * The sleep clock accuracy (ppm value) that used in BLE connected slave mode to calculate the window widening + * (in combination with the sleep clock accuracy sent by master in CONNECT_REQ PDU), + * refer to BLE 5.0 specifications - Vol 6 - Part B - chap 4.5.7 and 4.2.2 + * - Min value: 0 + * - Max value: 500 (worst possible admitted by specification) + */ + uint16_t SlaveSca; + + /** + * MasterSca + * The sleep clock accuracy handled in master mode. It is used to determine the connection and advertising events timing. + * It is transmitted to the slave in CONNEC_REQ PDU used by the slave to calculate the window widening, + * see SlaveSca and Bluetooth Core Specification v5.0 Vol 6 - Part B - chap 4.5.7 and 4.2.2 + * Possible values: + * - 251 ppm to 500 ppm: 0 + * - 151 ppm to 250 ppm: 1 + * - 101 ppm to 150 ppm: 2 + * - 76 ppm to 100 ppm: 3 + * - 51 ppm to 75 ppm: 4 + * - 31 ppm to 50 ppm: 5 + * - 21 ppm to 30 ppm: 6 + * - 0 ppm to 20 ppm: 7 + */ + uint8_t MasterSca; + + /** + * LsSource + * Some information for Low speed clock mapped in bits field + * - bit 0: 1: Calibration for the RF system wakeup clock source 0: No calibration for the RF system wakeup clock source + * - bit 1: 1: STM32W5M Module device 0: Other devices as STM32WBxx SOC, STM32WB1M module + * - bit 2: 1: HSE/1024 Clock config 0: LSE Clock config + */ + uint8_t LsSource; + + /** + * MaxConnEventLength + * This parameter determines the maximum duration of a slave connection event. When this duration is reached the slave closes + * the current connections event (whatever is the CE_length parameter specified by the master in HCI_CREATE_CONNECTION HCI command), + * expressed in units of 625/256 �s (~2.44 �s) + * - Min value: 0 (if 0 is specified, the master and slave perform only a single TX-RX exchange per connection event) + * - Max value: 1638400 (4000 ms). A higher value can be specified (max 0xFFFFFFFF) but results in a maximum connection time + * of 4000 ms as specified. In this case the parameter is not applied, and the predicted CE length calculated on slave is not shortened + */ + uint32_t MaxConnEventLength; + + /** + * HsStartupTime + * Startup time of the high speed (16 or 32 MHz) crystal oscillator in units of 625/256 �s (~2.44 �s). + * - Min value: 0 + * - Max value: 820 (~2 ms). A higher value can be specified, but the value that implemented in stack is forced to ~2 ms + */ + uint16_t HsStartupTime; + + /** + * ViterbiEnable + * Viterbi implementation in BLE LL reception. + * - 0: Enable + * - 1: Disable + */ + uint8_t ViterbiEnable; + + /** + * Options flags + * - bit 0: 1: LL only 0: LL + host + * - bit 1: 1: no service change desc. 0: with service change desc. + * - bit 2: 1: device name Read-Only 0: device name R/W + * - bit 3: 1: extended advertizing supported 0: extended advertizing not supported + * - bit 4: 1: CS Algo #2 supported 0: CS Algo #2 not supported + * - bit 5: 1: Reduced GATT database in NVM 0: Full GATT database in NVM + * - bit 6: 1: GATT caching is used 0: GATT caching is not used + * - bit 7: 1: LE Power Class 1 0: LE Power Class 2-3 + * - other bits: complete with Options_extension flag + */ + uint8_t Options; + + /** + * HwVersion + * Reserved for future use - shall be set to 0 + */ + uint8_t HwVersion; + + /** + * Maximum number of connection-oriented channels in initiator mode. + * Range: 0 .. 64 + */ + uint8_t max_coc_initiator_nbr; + + /** + * Minimum transmit power in dBm supported by the Controller. + * Range: -127 .. 20 + */ + int8_t min_tx_power; + + /** + * Maximum transmit power in dBm supported by the Controller. + * Range: -127 .. 20 + */ + int8_t max_tx_power; + + /** + * RX model configuration + * - bit 0: 1: agc_rssi model improved vs RF blockers 0: Legacy agc_rssi model + * - other bits: reserved ( shall be set to 0) + */ + uint8_t rx_model_config; + + /* Maximum number of advertising sets. + * Range: 1 .. 8 with limitation: + * This parameter is linked to max_adv_data_len such as both compliant with allocated Total memory computed with BLE_EXT_ADV_BUFFER_SIZE based + * on Max Extended advertising configuration supported. + * This parameter is considered by the CPU2 when Options has SHCI_C2_BLE_INIT_OPTIONS_EXT_ADV flag set + */ + uint8_t max_adv_set_nbr; + + /* Maximum advertising data length (in bytes) + * Range: 31 .. 1650 with limitation: + * This parameter is linked to max_adv_set_nbr such as both compliant with allocated Total memory computed with BLE_EXT_ADV_BUFFER_SIZE based + * on Max Extended advertising configuration supported. + * This parameter is considered by the CPU2 when Options has SHCI_C2_BLE_INIT_OPTIONS_EXT_ADV flag set + */ + uint16_t max_adv_data_len; + + /* RF TX Path Compensation Value (16-bit signed integer). Units: 0.1 dB. + * Range: -1280 .. 1280 + */ + int16_t tx_path_compens; + + /* RF RX Path Compensation Value (16-bit signed integer). Units: 0.1 dB. + * Range: -1280 .. 1280 + */ + int16_t rx_path_compens; + + /* BLE core specification version (8-bit unsigned integer). + * values as: 11(5.2), 12(5.3) + */ + uint8_t ble_core_version; + + /** + * Options flags extension + * - bit 0: 1: appearance Writable 0: appearance Read-Only + * - bit 1: 1: Enhanced ATT supported 0: Enhanced ATT not supported + * - other bits: reserved ( shall be set to 0) + */ + uint8_t Options_extension; + + } SHCI_C2_Ble_Init_Cmd_Param_t; + + typedef PACKED_STRUCT{ + SHCI_Header_t Header; /** Does not need to be initialized by the user */ + SHCI_C2_Ble_Init_Cmd_Param_t Param; + } SHCI_C2_Ble_Init_Cmd_Packet_t; + + /** + * Options + * Each definition below may be added together to build the Options value + * WARNING : Only one definition per bit shall be added to build the Options value + */ +#define SHCI_C2_BLE_INIT_OPTIONS_LL_ONLY (1<<0) +#define SHCI_C2_BLE_INIT_OPTIONS_LL_HOST (0<<0) + +#define SHCI_C2_BLE_INIT_OPTIONS_NO_SVC_CHANGE_DESC (1<<1) +#define SHCI_C2_BLE_INIT_OPTIONS_WITH_SVC_CHANGE_DESC (0<<1) + +#define SHCI_C2_BLE_INIT_OPTIONS_DEVICE_NAME_RO (1<<2) +#define SHCI_C2_BLE_INIT_OPTIONS_DEVICE_NAME_RW (0<<2) + +#define SHCI_C2_BLE_INIT_OPTIONS_EXT_ADV (1<<3) +#define SHCI_C2_BLE_INIT_OPTIONS_NO_EXT_ADV (0<<3) + +#define SHCI_C2_BLE_INIT_OPTIONS_CS_ALGO2 (1<<4) +#define SHCI_C2_BLE_INIT_OPTIONS_NO_CS_ALGO2 (0<<4) + +#define SHCI_C2_BLE_INIT_OPTIONS_REDUC_GATTDB_NVM (1<<5) +#define SHCI_C2_BLE_INIT_OPTIONS_FULL_GATTDB_NVM (0<<5) + +#define SHCI_C2_BLE_INIT_OPTIONS_GATT_CACHING_USED (1<<6) +#define SHCI_C2_BLE_INIT_OPTIONS_GATT_CACHING_NOTUSED (0<<6) + +#define SHCI_C2_BLE_INIT_OPTIONS_POWER_CLASS_1 (1<<7) +#define SHCI_C2_BLE_INIT_OPTIONS_POWER_CLASS_2_3 (0<<7) + + /** + * Options extension + * Each definition below may be added together to build the Options value + * WARNING : Only one definition per bit shall be added to build the Options value + */ +#define SHCI_C2_BLE_INIT_OPTIONS_APPEARANCE_WRITABLE (1<<0) +#define SHCI_C2_BLE_INIT_OPTIONS_APPEARANCE_READONLY (0<<0) + +#define SHCI_C2_BLE_INIT_OPTIONS_ENHANCED_ATT_SUPPORTED (1<<1) +#define SHCI_C2_BLE_INIT_OPTIONS_ENHANCED_ATT_NOTSUPPORTED (0<<1) + + /** + * RX models configuration + */ +#define SHCI_C2_BLE_INIT_RX_MODEL_AGC_RSSI_LEGACY (0<<0) +#define SHCI_C2_BLE_INIT_RX_MODEL_AGC_RSSI_BLOCKER (1<<0) + + /** + * BLE core version + */ +#define SHCI_C2_BLE_INIT_BLE_CORE_5_2 11 +#define SHCI_C2_BLE_INIT_BLE_CORE_5_3 12 +#define SHCI_C2_BLE_INIT_BLE_CORE_5_4 13 + + /** + * LsSource information + */ +#define SHCI_C2_BLE_INIT_CFG_BLE_LS_NOCALIB (0<<0) +#define SHCI_C2_BLE_INIT_CFG_BLE_LS_CALIB (1<<0) +#define SHCI_C2_BLE_INIT_CFG_BLE_LS_OTHER_DEV (0<<1) +#define SHCI_C2_BLE_INIT_CFG_BLE_LS_MOD5MM_DEV (1<<1) +#define SHCI_C2_BLE_INIT_CFG_BLE_LS_CLK_LSE (0<<2) +#define SHCI_C2_BLE_INIT_CFG_BLE_LS_CLK_HSE_1024 (1<<2) + +#define SHCI_OPCODE_C2_THREAD_INIT (( SHCI_OGF << 10) + SHCI_OCF_C2_THREAD_INIT) +/** No command parameters */ +/** No response parameters*/ + +#define SHCI_OPCODE_C2_DEBUG_INIT (( SHCI_OGF << 10) + SHCI_OCF_C2_DEBUG_INIT) + /** Command parameters */ + typedef PACKED_STRUCT + { + uint8_t thread_config; + uint8_t ble_config; + uint8_t mac_802_15_4_config; + uint8_t zigbee_config; + } SHCI_C2_DEBUG_TracesConfig_t; + + typedef PACKED_STRUCT + { + uint8_t ble_dtb_cfg; + /** + * sys_dbg_cfg1 options flag + * - bit 0: 0: IP BLE core in LP mode 1: IP BLE core in run mode (no LP supported) + * - bit 1: 0: CPU2 STOP mode Enable 1: CPU2 STOP mode Disable + * - bit [2-7]: bits reserved ( shall be set to 0) + */ + uint8_t sys_dbg_cfg1; + uint8_t reserved[2]; + uint16_t STBY_DebugGpioaPinList; + uint16_t STBY_DebugGpiobPinList; + uint16_t STBY_DebugGpiocPinList; + uint16_t STBY_DtbGpioaPinList; + uint16_t STBY_DtbGpiobPinList; + } SHCI_C2_DEBUG_GeneralConfig_t; + + typedef PACKED_STRUCT{ + uint8_t *pGpioConfig; + uint8_t *pTracesConfig; + uint8_t *pGeneralConfig; + uint8_t GpioConfigSize; + uint8_t TracesConfigSize; + uint8_t GeneralConfigSize; + } SHCI_C2_DEBUG_init_Cmd_Param_t; + + typedef PACKED_STRUCT{ + SHCI_Header_t Header; /** Does not need to be initialized by the user */ + SHCI_C2_DEBUG_init_Cmd_Param_t Param; + } SHCI_C2_DEBUG_Init_Cmd_Packet_t; + /** No response parameters*/ + + /** + * Options + * Each definition below may be added together to build the Options value + * WARNING : Only one definition per bit shall be added to build the Options value + */ +#define SHCI_C2_DEBUG_OPTIONS_IPCORE_LP (0<<0) +#define SHCI_C2_DEBUG_OPTIONS_IPCORE_NO_LP (1<<0) + +#define SHCI_C2_DEBUG_OPTIONS_CPU2_STOP_EN (0<<1) +#define SHCI_C2_DEBUG_OPTIONS_CPU2_STOP_DIS (1<<1) + + +#define SHCI_OPCODE_C2_FLASH_ERASE_ACTIVITY (( SHCI_OGF << 10) + SHCI_OCF_C2_FLASH_ERASE_ACTIVITY) + /** Command parameters */ + typedef enum + { + ERASE_ACTIVITY_OFF = 0x00, + ERASE_ACTIVITY_ON = 0x01, + } SHCI_EraseActivity_t; + + /** No response parameters*/ + +#define SHCI_OPCODE_C2_CONCURRENT_SET_MODE (( SHCI_OGF << 10) + SHCI_OCF_C2_CONCURRENT_SET_MODE) +/** command parameters */ + typedef enum + { + BLE_ENABLE, + THREAD_ENABLE, + ZIGBEE_ENABLE, + MAC_ENABLE, + } SHCI_C2_CONCURRENT_Mode_Param_t; + /** No response parameters*/ + +#define SHCI_OPCODE_C2_CONCURRENT_GET_NEXT_BLE_EVT_TIME (( SHCI_OGF << 10) + SHCI_OCF_C2_CONCURRENT_GET_NEXT_BLE_EVT_TIME) +/** command parameters */ + typedef PACKED_STRUCT + { + uint32_t relative_time; + } SHCI_C2_CONCURRENT_GetNextBleEvtTime_Param_t; + /** No response parameters*/ + +#define SHCI_OPCODE_C2_CONCURRENT_ENABLE_NEXT_802154_EVT_NOTIFICATION (( SHCI_OGF << 10) + SHCI_OCF_C2_CONCURRENT_ENABLE_NEXT_802154_EVT_NOTIFICATION) + /** No command parameters */ + /** No response parameters*/ + +#define SHCI_OPCODE_C2_FLASH_STORE_DATA (( SHCI_OGF << 10) + SHCI_OCF_C2_FLASH_STORE_DATA) +#define SHCI_OPCODE_C2_FLASH_ERASE_DATA (( SHCI_OGF << 10) + SHCI_OCF_C2_FLASH_ERASE_DATA) +/** command parameters */ + typedef enum + { + BLE_IP, + THREAD_IP, + ZIGBEE_IP, + } SHCI_C2_FLASH_Ip_t; + /** No response parameters*/ + +#define SHCI_OPCODE_C2_RADIO_ALLOW_LOW_POWER (( SHCI_OGF << 10) + SHCI_OCF_C2_RADIO_ALLOW_LOW_POWER) + +#define SHCI_OPCODE_C2_MAC_802_15_4_INIT (( SHCI_OGF << 10) + SHCI_OCF_C2_MAC_802_15_4_INIT) + +#define SHCI_OPCODE_C2_REINIT (( SHCI_OGF << 10) + SHCI_OCF_C2_REINIT) + +#define SHCI_OPCODE_C2_ZIGBEE_INIT (( SHCI_OGF << 10) + SHCI_OCF_C2_ZIGBEE_INIT) + +#define SHCI_OPCODE_C2_LLD_TESTS_INIT (( SHCI_OGF << 10) + SHCI_OCF_C2_LLD_TESTS_INIT) + +#define SHCI_OPCODE_C2_BLE_LLD_INIT (( SHCI_OGF << 10) + SHCI_OCF_C2_BLE_LLD_INIT) + +#define SHCI_OPCODE_C2_EXTPA_CONFIG (( SHCI_OGF << 10) + SHCI_OCF_C2_EXTPA_CONFIG) + /** Command parameters */ + enum + { + EXT_PA_ENABLED_LOW, + EXT_PA_ENABLED_HIGH, + }/* gpio_polarity */; + + enum + { + EXT_PA_DISABLED, + EXT_PA_ENABLED, + }/* gpio_status */; + + typedef PACKED_STRUCT{ + uint32_t gpio_port; + uint16_t gpio_pin_number; + uint8_t gpio_polarity; + uint8_t gpio_status; + } SHCI_C2_EXTPA_CONFIG_Cmd_Param_t; + + /** No response parameters*/ + +#define SHCI_OPCODE_C2_SET_FLASH_ACTIVITY_CONTROL (( SHCI_OGF << 10) + SHCI_OCF_C2_SET_FLASH_ACTIVITY_CONTROL) + /** Command parameters */ + typedef enum + { + FLASH_ACTIVITY_CONTROL_PES, + FLASH_ACTIVITY_CONTROL_SEM7, + }SHCI_C2_SET_FLASH_ACTIVITY_CONTROL_Source_t; + + /** No response parameters*/ + +#define SHCI_OPCODE_C2_CONFIG (( SHCI_OGF << 10) + SHCI_OCF_C2_CONFIG) + /** Command parameters */ + typedef PACKED_STRUCT{ + uint8_t PayloadCmdSize; + uint8_t Config1; + uint8_t EvtMask1; + uint8_t Spare1; + uint32_t BleNvmRamAddress; + uint32_t ThreadNvmRamAddress; + uint16_t RevisionID; + uint16_t DeviceID; + } SHCI_C2_CONFIG_Cmd_Param_t; + +#define SHCI_OPCODE_C2_802_15_4_DEINIT (( SHCI_OGF << 10) + SHCI_OCF_C2_802_15_4_DEINIT) + +/** + * PayloadCmdSize + * Value that shall be used + */ +#define SHCI_C2_CONFIG_PAYLOAD_CMD_SIZE (sizeof(SHCI_C2_CONFIG_Cmd_Param_t) - 1) + +/** + * Device revision ID + */ +#define SHCI_C2_CONFIG_CUT2_0 (0x2000) +#define SHCI_C2_CONFIG_CUT2_1 (0x2001) +#define SHCI_C2_CONFIG_CUT2_2 (0x2003) + +/** + * Device ID + */ +#define SHCI_C2_CONFIG_STM32WB55xx (0x495) +#define SHCI_C2_CONFIG_STM32WB15xx (0x494) + +/** + * Config1 + * Each definition below may be added together to build the Config1 value + * WARNING : Only one definition per bit shall be added to build the Config1 value + */ +#define SHCI_C2_CONFIG_CONFIG1_BIT0_BLE_NVM_DATA_TO_INTERNAL_FLASH (0<<0) +#define SHCI_C2_CONFIG_CONFIG1_BIT0_BLE_NVM_DATA_TO_SRAM (1<<0) +#define SHCI_C2_CONFIG_CONFIG1_BIT1_THREAD_NVM_DATA_TO_INTERNAL_FLASH (0<<1) +#define SHCI_C2_CONFIG_CONFIG1_BIT1_THREAD_NVM_DATA_TO_SRAM (1<<1) + +/** + * EvtMask1 + * Each definition below may be added together to build the EvtMask1 value + */ +#define SHCI_C2_CONFIG_EVTMASK1_BIT0_ERROR_NOTIF_ENABLE (1<<0) +#define SHCI_C2_CONFIG_EVTMASK1_BIT1_BLE_NVM_RAM_UPDATE_ENABLE (1<<1) +#define SHCI_C2_CONFIG_EVTMASK1_BIT2_THREAD_NVM_RAM_UPDATE_ENABLE (1<<2) +#define SHCI_C2_CONFIG_EVTMASK1_BIT3_NVM_START_WRITE_ENABLE (1<<3) +#define SHCI_C2_CONFIG_EVTMASK1_BIT4_NVM_END_WRITE_ENABLE (1<<4) +#define SHCI_C2_CONFIG_EVTMASK1_BIT5_NVM_START_ERASE_ENABLE (1<<5) +#define SHCI_C2_CONFIG_EVTMASK1_BIT6_NVM_END_ERASE_ENABLE (1<<6) + +/** + * BleNvmRamAddress + * The buffer shall have a size of BLE_NVM_SRAM_SIZE number of 32bits + * The buffer shall be allocated in SRAM2 + */ +#define BLE_NVM_SRAM_SIZE (507) + +/** + * ThreadNvmRamAddress + * The buffer shall have a size of THREAD_NVM_SRAM_SIZE number of 32bits + * The buffer shall be allocated in SRAM2 + */ +#define THREAD_NVM_SRAM_SIZE (1016) + + + /** No response parameters*/ + + /* Exported type --------------------------------------------------------*/ +#define FUS_DEVICE_INFO_TABLE_VALIDITY_KEYWORD (0xA94656B9) + +/* + * At startup, the information relative to the wireless binary are stored in RAM through a structure defined by + * MB_WirelessFwInfoTable_t.This structure contains 4 fields (Version,MemorySize, Stack_info and a reserved part) + * each of those coded on 32 bits as shown on the table below: + * + * + * |7 |6 |5 |4 |3 |2 |1 |0 |7 |6 |5 |4 |3 |2 |1 |0 |7 |6 |5 |4 |3 |2 |1 |0 |7 |6 |5 |4 |3 |2 |1 |0 | + * ------------------------------------------------------------------------------------------------- + * Version | Major version | Minor version | Sub version | Branch |ReleaseType| + * ------------------------------------------------------------------------------------------------- + * MemorySize | SRAM2B (kB) | SRAM2A (kB) | SRAM1 (kB) | FLASH (4kb) | + * ------------------------------------------------------------------------------------------------- + * Info stack | Reserved | Reserved | Reserved | Type (MAC,Thread,BLE) | + * ------------------------------------------------------------------------------------------------- + * Reserved | Reserved | Reserved | Reserved | Reserved | + * ------------------------------------------------------------------------------------------------- + * + */ + +/* Field Version */ +#define INFO_VERSION_MAJOR_OFFSET 24 +#define INFO_VERSION_MAJOR_MASK 0xff000000 +#define INFO_VERSION_MINOR_OFFSET 16 +#define INFO_VERSION_MINOR_MASK 0x00ff0000 +#define INFO_VERSION_SUB_OFFSET 8 +#define INFO_VERSION_SUB_MASK 0x0000ff00 +#define INFO_VERSION_BRANCH_OFFSET 4 +#define INFO_VERSION_BRANCH_MASK 0x0000000f0 +#define INFO_VERSION_TYPE_OFFSET 0 +#define INFO_VERSION_TYPE_MASK 0x00000000f + +#define INFO_VERSION_TYPE_RELEASE 1 + +/* Field Memory */ +#define INFO_SIZE_SRAM2B_OFFSET 24 +#define INFO_SIZE_SRAM2B_MASK 0xff000000 +#define INFO_SIZE_SRAM2A_OFFSET 16 +#define INFO_SIZE_SRAM2A_MASK 0x00ff0000 +#define INFO_SIZE_SRAM1_OFFSET 8 +#define INFO_SIZE_SRAM1_MASK 0x0000ff00 +#define INFO_SIZE_FLASH_OFFSET 0 +#define INFO_SIZE_FLASH_MASK 0x000000ff + +/* Field stack information */ +#define INFO_STACK_TYPE_OFFSET 0 +#define INFO_STACK_TYPE_MASK 0x000000ff +#define INFO_STACK_TYPE_NONE 0 + +#define INFO_STACK_TYPE_BLE_FULL 0x01 +#define INFO_STACK_TYPE_BLE_HCI 0x02 +#define INFO_STACK_TYPE_BLE_LIGHT 0x03 +#define INFO_STACK_TYPE_BLE_BEACON 0x04 +#define INFO_STACK_TYPE_BLE_BASIC 0x05 +#define INFO_STACK_TYPE_BLE_FULL_EXT_ADV 0x06 +#define INFO_STACK_TYPE_BLE_HCI_EXT_ADV 0x07 +#define INFO_STACK_TYPE_THREAD_FTD 0x10 +#define INFO_STACK_TYPE_THREAD_MTD 0x11 +#define INFO_STACK_TYPE_ZIGBEE_FFD 0x30 +#define INFO_STACK_TYPE_ZIGBEE_RFD 0x31 +#define INFO_STACK_TYPE_MAC 0x40 +#define INFO_STACK_TYPE_BLE_THREAD_FTD_STATIC 0x50 +#define INFO_STACK_TYPE_BLE_THREAD_FTD_DYAMIC 0x51 +#define INFO_STACK_TYPE_802154_LLD_TESTS 0x60 +#define INFO_STACK_TYPE_802154_PHY_VALID 0x61 +#define INFO_STACK_TYPE_BLE_PHY_VALID 0x62 +#define INFO_STACK_TYPE_BLE_LLD_TESTS 0x63 +#define INFO_STACK_TYPE_BLE_RLV 0x64 +#define INFO_STACK_TYPE_802154_RLV 0x65 +#define INFO_STACK_TYPE_BLE_ZIGBEE_FFD_STATIC 0x70 +#define INFO_STACK_TYPE_BLE_ZIGBEE_RFD_STATIC 0x71 +#define INFO_STACK_TYPE_BLE_ZIGBEE_FFD_DYNAMIC 0x78 +#define INFO_STACK_TYPE_BLE_ZIGBEE_RFD_DYNAMIC 0x79 +#define INFO_STACK_TYPE_RLV 0x80 +#define INFO_STACK_TYPE_BLE_MAC_STATIC 0x90 + +typedef struct { +/** + * Wireless Info + */ + uint8_t VersionMajor; + uint8_t VersionMinor; + uint8_t VersionSub; + uint8_t VersionBranch; + uint8_t VersionReleaseType; + uint8_t MemorySizeSram2B; /*< Multiple of 1K */ + uint8_t MemorySizeSram2A; /*< Multiple of 1K */ + uint8_t MemorySizeSram1; /*< Multiple of 1K */ + uint8_t MemorySizeFlash; /*< Multiple of 4K */ + uint8_t StackType; +/** + * Fus Info + */ + uint8_t FusVersionMajor; + uint8_t FusVersionMinor; + uint8_t FusVersionSub; + uint8_t FusMemorySizeSram2B; /*< Multiple of 1K */ + uint8_t FusMemorySizeSram2A; /*< Multiple of 1K */ + uint8_t FusMemorySizeFlash; /*< Multiple of 4K */ +}WirelessFwInfo_t; + + +/* Exported functions ------------------------------------------------------- */ + + /** + * SHCI_C2_FUS_GetState + * @brief Read the FUS State + * If the user is not interested by the Error code response, a null value may + * be passed as parameter + * + * Note: This command is fully supported only by the FUS. + * When the wireless firmware receives that command, it responds SHCI_FUS_CMD_NOT_SUPPORTED the first time. + * When the wireless firmware receives that command a second time, it reboots the full device with the FUS running on CPU2 + * + * @param p_rsp : return the error code when the FUS State Value = 0xFF + * @retval FUS State Values + */ + uint8_t SHCI_C2_FUS_GetState( SHCI_FUS_GetState_ErrorCode_t *p_rsp ); + + /** + * SHCI_C2_FUS_FwUpgrade + * @brief Request the FUS to install the CPU2 firmware update + * Note: This command is only supported by the FUS. + * + * @param fw_src_add: Address of the firmware image location + * @param fw_dest_add: Address of the firmware destination + * @retval Status + */ + SHCI_CmdStatus_t SHCI_C2_FUS_FwUpgrade( uint32_t fw_src_add, uint32_t fw_dest_add ); + + /** + * SHCI_C2_FUS_FwDelete + * @brief Delete the wireless stack on CPU2 + * Note: This command is only supported by the FUS. + * + * @param None + * @retval Status + */ + SHCI_CmdStatus_t SHCI_C2_FUS_FwDelete( void ); + + /** + * SHCI_C2_FUS_UpdateAuthKey + * @brief Request the FUS to update the authentication key + * Note: This command is only supported by the FUS. + * + * @param pCmdPacket + * @retval Status + */ + SHCI_CmdStatus_t SHCI_C2_FUS_UpdateAuthKey( SHCI_C2_FUS_UpdateAuthKey_Cmd_Param_t *pParam ); + + /** + * SHCI_C2_FUS_LockAuthKey + * @brief Request the FUS to prevent any future update of the authentication key + * Note: This command is only supported by the FUS. + * + * @param None + * @retval Status + */ + SHCI_CmdStatus_t SHCI_C2_FUS_LockAuthKey( void ); + + /** + * SHCI_C2_FUS_StoreUsrKey + * @brief Request the FUS to store the user key + * Note: This command is supported by both the FUS and the wireless stack. + * + * @param pParam : command parameter + * @param p_key_index : Index allocated by the FUS to the stored key + * + * @retval Status + */ + SHCI_CmdStatus_t SHCI_C2_FUS_StoreUsrKey( SHCI_C2_FUS_StoreUsrKey_Cmd_Param_t *pParam, uint8_t *p_key_index ); + + /** + * SHCI_C2_FUS_LoadUsrKey + * @brief Request the FUS to load the user key into the AES + * Note: This command is supported by both the FUS and the wireless stack. + * + * @param key_index : index of the user key to load in AES1 + * @retval Status + */ + SHCI_CmdStatus_t SHCI_C2_FUS_LoadUsrKey( uint8_t key_index ); + + /** + * SHCI_C2_FUS_StartWs + * @brief Request the FUS to reboot on the wireless stack + * Note: This command is only supported by the FUS. + * + * @param None + * @retval Status + */ + SHCI_CmdStatus_t SHCI_C2_FUS_StartWs( void ); + + /** + * SHCI_C2_FUS_LockUsrKey + * @brief Request the FUS to lock the user key so that it cannot be updated later on + * Note: This command is supported by both the FUS and the wireless stack. + * + * @param key_index : index of the user key to lock + * @retval Status + */ + SHCI_CmdStatus_t SHCI_C2_FUS_LockUsrKey( uint8_t key_index ); + + /** + * SHCI_C2_FUS_UnloadUsrKey + * @brief Request the FUS to Unload the user key so that the CPU1 may use the AES with another Key + * Note: This command is supported by both the FUS and the wireless stack. + * + * @param key_index : index of the user key to unload + * @retval Status + */ + SHCI_CmdStatus_t SHCI_C2_FUS_UnloadUsrKey( uint8_t key_index ); + + /** + * SHCI_C2_FUS_ActivateAntiRollback + * @brief Request the FUS to enable the AntiRollback feature so that it is not possible to update the wireless firmware + * with an older version than the current one. + * Note: + * - This command is only supported by the FUS. + * - Once this feature is enabled, it is not possible anymore to disable it. + * + * @param None + * @retval Status + */ + SHCI_CmdStatus_t SHCI_C2_FUS_ActivateAntiRollback( void ); + + /** + * SHCI_C2_BLE_Init + * @brief Provides parameters and starts the BLE Stack + * + * @param pCmdPacket : Parameters are described SHCI_C2_Ble_Init_Cmd_Packet_t declaration + * @retval Status + */ + SHCI_CmdStatus_t SHCI_C2_BLE_Init( SHCI_C2_Ble_Init_Cmd_Packet_t *pCmdPacket ); + + /** + * SHCI_C2_THREAD_Init + * @brief Starts the THREAD Stack + * + * @param None + * @retval Status + */ + SHCI_CmdStatus_t SHCI_C2_THREAD_Init( void ); + + /** + * SHCI_C2_LLDTESTS_Init + * @brief Starts the LLD tests CLI + * + * @param param_size : Nb of bytes + * @param p_param : pointer with data to give from M4 to M0 + * @retval Status + */ + SHCI_CmdStatus_t SHCI_C2_LLDTESTS_Init( uint8_t param_size, uint8_t * p_param ); + + /** + * SHCI_C2_BLE_LLD_Init + * @brief Starts the LLD tests BLE + * + * @param param_size : Nb of bytes + * @param p_param : pointer with data to give from M4 to M0 + * @retval Status + */ + SHCI_CmdStatus_t SHCI_C2_BLE_LLD_Init( uint8_t param_size, uint8_t * p_param ); + + /** + * SHCI_C2_ZIGBEE_Init + * @brief Starts the Zigbee Stack + * + * @param None + * @retval Status + */ + SHCI_CmdStatus_t SHCI_C2_ZIGBEE_Init( void ); + + /** + * SHCI_C2_DEBUG_Init + * @brief Starts the Traces + * + * @param None + * @retval Status + */ + SHCI_CmdStatus_t SHCI_C2_DEBUG_Init( SHCI_C2_DEBUG_Init_Cmd_Packet_t *pCmdPacket ); + + /** + * SHCI_C2_FLASH_EraseActivity + * @brief Provides the information of the start and the end of a flash erase window on the CPU1 + * The protection will be active until next end of radio event. + * + * @param erase_activity: Start/End of erase activity + * @retval Status + */ + SHCI_CmdStatus_t SHCI_C2_FLASH_EraseActivity( SHCI_EraseActivity_t erase_activity ); + + /** + * SHCI_C2_CONCURRENT_SetMode + * @brief Enable/Disable Thread on CPU2 (M0+) + * + * @param Mode: BLE or Thread enable flag + * @retval Status + */ + SHCI_CmdStatus_t SHCI_C2_CONCURRENT_SetMode( SHCI_C2_CONCURRENT_Mode_Param_t Mode ); + + /** + * SHCI_C2_CONCURRENT_GetNextBleEvtTime + * @brief Get the next BLE event date (relative time) + * + * @param Command Packet + * @retval None + */ + SHCI_CmdStatus_t SHCI_C2_CONCURRENT_GetNextBleEvtTime( SHCI_C2_CONCURRENT_GetNextBleEvtTime_Param_t *pParam ); + + /** + * SHCI_C2_CONCURRENT_EnableNext_802154_EvtNotification + * @brief Activate the next 802.15.4 event notification (one shot) + * + * @param None + * @retval None + */ + SHCI_CmdStatus_t SHCI_C2_CONCURRENT_EnableNext_802154_EvtNotification( void ); + + /** + * SHCI_C2_FLASH_StoreData + * @brief Store Data in Flash + * + * @param Ip: BLE or THREAD + * @retval Status + */ + SHCI_CmdStatus_t SHCI_C2_FLASH_StoreData( SHCI_C2_FLASH_Ip_t Ip ); + + /** + * SHCI_C2_FLASH_EraseData + * @brief Erase Data in Flash + * + * @param Ip: BLE or THREAD + * @retval Status + */ + SHCI_CmdStatus_t SHCI_C2_FLASH_EraseData( SHCI_C2_FLASH_Ip_t Ip ); + + /** + * SHCI_C2_RADIO_AllowLowPower + * @brief Allow or forbid IP_radio (802_15_4 or BLE) to enter in low power mode. + * + * @param Ip: BLE or 802_15_5 + * @param FlagRadioLowPowerOn: True or false + * @retval Status + */ + SHCI_CmdStatus_t SHCI_C2_RADIO_AllowLowPower( SHCI_C2_FLASH_Ip_t Ip,uint8_t FlagRadioLowPowerOn); + + + /** + * SHCI_C2_MAC_802_15_4_Init + * @brief Starts the MAC 802.15.4 on M0 + * + * @param None + * @retval Status + */ + SHCI_CmdStatus_t SHCI_C2_MAC_802_15_4_Init( void ); + + /** + * SHCI_GetWirelessFwInfo + * @brief This function read back the information relative to the wireless binary loaded. + * Refer yourself to MB_WirelessFwInfoTable_t structure to get the significance + * of the different parameters returned. + * @param pWirelessInfo : Pointer to WirelessFwInfo_t. + * + * @retval SHCI_Success + */ + SHCI_CmdStatus_t SHCI_GetWirelessFwInfo( WirelessFwInfo_t* pWirelessInfo ); + + /** + * SHCI_C2_Reinit + * @brief This is required to allow the CPU1 to fake a set C2BOOT when it has already been set. + * In order to fake a C2BOOT, the CPU1 shall : + * - Send SHCI_C2_Reinit() + * - call SEV instruction + * WARNING: + * This function is intended to be used by the SBSFU + * + * @param None + * @retval Status + */ + SHCI_CmdStatus_t SHCI_C2_Reinit( void ); + + /** + * SHCI_C2_ExtpaConfig + * @brief Send the Ext PA configuration + * When the CPU2 receives the command, it controls the Ext PA as requested by the configuration + * This configures only which IO is used to enable/disable the ExtPA and the associated polarity + * This command has no effect on the other IO that is used to control the mode of the Ext PA (Rx/Tx) + * + * @param gpio_port: GPIOx where x can be (A..F) to select the GPIO peripheral for STM32WBxx family + * @param gpio_pin_number: This parameter can be one of GPIO_PIN_x (= LL_GPIO_PIN_x) where x can be (0..15). + * @param gpio_polarity: This parameter can be either + * - EXT_PA_ENABLED_LOW: ExtPA is enabled when GPIO is low + * - EXT_PA_ENABLED_HIGH: ExtPA is enabled when GPIO is high + * @param gpio_status: This parameter can be either + * - EXT_PA_DISABLED: Stop driving the ExtPA + * - EXT_PA_ENABLED: Drive the ExtPA according to radio activity + * (ON before the Event and OFF at the end of the event) + * @retval Status + */ + SHCI_CmdStatus_t SHCI_C2_ExtpaConfig(uint32_t gpio_port, uint16_t gpio_pin_number, uint8_t gpio_polarity, uint8_t gpio_status); + + /** + * SHCI_C2_SetFlashActivityControl + * @brief Set the mechanism to be used on CPU2 to prevent the CPU1 to either write or erase in flash + * + * @param Source: It can be one of the following list + * - FLASH_ACTIVITY_CONTROL_PES : The CPU2 set the PES bit to prevent the CPU1 to either read or write in flash + * - FLASH_ACTIVITY_CONTROL_SEM7 : The CPU2 gets the semaphore 7 to prevent the CPU1 to either read or write in flash. + * This requires the CPU1 to first get semaphore 7 before erasing or writing the flash. + * + * @retval Status + */ + SHCI_CmdStatus_t SHCI_C2_SetFlashActivityControl(SHCI_C2_SET_FLASH_ACTIVITY_CONTROL_Source_t Source); + + /** + * SHCI_C2_Config + * @brief Send the system configuration to the CPU2 + * + * @param pCmdPacket: address of the buffer holding following parameters + * uint8_t PayloadCmdSize : Size of the payload - shall be SHCI_C2_CONFIG_PAYLOAD_CMD_SIZE + * uint8_t Config1 : + * - bit0 : 0 - BLE NVM Data data are flushed in internal secure flash + * 1 - BLE NVM Data are written in SRAM cache pointed by BleNvmRamAddress + * - bit1 : 0 - THREAD NVM Data data are flushed in internal secure flash + * 1 - THREAD NVM Data are written in SRAM cache pointed by ThreadNvmRamAddress + * - bit2 to bit7 : Unused, shall be set to 0 + * uint8_t EvtMask1 : + * When a bit is set to 0, the event is not reported + * bit0 : Asynchronous Event with Sub Evt Code 0x9201 (= SHCI_SUB_EVT_ERROR_NOTIF) + * ... + * bit31 : Asynchronous Event with Sub Evt Code 0x9220 + * uint8_t Spare1 : Unused, shall be set to 0 + * uint32_t BleNvmRamAddress : + * Only considered when Config1.bit0 = 1 + * When set to 0, data are kept in internal SRAM on CPU2 + * Otherwise, data are copied in the cache pointed by BleNvmRamAddress + * The size of the buffer shall be BLE_NVM_SRAM_SIZE (number of 32bits) + * The buffer shall be allocated in SRAM2 + * uint32_t ThreadNvmRamAddress : + * Only considered when Config1.bit1 = 1 + * When set to 0, data are kept in internal SRAM on CPU2 + * Otherwise, data are copied in the cache pointed by ThreadNvmRamAddress + * The size of the buffer shall be THREAD_NVM_SRAM_SIZE (number of 32bits) + * The buffer shall be allocated in SRAM1 + * + * Please check macro definition to be used for this function + * They are defined in this file next to the definition of SHCI_OPCODE_C2_CONFIG + * + * @retval Status + */ + SHCI_CmdStatus_t SHCI_C2_Config(SHCI_C2_CONFIG_Cmd_Param_t *pCmdPacket); + + /** + * SHCI_C2_802_15_4_DeInit + * @brief Deinit 802.15.4 layer (to be used before entering StandBy mode) + * + * @param None + * @retval Status + */ + SHCI_CmdStatus_t SHCI_C2_802_15_4_DeInit( void ); + + #ifdef __cplusplus +} +#endif + +#endif /*__SHCI_H */ + diff --git a/src/utility/STM32Cube_FW/shci_tl.c b/src/utility/STM32Cube_FW/shci_tl.c new file mode 100644 index 00000000..60380251 --- /dev/null +++ b/src/utility/STM32Cube_FW/shci_tl.c @@ -0,0 +1,270 @@ +/** + ****************************************************************************** + * @file shci.c + * @author MCD Application Team + * @brief System HCI command implementation + ****************************************************************************** + * @attention + * + * Copyright (c) 2018-2021 STMicroelectronics. + * All rights reserved. + * + * This software is licensed under terms that can be found in the LICENSE file + * in the root directory of this software component. + * If no LICENSE file comes with this software, it is provided AS-IS. + * + ****************************************************************************** + */ + +#if defined(STM32WBxx) +/* Includes ------------------------------------------------------------------*/ +#include "stm32_wpan_common.h" + +#include "stm_list.h" +#include "shci_tl.h" +#include "stm32_def.h" +#include "wiring_time.h" + +/* Private typedef -----------------------------------------------------------*/ +typedef enum +{ + SHCI_TL_CMD_RESP_RELEASE, + SHCI_TL_CMD_RESP_WAIT, +} SHCI_TL_CmdRespStatus_t; + +/* Private defines -----------------------------------------------------------*/ +/** + * The default System HCI layer timeout is set to 33s + */ +#define SHCI_TL_DEFAULT_TIMEOUT (33000) + +/* Private macros ------------------------------------------------------------*/ +/* Public variables ---------------------------------------------------------*/ +/* Private variables ---------------------------------------------------------*/ +/** + * START of Section SYSTEM_DRIVER_CONTEXT + */ +PLACE_IN_SECTION("SYSTEM_DRIVER_CONTEXT") static tListNode SHciAsynchEventQueue; +PLACE_IN_SECTION("SYSTEM_DRIVER_CONTEXT") static volatile SHCI_TL_CmdStatus_t SHCICmdStatus; +PLACE_IN_SECTION("SYSTEM_DRIVER_CONTEXT") static TL_CmdPacket_t *pCmdBuffer; +PLACE_IN_SECTION("SYSTEM_DRIVER_CONTEXT") SHCI_TL_UserEventFlowStatus_t SHCI_TL_UserEventFlow; +/** + * END of Section SYSTEM_DRIVER_CONTEXT + */ + +static tSHciContext shciContext; +static void (* StatusNotCallBackFunction) (SHCI_TL_CmdStatus_t status); + +static volatile SHCI_TL_CmdRespStatus_t CmdRspStatusFlag; + +/* Private function prototypes -----------------------------------------------*/ +static void Cmd_SetStatus(SHCI_TL_CmdStatus_t shcicmdstatus); +static void TlCmdEvtReceived(TL_EvtPacket_t *shcievt); +static void TlUserEvtReceived(TL_EvtPacket_t *shcievt); +static void TlInit( TL_CmdPacket_t * p_cmdbuffer ); + +/* Interface ------- ---------------------------------------------------------*/ +void shci_init(void(* UserEvtRx)(void* pData), void* pConf) +{ + StatusNotCallBackFunction = ((SHCI_TL_HciInitConf_t *)pConf)->StatusNotCallBack; + shciContext.UserEvtRx = UserEvtRx; + + shci_register_io_bus (&shciContext.io); + + TlInit((TL_CmdPacket_t *)(((SHCI_TL_HciInitConf_t *)pConf)->p_cmdbuffer)); + + return; +} + +void shci_user_evt_proc(void) +{ + TL_EvtPacket_t *phcievtbuffer; + tSHCI_UserEvtRxParam UserEvtRxParam; + + /** + * Up to release version v1.2.0, a while loop was implemented to read out events from the queue as long as + * it is not empty. However, in a bare metal implementation, this leads to calling in a "blocking" mode + * shci_user_evt_proc() as long as events are received without giving the opportunity to run other tasks + * in the background. + * From now, the events are reported one by one. When it is checked there is still an event pending in the queue, + * a request to the user is made to call again shci_user_evt_proc(). + * This gives the opportunity to the application to run other background tasks between each event. + */ + + /** + * It is more secure to use LST_remove_head()/LST_insert_head() compare to LST_get_next_node()/LST_remove_node() + * in case the user overwrite the header where the next/prev pointers are located + */ + if((LST_is_empty(&SHciAsynchEventQueue) == FALSE) && (SHCI_TL_UserEventFlow != SHCI_TL_UserEventFlow_Disable)) + { + LST_remove_head ( &SHciAsynchEventQueue, (tListNode **)&phcievtbuffer ); + + if (shciContext.UserEvtRx != NULL) + { + UserEvtRxParam.pckt = phcievtbuffer; + UserEvtRxParam.status = SHCI_TL_UserEventFlow_Enable; + shciContext.UserEvtRx((void *)&UserEvtRxParam); + SHCI_TL_UserEventFlow = UserEvtRxParam.status; + } + else + { + SHCI_TL_UserEventFlow = SHCI_TL_UserEventFlow_Enable; + } + + if(SHCI_TL_UserEventFlow != SHCI_TL_UserEventFlow_Disable) + { + TL_MM_EvtDone( phcievtbuffer ); + } + else + { + /** + * put back the event in the queue + */ + LST_insert_head ( &SHciAsynchEventQueue, (tListNode *)phcievtbuffer ); + } + } + + if((LST_is_empty(&SHciAsynchEventQueue) == FALSE) && (SHCI_TL_UserEventFlow != SHCI_TL_UserEventFlow_Disable)) + { + shci_notify_asynch_evt((void*) &SHciAsynchEventQueue); + } + + + return; +} + +void shci_resume_flow( void ) +{ + SHCI_TL_UserEventFlow = SHCI_TL_UserEventFlow_Enable; + + /** + * It is better to go through the background process as it is not sure from which context this API may + * be called + */ + shci_notify_asynch_evt((void*) &SHciAsynchEventQueue); + + return; +} + +void shci_send( uint16_t cmd_code, uint8_t len_cmd_payload, uint8_t * p_cmd_payload, TL_EvtPacket_t * p_rsp ) +{ + Cmd_SetStatus(SHCI_TL_CmdBusy); + + pCmdBuffer->cmdserial.cmd.cmdcode = cmd_code; + pCmdBuffer->cmdserial.cmd.plen = len_cmd_payload; + + memcpy(pCmdBuffer->cmdserial.cmd.payload, p_cmd_payload, len_cmd_payload ); + CmdRspStatusFlag = SHCI_TL_CMD_RESP_WAIT; + shciContext.io.Send(0,0); + + shci_cmd_resp_wait(SHCI_TL_DEFAULT_TIMEOUT); + + /** + * The command complete of a system command does not have the header + * It starts immediately with the evtserial field + */ + memcpy( &(p_rsp->evtserial), pCmdBuffer, ((TL_EvtSerial_t*)pCmdBuffer)->evt.plen + TL_EVT_HDR_SIZE ); + + Cmd_SetStatus(SHCI_TL_CmdAvailable); + + return; +} + +void shci_notify_asynch_evt(void *pdata) +{ + UNUSED(pdata); + /* Need to parse data in future version */ + shci_user_evt_proc(); +} + +void shci_register_io_bus(tSHciIO *fops) +{ + /* Register IO bus services */ + fops->Init = TL_SYS_Init; + fops->Send = TL_SYS_SendCmd; +} + +/* Private functions ---------------------------------------------------------*/ +static void TlInit( TL_CmdPacket_t * p_cmdbuffer ) +{ + TL_SYS_InitConf_t Conf; + + pCmdBuffer = p_cmdbuffer; + + LST_init_head (&SHciAsynchEventQueue); + + Cmd_SetStatus(SHCI_TL_CmdAvailable); + + SHCI_TL_UserEventFlow = SHCI_TL_UserEventFlow_Enable; + + /* Initialize low level driver */ + if (shciContext.io.Init) + { + + Conf.p_cmdbuffer = (uint8_t *)p_cmdbuffer; + Conf.IoBusCallBackCmdEvt = TlCmdEvtReceived; + Conf.IoBusCallBackUserEvt = TlUserEvtReceived; + shciContext.io.Init(&Conf); + } + + return; +} + +static void Cmd_SetStatus(SHCI_TL_CmdStatus_t shcicmdstatus) +{ + if(shcicmdstatus == SHCI_TL_CmdBusy) + { + if(StatusNotCallBackFunction != 0) + { + StatusNotCallBackFunction( SHCI_TL_CmdBusy ); + } + SHCICmdStatus = SHCI_TL_CmdBusy; + } + else + { + SHCICmdStatus = SHCI_TL_CmdAvailable; + if(StatusNotCallBackFunction != 0) + { + StatusNotCallBackFunction( SHCI_TL_CmdAvailable ); + } + } + + return; +} + +static void TlCmdEvtReceived(TL_EvtPacket_t *shcievt) +{ + (void)(shcievt); + shci_cmd_resp_release(0); /**< Notify the application the Cmd response has been received */ + + return; +} + +static void TlUserEvtReceived(TL_EvtPacket_t *shcievt) +{ + LST_insert_tail(&SHciAsynchEventQueue, (tListNode *)shcievt); + shci_notify_asynch_evt((void*) &SHciAsynchEventQueue); /**< Notify the application a full HCI event has been received */ + + return; +} + +/* Weak implementation ----------------------------------------------------------------*/ +__WEAK void shci_cmd_resp_wait(uint32_t timeout) +{ + for (unsigned long start = millis(); (millis() - start) < timeout;) { + if (CmdRspStatusFlag == SHCI_TL_CMD_RESP_RELEASE) { + break; + } + } + return; +} + +__WEAK void shci_cmd_resp_release(uint32_t flag) +{ + (void)flag; + + CmdRspStatusFlag = SHCI_TL_CMD_RESP_RELEASE; + + return; +} +#endif /* STM32WBxx */ diff --git a/src/utility/STM32Cube_FW/shci_tl.h b/src/utility/STM32Cube_FW/shci_tl.h new file mode 100644 index 00000000..74d0ff38 --- /dev/null +++ b/src/utility/STM32Cube_FW/shci_tl.h @@ -0,0 +1,173 @@ +/** + ****************************************************************************** + * @file shci_tl.h + * @author MCD Application Team + * @brief System HCI command header for the system channel + ****************************************************************************** + * @attention + * + * Copyright (c) 2018-2021 STMicroelectronics. + * All rights reserved. + * + * This software is licensed under terms that can be found in the LICENSE file + * in the root directory of this software component. + * If no LICENSE file comes with this software, it is provided AS-IS. + * + ****************************************************************************** + */ + +#ifndef __SHCI_TL_H_ +#define __SHCI_TL_H_ + +#ifdef __cplusplus +extern "C" { +#endif + +#include "tl.h" + +/* Exported defines -----------------------------------------------------------*/ +typedef enum +{ + SHCI_TL_UserEventFlow_Disable, + SHCI_TL_UserEventFlow_Enable, +} SHCI_TL_UserEventFlowStatus_t; + +typedef enum +{ + SHCI_TL_CmdBusy, + SHCI_TL_CmdAvailable +} SHCI_TL_CmdStatus_t; + +/** + * @brief Structure used to manage the BUS IO operations. + * All the structure fields will point to functions defined at user level. + * @{ + */ +typedef struct +{ + int32_t (* Init) (void* pConf); /**< Pointer to SHCI TL function for the IO Bus initialization */ + int32_t (* DeInit) (void); /**< Pointer to SHCI TL function for the IO Bus de-initialization */ + int32_t (* Reset) (void); /**< Pointer to SHCI TL function for the IO Bus reset */ + int32_t (* Receive) (uint8_t*, uint16_t); /**< Pointer to SHCI TL function for the IO Bus data reception */ + int32_t (* Send) (uint8_t*, uint16_t); /**< Pointer to SHCI TL function for the IO Bus data transmission */ + int32_t (* DataAck) (uint8_t*, uint16_t* len); /**< Pointer to SHCI TL function for the IO Bus data ack reception */ + int32_t (* GetTick) (void); /**< Pointer to BSP function for getting the HAL time base timestamp */ +} tSHciIO; +/** + * @} + */ + +/** + * @brief Contain the SHCI context + * @{ + */ +typedef struct +{ + tSHciIO io; /**< Manage the BUS IO operations */ + void (* UserEvtRx) (void * pData); /**< User System events callback function pointer */ +} tSHciContext; + +typedef struct +{ + SHCI_TL_UserEventFlowStatus_t status; + TL_EvtPacket_t *pckt; +} tSHCI_UserEvtRxParam; + +typedef struct +{ + uint8_t *p_cmdbuffer; + void (* StatusNotCallBack) (SHCI_TL_CmdStatus_t status); +} SHCI_TL_HciInitConf_t; + +/** + * shci_send + * @brief Send an System HCI Command + * + * @param : cmd_code = Opcode of the command + * @param : len_cmd_payload = Length of the command payload + * @param : p_cmd_payload = Address of the command payload + * @param : p_rsp_status = Address of the full buffer holding the command complete event + * @retval : None + */ +void shci_send( uint16_t cmd_code, uint8_t len_cmd_payload, uint8_t * p_cmd_payload, TL_EvtPacket_t * p_rsp_status ); + +/** + * @brief Register IO bus services. + * @param fops The SHCI IO structure managing the IO BUS + * @retval None + */ +void shci_register_io_bus(tSHciIO* fops); + +/** + * @brief Interrupt service routine that must be called when the system channel + * reports a packet has been received + * + * @param pdata Packet or event pointer + * @retval None + */ +void shci_notify_asynch_evt(void* pdata); + +/** + * @brief This function resume the User Event Flow which has been stopped on return + * from UserEvtRx() when the User Event has not been processed. + * + * @param None + * @retval None + */ +void shci_resume_flow(void); + + +/** + * @brief This function is called when an System HCI Command is sent to the CPU2 and the response is waited. + * It is called from the same context the System HCI command has been sent. + * It shall not return until the command response notified by shci_cmd_resp_release() is received. + * A weak implementation is available in shci_tl.c based on polling mechanism + * The user may re-implement this function in the application to improve performance : + * - It may use UTIL_SEQ_WaitEvt() API when using the Sequencer + * - It may use a semaphore when using cmsis_os interface + * + * @param timeout: Waiting timeout + * @retval None + */ +void shci_cmd_resp_wait(uint32_t timeout); + +/** + * @brief This function is called when an System HCI command is received from the CPU2. + * A weak implementation is available in shci_tl.c based on polling mechanism + * The user may re-implement this function in the application to improve performance : + * - It may use UTIL_SEQ_SetEvt() API when using the Sequencer + * - It may use a semaphore when using cmsis_os interface + * + * + * @param flag: Release flag + * @retval None + */ +void shci_cmd_resp_release(uint32_t flag); + + +/** + * @brief This process shall be called each time the shci_notify_asynch_evt notification is received + * + * @param None + * @retval None + */ + +void shci_user_evt_proc(void); + +/** + * @brief Initialize the System Host Controller Interface. + * This function must be called before any communication on the System Channel + * + * @param UserEvtRx: System events callback function pointer + * This callback is triggered when an user event is received on + * the System Channel from CPU2. + * @param pConf: Configuration structure pointer + * @retval None + */ +void shci_init(void(* UserEvtRx)(void* pData), void* pConf); + +#ifdef __cplusplus +} +#endif + +#endif /* __SHCI_TL_H_ */ diff --git a/src/utility/STM32Cube_FW/stm32_wpan_common.h b/src/utility/STM32Cube_FW/stm32_wpan_common.h new file mode 100644 index 00000000..f407bb98 --- /dev/null +++ b/src/utility/STM32Cube_FW/stm32_wpan_common.h @@ -0,0 +1,171 @@ +/** + ****************************************************************************** + * @file stm32_wpan_common.h + * @author MCD Application Team + * @brief Common file to utilities + ****************************************************************************** + * @attention + * + * Copyright (c) 2018-2021 STMicroelectronics. + * All rights reserved. + * + * This software is licensed under terms that can be found in the LICENSE file + * in the root directory of this software component. + * If no LICENSE file comes with this software, it is provided AS-IS. + * + ****************************************************************************** + */ + + +/* Define to prevent recursive inclusion -------------------------------------*/ +#ifndef __STM32_WPAN_COMMON_H +#define __STM32_WPAN_COMMON_H + +#ifdef __cplusplus +extern "C" { +#endif + +#if defined ( __CC_ARM )||defined (__ARMCC_VERSION) + #define __ASM __asm /*!< asm keyword for ARM Compiler */ + #define __INLINE __inline /*!< inline keyword for ARM Compiler */ + #define __STATIC_INLINE static __inline +#elif defined ( __ICCARM__ ) + #define __ASM __asm /*!< asm keyword for IAR Compiler */ + #define __INLINE inline /*!< inline keyword for IAR Compiler. Only available in High optimization mode! */ + #define __STATIC_INLINE static inline +#elif defined ( __GNUC__ ) + #define __ASM __asm /*!< asm keyword for GNU Compiler */ + #define __INLINE inline /*!< inline keyword for GNU Compiler */ + #define __STATIC_INLINE static inline +#endif + +#include +#include +#include +#include +#include +#include "cmsis_compiler.h" + + /* -------------------------------- * + * Basic definitions * + * -------------------------------- */ + +#undef NULL +#define NULL 0U + +#undef FALSE +#define FALSE 0U + +#undef TRUE +#define TRUE (!0U) + + /* -------------------------------- * + * Critical Section definition * + * -------------------------------- */ +#undef BACKUP_PRIMASK +#define BACKUP_PRIMASK() uint32_t primask_bit= __get_PRIMASK() + +#undef DISABLE_IRQ +#define DISABLE_IRQ() __disable_irq() + +#undef RESTORE_PRIMASK +#define RESTORE_PRIMASK() __set_PRIMASK(primask_bit) + + /* -------------------------------- * + * Macro delimiters * + * -------------------------------- */ +#undef M_BEGIN +#define M_BEGIN do { + +#undef M_END +#define M_END } while(0) + + /* -------------------------------- * + * Some useful macro definitions * + * -------------------------------- */ +#undef MAX +#define MAX(a, b) (((a) > (b)) ? (a) : (b)) + +#undef MIN +#define MIN(a, b) (((a) < (b)) ? (a) : (b)) + +#undef MODINC +#define MODINC( a, m ) M_BEGIN (a)++; if ((a)>=(m)) (a)=0; M_END + +#undef MODDEC +#define MODDEC( a, m ) M_BEGIN if ((a)==0) (a)=(m); (a)--; M_END + +#undef MODADD +#define MODADD( a, b, m ) M_BEGIN (a)+=(b); if ((a)>=(m)) (a)-=(m); M_END + +#undef MODSUB +#define MODSUB( a, b, m ) MODADD( a, (m)-(b), m ) + +#undef ALIGN +#ifdef WIN32 +#define ALIGN(n) +#else +#define ALIGN(n) __attribute__((aligned(n))) +#endif + +#undef PAUSE +#define PAUSE( t ) M_BEGIN \ + volatile int _i; \ + for ( _i = t; _i > 0; _i -- ); \ + M_END +#undef DIVF +#define DIVF( x, y ) ((x)/(y)) + +#undef DIVC +#define DIVC( x, y ) (((x)+(y)-1)/(y)) + +#undef DIVR +#define DIVR( x, y ) (((x)+((y)/2))/(y)) + +#undef SHRR +#define SHRR( x, n ) ((((x)>>((n)-1))+1)>>1) + +#undef BITN +#define BITN( w, n ) (((w)[(n)/32] >> ((n)%32)) & 1) + +#undef BITNSET +#define BITNSET( w, n, b ) M_BEGIN (w)[(n)/32] |= ((U32)(b))<<((n)%32); M_END + +/* -------------------------------- * + * Section attribute * + * -------------------------------- */ +#undef PLACE_IN_SECTION +#define PLACE_IN_SECTION( __x__ ) __attribute__((section (__x__))) + +/* ----------------------------------- * + * Packed usage (compiler dependent) * + * ----------------------------------- */ +#undef PACKED__ +#undef PACKED_STRUCT + +#if defined ( __CC_ARM ) + #if defined ( __GNUC__ ) + /* GNU extension */ + #define PACKED__ __attribute__((packed)) + #define PACKED_STRUCT struct PACKED__ + #elif defined (__ARMCC_VERSION) && (__ARMCC_VERSION >= 6010050U) + #define PACKED__ __attribute__((packed)) + #define PACKED_STRUCT struct PACKED__ + #else + #define PACKED__(TYPE) __packed TYPE + #define PACKED_STRUCT PACKED__(struct) + #endif +#elif defined ( __GNUC__ ) + #define PACKED__ __attribute__((packed)) + #define PACKED_STRUCT struct PACKED__ +#elif defined (__ICCARM__) + #define PACKED_STRUCT __packed struct +#else + #define PACKED_STRUCT __packed struct +#endif + +#ifdef __cplusplus +} +#endif + +#endif /*__STM32_WPAN_COMMON_H */ diff --git a/src/utility/STM32Cube_FW/stm_list.c b/src/utility/STM32Cube_FW/stm_list.c new file mode 100644 index 00000000..4e8c3643 --- /dev/null +++ b/src/utility/STM32Cube_FW/stm_list.c @@ -0,0 +1,209 @@ +/** + ****************************************************************************** + * @file stm_list.c + * @author MCD Application Team + * @brief TCircular Linked List Implementation. + ****************************************************************************** + * @attention + * + * Copyright (c) 2018-2021 STMicroelectronics. + * All rights reserved. + * + * This software is licensed under terms that can be found in the LICENSE file + * in the root directory of this software component. + * If no LICENSE file comes with this software, it is provided AS-IS. + * + ****************************************************************************** + */ + +#if defined(STM32WBxx) +/****************************************************************************** + * Include Files + ******************************************************************************/ +#include "stdint.h" +#include "cmsis_gcc.h" +#include "stm32_wpan_common.h" + +#include "stm_list.h" + +/****************************************************************************** + * Function Definitions + ******************************************************************************/ +void LST_init_head (tListNode * listHead) +{ + listHead->next = listHead; + listHead->prev = listHead; +} + +uint8_t LST_is_empty (tListNode * listHead) +{ + uint32_t primask_bit; + uint8_t return_value; + + primask_bit = __get_PRIMASK(); /**< backup PRIMASK bit */ + __disable_irq(); /**< Disable all interrupts by setting PRIMASK bit on Cortex*/ + if(listHead->next == listHead) + { + return_value = TRUE; + } + else + { + return_value = FALSE; + } + __set_PRIMASK(primask_bit); /**< Restore PRIMASK bit*/ + + return return_value; +} + +void LST_insert_head (tListNode * listHead, tListNode * node) +{ + uint32_t primask_bit; + + primask_bit = __get_PRIMASK(); /**< backup PRIMASK bit */ + __disable_irq(); /**< Disable all interrupts by setting PRIMASK bit on Cortex*/ + + node->next = listHead->next; + node->prev = listHead; + listHead->next = node; + (node->next)->prev = node; + + __set_PRIMASK(primask_bit); /**< Restore PRIMASK bit*/ +} + + +void LST_insert_tail (tListNode * listHead, tListNode * node) +{ + uint32_t primask_bit; + + primask_bit = __get_PRIMASK(); /**< backup PRIMASK bit */ + __disable_irq(); /**< Disable all interrupts by setting PRIMASK bit on Cortex*/ + + node->next = listHead; + node->prev = listHead->prev; + listHead->prev = node; + (node->prev)->next = node; + + __set_PRIMASK(primask_bit); /**< Restore PRIMASK bit*/ +} + + +void LST_remove_node (tListNode * node) +{ + uint32_t primask_bit; + + primask_bit = __get_PRIMASK(); /**< backup PRIMASK bit */ + __disable_irq(); /**< Disable all interrupts by setting PRIMASK bit on Cortex*/ + + (node->prev)->next = node->next; + (node->next)->prev = node->prev; + + __set_PRIMASK(primask_bit); /**< Restore PRIMASK bit*/ +} + + +void LST_remove_head (tListNode * listHead, tListNode ** node ) +{ + uint32_t primask_bit; + + primask_bit = __get_PRIMASK(); /**< backup PRIMASK bit */ + __disable_irq(); /**< Disable all interrupts by setting PRIMASK bit on Cortex*/ + + *node = listHead->next; + LST_remove_node (listHead->next); + + __set_PRIMASK(primask_bit); /**< Restore PRIMASK bit*/ +} + + +void LST_remove_tail (tListNode * listHead, tListNode ** node ) +{ + uint32_t primask_bit; + + primask_bit = __get_PRIMASK(); /**< backup PRIMASK bit */ + __disable_irq(); /**< Disable all interrupts by setting PRIMASK bit on Cortex*/ + + *node = listHead->prev; + LST_remove_node (listHead->prev); + + __set_PRIMASK(primask_bit); /**< Restore PRIMASK bit*/ +} + + +void LST_insert_node_after (tListNode * node, tListNode * ref_node) +{ + uint32_t primask_bit; + + primask_bit = __get_PRIMASK(); /**< backup PRIMASK bit */ + __disable_irq(); /**< Disable all interrupts by setting PRIMASK bit on Cortex*/ + + node->next = ref_node->next; + node->prev = ref_node; + ref_node->next = node; + (node->next)->prev = node; + + __set_PRIMASK(primask_bit); /**< Restore PRIMASK bit*/ +} + + +void LST_insert_node_before (tListNode * node, tListNode * ref_node) +{ + uint32_t primask_bit; + + primask_bit = __get_PRIMASK(); /**< backup PRIMASK bit */ + __disable_irq(); /**< Disable all interrupts by setting PRIMASK bit on Cortex*/ + + node->next = ref_node; + node->prev = ref_node->prev; + ref_node->prev = node; + (node->prev)->next = node; + + __set_PRIMASK(primask_bit); /**< Restore PRIMASK bit*/ +} + + +int LST_get_size (tListNode * listHead) +{ + int size = 0; + tListNode * temp; + uint32_t primask_bit; + + primask_bit = __get_PRIMASK(); /**< backup PRIMASK bit */ + __disable_irq(); /**< Disable all interrupts by setting PRIMASK bit on Cortex*/ + + temp = listHead->next; + while (temp != listHead) + { + size++; + temp = temp->next; + } + + __set_PRIMASK(primask_bit); /**< Restore PRIMASK bit*/ + + return (size); +} + +void LST_get_next_node (tListNode * ref_node, tListNode ** node) +{ + uint32_t primask_bit; + + primask_bit = __get_PRIMASK(); /**< backup PRIMASK bit */ + __disable_irq(); /**< Disable all interrupts by setting PRIMASK bit on Cortex*/ + + *node = ref_node->next; + + __set_PRIMASK(primask_bit); /**< Restore PRIMASK bit*/ +} + + +void LST_get_prev_node (tListNode * ref_node, tListNode ** node) +{ + uint32_t primask_bit; + + primask_bit = __get_PRIMASK(); /**< backup PRIMASK bit */ + __disable_irq(); /**< Disable all interrupts by setting PRIMASK bit on Cortex*/ + + *node = ref_node->prev; + + __set_PRIMASK(primask_bit); /**< Restore PRIMASK bit*/ +} +#endif /* STM32WBxx */ diff --git a/src/utility/STM32Cube_FW/stm_list.h b/src/utility/STM32Cube_FW/stm_list.h new file mode 100644 index 00000000..b7c3254c --- /dev/null +++ b/src/utility/STM32Cube_FW/stm_list.h @@ -0,0 +1,55 @@ +/** + ****************************************************************************** + * @file stm_list.h + * @author MCD Application Team + * @brief Header file for linked list library. + ****************************************************************************** + * @attention + * + * Copyright (c) 2018-2021 STMicroelectronics. + * All rights reserved. + * + * This software is licensed under terms that can be found in the LICENSE file + * in the root directory of this software component. + * If no LICENSE file comes with this software, it is provided AS-IS. + * + ****************************************************************************** + */ + + +#ifndef _STM_LIST_H_ +#define _STM_LIST_H_ + +/* Includes ------------------------------------------------------------------*/ +#include "stm32_wpan_common.h" + +typedef PACKED_STRUCT _tListNode { + struct _tListNode * next; + struct _tListNode * prev; +} tListNode; + +void LST_init_head (tListNode * listHead); + +uint8_t LST_is_empty (tListNode * listHead); + +void LST_insert_head (tListNode * listHead, tListNode * node); + +void LST_insert_tail (tListNode * listHead, tListNode * node); + +void LST_remove_node (tListNode * node); + +void LST_remove_head (tListNode * listHead, tListNode ** node ); + +void LST_remove_tail (tListNode * listHead, tListNode ** node ); + +void LST_insert_node_after (tListNode * node, tListNode * ref_node); + +void LST_insert_node_before (tListNode * node, tListNode * ref_node); + +int LST_get_size (tListNode * listHead); + +void LST_get_next_node (tListNode * ref_node, tListNode ** node); + +void LST_get_prev_node (tListNode * ref_node, tListNode ** node); + +#endif /* _STM_LIST_H_ */ diff --git a/src/utility/STM32Cube_FW/tl.h b/src/utility/STM32Cube_FW/tl.h new file mode 100644 index 00000000..74520878 --- /dev/null +++ b/src/utility/STM32Cube_FW/tl.h @@ -0,0 +1,372 @@ +/** + ****************************************************************************** + * @file tl.h + * @author MCD Application Team + * @brief Header for tl module + ****************************************************************************** + * @attention + * + * Copyright (c) 2018-2021 STMicroelectronics. + * All rights reserved. + * + * This software is licensed under terms that can be found in the LICENSE file + * in the root directory of this software component. + * If no LICENSE file comes with this software, it is provided AS-IS. + * + ****************************************************************************** + */ + + +/* Define to prevent recursive inclusion -------------------------------------*/ +#ifndef __TL_H +#define __TL_H + +#ifdef __cplusplus +extern "C" { +#endif + + +/* Includes ------------------------------------------------------------------*/ +#include "stm32_wpan_common.h" + +/* Exported defines -----------------------------------------------------------*/ +#define TL_BLECMD_PKT_TYPE ( 0x01 ) +#define TL_ACL_DATA_PKT_TYPE ( 0x02 ) +#define TL_BLEEVT_PKT_TYPE ( 0x04 ) +#define TL_OTCMD_PKT_TYPE ( 0x08 ) +#define TL_OTRSP_PKT_TYPE ( 0x09 ) +#define TL_CLICMD_PKT_TYPE ( 0x0A ) +#define TL_OTNOT_PKT_TYPE ( 0x0C ) +#define TL_OTACK_PKT_TYPE ( 0x0D ) +#define TL_CLINOT_PKT_TYPE ( 0x0E ) +#define TL_CLIACK_PKT_TYPE ( 0x0F ) +#define TL_SYSCMD_PKT_TYPE ( 0x10 ) +#define TL_SYSRSP_PKT_TYPE ( 0x11 ) +#define TL_SYSEVT_PKT_TYPE ( 0x12 ) +#define TL_CLIRESP_PKT_TYPE ( 0x15 ) +#define TL_M0CMD_PKT_TYPE ( 0x16 ) +#define TL_LOCCMD_PKT_TYPE ( 0x20 ) +#define TL_LOCRSP_PKT_TYPE ( 0x21 ) +#define TL_TRACES_APP_PKT_TYPE ( 0x40 ) +#define TL_TRACES_WL_PKT_TYPE ( 0x41 ) + +#define TL_CMD_HDR_SIZE (4) +#define TL_EVT_HDR_SIZE (3) +#define TL_EVT_CS_PAYLOAD_SIZE (4) + +#define TL_BLEEVT_CC_OPCODE (0x0E) +#define TL_BLEEVT_CS_OPCODE (0x0F) +#define TL_BLEEVT_VS_OPCODE (0xFF) + +#define TL_BLEEVT_CC_PACKET_SIZE (TL_EVT_HDR_SIZE + sizeof(TL_CcEvt_t)) +#define TL_BLEEVT_CC_BUFFER_SIZE (sizeof(TL_PacketHeader_t) + TL_BLEEVT_CC_PACKET_SIZE) +/* Exported types ------------------------------------------------------------*/ +/**< Packet header */ +typedef PACKED_STRUCT +{ + uint32_t *next; + uint32_t *prev; +} TL_PacketHeader_t; + +/******************************************************************************* + * Event type + */ + +/** + * This the payload of TL_Evt_t for a command status event + */ +typedef PACKED_STRUCT +{ + uint8_t status; + uint8_t numcmd; + uint16_t cmdcode; +} TL_CsEvt_t; + +/** + * This the payload of TL_Evt_t for a command complete event, only used a pointer + */ +typedef PACKED_STRUCT +{ + uint8_t numcmd; + uint16_t cmdcode; + uint8_t payload[2]; +} TL_CcEvt_t; + +/** + * This the payload of TL_Evt_t for an asynchronous event, only used a pointer + */ +typedef PACKED_STRUCT +{ + uint16_t subevtcode; + uint8_t payload[2]; +} TL_AsynchEvt_t; + +/** + * This the payload of TL_Evt_t, only used a pointer + */ +typedef PACKED_STRUCT +{ + uint8_t evtcode; + uint8_t plen; + uint8_t payload[4]; +} TL_Evt_t; + +typedef PACKED_STRUCT +{ + uint8_t type; + TL_Evt_t evt; +} TL_EvtSerial_t; + +/** + * This format shall be used for all events (asynchronous and command response) reported + * by the CPU2 except for the command response of a system command where the header is not there + * and the format to be used shall be TL_EvtSerial_t. + * Note: Be careful that the asynchronous events reported by the CPU2 on the system channel do + * include the header and shall use TL_EvtPacket_t format. Only the command response format on the + * system channel is different. + */ +typedef PACKED_STRUCT +{ + TL_PacketHeader_t header; + TL_EvtSerial_t evtserial; +} TL_EvtPacket_t; + +/***************************************************************************************** + * Command type + */ + +typedef PACKED_STRUCT +{ + uint16_t cmdcode; + uint8_t plen; + uint8_t payload[255]; +} TL_Cmd_t; + +typedef PACKED_STRUCT +{ + uint8_t type; + TL_Cmd_t cmd; +} TL_CmdSerial_t; + +typedef PACKED_STRUCT +{ + TL_PacketHeader_t header; + TL_CmdSerial_t cmdserial; +} TL_CmdPacket_t; + +/***************************************************************************************** + * HCI ACL DATA type + */ +typedef PACKED_STRUCT +{ + uint8_t type; + uint16_t handle; + uint16_t length; + uint8_t acl_data[1]; +} TL_AclDataSerial_t; + +typedef PACKED_STRUCT +{ + TL_PacketHeader_t header; + TL_AclDataSerial_t AclDataSerial; +} TL_AclDataPacket_t; + +typedef struct +{ + uint8_t *p_BleSpareEvtBuffer; + uint8_t *p_SystemSpareEvtBuffer; + uint8_t *p_AsynchEvtPool; + uint32_t AsynchEvtPoolSize; + uint8_t *p_TracesEvtPool; + uint32_t TracesEvtPoolSize; +} TL_MM_Config_t; + +typedef struct +{ + uint8_t *p_ThreadOtCmdRspBuffer; + uint8_t *p_ThreadCliRspBuffer; + uint8_t *p_ThreadNotAckBuffer; + uint8_t *p_ThreadCliNotBuffer; +} TL_TH_Config_t; + +typedef struct +{ + uint8_t *p_LldTestsCliCmdRspBuffer; + uint8_t *p_LldTestsM0CmdBuffer; +} TL_LLD_tests_Config_t; + +typedef struct +{ + uint8_t *p_BleLldCmdRspBuffer; + uint8_t *p_BleLldM0CmdBuffer; +} TL_BLE_LLD_Config_t; + +typedef struct +{ + uint8_t *p_Mac_802_15_4_CmdRspBuffer; + uint8_t *p_Mac_802_15_4_NotAckBuffer; +} TL_MAC_802_15_4_Config_t; + +typedef struct +{ + uint8_t *p_ZigbeeOtCmdRspBuffer; + uint8_t *p_ZigbeeNotAckBuffer; + uint8_t *p_ZigbeeNotifRequestBuffer; +} TL_ZIGBEE_Config_t; + +/** + * @brief Contain the BLE HCI Init Configuration + * @{ + */ +typedef struct +{ + void (* IoBusEvtCallBack) ( TL_EvtPacket_t *phcievt ); + void (* IoBusAclDataTxAck) ( void ); + uint8_t *p_cmdbuffer; + uint8_t *p_AclDataBuffer; +} TL_BLE_InitConf_t; + +/** + * @brief Contain the SYSTEM HCI Init Configuration + * @{ + */ +typedef struct +{ + void (* IoBusCallBackCmdEvt) (TL_EvtPacket_t *phcievt); + void (* IoBusCallBackUserEvt) (TL_EvtPacket_t *phcievt); + uint8_t *p_cmdbuffer; +} TL_SYS_InitConf_t; + +/***************************************************************************************** + * Event type copied from ble_legacy.h + */ + +typedef PACKED_STRUCT +{ + uint8_t type; + uint8_t data[1]; +} hci_uart_pckt; + +typedef PACKED_STRUCT +{ + uint8_t evt; + uint8_t plen; + uint8_t data[1]; +} hci_event_pckt; + +typedef PACKED_STRUCT +{ + uint8_t subevent; + uint8_t data[1]; +} evt_le_meta_event; + +/** + * Vendor specific event for BLE core. + */ +typedef PACKED_STRUCT +{ + uint16_t ecode; /**< One of the BLE core event codes. */ + uint8_t data[1]; +} evt_blecore_aci; + +/* Bluetooth 48 bit address (in little-endian order). + */ +typedef uint8_t tBDAddr[6]; + + +/* Exported constants --------------------------------------------------------*/ +/* External variables --------------------------------------------------------*/ +/* Exported macros -----------------------------------------------------------*/ +/* Exported functions ------------------------------------------------------- */ + +/****************************************************************************** + * GENERAL + ******************************************************************************/ +void TL_Enable( void ); +void TL_Init( void ); + +/****************************************************************************** + * BLE + ******************************************************************************/ +int32_t TL_BLE_Init( void* pConf ); +int32_t TL_BLE_SendCmd( uint8_t* buffer, uint16_t size ); +int32_t TL_BLE_SendAclData( uint8_t* buffer, uint16_t size ); + +/****************************************************************************** + * SYSTEM + ******************************************************************************/ +int32_t TL_SYS_Init( void* pConf ); +int32_t TL_SYS_SendCmd( uint8_t* buffer, uint16_t size ); + +/****************************************************************************** + * THREAD + ******************************************************************************/ +void TL_THREAD_Init( TL_TH_Config_t *p_Config ); +void TL_OT_SendCmd( void ); +void TL_CLI_SendCmd( void ); +void TL_OT_CmdEvtReceived( TL_EvtPacket_t * Otbuffer ); +void TL_THREAD_NotReceived( TL_EvtPacket_t * Notbuffer ); +void TL_THREAD_SendAck ( void ); +void TL_THREAD_CliSendAck ( void ); +void TL_THREAD_CliNotReceived( TL_EvtPacket_t * Notbuffer ); + +/****************************************************************************** + * LLD TESTS + ******************************************************************************/ +void TL_LLDTESTS_Init( TL_LLD_tests_Config_t *p_Config ); +void TL_LLDTESTS_SendCliCmd( void ); +void TL_LLDTESTS_ReceiveCliRsp( TL_CmdPacket_t * Notbuffer ); +void TL_LLDTESTS_SendCliRspAck( void ); +void TL_LLDTESTS_ReceiveM0Cmd( TL_CmdPacket_t * Notbuffer ); +void TL_LLDTESTS_SendM0CmdAck( void ); + +/****************************************************************************** + * BLE LLD + ******************************************************************************/ +void TL_BLE_LLD_Init( TL_BLE_LLD_Config_t *p_Config ); +void TL_BLE_LLD_SendCliCmd( void ); +void TL_BLE_LLD_ReceiveCliRsp( TL_CmdPacket_t * Notbuffer ); +void TL_BLE_LLD_SendCliRspAck( void ); +void TL_BLE_LLD_ReceiveM0Cmd( TL_CmdPacket_t * Notbuffer ); +void TL_BLE_LLD_SendM0CmdAck( void ); +void TL_BLE_LLD_SendCmd( void ); +void TL_BLE_LLD_ReceiveRsp( TL_CmdPacket_t * Notbuffer ); +void TL_BLE_LLD_SendRspAck( void ); +/****************************************************************************** + * MEMORY MANAGER + ******************************************************************************/ +void TL_MM_Init( TL_MM_Config_t *p_Config ); +void TL_MM_EvtDone( TL_EvtPacket_t * hcievt ); + +/****************************************************************************** + * TRACES + ******************************************************************************/ +void TL_TRACES_Init( void ); +void TL_TRACES_EvtReceived( TL_EvtPacket_t * hcievt ); + +/****************************************************************************** + * MAC 802.15.4 + ******************************************************************************/ +void TL_MAC_802_15_4_Init( TL_MAC_802_15_4_Config_t *p_Config ); +void TL_MAC_802_15_4_SendCmd( void ); +void TL_MAC_802_15_4_CmdEvtReceived( TL_EvtPacket_t * Otbuffer ); +void TL_MAC_802_15_4_NotReceived( TL_EvtPacket_t * Notbuffer ); +void TL_MAC_802_15_4_SendAck ( void ); + +/****************************************************************************** + * ZIGBEE + ******************************************************************************/ +void TL_ZIGBEE_Init( TL_ZIGBEE_Config_t *p_Config ); +void TL_ZIGBEE_SendM4RequestToM0( void ); +void TL_ZIGBEE_SendM4AckToM0Notify ( void ); +void TL_ZIGBEE_NotReceived( TL_EvtPacket_t * Notbuffer ); +void TL_ZIGBEE_CmdEvtReceived( TL_EvtPacket_t * Otbuffer ); +void TL_ZIGBEE_M0RequestReceived(TL_EvtPacket_t * Otbuffer ); +void TL_ZIGBEE_SendM4AckToM0Request(void); + +#ifdef __cplusplus +} /* extern "C" */ +#endif + +#endif /*__TL_H */ + diff --git a/src/utility/STM32Cube_FW/tl_dbg_conf.h b/src/utility/STM32Cube_FW/tl_dbg_conf.h new file mode 100644 index 00000000..841d1968 --- /dev/null +++ b/src/utility/STM32Cube_FW/tl_dbg_conf.h @@ -0,0 +1,140 @@ +/* USER CODE BEGIN Header */ +/** + ****************************************************************************** + * File Name : tl_dbg_conf.h + * Description : Debug configuration file for stm32wpan transport layer interface. + * + ****************************************************************************** + * @attention + * + * Copyright (c) 2019-2021 STMicroelectronics. + * All rights reserved. + * + * This software is licensed under terms that can be found in the LICENSE file + * in the root directory of this software component. + * If no LICENSE file comes with this software, it is provided AS-IS. + * + ****************************************************************************** + */ +/* USER CODE END Header */ + +/* Define to prevent recursive inclusion -------------------------------------*/ +#ifndef TL_DBG_CONF_H +#define TL_DBG_CONF_H + +#ifdef __cplusplus +extern "C" { +#endif + +/* USER CODE BEGIN Tl_Conf */ + +/* Includes ------------------------------------------------------------------*/ +#include "core_debug.h" + +/** + * Enable or Disable traces + * The raw data output is the hci binary packet format as specified by the BT specification * + */ +#ifndef TL_SHCI_CMD_DBG_EN +#define TL_SHCI_CMD_DBG_EN 1 /* Reports System commands sent to CPU2 and the command response */ +#endif + +#ifndef TL_SHCI_EVT_DBG_EN +#define TL_SHCI_EVT_DBG_EN 1 /* Reports System Asynchronous Events received from CPU2 */ +#endif + +#ifndef TL_HCI_CMD_DBG_EN +#define TL_HCI_CMD_DBG_EN 1 /* Reports BLE command sent to CPU2 and the command response */ +#endif + +#ifndef TL_HCI_EVT_DBG_EN +#define TL_HCI_EVT_DBG_EN 1 /* Reports BLE Asynchronous Events received from CPU2 */ +#endif + +#ifndef TL_MM_DBG_EN +#define TL_MM_DBG_EN 1 /* Reports the information of the buffer released to CPU2 */ +#endif + +/** + * Macro definition + */ + +/** + * System Transport Layer + */ +#if (TL_SHCI_CMD_DBG_EN != 0) +#define TL_SHCI_CMD_DBG_MSG core_debug +#define TL_SHCI_CMD_DBG_BUF PRINT_LOG_BUFF_DBG +#else +#define TL_SHCI_CMD_DBG_MSG(...) +#define TL_SHCI_CMD_DBG_BUF(...) +#endif + +#define TL_SHCI_CMD_DBG_RAW(...) + +#if (TL_SHCI_EVT_DBG_EN != 0) +#define TL_SHCI_EVT_DBG_MSG core_debug +#define TL_SHCI_EVT_DBG_BUF PRINT_LOG_BUFF_DBG +#else +#define TL_SHCI_EVT_DBG_MSG(...) +#define TL_SHCI_EVT_DBG_BUF(...) +#endif + +#define TL_SHCI_EVT_DBG_RAW(...) + +/** + * BLE Transport Layer + */ +#if (TL_HCI_CMD_DBG_EN != 0) +#define TL_HCI_CMD_DBG_MSG core_debug +#define TL_HCI_CMD_DBG_BUF PRINT_LOG_BUFF_DBG +#else +#define TL_HCI_CMD_DBG_MSG(...) +#define TL_HCI_CMD_DBG_BUF(...) +#endif + +#define TL_HCI_CMD_DBG_RAW(...) + +#if (TL_HCI_EVT_DBG_EN != 0) +#define TL_HCI_EVT_DBG_MSG core_debug +#define TL_HCI_EVT_DBG_BUF PRINT_LOG_BUFF_DBG +#else +#define TL_HCI_EVT_DBG_MSG(...) +#define TL_HCI_EVT_DBG_BUF(...) +#endif + +#define TL_HCI_EVT_DBG_RAW(...) + +/** + * Memory Manager - Released buffer tracing + */ +#if (TL_MM_DBG_EN != 0) +#define TL_MM_DBG_MSG core_debug +#else +#define TL_MM_DBG_MSG(...) +#endif + + +#define PRINT_LOG_BUFF_DBG(...) DbgTraceBuffer(__VA_ARGS__) + +void DbgTraceBuffer(const void *pBuffer, uint32_t u32Length, const char *strFormat, ...) +{ + va_list vaArgs; + uint32_t u32Index; + va_start(vaArgs, strFormat); + vprintf(strFormat, vaArgs); + va_end(vaArgs); + for (u32Index = 0; u32Index < u32Length; u32Index ++) + { + core_debug(" %02X", ((const uint8_t *) pBuffer)[u32Index]); + } +} + +/* USER CODE END Tl_Conf */ + +#ifdef __cplusplus +} +#endif + +#endif /* TL_DBG_CONF_H */ + diff --git a/src/utility/STM32Cube_FW/tl_mbox.c b/src/utility/STM32Cube_FW/tl_mbox.c new file mode 100644 index 00000000..11393162 --- /dev/null +++ b/src/utility/STM32Cube_FW/tl_mbox.c @@ -0,0 +1,853 @@ +/** + ****************************************************************************** + * @file tl_mbox.c + * @author MCD Application Team + * @brief Transport layer for the mailbox interface + ****************************************************************************** + * @attention + * + * Copyright (c) 2018-2021 STMicroelectronics. + * All rights reserved. + * + * This software is licensed under terms that can be found in the LICENSE file + * in the root directory of this software component. + * If no LICENSE file comes with this software, it is provided AS-IS. + * + ****************************************************************************** + */ + +#if defined(STM32WBxx) +/* Includes ------------------------------------------------------------------*/ +#include "stm32_wpan_common.h" +#include "hw.h" + +#include "stm_list.h" +#include "tl.h" +#include "mbox_def.h" +#include "tl_dbg_conf.h" + +/* Private typedef -----------------------------------------------------------*/ +typedef enum +{ + TL_MB_MM_RELEASE_BUFFER, + TL_MB_BLE_CMD, + TL_MB_BLE_CMD_RSP, + TL_MB_BLE_ASYNCH_EVT, + TL_MB_SYS_CMD, + TL_MB_SYS_CMD_RSP, + TL_MB_SYS_ASYNCH_EVT, +} TL_MB_PacketType_t; + +/* Private defines -----------------------------------------------------------*/ +/* Private macros ------------------------------------------------------------*/ +/* Private variables ---------------------------------------------------------*/ + +/**< reference table */ +PLACE_IN_SECTION("MAPPING_TABLE") static volatile MB_RefTable_t TL_RefTable; +PLACE_IN_SECTION("MB_MEM1") ALIGN(4) static MB_DeviceInfoTable_t TL_DeviceInfoTable; +PLACE_IN_SECTION("MB_MEM1") ALIGN(4) static MB_BleTable_t TL_BleTable; +PLACE_IN_SECTION("MB_MEM1") ALIGN(4) static MB_ThreadTable_t TL_ThreadTable; +PLACE_IN_SECTION("MB_MEM1") ALIGN(4) static MB_LldTestsTable_t TL_LldTestsTable; +PLACE_IN_SECTION("MB_MEM1") ALIGN(4) static MB_BleLldTable_t TL_BleLldTable; +PLACE_IN_SECTION("MB_MEM1") ALIGN(4) static MB_SysTable_t TL_SysTable; +PLACE_IN_SECTION("MB_MEM1") ALIGN(4) static MB_MemManagerTable_t TL_MemManagerTable; +PLACE_IN_SECTION("MB_MEM1") ALIGN(4) static MB_TracesTable_t TL_TracesTable; +#if 0 +PLACE_IN_SECTION("MB_MEM1") ALIGN(4) static MB_Mac_802_15_4_t TL_Mac_802_15_4_Table; +PLACE_IN_SECTION("MB_MEM1") ALIGN(4) static MB_ZigbeeTable_t TL_Zigbee_Table; +#endif +/**< tables */ +PLACE_IN_SECTION("MB_MEM1") ALIGN(4) static tListNode FreeBufQueue; +PLACE_IN_SECTION("MB_MEM1") ALIGN(4) static tListNode TracesEvtQueue; +PLACE_IN_SECTION("MB_MEM2") ALIGN(4) static uint8_t CsBuffer[sizeof(TL_PacketHeader_t) + TL_EVT_HDR_SIZE + sizeof(TL_CsEvt_t)]; +PLACE_IN_SECTION("MB_MEM1") ALIGN(4) static tListNode EvtQueue; +PLACE_IN_SECTION("MB_MEM1") ALIGN(4) static tListNode SystemEvtQueue; + + +static tListNode LocalFreeBufQueue; +static void (* BLE_IoBusEvtCallBackFunction) (TL_EvtPacket_t *phcievt); +static void (* BLE_IoBusAclDataTxAck) ( void ); +static void (* SYS_CMD_IoBusCallBackFunction) (TL_EvtPacket_t *phcievt); +static void (* SYS_EVT_IoBusCallBackFunction) (TL_EvtPacket_t *phcievt); + + +/* Global variables ----------------------------------------------------------*/ +/* Private function prototypes -----------------------------------------------*/ +static void SendFreeBuf( void ); +static void OutputDbgTrace(TL_MB_PacketType_t packet_type, uint8_t* buffer); + +/* Public Functions Definition ------------------------------------------------------*/ + +/****************************************************************************** + * GENERAL - refer to AN5289 for functions description. + ******************************************************************************/ +void TL_Enable( void ) +{ + HW_IPCC_Enable(); + + return; +} + + +void TL_Init( void ) +{ + TL_RefTable.p_device_info_table = &TL_DeviceInfoTable; + TL_RefTable.p_ble_table = &TL_BleTable; + TL_RefTable.p_thread_table = &TL_ThreadTable; + TL_RefTable.p_lld_tests_table = &TL_LldTestsTable; + TL_RefTable.p_ble_lld_table = &TL_BleLldTable; + TL_RefTable.p_sys_table = &TL_SysTable; + TL_RefTable.p_mem_manager_table = &TL_MemManagerTable; + TL_RefTable.p_traces_table = &TL_TracesTable; +#if 0 + TL_RefTable.p_mac_802_15_4_table = &TL_Mac_802_15_4_Table; + TL_RefTable.p_zigbee_table = &TL_Zigbee_Table; +#endif + HW_IPCC_Init(); + + return; +} + +/****************************************************************************** + * BLE + ******************************************************************************/ +int32_t TL_BLE_Init( void* pConf ) +{ + MB_BleTable_t * p_bletable; + + TL_BLE_InitConf_t *pInitHciConf = (TL_BLE_InitConf_t *) pConf; + + LST_init_head (&EvtQueue); + + p_bletable = TL_RefTable.p_ble_table; + + p_bletable->pcmd_buffer = pInitHciConf->p_cmdbuffer; + p_bletable->phci_acl_data_buffer = pInitHciConf->p_AclDataBuffer; + p_bletable->pcs_buffer = (uint8_t*)CsBuffer; + p_bletable->pevt_queue = (uint8_t*)&EvtQueue; + + HW_IPCC_BLE_Init(); + + BLE_IoBusEvtCallBackFunction = pInitHciConf->IoBusEvtCallBack; + BLE_IoBusAclDataTxAck = pInitHciConf->IoBusAclDataTxAck; + + return 0; +} + +int32_t TL_BLE_SendCmd( uint8_t* buffer, uint16_t size ) +{ + (void)(buffer); + (void)(size); + + ((TL_CmdPacket_t*)(TL_RefTable.p_ble_table->pcmd_buffer))->cmdserial.type = TL_BLECMD_PKT_TYPE; + + OutputDbgTrace(TL_MB_BLE_CMD, TL_RefTable.p_ble_table->pcmd_buffer); + + HW_IPCC_BLE_SendCmd(); + + return 0; +} + +void HW_IPCC_BLE_RxEvtNot(void) +{ + TL_EvtPacket_t *phcievt; + + while(LST_is_empty(&EvtQueue) == FALSE) + { + LST_remove_head (&EvtQueue, (tListNode **)&phcievt); + + if ( ((phcievt->evtserial.evt.evtcode) == TL_BLEEVT_CS_OPCODE) || ((phcievt->evtserial.evt.evtcode) == TL_BLEEVT_CC_OPCODE ) ) + { + OutputDbgTrace(TL_MB_BLE_CMD_RSP, (uint8_t*)phcievt); + } + else + { + OutputDbgTrace(TL_MB_BLE_ASYNCH_EVT, (uint8_t*)phcievt); + } + + BLE_IoBusEvtCallBackFunction(phcievt); + } + + return; +} + +int32_t TL_BLE_SendAclData( uint8_t* buffer, uint16_t size ) +{ + (void)(buffer); + (void)(size); + + ((TL_AclDataPacket_t *)(TL_RefTable.p_ble_table->phci_acl_data_buffer))->AclDataSerial.type = TL_ACL_DATA_PKT_TYPE; + + HW_IPCC_BLE_SendAclData(); + + return 0; +} + +void HW_IPCC_BLE_AclDataAckNot(void) +{ + BLE_IoBusAclDataTxAck( ); + + return; +} + +/****************************************************************************** + * SYSTEM + ******************************************************************************/ +int32_t TL_SYS_Init( void* pConf ) +{ + MB_SysTable_t * p_systable; + + TL_SYS_InitConf_t *pInitHciConf = (TL_SYS_InitConf_t *) pConf; + + LST_init_head (&SystemEvtQueue); + p_systable = TL_RefTable.p_sys_table; + p_systable->pcmd_buffer = pInitHciConf->p_cmdbuffer; + p_systable->sys_queue = (uint8_t*)&SystemEvtQueue; + + HW_IPCC_SYS_Init(); + + SYS_CMD_IoBusCallBackFunction = pInitHciConf->IoBusCallBackCmdEvt; + SYS_EVT_IoBusCallBackFunction = pInitHciConf->IoBusCallBackUserEvt; + + return 0; +} + +int32_t TL_SYS_SendCmd( uint8_t* buffer, uint16_t size ) +{ + (void)(buffer); + (void)(size); + + ((TL_CmdPacket_t *)(TL_RefTable.p_sys_table->pcmd_buffer))->cmdserial.type = TL_SYSCMD_PKT_TYPE; + + OutputDbgTrace(TL_MB_SYS_CMD, TL_RefTable.p_sys_table->pcmd_buffer); + + HW_IPCC_SYS_SendCmd(); + + return 0; +} + +void HW_IPCC_SYS_CmdEvtNot(void) +{ + OutputDbgTrace(TL_MB_SYS_CMD_RSP, (uint8_t*)(TL_RefTable.p_sys_table->pcmd_buffer) ); + + SYS_CMD_IoBusCallBackFunction( (TL_EvtPacket_t*)(TL_RefTable.p_sys_table->pcmd_buffer) ); + + return; +} + +void HW_IPCC_SYS_EvtNot( void ) +{ + TL_EvtPacket_t *p_evt; + + while(LST_is_empty(&SystemEvtQueue) == FALSE) + { + LST_remove_head (&SystemEvtQueue, (tListNode **)&p_evt); + + OutputDbgTrace(TL_MB_SYS_ASYNCH_EVT, (uint8_t*)p_evt ); + + SYS_EVT_IoBusCallBackFunction( p_evt ); + } + + return; +} + +/****************************************************************************** + * THREAD + ******************************************************************************/ +#ifdef THREAD_WB +void TL_THREAD_Init( TL_TH_Config_t *p_Config ) +{ + MB_ThreadTable_t * p_thread_table; + + p_thread_table = TL_RefTable.p_thread_table; + + p_thread_table->clicmdrsp_buffer = p_Config->p_ThreadCliRspBuffer; + p_thread_table->otcmdrsp_buffer = p_Config->p_ThreadOtCmdRspBuffer; + p_thread_table->notack_buffer = p_Config->p_ThreadNotAckBuffer; + p_thread_table->clinot_buffer = p_Config->p_ThreadCliNotBuffer; + + HW_IPCC_THREAD_Init(); + + return; +} + +void TL_OT_SendCmd( void ) +{ + ((TL_CmdPacket_t *)(TL_RefTable.p_thread_table->otcmdrsp_buffer))->cmdserial.type = TL_OTCMD_PKT_TYPE; + + HW_IPCC_OT_SendCmd(); + + return; +} + +void TL_CLI_SendCmd( void ) +{ + ((TL_CmdPacket_t *)(TL_RefTable.p_thread_table->clicmdrsp_buffer))->cmdserial.type = TL_CLICMD_PKT_TYPE; + + HW_IPCC_CLI_SendCmd(); + + return; +} + +void TL_THREAD_SendAck ( void ) +{ + ((TL_CmdPacket_t *)(TL_RefTable.p_thread_table->notack_buffer))->cmdserial.type = TL_OTACK_PKT_TYPE; + + HW_IPCC_THREAD_SendAck(); + + return; +} + +void TL_THREAD_CliSendAck ( void ) +{ + ((TL_CmdPacket_t *)(TL_RefTable.p_thread_table->notack_buffer))->cmdserial.type = TL_OTACK_PKT_TYPE; + + HW_IPCC_THREAD_CliSendAck(); + + return; +} + +void HW_IPCC_OT_CmdEvtNot(void) +{ + TL_OT_CmdEvtReceived( (TL_EvtPacket_t*)(TL_RefTable.p_thread_table->otcmdrsp_buffer) ); + + return; +} + +void HW_IPCC_THREAD_EvtNot( void ) +{ + TL_THREAD_NotReceived( (TL_EvtPacket_t*)(TL_RefTable.p_thread_table->notack_buffer) ); + + return; +} + +void HW_IPCC_THREAD_CliEvtNot( void ) +{ + TL_THREAD_CliNotReceived( (TL_EvtPacket_t*)(TL_RefTable.p_thread_table->clinot_buffer) ); + + return; +} + +__WEAK void TL_OT_CmdEvtReceived( TL_EvtPacket_t * Otbuffer ){}; +__WEAK void TL_THREAD_NotReceived( TL_EvtPacket_t * Notbuffer ){}; +__WEAK void TL_THREAD_CliNotReceived( TL_EvtPacket_t * Notbuffer ){}; + +#endif /* THREAD_WB */ + +/****************************************************************************** + * LLD TESTS + ******************************************************************************/ +#ifdef LLD_TESTS_WB +void TL_LLDTESTS_Init( TL_LLD_tests_Config_t *p_Config ) +{ + MB_LldTestsTable_t * p_lld_tests_table; + + p_lld_tests_table = TL_RefTable.p_lld_tests_table; + p_lld_tests_table->clicmdrsp_buffer = p_Config->p_LldTestsCliCmdRspBuffer; + p_lld_tests_table->m0cmd_buffer = p_Config->p_LldTestsM0CmdBuffer; + HW_IPCC_LLDTESTS_Init(); + return; +} + +void TL_LLDTESTS_SendCliCmd( void ) +{ + ((TL_CmdPacket_t *)(TL_RefTable.p_lld_tests_table->clicmdrsp_buffer))->cmdserial.type = TL_CLICMD_PKT_TYPE; + HW_IPCC_LLDTESTS_SendCliCmd(); + return; +} + +void HW_IPCC_LLDTESTS_ReceiveCliRsp( void ) +{ + TL_LLDTESTS_ReceiveCliRsp( (TL_CmdPacket_t*)(TL_RefTable.p_lld_tests_table->clicmdrsp_buffer) ); + return; +} + +void TL_LLDTESTS_SendCliRspAck( void ) +{ + HW_IPCC_LLDTESTS_SendCliRspAck(); + return; +} + +void HW_IPCC_LLDTESTS_ReceiveM0Cmd( void ) +{ + TL_LLDTESTS_ReceiveM0Cmd( (TL_CmdPacket_t*)(TL_RefTable.p_lld_tests_table->m0cmd_buffer) ); + return; +} + + +void TL_LLDTESTS_SendM0CmdAck( void ) +{ + HW_IPCC_LLDTESTS_SendM0CmdAck(); + return; +} + +__WEAK void TL_LLDTESTS_ReceiveCliRsp( TL_CmdPacket_t * Notbuffer ){}; +__WEAK void TL_LLDTESTS_ReceiveM0Cmd( TL_CmdPacket_t * Notbuffer ){}; +#endif /* LLD_TESTS_WB */ + +/****************************************************************************** + * BLE LLD + ******************************************************************************/ +#ifdef BLE_LLD_WB +void TL_BLE_LLD_Init( TL_BLE_LLD_Config_t *p_Config ) +{ + MB_BleLldTable_t * p_ble_lld_table; + + p_ble_lld_table = TL_RefTable.p_ble_lld_table; + p_ble_lld_table->cmdrsp_buffer = p_Config->p_BleLldCmdRspBuffer; + p_ble_lld_table->m0cmd_buffer = p_Config->p_BleLldM0CmdBuffer; + HW_IPCC_BLE_LLD_Init(); + return; +} + +void TL_BLE_LLD_SendCliCmd( void ) +{ + ((TL_CmdPacket_t *)(TL_RefTable.p_ble_lld_table->cmdrsp_buffer))->cmdserial.type = TL_CLICMD_PKT_TYPE; + HW_IPCC_BLE_LLD_SendCliCmd(); + return; +} + +void HW_IPCC_BLE_LLD_ReceiveCliRsp( void ) +{ + TL_BLE_LLD_ReceiveCliRsp( (TL_CmdPacket_t*)(TL_RefTable.p_ble_lld_table->cmdrsp_buffer) ); + return; +} + +void TL_BLE_LLD_SendCliRspAck( void ) +{ + HW_IPCC_BLE_LLD_SendCliRspAck(); + return; +} + +void HW_IPCC_BLE_LLD_ReceiveM0Cmd( void ) +{ + TL_BLE_LLD_ReceiveM0Cmd( (TL_CmdPacket_t*)(TL_RefTable.p_ble_lld_table->m0cmd_buffer) ); + return; +} + + +void TL_BLE_LLD_SendM0CmdAck( void ) +{ + HW_IPCC_BLE_LLD_SendM0CmdAck(); + return; +} + +__WEAK void TL_BLE_LLD_ReceiveCliRsp( TL_CmdPacket_t * Notbuffer ){}; +__WEAK void TL_BLE_LLD_ReceiveM0Cmd( TL_CmdPacket_t * Notbuffer ){}; + +/* Transparent Mode */ +void TL_BLE_LLD_SendCmd( void ) +{ + ((TL_CmdPacket_t *)(TL_RefTable.p_ble_lld_table->cmdrsp_buffer))->cmdserial.type = TL_CLICMD_PKT_TYPE; + HW_IPCC_BLE_LLD_SendCmd(); + return; +} + +void HW_IPCC_BLE_LLD_ReceiveRsp( void ) +{ + TL_BLE_LLD_ReceiveRsp( (TL_CmdPacket_t*)(TL_RefTable.p_ble_lld_table->cmdrsp_buffer) ); + return; +} + +void TL_BLE_LLD_SendRspAck( void ) +{ + HW_IPCC_BLE_LLD_SendRspAck(); + return; +} +#endif /* BLE_LLD_WB */ + +#ifdef MAC_802_15_4_WB +/****************************************************************************** + * MAC 802.15.4 + ******************************************************************************/ +void TL_MAC_802_15_4_Init( TL_MAC_802_15_4_Config_t *p_Config ) +{ + MB_Mac_802_15_4_t * p_mac_802_15_4_table; + + p_mac_802_15_4_table = TL_RefTable.p_mac_802_15_4_table; + + p_mac_802_15_4_table->p_cmdrsp_buffer = p_Config->p_Mac_802_15_4_CmdRspBuffer; + p_mac_802_15_4_table->p_notack_buffer = p_Config->p_Mac_802_15_4_NotAckBuffer; + + HW_IPCC_MAC_802_15_4_Init(); + + return; +} + +void TL_MAC_802_15_4_SendCmd( void ) +{ + ((TL_CmdPacket_t *)(TL_RefTable.p_mac_802_15_4_table->p_cmdrsp_buffer))->cmdserial.type = TL_OTCMD_PKT_TYPE; + + HW_IPCC_MAC_802_15_4_SendCmd(); + + return; +} + +void TL_MAC_802_15_4_SendAck ( void ) +{ + ((TL_CmdPacket_t *)(TL_RefTable.p_mac_802_15_4_table->p_notack_buffer))->cmdserial.type = TL_OTACK_PKT_TYPE; + + HW_IPCC_MAC_802_15_4_SendAck(); + + return; +} + +void HW_IPCC_MAC_802_15_4_CmdEvtNot(void) +{ + TL_MAC_802_15_4_CmdEvtReceived( (TL_EvtPacket_t*)(TL_RefTable.p_mac_802_15_4_table->p_cmdrsp_buffer) ); + + return; +} + +void HW_IPCC_MAC_802_15_4_EvtNot( void ) +{ + TL_MAC_802_15_4_NotReceived( (TL_EvtPacket_t*)(TL_RefTable.p_mac_802_15_4_table->p_notack_buffer) ); + + return; +} + +__WEAK void TL_MAC_802_15_4_CmdEvtReceived( TL_EvtPacket_t * Otbuffer ){}; +__WEAK void TL_MAC_802_15_4_NotReceived( TL_EvtPacket_t * Notbuffer ){}; +#endif + +#ifdef ZIGBEE_WB +/****************************************************************************** + * ZIGBEE + ******************************************************************************/ +void TL_ZIGBEE_Init( TL_ZIGBEE_Config_t *p_Config ) +{ + MB_ZigbeeTable_t * p_zigbee_table; + + p_zigbee_table = TL_RefTable.p_zigbee_table; + p_zigbee_table->appliCmdM4toM0_buffer = p_Config->p_ZigbeeOtCmdRspBuffer; + p_zigbee_table->notifM0toM4_buffer = p_Config->p_ZigbeeNotAckBuffer; + p_zigbee_table->requestM0toM4_buffer = p_Config->p_ZigbeeNotifRequestBuffer; + + HW_IPCC_ZIGBEE_Init(); + + return; +} + +/* Zigbee M4 to M0 Request */ +void TL_ZIGBEE_SendM4RequestToM0( void ) +{ + ((TL_CmdPacket_t *)(TL_RefTable.p_zigbee_table->appliCmdM4toM0_buffer))->cmdserial.type = TL_OTCMD_PKT_TYPE; + + HW_IPCC_ZIGBEE_SendM4RequestToM0(); + + return; +} + +/* Used to receive an ACK from the M0 */ +void HW_IPCC_ZIGBEE_RecvAppliAckFromM0(void) +{ + TL_ZIGBEE_CmdEvtReceived( (TL_EvtPacket_t*)(TL_RefTable.p_zigbee_table->appliCmdM4toM0_buffer) ); + + return; +} + +/* Zigbee notification from M0 to M4 */ +void HW_IPCC_ZIGBEE_RecvM0NotifyToM4( void ) +{ + TL_ZIGBEE_NotReceived( (TL_EvtPacket_t*)(TL_RefTable.p_zigbee_table->notifM0toM4_buffer) ); + + return; +} + +/* Send an ACK to the M0 for a Notification */ +void TL_ZIGBEE_SendM4AckToM0Notify ( void ) +{ + ((TL_CmdPacket_t *)(TL_RefTable.p_zigbee_table->notifM0toM4_buffer))->cmdserial.type = TL_OTACK_PKT_TYPE; + + HW_IPCC_ZIGBEE_SendM4AckToM0Notify(); + + return; +} + +/* Zigbee M0 to M4 Request */ +void HW_IPCC_ZIGBEE_RecvM0RequestToM4( void ) +{ + TL_ZIGBEE_M0RequestReceived( (TL_EvtPacket_t*)(TL_RefTable.p_zigbee_table->requestM0toM4_buffer) ); + + return; +} + +/* Send an ACK to the M0 for a Request */ +void TL_ZIGBEE_SendM4AckToM0Request(void) +{ + ((TL_CmdPacket_t *)(TL_RefTable.p_zigbee_table->requestM0toM4_buffer))->cmdserial.type = TL_OTACK_PKT_TYPE; + + HW_IPCC_ZIGBEE_SendM4AckToM0Request(); + + return; +} + + +__WEAK void TL_ZIGBEE_CmdEvtReceived( TL_EvtPacket_t * Otbuffer ){}; +__WEAK void TL_ZIGBEE_NotReceived( TL_EvtPacket_t * Notbuffer ){}; +#endif + + + +/****************************************************************************** + * MEMORY MANAGER + ******************************************************************************/ +void TL_MM_Init( TL_MM_Config_t *p_Config ) +{ + static MB_MemManagerTable_t * p_mem_manager_table; + + LST_init_head (&FreeBufQueue); + LST_init_head (&LocalFreeBufQueue); + + p_mem_manager_table = TL_RefTable.p_mem_manager_table; + + p_mem_manager_table->blepool = p_Config->p_AsynchEvtPool; + p_mem_manager_table->blepoolsize = p_Config->AsynchEvtPoolSize; + p_mem_manager_table->pevt_free_buffer_queue = (uint8_t*)&FreeBufQueue; + p_mem_manager_table->spare_ble_buffer = p_Config->p_BleSpareEvtBuffer; + p_mem_manager_table->spare_sys_buffer = p_Config->p_SystemSpareEvtBuffer; + p_mem_manager_table->traces_evt_pool = p_Config->p_TracesEvtPool; + p_mem_manager_table->tracespoolsize = p_Config->TracesEvtPoolSize; + + return; +} + +void TL_MM_EvtDone(TL_EvtPacket_t * phcievt) +{ + LST_insert_tail(&LocalFreeBufQueue, (tListNode *)phcievt); + + OutputDbgTrace(TL_MB_MM_RELEASE_BUFFER, (uint8_t*)phcievt); + + HW_IPCC_MM_SendFreeBuf( SendFreeBuf ); + + return; +} + +static void SendFreeBuf( void ) +{ + tListNode *p_node; + + while ( FALSE == LST_is_empty (&LocalFreeBufQueue) ) + { + LST_remove_head( &LocalFreeBufQueue, (tListNode **)&p_node ); + LST_insert_tail( (tListNode*)(TL_RefTable.p_mem_manager_table->pevt_free_buffer_queue), p_node ); + } + + return; +} + +/****************************************************************************** + * TRACES + ******************************************************************************/ +void TL_TRACES_Init( void ) +{ + LST_init_head (&TracesEvtQueue); + + TL_RefTable.p_traces_table->traces_queue = (uint8_t*)&TracesEvtQueue; + + HW_IPCC_TRACES_Init(); + + return; +} + +void HW_IPCC_TRACES_EvtNot(void) +{ + TL_EvtPacket_t *phcievt; + + while(LST_is_empty(&TracesEvtQueue) == FALSE) + { + LST_remove_head (&TracesEvtQueue, (tListNode **)&phcievt); + TL_TRACES_EvtReceived( phcievt ); + } + + return; +} + +__WEAK void TL_TRACES_EvtReceived( TL_EvtPacket_t * hcievt ) +{ + (void)(hcievt); +} + +/****************************************************************************** + * DEBUG INFORMATION + ******************************************************************************/ +static void OutputDbgTrace(TL_MB_PacketType_t packet_type, uint8_t* buffer) +{ + TL_EvtPacket_t *p_evt_packet; + TL_CmdPacket_t *p_cmd_packet; + + switch(packet_type) + { + case TL_MB_MM_RELEASE_BUFFER: + p_evt_packet = (TL_EvtPacket_t*)buffer; + switch(p_evt_packet->evtserial.evt.evtcode) + { + case TL_BLEEVT_CS_OPCODE: + TL_MM_DBG_MSG("mm evt released: 0x%02X", p_evt_packet->evtserial.evt.evtcode); + TL_MM_DBG_MSG(" cmd opcode: 0x%04X", ((TL_CsEvt_t*)(p_evt_packet->evtserial.evt.payload))->cmdcode); + TL_MM_DBG_MSG(" buffer addr: 0x%08X", p_evt_packet); + break; + + case TL_BLEEVT_CC_OPCODE: + TL_MM_DBG_MSG("mm evt released: 0x%02X", p_evt_packet->evtserial.evt.evtcode); + TL_MM_DBG_MSG(" cmd opcode: 0x%04X", ((TL_CcEvt_t*)(p_evt_packet->evtserial.evt.payload))->cmdcode); + TL_MM_DBG_MSG(" buffer addr: 0x%08X", p_evt_packet); + break; + + case TL_BLEEVT_VS_OPCODE: + TL_MM_DBG_MSG("mm evt released: 0x%02X", p_evt_packet->evtserial.evt.evtcode); + TL_MM_DBG_MSG(" subevtcode: 0x%04X", ((TL_AsynchEvt_t*)(p_evt_packet->evtserial.evt.payload))->subevtcode); + TL_MM_DBG_MSG(" buffer addr: 0x%08X", p_evt_packet); + break; + + default: + TL_MM_DBG_MSG("mm evt released: 0x%02X", p_evt_packet->evtserial.evt.evtcode); + TL_MM_DBG_MSG(" buffer addr: 0x%08X", p_evt_packet); + break; + } + + TL_MM_DBG_MSG("\r\n"); + break; + + case TL_MB_BLE_CMD: + p_cmd_packet = (TL_CmdPacket_t*)buffer; + TL_HCI_CMD_DBG_MSG("ble cmd: 0x%04X", p_cmd_packet->cmdserial.cmd.cmdcode); + if(p_cmd_packet->cmdserial.cmd.plen != 0) + { + TL_HCI_CMD_DBG_MSG(" payload:"); + TL_HCI_CMD_DBG_BUF(p_cmd_packet->cmdserial.cmd.payload, p_cmd_packet->cmdserial.cmd.plen, ""); + } + TL_HCI_CMD_DBG_MSG("\r\n"); + + TL_HCI_CMD_DBG_RAW(&p_cmd_packet->cmdserial, p_cmd_packet->cmdserial.cmd.plen+TL_CMD_HDR_SIZE); + break; + + case TL_MB_BLE_CMD_RSP: + p_evt_packet = (TL_EvtPacket_t*)buffer; + switch(p_evt_packet->evtserial.evt.evtcode) + { + case TL_BLEEVT_CS_OPCODE: + TL_HCI_CMD_DBG_MSG("ble rsp: 0x%02X", p_evt_packet->evtserial.evt.evtcode); + TL_HCI_CMD_DBG_MSG(" cmd opcode: 0x%04X", ((TL_CsEvt_t*)(p_evt_packet->evtserial.evt.payload))->cmdcode); + TL_HCI_CMD_DBG_MSG(" numhci: 0x%02X", ((TL_CsEvt_t*)(p_evt_packet->evtserial.evt.payload))->numcmd); + TL_HCI_CMD_DBG_MSG(" status: 0x%02X", ((TL_CsEvt_t*)(p_evt_packet->evtserial.evt.payload))->status); + break; + + case TL_BLEEVT_CC_OPCODE: + TL_HCI_CMD_DBG_MSG("ble rsp: 0x%02X", p_evt_packet->evtserial.evt.evtcode); + TL_HCI_CMD_DBG_MSG(" cmd opcode: 0x%04X", ((TL_CcEvt_t*)(p_evt_packet->evtserial.evt.payload))->cmdcode); + TL_HCI_CMD_DBG_MSG(" numhci: 0x%02X", ((TL_CcEvt_t*)(p_evt_packet->evtserial.evt.payload))->numcmd); + TL_HCI_CMD_DBG_MSG(" status: 0x%02X", ((TL_CcEvt_t*)(p_evt_packet->evtserial.evt.payload))->payload[0]); + if((p_evt_packet->evtserial.evt.plen-4) != 0) + { + TL_HCI_CMD_DBG_MSG(" payload:"); + TL_HCI_CMD_DBG_BUF(&((TL_CcEvt_t*)(p_evt_packet->evtserial.evt.payload))->payload[1], p_evt_packet->evtserial.evt.plen-4, ""); + } + break; + + default: + TL_HCI_CMD_DBG_MSG("unknown ble rsp received: %02X", p_evt_packet->evtserial.evt.evtcode); + break; + } + + TL_HCI_CMD_DBG_MSG("\r\n"); + + TL_HCI_CMD_DBG_RAW(&p_evt_packet->evtserial, p_evt_packet->evtserial.evt.plen+TL_EVT_HDR_SIZE); + break; + + case TL_MB_BLE_ASYNCH_EVT: + p_evt_packet = (TL_EvtPacket_t*)buffer; + if(p_evt_packet->evtserial.evt.evtcode != TL_BLEEVT_VS_OPCODE) + { + TL_HCI_EVT_DBG_MSG("ble evt: 0x%02X", p_evt_packet->evtserial.evt.evtcode); + if((p_evt_packet->evtserial.evt.plen) != 0) + { + TL_HCI_EVT_DBG_MSG(" payload:"); + TL_HCI_EVT_DBG_BUF(p_evt_packet->evtserial.evt.payload, p_evt_packet->evtserial.evt.plen, ""); + } + } + else + { + TL_HCI_EVT_DBG_MSG("ble evt: 0x%02X", p_evt_packet->evtserial.evt.evtcode); + TL_HCI_EVT_DBG_MSG(" subevtcode: 0x%04X", ((TL_AsynchEvt_t*)(p_evt_packet->evtserial.evt.payload))->subevtcode); + if((p_evt_packet->evtserial.evt.plen-2) != 0) + { + TL_HCI_EVT_DBG_MSG(" payload:"); + TL_HCI_EVT_DBG_BUF(((TL_AsynchEvt_t*)(p_evt_packet->evtserial.evt.payload))->payload, p_evt_packet->evtserial.evt.plen-2, ""); + } + } + + TL_HCI_EVT_DBG_MSG("\r\n"); + + TL_HCI_EVT_DBG_RAW(&p_evt_packet->evtserial, p_evt_packet->evtserial.evt.plen+TL_EVT_HDR_SIZE); + break; + + case TL_MB_SYS_CMD: + p_cmd_packet = (TL_CmdPacket_t*)buffer; + + TL_SHCI_CMD_DBG_MSG("sys cmd: 0x%04X", p_cmd_packet->cmdserial.cmd.cmdcode); + + if(p_cmd_packet->cmdserial.cmd.plen != 0) + { + TL_SHCI_CMD_DBG_MSG(" payload:"); + TL_SHCI_CMD_DBG_BUF(p_cmd_packet->cmdserial.cmd.payload, p_cmd_packet->cmdserial.cmd.plen, ""); + } + TL_SHCI_CMD_DBG_MSG("\r\n"); + + TL_SHCI_CMD_DBG_RAW(&p_cmd_packet->cmdserial, p_cmd_packet->cmdserial.cmd.plen+TL_CMD_HDR_SIZE); + break; + + case TL_MB_SYS_CMD_RSP: + p_evt_packet = (TL_EvtPacket_t*)buffer; + switch(p_evt_packet->evtserial.evt.evtcode) + { + case TL_BLEEVT_CC_OPCODE: + TL_SHCI_CMD_DBG_MSG("sys rsp: 0x%02X", p_evt_packet->evtserial.evt.evtcode); + TL_SHCI_CMD_DBG_MSG(" cmd opcode: 0x%02X", ((TL_CcEvt_t*)(p_evt_packet->evtserial.evt.payload))->cmdcode); + TL_SHCI_CMD_DBG_MSG(" status: 0x%02X", ((TL_CcEvt_t*)(p_evt_packet->evtserial.evt.payload))->payload[0]); + if((p_evt_packet->evtserial.evt.plen-4) != 0) + { + TL_SHCI_CMD_DBG_MSG(" payload:"); + TL_SHCI_CMD_DBG_BUF(&((TL_CcEvt_t*)(p_evt_packet->evtserial.evt.payload))->payload[1], p_evt_packet->evtserial.evt.plen-4, ""); + } + break; + + default: + TL_SHCI_CMD_DBG_MSG("unknown sys rsp received: %02X", p_evt_packet->evtserial.evt.evtcode); + break; + } + + TL_SHCI_CMD_DBG_MSG("\r\n"); + + TL_SHCI_CMD_DBG_RAW(&p_evt_packet->evtserial, p_evt_packet->evtserial.evt.plen+TL_EVT_HDR_SIZE); + break; + + case TL_MB_SYS_ASYNCH_EVT: + p_evt_packet = (TL_EvtPacket_t*)buffer; + if(p_evt_packet->evtserial.evt.evtcode != TL_BLEEVT_VS_OPCODE) + { + TL_SHCI_EVT_DBG_MSG("unknown sys evt received: %02X", p_evt_packet->evtserial.evt.evtcode); + } + else + { + TL_SHCI_EVT_DBG_MSG("sys evt: 0x%02X", p_evt_packet->evtserial.evt.evtcode); + TL_SHCI_EVT_DBG_MSG(" subevtcode: 0x%04X", ((TL_AsynchEvt_t*)(p_evt_packet->evtserial.evt.payload))->subevtcode); + if((p_evt_packet->evtserial.evt.plen-2) != 0) + { + TL_SHCI_EVT_DBG_MSG(" payload:"); + TL_SHCI_EVT_DBG_BUF(((TL_AsynchEvt_t*)(p_evt_packet->evtserial.evt.payload))->payload, p_evt_packet->evtserial.evt.plen-2, ""); + } + } + + TL_SHCI_EVT_DBG_MSG("\r\n"); + + TL_SHCI_EVT_DBG_RAW(&p_evt_packet->evtserial, p_evt_packet->evtserial.evt.plen+TL_EVT_HDR_SIZE); + break; + + default: + break; + } + + return; +} +#endif /* STM32WBxx */ From 63b1e88a57e2d54cdff6a33f20009345921a96a3 Mon Sep 17 00:00:00 2001 From: AresMaster Date: Tue, 17 Oct 2023 20:59:42 +0200 Subject: [PATCH 77/83] Small fixes and changes --- .../EnhancedAdvertising.ino | 2 +- .../BatteryMonitor/BatteryMonitor.ino | 4 +- .../Peripheral/CallbackLED/CallbackLED.ino | 1 + .../EncryptedBatteryMonitor.ino | 2 +- src/local/BLELocalDevice.cpp | 2 +- src/utility/ATT.cpp | 1 + src/utility/ATT.h | 2 - src/utility/HCI.cpp | 19 +- src/utility/HCI.h | 20 +- src/utility/HCICordioTransport.cpp | 312 ------------------ src/utility/HCIUartTransport.cpp | 107 ------ src/utility/btct.cpp | 2 +- 12 files changed, 19 insertions(+), 455 deletions(-) delete mode 100644 src/utility/HCICordioTransport.cpp delete mode 100644 src/utility/HCIUartTransport.cpp diff --git a/examples/Peripheral/Advertising/EnhancedAdvertising/EnhancedAdvertising.ino b/examples/Peripheral/Advertising/EnhancedAdvertising/EnhancedAdvertising.ino index 979b69a8..806c41bd 100644 --- a/examples/Peripheral/Advertising/EnhancedAdvertising/EnhancedAdvertising.ino +++ b/examples/Peripheral/Advertising/EnhancedAdvertising/EnhancedAdvertising.ino @@ -1,4 +1,4 @@ -#include +#include BLEService myService("fff0"); BLEIntCharacteristic myCharacteristic("fff1", BLERead | BLEBroadcast); diff --git a/examples/Peripheral/BatteryMonitor/BatteryMonitor.ino b/examples/Peripheral/BatteryMonitor/BatteryMonitor.ino index f013c6f5..65a6bd2c 100644 --- a/examples/Peripheral/BatteryMonitor/BatteryMonitor.ino +++ b/examples/Peripheral/BatteryMonitor/BatteryMonitor.ino @@ -15,9 +15,9 @@ This example code is in the public domain. */ -#include +#include - // Bluetooth® Low Energy Battery Service +// Bluetooth® Low Energy Battery Service BLEService batteryService("180F"); // Bluetooth® Low Energy Battery Level Characteristic diff --git a/examples/Peripheral/CallbackLED/CallbackLED.ino b/examples/Peripheral/CallbackLED/CallbackLED.ino index 74c4de0e..19139cbe 100644 --- a/examples/Peripheral/CallbackLED/CallbackLED.ino +++ b/examples/Peripheral/CallbackLED/CallbackLED.ino @@ -62,6 +62,7 @@ BLELocalDevice& BLE = BLEObj; /* Shield IDB05A2 with SPI clock on D3 */ SPIClass SpiHCI(D11, D12, D3); HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M0, A1, A0, D7, 8000000, SPI_MODE0); +#endif #if !defined(FAKE_BLELOCALDEVICE) BLELocalDevice BLEObj(&HCISpiTransport); BLELocalDevice& BLE = BLEObj; diff --git a/examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino b/examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino index 9f9d453b..b8d86042 100644 --- a/examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino +++ b/examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino @@ -15,7 +15,7 @@ This example code is in the public domain. */ -#include +#include #define PAIR_BUTTON 3 // button for pairing diff --git a/src/local/BLELocalDevice.cpp b/src/local/BLELocalDevice.cpp index 7b9e876a..3df8dea4 100644 --- a/src/local/BLELocalDevice.cpp +++ b/src/local/BLELocalDevice.cpp @@ -59,7 +59,7 @@ int BLELocalDevice::begin() /* Random address only requires 6 bytes (48 bits) * Force both MSB bits to b00 in order to define Static Random Address */ - randomNumber[5] |= 0xC0; + //randomNumber[5] |= 0xC0; // Copy the random address in private variable as it will be sent to the BLE chip randomAddress [0] = randomNumber[0]; diff --git a/src/utility/ATT.cpp b/src/utility/ATT.cpp index 0ff92a84..f6652a25 100644 --- a/src/utility/ATT.cpp +++ b/src/utility/ATT.cpp @@ -1936,6 +1936,7 @@ int ATTClass::getPeerResolvedAddress(uint16_t connectionHandle, uint8_t resolved return 1; } return 0; +} void ATTClass::setOwnBdaddrType(uint8_t ownBdaddrType) { _ownBdaddrType = ownBdaddrType; diff --git a/src/utility/ATT.h b/src/utility/ATT.h index 81dba5a4..e061a68b 100644 --- a/src/utility/ATT.h +++ b/src/utility/ATT.h @@ -112,8 +112,6 @@ class ATTClass { void setOwnBdaddrType(uint8_t ownBdaddrType); - void setOwnBdaddrType(uint8_t ownBdaddrType); - private: virtual void error(uint16_t connectionHandle, uint8_t dlen, uint8_t data[]); virtual void mtuReq(uint16_t connectionHandle, uint8_t dlen, uint8_t data[]); diff --git a/src/utility/HCI.cpp b/src/utility/HCI.cpp index 609f8589..166cee1c 100644 --- a/src/utility/HCI.cpp +++ b/src/utility/HCI.cpp @@ -603,17 +603,6 @@ int HCIClass::leRand(uint8_t randomNumber[8]) return result; } -int HCIClass::leRand(uint8_t randomNumber[8]) -{ - int result = sendCommand(OGF_LE_CTL << 10 | OCF_LE_RAND); - - if (result == 0) { - memcpy(randomNumber, _cmdResponse, 8); - } - - return result; -} - int HCIClass::sendAclPkt(uint16_t handle, uint8_t cid, uint8_t plen, void* data) { while (_pendingPkt >= _maxPkt) { @@ -1412,13 +1401,7 @@ int HCIClass::leEncrypt(uint8_t* key, uint8_t* plaintext, uint8_t* status, uint8 #endif return res; } -int HCIClass::leRand(uint8_t rand[]){ - int res = sendCommand(OGF_LE_CTL << 10 | LE_COMMAND::RANDOM); - if(res == 0){ - memcpy(rand,_cmdResponse, 8); /// backwards but it's a random number - } - return res; -} + int HCIClass::getLTK(uint8_t* address, uint8_t* LTK){ if(_getLTK!=0){ return _getLTK(address, LTK); diff --git a/src/utility/HCI.h b/src/utility/HCI.h index cb6170b6..71213349 100644 --- a/src/utility/HCI.h +++ b/src/utility/HCI.h @@ -119,8 +119,16 @@ class HCIClass { // TODO: Send command be private again & use ATT implementation of send command within ATT. void setTransport(HCITransportInterface *HCITransport); + virtual int getLTK(uint8_t *address, uint8_t *LTK); + virtual int storeLTK(uint8_t *address, uint8_t *LTK); + virtual int storeIRK(uint8_t *address, uint8_t *IRK); + int (*_storeIRK)(uint8_t *address, uint8_t *peerIrk) = 0; + int (*_getIRKs)(uint8_t *nIRKs, uint8_t **BADDR_type, uint8_t ***BADDRs, uint8_t ***IRKs) = 0; + int (*_storeLTK)(uint8_t *, uint8_t *) = 0; + int (*_getLTK)(uint8_t *, uint8_t *) = 0; + void (*_displayCode)(uint32_t confirmationCode) = 0; + bool (*_binaryConfirmPairing)() = 0; -private: virtual int sendCommand(uint16_t opcode, uint8_t plen = 0, void* parameters = NULL); uint8_t remotePublicKeyBuffer[64]; uint8_t localPublicKeyBuffer[64]; @@ -130,15 +138,7 @@ class HCIClass { uint8_t DHKey[32]; uint8_t localAddr[6]; uint8_t LTK[16]; - virtual int getLTK(uint8_t* address, uint8_t* LTK); - virtual int storeLTK(uint8_t* address, uint8_t* LTK); - virtual int storeIRK(uint8_t* address, uint8_t* IRK); - int (*_storeIRK)(uint8_t* address, uint8_t* peerIrk) = 0; - int (*_getIRKs)(uint8_t* nIRKs,uint8_t** BADDR_type, uint8_t*** BADDRs, uint8_t*** IRKs) = 0; - int (*_storeLTK)(uint8_t*, uint8_t*) = 0; - int (*_getLTK)(uint8_t*, uint8_t*) = 0; - void (*_displayCode)(uint32_t confirmationCode) = 0; - bool (*_binaryConfirmPairing)() = 0; + private: diff --git a/src/utility/HCICordioTransport.cpp b/src/utility/HCICordioTransport.cpp deleted file mode 100644 index 947378cf..00000000 --- a/src/utility/HCICordioTransport.cpp +++ /dev/null @@ -1,312 +0,0 @@ -/* - This file is part of the ArduinoBLE library. - Copyright (c) 2019 Arduino SA. All rights reserved. - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -*/ - -#if defined(ARDUINO_ARCH_MBED) && !defined(TARGET_NANO_RP2040_CONNECT) - -#include -#include - -#include -#include - -#if defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_GIGA) || defined(ARDUINO_OPTA) -#include "ble/BLE.h" -#include -#endif - -// Parts of this file are based on: https://github.com/ARMmbed/mbed-os-cordio-hci-passthrough/pull/2 -// With permission from the Arm Mbed team to re-license - -#if CORDIO_ZERO_COPY_HCI -#include -#include -#include -#include -#include -#include - -/* avoid many small allocs (and WSF doesn't have smaller buffers) */ -#define MIN_WSF_ALLOC (16) -#endif //CORDIO_ZERO_COPY_HCI - -#include "HCICordioTransport.h" - -#if (MBED_VERSION > MBED_ENCODE_VERSION(6, 2, 0)) -#define BLE_NAMESPACE ble -#else -#define BLE_NAMESPACE ble::vendor::cordio -#endif - -extern BLE_NAMESPACE::CordioHCIDriver& ble_cordio_get_hci_driver(); - -namespace BLE_NAMESPACE { - struct CordioHCIHook { - static CordioHCIDriver& getDriver() { - return ble_cordio_get_hci_driver(); - } - - static CordioHCITransportDriver& getTransportDriver() { - return getDriver()._transport_driver; - } - - static void setDataReceivedHandler(void (*handler)(uint8_t*, uint8_t)) { - getTransportDriver().set_data_received_handler(handler); - } - }; -} - -using BLE_NAMESPACE::CordioHCIHook; - -#if CORDIO_ZERO_COPY_HCI -extern uint8_t *SystemHeapStart; -extern uint32_t SystemHeapSize; - -void init_wsf(BLE_NAMESPACE::buf_pool_desc_t& buf_pool_desc) { - static bool init = false; - - if (init) { - return; - } - init = true; - - // use the buffer for the WSF heap - SystemHeapStart = buf_pool_desc.buffer_memory; - SystemHeapSize = buf_pool_desc.buffer_size; - - // Initialize buffers with the ones provided by the HCI driver - uint16_t bytes_used = WsfBufInit( - buf_pool_desc.pool_count, - (wsfBufPoolDesc_t*)buf_pool_desc.pool_description - ); - - // Raise assert if not enough memory was allocated - MBED_ASSERT(bytes_used != 0); - - SystemHeapStart += bytes_used; - SystemHeapSize -= bytes_used; - - WsfTimerInit(); -} - - -extern "C" void wsf_mbed_ble_signal_event(void) -{ - // do nothing -} -#endif //CORDIO_ZERO_COPY_HCI - -static void bleLoop() -{ -#if CORDIO_ZERO_COPY_HCI - uint64_t last_update_us = 0; - mbed::LowPowerTimer timer; - - timer.start(); - - while (true) { - last_update_us += (uint64_t) timer.read_high_resolution_us(); - timer.reset(); - - uint64_t last_update_ms = (last_update_us / 1000); - wsfTimerTicks_t wsf_ticks = (last_update_ms / WSF_MS_PER_TICK); - - if (wsf_ticks > 0) { - WsfTimerUpdate(wsf_ticks); - last_update_us -= (last_update_ms * 1000); - } - - wsfOsDispatcher(); - - bool sleep = false; - { - /* call needs interrupts disabled */ - mbed::CriticalSectionLock critical_section; - if (wsfOsReadyToSleep()) { - sleep = true; - } - } - - uint64_t time_spent = (uint64_t) timer.read_high_resolution_us(); - - /* don't bother sleeping if we're already past tick */ - if (sleep && (WSF_MS_PER_TICK * 1000 > time_spent)) { - /* sleep to maintain constant tick rate */ - uint64_t wait_time_us = WSF_MS_PER_TICK * 1000 - time_spent; - uint64_t wait_time_ms = wait_time_us / 1000; - - wait_time_us = wait_time_us % 1000; - - if (wait_time_ms) { - rtos::ThisThread::sleep_for(wait_time_ms); - } - - if (wait_time_us) { - wait_us(wait_time_us); - } - } - } -#else - while(true) { - rtos::ThisThread::sleep_for(osWaitForever); - } -#endif // CORDIO_ZERO_COPY_HCI -} - -static rtos::EventFlags bleEventFlags; -static rtos::Thread* bleLoopThread = NULL; - - -HCICordioTransportClass::HCICordioTransportClass() : - _begun(false) -{ -} - -HCICordioTransportClass::~HCICordioTransportClass() -{ -} - -#if defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_GIGA) || defined(ARDUINO_OPTA) -events::EventQueue eventQueue(10 * EVENTS_EVENT_SIZE); -void scheduleMbedBleEvents(BLE::OnEventsToProcessCallbackContext *context) { - eventQueue.call(mbed::Callback(&context->ble, &BLE::processEvents)); -} - -void completeCallback(BLE::InitializationCompleteCallbackContext *context) { - eventQueue.break_dispatch(); -} -#endif - -int HCICordioTransportClass::begin() -{ - _rxBuf.clear(); - -#if CORDIO_ZERO_COPY_HCI - BLE_NAMESPACE::buf_pool_desc_t bufPoolDesc = CordioHCIHook::getDriver().get_buffer_pool_description(); - init_wsf(bufPoolDesc); -#endif - -#if defined(ARDUINO_PORTENTA_H7_M4) || defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) || defined(ARDUINO_GIGA) || defined(ARDUINO_OPTA) - BLE &ble = BLE::Instance(); - ble.onEventsToProcess(scheduleMbedBleEvents); - - ble.init(completeCallback); - eventQueue.dispatch(10000); - - if (!ble.hasInitialized()){ - return 0; - } -#else - CordioHCIHook::getDriver().initialize(); -#endif - - if (bleLoopThread == NULL) { - bleLoopThread = new rtos::Thread(); - bleLoopThread->start(bleLoop); - } - - CordioHCIHook::setDataReceivedHandler(HCICordioTransportClass::onDataReceived); - - _begun = true; - - return 1; -} - -void HCICordioTransportClass::end() -{ - if (bleLoopThread != NULL) { - bleLoopThread->terminate(); - delete bleLoopThread; - bleLoopThread = NULL; - } - -#if !defined(TARGET_STM32H7) - CordioHCIHook::getDriver().terminate(); -#endif - - _begun = false; -} - -void HCICordioTransportClass::wait(unsigned long timeout) -{ - if (available()) { - return; - } - - // wait for handleRxData to signal - bleEventFlags.wait_all(0x01, timeout, true); -} - -int HCICordioTransportClass::available() -{ - return _rxBuf.available(); -} - -int HCICordioTransportClass::peek() -{ - return _rxBuf.peek(); -} - -int HCICordioTransportClass::read() -{ - return _rxBuf.read_char(); -} - -size_t HCICordioTransportClass::write(const uint8_t* data, size_t length) -{ - if (!_begun) { - return 0; - } - - uint8_t packetLength = length - 1; - uint8_t packetType = data[0]; - -#if CORDIO_ZERO_COPY_HCI - uint8_t* packet = (uint8_t*)WsfMsgAlloc(max(packetLength, MIN_WSF_ALLOC)); - - memcpy(packet, &data[1], packetLength); - - return CordioHCIHook::getTransportDriver().write(packetType, packetLength, packet); -#else - return CordioHCIHook::getTransportDriver().write(packetType, packetLength, (uint8_t*)&data[1]); -#endif -} - -void HCICordioTransportClass::handleRxData(uint8_t* data, uint8_t len) -{ - if (_rxBuf.availableForStore() < len) { - // drop! - return; - } - - for (int i = 0; i < len; i++) { - _rxBuf.store_char(data[i]); - } - - bleEventFlags.set(0x01); -} - -HCICordioTransportClass HCICordioTransport; -HCITransportInterface& HCITransport = HCICordioTransport; - -void HCICordioTransportClass::onDataReceived(uint8_t* data, uint8_t len) -{ - HCICordioTransport.handleRxData(data, len); -} - -#endif diff --git a/src/utility/HCIUartTransport.cpp b/src/utility/HCIUartTransport.cpp deleted file mode 100644 index d3c44d8f..00000000 --- a/src/utility/HCIUartTransport.cpp +++ /dev/null @@ -1,107 +0,0 @@ -/* - This file is part of the ArduinoBLE library. - Copyright (c) 2018 Arduino SA. All rights reserved. - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -*/ - -#if !defined(ARDUINO_ARCH_MBED) && !defined(ESP32) && !defined(ARDUINO_UNOR4_WIFI) || defined(TARGET_NANO_RP2040_CONNECT) - -#include "HCIUartTransport.h" - -#if defined(ARDUINO_SAMD_MKRWIFI1010) || defined(ARDUINO_AVR_UNO_WIFI_REV2) -#define SerialHCI Serial2 -#elif defined(ARDUINO_SAMD_NANO_33_IOT) || defined(ARDUINO_NANO_RP2040_CONNECT) -// SerialHCI is already defined in the variant -#elif defined(ARDUINO_PORTENTA_H7_M4) -// SerialHCI is already defined in the variant -#elif defined(ARDUINO_PORTENTA_H7_M7) || defined(ARDUINO_NICLA_VISION) -#define SerialHCI Serial2 -#elif defined(ARDUINO_OPTA) -#define SerialHCI Serial3 -#elif defined(ARDUINO_PORTENTA_C33) -#define SerialHCI Serial5 -#else -#error "Unsupported board selected!" -#endif - -HCIUartTransportClass::HCIUartTransportClass(HardwareSerial& uart, unsigned long baudrate) : - _uart(&uart), - _baudrate(baudrate) -{ -} - -HCIUartTransportClass::~HCIUartTransportClass() -{ -} - -int HCIUartTransportClass::begin() -{ - _uart->begin(_baudrate); - - return 1; -} - -void HCIUartTransportClass::end() -{ - _uart->end(); -} - -void HCIUartTransportClass::wait(unsigned long timeout) -{ - for (unsigned long start = millis(); (millis() - start) < timeout;) { - if (available()) { - break; - } - } -} - -int HCIUartTransportClass::available() -{ - return _uart->available(); -} - -int HCIUartTransportClass::peek() -{ - return _uart->peek(); -} - -int HCIUartTransportClass::read() -{ - return _uart->read(); -} - -size_t HCIUartTransportClass::write(const uint8_t* data, size_t length) -{ -#ifdef ARDUINO_AVR_UNO_WIFI_REV2 - // wait while the CTS pin is low - while (digitalRead(NINA_CTS) == HIGH); -#endif - - size_t result = _uart->write(data, length); - - _uart->flush(); - - return result; -} - -#if defined(ARDUINO_AVR_UNO_WIFI_REV2) || defined(ARDUINO_NANO_RP2040_CONNECT) -HCIUartTransportClass HCIUartTransport(SerialHCI, 119600); -#else -HCIUartTransportClass HCIUartTransport(SerialHCI, 912600); -#endif -HCITransportInterface& HCITransport = HCIUartTransport; - -#endif diff --git a/src/utility/btct.cpp b/src/utility/btct.cpp index 6829494c..199c9e0d 100644 --- a/src/utility/btct.cpp +++ b/src/utility/btct.cpp @@ -1,7 +1,7 @@ #include "btct.h" #include #include "HCI.h" -#include "ArduinoBLE.h" +#include "STM32duinoBLE.h" BluetoothCryptoToolbox::BluetoothCryptoToolbox(){} // In step 1, AES-128 with key K is applied to an all-zero input block. // In step 2, K1 is derived through the following operation: From fe46ea87070afa074e998591c1f8fb2d9ed5f874 Mon Sep 17 00:00:00 2001 From: AresMaster Date: Tue, 17 Oct 2023 21:19:20 +0200 Subject: [PATCH 78/83] Example fixes --- .../EnhancedAdvertising.ino | 76 ++++++++++++++++++ .../RawDataAdvertising/RawDataAdvertising.ino | 78 +++++++++++++++++- .../BatteryMonitor/BatteryMonitor.ino | 76 ++++++++++++++++++ .../Peripheral/CallbackLED/CallbackLED.ino | 1 - .../EncryptedBatteryMonitor.ino | 79 ++++++++++++++++++- 5 files changed, 306 insertions(+), 4 deletions(-) diff --git a/examples/Peripheral/Advertising/EnhancedAdvertising/EnhancedAdvertising.ino b/examples/Peripheral/Advertising/EnhancedAdvertising/EnhancedAdvertising.ino index 806c41bd..88ee8acf 100644 --- a/examples/Peripheral/Advertising/EnhancedAdvertising/EnhancedAdvertising.ino +++ b/examples/Peripheral/Advertising/EnhancedAdvertising/EnhancedAdvertising.ino @@ -1,5 +1,81 @@ #include +#include +#if defined(ARDUINO_STEVAL_MKBOXPRO) +/* STEVAL-MKBOXPRO */ +SPIClass SpiHCI(PA7, PA6, PA5); +HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_LP, PA2, PB11, PD4, 1000000, SPI_MODE3); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice &BLE = BLEObj; +#endif +#elif defined(ARDUINO_STEVAL_MKSBOX1V1) +/* STEVAL-MKSBOX1V1 */ +SPIClass SpiHCI(PC3, PD3, PD1); +HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_1S, PD0, PD4, PA8, 1000000, SPI_MODE1); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice &BLE = BLEObj; +#endif +#elif defined(ARDUINO_B_L475E_IOT01A) || defined(ARDUINO_B_L4S5I_IOT01A) +/* B-L475E-IOT01A1 or B_L4S5I_IOT01A */ +SPIClass SpiHCI(PC12, PC11, PC10); +HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, PD13, PE6, PA8, 8000000, SPI_MODE0); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice &BLE = BLEObj; +#endif +#elif defined(ARDUINO_NUCLEO_WB15CC) || defined(ARDUINO_P_NUCLEO_WB55RG) || \ + defined(ARDUINO_STM32WB5MM_DK) || defined(P_NUCLEO_WB55_USB_DONGLE) +HCISharedMemTransportClass HCISharedMemTransport; +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISharedMemTransport); +BLELocalDevice &BLE = BLEObj; +#endif +#else +/* Shield IDB05A2 with SPI clock on D3 */ +SPIClass SpiHCI(D11, D12, D3); +HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M0, A1, A0, D7, 8000000, SPI_MODE0); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice &BLE = BLEObj; +#endif +/* Shield IDB05A2 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M0, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield IDB05A1 with SPI clock on D3 */ +// SPIClass SpiHCI(D11, D12, D3); +// HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield IDB05A1 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield BNRG2A1 with SPI clock on D3 */ +// SPIClass SpiHCI(D11, D12, D3); +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M2SP, A1, A0, D7, 1000000, SPI_MODE1); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield BNRG2A1 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M2SP, A1, A0, D7, 1000000, SPI_MODE1); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +#endif BLEService myService("fff0"); BLEIntCharacteristic myCharacteristic("fff1", BLERead | BLEBroadcast); diff --git a/examples/Peripheral/Advertising/RawDataAdvertising/RawDataAdvertising.ino b/examples/Peripheral/Advertising/RawDataAdvertising/RawDataAdvertising.ino index d025dd62..505ce5c4 100644 --- a/examples/Peripheral/Advertising/RawDataAdvertising/RawDataAdvertising.ino +++ b/examples/Peripheral/Advertising/RawDataAdvertising/RawDataAdvertising.ino @@ -1,5 +1,81 @@ -#include +#include +#include +#if defined(ARDUINO_STEVAL_MKBOXPRO) +/* STEVAL-MKBOXPRO */ +SPIClass SpiHCI(PA7, PA6, PA5); +HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_LP, PA2, PB11, PD4, 1000000, SPI_MODE3); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice &BLE = BLEObj; +#endif +#elif defined(ARDUINO_STEVAL_MKSBOX1V1) +/* STEVAL-MKSBOX1V1 */ +SPIClass SpiHCI(PC3, PD3, PD1); +HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_1S, PD0, PD4, PA8, 1000000, SPI_MODE1); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice &BLE = BLEObj; +#endif +#elif defined(ARDUINO_B_L475E_IOT01A) || defined(ARDUINO_B_L4S5I_IOT01A) +/* B-L475E-IOT01A1 or B_L4S5I_IOT01A */ +SPIClass SpiHCI(PC12, PC11, PC10); +HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, PD13, PE6, PA8, 8000000, SPI_MODE0); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice &BLE = BLEObj; +#endif +#elif defined(ARDUINO_NUCLEO_WB15CC) || defined(ARDUINO_P_NUCLEO_WB55RG) || \ + defined(ARDUINO_STM32WB5MM_DK) || defined(P_NUCLEO_WB55_USB_DONGLE) +HCISharedMemTransportClass HCISharedMemTransport; +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISharedMemTransport); +BLELocalDevice &BLE = BLEObj; +#endif +#else +/* Shield IDB05A2 with SPI clock on D3 */ +SPIClass SpiHCI(D11, D12, D3); +HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M0, A1, A0, D7, 8000000, SPI_MODE0); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice &BLE = BLEObj; +#endif +/* Shield IDB05A2 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M0, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield IDB05A1 with SPI clock on D3 */ +// SPIClass SpiHCI(D11, D12, D3); +// HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield IDB05A1 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield BNRG2A1 with SPI clock on D3 */ +// SPIClass SpiHCI(D11, D12, D3); +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M2SP, A1, A0, D7, 1000000, SPI_MODE1); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield BNRG2A1 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M2SP, A1, A0, D7, 1000000, SPI_MODE1); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +#endif BLEService myService("fff0"); BLEIntCharacteristic myCharacteristic("fff1", BLERead | BLEBroadcast); diff --git a/examples/Peripheral/BatteryMonitor/BatteryMonitor.ino b/examples/Peripheral/BatteryMonitor/BatteryMonitor.ino index 65a6bd2c..1a2cd63f 100644 --- a/examples/Peripheral/BatteryMonitor/BatteryMonitor.ino +++ b/examples/Peripheral/BatteryMonitor/BatteryMonitor.ino @@ -15,8 +15,84 @@ This example code is in the public domain. */ +#include #include +#if defined(ARDUINO_STEVAL_MKBOXPRO) +/* STEVAL-MKBOXPRO */ +SPIClass SpiHCI(PA7, PA6, PA5); +HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_LP, PA2, PB11, PD4, 1000000, SPI_MODE3); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice &BLE = BLEObj; +#endif +#elif defined(ARDUINO_STEVAL_MKSBOX1V1) +/* STEVAL-MKSBOX1V1 */ +SPIClass SpiHCI(PC3, PD3, PD1); +HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_1S, PD0, PD4, PA8, 1000000, SPI_MODE1); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice &BLE = BLEObj; +#endif +#elif defined(ARDUINO_B_L475E_IOT01A) || defined(ARDUINO_B_L4S5I_IOT01A) +/* B-L475E-IOT01A1 or B_L4S5I_IOT01A */ +SPIClass SpiHCI(PC12, PC11, PC10); +HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, PD13, PE6, PA8, 8000000, SPI_MODE0); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice &BLE = BLEObj; +#endif +#elif defined(ARDUINO_NUCLEO_WB15CC) || defined(ARDUINO_P_NUCLEO_WB55RG) || \ + defined(ARDUINO_STM32WB5MM_DK) || defined(P_NUCLEO_WB55_USB_DONGLE) +HCISharedMemTransportClass HCISharedMemTransport; +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISharedMemTransport); +BLELocalDevice &BLE = BLEObj; +#endif +#else +/* Shield IDB05A2 with SPI clock on D3 */ +SPIClass SpiHCI(D11, D12, D3); +HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M0, A1, A0, D7, 8000000, SPI_MODE0); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice &BLE = BLEObj; +#endif +/* Shield IDB05A2 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M0, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield IDB05A1 with SPI clock on D3 */ +// SPIClass SpiHCI(D11, D12, D3); +// HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield IDB05A1 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield BNRG2A1 with SPI clock on D3 */ +// SPIClass SpiHCI(D11, D12, D3); +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M2SP, A1, A0, D7, 1000000, SPI_MODE1); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield BNRG2A1 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M2SP, A1, A0, D7, 1000000, SPI_MODE1); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +#endif // Bluetooth® Low Energy Battery Service BLEService batteryService("180F"); diff --git a/examples/Peripheral/CallbackLED/CallbackLED.ino b/examples/Peripheral/CallbackLED/CallbackLED.ino index 19139cbe..74c4de0e 100644 --- a/examples/Peripheral/CallbackLED/CallbackLED.ino +++ b/examples/Peripheral/CallbackLED/CallbackLED.ino @@ -62,7 +62,6 @@ BLELocalDevice& BLE = BLEObj; /* Shield IDB05A2 with SPI clock on D3 */ SPIClass SpiHCI(D11, D12, D3); HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M0, A1, A0, D7, 8000000, SPI_MODE0); -#endif #if !defined(FAKE_BLELOCALDEVICE) BLELocalDevice BLEObj(&HCISpiTransport); BLELocalDevice& BLE = BLEObj; diff --git a/examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino b/examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino index b8d86042..432068fb 100644 --- a/examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino +++ b/examples/Peripheral/EncryptedBatteryMonitor/EncryptedBatteryMonitor.ino @@ -25,8 +25,83 @@ #define CTRL_LED LED_BUILTIN - - // BLE Battery Service +#if defined(ARDUINO_STEVAL_MKBOXPRO) + /* STEVAL-MKBOXPRO */ + SPIClass SpiHCI(PA7, PA6, PA5); +HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_LP, PA2, PB11, PD4, 1000000, SPI_MODE3); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice &BLE = BLEObj; +#endif +#elif defined(ARDUINO_STEVAL_MKSBOX1V1) + /* STEVAL-MKSBOX1V1 */ + SPIClass SpiHCI(PC3, PD3, PD1); +HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_1S, PD0, PD4, PA8, 1000000, SPI_MODE1); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice &BLE = BLEObj; +#endif +#elif defined(ARDUINO_B_L475E_IOT01A) || defined(ARDUINO_B_L4S5I_IOT01A) + /* B-L475E-IOT01A1 or B_L4S5I_IOT01A */ + SPIClass SpiHCI(PC12, PC11, PC10); +HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, PD13, PE6, PA8, 8000000, SPI_MODE0); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice &BLE = BLEObj; +#endif +#elif defined(ARDUINO_NUCLEO_WB15CC) || defined(ARDUINO_P_NUCLEO_WB55RG) || \ + defined(ARDUINO_STM32WB5MM_DK) || defined(P_NUCLEO_WB55_USB_DONGLE) + HCISharedMemTransportClass HCISharedMemTransport; +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISharedMemTransport); +BLELocalDevice &BLE = BLEObj; +#endif +#else + /* Shield IDB05A2 with SPI clock on D3 */ + SPIClass SpiHCI(D11, D12, D3); +HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M0, A1, A0, D7, 8000000, SPI_MODE0); +#if !defined(FAKE_BLELOCALDEVICE) +BLELocalDevice BLEObj(&HCISpiTransport); +BLELocalDevice &BLE = BLEObj; +#endif +/* Shield IDB05A2 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M0, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield IDB05A1 with SPI clock on D3 */ +// SPIClass SpiHCI(D11, D12, D3); +// HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield IDB05A1 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, SPBTLE_RF, A1, A0, D7, 8000000, SPI_MODE0); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield BNRG2A1 with SPI clock on D3 */ +// SPIClass SpiHCI(D11, D12, D3); +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M2SP, A1, A0, D7, 1000000, SPI_MODE1); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +/* Shield BNRG2A1 with SPI clock on D13 */ +// #define SpiHCI SPI +// HCISpiTransportClass HCISpiTransport(SpiHCI, BLUENRG_M2SP, A1, A0, D7, 1000000, SPI_MODE1); +// #if !defined(FAKE_BLELOCALDEVICE) +// BLELocalDevice BLEObj(&HCISpiTransport); +// BLELocalDevice& BLE = BLEObj; +// #endif +#endif + +// BLE Battery Service BLEService batteryService("180F"); // BLE Battery Level Characteristic From 12d92e3ac6a5943fc21d5c7c967ed32dea5a8576 Mon Sep 17 00:00:00 2001 From: Arkadiusz Ambroziak Date: Wed, 18 Oct 2023 14:55:37 +0200 Subject: [PATCH 79/83] Fixes, update masks, static mac address --- src/local/BLELocalDevice.cpp | 10 +++++----- src/utility/ATT.cpp | 5 +++-- src/utility/HCI.cpp | 34 ++++++++++++++++++++-------------- src/utility/HCI.h | 4 ++-- src/utility/L2CAPSignaling.cpp | 4 ++-- 5 files changed, 32 insertions(+), 25 deletions(-) diff --git a/src/local/BLELocalDevice.cpp b/src/local/BLELocalDevice.cpp index 3df8dea4..d4171576 100644 --- a/src/local/BLELocalDevice.cpp +++ b/src/local/BLELocalDevice.cpp @@ -51,11 +51,11 @@ int BLELocalDevice::begin() return 0; } - uint8_t randomNumber[8]; - if (HCI.leRand(randomNumber) != 0) { + uint8_t randomNumber[8] = {0x00,0x80,0xe1,0x27,0xa3,0x30,0,0}; + /*if (HCI.leRand(randomNumber) != 0) { end(); return 0; - } + }*/ /* Random address only requires 6 bytes (48 bits) * Force both MSB bits to b00 in order to define Static Random Address */ @@ -85,11 +85,11 @@ int BLELocalDevice::begin() return 0; } - if (HCI.setEventMask(0x3FFFFFFFFFFFFFFF) != 0) { + if (HCI.setEventMask(0x2000F0FFFFFFF0FF) != 0) { end(); return 0; } - if (HCI.setLeEventMask(0x00000000000003FF) != 0) { + if (HCI.setLeEventMask(0x0000000000000193) != 0) { end(); return 0; } diff --git a/src/utility/ATT.cpp b/src/utility/ATT.cpp index f6652a25..811f46c8 100644 --- a/src/utility/ATT.cpp +++ b/src/utility/ATT.cpp @@ -1726,8 +1726,9 @@ bool ATTClass::discoverDescriptors(uint16_t connectionHandle, BLERemoteDevice* d } if (responseBuffer[0] == ATT_OP_FIND_INFO_RESP) { - uint16_t lengthPerDescriptor = responseBuffer[1] * 4; - uint8_t uuidLen = 2; + uint8_t uuidLen = responseBuffer[1] == 1 ? 2 : 16; + uint16_t lengthPerDescriptor = uuidLen + 2; + for (int i = 2; i < respLength; i += lengthPerDescriptor) { struct __attribute__ ((packed)) RawDescriptor { diff --git a/src/utility/HCI.cpp b/src/utility/HCI.cpp index 166cee1c..f4eabc1a 100644 --- a/src/utility/HCI.cpp +++ b/src/utility/HCI.cpp @@ -591,7 +591,7 @@ int HCIClass::tryResolveAddress(uint8_t* BDAddr, uint8_t* address){ } return 0; } - +/* int HCIClass::leRand(uint8_t randomNumber[8]) { int result = sendCommand(OGF_LE_CTL << 10 | OCF_LE_RAND); @@ -602,8 +602,8 @@ int HCIClass::leRand(uint8_t randomNumber[8]) return result; } - -int HCIClass::sendAclPkt(uint16_t handle, uint8_t cid, uint8_t plen, void* data) +*/ +int HCIClass::sendAclPkt(uint16_t handle, uint8_t cid, uint8_t plen, const void* data) { while (_pendingPkt >= _maxPkt) { poll(); @@ -617,7 +617,7 @@ int HCIClass::sendAclPkt(uint16_t handle, uint8_t cid, uint8_t plen, void* data) uint16_t cid; } aclHdr = { HCI_ACLDATA_PKT, handle, uint8_t(plen + 4), plen, cid }; - uint8_t txBuffer[sizeof(aclHdr) + plen]; + uint8_t* txBuffer = (uint8_t*)malloc(sizeof(aclHdr) + plen); memcpy(txBuffer, &aclHdr, sizeof(aclHdr)); memcpy(&txBuffer[sizeof(aclHdr)], data, plen); @@ -659,7 +659,7 @@ void HCIClass::noDebug() _debug = NULL; } -int HCIClass::sendCommand(uint16_t opcode, uint8_t plen, void* parameters) +int HCIClass::sendCommand(uint16_t opcode, uint8_t plen, const void* parameters) { struct __attribute__ ((packed)) { uint8_t pktType; @@ -667,7 +667,7 @@ int HCIClass::sendCommand(uint16_t opcode, uint8_t plen, void* parameters) uint8_t plen; } pktHdr = {HCI_COMMAND_PKT, opcode, plen}; - uint8_t txBuffer[sizeof(pktHdr) + plen]; + uint8_t* txBuffer = (uint8_t*)malloc(sizeof(pktHdr) + plen); memcpy(txBuffer, &pktHdr, sizeof(pktHdr)); memcpy(&txBuffer[sizeof(pktHdr)], parameters, plen); @@ -815,9 +815,9 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) if (GAP.advertising()) { - HCI.leSetAdvertiseEnable(0x01); + HCI.leSetAdvertiseEnable(0x01); } - } + } else if (eventHdr->evt == EVT_ENCRYPTION_CHANGE) { struct __attribute__ ((packed)) EncryptionChange { @@ -902,9 +902,9 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) }else{ ATT.setPeerEncryption(encryptionChange->connectionHandle, PEER_ENCRYPTION::NO_ENCRYPTION); } - - - } else if (eventHdr->evt == EVT_CMD_COMPLETE) { + } + else if (eventHdr->evt == EVT_CMD_COMPLETE) + { struct __attribute__ ((packed)) CmdComplete { uint8_t ncmd; uint16_t opcode; @@ -1239,7 +1239,7 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) // Send the local public key to the remote uint16_t connectionHandle = ATT.getPeerEncrptingConnectionHandle(); - if(connectionHandle>ATT_MAX_PEERS){ + if(connectionHandle==ATT_MAX_PEERS+1){ #ifdef _BLE_TRACE_ Serial.println("failed to find connection handle"); #endif @@ -1318,7 +1318,7 @@ void HCIClass::handleEventPkt(uint8_t /*plen*/, uint8_t pdata[]) Serial.println("DH key generated"); #endif uint16_t connectionHandle = ATT.getPeerEncrptingConnectionHandle(); - if(connectionHandle>ATT_MAX_PEERS){ + if(connectionHandle==ATT_MAX_PEERS+1){ #ifdef _BLE_TRACE_ Serial.println("Failed to find connection handle DH key check"); #endif @@ -1401,7 +1401,13 @@ int HCIClass::leEncrypt(uint8_t* key, uint8_t* plaintext, uint8_t* status, uint8 #endif return res; } - +int HCIClass::leRand(uint8_t rand[]){ + int res = sendCommand(OGF_LE_CTL << 10 | LE_COMMAND::RANDOM); + if(res == 0){ + memcpy(rand,_cmdResponse, 8); /// backwards but it's a random number + } + return res; +} int HCIClass::getLTK(uint8_t* address, uint8_t* LTK){ if(_getLTK!=0){ return _getLTK(address, LTK); diff --git a/src/utility/HCI.h b/src/utility/HCI.h index 71213349..75e9ff99 100644 --- a/src/utility/HCI.h +++ b/src/utility/HCI.h @@ -110,7 +110,7 @@ class HCIClass { virtual void writeLK(uint8_t peerAddress[], uint8_t LK[]); virtual int tryResolveAddress(uint8_t* BDAddr, uint8_t* address); - virtual int sendAclPkt(uint16_t handle, uint8_t cid, uint8_t plen, void* data); + virtual int sendAclPkt(uint16_t handle, uint8_t cid, uint8_t plen, const void* data); virtual int disconnect(uint16_t handle); @@ -129,7 +129,7 @@ class HCIClass { void (*_displayCode)(uint32_t confirmationCode) = 0; bool (*_binaryConfirmPairing)() = 0; - virtual int sendCommand(uint16_t opcode, uint8_t plen = 0, void* parameters = NULL); + virtual int sendCommand(uint16_t opcode, uint8_t plen = 0, const void* parameters = nullptr); uint8_t remotePublicKeyBuffer[64]; uint8_t localPublicKeyBuffer[64]; uint8_t remoteDHKeyCheckBuffer[16]; diff --git a/src/utility/L2CAPSignaling.cpp b/src/utility/L2CAPSignaling.cpp index 7af170df..4e5586c6 100644 --- a/src/utility/L2CAPSignaling.cpp +++ b/src/utility/L2CAPSignaling.cpp @@ -230,9 +230,9 @@ void L2CAPSignalingClass::handleSecurityData(uint16_t connectionHandle, uint8_t Serial.print("V : "); btct.printBytes(V,32); Serial.print("X : "); - btct.printBytes(X,16); + btct.printBytes(HCI.Na,16); Serial.print("Y : "); - btct.printBytes(Y,16); + btct.printBytes(HCI.Nb,16); Serial.print("g2res : "); btct.printBytes(g2Result,4); Serial.print("Result : "); From 04e020431f54509ed097c652d373b2cf08e7f8e7 Mon Sep 17 00:00:00 2001 From: AresMaster Date: Wed, 18 Oct 2023 21:53:46 +0200 Subject: [PATCH 80/83] Temporary fix for device pairing --- src/local/BLELocalDevice.h | 2 +- src/utility/ATT.h | 3 ++- src/utility/L2CAPSignaling.cpp | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/src/local/BLELocalDevice.h b/src/local/BLELocalDevice.h index dd114eb4..adc1be8e 100644 --- a/src/local/BLELocalDevice.h +++ b/src/local/BLELocalDevice.h @@ -37,7 +37,7 @@ enum Pairable { class BLELocalDevice { public: - BLELocalDevice(HCITransportInterface *HCITransport, uint8_t ownBdaddrType = STATIC_RANDOM_ADDR); + BLELocalDevice(HCITransportInterface *HCITransport, uint8_t ownBdaddrType = PUBLIC_ADDR); virtual ~BLELocalDevice(); virtual int begin(); diff --git a/src/utility/ATT.h b/src/utility/ATT.h index e061a68b..d2ca2d13 100644 --- a/src/utility/ATT.h +++ b/src/utility/ATT.h @@ -111,6 +111,8 @@ class ATTClass { uint8_t localIRK[16] = {0x54,0x83,0x63,0x7c,0xc5,0x1e,0xf7,0xec,0x32,0xdd,0xad,0x51,0x89,0x4b,0x9e,0x07}; void setOwnBdaddrType(uint8_t ownBdaddrType); + + uint8_t _ownBdaddrType; private: virtual void error(uint16_t connectionHandle, uint8_t dlen, uint8_t data[]); @@ -174,7 +176,6 @@ class ATTClass { BLEDeviceEventHandler _eventHandlers[2]; - uint8_t _ownBdaddrType; }; extern ATTClass& ATT; diff --git a/src/utility/L2CAPSignaling.cpp b/src/utility/L2CAPSignaling.cpp index 4e5586c6..1ba41687 100644 --- a/src/utility/L2CAPSignaling.cpp +++ b/src/utility/L2CAPSignaling.cpp @@ -372,7 +372,7 @@ void L2CAPSignalingClass::smCalculateLTKandConfirm(uint16_t handle, uint8_t expe HCI.readBdAddr(); memcpy(&localAddress[1],HCI.localAddr,6); - localAddress[0] = 0; // IOT 33 uses a static address // TODO: confirm for Nano BLE + localAddress[0] = ATT._ownBdaddrType; // IOT 33 uses a static address // TODO: confirm for Nano BLE // Compute the LTK and MacKey uint8_t MacKey[16]; From ea200811684929921e03148a9aa5e6665d56ec8b Mon Sep 17 00:00:00 2001 From: Arkadiusz Ambroziak Date: Thu, 19 Oct 2023 13:53:47 +0200 Subject: [PATCH 81/83] Fixes for pairing with Static Random Address --- src/STM32duinoBLE.h | 5 - src/local/BLELocalDevice.cpp | 28 +++-- src/utility/ATT.h | 4 +- src/utility/HCIVirtualTransport.cpp | 142 -------------------------- src/utility/HCIVirtualTransport.h | 50 --------- src/utility/HCIVirtualTransportAT.cpp | 112 -------------------- src/utility/HCIVirtualTransportAT.h | 42 -------- src/utility/L2CAPSignaling.cpp | 7 +- 8 files changed, 26 insertions(+), 364 deletions(-) delete mode 100644 src/utility/HCIVirtualTransport.cpp delete mode 100644 src/utility/HCIVirtualTransport.h delete mode 100644 src/utility/HCIVirtualTransportAT.cpp delete mode 100644 src/utility/HCIVirtualTransportAT.h diff --git a/src/STM32duinoBLE.h b/src/STM32duinoBLE.h index 8a01588f..4ad826bc 100644 --- a/src/STM32duinoBLE.h +++ b/src/STM32duinoBLE.h @@ -31,9 +31,4 @@ #endif #include "utility/HCISpiTransport.h" -#if defined(STM32WBxx) -#include "utility/HCISharedMemTransport.h" -#endif -#include "utility/HCISpiTransport.h" - #endif diff --git a/src/local/BLELocalDevice.cpp b/src/local/BLELocalDevice.cpp index d4171576..e1a17143 100644 --- a/src/local/BLELocalDevice.cpp +++ b/src/local/BLELocalDevice.cpp @@ -51,15 +51,15 @@ int BLELocalDevice::begin() return 0; } - uint8_t randomNumber[8] = {0x00,0x80,0xe1,0x27,0xa3,0x30,0,0}; - /*if (HCI.leRand(randomNumber) != 0) { + uint8_t randomNumber[8]; + if (HCI.leRand(randomNumber) != 0) { end(); return 0; - }*/ + } /* Random address only requires 6 bytes (48 bits) * Force both MSB bits to b00 in order to define Static Random Address */ - //randomNumber[5] |= 0xC0; + randomNumber[5] |= 0xC0; // Copy the random address in private variable as it will be sent to the BLE chip randomAddress [0] = randomNumber[0]; @@ -68,11 +68,19 @@ int BLELocalDevice::begin() randomAddress [3] = randomNumber[3]; randomAddress [4] = randomNumber[4]; randomAddress [5] = randomNumber[5]; - - if (HCI.leSetRandomAddress((uint8_t*)randomNumber) != 0) { + // @note Set Random address only when type is STATIC_RANDOM_ADDR + if (HCI.leSetRandomAddress((uint8_t*)randomNumber) != 0 && _ownBdaddrType == STATIC_RANDOM_ADDR) { end(); return 0; } + // @note Save address to HCI.localaddress variable, which is used to encryption in pairing + if(_ownBdaddrType == PUBLIC_ADDR){ + HCI.readBdAddr(); + }else{ + for(int k=0; k<6; k++){ + HCI.localAddr[5-k] = randomAddress[k]; + } + } uint8_t hciVer; uint16_t hciRev; @@ -216,7 +224,13 @@ bool BLELocalDevice::disconnect() String BLELocalDevice::address() const { uint8_t addr[6] = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }; - HCI.readBdAddr(addr); + // @note return correct device address when is set to STATIC RANDOM (set by HCI) + if(_ownBdaddrType==PUBLIC_ADDR) + HCI.readBdAddr(addr); + else + for(int k=0; k<6; k++){ + addr[k]=HCI.localAddr[5-k]; + } char result[18]; sprintf(result, "%02x:%02x:%02x:%02x:%02x:%02x", addr[5], addr[4], addr[3], addr[2], addr[1], addr[0]); diff --git a/src/utility/ATT.h b/src/utility/ATT.h index e061a68b..0067d45a 100644 --- a/src/utility/ATT.h +++ b/src/utility/ATT.h @@ -111,7 +111,7 @@ class ATTClass { uint8_t localIRK[16] = {0x54,0x83,0x63,0x7c,0xc5,0x1e,0xf7,0xec,0x32,0xdd,0xad,0x51,0x89,0x4b,0x9e,0x07}; void setOwnBdaddrType(uint8_t ownBdaddrType); - + uint8_t _ownBdaddrType; //@note Used in L2CAPSignaling to encryption private: virtual void error(uint16_t connectionHandle, uint8_t dlen, uint8_t data[]); virtual void mtuReq(uint16_t connectionHandle, uint8_t dlen, uint8_t data[]); @@ -173,8 +173,6 @@ class ATTClass { } _pendingResp; BLEDeviceEventHandler _eventHandlers[2]; - - uint8_t _ownBdaddrType; }; extern ATTClass& ATT; diff --git a/src/utility/HCIVirtualTransport.cpp b/src/utility/HCIVirtualTransport.cpp deleted file mode 100644 index 046a0e72..00000000 --- a/src/utility/HCIVirtualTransport.cpp +++ /dev/null @@ -1,142 +0,0 @@ -/* - This file is part of the ArduinoBLE library. - Copyright (c) 2018 Arduino SA. All rights reserved. - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -*/ - -#if defined(ESP32) - -#include "HCIVirtualTransport.h" - -StreamBufferHandle_t rec_buffer; -StreamBufferHandle_t send_buffer; -TaskHandle_t bleHandle; - - -static void notify_host_send_available(void) -{ -} - -static int notify_host_recv(uint8_t *data, uint16_t length) -{ - xStreamBufferSend(rec_buffer,data,length,portMAX_DELAY); // !!!potentially waiting forever - return 0; -} - -static esp_vhci_host_callback_t vhci_host_cb = { - notify_host_send_available, - notify_host_recv -}; - -void bleTask(void *pvParameters) -{ - esp_vhci_host_register_callback(&vhci_host_cb); - size_t length; - uint8_t mybuf[258]; - - while(true){ - length = xStreamBufferReceive(send_buffer,mybuf,258,portMAX_DELAY); - while (!esp_vhci_host_check_send_available()) {} - esp_vhci_host_send_packet(mybuf, length); - } -} - - -HCIVirtualTransportClass::HCIVirtualTransportClass() -{ -} - -HCIVirtualTransportClass::~HCIVirtualTransportClass() -{ -} - -int HCIVirtualTransportClass::begin() -{ - btStarted(); // this somehow stops the arduino ide from initializing bluedroid - - rec_buffer = xStreamBufferCreate(258, 1); - send_buffer = xStreamBufferCreate(258, 1); - - esp_err_t ret = nvs_flash_init(); - if (ret == ESP_ERR_NVS_NO_FREE_PAGES || ret == ESP_ERR_NVS_NEW_VERSION_FOUND) { - ESP_ERROR_CHECK(nvs_flash_erase()); - ret = nvs_flash_init(); - } - esp_bt_controller_config_t bt_cfg = BT_CONTROLLER_INIT_CONFIG_DEFAULT(); - -#if CONFIG_IDF_TARGET_ESP32 - bt_cfg.mode = ESP_BT_MODE_BLE; //original esp32 chip -#else - bt_cfg.bluetooth_mode = ESP_BT_MODE_BLE; //different api for newer models -#endif - - esp_bt_controller_mem_release(ESP_BT_MODE_CLASSIC_BT); - esp_bt_controller_init(&bt_cfg); - esp_bt_controller_enable(ESP_BT_MODE_BLE); - xTaskCreatePinnedToCore(&bleTask, "bleTask", 2048, NULL, 5, &bleHandle, 0); - return 1; -} - -void HCIVirtualTransportClass::end() -{ - vStreamBufferDelete(rec_buffer); - vStreamBufferDelete(send_buffer); - esp_bt_controller_disable(); - esp_bt_controller_deinit(); - vTaskDelete(bleHandle); -} - -void HCIVirtualTransportClass::wait(unsigned long timeout) -{ - for (unsigned long start = (esp_timer_get_time() / 1000ULL); ((esp_timer_get_time() / 1000ULL) - start) < timeout;) { - if (available()) { - break; - } - } -} - -int HCIVirtualTransportClass::available() -{ - size_t bytes = xStreamBufferBytesAvailable(rec_buffer); - return bytes; -} - -// never called -int HCIVirtualTransportClass::peek() -{ - return -1; -} - -int HCIVirtualTransportClass::read() -{ - uint8_t c; - if(xStreamBufferReceive(rec_buffer, &c, 1, portMAX_DELAY)) { - return c; - } - return -1; -} - -size_t HCIVirtualTransportClass::write(const uint8_t* data, size_t length) -{ - size_t result = xStreamBufferSend(send_buffer,data,length,portMAX_DELAY); - return result; -} - -HCIVirtualTransportClass HCIVirtualTransport; - -HCITransportInterface& HCITransport = HCIVirtualTransport; - -#endif diff --git a/src/utility/HCIVirtualTransport.h b/src/utility/HCIVirtualTransport.h deleted file mode 100644 index 0da43cac..00000000 --- a/src/utility/HCIVirtualTransport.h +++ /dev/null @@ -1,50 +0,0 @@ -/* - This file is part of the ArduinoBLE library. - Copyright (c) 2018 Arduino SA. All rights reserved. - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -*/ - -#include "HCITransport.h" -#include -#include -#include - -#include "freertos/FreeRTOS.h" -#include "freertos/task.h" -#include "freertos/stream_buffer.h" - -#include "esp_bt.h" -#include "nvs_flash.h" - -#include "esp32-hal-bt.h" // this is needed to disable bluedroid - - -class HCIVirtualTransportClass : public HCITransportInterface { -public: - HCIVirtualTransportClass(); - virtual ~HCIVirtualTransportClass(); - - virtual int begin(); - virtual void end(); - - virtual void wait(unsigned long timeout); - - virtual int available(); - virtual int peek(); - virtual int read(); - - virtual size_t write(const uint8_t* data, size_t length); -}; \ No newline at end of file diff --git a/src/utility/HCIVirtualTransportAT.cpp b/src/utility/HCIVirtualTransportAT.cpp deleted file mode 100644 index 7b3a24a9..00000000 --- a/src/utility/HCIVirtualTransportAT.cpp +++ /dev/null @@ -1,112 +0,0 @@ -/* - This file is part of the ArduinoBLE library. - Copyright (c) 2018 Arduino SA. All rights reserved. - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -*/ - -#if defined(ARDUINO_UNOR4_WIFI) - -#include "HCIVirtualTransportAT.h" - -extern ModemClass modem; - -HCIVirtualTransportATClass::HCIVirtualTransportATClass() -{ -} - -HCIVirtualTransportATClass::~HCIVirtualTransportATClass() -{ -} - -static RingBufferN<258> buf; - -int HCIVirtualTransportATClass::begin() -{ - // TODO: add this helper - //modem.debug(Serial); - buf.clear(); - //modem.debug(true); - std::string res = ""; - modem.begin(); - if (modem.write(std::string(PROMPT(_HCI_BEGIN)), res, CMD(_HCI_BEGIN))) { - return 1; - } - return 0; -} - -void HCIVirtualTransportATClass::end() -{ -} - -void HCIVirtualTransportATClass::wait(unsigned long timeout) -{ - std::string res = ""; - modem.write(std::string(PROMPT(_HCI_WAIT)), res, "%d\n\r", CMD_WRITE(_HCI_WAIT), timeout); -} - -int HCIVirtualTransportATClass::available() -{ - std::string res = ""; - if (buf.available()) { - return buf.available(); - } - if (modem.write(std::string(PROMPT(_HCI_AVAILABLE)), res, CMD_READ(_HCI_AVAILABLE))) { - return atoi(res.c_str()); - } - - return 0; -} - -// never called -int HCIVirtualTransportATClass::peek() -{ - return -1; -} - -int HCIVirtualTransportATClass::read() -{ - uint8_t c; - std::string res = ""; - if (buf.available()) { - return buf.read_char(); - } - modem.avoid_trim_results(); - modem.read_using_size(); - if (modem.write(std::string(PROMPT(_HCI_READ)), res, CMD(_HCI_READ))) { - for(int i = 0; i < res.size(); i++) { - buf.store_char((uint8_t)res[i]); - } - return buf.read_char(); - } - - return -1; -} - -size_t HCIVirtualTransportATClass::write(const uint8_t* data, size_t length) -{ - std::string res = ""; - modem.write_nowait(std::string(PROMPT(_HCI_WRITE)), res, "%s%d\r\n" , CMD_WRITE(_HCI_WRITE), length); - if(modem.passthrough(data, length)) { - return length; - } - return 0; -} - -HCIVirtualTransportATClass HCIVirtualTransportAT; - -HCITransportInterface& HCITransport = HCIVirtualTransportAT; - -#endif diff --git a/src/utility/HCIVirtualTransportAT.h b/src/utility/HCIVirtualTransportAT.h deleted file mode 100644 index 8e29801d..00000000 --- a/src/utility/HCIVirtualTransportAT.h +++ /dev/null @@ -1,42 +0,0 @@ -/* - This file is part of the ArduinoBLE library. - Copyright (c) 2018 Arduino SA. All rights reserved. - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA -*/ - -#include "HCITransport.h" -#include -#include -#include - -#include "WiFiS3.h" - -class HCIVirtualTransportATClass : public HCITransportInterface { -public: - HCIVirtualTransportATClass(); - virtual ~HCIVirtualTransportATClass(); - - virtual int begin(); - virtual void end(); - - virtual void wait(unsigned long timeout); - - virtual int available(); - virtual int peek(); - virtual int read(); - - virtual size_t write(const uint8_t* data, size_t length); -}; \ No newline at end of file diff --git a/src/utility/L2CAPSignaling.cpp b/src/utility/L2CAPSignaling.cpp index 4e5586c6..fbdcd5cd 100644 --- a/src/utility/L2CAPSignaling.cpp +++ b/src/utility/L2CAPSignaling.cpp @@ -369,10 +369,11 @@ void L2CAPSignalingClass::smCalculateLTKandConfirm(uint16_t handle, uint8_t expe uint8_t localAddress[7]; uint8_t remoteAddress[7]; ATT.getPeerAddrWithType(handle, remoteAddress); - - HCI.readBdAddr(); + // @note Address is taken directly from HCI.localaddress, + // which is set when object DeviceLocal is created + //HCI.readBdAddr(); memcpy(&localAddress[1],HCI.localAddr,6); - localAddress[0] = 0; // IOT 33 uses a static address // TODO: confirm for Nano BLE + localAddress[0] = ATT._ownBdaddrType; //@note Adding bit with address type (e.g. Static random or public address) // Compute the LTK and MacKey uint8_t MacKey[16]; From 201973623dc538ddba236f408071b1e6c8f28bee Mon Sep 17 00:00:00 2001 From: Arkadiusz Ambroziak Date: Thu, 19 Oct 2023 14:10:46 +0200 Subject: [PATCH 82/83] Revert change in default address type --- src/local/BLELocalDevice.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/local/BLELocalDevice.h b/src/local/BLELocalDevice.h index adc1be8e..dd114eb4 100644 --- a/src/local/BLELocalDevice.h +++ b/src/local/BLELocalDevice.h @@ -37,7 +37,7 @@ enum Pairable { class BLELocalDevice { public: - BLELocalDevice(HCITransportInterface *HCITransport, uint8_t ownBdaddrType = PUBLIC_ADDR); + BLELocalDevice(HCITransportInterface *HCITransport, uint8_t ownBdaddrType = STATIC_RANDOM_ADDR); virtual ~BLELocalDevice(); virtual int begin(); From 81dd688843f9ae20913470cc272888b15414ed03 Mon Sep 17 00:00:00 2001 From: AresMaster Date: Tue, 31 Oct 2023 21:39:38 +0100 Subject: [PATCH 83/83] Deletion of unnecessary files --- .github/workflows/spell-check.yml | 16 - .gitignore | 2 - docs/api.md | 3859 ---------------------- docs/assets/ble-bulletin-board-model.png | Bin 41914 -> 0 bytes docs/readme.md | 91 - src/utility/GAP.cpp | 2 +- 6 files changed, 1 insertion(+), 3969 deletions(-) delete mode 100644 .github/workflows/spell-check.yml delete mode 100644 .gitignore delete mode 100644 docs/api.md delete mode 100644 docs/assets/ble-bulletin-board-model.png delete mode 100644 docs/readme.md diff --git a/.github/workflows/spell-check.yml b/.github/workflows/spell-check.yml deleted file mode 100644 index 94b57020..00000000 --- a/.github/workflows/spell-check.yml +++ /dev/null @@ -1,16 +0,0 @@ -name: Spell Check - -on: [push, pull_request] - -jobs: - build: - runs-on: ubuntu-latest - - steps: - - name: Checkout - uses: actions/checkout@v4 - - - name: Spell check - uses: arduino/actions/libraries/spell-check@master - with: - skip-paths: ./extras/test \ No newline at end of file diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 9bea4330..00000000 --- a/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ - -.DS_Store diff --git a/docs/api.md b/docs/api.md deleted file mode 100644 index 636fe52c..00000000 --- a/docs/api.md +++ /dev/null @@ -1,3859 +0,0 @@ -# ArduinoBLE library - -## BLE class - -Used to enable the Bluetooth® Low Energy module. - -### `BLE.begin()` - -Initializes the Bluetooth® Low Energy device. - -#### Syntax - -``` -BLE.begin() - -``` - -#### Parameters - -None - -#### Returns -- 1 on success -- 0 on failure - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - -``` - -### `BLE.end()` - -Stops the Bluetooth® Low Energy device. - -#### Syntax - -``` -BLE.end() - -``` - -#### Parameters - -None - -#### Returns -Nothing - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - // .... - - BLE.end(); - - -``` - -### `BLE.poll()` - -Poll for Bluetooth® Low Energy radio events and handle them. - -#### Syntax - -``` -BLE.poll() -BLE.poll(timeout) - -``` - -#### Parameters - -**timeout**: optional timeout in ms, to wait for event. If not specified defaults to 0 ms. - -#### Returns -Nothing - -#### Example - -```arduino - - // assign event handlers for connected, disconnected to peripheral - BLE.setEventHandler(BLEConnected, blePeripheralConnectHandler); - BLE.setEventHandler(BLEDisconnected, blePeripheralDisconnectHandler); - - - - BLE.poll(); - - -``` - -### `BLE.setEventHandler()` - -Set the event handler (callback) function that will be called when the specified event occurs. - -#### Syntax - -``` -BLE.setEventHandler(eventType, callback) - -``` - -#### Parameters - -- **eventType**: event type (BLEConnected, BLEDisconnected) -- **callback**: function to call when event occurs -#### Returns -Nothing. - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - // ... - - // assign event handlers for connected, disconnected to peripheral - BLE.setEventHandler(BLEConnected, blePeripheralConnectHandler); - BLE.setEventHandler(BLEDisconnected, blePeripheralDisconnectHandler); - - - - -void blePeripheralConnectHandler(BLEDevice central) { - // central connected event handler - Serial.print("Connected event, central: "); - Serial.println(central.address()); -} - -void blePeripheralDisconnectHandler(BLEDevice central) { - // central disconnected event handler - Serial.print("Disconnected event, central: "); - Serial.println(central.address()); -} - - -``` - -### `BLE.connected()` - -Query if another Bluetooth® Low Energy device is connected - -#### Syntax - -``` -BLE.connected() - -``` - -#### Parameters - -None - -#### Returns -- **true** if another Bluetooth® Low Energy device is connected, -- otherwise **false**. - -#### Example - -```arduino - - // while the central is still connected to peripheral: - while (BLE.connected()) { - - // ... - } - - -``` - -### `BLE.disconnect()` - -Disconnect any Bluetooth® Low Energy devices that are connected - -#### Syntax - -``` -BLE.disconnect() - -``` - -#### Parameters - -None - -#### Returns -- **true** if any Bluetooth® Low Energy device that was previously connected was disconnected, -- otherwise **false**. - -#### Example - -```arduino - - if (BLE.connected()) { - - - BLE.disconnect(); - } - - -``` - -### `BLE.address()` - -Query the Bluetooth® address of the Bluetooth® Low Energy device. - -#### Syntax - -``` -BLE.address() - -``` - -#### Parameters - -None - -#### Returns -- The **Bluetooth® address** of the Bluetooth® Low Energy device (as a String). - -#### Example - -```arduino - - **String** address = BLE.address(); - - Serial.print(“Local address is: “); - Serial.println(address); - - -``` - -### `BLE.rssi()` - -Query the RSSI (Received signal strength indication) of the connected Bluetooth® Low Energy device. - -#### Syntax - -``` -BLE.rssi() - -``` - -#### Parameters - -None - -#### Returns -- The **RSSI** of the connected Bluetooth® Low Energy device, 127 if no Bluetooth® Low Energy device is connected. - -#### Example - -```arduino - - if (BLE.connected()) { - - - Serial.print(“RSSI = “); - Serial.println(BLE.rssi()); - } - - -``` - -### `BLE.setAdvertisedServiceUuid()` - -Set the advertised service UUID used when advertising. - -#### Syntax - -``` -BLE.setAdvertisedServiceUuid(uuid) - -``` - -#### Parameters - -- **uuid:** 16-bit or 128-bit Bluetooth® Low Energy UUID in **String** format - -#### Returns -Nothing - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - BLE.setAdvertisedServiceUuid(“19B10000-E8F2-537E-4F6C-D104768A1214"); - - // ... - - // start advertising - BLE.advertise(); - - -``` - -### `BLE.setAdvertisedService()` - -Set the advertised service UUID used when advertising to the value of the BLEService provided. - -#### Syntax - -``` -BLE.setAdvertisedService(bleService) - -``` - -#### Parameters - -- **bleService:** BLEService to use UUID from - -#### Returns -Nothing - -#### Example - -```arduino - -BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // Bluetooth® Low Energy LED Service - -// ... - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - BLE.setAdvertisedService(ledService); - - // ... - - // start advertising - BLE.advertise(); - - -``` - -### `BLE.setManufacturerData()` - -Set the manufacturer data value used when advertising. - -#### Syntax - -``` -BLE.setManufacturerData(data, length) - -``` - -#### Parameters - -- **data:** byte array containing manufacturer data -- **length:** length of manufacturer data array - -#### Returns -Nothing - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - byte data[5] = { 0x01, 0x02, 0x03, 0x04, 0x05}; - - BLE.setManufacturerData(data, 5); - - // ... - - // start advertising - BLE.advertise(); - - - -``` - -### `BLE.setLocalName()` - -Set the local value used when advertising. - -#### Syntax - -``` -BLE.setLocalName(name) - -``` - -#### Parameters - -- **name:** local name value to use when advertising - -#### Returns -Nothing - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - BLE.setLocalName("LED"); - - // ... - - // start advertising - BLE.advertise(); - - - -``` - -### `BLE.setDeviceName()` - -Set the device name in the built in device name characteristic. If not set, the value defaults “Arduino”. - -#### Syntax - -``` -BLE.setDeviceName(name) - -``` - -#### Parameters - -- **name:** device name value - -#### Returns -Nothing - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - BLE.setDeviceName("LED"); - - // ... - - // start advertising - BLE.advertise(); - - - -``` - -### `BLE.setAppearance()` - -Set the appearance in the built in appearance characteristic. If not set, the value defaults 0x0000. - -#### Syntax - -``` -BLE.setAppearance(appearance) - -``` - -#### Parameters - -- **appearance:** appearance value - -#### Returns -Nothing - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - BLE.setAppearance(0x8000); - - // ... - - // start advertising - BLE.advertise(); - - - -``` - -### `BLE.addService()` - -Add a BLEService to the set of services the Bluetooth® Low Energy device provides - -#### Syntax - -``` -BLE.addService(service) - -``` - -#### Parameters - -- **service:** BLEService to add - -#### Returns -Nothing - -#### Example - -```arduino - -BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // Bluetooth® Low Energy LED Service - - - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - // ... - - BLE.addService(ledService); - - // ... - - -``` - -### `BLE.advertise()` - -Start advertising. - -#### Syntax - -``` -BLE.advertise() - -``` - -#### Parameters - -None - -#### Returns -- 1 on success, -- 0 on failure. - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - // ... - - BLE.advertise(); - - // ... - - -``` - -### `BLE.stopAdvertise()` - -Stop advertising. - -#### Syntax - -``` -BLE.stopAdvertise() - -``` - -#### Parameters - -None - -#### Returns -Nothing - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - // ... - - BLE.advertise(); - - // ... - - BLE.stopAdvertise(); - - -``` - -### `BLE.central()` - -Query the central Bluetooth® Low Energy device connected. - -#### Syntax - -``` -BLE.central() - -``` - -#### Parameters - -None - -#### Returns -- **BLEDevice** representing the central. - -#### Example - -```arduino - - // listen for Bluetooth® Low Energy peripherals to connect: - BLEDevice central = BLE.central(); - - // if a central is connected to peripheral: - if (central) { - Serial.print("Connected to central: "); - // print the central's MAC address: - Serial.println(central.address()); - - - } - - -``` - -### `BLE.setAdvertisingInterval()` - -Set the advertising interval in units of 0.625 ms. Defaults to 100ms (160 * 0.625 ms) if not provided. - -#### Syntax - -``` -BLE.setAdvertisingInterval(advertisingInterval) - -``` - -#### Parameters - -- **advertisingInterval:** advertising interval in units of 0.625 ms - -#### Returns -Nothing. - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - // ... - - BLE.setAdvertisingInterval(320); // 200 * 0.625 ms - - BLE.advertise(); - - -``` - -### `BLE.setConnectionInterval()` - -Set the minimum and maximum desired connection intervals in units of 1.25 ms. - -#### Syntax - -``` -BLE.setConnectionInterval(minimum, maximum) - -``` - -#### Parameters - -- **minimum:** minimum desired connection interval in units of 1.25 ms -- **maximum:** maximum desired connection interval in units of 1.25 ms - -#### Returns -Nothing. - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - // ... - - BLE.setConnectionInterval(0x0006, 0x0c80); // 7.5 ms minimum, 4 s maximum - - - -``` - -### `BLE.setConnectable()` - -Set if the device is connectable after advertising, defaults to **true**. - -#### Syntax - -``` -BLE.setConnectable(connectable) - -``` - -#### Parameters - -- **true**: the device will be connectable when advertising -- **false**: the device will NOT be connectable when advertising - -#### Returns -Nothing. - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - // ... - - BLE.setConnectable(false); // make the device unconnectable when advertising - - - -``` - -### `BLE.scan()` - -Start scanning for Bluetooth® Low Energy devices that are advertising. - -#### Syntax - -``` -BLE.scan() -BLE.scan(withDuplicates) - -``` - -#### Parameters - -- **withDuplicates:** optional, defaults to **false**. If **true**, advertisements received more than once will not be filtered - -#### Returns -- 1 on success, -- 0 on failure. - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - Serial.println("BLE Central scan"); - - // start scanning for peripheral - BLE.scan(); - - - - BLEDevice peripheral = BLE.available(); - - if (peripheral) { - // ... - } - - -``` - -### `BLE.scanForName()` - -Start scanning for Bluetooth® Low Energy devices that are advertising with a particular (local) name. - -#### Syntax - -``` -BLE.scanForName(name) -BLE.scanForName(name, withDuplicates) - -``` - -#### Parameters - -- **name:** (local) name of device (as a **String**) to filter for -- **withDuplicates:** optional, defaults to **false**. If **true**, advertisements received more than once will not be filtered. - -#### Returns -- 1 on success, -- 0 on failure. - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - Serial.println("BLE Central scan"); - - // start scanning for peripheral - BLE.scanForName("LED"); - - - - BLEDevice peripheral = BLE.available(); - - if (peripheral) { - // ... - } - - -``` - -### `BLE.scanForAddress()` - -Start scanning for Bluetooth® Low Energy devices that are advertising with a particular (Bluetooth®) address. - -#### Syntax - -``` -BLE.scanForAddress(address) -BLE.scanForAddress(address, withDuplicates) - -``` - -#### Parameters - -- **address:** (Bluetooth®) address (as a String) to filter for -- **withDuplicates:** optional, defaults to **false**. If **true**, advertisements received more than once will not be filtered - -#### Returns -- 1 on success, -- 0 on failure. - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - Serial.println("BLE Central scan"); - - // start scanning for peripheral - BLE.scanForAddress("aa:bb:cc:ee:dd:ff"); - - - - BLEDevice peripheral = BLE.available(); - - if (peripheral) { - // ... - } - - -``` - -### `BLE.scanForUuid()` - -Start scanning for Bluetooth® Low Energy devices that are advertising with a particular (service) UUID. - -#### Syntax - -``` -BLE.scanForUuid(uuid) -BLE.scanForUuid(uuid, withDuplicates) - -``` - -#### Parameters - -- **uuid:** (service) UUID (as a **String**) to filter for -- **withDuplicates:** optional, defaults to **false**. If **true**, advertisements received more than once will not be filtered. - -#### Returns -- 1 on success, -- 0 on failure. - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - Serial.println("BLE Central scan"); - - // start scanning for peripheral - BLE.scanForUuid("aa10"); - - - - BLEDevice peripheral = BLE.available(); - - if (peripheral) { - // ... - } - - -``` - -### `BLE.stopScan()` - -Stop scanning for Bluetooth® Low Energy devices that are advertising. - -#### Syntax - -``` -BLE.stopScan() - -``` - -#### Parameters - -None - -#### Returns -Nothing - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - Serial.println("BLE Central scan"); - - // start scanning for peripheral - BLE.scan(); - - - BLE.stopScan(); - - -``` - -### `BLE.available()` - -Query for a discovered Bluetooth® Low Energy device that was found during scanning. - -#### Syntax - -``` -BLE.available() - -``` - -#### Parameters - -Nothing - -#### Returns -- **BLEDevice** representing the discovered device. - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - Serial.println("BLE Central scan"); - - // start scanning for peripheral - BLE.scan(); - - - - BLEDevice peripheral = BLE.available(); - - if (peripheral) { - // ... - } - - -``` - -## BLEDevice Class - -Used to get information about the devices connected or discovered while scanning - -### `bleDevice.poll()` - -Poll for Bluetooth® Low Energy radio events for the specified Bluetooth® Low Energy device and handle them. - -#### Syntax - -``` -bleDevice.poll() -bleDevice.poll(timeout) - -``` - -#### Parameters - -- **timeout**: optional timeout in ms, to wait for event. If not specified defaults to 0 ms. - -#### Returns -Nothing - -#### Example - -```arduino - - // listen for Bluetooth® Low Energy centrals to connect: - BLEDevice central = BLE.central(); - - // if a central is connected to peripheral: - if (central) { - - - central.poll(); - - // ... - } - - -``` - -### `bleDevice.connected()` - -Query if a Bluetooth® Low Energy device is connected - -#### Syntax - -``` -bleDevice.connected() - -``` - -#### Parameters - -None - -#### Returns -- **true** if the Bluetooth® Low Energy device is connected, -- otherwise **false**. - -#### Example - -```arduino - - // listen for Bluetooth® Low Energy centrals to connect: - BLEDevice central = BLE.central(); - - // while the central is still connected - while (central.connected()) { - - // ... - } - - -``` - -### `bleDevice.disconnect()` - -Disconnect the Bluetooth® Low Energy device, if connected - -#### Syntax - -``` -bleDevice.disconnect() - -``` - -#### Parameters - -None - -#### Returns -- **true** if the Bluetooth® Low Energy device was disconnected, -- otherwise **false**. - -#### Example - -```arduino - - // listen for Bluetooth® Low Energy centrals to connect: - BLEDevice central = BLE.central(); - - - - central.disconnect(); - - -``` - -### `bleDevice.address()` - -Query the Bluetooth® address of the Bluetooth® Low Energy device. - -#### Syntax - -``` -bleDevice.address() - -``` - -#### Parameters - -None - -#### Returns -- **Bluetooth® address** of the Bluetooth® Low Energy device (as a String). - -#### Example - -```arduino - - // listen for Bluetooth® Low Energy peripherals to connect: - BLEDevice central = BLE.central(); - - // if a central is connected to peripheral: - if (central) { - Serial.print("Connected to central: "); - // print the central's MAC address: - Serial.println(central.address()); - - . - } - - -``` - -### `bleDevice.rssi()` - -Query the RSSI (Received signal strength indication) of the Bluetooth® Low Energy device. - -#### Syntax - -``` -bleDevice.rssi() - -``` - -#### Parameters - -None - -#### Returns -- **RSSI** of the connected Bluetooth® Low Energy device, 127 if the Bluetooth® Low Energy device is not connected. - -#### Example - -```arduino - - if (bleDevice.connected()) { - - - Serial.print(“RSSI = “); - Serial.println(bleDevice.rssi()); - } - - -``` - -### `bleDevice.characteristic()` - -Get a BLECharacteristic representing a Bluetooth® Low Energy characteristic the device provides. - -#### Syntax - -``` -bleDevice.characteristic(index) -bleDevice.characteristic(uuid) -bleDevice.characteristic(uuid, index) - -``` - -#### Parameters - -- **index**: index of characteristic -- **uuid**: uuid (as a **String**) - -#### Returns -- **BLECharacteristic** for provided parameters - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - Serial.println("BLE Central scan"); - - // start scanning for peripheral - BLE.scan(); - - - - BLEDevice peripheral = BLE.available(); - - if (peripheral) { - // ... - - Serial.println("Connecting ..."); - - if (peripheral.connect()) { - Serial.println("Connected"); - } else { - Serial.println("Failed to connect!"); - return; - } - - // discover peripheral attributes - Serial.println("Discovering attributes ..."); - if (peripheral.discoverAttributes()) { - Serial.println("Attributes discovered"); - } else { - Serial.println("Attribute discovery failed!"); - peripheral.disconnect(); - return; - } - - BLECharacteristic batteryLevelCharacterisic = peripheral.characteristic("2a19"); - - if (batteryLevelCharacterisic) { - // use the characteristic - } else { - Serial.println("Peripheral does NOT have battery level characteristic"); - } - - // ... - } - - -``` - -### `bleDevice.discoverAttributes()` - -Discover all of the attributes of Bluetooth® Low Energy device. - -#### Syntax - -``` -bleDevice.discoverAttributes() - -``` - -#### Parameters - -None - -#### Returns -- **true**, if successful, -- **false** on failure. - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - Serial.println("BLE Central scan"); - - // start scanning for peripheral - BLE.scan(); - - - - BLEDevice peripheral = BLE.available(); - - if (peripheral) { - // ... - - Serial.println("Connecting ..."); - - if (peripheral.connect()) { - Serial.println("Connected"); - } else { - Serial.println("Failed to connect!"); - return; - } - - // discover peripheral attributes - Serial.println("Discovering attributes ..."); - if (peripheral.discoverAttributes()) { - Serial.println("Attributes discovered"); - } else { - Serial.println("Attribute discovery failed!"); - peripheral.disconnect(); - return; - } - - // ... - } - - -``` - -### `bleDevice.discoverService()` - -Discover the attributes of a particular service on the Bluetooth® Low Energy device. - -#### Syntax - -``` -bleDevice.discoverService(serviceUuid) - -``` - -#### Parameters - -- **serviceUuid:** service UUID to discover (as a **String**) - -#### Returns -- **true**, if successful, -- **false** on failure. - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - Serial.println("BLE Central scan"); - - // start scanning for peripheral - BLE.scan(); - - - - BLEDevice peripheral = BLE.available(); - - if (peripheral) { - // ... - - Serial.println("Connecting ..."); - - if (peripheral.connect()) { - Serial.println("Connected"); - } else { - Serial.println("Failed to connect!"); - return; - } - - // discover service attributes - Serial.println("Discovering service attributes ..."); - if (peripheral.serviceUuid("fffe")) { - Serial.println("Service attributes discovered"); - } else { - Serial.println("Service attribute discovery failed!"); - peripheral.disconnect(); - return; - } - - // ... - } - - -``` - -### `bleDevice.deviceName()` - -Query the device name (BLE characteristic UUID 0x2a00) of a Bluetooth® Low Energy device. - -#### Syntax - -``` -bleDevice.deviceName() - -``` - -#### Parameters - -None - -#### Returns -- **Device name** (as a String). - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - Serial.println("BLE Central scan"); - - // start scanning for peripheral - BLE.scan(); - - - - BLEDevice peripheral = BLE.available(); - - if (peripheral) { - // ... - - Serial.println("Connecting ..."); - - if (peripheral.connect()) { - Serial.println("Connected"); - } else { - Serial.println("Failed to connect!"); - return; - } - - // discover peripheral attributes - Serial.println("Discovering attributes ..."); - if (peripheral.discoverAttributes()) { - Serial.println("Attributes discovered"); - } else { - Serial.println("Attribute discovery failed!"); - peripheral.disconnect(); - return; - } - - // read and print device name of peripheral - Serial.println(); - Serial.print("Device name: "); - Serial.println(peripheral.deviceName()); - Serial.print("Appearance: 0x"); - Serial.println(peripheral.appearance(), HEX); - Serial.println(); - - // ... - } - - -``` - -### `bleDevice.appearance()` - -Query the appearance (BLE characteristic UUID 0x2a01) of a Bluetooth® Low Energy device. - -#### Syntax - -``` -bleDevice.appearance() - -``` - -#### Parameters - -None - -#### Returns -- **Appearance value** (as a number). - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - Serial.println("BLE Central scan"); - - // start scanning for peripheral - BLE.scan(); - - - - BLEDevice peripheral = BLE.available(); - - if (peripheral) { - // ... - - Serial.println("Connecting ..."); - - if (peripheral.connect()) { - Serial.println("Connected"); - } else { - Serial.println("Failed to connect!"); - return; - } - - // discover peripheral attributes - Serial.println("Discovering attributes ..."); - if (peripheral.discoverAttributes()) { - Serial.println("Attributes discovered"); - } else { - Serial.println("Attribute discovery failed!"); - peripheral.disconnect(); - return; - } - - // read and print device name of peripheral - Serial.println(); - Serial.print("Device name: "); - Serial.println(peripheral.deviceName()); - Serial.print("Appearance: 0x"); - Serial.println(peripheral.appearance(), HEX); - Serial.println(); - - // ... - } - - -``` - -### `bleDevice.serviceCount()` - -Query the number of services discovered for the Bluetooth® Low Energy device. - -#### Syntax - -``` -bleDevice.serviceCount() - -``` - -#### Parameters - -None - -#### Returns -- The number of **services discovered** for the Bluetooth® Low Energy device. - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - Serial.println("BLE Central scan"); - - // start scanning for peripheral - BLE.scan(); - - - - BLEDevice peripheral = BLE.available(); - - if (peripheral) { - // ... - - Serial.println("Connecting ..."); - - if (peripheral.connect()) { - Serial.println("Connected"); - } else { - Serial.println("Failed to connect!"); - return; - } - - // discover peripheral attributes - Serial.println("Discovering attributes ..."); - if (peripheral.discoverAttributes()) { - Serial.println("Attributes discovered"); - } else { - Serial.println("Attribute discovery failed!"); - peripheral.disconnect(); - return; - } - - int serviceCount = peripheral.serviceCount(); - - Serial.print(serviceCount); - Serial.println(" services discovered"); - - // ... - } - - -``` - -### `bleDevice.hasService()` - -Query if the Bluetooth® Low Energy device has a particular service. - -#### Syntax - -``` -bleDevice.hasService(uuid) -bleDevice.hasService(uuid, index) - -``` - -#### Parameters - -- **uuid**: uuid to check (as a **String**) -- **index**: optional, index of service to check if the device provides more than on. Defaults to 0, if not provided. - -#### Returns -- **true**, if the device provides the service, -- **false** otherwise. - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - Serial.println("BLE Central scan"); - - // start scanning for peripheral - BLE.scan(); - - - - BLEDevice peripheral = BLE.available(); - - if (peripheral) { - // ... - - Serial.println("Connecting ..."); - - if (peripheral.connect()) { - Serial.println("Connected"); - } else { - Serial.println("Failed to connect!"); - return; - } - - // discover peripheral attributes - Serial.println("Discovering attributes ..."); - if (peripheral.discoverAttributes()) { - Serial.println("Attributes discovered"); - } else { - Serial.println("Attribute discovery failed!"); - peripheral.disconnect(); - return; - } - - if (peripheral.hasService("180f")) { - Serial.println("Peripheral has battery service"); - } - - // ... - } - - -``` - -### `bleDevice.service()` - -Get a BLEService representing a Bluetooth® Low Energy service the device provides. - -#### Syntax - -``` -bleDevice.service(index) -bleDevice.service(uuid) -bleDevice.service(uuid, index) - -``` - -#### Parameters - -- **index**: index of service -- **uuid**: uuid (as a **String**) - -#### Returns -- **BLEService** for provided parameters - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - Serial.println("BLE Central scan"); - - // start scanning for peripheral - BLE.scan(); - - - - BLEDevice peripheral = BLE.available(); - - if (peripheral) { - // ... - - Serial.println("Connecting ..."); - - if (peripheral.connect()) { - Serial.println("Connected"); - } else { - Serial.println("Failed to connect!"); - return; - } - - // discover peripheral attributes - Serial.println("Discovering attributes ..."); - if (peripheral.discoverAttributes()) { - Serial.println("Attributes discovered"); - } else { - Serial.println("Attribute discovery failed!"); - peripheral.disconnect(); - return; - } - - BLEService batteryService = peripheral.service("180f"); - - if (batteryService) { - // use the service - } else { - Serial.println("Peripheral does NOT have battery service"); - } - - // ... - } - - -``` - -### `bleDevice.characteristicCount()` - -Query the number of characteristics discovered for the Bluetooth® Low Energy device. - -#### Syntax - -``` -bleDevice.characteristicCount() - -``` - -#### Parameters - -None - -#### Returns -- The **number of characteristics** discovered for the Bluetooth® Low Energy device. - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - Serial.println("BLE Central scan"); - - // start scanning for peripheral - BLE.scan(); - - - - BLEDevice peripheral = BLE.available(); - - if (peripheral) { - // ... - - Serial.println("Connecting ..."); - - if (peripheral.connect()) { - Serial.println("Connected"); - } else { - Serial.println("Failed to connect!"); - return; - } - - // discover peripheral attributes - Serial.println("Discovering attributes ..."); - if (peripheral.discoverAttributes()) { - Serial.println("Attributes discovered"); - } else { - Serial.println("Attribute discovery failed!"); - peripheral.disconnect(); - return; - } - - int characteristicCount = peripheral.characteristicCount(); - - Serial.print(characteristicCount); - Serial.println(" characteristis discovered"); - - // ... - } - - -``` - -### `bleDevice.hasCharacteristic()` - -Query if the Bluetooth® Low Energy device has a particular characteristic. - -#### Syntax - -``` -bleDevice.hasCharacteristic(uuid) -bleDevice.hasCharacteristic(uuid, index) - -``` - -#### Parameters - -- **uuid**: uuid to check (as a **String**) -- **index**: optional, index of characteristic to check if the device provides more than on. Defaults to 0, if not provided. - -#### Returns -- **true**, if the device provides the characteristic, -- **false** otherwise. - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - Serial.println("BLE Central scan"); - - // start scanning for peripheral - BLE.scan(); - - - - BLEDevice peripheral = BLE.available(); - - if (peripheral) { - // ... - - Serial.println("Connecting ..."); - - if (peripheral.connect()) { - Serial.println("Connected"); - } else { - Serial.println("Failed to connect!"); - return; - } - - // discover peripheral attributes - Serial.println("Discovering attributes ..."); - if (peripheral.discoverAttributes()) { - Serial.println("Attributes discovered"); - } else { - Serial.println("Attribute discovery failed!"); - peripheral.disconnect(); - return; - } - - if (peripheral.hasCharacteristic("2a19")) { - Serial.println("Peripheral has battery level characteristic"); - } - - // ... - } - - -``` - -### `bleDevice.hasLocalName()` - -Query if a discovered Bluetooth® Low Energy device is advertising a local name. - -#### Syntax - -``` -bleDevice.hasLocalName() - -``` - -#### Parameters - -Nothing - -#### Returns -- **true**, if the device is advertising a local name, -- **false** otherwise. - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - Serial.println("BLE Central scan"); - - // start scanning for peripheral - BLE.scan(); - - - - BLEDevice peripheral = BLE.available(); - - if (peripheral) { - // ... - - // print the local name, if present - if (peripheral.hasLocalName()) { - Serial.print("Local Name: "); - Serial.println(peripheral.localName()); - } - - // ... - } - - -``` - -### `bleDevice.hasAdvertisedServiceUuid()` - -Query if a discovered Bluetooth® Low Energy device is advertising a service UUID. - -#### Syntax - -``` -bleDevice.hasAdvertisedServiceUuid() -bleDevice.hasAdvertisedServiceUuid(index) - -``` - -#### Parameters - -- **index**: optional, defaults to 0, the index of the service UUID, if the device is advertising more than one. - -#### Returns -- **true**, if the device is advertising a service UUID, -- **false** otherwise. - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - Serial.println("BLE Central scan"); - - // start scanning for peripheral - BLE.scan(); - - - - BLEDevice peripheral = BLE.available(); - - if (peripheral) { - // ... - - // print the advertised service UUIDs, if present - if (peripheral.hasAdvertisedServiceUuid()) { - Serial.print("Service UUIDs: "); - for (int i = 0; i < peripheral.advertisedServiceUuidCount(); i++) { - Serial.print(peripheral.advertisedServiceUuid(i)); - Serial.print(" "); - } - Serial.println(); - } - - // ... - } - - -``` - -### `bleDevice.advertisedServiceUuidCount()` - -Query the number of advertised services a discovered Bluetooth® Low Energy device is advertising. - -#### Syntax - -``` -bleDevice.advertisedServiceUuidCount() - -``` - -#### Parameters - -None - -#### Returns -- The **number of advertised services** a discovered Bluetooth® Low Energy device is advertising. - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - Serial.println("BLE Central scan"); - - // start scanning for peripheral - BLE.scan(); - - - - BLEDevice peripheral = BLE.available(); - - if (peripheral) { - // ... - - // print the advertised service UUIDs, if present - if (peripheral.hasAdvertisedServiceUuid()) { - Serial.print("Service UUIDs: "); - for (int i = 0; i < peripheral.advertisedServiceUuidCount(); i++) { - Serial.print(peripheral.advertisedServiceUuid(i)); - Serial.print(" "); - } - Serial.println(); - } - - // ... - } - - -``` - -### `bleDevice.localName()` - -Query the local name a discovered Bluetooth® Low Energy device is advertising with. - -#### Syntax - -``` -bleDevice.localName() - -``` - -#### Parameters - -Nothing - -#### Returns -- **Advertised local name** (as a String). - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - Serial.println("BLE Central scan"); - - // start scanning for peripheral - BLE.scan(); - - - - BLEDevice peripheral = BLE.available(); - - if (peripheral) { - // ... - - // print the local name, if present - if (peripheral.hasLocalName()) { - Serial.print("Local Name: "); - Serial.println(peripheral.localName()); - } - - // ... - } - - -``` - -### `bleDevice.advertisedServiceUuid()` - -Query an advertised service UUID discovered Bluetooth® Low Energy device is advertising. - -#### Syntax - -``` -bleDevice.advertisedServiceUuid() -bleDevice.advertisedServiceUuid(index) - -``` - -#### Parameters - -- **index**: optional, defaults to 0, the index of the **service UUID**, if the device is advertising more than one. - -#### Returns -- Advertised service **UUID** (as a String). - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - Serial.println("BLE Central scan"); - - // start scanning for peripheral - BLE.scan(); - - - - BLEDevice peripheral = BLE.available(); - - if (peripheral) { - // ... - - // print the advertised service UUIDs, if present - if (peripheral.hasAdvertisedServiceUuid()) { - Serial.print("Service UUIDs: "); - for (int i = 0; i < peripheral.advertisedServiceUuidCount(); i++) { - Serial.print(peripheral.advertisedServiceUuid(i)); - Serial.print(" "); - } - Serial.println(); - } - - // ... - } - - -``` - -### `bleDevice.connect()` - -Connect to a Bluetooth® Low Energy device. - -#### Syntax - -``` -bleDevice.connect() - -``` - -#### Parameters - -None - -#### Returns -- **true**, if the connection was successful, -- **false** otherwise. - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - Serial.println("BLE Central scan"); - - // start scanning for peripheral - BLE.scan(); - - - - BLEDevice peripheral = BLE.available(); - - if (peripheral) { - // ... - - Serial.println("Connecting ..."); - - if (peripheral.connect()) { - Serial.println("Connected"); - } else { - Serial.println("Failed to connect!"); - return; - } - - // ... - } - - -``` - -## BLEService Class - -Used to enable the services board provides or interact with services a remote board provides. - -### `BLEService()` - -Create a new Bluetooth® Low Energy service. - -#### Syntax - -``` -BLEService(uuid) - -``` - -#### Parameters - -- **uuid**: 16-bit or 128-bit UUID in **String** format - -#### Returns -- New **BLEService** with the specified **UUID** - -#### Example - -```arduino - -BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // Bluetooth® Low Energy LED Service - - -``` - -### `bleService.uuid()` - -Query the UUID of the specified BLEService. - -#### Syntax - -``` -bleService.uuid() - -``` - -#### Parameters - -None - -#### Returns -- UUID of the Bluetooth® Low Energy service as a **String**. - -#### Example - -```arduino - -BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // Bluetooth® Low Energy LED Service - - -Serial.print(“LED service UUID = “); -Serial.println(ledService.uuid()); - - - -``` - -### `bleService.addCharacteristic()` - -Add a BLECharateristic to the Bluetooth® Low Energy service. - -#### Syntax - -``` -bleService.addCharacteristic(bleCharacteristic) - -``` - -#### Parameters - -None - -#### Returns -Nothing - -#### Example - -```arduino - -BLEService ledService("19B10000-E8F2-537E-4F6C-D104768A1214"); // Bluetooth® Low Energy LED Service - -// Bluetooth® Low Energy LED Switch Characteristic - custom 128-bit UUID, readable and writable by central -BLECharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite, 1); - - - - -// add the characteristic to the service -ledService.addCharacteristic(switchCharacteristic); - - - -``` - -### `bleService.characteristicCount()` - -Query the number of characteristics discovered for the Bluetooth® Low Energy service. - -#### Syntax - -``` -bleService.characteristicCount() - -``` - -#### Parameters - -None - -#### Returns -- The **number of characteristics** discovered for the Bluetooth® Low Energy service. - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - Serial.println("BLE Central scan"); - - // start scanning for peripheral - BLE.scan(); - - - - BLEDevice peripheral = BLE.available(); - - if (peripheral) { - // ... - - Serial.println("Connecting ..."); - - if (peripheral.connect()) { - Serial.println("Connected"); - } else { - Serial.println("Failed to connect!"); - return; - } - - // discover peripheral attributes - Serial.println("Discovering attributes ..."); - if (peripheral.discoverAttributes()) { - Serial.println("Attributes discovered"); - } else { - Serial.println("Attribute discovery failed!"); - peripheral.disconnect(); - return; - } - - BLEService batteryService = peripheral.service("180f"); - - if (batteryService) { - // use the service - int characteristicCount = batteryService.characteristicCount(); - - Serial.print(characteristicCount); - Serial.println(" characteristics discovered in battery service"); - } else { - Serial.println("Peripheral does NOT have battery service"); - } - - // ... - } - - -``` - -### `bleService.hasCharacteristic()` - -Query if the Bluetooth® Low Energy service has a particular characteristic. - -#### Syntax - -``` -bleService.hasCharacteristic(uuid) -bleService.hasCharacteristic(uuid, index) - -``` - -#### Parameters - -- **uuid**: uuid to check (as a **String**) -- **index**: optional, index of characteristic to check if the device provides more than on. Defaults to 0, if not provided. - -#### Returns -- **true**, if the service provides the characteristic, -- **false** otherwise. - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - Serial.println("BLE Central scan"); - - // start scanning for peripheral - BLE.scan(); - - - BLEDevice peripheral = BLE.available(); - - if (peripheral) { - // ... - - Serial.println("Connecting ..."); - - if (peripheral.connect()) { - Serial.println("Connected"); - } else { - Serial.println("Failed to connect!"); - return; - } - - // discover peripheral attributes - Serial.println("Discovering attributes ..."); - if (peripheral.discoverAttributes()) { - Serial.println("Attributes discovered"); - } else { - Serial.println("Attribute discovery failed!"); - peripheral.disconnect(); - return; - } - - BLEService batteryService = peripheral.service("180f"); - - if (batteryService) { - // use the service - if (batteryService.hasCharacteristic("2a19")) { - Serial.println("Battery service has battery level characteristic"); - } - } else { - Serial.println("Peripheral does NOT have battery service"); - } - - // ... - } - - -``` - -### `bleService.characteristic()` - -Get a BLECharacteristic representing a Bluetooth® Low Energy characteristic the service provides. - -#### Syntax - -``` -bleService.characteristic(index) -bleService.characteristic(uuid) -bleService.characteristic(uuid, index) - -``` - -#### Parameters - -- **index**: index of characteristic -- **uuid**: uuid (as a **String**) - -#### Returns -- **BLECharacteristic** for provided parameters - -#### Example - -```arduino - - // begin initialization - if (!BLE.begin()) { - Serial.println("starting Bluetooth® Low Energy module failed!"); - - while (1); - } - - Serial.println("BLE Central scan"); - - // start scanning for peripheral - BLE.scan(); - - - - BLEDevice peripheral = BLE.available(); - - if (peripheral) { - // ... - - Serial.println("Connecting ..."); - - if (peripheral.connect()) { - Serial.println("Connected"); - } else { - Serial.println("Failed to connect!"); - return; - } - - // discover peripheral attributes - Serial.println("Discovering attributes ..."); - if (peripheral.discoverAttributes()) { - Serial.println("Attributes discovered"); - } else { - Serial.println("Attribute discovery failed!"); - peripheral.disconnect(); - return; - } - - BLEService batteryService = peripheral.service("180f"); - - if (batteryService) { - // use the service - BLECharacteristic batteryLevelCharacterisic = peripheral.characteristic("2a19"); - - if (batteryLevelCharacterisic) { - // use the characteristic - } else { - Serial.println("Peripheral does NOT have battery level characteristic"); - } - } else { - Serial.println("Peripheral does NOT have battery service"); - } - - // ... - } - - -``` - -## BLECharacteristic Class - -Used to enable the characteristics board offers in a service or interact with characteristics a remote board provides. - -### `BLECharacteristic()` - -Create a new Bluetooth® Low Energy characteristic. - -#### Syntax - -``` -BLECharacteristic(uuid, properties, value, valueSize) -BLECharacteristic(uuid, properties, stringValue) - -BLEBoolCharacteristic(uuid, properties) -BLEBooleanCharacteristic(uuid, properties) -BLECharCharacteristic(uuid, properties) -BLEUnsignedCharCharacteristic(uuid, properties) -BLEByteCharacteristic(uuid, properties) -BLEShortCharacteristic(uuid, properties) -BLEUnsignedShortCharacteristic(uuid, properties) -BLEWordCharacteristic(uuid, properties) -BLEIntCharacteristic(uuid, properties) -BLEUnsignedIntCharacteristic(uuid, properties) -BLELongCharacteristic(uuid, properties) -BLEUnsignedLongCharacteristic(uuid, properties) -BLEFloatCharacteristic(uuid, properties) -BLEDoubleCharacteristic(uuid, properties) -``` - -#### Parameters - -- **uuid**: 16-bit or 128-bit UUID in **String** format -- **properties**: mask of the properties (BLEBroadcast, BLERead, BLEWriteWithoutResponse, BLEWrite, BLENotify, BLEIndicate) -- **valueSize**: (maximum) size of characteristic value -- **stringValue**: value as a string - -#### Returns -- New **BLECharacteristic** with the specified **UUID** and value - -#### Example - -```arduino - -// Bluetooth® Low Energy Battery Level Characteristic -BLEUnsignedCharCharacteristic batteryLevelChar("2A19", // standard 16-bit characteristic UUID - BLERead | BLENotify); // remote clients will be able to get notifications if this characteristic changes - - - -``` - -### `bleCharacteristic.uuid()` - -Query the UUID of the specified BLECharacteristic. - -#### Syntax - -``` -bleCharacteristic.uuid() - -``` - -#### Parameters - -None - -#### Returns -- **UUID** of the Bluetooth® Low Energy service as a **String**. - -#### Example - -```arduino - -// Bluetooth® Low Energy LED Switch Characteristic - custom 128-bit UUID, read and writable by central -BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); - - -Serial.print(“Switch characteristic UUID = “); -Serial.println(switchCharacteristic.uuid()); - - - -``` - -### `bleCharacteristic.properties()` - -Query the property mask of the specified BLECharacteristic. - -#### Syntax - -``` -bleCharacteristic.properties() - -``` - -#### Parameters - -None - -#### Returns -- **Properties of the characteristic masked** (BLEBroadcast, BLERead, BLEWriteWithoutResponse, BLEWrite, BLENotify, BLEIndicate) - -#### Example - -```arduino - -// Bluetooth® Low Energy LED Switch Characteristic - custom 128-bit UUID, read and writable by central -BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); - - -byte properties = switchCharacteristic.properties(); - -if (properties & BLERead) { - // characteristic is readable ... -} - -if (properties & (BLEWrite | BLEWriteWithoutResponse)) { - // characteristic is writable ... -} - - -``` - -### `bleCharacteristic.valueSize()` - -Query the maximum value size of the specified BLECharacteristic. - -#### Syntax - -``` -bleCharacteristic.valueSize() - -``` - -#### Parameters - -None - -#### Returns -- The **maximum value** size of the characteristic (in bytes) - -#### Example - -```arduino - -// Bluetooth® Low Energy LED Switch Characteristic - custom 128-bit UUID, read and writable by central -BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); - - - -Serial.print(“value size = “); -Serial.println(switchCharacteristic.valueSize()); - - -``` - -### `bleCharacteristic.value()` - -Query the current value of the specified BLECharacteristic. - -#### Syntax - -``` -bleCharacteristic.value() - -``` - -#### Parameters - -None - -#### Returns -- The **current value** of the characteristic, value type depends on the constructor used - -#### Example - -```arduino - -// Bluetooth® Low Energy LED Switch Characteristic - custom 128-bit UUID, read and writable by central -BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); - - - - if (switchCharacteristic.value()) { // any value other than 0 - Serial.println("LED on"); - digitalWrite(ledPin, HIGH); // will turn the LED on - } else { // a 0 value - Serial.println(F("LED off")); - digitalWrite(ledPin, LOW); // will turn the LED off - } - - - -``` - -### `bleCharacteristic.valueLength()` - -Query the current value size of the specified BLECharacteristic. - -#### Syntax - -``` -bleCharacteristic.valueLength() - -``` - -#### Parameters - -None - -#### Returns -- The **current value** size of the characteristic (in bytes) - -#### Example - -```arduino - -// Bluetooth® Low Energy LED Switch Characteristic - custom 128-bit UUID, read and writable by central -BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); - - - -Serial.print(“value length = “); -Serial.println(switchCharacteristic.valueLength()); - - -``` - -### `bleCharacteristic.readValue()` - -Read the current value of the characteristic. If the characteristic is on a remote device, a read request will be sent. - -#### Syntax - -``` -bleCharacteristic.readValue(buffer, length) -bleCharacteristic.readValue(value) - -``` - -#### Parameters - -- **buffer:** byte array to read value into length: size of buffer argument in bytes -- **value**: variable to read value into (by reference) - -#### Returns -- **Number of bytes** read - -#### Example - -```arduino - - while (peripheral.connected()) { - // while the peripheral is connected - - // check if the value of the simple key characteristic has been updated - if (simpleKeyCharacteristic.valueUpdated()) { - // yes, get the value, characteristic is 1 byte so use byte value - byte value = 0; - - simpleKeyCharacteristic.readValue(value); - - if (value & 0x01) { - // first bit corresponds to the right button - Serial.println("Right button pressed"); - } - - if (value & 0x02) { - // second bit corresponds to the left button - Serial.println("Left button pressed"); - } - } - } - - -``` - -### `bleCharacteristic.writeValue()` - -Write the value of the characteristic. If the characteristic is on a remote device, a write request or command will be sent. - -#### Syntax - -``` -bleCharacteristic.writeValue(buffer, length) -bleCharacteristic.writeValue(value) - -``` - -#### Parameters - -- **buffer**: byte array to write value with -- **length**: number of bytes of the buffer argument to write -- **value**: value to write - -#### Returns -- 1 on success, -- 0 on failure - -#### Example - -```arduino - - // read the button pin - int buttonState = digitalRead(buttonPin); - - if (oldButtonState != buttonState) { - // button changed - oldButtonState = buttonState; - - if (buttonState) { - Serial.println("button pressed"); - - // button is pressed, write 0x01 to turn the LED on - ledCharacteristic.writeValue((byte)0x01); - } else { - Serial.println("button released"); - - // button is released, write 0x00 to turn the LED off - ledCharacteristic.writeValue((byte)0x00); - } - } - - -``` - -### `bleCharacteristic.setEventHandler()` - -Set the event handler (callback) function that will be called when the specified event occurs. - -#### Syntax - -``` -bleCharacteristic.setEventHandler(eventType, callback) - -``` - -#### Parameters - -- **eventType**: event type (BLESubscribed, BLEUnsubscribed, BLERead, BLEWritten) -- **callback**: function to call when the event occurs - -#### Returns -Nothing - -#### Example - -```arduino - -// create switch characteristic and allow remote device to read and write -BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); - - - - - // assign event handlers for characteristic - switchCharacteristic.setEventHandler(BLEWritten, switchCharacteristicWritten); - - - -void switchCharacteristicWritten(BLEDevice central, BLECharacteristic characteristic) { - // central wrote new value to characteristic, update LED - Serial.print("Characteristic event, written: "); - - if (switchCharacteristic.value()) { - Serial.println("LED on"); - digitalWrite(ledPin, HIGH); - } else { - Serial.println("LED off"); - digitalWrite(ledPin, LOW); - } -} - - - -``` - -### `bleCharacteristic.broadcast()` - -Broadcast the characteristics value as service data when advertising. - -#### Syntax - -``` -bleCharacteristic.broadcast() - -``` - -#### Parameters - -None - -#### Returns -- 1 on success, -- 0 on failure - -#### Example - -```arduino - -// create button characteristic and allow remote device to get notifications -BLEByteCharacteristic buttonCharacteristic("19B10012-E8F2-537E-4F6C-D104768A1214", BLERead | BLENotify | BLEBroadcast); - - - -buttonCharacteristic.broadcast(); - - - -``` - -### `bleCharacteristic.written()` - -Query if the characteristic value has been written by another Bluetooth® Low Energy device. - -#### Syntax - -``` -bleCharacteristic.written() - -``` - -#### Parameters - -None - -#### Returns -- **true** if the characteristic value has been written by another Bluetooth® Low Energy device, -- **false** otherwise - -#### Example - -```arduino - -// Bluetooth® Low Energy LED Switch Characteristic - custom 128-bit UUID, read and writable by central -BLEByteCharacteristic switchCharacteristic("19B10001-E8F2-537E-4F6C-D104768A1214", BLERead | BLEWrite); - - - - - // listen for Bluetooth® Low Energy peripherals to connect: - BLEDevice central = BLE.central(); - - // if a central is connected to peripheral: - if (central) { - Serial.print("Connected to central: "); - // print the central's MAC address: - Serial.println(central.address()); - - // while the central is still connected to peripheral: - while (central.connected()) { - // if the remote device wrote to the characteristic, - // use the value to control the LED: - if (switchCharacteristic.written()) { - if (switchCharacteristic.value()) { // any value other than 0 - Serial.println("LED on"); - digitalWrite(ledPin, HIGH); // will turn the LED on - } else { // a 0 value - Serial.println(F("LED off")); - digitalWrite(ledPin, LOW); // will turn the LED off - } - } - } - - // when the central disconnects, print it out: - Serial.print(F("Disconnected from central: ")); - Serial.println(central.address()); - } - - - - -``` - -### `bleCharacteristic.subscribed()` - -Query if the characteristic has been subscribed to by another Bluetooth® Low Energy device. - -#### Syntax - -``` -bleCharacteristic.subscribed() - -``` - -#### Parameters - -None - -#### Returns -- **true** if the characteristic value has been subscribed to by another Bluetooth® Low Energy device, -- **false** otherwise - -#### Example - -```arduino - -// Bluetooth® Low Energy Battery Level Characteristic -BLEUnsignedCharCharacteristic batteryLevelChar("2A19", // standard 16-bit characteristic UUID - BLERead | BLENotify); // remote clients will be able to get notifications if this characteristic changes - - - - - - if (batteryLevelChar.subscribed()) { - // set a new value , that well be pushed to subscribed Bluetooth® Low Energy devices - batteryLevelChar.writeValue(0xab); - } - - -``` - -### `bleCharacteristic.addDescriptor()` - -Add a BLEDescriptor to the characteristic. - -#### Syntax - -``` -bleCharacteristic.addDescriptor(bleDescriptor) - -``` - -#### Parameters - -- **bleDescriptor**: descriptor to add to the characteristic - -#### Returns -Nothing - -#### Example - -```arduino - -// Bluetooth® Low Energy Battery Level Characteristic -BLEUnsignedCharCharacteristic batteryLevelChar("2A19", // standard 16-bit characteristic UUID - BLERead | BLENotify); // remote clients will be able to get notifications if this characteristic changes - -BLEDescriptor batteryLevelDescriptor("2901", "millis"); - - - - - - batteryLevelChar.addDescriptor(batteryLevelDescriptor); - - -``` - -### `bleCharacteristic.descriptorCount()` - -Query the number of Bluetooth® Low Energy descriptors discovered for the characteristic. - -#### Syntax - -``` -bleCharacteristic.descriptorCount() - -``` - -#### Parameters - -None - -#### Returns -- The **number of Bluetooth® Low Energy descriptors** discovered for the characteristic - -#### Example - -```arduino - - // loop the descriptors of the characteristic and explore each - for (int i = 0; i < characteristic.descriptorCount(); i++) { - BLEDescriptor descriptor = characteristic.descriptor(i); - - // ... - } - - -``` - -### `bleCharacteristic.hasDescriptor()` - -Check if a characteristic has a particular descriptor. - -#### Syntax - -``` -bleCharacteristic.hasDescriptor(uuid) -bleCharacteristic.hasDescriptor(uuid, index) - -``` - -#### Parameters - -- **index**: index of descriptor -- **uuid**: uuid (as a **String**) - -#### Returns -- **true**, if the characteristic has a matching descriptor, -- otherwise **false**. - -#### Example - -```arduino - - if (characteristic.hasDescriptor("2901")) { - Serial.println("characteristic has description descriptor"); - } - - -``` - -### `bleCharacteristic.descriptor()` - -Get a BLEDescriptor that represents a characteristics Bluetooth® Low Energy descriptor. - -#### Syntax - -``` -bleCharacteristic.descriptor(index) -bleCharacteristic.descriptor(uuid) -bleCharacteristic.descriptor(uuid, index) - -``` - -#### Parameters - -- **index**: index of descriptor -- **uuid**: uuid (as a **String**) - -#### Returns -- BLEDescriptor that represents a characteristics Bluetooth® Low Energy descriptor - -#### Example - -```arduino - - if (characteristic.hasDescriptor("2901")) { - Serial.println("characteristic has description descriptor"); - } - - -``` - -### `bleCharacteristic.canRead()` - -Query if a Bluetooth® Low Energy characteristic is readable. - -#### Syntax - -``` -bleCharacteristic.canRead() - -``` - -#### Parameters - -None - -#### Returns -- **true**, if characteristic is readable, -- **false** otherwise - -#### Example - -```arduino - - if (characteristic.canRead("2901")) { - Serial.println("characteristic is readable"); - } - - -``` - -read - -Perform a read request for the characteristic. - -#### Syntax - -``` -bleCharacteristic.read() - -``` - -#### Parameters - -None - -#### Returns -- **true**, if successful, -- **false** on failure - -#### Example - -```arduino - - if (characteristic.read()) { - Serial.println("characteristic value read"); - - // ... - } else { - Serial.println("error reading characteristic value"); - } - - -``` - -### `bleCharacteristic.canWrite()` - -Query if a Bluetooth® Low Energy characteristic is writable. - -#### Syntax - -``` -bleCharacteristic.canWrite() - -``` - -#### Parameters - -None - -#### Returns -- **true**, if characteristic is writable, -- **false** otherwise - -#### Example - -```arduino - - if (characteristic.canWrite()) { - Serial.println("characteristic is writable"); - } - - -``` - -### `bleCharacteristic.canSubscribe()` - -Query if a Bluetooth® Low Energy characteristic is subscribable. - -#### Syntax - -``` -bleCharacteristic.canSubscribe() - -``` - -#### Parameters - -None - -#### Returns -- **true**, if characteristic is subscribable, -- **false** otherwise - -#### Example - -```arduino - - if (characteristic.canSubscribe()) { - Serial.println("characteristic is subscribable"); - } - - -``` - -### `bleCharacteristic.subscribe()` - -Subscribe to a Bluetooth® Low Energy characteristics notification or indications. - -#### Syntax - -``` -bleCharacteristic.subscribe() - -``` - -#### Parameters - -None - -#### Returns -- **true**, on success, -- **false** on failure - -#### Example - -```arduino - - // ... - - // retrieve the simple key characteristic - BLECharacteristic simpleKeyCharacteristic = peripheral.characteristic("ffe1"); - - // subscribe to the simple key characteristic - Serial.println("Subscribing to simple key characteristic ..."); - if (!simpleKeyCharacteristic) { - Serial.println("no simple key characteristic found!"); - peripheral.disconnect(); - return; - } else if (!simpleKeyCharacteristic.canSubscribe()) { - Serial.println("simple key characteristic is not subscribable!"); - peripheral.disconnect(); - return; - } else if (!simpleKeyCharacteristic.subscribe()) { - Serial.println("subscription failed!"); - peripheral.disconnect(); - return; - } - - // ... - - -``` - -### `bleCharacteristic.canUnsubscribe()` - -Query if a Bluetooth® Low Energy characteristic is unsubscribable. - -#### Syntax - -``` -bleCharacteristic.canUnsubscribe() - -``` - -#### Parameters - -None - -#### Returns -- **true**, if characteristic is unsubscribable, -- **false** otherwise - -#### Example - -```arduino - - if (characteristic.canUnsubscribe()) { - Serial.println("characteristic is unsubscribable"); - } - - -``` - -### `bleCharacteristic.unsubscribe()` - -Unsubscribe to a Bluetooth® Low Energy characteristics notifications or indications. - -#### Syntax - -``` -bleCharacteristic.unsubscribe() - -``` - -#### Parameters - -None - -#### Returns -- **true**, on success, -- **false** on failure - -#### Example - -```arduino - - // ... - - // retrieve the simple key characteristic - BLECharacteristic simpleKeyCharacteristic = peripheral.characteristic("ffe1"); - - // subscribe to the simple key characteristic - Serial.println("Subscribing to simple key characteristic ..."); - if (!simpleKeyCharacteristic) { - Serial.println("no simple key characteristic found!"); - peripheral.disconnect(); - return; - } else if (!simpleKeyCharacteristic.canSubscribe()) { - Serial.println("simple key characteristic is not subscribable!"); - peripheral.disconnect(); - return; - } else if (!simpleKeyCharacteristic.subscribe()) { - Serial.println("subscription failed!"); - peripheral.disconnect(); - return; - } - - // ... - - simpleKeyCharacteristic.unsubscribe(); - - -``` - -### `bleCharacteristic.valueUpdated()` - -Has the characteristics value been updated via a notification or indication. - -#### Syntax - -``` -bleCharacteristic.valueUpdated() - -``` - -#### Parameters - -None - -#### Returns -- **true**, if the characteristics value been updated via a notification or indication - -#### Example - -```arduino - - while (peripheral.connected()) { - // while the peripheral is connected - - // check if the value of the simple key characteristic has been updated - if (simpleKeyCharacteristic.valueUpdated()) { - // yes, get the value, characteristic is 1 byte so use byte value - byte value = 0; - - simpleKeyCharacteristic.readValue(value); - - if (value & 0x01) { - // first bit corresponds to the right button - Serial.println("Right button pressed"); - } - - if (value & 0x02) { - // second bit corresponds to the left button - Serial.println("Left button pressed"); - } - } - } - - -``` - -## BLEDescriptor Class - -Used to describe a characteristic the board offers - -### `BLEDescriptor()` - -Create a new Bluetooth® Low Energy descriptor. - -#### Syntax - -``` -BLEDescriptor(uuid, value, valueSize) -BLEDescriptor(uuid, stringValue) - -``` - -#### Parameters - -- **uuid**: 16-bit or 128-bit UUID in string format -- **value**: byte array value -- **valueSize**: size of byte array value -- **stringValue**: value as a string - -#### Returns -- New **BLEDescriptor** with the specified **UUID** and value - -#### Example - -```arduino - -BLEDescriptor millisLabelDescriptor("2901", "millis"); - - -``` - -### `bleDescriptor.uuid()` - -Query the UUID of the specified BLEDescriptor. - -#### Syntax - -``` -bleDescriptor.uuid() - -``` - -#### Parameters - -None - -#### Returns -- **UUID** of the Bluetooth® Low Energy descriptor (as a String). - -#### Example - -```arduino - -BLEDescriptor millisLabelDescriptor("2901", "millis"); - - -Serial.print(“millis label descriptor UUID = “); -Serial.println(millisLabelDescriptor.uuid()); - - - -``` - -### `bleDescriptor.valueSize()` - -Query the value size of the specified BLEDescriptor. - -#### Syntax - -``` -bleDescriptor.valueSize() - -``` - -#### Parameters - -None - -#### Returns -- **Value size** (in bytes) of the Bluetooth® Low Energy descriptor. - -#### Example - -```arduino - -BLEDescriptor millisLabelDescriptor("2901", "millis"); - - -Serial.print(“millis label descriptor value size = “); -Serial.println(millisLabelDescriptor.valueSize()); - - - -``` - -### `bleDescriptor.valueLength()` - -Query the length, in bytes, of the descriptor current value. - -#### Syntax - -``` -bleDescriptor.valueLength() - -``` - -#### Parameters - -None - -#### Returns -- **Length of descriptor** value in bytes. - -#### Example - -```arduino - - // read the descriptor value - descriptor.read(); - - // print out the value of the descriptor - Serial.print(", value 0x"); - printData(descriptor.value(), descriptor.valueLength()); - - // ... - - void printData(const unsigned char data[], int length) { - for (int i = 0; i < length; i++) { - unsigned char b = data[i]; - - if (b < 16) { - Serial.print("0"); - } - - Serial.print(b, HEX); - } - } - - -``` - -### `bleDescriptor.value()` - -Query the value of the specified BLEDescriptor. - -#### Syntax - -``` -bleDescriptor.value() - -``` - -#### Parameters - -None - -#### Returns -- Value byte array of the **BLE descriptor**. - -#### Example - -```arduino - -BLEDescriptor millisLabelDescriptor("2901", "millis"); - - - - int descriptorValueSize = millisLabelDescriptor.valueSize(); - byte descriptorValue[descriptorValueSize]; - - for (int i = 0; i < descriptorValueSize; i++) { - descriptorValue[i] = millisLabelDescriptor.value()[i]; - } - - - -``` - -### `bleDescriptor.readValue()` - -Read the current value of the descriptor. If the descriptor is on a remote device, a read request will be sent. - -#### Syntax - -``` -bleDescriptor.readValue(buffer, length) -bleDescriptor.readValue(value) - -``` - -#### Parameters - -- **buffer**: byte array to read value into -- **length**: size of buffer argument in bytes -- **value**: variable to read value into (by reference) - -#### Returns -- **Number of bytes** read - -#### Example - - -```arduino - - byte value = 0; - - /get the value, descriptor is 1 byte so use byte value - descriptor.readValue(value); - - -``` - -### `bleDescriptor.read()` - -Perform a read request for the descriptor. - -#### Syntax - -``` -bleDescriptor.read() - -``` - -#### Parameters - -None - -#### Returns -- **true**, if successful, -- **false** on failure - -#### Example - -```arduino - - if (descriptor.read()) { - Serial.println("descriptor value read"); - - // ... - } else { - Serial.println("error reading descriptor value"); - } - -``` diff --git a/docs/assets/ble-bulletin-board-model.png b/docs/assets/ble-bulletin-board-model.png deleted file mode 100644 index 409ae9e89385b0c27d8331f7d52fff2a8f71e097..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 41914 zcmc$`WmuJ6*Y6Fulu}Akx_f~%NO!1!(%nc)mz2`o9nzqHbayw>B_J)GO3ORf<#pfk zKF{8tw+C|ImeJM``iSO0Q>e14f#-o4#UEkWrsLaYH5>dnSzoQ4Est zRzUFgrEwC!FNuvwuVSRs3NIBvVJLx(`r*C7H1aWqLU)^@xWxKGs0H#tG3Uu*@=cHW z((Go<^sMQD$80S+m)lef_hE#!jtO*))Qp6OaJ zBuK^}4|6)vZ2d>C$>mYS>kEUYjIkXrmIGa$kDOLM3}?mj{$dj^0Z*-NmGmZRub60W zPkn0R%|*-X5{c*Q8-ZT8E9E1a-H~*W&~)`B%iSWDCS15*R2nJ770q$VaFtdMgx8mg z3wx#UHWAzCmvq{P=y; zBB4eozFw2dUie(JhyTexcok}85PNL|;KV5JQCSPQA$aU)Vmw9ZZEk#1 z9QDOMg3ays<|QerR{!fwCen={+Ly zW`BEckqpk)TN>kD{5_~Nf|)R+TtsjNEWxKU@J=7h-@;A!xP67Ze9!gvffhuy_0e0@ zhu%`cDE@77tniCIW=QW3F>ta(K1Jf@peKn=VGwE{xr&J>@L=ET5(|pNh!(#1N>hN( z@ZnRYn1aA5rNfhYB<&BE9}&NjaXh$z_wdC`L>Sk9Gy_-dJzM&W2uZ4a;JdgBPAVc^ z>-@58Ev_J1O*`H);UOH8pKf~$l5j85y-`UuB*G(c(MUBacuaDOD2g0}LW$%^v>d{^ zFzG1UwR;Z&GW8Sjak~jt1Jpy84OH}}3}jg+6Acqpp5twBnP9N{T)fXUm@Lavqb(A0 zLgvCu31jY5(TmX2EKMl8H>1D%j0ml#m0*SFt!FL17MnF^38V&nI<&!ir{mEw&5=tZ z!y@*gs?XkNx(%lK2_y`rK|s`OEkF{jX`5uj-zkLlwxlCr~B7uJz4 zp~@iBrAChyQi!Fa!IqaLk`SGJ$tznY>?-Ukmiy{af%Syir^Na+4f!T<4_OZusTlTz zlZ4g2;+W4-7I8ZX?$q+J(+SQAy3h<-U2-qk-+9-y2#RgOZLfW@OI0!@mn+)^{A47O zv*HW_4U!Fl3_h%Ib}3RfM*Bq9V96H>ZZ3lhr5r3089&bA9t!^Q%ed=dh9d5$E)gG+mC{ zwd;WG()u8`+Dr4F9oquiF;9}8G(RDDqWmO*qnnc;**du|c|CcPqo?wX25J>VV_jpj zN{2NrX@5}3gt{VxH?z28FQ0i-FlXVjK(S##g_>#h%ZlO0+R;!=ZjlAQ6Gm0~ETBKSuz4}|flFjLbh@`X?WCmxp=%?#vFB?*RiuydtkgbvZteeNM z+BWz|a8;A0G$>6bS|+UT#p{`gMJ2uZk;;*W78`G9I6iYW^kkKOQ&%sNochSy!QcBX z+co8a5mg{WEhG(h0aur4kLfk@4il+5z50DMtIF-t%Z|CuWD9LWj~;*XRl|zmyoHUb z;zH&nr73%Ct08%BPi{i3*{xq6By5a1HfgmyOL;6&Hp>oJMB^JBSo_$YK0 zk=C8IY+NRPDNTKte)!RFHtIvXL%a!Qe7jNGAz8$9kng!f@qq zohAFEx+Es0UP!o0BuL05s4=NmtVxDygp%b6;F1#JxKlaV6`qYP$OWwKuAr>$L)o?B zD|YAXs@4k!MoJ=e+th6tNC-)ZmoRRF9=8{+KQB4et#e+7Ovf|?Tt#noGj4_*X`dTk zM?n&N%Y8@16FRkn3}s4WaAZ~yYklM#g5-vlosQ4w?B@o>z{GQtJno zGHSC6&^EDjaAdQJ)%TlC?khje5+03uPG_%f(vTSb`}t4lP^uK_59+8D=H-i~QpOqm zii4ONr)$Y;)&sDB(^e1NEW#+FlC7Y;N%o7m)MWm4&bH5!h~$l?ZTFhJw7H)7>6RrcuW|UW zdtHcvB-liaUcF}u7R4e~UHadai#kSjvbO76Oucly#P_6+qDG|rq;h-OBOE86O-yqa zaL01Bhedant=jh3+m0TW>3F;#Z5qo9}yUUTR;lEdHwZSP#EVBfJ;#;Bp_@?0&2BO<>Do@n#gU z5M4)T(2eKj&5hyiY8EYuJVW{?q2im#^J$a9rqkVz(|RKnfu<4uwPGx{aTj0YJMNDZ zjxb7AN^VOPOO1qHgf6(1opv1#geHuy`nAyiu0D$!{hZ&QND|sEwT|%Tr!nUKUn17B)6!@C38H ztF?o^3$wL7<)2FaQ;)c@y`i1iTL&{6Ycg29`UWi&deB$`k%L-{`>abvVWiFXMqj;jv@Y7`JYl? zWf+X5V%Fr19Ih>{EZZW>}E_T)v2ZdrE0jBsd^ej8RpmJ%afaPXxn zrUZu`o{DBcU4wT#FtI_{S@I6EI$-lmV3 z?hg*9a*gnw4LUErHu3TIW#`4jfdBi|8zme?mQ(e{0Z&uTWb=+2y84`$4q};qacGXqjKTt#tjJ($BQU*#|jSa zpTSZQ|F^>m%Mgq(9=wR%Y{K@@8)|AF`A!MitWP1Nd9zM z{38kSyQ{sL>aU`xevc?aPzT+N6hFDgdo$r|5sld%oe!|IK;SRN<%RqdQWGBkXEqZv z;NrV8yngdOJXzU(j|#=FuhNztCKWYZAtQq)K_8XdU^lss_n-08 zww~BUN#G)L2Y)mYlkUff@P-&2&1~S49Prn z^QD75=dmIsq*65zkfaCqLcKaK&sQUal5fS9$4R9gSs$Bd)1`Fo1D=V z>G6bs#mYzpbWmYC5;fIGK%5^K4U-KV^^l)t^ zYV+6Me`QE!FG(BmuWd0xp{I)%R7%LbE2=2q8~ZTteP61$#rssZ50kX=U#1P#q&Y9n zzU14Ya^J7pWOE&H^ZefGqyEJ{s-{7w$&GXC3oi+Y$Ejk&_xGq9A@A)|Y?|x#N;}Y| ziZ!{PoqiSDtD4qH8POG_h1RWMT}`+Aj+4i@!1>2=1qukKb9F8`v?KR(iXyuhSsnH9 zBCK?tzMgGrZwOo?rHHxOtr*!|a9(<$<9X0@RwS1I{k8r1%Ut;YG=)E7pe+!SGWoPy zXn8P+J>_(o2t8E)Vk5-{){Fc!r{ukg5y9oTd7Boi9wPhDw0FmS)dSFm!A+rr$5KSL zzEzg9YKev>U3hBErr3UsSFfW(b1a0oOckSg@!&#WjoO4g2+G+)g{Ns$m-8=8rq zJMPYmUY>3ll6qa+vZZUGP3d}h5I%FV#E9D$(!TuC^1Ghc<8*YNdiU&`{RnIKX;H;+ zx$~kcZK_x;8a`_)*W4S*ozd)o7fEc?1T@->eIa~*j;#VD1b&v;tnS3%UbRQ2qPV>% zj9TJ3s4~AX%j>*uua=hC5Ozx%_RFiS<~16e_I58eGipY&rRKqIA^x58Yu-j^-t%hD zDvWcg)HL0-TSdop{kzvzZo*6d&F>8d%@y<34MY3j2aFNj+e_7F+XdOXzzj&ge_xDv zJrKH<3>_vSu;fJw*YaX7qUh6w8;Xy#^65kn$`7Bm%5^Nuy4p4Lbv-YPdE}Ej{2x^~ zPO0~l)NMSuS_xqhRlRvE&mZ+vXJ78+Kj+U!J0zDH$J07`Fv$Z_xVC=!fGRW!_U$r3S> zlU80l`m*$A)2>s0ACdD4ua7)ESs&82%7daB-H-dMdOG1z&qNVU;&pxGkno<>{bD^~ zZ_eV&qiI+6ld|_}`?%T;qm|3A4l~vSp6~Fe7 zxDP^`PRG6)H*O?bJSh9tD;6%){QJ^EQ{NA#eDUD-)q%~lwsYEE^VR+@FywiGvv1>c zPTfg%8HWxv-|PnbI`Z}hZY)^-Y%3iEC{drEkk~*<_ME&nLivLM{HVa6td3I-b`f$LiFxzRrJH6#}jAEqy>?lytqSy|#62$|uDwpnY6xxkc$+*6n#ZDzz+F znkq@`swax2qEZyDn83VPAVmD{ohsafsetG7D4yrBNaF4a&AaZCb%rsT7s=RD;|Qn~ zX|6HZ^Smhov;y%cWa&nrOUKu&eh~%{`iI> z<8}KB4FOLxwG3%=N74m8e6(a(bgFej#xMAD;K2`6ybJ1uN;w(7ANB(ExULl0)lL~phV}+KYvBhw>HXrU9 z-bZ_Q&+h1P?{D!iA%QM6QG_~_9tZV)Remff!L2T4k`&n%`XlLchn2EImpUlzzZmmV z5`e>^EdRg_8`o&UZr{p_gg+nvzHg_3n=(z+`^R3z*P8#>6)+Kpgm6V^3PsM&zqiys z2o#1SEzH%PNqV>J1>h>n;K-7@T*U#XX%;EK^DbL~3K7cbMeCveb_!Of13qY-**zTN< zBfX0@#^n0k%|9@cMIL~kKPip&g?rO-vQ7H9!|$8qU$9XcI(qwSi+9mQ2N4GCd-L~G)tWn%Q zbL!lIT>Vf9tPoavWRxSoYU=KL#sgZg!JTK|L@i@wq z@FA1IdH%lGJY?%5W~%-EzO8;uw4B#Dw>ppal;N3W*?e+;v->(!7fj;?)@Qw2C&b?n66S+Z=)i`Ngw+fCAIhFH z2GyK#UT6LK%`hsbR>}OGjSG+LgTkDHP@(*g{JVPQ;@4ssJg%u8aMO?S3!G(pIAVPy zD&wIbAwcabLlqV`&U|V0B6E#FDE0QB=VDCp!nv3TR~A@C!43!arRc|Y6sqoBY&oPz z2|R2h>25(;;cm6J#^Kxlfxr~J`~3}dpbmRv73*_YcigA@)iWWd^c|vo%4$5IGmMe= z6(2D4Iz$7%hP*}+?-CXiBkdLAtTP|5A+mHO_&BUk(pA9iwiTEi%fJ|JP{kSNn9%=1 z3yf%$LcQBXi~l$>NAZg>xq{@Nv0S~HXsb=HM9ws!xD*YyaXmORd?tg2`8{AC%>H0k{@4kui<^g^bH z#|G9ef9+WWmIsh}&g{3`dIC1t+Xe8}yVmsagikSw0mM$FFzRyK z;q=fNtj^18o7@_b5uTE6n=Z#tv#Ofht=}oBn5{6KmNr{=ChWpSSnKS9!^Nx7Gws*E z`n6{T5U+0lU~a_CGP;-a@8+$%lp=sb)yw{ba|Mdo(VJIi2R2_Ck7Zpjc|iB}8c&8% z+lK}82>6$MAGeQuK;!F`pVzc$G6wkBWL4IM>(q%Ug}*bgjQ^QauhlzpDqhpt%%=Im zge{cx@Q{?_P2_DQb%GXK=+X1^f}?vy5tgIX-ifT`ZxT>h*;Bynj? z_xPnw$ZMCA<}_z!tM@sWCwO5>=|04m%@ph;-t15BBB~f5D%y_977O)`>v+OZc4|!I z7(-CUo*ncovKT_aceTU-M*NZ90Vm*zt2@}DR;NEkf1QrY2UvZpwH1L|**X~!s>u`! znB(0{ee7!t{Eb~;TRH!h)$nKU71lbzrXU(-FAN9(Fr#bD(tMufc(AzeQt0ON?H-JH ztEMytbi8gH8-8Eze5j?mO(J?I&%2Ht56Y$r`3=@@KT*EX#e-u^;As+7{)OGRXjWb&yTsi6@6t zn|R1~Pi{LjL%zpp`~^2>w+Qfs(z%R!F`gZ^-rLKL5Jb@d%fSNBQxS93#H;E-wgCXS z#3s&59?opZ>?8c+fNd8JQ3t84b)^-P z#SAc4H=&KC)qFK4$*(P<_#NP85v+Ja&)sZw!gZP#NzN}e>;k)YZ1Y1Zp3El;-E7G( zulu?6**4XJo%yr<%i{iPKw7fjNRbvl+RIhZLCilEpw#Qw`1sMjBuoFUs8sz4jNqZasF!a^-%Qe9147-p@E5 z%zvJyUhTmlC{)r_ZBjAB#jX<%C_1G6$-OP({&eR3Y8uUjv8rv#QiY$!>b%3^WS1im zq_=5(LYtTfmJYNO5d02*443~Pt%xh51V(L$;6%2l_mQn13VcLLnUdh}(8%P~BB4Fc z+N->-m7ie6_?PJ`GA;sUC9RL^Q%&Kr+J#a2RI}Fc*L?X5GPbgZ`!!3RC->Vv;aBO^ z2T0&)bExsszD!NLR?5%~*)QWaAaC0K^m*F}K_ylywMPg2_1WxLL0+|g!eg!J674W$ zc>H)p^l;elc6@^NpRxmb7_>D1C0m8;lgu2*&`<_CAsEV?Gl0MIa6dOe2PNjUOO#$+ zD%i1;zh(?04u8hbrn|In45tyAROU5I7FW+PgytI!uAU#QZl09?oYI_s+C%iXNSLvt z)*#Wh19jLqLEGfneyt%!0+fG5;7se;<&W$SrKf=l3R5dj}xMV>a zvP->X&C-E^Ixd62RO>W7r_4AkJP z_@yos)^bDqWoD!goy&KOoh#MBb0p@X%SlgBa5}p z|FU{o$K8(y-<`lwUf^f!i$qp(CeBVfF-vfsgt(2`Mj@`rru&TEG2eJtF^( zQh!{6a8(uO;JN8B9*g9lv`Nt(*d(uX0%f%!46&^U$T1!pRV)k~<5ls@-S`x1YV+Yx zp>AuBo1fE?XXvPJxRu3+kTYbES`$Y!ma|03Ql(FNisP6yjJV8KX_b*&lxBUsuL^qv z(Dmw_Rn_$GYdXyuf2cJP5bKAuH30<%H#C>`XWn;loKh-Cu(D0^Ytv7K#hJu;v^nYV zhx96G^b&qwHX0M&%a@Hs-Y-`(`b?!$^dU(L+CJK0@;F>kNRcr*!&G-SUvn4|pBR{kMt$LF9Z z996gG4uSh&M0zv%Cb$2sPM8=*r>pJL#eacbm>ggRYGxkmU+!1v0Yy8thmLpr0|g|| z577ep(7%)py5Q=nK zq95ONDG!Ol9nrz7r`L-$6-wq;=e^5S8M1nDQ9!@`9JI?GRakL?g|N75Yu1$enEmbdR>_v1lE@eX^Y605hHlsTV)npQ&qCKc#5F$%>d&C*SOhv! z*mbKI^ciTu+@gFMLz|f!jMpwf7$=v7T#tr4(#ubRN!x8Jw|cjHz`vErL#@M@QACF*lDIsGMtED7@dTF2Hf!^gsghr zd*F^({?_Pv(tZF_{{T@X4Gy3SUF*3YG}Q zJpc1lp3(jK9q7E*?aiYyUW=)s$OoP>F^v?mWkpbM#gh*vTa*y|T6ElN|COKNiE`!v z7T`QMRNpK#INMM~i*-7lOId}@CG!>iQg$A=jMbmSQNLhI{fzNl#G{Wo!55KP^m{O4 zNofIwF#q9KlW((6EQ&De(J>KJwH@P%ft-qqgYaLeQ1m;HwWk?Xa5c_QMiz?`5LdK3}*z9$@*P>q$ukZn+6E$%_|h!ryZ30UOo;rA>}}WTF_T zt$;|!LoY?~kE?%Vg$(0iM@e%Ftnwqr$W8wOJBPF=b%Nj$W@#p ziF3(rpMOp|w_rt1s+t%Nl=%vqoMIs)&60g>x!QlGY1cb-vqEI z9N$P|Y;bj4^bJ=Yg}-yrX%D)+(I=woV1!}wTYni5;2OP~kkcml42-?|zl<#``Y{sa zxii#I(VAGI5t^ad#P~mMTd0XtEXd6RW(1Jo!0N9IMr_5?D36b03#v8(&3+#{2?8wtfG17MkLq zzv1yiL)J3UJd~FvIFuSPgqs7{wxOj)(P%L}wTQf^hSE2=V&J5EawD%q<8vSD-k29* zlunXs(S_D%areDwMEnH@2UN<$M2Y?<&M$Bj?K|!z1{l5G5=W&-!wA%ociz2tj)Smu zZ3hL8=}jwxGSc?|_wO1?A9GNACTiJkUeZDicSOCR{Yp~Y#?7K+gzhDyKkM637=0bF zF=-s?*a-0zci&TSlGa`SI;N{!jFPNw+>A!NpidR%`qlM`d%b|&+yeJu2l*=tS%7_o zt`S$xW!vuGE{dwojeLr#u$V`0iYmusUGsfs`lJqXhUda)0y*i@vdM#jrLHTj7x>bq zX-0B2qWFcm;0F^0)uU2le^GpWhhT0o#;&9plO8f0AMV{P93Niw3hO^XR}7zI5M5P& z+*OeBH>~b61_Lr;i`+X9#VG>lh9+2%`;J_jO9@`(o07c)QReRfq`bh+wif*hRZLz`*(;I(@;ygAk4fY$hLr|Ad(SM7h&I zKZ+Ad_vQcg!+-|Fk=Yd_{-cZoW~+J$Ml~g;c6O)iDPZ7Gf`Y972BtB5G-$ypHB_DXHK`qQDwdQW9hlvPJhsJ0AXu3 z?D`=QPwA-5P49Cs&n8^;6bS1uPJel+oLKGa?JL|o`3pGj)tHo$GeGjwmlwRqfeD1w zfN*CImpjCi>^Fz2Y+7!(mfjei2)P~`T>*C(HP{AVMg^!pzpoTvqdTS0VdTI|VHn`- za*C@CyZ~nTMy(*RC5MzKgS4irk13a+<5tMruv<>fYB8E-*H1r{Efry8B=q|{JI!HC zrcHFV%0kusWQeuLiW-^WY)A9>|r@<>9tjY&>j$ zX^-pinlvZJKop-@bU&~{7dVY{+!~{v@XJqk>n~}(+{W17`O;D?hQ>>!)iHMoC~FR& ztWq6}WfGC~ z4R|3-BS|A+AGaKWu<;WErfrNU0LPBU6Topc08%7-kq?kavb5dzs+Q;Oq4Vp3?2X13 z$sB#@t{VjIt6|*H3qxv;0?>%fH&g9j{y@k80c4;gv~`0JGEzgjfcxA`nV}d=D@g@@ zfz_|h$MU|lAak?}PuCI{ARp**j^sq?BYZndnjq4@3-U>7!1x3M`EXk#2crXm9@EZ& zXN-ZI-a^i0I+Tnv*2-cQttw6*KMCsK_f@wa;_O&#DAAtz4V2C0W|o#~J9kihvHRJ6 zn7CbFE!u5Cv7+YdfXU`luU4MHV1pWe+y0z%Tj}k~)wp};?V*?RM=0cxo z8isL-o{@`w|Ma<}+;LiaI!jcqFgL!u1q8!IkWxV&19)_RsUnp4-CS2RIF5`_VLk zoJ?99i0m*-kcSs)!lLho12(>Eh56}EI_X*p9|tx#?1TBN28)}1EvbI8+Da41Z^??f zNMehyK=j3X3aqU>(^Oi0yRA7`@a98Y4Bv-m-@Wfy!g4oQ_T8RkR&Nlz)_iSK)qJ_H zico&pUu4M}kI@^dBTB|j2)P6+-c$}+XGAHlc6tuA`xKJiaqQf79}luDU&A^jJzS>= z^vi43T>@??XI^w&NSb_W;!{Ka;`;4RGA)gXIra{@BdNUOZfE;xjf1>8R2Y#~bCoiT zBu9-fQ7Rz=sIIdh*@OhbXh>DTdmQJ6KEPa~RZZq-3qoNV1}d5{Nns_i@!*&@b5(UT z2h<%R4|pTc{oVGlll}EK$5fC-uTa2vfN<kYrTX+#-v^LF*;LNz3m9c5c~*EaX~@Kocx-;e>2WH-P>kZb2W4<#hlEuX!k9#Zs$fu#0xS3CrV1aty6DkS)pc(VwM zk0Hv|o(Q34IYec<%LREnK_y_ZJo~!B zd3}JsDomgQ+n2uV&r$dQa%byoAFIKPt@^)=jfLO`vd`@aQ0sx_?pvZ?~Y0K zKx{}E!M9z&+HmnBI|41n7Mxd~E0-~nLsgCa+1Wp7R$H2Z(EQU4r>aSniWgk7RD*Mp zGZ!Jq?4L1Xdx)L24nuHaWSD`k?fxUa`$>G^z%$7C66shrVTx^CsF#r>*8tA)4=htB zo*2KZaN86R)>3ytHk{&FbsFJW4J}Bh=U36puFiupdd4kO)|Y-RYVA*2D8SJBhC7AT zovZ)CyuS`ZkLU@mpvk()V+2(l*IfM|qj-jPG6sm690vJUFo>_z1ULw456d9ra2NoAFvE-;miQIl<_8Fq#-wUk5@1c6qpYhZd+THHgnE{sEGaHWcdbXZCc6?#f#*%Sw8;S^a8@f-sUxQJp*@jnFNuqnS~`;0#-JIAA& z7ij299pjM5-!0IqjxV;&LJULuA6{8($V`#=k-z5yPx}WAhc<()IY}blP!vw++r8;51ZriZ zobI?SXFhUoU9dbA^Z4rNPjC=sXY9jDrg2o%$cwTASu+RXW?KUd@Tdwede>_bq%wbo zbCjk`Vs!?&=o1lHu z+&Go~XVjf91>e&;PFZt^6p3sRJ(5x4U&(jenc8aPa)nL?ufdli>vf;@1+V2);`wX< zSc*x{oJ&5{a;SCyAXx5D6c_zhuA6{>doGzya>4g+S!_5sHMZ0kssHAY79fL|8mD4t zJ@Vf&IvBi-m8rzq z>B5}$s!jAB9!J=ps}>7}U6A8Fb&DPIPIF=npfIH=Qwh=Y{F6^A(wdy`Pa0i=<1c*K zAoH|JL|A*KN-?}1^-i}4K)0eZRYdP}fe_ZMY$8XzJ7sL3ThwC3zIVFC1<-Cvl6M<= zr_2bvD(A0({BN!!$aoaC0-#tFW;daIM;Yz|uf{*D!n)%*%#nTc>jbT)c;NlZza~A| zNXN9T)8v)4cE7)2XYs)>RkyCNn4a`Xm7a{$!VpY7a4RBqlKc z?>1+>(tIuWt17X)zSN>j$x;5!NW{TNBz!*?{F`11V^LhdqEiNi+y9X1zeW!PBMCuL zRlK8JGXwdfsO#0Fz@5=yf>&`dOS1k=pM@c>28=vIay8z&kJbB8dlyjw`&3GP0%^TU zbimjs%!#r?Q-%=&Ca~nBmuY!iOq7=G^h-P`JDFo_WA^%t{Y4w7iQ>F|%L|FZP4h!AETlNL<%20l{@yo*yogXVuwn&H<=R(am{!na=N8?g8%Y`(3rO zCMmOmSG(gzGq50Z6sb!u7;UEOkASDZx4+#fmkvON!A!#v2+7kWeW_V=8>j~S zKM(Zq-9XB4y3dI(O=J-%6#O6)Qw7C^?dF=!>d+)_hh-#vys*Fykj&Bt!=Td5wqbvy zI>XzR6#r+Yvs=E^HC|%S)l4$s-=Pi%X?RV#4LflSTU)pyHKk4b8miH zMco)j^KIMxjwz5!ZYWk;n!rd5@B8lc(klU=;aUO504-_GB*p4|>1u!`J-vN>KHUhO zj!WB=nqk=YgtFM3k_KxY>&Z`X+K!XT%ZX3J{y;49e<7B@KB!i1bHDk@+8yM#il+Cy zp0Bn7jA&L3RO0~Fz+n(Bc4+>{@y%hJeK>}-&cOpSBUA zNegyeGR?5nc~*$(XqL2dC9di7m$SUf}n1 z6VgqQ*F(yTh#e;sr^=1xG~ZI>26V> zwf|&o?4`t5xB3HKW%oZa zZ$57iK1e_N$&}{Oc><8mSWU$J=QfUx5k^sH)Zj+1>bAfk1r?AgB86ZW(H72=2r_tF5~Xb1!G+4k#U#w%NMPENSPpWY+kmFI{PliN zqysz_4#TL60}+eQ9b`5H4x3YH<!L8yB9+)t$E`7hIp_@I0o7d`zr3jC;XR^zZ-weS#;m)WcCeIIUAS}k4MdV zx$OUl5VxDbF4TCU=jpLKfJ{rOZH(f&K`g1FdLf#n!?E@mEv>xEZXShhM^C`NZKN^p z!-4<*wnzwELKm0{04Ql%o=`5WlPM^nQgL_Q!`q=W)Nnz{0Es!vZL()Zg8Lvwg@#K` zV@zZ}_>`P3>%Lr$v+3sJjOz_~Z`(puEnB}mkj9+ZfEy+5%t293-!miaPyY2L)Gwls zC)D}HCPp$KQRC8=C*`d+CX%a(bRAftAf6voWwRuxMv){FW@z#=l3eV4RdgSd+S8<{ zp(3lI$Y%$Q_NB61#y&;`kcAl-mR5WLzp|6yVcHx->)|6v^BJlgg5})fpY<_W9uN7F zfc#aTYj7zmYQ}gKD+a!LtVX8a72;u)TJRHdxp#)WlTthCd7cZP-Q-ICynAhy3*gLS zamXI?>k}i^_YM?~^}Q z1h1F^%c$ekDBSpV$~MQl)Ko@-Lbkd!-SE{EH>`6{PheKmIrR4su51y$cx8zerrAIq#E$}v6;D7ae7R@huueAC3pq3y>g=wmRM z!n6In`Z7H{bS`<@#$qhaB6TwuVCA48bGPyY)Y8WC+hy-DBlwKK8<7>va|hEiIWla>Ne5a-z70}Gp60UJIju>yT{`jx@g- znFre=6=}Svp&(8Dzw84$%oJi}I0AXOiarSXJb>?0V7@dq^Rta-T#QZC(8 zf($caF*g)n>?=8iI$RvV%n)Ye?d5dKdz_Qjd+5)HWxK|tlX=FBRk(1$v9be;Rj*+A z5a1;El0%z)+d1(*M(`g?v+SK+ezV%bO_OeQoVJ7;*n)mwafk>%IaI{q?h?tZOqpNBhNBDJU>aUad2XtkvoZq z-BK!oByGzM;~kO#ULsO=0p+!drd3>Hdi^5#V{hcx!Ahm|>4HMPEG&gm#EW1HxAVy6-=7PNzN{@?N zef2o=?0Y}^R&RKM3ZJeh8_@#VRo)l`}b2?z@`j7!ix8)xC5(3 zxM>$mc_Tn@jpcC+fjArie6Mv_lpwVnE8=<#Lpv91UG`Wh)qwuZ4r-YGRiH2JsokazFN%mWs0YFS`Eb0}N6vKQ zn%X=qBw0c=es%IRXY0#$5zJ-k6azvBKM_s{Qf!Lw?vAjX*l+)>70jprmmCYc&l%N?6uY@Yx8jF4YJYDE-OiE#VT|>tOK4eA%Q9!#K$(J#P)7TXbnb$L{X#e|SgLtG zgqa`4+A!lLv^d(0z zMReE+FkN*R;m{**!}rfop4;Vxx6 zCVXFgWU6VldrHY(fwvY&CHb&E*3gU@X{komL`XQ==eQzVbjj1ZLirlyj{CF(0h>}J znSl&5Tl66Yu<=bN=p=lO;p(`fg%IWmMU+QXD`##b8F#11|I z-wnm!C>|^v0;8`GTQjFiMEJX;A;N?j4H)s6~JHTT~lPf5}Z)J^2P_0DRUpryS zsB*+hk&?>%P89zjbWKK)O=#=l@{7c|-(xHPuP+}c9EF6fEF5i$7ZoUi7ZE7oS#cIt zVy!zD5X1&WLtaG~8^Oe-J;G=G5rKp)-g?XJp{qcJqJ#sXGh{JcQkCeAlL2>PFf~Ss zcW8y8Ibc7gR*c-A-&30oc9zq3ev;6`p5spN>*-k39ZM$6Z%@d8GnPrZ#FYxqa-RTlDjqkY6y^1ES-82E{n z2y7V--MWkp4A`EeLoJ;5r@bsPlHiIO;q_R^Ba@Ulwdr#)$e3?$$8U8wC!;S;WO>KX zTvEKz!&l#$TdaIkbG5~;C@ySlP!3O)`_7#^^(_(QVa7gr+`g92==2L#(~Uy95E+8G*<$6($VqRO!}RaRLq zxHabvuV6=fYs&vpopUP1&~3u252&bLE~)fQGk3*H_^4s$jC03}x-Hr`%WK_mZe zMhPuoNk_!pjqoH6wg|-5wPw^F5pn!lQmjR>m}R`7yL}wN{C22Vc2SZe!MjH+&Gx9E zIRKw^MJbAD z``s``-EKfgYJ0hg1sxvm9&~>JC5TRMm78#yUU%++4I|1>SpY4xiqr2ElMTU!vFLRSg!H{Pb5QY8w&Mj?qRmnh*hd-FNVl4Q ztylA-?G1>vc4;YLD5yZm=-G9UUKK~$uBlkPAi|a-l{&p$&}D6G#@@-zK6Ng{mV<=V<<3%;MX(wXBR&PRe#31**IQbHAK z7VdCu;gtkCtCEv?k!L{etmBX)Y)-X$VRoQY8228iTl91ZWRGkns3Ed&4M;Mva!BGk zk3>6)L)H*&zqez42A33+#6uT?9n6M~FnXNbhynh)3C)BVKq4)>DXaV>Rh&baYR#qV zZ!G$qYh>#ZVbY3BjkxXjM=3%_WFIV_h^I+!F5+a7B5&T*UrXX&@@`{hjnWR2LF=GL zNQM2jP$Uco%UD7}gXsD-!r#d|1%x_6{LD=b90}%T9Z~~dVqu+q^|!PCA9a5jRaN_i z52LUJDUl8VDG4P76i^X1k^<6_0+LFIBHbX;DM+b=G}0)kgfxOkmxM@nm()8K&+m!< zd&YUk8RyFx=L=)7VXb|yxbJ(;YhKqiLm#K2pOd0kz36R8)5%d?xl#GSb&qfVo_Hbr za5LW$ujO*Z27{V@wMrNd^N^ay@mtHi;CiV=-1Y3dKpzY9$;+C$YQvw^EgGT7t8G=s z8e(uK`RX7~B0j-IrOQ;9UH%`%4pZ;cN}=C5v+*pP@0fhVKoPMQDDd5`S7h04z+(FW zok9YwD^*Z$LYAyo(t)M*o0sf7N<@~K3{lqCtL=o}>f}A@I@l-m!QcF?&{sZ7QCwfVd0=G#s> z4fk$07VWzDB$cn0+<5n#a8YE`bIWmSut0NiY}M!XbhGGizmxOxdx}{6h|*m$1OG=4 zZs)^;dK7_bZ_rd3`K(XFWNw=Kf(D-pHyZC+oBGmWGY|DcO_?T ztc@qu81czb)rgI}^IvV1xOvj}O*eo2Cg-lfw@R5|tB%Iq#Mts(kAktph{U8#mxY1f zinmtwx{E%PR>l&M)i7<}yYaUdfWgkZ;O`Coc6R;!JYED{)fgMQx^^~xIPPGT=JWKv zwg16ZC{CPE1l@r%YQH{DwZcjJk4H6aUKiQ%uMHgGgSnd|pk2$MW zUNyTtSU6E$Sati&k!i3%(XrcG@OX4{e2Ft}<+}gd@!-|BWU+Pqh@PE>XR)`5aodr5 z%w_BAG|^Ko$LgyN++(&?BRvR)_D)4%s4^h;^+D#!zI4LoJ^KPxxvVue$wm62&X~#; zE)fl1a_sxc|-v<3a5>{y;-xqR33)a2Ka$$Z{Hq!Eyc8n;|@txjfSN9~gah}IUN zyVvB=GxA0JM?c;Q@tT~Qm>c!4E_g|ovvU8=6>@f>X#L$F+kv3_SjA*nSvUS5y5c<0 zGdMt@`O%M({2=sMlt{yTe*-EIJ0O7f8t*E|Ok`i5%aYtCtT?E?+GvgArlymaMv zBI+)qoE>_c8YC@>$thS<KcW3!kYLX(HLIv1B9&Cy^L z!6qK=02JAoa8IZdDMHjXrq;Y?y2*dTPhK+53CNmCm)4yCp3#Ov|BG!?i1=F{|M^QA z6|@Z1I)|xOGQ+?Yd<4WagN;9MgO*>CDdN@;-JDCF+W)_!u~!#F!^HobIeQM*{0X3n zJK!3?R-Z=y&Uq$Y@Np-jE=0C!ynS0wJP(J63Iaz z$f}sn1;0tM$a0m!PHqX7u5G-uOtT#lOCji|Uv+YPAn3ODY;mOGBhY4bP8C526IOpl z_{T>A9~7-&DrIYmsW7RH6mAQ^+UyuQ7TM`{`T^0qyEt5uV{`h36T4eZG6+OXCanRD zgNS(z&|b@_<^O8(1#_ox(R7p-a=n255XQtcKl~X8mXQ;yz|~_Uzp)OmX8wbH6An0y#awY$fvgaSe^F9lb~SG4{*M~VjpPA?eyp}E$MprID|rU za$QfrxPWl+FzI+Jvy5v&B0gt7%Z|yFKsnq0Wq=@T;s)4F^#ka)t$GYMdZ7~B4 zy=PTH8dd*|3}Fd~v1QH?ng5{0)SpMbSjl8rY?=(JmO-UutGrPQ?F1Q6?MbNkEGK${xtUen= za1CMY+DHmJfj2y*Tf=gkdF1^yrr}>-Y(8j~yZe-qQr^$fFbf^>M_!5VsmpsK=|uUF zG56bM?Qzm$&dCDj?|m$yHS7wf!jL!f=N+=&Q z#am5UN8i_2uV*|2tdRZfHFH%hDKF2B7;as*0$cPMO2T@0|8;o|dj#%!v*wO;5j*Xc zCe{BAtet)mMJT=xEP6lTfXw~`q4JSOJf=G5=@Scj-AliyON>r7`hOplrhP(=#c$v1 z8g{6|y^`~OrH^^nZN(hmREw#E3UXM|JmxU(nD8AM!HrV-^M1hp{T&5qlb=w3t`BzY zmLMVeBFaRsx5RV^ege025y50uYFM#lenmzr-PPQek0^Eny?tVDxjYL@Dsb2jRxA=N zS9ZXRA9i1ENEsdUr+Xfd)US_abg8zSr^!}|-IDKBu(jzi=Kib*6aj2kc$zFau-*|0 z4%R;YqIxlSDpOa_tAJ;nI8oTfXhY3C+i?G$$0|rP3)kQB#esPQK}<)Kl4!iz^ZR#_ zhZpoYH0Tw+)E4GOzQa{##?=3Pfj1yRZnsr!*xkkVD)|?n78t&}_2koMF?hGc-70HG zfaaSEm12(@F}F`-#-4;?zq&SG+2QDWCPvJ}iM%PyIP3=76k%66IMZNHN^`~EBfC5F zxv4*HXnM^S%2BR@}=vCkYxNM_#CmIr*e=#`8SZII~t(4m2ocT*ckDm9vC# z>sRayKC&o(`028kw~Vm-713ynZmnN)DFH!kwm)t=iW0D#Z~`yO^Z8E@A|f(Wfxu?< z?&y=x!wU!#<59TipU0$JlMF&bCQ-S(B6ok>B=*K<@w(dZ@EL3aXD6g+>FlZVsWZcf zT@Tlrx$R}U?y@J4SB9M&&Wh32Cm@nF!o+pqzCY9nR}s4GS(13ZXE6le=TTiGhw9hJ zjc-^S9XvkQM*1aL-n0a5wotuu>pkt;>st%yZyQ#154wrbEE`SI16NP1zGNE_eu1)y z#M!v4I#Mx_%k#zc!`F2c}EpAnYY%hFG;P?kaJRwav*n zID!-eXE90l>V*$=0%!dLBuAv0Mfu%=PWW7^@oiq#<2wW42P+lz6ApKs7z zP?HssStysXj{6ZeK?&ux!XG=$<6Fg{H@*_hr-OK($c$}iO^J7x7Skz&L2OLpA6b`l zi!xh$WtInl-eIasw(BRQPin6vs>IMyW9eC5hJt>R2&nKueFm7v6V637~ZODj!MSsdJzpr=8=qW8So$%*Zu zo$;B}7;KXa*Ma?RlG>Ybt<%hOx2*&xsJEjOMV{YY;S)^E*ol@;ezTA$_L?I$<2f5D zTD-PqnEZPvtq<`l*l%>TDty+1aoa%@(+R}Cs;u2F;o1~0?@LlERls7;ZjjFx7GYLd zl`Y{21oGl{Dt za=h%&q!k$x+&|Nhz+*LpWl}mckbR-gYDt~>5BJ~XROKgF4>~IX8sq{3Oz_?#$_(wY z%>vIOPA$Gb0Sk8)?stywg*acy{wl_mU9H}EY9O-_wG&}&mC;3}_#eFLL$sGJ7KuYO z0{Ab|3e)4pA?jOk~lrwYzKD7T4*BYWJJg>s)7-@;q|2aNxafYC;@-!%JJXw*)P zR>bLt|F;->CafHBK92&ZeiK~p9e)_pu$HK(I z$L!digPQhmFhe@AyrNz@v9;{S+hgnF0!{)?g;&Bk3_Z-#UO*b=BMn;;F!V44zPRFKKra zIA%l!Aj&zv__OROZgXs}*2$~yQrW?>RQWdik9Y3;M#TDrKxI2OX0pu06t`!H9U@)WjmnTpms2|J+f{i|qKJ<-G)ywld#@w@<4FSYw_sta zS1Ri*zsI#0wYzbA=*BywxvJs)7PR>-c>pnFnOg)ka6_P;K z;<(Yl@01ZhY4|ew3_NwoL?8_-zYUR#AsdO1EBNVL=g4uZEEsoLSI-h z^?*W&UrfwJ)JAJ}u>SlWkNElnam#u@?Kai&>gzByMI!Zbr}Pp@G7sY@O1lX49O~H) z5cdp&s>%>ol-~uO5bfeEgf%x2bra))pjF%`Y%x2lo+m#cd5JX%{VI3EVM&V?JZbg< z_P{N}2w~^i&vkz7fS~c$>O0#GJd7fi?xQMLad3K`KQzzY;IV?r3g zt$X%R-6UOOrPv^3Kl#p%uGjgYXkXx#Zmf-^MAf~c6hI~DTBrQJ?k0-CA6~`I^k3r+a#?{wX)Q~NcVB8rC_vje+ zz8MeXUIGpE{;mJ1HYIoCChI+5tPC(&x|Bl17ceHyQf%mM;><8!9*gL{4`*m-f(dJ2 z#b}bYV`dCwDEg*xj%0`na~}!Hi(%ir#~(xT;%S0?KVE-5s3~u_nfddqW*IB6j8|sd zdME116%BlCt+f}jBS0gG9Gho5`LkG%hv-{MNzcg6FN^^f#3u>L;k@&jIR8T6%6G9; zu~}m7tky~6GUMu9W2V;r3Ai~^m~qEPCKf$3Gnyn7w`ERY$!OH|V-uR+iOiqk>O$NU zKTyDv)4*Jz=V5x9=h(%`OR3gCXD1ND^gaL)eZA-?L;tNh$;I>H`|vBy;Jco^>+Gpj ze}m!ZbdqP7f%@We6_X;gvxSVz990Kzc&zDCNZL{yRW4DxPtrBxs{VdPz+yvLe-yKc zG8%{dTO#Xj6r1m{D^3xt{C-1sw9b%(fig`lPU`g)y!M=mn+l(VD?b!z0TE-x5c8gy zRT9uyE2J-Z{^xoHQTgrg{wjaiuRLTBr0tIS`EOnGh+ok5mSIi7Ap@t6p z4BKOcQ>pqJnG6dhi}!ET{od2FDnm0H6WXxUmCM9zzyCap<0?HleKX1c%8eyo%+46< zHL$eBbgXaFcDLEx){B$7CBynvGW0&^hARx6nY9qP=ETn!J_?oeQHQ1dK%Yw|5&LU1 zNtNU$Sw;09YH>dn&C>8@9~KB`43AekZ|?BCeLfbspnqdtNNm|6-}QUV!9w`^?w>dt zn&v!7vkx-9G_$FgcOsBbCPg?)2jm3?w|UoPg?k+YZOVaJ^QcOZ?m08DkT(!}+iyCq zSS8%FFSZ`790Fd`g(l3X^LKD^oGM0u%WVbbDcGz(RJCEhwC2w(=vko0IZrp|KTH+x zwJ_#6fa}oy!Bz3jfgG!sR-1kO<%vacew(wCq{d7`&z5e?(()GU{kZP2ONEm&h-E?- zuR_PHOo*iwX3-EpGC`XLf)5kw@wRdbQM2&+ppeF@2i6F91i3fWYZ2qP3j-ssKf@A7 z>+J3SU>z@OB|dwFq9*Z*?*>V&PAlbdVD&ey4ND zpH8)vawDWLg2)h$z+(A*K*hx zpZzkvl8NtY)&!VMSnL5%Kuc<{XD+MtiiTA0eTY)1K=zw3&hudvYh$n{(vse}da3QL zb!9eF5r??M@6ESgm44H%5rTE2f^apgaI~bOKU>!Ve|QM8G-#E_5GNA`uB`bX-aChi zxCMTayALFOM@`1g15LrT5m1gy#EB>~ zjDBTYI21Z5!R>8Qaly@95soFb;=_sPrj4m zqO4wTdE`1JnH-5*c$O;X%wEb)qR@hC<%OXx+rYA0@>)AwhD_&12i@*_*{*0cGA_hj z6?eQLugx@f=xHJS`{x=GhjnwJcoR~Avo{FdF;k`;U3u+Tp9G%_zbvVbq`HIya-UdM z7tCDE0{v1KBNW|>z8V^e_5QgCxAd_y1moWtCD8V~0y2G7?N)YDSV7{9f&?s+S%o(X zllR5}rjmBPXV*q!DPXk!kc)~)iq5#9@XcC<#0V7P>sJp}KJ$k3R05J$e%{IK)Yctt2gjg9hF;^PA9EalMl$gMZwicyL>j~~js#UnyvD2Qx zcj`G$s=}}xfaHMCdV`kVB!H0ST2?mWgy*|J`sa;I$#CB}e^9}-xxuylW+M*v+WNZZ zMn;>{1RB~`?d(LoK$AP$6>$GmL4Rkc%)l1ti!Z)pB*T8@7DoKO1$_d^{pAP7>+21J zwT0^Vqh7GqN3Wx&$^6y{eAGe3Yi{MgR;voWa>51B5#(=YEdv19gqIn>Fb@WzDmy3^1mCdM&)4I*NGb64C= z63s)8`r!J(b-kCRks0-!omieqP(Geb#7+T zux-F5&iu^^f#7$U4C;jh42@^ig|Fi<$SN&K?rJrYyt;RzNtzy*mhTTP5HJX&I*ZHw z#fd}I8OyvL0s=JtQb{MQ)&0HI?yiVVERs^rOv9K@5(D72>90Y7rimvE{p!;Midw8k zw#oC|GY>#XUEg*g#{IZvpTYEhqUhNZzME&>{v{hJY~m+)>$Z7vnTiOr?{;66lSQNv z3Frv|rsc1Ngvzy_Crl!lGW4^5b;NMI=3m$#yM;Na4P;oKWk@y7$4DLal=%HJ=EsOS zM=BtGY792sr`T>mm~xHpqiuD*5PggtPDW*eRri{g(rtslnj&UCVSR%XbN%^-udf2x zy7&U`O$Xo^2k=$Pyvf;gtE9H%cu=_>L+^LfhuEGoJ!zJ{obo%B#@*`F;a)7p@cLaX z&YsYs2AaFWT5M_;dF{V!?eFTU6=WVHgx($~EMJhnR`W`2RBiMiPq24aCB2NuCR(vn zkU#(0Mj$&SK^oB;C9XV@m#L1+uSgisVo*isY@ChX#KUzHq76PrdC@FN8t34%LDT); zUv$H)t-0Rj2G6edxHmr{9p#f&P{azl_wZDmfhS3&o8NJw*}dN^7uV6%2^Dq^oigi$ z4$G)nAjqLi$!hJUXD`veZGS1!E`zpzD#|kPazWpP=O!o0hAhDJ9LuPAd5_{PZnv|c zD*}!Rxf7T#w|{}xE5V&t*0;`XOcICSHUn@uR_VB!Nd9u-_sMamee)TTV3sIMt!Miu z$EznVuKQv~*l6)+kCZqKa2a#Kdj%t~PBY*CQ1#*DWK+P|1A-OpGtj@dMfaDT674plB2Ki?RVaFyn` z9P^%xp@l%a^VtI_#~kZ}%?;+~Og81%&xb_|Hl;aBe&Do&O{<5xWr5>|#kVKd2dXT7 zKgj)};c`Gc;QlBl(eUy z;RshXAf4b=4a>Cdzx+bUc9W0d=?6_re66h{~#F%(2o=v*A@;Q)Kl~r zBuUK*CKZrds_V8 z|LP`A{^?S4v_qgdxcQm%9hM2}>lYiR9!P&({uQh*2QDC7#?{<=Cono>XB_+UE;{Bj z*6Zs3j^-KYRkdb25}tta6JIm-@1jukh$5mNPTu;@eIvw-S)GT9Nh;^zj9WzlmPv&? zdj3Be6mSPvv8;J;Wpt1A~yt&pYT${P@Gca4LtRP$^bg>`SmR{rhjq zW~d4~16Rtnp-^tj`Sj!}Tyk`BVr;?{jMx_qvJiGi#|6n@alAz5j}9b`K6fydN4s1B ze9W2H32IPvyLWH>-~5({>%q9$|q zHjN4Xv=aCUaW74h!e%hGRqA;NGuV?W9~rJsT{iElx=eUc^OiRtP)GW0+fS_UWO*@{ zr5I&UB8C5`b8sn{M5kY?<4U!0r%-}o*~5K^k_^{OciK@NGb4lz-i;Kcbd>HwBkKmip;FpE$( zkm4Q~u6iJaU}8V9r&ZfAPhfVIHd5*ilE~1hXz(SptB2BMtz@tC$=>gOlExJAbhkuC zrPO+PiO z21AKExMoK2H>#)oGjF=l!^i$&M>5L#Yp3u4DCCE}) zPYZ7G32V2y;;yk&`q7$!kFy7RWejZx2uhy4o3pSUgg?_l1-i`-`V&+ztyknIKPrzS zenJR5cdNDLB&bM&j~0P+L( zQf|5^oQ2d|)RGA&inz0WFP~XCf%2e!8o>MO&Z{aX^I=F{Kfmeu^`sdjPQ=Fsq`%9( zpYxWfjlQJ|LfaRNTrU#sDcIU!8c;<9FSMjaS2b5d4@tt-((MRXYukXzIwj7?H2CIl zYY5!$t>LEG1lYfQQd$JwPr`JcqxqSHLsnY;=b40!h~De$n^ZwkR5=k>#0}<7_l3+=!U%3t9pJWAIU*`>5ex?NT zyrF6De_;E)^IkYb^#7AK2mcZhZNFX62MY*QeblGjbDS37DAxa|8K@?aw`KNc1|J!N zP2ku4v)qF1z)ylfra8yCBtCn@eG{5t}z6ih$re`xwv$WU#7(W8V4kw68 zAzT<<_1OK~=?6uB-gBIC-$_OXxbPKS$6vbwJEC4WD_bp-t%{UqK&p{X)vCCat+mjX zz6GUy`G#+fE(%_byiv$^3>8u&WbM|^7BzCsSgq6%@Sb~t2)^*gsEOiRyM!OubxAn@ zI^}m2YJZ7{0PX87P_X~jvCNCU;v^hyN@8;ZU~yfOS5h?lrdB3`{`Rk%!U#F%lf`|w zx~?a3%NDA~Z2rvE7SKFHb$^$iidp0NX~L7fg$3dlr_bPkYXwGU0xs#)JsliWUm6Ys zYHg!`ELk?iBf6JTsBj}J9trYKn<4kv6IHdDJOx7c^pHA5M073WD~}OBh{B}_k{rew z?Qd)rPZX$Hp)&di-Z0DZ2CHSHoN9hwVLOSs;4$vmQ)?#dVjyfcJr{?mYl(|k0V4%- z;h86nP_u8Ha~QE{mL}4Wh^?3c!fwO+q@X*jrHjg?J_{{d1v z$8RQMQ@ENNUL8X7UkNYePhf?*fB_u^$CL-#(ib>)T>< zDbP*9?#bGJXaEZEvRe58*S^TpEt=S!6`U00{k+6)Ji`95uvKVu_4zunGGqk7nQT{L zjL3dTy_vY18!4{48aBr0h;UElf->@CsF{i9?Ng4Vu|xrQp4fkZG39#hcZXgmMS zk#%dE!|sFaAD+iO)TIsI7~Kzc2y+}dMFq%%qJ_0CUgG=O6ZLe*1Ji8j+AT^c2=laF zIgw3xhusfaQGSVvV$)W9!s?PuP&%efz8cXRQnb`RkJWnZqPiPy;IQ8y^ZCxCL*g&u7|0xh+ zQ=q#;E<-z)(S4=Kp0{V_km%9p6FX-OxC8QLhY}hpV3mX;~4KI^XDmS6K9gNbg!lJN?Z)}m5uHc;-H3^`XrY<@02g;CUtlyn| ztepCrL@ZCYOmViP)fQAl-k@Wz+=yRe(iDLde17P|O8RWd$8^?TCrNgiG8cKLzC7+0 z^?>T&*N5UiLT@$6NMB@dtlh7y-#Tmhe9KxY32)1($gDugq`g@<@=EBObEtPncW2SR zVeGXiFW$+fLA#iBo91$drq{-jXkoVgPC{m)_ss|k@AE+6Q;P@gy&q|51AK~R&pm~T zSoo5X=O49RU8`o&h@$uEfA;`_;Oyc1w{a!5`!3Xz=jU~r-pKA=GvG0vBb@Aye^@{J z%>AMoTi-PZ7K?8-)tnry?td|!Xz05Co%piZi^<=m=nn+99`-T(E1(Go#~{NcaSa(4 zoeUAU(~z6p#;$J@qHDs%+<&JsLkQZZfPb}9dCW3Vj^5SkS9n4%@7lYyc(+EnJ&z4n zxT?4TJ~2f7-yihHD}?g)JiV9FDw*+ec9Po5pl(USO4a6ByCbtiV_jBVh^etbpwCol z!2R8nYadq2-z@5HcZG>H0~C05<&~+sR*6rbS9aKY2ocH6UDonDdoS?iFFxkH?PE9IpFbF+`Z6RNIcopJxoV(_S^bez zyf=nHgb`s2*ka%G3C~a>q7~%IW!eX`lWWTr0iq_}T+9!o{u7C-puQAdn@u+bS0e%g zN?q{6N$rX`)S_&OyrlW!pRj!U&MySK?l&_Lx2ZO`Xzw=grsM)BaxEd2`~no)Da)ptNk`3nTcrN|lyXR-iJCf@9Afct)ySW@-- zD3q-^b=xN5kVZJ8q8$HyQCfU!|MvP^zh@QGw~pP27fgX{6yn#6?oZ`h2MGUaWd>q_ z!ia@<>P57J%=+B>mPf?}PW&nY&V9XE z0mLb7#F5hD(90&eT>GP$@9ohMEx`lmlth05>i4=wq(1%)3=QUVij*zFmpRV=`ygeR zYOyYifF#=t>P1M47Z&%cMSe=uVL-Y;Ja`z%i&#V5%l?25G!<2g)*HtcCm{_NYy4)#7+4axf3OeMz~31AE2aIF+(qI7oQv* zF5Nn*sMj-FNr=BS+kPPORl4YETIJ;E8r~lr$A3piEBNVS$4$jIiDcZz?C6=+vgGKeo#{F!%H{;%0D=_TZL8{w6fgEx~7n--;r3l9+lBb-c zmst*U08DrBcp%?85$xn&dS13Kc7AexNO)&U67M*FK#_Z4@55ZRo3F=GUznERlk52Q zP>Nyjtr@4VXIOL)y{S|LeyV+S_o+&G-gQ-k=<9n*>?M;*fu%@~Wy)>O*0wnQqg39q{zVgCrK%RILI@GySan`g-? zxL6d67!Ah}qZwyVSS@jyR~scxe}x~#+-R@%(#wngd|n4fUW|K}&! zU{vmMC)g}B7xaebMvWQigM3v$L@jvl8Xg_&mXRq6e?3b`V^VWC&08PEp^i0br5Dbf zlQ#hgZ5cvN(s}C%UJ>=FV;^+(AkVujAip8-vd!%)4i<4sHU=ht=9gSLIAu$s7rnm& z6%;rd1fPz*t0FWj&p^E0`t$YPPN*8R=gWKvrRGcd zX37BeLHwI7KA4zT8@zB6YHsLC!caf3CKuX4Qt97(!vfpo#Wyf_e$o=b6u1o(e{K<4 zP43q&VJpCdq^wqp-35CwG9BKUaiyfmVKU?VgZS3~N?zPyo5703o0l{sFfI69P)ELNLP}mky<&$e3Tx{d3w% z3>@;K24lOsRT1utRac6XAV3Fdm)#(8S%zo}w{2b}A2B%|&n`jYNW`7*QN~gKM~~|} z&f8xM7?1`Mw_xHgL-bJ!MWF(X`cJE5##p~O;5l1JZ~iHT1KqA#-SC1C(=1>7!q=Gh&6MoV7U%lF)N|b2P@uF^AMgjZr##B zp!OiF7^Xo&Sma=aU+CY23~LY}PI(?J8q`;kA8vU-NeRh8K7&(5-Sap5nl*o-fm`|= z@%#G>B`k@oo=F-Cvl1c#DxOcs7#yHF6jzs#IGZEBY4LVg(^s`5ccEfdXC~R_JihU2 z<<7&;u)->@j33Sj?d;Z^AiY=~u(9}4Y~rABP40O;GJF&oNx=k*Nd*OX=E*#^&$Z$N zE0BD|>)0@+zi`BOckgBJ-rnA1^TxUXN)Dd6X!M;9>{s>TZ0eC5(IWcJ@$%| zNbioBJ}m6kq{At8rjUh?9Tn>3oKNG#JgZOJn;qo3FLb{5;Wnrqfo+65MrF>bH>*oO zn1kiRTm8H&9kzu0Wyq%ZK0Qa)enWRit1}Y7^TajpEgmjo#6?V$i36QB0jzuxw%(N7 zI)ebo=B1^jwU_p$XqK&vU6gC>>D_PyROlz9eN>f2eKgtTqIUD$jpKerJpC$;&d~ls zA}7gUyXyJ09O7S1wh8k=WLq5o)6*MD?(bSpa;#rW*XUk#Uv*{L(I9ZY^h-WPpw6FTw^k!&N1xTPcnDLej$DuYnt6BHl(thi21=Ve8Jj;iE*D(3iCfaWDs7)u zOjF(hMDdPe-kr#NRgHjLi_VHyWbBIPMt@jL^h9?-$i(T$hy5J@iSNCn*}-aC+M3dq zoxc2)zMX*F8G?T}5%;UgNFAU2T*MSv!ZMx5OocNezoq~FPYYiWz$fqInB3=%075_E z=pbTpS^h^y(`3;>il&z}Kc~L$X1p7AX~)mQ?E=pyH&@j(4J~Wz#fi?KaHph`J7#BV z4^Qr1tr$9MnRf?$5;f4e{zv9M_nC#rZn6HGHtxWuGwo3OV02&V=z7?Co`;@!u0{dq ze|&WZvnnxpEk@ozTH3%<$x9|Z5+H98}@rzc@fhI#@YR{PjtDXvVC;e?T^zssO~vtwO4nB zSJ|~u&+ccX4rlA>Fj_Vzz83p`q!)Hc|8~;o(^<;>(&|wv272hRjGH@mDk<1+Q_CNnF_JZ^#ej zd<@Lu2b65c7yb2L>MUrlTv@;QzmLH{P2&^)e{-5zcSg=g!<)#Ak-;1lQ{nYHB>0u+ zXHl2a8Gi?53bcOQo0Y`Acf99KL^Zxw-u^N1! zz!_tNtZ1hrtRQ7X&&b7W|8oI+6pZMm|6iVDMlTucybRxpb{w29{Q3niE37Kf{asmT z>_?_?9EMl{f+!>ArFVcK`UA^iku&zk6DzbRm_HNmS-H#jy5gyGFSE=yTmq%N=l~ z>q{-W?5ek5`~FZPHd;djJ#iZxaHU!woOYqOOXCxAlzSyw#591uH(O`#Y< z%0VPPgrfKk(2aG>&9jln5#|epcVwd{Rn-{HwZ{*EMqCUNr1{NtOEbjM4JttK896*v z6vYvBsTTgmyp_$5d&8^dzI~ikp=3l$SL_V#@}pYCe&JK$)6z@7xn^zz8R188N%J$^ zO1Kk*ngWpQ2`uxb{f+*^B+9}H`5z-ANiByzWnZ@*5$=tx-dvF^SREefDc0R~U#C%*(2{W=EW~vG8VzcjabheNa2b0Xg_L3dtbUC!f|<_xyrEKuM~Dt;>&muzBc7q zVIN73u zFUh#?&sY(yqW7NW+Pyq&i@uE&OKe%cVXC#ObC?R=D)!Tus`eQt#A&5>`i~Pmi*S(p zOcuW?1DD?}-%g6#`@joB+qRyjK>WnXe9b0QQ>%ec0e+1%=d;H9r7 zGs*d+pQ6hFDLkvH?nYOhlU?Q;vQ3{GN(^qIOqK`42hSYsJ(fKt=_X27 zB6zxY2KF5!!rvk7Tund0sr6JMSQd+SUAAjrCx+feDErz>Kba%nU&p@jnh|A}*}}I) zw{2%E%>p;DW_~0+g}jDf*Me*HU_o)ShD>K{{9rKizT;?x4$nSykKkdseB#QgZ3$6s z*$gVXIo`8h%O~8jnzcV7->aPh_vm#@)+oE+=yPdvQMl&bn3Kt=6Iaz|TQw}LWyxLn z3%3$*W=0DSsiO_NSAH9RPv31#YBPw;j>nx7rh`ZW3=VEaHFhTscxG|ZWLBk!bj&r! zg_oFzRf%YzV+8Ma@y+&p{B%Jh%G)ccJ7pYwBq%*CT6BS&PxT`yBSBW>7E#m*wu+a+ z`S3rOs!qMm4?UOylIk_lQkPrw?jAD@oX_y!X-Np{R0J9~Q>N>p*q~^~d{gn4jb3B! zZQB^3=7nOeU(N5rKYnr1i1qebK!Np9 zI&tiatt!5B7Fl)Cd3bX|s=QB4RJ=mE-Hj{>dHiYF&@;qBQTJWFdJWE(@PDvZ;Z0iE z{kqvNvtkez$g??f2c2hrQ`)|rAK8j3C}l;z%hyD?WM_7GGHmNtIsOs4yScC%#pDPp z&B#zjmD$B9dh#Pr%|C|yzwYhO)Aez*9uf3pm^RVjKLB*a0Su{!ps|f@IfX_j>;!I1 z5r?r@$l;T)##(S23o2w6$}!7>3bJLG4&}D0vVw=rNu9#Ac%cE* zO+owV?HAYtxlsGB7^7Q6vdkA=Wp_RlHPSvHr-9f~IXhPLzzv3UQTP*jrbBS@`l8pa z$m)q}w*m2y?;6jO)yjT1(WgzcMwnO@mkS?vF(WQ~5YgxPSsK|OspoCXBc4C)} zM~>ZMi??1FyJTFC55~|YtK#Cx@zL{E_Qc#8J3&3pJ-O%X#UgA*l5qdN?k@niihx7S z%CqrdCrFDJ39!($K872sX&yq`y4kT~mYuGCBlw-Z3A*DU11ot!9_Q0Eeob^~#vCRn z8Hb#1j_48W$TMkUnbqnZb;cfHD3poEyPOgVqNwU;3y+dIs845)w-LGQ`PYqF$HQC# zn8kwILxTV8wc?nHqyZ1pi`sB|W6-d;BO=NXZ~)rzUOwGzd#fRK*jeM#bEtz5Z*x_~!#*vu*)LrgC~(2>rEfkDM~S5jPE)z}O< zPa^6Qy6L0-6^g&d9U%Zm+Df+tosIz(2yZ6{U?#N-UL$epDI(Ak4+-_7Pr20Id$@Ga z&af0Rh&}Rv$kQ;X7dB+=OQMw0jK?VO{VtxzUqadp9s8!gJdHTa@rW6FjEvZ@f;7Ec z#VDVSsy&C(CNo21BE_#DgW=7HND~mspwH=S!9d|*T2DqL|04W*gkI>IFzAfb29bY* zEIc^;#S5W-KbVJYrANhx9xF)sAyf-XA9tlNbKQ`VhWkpKB?m){CLX_}oQ6Vr1tPtY zxVpR5tdQ&T{)SZ^kimbkS|V8%TTWg+5Ax(4$V0S1W*wyNZFC60@jm}22Zmw0B1Ax6q4-(*t8`ujy97r%SuG_XbA!z#!B%;v%sj1Iwq;KCFU z1p(^%V_~3xAvIEk{Pdn!5x^$R{q4`+L-dX#==8m~iJ#&0_Yl#g5E%?nn!5kqh3{c%w*_A8r`}@Hmkd?p_%l%cDnwnt_(^=5L@g=FN%eae>oEie|hI*T_-# z2#c93f`*O)_xckkSqEy!5=GLJ+i$KxXRjgXZHi*Pn5Z7LlP}e=^()tp(+N0__nu z0{;~(SA@L2vQ>{x=LVWl+snYugmCN6 zs~E0z}OGljFu*^Z}4X?9NE=kjk0YZ(wG4yE3gEhRqN{gnGn3DaE7OF zBTK;@zmw*=1-ZUOpgL!o{{LQCV#XV1i375{{AChSvwmgS(#gxq*AssAKX<_h_$V6b zqx}>Vx}!q|#~ZPTO(Q|xt58}Y!IC>J0cjM)%r`QS+0%HbR_a=#+Q92;eklA`3zZsP zz4DkFK-vF+M5(O;Mv6Q&9M}9(^VLvc6RS zYYaoV;S)`?T$>nJE4;t2_EmjxcbSCQQnIZMZXB8mCSXyPG`@-zivIVZ#;q~myiErC zA2Rmh117>#5fXJSy(!tj&p&w}W6W)>)TTULrjgKpZh(pPvMQ$UjjF>1OQKgU8TO`S zOLzU{+bnO>GgcA2b-k03+KjAa=tCsBE-;p(HujzZpTsLxL&fRycjDfh)6rjC-(;Xr zEa4`~yRI$NcDjK`8hBw`IJ%jJCB^Z}yF(&P2akgJmfak2er-Np8&dG=49d1=D-*TQ zr6Fgza5{Bi&Bf6EVz1O{%=nA@1-`@aLRYFkw52PPPJatcBFt|u(C-pF7PA@TzC2(k?9H}fVRawK zcFuZ#!m{ftS^1HryF2GMu3KhZ0yyYPTCW0w8fcJeJ@OdvGyL~90DhF3eW&TU<|~J- zFuJHxc68%+z@^h>CMiD`&>s!4|=;ij0gT<~gbkwRo@2xJBy&BFj8M>yh%pkTM-X%YLqxa-n_LD|wI= zW!pP(nvkriN}irg4(34guQdvkFVC-8F&C$;W*QFRg(`mqYz1F=q6m&y9R~LszEZx@ z*h(b|9Fi_Msi=$@HLu=3)PL<8jOgd*7-3lyqvE?ExiBJwErTtakdV@u8G9$WvLfn? z31q4gj-SfV9O#AgwJgSY?ub8Qx(w#tA#-2rtdS|N4JoeKh1Y#d5lWa(4b^MaIN!fW ztt@n})S3*qkQ@ zNL&NZz9@R~zTvEhS)Ve+jI*+yr6n_J1Zic89FiPY|H!{rTfMHgxJD_P7mEqUL1b`p z()bmHiN(yBoNr1qmI6{sJ@2_e^JU<|qRlf8K(kf?Fr) z#=)o4$@el$rv@FvBmgaI;lN~n8DA;){y~F?oDu3lfqRuZB67Gf5c!z`J2lM5$;fDsuB^=^*qT(4ImA*i0VDaNwiWW4r@-7D? zQN`2A_H}3dXzeL3?#abE9kl}z8RpAfAx60pIK^!}C8w<7)a}6y<*7dneHkx8oOl{x zG4m+vqq&~yGz7PP( zpc3M7Q5A*U?9*ck;KqG<{*mvW5B~q*B*{D2Q1760sB12%ky*k#jc0mc=BVWG?NE8s z;3GC1{qH4kT<6~VTa>d=p2i`UHN0=SiZTS1ti7g%oPrue#?WD?5$PJOTmHAe*aUe9>LI{VFRTTUH^Rt$k43X60EjQLRmLMJQa1G_63nbt zYn0i;cRqpi>^*Cw^-_Sw<?BYr1K4u8~wI@deV(1OVKjz~_kx(EUY@^Q5Wzvw- zB!nLVWPUR487bJZvquN?&s7%bz2G~&v25^$D13^ef(_vHfcvu4goRb?!_)jNA|K8- zFUQ9K=gZ1E7!Lku+C~XBQBiq1B^);1p`OkE%iuP!9(!{s`I_T4$R?+(Sn?V{u2t7J zIHEoxMSc1@t3$|?D;Kaz5>Spdg|EN%@7Ldidz^_RB9iLKAK+NZ(LtWC|M%&^p?rV0 zgeutjpOJ;ZHgl16MjS3@9$3{~b4?C-O{e$!pX7j8#oO+4L6sBehOmrJpZo_H=3k@8 zLRZ2lMC^@;sIUHCyGoJv~R-ff(vrP}g36?s{Qu|rdi(JF0@Z{##7 zW3^$EU0PvDI?Y5O#5-#dx_FgS7)5fbxR~S=!<u#%BM3y{`4+T;_W{*LdTkh%sn(8VQkR#BQpH70 zyM4e&Vv|<#Q7kiMd6_g+d3Qv0P_+d3!$%kATTb}_IJ_|a1Uto!;mkPF{~dpnU9^hq zHaEP8!JC0LDvmMWQ+0<`3Eh!97By!Xxh5*<`oWKZfSlvbn?gOe9Jo^l0r0zBVH|ll z-unLrZ)!eDFk9xe7bO)udS?)(FGWn`PCq94B$8^f28h`YwNeM`=m#HNwI(D>7vgb? zNvvYhOo9rKSKs^DvN^3FYHt@5N4UfycNW8(R9<^U#PPAdDpSTGb&K#=^0Z{^d0WK+ z191wqkU9U~-%#zmLc`9GQc0#8Q7LXxfj8{$VAkICs$JQGwx1*`W0)naSBMVu7dF9Y zo4CR!*AFJ|L}BU79O|uYr6wL=>3CIw!`Q8~#lw%NPe|VITzHhmM;o)`f;OWYO$>7O zcpSPqbSVnSZ2i~ynM*b6eN6=V=ExfzYvgESIn5D#B=iuQ+EO%(R^}=(;un5>1^f00 zVK@@*_$O!KXK?5ucV&(Lz;e(F7w9wr#=%zK4ovw(Q%da1_M5sK5+McCvXLtm^6*9IfIM;naX#^9c9(-r{>&~Hy;oj!Y zL_wwQo6|}S`}b+bC8Sh?ajlv#4KLh`fT5vSy{nFiIowjk4N)^AYj$U|vOPGx4@1YU zFLt>zqK>uh>hR{=p8V8AP#ulFyzr&6C=e(VnJrXlSpI0ywuWsd)~jVTyz!>C5L1$+ znBHvc$PhptCX&9QqHNDmnJQ5l2t=6Aj5oiH7%QS69nqTQ1y)w{WwUNE)N z_}$)~ybu@z5u#_7BakRR=P=p1b92&9r(I-@J&F`G1xB~e==d9(X8xJ7g;0EBY#9mj zvKlL5a66`tH?dU`OmPGI%#J|*Z%1!t5y)A@6)+0cAvJTR3vK6Z9d5M^$!ybcE7xa6 zgKz_(6^~+cq3gi%m8)!DeP0NbJu;Y%GP5Tev=jZ_G$Z&R)=n2$om=lbey(2LU|N*< z{8cEY5Ckxbm=mNw#`M0;Q<|HPllJr0%X{|tI_2eNyBK`iAWQF>LG`+U)jxPY@uPYW zBJ9i^9rD_Sq!i^srzcU8KLJymkI9Zw7~k+P6XD;tz$@c}Ss~SKZ~Vro{UnummI%pM z18<|cXCq4#?tn9Xc~bkOMb177Vq{fZP8djR-&-kBP16?Q)_O>O?l8P(lw+7-6$7SO z`oPw+D4Wmk?3f@Uc_oB1muE@W{fU0Ve)X+Pocl1zRBn8^suw#s65JseWcMB>RFdM$w+LBnW^d zy;H$(R6LS-`3%9WFryfN$Y!lT0M~(cV2XRMbqg~0jJl28SP$!Eudvz5JukD*o4$Zcx83fBza*u8Uln&H=fXjt8BBoXTeU@5Rc;=ohhC z`iNEG!2A<1BmK);57&GzHJj-9w#EexY(#mn*#44}b?G*PfS zs;MEqRaOA%g6%1P?NJlnD`rS`?)dBdS?2DKxj}n}O|`` - -## A quick introduction to BLE - -Bluetooth® 4.0 includes both traditional Bluetooth®, now labeled "Bluetooth® Classic", and the Bluetooth® Low Energy. Bluetooth® Low Energy is optimized for low power use at low data rates, and was designed to operate from simple lithium coin cell batteries. - -Unlike standard Bluetooth® communication basically based on an asynchronous serial connection (UART) a Bluetooth® LE radio acts like a community bulletin board. The computers that connect to it are like community members that read the bulletin board. Each radio acts as either the bulletin board or the reader. If your radio is a bulletin board (called a peripheral device in Bluetooth® LE parlance) it posts data for all radios in the community to read. If your radio is a reader (called a central device in Blueooth LE terms) it reads from any of the bulletin boards (peripheral devices) that have information about which it cares. You can also think of peripheral devices as the servers in a client-server transaction, because they contain the information that reader radios ask for. Similarly, central devices are the clients of the Bluetooth® LE world because they read information available from the peripherals. - -![Communication between central and peripheral devices](https://raw.githubusercontent.com/arduino-libraries/ArduinoBLE/master/docs/assets/ble-bulletin-board-model.png) - -Think of a Bluetooth® LE peripheral device as a bulletin board and central devices as viewers of the board. Central devices view the services, get the data, then move on. Each transaction is quick (a few milliseconds), so multiple central devices can get data from one peripheral. - -The information presented by a peripheral is structured as **services**, each of which is subdivided into **characteristics**. You can think of services as the notices on a bulletin board, and characteristics as the individual paragraphs of those notices. If you're a peripheral device, you just update each service characteristic when it needs updating and don't worry about whether the central devices read them or not. If you're a central device, you connect to the peripheral then read the boxes you want. If a given characteristic is readable and writable, then the peripheral and central can both change it. - -## Notify - -The Bluetooth® LE specification includes a mechanism known as **notify** that lets you know when data's changed. When notify on a characteristic is enabled and the sender writes to it, the new value is automatically sent to the receiver, without the receiver explicitly issuing a read command. This is commonly used for streaming data such as accelerometer or other sensor readings. There's a variation on this specification called **indicate** which works similarly, but in the indicate specification, the reader sends an acknowledgement of the pushed data. - -The client-server structure of Bluetooth® LE, combined with the notify characteristic, is generally called a **publish-and-subscribe model**. - -## Update a characteristic - -Your peripheral should update characteristics when there's a significant change to them. For example, when a switch changes from off to on, update its characteristic. When an analog sensor changes by a significant amount, update its characteristic. - -Just as with writing to a characteristic, you could update your characteristics on a regular interval, but this wastes processing power and energy if the characteristic has not changed. - -## Central and Peripheral Devices - -**Central** devices are **clients**. They read and write data from peripheral devices. **Peripheral** devices are **servers**. They provide data from sensors as readable characteristics, and provide read/writable characteristics to control actuators like motors, lights, and so forth. - -## Services, characteristics, and UUIDs - -A Bluetooth® Low Energy peripheral will provide **services**, which in turn provide **characteristics**. You can define your own services, or use standard services (see section 3.4 in the [Assigned Numbers document](https://www.bluetooth.com/specifications/assigned-numbers/)). - -Services are identified by unique numbers known as UUIDs. You know about UUIDs from other contexts. Standard services have a 16-bit UUID and custom services have a 128-bit UUID. The ability to define services and characteristics depends on the radio you're using and its firmware. - -## Service design patterns - -A characteristic value can be up to 512 bytes long. This is a key constraint in designing services. Given this limit, you should consider how best to store data about your sensors and actuators most effectively for your application. The simplest design pattern is to store one sensor or actuator value per characteristic, in ASCII encoded values. - -|**Characteristic**|**Value**| -|------------------|---------| -|Accelerometer X|200| -|Accelerometer Y|134| -|Accelerometer Z|150| - -This is also the most expensive in memory terms, and would take the longest to read. But it's the simplest for development and debugging. - -You could also combine readings into a single characteristic, when a given sensor or actuator has multiple values associated with it. - -|**Characteristic**|**Value**| -|------------------|---------| -|Motor Speed, Direction|150,1| -|Accelerometer X, Y, Z|200,133,150| - -This is more efficient, but you need to be careful not to exceed the 512-byte limit. The accelerometer characteristic above, for example, takes 11 bytes as a ASCII-encoded string. - -## Read/write/notify/indicate - -There are 4 things a central device can do with a characteristic: - -- **Read:** ask the peripheral to send back the current value of the characteristic. Often used for characteristics that don't change very often, for example characteristics used for configuration, version numbers, etc. -- **Write:** modify the value of the characteristic. Often used for things that are like commands, for example telling the peripheral to turn a motor on or off. -- **Indicate** and **Notify:** ask the peripheral to continuously send updated values of the characteristic, without the central having to constantly ask for it. - -## Advertising and GAP - -BLE devices let other devices know that they exist by advertising using the **General Advertising Profile (GAP)**. Advertising packets can contain a device name, some other information, and also a list of the services it provides. - -Advertising packets have a limited size. You will only be able to fit a single 128-bit service UUID in the packet. Make sure the device name is not too long, or you won't even be able to fit that. - -You can provide additional services that are not advertised. Central devices will learn about these through the connection/bonding process. Non-advertised services cannot be used to discover devices, though. Sometimes this is not an issue. For example, you may have a custom peripheral device with a custom service, but in your central device app you may know that it also provides the Battery Service and other services. - -## GATT - -The Bluetooth LE protocol operates on multiple layers. **General Attribute Profile (GATT)** is the layer that defines services and characteristics and enables read/write/notify/indicate operations on them. When reading more about GATT, you may encounter GATT concepts of a "server" and "client". These don't always correspond to central and peripherals. In most cases, though, the peripheral is the GATT server (since it provides the services and characteristics), while the central is the GATT client. - -## Library structure - -As the library enables multiple types of functionality, there are a number of different classes. - -- `BLE` used to enable the Bluetooth® Low Energy module. -- `BLEDevice` used to get information about the devices connected or discovered while scanning. -- `BLEService` used to enable the services board provides or interact with services a remote board provides. -- `BLECharacteristic` used to enable the characteristics board offers in a service or interact with characteristics a remote board provides. -- `BLEDescriptor` used to describe a characteristic the board offers. diff --git a/src/utility/GAP.cpp b/src/utility/GAP.cpp index 695b1c99..85b9f244 100644 --- a/src/utility/GAP.cpp +++ b/src/utility/GAP.cpp @@ -22,7 +22,7 @@ #include "GAP.h" -#define GAP_MAX_DISCOVERED_QUEUE_SIZE 32 +#define GAP_MAX_DISCOVERED_QUEUE_SIZE 5 #define GAP_ADV_IND (0x00) #define GAP_ADV_SCAN_IND (0x02)