Interface IKeypad

Interface for keypad functions.

Inherited Members

IDevice.ClearAsync()

IDevice.SetAllAsync(Color)

IDevice.SetEffectAsync(Guid)

IDevice.CurrentEffectId

Namespace: Colore

Assembly: Colore.dll

Syntax

public interface IKeypad : IDevice

Properties

Item[Int32, Int32]

Gets or sets a color at the specified position in the keypad's grid layout.

Declaration

Color this[int row, int column] { get; set; }

Parameters

Type	Name	Description
Int32	row	The row to access (between 0 and MaxRows, exclusive upper-bound).
Int32	column	The column to access (between 0 and MaxColumns, exclusive upper-bound).

Property Value

Type	Description
Color	The Color at the specified position.

Methods

IsSet(Int32, Int32)

Returns whether a key has had a custom color set.

Declaration

bool IsSet(int row, int column)

Parameters

Type	Name	Description
Int32	row	The row to query.
Int32	column	The column to query.

Returns

Type	Description
Boolean	true if the position has a color set that is not black, otherwise false.

SetCustomAsync(CustomKeypadEffect)

Sets a CustomKeypadEffect effect on the keypad.

Declaration

Task<Guid> SetCustomAsync(CustomKeypadEffect effect)

Parameters

Type	Name	Description
CustomKeypadEffect	effect	An instance of the CustomKeypadEffect struct.

Returns

Type	Description
Task<Guid>	A Guid for the effect that was set.

SetEffectAsync(KeypadEffectType)

Sets an effect without any parameters. Currently, this only works for the None effect.

Declaration

Task<Guid> SetEffectAsync(KeypadEffectType effectType)

Parameters

Type	Name	Description
KeypadEffectType	effectType	Effect options.

Returns

Type	Description
Task<Guid>	A Guid for the effect that was set.

SetStaticAsync(Color)

Sets a StaticKeypadEffect effect on the keypad.

Declaration

Task<Guid> SetStaticAsync(Color color)

Parameters

Type	Name	Description
Color	color	Color of the effect.

Returns

Type	Description
Task<Guid>	A Guid for the effect that was set.

SetStaticAsync(StaticKeypadEffect)

Sets a StaticKeypadEffect effect on the keypad.

Declaration

Task<Guid> SetStaticAsync(StaticKeypadEffect effect)

Parameters

Type	Name	Description
StaticKeypadEffect	effect	An instance of the StaticKeypadEffect struct.

Returns

Type	Description
Task<Guid>	A Guid for the effect that was set.