C# Class RovioLib.RovioController

Class for accessing Rovio API
Mostra file Open project: shtirlic/rovio-dotnet

Public Methods

Method Description
AbortRecording ( ) : string

Terminates recording of a path without storing it to flash memory.
ChangeBrightness ( int Brightness ) : string

Change the brightness setting of camera's images.
ChangeCompressRatio ( int Ratio ) : string

Change the quality setting of camera's images. (only available with MPEG4)
ChangeFramerate ( int Framerate ) : string

Change the frame rate setting of camera's images.
ChangeMicVolume ( int MicVolume ) : string

Change the Mic Volume setting of IP_Cam.
ChangeResolution ( int ResType ) : string

Change the resolution setting of camera's images.
ChangeSpeakerVolume ( int SpeakerVolume ) : string

Change the Speaker Volume setting of camera.
ClearAllPaths ( ) : string

Deletes all paths in the robot’s Flash memory.
DelUser ( string User ) : string

Delete a user account.
Deletepath ( string PathName ) : string

Deletes specified path.
EmailImage ( string email ) : string

Emails current image or if in path recording mode sets an action.
GetCamera ( ) : string

Get the camera sensor’s settings.
GetDDNS ( ) : string

Get DDNS settings.
GetData ( ) : string

The basic command for acquiring MJPEG. NOT IMPLEMENTED
GetHttp ( ) : string

Get HTTP server's settings.
GetIP ( string Interface ) : string

Get IP settings.
GetImage ( ) : Bitmap

The basic command for acquiring Image.
GetLibNSVersion ( ) : string

Returns string version of libNS and NS sensor.
GetLog ( ) : string

Get Rovio’s system logs information.
GetLogo ( ) : string

Get a logo string on the image.
GetMCUReport ( ) : string

Returns MCU report including wheel encoders and IR obstacle avoidance.
GetMac ( ) : string

Get Mac address.
GetMail ( ) : string

Get email settings.
GetMediaFormat ( ) : string

Get the media format.
GetMyself ( bool ShowPrivilege ) : string

Get the username who sent this HTTP request.
GetName ( ) : string

Get camera's name.
GetNavStatus ( ) : string

Reports navigation state.

Name changed from GetStatus (in API two fucntions with same name)

GetPathList ( ) : string

Returns a list of paths stored in the robot.
GetReport ( ) : string

Generates a report from libNS module that provides Rovio’s current status.
GetStatus ( ) : string

Get run-time status of Rovio.
GetTime ( ) : string

Get current IP Camera's time zone and time.
GetTuningParameters ( ) : string

Returns homing, docking and driving parameters.
GetUser ( bool ShowPrivilege ) : string

Get the users list of IP Camera.
GetVer ( ) : string

Get Rovio’s base firmware version, Rovio also has a UI version and a NS2 version this function only get the base OS version.
GetWlan ( ) : string

Get WiFi settings.
GoHome ( ) : string

Drive to home location in front of charging station.
GoHomeAndDock ( ) : string

Drive to home location in front of charging station and dock.
ManualDrive ( int drive, int speed ) : string

Accepts manual driving commands.
PausePlaying ( ) : string

Pause the robot and waits for a new pause or stop command.
PlayPathBackward ( string PathName ) : string

Replays a stored path from closest point to the beginning; If NorthStar signal is lost it stops.

In API 1.2 there is no mention of PathName parameter

PlayPathForward ( string PathName ) : string

Replays a stored path from closest point to the end; If the NorthStar signal is lost, it stops.

In API 1.2 there is no mention of PathName parameter

ReadParameter ( long index ) : string

Read parameter in the robot’s Flash memory.
Reboot ( ) : string

Reboot Rovio.
RenamePath ( string OldPathName, string NewPathName ) : string

Rename the old path.
ResetHomeLocation ( ) : string

Clears home location in the robot's Flash memory.
ResetNavStateMachine ( ) : string

Stops whatever it was doing and resets to idle state.
RovioController ( RovioSettings settings ) : System

Constructor for RovioController object
RovioController ( string username, string password, string address ) : System

Constructor for RovioController object
SaveParameter ( long index, long value ) : string

Stores parameter in the robot’s Flash memory.
SendMail ( ) : string

Send an email with IPCam images.
SetCamera ( int Frequency ) : string

Change camera sensor’s settings.
SetFactoryDefault ( ) : string

Change all settings to factory-default.
SetHeadLight ( int Value ) : string

Turn off or turn on Rovio head light.
SetIRState ( int state ) : string

Turning on/off IR detector.
SetLogo ( string showstring, int pos ) : string

Set a logo string on the image.
SetMac ( string MAC ) : string

Set Mac address.
SetMediaFormat ( int Audio, int Video ) : string

Set the media format.
SetName ( string CameraName ) : string

Set camera's name.
SetTime ( long Sec1970, int TimeZone ) : string

Set server time zone and time.
SetTuningParameters ( ) : string

