<<

Getting started (en) Date: 09/2019 Revision: v.1.0 Copyright and disclaimer

All rights reserved. No parts of this manual may be reproduced in any form without the express written permission of Mobile Industrial Robots A/S (MiR). MiR makes no warranties, express or implied, in respect of this document or its contents. In addition, the contents of the document are subject to change without prior notice. Every precaution has been taken in the preparation of this manual. Nevertheless, MiR assumes no responsibility for errors or omissions or any damages resulting from the use of the information contained.

Copyright © 20162019 by Mobile Industrial Robots A/S.

Contact the manufacturer:

Mobile Industrial Robots A/S Emil Neckelmanns Vej 15F DK-5220 Odense SØ www.mir-robots.com Phone: +45 20 377 577 Email: [email protected]

CVR: 35251235

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 2 Table of contents

1. About this document 5

1.1 Where to find more information 6

1.2 Document history 7

2. Host and network requirements 8

2.1 Network architecture 8

3. Installing Software 10

3.1 What you need 10

3.2 Installing Docker 11

3.3 Installing MiRFleet Server Solution (/Red Hat Enterprise ) 14

3.4 Configuring MiRFleet Server Solution 15

3.5 FAQs 18

4. Getting Started 19

4.1 Updating robot software 19

4.2 Export site file(s) 20

4.3 Install and activate your fleet 21

5. Commissioning 25

5.1 MiRFleet interface 25

5.2 Add robots to the fleet 26

5.3 Activate site 27

5.4 Set up schedules 28

5.5 Groups 29

5.6 Set up elevators 30

5.7 Set up fleet dashboards 32

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 3 5.8 Set up the fleet robots for automatic charging and staging 33

5.9 Set up the fleet robots for collision avoidance 35

5.10 Evacuation zones 36

6. MiRFleet API 37

6.1 Authentication 38

7. Maintenance of MiRFleet Server Solution 40

7.1 Docker 40

7.2 MiRFleet 40

7.3 Updating robots 40

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 4 1. About this document

1. About this document

This guide describes how to set up MiRFleet Server Solution and get started with MiRFleet interface. As MiRFleet Server Solution user, you have received the following information to get started:

• License ID and password • USB pen with MiRFleet software and this getting started guide. • Usernames and passwords for logging in to the fleet interface.

MiRFleet Server Solution is an alternative to the physical MiRFleet PC. MiRFleet Server Solution makes it possible to run MiRFleet on your own hardware and server systems.

The MiRFleet Server Solution runs using Docker, a lightweight, simpler alternative to a Virtual Machine, so the first step in this guide is to install Docker.

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 5 1. About this document

1.1 Where to find more information

At www.mir-robots.com, several additional resources are available. To access more information, sign in to the Distributor site with your distributor account at http://www.mobile-industrial-robots.com/en/account/. The following relevant resources are available:

• Distributor site > Manuals http://www.mobile-industrial-robots.com/en/account/manuals/ This page contains the following resources: - Robot Quick starts The short guide that lets you start operating the robot quickly. This document is in the box with the robot in the printed format. Available in multiple languages. - Robot User guides The user guide of the robot. Available in multiple languages. - MiRFleet Reference guide The reference guide that describes the elements of the MiRFleet interface. Available in multiple languages. - MiRFleet REST API reference. The REST API reference for MiR100/MiR200MiRFleet. • Distributor site > Download http://www.mobile-industrial-robots.com/en/account/download/ This page contains the following resources: - CAD drawings. Select Show CAD-files to see the list of available CAD drawings. - Certificates. Select Show Certificates to see the list of certificates for the robot. • Distributor site > How to http://www.mobile-industrial-robots.com/en/account/how-to/ This page contains how-to articles that describe how to perform specific tasks with MiR products. • Distributor site > Troubleshooting https://www.mobile-industrial-robots.com/en/account/troubleshooting/ This page contains troubleshooting guides to solve common issues with MiR products. • MiRFleet Server Solution product page https://www.mobile-industrial-robots.com/en/products/mir-add-ons/mirfleet/ This page contains specifications, pictures, and brochures for MiRFleet Server Solution.

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 6 1. About this document

• Universal Robots: http://www.universal-robots.com/support 1.2 Document history

This table shows latest and previous versions of this document and their interrelations with product software releases.

Revision Release Date Description SW HW 1.0 2019-30-07 First edition 2.5.0 1.0 and higher

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 7 2. Host and network requirements

