foxBMS  1.4.1
The foxBMS Battery Management System API Documentation
can_cfg_rx.c
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2022, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V.
4  * All rights reserved.
5  *
6  * SPDX-License-Identifier: BSD-3-Clause
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright notice, this
12  * list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright notice,
15  * this list of conditions and the following disclaimer in the documentation
16  * and/or other materials provided with the distribution.
17  *
18  * 3. Neither the name of the copyright holder nor the names of its
19  * contributors may be used to endorse or promote products derived from
20  * this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  *
33  * We kindly request you to use one or more of the following phrases to refer to
34  * foxBMS in your hardware, software, documentation or advertising materials:
35  *
36  * - ″This product uses parts of foxBMS®″
37  * - ″This product includes parts of foxBMS®″
38  * - ″This product is derived from foxBMS®″
39  *
40  */
41 
42 /**
43  * @file can_cfg_rx.c
44  * @author foxBMS Team
45  * @date 2019-12-04 (date of creation)
46  * @updated 2022-10-27 (date of last update)
47  * @version v1.4.1
48  * @ingroup DRIVERS_CONFIGURATION
49  * @prefix CANRX
50  *
51  * @brief Configuration for the CAN module
52  *
53  * @details The CAN bus settings and the received messages and their reception
54  * handling are to be specified here.
55  *
56  *
57  */
58 
59 /*========== Includes =======================================================*/
60 #include "can_cfg.h"
61 
62 #include "can_cbs_rx.h"
64 #include "database.h"
65 #include "ftask.h"
66 
67 /*========== Macros and Definitions =========================================*/
68 
69 /*========== Static Constant and Variable Definitions =======================*/
70 
71 /*========== Extern Constant and Variable Definitions =======================*/
72 
73 /** registry of CAN RX messages */
89 };
90 
91 /** length of CAN message arrays */
92 const uint8_t can_rxLength = sizeof(can_rxMessages) / sizeof(can_rxMessages[0]);
93 
94 /*========== Static Function Prototypes =====================================*/
95 
96 /*========== Static Function Implementations ================================*/
97 
98 /*========== Extern Function Implementations ================================*/
99 
100 /*========== Externalized Static Function Implementations (Unit Test) =======*/
101 #ifdef UNITY_UNIT_TEST
102 
103 #endif
CAN callbacks header.
uint32_t CANRX_ImdResponse(CAN_MESSAGE_PROPERTIES_s message, const uint8_t *const kpkCanData, const CAN_SHIM_s *const kpkCanShim)
can rx callback function for IMD response messages
uint32_t CANRX_SoftwareReset(CAN_MESSAGE_PROPERTIES_s message, const uint8_t *const kpkCanData, const CAN_SHIM_s *const kpkCanShim)
can rx callback function for SW reset
uint32_t CANRX_SoftwareVersion(CAN_MESSAGE_PROPERTIES_s message, const uint8_t *const kpkCanData, const CAN_SHIM_s *const kpkCanShim)
can rx callback function for SW version
uint32_t CANRX_Debug(CAN_MESSAGE_PROPERTIES_s message, const uint8_t *const kpkCanData, const CAN_SHIM_s *const kpkCanShim)
can rx callback function for debug messages
uint32_t CANRX_CurrentSensor(CAN_MESSAGE_PROPERTIES_s message, const uint8_t *const kpkCanData, const CAN_SHIM_s *const kpkCanShim)
can rx callback function for current sensor measurements
uint32_t CANRX_BmsStateRequest(CAN_MESSAGE_PROPERTIES_s message, const uint8_t *const kpkCanData, const CAN_SHIM_s *const kpkCanShim)
can rx callback function for state requests
uint32_t CANRX_ImdInfo(CAN_MESSAGE_PROPERTIES_s message, const uint8_t *const kpkCanData, const CAN_SHIM_s *const kpkCanShim)
can rx callback function for IMD info messages
Headers for the configuration for the CAN module.
#define CAN_NODE_1
Definition: can_cfg.h:71
#define CAN_NODE_IMD
Definition: can_cfg.h:75
#define CAN_NODE_CURRENT_SENSOR
Definition: can_cfg.h:76
Header for the driver for the CAN module.
#define CANRX_DEBUG_MESSAGE
#define CANRX_SOFTWARE_RESET_MESSAGE
#define CANRX_STRING0_ENERGY_COUNTER_MESSAGE
#define CANRX_STRING0_VOLTAGE1_MESSAGE
#define CANRX_IMD_RESPONSE_MESSAGE
#define CANRX_IMD_INFO_MESSAGE
#define CANRX_STRING0_CURRENT_COUNTER_MESSAGE
#define CANRX_STRING0_VOLTAGE2_MESSAGE
#define CANRX_STRING0_CURRENT_MESSAGE
#define CANRX_STRING0_POWER_MESSAGE
#define CANRX_SOFTWARE_VERSION_MESSAGE
#define CANRX_STRING0_VOLTAGE3_MESSAGE
#define CANRX_BMS_STATE_REQUEST_MESSAGE
#define CANRX_STRING0_TEMPERATURE_MESSAGE
const CAN_RX_MESSAGE_TYPE_s can_rxMessages[]
Definition: can_cfg_rx.c:74
const uint8_t can_rxLength
Definition: can_cfg_rx.c:92
Database module header.
Header of task driver implementation.