espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-07-26 22:09:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

[docs] change thrNetworkKey for docs (#6810)

Browse Source
This commit is contained in:
gavinmcgovern
2021-07-12 14:48:02 -07:00
committed by GitHub
parent f86ceb43ce
commit 75df7a26fb
2 changed files with 6 additions and 6 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 (135)
#define OPENTHREAD_API_VERSION (136)
/**
* @addtogroup api-instance
include/openthread/thread.h
+5 -5
View File
@@ -378,11 +378,11 @@ otLinkModeConfig otThreadGetLinkMode(otInstance *aInstance);
otError otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig);
/**
* Get the thrNetworkKey.
* Get the Thread Network Key.
*
* @param[in] aInstance A pointer to an OpenThread instance.
*
* @returns A pointer to a buffer containing the thrNetworkKey.
* @returns A pointer to a buffer containing the Thread Network Key.
*
* @sa otThreadSetNetworkKey
*
@@ -390,16 +390,16 @@ otError otThreadSetLinkMode(otInstance *aInstance, otLinkModeConfig aConfig);
const otNetworkKey *otThreadGetNetworkKey(otInstance *aInstance);
/**
* Set the thrNetworkKey.
* Set the Thread Network Key.
*
* This function succeeds only when Thread protocols are disabled. A successful
* call to this function invalidates the Active and Pending Operational Datasets in
* non-volatile memory.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aKey A pointer to a buffer containing the thrNetworkKey.
* @param[in] aKey A pointer to a buffer containing the Thread Network Key.
*
* @retval OT_ERROR_NONE Successfully set the thrNetworkKey.
* @retval OT_ERROR_NONE Successfully set the Thread Network Key.
* @retval OT_ERROR_INVALID_ARGS If aKeyLength is larger than 16.
* @retval OT_ERROR_INVALID_STATE Thread protocols are enabled.
*