2. Host and network requirements

The specifications and requirements for running MiRFleet Server Solution are:

• Installation file size: 3 GB • MiRFleet update file size: ~300 MB • Server requirements: Dual core processor with minimum 2.1 GHz clock • RAM: Minimum 4 GB (8 GB recommended) • HDD: 30 GB • Virtualization software: Docker CE/EE 18.09

Network requirements for the MiRFleet correspond to those of the MiR robots. See the network requirements guide on our website under Fleet manuals: MiR_network_ requirements_03.pdf 2.1 Network architecture

MiRFleet is able to communicate to MiR robots, existing computer devices and WISE modules once connected to the network. Within the network it is still also possible for other computer devices to connect directly to the MiR robots through their robot interface. The WISE modules enable MiRFleet to control existing PLCs.

2.1. MiRFleet network architecture

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 8 2. Host and network requirements

NOTICE Avoid using the robot interface to control robots that are active in MiRFleet.

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 9 3. Installing Software

3. Installing Software

This section describes how to correctly install Docker and MiRFleet Server Solution to your computer system, and how to configure MiRFleet Server Solution to your preferences. 3.1 What you need

MiRFleet Server Solution is supported on the following operating systems:

• Red Hat Enterprise Linux RHEL 64-bit 7.4 or higher. • Ubuntu 18.04 • Ubuntu 18.04 Core Server • 9 • CentOS

Host minimum hardware requirements:

• CPU: Dual-Core, 2.1 GHz • RAM: 8 GB • Disk: 100 GB

Software:

• Docker EE or CE version 18.09.01 or higher • bash • (Ubuntu) or yum (Red Hat Enterprise Linux) • Unzip or similar (Optional)

NOTICE When MiRFleet starts, it will load data from persistent storage on the host. This persistent storage also functions as a backup for the MiRFleet con- figuration. The default path to the persistent storage folder is /mir_persistence. This path can be changed, but it must be done before the installation. See Configuring MiRFleet Server Solution on page 15

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 10 3. Installing Software

3.2 Installing Docker

Docker is a tool for creating a contained (OS), similar to a Virtual Machine (VM). Docker uses the host resources directly, whereas a VM either simulates hardware or lock resources for each VM. Because of the direct use of the host resources, Docker is a quick and easy way to make a fast-running contained OS environment inside an existing Operating System.

Instead of running in their own virtual machine environment, each application runs inside a lightweight container.

MiR has chosen to provide the MiRFleet Server Solution as a Docker file instead of a VM image because:

• Docker utilizes the host resources better. • Docker files are lightweight, so MiR can therefore more easily distribute security patches and update packages. • Docker containers are easy to configure and set up. • Docker containers are very isolated and therefore very secure and robust. Using Docker makes distribution of security patches for the underlying Ubuntu 16.04 easier than with a virtual machine image. When a new security patch is released, the customer will down- load a new MiRFleet Docker file and overwrite their original installation with this file. This will replace the containers running MiRFleet in Docker, but their configuration of the Docker containers and MiRFleet will not be overwritten.

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 11 3. Installing Software

• No conflicting dependencies. Because Docker containers are very isolated, there is no risk of conflicting dependencies between MiRFleet Server and other applications you as a cus- tomer might need to run. • Better backups. All data from MiRFleet will be stored in a folder on the host system (the customers server). This is what is called a persistent storage. Which Docker version should I choose?

The Docker version must be 18.09.01 or higher.

Docker is available in two editions: Community Edition (CE) and Enterprise Edition (EE). Docker recommends Docker EE for business-critical applications in large scale production, and MiR also recommends Docker EE for running MiRFleet.

Docker EE is available in three tiers: Basic, Standard, and Advanced (see Docker tiers).MiRFleet runs on all three tiers, and it is up to the customer to decide what tier they prefer. Installing Docker EE on Ubuntu 18.04

The following describes installation of Docker using an online device. For offline installation, you can follow the instructions in the ‘Install from a package’ section in the official Docker Ubuntu documentation.

1. Download the files needed for installation. To do this, follow the steps below: 1. Go to your Docker Hub and log in. 2. Select the Setup button on your subscription for Docker Enterprise Edition for Ubuntu. 3. Copy the URL from the field labeled Copy and paste this URL to download your Edition. 4. Navigate to ubuntu/dists/bionic/pool/stable-/ and download the version you want to install. 5. Download the following files: • Container daemon: io__. • Docker command line tools: docker-ee-cli_~_.deb • Docker installer file: docker-ee_~_.deb 2. Transfer the files downloaded in the first step to your server. On a Linux system you can do this through SSH using the command: $ sudo scp [path to downloaded Docker file] user@[host IP]:./

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 12 3. Installing Software

