Getting Started

Download and build Open MCT locally

In order to build Open MCT from source there are a number of prerequisites that you must have installed in your development environment. With the build prerequisites installed, Open MCT can be downloaded and built using the steps at right. Starting with an empty directory, these steps will check out Open MCT from github, build it, and run a local web server.

Git

Git is the source control system used, and a git client must be installed. Git is available for most operating systems, and may already be installed on your system. Try running git at a command prompt. If it’s not currently installed, you can download a git client from https://git-scm.com/downloads

Node.js

Node.js is used to build the source code, and npm is used to manage build dependencies. Node is available to download from https://nodejs.org/

  • 1Clone the source code

  • 2Install development Dependencies

  • 3Run a local development server

A New API

A new API is currently under development that will deprecate much of the documentation and tutorials below, however Open MCT will remain compatible with the currently documented API. An updated set of tutorials is being developed with the new API, and progress on this task can be followed in the associated pull request. Any code in this branch should be considered experimental, and we welcome any feedback.

Differences between the two APIs include a move away from a declarative system of JSON configuration files towards an imperative system based on function calls. Developers will be able to extend and build on Open MCT by making direct function calls to a public API. Open MCT is also being refactored to minimize the dependencies that using Open MCT imposes on developers, such as the current requirement to use Angular JS.

Developing for Open MCT

To support integration in new environments and the addition of new capabilities, Open MCT provides an extension mechanism for introducing new ways of interfacing with, interacting with, and visualizing data. Documentation and tutorials are provided that describe this extension mechanism in detail.

Integrating with Telemetry Sources

Open MCT is a rich web client that is designed to be integrated with telemetry sources. Integrating with a new data source requires a little JavaScript to define a new telemetry provider that fetches data and makes it available to the platform for display. The visualizations provided by Open MCT will then be able to display the data provided by the new data source, or new visualizations can be built using the plugin mechanism. Any extensions to Open MCT, including telemetry sources, are defined as plugins.

Broadly speaking, there are two types of telemetry sources that you might want to integrate with: Those that provide real-time streaming data, and those that provide historical data. The nature of the connections used to receive telemetry data (such as via HTTP request, or WebSockets) is not prescribed by Open MCT, nor is the format of the telemetry, and developers are encouraged to use the method that best suits their needs.

A tutorial is provided that gives an example of writing a telemetry provider and integrating with a real-time telemetry source. An example is also available that demonstrates integration with an historical data source.

Extending Open MCT

Open MCT can be extended to provide new ways of visualizing and interacting with data, while offering a consistent user experience. Plugins may utilize Open MCT's provided extension points to define new:

  • Views
  • Object Types
  • Toolbars, and toolbar items
  • User actions (e.g. context menu items)
  • Status indicators

This list is not exhaustive; the full list of extension points available is in the Developer's Guide. Tutorials are available that demonstrate how to create a new visualization, how to create a new interactive form, and how to integrate with data sources.

The visualization example shows an important use case: If necessary or useful data visualizations are not provided by Open MCT already, then these may be built as plugins instead. Using this extension mechanism, you could also incorporate third party visualization libraries. The second example shows how to add new views and user interactions. This allows developers to provide new ways for users to interact with the system, and with data.