foxBMS  1.4.1
The foxBMS Battery Management System API Documentation
can_cbs_tx_minimum-maximum-values.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_cbs_tx_minimum-maximum-values.c
44  * @author foxBMS Team
45  * @date 2021-04-20 (date of creation)
46  * @updated 2022-10-27 (date of last update)
47  * @version v1.4.1
48  * @ingroup DRIVER
49  * @prefix CANTX
50  *
51  * @brief CAN driver Tx callback implementation
52  * @details CAN Tx callback for min/max values
53  */
54 
55 /*========== Includes =======================================================*/
56 #include "bms.h"
57 #include "can_cbs_tx.h"
59 #include "can_helper.h"
60 
61 /*========== Macros and Definitions =========================================*/
62 
63 /*========== Static Constant and Variable Definitions =======================*/
64 
65 /*========== Extern Constant and Variable Definitions =======================*/
66 
67 /*========== Static Function Prototypes =====================================*/
68 
69 /*========== Static Function Implementations ================================*/
70 
71 /*========== Extern Function Implementations ================================*/
74  uint8_t *pCanData,
75  uint8_t *pMuxId,
76  const CAN_SHIM_s *const kpkCanShim) {
79  FAS_ASSERT(pCanData != NULL_PTR);
80  FAS_ASSERT(pMuxId == NULL_PTR); /* pMuxId is not used here, therefore has to be NULL_PTR */
81  FAS_ASSERT(kpkCanShim != NULL_PTR);
82  uint64_t messageData = 0u;
83 
84  DATA_READ_DATA(kpkCanShim->pTableMinMax);
85 
86  int16_t packMaximumVoltage_mV = INT16_MIN;
87  int16_t packMinimumVoltage_mV = INT16_MAX;
88  int16_t packMaximumTemperature_ddegC = INT16_MIN;
89  int16_t packMinimumTemperature_ddegC = INT16_MAX;
90 
91  if (0u == BMS_GetNumberOfConnectedStrings()) {
92  /* Calculate min/max values of complete pack if all slice switches are open */
93  for (uint8_t s = 0u; s < BS_NR_OF_STRINGS; s++) {
94  if (kpkCanShim->pTableMinMax->maximumCellVoltage_mV[s] >= packMaximumVoltage_mV) {
95  packMaximumVoltage_mV = kpkCanShim->pTableMinMax->maximumCellVoltage_mV[s];
96  }
97  if (kpkCanShim->pTableMinMax->minimumCellVoltage_mV[s] <= packMinimumVoltage_mV) {
98  packMinimumVoltage_mV = kpkCanShim->pTableMinMax->minimumCellVoltage_mV[s];
99  }
100  if (kpkCanShim->pTableMinMax->maximumTemperature_ddegC[s] >= packMaximumTemperature_ddegC) {
101  packMaximumTemperature_ddegC = kpkCanShim->pTableMinMax->maximumTemperature_ddegC[s];
102  }
103  if (kpkCanShim->pTableMinMax->minimumTemperature_ddegC[s] <= packMinimumTemperature_ddegC) {
104  packMinimumTemperature_ddegC = kpkCanShim->pTableMinMax->minimumTemperature_ddegC[s];
105  }
106  }
107  } else {
108  /* Calculate min/max values of connected slices */
109  for (uint8_t s = 0u; s < BS_NR_OF_STRINGS; s++) {
110  if (BMS_IsStringClosed(s) == true) {
111  if (kpkCanShim->pTableMinMax->maximumCellVoltage_mV[s] >= packMaximumVoltage_mV) {
112  packMaximumVoltage_mV = kpkCanShim->pTableMinMax->maximumCellVoltage_mV[s];
113  }
114  if (kpkCanShim->pTableMinMax->minimumCellVoltage_mV[s] <= packMinimumVoltage_mV) {
115  packMinimumVoltage_mV = kpkCanShim->pTableMinMax->minimumCellVoltage_mV[s];
116  }
117  if (kpkCanShim->pTableMinMax->maximumTemperature_ddegC[s] >= packMaximumTemperature_ddegC) {
118  packMaximumTemperature_ddegC = kpkCanShim->pTableMinMax->maximumTemperature_ddegC[s];
119  }
120  if (kpkCanShim->pTableMinMax->minimumTemperature_ddegC[s] <= packMinimumTemperature_ddegC) {
121  packMinimumTemperature_ddegC = kpkCanShim->pTableMinMax->minimumTemperature_ddegC[s];
122  }
123  }
124  }
125  }
126 
127  /* AXIVION Disable Style Generic-NoMagicNumbers: Signal data defined in .dbc file. */
128  /* Minimum cell voltage */
129  float signalData = (float)packMinimumVoltage_mV;
130  float offset = 0.0f;
131  float factor = 1.0f;
132  signalData = (signalData + offset) * factor;
133  uint64_t data = (int64_t)signalData;
134  /* set data in CAN frame */
135  CAN_TxSetMessageDataWithSignalData(&messageData, 10u, 13u, data, message.endianness);
136 
137  /* Maximum cell voltage */
138  signalData = (float)packMaximumVoltage_mV;
139  offset = 0.0f;
140  factor = 1.0f;
141  signalData = (signalData + offset) * factor;
142  data = (int64_t)signalData;
143  /* set data in CAN frame */
144  CAN_TxSetMessageDataWithSignalData(&messageData, 7u, 13u, data, message.endianness);
145 
146  /* Minimum cell temperature */
147  signalData = (float)packMinimumTemperature_ddegC;
148  offset = 0.0f;
149  factor = 0.1f; /* convert ddegC to degC */
150  signalData = (signalData + offset) * factor;
151  data = (int64_t)signalData;
152  /* set data in CAN frame */
153  CAN_TxSetMessageDataWithSignalData(&messageData, 63u, 8u, data, message.endianness);
154 
155  /* Maximum cell temperature */
156  signalData = (float)packMaximumTemperature_ddegC;
157  offset = 0.0f;
158  factor = 0.1f; /* convert ddegC to degC */
159  signalData = (signalData + offset) * factor;
160  data = (int64_t)signalData;
161  /* set data in CAN frame */
162  CAN_TxSetMessageDataWithSignalData(&messageData, 55u, 8u, data, message.endianness);
163  /* AXIVION Enable Style Generic-NoMagicNumbers: */
164 
165  /* now copy data in the buffer that will be used to send data */
166  CAN_TxSetCanDataWithMessageData(messageData, pCanData, message.endianness);
167 
168  return 0;
169 }
170 
172  CAN_MESSAGE_PROPERTIES_s message,
173  uint8_t *pCanData,
174  uint8_t *pMuxId,
175  const CAN_SHIM_s *const kpkCanShim) {
178  FAS_ASSERT(pCanData != NULL_PTR);
179  FAS_ASSERT(pMuxId != NULL_PTR);
180  FAS_ASSERT(*pMuxId < BS_NR_OF_STRINGS);
181  FAS_ASSERT(kpkCanShim != NULL_PTR);
182  uint64_t messageData = 0u;
183 
184  /** Database entry with minimum and maximum values does not need to be read
185  * within this callback as it is already read by function
186  * #CANTX_MinimumMaximumValues */
187  const uint8_t stringNumber = *pMuxId;
188 
189  /* AXIVION Disable Style Generic-NoMagicNumbers: Signal data defined in .dbc file. */
190  /* Minimum cell voltage */
191  float signalData = (float)kpkCanShim->pTableMinMax->minimumCellVoltage_mV[stringNumber];
192  float offset = 0.0f;
193  float factor = 1.0f;
194  signalData = (signalData + offset) * factor;
195  uint64_t data = (int64_t)signalData;
196  /* set data in CAN frame */
197  CAN_TxSetMessageDataWithSignalData(&messageData, 18u, 13u, data, message.endianness);
198 
199  /* Maximum cell voltage */
200  signalData = (float)kpkCanShim->pTableMinMax->maximumCellVoltage_mV[stringNumber];
201  offset = 0.0f;
202  factor = 1.0f;
203  signalData = (signalData + offset) * factor;
204  data = (int64_t)signalData;
205  /* set data in CAN frame */
206  CAN_TxSetMessageDataWithSignalData(&messageData, 15u, 13u, data, message.endianness);
207 
208  /* Minimum cell temperature */
209  signalData = (float)kpkCanShim->pTableMinMax->minimumTemperature_ddegC[stringNumber];
210  offset = 0.0f;
211  factor = 0.2f; /* convert ddegC to 0.5degC */
212  signalData = (signalData + offset) * factor;
213  data = (int64_t)signalData;
214  /* set data in CAN frame */
215  CAN_TxSetMessageDataWithSignalData(&messageData, 44u, 9u, data, message.endianness);
216 
217  /* Maximum cell temperature */
218  signalData = (float)kpkCanShim->pTableMinMax->maximumTemperature_ddegC[stringNumber];
219  offset = 0.0f;
220  factor = 0.2f; /* convert ddegC to 0.5degC */
221  signalData = (signalData + offset) * factor;
222  data = (int64_t)signalData;
223  /* set data in CAN frame */
224  CAN_TxSetMessageDataWithSignalData(&messageData, 37, 9u, data, message.endianness);
225  /* AXIVION Enable Style Generic-NoMagicNumbers: */
226 
227  /* now copy data in the buffer that will be use to send data */
228  CAN_TxSetCanDataWithMessageData(messageData, pCanData, message.endianness);
229 
230  /* Increment multiplexer for next cell */
231  (*pMuxId)++;
232 
233  /* Check mux value */
234  if (*pMuxId >= BS_NR_OF_STRINGS) {
235  *pMuxId = 0u;
236  }
237 
238  return 0;
239 }
240 
241 /*========== Externalized Static Function Implementations (Unit Test) =======*/
242 #ifdef UNITY_UNIT_TEST
243 
244 #endif
#define BS_NR_OF_STRINGS
Number of parallel strings in the battery pack.
uint8_t BMS_GetNumberOfConnectedStrings(void)
Returns number of connected strings.
Definition: bms.c:1615
bool BMS_IsStringClosed(uint8_t stringNumber)
Returns string state (closed or open)
Definition: bms.c:1597
bms driver header
CAN callbacks header.
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
#define CAN_FOXBMS_MESSAGES_DEFAULT_DLC
Definition: can_cfg.h:96
Header for the driver for the CAN module.
#define CANTX_STRING_MIN_MAX_VALUES_ID
#define CANTX_MINIMUM_MAXIMUM_VALUES_ID
void CAN_TxSetMessageDataWithSignalData(uint64_t *pMessage, uint64_t bitStart, uint8_t bitLength, uint64_t canSignal, CAN_ENDIANNESS_e endianness)
Puts CAN signal data in a 64-bit variable. This function is used to compose a 64-bit CAN message....
Definition: can_helper.c:167
void CAN_TxSetCanDataWithMessageData(uint64_t message, uint8_t *pCanData, CAN_ENDIANNESS_e endianness)
Copy CAN data from a 64-bit variable to 8 bytes. This function is used to copy a 64-bit CAN message t...
Definition: can_helper.c:206
Headers for the helper functions for the CAN module.
#define DATA_READ_DATA(...)
Definition: database.h:83
#define FAS_ASSERT(x)
Assertion macro that asserts that x is true.
Definition: fassert.h:252
#define NULL_PTR
Null pointer.
Definition: fstd_types.h:76
CAN_ENDIANNESS_e endianness
Definition: can_cfg.h:181
DATA_BLOCK_MIN_MAX_s * pTableMinMax
Definition: can_cfg.h:163
int16_t minimumTemperature_ddegC[BS_NR_OF_STRINGS]
Definition: database_cfg.h:172
int16_t maximumTemperature_ddegC[BS_NR_OF_STRINGS]
Definition: database_cfg.h:175
int16_t maximumCellVoltage_mV[BS_NR_OF_STRINGS]
Definition: database_cfg.h:164
int16_t minimumCellVoltage_mV[BS_NR_OF_STRINGS]
Definition: database_cfg.h:162