Updating to Silabs's standards

Author: silabs-alexandre

Joining_InstallCode/SimplicityStudio/JoinWithCode_CO.sls

@@ -27,7 +27,7 @@
  *    Include this file and corresponding header files
  *    Create the emberAfMainInitCallback() into the app.c file and initialize
  *    the command group : my_cli_command_group, and events
- *    (look at the app.c of this project)
+ *    (refer to app.c of this project as an example)
  ******************************************************************************/
 
 /***************************************************************************//**
@@ -41,40 +41,42 @@ sl_zigbee_event_t networkOpenCtrl;
 static EmberNodeId nodeTable[3] = {0};
 static int currentIndex = 0;
 
-// Create the CLI_Command_info
+/// Create the CLI_Command_info
 static const sl_cli_command_info_t myFormCreate_command =
-    SL_CLI_COMMAND(eventNetworkFormHandler,
-                   "Form and Create custom Network",
-                   "No argument",
-                   {SL_CLI_ARG_END, });
+  SL_CLI_COMMAND(eventNetworkFormHandler,
+                 "Form and Create custom Network",
+                 "No argument",
+                 {SL_CLI_ARG_END, });
+
 static const sl_cli_command_info_t myOpenInstallCode_command =
-    SL_CLI_COMMAND(networkOpenwithCodeHandler,
-                   "Open the network with Install-code",
-                   "index<7:0>" SL_CLI_UNIT_SEPARATOR "eui64" SL_CLI_UNIT_SEPARATOR "install-code" SL_CLI_UNIT_SEPARATOR,
-                   {SL_CLI_ARG_UINT8, SL_CLI_ARG_HEX, SL_CLI_ARG_HEX, SL_CLI_ARG_END, });
+  SL_CLI_COMMAND(networkOpenwithCodeHandler,
+                 "Open the network with Install-code",
+                 "index<7:0>" SL_CLI_UNIT_SEPARATOR "eui64" SL_CLI_UNIT_SEPARATOR "install-code" SL_CLI_UNIT_SEPARATOR,
+                 {SL_CLI_ARG_UINT8, SL_CLI_ARG_HEX, SL_CLI_ARG_HEX, SL_CLI_ARG_END, });
 
-// Create the entries
+/// Create the entries
 const sl_cli_command_entry_t my_cli_commands[] = {
-    {"form", &myFormCreate_command, false},
-    {"open", &myOpenInstallCode_command, false},
-    {NULL, NULL, false},
+  {"form", &myFormCreate_command, false},
+  {"open", &myOpenInstallCode_command, false},
+  {NULL, NULL, false},
 };
 
-// Create the group of entries
+/// Create the group of entries
 sl_cli_command_group_t my_cli_command_group = {
-    {NULL},
-    false,
-    my_cli_commands
+  {NULL},
+  false,
+  my_cli_commands
 };
 
 /***************************************************************************//**
  * Functions & events.
  ******************************************************************************/
 
 /**
- * Callback when Network Creator is completed
- * @param network
- * @param usedSecondaryChannels
+ * @brief Callback when Network Creator is completed
+ *
+ * @param network Network parameters
+ * @param usedSecondaryChannels Flag indicating use of Secondary channels
  */
 void emberAfPluginNetworkCreatorCompleteCallback(const EmberNetworkParameters *network,
                                                  bool usedSecondaryChannels)
