Rovio.API.Movement.ReportComponent Class Reference

Inheritance diagram for Rovio.API.Movement.ReportComponent:

Public Member Functions
	ReportComponent (Robot _robot)
	Contructor.
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
double	X [get]
	Average X location of Rovio in relation to the strongest beacon.
double	Y [get]
	Average Y location of Rovio in relation to the strongest beacon.
double	Theta [get]
	Average orientation of Rovio in relation to the strongest beacon.
int	RoomID [get]
	Room ID: 0: home base, 1-9: mutable room ID.
int	NavigationSS [get]
	Navigation signal strength. %> 47000: strong signal %< 5000: no signal
int	BeaconSS [get]
	Signal strength for docking beacon. (0 - 65535)
int	BeaconX [get]
	Horizontal position of a beacon (as seen by NorthStar). (-32767 - 32768)
int	NextRoomID [get]
	The next strongest room beacon ID. -1: no room found, 1-9: mutable room ID.
int	NextRoomSS [get]
	The next strongest room beacon signal. (0 - 65535) 47000: strong signal < 5000: no signal
Movement.NavigationState	Status [get]
	Rovio status.
int	UIStatus [get]
	Mysterious and non-documented variable: UserInterface status?
int	Resistance [get]
	Status of robot resistance to drive into areas badly covered by NorthStar. NOT IN USE!
int	StateMachine [get]
	Current status of the navigation state machine.
int	WayPoint [get]
	Current waypoint on the path. (1 - 10)
int	Flags [get]
	Flags: 1: home position, 2: obstacle detected, 3: IR detector activated
int	Brightness [get]
	Camera brightness level.
Camera.ImageResolution	Resolution [get]
	Camera resolution.
Camera.ImageCompression	Compression [get]
	Camera compression ratio.
int	Framerate [get]
	Camera frame rate.
int	Privilege [get]
	User privilige settings. 0: admin, 1: guest
int	UserCheck [get]
	Authentication: 0: requires user/password 1: does not require user/password
int	SpeakerVolume [get]
	Speaker volume.
int	MicVolume [get]
	Micorpohne volume.
int	WifiSS [get]
	Wifi signal strength. (0 - 254)
int	ShowTime [get]
	Time display in the image: 0: off 1: on
int	DDNSState [get]
	DDNS update status: 0: no update, 1: updating, 2: update successful, 3: update failed
int	EmailState [get]
	Email update status. NOT IN USE!
int	BatteryLevel [get]
	Battery level: < 100: turn itself off, 100-106: go back home, 106-127: normal
int	Charging [get]
	Charging status: 0-79: not charging 80: charging
int	HeadPosition [get]
	Head position: 204: low 135-140: mid 65: high
Camera.CameraFlickerFrequency	FlickerFrequency [get]
	Camera flicker frequency.

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

Report class.

Todo:

'ui_status' is not documented,

Use the defined enums for popular commands (e.g. Resolution)

Constructor & Destructor Documentation

Rovio.API.Movement.ReportComponent.ReportComponent

(

Robot

_robot

)

Contructor.

Member Function Documentation

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

virtual

Update the report.

Reimplemented from Rovio.Component.

Property Documentation

int Rovio.API.Movement.ReportComponent.BatteryLevel

get

Battery level: < 100: turn itself off, 100-106: go back home, 106-127: normal

int Rovio.API.Movement.ReportComponent.BeaconSS

get

Signal strength for docking beacon. (0 - 65535)

int Rovio.API.Movement.ReportComponent.BeaconX

get

Horizontal position of a beacon (as seen by NorthStar). (-32767 - 32768)

int Rovio.API.Movement.ReportComponent.Brightness

get

Camera brightness level.

int Rovio.API.Movement.ReportComponent.Charging

get

Charging status: 0-79: not charging 80: charging

Camera.ImageCompression Rovio.API.Movement.ReportComponent.Compression

get

Camera compression ratio.

int Rovio.API.Movement.ReportComponent.DDNSState

get

DDNS update status: 0: no update, 1: updating, 2: update successful, 3: update failed

int Rovio.API.Movement.ReportComponent.EmailState

get

Email update status. NOT IN USE!

int Rovio.API.Movement.ReportComponent.Flags

get

Flags: 1: home position, 2: obstacle detected, 3: IR detector activated

Camera.CameraFlickerFrequency Rovio.API.Movement.ReportComponent.FlickerFrequency

get

Camera flicker frequency.

int Rovio.API.Movement.ReportComponent.Framerate

get

Camera frame rate.

int Rovio.API.Movement.ReportComponent.HeadPosition

get

Head position: 204: low 135-140: mid 65: high

int Rovio.API.Movement.ReportComponent.MicVolume

get

Micorpohne volume.

int Rovio.API.Movement.ReportComponent.NavigationSS

get

Navigation signal strength. %> 47000: strong signal %< 5000: no signal

int Rovio.API.Movement.ReportComponent.NextRoomID

get

The next strongest room beacon ID. -1: no room found, 1-9: mutable room ID.

int Rovio.API.Movement.ReportComponent.NextRoomSS

get

The next strongest room beacon signal. (0 - 65535)

47000: strong signal

< 5000: no signal

int Rovio.API.Movement.ReportComponent.Privilege

get

User privilige settings. 0: admin, 1: guest

int Rovio.API.Movement.ReportComponent.Resistance

get

Status of robot resistance to drive into areas badly covered by NorthStar. NOT IN USE!

Camera.ImageResolution Rovio.API.Movement.ReportComponent.Resolution

get

Camera resolution.

int Rovio.API.Movement.ReportComponent.RoomID

get

Room ID: 0: home base, 1-9: mutable room ID.

int Rovio.API.Movement.ReportComponent.ShowTime

get

Time display in the image: 0: off 1: on

int Rovio.API.Movement.ReportComponent.SpeakerVolume

get

Speaker volume.

int Rovio.API.Movement.ReportComponent.StateMachine

get

Current status of the navigation state machine.

Movement.NavigationState Rovio.API.Movement.ReportComponent.Status

get

Rovio status.

double Rovio.API.Movement.ReportComponent.Theta

get

Average orientation of Rovio in relation to the strongest beacon.

int Rovio.API.Movement.ReportComponent.UIStatus

get

Mysterious and non-documented variable: UserInterface status?

int Rovio.API.Movement.ReportComponent.UserCheck

get

Authentication: 0: requires user/password 1: does not require user/password

int Rovio.API.Movement.ReportComponent.WayPoint

get

Current waypoint on the path. (1 - 10)

int Rovio.API.Movement.ReportComponent.WifiSS

get

Wifi signal strength. (0 - 254)

double Rovio.API.Movement.ReportComponent.X

get

Average X location of Rovio in relation to the strongest beacon.

double Rovio.API.Movement.ReportComponent.Y

get

Average Y location of Rovio in relation to the strongest beacon.

---

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

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