Return the run-time status of Rovio including camera settings, true track sensor settings, etc. Part of the Other command. Call Update() 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.Other.StatusComponent:

Public Member Functions
	StatusComponent (Robot _robot)
	The constructor.

override void	Update ()
	Update the report.

Public Member Functions inherited from Rovio.Component
	Component (Robot _robot)
	The constructor.

Properties
int	CameraState `[get]`
	Camera state: 0 = off, 1 = on.

int	ModemState `[get]`
	Modem state: 0 = off, 1 = on line(common mode), 2 = connecting(common mode).

int	PPPoEState `[get]`
	PPPoE State - same as Modem state.

int	XDirection `[get]`
	Reserved.

int	YDirection `[get]`
	Reserved.

int	Focus `[get]`
	Reserved.

int	Brightness `[get]`
	Camera brightness: 0-255.

int	Contrast `[get]`
	Camera contrast: 0-255.

Camera.ImageResolution	Resolution `[get]`
	Camera resolution.

Camera.ImageCompression	Compression `[get]`
	Reserved.

int	Privilege `[get]`
	Priviliege: 0 = super user(administrator), 1 = common user.

int	PictureIndex `[get]`
	Picture index: 999999 = invalid picture.

int	EmailState `[get]`
	Email state: 0 = do not send motion-detected pictures, 1 = send motion-detected pictures, success, 2 = send motion-detected pictures, fail (wrong IP, user or password?).

int	UserCheck `[get]`
	User check: 0 = do not check user, any user can connect and act as a super user, 1 = username and password required, only username is "administrator" has the super privilege.

int	ImageFileLength `[get]`
	Image file length: length in bytes.

int	MonitorRect `[get]`
	4 bytes left(0-9999), 4 bytes - top(0-9999), 4 bytes - right(0-9999), 4 bytes - bottom(0-9999)

int	FTPState `[get]`
	FTP state: 0 = disable ftp upload, 1 = enable ftp upload, and upload success, 2 = enable ftp upload, but fail(wrong IP, user or password?).

int	Saturation `[get]`
	Camera image saturation: 0-255.

int	MotionDetectedIndex `[get]`
	Motion detection index: 999999 = init value.

int	Hue `[get]`
	Hue: 0-255.

int	Sharpness `[get]`
	Sharpness: 0-255.

int	MotionDetectWay `[get]`
	0 = no motion detection, non-zero = motion detection

Camera.CameraFlickerFrequency	FlickerFrequency `[get]`
	Camera's frequency: 0 = outdoor, 1 = 50Hz, 2 = 60Hz

int	ChannelMode `[get]`
	0 = fixed mode, 1 = round robin mode.

int	ChannelValue `[get]`
	In fixed mode, the value may be from 0 to 3 In round robin mode, the value may be from 1 to 15.

int	AudioVolume `[get]`
	Audio volume.

int	DynamicDNSState `[get]`
	DNS state: 0 = no update, 1 = updating, 2 = update successful, 3 = update failed.

int	AudioState `[get]`
	0 = audio disabled, 1 = audio enabled.

int	Framerate `[get]`
	Framerate

int	SpeakerVolume `[get]`
	Speaker volume.

int	MicVolume `[get]`
	Microphone volume.

int	ShowTime `[get]`
	0 = do not show time in image, 1 = show time in image.

int	WifiStrength `[get]`
	0-15, 0 is max.

int	BatteryLevel `[get]`
	0-255, 255 is Max.

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 Attributes inherited from Rovio.Component
Robot	robot
	The robot class, accessible by all dervied classes.

Detailed Description

Return the run-time status of Rovio including camera settings, true track sensor settings, etc. Part of the Other command. Call Update() 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.Other.StatusComponent.StatusComponent ( Robot _robot )

The constructor.

Member Function Documentation

override void Rovio.API.Other.StatusComponent.Update ( )

virtual

Update the report.

Reimplemented from Rovio.Component.

Property Documentation

int Rovio.API.Other.StatusComponent.AudioState

get

0 = audio disabled, 1 = audio enabled.

int Rovio.API.Other.StatusComponent.AudioVolume

get

Audio volume.

int Rovio.API.Other.StatusComponent.BatteryLevel

get

0-255, 255 is Max.

int Rovio.API.Other.StatusComponent.Brightness

get

Camera brightness: 0-255.

int Rovio.API.Other.StatusComponent.CameraState

get

Camera state: 0 = off, 1 = on.

int Rovio.API.Other.StatusComponent.ChannelMode

get

0 = fixed mode, 1 = round robin mode.

int Rovio.API.Other.StatusComponent.ChannelValue

get

In fixed mode, the value may be from 0 to 3 In round robin mode, the value may be from 1 to 15.

Camera.ImageCompression Rovio.API.Other.StatusComponent.Compression

get

Reserved.

int Rovio.API.Other.StatusComponent.Contrast

get

Camera contrast: 0-255.

int Rovio.API.Other.StatusComponent.DynamicDNSState

get

DNS state: 0 = no update, 1 = updating, 2 = update successful, 3 = update failed.

int Rovio.API.Other.StatusComponent.EmailState

get

Email state: 0 = do not send motion-detected pictures, 1 = send motion-detected pictures, success, 2 = send motion-detected pictures, fail (wrong IP, user or password?).

Camera.CameraFlickerFrequency Rovio.API.Other.StatusComponent.FlickerFrequency

get

Camera's frequency: 0 = outdoor, 1 = 50Hz, 2 = 60Hz

int Rovio.API.Other.StatusComponent.Focus

get

Reserved.

int Rovio.API.Other.StatusComponent.Framerate

get

Framerate

int Rovio.API.Other.StatusComponent.FTPState

get

FTP state: 0 = disable ftp upload, 1 = enable ftp upload, and upload success, 2 = enable ftp upload, but fail(wrong IP, user or password?).

int Rovio.API.Other.StatusComponent.Hue

get

Hue: 0-255.

int Rovio.API.Other.StatusComponent.ImageFileLength

get

Image file length: length in bytes.

int Rovio.API.Other.StatusComponent.MicVolume

get

Microphone volume.

int Rovio.API.Other.StatusComponent.ModemState

get

Modem state: 0 = off, 1 = on line(common mode), 2 = connecting(common mode).

int Rovio.API.Other.StatusComponent.MonitorRect

get

4 bytes left(0-9999), 4 bytes - top(0-9999), 4 bytes - right(0-9999), 4 bytes - bottom(0-9999)

Todo:: fix the return value

int Rovio.API.Other.StatusComponent.MotionDetectedIndex

get

Motion detection index: 999999 = init value.

int Rovio.API.Other.StatusComponent.MotionDetectWay

get

0 = no motion detection, non-zero = motion detection

int Rovio.API.Other.StatusComponent.PictureIndex

get

Picture index: 999999 = invalid picture.

int Rovio.API.Other.StatusComponent.PPPoEState

get

PPPoE State - same as Modem state.

int Rovio.API.Other.StatusComponent.Privilege

get

Priviliege: 0 = super user(administrator), 1 = common user.

Camera.ImageResolution Rovio.API.Other.StatusComponent.Resolution

get

Camera resolution.

int Rovio.API.Other.StatusComponent.Saturation

get

Camera image saturation: 0-255.

int Rovio.API.Other.StatusComponent.Sharpness

get

Sharpness: 0-255.

int Rovio.API.Other.StatusComponent.ShowTime

get

0 = do not show time in image, 1 = show time in image.

int Rovio.API.Other.StatusComponent.SpeakerVolume

get

Speaker volume.

int Rovio.API.Other.StatusComponent.UserCheck

get

User check: 0 = do not check user, any user can connect and act as a super user, 1 = username and password required, only username is "administrator" has the super privilege.

int Rovio.API.Other.StatusComponent.WifiStrength

get

0-15, 0 is max.

int Rovio.API.Other.StatusComponent.XDirection

get

Reserved.

int Rovio.API.Other.StatusComponent.YDirection

get

Reserved.

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

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

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation