Interface IDeviceService

Namespace

Artemis.Core.Services

Assembly

Artemis.Core.dll

A service that allows you manage an ArtemisDevice

public interface IDeviceService

Properties

Devices

Gets a read-only collection containing all registered devices

IReadOnlyCollection<ArtemisDevice> Devices { get; }

Property Value

IReadOnlyCollection<ArtemisDevice>

EnabledDevices

Gets a read-only collection containing all enabled devices

IReadOnlyCollection<ArtemisDevice> EnabledDevices { get; }

Property Value

IReadOnlyCollection<ArtemisDevice>

SuspendedDeviceProviders

Gets a read-only collection containing all enabled but suspended device providers

IReadOnlyCollection<DeviceProvider> SuspendedDeviceProviders { get; }

Property Value

IReadOnlyCollection<DeviceProvider>

Methods

AddDeviceProvider(DeviceProvider)

Adds the given device provider and its devices.

void AddDeviceProvider(DeviceProvider deviceProvider)

Parameters

deviceProvider DeviceProvider

AutoArrangeDevices(bool)

Applies auto-arranging logic to the surface

void AutoArrangeDevices(bool leftHanded)

Parameters

leftHanded bool

DisableDevice(ArtemisDevice)

Disables the provided device

void DisableDevice(ArtemisDevice device)

Parameters

device ArtemisDevice

The device to disable

EnableDevice(ArtemisDevice)

Enables the provided device

void EnableDevice(ArtemisDevice device)

Parameters

device ArtemisDevice

The device to enable

IdentifyDevice(ArtemisDevice)

Identifies the device by making it blink white 5 times

void IdentifyDevice(ArtemisDevice device)

Parameters

device ArtemisDevice

LoadDeviceLayout(ArtemisDevice)

Apples the best available to the provided ArtemisDevice

void LoadDeviceLayout(ArtemisDevice device)

Parameters

device ArtemisDevice

RemoveDeviceProvider(DeviceProvider)

Removes the given device provider and its devices.

void RemoveDeviceProvider(DeviceProvider deviceProvider)

Parameters

deviceProvider DeviceProvider

ResumeDeviceProviders()

Resumes all previously active device providers

void ResumeDeviceProviders()

SaveDevice(ArtemisDevice)

Saves the configuration of the provided device to persistent storage

void SaveDevice(ArtemisDevice artemisDevice)

Parameters

artemisDevice ArtemisDevice

SaveDevices()

Saves the configuration of all current devices to persistent storage

void SaveDevices()

SuspendDeviceProviders()

Suspends all active device providers

void SuspendDeviceProviders()

Events

DeviceAdded

Occurs when a single device was added.

event EventHandler<DeviceEventArgs> DeviceAdded

Event Type

EventHandler<DeviceEventArgs>

DeviceDisabled

Occurs when a single device was disabled.

event EventHandler<DeviceEventArgs> DeviceDisabled

Event Type

EventHandler<DeviceEventArgs>

DeviceEnabled

Occurs when a single device was disabled

event EventHandler<DeviceEventArgs> DeviceEnabled

Event Type

EventHandler<DeviceEventArgs>

DeviceProviderAdded

Occurs when a device provider was added.

event EventHandler<DeviceProviderEventArgs> DeviceProviderAdded

Event Type

EventHandler<DeviceProviderEventArgs>

DeviceProviderRemoved

Occurs when a device provider was removed.

event EventHandler<DeviceProviderEventArgs> DeviceProviderRemoved

Event Type

EventHandler<DeviceProviderEventArgs>

DeviceRemoved

Occurs when a single device was removed.

event EventHandler<DeviceEventArgs> DeviceRemoved

Event Type

EventHandler<DeviceEventArgs>

LedsChanged

Occurs when the surface has had modifications to its LED collection

event EventHandler LedsChanged

Event Type

EventHandler