foxBMS-UnitTests  1.0.1
The foxBMS Unit Tests API Documentation
meas.h File Reference

Headers for the driver for the measurements needed by the BMS (e.g., I,V,T). More...

#include "general.h"
Include dependency graph for meas.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

STD_RETURN_TYPE_e MEAS_Initialize (void)
 
void MEAS_Control (void)
 Control function that is called from the task every 1ms. More...
 
bool MEAS_IsFirstMeasurementCycleFinished (void)
 Checks if the first MIC measurement cycle was made. More...
 
STD_RETURN_TYPE_e MEAS_StartMeasurement (void)
 Makes the initialization request to the MIC state machine. More...
 
STD_RETURN_TYPE_e MEAS_RequestIoWrite (uint8_t string)
 Makes the request to the MIC state machine to write to the IO port-expander. More...
 
STD_RETURN_TYPE_e MEAS_RequestIoRead (uint8_t string)
 Makes the request to the MIC state machine to read from the IO port-expander. More...
 
STD_RETURN_TYPE_e MEAS_RequestTemperatureRead (uint8_t string)
 Makes the request to the MIC state machine to read from the external temperature sensor on slaves. More...
 
STD_RETURN_TYPE_e MEAS_RequestBalancingFeedbackRead (uint8_t string)
 Makes the request to the MIC state machine to read balancing feedback from the slaves. More...
 
STD_RETURN_TYPE_e MEAS_RequestEepromRead (uint8_t string)
 Makes the request to the MIC state machine to read from the external EEPROM on slaves. More...
 
STD_RETURN_TYPE_e MEAS_RequestEepromWrite (uint8_t string)
 Makes the request to the MIC state machine to write to the external EEPROM on slaves. More...
 
STD_RETURN_TYPE_e MEAS_RequestOpenWireCheck (uint8_t string)
 Makes the request to the MIC state machine to perform open-wire check. More...
 

Detailed Description

Headers for the driver for the measurements needed by the BMS (e.g., I,V,T).

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
2020-02-24 (date of creation)
Updated
2021-03-24 (date of last update)
Prefix
MEAS

TODO

Definition in file meas.h.

Function Documentation

◆ MEAS_Control()

void MEAS_Control ( void  )

Control function that is called from the task every 1ms.

This control function or tick function is called every 1ms from the tasks. It calls the tick, trigger or control functions of the state machines belonging to the measurement module.

Definition at line 73 of file meas.c.

Here is the call graph for this function:

◆ MEAS_Initialize()

STD_RETURN_TYPE_e MEAS_Initialize ( void  )

Calls all initialization functions.

Definition at line 115 of file meas.c.

Here is the call graph for this function:

◆ MEAS_IsFirstMeasurementCycleFinished()

bool MEAS_IsFirstMeasurementCycleFinished ( void  )

Checks if the first MIC measurement cycle was made.

Returns
true if the first measurement cycle was made, false otherwise

Definition at line 107 of file meas.c.

Here is the call graph for this function:

◆ MEAS_RequestBalancingFeedbackRead()

STD_RETURN_TYPE_e MEAS_RequestBalancingFeedbackRead ( uint8_t  string)

Makes the request to the MIC state machine to read balancing feedback from the slaves.

Parameters
stringstring addressed by the request

Definition at line 92 of file meas.c.

Here is the call graph for this function:

◆ MEAS_RequestEepromRead()

STD_RETURN_TYPE_e MEAS_RequestEepromRead ( uint8_t  string)

Makes the request to the MIC state machine to read from the external EEPROM on slaves.

Parameters
stringstring addressed by the request

Definition at line 97 of file meas.c.

Here is the call graph for this function:

◆ MEAS_RequestEepromWrite()

STD_RETURN_TYPE_e MEAS_RequestEepromWrite ( uint8_t  string)

Makes the request to the MIC state machine to write to the external EEPROM on slaves.

Parameters
stringstring addressed by the request

Definition at line 102 of file meas.c.

Here is the call graph for this function:

◆ MEAS_RequestIoRead()

STD_RETURN_TYPE_e MEAS_RequestIoRead ( uint8_t  string)

Makes the request to the MIC state machine to read from the IO port-expander.

Parameters
stringstring addressed by the request

Definition at line 82 of file meas.c.

Here is the call graph for this function:

◆ MEAS_RequestIoWrite()

STD_RETURN_TYPE_e MEAS_RequestIoWrite ( uint8_t  string)

Makes the request to the MIC state machine to write to the IO port-expander.

Parameters
stringstring addressed by the request

Definition at line 77 of file meas.c.

Here is the call graph for this function:

◆ MEAS_RequestOpenWireCheck()

STD_RETURN_TYPE_e MEAS_RequestOpenWireCheck ( uint8_t  string)

Makes the request to the MIC state machine to perform open-wire check.

Parameters
stringstring addressed by the request

Definition at line 119 of file meas.c.

Here is the call graph for this function:

◆ MEAS_RequestTemperatureRead()

STD_RETURN_TYPE_e MEAS_RequestTemperatureRead ( uint8_t  string)

Makes the request to the MIC state machine to read from the external temperature sensor on slaves.

Parameters
stringstring addressed by the request

Definition at line 87 of file meas.c.

Here is the call graph for this function:

◆ MEAS_StartMeasurement()

STD_RETURN_TYPE_e MEAS_StartMeasurement ( void  )

Makes the initialization request to the MIC state machine.

Definition at line 111 of file meas.c.

Here is the call graph for this function: