led.h File Reference

Header file of the debug LED driver. More...

#include "general.h"

Include dependency graph for led.h:

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

Go to the source code of this file.

Macros
#define	LED_NORMAL_OPERATION_ON_OFF_TIME_ms   (500u)
#define	LED_ERROR_OPERATION_ON_OFF_TIME_ms   (100u)

Functions
void	LED_SetDebugLED (void)
	Turn debug LED on. More...
void	LED_Trigger (void)
	Trigger function to periodically toggle debug LED. Frequency can be set via function LED_SetToggleTime() More...
void	LED_SetToggleTime (uint32_t onOffTime_ms)
	Set debug LED with defined frequency. More...

Detailed Description

Header file of the debug LED driver.

Copyright

© 2010 - 2021, 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

2021-09-28 (date of creation)

Updated

2021-10-05 (date of last update)

Prefix

LED

This module controls the debug LED that is directly connected to a MCU pin. It is used to indicate basic operation states.

• During startup the LED is enabled continuously.
• Once the startup is complete the LED should be called with LED_SetToggleTime() in order to indicate whether the BMS has started normal operation (LED_NORMAL_OPERATION_ON_OFF_TIME_ms, slow blinking pattern) or if it is in an error state (LED_ERROR_OPERATION_ON_OFF_TIME_ms, fast blinking pattern).
• LED_SetToggleTime() can be called anytime the indicated pattern shall change.

Definition in file led.h.

Macro Definition Documentation

LED_ERROR_OPERATION_ON_OFF_TIME_ms

#define LED_ERROR_OPERATION_ON_OFF_TIME_ms   (100u)

time span to be used with LED_SetToggleTime() indicating an error state

Definition at line 74 of file led.h.

LED_NORMAL_OPERATION_ON_OFF_TIME_ms

#define LED_NORMAL_OPERATION_ON_OFF_TIME_ms   (500u)

time span to be used with LED_SetToggleTime() indicating normal operation

Definition at line 72 of file led.h.

Function Documentation

LED_SetDebugLED()

void LED_SetDebugLED

(

void

)

Turn debug LED on.

This function is intended to be called once during startup before LED_SetToggleTime() is called (after startup).

Definition at line 83 of file led.c.

Here is the call graph for this function:

LED_SetToggleTime()

void LED_SetToggleTime

(

uint32_t

onOffTime_ms

)

Set debug LED with defined frequency.

Parameters

onOffTime_ms

requested time for ON/OFF duration in ms

Definition at line 109 of file led.c.

LED_Trigger()

void LED_Trigger

(

void

)

Trigger function to periodically toggle debug LED. Frequency can be set via function LED_SetToggleTime()

Definition at line 87 of file led.c.

Here is the call graph for this function: