Package Elib

Classes
class	AsyncResultNoResult
	Class used in System.IAsyncResult for example in Epuck.EndFtion It does not allow to return an answer. More...
class	AsyncResult
	Class used in System.IAsyncResult when the "End" function returns an answer. E.g M:Epuck.EndGetFtion(IAsyncResult). More...
class	Commands
	List of functions, which return commands for BTCom 1.1.3 with correct parameters.
class	Epuck
	A virtual representation of e-Puck, which allows control the robot with its methods. More...
class	ElibException
	The ElibEception is thrown, if an unusual situation happens in Elib. It wraps all other exceptions, which are thrown from Elib. More...
class	TimeoutElibException
	The TimeoutElibException is thrown if the "End" function implementing IAsyncResult was called and indicates that the answer to command has not been delivered in time. More...
class	SerialPortException
	If SerialPort class throws any exception, than this exception wraps the original exception. After that the SerialPortException is thrown. More...
class	ArgsException
	ArgsException is thrown if wrong arguments are passed to function in Elib. More...
class	CommandArgsException
	Thrown if command to e-Puck has nonsense values. More...
class	UnconnectedException
	Thrown if session with e-Puck has not started or has already ended. More...
class	Sercom
	Sercom wraps serial communication with e-Puck. Main goal is to keep application responsive, although the used serial communication could be very unresponsive. More...
class	Stamp
	A wrapper, which converts a system clock ticks to seconds.
Enumerations
enum	Turn { On = 0, Off = 1, Inv = 2 }
	An enumeration of possible action performed with LED on e-Puck. More...
enum	CamMode { BaW = 0, Color = 1 }
	E-Puck's camera can be in two colour modes. More...
enum	Zoom { Big = 1, Medium = 4, Small = 8 }
	E-Puck's camera has 3 possible states of zoom. More...
Functions
delegate void	OkfCallback (string answer, object Data)
	OkfCallback, KofCallback are delegates for methods, which should be passed together with commands to Sercom. These methods should implement how to react if sent command was confirmed(OkfCallback) or the time for answer elapsed(KofCallback).
delegate void	KofCallback (object Data)
	OkfCallback, KofCallback are delegates for methods, which should be passed together with commands to Sercom. These methods should implement how to react if sent command was confirmed(OkfCallback) or the time for answer elapsed(KofCallback).

---

Enumeration Type Documentation

enum Elib::CamMode

E-Puck's camera can be in two colour modes.

Enumerator:

BaW	Black and white mode. One pixel corresponds to one byte.
Color	Colour mode. One pixel corresponds to 2 bytes= 5+6+5 ~ R+G+B.

enum Elib::Turn

An enumeration of possible action performed with LED on e-Puck.

Enumerator:

On	Turns LED on.
Off	Turns LED off.
Inv	If the LED is on, turn it off and vice versa.

enum Elib::Zoom

E-Puck's camera has 3 possible states of zoom.

Enumerator:

Big	The biggest zoom. Useful for linear camera.
Medium	The medium zoom.
Small	The smallest zoom. Good for analyzing pictures.

---

Function Documentation

delegate void Elib.KofCallback

(

object

Data

)

OkfCallback, KofCallback are delegates for methods, which should be passed together with commands to Sercom. These methods should implement how to react if sent command was confirmed(OkfCallback) or the time for answer elapsed(KofCallback).

delegate void Elib.OkfCallback	(	string	answer,
		object	Data
	)

OkfCallback, KofCallback are delegates for methods, which should be passed together with commands to Sercom. These methods should implement how to react if sent command was confirmed(OkfCallback) or the time for answer elapsed(KofCallback).