DC2343A  FW 1.0.2 / GUI 1.0.10
LTC3335 Nanopower Buck-Boost DC/DC with Integrated Coulomb Counter
 All Data Structures Namespaces Files Functions Variables Enumerations Macros Pages
Functions | Enumerations | Variables
Package LTC3335

Namespace containing constants and functions for the LTC3335 Nanopower Buck-Boost DC/DC with Integrated Coulomb Counter. More...

Functions

float Get_Vout_V (VOLTAGE_SELECTION_OPTIONS vout)
 Returns the VOUT value in V for a voltage setting. More...
 
int Get_IPeak_MA (LTC3335.IPEAK_SELECTION_OPTIONS ipeak)
 Returns the Ipeak value in mA for an ipeak setting. More...
 
float Get_Charge_Range (LTC3335.IPEAK_SELECTION_OPTIONS ipeak, int prescaler)
 Returns the charge range in Ah for an ipeak setting and prescaler. More...
 
float Get_Charge_Resolution (LTC3335.IPEAK_SELECTION_OPTIONS ipeak, int prescaler)
 Returns the charge resolution in Ah for an ipeak setting and prescaler. More...
 
int Get_Prescaler (LTC3335.IPEAK_SELECTION_OPTIONS ipeak, float capacity, bool use_software_correction=False, double software_correction_factor=0.0)
 Returns the recommended prescaler for an IPEAK setting and a capacity value in Ah. More...
 
float Get_Max_VOUT_Current (LTC3335.IPEAK_SELECTION_OPTIONS ipeak, float vbat, float vout)
 Returns the theoretical maximum output current available for a given IPEAK, VOUT, and VBAT. More...
 
float Convert_Counter_Test_Results (LTC3335.IPEAK_SELECTION_OPTIONS ipeak, float edges_per_sec, bool use_software_correction=False, float software_correction_factor=0.0)
 Converts the LTC3335 Counter Test results in /IRQ edges per second into mA of battery current. More...
 
double Get_Software_Correction_Factor (LTC3335.IPEAK_SELECTION_OPTIONS ipeak, float vout, float vbat)
 Returns typical coulomb count error for a given IPEAK, VOUT, and VBAT. More...
 
double Get_Software_Correction_Factor (LTC3335.IPEAK_SELECTION_OPTIONS ipeak, LTC3335.VOLTAGE_SELECTION_OPTIONS vout_setting, float vbat)
 Returns typical coulomb count error for a given IPEAK, VOUT, and VBAT. More...
 

Enumerations

enum  VOLTAGE_SELECTION_OPTIONS {
  HARDWARE_CONTROL,
  SOFTWARE_CONTROL_1_8V,
  SOFTWARE_CONTROL_2_5V,
  SOFTWARE_CONTROL_2_8V,
  SOFTWARE_CONTROL_3_0V,
  SOFTWARE_CONTROL_3_3V,
  SOFTWARE_CONTROL_3_6V,
  SOFTWARE_CONTROL_4_5V,
  SOFTWARE_CONTROL_5_0V,
  NUM_VOLTAGE_SELECTION_OPTIONS
}
 Voltage Selection Options for the LTC3335 More...
 
enum  IPEAK_SELECTION_OPTIONS {
  IPEAK_5MA,
  IPEAK_10MA,
  IPEAK_15MA,
  IPEAK_25MA,
  IPEAK_50MA,
  IPEAK_100MA,
  IPEAK_150MA,
  IPEAK_250MA,
  NUM_IPEAK_SELECTION_OPTIONS
}
 IPeak Selection Options for the LTC3335 More...
 
enum  EN_CONFIGURATION_OPTIONS {
  EN_CONFIGURATION_ON,
  EN_CONFIGURATION_EXT,
  EN_CONFIGURATION_OFF,
  NUM_EN_CONFIGURATIONS
}
 Possible states of the EN pin on the DC2343A demo board for the LTC3335. More...
 

Variables

double IQ = 0.00000068
 LTC3335 Input Quiescent Current in A More...
 
const float tFS = 0.00001174
 LTC3335 full scale ON time in seconds More...
 
const int PRESCALER_SELECTION_MIN = 0
 Allowable range for the LTC3335 Prescaler. More...
 
const int PRESCALER_SELECTION_MAX = 15
 
string[] IPEAK_INDICIES
 IPEAK Indicies into COULOMB_COUNTER_CORRECTION_TABLE More...
 
float[] VOUT_INDICIES
 VOUT Indicies into COULOMB_COUNTER_CORRECTION_TABLE More...
 
float[] VBAT_INDICIES
 VBAT Indicies into COULOMB_COUNTER_CORRECTION_TABLE More...
 
double[] COULOMB_COUNTER_CORRECTION_TABLE
 TYP Coulomb Counter Error for a given IPEAK, VOUT, and VBAT as shown in Datasheet Figures G37 - G44 More...
 

Detailed Description

Namespace containing constants and functions for the LTC3335 Nanopower Buck-Boost DC/DC with Integrated Coulomb Counter.

Implements ISample

Function Documentation

float LTC3335.Convert_Counter_Test_Results ( LTC3335.IPEAK_SELECTION_OPTIONS  ipeak,
float  edges_per_sec,
bool  use_software_correction = False,
float  software_correction_factor = 0.0 
)

Converts the LTC3335 Counter Test results in /IRQ edges per second into mA of battery current.

