can_api.h

Go to the documentation of this file.

/*************************************************************************/
#ifndef CAN_API_H_
#define CAN_API_H_
 
#include "argus.h"
 
 
/*!***************************************************************************
 * @defgroup    can_intf CAN API interface
 * @ingroup     can_app
 *
 * @brief       CAN interface for the AFBR-S50 Reference Board CAN application.
 *
 * @details     A simple CAN interface to demonstrate the basic usage of the
 *              CAN bus that comes with the AFBR-S50 Reference Board.
 *
 * @addtogroup  can_intf
 * @{
 *****************************************************************************/
 
/*!***************************************************************************
 * @brief   Initializes the CAN API module.
 *****************************************************************************/
void CAN_Init(void);
 
 
/*!***************************************************************************
 * @brief   Deinitializes the CAN module.
 *****************************************************************************/
void CAN_Deinit(void);
 
 
/*!***************************************************************************
 * @brief   Handles incoming CAN commands by invoking the corresponding methods.
 *
 * @details Checks the incomming data queue and handles/invokes commands
 *          accordingly.
 *
 *          Note that this function must be called from thread level (not from
 *          interrupt service routines) in order to be executed correctly.
 *****************************************************************************/
void CAN_HandleCommand(void);
 
 
/*!***************************************************************************
 * @brief   Prints measurement results via CAN bus.
 *
 * @details Prints 1D measurement data via CAN-bus as data frame with ID 28.
 *
 *          The following values are included in the CAN data frame payload:
 *
 *          - 0..2: 1D Range [mm] (24bit, unsigned, MSB first)
 *          - 3..4: 1D Amplitude [LSB] (16-bit, unsigned, MSB first)
 *          - 5: Signal Quality [%] (8-bit, 0%-100% )
 *          - 6-7: Status (16-bit, signed, MSB first, see #status_t for details)
 *          .
 *
 * @param   res A pointer to the latest measurement results structure.
 *****************************************************************************/
void CAN_Transmit1D(argus_results_t const * res);
 
#endif /* CAN_API_H_ */