Third Party Hardware Drivers Extension v2.0.1

README.md

@@ -1,6 +1,6 @@
 # Third Party Hardware Drivers #
 
-[![Version Badge](https://img.shields.io/badge/-v2.0.0-green)](https://github.com/SiliconLabs/third_party_hw_drivers_extension/releases)
+[![Version Badge](https://img.shields.io/badge/-v2.0.1-green)](https://github.com/SiliconLabs/third_party_hw_drivers_extension/releases)
 [![GSDK Badge](https://img.shields.io/badge/GSDK-v4.4.0-green)](https://github.com/SiliconLabs/gecko_sdk/releases)
 ![License badge](https://img.shields.io/badge/License-Zlib-green)
 
@@ -98,6 +98,8 @@ A full list of all drivers in this repository is defined below:
 | particulate_matter_sensor_sps30 | [Click Here](./driver/public/silabs/particulate_matter_sensor_sps30) | [Click Here](./app/example/sparkfun_particulate_matter_sensor_sps30) | [Click Here](./app/documentation/example/sparkfun_particulate_matter_sensor_sps30) |
 | adafruit_neotrellis_keypad_atsamd09 | [Click Here](./driver/public/silabs/adafruit_neotrellis_keypad_atsamd09) | [Click Here](./app/example/adafruit_neotrellis_keypad_atsamd09) | [Click Here](./app/documentation/example/adafruit_neotrellis_keypad_atsamd09) |
 | hvac_bundle_scd41_sps30 | [Click Here](./driver/public/mikroe/hvac_scd41) <br> [Click Here](./driver/public/silabs/particulate_matter_sensor_sps30)| [Click Here](./app/example/mikroe_hvac_bundle_scd41_sps30) | [Click Here](./app/documentation/example/mikroe_hvac_bundle_scd41_sps30) |
+| mikroe_uwb_dwm1000 | [Click Here](./driver/public/mikroe/uwb_dwm1000) | [Click Here](./app/example/mikroe_uwb_dwm1000) | [Click Here](./app/documentation/example/mikroe_uwb_dwm1000) |
+| mikroe_pir_pl_n823_01 | [Click Here](./driver/public/mikroe/pir_pl_n823_01) | [Click Here](./app/example/mikroe_pir_pl_n823_01) | [Click Here](./app/documentation/example/mikroe_pir_pl_n823_01) |
 ## Requirements ##
 
 - Desired Silicon Labs Starter Kit
@@ -161,4 +163,4 @@ The Third Party Hardware Drivers SDK contains the following files and folders.
 
 To report bugs in the Application Examples projects, please create a new "Issue" in the "Issues" section of this repo. Please reference the board, project, and source files associated with the bug, and reference line numbers. If you are proposing a fix, also include information on the proposed fix. Since these examples are provided as-is, there is no guarantee that these examples will be updated to fix these issues.
 
-Questions and comments related to these examples should be made by creating a new "Issue" in the "Issues" section of this repo.
+Questions and comments related to these examples should be made by creating a new "Issue" in the "Issues" section of this repo.

app/documentation/example/adafruit_neotrellis_keypad_atsamd09/README.md

@@ -22,7 +22,7 @@ Tested boards for working with this example:
 
 ## Hardware Connection ##
 
-Adafruit NeoTrellis can connect with the BGM220 Explorer Kit easily via I2C-Bus. Adafruit NeoTrellis includes a JST-PH 4-pin connector that provides two I2C wires (SDA and SCL), 3v3, and GND. To connect, you should solder these pins of the JST-PH 4-pin connector with the I2C Bus on the BMG220 as in the picture below:
+Adafruit NeoTrellis can connect with the BGM220 Explorer Kit easily via Qwiic connector. Adafruit NeoTrellis includes a JST-PH 4-pin connector that provides two I2C wires (SDA and SCL), 3v3, and GND. You can use [the JST PH to JST SH (qwiic) Cable](https://www.adafruit.com/product/4424) to connect the Adafruit Neotrellis to the BGM220 as in the picture below:
 
 ![connection](image/connection.png)
 

app/documentation/example/mikroe_pir_pl_n823_01/README.md

@@ -0,0 +1,101 @@
+# PL-N823-01 - PIR Click (Mikroe) #
+
+## Summary ##
+
+This example project showcases the integration of the Mikroe PIR Click board driver with the Silicon Labs Platform.
+
+The PIR sensor is a kind of thermal sensor that is able to detect the movement of a heat source. As the most general heat source in indoor environments, humans with motion can be detected by PIR sensors. The sensor can be used for developing various applications, the typical ones including human presence detection sensing for energy-saving functions including contactless switching, home appliances, lighting, air-conditioners, etc.
+
+This example reads a voltage when exposed to infrared radiation by ADC and converts it to a scaled value in millivolts (mV).
+
+
+## Required Hardware ##
+
+- [EFR32xG24-EK2703A - EFR32xG24 Explorer Kit](https://www.silabs.com/development-tools/wireless/efr32xg24-explorer-kit?tab=overview)
+
+- [Mikroe PIR Click](https://www.mikroe.com/pir-click) board based on a PL-N8230-01 infrared sensor
+
+**NOTE:**
+Tested boards for working with this example:
+
+| Board ID | Description  |
+| ---------------------- | ------ |
+| BRD2703A | [EFR32xG24 Explorer Kit - XG24-EK2703A](https://www.silabs.com/development-tools/wireless/efr32xg24-explorer-kit?tab=overview)    |
+| BRD4314A | [BGM220 Bluetooth Module Explorer Kit - BGM220-EK4314A](https://www.silabs.com/development-tools/wireless/bluetooth/bgm220-explorer-kit?tab=overview)  |
+| BRD4108A | [EFR32BG22 Explorer Kit Board](https://www.silabs.com/development-tools/wireless/bluetooth/bg22-explorer-kit?tab=overview)  |
+
+## Hardware Connection ##
+
+The PIR Click supports MikroBus; therefore, it can easily connect to the MikroBus header of the EFR32xG24 Explorer Kit. Make sure that the 45-degree corner of the PIR Click matches the 45-degree white line of the Explorer Kit.
+
+The hardware connection is shown in the image below:
+
+![hardware_connection](image/hardware_connection.png)
+
+## Setup ##
+
+You can either create a project based on an example project or start with an empty example project.
+
+### Create a project based on an example project ###
+
+1. From the Launcher Home, add the BRD2703A to My Products, click on it, and click on the **EXAMPLE PROJECTS & DEMOS** tab. Find the example project with filter **pir**.
+
+2. Click **Create** button on the **Third Party Hardware Drivers - PL-N823-01 - PIR Click (Mikroe)** example. Example project creation dialog pops up -> click Create and Finish and Project should be generated.
+![create_project](image/create_project.png)
+
+### Start with an empty example project ###
+
+1. Create an "Empty C Project" for the "EFR32xG24 Explorer Kit Board" using Simplicity Studio v5. Use the default project settings.
+
+2. Copy the file `app/example/mikroe_pir_pl_n823_01/app.c` into the project root folder (overwriting the existing file).
+
+3. Install the software components:
+
+    - Open the .slcp file in the project.
+
+    - Select the SOFTWARE COMPONENTS tab.
+
+    - Install the following components:
+
+        - [Services] → [Timers] → [Sleep Timer]
+
+        - [Services] → [IO Stream] → [IO Stream: USART] → default instance name: **vcom**
+
+        - [Application] → [Utility] → [Log]
+
+        - [Third Party Hardware Drivers] → [Sensors] → [PL-N823-01 - PIR Click (Mikroe)] → use default configuration
+
+4. Install **printf float**
+
+    - Open Properties of the project.
+
+    - Select C/C++ Build → Settings → Tool Settings → GNU ARM C Linker → General. Check Printf float.
+    ![install_float](image/install_float.png)
+
+5. Build and flash this example to the board.
+
+**Note :**
+
+- Make sure that the SDK Extension has already been installed. If not, follow [this documentation](https://github.com/SiliconLabs/third_party_hw_drivers_extension/blob/master/README.md#how-to-add-to-simplicity-studio-ide).
+
+- SDK Extension must be enabled for the project to install "PL-N823-01 - PIR Click (Mikroe)" component. Selecting this component will also include the "I2CSPM" component.
+
+## How It Works ##
+
+### Driver Layer Diagram ###
+
+![software_layer](image/software_layer.png)
+
+### Testing ###
+
+This example reads a voltage when exposed to infrared radiation by ADC and converts it to a scaled value in millivolts (mV). By moving in front of the sensor, you can see how the measured voltage values change on the console screen.
+
+You can launch Console, which is integrated into Simplicity Studio or you can use a third-party terminal tool like Tera Term to receive the data from USB. A screenshot of the console output is shown in the figure below.
+
+![console_log](image/console_log.png)
+
+## Report Bugs & Get Support ##
+
+To report bugs in the Application Examples projects, please create a new "Issue" in the "Issues" section of [third_party_hw_drivers_extension](https://github.com/SiliconLabs/third_party_hw_drivers_extension) repo. Please reference the board, project, and source files associated with the bug, and reference line numbers. If you are proposing a fix, also include information on the proposed fix. Since these examples are provided as-is, there is no guarantee that these examples will be updated to fix these issues.
+
+Questions and comments related to these examples should be made by creating a new "Issue" in the "Issues" section of [third_party_hw_drivers_extension](https://github.com/SiliconLabs/third_party_hw_drivers_extension) repo.

app/documentation/example/mikroe_uwb_dwm1000/README.md

@@ -0,0 +1,95 @@
+# DWM1000 - UWB Click (Mikroe) #
+
+## Summary ##
+
+This example project showcases the driver integration of the Mikroe DWM1000 - UWB Click board.
+
+UWB Click is an Ultra-Wideband transceiver Click board™ that can be used in 2-way ranging or TDOA location systems to locate assets to a precision of 10 cm and supports data rates of up to 6.8 Mbps. This Click board™ features the DWM1000 module based on Qorvo's DW1000 Ultra-Wideband (UWB) transceiver from Qorvo.
+
+It features a frequency range from 3.5GHz to 6.5GHz, a very precise location of tagged objects, up to 6.8Mbps data rates, low power consumption, and more while the communication with the MCU is accomplished through a standard SPI serial interface. This Click board™ is optimized for applications in real-time location systems and wireless sensor networks across a variety of markets including agriculture, building control and automation, factory automation, healthcare, safety & security, warehousing & logistics, and a range of others.
+
+## Required Hardware ##
+
+- [EFR32xG24 Explorer Kit](https://www.silabs.com/development-tools/wireless/efr32xg24-explorer-kit?tab=overview)
+
+- [UWB Click](https://www.mikroe.com/uwb-click)
+
+## Hardware Connection ##
+
+The DWM1000 - UWB Click board supports MikroBus; therefore, it can easily connect to the MikroBus socket of the EFR32xG24 Explorer Kit. Be sure that the 45-degree corner of the board matches the 45-degree white line of the Explorer Kit.
+
+The hardware connection is shown in the image below:
+
+![board](image/hardware_connection.png)
+
+### Driver Layer Diagram ###
+
+The driver of the DWM1000 - UWB Click board builds upon more than one level of software. On the first layer, there are the SPIDRV and GPIO drivers from Silabs, which focus on interfacing with the xG24 motherboard. On top of that, there are multiple layers of drivers, which either work as an interfacing layer between the Click board and the motherboard or control the DWM1000 UWB module. Here you can see the high-level overview of the software layers:
+
+![logging_screen](image/sw_layer.png)
+
+## Setup ##
+
+You can either create a project based on an example project or start with an empty example project.
+
+### Create a project based on an example project ###
+
+1. From the Launcher Home, add the BRD2703A to My Products, click on it, and click on the **EXAMPLE PROJECTS & DEMOS** tab. Find the example project filtering by uwb.
+
+2. Click **Create** button on the **Third Party Hardware Drivers - DWM1000 - UWB Click (Mikroe)** example. Example project creation dialog pops up -> click Create and Finish and Project should be generated.
+
+![create_example](image/create_example.png)
+
+3. Build and flash this example to the board.
+
+### Start with an empty example project ###
+
+1. Create an "Empty C Project" for the "EFR32xG24 Explorer Kit" using Simplicity Studio v5. Use the default project settings.
+
+2. Copy the file `app/example/mikroe_uwb_dwm1000/app.c` into the project root folder (overwriting the existing file).
+
+3. Install the software components:
+
+    - Open the .slcp file in the project.
+
+    - Select the SOFTWARE COMPONENTS tab.
+
+    - Install the following components:
+
+        - **[Services] → [IO Stream] → [IO Stream: EUSART]** → default instance name: vcom
+        - **[Application] → [Utility] → [Log]**
+        - **[Application] → [Utility] → [Assert]**
+        - **[Platform] → [Driver] → [Button] → [Simple Button]** → use default instance name: btn0
+            - For using the SPI interface
+                - [Platform] → [Driver] → [SPI] → [SPIDRV] → [mikroe] → change the configuration for [SPI master chip select (CS) control scheme] to "CS controlled by the application", use the default instance name "mikroe"
+        - **[Third Party Hardware Drivers] → [Wireless Connectivity] → [DWM1000 - UWB Click (Mikroe)]** → use default configuration.
+
+            ![config](image/uwb_config.png)
+
+4. Build and flash this example to the board.
+
+**Note:**
+
+- Make sure that the SDK extension has already been installed. If not, please follow [this documentation](https://github.com/SiliconLabs/third_party_hw_drivers_extension/blob/master/README.md#how-to-add-to-simplicity-studio-ide).
+
+- SDK Extension must be enabled for the project to install "DWM1000 - UWB Click (Mikroe)" component.
+
+- Make sure that the SPI CS Control scheme is set to "CS controlled by the application", otherwise the driver is not able to communicate with the module properly.
+
+## How It Works ##
+
+This is an example that demonstrates the use of the DWM1000 - UWB Click board. First, you have to decide whether you would like to use the device in Transmitter (Tx) or Receiver (Rx) mode, which you can do by setting the dev_mode to either **MIKROE_DWM1000_MODE_TX** or **MIKROE_DWM1000_MODE_RX**.
+
+In Tx mode, the device transmits a packet upon startup. The packet is re-transmitted every time when the BTN0 is pressed on the xG24 Explorer kit. The screenshot of the console can be seen below:
+
+![transmit_cli](image/transmit_cli.png)
+
+In Rx mode, the device enters receiver mode upon startup, and it prints each received packet after every IRQ event. The screenshot of the console can be seen below:
+
+![receive_cli](image/receive_cli.png)
+
+## Report Bugs & Get Support ##
+
+To report bugs in the Application Examples projects, please create a new "Issue" in the "Issues" section of [third_party_hw_drivers_extension](https://github.com/SiliconLabs/third_party_hw_drivers_extension) repo. Please reference the board, project, and source files associated with the bug, and reference line numbers. If you are proposing a fix, also include information on the proposed fix. Since these examples are provided as-is, there is no guarantee that these examples will be updated to fix these issues.
+
+Questions and comments related to these examples should be made by creating a new "Issue" in the "Issues" section of [third_party_hw_drivers_extension](https://github.com/SiliconLabs/third_party_hw_drivers_extension) repo.

app/example/adafruit_neotrellis_keypad_atsamd09/adafruit_neotrellis_keypad_atsamd09.slcp

@@ -39,7 +39,7 @@ define:
 
 sdk_extension:
 - id: third_party_hw_drivers
-  version: 2.0.0
+  version: 2.0.1
 
 other_file:
   - path: ../../documentation/example/adafruit_neotrellis_keypad_atsamd09/image/connection.png

app/example/adafruit_rgb_led_is31fl3741/adafruit_rgb_led_is31fl3741.slcp

@@ -46,7 +46,7 @@ define:
 - name: DEBUG_EFM
 sdk_extension:
 - id: third_party_hw_drivers
-  version: 2.0.0
+  version: 2.0.1
 other_file:
   - path: ../../documentation/example/adafruit_rgb_led_is31fl3741/image/connection.png
     directory: "image"

app/example/adafruit_tft_lcd_hxd8357d/adafruit_tft_lcd_hxd8357d.slcp

@@ -46,7 +46,7 @@ define:
 
 sdk_extension:
 - id: third_party_hw_drivers
-  version: 2.0.0
+  version: 2.0.1
 
 other_file:
   - path: ../../documentation/example/adafruit_tft_lcd_hxd8357d/image/create_example_with_dma_mode.png

app/example/adafruit_tft_lcd_hxd8357d/adafruit_tft_lcd_hxd8357d_dma.slcp

@@ -46,7 +46,7 @@ define:
 
 sdk_extension:
 - id: third_party_hw_drivers
-  version: 2.0.0
+  version: 2.0.1
 
 other_file:
   - path: ../../documentation/example/adafruit_tft_lcd_hxd8357d/image/create_example_with_dma_mode.png

app/example/adafruit_tft_lcd_hxd8357d_lvgl/adafruit_tft_lcd_hxd8357d_lvgl.slcp

@@ -66,7 +66,7 @@ define:
 
 sdk_extension:
 - id: third_party_hw_drivers
-  version: 2.0.0
+  version: 2.0.1
 
 other_file:
   - path: ../../documentation/example/adafruit_tft_lcd_hxd8357d_lvgl/image/create_example.png

app/example/adafruit_tft_lcd_hxd8357d_lvgl/adafruit_tft_lcd_hxd8357d_lvgl_dma.slcp

@@ -68,7 +68,7 @@ define:
 
 sdk_extension:
 - id: third_party_hw_drivers
-  version: 2.0.0
+  version: 2.0.1
 
 other_file:
   - path: ../../documentation/example/adafruit_tft_lcd_hxd8357d_lvgl/image/create_example.png

app/example/adafruit_tft_lcd_ili9341/adafruit_tft_lcd_ili9341.slcp

@@ -46,7 +46,7 @@ define:
 
 sdk_extension:
 - id: third_party_hw_drivers
-  version: 2.0.0
+  version: 2.0.1
 
 other_file:
   - path: ../../documentation/example/adafruit_tft_lcd_ili9341/image/create_example.png

app/example/adafruit_tft_lcd_ili9341/adafruit_tft_lcd_ili9341_dma.slcp

@@ -46,7 +46,7 @@ define:
 
 sdk_extension:
 - id: third_party_hw_drivers
-  version: 2.0.0
+  version: 2.0.1
 
 other_file:
   - path: ../../documentation/example/adafruit_tft_lcd_ili9341/image/create_example.png

app/example/adafruit_tft_lcd_ili9341_lvgl/adafruit_tft_lcd_ili9341_lvgl.slcp

@@ -88,7 +88,7 @@ define:
 
 sdk_extension:
 - id: third_party_hw_drivers
-  version: 2.0.0
+  version: 2.0.1
 
 configuration:
   - name: LV_BUFFER_MODE

app/example/adafruit_tft_lcd_ili9341_lvgl/adafruit_tft_lcd_ili9341_lvgl_dma.slcp

@@ -60,7 +60,7 @@ define:
 
 sdk_extension:
 - id: third_party_hw_drivers
-  version: 2.0.0
+  version: 2.0.1
 
 configuration:
   - name: LV_BUFFER_MODE

app/example/adafruit_tft_lcd_st7789/adafruit_tft_lcd_st7789.slcp

@@ -49,7 +49,7 @@ define:
 
 sdk_extension:
 - id: third_party_hw_drivers
-  version: 2.0.0
+  version: 2.0.1
 
 other_file:
   - path: ../../documentation/example/adafruit_tft_lcd_st7789/image/create_example.png

app/example/adafruit_tft_lcd_st7789/adafruit_tft_lcd_st7789_dma.slcp

@@ -50,7 +50,7 @@ define:
 
 sdk_extension:
 - id: third_party_hw_drivers
-  version: 2.0.0
+  version: 2.0.1
 
 other_file:
   - path: ../../documentation/example/adafruit_tft_lcd_st7789/image/create_example.png

app/example/adafruit_tft_lcd_st7789_lvgl_dma/adafruit_tft_lcd_st7789_lvgl_dma.slcp

@@ -59,7 +59,7 @@ define:
 
 sdk_extension:
 - id: third_party_hw_drivers
-  version: 2.0.0
+  version: 2.0.1
 
 other_file:
   - path: ../../documentation/example/adafruit_tft_lcd_st7789_lvgl_dma/image/create_example.png

app/example/adafruit_touchscreen_tsc2007/adafruit_touchscreen_tsc2007.slcp

@@ -45,7 +45,7 @@ define:
 
 sdk_extension:
 - id: third_party_hw_drivers
-  version: 2.0.0
+  version: 2.0.1
 
 other_file:
   - path: ../../documentation/example/adafruit_touchscreen_tsc2007/image/calib.png

app/example/bthome_v2_server/bthome_v2_server.slcp

@@ -62,7 +62,7 @@ define:
 
 sdk_extension:
 - id: third_party_hw_drivers
-  version: 2.0.0
+  version: 2.0.1
 
 other_file:
   - path: ../../documentation/example/bthome_v2_server/image/connection.png

app/example/maxim_fuel_gauge_max17048/maxim_fuel_gauge_max17048.slcp

@@ -47,7 +47,7 @@ define:
 
 sdk_extension:
 - id: third_party_hw_drivers
-  version: 2.0.0
+  version: 2.0.1
 
 other_file:
   - path: ../../documentation/example/maxim_fuel_gauge_max17048/image/overview.png

app/example/mikroe_accel5_bma400/mikroe_accel5_bma400_i2c.slcp

@@ -44,7 +44,7 @@ define:
 
 sdk_extension:
 - id: third_party_hw_drivers
-  version: 2.0.0
+  version: 2.0.1
 
 other_file:
   - path: ../../documentation/example/mikroe_accel5_bma400/image/hardware_connection.png

app/example/mikroe_accel5_bma400/mikroe_accel5_bma400_spi.slcp

@@ -44,7 +44,7 @@ define:
 
 sdk_extension:
 - id: third_party_hw_drivers
-  version: 2.0.0
+  version: 2.0.1
 
 other_file:
   - path: ../../documentation/example/mikroe_accel5_bma400/image/hardware_connection.png