Applications: matter bridge: code refactor

Unified code to a common place

Extended docs secion on adding new protocol

Signed-off-by: Adam Maciuga <[email protected]>

Author: Adam-Maciuga

applications/matter_bridge/CMakeLists.txt

@@ -28,33 +28,36 @@ target_include_directories(app PRIVATE
   src
   src/bridged_device_types
   ${ZAP_PARENT_DIR}
-  ${ZEPHYR_NRF_MODULE_DIR}/samples/matter/common/src/bridge/
-  ${ZEPHYR_NRF_MODULE_DIR}/samples/matter/common/src/bridge/util
+  src/core/util
+  src/core
 )
 
 target_sources(app PRIVATE
   src/app_task.cpp
   src/main.cpp
   src/bridge_shell.cpp
   src/zcl_callbacks.cpp
-  ${ZEPHYR_NRF_MODULE_DIR}/samples/matter/common/src/bridge/bridge_manager.cpp
-  ${ZEPHYR_NRF_MODULE_DIR}/samples/matter/common/src/bridge/matter_bridged_device.cpp
-  ${ZEPHYR_NRF_MODULE_DIR}/samples/matter/common/src/bridge/bridge_storage_manager.cpp
-  ${ZEPHYR_NRF_MODULE_DIR}/samples/matter/common/src/bridge/bridged_device_data_provider.cpp
+  src/core/bridge_manager.cpp
+  src/core/matter_bridged_device.cpp
+  src/core/bridge_storage_manager.cpp
+  src/core/bridged_device_data_provider.cpp
   ${ZEPHYR_NRF_MODULE_DIR}/samples/matter/common/src/binding/binding_handler.cpp
 )
 
 if(CONFIG_BRIDGED_DEVICE_BT)
   target_sources(app PRIVATE
-    ${ZEPHYR_NRF_MODULE_DIR}/samples/matter/common/src/bridge/ble_connectivity_manager.cpp
-      src/ble_providers/ble_bridged_device_factory.cpp
+    src/ble/ble_connectivity_manager.cpp
+    src/ble/ble_bridged_device_factory.cpp
+  )
+  target_include_directories(app PRIVATE
+    src/ble
+    src/ble/data_providers
   )
-  target_include_directories(app PRIVATE src/ble_providers)
 
 if(CONFIG_BRIDGE_ONOFF_LIGHT_BRIDGED_DEVICE AND (CONFIG_BRIDGE_GENERIC_SWITCH_BRIDGED_DEVICE OR CONFIG_BRIDGE_ONOFF_LIGHT_SWITCH_BRIDGED_DEVICE))
   target_sources(app PRIVATE
     src/bridged_device_types/onoff_light.cpp
-    src/ble_providers/ble_lbs_data_provider.cpp
+    src/ble/data_providers/ble_lbs_data_provider.cpp
   )
 
 if(CONFIG_BRIDGE_GENERIC_SWITCH_BRIDGED_DEVICE)
@@ -84,7 +87,7 @@ endif() # CONFIG_BRIDGE_TEMPERATURE_SENSOR_BRIDGED_DEVICE
 # Assume it makes no sense to support BLE environmental sensor without all Matter counterparts
 if(CONFIG_BRIDGE_TEMPERATURE_SENSOR_BRIDGED_DEVICE AND CONFIG_BRIDGE_HUMIDITY_SENSOR_BRIDGED_DEVICE)
   target_sources(app PRIVATE
-    src/ble_providers/ble_environmental_data_provider.cpp
+    src/ble/data_providers/ble_environmental_data_provider.cpp
 )
 endif() # CONFIG_BRIDGE_TEMPERATURE_SENSOR_BRIDGED_DEVICE AND CONFIG_BRIDGE_HUMIDITY_SENSOR_BRIDGED_DEVICE
 

applications/matter_bridge/Kconfig

@@ -186,6 +186,6 @@ config BRIDGE_EXPERIMENTAL
 
 source "$(ZEPHYR_CONNECTEDHOMEIP_MODULE_DIR)/config/nrfconnect/chip-module/Kconfig.features"
 source "$(ZEPHYR_CONNECTEDHOMEIP_MODULE_DIR)/config/nrfconnect/chip-module/Kconfig.defaults"
-source "$(ZEPHYR_NRF_MODULE_DIR)/samples/matter/common/src/bridge/Kconfig"
+source "$(ZEPHYR_NRF_MODULE_DIR)/applications/matter_bridge/src/core/Kconfig"
 source "$(ZEPHYR_NRF_MODULE_DIR)/samples/matter/common/src/Kconfig"
 source "Kconfig.zephyr"

