openc3 5.5.2 → 5.6.0

data/lib/openc3/version.rb

@@ -1,14 +1,14 @@
 # encoding: ascii-8bit
 
-OPENC3_VERSION = '5.5.2'
+OPENC3_VERSION = '5.6.0'
 module OpenC3
   module Version
     MAJOR = '5'
-    MINOR = '5'
-    PATCH = '2'
+    MINOR = '6'
+    PATCH = '0'
     OTHER = ''
-    BUILD = '9c73d9c7c86512a01e0373b12b3058d3ae6b5adf'
+    BUILD = '56316d9eb44190cd24889b5cdc667b83bee266b1'
   end
-  VERSION = '5.5.2'
-  GEM_VERSION = '5.5.2'
+  VERSION = '5.6.0'
+  GEM_VERSION = '5.6.0'
 end

data/templates/conversion/conversion.rb

@@ -36,8 +36,16 @@ module OpenC3
     # @param packet [Packet] The packet object where the conversion is defined
     # @param buffer [String] The raw packet buffer
     def call(value, packet, buffer)
-      # Typically perform conversion logic directly on value
-      # e.g. value.upcase()
+      # Read values from the packet and do a conversion
+      # Used for DERVIVED items that don't have a value
+      # item1 = packet.read("ITEM1") # returns CONVERTED value (default)
+      # item2 = packet.read("ITEM2", :RAW) # returns RAW value
+      # return (item1 + item2) / 2
+      #
+      # Perform conversion logic directly on value
+      # Used when conversion is applied to a regular (not DERIVED) item
+      # NOTE: You can also use packet.read("ITEM") to get additional values
+      # return value / 2 * packet.read("OTHER_ITEM")
     end
   end
 end

data/templates/microservice/microservices/TEMPLATE/microservice.rb

@@ -35,7 +35,7 @@ module OpenC3
         break if @cancel_thread
 
         # Do your microservice work here
-        Logger.info("Template Microservice ran")
+        @logger.info("Template Microservice ran")
         # cmd("INST ABORT")
 
         # The @state variable is set to 'RUNNING' by the microservice base class

data/templates/plugin/Rakefile

@@ -8,5 +8,12 @@ task :require_version do
 end
 
 task :build => [:require_version] do
-  system("gem build #{PLUGIN_NAME}")
+  # The sh command is built into Rake:
+  # https://rubydoc.info/gems/rake/FileUtils#sh-instance_method
+  sh('gem', 'build', PLUGIN_NAME)
+  sh('openc3cli validate *.gem') do |ok, status|
+    if !ok && status.exitstatus == 127 # command not found
+      puts "Install the openc3 gem to validate! (gem install openc3)"
+    end
+  end
 end

data/templates/widget/.browserslistrc

@@ -0,0 +1,16 @@
+> 0.2%
+# Chome 80 is circa Feb 2020
+# See https://en.wikipedia.org/wiki/Google_Chrome_version_history
+chrome >= 80
+# Edge 80 is circa Jan 2020
+# See https://docs.microsoft.com/en-us/deployedge/microsoft-edge-relnote-archive-stable-channel
+edge >= 80
+# Firefox ESR is extended support release
+firefox ESR
+# Safari 13.1 released Mar 24, 2020
+# See https://en.wikipedia.org/wiki/Safari_version_history
+safari >= 13.1
+not dead
+not ie 11
+# Opera mini doesn't have built-in support for ES6
+not op_mini all

data/templates/widget/.eslintrc.js

@@ -0,0 +1,43 @@
+module.exports = {
+  root: true,
+  env: {
+    node: true,
+  },
+  extends: [
+    'plugin:vue/essential',
+    'plugin:prettier/recommended',
+    '@vue/prettier',
+  ],
+  plugins: ['prettier'],
+  rules: {
+    'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'off',
+    'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off',
+    'prettier/prettier': [
+      'warn',
+      {
+        endOfLine: 'auto',
+      },
+    ],
+    'vue/multi-word-component-names': 'off',
+    'vue/valid-v-slot': [
+      'error',
+      {
+        allowModifiers: true,
+      },
+    ],
+  },
+  parserOptions: {
+    parser: '@babel/eslint-parser',
+  },
+  overrides: [
+    {
+      files: [
+        '**/__tests__/*.{j,t}s?(x)',
+        '**/tests/unit/**/*.spec.{j,t}s?(x)',
+      ],
+      env: {
+        jest: true,
+      },
+    },
+  ],
+}

data/templates/widget/.nycrc

@@ -0,0 +1,3 @@
+{
+  "extension": [".js", ".vue"]
+}

data/templates/widget/.prettierrc.js

@@ -0,0 +1,5 @@
+module.exports = {
+  singleQuote: true,
+  semi: false,
+  bracketSpacing: true,
+}

