explorer_app.h

Go to the documentation of this file.

/*************************************************************************/
#ifndef EXPLORER_APP_H
#define EXPLORER_APP_H
 
/*!***************************************************************************
 * @defgroup    explorer_main AFBR-S50 Explorer Application
 * @ingroup     explorer_app
 * @brief       AFBR-S50 Explorer Application
 * @details     An example application that utilizes the Argus API.
 *
 *              A simple task scheduler is used to host the Argus API and a
 *              simple systems communication interface is implemented to
 *              connect to the AFBR-S50 Explorer GUI. The latter is an evaluation
 *              software for the Argus time-of-flight devices.
 *
 * @addtogroup  explorer_main
 * @{
 *****************************************************************************/
 
#include "core/explorer_types.h"
#include "api/argus_status.h"
#include "argus.h"
#include <stdbool.h>
 
 /*!***************************************************************************
 * @brief   Initializes all the state machine.
 * @details This function does initialization of the state machine.
 *          - Initialization of the task scheduler.
 *          - Adding all task to the scheduler.
 *          - Set internal data to a known state.
 *          - Hardware driver initialization.
 *          - Send software information via serial interface.
 *          .
 * @return  Returns the \link #status_t status\endlink (#STATUS_OK on success).
 *****************************************************************************/
status_t ExplorerApp_Init(void);
 
/*!***************************************************************************
 * @brief   This runs the state machine.
 * @details It runs the task scheduler and never return.
 *****************************************************************************/
void ExplorerApp_Run(void);
 
 
#endif /* EXPLORER_APP_H */