AFBR-S50 API Reference Manual  v1.6.5
AFBR-S50 Time-of-Flight Sensor SDK for Embedded Software
explorer_app.h
Go to the documentation of this file.
1 /*************************************************************************/
38 #ifndef EXPLORER_APP_H
39 #define EXPLORER_APP_H
40 
41 /*!***************************************************************************
42  * @defgroup explorer_main AFBR-S50 Explorer Application
43  * @ingroup explorer_app
44  * @brief AFBR-S50 Explorer Application
45  * @details An example application that utilizes the Argus API.
46  *
47  * A simple task scheduler is used to host the Argus API and a
48  * simple systems communication interface is implemented to
49  * connect to the AFBR-S50 Explorer GUI. The latter is an evaluation
50  * software for the Argus time-of-flight devices.
51  *
52  * @addtogroup explorer_main
53  * @{
54  *****************************************************************************/
55 
56 #include "core/explorer_types.h"
57 #include "api/argus_status.h"
58 #include "argus.h"
59 #include <stdbool.h>
60 
61  /*!***************************************************************************
62  * @brief Initializes all the state machine.
63  * @details This function does initialization of the state machine.
64  * - Initialization of the task scheduler.
65  * - Adding all task to the scheduler.
66  * - Set internal data to a known state.
67  * - Hardware driver initialization.
68  * - Send software information via serial interface.
69  * .
70  * @return Returns the \link #status_t status\endlink (#STATUS_OK on success).
71  *****************************************************************************/
72 status_t ExplorerApp_Init(void);
73 
74 /*!***************************************************************************
75  * @brief This runs the state machine.
76  * @details It runs the task scheduler and never return.
77  *****************************************************************************/
78 void ExplorerApp_Run(void);
79 
80 
82 #endif /* EXPLORER_APP_H */
argus_status.h
This file is part of the AFBR-S50 API.
ExplorerApp_Init
status_t ExplorerApp_Init(void)
Initializes all the state machine.
Definition: explorer_app.c:111
explorer_types.h
This file is part of the AFBR-S50 Explorer Demo Application.
argus.h
This file is part of the AFBR-S50 API.
ExplorerApp_Run
void ExplorerApp_Run(void)
This runs the state machine.
Definition: explorer_tasks.c:230
status_t
int32_t status_t
Type used for all status and error return values.
Definition: argus_status.h:70