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.
|
|
GetHttp ( ) : string |
Get HTTP server's settings.
|
|
GetIP ( string Interface ) : string |
Get IP settings.
|
|
GetImage ( ) : |
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 ( |
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.
|
|
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.
|
public ChangeBrightness ( int Brightness ) : string | ||
Brightness | int | 0 - 6 (The lower the value is, the dimmer the image is) |
return | string |
public ChangeCompressRatio ( int Ratio ) : string | ||
Ratio | int | 0 – 2 (representing low, medium and high quality respectively) |
return | string |
public ChangeFramerate ( int Framerate ) : string | ||
Framerate | int | 2 – 32 frame per seconds respectively |
return | string |
public ChangeMicVolume ( int MicVolume ) : string | ||
MicVolume | int | 0 - 31 (The lower the value is, the lower the mic volume is) |
return | string |
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 |
public ChangeSpeakerVolume ( int SpeakerVolume ) : string | ||
SpeakerVolume | int | 0 - 31 (The lower the value is, the lower the speaker volume is) |
return | string |
public Deletepath ( string PathName ) : string | ||
PathName | string | name of the path |
return | string |
public EmailImage ( string email ) : string | ||
string | email address ([email protected]) | |
return | string |
public GetIP ( string Interface ) : string | ||
Interface | string | eth1, wlan0 |
return | string |
public GetMyself ( bool ShowPrivilege ) : string | ||
ShowPrivilege | bool | |
return | string |
public GetUser ( bool ShowPrivilege ) : string | ||
ShowPrivilege | bool | |
return | string |
public ManualDrive ( int drive, int speed ) : string | ||
drive | int | |
speed | int | |
return | string |
public PlayPathBackward ( string PathName ) : string | ||
PathName | string | |
return | string |
public PlayPathForward ( string PathName ) : string | ||
PathName | string | |
return | string |
public ReadParameter ( long index ) : string | ||
index | long | 0 – 19 |
return | string |
public RenamePath ( string OldPathName, string NewPathName ) : string | ||
OldPathName | string | |
NewPathName | string | |
return | string |
public RovioController ( |
||
settings | RovioSettings object | |
return | System |
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 |
public SaveParameter ( long index, long value ) : string | ||
index | long | 0 – 19 |
value | long | 32bit signed integer |
return | string |
public SetCamera ( int Frequency ) : string | ||
Frequency | int | 50 – 50Hz, 60 – 60Hz, 0 – Auto detect |
return | string |
public SetHeadLight ( int Value ) : string | ||
Value | int | 0 - Off, 1 - On |
return | string |
public SetIRState ( int state ) : string | ||
state | int | 0 - off, 1 - on |
return | string |
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 |
public SetMediaFormat ( int Audio, int Video ) : string | ||
Audio | int | 0 – 4 |
Video | int | 0 – 1 |
return | string |
public SetName ( string CameraName ) : string | ||
CameraName | string | |
return | string |
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 |
public SetUser ( string User, string Pass ) : string | ||
User | string | |
Pass | string | |
return | string |
public StopRecording ( string PathName ) : string | ||
PathName | string | name of the path |
return | string |