Merge pull request #74 from stm32duino/rebase_1.3.7

Sync to ArduinoBLE master

Author: fpistm

.codespellrc

@@ -0,0 +1,9 @@
+# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/spell-check/.codespellrc
+# See: https://github.com/codespell-project/codespell#using-a-config-file
+[codespell]
+# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:
+ignore-words-list = ,
+skip = ./.git,./.licenses,__pycache__,node_modules,./go.mod,./go.sum,./package-lock.json,./poetry.lock,./yarn.lock,./extras/test
+builtin = clear,informal,en-GB_to_en-US
+check-filenames =
+check-hidden =

.github/workflows/codespell.yml

@@ -1,10 +1,21 @@
 name: Compile Examples
+
+# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
 on:
-  - push
-  - pull_request
+  push:
+    paths:
+      - ".github/workflows/compile-examples.yml"
+      - "examples/**"
+      - "src/**"
+  pull_request:
+    paths:
+      - ".github/workflows/compile-examples.yml"
+      - "examples/**"
+      - "src/**"
+  workflow_dispatch:
 
 jobs:
-  build:
+  build-for-stm32:
     runs-on: ubuntu-latest
 
     strategy:
@@ -17,11 +28,17 @@ jobs:
           - STMicroelectronics:stm32:Nucleo_64:pnum=P_NUCLEO_WB55_USB_DONGLE
 
     steps:
-      - uses: actions/checkout@main
+      - uses: actions/checkout@v4
       - uses: arduino/compile-sketches@v1
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           fqbn: ${{ matrix.fqbn }}
           platforms: |
-            - source-url: https://github.com/stm32duino/BoardManagerFiles/raw/main/package_stmicroelectronics_index.json
-              name: STMicroelectronics:stm32
+            - name: STMicroelectronics:stm32
+              source-url: https://github.com/stm32duino/BoardManagerFiles/raw/main/package_stmicroelectronics_index.json
+          sketch-paths: |
+            - examples
+          cli-compile-flags: |
+            - --build-property
+            - build.extra_flags=-DIDB05A2_SPI_CLOCK_D3
+

.github/workflows/compile-examples.yml

@@ -0,0 +1,32 @@
+# Source: https://github.com/per1234/.github/blob/main/workflow-templates/spell-check.md
+name: Spell Check
+
+# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
+on:
+  push:
+  pull_request:
+  schedule:
+    # Run every Tuesday at 8 AM UTC to catch new misspelling detections resulting from dictionary updates.
+    - cron: "0 8 * * TUE"
+  workflow_dispatch:
+  repository_dispatch:
+
+jobs:
+  spellcheck:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Spell check
+        uses: codespell-project/actions-codespell@v2
+        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/STM32_WPAN
+          path: src

.github/workflows/spell-check.yml

@@ -0,0 +1,2 @@
+
+.DS_Store

.gitignore

@@ -1,11 +1,8 @@
-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 ?.?.? - ????.??.??
 
 ArduinoBLE 1.1.2 - 2019.11.12
 
-* cordio: switch to lower power when polling with timeout 
+* cordio: switch to lower power when polling with timeout
 * Fixed issue with wrong types for disconnection event handling. Thanks @cparata
 
 ArduinoBLE 1.1.1 - 2019.09.05

CHANGELOG

@@ -1,33 +1,95 @@
 # STM32duinoBLE
 
-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.
-
- - 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    
+This library is a fork of ArduinoBLE library to add the support of  STM32WB, SPBTLE-RF, SPBTLE-1S, BLUENRG-M2SP, BLUENRG-LP and BLUENRG-M0  BLE modules.
+
+It was successfully tested with the [NUCLEO-WB15CC], [P-NUCLEO-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], [B-L4S5I-IOT01A], [STEVAL-MKSBOX1V1], [STEVAL-MKBOXPRO] and with [STM32L562E-DK].
+
+ - 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.
 
- - 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
+ - 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/Arduino_Core_STM32/wiki/STM32duinoBLE#stm32duinoble-with-steval_mksbox1v1
 
-- 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
+- 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/Arduino_Core_STM32/wiki/STM32duinoBLE#stm32duinoble-with-x-nucleo-bnrg2a1
 
 For more information about ArduinoBLE library please visit the official web page at:
-https://github.com/arduino-libraries/ArduinoBLE
+https://www.arduino.cc/en/Reference/ArduinoBLE
 
 # Configuration
+
+### STM32WB
+
 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.
 
