openc3 5.0.9 → 5.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce13d20a53c970d01c019afff0088ee574998e393eb0e56be1ea3bc1af2dbc3c
-  data.tar.gz: '079099f252bf45fcbbcec9f05239de9c84858a166cfb2077806554bcdae76258'
+  metadata.gz: 89287db0131e005414e13d5e1ad18916fb85af1fecd415feb234ded2dc7808a4
+  data.tar.gz: 18ba67b0e23fb908c256540fe380e863655d7fd8b9368dd42fea34d254820c61
 SHA512:
-  metadata.gz: bf8762aa78976151e1c561e55fd08de0593f82055d759a6c1c2ed5db9fd3b0510141077f70592cade4a7dbf1ff957657ea4252b6a7d4839046b6b69f853a5cda
-  data.tar.gz: 457563612d61588d7f18da69a48df88b0368b0fba3e9840d7a316eabf334d3e88218cfca584327f927f23f119c005aef4dba63e033b011a7d4c8bcdc071df15c
+  metadata.gz: c181ccc282a7a97baf9f5bba954822d6e38499ead775bb8261216e70f1ecd4870bc071f2c9a56aa835697f4596e0748df018bde8a18486deb1a9a63360217f66
+  data.tar.gz: ea11fef50705c7cfa4c74f239abbf0c0c02b163a10c3cda6db15408eb3fef1fd69501df8be844741d49f274a1ad9edc01af866614f20ccd400c24f5ab73a512d

data/data/config/_id_items.yaml

@@ -20,5 +20,6 @@
   values: "['\"].*['\"]"
 - name: Endianness
   required: false
-  description: Indicates if the item is to be interpreted in Big Endian or Little Endian format
+  description: Indicates if the item is to be interpreted in Big Endian or Little Endian format.
+    See guide on <a href="https://openc3.com/docs/v5/little-endian-bitfields">Little Endian Bitfields</a>.
   values: <%= %w(BIG_ENDIAN LITTLE_ENDIAN) %>

data/data/config/_id_params.yaml

@@ -31,7 +31,8 @@
           values: "['\"].*['\"]"
         - name: Endianness
           required: false
-          description: Indicates if the data in this command is to be sent in Big Endian or Little Endian format
+          description: Indicates if the data in this command is to be sent in Big Endian or Little Endian format.
+            See guide on <a href="https://openc3.com/docs/v5/little-endian-bitfields">Little Endian Bitfields</a>.
           values: <%= %w(BIG_ENDIAN LITTLE_ENDIAN) %>
     UINT:
       parameters: *params

data/data/config/_items.yaml

@@ -16,5 +16,6 @@
   values: "['\"].*['\"]"
 - name: Endianness
   required: false
-  description: Indicates if the item is to be interpreted in Big Endian or Little Endian format
+  description: Indicates if the item is to be interpreted in Big Endian or Little Endian format.
+    See guide on <a href="https://openc3.com/docs/v5/little-endian-bitfields">Little Endian Bitfields</a>.
   values: <%= %w(BIG_ENDIAN LITTLE_ENDIAN) %>

data/data/config/_params.yaml

@@ -32,7 +32,8 @@
           values: '[''"].*[''"]'
         - name: Endianness
           required: false
-          description: Indicates if the data in this command is to be sent in Big Endian or Little Endian format
+          description: Indicates if the data in this command is to be sent in Big Endian or Little Endian format.
+            See guide on <a href="https://openc3.com/docs/v5/little-endian-bitfields">Little Endian Bitfields</a>.
           values: <%= %w(BIG_ENDIAN LITTLE_ENDIAN) %>
     UINT:
       parameters: *params

data/data/config/command_modifiers.yaml

@@ -158,3 +158,33 @@ HAZARDOUS:
       required: false
       description: Description for why the command is hazardous which must be enclosed with quotes
       values: "['\"].*['\"]"
+ACCESSOR:
+  summary: Defines the class used to read and write raw values from the packet
+  description: Defines the class that is used too read raw values from the packet. Defaults to BinaryAccessor.
+    Provided accessors also include JsonAccessor, CborAccessor, HtmlAccessor, and XmlAccessor.
+  parameters:
+    - name: Accessor Class Name
+      required: true
+      description: The name of the accessor class
+      values: .+
+  since: 5.0.10
+TEMPLATE:
+  summary: Defines a template string used to initialize the command before default values are filled in
+  description: Generally the template string is formatted in JSON or HTML and then values are filled in with
+    command parameters. Must be UTF-8 encoded.
+  parameters:
+    - name: Template
+      required: true
+      description: The template string which should be enclosed in quotes
+      values: "['\"].*['\"]"
+  since: 5.0.10
+TEMPLATE_FILE:
+  summary: Defines a template file used to initialize the command before default values are filled in
+  description: Generally the template file is formatted in JSON or HTML and then values are filled in with
+    command parameters. Can be binary or UTF-8.
+  parameters:
+    - name: Template File Path
+      required: true
+      description: The relative path to the template file. Filename should generally start with an underscore.
+      values: .+
+  since: 5.0.10

data/data/config/item_modifiers.yaml

@@ -219,3 +219,13 @@ LIMITS_RESPONSE:
       description: Variable length number of options that will be passed to the
         class constructor
       values: .+
+KEY:
+  summary: Defines the key used to access this raw value in the packet.
+  description: Keys are often JsonPath or XPath strings
+  example: KEY $.book.title
+  parameters:
+    - name: Key string
+      required: true
+      description: The key to access this item
+      values: .+
+  since: 5.0.10

data/data/config/microservice.yaml

@@ -32,6 +32,18 @@ MICROSERVICE:
           required: true
           description: Working directory to run the microservice CMD in. Can be a path relative to the microservice folder in the plugin, or an absolute path in the container the microservice runs in.
           values: .+
+    PORT:
+      summary: Open port for the microservice
+      description: Kubernetes needs a Service to be applied to open a port so this is required for Kubernetes support
+      parameters:
+        - name: Number
+          required: true
+          description: Port number
+          values: \d+
+        - name: Protocol
+          required: false
+          description: Port protocol. Default is TCP.
+          values: .+
     TOPIC:
       summary: Associate a Redis topic
       description: Redis topic to associate with this microservice. Standard OpenC3 microservices such as decom_microservice use this information to know what packet streams to subscribe to. The TOPIC keyword can be used as many times as necessary to associate all needed topics.

data/data/config/param_item_modifiers.yaml

@@ -50,3 +50,13 @@ OVERLAP:
     If an item's bit offset overlaps another item, OpenC3 issues a warning. This keyword explicitly
     allows an item to overlap another and supresses the warning message.
   since: 4.4.1
+KEY:
+  summary: Defines the key used to access this raw value in the packet.
+  description: Keys are often JsonPath or XPath strings
+  example: KEY $.book.title
+  parameters:
+    - name: Key string
+      required: true
+      description: The key to access this item
+      values: .+
+  since: 5.0.10

data/data/config/plugins.yaml

@@ -38,15 +38,6 @@ INTERFACE:
         documentation for more details.
 ROUTER:
   modifiers:
-    ROUTE:
-      summary: Map an interface to a router
-      description: Once an interface has been mapped to a router, all its received telemetry
-        will be sent out through the router.
-      parameters:
-        - name: Interface
-          required: true
-          description: Name of the interface
-          values: .+
     <%= MetaConfigParser.load('interface_modifiers.yaml').to_meta_config_yaml(4) %>
   summary: Create router to receive commands and output telemetry packets from one or more interfaces
   description: Creates an router which receives command packets from

data/data/config/telemetry_modifiers.yaml

@@ -157,3 +157,13 @@ HIDDEN:
     It also hides this telemetry from appearing in the Script Runner popup helper
     when writing scripts. The telemetry still exists in the system and can received
     and checked by scripts.
+ACCESSOR:
+  summary: Defines the class used to read and write raw values from the packet
+  description: Defines the class that is used too read raw values from the packet. Defaults to BinaryAccessor.
+    Provided accessors also include JsonAccessor, CborAccessor, HtmlAccessor, and XmlAccessor.
+  parameters:
+    - name: Accessor Class Name
+      required: true
+      description: The name of the accessor class
+      values: .+
+  since: 5.0.10

data/ext/openc3/ext/packet/packet.c

@@ -57,6 +57,7 @@ static ID id_ivar_packet_name = 0;
 static ID id_ivar_description = 0;
 static ID id_ivar_stored = 0;
 static ID id_ivar_extra = 0;
