foxBMS - Unit Tests  1.2.0
The foxBMS Unit Tests API Documentation
led.c File Reference

Implementation of the debug LED driver. More...

#include "led.h"
#include "ftask_cfg.h"
#include "HL_reg_het.h"
#include "io.h"
Include dependency graph for led.c:

Go to the source code of this file.

Macros

#define LED_PERIODIC_CALL_TIME_ms   (FTSK_TASK_CYCLIC_100MS_CYCLE_TIME)
 
#define LED_PORT   (hetREG1)
 
#define LED_PIN   (1u)
 

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...
 

Variables

uint32_t led_onOffTime_ms = 0u
 

Detailed Description

Implementation 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:

  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

Definition in file led.c.

Macro Definition Documentation

◆ LED_PERIODIC_CALL_TIME_ms

#define LED_PERIODIC_CALL_TIME_ms   (FTSK_TASK_CYCLIC_100MS_CYCLE_TIME)

Periodic call time of function LED_Trigger

Definition at line 65 of file led.c.

◆ LED_PIN

#define LED_PIN   (1u)

Pin of HET1 that the Debug LED is connected to.

Definition at line 70 of file led.c.

◆ LED_PORT

#define LED_PORT   (hetREG1)

HET1 GIO register that the Debug LED is connected to.

Definition at line 68 of file led.c.

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_msrequested 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:

Variable Documentation

◆ led_onOffTime_ms

uint32_t led_onOffTime_ms = 0u

duration of a half a LED blink cycle in ms

Definition at line 74 of file led.c.