main.h

Go to the documentation of this file.

/*************************************************************************/
#ifndef MAIN_H_
#define MAIN_H_
 
/*******************************************************************************
 * Include Files
 ******************************************************************************/
#include "argus.h"
#include "debug.h"
 
#if !defined(_RENESAS_RA_)
#error No target specified or target not supported!
#endif
 
/*!***************************************************************************
 * @defgroup    can_app CAN Application
 * @ingroup     demo_apps
 *
 * @brief       AFBR-S50 Reference Board CAN-bus example application.
 *
 * @details     This is the CAN interface example application that can be run
 *              in the \ref reference_board by **MikroElektronika** based on
 *              the **Renesas RA4M2** micro controller.
 *
 *              The application provides a simple CAN interface as an reference
 *              for the customers own implementation.
 *
 *              See the following documentation for more information:
 *              - @ref can_app
 *              - @ref reference_board
 *
 * @addtogroup  can_app
 * @{
 *****************************************************************************/
 
 
/*!***************************************************************************
 * @brief   A very brief example for error handling.
 *
 * @details Checks the specified status for errors (i.e. negative values) and
 *          prints a specified error message if any. An endless loop is entered
 *          to halt program execution.
 *
 * @param   status The specified status to be checked for errors.
 * @param   msg The associated error message to be printed in case of errors.
 *****************************************************************************/
void handle_error(status_t status, char const * msg);
 
 
/*!***************************************************************************
 * @brief   Starts measurements via the AFBR-S50 API.
 *
 * @details The measurements are started via the AFBR-S50 API using the current
 *          device configuration. Nothing happens if the device is already
 *          executing measurements.
 *
 *          In case of error, the #handle_error method is called.
 *****************************************************************************/
void start_measurements(void);
 
 
/*!***************************************************************************
 * @brief   Stops the currently ongoing measurements via the AFBR-S50 API.
 *
 * @details The measurements are stopped via the AFBR-S50 API. Nothing happens
 *          if the device does not currently execute measurements.
 *
 *          In case of error, the #handle_error method is called.
 *****************************************************************************/
void stop_measurements(void);
 
#endif /* MAIN_H_ */