espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-08-24 19:29:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

[docs] CLI commands ifconfig - linkmetrics (#8253)

Browse Source
This commit is contained in:
Sarah
2022-10-12 14:34:45 -07:00
committed by GitHub
parent 06bd4d6161
commit 23c01d7eaf
6 changed files with 424 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/openthread/instance.h
+1 -1
View File
@@ -53,7 +53,7 @@ extern "C" {
* @note This number versions both OpenThread platform and user APIs.
*
*/
#define OPENTHREAD_API_VERSION (249)
#define OPENTHREAD_API_VERSION (250)
/**
* @addtogroup api-instance
include/openthread/ip6.h
+13 -13
View File
@@ -257,9 +257,9 @@ enum
};
/**
* This function brings up/down the IPv6 interface.
* Brings the IPv6 interface up or down.
*
* Call this function to enable/disable IPv6 communication.
* Call this to enable or disable IPv6 communication.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aEnabled TRUE to enable IPv6, FALSE otherwise.
@@ -272,7 +272,7 @@ enum
otError otIp6SetEnabled(otInstance *aInstance, bool aEnabled);
/**
* This function indicates whether or not the IPv6 interface is up.
* Indicates whether or not the IPv6 interface is up.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -283,10 +283,10 @@ otError otIp6SetEnabled(otInstance *aInstance, bool aEnabled);
bool otIp6IsEnabled(otInstance *aInstance);
/**
* Add a Network Interface Address to the Thread interface.
* Adds a Network Interface Address to the Thread interface.
*
* The passed-in instance @p aAddress is copied by the Thread interface. The Thread interface only
* supports a fixed number of externally added unicast addresses. See OPENTHREAD_CONFIG_IP6_MAX_EXT_UCAST_ADDRS.
* supports a fixed number of externally added unicast addresses. See `OPENTHREAD_CONFIG_IP6_MAX_EXT_UCAST_ADDRS`.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aAddress A pointer to a Network Interface Address.
@@ -298,7 +298,7 @@ bool otIp6IsEnabled(otInstance *aInstance);
otError otIp6AddUnicastAddress(otInstance *aInstance, const otNetifAddress *aAddress);
/**
* Remove a Network Interface Address from the Thread interface.
* Removes a Network Interface Address from the Thread interface.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aAddress A pointer to an IP Address.
@@ -310,7 +310,7 @@ otError otIp6AddUnicastAddress(otInstance *aInstance, const otNetifAddress *aAdd
otError otIp6RemoveUnicastAddress(otInstance *aInstance, const otIp6Address *aAddress);
/**
* Get the list of IPv6 addresses assigned to the Thread interface.
* Gets the list of IPv6 addresses assigned to the Thread interface.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -319,10 +319,10 @@ otError otIp6RemoveUnicastAddress(otInstance *aInstance, const otIp6Address *aAd
const otNetifAddress *otIp6GetUnicastAddresses(otInstance *aInstance);
/**
* Subscribe the Thread interface to a Network Interface Multicast Address.
* Subscribes the Thread interface to a Network Interface Multicast Address.
*
* The passed in instance @p aAddress will be copied by the Thread interface. The Thread interface only
* supports a fixed number of externally added multicast addresses. See OPENTHREAD_CONFIG_IP6_MAX_EXT_MCAST_ADDRS.
* supports a fixed number of externally added multicast addresses. See `OPENTHREAD_CONFIG_IP6_MAX_EXT_MCAST_ADDRS`.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aAddress A pointer to an IP Address.
@@ -338,7 +338,7 @@ const otNetifAddress *otIp6GetUnicastAddresses(otInstance *aInstance);
otError otIp6SubscribeMulticastAddress(otInstance *aInstance, const otIp6Address *aAddress);
/**
* Unsubscribe the Thread interface to a Network Interface Multicast Address.
* Unsubscribes the Thread interface to a Network Interface Multicast Address.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aAddress A pointer to an IP Address.
@@ -351,7 +351,7 @@ otError otIp6SubscribeMulticastAddress(otInstance *aInstance, const otIp6Address
otError otIp6UnsubscribeMulticastAddress(otInstance *aInstance, const otIp6Address *aAddress);
/**
* Get the list of IPv6 multicast addresses subscribed to the Thread interface.
* Gets the list of IPv6 multicast addresses subscribed to the Thread interface.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -361,7 +361,7 @@ otError otIp6UnsubscribeMulticastAddress(otInstance *aInstance, const otIp6Addre
const otNetifMulticastAddress *otIp6GetMulticastAddresses(otInstance *aInstance);
/**
* Check if multicast promiscuous mode is enabled on the Thread interface.
* Checks if multicast promiscuous mode is enabled on the Thread interface.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -371,7 +371,7 @@ const otNetifMulticastAddress *otIp6GetMulticastAddresses(otInstance *aInstance)
bool otIp6IsMulticastPromiscuousEnabled(otInstance *aInstance);
/**
* Enable multicast promiscuous mode on the Thread interface.
* Enables or disables multicast promiscuous mode on the Thread interface.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aEnabled TRUE to enable Multicast Promiscuous mode, FALSE otherwise.
include/openthread/link_metrics.h
+2 -2
View File
@@ -170,7 +170,7 @@ otError otLinkMetricsQuery(otInstance * aInstance,
void * aCallbackContext);
/**
* This function sends an MLE Link Metrics Management Request to configure/clear a Forward Tracking Series.
* Sends an MLE Link Metrics Management Request to configure or clear a Forward Tracking Series.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aDestination A pointer to the destination address.
@@ -228,7 +228,7 @@ otError otLinkMetricsConfigEnhAckProbing(otInstance *
void * aEnhAckCallbackContext);
/**
* This function sends an MLE Link Probe message.
* Sends an MLE Link Probe message.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aDestination A pointer to the destination address.
include/openthread/thread.h
+11 -11
View File
@@ -459,7 +459,7 @@ otError otThreadSetNetworkKey(otInstance *aInstance, const otNetworkKey *aKey);
otError otThreadSetNetworkKeyRef(otInstance *aInstance, otNetworkKeyRef aKeyRef);
/**
* This function returns a pointer to the Thread Routing Locator (RLOC) address.
* Gets the Thread Routing Locator (RLOC) address.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -469,7 +469,7 @@ otError otThreadSetNetworkKeyRef(otInstance *aInstance, otNetworkKeyRef aKeyRef)
const otIp6Address *otThreadGetRloc(otInstance *aInstance);
/**
* This function returns a pointer to the Mesh Local EID address.
* Gets the Mesh Local EID address.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -505,7 +505,7 @@ const otMeshLocalPrefix *otThreadGetMeshLocalPrefix(otInstance *aInstance);
otError otThreadSetMeshLocalPrefix(otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix);
/**
* This function returns the Thread link-local IPv6 address.
* Gets the Thread link-local IPv6 address.
*
* The Thread link local address is derived using IEEE802.15.4 Extended Address as Interface Identifier.
*
@@ -517,9 +517,9 @@ otError otThreadSetMeshLocalPrefix(otInstance *aInstance, const otMeshLocalPrefi
const otIp6Address *otThreadGetLinkLocalIp6Address(otInstance *aInstance);
/**
* This function returns the Thread Link-Local All Thread Nodes multicast address.
* Gets the Thread Link-Local All Thread Nodes multicast address.
*
* The address is a link-local Unicast Prefix-Based Multcast Address [RFC 3306], with:
* The address is a link-local Unicast Prefix-Based Multicast Address [RFC 3306], with:
* - flgs set to 3 (P = 1 and T = 1)
* - scop set to 2
* - plen set to 64
@@ -534,9 +534,9 @@ const otIp6Address *otThreadGetLinkLocalIp6Address(otInstance *aInstance);
const otIp6Address *otThreadGetLinkLocalAllThreadNodesMulticastAddress(otInstance *aInstance);
/**
* This function returns the Thread Realm-Local All Thread Nodes multicast address.
* Gets the Thread Realm-Local All Thread Nodes multicast address.
*
* The address is a realm-local Unicast Prefix-Based Multcast Address [RFC 3306], with:
* The address is a realm-local Unicast Prefix-Based Multicast Address [RFC 3306], with:
* - flgs set to 3 (P = 1 and T = 1)
* - scop set to 3
* - plen set to 64
@@ -656,7 +656,7 @@ otError otThreadSetFixedDuaInterfaceIdentifier(otInstance *aInstance, const otIp
const otIp6InterfaceIdentifier *otThreadGetFixedDuaInterfaceIdentifier(otInstance *aInstance);
/**
* Get the thrKeySequenceCounter.
* Gets the thrKeySequenceCounter.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -668,7 +668,7 @@ const otIp6InterfaceIdentifier *otThreadGetFixedDuaInterfaceIdentifier(otInstanc
uint32_t otThreadGetKeySequenceCounter(otInstance *aInstance);
/**
* Set the thrKeySequenceCounter.
* Sets the thrKeySequenceCounter.
*
* @note This API is reserved for testing and demo purposes only. Changing settings with
* this API will render a production application non-compliant with the Thread Specification.
@@ -682,7 +682,7 @@ uint32_t otThreadGetKeySequenceCounter(otInstance *aInstance);
void otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceCounter);
/**
* Get the thrKeySwitchGuardTime
* Gets the thrKeySwitchGuardTime (in hours).
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -694,7 +694,7 @@ void otThreadSetKeySequenceCounter(otInstance *aInstance, uint32_t aKeySequenceC
uint32_t otThreadGetKeySwitchGuardTime(otInstance *aInstance);
/**
* Set the thrKeySwitchGuardTime
* Sets the thrKeySwitchGuardTime (in hours).
*
* @note This API is reserved for testing and demo purposes only. Changing settings with
* this API will render a production application non-compliant with the Thread Specification.
include/openthread/thread_ftd.h
+4 -4
View File
@@ -196,7 +196,7 @@ otError otThreadSetRouterEligible(otInstance *aInstance, bool aEligible);
otError otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId);
/**
* Get the Thread Leader Weight used when operating in the Leader role.
* Gets the Thread Leader Weight used when operating in the Leader role.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -208,7 +208,7 @@ otError otThreadSetPreferredRouterId(otInstance *aInstance, uint8_t aRouterId);
uint8_t otThreadGetLocalLeaderWeight(otInstance *aInstance);
/**
* Set the Thread Leader Weight used when operating in the Leader role.
* Sets the Thread Leader Weight used when operating in the Leader role.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aWeight The Thread Leader Weight value.
@@ -238,7 +238,7 @@ uint32_t otThreadGetPreferredLeaderPartitionId(otInstance *aInstance);
void otThreadSetPreferredLeaderPartitionId(otInstance *aInstance, uint32_t aPartitionId);
/**
* Get the Joiner UDP Port.
* Gets the Joiner UDP Port.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -250,7 +250,7 @@ void otThreadSetPreferredLeaderPartitionId(otInstance *aInstance, uint32_t aPart
uint16_t otThreadGetJoinerUdpPort(otInstance *aInstance);
/**
* Set the Joiner UDP Port.
* Sets the Joiner UDP Port.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aJoinerUdpPort The Joiner UDP Port number.