fprime-gds 3.3.2__py3-none-any.whl → 3.4.0__py3-none-any.whl

fprime_gds/flask/json.py

@@ -20,7 +20,7 @@ from fprime_gds.common.templates.data_template import DataTemplate
 
 
 def jsonify_base_type(input_type: Type[BaseType]) -> dict:
-    """ Turn a base type into a JSONable dictionary
+    """Turn a base type into a JSONable dictionary
 
     Convert a BaseType (the type, not an instance) into a jsonable dictionary. BaseTypes are converted by reading the
     class properties (without __) and creating the object:
@@ -36,14 +36,17 @@ def jsonify_base_type(input_type: Type[BaseType]) -> dict:
         json-able dictionary representing the type
     """
     assert issubclass(input_type, BaseType), "Failure to properly encode data"
-    members = getmembers(input_type, lambda value: not isroutine(value) and not isinstance(value, property))
+    members = getmembers(
+        input_type,
+        lambda value: not isroutine(value) and not isinstance(value, property),
+    )
     jsonable_dict = {name: value for name, value in members if not name.startswith("_")}
     jsonable_dict.update({"name": input_type.__name__})
     return jsonable_dict
 
 
 def getter_based_json(obj):
-    """ Converts objects to JSON via get_ methods
+    """Converts objects to JSON via get_ methods
 
     Template functions define a series of get_* methods whose return values need to be serialized. This function
     handles that data.
@@ -80,7 +83,7 @@ def getter_based_json(obj):
 
 
 def minimal_event(obj):
-    """ Minimal event encoding: time, id, display_text
+    """Minimal event encoding: time, id, display_text
 
     Events need time, id, display_text. No other information from the event is necessary for the display.  This will
     minimally encode the data for JSON.
@@ -95,7 +98,7 @@ def minimal_event(obj):
 
 
 def minimal_channel(obj):
-    """ Minimal channel serialization: time, id, val, and display_text
+    """Minimal channel serialization: time, id, val, and display_text
 
     Minimally serializes channel values for use with the flask layer. This does away with any unnecessary data by
     serializing only the id, value, and optional display text
@@ -106,11 +109,16 @@ def minimal_channel(obj):
     Returns:
         JSON compatible python anonymous type (dictionary)
     """
-    return {"time": obj.time, "id": obj.id, "val": obj.val_obj.val, "display_text": obj.display_text}
+    return {
+        "time": obj.time,
+        "id": obj.id,
+        "val": obj.val_obj.val,
+        "display_text": obj.display_text,
+    }
 
 
 def minimal_command(obj):
-    """ Minimal command serialization: time, id, and args values
+    """Minimal command serialization: time, id, and args values
 
     Minimally serializes the command values for use with the flask layer. This prevents excess data by keeping the data
     to the minimum instance data for commands including: time, opcode (id), and the value for args.
@@ -125,7 +133,7 @@ def minimal_command(obj):
 
 
 def time_type(obj):
-    """ Time type serialization
+    """Time type serialization
 
     Serializes the time type into a JSON compatible object.
 
@@ -137,49 +145,46 @@ def time_type(obj):
     """
     assert isinstance(obj, TimeType), "Incorrect type for serialization method"
     return {
-            "base": obj.timeBase.value,
-            "context": obj.timeContext,
-            "seconds": obj.seconds,
-            "microseconds": obj.useconds
-        }
+        "base": obj.timeBase.value,
+        "context": obj.timeContext,
+        "seconds": obj.seconds,
+        "microseconds": obj.useconds,
+    }
 
 
 def enum_json(obj):
-    """ Jsonify the python enums! """
+    """Jsonify the python enums!"""
     enum_dict = {"value": str(obj), "values": {}}
     for enum_val in type(obj):
         enum_dict["values"][str(enum_val)] = enum_val.value
     return enum_dict
 
 
-class GDSJsonEncoder(flask.json.JSONEncoder):
-    """
-    Custom class used to handle GDS object to JSON
+JSON_ENCODERS = {
+    ABCMeta: jsonify_base_type,
+    UUID: str,
+    ChData: minimal_channel,
+    EventData: minimal_event,
+    CmdData: minimal_command,
+    TimeType: time_type,
+}
+
+
+def default(obj):
     """
-    JSON_ENCODERS = {
-        ABCMeta: jsonify_base_type,
-        UUID: str,
-        ChData: minimal_channel,
-        EventData: minimal_event,
-        CmdData: minimal_command,
-        TimeType: time_type
-    }
+    Override the default JSON encoder to pull out a dictionary for our handled types for encoding with the default
+    encoder built into flask. This function must convert the given object into a JSON compatable python object (e.g.
+    using lists, dictionaries, strings, and primitive types).
 
-    def default(self, obj):
-        """
-        Override the default JSON encoder to pull out a dictionary for our handled types for encoding with the default
-        encoder built into flask. This function must convert the given object into a JSON compatable python object (e.g.
-        using lists, dictionaries, strings, and primitive types).
-
-        :param obj: obj to encode
-        :return: JSON
-        """
-        if type(obj) in self.JSON_ENCODERS:
-            return self.JSON_ENCODERS[type(obj)](obj)
-        if isinstance(obj, DataTemplate):
-            return getter_based_json(obj)
-        if isinstance(obj, Enum):
-            return enum_json(obj)
-        if isinstance(obj, ValueType):
-            return obj.val
-        return flask.json.JSONEncoder.default(self, obj)
+    :param obj: obj to encode
+    :return: JSON
+    """
+    if type(obj) in JSON_ENCODERS:
+        return JSON_ENCODERS[type(obj)](obj)
+    if isinstance(obj, DataTemplate):
+        return getter_based_json(obj)
+    if isinstance(obj, Enum):
+        return enum_json(obj)
+    if isinstance(obj, ValueType):
+        return obj.val
+    return flask.json.provider.DefaultJSONProvider.default(obj)

