foxBMS  1.2.0
The foxBMS Battery Management System API Documentation
can_cbs_tx_voltage.c File Reference

CAN driver Tx callback implementation. More...

#include "can_cbs.h"
#include "can_helper.h"
Include dependency graph for can_cbs_tx_voltage.c:

Go to the source code of this file.

Macros

#define NUMBER_OF_MUX_VOLTAGES_PER_MESSAGE   (4u)
 

Functions

static void CAN_TxVoltageSetData (uint8_t muxId, uint64_t *pMessage, CAN_SIGNAL_TYPE_s cellVoltageSignal, CAN_SIGNAL_TYPE_s cellVoltageInvalidFlagSignal, CAN_ENDIANNESS_e endianness, const CAN_SHIM_s *const kpkCanShim)
 Helper function for CAN_TxVoltage() 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...
 

Variables

static const CAN_SIGNAL_TYPE_s cellVoltageMultiplexer = {7u, 8u, 1.0f, 0.0f, 0.0f, 1.0f}
 
static const CAN_SIGNAL_TYPE_s cellVoltage0InvalidFlag = {12u, 1u, 1.0f, 0.0f, 0.0f, 1.0f}
 
static const CAN_SIGNAL_TYPE_s cellVoltage1InvalidFlag = {13u, 1u, 1.0f, 0.0f, 0.0f, 1.0f}
 
static const CAN_SIGNAL_TYPE_s cellVoltage2InvalidFlag = {14u, 1u, 1.0f, 0.0f, 0.0f, 1.0f}
 
static const CAN_SIGNAL_TYPE_s cellVoltage3InvalidFlag = {15u, 1u, 1.0f, 0.0f, 0.0f, 1.0f}
 
static const CAN_SIGNAL_TYPE_s cellVoltage0_mV = {11u, 13u, 1.0f, 0.0f, 0.0f, 8192.0f}
 
static const CAN_SIGNAL_TYPE_s cellVoltage1_mV = {30u, 13u, 1.0f, 0.0f, 0.0f, 8192.0f}
 
static const CAN_SIGNAL_TYPE_s cellVoltage2_mV = {33u, 13u, 1.0f, 0.0f, 0.0f, 8192.0f}
 
static const CAN_SIGNAL_TYPE_s cellVoltage3_mV = {52u, 13u, 1.0f, 0.0f, 0.0f, 8192.0f}
 

Detailed Description

CAN driver Tx callback implementation.

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
2021-07-29 (date of last update)
Prefix
CAN

CAN Tx callback for cell voltages

Definition in file can_cbs_tx_voltage.c.

Macro Definition Documentation

◆ NUMBER_OF_MUX_VOLTAGES_PER_MESSAGE

#define NUMBER_OF_MUX_VOLTAGES_PER_MESSAGE   (4u)

the number of voltages per message-frame

Definition at line 62 of file can_cbs_tx_voltage.c.

Function Documentation

◆ 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]idCAN ID
[in]dlcCAN Data Length Code
[in]endiannessbig or little endian
[in]pCanDatapayload of can frame
[in]pMuxIdmultiplexer for multiplexed CAN messages
[in]kpkCanShimshim to the database entries

Definition at line 149 of file can_cbs_tx_voltage.c.

Here is the call graph for this function:

◆ CAN_TxVoltageSetData()

static void CAN_TxVoltageSetData ( uint8_t  muxId,
uint64_t *  pMessage,
CAN_SIGNAL_TYPE_s  cellVoltageSignal,
CAN_SIGNAL_TYPE_s  cellVoltageInvalidFlagSignal,
CAN_ENDIANNESS_e  endianness,
const CAN_SHIM_s *const  kpkCanShim 
)
static

Helper function for CAN_TxVoltage()

Used in the CAN_TxVoltage() callback to set invalid flag data and voltage data in the CAN frame.

Parameters
[in]muxIdmultiplexer value
[in]pMessagepointer to CAN frame data
[in]cellVoltageSignalsignal characteristics for voltage data
[in]cellVoltageInvalidFlagSignalsignal characteristics for invalid flag data
[in]endiannessbig or little endianness of data
[in]kpkCanShimshim to the database entries

Definition at line 106 of file can_cbs_tx_voltage.c.

Here is the call graph for this function:

Variable Documentation

◆ cellVoltage0_mV

const CAN_SIGNAL_TYPE_s cellVoltage0_mV = {11u, 13u, 1.0f, 0.0f, 0.0f, 8192.0f}
static

Definition at line 74 of file can_cbs_tx_voltage.c.

◆ cellVoltage0InvalidFlag

const CAN_SIGNAL_TYPE_s cellVoltage0InvalidFlag = {12u, 1u, 1.0f, 0.0f, 0.0f, 1.0f}
static

Definition at line 70 of file can_cbs_tx_voltage.c.

◆ cellVoltage1_mV

const CAN_SIGNAL_TYPE_s cellVoltage1_mV = {30u, 13u, 1.0f, 0.0f, 0.0f, 8192.0f}
static

Definition at line 75 of file can_cbs_tx_voltage.c.

◆ cellVoltage1InvalidFlag

const CAN_SIGNAL_TYPE_s cellVoltage1InvalidFlag = {13u, 1u, 1.0f, 0.0f, 0.0f, 1.0f}
static

Definition at line 71 of file can_cbs_tx_voltage.c.

◆ cellVoltage2_mV

const CAN_SIGNAL_TYPE_s cellVoltage2_mV = {33u, 13u, 1.0f, 0.0f, 0.0f, 8192.0f}
static

Definition at line 76 of file can_cbs_tx_voltage.c.

◆ cellVoltage2InvalidFlag

const CAN_SIGNAL_TYPE_s cellVoltage2InvalidFlag = {14u, 1u, 1.0f, 0.0f, 0.0f, 1.0f}
static

Definition at line 72 of file can_cbs_tx_voltage.c.

◆ cellVoltage3_mV

const CAN_SIGNAL_TYPE_s cellVoltage3_mV = {52u, 13u, 1.0f, 0.0f, 0.0f, 8192.0f}
static

Definition at line 77 of file can_cbs_tx_voltage.c.

◆ cellVoltage3InvalidFlag

const CAN_SIGNAL_TYPE_s cellVoltage3InvalidFlag = {15u, 1u, 1.0f, 0.0f, 0.0f, 1.0f}
static

Definition at line 73 of file can_cbs_tx_voltage.c.

◆ cellVoltageMultiplexer

const CAN_SIGNAL_TYPE_s cellVoltageMultiplexer = {7u, 8u, 1.0f, 0.0f, 0.0f, 1.0f}
static

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

Definition at line 69 of file can_cbs_tx_voltage.c.