applications/matter_bridge/doc/adding_ble_bridged_device_service.rst

@@ -31,8 +31,8 @@ The following steps show how to add support for a new Bluetooth LE service calle
 
 #. Implement the ``Bridged Device Data Provider`` role.
 
-   a. Create the :file:`my_bt_service_data_provider.cpp` and :file:`my_bt_service_data_provider.h` files for your Bluetooth LE Data Provider in the :file:`src/ble_providers` directory.
-   #. Open the :file:`nrf/samples/matter/common/src/bridge/ble_bridged_device.h` header file and find the :c:struct:`BLEBridgedDeviceProvider` class constructor.
+   a. Create the :file:`my_bt_service_data_provider.cpp` and :file:`my_bt_service_data_provider.h` files for your Bluetooth LE Data Provider in the :file:`src/ble/data_providers` directory.
+   #. Open the :file:`nrf/applications/matter_bridge/src/ble/data_providers/ble_bridged_device.h` header file and find the :c:struct:`BLEBridgedDeviceProvider` class constructor.
       Note the constructor signature, it will be used in the child class implemented in the next steps.
    #. Add a new :c:struct:`MyBtServiceDataProvider` class inheriting :c:struct:`BLEBridgedDeviceProvider`, and implement its constructor in the :file:`my_bt_service_data_provider.h` file.
 
@@ -50,7 +50,7 @@ The following steps show how to add support for a new Bluetooth LE service calle
 
         };
 
-   #. Open the :file:`nrf/samples/matter/common/src/bridge/ble_bridged_device.h` header file again to see which methods of :c:struct:`BLEBridgedDeviceProvider` class are purely virtual (assigned with ``=0``) and have to be overridden by the :c:struct:`MyBtServiceDataProvider` class.
+   #. Open the :file:`nrf/applications/matter_bridge/src/ble/data_providers/ble_bridged_device.h` header file again to see which methods of :c:struct:`BLEBridgedDeviceProvider` class are purely virtual (assigned with ``=0``) and have to be overridden by the :c:struct:`MyBtServiceDataProvider` class.
 
       Note that :c:struct:`BLEBridgedDeviceProvider` inherits from the :c:struct:`BridgedDeviceDataProvider` class, so the :c:struct:`MyBtServiceDataProvider` class has to implement the purely virtual methods of :c:struct:`BridgedDeviceDataProvider` as well.
    #. Edit the :c:struct:`MyBtServiceDataProvider` class in the :file:`my_bt_service_data_provider.h` header file to declare the required methods as follows:
@@ -247,12 +247,12 @@ The following steps show how to add support for a new Bluetooth LE service calle
    .. code-block:: cmake
 
       target_sources(app PRIVATE
-        src/ble_providers/my_bt_service_data_provider.cpp
+        src/ble/data_providers/my_bt_service_data_provider.cpp
       )
 
 #. Provide an allocator for ``MyBtServiceDataProvider`` object creation.
    The Matter Bridge application uses a :c:struct:`BleBridgedDeviceFactory` factory module that creates paired ``Matter Bridged Device`` and ``Bridged Device Data Provider`` objects matching a specific Matter device type ID.
-   To add support for creating the ``MyBtServiceDataProvider`` object, edit the :file:`src/ble_providers/ble_bridged_device_factory.h` and :file:`src/ble_providers/ble_bridged_device_factory.cpp` files as follows:
+   To add support for creating the ``MyBtServiceDataProvider`` object, edit the :file:`src/ble/ble_bridged_device_factory.h` and :file:`src/ble/ble_bridged_device_factory.cpp` files as follows:
 
    - :file:`ble_bridged_device_factory.h`
 
@@ -270,7 +270,7 @@ The following steps show how to add support for a new Bluetooth LE service calle
 
 #. Provide mapping between the ``My Bt Service`` UUID and corresponding Matter device types in the helper methods.
 
-   a. Add the ``MyBtService`` UUID in the :c:enum:`ServiceUuid` declaration, in the :file:`src/ble_providers/ble_bridged_device_factory.h` header file.
-   #. Perform proper mapping of Bluetooth UUID and Matter device types in the :c:func:`MatterDeviceTypeToBleService` and :c:func:`BleServiceToMatterDeviceType` methods, in the :file:`src/ble_providers/ble_bridged_device_factory.cpp` file.
+   a. Add the ``MyBtService`` UUID in the :c:enum:`ServiceUuid` declaration, in the :file:`src/ble/ble_bridged_device_factory.h` header file.
+   #. Perform proper mapping of Bluetooth UUID and Matter device types in the :c:func:`MatterDeviceTypeToBleService` and :c:func:`BleServiceToMatterDeviceType` methods, in the :file:`src/ble/ble_bridged_device_factory.cpp` file.
 
 #. Compile the target and test it following the steps from the :ref:`Matter Bridge application testing <matter_bridge_testing>` section.

