| Linduino 1.3.0 Linear Technology Arduino-Compatible Demonstration Board

Data Structures | Public Member Functions | Protected Attributes
LT_3887FaultLog Class Reference

class that handles LTC3887 fault logs. More...

## Detailed Description

class that handles LTC3887 fault logs.

contains structs for interpreting the data read from the part.

Definition at line 61 of file LT_3887FaultLog.h.

Inheritance diagram for LT_3887FaultLog:

## Data Structures
struct | FaultLogLtc3887
struct | FaultLogPreambleLtc3887
struct | FaultLogReadLoopLtc3887
struct | FaultLogTelemetrySummaryLtc3887

## Public Member Functions
| LT_3887FaultLog (LT_PMBus *pmbus)
| Constructor. More...
void | print (Print *printer=0)
| Pretty prints this part's fault log to a Print inheriting object, or Serial if none specified. More...
uint8_t * | getBinary ()
| Get binary of the fault log or NULL if no log. More...
uint16_t | getBinarySize ()
| Get size of binary data. More...
void | dumpBinary (Print *printer=0)
| Dumps binary of the fault log to a Print inheriting object, or Serial if none specified. More...
void | read (uint8_t address)
| Reads the fault log from the specified address, reserves memory to hold the data. More...
struct FaultLogLtc3887 * | get ()
void | release ()
| Frees the memory reserved for the fault log. More...
Public Member Functions inherited from LT_EEDataFaultLog
| LT_EEDataFaultLog (LT_PMBus *pmbus)
void | getNvmBlock (uint8_t address, uint16_t offset, uint16_t numWords, uint8_t command, uint8_t *data)
Public Member Functions inherited from LT_FaultLog
| LT_FaultLog (LT_PMBus *pmbus)
virtual | ~LT_FaultLog ()
bool | hasFaultLog (uint8_t address)
void | enableFaultLog (uint8_t address)
void | disableFaultLog (uint8_t address)
void | clearFaultLog (uint8_t address)
void | dumpBin (Print *printer, uint8_t *log, uint8_t size)
uint64_t | getSharedTime200us (FaultLogTimeStamp time_stamp)
float | getTimeInMs (FaultLogTimeStamp time_stamp)
uint8_t | getRawByteVal (RawByte value)
uint16_t | getRawWordVal (RawWord value)
uint16_t | getRawWordReverseVal (RawWordReverse value)
uint16_t | getLin5_11WordVal (Lin5_11Word value)
uint16_t | getLin5_11WordReverseVal (Lin5_11WordReverse value)
uint16_t | getLin16WordVal (Lin16Word value)
uint16_t | getLin16WordReverseVal (Lin16WordReverse value)

## Protected Attributes
FaultLogLtc3887 * | faultLog3887
Protected Attributes inherited from LT_FaultLog
LT_PMBus * | pmbus_

## Additional Inherited Members
Protected Member Functions inherited from LT_FaultLog
uint8_t | readMfrStatusByte (uint8_t address)
uint8_t | readMfrFaultLogStatusByte (uint8_t address)

## Member Function Documentation

## ◆ dumpBinary()

void LT_3887FaultLog::dumpBinary | ( | Print * | printer = `0` | ) |
| virtual

Dumps binary of the fault log to a Print inheriting object, or Serial if none specified.

Parameters

  printer | Print inheriting object to print the binary to.

Implements LT_FaultLog.

Definition at line 108 of file LT_3887FaultLog.cpp.

## ◆ get()

struct FaultLogLtc3887* LT_3887FaultLog::get | ( |  | ) |

Definition at line 156 of file LT_3887FaultLog.h.

## ◆ getBinary()

uint8_t * LT_3887FaultLog::getBinary | ( |  | ) |
| virtual

Get binary of the fault log or NULL if no log.

Implements LT_FaultLog.

Definition at line 98 of file LT_3887FaultLog.cpp.

## ◆ getBinarySize()

uint16_t LT_3887FaultLog::getBinarySize | ( |  | ) |
| virtual

Get size of binary data.

Implements LT_FaultLog.

Definition at line 103 of file LT_3887FaultLog.cpp.

## ◆ print()

void LT_3887FaultLog::print | ( | Print * | printer = `0` | ) |
| virtual

Pretty prints this part's fault log to a Print inheriting object, or Serial if none specified.

Parameters

  printer | Print inheriting object to print the fault log to.

Implements LT_FaultLog.

Definition at line 113 of file LT_3887FaultLog.cpp.

## ◆ read()

void LT_3887FaultLog::read | ( | uint8_t | address | ) |
| virtual

Reads the fault log from the specified address, reserves memory to hold the data.

Returns
  a reference to the data read from the part.

Parameters

  address | the address to read the fault log from.

Implements LT_FaultLog.

Definition at line 75 of file LT_3887FaultLog.cpp.

## ◆ release()

void LT_3887FaultLog::release | ( |  | ) |
| virtual

Frees the memory reserved for the fault log.

Implements LT_FaultLog.

Definition at line 92 of file LT_3887FaultLog.cpp.

## Constructor & Destructor Documentation

## ◆ LT_3887FaultLog()

LT_3887FaultLog::LT_3887FaultLog | ( | LT_PMBus * | pmbus | ) |

Constructor.

Parameters

  pmbus | pmbus object reference for this fault log handler to use.

Definition at line 61 of file LT_3887FaultLog.cpp.

## Field Documentation

## ◆ faultLog3887

FaultLogLtc3887* LT_3887FaultLog::faultLog3887
| protected

Definition at line 129 of file LT_3887FaultLog.h.

The documentation for this class was generated from the following files:

- LT_3887FaultLog.h
- LT_3887FaultLog.cpp