foxBMS
1.1.1
The foxBMS Battery Management System API Documentation
|
Headers for the driver for the LTC monitoring chip. More...
#include "ltc_defs.h"
Go to the source code of this file.
Functions | |
void | LTC_Trigger (LTC_STATE_s *ltc_state) |
trigger function for the LTC driver state machine. More... | |
LTC_RETURN_TYPE_e | LTC_SetStateRequest (LTC_STATE_s *ltc_state, LTC_REQUEST_s statereq) |
sets the current state request of the state variable ltc_state. More... | |
bool | LTC_IsFirstMeasurementCycleFinished (LTC_STATE_s *ltc_state) |
gets the measurement initialization status. More... | |
void | LTC_SaveVoltages (LTC_STATE_s *ltc_state, uint8_t stringNumber) |
stores the measured voltages in the database. More... | |
void | LTC_SaveTemperatures (LTC_STATE_s *ltc_state, uint8_t stringNumber) |
stores the measured temperatures and the measured multiplexer feedbacks in the database. More... | |
void | LTC_SaveAllGPIOMeasurement (LTC_STATE_s *ltc_state) |
stores the measured GPIOs in the database. More... | |
LTC_REQUEST_s | LTC_GetStateRequest (LTC_STATE_s *ltc_state) |
gets the current state request. More... | |
LTC_STATEMACH_e | LTC_GetState (LTC_STATE_s *ltc_state) |
gets the current state. More... | |
void | LTC_monitoringPinInit (void) |
Sets the transceiver pins to enable LTC6820 IC. More... | |
Variables | |
LTC_STATE_s | ltc_stateBase |
Headers for the driver for the LTC monitoring chip.
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:
Definition in file ltc.h.
LTC_STATEMACH_e LTC_GetState | ( | LTC_STATE_s * | ltc_state | ) |
gets the current state.
This function is used in the functioning of the LTC state machine.
ltc_state | state of the ltc state machine |
Definition at line 572 of file ltc_6806.c.
LTC_REQUEST_s LTC_GetStateRequest | ( | LTC_STATE_s * | ltc_state | ) |
gets the current state request.
This function is used in the functioning of the LTC state machine.
ltc_state | state of the ltc state machine |
Definition at line 552 of file ltc_6806.c.
bool LTC_IsFirstMeasurementCycleFinished | ( | LTC_STATE_s * | ltc_state | ) |
gets the measurement initialization status.
ltc_state | state of the ltc state machine |
Definition at line 1733 of file ltc_6806.c.
void LTC_monitoringPinInit | ( | void | ) |
Sets the transceiver pins to enable LTC6820 IC.
Definition at line 1752 of file ltc_6806.c.
void LTC_SaveAllGPIOMeasurement | ( | LTC_STATE_s * | ltc_state | ) |
stores the measured GPIOs in the database.
This function loops through the data of all modules in the LTC daisy-chain that are stored in the ltc_allgpiovoltage buffer and writes them in the database. At each write iteration, the variable named "state" and related to voltages in the database is incremented.
ltc_state | state of the ltc state machine |
Definition at line 511 of file ltc_6806.c.
void LTC_SaveTemperatures | ( | LTC_STATE_s * | ltc_state, |
uint8_t | stringNumber | ||
) |
stores the measured temperatures and the measured multiplexer feedbacks in the database.
This function loops through the temperature and multiplexer feedback data of all modules in the LTC daisy-chain that are stored in the LTC_MultiplexerVoltages buffer and writes them in the database. At each write iteration, the variables named "state" and related to temperatures and multiplexer feedbacks in the database are incremented.
ltc_state | state of the ltc state machine |
stringNumber | string addressed |
Definition at line 463 of file ltc_6806.c.
void LTC_SaveVoltages | ( | LTC_STATE_s * | ltc_state, |
uint8_t | stringNumber | ||
) |
stores the measured voltages in the database.
This function loops through the data of all modules in the LTC daisy-chain that are stored in the LTC_CellVoltages buffer and writes them in the database. At each write iteration, the variable named "state" and related to voltages in the database is incremented.
ltc_state | state of the ltc state machine |
stringNumber | string addressed |
Definition at line 402 of file ltc_6806.c.
LTC_RETURN_TYPE_e LTC_SetStateRequest | ( | LTC_STATE_s * | ltc_state, |
LTC_REQUEST_s | statereq | ||
) |
sets the current state request of the state variable ltc_state.
This function is used to make a state request to the state machine,e.g, start voltage measurement, read result of voltage measurement, re-initialization It calls LTC_CheckStateRequest() to check if the request is valid. The state request is rejected if is not valid. The result of the check is returned immediately, so that the requester can act in case it made a non-valid state request.
ltc_state | state of the ltc state machine |
statereq | state request to set |
Definition at line 610 of file ltc_6806.c.
void LTC_Trigger | ( | LTC_STATE_s * | ltc_state | ) |
trigger function for the LTC driver state machine.
This function contains the sequence of events in the LTC state machine. It must be called time-triggered, every 1ms.
Definition at line 625 of file ltc_6806.c.
|
extern |
This variable contains the internal state of the LTC state machine.
Definition at line 147 of file ltc_6806.c.