From eef67307735863ecf05627efb3fa5d2f20f51a08 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Duda?= Date: Wed, 1 Mar 2017 19:08:10 +0100 Subject: [PATCH] Small fixes in CLI Readme.md (#1404) --- src/cli/README.md | 220 +++++++++++++++++++--------------------- src/cli/cli_dataset.cpp | 3 +- 2 files changed, 103 insertions(+), 120 deletions(-) diff --git a/src/cli/README.md b/src/cli/README.md index 028decd04..b04d074ed 100644 --- a/src/cli/README.md +++ b/src/cli/README.md @@ -9,6 +9,7 @@ OpenThread test scripts use the CLI to execute test cases. * [autostart](#autostart) * [blacklist](#blacklist) +* [bufferinfo](#bufferinfo) * [channel](#channel) * [child](#child-list) * [childmax](#childmax) @@ -18,7 +19,6 @@ OpenThread test scripts use the CLI to execute test cases. * [counter](#counter) * [dataset](#dataset-help) * [delaytimermin](#delaytimermin) -* [diagnostic](#diagnostic-get-addr-type-) * [discover](#discover-channel) * [eidcache](#eidcache) * [eui64](#eui64) @@ -30,13 +30,16 @@ OpenThread test scripts use the CLI to execute test cases. * [ipaddr](#ipaddr) * [ipmaddr](#ipmaddr) * [joiner](#joiner-start-pskd-provisioningurl) +* [joinerport](#joinerport-port) * [keysequence](#keysequence-counter) +* [leaderdata](#leaderdata) * [leaderpartitionid](#leaderpartitionid) * [leaderweight](#leaderweight) * [linkquality](#linkquality-extaddr) * [masterkey](#masterkey) * [mode](#mode) * [netdataregister](#netdataregister) +* [networkdiagnostic](#networkdiagnostic-get-addr-type-) * [networkidtimeout](#networkidtimeout) * [networkname](#networkname) * [panid](#panid) @@ -149,6 +152,24 @@ Remove an IEEE 802.15.4 Extended Address from the blacklist. Done ``` +### bufferinfo + +Show the current message buffer information. + +```bash +> bufferinfo +total: 40 +free: 40 +6lo send: 0 0 +6lo reas: 0 0 +ip6: 0 0 +mpl: 0 0 +mle: 0 0 +arp: 0 0 +coap: 0 0 +Done +``` + ### channel Get the IEEE 802.15.4 Channel value. @@ -426,6 +447,7 @@ help active activetimestamp channel +channelmask clear commit delay @@ -439,8 +461,9 @@ panid pending pendingtimestamp pskc -userdata +securitypolicy Done +> ``` ### dataset active @@ -453,16 +476,7 @@ Active Timestamp: 0 Done ``` -### dataset activetimestamp - -Set getting active timestamp flag. - -```bash -> dataset activestamp -Done -``` - -### dataset activetimestamp \[activetimestamp\] +### dataset activetimestamp \ Set active timestamp. @@ -471,16 +485,7 @@ Set active timestamp. Done ``` -### dataset channel - -Set getting channel flag. - -```bash -> dataset channel -Done -``` - -### dataset channel \[channel\] +### dataset channel \ Set channel. @@ -489,6 +494,15 @@ Set channel. Done ``` +### dataset channelmask \ + +Set channel mask. + +```bash +> dataset channelmask e0ff1f00 +Done +``` + ### dataset clear Reset operational dataset buffer. @@ -498,7 +512,7 @@ Reset operational dataset buffer. Done ``` -### dataset commit \[commit\] +### dataset commit \ Commit operational dataset buffer to active/pending operational dataset. @@ -507,16 +521,7 @@ Commit operational dataset buffer to active/pending operational dataset. Done ``` -### dataset delay - -Set getting delay timer value flag. - -```bash -> dataset delay -Done -``` - -### dataset delay \[delay\] +### dataset delay \ Set delay timer value. @@ -525,16 +530,7 @@ Set delay timer value. Done ``` -### dataset extpanid - -Set getting extended panid flag. - -```bash -> dataset extpanid -Done -``` - -### dataset extpanid \[extpanid\] +### dataset extpanid \ Set extended panid. @@ -543,16 +539,7 @@ Set extended panid. Done ``` -### dataset masterkey - -Set getting master key flag. - -```bash -> dataset masterkey -Done -``` - -### dataset masterkey \[masterkey\] +### dataset masterkey \ Set master key. @@ -561,16 +548,7 @@ Set master key. Done ``` -### dataset meshlocalprefix - -Set getting mesh local prefix flag. - -```bash -> dataset meshlocalprefix -Done -``` - -### dataset meshlocalprefix fd00:db8:: +### dataset meshlocalprefix \ Set mesh local prefix. @@ -615,16 +593,7 @@ Send MGMT_PENDING_SET. Done ``` -### dataset networkname - -Set getting network name flag. - -```bash -> dataset networkname -Done -``` - -### dataset networkname \[networkname\] +### dataset networkname \ Set network name. @@ -633,16 +602,7 @@ Set network name. Done ``` -### dataset panid - -Set getting panid flag. - -```bash -> dataset panid -Done -``` - -### dataset panid \[panid\] +### dataset panid \ Set panid. @@ -660,16 +620,7 @@ Print meshcop pending operational dataset. Done ``` -### dataset pendingtimestamp - -Set getting pending timestamp flag. - -```bash -> dataset pendingtimestamp -Done -``` - -### dataset pendingtimestamp \[pendingtimestamp\] +### dataset pendingtimestamp \ Set pending timestamp. @@ -678,7 +629,7 @@ Set pending timestamp. Done ``` -### dataset pskc \[pskc\] +### dataset pskc \ Set pskc with hex format. @@ -687,12 +638,18 @@ Set pskc with hex format. Done ``` -### dataset userdata \[size\] \[data\] +### dataset securitypolicy \ \[onrcb\] -Set user specific data for the command. +Set security policy. + +* o: Obtaining the Master Key for out-of-band commissioning is enabled. +* n: Native Commissioning using PSKc is allowed. +* r: Thread 1.x Routers are enabled. +* c: External Commissioner authentication is allowed using PSKc. +* b: Thread 1.x Beacons are enabled. ```bash -> dataset userdata 3 820155 +> dataset securitypolicy 672 onrcb Done ``` @@ -715,27 +672,6 @@ Set the minimal delay timer (in seconds). Done ``` -### diagnostic get \ \ .. - -Send network diagnostic request to retrieve tlv of \s. - -If \ is unicast address, `Diagnostic Get` will be sent. -if \ is multicast address, `Diagnostic Query` will be sent. - -```bash -> diagnostic get fd00:db8::ff:fe00:0 1 2 -> diagnostic get ff02::1 1 -``` - -### diagnostic reset \ \ .. - -Send network diagnostic request to reset \'s tlv of \s. Currently only `MAC Counters`(9) is supported. - -```bash -> diagnostic reset fd00:db8::ff:fe00:0 9 -Done -``` - ### discover \[channel\] Perform an MLE Discovery operation. @@ -967,6 +903,15 @@ Stop the Joiner role. Done ``` +### joinerport \ + +Set the Joiner port. + +```bash +> joinerport 1000 +Done +``` + ### keysequence counter Get the Thread Key Sequence Counter. @@ -1025,6 +970,20 @@ Set the Thread Leader Partition ID. Done ``` +### leaderdata + +Show the Thread Leader Data. + +```bash +> leaderdata +Partition ID: 1077744240 +Weighting: 64 +Data Version: 109 +Stable Data Version: 211 +Leader Router ID: 60 +Done +``` + ### leaderweight Get the Thread Leader Weight. @@ -1120,6 +1079,31 @@ Register local network data with Thread Leader. Done ``` +### networkdiagnostic get \ \ .. + +Send network diagnostic request to retrieve tlv of \s. + +If \ is unicast address, `Diagnostic Get` will be sent. +if \ is multicast address, `Diagnostic Query` will be sent. + +```bash +> networkdiagnostic get fdde:ad00:beef:0:0:ff:fe00:f400 0 1 6 +DIAG_GET.rsp: 00088e18ad17a24b0b740102f400060841dcb82d40bac63d + +> networkdiagnostic get ff02::1 0 1 +DIAG_GET.rsp: 0008567e31a79667a8cc0102f000 +DIAG_GET.rsp: 0008aaa7e584759e4e6401025400 +``` + +### networkdiagnostic reset \ \ .. + +Send network diagnostic request to reset \'s tlv of \s. Currently only `MAC Counters`(9) is supported. + +```bash +> diagnostic reset fd00:db8::ff:fe00:0 9 +Done +``` + ### networkidtimeout Get the NETWORK_ID_TIMEOUT parameter used in the Router role. diff --git a/src/cli/cli_dataset.cpp b/src/cli/cli_dataset.cpp index 8124d0b47..75c359551 100644 --- a/src/cli/cli_dataset.cpp +++ b/src/cli/cli_dataset.cpp @@ -239,8 +239,7 @@ ThreadError Dataset::ProcessActiveTimestamp(otInstance *aInstance, int argc, cha ThreadError error = kThreadError_None; long value; - VerifyOrExit(argc > 0, ;); - + VerifyOrExit(argc > 0, error = kThreadError_Parse); SuccessOrExit(error = Interpreter::ParseLong(argv[0], value)); sDataset.mActiveTimestamp = static_cast(value); sDataset.mIsActiveTimestampSet = true;