foxBMS - Unit Tests  1.5.0
The foxBMS Unit Tests API Documentation
can_cbs_tx.h File Reference

CAN callbacks header. More...

#include "can_cfg.h"
#include <stdint.h>
Include dependency graph for can_cbs_tx.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 
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 More...
 

Detailed Description

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:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. 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.
  3. 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
2023-02-03 (date of last update)
Version
v1.5.0
Prefix
CANTX

Definition in file can_cbs_tx.h.

Function Documentation

◆ CANTX_BmsState()

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

TX callback functions

Parameters
[in]messagecontains the message ID, DLC and endianness
[in]pCanDatapayload of can frame
[in]pMuxIdmultiplexer for multiplexed CAN messages
[in]kpkCanShimshim to the database entries

Definition at line 94 of file can_cbs_tx_state.c.

Here is the call graph for this function:

◆ CANTX_BmsStateDetails()

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

Parameters
[in]messagecontains the message ID, DLC and endianness
[in]pCanDatapayload of can frame
[in]pMuxIdmultiplexer for multiplexed CAN messages
[in]kpkCanShimshim to the database entries

Definition at line 214 of file can_cbs_tx_state.c.

Here is the call graph for this function:

◆ CANTX_CellTemperatures()

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

Parameters
[in]messagecontains the message ID, DLC and endianness
[in]pCanDatapayload of can frame
[in]pMuxIdmultiplexer for multiplexed CAN messages
[in]kpkCanShimshim to the database entries

Definition at line 173 of file can_cbs_tx_cell-temperatures.c.

Here is the call graph for this function:

◆ CANTX_CellVoltages()

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

Parameters
[in]messagecontains the message ID, DLC and endianness
[in]pCanDatapayload of can frame
[in]pMuxIdmultiplexer for multiplexed CAN messages
[in]kpkCanShimshim to the database entries

Definition at line 155 of file can_cbs_tx_cell-voltages.c.

Here is the call graph for this function:

◆ CANTX_LimitValues()

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

Parameters
[in]messagecontains the message ID, DLC and endianness
[in]pCanDatapayload of can frame
[in]pMuxIdmultiplexer for multiplexed CAN messages
[in]kpkCanShimshim to the database entries

Definition at line 76 of file can_cbs_tx_limit-values.c.

Here is the call graph for this function:

◆ CANTX_MinimumMaximumValues()

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

Parameters
[in]messagecontains the message ID, DLC and endianness
[in]pCanDatapayload of can frame
[in]pMuxIdmultiplexer for multiplexed CAN messages
[in]kpkCanShimshim to the database entries

Definition at line 75 of file can_cbs_tx_minimum-maximum-values.c.

Here is the call graph for this function:

◆ CANTX_PackStateEstimation()

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

Parameters
[in]messagecontains the message ID, DLC and endianness
[in]pCanDatapayload of can frame
[in]pMuxIdmultiplexer for multiplexed CAN messages
[in]kpkCanShimshim to the database entries

Definition at line 76 of file can_cbs_tx_pack-state-estimation.c.

Here is the call graph for this function:

◆ CANTX_PackValues()

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

Parameters
[in]messagecontains the message ID, DLC and endianness
[in]pCanDatapayload of can frame
[in]pMuxIdmultiplexer for multiplexed CAN messages
[in]kpkCanShimshim to the database entries

Definition at line 74 of file can_cbs_tx_system-values.c.

Here is the call graph for this function:

◆ CANTX_StringMinimumMaximumValues()

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

Parameters
[in]messagecontains the message ID, DLC and endianness
[in]pCanDatapayload of can frame
[in]pMuxIdmultiplexer for multiplexed CAN messages
[in]kpkCanShimshim 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 CANTX_MinimumMaximumValues

Definition at line 175 of file can_cbs_tx_minimum-maximum-values.c.

Here is the call graph for this function:

◆ CANTX_StringState()

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

Parameters
[in]messagecontains the message ID, DLC and endianness
[in]pCanDatapayload of can frame
[in]pMuxIdmultiplexer for multiplexed CAN messages
[in]kpkCanShimshim to the database entries

Definition at line 271 of file can_cbs_tx_state.c.

Here is the call graph for this function:

◆ CANTX_StringStateEstimation()

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

Parameters
[in]messagecontains the message ID, DLC and endianness
[in]pCanDatapayload of can frame
[in]pMuxIdmultiplexer for multiplexed CAN messages
[in]kpkCanShimshim 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 CANTX_PackStateEstimation

Definition at line 77 of file can_cbs_tx_string-state-estimation.c.

Here is the call graph for this function:

◆ CANTX_StringValuesP0()

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

Parameters
[in]messagecontains the message ID, DLC and endianness
[in]pCanDatapayload of can frame
[in]pMuxIdmultiplexer for multiplexed CAN messages
[in]kpkCanShimshim to the database entries

Definition at line 136 of file can_cbs_tx_system-values.c.

Here is the call graph for this function:

◆ CANTX_StringValuesP1()

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

Parameters
[in]messagecontains the message ID, DLC and endianness
[in]pCanDatapayload of can frame
[in]pMuxIdmultiplexer for multiplexed CAN messages
[in]kpkCanShimshim to the database entries

Definition at line 211 of file can_cbs_tx_system-values.c.

Here is the call graph for this function: