[TC-IDM-4.3] Report Data Messages post Subscription Activation (python)

src/app/BufferedReadCallback.h

@@ -70,6 +70,10 @@ class BufferedReadCallback : public ReadClient::Callback
     //
     void OnReportBegin() override;
     void OnReportEnd() override;
+    void NotifySubscriptionStillActive(const ReadClient & apReadClient) override
+    {
+        mCallback.NotifySubscriptionStillActive(apReadClient);
+    }
     void OnAttributeData(const ConcreteDataAttributePath & aPath, TLV::TLVReader * apData, const StatusIB & aStatus) override;
     void OnError(CHIP_ERROR aError) override
     {

src/controller/python/chip/clusters/Attribute.py

@@ -551,6 +551,15 @@ def SetErrorCallback(self, callback: Callable[[int, SubscriptionTransaction], No
         if callback is not None:
             self._onErrorCb = callback
 
+    def SetNotifySubscriptionStillActiveCallback(self, callback: Callable):
+        '''
+        Sets the callback function that gets invoked when a report data message is sent. The callback
+        is expected to have the following signature:
+            def Callback()
+        '''
+        if callback is not None:
+            self._readTransaction.register_notify_subscription_still_active_callback(callback)
+
     @property
     def OnAttributeChangeCb(self) -> Callable[[TypedAttributePath, SubscriptionTransaction], None]:
         return self._onAttributeChangeCb
@@ -752,9 +761,9 @@ def handleResubscriptionAttempted(self, terminationCause: PyChipError, nextResub
     def _handleReportBegin(self):
         pass
 
-    def _handleReportEnd(self):
+    def _handleReportEnd(self):        
         self._cache.UpdateCachedData(self._changedPathSet)
-
+        
         if (self._subscription_handler is not None):
             for change in self._changedPathSet:
                 try:
@@ -785,7 +794,6 @@ def _handleDone(self):
             else:
                 self._future.set_result(AsyncReadTransaction.ReadResponse(
                     attributes=self._cache.attributeCache, events=self._events, tlvAttributes=self._cache.attributeTLVCache))
-
         #
         # Decrement the ref on ourselves to match the increment that happened at allocation.
         # This happens synchronously as part of handling done to ensure the object remains valid
@@ -795,14 +803,23 @@ def _handleDone(self):
 
     def handleDone(self):
         self._event_loop.call_soon_threadsafe(self._handleDone)
-
+        
     def handleReportBegin(self):
-        pass
-
+        self._handleReportBegin()
+        
     def handleReportEnd(self):
-        # self._event_loop.call_soon_threadsafe(self._handleReportEnd)
         self._handleReportEnd()
 
+    def _handleNotifySubscriptionStillActive(self):
+        if self._notify_subscription_still_active_callback:
+            self._notify_subscription_still_active_callback()
+
+    def handleNotifySubscriptionStillActive(self):
+        self._handleNotifySubscriptionStillActive()
+
+    def register_notify_subscription_still_active_callback(self, callback):
+        self._notify_subscription_still_active_callback = callback        
+
 
 class AsyncWriteTransaction:
     def __init__(self, future: Future, eventLoop):
@@ -861,7 +878,8 @@ def handleDone(self):
     None, py_object)
 _OnReportEndCallbackFunct = CFUNCTYPE(
     None, py_object)
-
+_OnNotifySubscriptionStillActiveCallbackFunct = CFUNCTYPE(
+    None, py_object)
 
 @_OnReadAttributeDataCallbackFunct
 def _OnReadAttributeDataCallback(closure, dataVersion: int, endpoint: int, cluster: int, attribute: int, status, data, len):
@@ -909,6 +927,11 @@ def _OnReportEndCallback(closure):
     closure.handleReportEnd()
 
 
+@_OnNotifySubscriptionStillActiveCallbackFunct
+def _OnNotifySubscriptionStillActiveCallback(closure):
+    closure.handleNotifySubscriptionStillActive()
+
+
 @_OnReadDoneCallbackFunct
 def _OnReadDoneCallback(closure):
     closure.handleDone()
@@ -1180,14 +1203,15 @@ def Init():
                    _OnReadAttributeDataCallbackFunct, _OnReadEventDataCallbackFunct,
                    _OnSubscriptionEstablishedCallbackFunct, _OnResubscriptionAttemptedCallbackFunct,
                    _OnReadErrorCallbackFunct, _OnReadDoneCallbackFunct,
-                   _OnReportBeginCallbackFunct, _OnReportEndCallbackFunct])
+                   _OnReportBeginCallbackFunct, _OnReportEndCallbackFunct,
+                   _OnNotifySubscriptionStillActiveCallbackFunct])
 
     handle.pychip_WriteClient_InitCallbacks(
         _OnWriteResponseCallback, _OnWriteErrorCallback, _OnWriteDoneCallback)
     handle.pychip_ReadClient_InitCallbacks(
         _OnReadAttributeDataCallback, _OnReadEventDataCallback,
         _OnSubscriptionEstablishedCallback, _OnResubscriptionAttemptedCallback, _OnReadErrorCallback, _OnReadDoneCallback,
-        _OnReportBeginCallback, _OnReportEndCallback)
+        _OnReportBeginCallback, _OnReportEndCallback, _OnNotifySubscriptionStillActiveCallback)
 
     _BuildAttributeIndex()
     _BuildClusterIndex()

