RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-01-17 05:32:45 +01:00
Code Releases Activity

pkg/openthread: deprecate ot_command related functions

Browse Source
This commit is contained in:
Jose Alamos 2020-12-17 13:53:22 +01:00 committed by Jose Alamos
parent 5d7477fa5f
commit 36c793ec52
No known key found for this signature in database
GPG Key ID: F483EB800EF89DD9
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
pkg/openthread/include/ot.h
View File

@ -73,6 +73,10 @@ typedef struct {
/**
* @brief Struct containing an OpenThread job
*
* @deprecated This structure is not needed anymore since it's possible to
* run OpenThread code via @ref sys_event (see @ref openthread_get_evq).
* Therefore it will be removed after the 2022.01 release.
*/
typedef struct {
event_t ev; /**< Event associated to the OpenThread job */
@ -157,6 +161,10 @@ void ot_random_init(void);
/**
* @brief Execute OpenThread command. Call this function only in OpenThread thread
*
* @deprecated This function is not needed anymore since it's possible to
* run OpenThread code via @ref sys_event (see @ref openthread_get_evq).
* Therefore it will be removed after the 2022.01 release.
*
* @param[in] ot_instance OpenThread instance
* @param[in] command OpenThread command name
* @param[in] arg arg for the command
@ -172,6 +180,10 @@ uint8_t ot_exec_command(otInstance *ot_instance, const char* command, void *arg,
* @note An OpenThread command allows direct calls to OpenThread API (otXXX functions) without worrying about concurrency
* issues. All API calls should be made in OT_JOB type functions.
*
* @deprecated This function is not needed anymore since it's possible to
* run OpenThread code via @ref sys_event (see @ref openthread_get_evq).
* Therefore it will be removed after the 2022.01 release.
*
* @param[in] command name of the command to call
* @param[in] arg arg for the command
* @param[out] answer answer for the command