espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-10-18 05:28:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

[docs] CLI channel (#7957)

Browse Source
This commit is contained in:
Sarah
2022-08-02 12:54:10 -07:00
committed by GitHub
parent c096c0e9ca
commit 9a104a814c
7 changed files with 425 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/openthread/channel_manager.h
+14 -14
View File
@@ -55,12 +55,12 @@ extern "C" {
*/
/**
* This function requests a Thread network channel change.
* Requests a Thread network channel change.
*
* The network switches to the given channel after a specified delay (see otChannelManagerSetDelay()). The channel
* The network switches to the given channel after a specified delay (see #otChannelManagerSetDelay()). The channel
* change is performed by updating the Pending Operational Dataset.
*
* A subsequent call to this function will cancel an ongoing previously requested channel change.
* A subsequent call will cancel an ongoing previously requested channel change.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aChannel The new channel for the Thread network.
@@ -87,9 +87,9 @@ uint8_t otChannelManagerGetRequestedChannel(otInstance *aInstance);
uint16_t otChannelManagerGetDelay(otInstance *aInstance);
/**
* This function sets the delay (in seconds) used for a channel change.
* Sets the delay (in seconds) used for a channel change.
*
* The delay should preferably be longer than maximum data poll interval used by all sleepy-end-devices within the
* The delay should preferably be longer than the maximum data poll interval used by all sleepy-end-devices within the
* Thread network.
*
* @param[in] aInstance A pointer to an OpenThread instance.
@@ -105,7 +105,7 @@ otError otChannelManagerSetDelay(otInstance *aInstance, uint16_t aDelay);
* This function requests that `ChannelManager` checks and selects a new channel and starts a channel change.
*
* Unlike the `otChannelManagerRequestChannelChange()` where the channel must be given as a parameter, this function
* asks the `ChannelManager` to select a channel by itself (based of collected channel quality info).
* asks the `ChannelManager` to select a channel by itself (based on collected channel quality info).
*
* Once called, the Channel Manager will perform the following 3 steps:
*
@@ -132,7 +132,7 @@ otError otChannelManagerSetDelay(otInstance *aInstance, uint16_t aDelay);
otError otChannelManagerRequestChannelSelect(otInstance *aInstance, bool aSkipQualityCheck);
/**
* This function enables/disables the auto-channel-selection functionality.
* Enables or disables the auto-channel-selection functionality.
*
* When enabled, `ChannelManager` will periodically invoke a `RequestChannelSelect(false)`. The period interval
* can be set by `SetAutoChannelSelectionInterval()`.
@@ -154,7 +154,7 @@ void otChannelManagerSetAutoChannelSelectionEnabled(otInstance *aInstance, bool
bool otChannelManagerGetAutoChannelSelectionEnabled(otInstance *aInstance);
/**
* This function sets the period interval (in seconds) used by auto-channel-selection functionality.
* Sets the period interval (in seconds) used by auto-channel-selection functionality.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aInterval The interval in seconds.
@@ -176,7 +176,7 @@ otError otChannelManagerSetAutoChannelSelectionInterval(otInstance *aInstance, u
uint32_t otChannelManagerGetAutoChannelSelectionInterval(otInstance *aInstance);
/**
* This function gets the supported channel mask.
* Gets the supported channel mask.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -186,7 +186,7 @@ uint32_t otChannelManagerGetAutoChannelSelectionInterval(otInstance *aInstance);
uint32_t otChannelManagerGetSupportedChannels(otInstance *aInstance);
/**
* This function sets the supported channel mask.
* Sets the supported channel mask.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aChannelMask A channel mask.
@@ -195,7 +195,7 @@ uint32_t otChannelManagerGetSupportedChannels(otInstance *aInstance);
void otChannelManagerSetSupportedChannels(otInstance *aInstance, uint32_t aChannelMask);
/**
* This function gets the favored channel mask.
* Gets the favored channel mask.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -205,7 +205,7 @@ void otChannelManagerSetSupportedChannels(otInstance *aInstance, uint32_t aChann
uint32_t otChannelManagerGetFavoredChannels(otInstance *aInstance);
/**
* This function sets the favored channel mask.
* Sets the favored channel mask.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aChannelMask A channel mask.
@@ -214,7 +214,7 @@ uint32_t otChannelManagerGetFavoredChannels(otInstance *aInstance);
void otChannelManagerSetFavoredChannels(otInstance *aInstance, uint32_t aChannelMask);
/**
* This function gets the CCA failure rate threshold
* Gets the CCA failure rate threshold.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -224,7 +224,7 @@ void otChannelManagerSetFavoredChannels(otInstance *aInstance, uint32_t aChannel
uint16_t otChannelManagerGetCcaFailureRateThreshold(otInstance *aInstance);
/**
* This function sets the CCA failure rate threshold
* Sets the CCA failure rate threshold.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aThreshold A CCA failure rate threshold. Value 0 maps to 0% and 0xffff maps to 100%.
include/openthread/channel_monitor.h
+3 -3
View File
@@ -64,13 +64,13 @@ extern "C" {
*/
/**
* This function enables/disables the Channel Monitoring operation.
* Enables or disables the Channel Monitoring operation.
*
* Once operation starts, any previously collected data is cleared. However, after operation is disabled, the previous
* collected data is still valid and can be read.
*
* @note OpenThread core internally enables/disables the Channel Monitoring operation when the IPv6 interface is
* brought up/down (i.e., call to `otIp6SetEnabled()`).
* @note OpenThread core internally enables or disables the Channel Monitoring operation when the IPv6 interface is
* brought up or down, for example in a call to `otIp6SetEnabled()`.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aEnabled TRUE to enable/start Channel Monitoring operation, FALSE to disable/stop it.
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 (230)
#define OPENTHREAD_API_VERSION (231)
/**
* @addtogroup api-instance
include/openthread/link.h
+4 -4
View File
@@ -965,7 +965,7 @@ void otLinkResetTxRetrySuccessHistogram(otInstance *aInstance);
const otMacCounters *otLinkGetCounters(otInstance *aInstance);
/**
* Reset the MAC layer counters.
* Resets the MAC layer counters.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -1034,7 +1034,7 @@ otError otLinkSetPromiscuous(otInstance *aInstance, bool aPromiscuous);
uint8_t otLinkCslGetChannel(otInstance *aInstance);
/**
* This function sets the CSL channel.
* Sets the CSL channel.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aChannel The CSL sample channel. Channel value should be `0` (Set CSL Channel unspecified) or
@@ -1057,7 +1057,7 @@ otError otLinkCslSetChannel(otInstance *aInstance, uint8_t aChannel);
uint16_t otLinkCslGetPeriod(otInstance *aInstance);
/**
* This function sets the CSL period.
* Sets the CSL period in units of 10 symbols. Disable CSL by setting this parameter to `0`.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aPeriod The CSL period in units of 10 symbols.
@@ -1079,7 +1079,7 @@ otError otLinkCslSetPeriod(otInstance *aInstance, uint16_t aPeriod);
uint32_t otLinkCslGetTimeout(otInstance *aInstance);
/**
* This function sets the CSL timeout.
* Sets the CSL timeout in seconds.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aTimeout The CSL timeout in seconds.
include/openthread/platform/radio.h
+1 -1
View File
@@ -969,7 +969,7 @@ void otPlatRadioClearSrcMatchExtEntries(otInstance *aInstance);
uint32_t otPlatRadioGetSupportedChannelMask(otInstance *aInstance);
/**
* Get the radio preferred channel mask that the device prefers to form on.
* Gets the radio preferred channel mask that the device prefers to form on.
*
* @param[in] aInstance The OpenThread instance structure.
*
include/openthread/thread.h
+4 -4
View File
@@ -845,7 +845,7 @@ otError otThreadGetParentAverageRssi(otInstance *aInstance, int8_t *aParentRssi)
otError otThreadGetParentLastRssi(otInstance *aInstance, int8_t *aLastRssi);
/**
* Get the IPv6 counters.
* Gets the IPv6 counters.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -855,7 +855,7 @@ otError otThreadGetParentLastRssi(otInstance *aInstance, int8_t *aLastRssi);
const otIpCounters *otThreadGetIp6Counters(otInstance *aInstance);
/**
* Reset the IPv6 counters.
* Resets the IPv6 counters.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -863,7 +863,7 @@ const otIpCounters *otThreadGetIp6Counters(otInstance *aInstance);
void otThreadResetIp6Counters(otInstance *aInstance);
/**
* Get the Thread MLE counters.
* Gets the Thread MLE counters.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
@@ -873,7 +873,7 @@ void otThreadResetIp6Counters(otInstance *aInstance);
const otMleCounters *otThreadGetMleCounters(otInstance *aInstance);
/**
* Reset the Thread MLE counters.
* Resets the Thread MLE counters.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*