+static ID id_ivar_template = 0;
 
 /* Sets the target name this packet is associated with. Unidentified packets
  * will have target name set to nil.
@@ -193,6 +194,22 @@ static VALUE packet_initialize(int argc, VALUE *argv, VALUE self)
 
   switch (argc)
   {
+  case 0:
+    target_name = Qnil;
+    packet_name = Qnil;
+    default_endianness = symbol_BIG_ENDIAN;
+    description = Qnil;
+    buffer = Qnil;
+    item_class = cPacketItem;
+    break;
+  case 1:
+    target_name = argv[0];
+    packet_name = Qnil;
+    default_endianness = symbol_BIG_ENDIAN;
+    description = Qnil;
+    buffer = Qnil;
+    item_class = cPacketItem;
+    break;
   case 2:
     target_name = argv[0];
     packet_name = argv[1];
@@ -235,7 +252,7 @@ static VALUE packet_initialize(int argc, VALUE *argv, VALUE self)
     break;
   default:
     /* Invalid number of arguments given */
-    rb_raise(rb_eArgError, "wrong number of arguments (%d for 2..6)", argc);
+    rb_raise(rb_eArgError, "wrong number of arguments (%d for 0..6)", argc);
     break;
   };
 
@@ -264,7 +281,7 @@ static VALUE packet_initialize(int argc, VALUE *argv, VALUE self)
   rb_ivar_set(self, id_ivar_disabled, Qfalse);
   rb_ivar_set(self, id_ivar_stored, Qfalse);
   rb_ivar_set(self, id_ivar_extra, Qnil);
-
+  rb_ivar_set(self, id_ivar_template, Qnil);
   return self;
 }
 
@@ -305,6 +322,7 @@ void Init_packet(void)
   id_ivar_description = rb_intern("@description");
   id_ivar_stored = rb_intern("@stored");
   id_ivar_extra = rb_intern("@extra");
+  id_ivar_template = rb_intern("@template");
 
   cPacket = rb_define_class_under(mOpenC3, "Packet", cStructure);
   rb_define_method(cPacket, "initialize", packet_initialize, -1);

data/ext/openc3/ext/structure/structure.c

@@ -44,6 +44,7 @@ static VALUE MAX_INT64 = Qnil;
 static VALUE MAX_UINT64 = Qnil;
 
 static VALUE mOpenC3 = Qnil;
+static VALUE cAccessor = Qnil;
 static VALUE cBinaryAccessor = Qnil;
 static VALUE cStructure = Qnil;
 static VALUE cStructureItem = Qnil;
@@ -51,6 +52,7 @@ static VALUE cStructureItem = Qnil;
 static ID id_method_to_s = 0;
 static ID id_method_raise_buffer_error = 0;
 static ID id_method_read_array = 0;
+static ID id_method_read_item = 0;
 static ID id_method_force_encoding = 0;
 static ID id_method_freeze = 0;
 static ID id_method_slice = 0;
@@ -78,6 +80,7 @@ static ID id_ivar_fixed_size = 0;
 static ID id_ivar_short_buffer_allowed = 0;
 static ID id_ivar_mutex = 0;
 static ID id_ivar_create_index = 0;
+static ID id_ivar_accessor = 0;
 
 static ID id_const_ASCII_8BIT_STRING = 0;
 static ID id_const_ZERO_STRING = 0;
@@ -1298,11 +1301,8 @@ static VALUE structure_length(VALUE self)
 
 static VALUE read_item_internal(VALUE self, VALUE item, VALUE buffer)
 {
-  volatile VALUE bit_offset = Qnil;
-  volatile VALUE bit_size = Qnil;
   volatile VALUE data_type = Qnil;
-  volatile VALUE array_size = Qnil;
-  volatile VALUE endianness = Qnil;
+  volatile VALUE accessor = Qnil;
 
   data_type = rb_ivar_get(item, id_ivar_data_type);
   if (data_type == symbol_DERIVED)
@@ -1314,18 +1314,9 @@ static VALUE read_item_internal(VALUE self, VALUE item, VALUE buffer)
   {
     buffer = rb_funcall(self, id_method_allocate_buffer_if_needed, 0);
   }
-  bit_offset = rb_ivar_get(item, id_ivar_bit_offset);
-  bit_size = rb_ivar_get(item, id_ivar_bit_size);
-  array_size = rb_ivar_get(item, id_ivar_array_size);
-  endianness = rb_ivar_get(item, id_ivar_endianness);
-  if (RTEST(array_size))
-  {
-    return rb_funcall(cBinaryAccessor, id_method_read_array, 6, bit_offset, bit_size, data_type, array_size, buffer, endianness);
-  }
-  else
-  {
-    return binary_accessor_read(cBinaryAccessor, bit_offset, bit_size, data_type, buffer, endianness);
-  }
+
+  accessor = rb_ivar_get(self, id_ivar_accessor);
+  return rb_funcall(accessor, id_method_read_item, 2, item, buffer);
 }
 
 /*
@@ -1562,6 +1553,7 @@ static VALUE structure_initialize(int argc, VALUE *argv, VALUE self)
     rb_ivar_set(self, id_ivar_fixed_size, Qtrue);
     rb_ivar_set(self, id_ivar_short_buffer_allowed, Qfalse);
     rb_ivar_set(self, id_ivar_mutex, Qnil);
+    rb_ivar_set(self, id_ivar_accessor, cBinaryAccessor);
   }
   else
   {
@@ -1607,11 +1599,13 @@ void Init_structure(void)
   volatile VALUE ascii_8bit_string = Qnil;
 
   mOpenC3 = rb_define_module("OpenC3");
-  cBinaryAccessor = rb_define_class_under(mOpenC3, "BinaryAccessor", rb_cObject);
+  cAccessor = rb_define_class_under(mOpenC3, "Accessor", rb_cObject);
+  cBinaryAccessor = rb_define_class_under(mOpenC3, "BinaryAccessor", cAccessor);
 
   id_method_to_s = rb_intern("to_s");
   id_method_raise_buffer_error = rb_intern("raise_buffer_error");
   id_method_read_array = rb_intern("read_array");
+  id_method_read_item = rb_intern("read_item");
   id_method_force_encoding = rb_intern("force_encoding");
   id_method_freeze = rb_intern("freeze");
   id_method_slice = rb_intern("slice");
@@ -1670,6 +1664,7 @@ void Init_structure(void)
   id_ivar_short_buffer_allowed = rb_intern("@short_buffer_allowed");
   id_ivar_mutex = rb_intern("@mutex");
   id_ivar_create_index = rb_intern("@create_index");
+  id_ivar_accessor = rb_intern("@accessor");
 
   symbol_LITTLE_ENDIAN = ID2SYM(rb_intern("LITTLE_ENDIAN"));
   symbol_BIG_ENDIAN = ID2SYM(rb_intern("BIG_ENDIAN"));

data/lib/openc3/accessors/accessor.rb

@@ -0,0 +1,71 @@
+# encoding: ascii-8bit
+
+# Copyright 2022 OpenC3, Inc.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU Affero General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+module OpenC3
+  class Accessor
+    def read_item(item, buffer)
+      raise "Must be defined by subclass"
+    end
+
+    def write_item(item, value, buffer)
+      raise "Must be defined by subclass"
+    end
+
+    def self.read_items(items, buffer)
+      result = {}
+      items.each do |item|
+        result[item.name] = read_item(item, buffer)
+      end
+      return result
+    end
+
+    def self.write_items(items, values, buffer)
+      items.each_with_index do |item, index|
+        write_item(item, values[index], buffer)
+      end
+      return buffer
+    end
+
+    def self.convert_to_type(value, item)
+      data_type = item.data_type
+      if (data_type == :STRING) || (data_type == :BLOCK)
+        #######################################
+        # Handle :STRING and :BLOCK data types
+        #######################################
+        value = value.to_s
+
+      elsif (data_type == :INT) || (data_type == :UINT)
+        ###################################
+        # Handle :INT data type
+        ###################################
+        value = Integer(value)
+
+      elsif data_type == :FLOAT
+        ##########################
+        # Handle :FLOAT data type
+        ##########################
+        value = Float(value)
+
+      else
+        ############################
+        # Handle Unknown data types
+        ############################
+
+        raise(ArgumentError, "data_type #{data_type} is not recognized")
+      end
+      return value
+    end
+  end
+end