Documentation

Overview

Documentation is provided to support the use and development of Open MCT. It's recommended that before doing any development with Open MCT you take some time to familiarize yourself with the documentation below.

Open MCT provides functionality out of the box, but it's also a platform for building rich mission operations applications based on modern web technology. The platform is configured declaratively, and defines conventions for building on the provided capabilities by creating modular 'bundles' that extend the platform at a variety of extension points. The details of how to extend the platform are provided in the following documentation.

Documentation

API Documentation

The Open MCT API provides the means to integrate Open MCT with your telemetry sources, and with time will include additional extension points for developers to add new categories of functionality to Open MCT.

  • The tutorials are the best place to start. The tutorials will take you through the process of integrating with a telemetry source and displaying data in Open MCT
  • The API documentation provides details on the classes and functions that can be used to extend Open MCT.
  • The Style Guide explains how to provide a consistent look and feel by utilizing Open MCT's CSS classes and design standards.
  • Finally, the Development Process document describes the Open MCT software development cycle.

Internal API (Deprecated)

Documentation is available for internal of Open MCT APIs. This is provided as a reference for developers who are maintaining code in core Open MCT modules. We strongly advise against developing any plugins using the internal API as it is deprecated and may be modified or removed without notice.

  • The Architecture Overview describes the concepts used throughout Open MCT, and gives a high level overview of the platform's design.
  • The Developer's Guide goes into more detail about the various extension categories and their usage in the internal API.

API Roadmap

The API will continue to develop to support new ways of extending Open MCT to allow new methods of working with objects and telemetry. The API roadmap below gives an overview of upcoming API features, and the timescales in which we expect to deliver them.

Q2 2017

  • Time: setting the temporal bounds of the displayed data, registering new Time Systems, registering timing sources
  • Persistence: Support persistence of objects via custom object providers. API currently supports read-only custom object providers
Q3 2017
  • Custom indicators
  • View registration: Support registration of a simple static custom main object view.
Q4 2017
  • Object mutation: Allow for the mutation of user-editable objects, and synchronization of object state across views.
  • User actions: Registration of new user actions, allowing new context menu and toolbar actions that can be performed on objects
  • View Registration: Support registration of complex views, with the ability to define forms and other dynamic behavior
  • Toolbars and inspectors: The ability to register new toolbars, object inspectors, and views in other screen regions