+### Shield
+
+The user can include the file `ble_spi_conf.h` to define which shield and configuration to use from the following list:
+
+ * [X-NUCLEO-IDB05A2]
+    * `IDB05A2_SPI_CLOCK_D3`: SPI clock on D3
+    * `IDB05A2_SPI_CLOCK_D13` SPI clock on D13
+ * [X-NUCLEO-IDB05A1]
+    * `IDB05A1_SPI_CLOCK_D3`: SPI clock on D3
+    * `IDB05A1_SPI_CLOCK_D13`: SPI clock on D13
+ * [X-NUCLEO-BNRG2A1]
+    * `BNRG2A1_SPI_CLOCK_D3`: SPI clock on D3
+    * `BNRG2A1_SPI_CLOCK_D13`: SPI clock on D13
+ * `CUSTOM_BLE_SPI`: define a custom configuration, it requires below definition:
+    * `BLE_SPI_MISO`: SPI MISO pin
+    * `BLE_SPI_MOSI`: SPI MOSI pin
+    * `BLE_SPI_CLK`: SPI CLocK pin
+    * `BLE_SPI_CS`: SPI Chip Select pin
+    * `BLE_SPI_IRQ`: SPI IRQ pin
+    * `BLE_SPI_FREQ`: SPI bus frequency
+    * `BLE_SPI_MODE`: can be one of the below `SPIMode`:
+      * `SPI_MODE0`
+      * `SPI_MODE1`
+      * `SPI_MODE2`
+      * `SPI_MODE0`
+    * `BLE_CHIP_TYPE`: can be one of the below `BLEChip_t`:
+      * `SPBTLE_RF`
+      * `SPBTLE_1S`
+      * `BLUENRG_M2SP`
+      * `BLUENRG_M0`
+      * `BLUENRG_LP`
+    * `BLE_RESET`: BLE reset pin
+
+#### Examples
+
+To use the [X-NUCLEO-IDB05A2] with SPI clock on D3, define in `ble_spi_conf.h`:
+```C
+#define IDB05A2_SPI_CLOCK_D3
+```
+This is equivalent to the below configuration using the `CUSTOM_BLE_SPI`:
+```C
+#define CUSTOM_BLE_SPI
+#define BLE_SPI_MISO    D12
+#define BLE_SPI_MOSI    D11
+#define BLE_SPI_CLK     D3
+#define BLE_SPI_CS      A1
+#define BLE_SPI_IRQ     A0
+#define BLE_SPI_FREQ    8000000
+#define BLE_SPI_MODE    SPI_MODE0
+#define BLE_CHIP_TYPE   BLUENRG_M0
+#define BLE_RESET       D7
+```
+
+#### Using a SPI BLE module on STM32WB
+
+If required, user can use a compatible BLE module over SPI.
+
+In the `ble_spi_conf.h`, define `USE_BLE_SPI`.
+
 ## License
 
 ```
@@ -48,3 +110,19 @@ 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
 ```
+
+
+B-L475E-IOT01A: https://www.st.com/en/evaluation-tools/b-l475e-iot01a.html
+B-L4S5I-IOT01A: https://www.st.com/en/evaluation-tools/b-l4s5i-iot01a.html
+NUCLEO-F401RE: https://www.st.com/en/evaluation-tools/nucleo-f401re.html
+NUCLEO-L053R8: https://www.st.com/en/evaluation-tools/nucleo-l053r8.html
+NUCLEO-L476RG: https://www.st.com/en/evaluation-tools/nucleo-l476rg.html
+NUCLEO-WB15CC: https://www.st.com/en/evaluation-tools/nucleo-wb15cc.html
+P-NUCLEO-WB55RG: https://www.st.com/en/evaluation-tools/p-nucleo-wb55.html
+STEVAL-MKSBOX1V1: https://www.st.com/en/evaluation-tools/steval-mksbox1v1.html
+STEVAL-MKBOXPRO: https://www.st.com/en/evaluation-tools/steval-mkboxpro.html
+STM32L562E-DK: https://www.st.com/en/evaluation-tools/stm32l562e-dk.html
+STM32WB5MM-DK: https://www.st.com/en/evaluation-tools/stm32wb5mm-dk.html
+X-NUCLEO-BNRG2A1: https://www.st.com/en/ecosystems/x-nucleo-bnrg2a1.html
+X-NUCLEO-IDB05A2: https://www.st.com/en/ecosystems/x-nucleo-idb05a2.html
+X-NUCLEO-IDB05A1: https://www.st.com/en/ecosystems/x-nucleo-idb05a1.html