![]() |
foxBMS
1.5.1
The foxBMS Battery Management System API Documentation
|
Header for the driver for the CAN module. More...
Go to the source code of this file.
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:
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:
Definition in file can_cfg_tx-message-definitions.h.
#define CANTX_BMS_STATE_DETAILS_ENDIANNESS (CAN_BIG_ENDIAN) |
CAN message properties for BMS detail state. Required properties are:
Definition at line 96 of file can_cfg_tx-message-definitions.h.
#define CANTX_BMS_STATE_DETAILS_ID (0x226u) |
CAN message properties for BMS detail state. Required properties are:
Definition at line 92 of file can_cfg_tx-message-definitions.h.
#define CANTX_BMS_STATE_DETAILS_ID_TYPE (CAN_STANDARD_IDENTIFIER_11_BIT) |
CAN message properties for BMS detail state. Required properties are:
Definition at line 93 of file can_cfg_tx-message-definitions.h.
#define CANTX_BMS_STATE_DETAILS_MESSAGE |
Definition at line 261 of file can_cfg_tx-message-definitions.h.
#define CANTX_BMS_STATE_DETAILS_PERIOD_ms (1000u) |
CAN message properties for BMS detail state. Required properties are:
Definition at line 94 of file can_cfg_tx-message-definitions.h.
#define CANTX_BMS_STATE_DETAILS_PHASE_ms (100u) |
CAN message properties for BMS detail state. Required properties are:
Definition at line 95 of file can_cfg_tx-message-definitions.h.
#define CANTX_BMS_STATE_ENDIANNESS (CAN_BIG_ENDIAN) |
CAN message properties for BMS state message. Required properties are:
Definition at line 84 of file can_cfg_tx-message-definitions.h.
#define CANTX_BMS_STATE_ID (0x220u) |
CAN message properties for BMS state message. Required properties are:
Definition at line 80 of file can_cfg_tx-message-definitions.h.
#define CANTX_BMS_STATE_ID_TYPE (CAN_STANDARD_IDENTIFIER_11_BIT) |
CAN message properties for BMS state message. Required properties are:
Definition at line 81 of file can_cfg_tx-message-definitions.h.
#define CANTX_BMS_STATE_MESSAGE |
Definition at line 250 of file can_cfg_tx-message-definitions.h.
#define CANTX_BMS_STATE_PERIOD_ms (100u) |
CAN message properties for BMS state message. Required properties are:
Definition at line 82 of file can_cfg_tx-message-definitions.h.
#define CANTX_BMS_STATE_PHASE_ms (0u) |
CAN message properties for BMS state message. Required properties are:
Definition at line 83 of file can_cfg_tx-message-definitions.h.
#define CANTX_CELL_TEMPERATURES_ENDIANNESS (CAN_BIG_ENDIAN) |
CAN message properties for BMS cell temperatures. Required properties are:
Definition at line 120 of file can_cfg_tx-message-definitions.h.
#define CANTX_CELL_TEMPERATURES_ID (0x250u) |
CAN message properties for BMS cell temperatures. Required properties are:
Definition at line 116 of file can_cfg_tx-message-definitions.h.
#define CANTX_CELL_TEMPERATURES_ID_TYPE (CAN_STANDARD_IDENTIFIER_11_BIT) |
CAN message properties for BMS cell temperatures. Required properties are:
Definition at line 117 of file can_cfg_tx-message-definitions.h.
#define CANTX_CELL_TEMPERATURES_MESSAGE |
Definition at line 305 of file can_cfg_tx-message-definitions.h.
#define CANTX_CELL_TEMPERATURES_PERIOD_ms (200u) |
CAN message properties for BMS cell temperatures. Required properties are:
Definition at line 118 of file can_cfg_tx-message-definitions.h.
#define CANTX_CELL_TEMPERATURES_PHASE_ms (20u) |
CAN message properties for BMS cell temperatures. Required properties are:
Definition at line 119 of file can_cfg_tx-message-definitions.h.
#define CANTX_CELL_VOLTAGES_ENDIANNESS (CAN_BIG_ENDIAN) |
CAN message properties for BMS cell voltages. Required properties are:
Definition at line 108 of file can_cfg_tx-message-definitions.h.
#define CANTX_CELL_VOLTAGES_ID (0x240u) |
CAN message properties for BMS cell voltages. Required properties are:
Definition at line 104 of file can_cfg_tx-message-definitions.h.
#define CANTX_CELL_VOLTAGES_ID_TYPE (CAN_STANDARD_IDENTIFIER_11_BIT) |
CAN message properties for BMS cell voltages. Required properties are:
Definition at line 105 of file can_cfg_tx-message-definitions.h.
#define CANTX_CELL_VOLTAGES_MESSAGE |
Definition at line 272 of file can_cfg_tx-message-definitions.h.
#define CANTX_CELL_VOLTAGES_PERIOD_ms (100u) |
CAN message properties for BMS cell voltages. Required properties are:
Definition at line 106 of file can_cfg_tx-message-definitions.h.
#define CANTX_CELL_VOLTAGES_PHASE_ms (10u) |
CAN message properties for BMS cell voltages. Required properties are:
Definition at line 107 of file can_cfg_tx-message-definitions.h.
#define CANTX_DEBUG_IDENTIFIER (CAN_STANDARD_IDENTIFIER_11_BIT) |
Definition at line 69 of file can_cfg_tx-message-definitions.h.
#define CANTX_DEBUG_RESPONSE_ID (0x227u) /* check_ids:not-periodic */ |
CAN message ID for debug response message
Definition at line 68 of file can_cfg_tx-message-definitions.h.
#define CANTX_IMD_ID_TYPE (CAN_STANDARD_IDENTIFIER_11_BIT) |
CAN message identifier type
Definition at line 242 of file can_cfg_tx-message-definitions.h.
#define CANTX_IMD_REQUEST_ID (0x22u) |
----------------------—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 request message to iso165c
Definition at line 240 of file can_cfg_tx-message-definitions.h.
#define CANTX_LIMIT_VALUES_ENDIANNESS (CAN_BIG_ENDIAN) |
CAN message properties for BMS limit values. Required properties are:
Definition at line 132 of file can_cfg_tx-message-definitions.h.
#define CANTX_LIMIT_VALUES_ID (0x224u) |
CAN message properties for BMS limit values. Required properties are:
Definition at line 128 of file can_cfg_tx-message-definitions.h.
#define CANTX_LIMIT_VALUES_ID_TYPE (CAN_STANDARD_IDENTIFIER_11_BIT) |
CAN message properties for BMS limit values. Required properties are:
Definition at line 129 of file can_cfg_tx-message-definitions.h.
#define CANTX_LIMIT_VALUES_MESSAGE |
Definition at line 294 of file can_cfg_tx-message-definitions.h.
#define CANTX_LIMIT_VALUES_PERIOD_ms (100u) |
CAN message properties for BMS limit values. Required properties are:
Definition at line 130 of file can_cfg_tx-message-definitions.h.
#define CANTX_LIMIT_VALUES_PHASE_ms (30u) |
CAN message properties for BMS limit values. Required properties are:
Definition at line 131 of file can_cfg_tx-message-definitions.h.
#define CANTX_MINIMUM_MAXIMUM_VALUES_ENDIANNESS (CAN_BIG_ENDIAN) |
CAN message properties for minimum and maximum values. Required properties are:
Definition at line 144 of file can_cfg_tx-message-definitions.h.
#define CANTX_MINIMUM_MAXIMUM_VALUES_ID (0x223u) |
CAN message properties for minimum and maximum values. Required properties are:
Definition at line 140 of file can_cfg_tx-message-definitions.h.
#define CANTX_MINIMUM_MAXIMUM_VALUES_ID_TYPE (CAN_STANDARD_IDENTIFIER_11_BIT) |
CAN message properties for minimum and maximum values. Required properties are:
Definition at line 141 of file can_cfg_tx-message-definitions.h.
#define CANTX_MINIMUM_MAXIMUM_VALUES_MESSAGE |
Definition at line 283 of file can_cfg_tx-message-definitions.h.
#define CANTX_MINIMUM_MAXIMUM_VALUES_PERIOD_ms (100u) |
CAN message properties for minimum and maximum values. Required properties are:
Definition at line 142 of file can_cfg_tx-message-definitions.h.
#define CANTX_MINIMUM_MAXIMUM_VALUES_PHASE_ms (40u) |
CAN message properties for minimum and maximum values. Required properties are:
Definition at line 143 of file can_cfg_tx-message-definitions.h.
#define CANTX_PACK_STATE_ESTIMATION_ENDIANNESS (CAN_BIG_ENDIAN) |
CAN message properties for pack state estimation values. Required properties are:
Definition at line 156 of file can_cfg_tx-message-definitions.h.
#define CANTX_PACK_STATE_ESTIMATION_ID (0x225u) |
CAN message properties for pack state estimation values. Required properties are:
Definition at line 152 of file can_cfg_tx-message-definitions.h.
#define CANTX_PACK_STATE_ESTIMATION_ID_TYPE (CAN_STANDARD_IDENTIFIER_11_BIT) |
CAN message properties for pack state estimation values. Required properties are:
Definition at line 153 of file can_cfg_tx-message-definitions.h.
#define CANTX_PACK_STATE_ESTIMATION_MESSAGE |
Definition at line 316 of file can_cfg_tx-message-definitions.h.
#define CANTX_PACK_STATE_ESTIMATION_PERIOD_ms (1000u) |
CAN message properties for pack state estimation values. Required properties are:
Definition at line 154 of file can_cfg_tx-message-definitions.h.
#define CANTX_PACK_STATE_ESTIMATION_PHASE_ms (50u) |
CAN message properties for pack state estimation values. Required properties are:
Definition at line 155 of file can_cfg_tx-message-definitions.h.
#define CANTX_PACK_VALUES_ENDIANNESS (CAN_BIG_ENDIAN) |
CAN message properties for pack values. Required properties are:
Definition at line 168 of file can_cfg_tx-message-definitions.h.
#define CANTX_PACK_VALUES_ID (0x222u) |
CAN message properties for pack values. Required properties are:
Definition at line 164 of file can_cfg_tx-message-definitions.h.
#define CANTX_PACK_VALUES_ID_TYPE (CAN_STANDARD_IDENTIFIER_11_BIT) |
CAN message properties for pack values. Required properties are:
Definition at line 165 of file can_cfg_tx-message-definitions.h.
#define CANTX_PACK_VALUES_MESSAGE |
Definition at line 327 of file can_cfg_tx-message-definitions.h.
#define CANTX_PACK_VALUES_PERIOD_ms (100u) |
CAN message properties for pack values. Required properties are:
Definition at line 166 of file can_cfg_tx-message-definitions.h.
#define CANTX_PACK_VALUES_PHASE_ms (60u) |
CAN message properties for pack values. Required properties are:
Definition at line 167 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_MIN_MAX_VALUES_ENDIANNESS (CAN_BIG_ENDIAN) |
CAN message properties for string minimum and maximum values. Required properties are:
Definition at line 218 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_MIN_MAX_VALUES_ID (0x281u) |
CAN message properties for string minimum and maximum values. Required properties are:
Definition at line 214 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_MIN_MAX_VALUES_ID_TYPE (CAN_STANDARD_IDENTIFIER_11_BIT) |
CAN message properties for string minimum and maximum values. Required properties are:
Definition at line 215 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_MIN_MAX_VALUES_MESSAGE |
Definition at line 371 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_MIN_MAX_VALUES_PERIOD_ms (100u) |
CAN message properties for string minimum and maximum values. Required properties are:
Definition at line 216 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_MIN_MAX_VALUES_PHASE_ms (90u) |
CAN message properties for string minimum and maximum values. Required properties are:
Definition at line 217 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_STATE_ENDIANNESS (CAN_BIG_ENDIAN) |
TX messages - string related CAN message properties for string state. Required properties are:
Definition at line 182 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_STATE_ESTIMATION_ENDIANNESS (CAN_BIG_ENDIAN) |
CAN message properties for string state estimation values. Required properties are:
Definition at line 230 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_STATE_ESTIMATION_ID (0x282u) |
CAN message properties for string state estimation values. Required properties are:
Definition at line 226 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_STATE_ESTIMATION_ID_TYPE (CAN_STANDARD_IDENTIFIER_11_BIT) |
CAN message properties for string state estimation values. Required properties are:
Definition at line 227 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_STATE_ESTIMATION_MESSAGE |
Definition at line 382 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_STATE_ESTIMATION_PERIOD_ms (1000u) |
CAN message properties for string state estimation values. Required properties are:
Definition at line 228 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_STATE_ESTIMATION_PHASE_ms (0u) |
CAN message properties for string state estimation values. Required properties are:
Definition at line 229 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_STATE_ID (0x221u) |
TX messages - string related CAN message properties for string state. Required properties are:
Definition at line 178 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_STATE_ID_TYPE (CAN_STANDARD_IDENTIFIER_11_BIT) |
TX messages - string related CAN message properties for string state. Required properties are:
Definition at line 179 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_STATE_MESSAGE |
Definition at line 338 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_STATE_PERIOD_ms (100u) |
TX messages - string related CAN message properties for string state. Required properties are:
Definition at line 180 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_STATE_PHASE_ms (70u) |
TX messages - string related CAN message properties for string state. Required properties are:
Definition at line 181 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_VALUES_P0_ENDIANNESS (CAN_BIG_ENDIAN) |
CAN message properties for string values part 0. Required properties are:
Definition at line 194 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_VALUES_P0_ID (0x280u) |
CAN message properties for string values part 0. Required properties are:
Definition at line 190 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_VALUES_P0_ID_TYPE (CAN_STANDARD_IDENTIFIER_11_BIT) |
CAN message properties for string values part 0. Required properties are:
Definition at line 191 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_VALUES_P0_MESSAGE |
Definition at line 349 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_VALUES_P0_PERIOD_ms (100u) |
CAN message properties for string values part 0. Required properties are:
Definition at line 192 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_VALUES_P0_PHASE_ms (80u) |
CAN message properties for string values part 0. Required properties are:
Definition at line 193 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_VALUES_P1_ENDIANNESS (CAN_BIG_ENDIAN) |
CAN message properties for string values part 1. Required properties are:
Definition at line 206 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_VALUES_P1_ID (0x283u) |
CAN message properties for string values part 1. Required properties are:
Definition at line 202 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_VALUES_P1_ID_TYPE (CAN_STANDARD_IDENTIFIER_11_BIT) |
CAN message properties for string values part 1. Required properties are:
Definition at line 203 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_VALUES_P1_MESSAGE |
Definition at line 360 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_VALUES_P1_PERIOD_ms (100u) |
CAN message properties for string values part 1. Required properties are:
Definition at line 204 of file can_cfg_tx-message-definitions.h.
#define CANTX_STRING_VALUES_P1_PHASE_ms (10u) |
CAN message properties for string values part 1. Required properties are:
Definition at line 205 of file can_cfg_tx-message-definitions.h.
#define CANTX_UNSUPPORTED_MULTIPLEXER_IDENTIFIER (CAN_STANDARD_IDENTIFIER_11_BIT) |
Definition at line 73 of file can_cfg_tx-message-definitions.h.
#define CANTX_UNSUPPORTED_MULTIPLEXER_VAL_ID (0x201u) /* check_ids:not-periodic */ |
CAN message ID for unsupported multiplexer values in messages
Definition at line 72 of file can_cfg_tx-message-definitions.h.