3. Check that no other version of Docker is installed on your server by running the com- mand: $ sudo -get remove docker docker-engine docker-ce docker.io 4. Install containerd.io__.deb $ sudo dpkg -i /path/to/containerd.io__.deb 5. Install docker-ee_cli _~_.deb $ sudo dpkg -i /path/to/docker-ee_cli~_.deb 6. Install docker-ee_~_.deb $ sudo dpkg -i /path/to/docker-ee_~_.deb 7. Finalize the installation by setting up user groups, start up Docker on boot, etc. To do this, follow the Docker post-installation guide. Feel free to delete the installation files used in the above steps.

Installing Docker EE on Red Hat Enterprise Linux

The following describes installation using an online device. For offline installation, you can follow the instructions in the Install from a package section in the official Red Hat Enterprise Linux documentation.

1. Download the files needed for installation. To do this, follow the steps below: 1. Go to your Docker Hub and log in. 2. Select the Setup button on your subscription for Docker Enterprise Edition for Ubuntu. 3. Copy the URL from the field labeled Copy and paste this URL to download your Edi- tion. 4. Navigate to rhel///stable-/Packages and download the version you want to install. 5. Download the following files: • Container daemon: io_.x86_64.rpm • Docker command line tools: docker-ee-cli_.x86_64.rpm • Docker installer file: docker-ee_.x86_64.rpm 2. Transfer the files downloaded in Step 1 to your server. On a Linux system you can do this through SSH using the command: $ sudo scp [path to downloaded Docker file] user@[host IP]:./

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 13 3. Installing Software

3. Check that no other version of Docker is installed on your server by running the following command six times where is replaced each time with one of the listed items. $ sudo yum remove • docker \ • docker-client \ • docker-client-latest \ • docker-common \ • docker-latest \ • docker engine 4. Enable the extras RHEL repository to ensure access to the container-selinux package. The repository can differ per your architecture and cloud provider (see step 5 in the Docker guide for setting up repositories). For offline installation on Red Hat Enterprise Linux (see Red Hat offline update documentation). 5. Install containerd.io_.x86_64.rpm $ sudo yum install /path/to/containerd.io_.x86_64.rpm 6. Install docker-ee_cli _.x86:64.rpm $ sudo yum install /path/to/docker-ee_cli.x86_64.rpm 7. Install docker-ee_.x86_64.rpm $ sudo yum install /path/to/docker-ee_.x86_64.rpm 8. Finalize the installation by setting up user groups, start up Docker on boot, etc. To do this, follow the Docker post-installation guide. Feel free to delete the installation files used in the above steps. 3.3 Installing MiRFleet Server Solution (Ubuntu/Red Hat Enterprise Linux)

Any changes to the MiRFleet configuration must be done before installing MiRFleet; see Configuring MiRFleet Server Solution on the next page.

1. Download the MiRFleet Server installer file from the MiR Distributor webpage. You must do this on an online device. 2. Transfer the installer file to your server. On a Linux system you can do this through SSH using the command. $ sudo scp [path to downloaded MiRFleet installer file] user@[host IP]:./

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 14 3. Installing Software

3. Unzip the file. If you are using a Linux system and unzip is installed, use the command: $ sudo unzip .zip 4. Enter the mirfleet-server- folder. should be replaced with the ver- sion of MiRFleet you are using. Use the command: $ cd mirfleet-server- 5. Run the installer script. $ sudo bash fleet-install-linux Error messages during a first-time installation are normal and can be disregarded.

6. Reboot the server. $ sudo reboot 7. Check if the MiRFleet containers are running. Use the command: $ sudo docker container ls You should see two images: • fleet: • mysql:5.7 8. If Docker is not running since it is not configured to start with the host system, run the command: $ sudo systemctl enable docker Docker and the MiRFleet containers should now start. MiRFleet will start and stop auto- matically with Docker. 9. Feel free to delete the mirfleet-server- installation folder.

After successfully activating the MiRFleet license, you must reboot the server. Activate your license and log on to MiRFleet. A description of how to activate you license is provided in section Install and activate your fleet on page 21.