Change homing, docking and driving parameters – speed for driving commands. NOT IMPLEMENTED
SetUser ( string User, string Pass ) : string

Add a user or change the password for existed user.
SetUserCheck ( bool Check ) : string

Enable or disable user authorization check.
StartRecoding ( ) : string

Start recording a path.
StopPlaying ( ) : string

Stop playing a path.
StopRecording ( string PathName ) : string

Stops the recoding of a path and stores it in flash memory; javascript will give default name if user does not provide one.
UpdateHomePosition ( ) : string

Define current position as home location in front of charging station.

Method Details

AbortRecording() public method

Terminates recording of a path without storing it to flash memory.
public AbortRecording ( ) : string
return string

ChangeBrightness() public method

Change the brightness setting of camera's images.
public ChangeBrightness ( int Brightness ) : string
Brightness int 0 - 6 (The lower the value is, the dimmer the image is)
return string

ChangeCompressRatio() public method

Change the quality setting of camera's images. (only available with MPEG4)
public ChangeCompressRatio ( int Ratio ) : string
Ratio int 0 – 2 (representing low, medium and high quality respectively)
return string

ChangeFramerate() public method

Change the frame rate setting of camera's images.
public ChangeFramerate ( int Framerate ) : string
Framerate int 2 – 32 frame per seconds respectively
return string

ChangeMicVolume() public method

Change the Mic Volume setting of IP_Cam.
public ChangeMicVolume ( int MicVolume ) : string
MicVolume int 0 - 31 (The lower the value is, the lower the mic volume is)
return string

ChangeResolution() public method

Change the resolution setting of camera's images.
public ChangeResolution ( int ResType ) : string
ResType int Camera supports 4 types of resolution:0 - {176, 144}1 - {352, 288}2 - {320, 240} (Default)3 - {640, 480}
return string

ChangeSpeakerVolume() public method

Change the Speaker Volume setting of camera.
public ChangeSpeakerVolume ( int SpeakerVolume ) : string
SpeakerVolume int 0 - 31 (The lower the value is, the lower the speaker volume is)
return string

ClearAllPaths() public method

Deletes all paths in the robot’s Flash memory.
public ClearAllPaths ( ) : string
return string

DelUser() public method

Delete a user account.
public DelUser ( string User ) : string
User string
return string

Deletepath() public method

Deletes specified path.
public Deletepath ( string PathName ) : string
PathName string name of the path
return string

EmailImage() public method

Emails current image or if in path recording mode sets an action.
public EmailImage ( string email ) : string
email string email address ([email protected])
return string

GetCamera() public method

Get the camera sensor’s settings.
public GetCamera ( ) : string
return string

GetDDNS() public method

Get DDNS settings.
public GetDDNS ( ) : string
return string

GetData() public method

The basic command for acquiring MJPEG. NOT IMPLEMENTED
public GetData ( ) : string
return string

GetHttp() public method

Get HTTP server's settings.
public GetHttp ( ) : string
return string

GetIP() public method

Get IP settings.
public GetIP ( string Interface ) : string
Interface string eth1, wlan0
return string

GetImage() public method

The basic command for acquiring Image.
public GetImage ( ) : Bitmap
return System.Drawing.Bitmap

GetLibNSVersion() public method

Returns string version of libNS and NS sensor.
public GetLibNSVersion ( ) : string
return string

GetLog() public method

Get Rovio’s system logs information.
public GetLog ( ) : string
return string

GetLogo() public method

Get a logo string on the image.
public GetLogo ( ) : string
return string

GetMCUReport() public method

Returns MCU report including wheel encoders and IR obstacle avoidance.
public GetMCUReport ( ) : string
return string

GetMac() public method

Get Mac address.
public GetMac ( ) : string
return string

GetMail() public method

Get email settings.
public GetMail ( ) : string
return string

GetMediaFormat() public method

Get the media format.
public GetMediaFormat ( ) : string
return string

GetMyself() public method

Get the username who sent this HTTP request.
public GetMyself ( bool ShowPrivilege ) : string
ShowPrivilege bool
return string

GetName() public method

Get camera's name.
public GetName ( ) : string
return string

GetNavStatus() public method

Reports navigation state.
Name changed from GetStatus (in API two fucntions with same name)
public GetNavStatus ( ) : string
return string

GetPathList() public method

Returns a list of paths stored in the robot.
public GetPathList ( ) : string
return string

GetReport() public method

Generates a report from libNS module that provides Rovio’s current status.
public GetReport ( ) : string
return string

GetStatus() public method

Get run-time status of Rovio.
public GetStatus ( ) : string
return string

GetTime() public method

Get current IP Camera's time zone and time.
public GetTime ( ) : string
return string

GetTuningParameters() public method

Returns homing, docking and driving parameters.
public GetTuningParameters ( ) : string
return string

GetUser() public method

