Bluetooth Applications v2.0.3

Author: silabs-DanielN

README.md

@@ -13,7 +13,7 @@
 
 # Silicon Labs Bluetooth Applications #
 
-[![Version Badge](https://img.shields.io/badge/-v2.0.2-green)](https://github.com/SiliconLabs/bluetooth_applications/releases)
+[![Version Badge](https://img.shields.io/badge/-v2.0.3-green)](https://github.com/SiliconLabs/bluetooth_applications/releases)
 [![GSDK Badge](https://img.shields.io/badge/GSDK-v4.4.0-green)](https://github.com/SiliconLabs/gecko_sdk/releases)
 [![TPHD Version Badge](https://img.shields.io/badge/TPHD-v2.0.0+-green)](https://github.com/SiliconLabs/third_party_hw_drivers_extension/releases)
 ![License badge](https://img.shields.io/badge/License-Zlib-green)
@@ -83,6 +83,7 @@ This repository provides both SLCP projects (as External Repositories) and SLS p
 | 55 | Bluetooth - HID Multiple Reports | [Click Here](./bluetooth_hid_multiple_reports/) |
 | 56 | Bluetooth - ESL Tag with E-Paper display 1,54inch 200x200 dots from Mikroe | [Click Here](./bluetooth_esl_tag_mikroe_eink154_e_paper_display) |
 | 56 | Bluetooth - RSSI - based position estimation for PEPS | [Click Here](./bluetooth_rssi_positioning_for_peps) |
+| 57 | Bluetooth - BTHome v2 - PIR Alarm | [Click Here](./bluetooth_bthome_v2_pir_alarm/) |
 
 ## Requirements ##
 

bluetooth_bthome_v2_pir_alarm/README.md

@@ -0,0 +1,138 @@
+# Bluetooth - BTHome v2 - PIR Alarm #
+
+![Type badge](https://img.shields.io/badge/dynamic/json?url=https://raw.githubusercontent.com/SiliconLabs/application_examples_ci/master/bluetooth_applications/bluetooth_bthome_v2_pir_alarm_common.json&label=Type&query=type&color=green)
+![Technology badge](https://img.shields.io/badge/dynamic/json?url=https://raw.githubusercontent.com/SiliconLabs/application_examples_ci/master/bluetooth_applications/bluetooth_bthome_v2_pir_alarm_common.json&label=Technology&query=technology&color=green)
+![License badge](https://img.shields.io/badge/dynamic/json?url=https://raw.githubusercontent.com/SiliconLabs/application_examples_ci/master/bluetooth_applications/bluetooth_bthome_v2_pir_alarm_common.json&label=License&query=license&color=green)
+![SDK badge](https://img.shields.io/badge/dynamic/json?url=https://raw.githubusercontent.com/SiliconLabs/application_examples_ci/master/bluetooth_applications/bluetooth_bthome_v2_pir_alarm_common.json&label=SDK&query=sdk&color=green)
+[![Required board](https://img.shields.io/badge/Mikroe--green)](https://www.mikroe.com/pir-click)
+![Build badge](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/SiliconLabs/application_examples_ci/master/bluetooth_applications/bluetooth_bthome_v2_pir_alarm_build_status.json)
+![Flash badge](https://img.shields.io/badge/dynamic/json?url=https://raw.githubusercontent.com/SiliconLabs/application_examples_ci/master/bluetooth_applications/bluetooth_bthome_v2_pir_alarm_common.json&label=Flash&query=flash&color=blue)
+![RAM badge](https://img.shields.io/badge/dynamic/json?url=https://raw.githubusercontent.com/SiliconLabs/application_examples_ci/master/bluetooth_applications/bluetooth_bthome_v2_pir_alarm_common.json&label=RAM&query=ram&color=blue)
+## Overview ##
+
+This project aims to implement a BTHome v2 compatible PIR alarm. The device reads the PIR sensor value and sends the motion information to the BTHome Server, which notifies the user if motion is detected.
+
+The Home Assistant OS is installed and running on a Raspberry Pi 4 device, which scans for BTHome v2 devices. The Home Assistant application of your smartphone can communicate with the Raspberry Pi 4 (RPi 4). RPi4 receives advertisement packages from the BTHome v2 PIR alarm device and detects the movement.
+
+## Gecko SDK Suite version ##
+
+- GSDK v4.4.2
+
+## Software requirements ##
+
+- [Third Party Hardware Drivers v2.0.1](https://github.com/SiliconLabs/third_party_hw_drivers_extension)
+
+- Home Assistant OS v12.3
+
+## Hardware Required ##
+
+- [**BGM220-EK4314A** BGM220 Bluetooth Module Explorer Kit](https://www.silabs.com/development-tools/wireless/bluetooth/bgm220-explorer-kit)
+
+- [MikroE - PIR Click](https://www.mikroe.com/pir-click)
+
+- Raspberry Pi 4 runs Home Assistant OS
+
+**NOTE:**
+Tested boards for working with this example:
+
+| Board ID | Description  |
+| -------- | ------ |
+| BRD4314A | [BGM220 Bluetooth Module Explorer Kit - BGM220-EK4314A](https://www.silabs.com/development-tools/wireless/bluetooth/bgm220-explorer-kit?tab=overview)  |
+| BRD2703A | [EFR32xG24 Explorer Kit - xG24-EK2703A ](https://www.silabs.com/development-tools/wireless/efr32xg24-explorer-kit?tab=overview)    |
+| BRD4108A | [EFR32BG22 Explorer Kit - BG22-EK4108A](https://www.silabs.com/development-tools/wireless/bluetooth/bg22-explorer-kit?tab=overview)  |
+
+## Connections Required ##
+
+The following picture shows the connection for this application:
+
+![overview](image/overview.png)
+
+
+## Setup ##
+
+To test this application, you can either create a project based on an example project or start with a "Bluetooth - SoC Empty" project based on your hardware.
+
+### Create a project based on an example project ###
+
+1. From the Launcher Home, add your product name to My Products, click on it, and click on the **EXAMPLE PROJECTS & DEMOS** tab. Find the example project filtering by "bthome" and "pir".
+
+2. Click the **Create** button on **Bluetooth - BTHome v2 - PIR Alarm** example. Example project creation dialog pops up -> click Create and Finish and the project should be generated.
+![create_project](image/create_project.png)
+
+1. Build and flash this example to the board.
+
+### Start with a "Bluetooth - SoC Empty" project ###
+
+1. Create a **Bluetooth - SoC Empty** project for your hardware using Simplicity Studio 5.
+
+2. Copy the `src/app.c` file into the project root folder (overwriting the existing file).
+3. Install the software components:
+
+    3.1 Open the .slcp file in the project
+
+    3.2 Select the SOFTWARE COMPONENTS tab
+
+    3.3 Install the following components:
+
+      - [Services] → [IO Stream] → [Driver] → [IO Stream: USART] → default instance name: vcom
+
+      - [Application] → [Utility] → [Log]
+  
+      - [Third-Party Hardware Drivers] → [Services] → [BTHome v2]
+
+      - [Third-Party Hardware Drivers] → [Sensors] → [PL-N823-01 - PIR Click (Mikroe)]
+  
+4. Build and flash the project to your device.
+
+**Note:**
+
+- Make sure that the [Third Party Hardware Drivers extension](https://github.com/SiliconLabs/third_party_hw_drivers_extension) is added to the required SDK: [Preferences > Simplicity Studio > SDKs](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 **BTHOME v2** component.
+
+- Do not forget to flash a bootloader to your board, see [Bootloader](https://github.com/SiliconLabs/bluetooth_applications/blob/master/README.md#bootloader) for more information.
+
+## How It Works ##
+
+### Application Initialization ###
+
+![application_initialization](image/application_init.png)
+
+### Motion detection ###
+
+![motion_detection](image/motion_detection.png)
+
+## Testing ##
+
+To test this application and monitor the switch changes, you need the following materials:
+
+- Raspberry Pi 4 runs Home Assistant OS
+
+- Home Assistant application on your smartphone
+
+- [BGM220 Bluetooth Module Explorer Kit](https://www.silabs.com/development-tools/wireless/bluetooth/bgm220-explorer-kit) runs the **Bluetooth - BTHome v2 - PIR Alarm** example
+
+To test this example, you should follow the below steps:
+
+1. Power on Raspberry Pi 4 and BTHome PIR alarm device. After that, the microcontroller reads the output of the sensor in millivolts (mV) periodically. If the value is lower than the configured threshold, then the microcontroller sends the updated advertisement packet. The advertisement packet contains information about the movement.
+
+    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. Data is coming from the UART COM port. A screenshot of the console output is shown in the figure below.
+
+    ![console_log](image/console_log.png)
+
+2. Open the Home Assistant application on your smartphone, select [Settings] → [Devices and Services] → [Add Integration]
+![add_device](image/add_device.png)
+
+3. **Add Integration** with the name "BTHome". You can see the list of devices, which are advertising in BTHome v2 format. Choose your device with the correct name, for example **PIRAlarm 571E**, and submit the bindkey. Bindkey is defined in the firmware of the BTHome PIR device.
+
+    - The name of the device is `PIRAlarm`
+
+    - The bindkey is  `11112222333344445555666677778888`
+
+    **Note:** To be able to find your switch device with the Home Assistant application, you need to use the same network on both Raspberry Pi 4 and your smartphone.
+    ![configure_device](image/configure_device.png)
+
+4. After adding your switch device successfully with the bindkey, select a suitable area where your device is located.
+![device_information](image/device_information.png)
+
+Now it is visible that the sensor device has already been added to the Home Assistant system. If you move in front of the sensor, the motion change is visible in the **Sensors** section.

bluetooth_bthome_v2_pir_alarm/SimplicityStudio/bluetooth_bthome_v2_pir_alarm.slcp

@@ -0,0 +1,109 @@
+# Silicon Labs Project Configuration Tools: slcp, v0, Component selection file.
+project_name: bluetooth_bthome_v2_pir_alarm
+label: Bluetooth - BTHome v2 - PIR Alarm
+description: |
+  This project aims to implement a BTHome v2 compatible PIR alarm, the device is reading the PIR sensor value and sends motion detected signal once the measured value is below of the configured threshold.
+
+category: Bluetooth Examples
+
+filter:
+- name: Device Type
+  value: [SoC]
+- name: Project Difficulty
+  value: [Advanced]
+- name: Wireless Technology
+  value: [Bluetooth]
+
+package: Bluetooth
+
+quality: experimental
+
+readme:
+- path: ../README.md
+
+source:
+- path: ../src/main.c
+- path: ../src/app.c
+
+include:
+- path: ../inc/
+  file_list:
+  - path: ../inc/app.h
+
+component:
+  - id: bluetooth_stack
+  - id: gatt_configuration
+  - id: gatt_service_device_information
+  - id: bluetooth_feature_legacy_advertiser
+  - id: bluetooth_feature_connection
+  - id: bluetooth_feature_gatt
+  - id: bluetooth_feature_gatt_server
+  - id: bluetooth_feature_system
+  - id: bluetooth_feature_sm
+  - id: rail_util_pti
+  - id: mpu
+  - id: bt_post_build
+  - id: sl_system
+  - id: device_init
+  - id: app_assert
+  - id: app_log
+  - id: component_catalog
+  - id: sleeptimer
+  - id: iostream_usart
+    instance: [vcom]
+  - id: services_bthome_v2
+    from: third_party_hw_drivers
+  - id: mikroe_pir_pl_n823_01 
+    from: third_party_hw_drivers
+  - id: i2cspm
+    instance: [mikroe]
+
+config_file:
+  - override:
+      component: gatt_configuration
+      file_id: gatt_configuration_file_id
+    path: "../config/btconf/gatt_configuration.btconf"
+    directory: "btconf"
+
+other_file:
+  - path: ../image/add_device.png
+    directory: "image"
+  - path: ../image/application_init.png
+    directory: "image"
+  - path: ../image/create_project.png
+    directory: "image"
+  - path: ../image/motion_detection.png
+    directory: "image"
+  - path: ../image/overview.png
+    directory: "image"
+  - path: ../image/console_log.png
+    directory: "image"
+  - path: ../image/configure_device.png
+    directory: "image"
+  - path: ../image/device_information.png
+    directory: "image"
+
+define:
+  - name: DEBUG_EFM
+
+configuration:
+  - name: SL_STACK_SIZE
+    value: '2752'
+  - name: SL_HEAP_SIZE
+    value: '9200'
+  - condition: [psa_crypto]
+    name: SL_PSA_KEY_USER_SLOT_COUNT
+    value: '0'
+
+tag:
+  - hardware:rf:band:2400
+
+sdk_extension:
+  - id: third_party_hw_drivers
+    version: 2.0.1
+
+ui_hints:
+  highlight:
+    - path: config/btconf/gatt_configuration.btconf
+    - path: README.md
+      focus: true

bluetooth_bthome_v2_pir_alarm/config/btconf/gatt_configuration.btconf

@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project>
+  <gatt generic_attribute_service="true" header="gatt_db.h" name="Custom BLE GATT" out="gatt_db.c" prefix="gattdb_">
+    <service advertise="false" name="Generic Access" requirement="mandatory" sourceId="org.bluetooth.service.generic_access" type="primary" uuid="1800">
+      <informativeText>Abstract: The generic_access service contains generic information about the device. All available Characteristics are readonly. </informativeText>
+      <characteristic id="device_name" name="Device Name" sourceId="org.bluetooth.characteristic.gap.device_name" uuid="2A00">
+        <informativeText/>
+        <value length="13" type="utf-8" variable_length="false">Empty Example</value>
+        <properties read="true" read_requirement="optional" write="true" write_requirement="optional"/>
+      </characteristic>
+      <characteristic name="Appearance" sourceId="org.bluetooth.characteristic.gap.appearance" uuid="2A01">
+        <informativeText>Abstract: The external appearance of this device. The values are composed of a category (10-bits) and sub-categories (6-bits). </informativeText>
+        <value length="2" type="hex" variable_length="false">0000</value>
+        <properties const="true" const_requirement="optional" read="true" read_requirement="optional"/>
+      </characteristic>
+    </service>
+    <service advertise="false" id="device_information" name="Device Information" requirement="mandatory" sourceId="org.bluetooth.service.device_information" type="primary" uuid="180A">
+      <informativeText>Abstract: The Device Information Service exposes manufacturer and/or vendor information about a device. Summary: This service exposes manufacturer information about a device. The Device Information Service is instantiated as a Primary Service. Only one instance of the Device Information Service is exposed on a device.</informativeText>
+      <characteristic const="true" id="manufacturer_name_string" name="Manufacturer Name String" sourceId="org.bluetooth.characteristic.manufacturer_name_string" uuid="2A29">
+        <informativeText>Abstract: The value of this characteristic is a UTF-8 string representing the name of the manufacturer of the device.</informativeText>
+        <value length="12" type="utf-8" variable_length="false">Silicon Labs</value>
+        <properties const="true" read="true">
+          <read authenticated="false" bonded="false" encrypted="false"/>
+        </properties>
+      </characteristic>
+      <characteristic id="model_number_string" name="Model Number String" sourceId="org.bluetooth.characteristic.model_number_string" uuid="2A24">
+        <informativeText>Abstract: The value of this characteristic is a UTF-8 string representing the model number assigned by the device vendor.</informativeText>
+        <value length="8" type="utf-8" variable_length="false">00000000</value>
+        <properties read="true" read_requirement="mandatory"/>
+      </characteristic>
+      <characteristic id="hardware_revision_string" name="Hardware Revision String" sourceId="org.bluetooth.characteristic.hardware_revision_string" uuid="2A27">
+        <informativeText>Summary: The value of this characteristic is a UTF-8 string representing the hardware revision for the hardware within the device.</informativeText>
+        <value length="3" type="utf-8" variable_length="false">000</value>
+        <properties read="true" read_requirement="mandatory"/>
+      </characteristic>
+      <characteristic id="firmware_revision_string" name="Firmware Revision String" sourceId="org.bluetooth.characteristic.firmware_revision_string" uuid="2A26">
+        <informativeText>Summary: The value of this characteristic is a UTF-8 string representing the firmware revision for the firmware within the device.</informativeText>
+        <value length="5" type="utf-8" variable_length="false">0.0.0</value>
+        <properties read="true" read_requirement="mandatory"/>
+      </characteristic>
+      <characteristic const="false" id="system_id" name="System ID" sourceId="org.bluetooth.characteristic.system_id" uuid="2A23">
+        <informativeText>Abstract: The SYSTEM ID characteristic consists of a structure with two fields. The first field are the LSOs and the second field contains the MSOs. This is a 64-bit structure which consists of a 40-bit manufacturer-defined identifier concatenated with a 24 bit unique Organizationally Unique Identifier (OUI). The OUI is issued by the IEEE Registration Authority (http://standards.ieee.org/regauth/index.html) and is required to be used in accordance with IEEE Standard 802-2001.6 while the least significant 40 bits are manufacturer defined. If System ID generated based on a Bluetooth Device Address, it is required to be done as follows. System ID and the Bluetooth Device Address have a very similar structure: a Bluetooth Device Address is 48 bits in length and consists of a 24 bit Company Assigned Identifier (manufacturer defined identifier) concatenated with a 24 bit Company Identifier (OUI). In order to encapsulate a Bluetooth Device Address as System ID, the Company Identifier is concatenated with 0xFFFE followed by the Company Assigned Identifier of the Bluetooth Address. For more guidelines related to EUI-64, refer to http://standards.ieee.org/develop/regauth/tut/eui64.pdf. Examples: If the system ID is based of a Bluetooth Device Address with a Company Identifier (OUI) is 0x123456 and the Company Assigned Identifier is 0x9ABCDE, then the System Identifier is required to be 0x123456FFFE9ABCDE.</informativeText>
+        <value length="8" type="hex" variable_length="false"/>
+        <properties read="true" read_requirement="mandatory"/>
+      </characteristic>
+    </service>
+  </gatt>
+</project>