foxBMS  1.1.2
The foxBMS Battery Management System API Documentation
masterinfo.h File Reference

General foxBMS-master system information. More...

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

Go to the source code of this file.

Data Structures

struct  MINFO_MASTER_STATE
 state of the system More...
 

Typedefs

typedef enum MINFO_DEBUG_PROBE_CONNECTION_STATE MINFO_DEBUG_PROBE_CONNECTION_STATE_e
 
typedef struct MINFO_MASTER_STATE MINFO_MASTER_STATE_s
 state of the system More...
 

Enumerations

enum  MINFO_DEBUG_PROBE_CONNECTION_STATE { MINFO_DEBUG_PROBE_NOT_CONNECTED , MINFO_DEBUG_PROBE_CONNECTED }
 

Functions

void MINFO_SetResetSource (resetSource_t resetSource)
 Set reason for last reset. More...
 
resetSource_t MINFO_GetResetSource (void)
 Get reason for last reset. More...
 
void MINFO_SetDebugProbeConnectionState (MINFO_DEBUG_PROBE_CONNECTION_STATE_e state)
 Check if debug probe is connected. More...
 
MINFO_DEBUG_PROBE_CONNECTION_STATE_e MINFO_GetDebugProbeConnectionState (void)
 Get state if debugger is connected or not. More...
 

Detailed Description

General foxBMS-master system information.

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-07-08 (date of creation)
Updated
2020-07-08 (date of last update)
Prefix
MINFO

Header file for the implementation to gather information on the foxBMS-Master and its connected peripherals on the master PCB.

Definition in file masterinfo.h.

Typedef Documentation

◆ MINFO_DEBUG_PROBE_CONNECTION_STATE_e

values describing the connection state of the debug probe

◆ MINFO_MASTER_STATE_s

state of the system

This currently describes the source of the last reset and whether a debug probe is attached or not.

Enumeration Type Documentation

◆ MINFO_DEBUG_PROBE_CONNECTION_STATE

values describing the connection state of the debug probe

Enumerator
MINFO_DEBUG_PROBE_NOT_CONNECTED 

no debug probe connected

MINFO_DEBUG_PROBE_CONNECTED 

debug probe connected

Definition at line 65 of file masterinfo.h.

Function Documentation

◆ MINFO_GetDebugProbeConnectionState()

MINFO_DEBUG_PROBE_CONNECTION_STATE_e MINFO_GetDebugProbeConnectionState ( void  )

Get state if debugger is connected or not.

Returns
MINFO_DEBUG_PROBE_CONNECTION_STATE_e if debugger connected or not

Definition at line 91 of file masterinfo.c.

◆ MINFO_GetResetSource()

resetSource_t MINFO_GetResetSource ( void  )

Get reason for last reset.

Returns
returns reset reason

Definition at line 83 of file masterinfo.c.

◆ MINFO_SetDebugProbeConnectionState()

void MINFO_SetDebugProbeConnectionState ( MINFO_DEBUG_PROBE_CONNECTION_STATE_e  state)

Check if debug probe is connected.

Definition at line 87 of file masterinfo.c.

◆ MINFO_SetResetSource()

void MINFO_SetResetSource ( resetSource_t  resetSource)

Set reason for last reset.

Parameters
[in]resetSourcesource of last reset

Definition at line 78 of file masterinfo.c.