laelaps::LaeAuxBattOutEnable Class Reference

Laelaps top deck auxilliary battery power out enable class. More...

#include <laeGpio.h>

Inheritance diagram for laelaps::LaeAuxBattOutEnable:

Public Member Functions
	LaeAuxBattOutEnable ()
	Default constructor.
virtual	~LaeAuxBattOutEnable ()
	Destructor.
virtual void	sync ()
	Synchronized this with GPIO hardware state.
bool	enable ()
	Enable battery power to top deck. More...
bool	disable ()
	Disable battery power to top deck. More...
bool	isEnabled ()
	Test if battery power to top deck is enabled. More...
Public Member Functions inherited from laelaps::LaeGpio
	LaeGpio (const std::string &strTag, const int gpio, const LaeGpio::Direction dir)
	Default intialization constructor. More...
virtual	~LaeGpio ()
	Destructor.
virtual int	writeValue (const LaeGpio::TriState value)
	Write value to gpio. More...
virtual int	writeValue (const int value)
	Write value to gpio. More...
virtual int	readValue (int &value)
	Read current value of gpio. More...
int	hasValue () const
	Get the current shadowed gpio value. More...
bool	isConfigured () const
	Is the exported GPIO number configured to match this ojbect? More...

Additional Inherited Members
Public Types inherited from laelaps::LaeGpio
enum	TriState {   UNKNOWN = -1,   LOW = 0,   HIGH = 1 }
	GPIO tri-state value. More...
enum	Direction {   INPUT = GPIO_DIR_IN,   OUTPUT = GPIO_DIR_OUT }
	GPIO direction. More...
Protected Member Functions inherited from laelaps::LaeGpio
bool	checkConfig ()
	Check if the exported GPIO exists in /sys/class and that it has been configured to match this objects configuration. More...
Protected Attributes inherited from laelaps::LaeGpio
std::string	m_gpioTag
	identifying tag
int	m_gpioNum
	exported GPIO number
LaeGpio::Direction	m_gpioDir
	GPIO direction.
int	m_gpioVal
	shadowed value
bool	m_gpioCfg
	GPIO is [not] configured (correctly)

Detailed Description

Laelaps top deck auxilliary battery power out enable class.

Definition at line 347 of file laeGpio.h.

Member Function Documentation

bool LaeAuxBattOutEnable::disable

(

)

Disable battery power to top deck.

Returns

Returns true if power is enabled, false otherwise.

Definition at line 377 of file laeGpio.cxx.

References laelaps::LaeGpio::isConfigured(), laelaps::LaeGpio::m_gpioNum, laelaps::LaeGpio::m_gpioTag, laelaps::LaeGpio::m_gpioVal, laelaps::LaeGpio::sync(), laelaps::LaeGpio::UNKNOWN, and laelaps::LaeGpio::writeValue().

{
  bool  bEnabled;

  // lazy one-time synchronization
  if( m_gpioVal == LaeGpio::UNKNOWN )
  {
    sync();
  }

  // versions 2.1+ have battery power enable to top deck
  if( isConfigured() )
  {
    writeValue(0);
  }

  bEnabled = isEnabled();

  if( !bEnabled )
  {
    LOGDIAG2("%s (GPIO %d) disabled.", m_gpioTag.c_str(), m_gpioNum);
  }

  return bEnabled;
}

bool LaeAuxBattOutEnable::enable

(

)

Enable battery power to top deck.

Returns

Returns true if power is enabled, false otherwise.

Definition at line 351 of file laeGpio.cxx.

References laelaps::LaeGpio::isConfigured(), laelaps::LaeGpio::m_gpioNum, laelaps::LaeGpio::m_gpioTag, laelaps::LaeGpio::m_gpioVal, laelaps::LaeGpio::sync(), laelaps::LaeGpio::UNKNOWN, and laelaps::LaeGpio::writeValue().

{
  bool  bEnabled;

  // lazy one-time synchronization
  if( m_gpioVal == LaeGpio::UNKNOWN )
  {
    sync();
  }

  // versions 2.1+ have battery power enable to top deck
  if( isConfigured() )
  {
    writeValue(1);
  }

  bEnabled = isEnabled();

  if( bEnabled )
  {
    LOGDIAG2("%s (GPIO %d) enabled.", m_gpioTag.c_str(), m_gpioNum);
  }

  return bEnabled;
}

bool LaeAuxBattOutEnable::isEnabled

(

)

Test if battery power to top deck is enabled.

Returns

Returns true if power is enabled, false otherwise.

Definition at line 403 of file laeGpio.cxx.

References laelaps::LaeGpio::hasValue(), laelaps::LaeGpio::HIGH, laelaps::LaeGpio::m_gpioVal, laelaps::LaeGpio::sync(), and laelaps::LaeGpio::UNKNOWN.

{
  // lazy one-time synchronization
  if( m_gpioVal == LaeGpio::UNKNOWN )
  {
    sync();
  }

  return hasValue() == LaeGpio::HIGH;
}

---

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

• include/Laelaps/laeGpio.h
• sw/liblaelaps/laeGpio.cxx