Doly C++ SDK v1.00
Loading...
Searching...
No Matches
LedControl

Doly LED control and event API. More...

Files

file  LedControl.h
 Public API for Doly LED control.
file  LedEvent.h
 Event registration helpers for the LED subsystem.

Classes

struct  LedActivity
 Describes a single LED activity (color and fade parameters). More...
class  LedEventListener
 Observer interface for receiving LED completion and error events. More...

Enumerations

enum class  LedSide : uint8_t { LedSide::BOTH , LedSide::LEFT , LedSide::RIGHT }
 Which LED(s) to address. More...
enum class  LedActivityState : uint8_t { LedActivityState::FREE , LedActivityState::RUNNING , LedActivityState::COMPLETED }
 Activity lifecycle state. More...
enum class  LedErrorType : uint8_t { LedErrorType::ABORT }
 Error type reported by the LED subsystem. More...

Detailed Description

Doly LED control and event API.

LED control module.

Enumeration Type Documentation

◆ LedActivityState

enum class LedActivityState : uint8_t
strong

Activity lifecycle state.

Enumerator
FREE 

No pending activity.

RUNNING 

Activity is running (being processed by the worker).

COMPLETED 

Activity completed successfully.

◆ LedErrorType

enum class LedErrorType : uint8_t
strong

Error type reported by the LED subsystem.

Enumerator
ABORT 

Activity was aborted/cancelled.

Examples
LedControl/main.cpp.

◆ LedSide

enum class LedSide : uint8_t
strong

Which LED(s) to address.

Enumerator
BOTH 

Apply to both sides (left and right).

LEFT 

Left LED.

RIGHT 

Right LED.

Examples
LedControl/main.cpp.