3.4 Configuring MiRFleet Server Solution

The MiRFleet Server Solution installation can be manually configured by editing the mirfleet- server-config.yml file.

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 15 3. Installing Software

For the initial installation, mirfleet-server-config.yml is in the MiRFleet Server installer folder mirfleet-server-. If the MiRFleet Server is already installed, the mirfleet-server- config.yml file is in the persistent storage, located by default at /mir_persistence.

If the MiRFleet Server is already installed, it must be reinstalled for the changes to take effect. To do this, follow the steps in Installation of MiRFleet Server above.

If the MiRFleet Server is updated, all data in /mir_persistence is left unchanged, and any previous configuration of mirfleet-server-config.yml is kept. Network interface

The network interface can be either host or bridged. You can read more about the two options here:

• Host networking: https://docs.docker.com/network/host/. • Bridge networking: https://docs.docker.com/network/bridge/. • Advanced configuration of a bridged network: https://- docs.docker.com/v17.09/engine/userguide/networking/default_network/custom- docker0/. Host (Default)

The host network interface is used in Docker, and no specific port mapping is needed. This mode is recommended because it eases the setup of subnets as MiRFleet scans for robots on the subnets visible on the NIC.

If the MiRFleet Server Solution is used with host network interface, it assumes that ports 22, 80, 8080, 8888 and 9090 are open. Bridged

In bridged mode, port mapping can be controlled manually. It requires ports 80, 8080, 8888, 9090 to be open.

Portmapping

MiRFleet exposes the following ports: 22, 80, 8080, 8888, 9090.

The default port mapping is:

• 22:22, needed for access through SSH. • 80:80, needed for accessing MiRFleet interface. • 8080:8080, needed for REST communication between MiRFleet and robots.

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 16 3. Installing Software

• 8888:8888, needed for access to the MiRFleet recovery page. • 9090:9090, needed for ROSbridge communication between MiRFleet and robots.

Changing the location of persistent storage

It is possible to change the location of the persistent storage. This can be done by executing the following steps before installing MiRFleet.

1. Go to the MiRFleet installation folder. $ cd /path/to/mirfleet-server- 2. Open the install script in a text editor, such as vi. $ vi fleet-install-linux 3. In line 2, change /mir_persistence to the desired path of the persistent storage. Save and exit the file. 4. Complete the installation process. Follow the instructions in Installing MiRFleet Server Solution (Ubuntu/Red Hat Enterprise Linux) on page 14 using the changed fleet-install- linux script. 5. When the installation is complete, open the mirfleet-server-config.yml file in a text editor. 6. Change /mir_persistence in line 15 to the path used in step 3. 7. Save and exit the file.

Configuring Docker default address pool

It is possible to configure the default adress pool. This can be done by executing the following steps.

1. Create the file /etc/docker/daemon.json $ sudo touch /etc/docker/daemon.json 2. Open /etc/docker/daemon.json with a text editor, such as vi $ vi /etc/docker/daemon.json 3. Type in the following content: { "bip”: “[IP]/24”, “default-address-pools":[ {“base”:”[IP]/16”,”size”:24} ] } 4. Save and exit the file. 5. Restart Docker $ sudo systemctl restart docker

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 17 3. Installing Software

6. Reinstall the MiRFleet Server. Follow the steps in Installing MiRFleet Server Solution (Ubuntu/Red Hat Enterprise Linux) on page 14.

For advanced network settings, see the Docker guide on https://- docs.docker.com/v17.09/engine/userguide/networking/default_net- work/custom-docker0/.

3.5 FAQs

1. How can I check if the Docker containers are running? • Run $ sudo docker container ls • You should see two images: fleet: and mysql:. 2. Will MiRFleet start automatically when the server is rebooted? • MiRFleet will start automatically when Docker is started. • Docker can be configured to start automatically after a server reboot, see https://- docs.docker.com/install/linux/linux-postinstall/. 3. How can I make a backup of the MiRFleet configuration? • MiRFleet data is stored in the persistent storage. A backup of the persistent storage works as a backup of the MiRFleet configuration. 4. Can I change the location of the persistent storage? • Yes; see Configuring MiRFleet Server Solution on page 15. 5. Will data in the persistent storage be overwritten when I update the MiRFleet Docker file? • No, the data in the persistent storage is not overwritten. The updated MiRFleet will use the configuration saved in the persistent storage. 6. Will a restart of MiRFleet from the MiRFleet user interface also reboot my server? • No, this will only restart the Docker containers running MiRFleet. 7. Can I restart the fleet container? • Yes, you can restart the fleet container using the command $ sudo docker restart fleet.

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 18 4. Getting Started

4. Getting Started

This section describes how to prepare your robots to join the fleet and activate your license.

Before installing the MiRFleet, a few preparations are recommended. The first point, however, is mandatory.

1. Update the fleet robots to SW version 2.5.0 or newer. All robots in the fleet must run the same software version as MiRFleet. We recommend the newest available software. 2. Export site file(s) from one of the fleet robots. Although site files are automatically impor- ted into the fleet interface when you add the first robot, it is good practice to ensure that you have a backup of your created site(s).

4.1 Updating robot software

Follow the steps below to update your robot software:

1. Go to MiR Distributor site and sign in with your credentials at mirfleet.com. 2. Select Download and select your robot in the product drop down menu.

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 19 4. Getting Started

3. Download the latest version of MiR Software Robot / Hook / Fleet 2 version x.x.x.

4. Connect your computer to the WiFi of the robot you would like to update. 5. Access the robot's interface by going to the website mir.com in your preferred web browser and sign in. 6. Navigate to System > Software versions and select Upload software

7. Locate and select the downloaded software package. 8. It may take a few minutes for the package to successfully upload.

NOTICE When updating a MiR robot with an attached MiRHook, the Hook software must be updated first to ensure that the robot is compatible with the hook when uploading the software.

4.2 Export site file(s)

Follow the steps below to export your site file(s).

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 20 4. Getting Started

1. In a robot interface, go to Setup > Maps. 2. Select the site you want to use for the fleet and select Export.

3. The site file is downloaded to your device and may be imported later into both fleet and other robots. 4.3 Install and activate your fleet

You are now ready to install and activate the MiRFleet interface. It is only necessary to activate your license the first time you log on to the MiRFleet.

After activation, the license is tied to the hardware of the host and can only run on that host. If you want to change the host, the license can be deactivated from its current host and re-activated on a new one. Please contact MiR Sup- port for assistance.

You can activate the license both online and offline by following these steps:

1. On the login page, select Activate license.

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 21 4. Getting Started

2. Enter the License ID and password that you have received from MiR.

3. Wait while the system attempts to activate the license. 4. If you work online, you are finished activating your license, and can continue to step 8. If you work offline, the attempt to activate the license will fail, and you are directed to a page from where you can download a request file. If the download does not start auto- matically, then select the link Download it here. 5. Transfer the request file to a computer with internet access, for example via a USB pen. In a browser, go to www.mir-robots.com/activate and upload the request file.

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 22 4. Getting Started

6. The web page now generates a response file. Select Download and save the file on a USB pen. Then bring it back to MiRFleet.

7. If you are still on the Download page, then select Next to go to the Upload page. Upload the response file to MiRFleet and select Next.

8. Your MiRFleet license is now successfully activated. Select Go to login.

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 23 4. Getting Started

9. Enter a username and password. The default usernames and passwords are the same as for robots. You can find the default usernames and passwords in the MiR folder you received with the Fleet USB pen.

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 24 5. Commissioning

5. Commissioning

This section describes how you import robots into the MiRFleet interface and set up the parameters that will get your fleet up and running.

When you have added the first robot, settings from the robot are imported into the fleet through the synchronization feature. These include:

• Maps, including positions, markers, walls, floors and all types of zones • Missions and Mission groups • Users and User groups • Paths • User-created sounds • I/O modules • Carts, cart types and calibrations • Shelf types

This means that you only need to set up features that are specific to the fleet:

1. Add robots to the fleet 2. Set up schedules 3. Set up elevators 4. Set up Fleet dashboard(s) 5. Set up the fleet robots for automatic charging and staging 6. Set up the fleet robots for collision avoidance 5.1 MiRFleet interface

The MiRFleet interface is very similar to the robot interface. Figure 5.1 shows what is synchronized between fleet and robots in the Setup menu (green frame) and what is not synchronized (red frame). The items in the red frame are fleet specific and must be set up in the fleet interface.

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 25 5. Commissioning

5.1. The items that are boxed in green are synchronized between the robots through the fleet. The items boxed in red are not synchronized and are specific to the fleet. 5.2 Add robots to the fleet

Follow these steps to add robots to the MiRFleet.

