mirror of
https://github.com/yoboujon/dumber.git
synced 2025-06-08 13:50:49 +02:00
114 lines
3.4 KiB
C
114 lines
3.4 KiB
C
/**
|
|
******************************************************************************
|
|
* @file messages.h
|
|
* @brief messages handler header
|
|
* @author S. DI MERCURIO (dimercur@insa-toulouse.fr)
|
|
* @date December 2023
|
|
*
|
|
******************************************************************************
|
|
* @copyright Copyright 2023 INSA-GEI, Toulouse, France. All rights reserved.
|
|
* @copyright This project is released under the Lesser GNU Public License (LGPL-3.0-only).
|
|
*
|
|
* @copyright This file is part of "Dumber" project
|
|
*
|
|
* @copyright This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 3 of the License, or (at your option) any later version.
|
|
*
|
|
* @copyright This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
|
|
* @copyright You should have received a copy of the GNU Lesser General Public License
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
******************************************************************************
|
|
*/
|
|
|
|
#ifndef INC_MESSAGES_H_
|
|
#define INC_MESSAGES_H_
|
|
|
|
#include "application.h"
|
|
#include "queue.h"
|
|
|
|
/** @addtogroup Application_Software
|
|
* @{
|
|
*/
|
|
|
|
/** @addtogroup MESSAGES
|
|
* @{
|
|
*/
|
|
|
|
/** @addtogroup MESSAGES_Public Public
|
|
* @{
|
|
*/
|
|
|
|
/** Structure storing messages to be posted in mailbox */
|
|
typedef struct {
|
|
uint16_t id; /**< Id of message, as found in \ref msg_id_def "Message ID definitions" */
|
|
QueueHandle_t* sender; /**< reference to sender mailbox, in case of expected answer */
|
|
void *data; /**< reference to data */
|
|
} MESSAGE_Typedef;
|
|
|
|
extern QueueHandle_t LEDS_Mailbox;
|
|
extern QueueHandle_t MOTORS_Mailbox;
|
|
extern QueueHandle_t APPLICATION_Mailbox;
|
|
extern QueueHandle_t XBEE_Mailbox;
|
|
|
|
/**
|
|
* @anchor msg_id_def
|
|
* @name Message ID definitions
|
|
* List of message identifiers
|
|
*/
|
|
///@{
|
|
#define MSG_ID_NO_MESSAGE 0x00
|
|
|
|
#define MSG_ID_LED_ETAT 0x10
|
|
|
|
#define MSG_ID_BAT_CHARGE_ERR 0x20
|
|
#define MSG_ID_BAT_ADC_ERR 0x21
|
|
#define MSG_ID_BAT_LEVEL 0x22
|
|
#define MSG_ID_BAT_CRITICAL_LOW 0x23
|
|
#define MSG_ID_BAT_LOW 0x24
|
|
#define MSG_ID_BAT_MED 0x25
|
|
#define MSG_ID_BAT_HIGH 0x26
|
|
#define MSG_ID_BAT_CHARGE_LOW 0x27
|
|
#define MSG_ID_BAT_CHARGE_MED 0x28
|
|
#define MSG_ID_BAT_CHARGE_HIGH 0x29
|
|
#define MSG_ID_BAT_CHARGE_COMPLETE 0x2A
|
|
//#define MSG_ID_BAT_CHARGE_ON 0x23
|
|
//#define MSG_ID_BAT_CHARGE_OFF 0x24
|
|
|
|
#define MSG_ID_BUTTON_PRESSED 0x30
|
|
|
|
#define MSG_ID_MOTORS_STOP 0x40
|
|
#define MSG_ID_MOTORS_MOVE 0x41
|
|
#define MSG_ID_MOTORS_TURN 0x42
|
|
#define MSG_ID_MOTORS_END_OF_MOUVMENT 0x43
|
|
|
|
#define MSG_ID_XBEE_CMD 0x50
|
|
#define MSG_ID_XBEE_ANS 0x51
|
|
///@}
|
|
|
|
void MESSAGE_Init(void);
|
|
MESSAGE_Typedef MESSAGE_ReadMailbox(QueueHandle_t mbx);
|
|
MESSAGE_Typedef MESSAGE_ReadMailboxNoDelay(QueueHandle_t mbx);
|
|
void MESSAGE_SendMailbox(QueueHandle_t mbx_dest, uint16_t id, QueueHandle_t mbx_sender, void *data);
|
|
void MESSAGE_SendMailboxFromISR(QueueHandle_t mbx_dest, uint16_t id, QueueHandle_t mbx_sender, void *data, BaseType_t *xHigherPriorityTaskWoken);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#endif /* INC_MESSAGES_H_ */
|