sci_cmd.h

Go to the documentation of this file.

/*************************************************************************/
#ifndef SCI_CMD_H
#define SCI_CMD_H
 
/*!***************************************************************************
 * @defgroup    sci_cmd SCI: Generic Command Definitions
 * @ingroup     sci
 * @brief       Generic Command Definitions
 * @details     Generic command definitions for the systems communication interface.
 * @addtogroup  sci_cmd
 * @{
 *****************************************************************************/
 
#include "sci.h"
 
#define SCI_LOG_TIMESTAMP 1
 
 
enum GenericSerialCommandCodes
{
    CMD_INVALID             = 0x00, 
    /* Generic commands. */
    CMD_PING                = 0x01, 
    CMD_LOG_MESSAGE         = 0x06, 
    CMD_STATUS_REPORT       = 0x07, 
    CMD_SYSTEM_RESET        = 0x08, 
    CMD_ACKNOWLEDGE         = 0x0A, 
    CMD_NOT_ACKNOWLEDGE     = 0x0B, 
    /* Misc. commands. */
    CMD_TEST_MESSAGE        = 0x04, 
};
 
/*!***************************************************************************
 * @brief   Sends an status report.
 * @param   deviceID The slave ID of the sensor handler to process the command.
 * @param   status The status value to be reported.
 * @return  Returns the \link #status_t status\endlink (#STATUS_OK on success).
 *****************************************************************************/
status_t SCI_SendStatusReport(sci_device_t deviceID, status_t status);
 
/*!***************************************************************************
 * @brief   Sends a log message.
 * @param   fmt_s The printf() format string.
 * @param   ...   The printf() arguments.
 * @return  Returns the \link #status_t status\endlink (#STATUS_OK on success).
 *****************************************************************************/
status_t SCI_SendLogEntry(const char *fmt_s, ...);
 
/*!***************************************************************************
 * @brief   Sends a log message.
 * @param   fmt_s The printf() format string.
 * @param   ...   The printf() arguments.
 * @return  Returns the \link #status_t status\endlink (#STATUS_OK on success).
 *****************************************************************************/
status_t SCI_Printf(const char  *fmt_s, ...);
 
#endif /* SCI_CMD_H */