ALSystem API

NAOqi Core - Overview | API | PartitionInfo

---

Namespace : AL

#include <alproxies/alsystemproxy.h>

Method list

As any module, this module inherits methods from ALModule API. It also has the following specific methods:

class ALSystemProxy

• ALSystemProxy::robotName
• ALSystemProxy::robotIcon
• ALSystemProxy::setRobotName
• ALSystemProxy::shutdown
• ALSystemProxy::reboot
• ALSystemProxy::systemVersion
• ALSystemProxy::timezone
• ALSystemProxy::setTimezone
• ALSystemProxy::freeMemory
• ALSystemProxy::totalMemory
• ALSystemProxy::diskFree
• ALSystemProxy::previousSystemVersion
• ALSystemProxy::changePassword
• ALSystemProxy::upgrade
• ALSystemProxy::factoryReset

Event list

• ALSystem/RobotNameChanged()

Methods

std::string ALSystemProxy::robotName()

Get robot name.

Returns:the robot name

AL::ALValue ALSystemProxy::robotIcon()

Get the content of the robot icon file.

Returns:a buffer containing the robot icon

bool ALSystemProxy::setRobotName(const std::string& name)

Set robot name. This will raise ALSystem/RobotNameChanged().

Parameters:

• name – Name to use.

Returns:

True if successful, false otherwise.

void ALSystemProxy::shutdown()

Shut down the robot after going to safety position using ALMotionProxy::rest.

void ALSystemProxy::reboot()

Reboot the robot after going to safety position using ALMotionProxy::rest.

std::string ALSystemProxy::systemVersion()

Get NAOqi OS version currently run by the robot.

Returns:the version of NAOqi OS

std::string ALSystemProxy::timezone()

Get timezone currently used by the robot.

Returns:Current timezone.

bool ALSystemProxy::setTimezone(const std::string& timezone)

Set timezone.

Parameters:

• timezone – Timezone to use.

Returns:

True if successful, false otherwise.

int ALSystemProxy::freeMemory()

Amount of available memory in heap.

Returns:Number of kb free on the heap.

int ALSystemProxy::totalMemory()

Amount of total memory in heap.

Returns:Number of total kb on the heap.

std::vector<AL::PartitionInfo> ALSystemProxy::diskFree(bool all)

Display free disk space for user data.

Parameters:

• all – Deprecated, has no effect.

Returns:

A vector containing information about the user data partition PartitionInfo.

std::string ALSystemProxy::previousSystemVersion()

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.

void ALSystemProxy::changePassword(const std::string& old, const std::string& new)

Change the user password on the robot. This password is required to login into system services such as: ssh, and ftp.

Parameters:

• old – The old password.
• new – The new password.

void ALSystemProxy::upgrade(const std::string& imageurl, const std::string& checksumurl)

Upgrade the system image.

Note

A reboot is required to terminate the upgrade.

Parameters:

• imageurl – The local path of the system image.
• checksum – The local path to the checksum file, or an empty string to skip verification.

void ALSystemProxy::factoryReset(const std::string& imageurl, const std::string& checksumurl)

Update the system image, and erase all the user data.

Note

A reboot is required to terminate the factory reset.

Parameters:

• imageurl – The local path of the system image.
• checksum – The local path to the checksum file, or an empty string to skip verification.

Warning

Factory Reset will remove all the data from your robot, please backup your data before calling the method.

Events

Event: "ALSystem/RobotNameChanged"

callback(std::string eventName, const std::string& name, std::string subscriberIdentifier)

Raised when ALSystemProxy::setRobotName is successfully called.

Parameters:

• eventName (std::string) – “ALSystem/RobotNameChanged”
• name – the new name of the robot.
• subscriberIdentifier (std::string) –