fprime_gds/flask/static/addons/advanced-settings/addon-templates.js

@@ -9,6 +9,10 @@ export let advanced_template = `
                 <h3>{{ setting_category.replace("_", " ") }}</h3>
                 <div v-html="settings[setting_category].description"></div>
                 <div class="input-group mb-3" v-for="setting_key in Object.keys(settings[setting_category].settings)">
+                    <small v-if="(settings[setting_category].descriptions || {})[setting_key]">
+                        <strong>{{ setting_key }}</strong>
+                        {{ settings[setting_category].descriptions[setting_key]}}
+                    </small>
                     <div class="input-group-prepend col-6">
                         <span class="input-group-text col-12">{{ setting_key }}</span>
                     </div>

fprime_gds/flask/static/addons/advanced-settings/addon.js

@@ -19,13 +19,19 @@ Vue.component("advanced-settings", {
                     settings: _settings.polling_intervals
                 },
                 "Miscellaneous": {
-                    description: "Miscellaneous settings for GDS UI operations." +
-                        "<small><ul>" +
-                        "<li>event_buffer_size: maximum event records. Default: -1, infinite.</li>" +
-                        "<li>command_buffer_size: maximum command history records. Default: -1, infinite.</li>" +
-                        "<li>response_object_limit: maximum results to load per polling request. Default: 6000</li>" +
-                        '<li>compact_commanding: use compact "flattened" style for commanding complex arguments.</li>' +
-                        "</ul></small>",
+                    description: "Miscellaneous settings for GDS UI operations.",
+                    descriptions: {
+                        event_buffer_size: "Maximum number of events stored by the GDS. When exceeded, oldest events are dropped " +
+                                            "Lower this value if performance drops on the Events tab. Default: -1, no limit.",
+                        command_buffer_size: "Maximum number of commands stored by the GDS. When exceeded, oldest commands are dropped " +
+                                                "Lower this value if performance drops on the Commanding tab. Default: -1, no limit.",
+                        response_object_limit: "Limit to the number of objects returned by one POLL request to the backend. " +
+                                                "Lower this value if polling times are longer than polling intervals. Default: 6000.",
+                        compact_commanding: "Use the compact form for command arguments. In this form, Array and Serializable type " +
+                                            "inputs are flattened into a sequential set of input boxes without extraneous structure.",
+                        channels_display_last_received: "When set, any channel received will update the displayed value. Otherwise " +
+                                                        "only channels with newer timestamps update the displayed value."
+                    },
                     settings: _settings.miscellaneous
                 }
             },

fprime_gds/flask/static/addons/channel-render/channel-render.js

@@ -107,7 +107,13 @@ Vue.component("channel-render", {
          * @returns: display text of item/child item
          */
         displayText() {
-            return this.item?.display_text || this.item?.val || this.val || "";
+            let possibles = [this.item?.display_text, this.item?.val, this.val];
+            for (let i = 0; i < possibles.length; i++) {
+                if (typeof(possibles[i]) !== "undefined" && possibles[i] !== null) {
+                    return possibles[i];
+                }
+            }
+            return "";
         }
 
     }
@@ -120,4 +126,4 @@ let channel_row_data = {
 /**
  * channel-row replaces fp-row in display template only.
  */
-Vue.component("channel-row", channel_row_data);
+Vue.component("channel-row", channel_row_data);

fprime_gds/flask/static/addons/commanding/argument-templates.js

@@ -15,6 +15,17 @@ export let command_enum_argument_template = `
 </v-select>
 `;
 
+/**
+ * Enum argument uses the v-select dropdown to render the various choices while providing search and match capabilities.
+ */
+export let command_bool_argument_template = `
+<v-select :id="argument.name" style="flex: 1 1 auto; background-color: white;"
+          :clearable="false" :searchable="true" @input="validateTrigger"
+          :filterable="true"  label="full_name" :options="['True', 'False']"
+          v-model="argument.value" class="fprime-input" :class="argument.error == '' ? '' : 'is-invalid'" required>
+</v-select>
+`;
+
 /**
  * Serializable arguments "flatten" the structure into a list of fields.
  */
@@ -59,13 +70,13 @@ export let command_array_argument_template = `
  * enumerations are handled here as they represent a single scalar input.
  */
 export let command_scalar_argument_template = `
-<div style="display: contents;">
+<div style="display: contents;" class="fprime-scalar-argument">
     <div class="form-group col-md-6">
         <label :for="argument.name" class="control-label font-weight-bold">
             {{ argument.name + ((argument.description != null) ? ": " + argument.description : "") }}
         </label>
-        
-        <command-enum-argument v-if="argument.type.ENUM_DICT" :argument="argument"></command-enum-argument>
+        <command-bool-argument v-if="argument.type.name == 'BoolType'" :argument="argument"></command-bool-argument>
+        <command-enum-argument v-else-if="argument.type.ENUM_DICT" :argument="argument"></command-enum-argument>
         <input v-else :type="inputType[0]" v-bind:id="argument.name" class="form-control fprime-input"
                :placeholder="argument.name" :pattern="inputType[1]" :step="inputType[2]" v-on:input="validateTrigger"
                v-model="argument.value"  :class="argument.error == '' ? '' : 'is-invalid'" required>

fprime_gds/flask/static/addons/commanding/arguments.js

@@ -8,6 +8,7 @@
  */
 import "../../third-party/js/vue-select.js"
 import {
+    command_bool_argument_template,
     command_enum_argument_template,
     command_array_argument_template,
     command_serializable_argument_template,
@@ -118,6 +119,35 @@ export function squashify_argument(argument) {
             let field = argument.type.MEMBER_LIST[i][0];
             value[field] = squashify_argument(argument.value[field]);
         }
+    } else if (["U64Type", "U32Type", "U16Type", "U8Type"].indexOf(argument.type.name) != -1) {
+        if (argument.value.startsWith("0x")) {
+            // Hexadecimal
+            value = parseInt(argument.value, 16);
+        } else if (argument.value.startsWith("0b")) {
+            // Binary
+            value = parseInt(argument.value.slice(2), 2);
+        } else if (argument.value.startsWith("0o")) {
+            // Octal
+            value = parseInt(argument.value.slice(2), 8);
+        } else {
+            // Decimal
+            value = parseInt(argument.value, 10);
+        }
+    }
+    else if (["I64Type", "I32Type", "I16Type", "I8Type"].indexOf(argument.type.name) != -1) {
+        value = parseInt(argument.value, 10);
+    }
+    else if (["F64Type", "F32Type"].indexOf(argument.type.name) != -1) {
+        value = parseFloat(argument.value);
+    }
+    else if (argument.type.name == "BoolType") {
+        if ((typeof(value) === "string") && (["true", "yes"].indexOf(value.toLowerCase()) !== -1)) {
+            value = true;
+        } else if ((typeof(value) === "string") && (["false", "no"].indexOf(value.toLowerCase()) !== -1)) {
+            value = false;
+        } else {
+            console.assert(typeof(value) !== "boolean", "Cannot process boolean, invalid input type")
+        }
     }
     return value;
 }
@@ -174,13 +204,22 @@ let base_argument_component_properties = {
             validateArgument(recurse_down) {
                 recurse_down = !!(recurse_down); // Force recurse_down to be defined as a boolean
                 let valid = validate_input(this.argument);
-                // HTML element validation
+                // Each scalar argument needs to set custom validity on the HTML input that it owns. However, non-scalar
+                // inputs skip this step less the first scalar child's input box be poisoned with incorrect validity due
+                // to the unbounded recursive nature of getElementsByClassName used to find a fprime-input children.
+                let is_scalar = [...document.getElementsByClassName("fprime-scalar-argument")]
+                    .filter((scalar) => scalar === this.$el || scalar.contains(this.$el)).length > 0;
+
+                // Now grab the singular the nearest input and report validity if and only if this is a scalar. Non-
+                // scalar values are compositions of scalar children and thus validity will be set when the scalar
+                // itself is validated.
                 let input_element = this.$el.getElementsByClassName("fprime-input")[0] || this.$el;
-                if (input_element.setCustomValidity && input_element.reportValidity) {
+                if (is_scalar && input_element.setCustomValidity && input_element.reportValidity) {
                     input_element.setCustomValidity(this.argument.error);
                     input_element.reportValidity();
                 }
-                // Downward recursion uses children
+                // Validation can happen recursively down through the children, or up through the parent in order to
+                // laterally validate complex arguments when a single input scalar filed is adjusted.
                 let recursive_listing = (recurse_down) ? this.$children.slice().reverse() : [this.$parent];
                 let valid_recursion = (recursive_listing || []).reduce(
                     (accumulator, next_element) => {
@@ -225,6 +264,14 @@ Vue.component("command-enum-argument", {
     template: command_enum_argument_template,
 });
 
+/**
+ * Special boolean processing component to render as a drop-down.
+ */
+Vue.component("command-bool-argument", {
+    ...base_argument_component_properties,
+    template: command_bool_argument_template,
+});
+
 /**
  * Scalar argument processing. Sets up the input type such that numbers can be input with the correct formatting.
  */
@@ -239,14 +286,14 @@ Vue.component("command-scalar-argument", {
          */
         inputType() {
             // Unsigned integer
-            if (this.argument.type.name[0] == 'U') {
+            if (["U64Type", "U32Type", "U16Type", "U8Type"].indexOf(this.argument.type.name) != -1) {
                 // Supports binary, hex, octal, and digital
                 return ["text", "0[bB][01]+|0[oO][0-7]+|0[xX][0-9a-fA-F]+|[1-9]\\d*|0", ""];
             }
-            else if (this.argument.type.name[0] == 'I') {
+            else if (["I64Type", "I32Type", "I16Type", "I8Type"].indexOf(this.argument.type.name) != -1) {
                 return ["number", null, "1"];
             }
-            else if (this.argument.type.name[0] == 'F') {
+            else if (["F64Type", "F32Type"].indexOf(this.argument.type.name) != -1) {
                 return ["number", null, "any"];
             }
             return ["text", ".*", null];

fprime_gds/flask/static/js/datastore.js

@@ -28,6 +28,7 @@ class HistoryHelper {
         this.active_key = active_key;
         this.consumers = [];
         this.active_timeout = null;
+        this.counter = 0;
     }
 
     /**
@@ -58,7 +59,8 @@ class HistoryHelper {
         // Break our when no new items returned
         if (new_items.length === 0) { return; }
         new_items.filter((item) => item.time).forEach((item) => {
-            item.datetime = timeToDate(item.time)
+            item.datetime = timeToDate(item.time);
+            item.incremental_id = this.counter++;
         });
         this.consumers.forEach((consumer) => {
             try {
@@ -119,7 +121,18 @@ class FullListHistory extends ListHistory {
      * @param new_items: new items being to be process
      */
     send(new_items) {
-        this.store.splice(0, this.store.length, ...new_items);
+        // When the lists are not the same, update the stored list otherwise keep the list to prevent unnecessary bound
+        // data re-rendering.
+        if (this.store.length !== new_items.length) {
+            this.store.splice(0, this.store.length, ...new_items);
+            return;
+        }
+        for (let i = 0; i < Math.min(this.store.length, new_items.length); i++) {
+            if (this.store[i] !== new_items[i]) {
+                this.store.splice(0, this.store.length, ...new_items);
+                return;
+            }
+        }
     }
 }
 
@@ -148,8 +161,12 @@ class MappedHistory extends HistoryHelper {
         let updated = {};
         for (let i = 0; i < new_items.length; i++) {
             let item = new_items[i];
-            // Check for miss-ordered updates
-            if ((this.store[item.id] || null) === null || item.datetime >= this.store[item.id].datetime) {
+            // When displaying last received, update the value always
+            if (_settings.miscellaneous.channels_display_last_received) {
+                updated[item.id] = item;
+            }
+            // Otherwise check for a newer timestamp
+            else if ((this.store[item.id] || null) === null || item.datetime >= this.store[item.id].datetime) {
                 updated[item.id] = item;
             }
         }
@@ -270,6 +287,10 @@ class DataStore {
         if (argument.type.ENUM_DICT) {
             argument.value = Object.keys(argument.type.ENUM_DICT)[0];
         }
+        // Booleans are initialized to True
+        else if (argument.type.name === "BoolType") {
+            argument.value = "True";
+        }
         // Arrays expand to a set length of N pseudo-arguments
         else if (argument.type.LENGTH) {
             let array_length = argument.type.LENGTH;

fprime_gds/flask/static/js/settings.js

@@ -12,7 +12,8 @@ class Settings {
             event_buffer_size: -1,
             command_buffer_size: -1,
             response_object_limit: 6000,
-            compact_commanding: false
+            compact_commanding: false,
+            channels_display_last_received: true
          };
          this.polling_intervals = {};
     }

fprime_gds/flask/static/js/validate.js

@@ -116,6 +116,11 @@ export function validate_scalar_input(argument) {
         argument.error = "";
         return true;
     }
+    // Boolean type handling
+    else if (argument.type.name === "BoolType") {
+        return (argument.value == null) ? null :
+            ["yes", "no", "true", "false"].indexOf(argument.value.toString().toLowerCase()) >= 0;
+    }
     console.assert(false, "Unknown scalar type: " + argument.type.name);
     argument.error = "";
     return true;

fprime_gds/flask/static/js/vue-support/event.js

@@ -109,7 +109,7 @@ Vue.component("event-list", {
          * @return {string} unique key
          */
         keyify(item) {
-            return "evt-" + item.id + "-" + item.time.seconds + "-"+ item.time.microseconds;
+            return "evt-" + item.id + "-" + item.time.seconds + "-"+ item.time.microseconds + "-" + item.incremental_id;
         },
         /**
          * A function to clear events out of the data store. This is to reset the events entirely.

fprime_gds/flask/static/js/vue-support/log.js

@@ -21,9 +21,11 @@ let template = `
         <div class="my-3">
             <v-select id="logselect"
                     :clearable="true" :searchable="true"
