CAN callbacks header. More...

#include "general.h"
#include "can_cfg.h"

Include dependency graph for can_cbs.h:

This graph shows which files directly or indirectly include 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_TxDetailState (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 detail 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, const uint8_t const kpkCanData, 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, const uint8_t const kpkCanData, 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, const uint8_t const kpkCanData, 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, const uint8_t const kpkCanData, 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, const uint8_t const kpkCanData, 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, const uint8_t const kpkCanData, 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, const uint8_t const kpkCanData, const CAN_SHIM_s const kpkCanShim)
	can rx callback function for SW version More...

Detailed Description

CAN callbacks header.

Copyright: © 2010 - 2022, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. All rights reserved.

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:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

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:

″This product uses parts of foxBMS®″
″This product includes parts of foxBMS®″
″This product is derived from foxBMS®″

Author: foxBMS Team

Date: 2021-04-20 (date of creation)

Updated: 2022-05-30 (date of last update)

Version: v1.3.0

Prefix: CAN

Definition in file can_cbs.h.

Function Documentation

◆ CAN_RxCurrentSensor()

uint32_t CAN_RxCurrentSensor	(	uint32_t	id,
		uint8_t	dlc,
		CAN_ENDIANNESS_e	endianness,
		const uint8_t *const	kpkCanData,
		const CAN_SHIM_s *const	kpkCanShim
	)

can rx callback function for current sensor measurements

Parameters

[in]	id	CAN ID
[in]	dlc	CAN Data Length Code
[in]	endianness	big or little endian
[in]	kpkCanData	payload of can frame
[in]	kpkCanShim	shim to the database entries

CAN signals used in this message Parameters: bit start, bit length, factor, offset, minimum value, maximum value

Definition at line 79 of file can_cbs_rx_current_sensor.c.

Here is the call graph for this function:

◆ CAN_RxDebug()

uint32_t CAN_RxDebug	(	uint32_t	id,
		uint8_t	dlc,
		CAN_ENDIANNESS_e	endianness,
		const uint8_t *const	kpkCanData,
		const CAN_SHIM_s *const	kpkCanShim
	)

can rx callback function for debug messages

Parameters

[in]	id	CAN ID
[in]	dlc	CAN Data Length Code
[in]	endianness	big or little endian
[in]	kpkCanData	payload of can frame
[in]	kpkCanShim	shim to the database entries

Definition at line 87 of file can_cbs_rx_misc.c.

Here is the call graph for this function:

◆ CAN_RxImdInfo()

uint32_t CAN_RxImdInfo	(	uint32_t	id,
		uint8_t	dlc,
		CAN_ENDIANNESS_e	endianness,
		const uint8_t *const	kpkCanData,
		const CAN_SHIM_s *const	kpkCanShim
	)

can rx callback function for IMD info messages

RX callback functions

Parameters

[in]	id	CAN ID
[in]	dlc	CAN Data Length Code
[in]	endianness	big or little endian
[in]	kpkCanData	payload of can frame
[in]	kpkCanShim	shim to the database entries

Definition at line 71 of file can_cbs_rx_imd.c.

Here is the call graph for this function:

◆ CAN_RxImdResponse()

uint32_t CAN_RxImdResponse	(	uint32_t	id,
		uint8_t	dlc,
		CAN_ENDIANNESS_e	endianness,
		const uint8_t *const	kpkCanData,
		const CAN_SHIM_s *const	kpkCanShim
	)

can rx callback function for IMD response messages

Parameters

[in]	id	CAN ID
[in]	dlc	CAN Data Length Code
[in]	endianness	big or little endian
[in]	kpkCanData	payload of can frame
[in]	kpkCanShim	shim to the database entries

Definition at line 98 of file can_cbs_rx_imd.c.

Here is the call graph for this function:

◆ CAN_RxRequest()

uint32_t CAN_RxRequest	(	uint32_t	id,
		uint8_t	dlc,
		CAN_ENDIANNESS_e	endianness,
		const uint8_t *const	kpkCanData,
		const CAN_SHIM_s *const	kpkCanShim
	)

can rx callback function for state requests

Parameters

