contactor_cfg.h File Reference

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

#include "battery_system_cfg.h"
#include "sps_types.h"
#include <stdint.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_s

Typedefs
typedef uint8_t	CONT_CONTACTOR_INDEX

Enumerations
enum	CONT_ELECTRICAL_STATE_TYPE_e { CONT_SWITCH_OFF , CONT_SWITCH_ON , CONT_SWITCH_UNDEFINED }
enum	CONT_FEEDBACK_TYPE_e { CONT_FEEDBACK_NORMALLY_OPEN , CONT_FEEDBACK_NORMALLY_CLOSED , CONT_FEEDBACK_THROUGH_CURRENT , CONT_HAS_NO_FEEDBACK }
enum	CONT_TYPE_e { CONT_PLUS , CONT_MINUS , CONT_PRECHARGE , CONT_UNDEFINED }
enum	CONT_CURRENT_BREAKING_DIRECTION_e { CONT_CHARGING_DIRECTION , CONT_DISCHARGING_DIRECTION , CONT_BIDIRECTIONAL }

Variables
CONT_CONTACTOR_STATE_s	cont_contactorStates [BS_NR_OF_CONTACTORS]

Detailed Description

Header for the configuration for the driver for the contactors.

Copyright

© 2010 - 2023, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. All rights reserved.

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

2023-02-03 (date of last update)

Version

v1.5.0

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 118 of file contactor_cfg.h.

Enumeration Type Documentation

CONT_CURRENT_BREAKING_DIRECTION_e

enum CONT_CURRENT_BREAKING_DIRECTION_e

Some contactors are designed and optimized to open current that is flowing in one direction to provide maximum current breaking capability. This direction is then dependent on how the contactors are installed withing the battery system. If bidirectional contactors are used, the main power terminals can be connected in either direction and the current breaking capability is the same for both directions.

Enumerator
CONT_CHARGING_DIRECTION	Contactor is preferred opened in charge current direction
CONT_DISCHARGING_DIRECTION	Contactor is preferred opened in discharge current direction
CONT_BIDIRECTIONAL	Contactor has no preferred way of being opened depending on the current flow

Definition at line 100 of file contactor_cfg.h.

CONT_ELECTRICAL_STATE_TYPE_e

enum CONT_ELECTRICAL_STATE_TYPE_e

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_UNDEFINED	Contactor undefined --> Contactor state not known

Definition at line 70 of file contactor_cfg.h.

CONT_FEEDBACK_TYPE_e

enum CONT_FEEDBACK_TYPE_e

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 77 of file contactor_cfg.h.

CONT_TYPE_e

enum CONT_TYPE_e

Contactor type

Enumerator
CONT_PLUS	Contactor is placed in HV plus path
CONT_MINUS	Contactor is placed in HV minus path
CONT_PRECHARGE	Contactor is used as precharge contactor, installed as a plus contactor
CONT_UNDEFINED	Undefined contactor

Definition at line 85 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 67 of file contactor_cfg.c.