foxBMS - Unit Tests  1.5.0
The foxBMS Unit Tests API Documentation
can_cfg_rx-message-definitions.h File Reference

Header for the driver for the CAN module. More...

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

Go to the source code of this file.

Macros

#define CANRX_NOT_PERIODIC   (0u)
 
#define CANRX_IMD_INFO_ID   (0x37u)
 
#define CANRX_IMD_RESPONSE_ID   (0x23u)
 
#define CANRX_IMD_ID_TYPE   (CAN_STANDARD_IDENTIFIER_11_BIT)
 
#define CANRX_DEBUG_MESSAGE
 
#define CANRX_IMD_INFO_MESSAGE
 
#define CANRX_IMD_RESPONSE_MESSAGE
 
#define CANRX_BMS_STATE_REQUEST_MESSAGE
 
#define CANRX_STRING0_CURRENT_MESSAGE
 
#define CANRX_STRING0_VOLTAGE1_MESSAGE
 
#define CANRX_STRING0_VOLTAGE2_MESSAGE
 
#define CANRX_STRING0_VOLTAGE3_MESSAGE
 
#define CANRX_STRING0_TEMPERATURE_MESSAGE
 
#define CANRX_STRING0_POWER_MESSAGE
 
#define CANRX_STRING0_CURRENT_COUNTER_MESSAGE
 
#define CANRX_STRING0_ENERGY_COUNTER_MESSAGE
 
#define CANRX_BMS_STATE_REQUEST_ID   (0x230u)
 
#define CANRX_BMS_STATE_REQUEST_ID_TYPE   (CAN_STANDARD_IDENTIFIER_11_BIT)
 
#define CANRX_BMS_STATE_REQUEST_PERIOD_ms   (CANRX_NOT_PERIODIC)
 
#define CANRX_BMS_STATE_REQUEST_ENDIANNESS   (CAN_BIG_ENDIAN)
 
#define CANRX_DEBUG_ID   (0x200u)
 
#define CANRX_DEBUG_ID_TYPE   (CAN_STANDARD_IDENTIFIER_11_BIT)
 
#define CANRX_DEBUG_PERIOD_ms   (CANRX_NOT_PERIODIC)
 
#define CANRX_DEBUG_ENDIANNESS   (CAN_BIG_ENDIAN)
 
#define CANRX_CURRENT_SENSOR_MESSAGES_DLC   (6u)
 
#define CANRX_CURRENT_SENSOR_MESSAGES_ID_TYPE   (CAN_STANDARD_IDENTIFIER_11_BIT)
 
#define CANRX_CURRENT_SENSOR_MESSAGES_ENDIANNESS   (CAN_BIG_ENDIAN)
 
#define CANRX_STRING0_CURRENT_ID   (0x521u)
 
#define CANRX_STRING0_CURRENT_PERIOD_ms   (CANRX_NOT_PERIODIC)
 
#define CANRX_STRING0_VOLTAGE1_ID   (0x522u)
 
#define CANRX_STRING0_VOLTAGE1_PERIOD_ms   (CANRX_NOT_PERIODIC)
 
#define CANRX_STRING0_VOLTAGE2_ID   (0x523u)
 
#define CANRX_STRING0_VOLTAGE2_PERIOD_ms   (CANRX_NOT_PERIODIC)
 
#define CANRX_STRING0_VOLTAGE3_ID   (0x524u)
 
#define CANRX_STRING0_VOLTAGE3_PERIOD_ms   (CANRX_NOT_PERIODIC)
 
#define CANRX_STRING0_TEMPERATURE_ID   (0x525u)
 
#define CANRX_STRING0_TEMPERATURE_PERIOD_ms   (CANRX_NOT_PERIODIC)
 
#define CANRX_STRING0_POWER_ID   (0x526u)
 
#define CANRX_STRING0_POWER_PERIOD_ms   (CANRX_NOT_PERIODIC)
 
#define CANRX_STRING0_CURRENT_COUNTER_ID   (0x527u)
 
#define CANRX_STRING0_CURRENT_COUNTER_PERIOD_ms   (CANRX_NOT_PERIODIC)
 
