riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

pkg/openthread: add doxygen documentation for calling OT API

Browse Source
This commit is contained in:
Jose Alamos 2020-12-17 14:06:34 +01:00 committed by Jose Alamos
parent d9c5d0a5cc
commit 6b6eb1cbd8
No known key found for this signature in database
GPG Key ID: F483EB800EF89DD9
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -13,6 +13,35 @@
* @see https://github.com/openthread/openthread * @see https://github.com/openthread/openthread
* *
* Thread is a mesh oriented network stack running for IEEE802.15.4 networks. * Thread is a mesh oriented network stack running for IEEE802.15.4 networks.
*
* The RIOT port allows to directly call OpenThread API functions using
* @ref sys_event. For example:
*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ {.c}
* #include "ot.h"
* #include "openthread/thread.h"
*
* static void _panid_handler(event_t *event);
* static event_t event_panid = {
* .handler = _panid_handler
* };
*
* static void _panid_handler(event_t *event)
* {
* (void) event;
* uint16_t panid = otLinkGetPanId(openthread_get_instance());
* do_something_with_panid(panid);
* }
*
* int main(void)
* {
* event_post(openthread_get_evq(), &event_panid);
* return 0;
* }
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* @see https://openthread.io/releases/thread-reference-20180619
*
* @{ * @{
* *
* @file * @file