data/templates/widget/LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License
+
+Copyright 2023 OpenC3, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in the
+Software without restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/templates/widget/Rakefile

@@ -0,0 +1,24 @@
+PLUGIN_NAME = Dir['*.gemspec'][0].split('.')[0..-2].join('.')
+
+task :require_version do
+  unless ENV['VERSION']
+    puts "VERSION is required: rake build VERSION=X.Y.Z"
+    exit 1
+  end
+end
+
+task :build => [:require_version] do
+  _, platform, *_ = RUBY_PLATFORM.split("-")
+  if platform == 'mswin32' or platform == 'mingw32'
+    puts "Warning: Building gem on Windows will lose file permissions"
+  end
+  # Build the widget and gem using sh built into Rake:
+  # https://rubydoc.info/gems/rake/FileUtils#sh-instance_method
+  sh('yarn', 'run', 'build')
+  sh('gem', 'build', PLUGIN_NAME)
+  sh('openc3cli validate *.gem') do |ok, status|
+    if !ok && status.exitstatus == 127 # command not found
+      puts "Install the openc3 gem to validate! (gem install openc3)"
+    end
+  end
+end

data/templates/widget/babel.config.json

@@ -0,0 +1,11 @@
+{
+  "presets": ["@vue/cli-plugin-babel/preset"],
+  "plugins": [
+    [
+      "babel-plugin-istanbul",
+      {
+        "extension": [".js", ".vue"]
+      }
+    ]
+  ]
+}

data/templates/widget/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "widget",
+  "version": "5.6.0",
+  "private": true,
+  "scripts": {
+    "build": "vue-cli-service build --target lib --dest tools/widgets/<%= widget_name %> --formats umd-min <%= widget_path %> --name <%= widget_name %>"
+  },
+  "dependencies": {
+    "@openc3/tool-common": "5.6.0",
+    "vue": "2.7.14",
+    "vuetify": "2.6.14"
+  },
+  "devDependencies": {
+    "@babel/eslint-parser": "7.21.3",
+    "@rushstack/eslint-patch": "1.2.0",
+    "@vue/babel-preset-app": "5.0.8",
+    "@vue/cli": "5.0.8",
+    "@vue/cli-plugin-babel": "5.0.8",
+    "@vue/cli-plugin-eslint": "5.0.8",
+    "@vue/cli-service": "5.0.8",
+    "@vue/eslint-config-prettier": "7.1.0",
+    "babel-loader": "9.1.2",
+    "babel-plugin-istanbul": "6.1.1",
+    "eslint": "8.38.0",
+    "eslint-config-prettier": "8.8.0",
+    "eslint-plugin-prettier": "4.2.1",
+    "eslint-plugin-vue": "9.11.0",
+    "prettier": "2.8.7",
+    "sass": "1.62.0",
+    "sass-loader": "13.2.2",
+    "vue-cli-plugin-vuetify": "2.5.8",
+    "vue-template-compiler": "2.7.14",
+    "webpack": "5.79.0"
+  }
+}

data/templates/widget/src/Widget.vue

@@ -0,0 +1,46 @@
+<!--
+# Copyright 2023 OpenC3, Inc.
+# All Rights Reserved.
+#
+# This file may also be used under the terms of a commercial license
+# if purchased from OpenC3, Inc.
+-->
+
+<template>
+  <div class="value-widget-container">
+    <template>
+      <v-text-field
+        solo
+        dense
+        readonly
+        single-line
+        hide-no-data
+        hide-details
+        placeholder="Value"
+        :value="_value"
+        :class="valueClass"
+        :style="computedStyle"
+        data-test="value"
+      />
+    </template>
+  </div>
+</template>
+
+<script>
+import VWidget from '@openc3/tool-common/src/components/widgets/VWidget'
+
+export default {
+  mixins: [VWidget],
+}
+</script>
+
+<style lang="scss" scoped>
+.value-widget-container {
+  min-height: 100px;
+}
+.value-widget-container :deep(input) {
+  max-height: none !important;
+  line-height: 70px !important;
+  font-size: 60px !important;
+}
+</style>

data/templates/widget/vue.config.js

@@ -0,0 +1,25 @@
+const path = require('path')
+
+module.exports = {
+  css: {
+    extract: false,
+  },
+  filenameHashing: false,
+  transpileDependencies: ['vuetify'],
+  chainWebpack(config) {
+    config.module
+      .rule('js')
+      .use('babel-loader')
+      .tap((options) => {
+        return {
+          rootMode: 'upward',
+        }
+      })
+    config.externals([
+      'vue',
+      'vuetify',
+      'vuex',
+      'vue-router',
+    ])
+  },
+}