Class PicoPiDeviceProvider

Represents the abstract base implementation for a IRGBDeviceProvider.

Inheritance
object
AbstractRGBDeviceProvider
PicoPiDeviceProvider
Implements
Inherited Members
Namespace: RGB.NET.Devices.PicoPi
Assembly: RGB.NET.Devices.PicoPi.dll
Syntax
public sealed class PicoPiDeviceProvider : AbstractRGBDeviceProvider, IRGBDeviceProvider, IDisposable

Constructors

| Edit this page View Source

PicoPiDeviceProvider()

Initializes a new instance of the PicoPiDeviceProvider class.

Declaration
public PicoPiDeviceProvider()
Exceptions
Type Condition
InvalidOperationException

Thrown if this constructor is called even if there is already an instance of this class.

Properties

| Edit this page View Source

DeviceDefinitions

Gets the HID-definitions for PicoPi-devices.

Declaration
public static HIDLoader<int, int> DeviceDefinitions { get; }
Property Value
Type Description
HIDLoader<int, int>
| Edit this page View Source

Instance

Gets the singleton PicoPiDeviceProvider instance.

Declaration
public static PicoPiDeviceProvider Instance { get; }
Property Value
Type Description
PicoPiDeviceProvider
| Edit this page View Source

UpdateMode

Gets or sets the endpoint used to update devices. (default Auto). If auto is set it automatically is using bulk-updates for devies with more than 40 LEDs if supported. Else HID is used.

Declaration
public UpdateMode UpdateMode { get; set; }
Property Value
Type Description
UpdateMode

Methods

| Edit this page View Source

Dispose(bool)

Disposes the object and frees all resources.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

true if explicitely called through the Dispose-Method, false if called by the destructor.
Overrides
| Edit this page View Source

GetLoadedDevices(RGBDeviceType)

Loads devices and returns a filtered list of them.

Declaration
protected override IEnumerable<IRGBDevice> GetLoadedDevices(RGBDeviceType loadFilter)
Parameters
Type Name Description
RGBDeviceType loadFilter

RGBDeviceType-flags to filter the device with.
Returns
Type Description
IEnumerable<IRGBDevice>

The filtered collection of loaded devices.
Overrides
Remarks

The underlying loading of the devices happens in LoadDevices().

| Edit this page View Source

InitializeSDK()

Initializes the underlying SDK.

Declaration
protected override void InitializeSDK()
Overrides
| Edit this page View Source

LoadDevices()

Loads all devices this device provider is capable of loading.

Declaration
protected override IEnumerable<IRGBDevice> LoadDevices()
Returns
Type Description
IEnumerable<IRGBDevice>

A collection of loaded devices.
Overrides
Remarks

Filtering happens in GetLoadedDevices(RGBDeviceType).

| Edit this page View Source

Reset()

Resets the device provider and disposes all devices and update triggers.

Declaration
protected override void Reset()
Overrides

Implements