foxBMS
1.2.1
The foxBMS Battery Management System API Documentation
|
CAN callbacks header. More...
Go to the source code of this file.
Functions | |
uint32_t | CAN_TxState (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 state More... | |
uint32_t | CAN_TxVoltage (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 cell voltages More... | |
uint32_t | CAN_TxCellTemperature (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 cell temperatures More... | |
uint32_t | CAN_TxLimitValues (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 limit values More... | |
uint32_t | CAN_TxMinimumMaximumValues (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 min/max values More... | |
uint32_t | CAN_TxStateEstimation (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 state estimation values More... | |
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 More... | |
uint32_t | CAN_TxStringState (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 state values More... | |
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 More... | |
uint32_t | CAN_TxStringMinimumMaximumValues (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 minimum and maximum values More... | |
uint32_t | CAN_TxStringStateEstimation (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 state estimation More... | |
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 More... | |
uint32_t | CAN_RxImdInfo (uint32_t id, uint8_t dlc, CAN_ENDIANNESS_e endianness, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim) |
can rx callback function for IMD info messages More... | |
uint32_t | CAN_RxImdResponse (uint32_t id, uint8_t dlc, CAN_ENDIANNESS_e endianness, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim) |
can rx callback function for IMD response messages More... | |
uint32_t | CAN_RxRequest (uint32_t id, uint8_t dlc, CAN_ENDIANNESS_e endianness, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim) |
can rx callback function for state requests More... | |
uint32_t | CAN_RxSwReset (uint32_t id, uint8_t dlc, CAN_ENDIANNESS_e endianness, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim) |
can rx callback function for SW reset More... | |
uint32_t | CAN_RxCurrentSensor (uint32_t id, uint8_t dlc, CAN_ENDIANNESS_e endianness, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim) |
can rx callback function for current sensor measurements More... | |
uint32_t | CAN_RxDebug (uint32_t id, uint8_t dlc, CAN_ENDIANNESS_e endianness, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim) |
can rx callback function for debug messages More... | |
uint32_t | CAN_RxSwVersion (uint32_t id, uint8_t dlc, CAN_ENDIANNESS_e endianness, uint8_t *pCanData, uint8_t *pMuxId, const CAN_SHIM_s *const kpkCanShim) |
can rx callback function for SW version More... | |
CAN callbacks header.
SPDX-License-Identifier: BSD-3-Clause
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
We kindly request you to use one or more of the following phrases to refer to foxBMS in your hardware, software, documentation or advertising materials:
Definition in file can_cbs.h.
uint32_t CAN_RxCurrentSensor | ( | uint32_t | id, |
uint8_t | dlc, | ||
CAN_ENDIANNESS_e | endianness, | ||
uint8_t * | pCanData, | ||
uint8_t * | pMuxId, | ||
const CAN_SHIM_s *const | kpkCanShim | ||
) |
can rx callback function for current sensor measurements
[in] | id | CAN ID |
[in] | dlc | CAN Data Length Code |
[in] | endianness | big or little endian |
[in] | pCanData | payload of can frame |
[in] | pMuxId | multiplexer for multiplexed CAN messages |
[in] | kpkCanShim | shim to the database entries |
Definition at line 86 of file can_cbs_rx_current_sensor.c.
uint32_t CAN_RxDebug | ( | uint32_t | id, |
uint8_t | dlc, | ||
CAN_ENDIANNESS_e | endianness, | ||
uint8_t * | pCanData, | ||
uint8_t * | pMuxId, | ||
const CAN_SHIM_s *const | kpkCanShim | ||
) |
can rx callback function for debug messages
[in] | id | CAN ID |
[in] | dlc | CAN Data Length Code |
[in] | endianness | big or little endian |
[in] | pCanData | payload of can frame |
[in] | pMuxId | multiplexer for multiplexed CAN messages |
[in] | kpkCanShim | shim to the database entries |
Definition at line 89 of file can_cbs_rx_misc.c.
uint32_t CAN_RxImdInfo | ( | uint32_t | id, |
uint8_t | dlc, | ||
CAN_ENDIANNESS_e | endianness, | ||
uint8_t * | pCanData, | ||
uint8_t * | pMuxId, | ||
const CAN_SHIM_s *const | kpkCanShim | ||
) |
can rx callback function for IMD info messages
RX callback functions
[in] | id | CAN ID |
[in] | dlc | CAN Data Length Code |
[in] | endianness | big or little endian |
[in] | pCanData | payload of can frame |
[in] | pMuxId | multiplexer for multiplexed CAN messages |
[in] | kpkCanShim | shim to the database entries |
Definition at line 70 of file can_cbs_rx_imd.c.
uint32_t CAN_RxImdResponse | ( | uint32_t | id, |
uint8_t | dlc, | ||
CAN_ENDIANNESS_e | endianness, | ||
uint8_t * | pCanData, | ||
uint8_t * | pMuxId, | ||
const CAN_SHIM_s *const | kpkCanShim | ||
) |
can rx callback function for IMD response messages
[in] | id | CAN ID |
[in] | dlc | CAN Data Length Code |
[in] | endianness | big or little endian |
[in] | pCanData | payload of can frame |
[in] | pMuxId | multiplexer for multiplexed CAN messages |
[in] | kpkCanShim | shim to the database entries |
Definition at line 100 of file can_cbs_rx_imd.c.
uint32_t CAN_RxRequest | ( | uint32_t | id, |
uint8_t | dlc, | ||
CAN_ENDIANNESS_e | endianness, | ||
uint8_t * | pCanData, | ||
uint8_t * | pMuxId, | ||
const CAN_SHIM_s *const | kpkCanShim | ||
) |
can rx callback function for state requests
[in] | id | CAN ID |
[in] | dlc | CAN Data Length Code |
[in] | endianness | big or little endian |
[in] | pCanData | payload of can frame |
[in] | pMuxId | multiplexer for multiplexed CAN messages |
[in] | kpkCanShim | shim to the database entries |
0x00: Disconnect strings from HV bus 0x01: Connect strings to HV bus to start discharge 0x02: Connect strings to HV bus to start charging
Definition at line 73 of file can_cbs_rx_command.c.
uint32_t CAN_RxSwReset | ( | uint32_t | id, |
uint8_t | dlc, | ||
CAN_ENDIANNESS_e | endianness, | ||
uint8_t * | pCanData, | ||
uint8_t * | pMuxId, | ||
const CAN_SHIM_s *const | kpkCanShim | ||
) |
can rx callback function for SW reset
[in] | id | CAN ID |
[in] | dlc | CAN Data Length Code |
[in] | endianness | big or little endian |
[in] | pCanData | payload of can frame |
[in] | pMuxId | multiplexer for multiplexed CAN messages |
[in] | kpkCanShim | shim to the database entries |
Definition at line 70 of file can_cbs_rx_misc.c.
uint32_t CAN_RxSwVersion | ( | uint32_t | id, |
uint8_t | dlc, | ||
CAN_ENDIANNESS_e | endianness, | ||
uint8_t * | pCanData, | ||
uint8_t * | pMuxId, | ||
const CAN_SHIM_s *const | kpkCanShim | ||
) |
can rx callback function for SW version
[in] | id | CAN ID |
[in] | dlc | CAN Data Length Code |
[in] | endianness | big or little endian |
[in] | pCanData | payload of can frame |
[in] | pMuxId | multiplexer for multiplexed CAN messages |
[in] | kpkCanShim | shim to the database entries |
Definition at line 126 of file can_cbs_rx_misc.c.
uint32_t CAN_TxCellTemperature | ( | 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 cell temperatures
[in] | id | CAN ID |
[in] | dlc | CAN Data Length Code |
[in] | endianness | big or little endian |
[in] | pCanData | payload of can frame |
[in] | pMuxId | multiplexer for multiplexed CAN messages |
[in] | kpkCanShim | shim to the database entries |
Definition at line 169 of file can_cbs_tx_temperature.c.
uint32_t CAN_TxLimitValues | ( | 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 limit values
[in] | id | CAN ID |
[in] | dlc | CAN Data Length Code |
[in] | endianness | big or little endian |
[in] | pCanData | payload of can frame |
[in] | pMuxId | multiplexer for multiplexed CAN messages |
[in] | kpkCanShim | shim to the database entries |
Definition at line 71 of file can_cbs_tx_limits.c.
uint32_t CAN_TxMinimumMaximumValues | ( | 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 min/max values
[in] | id | CAN ID |
[in] | dlc | CAN Data Length Code |
[in] | endianness | big or little endian |
[in] | pCanData | payload of can frame |
[in] | pMuxId | multiplexer for multiplexed CAN messages |
[in] | kpkCanShim | shim to the database entries |
Definition at line 70 of file can_cbs_tx_minmax.c.
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
[in] | id | CAN ID |
[in] | dlc | CAN Data Length Code |
[in] | endianness | big or little endian |
[in] | pCanData | payload of can frame |
[in] | pMuxId | multiplexer for multiplexed CAN messages |
[in] | kpkCanShim | shim to the database entries |
Definition at line 69 of file can_cbs_tx_system_values.c.
uint32_t CAN_TxState | ( | 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 state
TX callback functions
[in] | id | CAN ID |
[in] | dlc | CAN Data Length Code |
[in] | endianness | big or little endian |
[in] | pCanData | payload of can frame |
[in] | pMuxId | multiplexer for multiplexed CAN messages |
[in] | kpkCanShim | shim to the database entries |
Definition at line 71 of file can_cbs_tx_state.c.
uint32_t CAN_TxStateEstimation | ( | 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 state estimation values
[in] | id | CAN ID |
[in] | dlc | CAN Data Length Code |
[in] | endianness | big or little endian |
[in] | pCanData | payload of can frame |
[in] | pMuxId | multiplexer for multiplexed CAN messages |
[in] | kpkCanShim | shim to the database entries |
Definition at line 71 of file can_cbs_tx_state_estimation.c.
uint32_t CAN_TxStringMinimumMaximumValues | ( | 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 minimum and maximum values
[in] | id | CAN ID |
[in] | dlc | CAN Data Length Code |
[in] | endianness | big or little endian |
[in] | pCanData | payload of can frame |
[in] | pMuxId | multiplexer for multiplexed CAN messages |
[in] | kpkCanShim | shim to the database entries |
Database entry with minimum and maximum values does not need to be read within this callback as it is already read by function CAN_TxMinimumMaximumValues
Definition at line 173 of file can_cbs_tx_minmax.c.
uint32_t CAN_TxStringState | ( | 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 state values
[in] | id | CAN ID |
[in] | dlc | CAN Data Length Code |
[in] | endianness | big or little endian |
[in] | pCanData | payload of can frame |
[in] | pMuxId | multiplexer for multiplexed CAN messages |
[in] | kpkCanShim | shim to the database entries |
Definition at line 173 of file can_cbs_tx_state.c.
uint32_t CAN_TxStringStateEstimation | ( | 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 state estimation
[in] | id | CAN ID |
[in] | dlc | CAN Data Length Code |
[in] | endianness | big or little endian |
[in] | pCanData | payload of can frame |
[in] | pMuxId | multiplexer for multiplexed CAN messages |
[in] | kpkCanShim | shim to the database entries |
Database entry with state estimation values does not need to be read within this callback as it is already read by function CAN_TxStateEstimation
Definition at line 190 of file can_cbs_tx_state_estimation.c.
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
[in] | id | CAN ID |
[in] | dlc | CAN Data Length Code |
[in] | endianness | big or little endian |
[in] | pCanData | payload of can frame |
[in] | pMuxId | multiplexer for multiplexed CAN messages |
[in] | kpkCanShim | shim to the database entries |
Definition at line 132 of file can_cbs_tx_system_values.c.
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
[in] | id | CAN ID |
[in] | dlc | CAN Data Length Code |
[in] | endianness | big or little endian |
[in] | pCanData | payload of can frame |
[in] | pMuxId | multiplexer for multiplexed CAN messages |
[in] | kpkCanShim | shim to the database entries |
Definition at line 208 of file can_cbs_tx_system_values.c.
uint32_t CAN_TxVoltage | ( | 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 cell voltages
[in] | id | CAN ID |
[in] | dlc | CAN Data Length Code |
[in] | endianness | big or little endian |
[in] | pCanData | payload of can frame |
[in] | pMuxId | multiplexer for multiplexed CAN messages |
[in] | kpkCanShim | shim to the database entries |
Definition at line 149 of file can_cbs_tx_voltage.c.