foxBMS - Unit Tests  1.4.1
The foxBMS Unit Tests API Documentation
can_cbs_rx.h File Reference

CAN callbacks header. More...

#include "general.h"
#include "can_cfg.h"
Include dependency graph for can_cbs_rx.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

uint32_t CANRX_ImdInfo (CAN_MESSAGE_PROPERTIES_s message, const uint8_t *const kpkCanData, const CAN_SHIM_s *const kpkCanShim)
 can rx callback function for IMD info messages More...
 
uint32_t CANRX_ImdResponse (CAN_MESSAGE_PROPERTIES_s message, const uint8_t *const kpkCanData, const CAN_SHIM_s *const kpkCanShim)
 can rx callback function for IMD response messages More...
 
uint32_t CANRX_BmsStateRequest (CAN_MESSAGE_PROPERTIES_s message, const uint8_t *const kpkCanData, const CAN_SHIM_s *const kpkCanShim)
 can rx callback function for state requests More...
 
uint32_t CANRX_SoftwareReset (CAN_MESSAGE_PROPERTIES_s message, const uint8_t *const kpkCanData, const CAN_SHIM_s *const kpkCanShim)
 can rx callback function for SW reset More...
 
uint32_t CANRX_CurrentSensor (CAN_MESSAGE_PROPERTIES_s message, const uint8_t *const kpkCanData, const CAN_SHIM_s *const kpkCanShim)
 can rx callback function for current sensor measurements More...
 
uint32_t CANRX_Debug (CAN_MESSAGE_PROPERTIES_s message, const uint8_t *const kpkCanData, const CAN_SHIM_s *const kpkCanShim)
 can rx callback function for debug messages More...
 
uint32_t CANRX_SoftwareVersion (CAN_MESSAGE_PROPERTIES_s message, const uint8_t *const kpkCanData, const CAN_SHIM_s *const kpkCanShim)
 can rx callback function for SW version 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
2022-10-27 (date of last update)
Version
v1.4.1
Prefix
CANRX

Definition in file can_cbs_rx.h.

Function Documentation

◆ CANRX_BmsStateRequest()

uint32_t CANRX_BmsStateRequest ( CAN_MESSAGE_PROPERTIES_s  message,
const uint8_t *const  kpkCanData,
const CAN_SHIM_s *const  kpkCanShim 
)

can rx callback function for state requests

Parameters
[in]messagecontains the message ID, DLC and endianness
[in]kpkCanDatapayload of can frame
[in]kpkCanShimshim to the database entries

Definition at line 186 of file can_cbs_rx_state-request.c.

Here is the call graph for this function:

◆ CANRX_CurrentSensor()

uint32_t CANRX_CurrentSensor ( CAN_MESSAGE_PROPERTIES_s  message,
const uint8_t *const  kpkCanData,
const CAN_SHIM_s *const  kpkCanShim 
)

can rx callback function for current sensor measurements

Parameters
[in]messagecontains the message ID, DLC and endianness
[in]kpkCanDatapayload of can frame
[in]kpkCanShimshim to the database entries

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

Definition at line 80 of file can_cbs_rx_current-sensor.c.

Here is the call graph for this function:

◆ CANRX_Debug()

uint32_t CANRX_Debug ( CAN_MESSAGE_PROPERTIES_s  message,
const uint8_t *const  kpkCanData,
const CAN_SHIM_s *const  kpkCanShim 
)

can rx callback function for debug messages

Parameters
[in]messagecontains the message ID, DLC and endianness
[in]kpkCanDatapayload of can frame
[in]kpkCanShimshim to the database entries

Definition at line 85 of file can_cbs_rx_misc.c.

Here is the call graph for this function:

◆ CANRX_ImdInfo()

uint32_t CANRX_ImdInfo ( CAN_MESSAGE_PROPERTIES_s  message,
const uint8_t *const  kpkCanData,
const CAN_SHIM_s *const  kpkCanShim 
)

can rx callback function for IMD info messages

RX callback functions

Parameters
[in]messagecontains the message ID, DLC and endianness
[in]kpkCanDatapayload of can frame
[in]kpkCanShimshim to the database entries

Definition at line 72 of file can_cbs_rx_imd.c.

Here is the call graph for this function:

◆ CANRX_ImdResponse()

uint32_t CANRX_ImdResponse ( CAN_MESSAGE_PROPERTIES_s  message,
const uint8_t *const  kpkCanData,
const CAN_SHIM_s *const  kpkCanShim 
)

can rx callback function for IMD response messages

Parameters
[in]messagecontains the message ID, DLC and endianness
[in]kpkCanDatapayload of can frame
[in]kpkCanShimshim to the database entries

Definition at line 96 of file can_cbs_rx_imd.c.

Here is the call graph for this function:

◆ CANRX_SoftwareReset()

uint32_t CANRX_SoftwareReset ( CAN_MESSAGE_PROPERTIES_s  message,
const uint8_t *const  kpkCanData,
const CAN_SHIM_s *const  kpkCanShim 
)

can rx callback function for SW reset

Parameters
[in]messagecontains the message ID, DLC and endianness
[in]kpkCanDatapayload of can frame
[in]kpkCanShimshim to the database entries

Definition at line 72 of file can_cbs_rx_misc.c.

◆ CANRX_SoftwareVersion()

uint32_t CANRX_SoftwareVersion ( CAN_MESSAGE_PROPERTIES_s  message,
const uint8_t *const  kpkCanData,
const CAN_SHIM_s *const  kpkCanShim 
)

can rx callback function for SW version

Parameters
[in]messagecontains the message ID, DLC and endianness
[in]kpkCanDatapayload of can frame
[in]kpkCanShimshim to the database entries

Definition at line 116 of file can_cbs_rx_misc.c.