C# Class LitDev.Engines.HIDDevice

Inheritance: Win32Usb, IDisposable
Afficher le fichier Open project: litdev1/LitDev Class Usage Examples

Méthodes publiques

Méthode Description
CreateInputReport ( ) : InputReport

Virtual method to create an input report for this device. Override to use.
Dispose ( ) : void

Dispose method
FindDevice ( int nVid, int nPid, Type oType ) : HIDDevice

Finds a device given its PID and VID

Méthodes protégées

Méthode Description
Dispose ( bool bDisposing ) : void

Disposer called by both dispose and finalise
HandleDataReceived ( InputReport oInRep ) : void

virtual handler for any action to be taken when data is received. Override to use.
HandleDeviceRemoved ( ) : void

Virtual handler for any action to be taken when a device is removed. Override to use.
ReadCompleted ( IAsyncResult iResult ) : void

Callback for above. Care with this as it will be called on the background thread from the async read
Write ( OutputReport oOutRep ) : void

Write an output report to the device.

Private Methods

Méthode Description
BeginAsyncRead ( ) : void

Kicks off an asynchronous read which completes when data is read or when the device is disconnected. Uses a callback.
GetDeviceName ( ) : string
GetDevicePath ( IntPtr hInfoSet, DeviceInterfaceData &oInterface ) : string

Helper method to return the device path given a DeviceInterfaceData structure and an InfoSet handle. Used in 'FindDevice' so check that method out to see how to get an InfoSet handle and a DeviceInterfaceData.
Initialise ( string strPath ) : void

Initialises the device

Method Details

CreateInputReport() public méthode

Virtual method to create an input report for this device. Override to use.
public CreateInputReport ( ) : InputReport
Résultat InputReport

Dispose() public méthode

Dispose method
public Dispose ( ) : void
Résultat void

Dispose() protected méthode

Disposer called by both dispose and finalise
protected Dispose ( bool bDisposing ) : void
bDisposing bool True if disposing
Résultat void

FindDevice() public static méthode

Finds a device given its PID and VID
public static FindDevice ( int nVid, int nPid, Type oType ) : HIDDevice
nVid int Vendor id for device (VID)
nPid int Product id for device (PID)
oType System.Type Type of device class to create
Résultat HIDDevice

HandleDataReceived() protected méthode

virtual handler for any action to be taken when data is received. Override to use.
protected HandleDataReceived ( InputReport oInRep ) : void
oInRep InputReport The input report that was received
Résultat void

HandleDeviceRemoved() protected méthode

Virtual handler for any action to be taken when a device is removed. Override to use.
protected HandleDeviceRemoved ( ) : void
Résultat void

ReadCompleted() protected méthode

Callback for above. Care with this as it will be called on the background thread from the async read
protected ReadCompleted ( IAsyncResult iResult ) : void
iResult IAsyncResult Async result parameter
Résultat void

Write() protected méthode

Write an output report to the device.
protected Write ( OutputReport oOutRep ) : void
oOutRep OutputReport Output report to write
Résultat void