C# 클래스 RovioLib.RovioController

Class for accessing Rovio API
파일 보기 프로젝트 열기: shtirlic/rovio-dotnet

공개 메소드들

메소드 설명
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.

메소드 상세

AbortRecording() 공개 메소드

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

ChangeBrightness() 공개 메소드

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)
리턴 string

ChangeCompressRatio() 공개 메소드

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)
리턴 string

ChangeFramerate() 공개 메소드

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

ChangeMicVolume() 공개 메소드

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)
리턴 string

ChangeResolution() 공개 메소드

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}
리턴 string

ChangeSpeakerVolume() 공개 메소드

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)
리턴 string

ClearAllPaths() 공개 메소드

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

DelUser() 공개 메소드

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

Deletepath() 공개 메소드

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

EmailImage() 공개 메소드

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

GetCamera() 공개 메소드

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

GetDDNS() 공개 메소드

Get DDNS settings.
public GetDDNS ( ) : string
리턴 string

GetData() 공개 메소드

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

GetHttp() 공개 메소드

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

GetIP() 공개 메소드

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

GetImage() 공개 메소드

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

GetLibNSVersion() 공개 메소드

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

GetLog() 공개 메소드

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

GetLogo() 공개 메소드

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

GetMCUReport() 공개 메소드

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

GetMac() 공개 메소드

Get Mac address.
public GetMac ( ) : string
리턴 string

GetMail() 공개 메소드

Get email settings.
public GetMail ( ) : string
리턴 string

GetMediaFormat() 공개 메소드

Get the media format.
public GetMediaFormat ( ) : string
리턴 string

GetMyself() 공개 메소드

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

GetName() 공개 메소드

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

GetNavStatus() 공개 메소드

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

GetPathList() 공개 메소드

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

GetReport() 공개 메소드

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

GetStatus() 공개 메소드

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

GetTime() 공개 메소드

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

GetTuningParameters() 공개 메소드

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

GetUser() 공개 메소드

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

GetVer() 공개 메소드

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
리턴 string

GetWlan() 공개 메소드

Get WiFi settings.
public GetWlan ( ) : string
리턴 string

GoHome() 공개 메소드

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

GoHomeAndDock() 공개 메소드

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

ManualDrive() 공개 메소드

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

PausePlaying() 공개 메소드

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

PlayPathBackward() 공개 메소드

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
리턴 string

PlayPathForward() 공개 메소드

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
리턴 string

ReadParameter() 공개 메소드

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

Reboot() 공개 메소드

Reboot Rovio.
public Reboot ( ) : string
리턴 string

RenamePath() 공개 메소드

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

ResetHomeLocation() 공개 메소드

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

ResetNavStateMachine() 공개 메소드

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

RovioController() 공개 메소드

Constructor for RovioController object
public RovioController ( RovioSettings settings ) : System
settings RovioSettings RovioSettings object
리턴 System

RovioController() 공개 메소드

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
리턴 System

SaveParameter() 공개 메소드

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

SendMail() 공개 메소드

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

SetCamera() 공개 메소드

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

SetFactoryDefault() 공개 메소드

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

SetHeadLight() 공개 메소드

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

SetIRState() 공개 메소드

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

SetLogo() 공개 메소드

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
리턴 string

SetMac() 공개 메소드

Set Mac address.
public SetMac ( string MAC ) : string
MAC string Mac address
리턴 string

SetMediaFormat() 공개 메소드

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

SetName() 공개 메소드

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

SetTime() 공개 메소드

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)
리턴 string

SetTuningParameters() 공개 메소드

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

SetUser() 공개 메소드

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

SetUserCheck() 공개 메소드

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

StartRecoding() 공개 메소드

Start recording a path.
public StartRecoding ( ) : string
리턴 string

StopPlaying() 공개 메소드

Stop playing a path.
public StopPlaying ( ) : string
리턴 string

StopRecording() 공개 메소드

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
리턴 string

UpdateHomePosition() 공개 메소드

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