Jump to content

Component: Battery Cell Fuel Gauge (MAX1704x) (Electrical): Difference between revisions

From Flowcode Help

SteveT (talk | contribs)

4 user groups
6,422 edits
Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix TSL |- | width="20%" style="color:gray;" | Version | 1.0 |- | width="20%" style="color:gray..."
 
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(5 intermediate revisions by the same user not shown)
Line 26: Line 26:


===ClearAlert===
===ClearAlert===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ClearAlert'''
| width="90%" class="mtx-class-macrohead" | '''ClearAlert'''
|-
|-
| colspan="2" | Clears the alert status bit, if the voltage is still below the specified threshold level then the  alert interrupt pin will fire again. 
| colspan="2" | Clears the alert status bit, if the voltage is still below the specified threshold level then the  alert interrupt pin will fire again. 
Line 40: Line 40:


===Initialise===
===Initialise===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
| width="90%" class="mtx-class-macrohead" | '''Initialise'''
|-
|-
| colspan="2" | Configures the I2C bus ready for communications and applies the settings defined in the properties. Also sets the default power level to awake. Returns 1 if the module is detected 0 if the module is not found 
| colspan="2" | Configures the I2C bus ready for communications and applies the settings defined in the properties. Also sets the default power level to awake. Returns 1 if the module is detected 0 if the module is not found 
Line 54: Line 54:


===ReadStateOfCharge===
===ReadStateOfCharge===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadStateOfCharge'''
| width="90%" class="mtx-class-macrohead" | '''ReadStateOfCharge'''
|-
|-
| colspan="2" | Reads the SOC and returns as a floating point value in % between 0 and 100 
| colspan="2" | Reads the SOC and returns as a floating point value in % between 0 and 100 
Line 68: Line 68:


===ReadStateOfChargeByte===
===ReadStateOfChargeByte===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadStateOfChargeByte'''
| width="90%" class="mtx-class-macrohead" | '''ReadStateOfChargeByte'''
|-
|-
| colspan="2" | Reads the SOC and returns as a byte value in % between 0 and 100 
| colspan="2" | Reads the SOC and returns as a byte value in % between 0 and 100 
Line 82: Line 82:


===ReadVoltage===
===ReadVoltage===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadVoltage'''
| width="90%" class="mtx-class-macrohead" | '''ReadVoltage'''
|-
|-
| colspan="2" | Reads the voltage and returns as a floating point value in Volts. 
| colspan="2" | Reads the voltage and returns as a floating point value in Volts. 
Line 96: Line 96:


===SetPowerMode===
===SetPowerMode===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetPowerMode'''
| width="90%" class="mtx-class-macrohead" | '''SetPowerMode'''
|-
|-
| colspan="2" | Allows the device to be put to sleep and woken from sleep. 
| colspan="2" | Allows the device to be put to sleep and woken from sleep. 
Line 116: Line 116:
==Property reference==
==Property reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
| width="90%" class="mtx-class-macrohead" | '''Properties'''  
|-
|-
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Settings
| width="90%" class="mtx-class-propfolder" | Settings
|-
|-
|-
|-
Line 146: Line 146:
| colspan="2" | Specific to the lithium charcteristics of the cell. 0x97 is the default value. 
| colspan="2" | Specific to the lithium charcteristics of the cell. 0x97 is the default value. 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | I2C Settings
| width="90%" class="mtx-class-propfolder" | I2C Settings
|-
|-
|-
|-
Line 165: Line 165:
| colspan="2" | Baud rate to be used 
| colspan="2" | Baud rate to be used 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
| width="90%" class="mtx-class-propfolder" | Connections
|-
|-
|-
|-
Line 189: Line 189:
| colspan="2" |  
| colspan="2" |  
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
| width="90%" class="mtx-class-propfolder" | Simulation
|-
|-
|-
|-

Latest revision as of 14:37, 13 July 2026

Author Matrix TSL
Version 1.0
Category Electrical


Battery Cell Fuel Gauge (MAX1704x) component

Provides accurate voltage and state of charge readings for one or two lithium ion cells. Based on the MAX1704x device range including: MAX17043 MAX17044 MAX17048 MAX17049

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

ClearAlert

ClearAlert
Clears the alert status bit, if the voltage is still below the specified threshold level then the alert interrupt pin will fire again. 
- VOID Return


Initialise

Initialise
Configures the I2C bus ready for communications and applies the settings defined in the properties. Also sets the default power level to awake. Returns 1 if the module is detected 0 if the module is not found 
- BYTE Return


ReadStateOfCharge

ReadStateOfCharge
Reads the SOC and returns as a floating point value in % between 0 and 100 
- FLOAT Return


ReadStateOfChargeByte

ReadStateOfChargeByte
Reads the SOC and returns as a byte value in % between 0 and 100 
- BYTE Return


ReadVoltage

ReadVoltage
Reads the voltage and returns as a floating point value in Volts. 
- FLOAT Return


SetPowerMode

SetPowerMode
Allows the device to be put to sleep and woken from sleep. 
- BOOL Mode
0=Awake, 1=Sleep 
- VOID Return


Property reference

Properties
Settings
Cell Count
Set the chip type used to determine if you have 1S or 2S cells connected. 
Voltage Per Bit
 
Alert Threshold
Sets the SOC level where the Alert pin will fire which can be used to trigger an interrupt. Alert status needs to be reset using the ClearAlert component macro. 
Config Value
Specific to the lithium charcteristics of the cell. 0x97 is the default value. 
I2C Settings
Channel
Channel selection 
Baud Select
Baud rate option selector 
Baud Rate
Baud rate to be used 
Connections
SDA
Pin used for SDA (data signal) 
SDA Remap Pin
 
SCL
Pin used for SCL (clock signal) 
SCL Remap Pin
 
Simulation
Sim Comms
 
Scope Traces
Selects if the scope traces are automatically generated or not 
Console Data
Selects if the console data is automatically generated or not 
API
 

Component Source Code

Please click here to download the component source project: FC_Comp_Source_Battery_Cell_Fuel_Gauge_MAX17043_17044.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_Battery_Cell_Fuel_Gauge_MAX17043_17044.fcfx

Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Battery_Cell_Fuel_Gauge_(MAX1704x)_(Electrical)&oldid=48219"