foxBMS  1.3.0
The foxBMS Battery Management System API Documentation
led.h
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 led.h
44  * @author foxBMS Team
45  * @date 2021-09-28 (date of creation)
46  * @updated 2022-05-30 (date of last update)
47  * @version v1.3.0
48  * @ingroup DRIVERS
49  * @prefix LED
50  *
51  * @brief Header file of the debug LED driver
52  * @details This module controls the debug LED that is directly connected to a
53  * MCU pin. It is used to indicate basic operation states.
54  *
55  * * During startup the LED is enabled continuously.
56  * * Once the startup is complete the LED should be called with
57  * #LED_SetToggleTime() in order to indicate whether the BMS has
58  * started normal operation (#LED_NORMAL_OPERATION_ON_OFF_TIME_ms,
59  * slow blinking pattern) or if it is in an error state
60  * (#LED_ERROR_OPERATION_ON_OFF_TIME_ms, fast blinking pattern).
61  * * #LED_SetToggleTime() can be called anytime the indicated pattern
62  * shall change.
63  */
64 
65 #ifndef FOXBMS__LED_H_
66 #define FOXBMS__LED_H_
67 
68 /*========== Includes =======================================================*/
69 #include "general.h"
70 
71 /*========== Macros and Definitions =========================================*/
72 /** time span to be used with #LED_SetToggleTime() indicating normal operation */
73 #define LED_NORMAL_OPERATION_ON_OFF_TIME_ms (500u)
74 /** time span to be used with #LED_SetToggleTime() indicating an error state */
75 #define LED_ERROR_OPERATION_ON_OFF_TIME_ms (100u)
76 
77 /*========== Extern Constant and Variable Declarations ======================*/
78 
79 /*========== Extern Function Prototypes =====================================*/
80 /**
81  * @brief Turn debug LED on
82  * @details This function is intended to be called once during startup before
83  * #LED_SetToggleTime() is called (after startup).
84  */
85 extern void LED_SetDebugLed(void);
86 
87 /**
88  * @brief Trigger function to periodically toggle debug LED. Frequency can be
89  * set via function #LED_SetToggleTime()
90  */
91 extern void LED_Trigger(void);
92 
93 /**
94  * @brief Set debug LED with defined frequency
95  * @param onOffTime_ms requested time for ON/OFF duration in ms
96  */
97 extern void LED_SetToggleTime(uint32_t onOffTime_ms);
98 
99 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
100 
101 #endif /* FOXBMS__LED_H_ */
General macros and definitions for the whole platform.
void LED_SetToggleTime(uint32_t onOffTime_ms)
Set debug LED with defined frequency.
Definition: led.c:110
void LED_SetDebugLed(void)
Turn debug LED on.
Definition: led.c:84
void LED_Trigger(void)
Trigger function to periodically toggle debug LED. Frequency can be set via function LED_SetToggleTim...
Definition: led.c:88