Tutorial packages

[Plot] Add current conductor bounds to telemetry requests via the old API. Replaces telemetry decorator. Fixes #1458
Merge pull request #1433 from nasa/open1432
2025-06-25 10:44:21 +00:00 · 2017-02-27 19:28:21 -08:00 · 2017-02-27 19:26:51 -08:00 · 2017-02-27 11:12:27 -08:00 · 2017-02-24 14:58:50 -08:00 · 2017-02-24 14:56:18 -08:00
33 changed files with 463 additions and 391 deletions
--- a/example/generator/src/GeneratorProvider.js
+++ b/example/generator/src/GeneratorProvider.js
@ -41,6 +41,10 @@ define([
        return domainObject.type === 'generator';
    };

+    GeneratorProvider.prototype.supportsRequest =
+        GeneratorProvider.prototype.supportsSubscribe =
+            GeneratorProvider.prototype.canProvideTelemetry;
+
    GeneratorProvider.prototype.makeWorkerRequest = function (domainObject, request) {
        var props = [
            'amplitude',
--- a/example/generator/src/SinewaveConstants.js
+++ b/example/generator/src/SinewaveConstants.js
@ -19,7 +19,7 @@
 * this source code distribution or the Licensing information page available
 * at runtime from the About dialog for additional information.
 *****************************************************************************/
-/*global define,Promise*/
+/*global define*/

 define({
    START_TIME: Date.now() - 24 * 60 * 60 * 1000 // Now minus a day.
--- a/example/generator/src/SinewaveDeltaFormat.js
+++ b/example/generator/src/SinewaveDeltaFormat.js
@ -19,12 +19,11 @@
 * this source code distribution or the Licensing information page available
 * at runtime from the About dialog for additional information.
 *****************************************************************************/
-/*global define,Promise*/
+/*global define*/

 define(
    ['./SinewaveConstants', 'moment'],
    function (SinewaveConstants, moment) {
-        "use strict";

        var START_TIME = SinewaveConstants.START_TIME,
            FORMAT_REGEX = /^-?\d+:\d+:\d+$/,
--- a/example/generator/src/SinewaveLimitCapability.js
+++ b/example/generator/src/SinewaveLimitCapability.js
--- a/example/generator/src/SinewaveTelemetryProvider.js
+++ b/example/generator/src/SinewaveTelemetryProvider.js
--- a/example/generator/src/SinewaveTelemetrySeries.js
+++ b/example/generator/src/SinewaveTelemetrySeries.js
--- a/example/generator/src/WorkerInterface.js
+++ b/example/generator/src/WorkerInterface.js
--- a/example/generator/bundle.js
+++ b/example/generator/bundle.js
@ -1,184 +0,0 @@
-/*****************************************************************************
- * Open MCT, Copyright (c) 2014-2016, United States Government
- * as represented by the Administrator of the National Aeronautics and Space
- * Administration. All rights reserved.
- *
- * Open MCT is licensed under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance with the License.
- * 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.
- *****************************************************************************/
-/*global define*/
-
-define([
-    "./src/SinewaveTelemetryProvider",
-    "./src/SinewaveLimitCapability",
-    "./src/SinewaveDeltaFormat",
-    'legacyRegistry'
-], function (
-    SinewaveTelemetryProvider,
-    SinewaveLimitCapability,
-    SinewaveDeltaFormat,
-    legacyRegistry
-) {
-    "use strict";
-
-    legacyRegistry.register("example/generator", {
-        "name": "Sine Wave Generator",
-        "description": "For development use. Generates example streaming telemetry data using a simple sine wave algorithm.",
-        "extensions": {
-            "components": [
-                {
-                    "implementation": SinewaveTelemetryProvider,
-                    "type": "provider",
-                    "provides": "telemetryService",
-                    "depends": [
-                        "$q",
-                        "$timeout"
-                    ]
-                }
-            ],
-            "capabilities": [
-                {
-                    "key": "limit",
-                    "implementation": SinewaveLimitCapability
-                }
-            ],
-            "formats": [
-                {
-                    "key": "example.delta",
-                    "implementation": SinewaveDeltaFormat
-                }
-            ],
-            "constants": [
-                {
-                    "key": "TIME_CONDUCTOR_DOMAINS",
-                    "value": [
-                        {
-                            "key": "time",
-                            "name": "Time"
-                        },
-                        {
-                            "key": "yesterday",
-                            "name": "Yesterday"
-                        },
-                        {
-                            "key": "delta",
-                            "name": "Delta"
-                        }
-                    ],
-                    "priority": -1
-                }
-            ],
-            "types": [
-                {
-                    "key": "generator",
-                    "name": "Sine Wave Generator",
-                    "cssClass": "icon-telemetry",
-                    "description": "For development use. Generates example streaming telemetry data using a simple sine wave algorithm.",
-                    "priority": 10,
-                    "features": "creation",
-                    "model": {
-                        "telemetry": {
-                            "period": 10,
-                            "amplitude": 1,
-                            "offset": 0,
-                            "dataRateInHz": 1
-                        }
-                    },
-                    "telemetry": {
-                        "source": "generator",
-                        "domains": [
-                            {
-                                "key": "utc",
-                                "name": "Time",
-                                "format": "utc"
-                            },
-                            {
-                                "key": "yesterday",
-                                "name": "Yesterday",
-                                "format": "utc"
-                            },
-                            {
-                                "key": "delta",
-                                "name": "Delta",
-                                "format": "example.delta"
-                            }
-                        ],
-                        "ranges": [
-                            {
-                                "key": "sin",
-                                "name": "Sine"
-                            },
-                            {
-                                "key": "cos",
-                                "name": "Cosine"
-                            }
-                        ]
-                    },
-                    "properties": [
-                        {
-                            "name": "Period",
-                            "control": "textfield",
-                            "cssClass": "l-input-sm l-numeric",
-                            "key": "period",
-                            "required": true,
-                            "property": [
-                                "telemetry",
-                                "period"
-                            ],
-                            "pattern": "^\\d*(\\.\\d*)?$"
-                        },
-                        {
-                            "name": "Amplitude",
-                            "control": "textfield",
-                            "cssClass": "l-input-sm l-numeric",
-                            "key": "amplitude",
-                            "required": true,
-                            "property": [
-                                "telemetry",
-                                "amplitude"
-                            ],
-                            "pattern": "^\\d*(\\.\\d*)?$"
-                        },
-                        {
-                            "name": "Offset",
-                            "control": "textfield",
-                            "cssClass": "l-input-sm l-numeric",
-                            "key": "offset",
-                            "required": true,
-                            "property": [
-                                "telemetry",
-                                "offset"
-                            ],
-                            "pattern": "^\\d*(\\.\\d*)?$"
-                        },
-                        {
-                            "name": "Data Rate (hz)",
-                            "control": "textfield",
-                            "cssClass": "l-input-sm l-numeric",
-                            "key": "dataRateInHz",
-                            "required": true,
-                            "property": [
-                                "telemetry",
-                                "dataRateInHz"
-                            ],
-                            "pattern": "^\\d*(\\.\\d*)?$"
-                        }
-                    ]
-                }
-            ]
-        }
-    });
-});
--- a/example/generator/src/generatorWorker.js
+++ b/example/generator/src/generatorWorker.js
--- a/example/generator/plugin.js
+++ b/example/generator/plugin.js
@ -0,0 +1,171 @@
+/*****************************************************************************
+ * Open MCT, Copyright (c) 2014-2016, United States Government
+ * as represented by the Administrator of the National Aeronautics and Space
+ * Administration. All rights reserved.
+ *
+ * Open MCT is licensed under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance with the License.
+ * 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.
+ *****************************************************************************/
+/*global define*/
+
+define([
+    "./GeneratorProvider",
+    "./SinewaveLimitCapability",
+    "./SinewaveDeltaFormat"
+], function (
+    GeneratorProvider,
+    SinewaveLimitCapability,
+    SinewaveDeltaFormat
+) {
+
+    var legacyExtensions = {
+        "capabilities": [
+            {
+                "key": "limit",
+                "implementation": SinewaveLimitCapability
+            }
+        ],
+        "formats": [
+            {
+                "key": "example.delta",
+                "implementation": SinewaveDeltaFormat
+            }
+        ],
+        "constants": [
+            {
+                "key": "TIME_CONDUCTOR_DOMAINS",
+                "value": [
+                    {
+                        "key": "time",
+                        "name": "Time"
+                    },
+                    {
+                        "key": "yesterday",
+                        "name": "Yesterday"
+                    },
+                    {
+                        "key": "delta",
+                        "name": "Delta"
+                    }
+                ],
+                "priority": -1
+            }
+        ]
+    }
+
+    return function(openmct){
+        //Register legacy extensions for things not yet supported by the new API
+        Object.keys(legacyExtensions).forEach(function (type){
+            var extensionsOfType = legacyExtensions[type];
+            extensionsOfType.forEach(function (extension) {
+                openmct.legacyExtension(type, extension)
+            })
+        });
+        openmct.types.addType("generator", {
+            label: "Sine Wave Generator",
+            description: "For development use. Generates example streaming telemetry data using a simple sine wave algorithm.",
+            cssClass: "icon-telemetry",
+            creatable: true,
+            form: [
+                {
+                    name: "Period",
+                    control: "textfield",
+                    cssClass: "l-input-sm l-numeric",
+                    key: "period",
+                    required: true,
+                    property: [
+                        "telemetry",
+                        "period"
+                    ],
+                    pattern: "^\\d*(\\.\\d*)?$"
+                },
+                {
+                    name: "Amplitude",
+                    control: "textfield",
+                    cssClass: "l-input-sm l-numeric",
+                    key: "amplitude",
+                    required: true,
+                    property: [
+                        "telemetry",
+                        "amplitude"
+                    ],
+                    pattern: "^\\d*(\\.\\d*)?$"
+                },
+                {
+                    name: "Offset",
+                    control: "textfield",
+                    cssClass: "l-input-sm l-numeric",
+                    key: "offset",
+                    required: true,
+                    property: [
+                        "telemetry",
+                        "offset"
+                    ],
+                    pattern: "^\\d*(\\.\\d*)?$"
+                },
+                {
+                    name: "Data Rate (hz)",
+                    control: "textfield",
+                    cssClass: "l-input-sm l-numeric",
+                    key: "dataRateInHz",
+                    required: true,
+                    property: [
+                        "telemetry",
+                        "dataRateInHz"
+                    ],
+                    pattern: "^\\d*(\\.\\d*)?$"
+                }
+            ],
+            initialize: function (object) {
+                object.telemetry = {
+                    period: 10,
+                    amplitude: 1,
+                    offset: 0,
+                    dataRateInHz: 1,
+                    domains: [
+                        {
+                            key: "utc",
+                            name: "Time",
+                            format: "utc"
+                        },
+                        {
+                            key: "yesterday",
+                            name: "Yesterday",
+                            format: "utc"
+                        },
+                        {
+                            key: "delta",
+                            name: "Delta",
+                            format: "example.delta"
+                        }
+                    ],
+                    ranges: [
+                        {
+                            key: "sin",
+                            name: "Sine"
+                        },
+                        {
+                            key: "cos",
+                            name: "Cosine"
+                        }
+                    ]
+                };
+            }
+        });
+        openmct.telemetry.addProvider(new GeneratorProvider());
+    };
+
+});
--- a/index.html
+++ b/index.html
@ -25,28 +25,32 @@
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
    <title></title>
+    <script src="openmct-tutorial/lib/http.js">
+    </script>
    <script src="bower_components/requirejs/require.js">
    </script>
+    <script src="openmct-tutorial/dictionary-plugin.js">
+    </script>
+    <script src="openmct-tutorial/realtime-telemetry-plugin.js">
+    </script>
+    <script src="openmct-tutorial/historical-telemetry-plugin.js">
+    </script>
    <script>
        require(['openmct'], function (openmct) {
            [
                'example/imagery',
-                'example/eventGenerator',
-                'example/generator'
+                'example/eventGenerator'
            ].forEach(
                openmct.legacyRegistry.enable.bind(openmct.legacyRegistry)
            );
-            openmct.install(openmct.plugins.myItems);
-            openmct.install(openmct.plugins.localStorage);
-            openmct.install(openmct.plugins.espresso);
-
+            openmct.install(openmct.plugins.MyItems());
+            openmct.install(openmct.plugins.LocalStorage());
+            openmct.install(openmct.plugins.Espresso());
+            openmct.install(openmct.plugins.Generator());
            openmct.install(openmct.plugins.UTCTimeSystem());
-            openmct.install(openmct.plugins.Conductor({
-                defaultTimeSystem: 'utc',
-                defaultTimespan: 30 * 60 * 1000,
-                showConductor: false
-            }));
-
+            openmct.install(DictionaryPlugin());
+            openmct.install(RealtimeTelemetryPlugin());
+            openmct.install(HistoricalTelemetryPlugin());
            openmct.start();
        });
    </script>
--- a/1
+++ b/1
--- a/openmct.js
+++ b/openmct.js
@ -84,5 +84,11 @@ define([
        return new Main().run(defaultRegistry);
    });

+    // For now, install conductor by default
+    openmct.install(openmct.plugins.Conductor({
+        showConductor: false
+    }));
+
+
    return openmct;
 });
--- a/platform/commonUI/general/res/sass/startup-base.scss
+++ b/platform/commonUI/general/res/sass/startup-base.scss
@ -19,6 +19,7 @@
 * this source code distribution or the Licensing information page available
 * at runtime from the About dialog for additional information.
 *****************************************************************************/
+$output-bourbon-deprecation-warnings: false;
@import "bourbon";
@import "logo-and-bg";

--- a/platform/commonUI/themes/espresso/res/sass/theme-espresso.scss
+++ b/platform/commonUI/themes/espresso/res/sass/theme-espresso.scss
@ -19,7 +19,7 @@
 * this source code distribution or the Licensing information page available
 * at runtime from the About dialog for additional information.
 *****************************************************************************/
-
+$output-bourbon-deprecation-warnings: false;
@import "bourbon";

@import "../../../../general/res/sass/_mixins";
--- a/platform/commonUI/themes/snow/res/sass/theme-snow.scss
+++ b/platform/commonUI/themes/snow/res/sass/theme-snow.scss
@ -19,7 +19,7 @@
 * this source code distribution or the Licensing information page available
 * at runtime from the About dialog for additional information.
 *****************************************************************************/
-
+$output-bourbon-deprecation-warnings: false;
@import "bourbon";

@import "../../../../general/res/sass/_mixins";
--- a/platform/features/conductor/compatibility/bundle.js
+++ b/platform/features/conductor/compatibility/bundle.js
@ -21,11 +21,9 @@
 *****************************************************************************/

 define([
-    "./src/ConductorTelemetryDecorator",
    "./src/ConductorRepresenter",
    'legacyRegistry'
 ], function (
-    ConductorTelemetryDecorator,
    ConductorRepresenter,
    legacyRegistry
 ) {
@ -39,16 +37,6 @@ define([
                        "openmct"
                    ]
                }
-            ],
-            "components": [
-                {
-                    "type": "decorator",
-                    "provides": "telemetryService",
-                    "implementation": ConductorTelemetryDecorator,
-                    "depends": [
-                        "openmct"
-                    ]
-                }
            ]
        }
    });
--- a/platform/features/conductor/compatibility/src/ConductorTelemetryDecorator.js
+++ b/platform/features/conductor/compatibility/src/ConductorTelemetryDecorator.js
@ -1,87 +0,0 @@
-/*****************************************************************************
- * Open MCT Web, Copyright (c) 2014-2015, United States Government
- * as represented by the Administrator of the National Aeronautics and Space
- * Administration. All rights reserved.
- *
- * Open MCT Web is licensed under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance with the License.
- * 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 Web 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.
- *****************************************************************************/
-
-define(
-    function () {
-
-        /**
-         * Decorates the `telemetryService` such that requests are
-         * mediated by the time conductor. This is a modified version of the
-         * decorator used in the old TimeConductor that integrates with the
-         * new TimeConductor API.
-         *
-         * @constructor
-         * @memberof platform/features/conductor
-         * @implements {TelemetryService}
-         * @param {platform/features/conductor.TimeConductor} conductor
-         *        the service which exposes the global time conductor
-         * @param {TelemetryService} telemetryService the decorated service
-         */
-        function ConductorTelemetryDecorator(openmct, telemetryService) {
-            this.conductor = openmct.conductor;
-            this.telemetryService = telemetryService;
-
-            this.amendRequests = ConductorTelemetryDecorator.prototype.amendRequests.bind(this);
-        }
-
-        function amendRequest(request, bounds, timeSystem) {
-            request = request || {};
-            request.start = bounds.start;
-            request.end = bounds.end;
-            request.domain = timeSystem.metadata.key;
-
-            return request;
-        }
-
-        ConductorTelemetryDecorator.prototype.amendRequests = function (requests) {
-            var bounds = this.conductor.bounds(),
-                timeSystem = this.conductor.timeSystem();
-
-            return (requests || []).map(function (request) {
-                return amendRequest(request, bounds, timeSystem);
-            });
-        };
-
-        ConductorTelemetryDecorator.prototype.requestTelemetry = function (requests) {
-            return this.telemetryService
-                .requestTelemetry(this.amendRequests(requests));
-        };
-
-        ConductorTelemetryDecorator.prototype.subscribe = function (callback, requests) {
-            var unsubscribeFunc = this.telemetryService.subscribe(callback, this.amendRequests(requests)),
-                conductor = this.conductor,
-                self = this;
-
-            function amendRequests() {
-                return self.amendRequests(requests);
-            }
-
-            conductor.on('bounds', amendRequests);
-            return function () {
-                unsubscribeFunc();
-                conductor.off('bounds', amendRequests);
-            };
-        };
-
-        return ConductorTelemetryDecorator;
-    }
-);
--- a/platform/features/conductor/core/bundle.js
+++ b/platform/features/conductor/core/bundle.js
@ -72,7 +72,7 @@ define([
                        "timeConductorViewService",
                        "formatService",
                        "DEFAULT_TIMECONDUCTOR_MODE",
-                        "SHOW_TIMECONDUCTOR",
+                        "SHOW_TIMECONDUCTOR"
                    ]
                },
                {
--- a/platform/features/conductor/core/res/sass/time-conductor-espresso.scss
+++ b/platform/features/conductor/core/res/sass/time-conductor-espresso.scss
@ -19,6 +19,7 @@
 * this source code distribution or the Licensing information page available
 * at runtime from the About dialog for additional information.
 *****************************************************************************/
+$output-bourbon-deprecation-warnings: false;
@import "bourbon";
@import "../../../../../commonUI/general/res/sass/constants";
@import "../../../../../commonUI/general/res/sass/mixins";
--- a/platform/features/conductor/core/res/sass/time-conductor-snow.scss
+++ b/platform/features/conductor/core/res/sass/time-conductor-snow.scss
@ -19,6 +19,7 @@
 * this source code distribution or the Licensing information page available
 * at runtime from the About dialog for additional information.
 *****************************************************************************/
+$output-bourbon-deprecation-warnings: false;
@import "bourbon";
@import "../../../../../commonUI/general/res/sass/constants";
@import "../../../../../commonUI/general/res/sass/mixins";
--- a/platform/features/conductor/core/src/ui/TimeConductorController.js
+++ b/platform/features/conductor/core/src/ui/TimeConductorController.js
@ -41,10 +41,10 @@ define(
         * @constructor
         */
        function TimeConductorController(
-            $scope, 
-            $window, 
-            $location, 
-            openmct, 
+            $scope,
+            $window,
+            $location,
+            openmct,
            conductorViewService,
            formatService,
            DEFAULT_MODE,
@ -68,6 +68,11 @@ define(
            this.modes = conductorViewService.availableModes();
            this.validation = new TimeConductorValidation(this.conductor);
            this.formatService = formatService;
+
+            //Check if the default mode defined is actually available
+            if (this.modes[DEFAULT_MODE] === undefined) {
+                DEFAULT_MODE = 'fixed';
+            }
            this.DEFAULT_MODE = DEFAULT_MODE;

            // Construct the provided time system definitions
--- a/platform/features/conductor/core/src/ui/TimeConductorControllerSpec.js
+++ b/platform/features/conductor/core/src/ui/TimeConductorControllerSpec.js
@ -130,8 +130,10 @@ define(['./TimeConductorController'], function (TimeConductorController) {
                    mockLocation,
                    {conductor: mockTimeConductor},
                    mockConductorViewService,
-                    mockTimeSystems,
-                    mockFormatService
+                    mockFormatService,
+                    'fixed',
+                    true
+
                );

                tsListener = getListener(mockTimeConductor.on, "timeSystem");
@ -244,7 +246,6 @@ define(['./TimeConductorController'], function (TimeConductorController) {
            var ts1Metadata;
            var ts2Metadata;
            var ts3Metadata;
-            var mockTimeSystemConstructors;

            beforeEach(function () {
                mode = "realtime";
@ -276,11 +277,7 @@ define(['./TimeConductorController'], function (TimeConductorController) {
                ];

                //Wrap in mock constructors
-                mockTimeSystemConstructors = mockTimeSystems.map(function (mockTimeSystem) {
-                    return function () {
-                        return mockTimeSystem;
-                    };
-                });
+                mockConductorViewService.systems = mockTimeSystems;

                controller = new TimeConductorController(
                    mockScope,
@ -288,8 +285,9 @@ define(['./TimeConductorController'], function (TimeConductorController) {
                    mockLocation,
                    {conductor: mockTimeConductor},
                    mockConductorViewService,
-                    mockTimeSystemConstructors,
-                    mockFormatService
+                    mockFormatService,
+                    "fixed",
+                    true
                );
            });

@ -434,12 +432,7 @@ define(['./TimeConductorController'], function (TimeConductorController) {
                    }
                };

-                mockTimeSystems.push(function () {
-                    return timeSystem;
-                });
-                mockTimeSystems.push(function () {
-                    return otherTimeSystem;
-                });
+                mockConductorViewService.systems = [timeSystem, otherTimeSystem];

                urlBounds = {
                    start: 100,
@ -467,8 +460,9 @@ define(['./TimeConductorController'], function (TimeConductorController) {
                    mockLocation,
                    {conductor: mockTimeConductor},
                    mockConductorViewService,
-                    mockTimeSystems,
-                    mockFormatService
+                    mockFormatService,
+                    "fixed",
+                    true
                );

                spyOn(controller, "setMode");
--- a/platform/features/conductor/utcTimeSystem/src/UTCTimeSystem.js
+++ b/platform/features/conductor/utcTimeSystem/src/UTCTimeSystem.js
@ -66,7 +66,7 @@ define([
    };

    UTCTimeSystem.prototype.defaults = function (defaults) {
-        if (arguments.length > 0){
+        if (arguments.length > 0) {
            this.defaultValues = defaults;
        }

@ -81,7 +81,7 @@ define([
                deltas: {start: FIFTEEN_MINUTES, end: 0},
                bounds: {start: now - FIFTEEN_MINUTES, end: now},
                zoom: {min: FIFTY_YEARS, max: ONE_MINUTE}
-            }
+            };
        }
        return this.defaultValues;
    };
--- a/platform/features/timeline/res/sass/timeline-espresso.scss
+++ b/platform/features/timeline/res/sass/timeline-espresso.scss
@ -19,6 +19,7 @@
 * this source code distribution or the Licensing information page available
 * at runtime from the About dialog for additional information.
 *****************************************************************************/
+$output-bourbon-deprecation-warnings: false;
@import "bourbon";

@import "../../../../commonUI/general/res/sass/constants";
--- a/platform/features/timeline/res/sass/timeline-snow.scss
+++ b/platform/features/timeline/res/sass/timeline-snow.scss
@ -19,6 +19,7 @@
 * this source code distribution or the Licensing information page available
 * at runtime from the About dialog for additional information.
 *****************************************************************************/
+$output-bourbon-deprecation-warnings: false;
@import "bourbon";

@import "../../../../commonUI/general/res/sass/constants";
--- a/platform/features/timeline/res/sass/timeline.scss
+++ b/platform/features/timeline/res/sass/timeline.scss
@ -19,6 +19,7 @@
 * this source code distribution or the Licensing information page available
 * at runtime from the About dialog for additional information.
 *****************************************************************************/
+$output-bourbon-deprecation-warnings: false;
@import "bourbon";

@import "../../../../commonUI/general/res/sass/constants";
--- a/platform/telemetry/bundle.js
+++ b/platform/telemetry/bundle.js
@ -79,6 +79,7 @@ define([
                    "key": "telemetry",
                    "implementation": TelemetryCapability,
                    "depends": [
+                        "openmct",
                        "$injector",
                        "$q",
                        "$log"
--- a/platform/telemetry/src/TelemetryCapability.js
+++ b/platform/telemetry/src/TelemetryCapability.js
@ -24,8 +24,12 @@
 * Module defining TelemetryCapability. Created by vwoeltje on 11/12/14.
 */
 define(
-    [],
-    function () {
+    [
+        '../../../src/api/objects/object-utils'
+    ],
+    function (
+        objectUtils
+    ) {

        var ZERO = function () {
            return 0;
@ -103,7 +107,7 @@ define(
         * @implements {Capability}
         * @constructor
         */
-        function TelemetryCapability($injector, $q, $log, domainObject) {
+        function TelemetryCapability(openmct, $injector, $q, $log, domainObject) {
            // We could depend on telemetryService directly, but
            // there isn't a platform implementation of this.
            this.initializeTelemetryService = function () {
@ -118,7 +122,7 @@ define(
                }
            };

-
+            this.openmct = openmct;
            this.$q = $q;
            this.$log = $log;
            this.domainObject = domainObject;
@ -135,7 +139,8 @@ define(
                type = domainObject.getCapability("type"),
                typeRequest = (type && type.getDefinition().telemetry) || {},
                modelTelemetry = domainObject.getModel().telemetry,
-                fullRequest = Object.create(typeRequest);
+                fullRequest = Object.create(typeRequest),
+                bounds;

            // Add properties from the telemetry field of this
            // specific domain object.
@ -156,10 +161,30 @@ define(
                fullRequest.key = domainObject.getId();
            }

+            if (request.start === undefined && request.end === undefined) {
+                bounds = this.openmct.conductor.bounds();
+                fullRequest.start = bounds.start;
+                fullRequest.end = bounds.end;
+            }
+
            return fullRequest;
        };


+        function asSeries(telemetry, defaultDomain, defaultRange) {
+            return {
+                getRangeValue: function (index, range) {
+                    return telemetry[index][range || defaultRange];
+                },
+                getDomainValue: function (index, domain) {
+                    return telemetry[index][domain || defaultDomain];
+                },
+                getPointCount: function () {
+                    return telemetry.length;
+                }
+            };
+        }
+
        /**
         * Request telemetry data for this specific domain object.
         * @param {TelemetryRequest} [request] parameters for this
@ -169,11 +194,21 @@ define(
         */
        TelemetryCapability.prototype.requestData = function requestTelemetry(request) {
            // Bring in any defaults from the object model
-            var fullRequest = this.buildRequest(request || {}),
-                source = fullRequest.source,
-                key = fullRequest.key,
-                telemetryService = this.telemetryService ||
-                    this.initializeTelemetryService(); // Lazy initialization
+            var fullRequest = this.buildRequest(request || {});
+            var source = fullRequest.source;
+            var key = fullRequest.key;
+            var telemetryService = this.telemetryService ||
+                this.initializeTelemetryService(); // Lazy initialization
+
+            var domainObject = objectUtils.toNewFormat(this.domainObject.getModel(), this.domainObject.getId());
+            var telemetryAPI = this.openmct.telemetry;
+
+            var metadata = telemetryAPI.getMetadata(domainObject);
+            var defaultDomain = (metadata.valuesForHints(['domain'])[0] || {}).key;
+            var defaultRange = (metadata.valuesForHints(['range'])[0] || {}).key;
+
+            var isLegacyProvider = telemetryAPI.findRequestProvider(domainObject) ===
+                telemetryAPI.legacyProvider;

            // Pull out the relevant field from the larger,
            // structured response.
@ -187,11 +222,17 @@ define(
                return telemetryService.requestTelemetry([fullRequest]);
            }

-            // If a telemetryService is not available,
-            // getTelemetryService() should reject, and this should
-            // bubble through subsequent then calls.
-            return telemetryService &&
-                requestTelemetryFromService().then(getRelevantResponse);
+            if (isLegacyProvider) {
+                // If a telemetryService is not available,
+                // getTelemetryService() should reject, and this should
+                // bubble through subsequent then calls.
+                return telemetryService &&
+                    requestTelemetryFromService().then(getRelevantResponse);
+            } else {
+                return telemetryAPI.request(domainObject, fullRequest).then(function (telemetry) {
+                    return asSeries(telemetry, defaultDomain, defaultRange);
+                });
+            }
        };

        /**
@ -217,12 +258,26 @@ define(
         *        subscription request
         */
        TelemetryCapability.prototype.subscribe = function subscribe(callback, request) {
-            var fullRequest = this.buildRequest(request || {}),
-                telemetryService = this.telemetryService ||
-                    this.initializeTelemetryService(); // Lazy initialization
+            var fullRequest = this.buildRequest(request || {});
+            var telemetryService = this.telemetryService ||
+                this.initializeTelemetryService(); // Lazy initialization
+
+            var domainObject = objectUtils.toNewFormat(this.domainObject.getModel(), this.domainObject.getId());
+            var telemetryAPI = this.openmct.telemetry;
+
+            var metadata = telemetryAPI.getMetadata(domainObject);
+            var defaultDomain = (metadata.valuesForHints(['domain'])[0] || {}).key;
+            var defaultRange = (metadata.valuesForHints(['range'])[0] || {}).key;
+
+            var isLegacyProvider = telemetryAPI.findSubscriptionProvider(domainObject) ===
+                telemetryAPI.legacyProvider;
+
+            function update(telemetry) {
+                callback(asSeries([telemetry], defaultDomain, defaultRange));
+            }

            // Unpack the relevant telemetry series
-            function update(telemetries) {
+            function updateLegacy(telemetries) {
                var source = fullRequest.source,
                    key = fullRequest.key,
                    result = ((telemetries || {})[source] || {})[key];
@ -231,8 +286,13 @@ define(
                }
            }

-            return telemetryService &&
-                telemetryService.subscribe(update, [fullRequest]);
+            // Avoid a loop here...
+            if (isLegacyProvider) {
+                return telemetryService &&
+                    telemetryService.subscribe(updateLegacy, [fullRequest]);
+            } else {
+                return telemetryAPI.subscribe(domainObject, update, fullRequest);
+            }
        };

        /**
--- a/platform/telemetry/test/TelemetryCapabilitySpec.js
+++ b/platform/telemetry/test/TelemetryCapabilitySpec.js
@ -32,8 +32,9 @@ define(
                mockTelemetryService,
                mockReject,
                mockUnsubscribe,
-                telemetry;
-
+                telemetry,
+                mockTelemetryAPI,
+                mockAPI;

            function mockPromise(value) {
                return {
@ -43,6 +44,9 @@ define(
                };
            }

+            function noop() {
+            }
+
            beforeEach(function () {
                mockInjector = jasmine.createSpyObj("$injector", ["get"]);
                mockQ = jasmine.createSpyObj("$q", ["when", "reject"]);
@ -79,7 +83,33 @@ define(
                // Bubble up...
                mockReject.then.andReturn(mockReject);

+                mockTelemetryAPI = jasmine.createSpyObj("telemetryAPI", [
+                    "getMetadata",
+                    "subscribe",
+                    "request",
+                    "findRequestProvider",
+                    "findSubscriptionProvider"
+                ]);
+                mockTelemetryAPI.getMetadata.andReturn({
+                    valuesForHints: function () {
+                        return [];
+                    }
+                });
+
+                mockAPI = {
+                    telemetry: mockTelemetryAPI,
+                    conductor: {
+                        bounds: function () {
+                            return {
+                                start: 0,
+                                end: 1
+                            };
+                        }
+                    }
+                };
+
                telemetry = new TelemetryCapability(
+                    mockAPI,
                    mockInjector,
                    mockQ,
                    mockLog,
@ -113,7 +143,6 @@ define(
                        key: "testKey", // from model
                        start: 42 // from argument
                    }]);
-
            });

            it("provides an empty series when telemetry is missing", function () {
@ -129,7 +158,9 @@ define(
                expect(telemetry.getMetadata()).toEqual({
                    id: "testId", // from domain object
                    source: "testSource",
-                    key: "testKey"
+                    key: "testKey",
+                    start: 0,
+                    end: 1
                });
            });

@ -143,7 +174,9 @@ define(
                expect(telemetry.getMetadata()).toEqual({
                    id: "testId", // from domain object
                    source: "testSource", // from model
-                    key: "testId" // from domain object
+                    key: "testId", // from domain object
+                    start: 0,
+                    end: 1
                });
            });

@ -161,6 +194,57 @@ define(
                expect(mockLog.warn).toHaveBeenCalled();
            });

+            it("if a new style telemetry source is available, use it", function () {
+                var mockProvider = {};
+                mockTelemetryAPI.findSubscriptionProvider.andReturn(mockProvider);
+                telemetry.subscribe(noop, {});
+                expect(mockTelemetryService.subscribe).not.toHaveBeenCalled();
+                expect(mockTelemetryAPI.subscribe).toHaveBeenCalled();
+            });
+
+            it("if a new style telemetry source is not available, revert to old API", function () {
+                mockTelemetryAPI.findSubscriptionProvider.andReturn(undefined);
+                telemetry.subscribe(noop, {});
+                expect(mockTelemetryAPI.subscribe).not.toHaveBeenCalled();
+                expect(mockTelemetryService.subscribe).toHaveBeenCalled();
+            });
+
+            it("Wraps telemetry returned from the new API as a telemetry series", function () {
+                var returnedTelemetry;
+                var mockTelemetry = [{
+                    prop1: "val1",
+                    prop2: "val2",
+                    prop3: "val3"
+                },
+                {
+                    prop1: "val4",
+                    prop2: "val5",
+                    prop3: "val6"
+                }];
+                var mockProvider = {};
+                var dunzo = false;
+
+                mockTelemetryAPI.findRequestProvider.andReturn(mockProvider);
+                mockTelemetryAPI.request.andReturn(Promise.resolve(mockTelemetry));
+
+                telemetry.requestData({}).then(function (data) {
+                    returnedTelemetry = data;
+                    dunzo = true;
+                });
+
+                waitsFor(function () {
+                    return dunzo;
+                });
+
+                runs(function () {
+                    expect(returnedTelemetry.getPointCount).toBeDefined();
+                    expect(returnedTelemetry.getDomainValue).toBeDefined();
+                    expect(returnedTelemetry.getRangeValue).toBeDefined();
+                    expect(returnedTelemetry.getPointCount()).toBe(2);
+                });
+
+            });
+
            it("allows subscriptions to updates", function () {
                var mockCallback = jasmine.createSpy("callback"),
                    subscription = telemetry.subscribe(mockCallback);
@ -171,7 +255,9 @@ define(
                    [{
                        id: "testId", // from domain object
                        source: "testSource",
-                        key: "testKey"
+                        key: "testKey",
+                        start: 0,
+                        end: 1
                    }]
                );

--- a/src/api/telemetry/TelemetryMetadataManager.js
+++ b/src/api/telemetry/TelemetryMetadataManager.js
@ -105,7 +105,6 @@ define([
        this.valueMetadatas = this.valueMetadatas.map(applyReasonableDefaults);
    }

-
    /**
     * Get value metadata for a single key.
     */
--- a/src/defaultRegistry.js
+++ b/src/defaultRegistry.js
@ -33,7 +33,6 @@ define([
    '../example/export/bundle',
    '../example/extensions/bundle',
    '../example/forms/bundle',
-    '../example/generator/bundle',
    '../example/identity/bundle',
    '../example/imagery/bundle',
    '../example/mobile/bundle',
--- a/src/plugins/plugins.js
+++ b/src/plugins/plugins.js
@ -22,23 +22,27 @@

 define([
    'lodash',
-    '../../platform/features/conductor/utcTimeSystem/src/UTCTimeSystem'
+    '../../platform/features/conductor/utcTimeSystem/src/UTCTimeSystem',
+    '../../example/generator/plugin'
 ], function (
    _,
-    UTCTimeSystem
+    UTCTimeSystem,
+    GeneratorPlugin
 ) {
    var bundleMap = {
-        couchDB: 'platform/persistence/couch',
-        elasticsearch: 'platform/persistence/elastic',
-        espresso: 'platform/commonUI/themes/espresso',
-        localStorage: 'platform/persistence/local',
-        myItems: 'platform/features/my-items',
-        snow: 'platform/commonUI/themes/snow'
+        CouchDB: 'platform/persistence/couch',
+        Elasticsearch: 'platform/persistence/elastic',
+        Espresso: 'platform/commonUI/themes/espresso',
+        LocalStorage: 'platform/persistence/local',
+        MyItems: 'platform/features/my-items',
+        Snow: 'platform/commonUI/themes/snow'
    };

    var plugins = _.mapValues(bundleMap, function (bundleName, pluginName) {
-        return function (openmct) {
-            openmct.legacyRegistry.enable(bundleName);
+        return function pluginConstructor() {
+            return function (openmct) {
+                openmct.legacyRegistry.enable(bundleName);
+            };
        };
    });

@ -48,47 +52,59 @@ define([
                "implementation": UTCTimeSystem,
                "depends": ["$timeout"]
            });
-        }
+        };
    };

+    var conductorInstalled = false;
+
    plugins.Conductor = function (options) {
        if (!options) {
            options = {};
        }
-        
+
+        function applyDefaults(openmct, timeConductorViewService) {
+            var defaults = {};
+            var timeSystem = timeConductorViewService.systems.find(function (ts) {
+                return ts.metadata.key === options.defaultTimeSystem;
+            });
+            if (timeSystem !== undefined) {
+                defaults = timeSystem.defaults();
+
+                if (options.defaultTimespan !== undefined) {
+                    defaults.deltas.start = options.defaultTimespan;
+                    defaults.bounds.start = defaults.bounds.end - options.defaultTimespan;
+                    timeSystem.defaults(defaults);
+                }
+
+                openmct.conductor.timeSystem(timeSystem, defaults.bounds);
+            }
+        }
+
        return function (openmct) {
            openmct.legacyExtension('constants', {
                key: 'DEFAULT_TIMECONDUCTOR_MODE',
                value: options.showConductor ? 'fixed' : 'realtime',
-                priority: 'mandatory'
-            });
-            openmct.legacyExtension('constants', {
-                key: 'SHOW_TIMECONDUCTOR',
-                value: options.showConductor,
-                priority: 'mandatory'
+                priority: conductorInstalled ? 'mandatory' : 'fallback'
            });
+            if (options.showConductor !== undefined) {
+                openmct.legacyExtension('constants', {
+                    key: 'SHOW_TIMECONDUCTOR',
+                    value: options.showConductor,
+                    priority: conductorInstalled ? 'mandatory' : 'fallback'
+                });
+            }
            if (options.defaultTimeSystem !== undefined || options.defaultTimespan !== undefined) {
                openmct.legacyExtension('runs', {
-                    implementation: function (openmct, $timeout, timeConductorViewService) {
-                        var timeSystem = timeConductorViewService.systems.find(function (ts) {
-                            return ts.metadata.key === options.defaultTimeSystem;
-                        });
-                        if (options.defaultTimespan !== undefined && timeSystem !== undefined) {
-                            var defaults = timeSystem.defaults();
-                            defaults.deltas.start = options.defaultTimespan;
-                            defaults.bounds.start = defaults.bounds.end - options.defaultTimespan;
-                            timeSystem.defaults(defaults);
-                        }
-                        if (timeSystem!== undefined) {
-                            openmct.conductor.timeSystem(timeSystem, defaults.bounds);
-                        }
-                    },
-                    depends: ["openmct", "$timeout", "timeConductorViewService"]
+                    implementation: applyDefaults,
+                    depends: ["openmct", "timeConductorViewService"]
                });
            }

-            openmct.legacyRegistry.enable('platform/features/conductor/core');
-            openmct.legacyRegistry.enable('platform/features/conductor/compatibility');
+            if (!conductorInstalled) {
+                openmct.legacyRegistry.enable('platform/features/conductor/core');
+                openmct.legacyRegistry.enable('platform/features/conductor/compatibility');
+            }
+            conductorInstalled = true;
        };
    };

@ -110,7 +126,7 @@ define([
                openmct.legacyRegistry.enable(bundleName);
            }

-            openmct.legacyRegistry.enable(bundleMap.couchDB);
+            openmct.legacyRegistry.enable(bundleMap.CouchDB);
        };
    };

@ -132,9 +148,13 @@ define([
                openmct.legacyRegistry.enable(bundleName);
            }

-            openmct.legacyRegistry.enable(bundleMap.elasticsearch);
+            openmct.legacyRegistry.enable(bundleMap.Elasticsearch);
        };
    };

+    plugins.Generator = function () {
+        return GeneratorPlugin;
+    };
+
    return plugins;
 });
Author	SHA1	Message	Date
Henry	9553e0c64f	Tutorial packages	2017-02-27 19:28:21 -08:00
Henry	da40f4c96e	[Plot] Add current conductor bounds to telemetry requests via the old API. Replaces telemetry decorator. Fixes #1458	2017-02-27 19:26:51 -08:00
Charles Hacskaylo	6fa5a31217	Merge pull request #1433 from nasa/open1432 [Build] Installed sound suppression system for Bourbon deprecation messages.	2017-02-27 11:12:27 -08:00
Pete Richards	5bc7a701dc	Merge pull request #1455 from nasa/api-conductor-config [Conductor] Allow configuration of conductor defaults	2017-02-24 14:58:50 -08:00
Pete Richards	5cd0516048	Enable TC by default and hide Set up TC so that it is always enabled and defaults to realtime mode. This allows us to have warp-like functionality without showing the TC interface, and simplifies a lot of tutorials. We can still reconfigure the TC by re-installing the plugin with different settings	2017-02-24 14:56:18 -08:00
Pete Richards	48a603ece8	Merge branch 'api-legacy-telemetry-provider-v2'	2017-02-24 14:47:10 -08:00
Pete Richards	abfa56464a	Merge branch 'plugins-functions'	2017-02-24 14:34:54 -08:00
Henry	c1d6e21c3c	Added tests. Fixes #1364	2017-02-23 13:50:14 -08:00
Henry	3bd556a406	Fixed failing tests	2017-02-23 10:21:33 -08:00
Henry	347fb6d882	Fixed style errors	2017-02-23 10:19:10 -08:00
Henry	b3cf7a5d93	Added support for new style telemetry providers from old screens. Converted SWG to new style data adapter	2017-02-23 09:58:46 -08:00
Henry	b10fb4533e	All builtin plugins now standardized as functions	2017-02-22 12:51:49 -08:00
Henry	77d0134e2e	[Build] Added Bourbon deprecation warning suppression system.	2017-02-10 10:03:05 -08:00