#define CANRX_STRING0_ENERGY_COUNTER_ID   (0x528u)
 
#define CANRX_STRING0_ENERGY_COUNTER_PERIOD_ms   (CANRX_NOT_PERIODIC)
 

Detailed Description

Header for the driver for the CAN module.

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
2022-07-01 (date of creation)
Updated
2023-02-03 (date of last update)
Version
v1.5.0
Prefix
CANRX

Definition in file can_cfg_rx-message-definitions.h.

Macro Definition Documentation

◆ CANRX_BMS_STATE_REQUEST_ENDIANNESS

#define CANRX_BMS_STATE_REQUEST_ENDIANNESS   (CAN_BIG_ENDIAN)

CAN message properties for state request message. Required properties are:

  • Message ID
  • Identifier type (standard or extended)
  • Expected message period in ms or if asynchronous message
  • Endianness of message data

Definition at line 76 of file can_cfg_rx-message-definitions.h.

◆ CANRX_BMS_STATE_REQUEST_ID

#define CANRX_BMS_STATE_REQUEST_ID   (0x230u)

CAN message properties for state request message. Required properties are:

  • Message ID
  • Identifier type (standard or extended)
  • Expected message period in ms or if asynchronous message
  • Endianness of message data

Definition at line 73 of file can_cfg_rx-message-definitions.h.

◆ CANRX_BMS_STATE_REQUEST_ID_TYPE

#define CANRX_BMS_STATE_REQUEST_ID_TYPE   (CAN_STANDARD_IDENTIFIER_11_BIT)

CAN message properties for state request message. Required properties are:

  • Message ID
  • Identifier type (standard or extended)
  • Expected message period in ms or if asynchronous message
  • Endianness of message data

Definition at line 74 of file can_cfg_rx-message-definitions.h.

◆ CANRX_BMS_STATE_REQUEST_MESSAGE

#define CANRX_BMS_STATE_REQUEST_MESSAGE
Value:
{ \
.dlc = CAN_DEFAULT_DLC, \
}, \
{ \
}
#define CAN_DEFAULT_DLC
Definition: can_cfg.h:103
#define CANRX_BMS_STATE_REQUEST_PERIOD_ms
#define CANRX_BMS_STATE_REQUEST_ENDIANNESS
#define CANRX_BMS_STATE_REQUEST_ID
#define CANRX_BMS_STATE_REQUEST_ID_TYPE

Definition at line 178 of file can_cfg_rx-message-definitions.h.

◆ CANRX_BMS_STATE_REQUEST_PERIOD_ms

#define CANRX_BMS_STATE_REQUEST_PERIOD_ms   (CANRX_NOT_PERIODIC)

CAN message properties for state request message. Required properties are:

  • Message ID
  • Identifier type (standard or extended)
  • Expected message period in ms or if asynchronous message
  • Endianness of message data

Definition at line 75 of file can_cfg_rx-message-definitions.h.

◆ CANRX_CURRENT_SENSOR_MESSAGES_DLC

#define CANRX_CURRENT_SENSOR_MESSAGES_DLC   (6u)

CAN message properties for Isabellenhuette current sensor messages. Properties are:

  • Data length of current sensor CAN messages
  • Identifier type (standard or extended)
  • Endianness of message data

Definition at line 107 of file can_cfg_rx-message-definitions.h.

◆ CANRX_CURRENT_SENSOR_MESSAGES_ENDIANNESS

#define CANRX_CURRENT_SENSOR_MESSAGES_ENDIANNESS   (CAN_BIG_ENDIAN)

CAN message properties for Isabellenhuette current sensor messages. Properties are:

  • Data length of current sensor CAN messages
  • Identifier type (standard or extended)
  • Endianness of message data

Definition at line 109 of file can_cfg_rx-message-definitions.h.

◆ CANRX_CURRENT_SENSOR_MESSAGES_ID_TYPE

#define CANRX_CURRENT_SENSOR_MESSAGES_ID_TYPE   (CAN_STANDARD_IDENTIFIER_11_BIT)