applications/matter_bridge/doc/adding_bridged_matter_device.rst

@@ -18,7 +18,7 @@ The following steps show how to add support for a new Matter device type, using
 #. Implement the ``Matter Bridged Device`` role.
 
    a. Create the :file:`pressure_sensor.cpp` and :file:`pressure_sensor.h` files in the :file:`src/bridged_device_types` directory.
-   #. Open the :file:`nrf/samples/matter/common/src/bridge/matter_bridged_device.h` header file and find the :c:struct:`MatterBridgedDevice` class constructor.
+   #. Open the :file:`nrf/applications/matter_bridge/src/core/matter_bridged_device.h` header file and find the :c:struct:`MatterBridgedDevice` class constructor.
       Note the constructor signature, it will be used in the child class implemented in the next steps.
    #. Add a new :c:struct:`PressureSensorDevice` class inheriting :c:struct:`MatterBridgedDevice`, and implement its constructor in the :file:`pressure_sensor.cpp` and :file:`pressure_sensor.h` files.
 
@@ -49,7 +49,7 @@ The following steps show how to add support for a new Matter device type, using
 
    #. Declare all clusters that are mandatory for the Pressure Sensor device type, according to the Matter device library specification, and fill the appropriate :c:struct:`MatterBridgedDevice` class fields in the :c:struct:`PressureSensorDevice` class constructor.
 
-      The Pressure Sensor device requires the ``Descriptor``, ``Bridged Device Basic Information`` and ``Identify`` clusters, which can be declared using helper macros from the :file:`nrf/samples/matter/common/src/bridge/matter_bridged_device.h` header file, and the ``Pressure Measurement`` cluster, which has to be defined in the application.
+      The Pressure Sensor device requires the ``Descriptor``, ``Bridged Device Basic Information`` and ``Identify`` clusters, which can be declared using helper macros from the :file:`nrf/applications/matter_bridge/src/core/matter_bridged_device.h` header file, and the ``Pressure Measurement`` cluster, which has to be defined in the application.
       Edit the :file:`pressure_sensor.cpp` file as follows:
 
       - Add:
@@ -109,7 +109,7 @@ The following steps show how to add support for a new Matter device type, using
                   mDataVersion = static_cast<DataVersion *>(chip::Platform::MemoryAlloc(sizeof(DataVersion) * mDataVersionSize));
             }
 
-   #. Open the :file:`nrf/samples/matter/common/src/bridge/matter_bridged_device.h` header file again to see which methods of the :c:struct:`MatterBridgedDevice` class are purely virtual (assigned with ``=0``) and have to be overridden by the :c:struct:`PressureSensorDevice` class.
+   #. Open the :file:`nrf/applications/matter_bridge/src/core/matter_bridged_device.h` header file again to see which methods of the :c:struct:`MatterBridgedDevice` class are purely virtual (assigned with ``=0``) and have to be overridden by the :c:struct:`PressureSensorDevice` class.
    #. Edit the :c:struct:`PressureSensorDevice` class in the :file:`pressure_sensor.h` header file to declare the required methods as follows:
 
       .. code-block:: C++
@@ -118,7 +118,8 @@ The following steps show how to add support for a new Matter device type, using
 
         CHIP_ERROR HandleRead(chip::ClusterId clusterId, chip::AttributeId attributeId, uint8_t *buffer,
                     uint16_t maxReadLength) override;
-        CHIP_ERROR HandleWrite(chip::ClusterId clusterId, chip::AttributeId attributeId, uint8_t *buffer) override;
+        CHIP_ERROR HandleWrite(chip::ClusterId clusterId, chip::AttributeId attributeId, uint8_t *buffer,
+                    size_t size) override
         CHIP_ERROR HandleAttributeChange(chip::ClusterId clusterId, chip::AttributeId attributeId, void *data,
                         size_t dataSize) override;
 
@@ -257,7 +258,7 @@ The following steps show how to add support for a new Matter device type, using
 #. Implement the ``Bridged Device Data Provider`` role.
 
    a. Create the :file:`simulated_pressure_sensor_data_provider.cpp` and :file:`simulated_pressure_sensor_data_provider.h` files in the :file:`src/simulated_providers` directory.
