Skip to content

Latest commit

 

History

History
 
 

dashboard

README.md

rmf-dashboard

rmf-dashboard is a web application that provides overall visualization and control over the RMF system.

Setup

Follow the build instructions here.

Configuration

(Optional) Import external resources.

pnpm run setup

When executing this command, a prompt will be displayed, and it will guide you through the process.

You have two options, import a specific folder with assets from a repository (like Github) or copy the assets folder from a local directory.

In the case of choosing to obtain the data from a repository, you must define: (1) The repository URL and (2) the folder within the repository. In case of choosing to obtain the data from a local directory, the absolute path must be defined.

This folder obtained must contain at its root a JSON file calling main.json, with the RmfDashboard actors (robots, dispensers, etc.) and the path to their corresponding resources. E.g.:

{
  "robots":
    "tinyRobot" <fleet>: {
      "icons": {
        "tinyRobot"<fleet>: "/robots/tinyRobot/tinyRobot.png",
        "model1"<model>: "/robots/tinyRobot/model1.png"
      }
    }
}

Obs: the algorithm will check the robot's icons in this order:

  1. Icon exists for a model; if not exists
  2. Icon exists for a fleet; if not exists
  3. It will use a default icon.

Upon completion of the configuration, a file called .resources.json will be created automatically, which will save the configuration from where to obtain the resources.

In case you want to modify the source of your resources. You can rerun the command:

pnpm run setup

Environment Variables

The default launch script with pnpm start launches only the backend servers without any simulation instances from rmf_demos. For local development, the launch script pnpm run start:sim launches a headless simulation instance on top of all the backend servers.

In production, the dashboard would need to be configured so that it knows where to find the various services.

Here are the environment variables that you can set before you build the dashboard:

  • PUBLIC_URL: Url that the app is hosted. Defaults to '/'.
  • REACT_APP_TRAJECTORY_SERVER: Required URL to the trajectory server.
  • REACT_APP_RMF_SERVER: Required URL to the RMF api server.
  • REACT_APP_AUTH_PROVIDER: A string indicating the auth provider to use, defaults to the stub authenticator.

Supported auth providers are

provider config
stub N/A
keycloak REACT_APP_KEYCLOAK_CONFIG: a json string with the keys realm, clientId and url

Storybook

Many of the components are reused from react-components, you may want to run storybook on react-components instead.

Another way to work on the frontend without rmf is with storybook, simply run

npm run storybook

This is ideal if you are working on individual isolated components.