update README (#1349)

This commit is contained in:
Buke Po
2017-02-19 23:11:18 -08:00
committed by Jonathan Hui
parent 1973a03865
commit 75486af85d
+69 -30
View File
@@ -7,17 +7,18 @@ OpenThread test scripts use the CLI to execute test cases.
## OpenThread Command List
* [channel](#channel)
* [blacklist](#blacklist)
* [child](#child)
* [channel](#channel)
* [child](#child-list)
* [childmax](#childmax)
* [childtimeout](#childtimeout)
* [commissioner](#commissioner)
* [commissioner](#commissioner-start-provisioningurl)
* [contextreusedelay](#contextreusedelay)
* [counter](#counter)
* [dataset](#dataset)
* [dataset](#dataset-help)
* [delaytimermin](#delaytimermin)
* [discover](#discover)
* [diagnostic](#diagnostic-get-addr-type-)
* [discover](#discover-channel)
* [eidcache](#eidcache)
* [eui64](#eui64)
* [extaddr](#extaddr)
@@ -27,11 +28,11 @@ OpenThread test scripts use the CLI to execute test cases.
* [ifconfig](#ifconfig)
* [ipaddr](#ipaddr)
* [ipmaddr](#ipmaddr)
* [joiner](#joiner)
* [keysequence](#keysequence)
* [joiner](#joiner-start-pskd-provisioningurl)
* [keysequence](#keysequence-counter)
* [leaderpartitionid](#leaderpartitionid)
* [leaderweight](#leaderweight)
* [linkquality](#linkquality)
* [linkquality](#linkquality-extaddr)
* [masterkey](#masterkey)
* [mode](#mode)
* [netdataregister](#netdataregister)
@@ -39,23 +40,23 @@ OpenThread test scripts use the CLI to execute test cases.
* [networkname](#networkname)
* [panid](#panid)
* [parent](#parent)
* [ping](#ping)
* [pollperiod](#pollperiod)
* [prefix](#prefix)
* [ping](#ping-ipaddr-size-count-interval)
* [pollperiod](#pollperiod-pollperiod)
* [prefix](#prefix-add-prefix-pvdcsr-prf)
* [promiscuous](#promiscuous)
* [releaserouterid](#releaserouterid)
* [releaserouterid](#releaserouterid-routerid)
* [reset](#reset)
* [rloc16](#rloc16)
* [route](#route)
* [router](#router)
* [route](#route-add-prefix-s-prf)
* [router](#router-list)
* [routerdowngradethreshold](#routerdowngradethreshold)
* [routerrole](#routerrole)
* [routerselectionjitter](#routerselectionjitter)
* [routerupgradethreshold](#routerupgradethreshold)
* [scan](#scan)
* [scan](#scan-channel)
* [singleton](#singleton)
* [state](#state)
* [thread](#thread)
* [thread](#thread-start)
* [version](#version)
* [whitelist](#whitelist)
* [diag](#diag)
@@ -685,6 +686,27 @@ Set the minimal delay timer (in seconds).
Done
```
### diagnostic get \<addr\> \<type\> ..
Send network diagnostic request to retrieve tlv of \<type\>s.
If \<addr\> is unicast address, `Diagnostic Get` will be sent.
if \<addr\> 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 \<addr\> \<type\> ..
Send network diagnostic request to reset \<addr\>'s tlv of \<type\>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.
@@ -776,6 +798,16 @@ e0b220eb7d8dda7e
Done
```
### ifconfig
Show the status of the IPv6 interface.
```bash
> ifconfig
down
Done
```
### ifconfig up
Bring up the IPv6 interface.
@@ -794,16 +826,6 @@ Bring down the IPv6 interface.
Done
```
### ifconfig
Show the status of the IPv6 interface.
```bash
> ifconfig
down
Done
```
### ipaddr
List all IPv6 addresses assigned to the Thread interface.
@@ -965,7 +987,7 @@ Get the Thread Leader Partition ID.
Done
```
### leaderpartitionid \<partitionid>\
### leaderpartitionid \<partitionid\>
Set the Thread Leader Partition ID.
@@ -993,7 +1015,7 @@ Set the Thread Leader Weight.
Done
```
### linkquality \<extaddr>\
### linkquality \<extaddr\>
Get the link quality on the link to a given extended address.
@@ -1003,7 +1025,7 @@ Get the link quality on the link to a given extended address.
Done
```
### linkquality \<extaddr>\ \<linkquality>\
### linkquality \<extaddr\> \<linkquality\>
Set the link quality on the link to a given extended address.
@@ -1156,7 +1178,7 @@ Get the customized data poll period of sleepy end device (seconds). Only for cer
Done
```
### pollperiod \<pollperiod>\
### pollperiod \<pollperiod\>
Set the customized data poll period for sleepy end device (seconds). Only for certification test
@@ -1431,6 +1453,23 @@ true or false
Done
```
### state
Return state of current state.
```bash
> state
offline, disabled, detached, child, router or leader
Done
```
### state <state>
Try to switch to state `detached`, `child`, `router` or `leader`.
```bash
> state leader
Done
```
### thread start
Enable Thread protocol operation and attach to a Thread network.