-   #. Open the :file:`nrf/samples/matter/common/src/bridge/bridged_device_data_provider.h` header file and find the :c:struct:`BridgedDeviceDataProvider` class constructor.
+   #. Open the :file:`nrf/applications/matter_bridge/src/core/bridged_device_data_provider.h` header file and find the :c:struct:`BridgedDeviceDataProvider` class constructor.
       Note the constructor signature, it will be used in the child class implemented in the next steps.
    #. Add a new :c:struct:`SimulatedPressureSensorDataProvider` class inheriting :c:struct:`BridgedDeviceDataProvider`, and implement its constructor in the :file:`simulated_pressure_sensor_data_provider.h` header file.
 
@@ -275,7 +276,7 @@ The following steps show how to add support for a new Matter device type, using
             ~SimulatedPressureSensorDataProvider() {}
          };
 
-   #. Open the :file:`nrf/samples/matter/common/src/bridge/bridged_device_data_provider.h` header file again to see which methods of the :c:struct:`BridgedDeviceDataProvider` class are purely virtual (assigned with ``=0``) and have to be overridden by the :c:struct:`SimulatedPressureSensorDataProvider` class.
+   #. Open the :file:`nrf/applications/matter_bridge/src/core/bridged_device_data_provider.h` header file again to see which methods of the :c:struct:`BridgedDeviceDataProvider` class are purely virtual (assigned with ``=0``) and have to be overridden by the :c:struct:`SimulatedPressureSensorDataProvider` class.
    #. Edit the :c:struct:`SimulatedPressureSensorDataProvider` class in the :file:`simulated_pressure_sensor_data_provider.h` header file to declare the required methods as follows:
 
       .. code-block:: C++
