contactor.h File Reference

Headers for the driver for the contactors. More...

#include "contactor_cfg.h"
#include "fstd_types.h"
#include <stdint.h>

Include dependency graph for contactor.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
CONT_ELECTRICAL_STATE_TYPE_e	CONT_GetContactorState (uint8_t stringNumber, CONT_TYPE_e contactorType)
	Returns the current contactor state. More...
STD_RETURN_TYPE_e	CONT_OpenContactor (uint8_t stringNumber, CONT_TYPE_e contactor)
	Opens the contactor. More...
STD_RETURN_TYPE_e	CONT_CloseContactor (uint8_t stringNumber, CONT_TYPE_e contactor)
	Closes the contactor. More...
STD_RETURN_TYPE_e	CONT_ClosePrecharge (uint8_t stringNumber)
	Closes precharge. More...
STD_RETURN_TYPE_e	CONT_OpenPrecharge (uint8_t stringNumber)
	Opens precharge. More...
void	CONT_OpenAllPrechargeContactors (void)
	Open all currently closed precharge contactors. More...
void	CONT_CheckFeedback (void)
	checks the feedback of all contactors More...
void	CONT_Initialize (void)
	initializes the contactor module More...
void	TEST_CONT_InitializationCheckOfContactorRegistry (void)

Detailed Description

Headers 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-10-12 (date of last update)

Version

v1.6.0

Prefix

CONT

Definition in file contactor.h.

Function Documentation

CONT_CheckFeedback()

void CONT_CheckFeedback

(

void

)

checks the feedback of all contactors

makes a DIAG entry for each contactor when the feedback does not match the set value

Definition at line 125 of file contactor.c.

Here is the call graph for this function:

CONT_CloseContactor()

STD_RETURN_TYPE_e CONT_CloseContactor	(	uint8_t	stringNumber,
		CONT_TYPE_e	contactor
	)

Closes the contactor.

This function makes an close state request to the specific contactor

Parameters

stringNumber	String addressed
contactor	contactor addressed

Definition at line 184 of file contactor.c.

Here is the call graph for this function:

CONT_ClosePrecharge()

STD_RETURN_TYPE_e CONT_ClosePrecharge

(

uint8_t

stringNumber

)

Closes precharge.

This function makes a close state request to the precharge contactor.

Parameters

stringNumber

String addressed

Returns

STD_OK if requested contactor exists and close requested, otherwise STD_NOT_OK

Definition at line 203 of file contactor.c.

Here is the call graph for this function:

CONT_GetContactorState()

CONT_ELECTRICAL_STATE_TYPE_e CONT_GetContactorState	(	uint8_t	stringNumber,
		CONT_TYPE_e	contactorType
	)

Returns the current contactor state.

This function is used in the functioning of the CONT state machine.

Parameters

stringNumber	string in which the contactor is placed
contactorType	contactor type for which the feedback is requested

Returns

current state, taken from CONT_ELECTRICAL_STATE_TYPE_e

Definition at line 236 of file contactor.c.

CONT_Initialize()

void CONT_Initialize

(

void

)

initializes the contactor module

Definition at line 251 of file contactor.c.

Here is the call graph for this function:

CONT_OpenAllPrechargeContactors()

void CONT_OpenAllPrechargeContactors

(

void

)

Open all currently closed precharge contactors.

This function iterates over all contactors and opens all currently closed precharge contactors

Returns

none (void)

Definition at line 223 of file contactor.c.

Here is the call graph for this function:

CONT_OpenContactor()

STD_RETURN_TYPE_e CONT_OpenContactor	(	uint8_t	stringNumber,
		CONT_TYPE_e	contactor
	)

Opens the contactor.

This function makes an open state request to the specific contactor

Parameters

stringNumber	String addressed
contactor	contactor addressed

Definition at line 165 of file contactor.c.

Here is the call graph for this function:

CONT_OpenPrecharge()

STD_RETURN_TYPE_e CONT_OpenPrecharge

(

uint8_t

stringNumber

)

Opens precharge.

This function makes an open state request to the precharge contactor.

Parameters

stringNumber

String addressed

Definition at line 213 of file contactor.c.

Here is the call graph for this function:

TEST_CONT_InitializationCheckOfContactorRegistry()

void TEST_CONT_InitializationCheckOfContactorRegistry

(

void

)

Definition at line 257 of file contactor.c.

Here is the call graph for this function: