com.aldebaran.qi.helper.proxies

Class ALSystem

java.lang.Object

com.aldebaran.qi.helper.ALProxy

com.aldebaran.qi.helper.proxies.ALSystem

public class ALSystem
extends ALProxy

See Also:

NAOqi APIs for ALSystem

Field Summary

Fields inherited from class com.aldebaran.qi.helper.ALProxy

name, service

Constructor Summary

Constructors

Constructor and Description
ALSystem(Session session)

Method Summary

Modifier and Type	Method and Description
void	changePassword(java.lang.String oldPassword, java.lang.String newPassword) Change the user password.
void	clearStats()
java.util.List<Tuple4<java.lang.String,java.lang.String,java.lang.Long,java.lang.Long>>	diskFree(java.lang.Boolean all) Display free disk space
void	exit() Exits and unregisters the module.
java.lang.Integer	freeMemory() Amount of available memory in heap
java.lang.String	getBrokerName() Gets the name of the parent broker.
java.lang.Object	getMethodHelp(java.lang.String methodName) Retrieves a method's description.
java.util.List<java.lang.String>	getMethodList() Retrieves the module's method list.
java.lang.Object	getModuleHelp() Retrieves the module's description.
java.lang.String	getUsage(java.lang.String name) Gets the method usage string.
java.lang.Boolean	isRunning(java.lang.Integer id) Returns true if the method is currently running.
java.lang.Boolean	isStatsEnabled()
java.lang.Boolean	isTraceEnabled()
java.lang.Boolean	ping() Just a ping.
java.lang.String	previousSystemVersion() Previous system version before software update (empty if this is not the 1st boot after a software update)
void	reboot() Reboot robot
java.lang.Object	robotIcon() Robot icon
java.lang.String	robotName() System hostname
java.lang.Boolean	setRobotName(java.lang.String name) Set system hostname
java.lang.Boolean	setTimezone(java.lang.String timezone) Set current timezone
void	shutdown() Shutdown robot
void	stop(java.lang.Integer id) returns true if the method is currently running
Tuple3<java.lang.String,java.lang.String,java.lang.String>	systemInfo() Running system version
java.lang.String	systemVersion() Running system version
java.lang.String	timezone() Current timezone
java.lang.Integer	totalMemory() Amount of total memory in heap
void	upgrade(java.lang.String image, java.lang.String checksum) Change the user password.
java.lang.String	version() Returns the version of the module.
java.lang.Boolean	wait(java.lang.Integer id, java.lang.Integer timeoutPeriod) Wait for the end of a long running method that was called using 'post'

Methods inherited from class com.aldebaran.qi.helper.ALProxy

call, connect, connect, disconnect, getNaoqiType, getService, isProxyReady, setService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ALSystem

public ALSystem(Session session)
         throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

isStatsEnabled

public java.lang.Boolean isStatsEnabled()
                                 throws CallError,
                                        java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

clearStats

public void clearStats()
                throws CallError,
                       java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

isTraceEnabled

public java.lang.Boolean isTraceEnabled()
                                 throws CallError,
                                        java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

exit

public void exit()
          throws CallError,
                 java.lang.InterruptedException

Exits and unregisters the module.

Throws:

CallError

java.lang.InterruptedException

version

public java.lang.String version()
                         throws CallError,
                                java.lang.InterruptedException

Returns the version of the module.

Returns:

A string containing the version of the module.

Throws:

CallError

java.lang.InterruptedException

ping

public java.lang.Boolean ping()
                       throws CallError,
                              java.lang.InterruptedException

Just a ping. Always returns true

Returns:

returns true

Throws:

CallError

java.lang.InterruptedException

getMethodList

public java.util.List<java.lang.String> getMethodList()
                                               throws CallError,
                                                      java.lang.InterruptedException

Retrieves the module's method list.

Returns:

An array of method names.

Throws:

CallError

java.lang.InterruptedException

getMethodHelp

public java.lang.Object getMethodHelp(java.lang.String methodName)
                               throws CallError,
                                      java.lang.InterruptedException

Retrieves a method's description.

Parameters:

methodName - The name of the method.

Returns:

A structure containing the method's description.

Throws:

CallError

java.lang.InterruptedException

getModuleHelp

public java.lang.Object getModuleHelp()
                               throws CallError,
                                      java.lang.InterruptedException

Retrieves the module's description.

Returns:

A structure describing the module.

Throws:

CallError

java.lang.InterruptedException

wait

public java.lang.Boolean wait(java.lang.Integer id,
                              java.lang.Integer timeoutPeriod)
                       throws CallError,
                              java.lang.InterruptedException

Wait for the end of a long running method that was called using 'post'

Parameters:

id - The ID of the method that was returned when calling the method using 'post'

timeoutPeriod - The timeout period in ms. To wait indefinately, use a timeoutPeriod of zero.

Returns:

True if the timeout period terminated. False if the method returned.

Throws:

CallError

java.lang.InterruptedException

isRunning

public java.lang.Boolean isRunning(java.lang.Integer id)
                            throws CallError,
                                   java.lang.InterruptedException

Returns true if the method is currently running.

Parameters:

id - The ID of the method that was returned when calling the method using 'post'

Returns:

True if the method is currently running

Throws:

CallError

java.lang.InterruptedException

stop

public void stop(java.lang.Integer id)
          throws CallError,
                 java.lang.InterruptedException

returns true if the method is currently running

Parameters:

id - the ID of the method to wait for

Throws:

CallError

java.lang.InterruptedException

getBrokerName

public java.lang.String getBrokerName()
                               throws CallError,
                                      java.lang.InterruptedException

Gets the name of the parent broker.

Returns:

The name of the parent broker.

Throws:

CallError

java.lang.InterruptedException

getUsage

public java.lang.String getUsage(java.lang.String name)
                          throws CallError,
                                 java.lang.InterruptedException

Gets the method usage string. This summarises how to use the method.

Parameters:

name - The name of the method.

Returns:

A string that summarises the usage of the method.

Throws:

CallError

java.lang.InterruptedException

diskFree

public java.util.List<Tuple4<java.lang.String,java.lang.String,java.lang.Long,java.lang.Long>> diskFree(java.lang.Boolean all)
                                                                                                 throws CallError,
                                                                                                        java.lang.InterruptedException

Display free disk space

Parameters:

all - Show all mount partions.

Returns:

A vector with all partions' infos

Throws:

CallError

java.lang.InterruptedException

robotName

public java.lang.String robotName()
                           throws CallError,
                                  java.lang.InterruptedException

System hostname

Returns:

name of the robot

Throws:

CallError

java.lang.InterruptedException

setRobotName

public java.lang.Boolean setRobotName(java.lang.String name)
                               throws CallError,
                                      java.lang.InterruptedException

Set system hostname

Parameters:

name - name to use

Returns:

whether the operation was successful

Throws:

CallError

java.lang.InterruptedException

robotIcon

public java.lang.Object robotIcon()
                           throws CallError,
                                  java.lang.InterruptedException

Robot icon

Returns:

icon of the robot

Throws:

CallError

java.lang.InterruptedException

shutdown

public void shutdown()
              throws CallError,
                     java.lang.InterruptedException

Shutdown robot

Throws:

CallError

java.lang.InterruptedException

reboot

public void reboot()
            throws CallError,
                   java.lang.InterruptedException

Reboot robot

Throws:

CallError

java.lang.InterruptedException

systemVersion

public java.lang.String systemVersion()
                               throws CallError,
                                      java.lang.InterruptedException

Running system version

Returns:

running system version

Throws:

CallError

java.lang.InterruptedException

systemInfo

public Tuple3<java.lang.String,java.lang.String,java.lang.String> systemInfo()
                                                                      throws CallError,
                                                                             java.lang.InterruptedException

Running system version

Returns:

information about the system version

Throws:

CallError

java.lang.InterruptedException

freeMemory

public java.lang.Integer freeMemory()
                             throws CallError,
                                    java.lang.InterruptedException

Amount of available memory in heap

Returns:

amount of available memory in heap

Throws:

CallError

java.lang.InterruptedException

totalMemory

public java.lang.Integer totalMemory()
                              throws CallError,
                                     java.lang.InterruptedException

Amount of total memory in heap

Returns:

amount of total memory in heap

Throws:

CallError

java.lang.InterruptedException

timezone

public java.lang.String timezone()
                          throws CallError,
                                 java.lang.InterruptedException

Current timezone

Returns:

current timezone

Throws:

CallError

java.lang.InterruptedException

setTimezone

public java.lang.Boolean setTimezone(java.lang.String timezone)
                              throws CallError,
                                     java.lang.InterruptedException

Set current timezone

Parameters:

timezone - timezone to use

Returns:

whether the operation was successful

Throws:

CallError

java.lang.InterruptedException

previousSystemVersion

public java.lang.String previousSystemVersion()
                                       throws CallError,
                                              java.lang.InterruptedException

Previous system version before software update (empty if this is not the 1st boot after a software update)

Returns:

Previous system version before software update.

Throws:

CallError

java.lang.InterruptedException

changePassword

public void changePassword(java.lang.String oldPassword,
                           java.lang.String newPassword)
                    throws CallError,
                           java.lang.InterruptedException

Change the user password.

Parameters:

old - password The current password of the user.

new - password The new user password.

Throws:

CallError

java.lang.InterruptedException

upgrade

public void upgrade(java.lang.String image,
                    java.lang.String checksum)
             throws CallError,
                    java.lang.InterruptedException

Change the user password.

Parameters:

image - Local path to a valid image.

checksum - Local path to a md5 checksum file, or empty string for no verification

Throws:

CallError

java.lang.InterruptedException