@@ -396,7 +397,7 @@ The following steps show how to add support for a new Matter device type, using
       .. code-block:: C++
 
          { PressureSensorDevice::kPressureSensorDeviceTypeId,
-         [checkUniqueID, checkLabel](const char *nodeLabel) -> Nrf::MatterBridgedDevice * {
+         [checkUniqueID, checkLabel](const char* uniqueID, const char* nodeLabel) -> Nrf::MatterBridgedDevice * {
             if (!checkUniqueID(uniqueID) || !checkLabel(nodeLabel)) {
                return nullptr;
             }
@@ -412,4 +413,4 @@ The following steps show how to add support for a new Matter device type, using
             return chip::Platform::New<SimulatedPressureSensorDataProvider>(updateClb, commandClb);
          } },
 
-5. Compile the target and test it following the steps from the :ref:`Matter Bridge application testing <matter_bridge_testing>` section.
+#. Compile the target and test it following the steps from the :ref:`Matter Bridge application testing <matter_bridge_testing>` section.

applications/matter_bridge/doc/adding_bridged_protocol.rst

@@ -18,3 +18,43 @@ This allows updating the Matter Data Model state and also enables handling Matte
 The subscription handling can be implemented either by utilizing the implemented protocol's native support for pushing notifications by the end device, or by performing periodic data polling, which is less efficient.
 
 If the Matter device can perform write operations or be controlled using Matter invoke command operations, the ``Bridged Device Data Provider`` shall be able to send appropriate information to the physical end device.
+
+Complete the following steps to add support for a proprietary protocol:
+
+1. Create a ``MyProtocol Data Provider`` class that inherits from the ``Bridged Device Data Provider`` class.
+   This class should contain all the data and logic used by all your bridged devices.
+   For reference, see the implementation in the :file:`src/ble/data_providers/ble_bridged_device.h` file.
+
+#. For each bridged device type, create a ``MyProtocol MyDevice Data Provider`` class that inherits from the ``MyProtocol Data Provider`` class.
+   These classes keep the state of the Matter device synchronized with the state of the device, using the following functions:
+   * :c:func:`NotifyUpdateState` - Called to notify the bridge when the bridged device changed state.
+   * :c:func:`UpdateState` - Called by the bridge when the bridged device should update its state (for example, turning a light on or off).
+
+#. Create a ``MyProtocol Connectivity Manager`` class that holds information about all current connections of the bridged device.
+   This class must implement the following functions:
+
+   .. code-block:: C++
+
+      CHIP_ERROR AddMyProtocolProvider(MyProtocolBridgedDeviceProvider *provider, const MyProtocolId &deviceId);
+      CHIP_ERROR RemoveMyProtocolProvider(const MyProtocolId &deviceId);
+      MyProtocolBridgedDeviceProvider *FindMyProtocolProvider(const MyProtocolId &deviceId);
+
+   This class takes care of any connection-related code that your protocol needs.
+
+#. Create a ``MyProtocol Bridged Device Factory`` class that handles device creation, storage, and removal.
+
+#. Adapt the main application to use your newly created classes.
+   Create a new ``BRIDGED_DEVICE_MY_PROTOCOL`` configuration, go through the application code and find where the :ref:`CONFIG_BRIDGED_DEVICE_BT <CONFIG_BRIDGED_DEVICE_BT>` Kconfig option is used by the preprocessor.
+   Add support for your protocol in the found instances.
+
+An application with support for ``MyProtocol`` would work like this:
+
+1. The application reads the stored devices and creates them using the ``MyProtocol Bridged Device Factory`` class.
+#. To bridge new devices, the application needs to know their ``MyProtocol`` connection details.
+   Those details can be provided by the user or obtained through device discovery.
+   To enable this, implement the necessary shell commands in the :file:`src/bridge_shell.cpp` file.
+#. Using the ``MyProtocol Bridged Device Factory`` class and knowing the connection details, the application creates and stores new bridged devices.
+   You can use the ``MyProtocol Connectivity Manager`` class to map the ``MyProtocol`` device ID to the corresponding ``MyProtocol Device Data Provider`` instance.
+#. Matter traffic is routed through the ``MyProtocol MyDevice Data Provider`` class.
+   When data from the device is received, you can use the ``MyProtocol Connectivity Manager`` class to forward the data to the correct ``MyProtocol MyDevice Data Provider`` instance.
+#. If a device must be removed, the ``MyProtocol Bridged Device Factory`` class handles it.

applications/matter_bridge/src/app_task.cpp

@@ -15,11 +15,11 @@
 #include "app/matter_init.h"
 #include "app/task_executor.h"
 #include "board/board.h"
-#include "bridge/bridge_manager.h"
-#include "bridge/bridge_storage_manager.h"
+#include "bridge_manager.h"
+#include "bridge_storage_manager.h"
 
 #ifdef CONFIG_BRIDGED_DEVICE_BT
-#include "bridge/ble_connectivity_manager.h"
+#include "ble_connectivity_manager.h"
 #endif
 
 #include <app-common/zap-generated/attributes/Accessors.h>

applications/matter_bridge/src/ble_providers/ble_bridged_device_factory.cpp renamed to applications/matter_bridge/src/ble/ble_bridged_device_factory.cpp

@@ -87,9 +87,9 @@ CHIP_ERROR StoreDevice(MatterBridgedDevice *device, BridgedDeviceDataProvider *p
 
 	bridgedDevice.mEndpointId = device->GetEndpointId();
 	bridgedDevice.mDeviceType = device->GetDeviceType();
-	bridgedDevice.mUniqueIDLength = strlen(device->GetUniqueID());
+	bridgedDevice.mUniqueIDLength = strnlen(device->GetUniqueID(),MatterBridgedDevice::kUniqueIDSize);
 	memcpy(bridgedDevice.mUniqueID, device->GetUniqueID(), bridgedDevice.mUniqueIDLength);
-	bridgedDevice.mNodeLabelLength = strlen(device->GetNodeLabel());
+	bridgedDevice.mNodeLabelLength = strnlen(device->GetNodeLabel(),MatterBridgedDevice::kNodeLabelSize);
 	memcpy(bridgedDevice.mNodeLabel, device->GetNodeLabel(), bridgedDevice.mNodeLabelLength);
 
 	/* Fill BT address information as a part of implementation specific user data. */
@@ -235,15 +235,15 @@ BleBridgedDeviceFactory::BridgedDeviceFactory &BleBridgedDeviceFactory::GetBridg
 {
 	auto checkUniqueID = [](const char *uniqueID) {
 		/* If node uniqueID is provided it must fit the maximum defined length */
-		if (!uniqueID || (uniqueID && (strlen(uniqueID) < Nrf::MatterBridgedDevice::kUniqueIDSize))) {
+		if (!uniqueID || (uniqueID && (strnlen(uniqueID,Nrf::MatterBridgedDevice::kUniqueIDSize) < Nrf::MatterBridgedDevice::kUniqueIDSize))) {
 			return true;
 		}
 		return false;
 	};
 
 	auto checkLabel = [](const char *nodeLabel) {
 		/* If node label is provided it must fit the maximum defined length */
-		if (!nodeLabel || (nodeLabel && (strlen(nodeLabel) < MatterBridgedDevice::kNodeLabelSize))) {
+		if (!nodeLabel || (nodeLabel && (strnlen(nodeLabel,Nrf::MatterBridgedDevice::kNodeLabelSize) < MatterBridgedDevice::kNodeLabelSize))) {
 			return true;
 		}
 		return false;