foxBMS
1.2.1
The foxBMS Battery Management System API Documentation
|
Header file of the debug LED driver. More...
#include "general.h"
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... | |
Header file of the debug LED driver.
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:
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 module controls the debug LED that is directly connected to a MCU pin. It is used to indicate basic operation states.
Definition in file led.h.
#define LED_ERROR_OPERATION_ON_OFF_TIME_ms (100u) |
time span to be used with LED_SetToggleTime() indicating an error state
#define LED_NORMAL_OPERATION_ON_OFF_TIME_ms (500u) |
time span to be used with LED_SetToggleTime() indicating normal operation
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.
void LED_SetToggleTime | ( | uint32_t | onOffTime_ms | ) |
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.