foxBMS  1.1.0
The foxBMS Battery Management System API Documentation
can_cbs_tx_system_values.c
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2021, 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_system_values.c
44  * @author foxBMS Team
45  * @date 2021-07-21 (date of creation)
46  * @updated 2021-07-21 (date of last update)
47  * @ingroup DRIVER
48  * @prefix CAN
49  *
50  * @brief CAN driver Tx callback implementation
51  * @details CAN Tx callback for pack value and string value messages
52  */
53 
54 /*========== Includes =======================================================*/
55 #include "can_cbs.h"
56 #include "can_helper.h"
57 
58 /*========== Macros and Definitions =========================================*/
59 
60 /*========== Static Constant and Variable Definitions =======================*/
61 
62 /*========== Extern Constant and Variable Definitions =======================*/
63 
64 /*========== Static Function Prototypes =====================================*/
65 
66 /*========== Static Function Implementations ================================*/
67 
68 /*========== Extern Function Implementations ================================*/
69 extern uint32_t CAN_TxPackValues(
70  uint32_t id,
71  uint8_t dlc,
72  CAN_ENDIANNESS_e endianness,
73  uint8_t *pCanData,
74  uint8_t *pMuxId,
75  const CAN_SHIM_s *const kpkCanShim) {
76  /* pMuxId is not used here, therefore has to be NULL_PTR */
77  FAS_ASSERT(pMuxId == NULL_PTR);
78 
79  FAS_ASSERT(id < CAN_MAX_11BIT_ID); /* Currently standard ID, 11 bit */
80  FAS_ASSERT(dlc <= CAN_MAX_DLC); /* Currently max 8 bytes in a CAN frame */
81  FAS_ASSERT(pCanData != NULL_PTR);
82  FAS_ASSERT(kpkCanShim != NULL_PTR);
83  uint64_t message = 0;
84  float signalData = 0.0f;
85  float offset = 0.0f;
86  float factor = 0.0f;
87  uint64_t data = 0u;
88 
89  /* Read database entry */
90  DATA_READ_DATA(kpkCanShim->pTablePackValues);
91 
92  /* AXIVION Disable Style Generic-NoMagicNumbers: Signal data defined in .dbc file. */
93  /* Battery voltage */
94  signalData = kpkCanShim->pTablePackValues->batteryVoltage_mV;
95  offset = 0.0f;
96  factor = 0.01f; /* convert mV -> 100mV */
97  signalData = (signalData + offset) * factor;
98  data = (uint64_t)signalData;
99  /* set data in CAN frame */
100  CAN_TxSetMessageDataWithSignalData(&message, 7u, 14u, data, endianness);
101 
102  /* System voltage */
103  signalData = kpkCanShim->pTablePackValues->highVoltageBusVoltage_mV;
104  offset = 0.0f;
105  factor = 0.01f; /* convert mV -> 100mV */
106  signalData = (signalData + offset) * factor;
107  data = (uint64_t)signalData;
108  /* set data in CAN frame */
109  CAN_TxSetMessageDataWithSignalData(&message, 9u, 14u, data, endianness);
110 
111  /* System current */
112  signalData = kpkCanShim->pTablePackValues->packCurrent_mA;
113  offset = 0.0f;
114  factor = 0.1f; /* convert mA -> 10mA */
115  signalData = (signalData + offset) * factor;
116  data = (int64_t)signalData;
117  /* set data in CAN frame */
118  CAN_TxSetMessageDataWithSignalData(&message, 41u, 18u, data, endianness);
119 
120  /* System power */
121  signalData = kpkCanShim->pTablePackValues->packPower_W;
122  offset = 0.0f;
123  factor = 0.1f; /* convert W -> 10W */
124  signalData = (signalData + offset) * factor;
125  data = (int64_t)signalData;
126  /* set data in CAN frame */
127  CAN_TxSetMessageDataWithSignalData(&message, 27u, 18u, data, endianness);
128  /* AXIVION Enable Style Generic-NoMagicNumbers: */
129 
130  /* now copy data in the buffer that will be used to send data */
131  CAN_TxSetCanDataWithMessageData(message, pCanData, endianness);
132 
133  return 0;
134 }
135 
136 extern uint32_t CAN_TxStringValues(
137  uint32_t id,
138  uint8_t dlc,
139  CAN_ENDIANNESS_e endianness,
140  uint8_t *pCanData,
141  uint8_t *pMuxId,
142  const CAN_SHIM_s *const kpkCanShim) {
143  FAS_ASSERT(id < CAN_MAX_11BIT_ID); /* Currently standard ID, 11 bit */
144  FAS_ASSERT(dlc <= CAN_MAX_DLC); /* Currently max 8 bytes in a CAN frame */
145  FAS_ASSERT(pCanData != NULL_PTR);
146  FAS_ASSERT(pMuxId != NULL_PTR);
147  FAS_ASSERT(*pMuxId < BS_NR_OF_STRINGS);
148  FAS_ASSERT(kpkCanShim != NULL_PTR);
149  uint64_t message = 0;
150 
151  /* STUB IMPLEMENTATION */
152 
153  /* now copy data in the buffer that will be used to send data */
154  CAN_TxSetCanDataWithMessageData(message, pCanData, endianness);
155 
156  return 0;
157 }
158 
159 extern uint32_t CAN_TxStringValues2(
160  uint32_t id,
161  uint8_t dlc,
162  CAN_ENDIANNESS_e endianness,
163  uint8_t *pCanData,
164  uint8_t *pMuxId,
165  const CAN_SHIM_s *const kpkCanShim) {
166  FAS_ASSERT(id < CAN_MAX_11BIT_ID); /* Currently standard ID, 11 bit */
167  FAS_ASSERT(dlc <= CAN_MAX_DLC); /* Currently max 8 bytes in a CAN frame */
168  FAS_ASSERT(pCanData != NULL_PTR);
169  FAS_ASSERT(pMuxId != NULL_PTR);
170  FAS_ASSERT(*pMuxId < BS_NR_OF_STRINGS);
171  FAS_ASSERT(kpkCanShim != NULL_PTR);
172  uint64_t message = 0;
173 
174  /* STUB IMPLEMENTATION */
175 
176  /* now copy data in the buffer that will be used to send data */
177  CAN_TxSetCanDataWithMessageData(message, pCanData, endianness);
178 
179  return 0;
180 }
181 
182 /*========== Externalized Static Function Implementations (Unit Test) =======*/
183 #ifdef UNITY_UNIT_TEST
184 
185 #endif
#define BS_NR_OF_STRINGS
CAN callbacks header.
uint32_t CAN_TxStringValues2(uint32_t id, uint8_t dlc, CAN_ENDIANNESS_e endianness, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim)
can tx callback function for string values 2
uint32_t CAN_TxPackValues(uint32_t id, uint8_t dlc, CAN_ENDIANNESS_e endianness, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim)
can tx callback function for pack values values
uint32_t CAN_TxStringValues(uint32_t id, uint8_t dlc, CAN_ENDIANNESS_e endianness, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim)
can tx callback function for string values
#define CAN_MAX_11BIT_ID
Definition: can_cfg.h:68
enum CAN_ENDIANNESS CAN_ENDIANNESS_e
#define CAN_MAX_DLC
Definition: can_cfg.h:70
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:166
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:205
Headers for the helper functions for the CAN module.
#define DATA_READ_DATA(...)
Definition: database.h:76
#define FAS_ASSERT(x)
Assertion macro that asserts that x is true.
Definition: fassert.h:237
#define NULL_PTR
Null pointer.
Definition: fstd_types.h:66
DATA_BLOCK_PACK_VALUES_s * pTablePackValues
Definition: can_cfg.h:302
int32_t highVoltageBusVoltage_mV
Definition: database_cfg.h:198