Class ArduinoWS2812USBDevice

Represents an arduino WS2812 device.

Inheritance
object
AbstractBindable
Placeable
AbstractRGBDevice<ArduinoWS2812USBDeviceInfo>
ArduinoWS2812USBDevice
Implements
Inherited Members
Namespace: RGB.NET.Devices.WS281X.Arduino
Assembly: RGB.NET.Devices.WS281X.dll
Syntax
public sealed class ArduinoWS2812USBDevice : AbstractRGBDevice<ArduinoWS2812USBDeviceInfo>, IRGBDevice<ArduinoWS2812USBDeviceInfo>, ILedStripe, IRGBDevice, IEnumerable<Led>, IEnumerable, IPlaceable, IBindable, INotifyPropertyChanged, IDisposable

Constructors

| Edit this page View Source

ArduinoWS2812USBDevice(ArduinoWS2812USBDeviceInfo, ArduinoWS2812USBUpdateQueue, int, int)

Initializes a new instance of the ArduinoWS2812USBDevice class.

Declaration
public ArduinoWS2812USBDevice(ArduinoWS2812USBDeviceInfo deviceInfo, ArduinoWS2812USBUpdateQueue updateQueue, int channel, int ledCount)
Parameters
Type Name Description
ArduinoWS2812USBDeviceInfo deviceInfo

The device info of this device.
ArduinoWS2812USBUpdateQueue updateQueue

The update queue performing updates for this device.
int channel

The channel (as defined in the arduino-sketch) this device is attached to.
int ledCount

The amount of leds on this device.

Properties

| Edit this page View Source

Channel

Gets the channel (as defined in the arduino-sketch) this device is attached to.

Declaration
public int Channel { get; }
Property Value
Type Description
int

Methods

| Edit this page View Source

GetLedCustomData(LedId)

Gets the custom data associated with the specified LED.

Declaration
protected override object GetLedCustomData(LedId ledId)
Parameters
Type Name Description
LedId ledId

The id of the led.
Returns
Type Description
object

The custom data for the specified LED.
Overrides
RGB.NET.Core.AbstractRGBDevice<RGB.NET.Devices.WS281X.Arduino.ArduinoWS2812USBDeviceInfo>.GetLedCustomData(RGB.NET.Core.LedId)
| Edit this page View Source

GetLedsToUpdate(bool)

Gets an enumerable of LEDs that are changed and requires an update.

Declaration
protected override IEnumerable<Led> GetLedsToUpdate(bool flushLeds)
Parameters
Type Name Description
bool flushLeds

Forces all LEDs to be treated as dirty.
Returns
Type Description
IEnumerable<Led>

The collection LEDs to update.
Overrides

Implements