Public Member Functions | List of all members
BreatheLEDs Class Reference

Behaviour that cycles all LEDs from full to minimum brightness and back at a speed specified as its argument. More...

#include <LEDBehaviours.h>

Inheritance diagram for BreatheLEDs:
Behaviour

Public Member Functions

char * args ()
 
 BreatheLEDs (Adafruit_NeoPixel *strip, String name="Breathe", uint32_t hue=0, uint32_t sat=0)
 
String start (String args)
 
void update ()
 
- Public Member Functions inherited from Behaviour
 Behaviour (String name)
 
virtual boolean is_background ()
 
virtual boolean is_interruptable ()
 
virtual boolean is_priority ()
 
virtual boolean is_running ()
 
virtual boolean is_temp ()
 
virtual String name ()
 
virtual void stop ()
 
 ~Behaviour ()
 

Additional Inherited Members

- Protected Attributes inherited from Behaviour
boolean _background = false
 
boolean _interruptable = true
 
String _name = "name"
 
boolean _priority = false
 
boolean _running = false
 
boolean _temp = false
 

Detailed Description

Behaviour that cycles all LEDs from full to minimum brightness and back at a speed specified as its argument.

Constructor & Destructor Documentation

◆ BreatheLEDs()

BreatheLEDs::BreatheLEDs ( Adafruit_NeoPixel *  strip,
String  name = "Breathe",
uint32_t  hue = 0,
uint32_t  sat = 0 
)

Member Function Documentation

◆ args()

char* BreatheLEDs::args ( )
virtual

What arguments does the behaviour take? Override this to document your behaviour.

Reimplemented from Behaviour.

◆ start()

String BreatheLEDs::start ( String  args)
virtual

Start the behaviour, with arguments.

Reimplemented from Behaviour.

◆ update()

void BreatheLEDs::update ( )
virtual

Update the behaviour periodically.

Reimplemented from Behaviour.


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