SimpleLedSubsystem Class Reference

#include <simple_led_subsystem.h>

Inheritance diagram for SimpleLedSubsystem:

Public Member Functions
	SimpleLedSubsystem (argos_lib::RobotInstance instance)
void	Enable ()
void	Disable ()
void	SetLedsConnectedBrightness (bool connected)
void	SetDisableAnimation (std::function< void()> animationFunction)
void	SetLedGroupColor (LedGroup group, argos_lib::ArgosColor color, bool restorable=true)
	Sets group of leds to given color.
void	SetLedStripColor (LedStrip strip, argos_lib::ArgosColor color, bool restorable=true)
void	SetAllGroupsColor (argos_lib::ArgosColor color, bool restorable=true)
	Sets all led groups to a given color.
void	SetAllGroupsFade (argos_lib::ArgosColor color, bool restorable=true)
void	SetAllGroupsFlash (argos_lib::ArgosColor color, bool restorable=true)
void	FlashStrip (LedStrip strip, argos_lib::ArgosColor color, bool restorable=true)
void	SetAllGroupsLarson (argos_lib::ArgosColor color, bool restorable=true)
argos_lib::ArgosColor	GetAllianceColor ()
void	SetAllGroupsAllianceColor (bool fade, bool restorable=true)
	Set all groups of LEDs to the alliance color.
void	StopAllAnimations (bool restorable=true)
void	SetAllGroupsOff (bool restorable=true)
	Turn off all LEDs.
void	Periodic () override
void	FireEverywhere (bool restorable=true)
void	ColorSweep (argos_lib::ArgosColor color, bool correctGamma=true, bool restorable=true)
void	TemporaryAnimate (std::function< void()> animationFunction, units::millisecond_t duration)

Private Attributes
std::optional< ctre::phoenix::led::CANdle >	m_CANdle
argos_lib::ArgosLogger	m_log
bool	m_enabled
bool	m_hasBeenConnected
std::function< void()>	m_disableUpdateFunction
std::function< void()>	m_ledUpdateFunction
std::optional< std::function< void(void)> >	m_restoreAnimationFunction
std::chrono::time_point< std::chrono::steady_clock >	m_startTime
units::millisecond_t	m_temporaryDuration
frc::DriverStation::Alliance	m_latestAlliance

Static Private Attributes
static constexpr int	startIndex_backLeft = 8
	Address of first LED in strip.
static constexpr int	length_backLeft = 23
	Number of LEDs in strip.
static constexpr bool	inverted_backLeft = true
	true indicates first index is at top of tower
static constexpr int	startIndex_backRight = 31
static constexpr int	length_backRight = 23
static constexpr bool	inverted_backRight = true
static constexpr int	startIndex_front = 54
static constexpr int	length_front = 9
static constexpr bool	inverted_front = true

Constructor & Destructor Documentation

SimpleLedSubsystem()

SimpleLedSubsystem::SimpleLedSubsystem ( argos_lib::RobotInstance  instance )

explicit

Member Function Documentation

ColorSweep()

void SimpleLedSubsystem::ColorSweep	(	argos_lib::ArgosColor	color,
		bool	correctGamma = true,
		bool	restorable = true
	)

Disable()

void SimpleLedSubsystem::Disable

(

)

Enable()

void SimpleLedSubsystem::Enable

(

)

FireEverywhere()

void SimpleLedSubsystem::FireEverywhere

(

bool

restorable = true

)

FlashStrip()

void SimpleLedSubsystem::FlashStrip	(	LedStrip	strip,
		argos_lib::ArgosColor	color,
		bool	restorable = true
	)

GetAllianceColor()

argos_lib::ArgosColor SimpleLedSubsystem::GetAllianceColor

(

)

Periodic()

void SimpleLedSubsystem::Periodic ( )

override

Will be called periodically whenever the CommandScheduler runs.

SetAllGroupsAllianceColor()

void SimpleLedSubsystem::SetAllGroupsAllianceColor	(	bool	fade,
		bool	restorable = true
	)

Set all groups of LEDs to the alliance color.

SetAllGroupsColor()

void SimpleLedSubsystem::SetAllGroupsColor	(	argos_lib::ArgosColor	color,
		bool	restorable = true
	)

