Treehopper C# API
Is31fl3218 Class Reference

ISSI IS31FL3218 I2c 18-channel 16-bit PWM constant-current LED driver More...

Inheritance diagram for Is31fl3218:
LedDriver ILedDriver IFlushable

Public Member Functions

 Is31fl3218 (I2C i2c, int rateKhz=100)
 Construct a new IS31FL3218 More...
 
override Task FlushAsync (bool force=false)
 Flush the data out to the LED driver More...
 
async Task Clear ()
 Clear the display More...
 

Protected Attributes

double brightness
 The internally-referenced global brightness of the LED driver More...
 

Properties

bool Shutdown [get, set]
 Gets or sets whether the chip should be in shutdown mode. More...
 
bool AutoFlush = true [get, set]
 Gets or sets whether the display should auto-flush whenever an LED state is changed More...
 
bool HasGlobalBrightnessControl [get, protected set]
 Gets or sets whether this controller supports global brightness control. More...
 
bool HasIndividualBrightnessControl [get]
 Gets or sets whether this controller's LEDs have individual brightness control (through PWM or otherwise). More...
 
double Brightness [get, set]
 The global brightness, from 0.0-1.0, of the LEDs attached to this driver More...
 
IList< LedLeds = new Collection<Led>() [get, set]
 The collection of LEDs that belong to this driver. More...
 
IFlushable Parent [get, protected set]
 Gets the parent device of this LED driver More...
 

Detailed Description

ISSI IS31FL3218 I2c 18-channel 16-bit PWM constant-current LED driver

Constructor & Destructor Documentation

◆ Is31fl3218()

Is31fl3218 ( I2C  i2c,
int  rateKhz = 100 
)

Construct a new IS31FL3218

Parameters
i2cThe I2C peripheral this chip is attached to
rateKhzThe frequency, in kHz, that should be used to communicate with the chip

Member Function Documentation

◆ FlushAsync()

override Task FlushAsync ( bool  force = false)
virtual

Flush the data out to the LED driver

Parameters
forceWhether the data should be sent even if the data does not appear to have changed
Returns
An awaitable task

Implements LedDriver.

◆ Clear()

async Task Clear ( )
inherited

Clear the display

Returns
An awaitable task that completes when the display is cleared

Implements ILedDriver.

Member Data Documentation

◆ brightness

double brightness
protectedinherited

The internally-referenced global brightness of the LED driver

Property Documentation

◆ Shutdown

bool Shutdown
getset

Gets or sets whether the chip should be in shutdown mode.

◆ AutoFlush

bool AutoFlush = true
getsetinherited

Gets or sets whether the display should auto-flush whenever an LED state is changed

◆ HasGlobalBrightnessControl

bool HasGlobalBrightnessControl
getprotected setinherited

Gets or sets whether this controller supports global brightness control.

◆ HasIndividualBrightnessControl

bool HasIndividualBrightnessControl
getinherited

Gets or sets whether this controller's LEDs have individual brightness control (through PWM or otherwise).

◆ Brightness

double Brightness
getsetinherited

The global brightness, from 0.0-1.0, of the LEDs attached to this driver

◆ Leds

IList<Led> Leds = new Collection<Led>()
getsetinherited

The collection of LEDs that belong to this driver.

◆ Parent

IFlushable Parent
getprotected setinherited

Gets the parent device of this LED driver


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