CAN message properties for Isabellenhuette current sensor messages. Properties are:

  • Data length of current sensor CAN messages
  • Identifier type (standard or extended)
  • Endianness of message data

Definition at line 108 of file can_cfg_rx-message-definitions.h.

◆ CANRX_DEBUG_ENDIANNESS

#define CANRX_DEBUG_ENDIANNESS   (CAN_BIG_ENDIAN)

CAN message properties for debug message. Required properties are:

  • Message ID
  • Identifier type (standard or extended)
  • Expected message period in ms or if asynchronous message
  • Endianness of message data

Definition at line 87 of file can_cfg_rx-message-definitions.h.

◆ CANRX_DEBUG_ID

#define CANRX_DEBUG_ID   (0x200u)

CAN message properties for debug message. Required properties are:

  • Message ID
  • Identifier type (standard or extended)
  • Expected message period in ms or if asynchronous message
  • Endianness of message data

Definition at line 84 of file can_cfg_rx-message-definitions.h.

◆ CANRX_DEBUG_ID_TYPE

#define CANRX_DEBUG_ID_TYPE   (CAN_STANDARD_IDENTIFIER_11_BIT)

CAN message properties for debug message. Required properties are:

  • Message ID
  • Identifier type (standard or extended)
  • Expected message period in ms or if asynchronous message
  • Endianness of message data

Definition at line 85 of file can_cfg_rx-message-definitions.h.

◆ CANRX_DEBUG_MESSAGE

#define CANRX_DEBUG_MESSAGE
Value:
{ \
.id = CANRX_DEBUG_ID, \
.idType = CANRX_DEBUG_ID_TYPE, \
.dlc = CAN_DEFAULT_DLC, \
.endianness = CANRX_DEBUG_ENDIANNESS, \
}, \
{ \
}
#define CANRX_DEBUG_ID_TYPE
#define CANRX_DEBUG_ENDIANNESS
#define CANRX_DEBUG_ID
#define CANRX_DEBUG_PERIOD_ms

Definition at line 145 of file can_cfg_rx-message-definitions.h.

◆ CANRX_DEBUG_PERIOD_ms

#define CANRX_DEBUG_PERIOD_ms   (CANRX_NOT_PERIODIC)

CAN message properties for debug message. Required properties are:

  • Message ID
  • Identifier type (standard or extended)
  • Expected message period in ms or if asynchronous message
  • Endianness of message data

Definition at line 86 of file can_cfg_rx-message-definitions.h.

◆ CANRX_IMD_ID_TYPE

#define CANRX_IMD_ID_TYPE   (CAN_STANDARD_IDENTIFIER_11_BIT)

CAN message identifier type

Definition at line 101 of file can_cfg_rx-message-definitions.h.

◆ CANRX_IMD_INFO_ID

#define CANRX_IMD_INFO_ID   (0x37u)

----------------------—CAUTION----------------------— The following defines are used by the insulation monitoring device (IMD). If they are changed, the IMD will not work anymore ----------------------—CAUTION----------------------— CAN message ID for info message from iso165c

Definition at line 97 of file can_cfg_rx-message-definitions.h.

◆ CANRX_IMD_INFO_MESSAGE

#define CANRX_IMD_INFO_MESSAGE
Value:
{ \
.idType = CANRX_IMD_ID_TYPE, \
.dlc = CAN_DEFAULT_DLC, \
.endianness = CAN_LITTLE_ENDIAN, \
}, \
{ \
.period = CANRX_NOT_PERIODIC \
}
@ CAN_LITTLE_ENDIAN
Definition: can_cfg.h:157
#define CANRX_IMD_INFO_ID
#define CANRX_NOT_PERIODIC
#define CANRX_IMD_ID_TYPE

Definition at line 156 of file can_cfg_rx-message-definitions.h.

◆ CANRX_IMD_RESPONSE_ID

#define CANRX_IMD_RESPONSE_ID   (0x23u)

CAN message ID for response message from iso165c

Definition at line 99 of file can_cfg_rx-message-definitions.h.

◆ CANRX_IMD_RESPONSE_MESSAGE

