KubOS Mission Applications Development Guide¶
In order to be compatible with the applications service, mission applications must comply with the applications framework:
- The application should provide a
-hcommand option for query the command line arguments
- The application should not define a
-ccommand option (reserved for configuration setup)
- The application must be packaged with a manifest file which details the name, version, and author information for the binary
Once an application has been built, it should be transferred to the system, along with its manifest, and then registered with the applications service.
For projects written in languages like Python, where there is no executable file, multiple files may be used for the application.
Users may write applications in the language of their choice. However, Kubos provides APIs to assist and simplify with application development for use with one of our preferred languages.
Our supported languages for mission applications are:
These APIs abstract initial logging setup and provide helper functions for use when querying other system and hardware services.
Additional command line arguments may be used by the application. They will be automatically passed through to the application by the applications service.
Under the covers, the application would be called like so:
mission-app --verbose --release
--release are custom arguments for that particular application.
-c option is pre-defined by the system to allow a custom config file to be used.
In order for the applications service to properly maintain versioning information, each application should be registered along with a manifest file, manifest.toml.
This file must have the following key values:
name- The name of the application which will be called for execution
version- The version number of the application
author- The author of the application
Optionally, the file may also specify the following values:
executable key value allows you to specify which file should be called in order to begin
execution of the application.
If it’s omitted, the value of
name will be used.
This is particularly useful for Python applications, where the name of the application might not
match the name of the file to be called.
config key value allows you to specify a custom file which the application should use in
order to read service configuration information.
If it is omitted, the default location
/etc/kubos-config.toml will be used.
name = "mission-app" executable = "app.py" version = "1.1" author = "Me" config = "/custom/config.toml"
If you would like to test your application locally and if it will communicate with any
:doc`locally running services <../../getting-started/local-services>`, then you will need to
-c path/to/config.toml argument when starting your application.
$ ./app.py -c ../tools/default_config.toml
- Creating Your First Mission Application - Walks the user through the process of creating their first mission application which is capable of interacting with Kubos services
- Registering a Mission Application - Walks the user through the process of registering a mission application with the applications service and then starting, updating, and verifying the application
- Basic application written in Rust - Demonstrates the basic application framework and how passthrough arguments can be used
- Framework application written in Python - Can be used as a starting template when creating Python applications
- Basic application wrtting in Python - Demonstrates the basic application framework and how to communicate with Kubos services