ST / X_NUCLEO_LED61A1

Library to handle the X-NUCLEO-LED61A1 LED Control Expansion Board based on the LED6001 component.

Dependents:   LedDimming_LED61A1_mbedOS HelloWorld_LED61A1_mbedOS LedDimming_LED61A1 HelloWorld_LED61A1 ... more

Fork of X_NUCLEO_LED61A1 by ST Expansion SW Team

Embed: (wiki syntax)

« Back to documentation index

Led Class Reference
Public Member Functions

Led Class Reference

An abstract class for Led components. More...

#include <Led.h>

Inherits Component.

Inherited by Led6001.

Public Member Functions

virtual float get_current (void)=0
 Getting the current flowing through the LED.
virtual void set_pwm_dimming (float dimming)=0
 Setting PWM dimming value.
virtual void set_analog_dimming (float dimming)=0
 Setting Analog dimming value.
virtual ~Led ()
 Destructor.
virtual int init (void *init)=0
 Initializing the component.
virtual int read_id (uint8_t *id)=0
 Getting the ID of the component.

Detailed Description

An abstract class for Led components.

Definition at line 67 of file Led.h.

Constructor & Destructor Documentation

virtual ~Led (  ) [virtual]

Destructor.

Definition at line 106 of file Led.h.

Member Function Documentation

virtual float get_current ( void   ) [pure virtual]

Getting the current flowing through the LED.

Parameters:
None.
Return values:
Thecurrent flowing through the LED, represented as a floating point number in the range [0.0, 1.0].

Implemented in Led6001.

virtual int init ( void *  init ) [pure virtual, inherited]

Initializing the component.

Parameters:
[in]initpointer to device specific initalization structure.
Return values:
0in case of success, an error code otherwise.

Implemented in Led6001.

virtual int read_id ( uint8_t *  id ) [pure virtual, inherited]

Getting the ID of the component.

Parameters:
[out]idpointer to an allocated variable to store the ID into.
Return values:
0in case of success, an error code otherwise.

Implemented in Led6001.

virtual void set_analog_dimming ( float  dimming ) [pure virtual]

Setting Analog dimming value.

Parameters:
dimmingAnalog dimming value.
Return values:
None.

Implemented in Led6001.

virtual void set_pwm_dimming ( float  dimming ) [pure virtual]

Setting PWM dimming value.

Parameters:
dimmingPWM dimming value.
Return values:
None.

Implemented in Led6001.

Generated on Mon Jul 18 2022 02:55:00 by  doxygen 1.7.2