From ce6950c1d4be0c8e7f2be085b8febcc5af9deedd Mon Sep 17 00:00:00 2001 From: Bill A Date: Thu, 30 Dec 2021 07:36:05 +0900 Subject: [PATCH 1/2] Add update nrf cli doc to reflect latest command --- docs/guides/nrfconnect_examples_cli.md | 26 ++++++++++++++++++-------- 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/docs/guides/nrfconnect_examples_cli.md b/docs/guides/nrfconnect_examples_cli.md index 5ac2589113d678..adee45dace0a1b 100644 --- a/docs/guides/nrfconnect_examples_cli.md +++ b/docs/guides/nrfconnect_examples_cli.md @@ -103,24 +103,34 @@ Performs device factory reset that is hardware reset preceded by erasing of the whole Matter settings stored in a non-volatile memory. ```shell -uart:~$ matter factoryreset +uart:~$ matter device factoryreset Performing factory reset ... ``` ### onboardingcodes Handles a group of commands that are used to view information about device -onboarding codes. You can use this command without any subcommand to print all -available onboarding codes or to add a specific subcommand. +onboarding codes. The `onboardingcodes` command takes one required parameter for +the rendezvous type, then an optional parameter for printing a specific type +of onboarding code. + +The full format of the command is: + +``` +onboardingcodes none|softap|ble|onnetwork [qrcode|qrcodeurl|manualpairingcode] +``` + +To print all the onboardingcodes: + ```shell -uart:~$ matter onboardingcodes +uart:~$ matter onboardingcodes none QRCode: MT:W0GU2OTB00KA0648G00 QRCodeUrl: https://dhrishi.github.io/connectedhomeip/qrcode.html?data=MT%3AW0GU2OTB00KA0648G00 ManualPairingCode: 34970112332 ``` -The `onboardingcodes` command can also take the subcommands listed below. +To print a specific type of onboarding code: #### qrcode @@ -129,7 +139,7 @@ Prints the device Takes no arguments. ```shell -uart:~$ matter onboardingcodes qrcode +uart:~$ matter onboardingcodes none qrcode MT:W0GU2OTB00KA0648G00 ``` @@ -140,7 +150,7 @@ Prints the URL to view the in a web browser. Takes no arguments. ```shell -uart:~$ matter onboardingcodes qrcodeurl +uart:~$ matter onboardingcodes none qrcodeurl https://dhrishi.github.io/connectedhomeip/qrcode.html?data=MT%3AW0GU2OTB00KA0648G00 ``` @@ -150,7 +160,7 @@ Prints the pairing code for the manual onboarding of a device. Takes no arguments. ```shell -uart:~$ matter onboardingcodes manualpairingcode +uart:~$ matter onboardingcodes none manualpairingcode 34970112332 ``` From 363852d0e59a49665997e00371bbf4093acb93b8 Mon Sep 17 00:00:00 2001 From: "Restyled.io" Date: Wed, 29 Dec 2021 22:42:56 +0000 Subject: [PATCH 2/2] Restyled by prettier-markdown --- docs/guides/nrfconnect_examples_cli.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/guides/nrfconnect_examples_cli.md b/docs/guides/nrfconnect_examples_cli.md index adee45dace0a1b..b6104289e844cc 100644 --- a/docs/guides/nrfconnect_examples_cli.md +++ b/docs/guides/nrfconnect_examples_cli.md @@ -111,8 +111,8 @@ Performing factory reset ... Handles a group of commands that are used to view information about device onboarding codes. The `onboardingcodes` command takes one required parameter for -the rendezvous type, then an optional parameter for printing a specific type -of onboarding code. +the rendezvous type, then an optional parameter for printing a specific type of +onboarding code. The full format of the command is: @@ -122,7 +122,6 @@ onboardingcodes none|softap|ble|onnetwork [qrcode|qrcodeurl|manualpairingcode] To print all the onboardingcodes: - ```shell uart:~$ matter onboardingcodes none QRCode: MT:W0GU2OTB00KA0648G00