foxBMS - Unit Tests  1.2.0
The foxBMS Unit Tests API Documentation
interlock_cfg.h File Reference

Header for the configuration for the driver for the interlock. More...

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

Go to the source code of this file.

Macros

#define ILCK_IO_REG_DIR   (hetREG1->DIR)
 
#define ILCK_IO_REG_PORT   (hetREG1)
 
#define ILCK_INTERLOCK_CONTROL_PIN_IL_HS_ENABLE   (30u)
 
#define ILCK_INTERLOCK_FEEDBACK_PIN_IL_STATE   (29u)
 
#define ILCK_ADC_INPUT_HIGH_SIDE_VOLTAGE_SENSE   (2u)
 
#define ILCK_ADC_INPUT_LOW_SIDE_VOLTAGE_SENSE   (3u)
 
#define ILCK_ADC_INPUT_HIGH_SIDE_CURRENT_SENSE   (4u)
 
#define ILCK_ADC_INPUT_LOW_SIDE_CURRENT_SENSE   (5u)
 
#define ILCK_VOLTAGE_DIVIDER_FACTOR   ((5.6f + 3.9f) / 3.9f)
 
#define ILCK_FACTOR_IL_HS_CS_1_ohm   (80.0f / 2049.0f)
 
#define ILCK_FACTOR_IL_LS_CS_1_ohm   (0.025f)
 
#define ILCK_STATEMACH_SHORTTIME   (1u)
 ILCK statemachine short time definition in ILCK_Trigger() calls until next state/substate is processed. More...
 

Typedefs

typedef enum ILCK_ELECTRICAL_STATE_TYPE ILCK_ELECTRICAL_STATE_TYPE_e
 

Enumerations

enum  ILCK_ELECTRICAL_STATE_TYPE { ILCK_SWITCH_OFF , ILCK_SWITCH_ON , ILCK_SWITCH_UNDEF }
 

Detailed Description

Header for the configuration for the driver for the interlock.

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
2020-02-24 (date of creation)
Updated
2021-10-18 (date of last update)
Prefix
ILCK

Definition in file interlock_cfg.h.

Macro Definition Documentation

◆ ILCK_ADC_INPUT_HIGH_SIDE_CURRENT_SENSE

#define ILCK_ADC_INPUT_HIGH_SIDE_CURRENT_SENSE   (4u)

High-side current sense signal connected to ADC input 4 (IL_HS_CS)

Definition at line 81 of file interlock_cfg.h.

◆ ILCK_ADC_INPUT_HIGH_SIDE_VOLTAGE_SENSE

#define ILCK_ADC_INPUT_HIGH_SIDE_VOLTAGE_SENSE   (2u)

High-side voltage sense signal connected to ADC input 2 (IL_HS_VS)

Definition at line 77 of file interlock_cfg.h.

◆ ILCK_ADC_INPUT_LOW_SIDE_CURRENT_SENSE

#define ILCK_ADC_INPUT_LOW_SIDE_CURRENT_SENSE   (5u)

Low-side current sense signal connected to ADC input 5 (IL_LS_CS)

Definition at line 83 of file interlock_cfg.h.

◆ ILCK_ADC_INPUT_LOW_SIDE_VOLTAGE_SENSE

#define ILCK_ADC_INPUT_LOW_SIDE_VOLTAGE_SENSE   (3u)

Low-side voltage sense signal connected to ADC input 3 (IL_LS_VS)

Definition at line 79 of file interlock_cfg.h.

◆ ILCK_FACTOR_IL_HS_CS_1_ohm

#define ILCK_FACTOR_IL_HS_CS_1_ohm   (80.0f / 2049.0f)

Conversion factor for interlock current IL_HS_CS 2k49 ohm is the resistance through which sense current flows 80 is the (output current / sense current) ratio of high-side power switch TPS2H000-Q1 Datasheet SLVSD72D ?DECEMBER 2015?REVISED DECEMBER 2019 p.8

Definition at line 95 of file interlock_cfg.h.

◆ ILCK_FACTOR_IL_LS_CS_1_ohm

#define ILCK_FACTOR_IL_LS_CS_1_ohm   (0.025f)

Linear conversion factor for low-side interlock current measurement (IL_LS_CS). Measurement performed via 2 ohm shunt with a gain of 20V/V

Definition at line 99 of file interlock_cfg.h.

◆ ILCK_INTERLOCK_CONTROL_PIN_IL_HS_ENABLE

#define ILCK_INTERLOCK_CONTROL_PIN_IL_HS_ENABLE   (30u)

Enable pin for diagnostic power supply

Definition at line 70 of file interlock_cfg.h.

◆ ILCK_INTERLOCK_FEEDBACK_PIN_IL_STATE

#define ILCK_INTERLOCK_FEEDBACK_PIN_IL_STATE   (29u)

Defines the pin where interlock feedback pin is connected to the mcu

Definition at line 73 of file interlock_cfg.h.

◆ ILCK_IO_REG_DIR

#define ILCK_IO_REG_DIR   (hetREG1->DIR)

IO register to which the interlock is connected

Definition at line 65 of file interlock_cfg.h.

◆ ILCK_IO_REG_PORT

#define ILCK_IO_REG_PORT   (hetREG1)

IO port for interlock related pins

Definition at line 67 of file interlock_cfg.h.

◆ ILCK_STATEMACH_SHORTTIME

#define ILCK_STATEMACH_SHORTTIME   (1u)

ILCK statemachine short time definition in ILCK_Trigger() calls until next state/substate is processed.

Definition at line 105 of file interlock_cfg.h.

◆ ILCK_VOLTAGE_DIVIDER_FACTOR

#define ILCK_VOLTAGE_DIVIDER_FACTOR   ((5.6f + 3.9f) / 3.9f)

Factor of resistor divider used for measuring the low- and high-side interlock voltages. Used resistor values are 5k6 ohm and 3k9 ohm.

Definition at line 87 of file interlock_cfg.h.

Typedef Documentation

◆ ILCK_ELECTRICAL_STATE_TYPE_e

Symbolic names for contactors' possible states

Enumeration Type Documentation

◆ ILCK_ELECTRICAL_STATE_TYPE

Symbolic names for contactors' possible states

Enumerator
ILCK_SWITCH_OFF 

Contactor off --> Contactor is open

ILCK_SWITCH_ON 

Contactor on --> Contactor is closed

ILCK_SWITCH_UNDEF 

Contactor undefined --> Contactor state not known

Definition at line 108 of file interlock_cfg.h.