foxBMS  1.4.1
The foxBMS Battery Management System API Documentation
no-imd.c
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2022, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V.
4  * All rights reserved.
5  *
6  * SPDX-License-Identifier: BSD-3-Clause
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright notice, this
12  * list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright notice,
15  * this list of conditions and the following disclaimer in the documentation
16  * and/or other materials provided with the distribution.
17  *
18  * 3. Neither the name of the copyright holder nor the names of its
19  * contributors may be used to endorse or promote products derived from
20  * this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  *
33  * We kindly request you to use one or more of the following phrases to refer to
34  * foxBMS in your hardware, software, documentation or advertising materials:
35  *
36  * - ″This product uses parts of foxBMS®″
37  * - ″This product includes parts of foxBMS®″
38  * - ″This product is derived from foxBMS®″
39  *
40  */
41 
42 /**
43  * @file no-imd.c
44  * @author foxBMS Team
45  * @date 2020-11-20 (date of creation)
46  * @updated 2022-10-27 (date of last update)
47  * @version v1.4.1
48  * @ingroup DRIVERS
49  * @prefix NOIMD
50  *
51  * @brief Driver for the dummy insulation monitoring driver
52  *
53  * @details Dummy driver that provides a default resistance and returns that
54  * the measurement is always valid.
55  */
56 
57 /*========== Includes =======================================================*/
58 #include "no-imd.h"
59 
60 #include "database.h"
61 
62 /*========== Macros and Definitions =========================================*/
63 
64 /*========== Static Constant and Variable Definitions =======================*/
65 
66 /*========== Extern Constant and Variable Definitions =======================*/
67 
68 /*========== Static Function Prototypes =====================================*/
69 /** Initialize function */
71 
72 /** Enable IMD function */
74 
75 /**
76  * @brief Function to write dummy values into the database
77  * @param pTableInsulationMonitoring pointer to database entry
78  */
80 
81 /** Enable IMD function */
83 
84 /*========== Static Function Implementations ================================*/
87 }
88 
90  return IMD_FSM_STATE_RUNNING;
91 }
92 
94  pTableInsulationMonitoring->isInsulationMeasurementValid = true;
95  pTableInsulationMonitoring->areDeviceFlagsValid = true;
96  pTableInsulationMonitoring->insulationResistance_kOhm = 1000u;
97  pTableInsulationMonitoring->dfIsCriticalResistanceDetected = false;
98  pTableInsulationMonitoring->dfIsChassisFaultDetected = false;
99  pTableInsulationMonitoring->dfIsDeviceErrorDetected = false;
100  pTableInsulationMonitoring->dfIsWarnableResistanceDetected = false;
101  return IMD_FSM_STATE_RUNNING;
102 }
103 
106 }
107 
108 /*========== Extern Function Implementations ================================*/
110  return NOIMD_Initialize();
111 }
112 
114  return NOIMD_EnableImd();
115 }
116 
118  FAS_ASSERT(pTableInsulationMonitoring != NULL_PTR);
119  return NOIMD_MeasureInsulation(pTableInsulationMonitoring);
120 }
121 
123  return NOIMD_DisableImd();
124 }
125 
126 /*========== Externalized Static Function Implementations (Unit Test) =======*/
127 #ifdef UNITY_UNIT_TEST
128 extern IMD_FSM_STATES_e TEST_NOIMD_Initialize(void) {
129  return NOIMD_Initialize();
130 }
131 extern IMD_FSM_STATES_e TEST_NOIMD_EnableImd(void) {
132  return NOIMD_EnableImd();
133 }
134 extern IMD_FSM_STATES_e TEST_NOIMD_MeasureInsulation(DATA_BLOCK_INSULATION_MONITORING_s *pTableInsulationMonitoring) {
135  return NOIMD_MeasureInsulation(pTableInsulationMonitoring);
136 }
137 extern IMD_FSM_STATES_e TEST_NOIMD_DisableImd(void) {
138  return NOIMD_DisableImd();
139 }
140 #endif
Database module header.
#define FAS_ASSERT(x)
Assertion macro that asserts that x is true.
Definition: fassert.h:252
#define NULL_PTR
Null pointer.
Definition: fstd_types.h:76
IMD_FSM_STATES_e
Definition: imd.h:92
@ IMD_FSM_STATE_RUNNING
Definition: imd.h:99
@ IMD_FSM_STATE_IMD_ENABLE
Definition: imd.h:97
static IMD_FSM_STATES_e NOIMD_Initialize(void)
Definition: no-imd.c:85
IMD_FSM_STATES_e IMD_ProcessInitializationState(void)
Processes the initialization state.
Definition: no-imd.c:109
IMD_FSM_STATES_e IMD_ProcessShutdownState(void)
Processes the shutdown state.
Definition: no-imd.c:122
IMD_FSM_STATES_e IMD_ProcessEnableState(void)
Processes the IMD enable state.
Definition: no-imd.c:113
static IMD_FSM_STATES_e NOIMD_EnableImd(void)
Definition: no-imd.c:89
static IMD_FSM_STATES_e NOIMD_MeasureInsulation(DATA_BLOCK_INSULATION_MONITORING_s *pTableInsulationMonitoring)
Function to write dummy values into the database.
Definition: no-imd.c:93
static IMD_FSM_STATES_e NOIMD_DisableImd(void)
Definition: no-imd.c:104
IMD_FSM_STATES_e IMD_ProcessRunningState(DATA_BLOCK_INSULATION_MONITORING_s *pTableInsulationMonitoring)
Processes the running state.
Definition: no-imd.c:117
Header for the driver for the dummy insulation monitoring.