explorer_tasks.h

Go to the documentation of this file.

/*************************************************************************/
#ifndef EXPLORER_TASKS_H
#define EXPLORER_TASKS_H
 
/*!***************************************************************************
 * @defgroup    explorer_tasks AFBR-S50 Explorer Application - Tasks
 * @ingroup     explorer_app
 * @brief       AFBR-S50 Explorer Application - Tasks
 * @details     Contains the scheduler task definitions for the AFBR-S50 Explorer
 *              Application.
 *
 *              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_tasks
 * @{
 *****************************************************************************/
 
#include "api/argus_status.h"
#include "explorer_app.h"
#include "argus.h"
 
 
typedef enum explorer_task_t
{
    TASK_ERROR      = 7U,   
    TASK_HNDL_CMD   = 6U,   
    TASK_SEND_DAT   = 2U,   
    TASK_EVAL_DAT   = 1U,   
    TASK_IDLE       = 0U    
} explorer_task_t;
 
/*!***************************************************************************
 * @brief   Initializes the scheduler tasks.
 * @return  Returns the \link #status_t status\endlink (#STATUS_OK on success).
 *****************************************************************************/
status_t ExplorerApp_InitTasks();
 
/*!***************************************************************************
 * @brief   Callback function after measurement cycle was finished.
 *
 * @details Pass this to the #Argus_StartMeasurementTimer and
 *          #Argus_TriggerMeasurement functions.
 *
 * @param   status The current API measurement status.
 *
 * @param   argus The AFBR-S50-API instance that invokes the callback.
 *
 * @return  Returns the \link #status_t status\endlink (#STATUS_OK on success).
 *****************************************************************************/
status_t ExplorerApp_MeasurementReadyCallback(status_t status, argus_hnd_t * argus);
 
/*!***************************************************************************
 * @brief   Switches the scheduler task context.
 * @details Pauses the execution of the current task and lets the lower priority
 *          tasks run. Useful when current task depends on any lower priority
 *          task.
 *****************************************************************************/
void ExplorerApp_SwitchContext(void);
 
#endif /* EXPLORER_TASKS_H */