| Characteristic | Locus |
|---|---|
| Inheritance | object > BBQ10Keyboard |
| Implements | II2cPeripheral 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 | Bbq10Keyboard.dll |
Syntax
public class BBQ10Keyboard : II2cPeripheral, IDisposableConstructors
BBQ10Keyboard(II2cBus, IPin?, byte)
Create a new BBQ10Keyboard object
Declaration
public BBQ10Keyboard(II2cBus i2cBus, IPin? interruptPin = null, byte address = 31)Parameters
| Type | Name | Description |
|---|---|---|
| II2cBus | i2cBus | The I2C bus |
| IPin | interruptPin | The interrupt pin |
| byte | address | The I2C address |
Fields
i2cComms
I2C Communication bus used to communicate with the peripheral
Declaration
protected readonly II2cCommunications i2cCommsField Value
| Type | Description |
|---|---|
| II2cCommunications |
Properties
BackLight
Get or set the backlight
Declaration
public byte BackLight { get; set; }Property Value
| Type | Description |
|---|---|
| byte |
BackLight2
Get or set the 2nd backlight
Declaration
public byte BackLight2 { get; set; }Property Value
| Type | Description |
|---|---|
| byte |
DefaultI2cAddress
The default I2C address for the peripheral
Declaration
public byte DefaultI2cAddress { get; }Property Value
| Type | Description |
|---|---|
| byte |
IsDisposed
Is the object disposed
Declaration
public bool IsDisposed { get; }Property Value
| Type | Description |
|---|---|
| bool |
Methods
ClearInerruptStatus()
Clear the interrupt status
Declaration
protected void ClearInerruptStatus()Dispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Declaration
public void Dispose()Dispose(bool)
Dispose of the object
Declaration
protected virtual void Dispose(bool disposing)Parameters
| Type | Name | Description |
|---|---|---|
| bool | disposing | Is disposing |
GetLastKeyEvent()
Get the last key event
Declaration
public BBQ10Keyboard.KeyEvent GetLastKeyEvent()Returns
| Type | Description |
|---|---|
| BBQ10Keyboard.KeyEvent | The event |
Reset()
Reset the keyboard
Declaration
public void Reset()Events
OnKeyEvent
Raised when a key press is detected
Declaration
public event EventHandler<BBQ10Keyboard.KeyEvent> OnKeyEventEvent Type
| Type | Description |
|---|---|
| EventHandler<BBQ10Keyboard.KeyEvent> |