#define CANRX_IMD_RESPONSE_MESSAGE
Value:
{ \
.idType = CANRX_IMD_ID_TYPE, \
.dlc = CAN_DEFAULT_DLC, \
.endianness = CAN_LITTLE_ENDIAN, \
}, \
{ \
.period = CANRX_NOT_PERIODIC \
}
#define CANRX_IMD_RESPONSE_ID

Definition at line 167 of file can_cfg_rx-message-definitions.h.

◆ CANRX_NOT_PERIODIC

#define CANRX_NOT_PERIODIC   (0u)

Definition at line 64 of file can_cfg_rx-message-definitions.h.

◆ CANRX_STRING0_CURRENT_COUNTER_ID

#define CANRX_STRING0_CURRENT_COUNTER_ID   (0x527u)

CAN message properties for string 0 current sensor messages. Properties for each message are:

  • Message ID
  • Expected message period in ms or if asynchronous message

Definition at line 127 of file can_cfg_rx-message-definitions.h.

◆ CANRX_STRING0_CURRENT_COUNTER_MESSAGE

#define CANRX_STRING0_CURRENT_COUNTER_MESSAGE
Value:
{ \
}, \
{ \
}
#define CANRX_STRING0_CURRENT_COUNTER_ID
#define CANRX_CURRENT_SENSOR_MESSAGES_DLC
#define CANRX_CURRENT_SENSOR_MESSAGES_ENDIANNESS
#define CANRX_STRING0_CURRENT_COUNTER_PERIOD_ms
#define CANRX_CURRENT_SENSOR_MESSAGES_ID_TYPE

Definition at line 255 of file can_cfg_rx-message-definitions.h.

◆ CANRX_STRING0_CURRENT_COUNTER_PERIOD_ms

#define CANRX_STRING0_CURRENT_COUNTER_PERIOD_ms   (CANRX_NOT_PERIODIC)

CAN message properties for string 0 current sensor messages. Properties for each message are:

  • Message ID
  • Expected message period in ms or if asynchronous message

Definition at line 128 of file can_cfg_rx-message-definitions.h.

◆ CANRX_STRING0_CURRENT_ID

#define CANRX_STRING0_CURRENT_ID   (0x521u)

CAN message properties for string 0 current sensor messages. Properties for each message are:

  • Message ID
  • Expected message period in ms or if asynchronous message

Definition at line 115 of file can_cfg_rx-message-definitions.h.

◆ CANRX_STRING0_CURRENT_MESSAGE

#define CANRX_STRING0_CURRENT_MESSAGE

◆ CANRX_STRING0_CURRENT_PERIOD_ms

#define CANRX_STRING0_CURRENT_PERIOD_ms   (CANRX_NOT_PERIODIC)

CAN message properties for string 0 current sensor messages. Properties for each message are:

  • Message ID
  • Expected message period in ms or if asynchronous message

Definition at line 116 of file can_cfg_rx-message-definitions.h.

◆ CANRX_STRING0_ENERGY_COUNTER_ID

#define CANRX_STRING0_ENERGY_COUNTER_ID   (0x528u)

CAN message properties for string 0 current sensor messages. Properties for each message are:

  • Message ID
  • Expected message period in ms or if asynchronous message

Definition at line 129 of file can_cfg_rx-message-definitions.h.

◆ CANRX_STRING0_ENERGY_COUNTER_MESSAGE

#define CANRX_STRING0_ENERGY_COUNTER_MESSAGE

◆ CANRX_STRING0_ENERGY_COUNTER_PERIOD_ms

#define CANRX_STRING0_ENERGY_COUNTER_PERIOD_ms   (CANRX_NOT_PERIODIC)

CAN message properties for string 0 current sensor messages. Properties for each message are:

  • Message ID
  • Expected message period in ms or if asynchronous message

Definition at line 130 of file can_cfg_rx-message-definitions.h.

◆ CANRX_STRING0_POWER_ID

#define CANRX_STRING0_POWER_ID   (0x526u)

CAN message properties for string 0 current sensor messages. Properties for each message are:

  • Message ID
  • Expected message period in ms or if asynchronous message

