Remarks
Keyboard | |
---|---|
Status | |
Source code | GitHub |
NuGet package |
Characteristic | Locus |
---|---|
Inheritance | object > Keyboard |
Implements | IDigitalInterruptController IDigitalOutputController IPinController IDisposable |
Inherited Members | object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() |
Namespace | Meadow.Foundation.Sensors.Hid |
Assembly | Meadow.Keyboard.dll |
Syntax
public class Keyboard : IDigitalInterruptController, IDigitalOutputController, IPinController, IDisposable
Constructors
Keyboard(int)
Creates a Keyboard instance
Declaration
public Keyboard(int keyboardNumber = 0)
Parameters
Type | Name | Description |
---|---|---|
int | keyboardNumber |
Remarks
Keyboard | |
---|---|
Status | |
Source code | GitHub |
NuGet package |
Properties
Pins
d The pins
Declaration
public Keyboard.PinDefinitions Pins { get; }
Property Value
Type | Description |
---|---|
Keyboard.PinDefinitions |
Remarks
Keyboard | |
---|---|
Status | |
Source code | GitHub |
NuGet package |
Methods
CreateDigitalInterruptPort(IPin)
Creates an input for a keyboard key
Declaration
public IDigitalInterruptPort CreateDigitalInterruptPort(IPin pin)
Parameters
Type | Name | Description |
---|---|---|
IPin | pin |
Returns
Type | Description |
---|---|
IDigitalInterruptPort |
Remarks
Keyboard | |
---|---|
Status | |
Source code | GitHub |
NuGet package |
CreateDigitalInterruptPort(IPin, InterruptMode)
Creates an input for a keyboard key
Declaration
public IDigitalInterruptPort CreateDigitalInterruptPort(IPin pin, InterruptMode interruptMode)
Parameters
Type | Name | Description |
---|---|---|
IPin | pin | |
InterruptMode | interruptMode |
Returns
Type | Description |
---|---|
IDigitalInterruptPort |
Remarks
Keyboard | |
---|---|
Status | |
Source code | GitHub |
NuGet package |
CreateDigitalInterruptPort(IPin, InterruptMode, ResistorMode, TimeSpan, TimeSpan)
Creates an input for a keyboard key
Declaration
public IDigitalInterruptPort CreateDigitalInterruptPort(IPin pin, InterruptMode interruptMode, ResistorMode resistorMode, TimeSpan debounceDuration, TimeSpan glitchDuration)
Parameters
Type | Name | Description |
---|---|---|
IPin | pin | |
InterruptMode | interruptMode | |
ResistorMode | resistorMode | |
TimeSpan | debounceDuration | |
TimeSpan | glitchDuration |
Returns
Type | Description |
---|---|
IDigitalInterruptPort |
Remarks
Keyboard | |
---|---|
Status | |
Source code | GitHub |
NuGet package |
CreateDigitalOutputPort(IPin, bool, OutputType)
Creates an output for a Keyboard indicator
Declaration
public IDigitalOutputPort CreateDigitalOutputPort(IPin pin, bool initialState = false, OutputType initialOutputType = OutputType.PushPull)
Parameters
Type | Name | Description |
---|---|---|
IPin | pin | |
bool | initialState | |
OutputType | initialOutputType |
Returns
Type | Description |
---|---|
IDigitalOutputPort |
Remarks
Keyboard | |
---|---|
Status | |
Source code | GitHub |
NuGet package |
Exceptions
Type | Condition |
---|---|
ArgumentException | |
NotImplementedException |
Dispose()
Releases resources created by the Keyboard instance
Declaration
public void Dispose()
Remarks
Keyboard | |
---|---|
Status | |
Source code | GitHub |
NuGet package |
Dispose(bool)
Dispose of the object
Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
bool | disposing | Is disposing |
Remarks
Keyboard | |
---|---|
Status | |
Source code | GitHub |
NuGet package |