1. Go to Setup > Fleet > Robots and select Scan for robots.

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 26 5. Commissioning

If one or more robots are not found through the scanning, you can add them by selecting Add robot manually and entering the IP address of the robot(s).

2. To activate a new robot, select Add robot to a group and select Active in MiRFleet. You can use the default robot group or create new groups for different types of robots. See more in section Groups on page 29.

We recommend that you select Factory reset the robot before adding it for all robots except for the first one that you activate. The first one is used to syn- chronize sites with the fleet.

NOTICE Be aware that all user settings on the robot are erased when you select the Factory reset option.

5.3 Activate site

Even though all robot settings are synchronized, you must activate the site you want to use for the fleet. In robot interfaces, you activate individual maps, but in MiRFleet you must activate a whole site. To do this, navigate to Setup > Maps, find the site you want to activate, and select the activate site icon.

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 27 5. Commissioning

If there is only one site, it will already be activated.

5.4 Set up schedules

Missions are set up and monitored from the Schedule page. Follow these steps to schedule a mission:

1. Go to Setup > Fleet > Schedule. Available missions are shown in the top bar. Select one of the robot groups and select a mission from the list.

2. Set the mission parameters to specify which robot group should run the mission and at what time the mission should be initiated. High priority puts the mission to the front of the queue.

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 28 5. Commissioning

5.5 Groups

In MiRFleet, robot groups can be matched with mission groups, which gives you even more control of your fleet flow. An example could be a group of MiRHook robots that are restricted to perform Cart pick-up and drop-off missions only. The efficiency of the robot groups / mission groups setup depends on how you have set up missions and mission groups (Setup > Missions). Follow these steps to set up groups of robots and missions.

1. Go to Setup > Robots and select Create/Edit groups. Select Create/Edit groups again in the next window

2. Select Robot group or Charging group.

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 29 5. Commissioning

3. When you create a Robot group, you get the extra option Allow all mission groups. To match a robot group with one or more mission groups, deselect this option, and then select the mission group(s) you want to match the robot group with.

NOTICE We discourage the use of robot interface for robots in MiRFleet.

• All missions should go through the mission scheduler in the fleet, and the user should not issue independent robot missions. • Don’t manipulate map components on the robot, use the fleet interface instead. • After moving a robot manually with the joystick it is important to schedule a mission to the robot from the fleet. Otherwise the robot will not release its resources.

5.6 Set up elevators

Elevators must be set up with a specific robot control with its own IP-address to work with MiRFleet. Contact your distributor for further information.

Follow these steps to set up an elevator:

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 30 5. Commissioning

1. Go to Fleet > Elevators and select Create elevator. 2. Start by setting up the elevator: name, IP address, if the robot should turn inside the elev- ator, and if you want to activate the elevator right away. Finish by selecting Create elev- ator.

3. Now select Add floor to set up the first floor.

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 31 5. Commissioning

4. Select settings for each floor. Positions and missions must have been setup previously in the map editor (Setup > Maps > Create map / Edit map). • Floor: Enter a floor number. • Map: The map must have been created in a robot and include two elevator positions that will enable the switching from one map to another. • Position in the elevator: This position represents the robot’s position inside the elev- ator. • Position in front of elevator: The position in front of the elevator where the robot waits for the elevator to arrive and the door to open. • Entry mission: An entry mission is not mandatory. An example of an entry mission could be a sound as the robot enters the elevator. An entry mission must include a Move action with a variable position. • Exit mission: An exit mission is not mandatory. An example of an entry mission could be a sound as the robot leaves the elevator. • Door: Select 1 if the elevator has one door and 2 if the elevator has two doors and you want the robot to leave through the opposite door.

Select Update elevator

5. Keep adding floors until you have the required number for your building. 5.7 Set up fleet dashboards

Dashboards are set up the same way as in the robot interface, though with a different set of available widgets.

Follow these steps to set up a dashboard:

1. Go to Dashboards > Dashboards and select Create dashboard. Give the dashboard a name and select Create dashboard.

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 32 5. Commissioning

2. Available widgets are shown in the top bar. Select one of the widget groups and select a widget. Keep adding widgets, until you have the wanted dashboard. You can move the widgets around and resize them as needed. Select Save when you are done editing the dashboard. The dashboard is now accessible from the Dashboards menu.

