foxBMS - Unit Tests  1.1.2
The foxBMS Unit Tests API Documentation
contactor_cfg.h File Reference

Header for the configuration for the driver for the contactors. More...

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

Go to the source code of this file.

Data Structures

struct  CONT_CONTACTOR_STATE
 

Typedefs

typedef enum CONT_ELECTRICAL_STATE_TYPE CONT_ELECTRICAL_STATE_TYPE_e
 
typedef enum CONT_NAMES CONT_NAMES_e
 
typedef enum CONT_FEEDBACK_TYPE CONT_FEEDBACK_TYPE_e
 
typedef struct CONT_CONTACTOR_STATE CONT_CONTACTOR_STATE_s
 
typedef uint8_t CONT_CONTACTOR_INDEX
 

Enumerations

enum  CONT_ELECTRICAL_STATE_TYPE { CONT_SWITCH_OFF , CONT_SWITCH_ON , CONT_SWITCH_UNDEF }
 
enum  CONT_NAMES {
  CONT_STRING0_PLUS , CONT_STRING0_MINUS , CONT_STRING1_PLUS , CONT_STRING1_MINUS ,
  CONT_STRING2_PLUS , CONT_STRING2_MINUS , CONT_PRECHARGE
}
 
enum  CONT_FEEDBACK_TYPE { CONT_FEEDBACK_NORMALLY_OPEN , CONT_FEEDBACK_NORMALLY_CLOSED , CONT_FEEDBACK_THROUGH_CURRENT , CONT_HAS_NO_FEEDBACK }
 

Variables

CONT_CONTACTOR_STATE_s cont_contactorStates [BS_NR_OF_CONTACTORS]
 

Detailed Description

Header for the configuration for the driver for the contactors.

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-11 (date of creation)
Updated
2021-03-24 (date of last update)
Prefix
CONT

Definition in file contactor_cfg.h.

Typedef Documentation

◆ CONT_CONTACTOR_INDEX

typedef uint8_t CONT_CONTACTOR_INDEX

index number of the contactor array; not to be confused with SPS_CHANNEL_INDEX

Definition at line 108 of file contactor_cfg.h.

◆ CONT_CONTACTOR_STATE_s

Status struct for a registry of all contactors

◆ CONT_ELECTRICAL_STATE_TYPE_e

Symbolic names for the possible states of the contactors

◆ CONT_FEEDBACK_TYPE_e

Symbolic names defining the electric behavior of the contactor

◆ CONT_NAMES_e

typedef enum CONT_NAMES CONT_NAMES_e

Symbolic names for the contactors

Enumeration Type Documentation

◆ CONT_ELECTRICAL_STATE_TYPE

Symbolic names for the possible states of the contactors

Enumerator
CONT_SWITCH_OFF 

Contactor off --> Contactor is open

CONT_SWITCH_ON 

Contactor on --> Contactor is closed

CONT_SWITCH_UNDEF 

Contactor undefined --> Contactor state not known

Definition at line 70 of file contactor_cfg.h.

◆ CONT_FEEDBACK_TYPE

Symbolic names defining the electric behavior of the contactor

Enumerator
CONT_FEEDBACK_NORMALLY_OPEN 

Feedback line of a contactor is normally open

CONT_FEEDBACK_NORMALLY_CLOSED 

Feedback line of a contactor is normally closed

CONT_FEEDBACK_THROUGH_CURRENT 

Get feedback information through the current flowing into the contactor

CONT_HAS_NO_FEEDBACK 

Feedback line of the contactor is not used

Definition at line 88 of file contactor_cfg.h.

◆ CONT_NAMES

enum CONT_NAMES

Symbolic names for the contactors

Enumerator
CONT_STRING0_PLUS 

Contactor in string0 plus path

CONT_STRING0_MINUS 

Contactor in string0 minus path

CONT_STRING1_PLUS 

Contactor in string1 plus path

CONT_STRING1_MINUS 

Contactor in string1 minus path

CONT_STRING2_PLUS 

Contactor in string2 plus path

CONT_STRING2_MINUS 

Contactor in string2 minus path

CONT_PRECHARGE 

Precharge contactor

Definition at line 77 of file contactor_cfg.h.

Variable Documentation

◆ cont_contactorStates

CONT_CONTACTOR_STATE_s cont_contactorStates[BS_NR_OF_CONTACTORS]
extern

central state registry of all contactors of the system

Definition at line 62 of file contactor_cfg.c.