Parameters
ipeakAn option from the IPEAK_SELECTION_OPTIONS enum.
edges_per_secThe number of rising edges of /IRQ per second when the LTC3335 Counter Test is active.
use_software_correctionTrue is the prescaler should be selected assuming software correction will be used.
software_correction_factorThe software correction factor that will be used if use_software_correction is True.
Returns
The estimated battery current in mA.
float LTC3335.Get_Charge_Range ( LTC3335.IPEAK_SELECTION_OPTIONS  ipeak,
int  prescaler 
)

Returns the charge range in Ah for an ipeak setting and prescaler.

Parameters
ipeakAn option from the IPEAK_SELECTION_OPTIONS enum.
prescalerThe value of the prescaler.
Returns
The range of the Accumulator in Ah.
float LTC3335.Get_Charge_Resolution ( LTC3335.IPEAK_SELECTION_OPTIONS  ipeak,
int  prescaler 
)

Returns the charge resolution in Ah for an ipeak setting and prescaler.

Parameters
ipeakAn option from the IPEAK_SELECTION_OPTIONS enum.
prescalerThe value of the prescaler.
Returns
The resolution of the Accumulator in Ah.
int LTC3335.Get_IPeak_MA ( LTC3335.IPEAK_SELECTION_OPTIONS  ipeak)

Returns the Ipeak value in mA for an ipeak setting.

Parameters
ipeakAn option from the IPEAK_SELECTION_OPTIONS enum.
Returns
The IPEAK value in mA.
float LTC3335.Get_Max_VOUT_Current ( LTC3335.IPEAK_SELECTION_OPTIONS  ipeak,
float  vbat,
float  vout 
)

Returns the theoretical maximum output current available for a given IPEAK, VOUT, and VBAT.

Parameters
ipeakAn option from the IPEAK_SELECTION_OPTIONS enum.
vbatThe battery voltage in V.
voutThe output voltage in V.
Returns
The theoretical maximum output current available from the LTC3335.
int LTC3335.Get_Prescaler ( LTC3335.IPEAK_SELECTION_OPTIONS  ipeak,
float  capacity,
bool  use_software_correction = False,
double  software_correction_factor = 0.0 
)

Returns the recommended prescaler for an IPEAK setting and a capacity value in Ah.

Parameters
ipeakAn option from the IPEAK_SELECTION_OPTIONS enum.
capacityThe battery capacity in Ah.
use_software_correctionTrue is the prescaler should be selected assuming software correction will be used.
software_correction_factorThe software correction factor that will be used if use_software_correction is True.
Returns
The recommended prescaler for the LTC3335.
double LTC3335.Get_Software_Correction_Factor ( LTC3335.IPEAK_SELECTION_OPTIONS  ipeak,
float  vout,
float  vbat 
)

Returns typical coulomb count error for a given IPEAK, VOUT, and VBAT.

Parameters
ipeakAn option from the IPEAK_SELECTION_OPTIONS enum.
vbatThe battery voltage in V.
voutThe output voltage in V.
Returns
The typical error which can be used to correct the coulomb count in software.
double LTC3335.Get_Software_Correction_Factor ( LTC3335.IPEAK_SELECTION_OPTIONS  ipeak,
LTC3335.VOLTAGE_SELECTION_OPTIONS  vout_setting,
float  vbat 
)

Returns typical coulomb count error for a given IPEAK, VOUT, and VBAT.

Parameters
ipeakAn option from the IPEAK_SELECTION_OPTIONS enum.
vout_settingAn option from the VOLTAGE_SELECTION_OPTIONS enum.
voutThe output voltage in V.
Returns
The typical error which can be used to correct the coulomb count in software.
float LTC3335.Get_Vout_V ( VOLTAGE_SELECTION_OPTIONS  vout)

Returns the VOUT value in V for a voltage setting.

Parameters
voutAn option from the VOLTAGE_SELECTION_OPTIONS enum.
Returns
The output voltage in Volts.

Enumeration Type Documentation

Possible states of the EN pin on the DC2343A demo board for the LTC3335.

Definition at line 78 of file LTC3335.vb.

IPeak Selection Options for the LTC3335

Definition at line 61 of file LTC3335.vb.

Voltage Selection Options for the LTC3335

Definition at line 43 of file LTC3335.vb.

Variable Documentation

double [] LTC3335.COULOMB_COUNTER_CORRECTION_TABLE

TYP Coulomb Counter Error for a given IPEAK, VOUT, and VBAT as shown in Datasheet Figures G37 - G44

Typ_Error_Curves.png

Definition at line 186 of file LTC3335.vb.

string [] LTC3335.IPEAK_INDICIES

IPEAK Indicies into COULOMB_COUNTER_CORRECTION_TABLE

Definition at line 164 of file LTC3335.vb.

double LTC3335.IQ = 0.00000068

LTC3335 Input Quiescent Current in A

Definition at line 31 of file LTC3335.vb.

const int LTC3335.PRESCALER_SELECTION_MIN = 0

Allowable range for the LTC3335 Prescaler.

Definition at line 90 of file LTC3335.vb.

const float LTC3335.tFS = 0.00001174

LTC3335 full scale ON time in seconds

Definition at line 37 of file LTC3335.vb.

float [] LTC3335.VBAT_INDICIES

VBAT Indicies into COULOMB_COUNTER_CORRECTION_TABLE

Definition at line 178 of file LTC3335.vb.

float [] LTC3335.VOUT_INDICIES

VOUT Indicies into COULOMB_COUNTER_CORRECTION_TABLE

Definition at line 171 of file LTC3335.vb.