Linduino  1.3.0
Linear Technology Arduino-Compatible Demonstration Board
LT_PMBusDeviceLTM2987 Class Reference

Detailed Description

Definition at line 56 of file LT_PMBusDeviceLTM2987.h.

Inheritance diagram for LT_PMBusDeviceLTM2987:
LT_PMBusDeviceManager LT_PMBusDevice

Public Member Functions

 LT_PMBusDeviceLTM2987 (LT_PMBus *pmbus, uint8_t address)
 
uint32_t getCapabilities ()
 Get the supported capabilities. More...
 
bool hasCapability (uint32_t capability)
 Is/are these capability(s) supported? More...
 
char * getType (void)
 
uint8_t getNumPages (void)
 
void enableFaultLog ()
 Enable the Fault Log. More...
 
void disableFaultLog ()
 Disable the Fault Log. More...
 
bool hasFaultLog ()
 Is there a fault log? More...
 
char * getFaultLog ()
 Get the fault log text (call must free) More...
 
void clearFaultLog ()
 Clear the Fault Log. More...
 
- Public Member Functions inherited from LT_PMBusDeviceManager
 LT_PMBusDeviceManager (LT_PMBus *pmbus, uint8_t address, uint8_t no_pages)
 
void setSpeed (uint32_t speed)
 Set the speed. If > 100000, enable clock stretching. More...
 
LT_PMBusRail ** getRails ()
 Return a list of rails if any page is part of a rail. More...
 
- Public Member Functions inherited from LT_PMBusDevice
virtual ~LT_PMBusDevice ()
 
LT_PMBuspmbus ()
 
LT_SMBussmbus ()
 
void changePMBus (LT_PMBus *pmbus)
 Change the pmbus. More...
 
uint8_t getAddress ()
 Get the address. More...
 
void setPage (uint8_t page)
 
uint32_t getMaxSpeed (void)
 Get the maximum speed the device can communicate with. More...
 
void setVout (float voltage)
 
float readVin (bool polling)
 
float readVout (bool polling)
 
float readIin (bool polling)
 
float readIout (bool polling)
 
float readPin (bool polling)
 
float readPout (bool polling)
 
float readExternalTemperature (bool polling)
 
float readInternalTemperature (bool polling)
 
float readDutyCycle (bool polling)
 
uint16_t readStatusWord ()
 
uint16_t readMfrSpecialId ()
 
void clearFaults ()
 
void marginHigh ()
 
void marginLow ()
 
void marginOff ()
 

Static Public Member Functions

static LT_PMBusDevicedetect (LT_PMBus *pmbus, uint8_t address)
 

Static Public Attributes

static uint32_t cap_
 

Additional Inherited Members

- Protected Member Functions inherited from LT_PMBusDevice
 LT_PMBusDevice (LT_PMBus *pmbus, uint8_t address)
 
void probeSpeed ()
 
- Protected Attributes inherited from LT_PMBusDevice
LT_PMBuspmbus_
 
uint8_t address_
 
uint32_t maxSpeed_
 
uint8_t model_ [9]
 

Member Function Documentation

◆ clearFaultLog()

void LT_PMBusDeviceLTM2987::clearFaultLog ( )
virtual

Clear the Fault Log.

Reimplemented from LT_PMBusDevice.

Definition at line 158 of file LT_PMBusDeviceLTM2987.h.

◆ detect()

static LT_PMBusDevice* LT_PMBusDeviceLTM2987::detect ( LT_PMBus pmbus,
uint8_t  address 
)
static

Definition at line 88 of file LT_PMBusDeviceLTM2987.h.

◆ disableFaultLog()

void LT_PMBusDeviceLTM2987::disableFaultLog ( )
virtual

Disable the Fault Log.

Reimplemented from LT_PMBusDevice.

Definition at line 117 of file LT_PMBusDeviceLTM2987.h.

◆ enableFaultLog()

void LT_PMBusDeviceLTM2987::enableFaultLog ( )
virtual

Enable the Fault Log.

Reimplemented from LT_PMBusDevice.

Definition at line 110 of file LT_PMBusDeviceLTM2987.h.

◆ getCapabilities()

uint32_t LT_PMBusDeviceLTM2987::getCapabilities ( )
virtual

Get the supported capabilities.

Returns
or'd list of capabilities

Implements LT_PMBusDevice.

Definition at line 66 of file LT_PMBusDeviceLTM2987.h.

◆ getFaultLog()

char* LT_PMBusDeviceLTM2987::getFaultLog ( )
virtual

Get the fault log text (call must free)

Returns
text

Reimplemented from LT_PMBusDevice.

Definition at line 139 of file LT_PMBusDeviceLTM2987.h.

◆ getNumPages()

uint8_t LT_PMBusDeviceLTM2987::getNumPages ( void  )
virtual

Implements LT_PMBusDevice.

Definition at line 105 of file LT_PMBusDeviceLTM2987.h.

◆ getType()

char* LT_PMBusDeviceLTM2987::getType ( void  )
virtual

Reimplemented from LT_PMBusDevice.

Definition at line 81 of file LT_PMBusDeviceLTM2987.h.

◆ hasCapability()

bool LT_PMBusDeviceLTM2987::hasCapability ( uint32_t  capability)
virtual

Is/are these capability(s) supported?

Returns
true if yes
Parameters
capabilityList of capabilities

Implements LT_PMBusDevice.

Definition at line 74 of file LT_PMBusDeviceLTM2987.h.

◆ hasFaultLog()

bool LT_PMBusDeviceLTM2987::hasFaultLog ( )
virtual

Is there a fault log?

Returns
true/false

Reimplemented from LT_PMBusDevice.

Definition at line 124 of file LT_PMBusDeviceLTM2987.h.

Constructor & Destructor Documentation

◆ LT_PMBusDeviceLTM2987()

LT_PMBusDeviceLTM2987::LT_PMBusDeviceLTM2987 ( LT_PMBus pmbus,
uint8_t  address 
)

Definition at line 62 of file LT_PMBusDeviceLTM2987.h.

Field Documentation

◆ cap_

uint32_t LT_PMBusDeviceLTM2987::cap_
static
Initial value:

Definition at line 60 of file LT_PMBusDeviceLTM2987.h.


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