Class DeviceProvider

Allows you to implement and register your own device provider

Inheritance
System.Object
CorePropertyChanged
PluginFeature
DeviceProvider
Implements
System.IDisposable
Inherited Members
Namespace: Artemis.Core.DeviceProviders
Assembly: Artemis.Core.dll
Syntax
public abstract class DeviceProvider : PluginFeature, INotifyPropertyChanged, IDisposable

Constructors

| Improve this Doc View Source

DeviceProvider(IRGBDeviceProvider)

Creates a new instance of the DeviceProvider class

Declaration
protected DeviceProvider(IRGBDeviceProvider rgbDeviceProvider)
Parameters
Type Name Description
RGB.NET.Core.IRGBDeviceProvider rgbDeviceProvider

Properties

| Improve this Doc View Source

CanDetectLogicalLayout

A boolean indicating whether this device provider detects the logical layout of connected keyboards

Note: GetLogicalLayout(IKeyboard) is only called when this or CanDetectPhysicalLayout is true.

Declaration
public bool CanDetectLogicalLayout { get; protected set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

CanDetectPhysicalLayout

A boolean indicating whether this device provider detects the physical layout of connected keyboards.

Note: GetLogicalLayout(IKeyboard) is only called when this or CanDetectLogicalLayout is true.

Declaration
public bool CanDetectPhysicalLayout { get; protected set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

CreateMissingLedsSupported

Gets or sets a boolean indicating whether adding missing LEDs defined in a layout but missing on the device is supported

Note: Defaults to true.

Declaration
public bool CreateMissingLedsSupported { get; protected set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Logger

TODO: Make internal while still injecting. A logger used by the device provider internally, ignore this

Declaration
[Inject]
public ILogger Logger { get; set; }
Property Value
Type Description
Serilog.ILogger
| Improve this Doc View Source

RemoveExcessiveLedsSupported

Gets or sets a boolean indicating whether removing excess LEDs present in the device but missing in the layout is supported

Note: Defaults to true.

Declaration
public bool RemoveExcessiveLedsSupported { get; protected set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

RgbDeviceProvider

The RGB.NET device provider backing this Artemis device provider

Declaration
public IRGBDeviceProvider RgbDeviceProvider { get; }
Property Value
Type Description
RGB.NET.Core.IRGBDeviceProvider

Methods

| Improve this Doc View Source

GetLogicalLayout(IKeyboard)

Called when a specific RGB device's logical and physical layout must be detected

Note: Only called when CanDetectLogicalLayout is true.

Declaration
public virtual string GetLogicalLayout(IKeyboard keyboard)
Parameters
Type Name Description
RGB.NET.Core.IKeyboard keyboard

The device to detect the layout for, always a keyboard
Returns
Type Description
System.String
| Improve this Doc View Source

LoadLayout(ArtemisDevice)

Loads a layout for the specified device and wraps it in an ArtemisLayout

Declaration
public virtual ArtemisLayout LoadLayout(ArtemisDevice device)
Parameters
Type Name Description
ArtemisDevice device

The device to load the layout for
Returns
Type Description
ArtemisLayout

The resulting Artemis layout
| Improve this Doc View Source

LoadUserLayout(ArtemisDevice)

Loads a layout from the user layout folder for the specified device and wraps it in an ArtemisLayout

Declaration
public virtual ArtemisLayout LoadUserLayout(ArtemisDevice device)
Parameters
Type Name Description
ArtemisDevice device

The device to load the layout for
Returns
Type Description
ArtemisLayout

The resulting Artemis layout

Implements

System.IDisposable