ArPiRobot-CoreLib C++
C++ library for ArPiRobot robots
Public Member Functions | Protected Member Functions | List of all members
arpirobot::StatusLED Class Reference

#include <arpirobot/devices/gpio/StatusLED.hpp>

Inheritance diagram for arpirobot::StatusLED:
arpirobot::BaseDevice arpirobot::IoDevice

Public Member Functions

 StatusLED (unsigned int pin)
 
 StatusLED (const StatusLED &other)=delete
 
StatusLEDoperator= (const StatusLED &other)=delete
 
- Public Member Functions inherited from arpirobot::BaseDevice
virtual std::string getDeviceName ()
 
bool isLockedByAction (std::shared_ptr< Action > action=nullptr)
 Check if a given action locks the device. More...
 
bool isLockedByAction (Action &action)
 Check if a given action locks the device. More...
 

Protected Member Functions

void close () override
 
void begin () override
 
bool isEnabled () override
 
bool shouldMatchRobotState () override
 
bool shouldDisableWithWatchdog () override
 
void enable () override
 
void disable () override
 

Additional Inherited Members

- Protected Attributes inherited from arpirobot::BaseDevice
bool initialized = false
 
std::string deviceName
 

Detailed Description

Controls an LED connected to a GPIO pin to add a visual indicator of robot status. While a robot program is running, the LED indicates the robot's state. While the robot is disabled, the LED is solid. While the robot is enabled, the LED blinks.


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