C# Class LitDev.LDIOWarrior

Datei anzeigen Open project: litdev1/LitDev

Public Properties

Property	Type	Description
timeout	uint

Public Methods

Method	Description
Detatch ( ) : void	Disconnect all IO-Warrior devices.
GetName ( Primitive id ) : Primitive	Get the device name.
GetPID ( Primitive id ) : Primitive	Get the device PID.
GetReportSize ( Primitive id ) : Primitive	Get the report size. Number of bytes in a Read/Write. This the report size for channel 0.
GetSerialNumber ( Primitive id ) : Primitive	Get the device serial number.
GetSpecialReportSize ( Primitive id ) : Primitive	Get the special report size. Number of bytes in a special Read/Write. This the report size for channel 1.
GetVID ( ) : Primitive	Get the device VID (Common to all IOWarrior types).
GetVersion ( Primitive id ) : Primitive	Get the device firmware version.
Initialise ( ) : Primitive	Initialise IO-Warrior devices.
LCDWrite ( Primitive id, Primitive text ) : void	Write text to the LCD (untested).
LastError ( ) : Primitive	Get the last system error message. "" for no error (probably only useful for detailed error analysis of underlying system calls).
Read ( Primitive id, Primitive channel, Primitive blocking, Primitive count ) : Primitive	Read from the IO-Warrior device.
Write ( Primitive id, Primitive channel, Primitive data ) : Primitive	Write to the IO-Warrior device.

Private Methods

Method	Description
AddDevice ( uint id ) : string
ExtractDll ( ) : void
GetDevice ( uint id ) : IOWDevice
LoadAll ( ) : int
RemoveAll ( ) : void
RemoveDevice ( uint id ) : void

Method Details

Detatch() public static method

Disconnect all IO-Warrior devices.

public static Detatch ( ) : void
return	void

GetName() public static method

Get the device name.

public static GetName ( Primitive id ) : Primitive
id	Primitive	The device number (indexed from 1).
return	Primitive

GetPID() public static method

Get the device PID.

public static GetPID ( Primitive id ) : Primitive
id	Primitive	The device number (indexed from 1).
return	Primitive

GetReportSize() public static method

Get the report size. Number of bytes in a Read/Write. This the report size for channel 0.

public static GetReportSize ( Primitive id ) : Primitive
id	Primitive	The device number (indexed from 1).
return	Primitive

GetSerialNumber() public static method

Get the device serial number.

public static GetSerialNumber ( Primitive id ) : Primitive
id	Primitive	The device number (indexed from 1).
return	Primitive

GetSpecialReportSize() public static method

Get the special report size. Number of bytes in a special Read/Write. This the report size for channel 1.

public static GetSpecialReportSize ( Primitive id ) : Primitive
id	Primitive	The device number (indexed from 1).
return	Primitive

GetVID() public static method

Get the device VID (Common to all IOWarrior types).

public static GetVID ( ) : Primitive
return	Primitive

GetVersion() public static method

Get the device firmware version.

public static GetVersion ( Primitive id ) : Primitive
id	Primitive	The device number (indexed from 1).
return	Primitive

Initialise() public static method

Initialise IO-Warrior devices.

public static Initialise ( ) : Primitive
return	Primitive

LCDWrite() public static method

Write text to the LCD (untested).

public static LCDWrite ( Primitive id, Primitive text ) : void
id	Primitive	The device number (indexed from 1).
text	Primitive	The text to write.
return	void

LastError() public static method

Get the last system error message. "" for no error (probably only useful for detailed error analysis of underlying system calls).

public static LastError ( ) : Primitive
return	Primitive

Read() public static method

Read from the IO-Warrior device.

public static Read ( Primitive id, Primitive channel, Primitive blocking, Primitive count ) : Primitive
id	Primitive	The device number (indexed from 1).
channel	Primitive	The channel to read (indexed from 0).
blocking	Primitive	"True" (return after the state changes) or "False" (return with current state).
count	Primitive	The number of bytes to read (if zero, then the ReportSize is used if channel is 0 or SpecialReportSize if channel is 1). /// See GetReportSize and GetSpecialReportSize.
return	Primitive

Write() public static method

Write to the IO-Warrior device.

public static Write ( Primitive id, Primitive channel, Primitive data ) : Primitive
id	Primitive	The device number (indexed from 1).
channel	Primitive	The channel to write to (indexed from 0).
data	Primitive	An array of bytes to send [0 to 255]. /// The array size should be ReportSize for channel 0 and SpecialReportSize for channel 1. /// See GetReportSize and GetSpecialReportSize.
return	Primitive

Property Details

timeout public_oe static_oe property

public static uint timeout
return	uint