Rovio.API.Movement.MCUReportComponent Class Reference

Provides a run-time report from Rovio's microcontroller. Run the Update() method before accessing individual parameters of the report. This solution reduces the data traffic when accessing multiple parameters at the same time. More...

Inheritance diagram for Rovio.API.Movement.MCUReportComponent:

Public Member Functions
	MCUReportComponent (Robot _robot)
	The constructor.
override void	Update ()
	Update the report.
Public Member Functions inherited from Rovio.API.MovementComponent
	MovementComponent (Robot _robot)
	The constructor.
virtual string	Request (string value)
	Request and parse the movement command.
Public Member Functions inherited from Rovio.Component
	Component (Robot _robot)
	The constructor.

Properties
bool	LeftWheelRot [get]
	Left wheel odometry: positive rotation direction.
int	LeftWheelTicks [get]
	Left wheel odometry: number of ticks.
bool	RightWheelRot [get]
	Right wheel odometry: positive rotation direction.
int	RightWheelTicks [get]
	Right wheel odometry: number of ticks.
bool	RearWheelRot [get]
	Rear wheel odometry: positive rotation direction.
int	RearWheelTicks [get]
	Rear wheel odometry: number of ticks.
int	HeadPosition [get]
	Position of the head.
int	BatteryLevel [get]
	Battery level.
int	Status [get]
	Status.
bool	LightOn [get]
	The state of the front LED light.
bool	IRPowerOn [get]
	The power state of the IR proximity sensor.
bool	IRDetectorOn [get]
	The state of the IR proximity sensor.
Movement.ChargerStatus	ChargerStatus [get]
	Charger status.

Additional Inherited Members
Public Attributes inherited from Rovio.Component
bool	AutoUpdate = true
	Automatic update option for methods requesting more than one piece of information.
Protected Member Functions inherited from Rovio.API.MovementComponent
string	GetParameter (string value)
	Parse the specific parameter and return its value.
Protected Attributes inherited from Rovio.API.MovementComponent
string	report
	Stores the latest response from the robot. Usefull for commands supporting multiple fields in the response.

Detailed Description

Provides a run-time report from Rovio's microcontroller. Run the Update() method before accessing individual parameters of the report. This solution reduces the data traffic when accessing multiple parameters at the same time.

Constructor & Destructor Documentation

Rovio.API.Movement.MCUReportComponent.MCUReportComponent

(

Robot

_robot

)

The constructor.

Member Function Documentation

override void Rovio.API.Movement.MCUReportComponent.Update ( )

virtual

Update the report.

Reimplemented from Rovio.Component.

Property Documentation

int Rovio.API.Movement.MCUReportComponent.BatteryLevel

get

Battery level.

Movement.ChargerStatus Rovio.API.Movement.MCUReportComponent.ChargerStatus

get

Charger status.

int Rovio.API.Movement.MCUReportComponent.HeadPosition

get

Position of the head.

bool Rovio.API.Movement.MCUReportComponent.IRDetectorOn

get

The state of the IR proximity sensor.

bool Rovio.API.Movement.MCUReportComponent.IRPowerOn

get

The power state of the IR proximity sensor.

bool Rovio.API.Movement.MCUReportComponent.LeftWheelRot

get

Left wheel odometry: positive rotation direction.

int Rovio.API.Movement.MCUReportComponent.LeftWheelTicks

get

Left wheel odometry: number of ticks.

bool Rovio.API.Movement.MCUReportComponent.LightOn

get

The state of the front LED light.

bool Rovio.API.Movement.MCUReportComponent.RearWheelRot

get

Rear wheel odometry: positive rotation direction.

int Rovio.API.Movement.MCUReportComponent.RearWheelTicks

get

Rear wheel odometry: number of ticks.

bool Rovio.API.Movement.MCUReportComponent.RightWheelRot

get

Right wheel odometry: positive rotation direction.

int Rovio.API.Movement.MCUReportComponent.RightWheelTicks

get

Right wheel odometry: number of ticks.

int Rovio.API.Movement.MCUReportComponent.Status

get

Status.

---

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

• C:/Users/Greg/Documents/GitHub/RoboLib/src/Rovio.cs