foxBMS  1.6.0
The foxBMS Battery Management System API Documentation
can_cfg_tx.c
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2023, 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_tx.c
44  * @author foxBMS Team
45  * @date 2019-12-04 (date of creation)
46  * @updated 2023-10-12 (date of last update)
47  * @version v1.6.0
48  * @ingroup DRIVERS_CONFIGURATION
49  * @prefix CANTX
50  *
51  * @brief Configuration for the CAN module
52  *
53  * @details The CAN bus settings and the transmitted messages and their
54  * reception handling are to be specified here.
55  *
56  *
57  */
58 
59 /*========== Includes =======================================================*/
60 #include "can_cfg.h"
61 
62 #include "can_cbs_tx.h"
64 #include "database.h"
65 #include "ftask.h"
66 
67 #include <stdint.h>
68 
69 /*========== Macros and Definitions =========================================*/
70 
71 /*========== Static Constant and Variable Definitions =======================*/
72 
73 /** Multiplexer values @{*/
74 static uint8_t cantx_voltagesMux = 0u;
75 static uint8_t cantx_temperaturesMux = 0u;
76 static uint8_t cantx_stringStateMux = 0u;
77 static uint8_t cantx_stringValuesP0Mux = 0u;
78 static uint8_t cantx_stringMinMaxMux = 0u;
79 static uint8_t cantx_stringStateEstimationMux = 0u;
80 static uint8_t cantx_stringValuesP1Mux = 0u;
81 /**@}*/
82 
83 /*========== Extern Constant and Variable Definitions =======================*/
84 
85 /** registry of CAN TX messages */
100 };
101 
102 /** length of CAN message arrays */
103 const uint8_t can_txMessagesLength = sizeof(can_txMessages) / sizeof(can_txMessages[0]);
104 
105 /*========== Static Function Prototypes =====================================*/
106 
107 /*========== Static Function Implementations ================================*/
108 
109 /*========== Extern Function Implementations ================================*/
110 
111 /*========== Externalized Static Function Implementations (Unit Test) =======*/
112 #ifdef UNITY_UNIT_TEST
113 #endif
CAN callbacks header.
uint32_t CANTX_CellVoltages(CAN_MESSAGE_PROPERTIES_s message, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim)
can tx callback function for cell voltages
uint32_t CANTX_PackStateEstimation(CAN_MESSAGE_PROPERTIES_s message, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim)
can tx callback function for state estimation values
uint32_t CANTX_BmsState(CAN_MESSAGE_PROPERTIES_s message, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim)
can tx callback function for state
uint32_t CANTX_StringValuesP0(CAN_MESSAGE_PROPERTIES_s message, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim)
can tx callback function for string values
uint32_t CANTX_StringStateEstimation(CAN_MESSAGE_PROPERTIES_s message, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim)
can tx callback function for string state estimation
uint32_t CANTX_LimitValues(CAN_MESSAGE_PROPERTIES_s message, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim)
can tx callback function for limit values
uint32_t CANTX_CellTemperatures(CAN_MESSAGE_PROPERTIES_s message, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim)
can tx callback function for cell temperatures
uint32_t CANTX_PackValues(CAN_MESSAGE_PROPERTIES_s message, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim)
can tx callback function for pack values values
uint32_t CANTX_MinimumMaximumValues(CAN_MESSAGE_PROPERTIES_s message, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim)
can tx callback function for min/max values
uint32_t CANTX_StringMinimumMaximumValues(CAN_MESSAGE_PROPERTIES_s message, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim)
can tx callback function for string minimum and maximum values
uint32_t CANTX_BmsStateDetails(CAN_MESSAGE_PROPERTIES_s message, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim)
can tx callback function for detail state
uint32_t CANTX_StringValuesP1(CAN_MESSAGE_PROPERTIES_s message, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim)
can tx callback function for string values 2
uint32_t CANTX_StringState(CAN_MESSAGE_PROPERTIES_s message, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim)
can tx callback function for string state values
Headers for the configuration for the CAN module.
#define CAN_NODE_1
Definition: can_cfg.h:80
Header for the driver for the CAN module.
#define CANTX_PACK_VALUES_MESSAGE
#define CANTX_CELL_VOLTAGES_MESSAGE
#define CANTX_STRING_VALUES_P1_MESSAGE
#define CANTX_BMS_STATE_DETAILS_MESSAGE
#define CANTX_LIMIT_VALUES_MESSAGE
#define CANTX_MINIMUM_MAXIMUM_VALUES_MESSAGE
#define CANTX_BMS_STATE_MESSAGE
#define CANTX_PACK_STATE_ESTIMATION_MESSAGE
#define CANTX_STRING_VALUES_P0_MESSAGE
#define CANTX_CELL_TEMPERATURES_MESSAGE
#define CANTX_STRING_STATE_ESTIMATION_MESSAGE
#define CANTX_STRING_STATE_MESSAGE
#define CANTX_STRING_MIN_MAX_VALUES_MESSAGE
static uint8_t cantx_stringValuesP1Mux
Definition: can_cfg_tx.c:80
static uint8_t cantx_voltagesMux
Definition: can_cfg_tx.c:74
const uint8_t can_txMessagesLength
Definition: can_cfg_tx.c:103
static uint8_t cantx_temperaturesMux
Definition: can_cfg_tx.c:75
const CAN_TX_MESSAGE_TYPE_s can_txMessages[]
Definition: can_cfg_tx.c:86
static uint8_t cantx_stringStateEstimationMux
Definition: can_cfg_tx.c:79
static uint8_t cantx_stringMinMaxMux
Definition: can_cfg_tx.c:78
static uint8_t cantx_stringValuesP0Mux
Definition: can_cfg_tx.c:77
static uint8_t cantx_stringStateMux
Definition: can_cfg_tx.c:76
Database module header.
#define NULL_PTR
Null pointer.
Definition: fstd_types.h:77
Header of task driver implementation.