Sets all led groups to a given color.

Parameters

color

an ArgosColor to set the LEDs too

SetAllGroupsFade()

void SimpleLedSubsystem::SetAllGroupsFade	(	argos_lib::ArgosColor	color,
		bool	restorable = true
	)

SetAllGroupsFlash()

void SimpleLedSubsystem::SetAllGroupsFlash	(	argos_lib::ArgosColor	color,
		bool	restorable = true
	)

SetAllGroupsLarson()

void SimpleLedSubsystem::SetAllGroupsLarson	(	argos_lib::ArgosColor	color,
		bool	restorable = true
	)

SetAllGroupsOff()

void SimpleLedSubsystem::SetAllGroupsOff

(

bool

restorable = true

)

Turn off all LEDs.

SetDisableAnimation()

void SimpleLedSubsystem::SetDisableAnimation

(

std::function< void()>

animationFunction

)

SetLedGroupColor()

void SimpleLedSubsystem::SetLedGroupColor	(	LedGroup	group,
		argos_lib::ArgosColor	color,
		bool	restorable = true
	)

Sets group of leds to given color.

Parameters

group	The group of leds to set
color	an ArgosColor to set the LEDs too

SetLedsConnectedBrightness()

void SimpleLedSubsystem::SetLedsConnectedBrightness

(

bool

connected

)

SetLedStripColor()

void SimpleLedSubsystem::SetLedStripColor	(	LedStrip	strip,
		argos_lib::ArgosColor	color,
		bool	restorable = true
	)

StopAllAnimations()

void SimpleLedSubsystem::StopAllAnimations

(

bool

restorable = true

)

TemporaryAnimate()

void SimpleLedSubsystem::TemporaryAnimate	(	std::function< void()>	animationFunction,
		units::millisecond_t	duration
	)

Member Data Documentation

inverted_backLeft

constexpr bool SimpleLedSubsystem::inverted_backLeft = true

staticconstexprprivate

true indicates first index is at top of tower

inverted_backRight

constexpr bool SimpleLedSubsystem::inverted_backRight = true

staticconstexprprivate

inverted_front

constexpr bool SimpleLedSubsystem::inverted_front = true

staticconstexprprivate

length_backLeft

constexpr int SimpleLedSubsystem::length_backLeft = 23

staticconstexprprivate

Number of LEDs in strip.

length_backRight

constexpr int SimpleLedSubsystem::length_backRight = 23

staticconstexprprivate

length_front

constexpr int SimpleLedSubsystem::length_front = 9

staticconstexprprivate

m_CANdle

std::optional<ctre::phoenix::led::CANdle> SimpleLedSubsystem::m_CANdle

private

m_disableUpdateFunction

std::function<void()> SimpleLedSubsystem::m_disableUpdateFunction

private

m_enabled

bool SimpleLedSubsystem::m_enabled

private

m_hasBeenConnected

bool SimpleLedSubsystem::m_hasBeenConnected

private

m_latestAlliance

frc::DriverStation::Alliance SimpleLedSubsystem::m_latestAlliance

private

m_ledUpdateFunction

std::function<void()> SimpleLedSubsystem::m_ledUpdateFunction

private

m_log

argos_lib::ArgosLogger SimpleLedSubsystem::m_log

private

m_restoreAnimationFunction

std::optional<std::function<void(void)> > SimpleLedSubsystem::m_restoreAnimationFunction

private

m_startTime

std::chrono::time_point<std::chrono::steady_clock> SimpleLedSubsystem::m_startTime

private

m_temporaryDuration

units::millisecond_t SimpleLedSubsystem::m_temporaryDuration

private

startIndex_backLeft

constexpr int SimpleLedSubsystem::startIndex_backLeft = 8

staticconstexprprivate

Address of first LED in strip.

startIndex_backRight

constexpr int SimpleLedSubsystem::startIndex_backRight = 31

staticconstexprprivate

startIndex_front

constexpr int SimpleLedSubsystem::startIndex_front = 54

staticconstexprprivate

---

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

• src/main/include/subsystems/simple_led_subsystem.h
• src/main/cpp/subsystems/simple_led_subsystem.cpp