Critical Link MityCam SoC Firmware  1.0
Critical Link MityCam SoC Firmware
tcPCA9553Status Class Reference

The tcPCA9553Status changes an onboard tri-color LED based on updateStatus() reports. More...

#include <PCA9553Status.h>

Inheritance diagram for tcPCA9553Status:
Collaboration diagram for tcPCA9553Status:

Public Member Functions

 tcPCA9553Status (std::string *apInformation=NULL)
 
virtual ~tcPCA9553Status ()
 
virtual void updateStatus (teStatus aeStatus, const char *apMessage) override
 
virtual void disableIndicators (bool abDisable) override
 Turn on/off the attached Tri-Color LED. More...
 
- Public Member Functions inherited from tcStatusReporter
 tcStatusReporter ()
 
virtual ~tcStatusReporter ()
 
virtual void updateStatus (teStatus aeStatus, const char *apMessage)=0
 

Additional Inherited Members

- Public Types inherited from tcStatusReporter
enum  teStatus {
  eeCapturingStart, eeCapturingEnd, eeGood, eeWarning,
  eeError, eeClear, eeInfo
}
 
- Static Public Member Functions inherited from tcStatusReporter
static void UpdateStatus (teStatus aeStatus, const char *apMessage)
 
static void DisableIndicators (bool abDisable)
 
- Protected Member Functions inherited from tcStatusReporter
const char * statusToString (teStatus aeStatus)
 
- Static Protected Attributes inherited from tcStatusReporter
static std::list< tcStatusReporter * > mcReporters
 

Detailed Description

The tcPCA9553Status changes an onboard tri-color LED based on updateStatus() reports.

The tcPCA9553Status will control a tri-color LED based on the updateStatus() command received. The LED color will be set to GREEN when captureEnds or Good is reported, RED on errors, blinking RED on warning, blinking BLUE on captureStart, off on Clear status, and no change on Info/Debug messages.

Constructor & Destructor Documentation

◆ tcPCA9553Status()

tcPCA9553Status::tcPCA9553Status ( std::string *  apInformation = NULL)

Constructs a new PCA9553 with the information presented.

Information must either be empty for default settings: bus: 1 addr: 0x62 blue: LED0 red: LED1 green:LED2

Or information can follow: bus addr red green blue

All values are integers.

Parameters
arInformationEither blank or of the form i_i_i_i_i.

◆ ~tcPCA9553Status()

tcPCA9553Status::~tcPCA9553Status ( )
virtual

Member Function Documentation

◆ disableIndicators()

void tcPCA9553Status::disableIndicators ( bool  abDisable)
overridevirtual

Turn on/off the attached Tri-Color LED.

Parameters
abDisablewhen true, turn LED status off. When false, enable LED status updates.

Reimplemented from tcStatusReporter.

◆ updateStatus()

void tcPCA9553Status::updateStatus ( teStatus  aeStatus,
const char *  apMessage 
)
overridevirtual

Sets the LEDs to a correct state depending on the

Parameters
aeStatus

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