Get the users list of IP Camera.
public GetUser ( bool ShowPrivilege ) : string
ShowPrivilege bool
return string

GetVer() public method

Get Rovio’s base firmware version, Rovio also has a UI version and a NS2 version this function only get the base OS version.
public GetVer ( ) : string
return string

GetWlan() public method

Get WiFi settings.
public GetWlan ( ) : string
return string

GoHome() public method

Drive to home location in front of charging station.
public GoHome ( ) : string
return string

GoHomeAndDock() public method

Drive to home location in front of charging station and dock.
public GoHomeAndDock ( ) : string
return string

ManualDrive() public method

Accepts manual driving commands.
public ManualDrive ( int drive, int speed ) : string
drive int
speed int
return string

PausePlaying() public method

Pause the robot and waits for a new pause or stop command.
public PausePlaying ( ) : string
return string

PlayPathBackward() public method

Replays a stored path from closest point to the beginning; If NorthStar signal is lost it stops.
In API 1.2 there is no mention of PathName parameter
public PlayPathBackward ( string PathName ) : string
PathName string
return string

PlayPathForward() public method

Replays a stored path from closest point to the end; If the NorthStar signal is lost, it stops.
In API 1.2 there is no mention of PathName parameter
public PlayPathForward ( string PathName ) : string
PathName string
return string

ReadParameter() public method

Read parameter in the robot’s Flash memory.
public ReadParameter ( long index ) : string
index long 0 – 19
return string

Reboot() public method

Reboot Rovio.
public Reboot ( ) : string
return string

RenamePath() public method

Rename the old path.
public RenamePath ( string OldPathName, string NewPathName ) : string
OldPathName string
NewPathName string
return string

ResetHomeLocation() public method

Clears home location in the robot's Flash memory.
public ResetHomeLocation ( ) : string
return string

ResetNavStateMachine() public method

Stops whatever it was doing and resets to idle state.
public ResetNavStateMachine ( ) : string
return string

RovioController() public method

Constructor for RovioController object
public RovioController ( RovioSettings settings ) : System
settings RovioSettings RovioSettings object
return System

RovioController() public method

Constructor for RovioController object
public RovioController ( string username, string password, string address ) : System
username string Username to access Rovio
password string Password to access Rovio
address string Address to acces Rovio
return System

SaveParameter() public method

Stores parameter in the robot’s Flash memory.
public SaveParameter ( long index, long value ) : string
index long 0 – 19
value long 32bit signed integer
return string

SendMail() public method

Send an email with IPCam images.
public SendMail ( ) : string
return string

SetCamera() public method

Change camera sensor’s settings.
public SetCamera ( int Frequency ) : string
Frequency int 50 – 50Hz, 60 – 60Hz, 0 – Auto detect
return string

SetFactoryDefault() public method

Change all settings to factory-default.
public SetFactoryDefault ( ) : string
return string

SetHeadLight() public method

Turn off or turn on Rovio head light.
public SetHeadLight ( int Value ) : string
Value int 0 - Off, 1 - On
return string

SetIRState() public method

Turning on/off IR detector.
public SetIRState ( int state ) : string
state int 0 - off, 1 - on
return string

SetLogo() public method

Set a logo string on the image.
public SetLogo ( string showstring, int pos ) : string
showstring string time - time, date - date,ver - version
pos int 0 – top left, 1 – top right, 2 – bottom left, 3 – bottom right
return string

SetMac() public method

Set Mac address.
public SetMac ( string MAC ) : string
MAC string Mac address
return string

SetMediaFormat() public method

Set the media format.
public SetMediaFormat ( int Audio, int Video ) : string
Audio int 0 – 4
Video int 0 – 1
return string

SetName() public method

Set camera's name.
public SetName ( string CameraName ) : string
CameraName string
return string

SetTime() public method

Set server time zone and time.
public SetTime ( long Sec1970, int TimeZone ) : string
Sec1970 long seconds since "00:00:00 1/1/1970".
TimeZone int Time zone in minutes. (e.g. Beijing is GMT+08:00, TimeZone = -480)
return string

SetTuningParameters() public method

Change homing, docking and driving parameters – speed for driving commands. NOT IMPLEMENTED
public SetTuningParameters ( ) : string
return string

SetUser() public method

Add a user or change the password for existed user.
public SetUser ( string User, string Pass ) : string
User string
Pass string
return string

SetUserCheck() public method

Enable or disable user authorization check.
public SetUserCheck ( bool Check ) : string
Check bool
return string

StartRecoding() public method

Start recording a path.
public StartRecoding ( ) : string
return string

StopPlaying() public method

Stop playing a path.
public StopPlaying ( ) : string
return string

StopRecording() public method

Stops the recoding of a path and stores it in flash memory; javascript will give default name if user does not provide one.
public StopRecording ( string PathName ) : string
PathName string name of the path
return string

UpdateHomePosition() public method

Define current position as home location in front of charging station.
public UpdateHomePosition ( ) : string
return string