chore: update with stm32wb

Signed-off-by: Frederic Pillon <[email protected]>

Author: fpistm

.github/workflows/compile-examples.yml

@@ -27,6 +27,8 @@ jobs:
           - 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
+          - STMicroelectronics:stm32:Nucleo_64:pnum=P_NUCLEO_WB55_USB_DONGLE
 
     steps:
       - uses: actions/checkout@v4

.github/workflows/spell-check.yml

@@ -23,3 +23,10 @@ jobs:
 
       - 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

README.md

@@ -1,8 +1,14 @@
 # STM32duinoBLE
 
-This library is a fork of ArduinoBLE library to add the support of SPBTLE-RF, SPBTLE-1S, BLUENRG-M2SP, BLUENRG-LP and BLUENRG-M0 BLE modules.
+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 [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].
+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:
 
@@ -17,6 +23,14 @@ 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:
@@ -70,6 +84,12 @@ This is equivalent to the below configuration using the `CUSTOM_BLE_SPI`:
 #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
 
 ```
@@ -91,14 +111,18 @@ 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
+X-NUCLEO-IDB05A1: https://www.st.com/en/ecosystems/x-nucleo-idb05a1.html

library.properties

@@ -2,7 +2,7 @@ name=STM32duinoBLE
 version=1.4.0
 author=Arduino, SRA
 maintainer=stm32duino
-sentence=Fork of ArduinoBLE library to add the support of SPBTLE-RF, SPBTLE-1S, BLUENRG-M2SP, BLUENRG-LP and BLUENRG-M0 BLE modules.
+sentence=Fork of ArduinoBLE library to add the support of STM32WB, SPBTLE-RF, SPBTLE-1S, BLUENRG-M2SP, BLUENRG-LP and BLUENRG-M0 BLE modules.
 paragraph=This library supports creating a Bluetooth® Low Energy peripheral & central mode.
 category=Communication
 url=https://github.com/stm32duino/STM32duinoBLE

src/utility/HCISharedMemTransport.cpp

@@ -16,7 +16,7 @@
   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)
+#if defined(STM32WBxx) && !defined(USE_BLE_SPI)
 
 #include "HCISharedMemTransport.h"
 #include "STM32_WPAN/hw.h"
@@ -778,4 +778,4 @@ int HCISharedMemTransportClass::bt_ipm_set_power(void)
 }
 
 HCITransportInterface& HCITransport = HCISharedMemTransport;
-#endif /* STM32WBxx */
+#endif /* STM32WBxx && !USE_BLE_SPI */

src/utility/HCISpiTransport.cpp

@@ -17,12 +17,9 @@
   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
+#if !defined(STM32WBxx) || defined(USE_BLE_SPI)
 #include "HCISpiTransport.h"
 
-#if __has_include("ble_spi_conf.h")
-  #include "ble_spi_conf.h"
-#endif
-
 #if defined(CUSTOM_BLE_SPI)
 SPIClass SpiHCI(BLE_SPI_MOSI, BLE_SPI_MISO, BLE_SPI_CLK);
 HCISpiTransportClass HCISpiTransport(SpiHCI, BLE_CHIP_TYPE, BLE_SPI_CS, BLE_SPI_IRQ, BLE_RESET, BLE_SPI_FREQ, BLE_SPI_MODE);
@@ -1404,3 +1401,4 @@ void HCISpiTransportClass::wait_for_set_address()
 }
 
 HCITransportInterface& HCITransport = HCISpiTransport;
+#endif // !STM32WBxx || USE_BLE_SPI

src/utility/HCITransport.h

@@ -22,6 +22,10 @@
 
 #include <Arduino.h>
 
+#if __has_include("ble_spi_conf.h")
+  #include "ble_spi_conf.h"
+#endif
+
 class HCITransportInterface {
 public:
   virtual int begin() = 0;