The only fleet specific widget is the one named Locked fleet map. It cor- responds to the Locked robot map known from the robot interface, but it shows all fleet robots that are on the selected map.

5.8 Set up the fleet robots for automatic charging and staging

MiRFleet is able to automatically send robots to charging stations when they begin to reach low power, and send them to stage positions to park when not in use. Follow these steps to set up the fleet robots for auto charging and auto staging:

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 33 5. Commissioning

1. Go to System > Settings and select Charging and staging.

2. Set Auto charging and Auto staging to true.

MiRFleet will now handle charging and staging automatically, using the default settings. If you want to change any other settings for Charging and staging, see the following description of the various parameters you can change.

• Threshold at charging position Distance in meters between a robot and a charging station when the robot moves away before another robot can use the charging station. • Auto charging Select True to auto charge the fleet robots. • Auto staging Select True to auto stage the fleet robots. • Idle time Minimum of minutes a robot must idle before it is sent to a charging station. • Minimum battery percentage for charging The robot’s minimum battery percentage before it can receive a new order. • Minimum battery percentage for release The minimum battery percentage the robot should be charged • Minimum time at charging station Minimum number of minutes the robot should charge in a charging station

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 34 5. Commissioning

5.2. Parameters that can be set in Charging and staging for both versions of fleet.

5.9 Set up the fleet robots for collision avoidance

Enabling collision avoidance synchronizes the footprints and positions of the robots connected to fleet. This ensures that the robots will not collide with each other. Follow these steps to set up the fleet robots for collision avoidance:

1. Go to System > Settings and select Collision avoidance.

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 35 5. Commissioning

2. Check that Collision avoidance is set to True.

5.10 Evacuation zones

By adding evacuation zones and positions to a map you can clear an area of robots from the MiRFleet interface. Evacuation zones may be used in connection with for example, fire alarms.

For more information about Evacuation zones, see the How to guide How to set up evacuation zones and fire alarms on the Distributor site.

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 36 6. MiRFleet API

6. MiRFleet API

The MiRFleet API is completely integrated with the robot API. This includes the request authentication and a large number of API endpoints.

For additional information see:

• The How to guide Use MiR v2.0.0 REST Interface using Postman or ARC that describes how to use REST API. • The Reference guides for the REST API of each product. These can be found on the Dis- tributor site under Manuals.

In general, the MiRFleet API has possibilities for integration directly through the API, and you can try the API calls directly from the MiRFleet interface help menu, like you know it from the robot interface. Make sure to check the parameters in the API documentation.

To open the API documentation, go to Help > API documentation and then select Launch API documentation.

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 37 6. MiRFleet API

NOTICE The MiRFleet API requires authentication. See Authentication below.

6.1 Authentication

To authenticate REST requests in the MiRFleet API a basic authentication must be included in the header similar to the robot API. It consists of a base64 encoded string and is formed by the username followed by a colon and a sha-256-encoded password. Ex: BASE64 (:SHA-256( )).

For example, a header could look like this:

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 38 6. MiRFleet API

When you are determining your authentication header the links below can be used to encode you user name and password information.

SHA-256 encoder: http://www.xorbin.com/tools/sha256-hash-calculator

Base64 encoder: https://www.base64encode.org/

The following How to guide provides additional information regarding the use of REST API: https://www.mobile-industrial-robots.com/en/account/how- to/software/use-mir-v200-rest-interface-using-postman-or-arc/.

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 39 7. Maintenance of MiRFleet Server

7. Maintenance of MiRFleet Server Solution 7.1 Docker

For maintenance lifecycle of Docker see https://success.docker.com/article/maintenance- lifecycle. 7.2 MiRFleet

The MiRFleet Server Solution software can be updated in two ways:

1. Update software from the MiRFleet user interface using a .mir file. • Only the MiRFleet software is updated to the new version. • See the MiRFleet reference guide. 2. Update software and containers using a MiRFleet Server Solution installer file. • The MiRFleet software is updated to the newest version. The packages and con- figuration in the containers are updated to the latest versions. 7.3 Updating robots

Robots and fleet share the same software file, so you only need to download one software file when updating robot and fleet software.

When you update the software in either a robot or a fleet, the software distinguishes between the two, which means that you cannot upload the wrong file, as long as you make sure to run the same software version on both MiRFleet and all robots on the fleet.

MiRFleet Server Solution Getting started (en) 09/2019 - v.1.0 ©Copyright 2019: Mobile Industrial Robots A/S. 40