diff --git a/include/openthread/dataset_ftd.h b/include/openthread/dataset_ftd.h index de6251f95..15d0fa940 100644 --- a/include/openthread/dataset_ftd.h +++ b/include/openthread/dataset_ftd.h @@ -160,6 +160,9 @@ OTAPI uint32_t OTCALL otDatasetGetDelayTimerMinimal(otInstance *aInstance); /** * Set minimal delay timer. * + * @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. + * * @param[in] aInstance A pointer to an OpenThread instance. * @param[in] aDelayTimerMinimal The value of minimal delay timer (in ms). * diff --git a/include/openthread/thread.h b/include/openthread/thread.h index 47fe24f02..bea394d1b 100644 --- a/include/openthread/thread.h +++ b/include/openthread/thread.h @@ -485,6 +485,9 @@ OTAPI uint32_t OTCALL otThreadGetKeySequenceCounter(otInstance *aInstance); /** * Set 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. + * * @param[in] aInstance A pointer to an OpenThread instance. * @param[in] aKeySequenceCounter The thrKeySequenceCounter value. * @@ -508,6 +511,9 @@ OTAPI uint32_t OTCALL otThreadGetKeySwitchGuardTime(otInstance *aInstance); /** * Set the thrKeySwitchGuardTime * + * @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. + * * @param[in] aInstance A pointer to an OpenThread instance. * @param[in] aKeySwitchGuardTime The thrKeySwitchGuardTime value (in hours). * @@ -530,6 +536,9 @@ OTAPI otError OTCALL otThreadBecomeDetached(otInstance *aInstance); /** * Attempt to reattach as a child. * + * @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. + * * @param[in] aInstance A pointer to an OpenThread instance. * * @retval OT_ERROR_NONE Successfully begin attempt to become a child. diff --git a/include/openthread/thread_ftd.h b/include/openthread/thread_ftd.h index 32824e910..5ed1cde65 100644 --- a/include/openthread/thread_ftd.h +++ b/include/openthread/thread_ftd.h @@ -149,6 +149,9 @@ OTAPI void OTCALL otThreadSetRouterRoleEnabled(otInstance *aInstance, bool aEnab * it can not be used, a randomly generated router id is picked. This property can be set only when the device role is * either detached or disabled. * + * @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. + * * @param[in] aInstance A pointer to an OpenThread instance. * @param[in] aRouterId The preferred Router Id. * @@ -257,6 +260,9 @@ OTAPI uint32_t OTCALL otThreadGetContextIdReuseDelay(otInstance *aInstance); /** * Set the CONTEXT_ID_REUSE_DELAY parameter used in the Leader role. * + * @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. + * * @param[in] aInstance A pointer to an OpenThread instance. * @param[in] aDelay The CONTEXT_ID_REUSE_DELAY value. * @@ -268,6 +274,9 @@ OTAPI void OTCALL otThreadSetContextIdReuseDelay(otInstance *aInstance, uint32_t /** * Get the NETWORK_ID_TIMEOUT parameter used in the Router role. * + * @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. + * * @param[in] aInstance A pointer to an OpenThread instance. * * @returns The NETWORK_ID_TIMEOUT value. @@ -303,6 +312,9 @@ OTAPI uint8_t OTCALL otThreadGetRouterUpgradeThreshold(otInstance *aInstance); /** * Set the ROUTER_UPGRADE_THRESHOLD parameter used in the Leader role. * + * @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. + * * @param[in] aInstance A pointer to an OpenThread instance. * @param[in] aThreshold The ROUTER_UPGRADE_THRESHOLD value. * @@ -314,6 +326,9 @@ OTAPI void OTCALL otThreadSetRouterUpgradeThreshold(otInstance *aInstance, uint8 /** * Release a Router ID that has been allocated by the device in the Leader role. * + * @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. + * * @param[in] aInstance A pointer to an OpenThread instance. * @param[in] aRouterId The Router ID to release. Valid range is [0, 62]. * @@ -327,6 +342,9 @@ OTAPI otError OTCALL otThreadReleaseRouterId(otInstance *aInstance, uint8_t aRou /** * Attempt to become a router. * + * @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. + * * @param[in] aInstance A pointer to an OpenThread instance. * * @retval OT_ERROR_NONE Successfully begin attempt to become a router. @@ -337,6 +355,9 @@ OTAPI otError OTCALL otThreadBecomeRouter(otInstance *aInstance); /** * Become a leader and start a new partition. * + * @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. + * * @param[in] aInstance A pointer to an OpenThread instance. * * @retval OT_ERROR_NONE Successfully became a leader and started a new partition. @@ -358,6 +379,9 @@ OTAPI uint8_t OTCALL otThreadGetRouterDowngradeThreshold(otInstance *aInstance); /** * Set the ROUTER_DOWNGRADE_THRESHOLD parameter used in the Leader role. * + * @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. + * * @param[in] aInstance A pointer to an OpenThread instance. * @param[in] aThreshold The ROUTER_DOWNGRADE_THRESHOLD value. * @@ -379,6 +403,9 @@ OTAPI uint8_t OTCALL otThreadGetRouterSelectionJitter(otInstance *aInstance); /** * Set the ROUTER_SELECTION_JITTER parameter used in the REED/Router role. * + * @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. + * * @param[in] aInstance A pointer to an OpenThread instance. * @param[in] aRouterJitter The ROUTER_SELECTION_JITTER value. * @@ -531,6 +558,9 @@ OTAPI int8_t OTCALL otThreadGetParentPriority(otInstance *aInstance); /** * Set the parent priority. * + * @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. + * * @param[in] aInstance A pointer to an OpenThread instance. * @param[in] aParentPriority The parent priority value. *