Manifest file
In this tutorial the use of the Manifest Files is explained.
Last updated
In this tutorial the use of the Manifest Files is explained.
Last updated
A manifest file in Asimovo is a metadata file that provides essential information about an asset used in a simulation environment. In Asimovo an asset can be a robot, an environment, a component or a workspace. The manifest file helps Asimovo to understand the properties, compatibility, and other details of the asset.
When uploading an asset a skeleton-Manifest file is automatically created for it on the platform. Users can use this manifest file, and modify it according to their own needs.
The following is an example of a Manifest file in YAML format:
In the following section the different fields will be explained.
name: A unique identifier for the asset.
displayName: A human-readable name for the asset.
description: A brief description of the asset.
version: The version number of the asset.
license: The license under which the asset is distributed.
tags: Keywords associated with the asset.
created, lastEdited, repackaged: Timestamps indicating when the asset was created, last edited, and repackaged.
size: The physical dimensions of the asset.
asset-type: The type of asset (e.g., Robot, Environment, Component).
ROS-compatibility: A list of ROS (Robot Operating System) versions compatible with the asset.
simulator-compatibility: A list of Gazebo versions compatible with the asset.
source: The source of the asset (e.g., Public, Private).
creator: The creator or organization that developed the asset.
image_filenames: A list of filenames for images representing the asset. These will be visible when an asset is displayed in the Assets Library.
Create a Manifest File: When creating a new asset, a manifest file is automatically generated for it in the platform. Once you are in the workspace where you can upload your files, you can also modify the content of this manifest file. For more information, please visit the Asset management page of this tutorial.
Read a Manifest File: To understand an asset's properties, open its manifest file and review the details.
Edit a Manifest File: To update an asset's properties, edit the corresponding fields in the manifest file and update the lastEdited timestamp. Alternatively, you are also able to edit some of the fields through a pop-up panel that you can open from the Assets Library page, by clicking on the ⋮symbol on the top-right of an asset and choosing the Edit info option.
Compatibility Check: Before using an asset in your simulation, we recommend to check the ROS-compatibility and simulator-compatibility fields to ensure it works out-of-the-box with your setup.
Asset Visualization: Use the image_filenames field to find and display images of the asset in the Asimovo UI. This images should be stored in a folder named asset_images. It can include screenshots from simulations showcasing the robot, environment or component, or any kind of image that represents the asset.