[in]	id	CAN ID
[in]	dlc	CAN Data Length Code
[in]	endianness	big or little endian
[in]	kpkCanData	payload of can frame
[in]	kpkCanShim	shim to the database entries

Definition at line 185 of file can_cbs_rx_command.c.

Here is the call graph for this function:

◆ CAN_RxSwReset()

uint32_t CAN_RxSwReset	(	uint32_t	id,
		uint8_t	dlc,
		CAN_ENDIANNESS_e	endianness,
		const uint8_t *const	kpkCanData,
		const CAN_SHIM_s *const	kpkCanShim
	)

can rx callback function for SW reset

Parameters

[in]	id	CAN ID
[in]	dlc	CAN Data Length Code
[in]	endianness	big or little endian
[in]	kpkCanData	payload of can frame
[in]	kpkCanShim	shim to the database entries

Definition at line 71 of file can_cbs_rx_misc.c.

◆ CAN_RxSwVersion()

uint32_t CAN_RxSwVersion	(	uint32_t	id,
		uint8_t	dlc,
		CAN_ENDIANNESS_e	endianness,
		const uint8_t *const	kpkCanData,
		const CAN_SHIM_s *const	kpkCanShim
	)

can rx callback function for SW version

Parameters

[in]	id	CAN ID
[in]	dlc	CAN Data Length Code
[in]	endianness	big or little endian
[in]	kpkCanData	payload of can frame
[in]	kpkCanShim	shim to the database entries

Definition at line 120 of file can_cbs_rx_misc.c.

◆ CAN_TxCellTemperature()

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

Parameters

[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 170 of file can_cbs_tx_temperature.c.

Here is the call graph for this function:

◆ CAN_TxDetailState()

uint32_t CAN_TxDetailState	(	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 detail state

Parameters

[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 186 of file can_cbs_tx_state.c.

Here is the call graph for this function:

◆ CAN_TxLimitValues()

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

Parameters

[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 72 of file can_cbs_tx_limits.c.

Here is the call graph for this function:

◆ CAN_TxMinimumMaximumValues()

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

Parameters

[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_minmax.c.

Here is the call graph for this function:

◆ CAN_TxPackValues()

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

Parameters

[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_system_values.c.

Here is the call graph for this function:

◆ CAN_TxState()

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

Parameters

[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 87 of file can_cbs_tx_state.c.

Here is the call graph for this function:

◆ CAN_TxStateEstimation()

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

Parameters

[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 72 of file can_cbs_tx_state_estimation.c.

Here is the call graph for this function:

◆ CAN_TxStringMinimumMaximumValues()

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

Parameters

[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 174 of file can_cbs_tx_minmax.c.

Here is the call graph for this function:

◆ CAN_TxStringState()

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

Parameters

[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 246 of file can_cbs_tx_state.c.

Here is the call graph for this function:

◆ CAN_TxStringStateEstimation()

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

Parameters

[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 191 of file can_cbs_tx_state_estimation.c.

Here is the call graph for this function:

◆ CAN_TxStringValues()

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

Parameters

[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 133 of file can_cbs_tx_system_values.c.

Here is the call graph for this function:

◆ CAN_TxStringValues2()

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

Parameters

[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 209 of file can_cbs_tx_system_values.c.

Here is the call graph for this function:

◆ CAN_TxVoltage()

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

Parameters

[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 150 of file can_cbs_tx_voltage.c.

Here is the call graph for this function:

Functions

Detailed Description

Function Documentation

◆ CAN_RxCurrentSensor()

◆ CAN_RxDebug()

◆ CAN_RxImdInfo()

◆ CAN_RxImdResponse()

◆ CAN_RxRequest()

◆ CAN_RxSwReset()

◆ CAN_RxSwVersion()

◆ CAN_TxCellTemperature()

◆ CAN_TxDetailState()

◆ CAN_TxLimitValues()

◆ CAN_TxMinimumMaximumValues()

◆ CAN_TxPackValues()

◆ CAN_TxState()

◆ CAN_TxStateEstimation()

◆ CAN_TxStringMinimumMaximumValues()

◆ CAN_TxStringState()

◆ CAN_TxStringStateEstimation()

◆ CAN_TxStringValues()

◆ CAN_TxStringValues2()

◆ CAN_TxVoltage()