espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-09-21 08:27:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

[spinel] update docs - property formats (#2349)

Browse Source 
This commit updates the docs in spinel header file to provide
info about format (struct fields) of some properties.
This commit is contained in:
Abtin Keshavarzian
2017-11-17 10:11:03 +00:00
committed by Jonathan Hui
parent a89eb88748
commit 134071d814
2 changed files with 86 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/spinel-protocol-src/spinel-tech-thread.md
+18 -6
View File
@@ -39,10 +39,21 @@ The long address and short address of the parent of this node.
### PROP 82: PROP_THREAD_CHILD_TABLE
* Type: Read-Only
* Packed-Encoding: `A(t(ES))`
* Packed-Encoding: `A(t(ESLLCCcCc)`
Table containing the long and short addresses of all
the children of this node.
Table containing info about all the children of this node.
Data per item is:
* `E`: Extended/long address
* `S`: RLOC16
* `L`: Timeout (in seconds)
* `L`: Age (in seconds)
* `L`: Network Data version
* `C`: Link Quality In
* `c`: Average RSS (in dBm)
* `C`: Mode (bit-flags)
* `c`: Last RSSI (in dBm)
### PROP 83: PROP_THREAD_LEADER_RID
* Type: Read-Only
@@ -84,7 +95,7 @@ The local stable network data.
### PROP 90: PROP_THREAD_ON_MESH_NETS
* Type: Read-Write
* Packed-Encoding: `A(t(6CbCb))`
* Packed-Encoding: `A(t(6CbCbS))`
Data per item is:
@@ -212,7 +223,7 @@ disabled.
### PROP 5387: PROP_THREAD_NEIGHBOR_TABLE
* Type: Read-Only
* Packed-Encoding: `A(t(ESLCcCbLL))`
* Packed-Encoding: `A(t(ESLCcCbLLc))`
Data per item is:
@@ -220,11 +231,12 @@ Data per item is:
* `S`: RLOC16
* `L`: Age
* `C`: Link Quality In
* `c`: Average RSS
* `c`: Average RSS (in dBm)
* `C`: Mode (bit-flags)
* `b`: `true` if neighbor is a child, `false` otherwise.
* `L`: Link Frame Counter
* `L`: MLE Frame Counter
* `c`: The last RSSI (in dBm)
### PROP 5388: PROP_THREAD_CHILD_COUNT_MAX
* Type: Read-Write
src/ncp/spinel.h
+68 -5
View File
@@ -795,7 +795,24 @@ typedef enum
SPINEL_PROP_THREAD__BEGIN = 0x50,
SPINEL_PROP_THREAD_LEADER_ADDR = SPINEL_PROP_THREAD__BEGIN + 0, ///< [6]
SPINEL_PROP_THREAD_PARENT = SPINEL_PROP_THREAD__BEGIN + 1, ///< LADDR, SADDR [ES]
SPINEL_PROP_THREAD_CHILD_TABLE = SPINEL_PROP_THREAD__BEGIN + 2, ///< array(EUI64,rloc16,timeout,age,netDataVer,inLqi,aveRSS,mode) [A(t(ESLLCCcC))]
/// Thread Child Table
/** Format: [A(t(ESLLCCcCc)] - Read only
*
* Data per item is:
*
* `E`: Extended/long address
* `S`: RLOC16
* `L`: Timeout (in seconds)
* `L`: Age (in seconds)
* `L`: Network Data version
* `C`: Link Quality In
* `c`: Average RSS (in dBm)
* `C`: Mode (bit-flags)
* `c`: Last RSSI (in dBm)
*
*/
SPINEL_PROP_THREAD_CHILD_TABLE = SPINEL_PROP_THREAD__BEGIN + 2,
SPINEL_PROP_THREAD_LEADER_RID = SPINEL_PROP_THREAD__BEGIN + 3, ///< [C]
SPINEL_PROP_THREAD_LEADER_WEIGHT = SPINEL_PROP_THREAD__BEGIN + 4, ///< [C]
SPINEL_PROP_THREAD_LOCAL_LEADER_WEIGHT
@@ -807,7 +824,24 @@ typedef enum
= SPINEL_PROP_THREAD__BEGIN + 8, ///< [D]
SPINEL_PROP_THREAD_STABLE_NETWORK_DATA_VERSION
= SPINEL_PROP_THREAD__BEGIN + 9, ///< [S]
SPINEL_PROP_THREAD_ON_MESH_NETS = SPINEL_PROP_THREAD__BEGIN + 10, ///< array(ipv6prefix,prefixlen,stable,flags,isLocal,rloc6) [A(t(6CbCbS))]
/// On-Mesh Prefixes
/** Format: `A(t(6CbCbS))`
*
* Data per item is:
*
* `6`: IPv6 Prefix
* `C`: Prefix length in bits
* `b`: Stable flag
* `C`: TLV flags
* `b`: "Is defined locally" flag. Set if this network was locally
* defined. Assumed to be true for set, insert and replace. Clear if
* the on mesh network was defined by another node.
* `S`: The RLOC16 of the device that registered this on-mesh prefix entry.
* This value is not used and ignored when adding an on-mesh prefix.
*
*/
SPINEL_PROP_THREAD_ON_MESH_NETS = SPINEL_PROP_THREAD__BEGIN + 10,
/// Off-mesh routes
/** Format: [A(t(6CbCbb))]
@@ -920,8 +954,21 @@ typedef enum
= SPINEL_PROP_THREAD_EXT__BEGIN + 10,
/// Thread Neighbor Table
/** Format: `A(t(ESLCcCbLL))`
* eui64, rloc16, age, inLqi ,aveRSS, mode, isChild. linkFrameCounter, mleCounter
/** Format: `A(t(ESLCcCbLLc))` - Read only
*
* Data per item is:
*
* `E`: Extended/long address
* `S`: RLOC16
* `L`: Age (in seconds)
* `C`: Link Quality In
* `c`: Average RSS (in dBm)
* `C`: Mode (bit-flags)
* `b`: `true` if neighbor is a child, `false` otherwise.
* `L`: Link Frame Counter
* `L`: MLE Frame Counter
* `c`: The last RSSI (in dBm)
*
*/
SPINEL_PROP_THREAD_NEIGHBOR_TABLE = SPINEL_PROP_THREAD_EXT__BEGIN + 11,
@@ -1182,7 +1229,23 @@ typedef enum
SPINEL_PROP_IPV6_LL_ADDR = SPINEL_PROP_IPV6__BEGIN + 0, ///< [6]
SPINEL_PROP_IPV6_ML_ADDR = SPINEL_PROP_IPV6__BEGIN + 1, ///< [6C]
SPINEL_PROP_IPV6_ML_PREFIX = SPINEL_PROP_IPV6__BEGIN + 2, ///< [6C]
SPINEL_PROP_IPV6_ADDRESS_TABLE = SPINEL_PROP_IPV6__BEGIN + 3, ///< array(ipv6addr,prefixlen,valid,preferred,flags) [A(t(6CLLC))]
/// IPv6 Address Table
/** Format: `A(t(6CLLC))`
*
* This property provides all unicast addresses.
*
* Array of structures containing:
*
* `6`: IPv6 Address
* `C`: Network Prefix Length
* `L`: Valid Lifetime
* `L`: Preferred Lifetime
* `C`: Flags
*
*/
SPINEL_PROP_IPV6_ADDRESS_TABLE = SPINEL_PROP_IPV6__BEGIN + 3,
SPINEL_PROP_IPV6_ROUTE_TABLE = SPINEL_PROP_IPV6__BEGIN + 4, ///< array(ipv6prefix,prefixlen,iface,flags) [A(t(6CCC))]
/// IPv6 ICMP Ping Offload