[OIS] Update the examples docs and maintenance improvements

Add setup Open IoT SDK network VScode task. Add networking setup details and default settings. Update the OIS example documentation and extend it with description of adding a new example. Update examples README files. Create the list of supported Matter examples and use it in helper script and VSCode tasks. Add specific examples of how to build/run/debug and any additional notes to be aware of. Update the OIS commissioning description - use the chip-tool as controller. Co-authored-by: ATmobica <[email protected]> Signed-off-by: Anna Bridge <[email protected]>
project-chip · May 19, 2023 · 892c89f · 892c89f
1 parent ba29c8b
commit 892c89f
Show file tree

Hide file tree

Showing 11 changed files with 883 additions and 442 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -430,16 +430,16 @@
             "name": "Debug Open IoT SDK example application",
             "type": "cortex-debug",
             "request": "launch",
-            "cwd": "${workspaceRoot}/examples/${input:openiotsdkApp}/openiotsdk",
-            "executable": "./build/chip-openiotsdk-${input:openiotsdkApp}-example.elf",
+            "cwd": "${workspaceRoot}/examples/${input:openiotsdkExample}/openiotsdk",
+            "executable": "./build/chip-openiotsdk-${input:openiotsdkExample}-example.elf",
             "armToolchainPath": "${env:PW_ENVIRONMENT_ROOT}/cipd/packages/arm/bin/",
             "servertype": "external",
             "gdbTarget": "${input:openiotsdkRemoteHost}:31627", //GDBserver port on FVP
             "overrideLaunchCommands": [
                 "-enable-pretty-printing",
                 "add-symbol-file ./build/bl2.elf 0x10000000",
                 "add-symbol-file ./build/tfm_s.elf 0x38000400",
-                "add-symbol-file ./build/chip-openiotsdk-${input:openiotsdkApp}-example_ns.elf 0x28060400",
+                "add-symbol-file ./build/chip-openiotsdk-${input:openiotsdkExample}-example_ns.elf 0x28060400",
                 "break main_ns.cpp:main"
             ],
             "runToEntryPoint": "main",
@@ -522,11 +522,13 @@
             "default": "CY8CPROTO_062_4343W"
         },
         {
-            "type": "pickString",
-            "id": "openiotsdkApp",
-            "description": "What Open IoT SDK example do you want to use?",
-            "options": ["shell", "lock-app"],
-            "default": "shell"
+            "type": "command",
+            "id": "openiotsdkExample",
+            "command": "shellCommand.execute",
+            "args": {
+                "command": "cat examples/platform/openiotsdk/supported_examples.txt",
+                "description": "What Open IoT SDK example application do you want to use?"
+            }
         },
         {
             "type": "promptString",

diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -243,6 +243,19 @@
                 "clear": true
             }
         },
+        {
+            "label": "Setup Open IoT SDK network",
+            "type": "shell",
+            "command": "sudo scripts/setup/openiotsdk/network_setup.sh -n${input:openiotsdkNetworkSetupName} ${input:openiotsdkNetworkSetupCmd}",
+            "problemMatcher": {
+                "pattern": {
+                    "regexp": "^(.*):(\\d+):(\\d+):\\s+(warning|error):\\s+(.*)$",
+                    "file": 1,
+                    "line": 2,
+                    "message": 5
+                }
+            }
+        },
         {
             "label": "Build Open IoT SDK example",
             "type": "shell",
@@ -453,6 +466,19 @@
             "options": ["simple", "boot", "upgrade"],
             "default": "simple"
         },
+        {
+            "type": "pickString",
+            "id": "openiotsdkNetworkSetupCmd",
+            "description": "Which command do you wish to use?",
+            "options": ["up", "down", "restart"],
+            "default": "up"
+        },
+        {
+            "type": "promptString",
+            "id": "openiotsdkNetworkSetupName",
+            "description": "Type the network namespace name that you want to use.",
+            "default": "ARM"
+        },
         {
             "type": "pickString",
             "id": "openiotsdkDebugMode",
@@ -468,11 +494,13 @@
             "default": "false"
         },
         {
-            "type": "pickString",
+            "type": "command",
             "id": "openiotsdkExample",
-            "description": "What Open IoT SDK example application do you want to use?",
-            "options": ["shell", "lock-app"],
-            "default": "shell"
+            "command": "shellCommand.execute",
+            "args": {
+                "command": "cat examples/platform/openiotsdk/supported_examples.txt",
+                "description": "What Open IoT SDK example application do you want to use?"
+            }
         },
         {
             "type": "command",

diff --git a/docs/examples/index.md b/docs/examples/index.md
@@ -134,15 +134,6 @@ log-source-app/**/README
 minimal-mdns/README
 ```
 
-## Open IoT SDK examples
-
-```{toctree}
-:glob:
-:maxdepth: 1
-
-openiotsdk_examples
-```
-
 ## OTA Provider example
 
 ```{toctree}