Merge pull request #78 from fpistm/sync_1.4.0

Sync 1.4.0

Author: fpistm

.github/workflows/compile-examples.yml

@@ -12,6 +12,9 @@ on:
       - ".github/workflows/compile-examples.yml"
       - "examples/**"
       - "src/**"
+  schedule:
+    # Run every Tuesday at 8 AM UTC to catch breakage caused by changes to external resources (libraries, platforms).
+    - cron: "0 8 * * TUE"
   workflow_dispatch:
 
 jobs:

README.md

@@ -31,6 +31,17 @@ The user can include the file `app_conf_custom.h` to customize the BLE applicati
 Options wrapped in `#ifndef`, `#endif` in `app_conf_default.h` can be overwritten.
 Additional options can be added.
 
+The user can refer to [AN5270](https://www.st.com/resource/en/application_note/an5270-introduction-to-stm32wb-bluetooth-low-energy-wireless-interface-stmicroelectronics.pdf)
+
+##### Examples
+
+The user can change the Tx Power by redefining `CFG_TX_POWER` using the [`build_opt.h`](https://github.com/stm32duino/Arduino_Core_STM32/wiki/Customize-build-options-using-build_opt.h) file. Possible values are listed in the chapter 
+**4.2 Tx power level**, default value is `0x18`(`-0.15dBm`). To set it at `+1dBm`, `CFG_TX_POWER` have to be defined at `0x1A`:
+
+```
+-DCFG_TX_POWER=0x1A
+```
+
 ### Shield
 
 The user can include the file `ble_spi_conf.h` to define which shield and configuration to use from the following list:

extras/test/src/test_characteristic/test_permissions.cpp

@@ -0,0 +1,126 @@
+/*
+  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 <catch2/catch_test_macros.hpp>
+
+#define private public
+#define protected public
+
+#include "FakeBLELocalDevice.h"
+#include "BLEAdvertisingData.h"
+#include "BLETypedCharacteristics.h"
+#include "BLELocalCharacteristic.h"
+#include "BLEStringCharacteristic.h"
+#include "BLEProperty.h"
+#include <memory>
+
+int property[] = {
+  BLEBroadcast,
+  BLERead,
+  BLEWriteWithoutResponse,
+  BLEWrite,
+  BLENotify,
+  BLEIndicate,
+  BLEAuthSignedWrite,
+  BLEExtProp,
+  BLERead | BLEWrite | BLENotify
+};
+
+int permission[] = {
+  BLEEncryption,
+  BLEAuthentication,
+  BLEAuthorization,
+  BLEEncryption | BLEAuthentication
+};
+
+const char uuid[][31] = {
+  "1 Bool",
+  "2 Char",
+  "3 UnsignedChar",
+  "4 Byte",
+  "5 Short",
+  "6 UnsignedShort",
+  "7 Word",
+  "8 Int",
+  "9 UnsignedInt",
+  "A Long",
+  "B UnsignedLong",
+  "C Float",
+  "D Double",
+  "E String"
+};
+
+std::unique_ptr<BLECharacteristic> createCharacteristic(const char* uuid, unsigned int properties)
+{
+  switch(uuid[0])
+  {
+    case '1':
+      return std::unique_ptr<BLECharacteristic>(new BLEBoolCharacteristic(uuid, properties));
+    case '2':
+      return std::unique_ptr<BLECharacteristic>(new BLECharCharacteristic(uuid, properties));
+    case '3':
+      return std::unique_ptr<BLECharacteristic>(new BLEUnsignedCharCharacteristic(uuid, properties));
+    case '4':
+      return std::unique_ptr<BLECharacteristic>(new BLEByteCharacteristic(uuid, properties));
+    case '5':
+      return std::unique_ptr<BLECharacteristic>(new BLEShortCharacteristic(uuid, properties));
+    case '6':
+      return std::unique_ptr<BLECharacteristic>(new BLEUnsignedShortCharacteristic(uuid, properties));
+    case '7':
+      return std::unique_ptr<BLECharacteristic>(new BLEWordCharacteristic(uuid, properties));
+    case '8':
+      return std::unique_ptr<BLECharacteristic>(new BLEIntCharacteristic(uuid, properties));
+    case '9':
+      return std::unique_ptr<BLECharacteristic>(new BLEUnsignedIntCharacteristic(uuid, properties));
+    case 'A':
+      return std::unique_ptr<BLECharacteristic>(new BLELongCharacteristic(uuid, properties));
+    case 'B':
+      return std::unique_ptr<BLECharacteristic>(new BLEUnsignedLongCharacteristic(uuid, properties));
+    case 'C':
+      return std::unique_ptr<BLECharacteristic>(new BLEFloatCharacteristic(uuid, properties));
+    case 'D':
+      return std::unique_ptr<BLECharacteristic>(new BLEDoubleCharacteristic(uuid, properties));
+    case 'E':
+      return std::unique_ptr<BLECharacteristic>(new BLEStringCharacteristic(uuid, properties, 2));
+    default:
+      break;
+  }
+  return nullptr;
+}
+
+TEST_CASE("Test characteristic properties and permissions", "[ArduinoBLE::BLECharacteristic]")
+{
+  WHEN("Create a characteristic")
+  {
+    for(int i = 0; i < sizeof(property)/sizeof(int); i++)
+    {
+      for(int j = 0; j < sizeof(permission)/sizeof(int); j++)
+      {
+        for(int k = 0; k < 14; k++)
+        {
+          std::unique_ptr<BLECharacteristic> ptr = createCharacteristic(uuid[k], property[i] | permission[j]);
+          REQUIRE(ptr != nullptr);
+          REQUIRE(ptr->properties() == (property[i]));
+          BLELocalCharacteristic * local  = ptr->local();
+          REQUIRE(local->permissions() == (permission[j] >> 8));
+        }
+      }
+    }
+  }
+}