-                    :filterable="true"  :options="options"
+                    :filterable="true"  :options="logs"
                     v-model="selected">
             </v-select>
+            <input name="scroll" type="checkbox" v-model="scroll" />
+            <label for="scroll">Scroll Log Output</label>
         </div>
     </div>
     <div class="fp-scroll-container">
@@ -31,6 +33,7 @@ let template = `
             <pre><code>{{ text }}</code></pre>
         </div>
     </div>
+    <div class="alert alert-danger" role="alert" v-if="error">{{ error }}</div>
 </div>
 `;
 
@@ -40,19 +43,10 @@ Vue.component('v-select', VueSelect.VueSelect);
 
 Vue.component("logging", {
     template: template,
-    data() {return {"selected": "", "logs": _datastore.logs, text: ""}},
+    data() {return {"selected": "", "logs": _datastore.logs, text: "", "scroll": true, "error": ""}},
     mounted() {
         setInterval(this.update, 1000); // Grab log updates once a second
     },
-    computed:{
-        /**
-         * Computes the appropriate log files available.
-         * @return {string[]}
-         */
-        options: function () {
-            return this.logs;
-        }
-    },
     methods: {
         /**
          * Updates the log data such that new logs can be displayed.
@@ -65,8 +59,22 @@ Vue.component("logging", {
             _loader.load("/logdata/" + this.selected, "GET").then(
                 (result) => {
                     _self.text = result[_self.selected];
-                    this.$el.scrollTop = this.$el.scrollHeight
-                }).catch((result) => {_self.text = "[ERROR] "+ result});
+                    // Update on next-tick so that the updated content has been drawn already
+                    _self.$nextTick(() => {
+                        let panes = _self.$el.getElementsByClassName("fp-scrollable");
+                        if (panes && _self.scroll)
+                        {
+                            panes[0].scrollTop = panes[0].scrollHeight;
+                        }
+                    });
+                    _self.error = "";
+                }).catch((result) => {
+                    if (result === "") {
+                        _self.error = "[ERROR] Failed to update log content.";
+                    } else {
+                        _self.error = "[ERROR] " + result + ".";
+                    }
+                });
         }
     }
 });

{fprime_gds-3.3.2.dist-info → fprime_gds-3.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fprime-gds
-Version: 3.3.2
+Version: 3.4.0
 Summary: F Prime Flight Software Ground Data System layer.
 Home-page: https://github.com/nasa/fprime
 Author: Michael Starch
@@ -23,7 +23,7 @@ Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.7
 License-File: LICENSE.txt
 License-File: NOTICE.txt
-Requires-Dist: flask <=2.2.3,>=1.1.2
+Requires-Dist: flask >=3.0.0
 Requires-Dist: flask-compress >=1.11
 Requires-Dist: pyzmq >=24.0.1
 Requires-Dist: pexpect >=4.8.0