Public Member Functions

CQEPower Class Reference

CQEPower is used to get power information such as battery voltage, battery status, and to initiate a system power-down. More...

#include <qepower.h>

Inheritance diagram for CQEPower:
IProperty

List of all members.

Public Member Functions

 SINGLETON (CQEPower)
 This internal macro handles instantiation of this class.
void PowerOff ()
 Initiates a system power down.
virtual int GetProperty (int property, long *value)
 See the definition of IProperty::GetProperty for more information on this method.
virtual int SetProperty (int property, long value)
 See the definition of IProperty::SetProperty for more information on this method.

Detailed Description

CQEPower is used to get power information such as battery voltage, battery status, and to initiate a system power-down.

To instantiate this class: 

 // by pointer
 CQEPower *ppwr = CQEPower::GetPtr(); 
 // or by reference
 CQEPower &pwr = CQEPower::GetRef();

And when done with this class, call Release(), for each call to GetPtr() or GetRef(): 

 CQEPower::Release();

Member Function Documentation

int CQEPower::GetProperty ( int  property,
long *  value 
) [virtual]

See the definition of IProperty::GetProperty for more information on this method.

The following properties are supported:

  • QP_PROP_HARDWARE_VERSION=version of VEXPro hardware
  • QP_PROP_BREAKER_STATE=bitmap of the 5 PSD fuses in the power system. A 1 indicates that the fuse is tripped (open), a 0 indicates the fuse is normal (closed).
    • Bit 0=PSD state for motors 1 through 4
    • Bit 1=PSD state for motors 5 through 8
    • Bit 2=PSD state for motors 9 through 12
    • Bit 3=PSD state for motors 13 through 14
    • Bit 4=PSD state for motors 15 through 16
  • QP_PROP_MAIN_BATT_VOLTAGE=main battery voltage in millivolts.
  • QP_PROP_MAIN_BATT_STATE=state of main battery.
  • QP_PROP_BACKUP_BATT_VOLTAGE=voltage of backup battery in millivolts.
  • QP_PROP_BACKUP_BATT_STATE=state of backup battery.
  • QP_PROP_MAIN_5V_VOLTAGE=voltage of main 5V regulator in millivolts.
  • QP_PROP_IO_5V_VOLTAGE=voltage of I/O connector 5V regulator in millivolts.
  • QP_PROP_IO_5V_STATE=on/off state of 5V regulator for I/O connectors (analog, digital, I2C), 1=on, 0=off.

Implements IProperty.

void CQEPower::PowerOff (  ) 

Initiates a system power down.

It does a sync of the flash disk before shutting down, so no information is lost.

int CQEPower::SetProperty ( int  property,
long  value 
) [virtual]

See the definition of IProperty::SetProperty for more information on this method.

The following properties re supported:

  • QP_PROP_IO_5V_STATE=control the 5V regulator for I/O connectors (analog, digital, I2C)
    • 1 (nonzero)=on default,
    • 0=off or power saving mode where all devices connected to I/O connectors receive no 5V power.

Implements IProperty.

CQEPower::SINGLETON ( CQEPower   ) 

This internal macro handles instantiation of this class.

The documentation for this class was generated from the following files:
Generated on Mon Oct 3 2011 15:36:31 for libqwerk by  doxygen 1.7.1