Definition at line 125 of file can_cfg_rx-message-definitions.h.

◆ CANRX_STRING0_POWER_MESSAGE

#define CANRX_STRING0_POWER_MESSAGE

◆ CANRX_STRING0_POWER_PERIOD_ms

#define CANRX_STRING0_POWER_PERIOD_ms   (CANRX_NOT_PERIODIC)

CAN message properties for string 0 current sensor messages. Properties for each message are:

  • Message ID
  • Expected message period in ms or if asynchronous message

Definition at line 126 of file can_cfg_rx-message-definitions.h.

◆ CANRX_STRING0_TEMPERATURE_ID

#define CANRX_STRING0_TEMPERATURE_ID   (0x525u)

CAN message properties for string 0 current sensor messages. Properties for each message are:

  • Message ID
  • Expected message period in ms or if asynchronous message

Definition at line 123 of file can_cfg_rx-message-definitions.h.

◆ CANRX_STRING0_TEMPERATURE_MESSAGE

#define CANRX_STRING0_TEMPERATURE_MESSAGE

◆ CANRX_STRING0_TEMPERATURE_PERIOD_ms

#define CANRX_STRING0_TEMPERATURE_PERIOD_ms   (CANRX_NOT_PERIODIC)

CAN message properties for string 0 current sensor messages. Properties for each message are:

  • Message ID
  • Expected message period in ms or if asynchronous message

Definition at line 124 of file can_cfg_rx-message-definitions.h.

◆ CANRX_STRING0_VOLTAGE1_ID

#define CANRX_STRING0_VOLTAGE1_ID   (0x522u)

CAN message properties for string 0 current sensor messages. Properties for each message are:

  • Message ID
  • Expected message period in ms or if asynchronous message

Definition at line 117 of file can_cfg_rx-message-definitions.h.

◆ CANRX_STRING0_VOLTAGE1_MESSAGE

#define CANRX_STRING0_VOLTAGE1_MESSAGE

◆ CANRX_STRING0_VOLTAGE1_PERIOD_ms

#define CANRX_STRING0_VOLTAGE1_PERIOD_ms   (CANRX_NOT_PERIODIC)

CAN message properties for string 0 current sensor messages. Properties for each message are:

  • Message ID
  • Expected message period in ms or if asynchronous message

Definition at line 118 of file can_cfg_rx-message-definitions.h.

◆ CANRX_STRING0_VOLTAGE2_ID

#define CANRX_STRING0_VOLTAGE2_ID   (0x523u)

CAN message properties for string 0 current sensor messages. Properties for each message are:

  • Message ID
  • Expected message period in ms or if asynchronous message

Definition at line 119 of file can_cfg_rx-message-definitions.h.

◆ CANRX_STRING0_VOLTAGE2_MESSAGE

#define CANRX_STRING0_VOLTAGE2_MESSAGE

◆ CANRX_STRING0_VOLTAGE2_PERIOD_ms

#define CANRX_STRING0_VOLTAGE2_PERIOD_ms   (CANRX_NOT_PERIODIC)

CAN message properties for string 0 current sensor messages. Properties for each message are:

  • Message ID
  • Expected message period in ms or if asynchronous message

Definition at line 120 of file can_cfg_rx-message-definitions.h.

◆ CANRX_STRING0_VOLTAGE3_ID

#define CANRX_STRING0_VOLTAGE3_ID   (0x524u)

CAN message properties for string 0 current sensor messages. Properties for each message are:

  • Message ID
  • Expected message period in ms or if asynchronous message

Definition at line 121 of file can_cfg_rx-message-definitions.h.

◆ CANRX_STRING0_VOLTAGE3_MESSAGE

#define CANRX_STRING0_VOLTAGE3_MESSAGE

◆ CANRX_STRING0_VOLTAGE3_PERIOD_ms

#define CANRX_STRING0_VOLTAGE3_PERIOD_ms   (CANRX_NOT_PERIODIC)

CAN message properties for string 0 current sensor messages. Properties for each message are:

  • Message ID
  • Expected message period in ms or if asynchronous message

Definition at line 122 of file can_cfg_rx-message-definitions.h.