Update TI Applications with correct OTA startup handling

Author: adabreuti

examples/all-clusters-app/cc13x4_26x4/BUILD.gn

@@ -78,13 +78,18 @@ ti_simplelink_executable("all-clusters-app") {
     "${chip_root}/examples/energy-management-app/energy-management-common/src/EnergyEvseDelegateImpl.cpp",
     "${chip_root}/examples/energy-management-app/energy-management-common/src/EnergyEvseManager.cpp",
     "${chip_root}/examples/providers/DeviceInfoProviderImpl.cpp",
+    "${chip_root}/src/app/clusters/general-diagnostics-server/GenericFaultTestEventTriggerHandler.cpp",
     "${project_dir}/main/AppTask.cpp",
     "${project_dir}/main/ClusterManager.cpp",
     "${project_dir}/main/Globals.cpp",
     "${project_dir}/main/ZclCallbacks.cpp",
     "${project_dir}/main/main.cpp",
   ]
 
+  public = [
+    "${chip_root}/src/platform/cc13xx_26xx/DefaultTestEventTriggerDelegate.h",
+  ]
+
   deps = [
     ":sdk",
     ":sysconfig",

examples/all-clusters-app/cc13x4_26x4/README.md

@@ -65,10 +65,16 @@ guide assumes that the environment is linux based, and recommends Ubuntu 20.04.
     ```
 
 -   Run the bootstrap script to setup the build environment.
+-   Note, a recursive submodule checkout is required to utilize TI's Openthread
+    reference commit.
+-   Note, in order to build the chip-tool and ota-provider examples, a recursive
+    submodule checkout is required for the linux platform as seen in the command
+    below.
 
     ```
     $ cd ~/connectedhomeip
     $ source ./scripts/bootstrap.sh
+    $ ./scripts/checkout_submodules.py --shallow --platform cc13xx_26xx linux --recursive
 
     ```
 

examples/all-clusters-app/cc13x4_26x4/args.gni

@@ -32,7 +32,11 @@ chip_enable_ota_requestor = true
 
 openthread_external_platform =
     "${chip_root}/third_party/openthread/platforms/ti:libopenthread-ti"
-chip_openthread_target = ""
+
+# When using TI Certified Openthread libs set to ${chip_root}/third_party/openthread/platforms/ti:ot-ti-cert
+# For source builds, set to empty string.
+chip_openthread_target =
+    "${chip_root}/third_party/openthread/platforms/ti:ot-ti-cert"
 
 chip_openthread_ftd = true
 
@@ -61,3 +65,8 @@ chip_persist_subscriptions = false
 chip_subscription_timeout_resumption = false
 
 freertos_root = "//third_party/connectedhomeip/third_party/ti_simplelink_sdk/repo_cc13xx_cc26xx/source/third_party/freertos"
+
+if (chip_openthread_target != "") {
+  openthread_root =
+      "//third_party/connectedhomeip/third_party/openthread/ot-ti/openthread"
+}

examples/all-clusters-app/cc13x4_26x4/chip.syscfg

@@ -89,8 +89,8 @@ CCFG.enableCodeGeneration = false;
 
 /* NVS */
 NVS1.$name                      = "CONFIG_NVSINTERNAL";
-NVS1.internalFlash.regionBase = 0xFB800;
-NVS1.internalFlash.regionSize = 0x2800;
+NVS1.internalFlash.regionBase = 0xF8800;
+NVS1.internalFlash.regionSize = 0x6000;
 
 
 NVS2.$name                                 = "CONFIG_NVSEXTERNAL";

examples/all-clusters-app/cc13x4_26x4/main/AppTask.cpp

@@ -45,6 +45,10 @@
 #endif
 #include <app/server/OnboardingCodesUtil.h>
 
+#include <app/TestEventTriggerDelegate.h>
+#include <app/clusters/general-diagnostics-server/GenericFaultTestEventTriggerHandler.h>
+#include <src/platform/cc13xx_26xx/DefaultTestEventTriggerDelegate.h>
+
 #include <ti/drivers/apps/Button.h>
 #include <ti/drivers/apps/LED.h>
 
@@ -56,6 +60,8 @@
 #define APP_EVENT_QUEUE_SIZE 10
 #define BUTTON_ENABLE 1
 
+#define OTAREQUESTOR_INIT_TIMER_DELAY_MS 10000
+
 using namespace ::chip;
 using namespace ::chip::Credentials;
 using namespace ::chip::DeviceLayer;
@@ -70,6 +76,12 @@ AppTask AppTask::sAppTask;
 
 constexpr EndpointId kNetworkCommissioningEndpointSecondary = 0xFFFE;
 
+void StartTimer(uint32_t aTimeoutMs);
+void CancelTimer(void);
+
+uint8_t sTestEventTriggerEnableKey[TestEventTriggerDelegate::kEnableKeyLength] = { 0x00, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77,
+                                                                                   0x88, 0x99, 0xaa, 0xbb, 0xcc, 0xdd, 0xee, 0xff };
+
 #if CHIP_DEVICE_CONFIG_ENABLE_OTA_REQUESTOR
 static DefaultOTARequestor sRequestorCore;
 static DefaultOTARequestorStorage sRequestorStorage;
@@ -90,6 +102,15 @@ void InitializeOTARequestor(void)
 }
 #endif
 
+TimerHandle_t sOTAInitTimer = 0;
+
+// The OTA Init Timer is only started upon the first Thread State Change
+// detected if the device is already on a Thread Network, or during the AppTask
+// Init sequence if the device is not yet on a Thread Network. Once the timer 
+// has been started once, it does not need to be started again so the flag will
+// be set to false.
+bool isAppStarting = true;
+
 #ifdef AUTO_PRINT_METRICS
 static void printMetrics(void)
 {
@@ -132,13 +153,31 @@ void DeviceEventCallback(const ChipDeviceEvent * event, intptr_t arg)
     case DeviceEventType::kCommissioningComplete:
         PLAT_LOG("Commissioning complete");
         break;
+    case DeviceEventType::kThreadStateChange:
+        PLAT_LOG("Thread State Change");
+        bool isThreadAttached = ThreadStackMgrImpl().IsThreadAttached();
+
+        if(isThreadAttached){
+            PLAT_LOG("Device is on the Thread Network");
+#if CHIP_DEVICE_CONFIG_ENABLE_OTA_REQUESTOR
+            if(isAppStarting){
+                StartTimer(OTAREQUESTOR_INIT_TIMER_DELAY_MS);
+                isAppStarting = false;
+            }   
+#endif
+        }
+        break;
     }
 
 #ifdef AUTO_PRINT_METRICS
     printMetrics();
 #endif
 }
 
+void OTAInitTimerEventHandler(TimerHandle_t xTimer){
+    InitializeOTARequestor();
+}
+
 int AppTask::StartAppTask()
 {
     int ret = 0;
@@ -171,6 +210,9 @@ int AppTask::Init()
     // Init Chip memory management before the stack
     Platform::MemoryInit();
 
+    PLAT_LOG("Software Version: %d", CHIP_DEVICE_CONFIG_DEVICE_SOFTWARE_VERSION);
+    PLAT_LOG("Software Version String: %s", CHIP_DEVICE_CONFIG_DEVICE_SOFTWARE_VERSION_STRING);
+
     CHIP_ERROR ret = PlatformMgr().InitChipStack();
     if (ret != CHIP_NO_ERROR)
     {
@@ -179,6 +221,23 @@ int AppTask::Init()
             ;
     }
 
+    // Create FreeRTOS sw timer for OTA timer.
+    sOTAInitTimer = xTimerCreate("OTAInitTmr",                 // Just a text name, not used by the RTOS kernel
+                            OTAREQUESTOR_INIT_TIMER_DELAY_MS,  // timer period (mS)
+                            false,                             // no timer reload (==one-shot)
+                            (void *) this,                     // init timer id = light obj context
+                            OTAInitTimerEventHandler           // timer callback handler
+    );
+
+    if (sOTAInitTimer == NULL)
+    {
+        PLAT_LOG("sOTAInitTimer timer create failed");
+    } 
+    else
+    {
+        PLAT_LOG("sOTAInitTimer timer created successfully ");
+    }
+
     ret = ThreadStackMgr().InitThreadStack();
     if (ret != CHIP_NO_ERROR)
     {
@@ -202,14 +261,6 @@ int AppTask::Init()
             ;
     }
 
-    ret = PlatformMgr().StartEventLoopTask();
-    if (ret != CHIP_NO_ERROR)
-    {
-        PLAT_LOG("PlatformMgr().StartEventLoopTask() failed");
-        while (1)
-            ;
-    }
-
     ret = ThreadStackMgrImpl().StartThreadTask();
     if (ret != CHIP_NO_ERROR)
     {
@@ -234,6 +285,9 @@ int AppTask::Init()
     // Init ZCL Data Model and start server
     PLAT_LOG("Initialize Server");
     static chip::CommonCaseDeviceServerInitParams initParams;
+    static DefaultTestEventTriggerDelegate sTestEventTriggerDelegate{ ByteSpan(sTestEventTriggerEnableKey) };
+    initParams.testEventTriggerDelegate = &sTestEventTriggerDelegate; 
+    
     (void) initParams.InitializeStaticResourcesBeforeServerInit();
 
     // Initialize info provider
@@ -242,18 +296,32 @@ int AppTask::Init()
 
     chip::Server::GetInstance().Init(initParams);
 
+    ret = PlatformMgr().StartEventLoopTask();
+    if (ret != CHIP_NO_ERROR)
+    {
+        PLAT_LOG("PlatformMgr().StartEventLoopTask() failed");
+        while (1)
+            ;
+    }
+
     ConfigurationMgr().LogDeviceConfig();
 
     // We only have network commissioning on endpoint 0.
     emberAfEndpointEnableDisable(kNetworkCommissioningEndpointSecondary, false);
 
+
     // Register a function to receive events from the CHIP device layer.  Note that calls to
     // this function will happen on the CHIP event loop thread, not the app_main thread.
     PlatformMgr().AddEventHandler(DeviceEventCallback, reinterpret_cast<intptr_t>(nullptr));
 
+    bool isThreadEnabled = ThreadStackMgrImpl().IsThreadEnabled();
+    if(!isThreadEnabled && isAppStarting){
 #if CHIP_DEVICE_CONFIG_ENABLE_OTA_REQUESTOR
-    InitializeOTARequestor();
+    PLAT_LOG("Thread is Disabled, enable OTA Requestor");
+    StartTimer(OTAREQUESTOR_INIT_TIMER_DELAY_MS);
+    isAppStarting = false;
 #endif
+    }
     // QR code will be used with CHIP Tool
     PrintOnboardingCodes(RendezvousInformationFlags(RendezvousInformationFlag::kBLE));
 
@@ -276,6 +344,33 @@ void AppTask::AppTaskMain(void * pvParameter)
     }
 }
 
+void StartTimer(uint32_t aTimeoutMs)
+{
+        PLAT_LOG("Start OTA Init Timer")
+        if (xTimerIsTimerActive(sOTAInitTimer))
+        {
+            PLAT_LOG("app timer already started!");
+            CancelTimer();
+        }
+
+        // timer is not active, change its period to required value (== restart).
+        // FreeRTOS- Block for a maximum of 100 ticks if the change period command
+        // cannot immediately be sent to the timer command queue.
+        if (xTimerChangePeriod(sOTAInitTimer, pdMS_TO_TICKS(aTimeoutMs), 100) != pdPASS)
+        {
+            PLAT_LOG("sOTAInitTimer timer start() failed");
+        }  
+}
+
+void CancelTimer(void)
+{
+    if (xTimerStop(sOTAInitTimer, 0) == pdFAIL)
+    {
+        PLAT_LOG("sOTAInitTimer stop() failed");
+    }
+}
+
+
 void AppTask::PostEvent(const AppEvent * aEvent)
 {
     if (xQueueSend(sAppEventQueue, aEvent, 0) != pdPASS)

examples/lighting-app/cc13x4_26x4/BUILD.gn

@@ -65,12 +65,17 @@ ti_simplelink_executable("lighting_app") {
 
   sources = [
     "${chip_root}/examples/providers/DeviceInfoProviderImpl.cpp",
+    "${chip_root}/src/app/clusters/general-diagnostics-server/GenericFaultTestEventTriggerHandler.cpp",
     "${project_dir}/src/AppTask.cpp",
     "${project_dir}/src/LightingManager.cpp",
     "${project_dir}/src/ZclCallbacks.cpp",
     "${project_dir}/src/main.cpp",
   ]
 
+  public = [
+    "${chip_root}/src/platform/cc13xx_26xx/DefaultTestEventTriggerDelegate.h",
+  ]
+
   deps = [
     ":sdk",
     ":sysconfig",

examples/lighting-app/cc13x4_26x4/README.md

@@ -64,10 +64,16 @@ guide assumes that the environment is linux based, and recommends Ubuntu 20.04.
     ```
 
 -   Run the bootstrap script to setup the build environment.
+-   Note, a recursive submodule checkout is required to utilize TI's Openthread
+    reference commit.
+-   Note, in order to build the chip-tool and ota-provider examples, a recursive
+    submodule checkout is required for the linux platform as seen in the command
+    below.
 
     ```
     $ cd ~/connectedhomeip
     $ source ./scripts/bootstrap.sh
+    $ ./scripts/checkout_submodules.py --shallow --platform cc13xx_26xx linux --recursive
 
     ```
 
@@ -101,7 +107,6 @@ Ninja to build the executable.
     If you would like to define arguments on the command line you may add them
     to the GN call.
 
-
     ```
     gn gen out/debug --args="ti_sysconfig_root=\"$HOME/ti/sysconfig_1.18.1\" target_defines=[\"CC13X4_26X4_ATTESTATION_CREDENTIALS=1\"]"
     ```

examples/lighting-app/cc13x4_26x4/args.gni

@@ -30,13 +30,16 @@ lwip_debug = false
 
 chip_enable_ota_requestor = true
 
-chip_openthread_ftd = true
+chip_openthread_ftd = false
 
 ot_ti_lib_dir = ""
 openthread_external_platform =
     "${chip_root}/third_party/openthread/platforms/ti:libopenthread-ti"
 
-chip_openthread_target = ""
+# When using TI Certified Openthread libs set to ${chip_root}/third_party/openthread/platforms/ti:ot-ti-cert
+# For source builds, set to empty string.
+chip_openthread_target =
+    "${chip_root}/third_party/openthread/platforms/ti:ot-ti-cert"
 
 # Disable CHIP Logging
 chip_progress_logging = true
@@ -55,7 +58,7 @@ matter_device_pid = "0x8005"
 matter_software_ver = "0x0001"
 matter_software_ver_str = "1.0.1+1"
 
-custom_factory_data = true
+custom_factory_data = false
 
 # ICD Default configurations
 # when enabled the device will be configured as a sleepy end device
@@ -64,3 +67,8 @@ chip_persist_subscriptions = false
 chip_subscription_timeout_resumption = false
 
 freertos_root = "//third_party/connectedhomeip/third_party/ti_simplelink_sdk/repo_cc13xx_cc26xx/source/third_party/freertos"
+
+if (chip_openthread_target != "") {
+  openthread_root =
+      "//third_party/connectedhomeip/third_party/openthread/ot-ti/openthread"
+}

examples/lighting-app/cc13x4_26x4/chip.syscfg

@@ -16,7 +16,6 @@
  *    limitations under the License.
  */
 
-
 /* Modules */
 var AESCCM      = scripting.addModule("/ti/drivers/AESCCM");
 var AESECB      = scripting.addModule("/ti/drivers/AESECB");
@@ -89,8 +88,8 @@ CCFG.enableCodeGeneration = false;
 
 /* NVS */
 NVS1.$name                      = "CONFIG_NVSINTERNAL";
-NVS1.internalFlash.regionBase = 0xFB800;
-NVS1.internalFlash.regionSize = 0x2800;
+NVS1.internalFlash.regionBase = 0xF8800;
+NVS1.internalFlash.regionSize = 0x6000;
 
 
 NVS2.$name                                 = "CONFIG_NVSEXTERNAL";

examples/lighting-app/cc13x4_26x4/src/AppEvent.h

@@ -34,6 +34,7 @@ struct AppEvent
         kEventType_IdentifyStop,
         kEventType_Light,
         kEventType_Timer,
+        kEventType_Identify,
     };
 
     enum AppEventButtonType