RobotLib  1
A set of software wrappers for Rovio, Roomba and NXT robots written in C#.
 All Classes Namespaces Functions Variables Enumerations Properties Pages
Public Member Functions | Public Attributes | List of all members
Roomba.Robot Class Reference

The main class for communication with Roomba through a serial interface. More...

Public Member Functions

void Connect (string port_name)
 Connect to the robot.
 
void Disconnect ()
 Disconnect from the robot.
 
void AutoConnect ()
 Automatically scan all existing serial ports and connect to the first visible robot.
 
void Send (byte[] command)
 Send a byte array corresponding to a desired command.
 
void Receive (ref byte[] data, int offset, int count)
 Receive data, with timeout functionality. The call to this method has to be preceded by an appropriate request (see the Send function).
 

Public Attributes

SCI.SCI SCI
 All SCI commands.
 
Leds Leds
 LED related commands.
 
Sensors Sensors
 Sensor realted commands.
 

Detailed Description

The main class for communication with Roomba through a serial interface.

Todo:
Introduce helper classes for Roomba state, odometry, motors, etc. Implement iCreate specific methods.

Member Function Documentation

void Roomba.Robot.AutoConnect ( )

Automatically scan all existing serial ports and connect to the first visible robot.

It is slower than directly connecting to a specific port.

void Roomba.Robot.Connect ( string  port_name)

Connect to the robot.

Parameters
port_nameserial port name
void Roomba.Robot.Disconnect ( )

Disconnect from the robot.

void Roomba.Robot.Receive ( ref byte[]  data,
int  offset,
int  count 
)

Receive data, with timeout functionality. The call to this method has to be preceded by an appropriate request (see the Send function).

Parameters
data
offset
count
void Roomba.Robot.Send ( byte[]  command)

Send a byte array corresponding to a desired command.

Parameters
command

Member Data Documentation

Leds Roomba.Robot.Leds

LED related commands.

SCI.SCI Roomba.Robot.SCI

All SCI commands.

Sensors Roomba.Robot.Sensors

Sensor realted commands.


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