ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-06-19 15:43:48 +00:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

Merge pull request #1339 from nasa/open1336

Browse Source 
[Documentation] Fixed non-functioning telemetry tutorial, updated glyphs.
This commit is contained in:
Victor Woeltjen
2016-12-01 15:15:25 -08:00
committed by GitHub
parent f85595665f 828e5629c5
commit aaf4877daa
1 changed files with 273 additions and 317 deletions
Download Patch File Download Diff File Expand all files Collapse all files

586
docs/src/tutorials/index.md
View File

@ -131,11 +131,11 @@ one which exposes no extensions - which looks like:
```diff ```diff
define([ define([
'legacyRegistry' 'openmct'
], function ( ], function (
legacyRegistry openmct
) { ) {
legacyRegistry.register("tutorials/todo", { openmct.legacyRegistry.register("tutorials/todo", {
"name": "To-do Plugin", "name": "To-do Plugin",
"description": "Allows creating and editing to-do lists.", "description": "Allows creating and editing to-do lists.",
"extensions": "extensions":
@ -155,176 +155,134 @@ has been finalized.
#### Before #### Before
```diff ```diff
requirejs.config({ <!--
"paths": { Open MCT, Copyright (c) 2014-2016, United States Government
"legacyRegistry": "src/legacyRegistry", as represented by the Administrator of the National Aeronautics and Space
"angular": "bower_components/angular/angular.min", Administration. All rights reserved.
"angular-route": "bower_components/angular-route/angular-route.min",
"csv": "bower_components/comma-separated-values/csv.min",
"es6-promise": "bower_components/es6-promise/promise.min",
"moment": "bower_components/moment/moment",
"moment-duration-format": "bower_components/moment-duration-format/lib/moment-duration-format",
"saveAs": "bower_components/FileSaver.js/FileSaver.min",
"screenfull": "bower_components/screenfull/dist/screenfull.min",
"text": "bower_components/text/text",
"uuid": "bower_components/node-uuid/uuid",
"zepto": "bower_components/zepto/zepto.min"
},
"shim": {
"angular": {
"exports": "angular"
},
"angular-route": {
"deps": [ "angular" ]
},
"moment-duration-format": {
"deps": [ "moment" ]
},
"screenfull": {
"exports": "screenfull"
},
"zepto": {
"exports": "Zepto"
}
}
});
define([ Open MCT is licensed under the Apache License, Version 2.0 (the
'./platform/framework/src/Main', "License"); you may not use this file except in compliance with the License.
'legacyRegistry', You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0.
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
Open MCT includes source code licensed under additional open source
licenses. See the Open Source Licenses file (LICENSES.md) included with
this source code distribution or the Licensing information page available
at runtime from the About dialog for additional information.
-->
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
<title></title>
<script src="bower_components/requirejs/require.js">
</script>
<script>
require([
'openmct'
], function (openmct) {
[
'example/imagery',
'example/eventGenerator',
'example/generator',
'platform/features/my-items',
'platform/persistence/local'
].forEach(
openmct.legacyRegistry.enable.bind(openmct.legacyRegistry)
);
openmct.start();
});
</script>
<link rel="stylesheet" href="platform/commonUI/general/res/css/startup-base.css">
<link rel="stylesheet" href="platform/commonUI/general/res/css/openmct.css">
<link rel="icon" type="image/png" href="platform/commonUI/general/res/images/favicons/favicon-32x32.png" sizes="32x32">
<link rel="icon" type="image/png" href="platform/commonUI/general/res/images/favicons/favicon-96x96.png" sizes="96x96">
<link rel="icon" type="image/png" href="platform/commonUI/general/res/images/favicons/favicon-16x16.png" sizes="16x16">
<link rel="shortcut icon" href="platform/commonUI/general/res/images/favicons/favicon.ico">
</head>
<body class="user-environ">
<div class="l-splash-holder s-splash-holder">
<div class="l-splash s-splash"></div>
</div>
</body>
</html>
'./platform/framework/bundle',
'./platform/core/bundle',
'./platform/representation/bundle',
'./platform/commonUI/about/bundle',
'./platform/commonUI/browse/bundle',
'./platform/commonUI/edit/bundle',
'./platform/commonUI/dialog/bundle',
'./platform/commonUI/formats/bundle',
'./platform/commonUI/general/bundle',
'./platform/commonUI/inspect/bundle',
'./platform/commonUI/mobile/bundle',
'./platform/commonUI/themes/espresso/bundle',
'./platform/commonUI/notification/bundle',
'./platform/containment/bundle',
'./platform/execution/bundle',
'./platform/exporters/bundle',
'./platform/telemetry/bundle',
'./platform/features/clock/bundle',
'./platform/features/imagery/bundle',
'./platform/features/layout/bundle',
'./platform/features/pages/bundle',
'./platform/features/plot/bundle',
'./platform/features/timeline/bundle',
'./platform/features/table/bundle',
'./platform/forms/bundle',
'./platform/identity/bundle',
'./platform/persistence/aggregator/bundle',
'./platform/persistence/local/bundle',
'./platform/persistence/queue/bundle',
'./platform/policy/bundle',
'./platform/entanglement/bundle',
'./platform/search/bundle',
'./platform/status/bundle',
'./platform/commonUI/regions/bundle'
], function (Main, legacyRegistry) {
return {
legacyRegistry: legacyRegistry,
run: function () {
return new Main().run(legacyRegistry);
}
};
});
``` ```
__main.js__ __index.html__
#### After #### After
```diff ```diff
requirejs.config({ <!--
"paths": { Open MCT, Copyright (c) 2014-2016, United States Government
"legacyRegistry": "src/legacyRegistry", as represented by the Administrator of the National Aeronautics and Space
"angular": "bower_components/angular/angular.min", Administration. All rights reserved.
"angular-route": "bower_components/angular-route/angular-route.min",
"csv": "bower_components/comma-separated-values/csv.min",
"es6-promise": "bower_components/es6-promise/promise.min",
"moment": "bower_components/moment/moment",
"moment-duration-format": "bower_components/moment-duration-format/lib/moment-duration-format",
"saveAs": "bower_components/FileSaver.js/FileSaver.min",
"screenfull": "bower_components/screenfull/dist/screenfull.min",
"text": "bower_components/text/text",
"uuid": "bower_components/node-uuid/uuid",
"zepto": "bower_components/zepto/zepto.min"
},
"shim": {
"angular": {
"exports": "angular"
},
"angular-route": {
"deps": [ "angular" ]
},
"moment-duration-format": {
"deps": [ "moment" ]
},
"screenfull": {
"exports": "screenfull"
},
"zepto": {
"exports": "Zepto"
}
}
});
define([ Open MCT is licensed under the Apache License, Version 2.0 (the
'./platform/framework/src/Main', "License"); you may not use this file except in compliance with the License.
'legacyRegistry', You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0.
'./platform/framework/bundle', Unless required by applicable law or agreed to in writing, software
'./platform/core/bundle', distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
'./platform/representation/bundle', WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
'./platform/commonUI/about/bundle', License for the specific language governing permissions and limitations
'./platform/commonUI/browse/bundle', under the License.
'./platform/commonUI/edit/bundle',
'./platform/commonUI/dialog/bundle', Open MCT includes source code licensed under additional open source
'./platform/commonUI/formats/bundle', licenses. See the Open Source Licenses file (LICENSES.md) included with
'./platform/commonUI/general/bundle', this source code distribution or the Licensing information page available
'./platform/commonUI/inspect/bundle', at runtime from the About dialog for additional information.
'./platform/commonUI/mobile/bundle', -->
'./platform/commonUI/themes/espresso/bundle', <!doctype html>
'./platform/commonUI/notification/bundle', <html lang="en">
'./platform/containment/bundle', <head>
'./platform/execution/bundle', <meta charset="utf-8">
'./platform/exporters/bundle', <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
'./platform/telemetry/bundle', <title></title>
'./platform/features/clock/bundle', <script src="bower_components/requirejs/require.js">
'./platform/features/imagery/bundle', </script>
'./platform/features/layout/bundle', <script>
'./platform/features/pages/bundle', require([
'./platform/features/plot/bundle', 'openmct',
'./platform/features/timeline/bundle', + 'tutorials/todo/bundle'
'./platform/features/table/bundle', ], function (openmct) {
'./platform/forms/bundle', [
'./platform/identity/bundle', 'example/imagery',
'./platform/persistence/aggregator/bundle', 'example/eventGenerator',
'./platform/persistence/local/bundle', 'example/generator',
'./platform/persistence/queue/bundle', 'platform/features/my-items',
'./platform/policy/bundle', 'platform/persistence/local',
'./platform/entanglement/bundle', + 'tutorials/todo'
'./platform/search/bundle', ].forEach(
'./platform/status/bundle', openmct.legacyRegistry.enable.bind(openmct.legacyRegistry)
'./platform/commonUI/regions/bundle', );
openmct.start();
});
</script>
<link rel="stylesheet" href="platform/commonUI/general/res/css/startup-base.css">
<link rel="stylesheet" href="platform/commonUI/general/res/css/openmct.css">
<link rel="icon" type="image/png" href="platform/commonUI/general/res/images/favicons/favicon-32x32.png" sizes="32x32">
<link rel="icon" type="image/png" href="platform/commonUI/general/res/images/favicons/favicon-96x96.png" sizes="96x96">
<link rel="icon" type="image/png" href="platform/commonUI/general/res/images/favicons/favicon-16x16.png" sizes="16x16">
<link rel="shortcut icon" href="platform/commonUI/general/res/images/favicons/favicon.ico">
</head>
<body class="user-environ">
<div class="l-splash-holder s-splash-holder">
<div class="l-splash s-splash"></div>
</div>
</body>
</html>
+ './tutorials/todo/bundle'
], function (Main, legacyRegistry) {
return {
legacyRegistry: legacyRegistry,
run: function () {
return new Main().run(legacyRegistry);
}
};
});
``` ```
__main.js__ __index.html__
At this point, we can reload Open MCT. We haven't introduced any new At this point, we can reload Open MCT. We haven't introduced any new
functionality, so we don't see anything different, but if we run with logging functionality, so we don't see anything different, but if we run with logging
@ -349,11 +307,11 @@ our bundle definition:
```diff ```diff
define([ define([
'legacyRegistry' 'openmct'
], function ( ], function (
legacyRegistry openmct
) { ) {
legacyRegistry.register("tutorials/todo", { openmct.legacyRegistry.register("tutorials/todo", {
"name": "To-do Plugin", "name": "To-do Plugin",
"description": "Allows creating and editing to-do lists.", "description": "Allows creating and editing to-do lists.",
"extensions": "extensions":
@ -362,7 +320,7 @@ define([
+ { + {
+ "key": "example.todo", + "key": "example.todo",
+ "name": "To-Do List", + "name": "To-Do List",
+ "glyph": "2", + "cssclass": "icon-check",
+ "description": "A list of things that need to be done.", + "description": "A list of things that need to be done.",
+ "features": ["creation"] + "features": ["creation"]
+ } + }
@ -445,11 +403,11 @@ definition:
```diff ```diff
define([ define([
'legacyRegistry' 'openmct'
], function ( ], function (
legacyRegistry openmct
) { ) {
legacyRegistry.register("tutorials/todo", { openmct.legacyRegistry.register("tutorials/todo", {
"name": "To-do Plugin", "name": "To-do Plugin",
"description": "Allows creating and editing to-do lists.", "description": "Allows creating and editing to-do lists.",
"extensions": { "extensions": {
@ -457,7 +415,7 @@ define([
{ {
"key": "example.todo", "key": "example.todo",
"name": "To-Do List", "name": "To-Do List",
"glyph": "2", "cssclass": "icon-check",
"description": "A list of things that need to be done.", "description": "A list of things that need to be done.",
"features": ["creation"] "features": ["creation"]
} }
@ -466,7 +424,7 @@ define([
+ { + {
+ "key": "example.todo", + "key": "example.todo",
+ "type": "example.todo", + "type": "example.todo",
+ "glyph": "2", + "cssclass": "icon-check",
+ "name": "List", + "name": "List",
+ "templateUrl": "templates/todo.html", + "templateUrl": "templates/todo.html",
+ "editable": true + "editable": true
@ -502,11 +460,11 @@ definition of that type.
```diff ```diff
define([ define([
'legacyRegistry' 'openmct'
], function ( ], function (
legacyRegistry openmct
) { ) {
legacyRegistry.register("tutorials/todo", { openmct.legacyRegistry.register("tutorials/todo", {
"name": "To-do Plugin", "name": "To-do Plugin",
"description": "Allows creating and editing to-do lists.", "description": "Allows creating and editing to-do lists.",
"extensions": { "extensions": {
@ -514,7 +472,7 @@ define([
{ {
"key": "example.todo", "key": "example.todo",
"name": "To-Do List", "name": "To-Do List",
"glyph": "2", "cssclass": "icon-check",
"description": "A list of things that need to be done.", "description": "A list of things that need to be done.",
"features": ["creation"], "features": ["creation"],
+ "model": { + "model": {
@ -529,7 +487,7 @@ define([
{ {
"key": "example.todo", "key": "example.todo",
"type": "example.todo", "type": "example.todo",
"glyph": "2", "cssclass": "icon-check",
"name": "List", "name": "List",
"templateUrl": "templates/todo.html", "templateUrl": "templates/todo.html",
"editable": true "editable": true
@ -674,13 +632,13 @@ it in our bundle definition, as an extension of category `controllers`:
```diff ```diff
define([ define([
'legacyRegistry', 'openmct',
+ './src/controllers/TodoController' + './src/controllers/TodoController'
], function ( ], function (
legacyRegistry, openmct,
+ TodoController + TodoController
) { ) {
legacyRegistry.register("tutorials/todo", { openmct.legacyRegistry.register("tutorials/todo", {
"name": "To-do Plugin", "name": "To-do Plugin",
"description": "Allows creating and editing to-do lists.", "description": "Allows creating and editing to-do lists.",
"extensions": { "extensions": {
@ -688,7 +646,7 @@ define([
{ {
"key": "example.todo", "key": "example.todo",
"name": "To-Do List", "name": "To-Do List",
"glyph": "2", "cssclass": "icon-check",
"description": "A list of things that need to be done.", "description": "A list of things that need to be done.",
"features": ["creation"], "features": ["creation"],
"model": { "model": {
@ -703,7 +661,7 @@ define([
{ {
"key": "example.todo", "key": "example.todo",
"type": "example.todo", "type": "example.todo",
"glyph": "2", "cssclass": "icon-check",
"name": "List", "name": "List",
"templateUrl": "templates/todo.html", "templateUrl": "templates/todo.html",
"editable": true "editable": true
@ -768,13 +726,13 @@ extension definition.
```diff ```diff
define([ define([
'legacyRegistry', 'openmct',
'./src/controllers/TodoController' './src/controllers/TodoController'
], function ( ], function (
legacyRegistry, openmct,
TodoController TodoController
) { ) {
legacyRegistry.register("tutorials/todo", { openmct.legacyRegistry.register("tutorials/todo", {
"name": "To-do Plugin", "name": "To-do Plugin",
"description": "Allows creating and editing to-do lists.", "description": "Allows creating and editing to-do lists.",
"extensions": { "extensions": {
@ -782,7 +740,7 @@ define([
{ {
"key": "example.todo", "key": "example.todo",
"name": "To-Do List", "name": "To-Do List",
"glyph": "2", "cssclass": "icon-check",
"description": "A list of things that need to be done.", "description": "A list of things that need to be done.",
"features": ["creation"], "features": ["creation"],
"model": { "model": {
@ -797,7 +755,7 @@ define([
{ {
"key": "example.todo", "key": "example.todo",
"type": "example.todo", "type": "example.todo",
"glyph": "2", "cssclass": "icon-check",
"name": "List", "name": "List",
"templateUrl": "templates/todo.html", "templateUrl": "templates/todo.html",
"editable": true, "editable": true,
@ -807,7 +765,7 @@ define([
+ "items": [ + "items": [
+ { + {
+ "text": "Add Task", + "text": "Add Task",
+ "glyph": "+", + "cssclass": "icon-plus",
+ "method": "addTask", + "method": "addTask",
+ "control": "button" + "control": "button"
+ } + }
@ -816,7 +774,7 @@ define([
+ { + {
+ "items": [ + "items": [
+ { + {
+ "glyph": "Z", + "cssclass": "icon-trash",
+ "method": "removeTask", + "method": "removeTask",
+ "control": "button" + "control": "button"
+ } + }
@ -998,13 +956,13 @@ declare that dependency in its extension definition:
```diff ```diff
define([ define([
'legacyRegistry', 'openmct',
'./src/controllers/TodoController' './src/controllers/TodoController'
], function ( ], function (
legacyRegistry, openmct,
TodoController TodoController
) { ) {
legacyRegistry.register("tutorials/todo", { openmct.legacyRegistry.register("tutorials/todo", {
"name": "To-do Plugin", "name": "To-do Plugin",
"description": "Allows creating and editing to-do lists.", "description": "Allows creating and editing to-do lists.",
"extensions": { "extensions": {
@ -1012,7 +970,7 @@ define([
{ {
"key": "example.todo", "key": "example.todo",
"name": "To-Do List", "name": "To-Do List",
"glyph": "2", "cssclass": "icon-check",
"description": "A list of things that need to be done.", "description": "A list of things that need to be done.",
"features": ["creation"], "features": ["creation"],
"model": { "model": {
@ -1027,7 +985,7 @@ define([
{ {
"key": "example.todo", "key": "example.todo",
"type": "example.todo", "type": "example.todo",
"glyph": "2", "cssclass": "icon-check",
"name": "List", "name": "List",
"templateUrl": "templates/todo.html", "templateUrl": "templates/todo.html",
"editable": true, "editable": true,
@ -1037,7 +995,7 @@ define([
"items": [ "items": [
{ {
"text": "Add Task", "text": "Add Task",
"glyph": "+", "cssclass": "icon-plus",
"method": "addTask", "method": "addTask",
"control": "button" "control": "button"
} }
@ -1046,7 +1004,7 @@ define([
{ {
"items": [ "items": [
{ {
"glyph": "Z", "cssclass": "icon-trash",
"method": "removeTask", "method": "removeTask",
"control": "button" "control": "button"
} }
@ -1263,13 +1221,13 @@ declare it in our bundle definition, this time as an extension of category
```diff ```diff
define([ define([
'legacyRegistry', 'openmct',
'./src/controllers/TodoController' './src/controllers/TodoController'
], function ( ], function (
legacyRegistry, openmct,
TodoController TodoController
) { ) {
legacyRegistry.register("tutorials/todo", { openmct.legacyRegistry.register("tutorials/todo", {
"name": "To-do Plugin", "name": "To-do Plugin",
"description": "Allows creating and editing to-do lists.", "description": "Allows creating and editing to-do lists.",
"extensions": { "extensions": {
@ -1277,7 +1235,7 @@ define([
{ {
"key": "example.todo", "key": "example.todo",
"name": "To-Do List", "name": "To-Do List",
"glyph": "2", "cssclass": "icon-check",
"description": "A list of things that need to be done.", "description": "A list of things that need to be done.",
"features": ["creation"], "features": ["creation"],
"model": { "model": {
@ -1289,7 +1247,7 @@ define([
{ {
"key": "example.todo", "key": "example.todo",
"type": "example.todo", "type": "example.todo",
"glyph": "2", "cssclass": "icon-check",
"name": "List", "name": "List",
"templateUrl": "templates/todo.html", "templateUrl": "templates/todo.html",
"editable": true, "editable": true,
@ -1299,7 +1257,7 @@ define([
"items": [ "items": [
{ {
"text": "Add Task", "text": "Add Task",
"glyph": "+", "cssclass": "icon-plus",
"method": "addTask", "method": "addTask",
"control": "button" "control": "button"
} }
@ -1308,7 +1266,7 @@ define([
{ {
"items": [ "items": [
{ {
"glyph": "Z", "cssclass": "icon-trash",
"method": "removeTask", "method": "removeTask",
"control": "button" "control": "button"
} }
@ -1403,11 +1361,11 @@ bundle definition looks like:
```diff ```diff
define([ define([
'legacyRegistry' 'openmct'
], function ( ], function (
legacyRegistry openmct
) { ) {
legacyRegistry.register("tutorials/bargraph", { openmct.legacyRegistry.register("tutorials/bargraph", {
"name": "Bar Graph", "name": "Bar Graph",
"description": "Provides the Bar Graph view of telemetry elements.", "description": "Provides the Bar Graph view of telemetry elements.",
"extensions": { "extensions": {
@ -1415,7 +1373,7 @@ define([
{ {
"name": "Bar Graph", "name": "Bar Graph",
"key": "example.bargraph", "key": "example.bargraph",
"glyph": "H", "cssclass": "icon-autoflow-tabular",
"templateUrl": "templates/bargraph.html", "templateUrl": "templates/bargraph.html",
"needs": [ "telemetry" ], "needs": [ "telemetry" ],
"delegation": true "delegation": true
@ -1573,7 +1531,7 @@ The corresponding CSS file which styles and positions these elements:
``` ```
__tutorials/bargraph/res/css/bargraph.css__ __tutorials/bargraph/res/css/bargraph.css__
This is already enough that, if we add `"tutorials/bargraph"` to `main.js`, This is already enough that, if we add `"tutorials/bargraph"` to `index.html`,
we should be able to run Open MCT and see our Bar Graph as an available view we should be able to run Open MCT and see our Bar Graph as an available view
for domain objects which provide telemetry (such as the example for domain objects which provide telemetry (such as the example
_Sine Wave Generator_) as well as for _Telemetry Panel_ objects: _Sine Wave Generator_) as well as for _Telemetry Panel_ objects:
@ -1704,13 +1662,13 @@ service we made use of.
```diff ```diff
define([ define([
'legacyRegistry', 'openmct',
'./src/controllers/BarGraphController' './src/controllers/BarGraphController'
], function ( ], function (
legacyRegistry, openmct,
BarGraphController BarGraphController
) { ) {
legacyRegistry.register("tutorials/bargraph", { openmct.legacyRegistry.register("tutorials/bargraph", {
"name": "Bar Graph", "name": "Bar Graph",
"description": "Provides the Bar Graph view of telemetry elements.", "description": "Provides the Bar Graph view of telemetry elements.",
"extensions": { "extensions": {
@ -1718,7 +1676,7 @@ define([
{ {
"name": "Bar Graph", "name": "Bar Graph",
"key": "example.bargraph", "key": "example.bargraph",
"glyph": "H", "cssclass": "icon-autoflow-tabular",
"templateUrl": "templates/bargraph.html", "templateUrl": "templates/bargraph.html",
"needs": [ "telemetry" ], "needs": [ "telemetry" ],
"delegation": true "delegation": true
@ -1870,13 +1828,13 @@ First, let's add a tool bar for changing these three values in Edit mode:
```diff ```diff
define([ define([
'legacyRegistry', 'openmct',
'./src/controllers/BarGraphController' './src/controllers/BarGraphController'
], function ( ], function (
legacyRegistry, openmct,
BarGraphController BarGraphController
) { ) {
legacyRegistry.register("tutorials/bargraph", { openmct.legacyRegistry.register("tutorials/bargraph", {
"name": "Bar Graph", "name": "Bar Graph",
"description": "Provides the Bar Graph view of telemetry elements.", "description": "Provides the Bar Graph view of telemetry elements.",
"extensions": { "extensions": {
@ -1884,7 +1842,7 @@ define([
{ {
"name": "Bar Graph", "name": "Bar Graph",
"key": "example.bargraph", "key": "example.bargraph",
"glyph": "H", "cssclass": "icon-autoflow-tabular",
"templateUrl": "templates/bargraph.html", "templateUrl": "templates/bargraph.html",
"needs": [ "telemetry" ], "needs": [ "telemetry" ],
"delegation": true, "delegation": true,
@ -2350,27 +2308,33 @@ will retrieve from the server.)
```diff ```diff
define([ define([
'legacyRegistry' 'openmct'
], function ( ], function (
legacyRegistry openmct
) { ) {
legacyRegistry.register("tutorials/telemetry", { openmct.legacyRegistry.register("tutorials/telemetry", {
"name": "Example Telemetry Adapter", "name": "Example Telemetry Adapter",
"extensions": { "extensions": {
"types": [ "types": [
{ {
"name": "Spacecraft", "name": "Spacecraft",
"key": "example.spacecraft", "key": "example.spacecraft",
"glyph": "o" "cssclass": "icon-object"
} }
], ],
"roots": [ "roots": [
{ {
"id": "example:sc", "id": "example:sc",
"priority": "preferred", "priority": "preferred"
}
],
"models": [
{
"id": "example:sc",
"model": { "model": {
"type": "example.spacecraft", "type": "example.spacecraft",
"name": "My Spacecraft", "name": "My Spacecraft",
"location": "ROOT",
"composition": [] "composition": []
} }
} }
@ -2389,91 +2353,70 @@ preferred so that this shows up near the top, instead of below My Items.
If we include this in our set of active bundles: If we include this in our set of active bundles:
```diff ```html
requirejs.config({ <!--
"paths": { Open MCT, Copyright (c) 2014-2016, United States Government
"legacyRegistry": "src/legacyRegistry", as represented by the Administrator of the National Aeronautics and Space
"angular": "bower_components/angular/angular.min", Administration. All rights reserved.
"angular-route": "bower_components/angular-route/angular-route.min",
"csv": "bower_components/comma-separated-values/csv.min",
"es6-promise": "bower_components/es6-promise/promise.min",
"moment": "bower_components/moment/moment",
"moment-duration-format": "bower_components/moment-duration-format/lib/moment-duration-format",
"saveAs": "bower_components/FileSaver.js/FileSaver.min",
"screenfull": "bower_components/screenfull/dist/screenfull.min",
"text": "bower_components/text/text",
"uuid": "bower_components/node-uuid/uuid",
"zepto": "bower_components/zepto/zepto.min"
},
"shim": {
"angular": {
"exports": "angular"
},
"angular-route": {
"deps": [ "angular" ]
},
"moment-duration-format": {
"deps": [ "moment" ]
},
"screenfull": {
"exports": "screenfull"
},
"zepto": {
"exports": "Zepto"
}
}
});
define([ Open MCT is licensed under the Apache License, Version 2.0 (the
'./platform/framework/src/Main', "License"); you may not use this file except in compliance with the License.
'legacyRegistry', You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0.
'./platform/framework/bundle', Unless required by applicable law or agreed to in writing, software
'./platform/core/bundle', distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
'./platform/representation/bundle', WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
'./platform/commonUI/about/bundle', License for the specific language governing permissions and limitations
'./platform/commonUI/browse/bundle', under the License.
'./platform/commonUI/edit/bundle',
'./platform/commonUI/dialog/bundle', Open MCT includes source code licensed under additional open source
'./platform/commonUI/formats/bundle', licenses. See the Open Source Licenses file (LICENSES.md) included with
'./platform/commonUI/general/bundle', this source code distribution or the Licensing information page available
'./platform/commonUI/inspect/bundle', at runtime from the About dialog for additional information.
'./platform/commonUI/mobile/bundle', -->
'./platform/commonUI/themes/espresso/bundle', <!doctype html>
'./platform/commonUI/notification/bundle', <html lang="en">
'./platform/containment/bundle', <head>
'./platform/execution/bundle', <meta charset="utf-8">
'./platform/exporters/bundle', <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
'./platform/telemetry/bundle', <title></title>
'./platform/features/clock/bundle', <script src="bower_components/requirejs/require.js">
'./platform/features/imagery/bundle', </script>
'./platform/features/layout/bundle', <script>
'./platform/features/pages/bundle', require([
'./platform/features/plot/bundle', 'openmct',
'./platform/features/timeline/bundle', './tutorials/telemetry/bundle'
'./platform/features/table/bundle', ], function (openmct) {
'./platform/forms/bundle', [
'./platform/identity/bundle', 'example/imagery',
'./platform/persistence/aggregator/bundle', 'example/eventGenerator',
'./platform/persistence/local/bundle', 'example/generator',
'./platform/persistence/queue/bundle', 'platform/features/my-items',
'./platform/policy/bundle', 'platform/persistence/local',
'./platform/entanglement/bundle', 'tutorials/telemetry'
'./platform/search/bundle', ].forEach(
'./platform/status/bundle', openmct.legacyRegistry.enable.bind(openmct.legacyRegistry)
'./platform/commonUI/regions/bundle', );
openmct.start();
});
</script>
<link rel="stylesheet" href="platform/commonUI/general/res/css/startup-base.css">
<link rel="stylesheet" href="platform/commonUI/general/res/css/openmct.css">
<link rel="icon" type="image/png" href="platform/commonUI/general/res/images/favicons/favicon-32x32.png" sizes="32x32">
<link rel="icon" type="image/png" href="platform/commonUI/general/res/images/favicons/favicon-96x96.png" sizes="96x96">
<link rel="icon" type="image/png" href="platform/commonUI/general/res/images/favicons/favicon-16x16.png" sizes="16x16">
<link rel="shortcut icon" href="platform/commonUI/general/res/images/favicons/favicon.ico">
</head>
<body class="user-environ">
<div class="l-splash-holder s-splash-holder">
<div class="l-splash s-splash"></div>
</div>
</body>
</html>
+ './tutorials/telemetry/bundle'
], function (Main, legacyRegistry) {
return {
legacyRegistry: legacyRegistry,
run: function () {
return new Main().run(legacyRegistry);
}
};
});
``` ```
__main.js__ __index.html__
...we will be able to reload Open MCT and see that it is present: ...we will be able to reload Open MCT and see that it is present:
@ -2745,35 +2688,35 @@ with the platform):
```diff ```diff
define([ define([
'legacyRegistry', 'openmct',
+ './src/ExampleTelemetryServerAdapter', + './src/ExampleTelemetryServerAdapter',
+ './src/ExampleTelemetryInitializer', + './src/ExampleTelemetryInitializer',
+ './src/ExampleTelemetryModelProvider' + './src/ExampleTelemetryModelProvider'
], function ( ], function (
legacyRegistry, openmct,
+ ExampleTelemetryServerAdapter, + ExampleTelemetryServerAdapter,
+ ExampleTelemetryInitializer, + ExampleTelemetryInitializer,
+ ExampleTelemetryModelProvider + ExampleTelemetryModelProvider
) { ) {
legacyRegistry.register("tutorials/telemetry", { openmct.legacyRegistry.register("tutorials/telemetry", {
"name": "Example Telemetry Adapter", "name": "Example Telemetry Adapter",
"extensions": { "extensions": {
"types": [ "types": [
{ {
"name": "Spacecraft", "name": "Spacecraft",
"key": "example.spacecraft", "key": "example.spacecraft",
"glyph": "o" "cssclass": "icon-object"
}, },
+ { + {
+ "name": "Subsystem", + "name": "Subsystem",
+ "key": "example.subsystem", + "key": "example.subsystem",
+ "glyph": "o", + "cssclass": "icon-object",
+ "model": { "composition": [] } + "model": { "composition": [] }
+ }, + },
+ { + {
+ "name": "Measurement", + "name": "Measurement",
+ "key": "example.measurement", + "key": "example.measurement",
+ "glyph": "T", + "cssclass": "icon-telemetry",
+ "model": { "telemetry": {} }, + "model": { "telemetry": {} },
+ "telemetry": { + "telemetry": {
+ "source": "example.source", + "source": "example.source",
@ -2790,9 +2733,15 @@ define([
{ {
"id": "example:sc", "id": "example:sc",
"priority": "preferred", "priority": "preferred",
}
],
"models": [
{
"id": "example:sc",
"model": { "model": {
"type": "example.spacecraft", "type": "example.spacecraft",
"name": "My Spacecraft", "name": "My Spacecraft",
"location": "ROOT",
"composition": [] "composition": []
} }
} }
@ -3064,35 +3013,35 @@ Finally, we expose this `telemetryService` provider declaratively:
```diff ```diff
define([ define([
'legacyRegistry', 'openmct',
'./src/ExampleTelemetryServerAdapter', './src/ExampleTelemetryServerAdapter',
'./src/ExampleTelemetryInitializer', './src/ExampleTelemetryInitializer',
'./src/ExampleTelemetryModelProvider' './src/ExampleTelemetryModelProvider'
], function ( ], function (
legacyRegistry, openmct,
ExampleTelemetryServerAdapter, ExampleTelemetryServerAdapter,
ExampleTelemetryInitializer, ExampleTelemetryInitializer,
ExampleTelemetryModelProvider ExampleTelemetryModelProvider
) { ) {
legacyRegistry.register("tutorials/telemetry", { openmct.legacyRegistry.register("tutorials/telemetry", {
"name": "Example Telemetry Adapter", "name": "Example Telemetry Adapter",
"extensions": { "extensions": {
"types": [ "types": [
{ {
"name": "Spacecraft", "name": "Spacecraft",
"key": "example.spacecraft", "key": "example.spacecraft",
"glyph": "o" "cssclass": "icon-object"
}, },
{ {
"name": "Subsystem", "name": "Subsystem",
"key": "example.subsystem", "key": "example.subsystem",
"glyph": "o", "cssclass": "icon-object",
"model": { "composition": [] } "model": { "composition": [] }
}, },
{ {
"name": "Measurement", "name": "Measurement",
"key": "example.measurement", "key": "example.measurement",
"glyph": "T", "cssclass": "icon-telemetry",
"model": { "telemetry": {} }, "model": { "telemetry": {} },
"telemetry": { "telemetry": {
"source": "example.source", "source": "example.source",
@ -3108,10 +3057,16 @@ define([
"roots": [ "roots": [
{ {
"id": "example:sc", "id": "example:sc",
"priority": "preferred", "priority": "preferred"
}
],
"models": [
{
"id": "example:sc",
"model": { "model": {
"type": "example.spacecraft", "type": "example.spacecraft",
"name": "My Spacecraft", "name": "My Spacecraft",
"location": "ROOT",
"composition": [] "composition": []
} }
} }
@ -3248,7 +3203,7 @@ We then need only to utilize these methods from our `telemetryService`:
/*global define*/ /*global define*/
define( define(
['./src/ExampleTelemetrySeries'], ['./ExampleTelemetrySeries'],
function (ExampleTelemetrySeries) { function (ExampleTelemetrySeries) {
"use strict"; "use strict";
@ -3350,3 +3305,4 @@ server can handle this.)
Running Open MCT again, we can still plot our historical telemetry - but Running Open MCT again, we can still plot our historical telemetry - but
now we also see that it updates in real-time as more data comes in from the now we also see that it updates in real-time as more data comes in from the
server. server.