foxBMS  1.2.0
The foxBMS Battery Management System API Documentation
Enums definition

Enumerations

enum  fs8x_reg_output_t {
  fs8xBuck1 = 4 , fs8xBuck2 = 3 , fs8xBuck3 = 2 , fs8xLdo1 = 1 ,
  fs8xLdo2 = 0 , fs8xVBoost = 5 , fs8xVPre = 6
}
 Voltage outputs. Can be used with function FS8x_SetRegulatorState(). More...
 
enum  fs8x_amux_selection_t {
  fs8xAmuxGnd = FS8X_M_AMUX_GND , fs8xAmuxVddio = FS8X_M_AMUX_VDDIO , fs8xAmuxTempSensor = FS8X_M_AMUX_TEMPERATURE_SENSOR , fs8xAmuxBandgapMain = FS8X_M_AMUX_BAND_GAP_MAIN ,
  fs8xAmuxBandgapFailSafe = FS8X_M_AMUX_BAND_GAP_FAIL_SAFE , fs8xAmuxVbuck1Volt = FS8X_M_AMUX_VBUCK1_VOLTAGE , fs8xAmuxVbuck2Volt = FS8X_M_AMUX_VBUCK2_VOLTAGE , fs8xAmuxVbuck3VoltDiv2_5 = FS8X_M_AMUX_VBUCK3_VOLTAGE_DIVIDED ,
  fs8xAmuxVpreVoltDiv2_5 = FS8X_M_AMUX_VPRE_VOLTAGE_DIVIDED , fs8xAmuxVboostVoltDiv2_5 = FS8X_M_AMUX_VBOOST_VOLTAGE_DIVIDED , fs8xAmuxVldo1VoltDiv2_5 = FS8X_M_AMUX_VLDO1_VOLTAGE_DIVIDED , fs8xAmuxVldo2VoltDiv2_5 = FS8X_M_AMUX_VLDO2_VOLTAGE_DIVIDED ,
  fs8xAmuxVbosVoltDiv2_5 = FS8X_M_AMUX_VBOS_VOLTAGE_DIVIDED , fs8xAmuxVsup1VoltDiv7_5 = FS8X_M_AMUX_VSUP1_VOLTAGE_DIVIDED , fs8xAmuxWake1VoltDiv7_5 = FS8X_M_AMUX_WAKE1_VOLTAGE_DIVIDED , fs8xAmuxWake2VoltDiv7_5 = FS8X_M_AMUX_WAKE2_VOLTAGE_DIVIDED ,
  fs8xAmuxVana = FS8X_M_AMUX_VANA , fs8xAmuxVdig = FS8X_M_AMUX_VDIG , fs8xAmuxVdigFs = FS8X_M_AMUX_VDIG_FS , fs8xAmuxPsync = FS8X_M_AMUX_PSYNC_VOLTAGE ,
  fs8xAmuxVsup1VoltDiv14 = FS8X_M_RATIO_RATIO_14 | FS8X_M_AMUX_VSUP1_VOLTAGE_DIVIDED , fs8xAmuxWake1VoltDiv14 = FS8X_M_RATIO_RATIO_14 | FS8X_M_AMUX_WAKE1_VOLTAGE_DIVIDED , fs8xAmuxWake2VoltDiv14 = FS8X_M_RATIO_RATIO_14 | FS8X_M_AMUX_WAKE2_VOLTAGE_DIVIDED
}
 
enum  fs8x_status_t { fs8xStatusOk = 0U , fs8xStatusError = 1U }
 Status return codes. More...
 
enum  fs8x_commType_t { fs8xSPI = 0 , fs8xI2C = 1 }
 Actually selected communication type (SPI or I2C). More...
 
enum  fs8x_command_type_t { fs8xRegRead , fs8xRegWrite }
 Command type. More...
 

Detailed Description

Enumeration Type Documentation

◆ fs8x_amux_selection_t

AMUX channel selection. Can be used with function FS8x_SwitchAMUXchannel().

Enumerator
fs8xAmuxGnd 

GND

fs8xAmuxVddio 

VDDIO

fs8xAmuxTempSensor 

Temperature sensor

fs8xAmuxBandgapMain 

Main Bandgap

fs8xAmuxBandgapFailSafe 

Fail-safe bandgap

fs8xAmuxVbuck1Volt 

BUCK1

fs8xAmuxVbuck2Volt 

BUCK2

fs8xAmuxVbuck3VoltDiv2_5 

BUCK3 divided by 2.5

fs8xAmuxVpreVoltDiv2_5 

VPRE divided by 2.5

fs8xAmuxVboostVoltDiv2_5 

VBOOST divided by 2.5

fs8xAmuxVldo1VoltDiv2_5 

VLDO1 divided by 2.5

fs8xAmuxVldo2VoltDiv2_5 

VLDO2 divided by 2.5

fs8xAmuxVbosVoltDiv2_5 

VBOS divided by 2.5

fs8xAmuxVsup1VoltDiv7_5 

VSUP1 divided by 7.5

fs8xAmuxWake1VoltDiv7_5 

WAKE1 divided by 7.5

fs8xAmuxWake2VoltDiv7_5 

WAKE2 divided by 7.5

fs8xAmuxVana 

Vana

fs8xAmuxVdig 

Vdig

fs8xAmuxVdigFs 

Vdig_fs

fs8xAmuxPsync 

PSYNC

fs8xAmuxVsup1VoltDiv14 

VSUP1 divided by 14

fs8xAmuxWake1VoltDiv14 

WAKE1 divided by 14

fs8xAmuxWake2VoltDiv14 

WAKE2 divided by 14

Definition at line 76 of file sbc_fs8x.h.

◆ fs8x_command_type_t

Command type.

Enumerator
fs8xRegRead 

Register Read

fs8xRegWrite 

Register Write

Definition at line 107 of file sbc_fs8x_common.h.

◆ fs8x_commType_t

Actually selected communication type (SPI or I2C).

Note that the value of FS8x_COMM_TYPE define should match selected value.

Enumerator
fs8xSPI 

SPI

fs8xI2C 

I2C

Definition at line 100 of file sbc_fs8x_common.h.

◆ fs8x_reg_output_t

Voltage outputs. Can be used with function FS8x_SetRegulatorState().

Enumerator
fs8xBuck1 

BUCK1

fs8xBuck2 

BUCK2

fs8xBuck3 

BUCK3

fs8xLdo1 

LDO1

fs8xLdo2 

LDO2

fs8xVBoost 

VBOOST

fs8xVPre 

VPRE

Definition at line 64 of file sbc_fs8x.h.

◆ fs8x_status_t

Status return codes.

Enumerator
fs8xStatusOk 

No error.

fs8xStatusError 

Error.

Definition at line 91 of file sbc_fs8x_common.h.