Quick Start

First-time users can follow this guide.

Creating a Project

To be able to use FMS, you need to create a project. Everything in FMS (robots, maps, tasks, etc.) is organised in projects. To create a project, from the FMS application home click "Add Projects" or "Create" > "Project" from the top right.

Fill in the details then click "Submit". You then should see there's a new project on the list.

Enter the project and you should be directed to the new project's dashboard.

Adding Your First Robot

Now that we have a project, let's add a robot to the project. Inside the project, under the "Robots" tab, click "Create Robot".

Fill in the details, then click "Submit".

You will get a robot key. Copy and paste this robot key to your robot's plugin. Refer to this tutorial for a quick start with RNS plugin. Now you can close the dialog.

You will see the new robot appear on the list. When the robot is connected, the connection status should turn green.

When robot is disconnected

When robot is connected

Add and Load a Map to FMS

Robots must operate within a map. For this, we need to add a map to FMS. There are several ways to add a map to FMS. We will discuss two methods: importing from file and creating a map with robot (mapping).

Adding a Map to FMS

Import a Map from File

To import a map from file, go to "Library" tab and click "Import Map from File" on the top left.

Fill in the map information and upload the files. You need both the PGM and YAML files of the map (following the ROS mapping system). Then click "Submit".

You should now see the new map on the list.

Adding a Map by Mapping

To add a new map by mapping, go to the Dashboard tab and switch the mode to manual mapping.

To begin the mapping process, click "Manual" on the control panel.

Drive the robot with keyboard or joystick.

When you're done, click "Save".

A new map will then appear on the list in "Library".

Loading a Map to Dashboard

Now we will use the map(s) that we just added into the dashboard so the robots can use it for navigation and localisation. For this, under the "Library" tab, click "Load Maps".

FMS allows multiple maps to be loaded at the same time (e.g. for multi-floor operations). Robots will be able to navigate between maps. To add a map to dashboard, click the little "+" button on the map card. Then click "Save".

If you go to the Dashboard, you should see that the maps are now visible.

Adding and Running a Task

Now that we have robots operating in a map, let's put the robot to work. We can send robots to do tasks. Let's create our first task.

Under the "Dashboard" tab, switch the mode to "Waypoint".

Add waypoints on the map by dragging across the map and clicking "Mark" where you want your waypoint to be, then click "Save". Name your waypoint.

To execute the task, click the tasks shortcut icon and choose your task.

Choose the agent to execute the task. You can also ask the FMS to automatically assign the task to any one robot. Then click "Run Now".

You shall now see that the assigned robot is executing the task.

Next Steps

Congratulations, you've executed your first task on FMS. Now let's see the other features that FMS has to offer.