@@ -93,8 +95,7 @@ void emberAfTrustCenterJoinCallback(EmberNodeId newNodeId,
   emberAfCorePrintln("Child 0x%x%x has %s the channel", ((newNodeId >> 8) & 0xff),
                      (newNodeId & 0xff), ((status) != EMBER_DEVICE_LEFT) ? "joined" : "left");
   // JOINING ?
-  if(status != EMBER_DEVICE_LEFT)
-  {
+  if(status != EMBER_DEVICE_LEFT) {
       nodeTable[currentIndex] = newNodeId;
       emberAfCorePrintln("Current NodeID : 0x%x%x",(newNodeId >> 8) & 0xff,
                          (newNodeId & 0xff));
@@ -104,8 +105,9 @@ void emberAfTrustCenterJoinCallback(EmberNodeId newNodeId,
 }
 
 /**
- * CLI Function to form the network when : form
- * @param arguments
+ * @brief CLI Function to form the network when : form
+ *
+ * @param arguments CLI arguments when forming Network
  */
 void eventNetworkFormHandler(sl_cli_command_arg_t *arguments)
 {
@@ -117,20 +119,18 @@ void eventNetworkFormHandler(sl_cli_command_arg_t *arguments)
   // Network Creation
   state = emberAfNetworkState();
 
-  if (state != EMBER_JOINED_NETWORK)
-  {
-      status = emberAfPluginNetworkCreatorStart(true);
-      emberAfCorePrintln("%p network %p: 0x%X", "Form", "start", status);
-  }
-  else
-  {
-      emberAfCorePrintln("Network already created");
+  if (state != EMBER_JOINED_NETWORK) {
+    status = emberAfPluginNetworkCreatorStart(true);
+    emberAfCorePrintln("%p network %p: 0x%X", "Form", "start", status);
+  } else {
+    emberAfCorePrintln("Network already created");
   }
 }
 
 /**
- * CLI Function to open the network with Install code
- * @param arguments
+ * @brief CLI Function to open the network with Install code
+ *
+ * @param arguments CLI arguments after open
  */
 void networkOpenwithCodeHandler(sl_cli_command_arg_t *arguments)
 {
@@ -150,15 +150,12 @@ void networkOpenwithCodeHandler(sl_cli_command_arg_t *arguments)
 
   state = emberAfNetworkState();
   // Check if Network Created
-  if (state != EMBER_JOINED_NETWORK)
-  {
-      emberAfCorePrintln("Network not Joined, cannot open the network");
-  }
-  else
-  {
-      emberAfCorePrintln("Network UP, opening process launched");
-      emberAfCorePrintln("Derived key from Install-Code : ");
-      status = emberAfPluginNetworkCreatorSecurityOpenNetworkWithKeyPair(eui64, keyData);
-      emberAfCorePrintln("Network Open with Key : 0x%X", status);
+  if (state != EMBER_JOINED_NETWORK) {
+    emberAfCorePrintln("Network not Joined, cannot open the network");
+  } else {
+    emberAfCorePrintln("Network UP, opening process launched");
+    emberAfCorePrintln("Derived key from Install-Code : ");
+    status = emberAfPluginNetworkCreatorSecurityOpenNetworkWithKeyPair(eui64, keyData);
+    emberAfCorePrintln("Network Open with Key : 0x%X", status);
   }
 }

Joining_InstallCode/SimplicityStudio/JoinWithCode_Ro.sls

@@ -1,6 +1,6 @@
 /***************************************************************************//**
  * @file networkJoin.c
- * @brief File with Events and Function to create & open the network.
+ * @brief File with Events and Function to join the network.
  *******************************************************************************
  * # License
  * <b>Copyright 2021 Silicon Laboratories Inc. www.silabs.com</b>
@@ -36,48 +36,49 @@
 sl_zigbee_event_t eventRouterInfoCtrl;
 
 static const sl_cli_command_info_t myJoinCommand =
-       SL_CLI_COMMAND(myJoinHandler,
-                      "Function to join the network with install-code",
-                      "None",
-                      {SL_CLI_ARG_END});
+  SL_CLI_COMMAND(myJoinHandler,
+                 "Function to join the network with install-code",
+                 "None",
+                 {SL_CLI_ARG_END});
+
 const sl_cli_command_entry_t my_cli_commands[] = {
-    {"join", &myJoinCommand, false},
-    {NULL, NULL, false},
+  {"join", &myJoinCommand, false},
+  {NULL, NULL, false},
 };
 
 sl_cli_command_group_t my_cli_command_group = {
-    {NULL},
-    false,
-    my_cli_commands
+  {NULL},
+  false,
+  my_cli_commands
 };
+
 /***************************************************************************//**
  * Functions & events.
  ******************************************************************************/
 
 /**
- * CLI Handler to join a network with join command
- * @param arguments
+ * @brief CLI Handler to join a network with join command
+ *
+ * @param arguments CLI arguments after join
  */
-void myJoinHandler(sl_cli_argument_type_t *arguments)
+void myJoinHandler(sl_cli_command_arg_t *arguments)
 {
   // Launch the join process
   EmberStatus status;
   status = emberAfPluginNetworkSteeringStart();
 
   // Check the status of the network Steering
-  if (status == EMBER_SUCCESS)
-  {
-      emberAfCorePrintln("Start of Network Steering successful");
-  }
-  else
-  {
-      emberAfCorePrintln("ERROR to start Network Steering");
+  if (status == EMBER_SUCCESS) {
+    emberAfCorePrintln("Start of Network Steering successful");
+  } else {
+    emberAfCorePrintln("ERROR to start Network Steering");
   }
 }
 
 /**
- * Event to print info of the router
- * @param context
+ * @brief Event to print info of the router
+ *
+ * @param context Context of the event
  */
 void myEventRouterInfoHandler(sl_zigbee_event_context_t *context)
 {

Joining_InstallCode/SimplicityStudio/JoinWithCode_SED.sls

@@ -1,6 +1,6 @@
 /***************************************************************************//**
  * @file networkJoin.h
- * @brief File with Events and Function to create & open the network.
+ * @brief Header file
  *******************************************************************************
  * # License
  * <b>Copyright 2021 Silicon Laboratories Inc. www.silabs.com</b>
@@ -36,7 +36,7 @@
  * Function Prototypes
  ******************************************************************************/
 
-void myJoinHandler(sl_cli_argument_type_t *arguments);
+void myJoinHandler(sl_cli_command_arg_t *arguments);
 void myEventRouterInfoHandler(sl_zigbee_event_context_t *context);
 
 /***************************************************************************//**