src/controller/python/chip/clusters/attribute.cpp

@@ -83,6 +83,7 @@ using OnReadErrorCallback               = void (*)(PyObject * appContext, PyChip
 using OnReadDoneCallback                = void (*)(PyObject * appContext);
 using OnReportBeginCallback             = void (*)(PyObject * appContext);
 using OnReportEndCallback               = void (*)(PyObject * appContext);
+using OnNotifySubscriptionStillActiveCallback               = void (*)(PyObject * appContext);
 
 OnReadAttributeDataCallback gOnReadAttributeDataCallback             = nullptr;
 OnReadEventDataCallback gOnReadEventDataCallback                     = nullptr;
@@ -92,6 +93,7 @@ OnReadErrorCallback gOnReadErrorCallback                             = nullptr;
 OnReadDoneCallback gOnReadDoneCallback                               = nullptr;
 OnReportBeginCallback gOnReportBeginCallback                         = nullptr;
 OnReportBeginCallback gOnReportEndCallback                           = nullptr;
+OnNotifySubscriptionStillActiveCallback gOnNotifySubscriptionStillActiveCallback = nullptr;
 
 void PythonResubscribePolicy(uint32_t aNumCumulativeRetries, uint32_t & aNextSubscriptionIntervalMsec, bool & aShouldResubscribe)
 {
@@ -225,6 +227,11 @@ class ReadClientCallback : public ReadClient::Callback
 
     void OnReportEnd() override { gOnReportEndCallback(mAppContext); }
 
+    void NotifySubscriptionStillActive(const ReadClient & apReadClient) override
+    {
+        gOnNotifySubscriptionStillActiveCallback(mAppContext);
+    }
+
     void OnDone(ReadClient *) override
     {
         gOnReadDoneCallback(mAppContext);
@@ -326,16 +333,18 @@ void pychip_ReadClient_InitCallbacks(OnReadAttributeDataCallback onReadAttribute
                                      OnSubscriptionEstablishedCallback onSubscriptionEstablishedCallback,
                                      OnResubscriptionAttemptedCallback onResubscriptionAttemptedCallback,
                                      OnReadErrorCallback onReadErrorCallback, OnReadDoneCallback onReadDoneCallback,
-                                     OnReportBeginCallback onReportBeginCallback, OnReportEndCallback onReportEndCallback)
+                                     OnReportBeginCallback onReportBeginCallback, OnReportEndCallback onReportEndCallback,
+                                     OnNotifySubscriptionStillActiveCallback onNotifySubscriptionStillActiveCallback)
 {
-    gOnReadAttributeDataCallback       = onReadAttributeDataCallback;
-    gOnReadEventDataCallback           = onReadEventDataCallback;
-    gOnSubscriptionEstablishedCallback = onSubscriptionEstablishedCallback;
-    gOnResubscriptionAttemptedCallback = onResubscriptionAttemptedCallback;
-    gOnReadErrorCallback               = onReadErrorCallback;
-    gOnReadDoneCallback                = onReadDoneCallback;
-    gOnReportBeginCallback             = onReportBeginCallback;
-    gOnReportEndCallback               = onReportEndCallback;
+    gOnReadAttributeDataCallback                = onReadAttributeDataCallback;
+    gOnReadEventDataCallback                    = onReadEventDataCallback;
+    gOnSubscriptionEstablishedCallback          = onSubscriptionEstablishedCallback;
+    gOnResubscriptionAttemptedCallback          = onResubscriptionAttemptedCallback;
+    gOnReadErrorCallback                        = onReadErrorCallback;
+    gOnReadDoneCallback                         = onReadDoneCallback;
+    gOnReportBeginCallback                      = onReportBeginCallback;
+    gOnReportEndCallback                        = onReportEndCallback;
+    gOnNotifySubscriptionStillActiveCallback    = onNotifySubscriptionStillActiveCallback;
 }
 
 PyChipError pychip_WriteClient_WriteAttributes(void * appContext, DeviceProxy * device, size_t timedWriteTimeoutMsSizeT,