UsbController Class Reference

UsbController. More...

Inheritance diagram for UsbController:

Public Member Functions
void	begin (int)
	Start the UsbController. More...
void	end ()
	End the UsbController. More...
int	available ()
	Returns number of bytes available in the buffer. More...
int	print (string)
	Print string to the console. More...
string	readLine ()
	Read the next line in the buffer. More...
string	readChar ()
	Read the next character in the buffer. More...
string	peekChar ()
	Peek the next character in the buffer. More...
int	read ()
	Read the next character in the buffer - same as readChar() More...
int	peek ()
	Peek the next character in the buffer - same as peekChar() More...
int	write (int)
	Write a character to the console. More...
void	setSerialMonitoring (bool)
	Set Serial Monitoring on or off. More...
bool	isSerialMonitoring ()
	Check if Serial Monitoring is on or off. More...
bool	deployProjectFromFileSystem (string, string)
	Deploy project from file system. More...
bool	isPortUp ()
	Check if port is powered on. More...
bool	isProtocolUp ()
	Check if port's protocol is up. More...
Public Member Functions inherited from Process
Device	getOwnerDevice ()
	Returns the device for this process. More...

Detailed Description

UsbController.

Member Function Documentation

available()

int UsbController::available

(

)

Returns number of bytes available in the buffer.

Returns

int, number of bytes

begin()

void UsbController::begin

(

int

)

Start the UsbController.

Parameters

speed,the

speed at which the Usb Controller is operating at

deployProjectFromFileSystem()

bool UsbController::deployProjectFromFileSystem	(	string	,
		string
	)

Deploy project from file system.

Parameters

projectName,name	of the project in string
path,path	of the project in string

Returns

bool, true if the project was successfully deployed and false if it's not

end()

void UsbController::end

(

)

End the UsbController.

isPortUp()

bool UsbController::isPortUp

(

)

Check if port is powered on.

Returns

bool, true if it's powered on and false if it's not

isProtocolUp()

bool UsbController::isProtocolUp

(

)

Check if port's protocol is up.

Returns

bool, true if port's protocol is up and false if it's not

isSerialMonitoring()

bool UsbController::isSerialMonitoring

(

)

Check if Serial Monitoring is on or off.

Returns

bool, true for on and false for off

peek()

int UsbController::peek

(

)

Peek the next character in the buffer - same as peekChar()

Returns

string, the next character in string format

peekChar()

string UsbController::peekChar

(

)

Peek the next character in the buffer.

Returns

string, the next character in string format

print()

int UsbController::print

(

string

)

Print string to the console.

Parameters

value,the

string to be printed

Returns

int, the length of the string

read()

int UsbController::read

(

)

Read the next character in the buffer - same as readChar()

Returns

string, the next character in string format

readChar()

string UsbController::readChar

(

)

Read the next character in the buffer.

Returns

string, the next character in string format

readLine()

string UsbController::readLine

(

)

Read the next line in the buffer.

Returns

string, the next line

setSerialMonitoring()

void UsbController::setSerialMonitoring

(

bool

)

Set Serial Monitoring on or off.

Parameters

bMonitoring,true

for on and false for off

write()

int UsbController::write

(

int

)

Write a character to the console.

Parameters

value,ascii

value of the character to be written \

---

The documentation for this class was generated from the following file:

• CUsbController.pki