app_manager¶

Message types¶

• app_manager/App
• app_manager/AppList
• app_manager/StatusCodes
• app_manager/AppInstallationState
• app_manager/KeyValue
• app_manager/ExchangeApp
• app_manager/AppStatus
• app_manager/ClientApp
• app_manager/Icon

app_manager/App¶

Field:	name (string) – display_name (string) – icon (app_manager/Icon) – client_apps[] (app_manager/ClientApp) –

app name

# app name
string name
# user-friendly display name of application
string display_name
# icon for showing app
Icon icon
# ordered list (by preference) of client applications to interact with this robot app.  
ClientApp[] client_apps

app_manager/AppList¶

Field:	running_apps[] (app_manager/App) – available_apps[] (app_manager/App) –

App[] running_apps
App[] available_apps

app_manager/StatusCodes¶

Constant:	SUCCESS (int32):0 – BAD_REQUEST (int32):400 – NOT_FOUND (int32):404 – NOT_RUNNING (int32):430 – INTERNAL_ERROR (int32):500 – APP_INVALID (int32):510 – MULTIAPP_NOT_SUPPORTED (int32):511 –

Common error codes used with App Manager.

# Common error codes used with App Manager.
int32 SUCCESS = 0
# Request was invalid.
int32 BAD_REQUEST = 400
# App is not installed.
int32 NOT_FOUND = 404
# App is not running.
int32 NOT_RUNNING = 430
# Unknown internal error on the server.
int32 INTERNAL_ERROR = 500
# App is installed but failed validation.
int32 APP_INVALID = 510
# App manager does not support launching multiple apps simultaneously. Running app must first be stopped.
int32 MULTIAPP_NOT_SUPPORTED = 511

app_manager/AppInstallationState¶

Field:	installed_apps[] (app_manager/ExchangeApp) – available_apps[] (app_manager/ExchangeApp) –

ExchangeApp[] installed_apps
ExchangeApp[] available_apps

app_manager/KeyValue¶

Field:	key (string) – value (string) –

string key
string value

app_manager/ExchangeApp¶

Field:	name (string) – display_name (string) – version (string) – latest_version (string) – description (string) – icon (app_manager/Icon) – hidden (bool) –

app name

# app name
string name
# user-friendly display name of application
string display_name
# the version of the package currently installed
string version
# latest version of the package avaliable
string latest_version
# the detailed description of the app
string description
# icon for showing app
Icon icon
# hidden apps are not show - used for cases where multiple apps are in a deb
bool hidden

app_manager/AppStatus¶

Constant:	INFO (int32):0 – WARN (int32):1 – ERROR (int32):2 –
Field:	type (int32) – status (string) –

int32 INFO=0
int32 WARN=1
int32 ERROR=2
# Status type.  One of INFO, WARN, ERROR.
int32 type
# Status message.
string status

app_manager/ClientApp¶

Field:	client_type (string) – manager_data[] (app_manager/KeyValue) – app_data[] (app_manager/KeyValue) –

like “android” or “web” or “linux”

# like "android" or "web" or "linux"
string client_type

# like "intent = ros.android.teleop" and "accelerometer = true", used to choose which ClientApp to use
KeyValue[] manager_data

# parameters which just get passed through to the client app.
KeyValue[] app_data

app_manager/Icon¶

Field:	format (string) – data[] (uint8) –

Image data format. “jpeg” or “png”

# Image data format.  "jpeg" or "png"
string format

# Image data.
uint8[] data

Service types¶

• app_manager/GetAppDetails
• app_manager/ListApps
• app_manager/GetInstallationState
• app_manager/StopApp
• app_manager/InstallApp
• app_manager/StartApp
• app_manager/UninstallApp

app_manager/GetAppDetails¶

Field (Request):
	name (string) –
Field (Response):
	app (app_manager/ExchangeApp) –

Name of the app to get details of

# Name of the app to get details of
string name 
---
ExchangeApp app

app_manager/ListApps¶

Field (Response):
	running_apps[] (app_manager/App) – available_apps[] (app_manager/App) –

---
App[] running_apps
App[] available_apps

app_manager/GetInstallationState¶

Field (Request):
	remote_update (bool) –
Field (Response):
	installed_apps[] (app_manager/ExchangeApp) – available_apps[] (app_manager/ExchangeApp) –

bool remote_update
---
ExchangeApp[] installed_apps
ExchangeApp[] available_apps

app_manager/StopApp¶

Field (Request):
	name (string) –
Field (Response):
	stopped (bool) – error_code (int32) – message (string) –

Name of app to stop. Sending “*” stops all apps.

# Name of app to stop.  Sending "*" stops all apps.
string name
---
# true if app stopped, false otherwise
bool stopped
# if app did not stop, error code for classifying stop failure.  See
# StatusCodes.msg for common codes.
int32 error_code
string message

app_manager/InstallApp¶

Field (Request):
	name (string) –
Field (Response):
	installed (bool) – message (string) –

Name of the app to install or upgrade

# Name of the app to install or upgrade
string name 
---
# true if app started, false otherwise
bool installed
# response message for debugging
string message

app_manager/StartApp¶

Field (Request):
	name (string) –
Field (Response):
	started (bool) – error_code (int32) – message (string) – namespace (string) –

Name of the app to launch

# Name of the app to launch
string name 
---
# true if app started, false otherwise
bool started
# if app did not start, error code for classifying start failure.  See
# StatusCodes.msg for common codes.
int32 error_code
# response message for debugging
string message
# Namespace where the app interface can be found
string namespace  

app_manager/UninstallApp¶

Field (Request):
	name (string) –
Field (Response):
	uninstalled (bool) – message (string) –

Name of app to uninstall

# Name of app to uninstall
string name
---
# true if app stopped, false otherwise
bool uninstalled
string message