openc3 5.17.0 → 5.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38d414a88623d811f51dc74da1f49169ca0b0c3ca3ba740e5f70b854e9524824
-  data.tar.gz: ad24c61fe6f733ae07777f3fa4dbe7b2cfd013adf8e22bc8cec63d4c1a3b1684
+  metadata.gz: e6ba1e299807bdcbb67ae8b2e678d37152286d3061a8127fe982d0d9efe39fac
+  data.tar.gz: 9b76aea8554d86a633ec2b2b35c250a2481550c2069a64e083d74d0cbb89d156
 SHA512:
-  metadata.gz: 8faed944b2e064ecf2a4d55f434dfeb91bf09f5a383aa30bc370f550fc7bc5dccfa9c1d8cf7efdda601887359dc6a44bad84e1eef27dc811341208062b038f23
-  data.tar.gz: 7c50c7428cac1a2c35a5b62121fc5791f90a3d1a6d3c2f00c61b24b2e7ebfa24990bd08c74b0af47a41979b55c41e1cd582d76cf8392260947e7578f47a9eeb2
+  metadata.gz: 34df5327bcfbcdff0c21e5856d7dcc11ee88a8f83e3e83f1a8fc9e70b37b37e36360e54f0f9ad8df8f505f9e7b6ed2cf253d0d4a8efaaec072cced50a0e104d7
+  data.tar.gz: c78d41c4ed5b18ae17450c1e50889d169c714dbc2975cc710158de682f7012be9c8f39e1a0230aaa3d67c57c26fbdeaa82bfa8617658d3ab22ac709828248209

data/bin/openc3cli

@@ -425,7 +425,7 @@ def load_plugin(plugin_file_path, scope:, plugin_hash_file: nil, force: false)
     unless OpenC3::ScopeModel.names.include?(scope)
       begin
         puts "Creating scope: #{scope}"
-        scope_model = OpenC3::ScopeModel.new(name: scope, scope: scope)
+        scope_model = OpenC3::ScopeModel.new(name: scope)
         scope_model.create
         scope_model.deploy(".", {})
       rescue => e

data/data/config/_interfaces.yaml

@@ -1,5 +1,5 @@
 ---
-tcpip_client_interface.rb:
+tcpip_client_interface:
   parameters:
     - name: Host
       required: true
@@ -29,7 +29,7 @@ tcpip_client_interface.rb:
       # prettier-ignore
       values:
         <%= MetaConfigParser.load('protocols.yaml').to_meta_config_yaml(8) %>
-tcpip_server_interface.rb:
+tcpip_server_interface:
   parameters:
     - name: Write Port
       required: true
@@ -54,7 +54,7 @@ tcpip_server_interface.rb:
       # prettier-ignore
       values:
         <%= MetaConfigParser.load('protocols.yaml').to_meta_config_yaml(8) %>
-udp_interface.rb:
+udp_interface:
   description: The UDP interface uses UDP packets to send and receive telemetry
     from the target
   parameters:
@@ -100,7 +100,7 @@ udp_interface.rb:
       required: false
       description: Address to bind UDP ports to
       values: .+
-serial_interface.rb:
+serial_interface:
   description: Connects to a target over a serial port. OpenC3 provides drivers
     for both Windows and POSIX drivers for UNIX based systems.
   parameters:

data/data/config/command_modifiers.yaml

@@ -244,3 +244,7 @@ SCREEN:
       description: Screen Name of related telemetry screen
       values: .+
   since: 5.14.0
+VIRTUAL:
+  summary: Marks this packet as virtual and not participating in identification
+  description: Used for packet definitions that can be used as structures for items with a given packet.
+  since: 5.18.0

data/data/config/interface_modifiers.yaml

@@ -6,9 +6,12 @@ MAP_TARGET:
       required: true
       description: Target name to map to this interface
       values: .+
-  example: |
+  ruby_example: |
     INTERFACE DATA_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST
       MAP_TARGET DATA
+  python_example: |
+    INTERFACE DATA_INT openc3/interfaces/tcpip_client_interface.py host.docker.internal 8080 8081 10.0 nil BURST
+      MAP_TARGET DATA
 MAP_CMD_TARGET:
   summary: Maps a target name to an interface for commands only
   since: 5.2.0
@@ -17,9 +20,12 @@ MAP_CMD_TARGET:
       required: true
       description: Command target name to map to this interface
       values: .+
-  example: |
+  ruby_example: |
     INTERFACE CMD_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST
       MAP_CMD_TARGET DATA # Only DATA commands go on the CMD_INT interface
+  python_example: |
+    INTERFACE CMD_INT openc3/interfaces/tcpip_client_interface.py host.docker.internal 8080 8081 10.0 nil BURST
+      MAP_CMD_TARGET DATA # Only DATA commands go on the CMD_INT interface
 MAP_TLM_TARGET:
   summary: Maps a target name to an interface for telemetry only
   since: 5.2.0
@@ -28,9 +34,12 @@ MAP_TLM_TARGET:
       required: true
       description: Telemetry target name to map to this interface
       values: .+
-  example: |
+  ruby_example: |
     INTERFACE TLM_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST
       MAP_TLM_TARGET DATA # Only DATA telemetry received on TLM_INT interface
+  python_example: |
+    INTERFACE TLM_INT openc3/interfaces/tcpip_client_interface.py host.docker.internal 8080 8081 10.0 nil BURST
+      MAP_TLM_TARGET DATA # Only DATA telemetry received on TLM_INT interface
 DONT_CONNECT:
   summary: Server will not automatically try to connect to the interface at startup
 DONT_RECONNECT:
@@ -102,17 +111,18 @@ PROTOCOL:
       values: ["READ", "WRITE", "READ_WRITE"]
     - name: Protocol Filename or Classname
       required: true
-      description: Ruby filename or class name which implements the protocol
+      description: Ruby or Python filename or class name which implements the protocol
       values: .*
     - name: Protocol specific parameters
       required: false
       description: Additional parameters used by the protocol
-  example: |
+  ruby_example: |
     INTERFACE DATA_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil nil
       MAP_TARGET DATA
       # Rather than defining the LENGTH protocol on the INTERFACE line we define it here
       PROTOCOL READ LengthProtocol 0 16 0 1 BIG_ENDIAN 4 0xBA5EBA11
-    INTERFACE DATA_INT tcpip_client_interface.rb host.docker.internal 8080 8081 10.0 nil BURST
+  python_example: |
+    INTERFACE DATA_INT openc3/interfaces/tcpip_client_interface.py host.docker.internal 8080 8081 10.0 nil BURST
       MAP_TARGET DATA
       PROTOCOL READ IgnorePacketProtocol INST IMAGE # Drop all INST IMAGE packets
 OPTION:
@@ -220,8 +230,8 @@ CMD:
       required: true
       description: One or more arguments to exec to run the microservice.
       values: .+
-  example: |
-    CMD ruby interface_microservice.rb DEFAULT__INTERFACE__INT1
+  ruby_example: CMD ruby interface_microservice.rb DEFAULT__INTERFACE__INT1
+  python_example: CMD python interface_microservice.py DEFAULT__INTERFACE__INT1
 CONTAINER:
   summary: Docker Container
   description: Container to execute and run the microservice in. Only used in COSMOS Enterprise Edition.

data/data/config/item_modifiers.yaml

@@ -31,14 +31,14 @@ STATE:
       values: ['GREEN', 'YELLOW', 'RED']
 READ_CONVERSION:
   summary: Applies a conversion to the current telemetry item
-  description: Conversions are implemented in a custom Ruby file which should be
-    located in the target's lib folder. The class must require 'openc3/conversions/conversion'
-    and inherit from Conversion. It must implement the initialize method if it
-    takes extra parameters and must always implement the call method. The conversion
+  description: Conversions are implemented in a custom Ruby or Python file which should be
+    located in the target's lib folder. The class must inherit from Conversion.
+    It must implement the `initialize` (Ruby) or `__init__` (Python) method if it
+    takes extra parameters and must always implement the `call` method. The conversion
     factor is applied to the raw value in the telemetry packet before it is displayed
     to the user. The user still has the ability to see the raw unconverted value
     in a details dialog.
-  example: |
+  ruby_example: |
     READ_CONVERSION the_great_conversion.rb 1000
 
     Defined in the_great_conversion.rb:
@@ -55,14 +55,26 @@ READ_CONVERSION:
         end
       end
     end
+  python_example: |
+    READ_CONVERSION the_great_conversion.py 1000
+
+    Defined in the_great_conversion.py:
+
+    from openc3.conversions.conversion import Conversion
+    class TheGreatConversion(Conversion):
+        def __init__(self, multiplier):
+            super().__init__()
+            self.multiplier = float(multiplier)
+        def call(self, value, packet, buffer):
+            return value * multiplier
   parameters:
     - name: Class Filename
       required: true
-      description: The filename which contains the Ruby class. The filename must
+      description: The filename which contains the Ruby or Python class. The filename must
         be named after the class such that the class is a CamelCase version of the
         underscored filename. For example, 'the_great_conversion.rb' should contain
         'class TheGreatConversion'.
-      values: .*\.rb
+      values: .*
     - name: Parameter
       required: false
       description: Additional parameter values for the conversion which are passed
@@ -118,19 +130,24 @@ GENERIC_READ_CONVERSION_START:
     This conversion factor is applied to the raw value in the telemetry packet
     before it is displayed to the user. The user still has the ability to see the
     raw unconverted value in a details dialog. The conversion is specified as
-    ruby code that receives two implied parameters. 'value' which is the raw
+    Ruby or Python code that receives two implied parameters. 'value' which is the raw
     value being read and 'packet' which is a reference to the telemetry packet
     class (Note, referencing the packet as 'myself' is still supported for backwards
-    compatibility). The last line of ruby code given should return the converted
+    compatibility). The last line of code should return the converted
     value. The GENERIC_READ_CONVERSION_END keyword specifies that all lines of
-    ruby code for the conversion have been given.
+    code for the conversion have been given.
   warning: Generic conversions are not a good long term solution. Consider creating
     a conversion class and using READ_CONVERSION instead. READ_CONVERSION is easier
-    to debug and higher performance.
-  example: |
+    to debug and has higher performance.
+  ruby_example: |
     APPEND_ITEM ITEM1 32 UINT
       GENERIC_READ_CONVERSION_START
-        value * 1.5  # Convert the value by a scale factor
+        return (value * 1.5).to_i # Convert the value by a scale factor
+      GENERIC_READ_CONVERSION_END
+  python_example: |
+    APPEND_ITEM ITEM1 32 UINT
+      GENERIC_READ_CONVERSION_START
+        return int(value * 1.5) # Convert the value by a scale factor
       GENERIC_READ_CONVERSION_END
   parameters:
     - name: Converted Type
@@ -208,25 +225,16 @@ LIMITS:
       values: .+
 LIMITS_RESPONSE:
   summary: Defines a response class that is called when the limits state of the current item changes
-  example: LIMITS_RESPONSE example_limits_response.rb 10
+  ruby_example: LIMITS_RESPONSE example_limits_response.rb 10
+  python_example: LIMITS_RESPONSE example_limits_response.py 10
   parameters:
     - name: Response Class Filename
       required: true
-      description: Name of the Ruby file which implements the limits response.
-        This file should be in the config/TARGET/lib directory so it can be found by OpenC3.
+      description: Name of the Ruby or Python file which implements the limits response.
+        This file should be in the target's lib directory.
       values: .+
     - name: Response Specific Options
       required: false
       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
-  since: 5.0.10
-  parameters:
-    - name: Key string
-      required: true
-      description: The key to access this item
-      values: .+
-  example: KEY $.book.title

data/data/config/microservice.yaml

@@ -87,9 +87,12 @@ MICROSERVICE:
           required: true
           description: One or more arguments to exec to run the microservice.
           values: .+
-      example: |
+      ruby_example: |
         MICROSERVICE EXAMPLE openc3-example
           CMD ruby example_target.rb
+      python_example: |
+        MICROSERVICE EXAMPLE openc3-example
+          CMD python example_target.py
     OPTION:
       summary: Pass an option to the microservice
       description: Generic key/value(s) options to pass to the microservice. These take the form of KEYWORD/PARAMS like a line in a OpenC3 configuration file. Multiple OPTION keywords can be used to pass multiple options to the microservice.

data/data/config/param_item_modifiers.yaml

@@ -60,3 +60,19 @@ KEY:
       description: The key to access this item
       values: .+
   since: 5.0.10
+VARIABLE_BIT_SIZE:
+  summary: Marks an item as having its bit size defined by another length item
+  since: 5.18.0
+  parameters:
+    - name: Length Item Name
+      required: true
+      description: The name of the associated length item
+      values: .+
+    - name: Length Bits Per Count
+      required: false
+      description: Bits per count of the length item. Defaults to 8
+      values: \d+
+    - name: Length Value Bit Offset
+      required: false
+      description: Offset in Bits to Apply to Length Field Value. Defaults to 0
+      values: \d+

data/data/config/parameter_modifiers.yaml

@@ -64,10 +64,10 @@ STATE:
 WRITE_CONVERSION:
   summary: Applies a conversion when writing the current command parameter
   description: |
-    Conversions are implemented in a custom Ruby file which should be
-    located in the target's lib folder. The class must require 'openc3/conversions/conversion'
-    and inherit from Conversion. It must implement the initialize method if it
-    takes extra parameters and must always implement the call method. The conversion
+    Conversions are implemented in a custom Ruby or Python file which should be
+    located in the target's lib folder. The class must inherit from Conversion.
+    It must implement the `initialize` (Ruby) or `__init__` (Python) method if it
+    takes extra parameters and must always implement the `call` method. The conversion
     factor is applied to the value entered by the user before it is written into
     the binary command packet and sent.
 
@@ -79,7 +79,7 @@ WRITE_CONVERSION:
     given_values() method which can be used to retrieve a hash of the user provided
     values to the command. That can be used to check parameter values passed in.
     :::
-  example: |
+  ruby_example: |
     WRITE_CONVERSION the_great_conversion.rb 1000
 
     Defined in the_great_conversion.rb:
@@ -96,14 +96,26 @@ WRITE_CONVERSION:
         end
       end
     end
+  python_example: |
+    WRITE_CONVERSION the_great_conversion.py 1000
+
+    Defined in the_great_conversion.py:
+
+    from openc3.conversions.conversion import Conversion
+    class TheGreatConversion(Conversion):
+        def __init__(self, multiplier):
+            super().__init__()
+            self.multiplier = float(multiplier)
+        def call(self, value, packet, buffer):
+            return value * multiplier
   parameters:
     - name: Class Filename
       required: true
-      description: The filename which contains the Ruby class. The filename must
+      description: The filename which contains the Ruby or Python class. The filename must
         be named after the class such that the class is a CamelCase version of the
         underscored filename. For example, 'the_great_conversion.rb' should contain
         'class TheGreatConversion'.
-      values: .*\.rb
+      values: .*
     - name: Parameter
       required: false
       description: Additional parameter values for the conversion which are passed
@@ -157,12 +169,12 @@ GENERIC_WRITE_CONVERSION_START:
     Adds a generic conversion function to the current command parameter.
     This conversion factor is applied to the value entered by the user before it
     is written into the binary command packet and sent. The conversion is specified
-    as ruby code that receives two implied parameters. 'value' which is the raw
+    as Ruby or Python code that receives two implied parameters. 'value' which is the raw
     value being written and 'packet' which is a reference to the command packet
     class (Note, referencing the packet as 'myself' is still supported for backwards
-    compatibility). The last line of ruby code given should return the converted
+    compatibility). The last line of code should return the converted
     value. The GENERIC_WRITE_CONVERSION_END keyword specifies that all lines of
-    ruby code for the conversion have been given.
+    code for the conversion have been given.
 
     :::info Multiple write conversions on command parameters
     When a command is built, each item gets written (and write conversions are run)
@@ -175,10 +187,15 @@ GENERIC_WRITE_CONVERSION_START:
   warning: Generic conversions are not a good long term solution. Consider creating
     a conversion class and using WRITE_CONVERSION instead. WRITE_CONVERSION is easier
     to debug and higher performance.
-  example: |
+  ruby_example: |
+    APPEND_PARAMETER ITEM1 32 UINT 0 0xFFFFFFFF 0
+      GENERIC_WRITE_CONVERSION_START
+        return (value * 1.5).to_i # Convert the value by a scale factor
+      GENERIC_WRITE_CONVERSION_END
+  python_example: |
     APPEND_PARAMETER ITEM1 32 UINT 0 0xFFFFFFFF 0
       GENERIC_WRITE_CONVERSION_START
-        (value * 1.5).to_i # Convert the value by a scale factor
+        return int(value * 1.5) # Convert the value by a scale factor
       GENERIC_WRITE_CONVERSION_END
 GENERIC_WRITE_CONVERSION_END:
   summary: Complete a generic write conversion

data/data/config/plugins.yaml

@@ -24,7 +24,7 @@ INTERFACE:
     <%= MetaConfigParser.load('interface_modifiers.yaml').to_meta_config_yaml(4) %>
   summary: Defines a connection to a physical target
   description: Interfaces are what OpenC3 uses to talk to a particular piece
-    of hardware. Interfaces require a Ruby file which implements all the interface
+    of hardware. Interfaces require a Ruby or Python file which implements all the interface
     methods necessary to talk to the hardware. OpenC3 defines many built in interfaces
     or you can define your own as long as it implements the interface protocol.
   parameters:
@@ -37,7 +37,7 @@ INTERFACE:
       values: \D\S*
     - name: Filename
       required: true
-      description: Ruby file to use when instantiating the interface.
+      description: Ruby or Python file to use when instantiating the interface.
       values:
         <%= MetaConfigParser.load('_interfaces.yaml').to_meta_config_yaml(8) %>
       documentation: Additional parameters are required. Please see the [Interfaces](../configuration/interfaces.md)
@@ -57,7 +57,7 @@ ROUTER:
       values: .+
     - name: Filename
       required: true
-      description: Ruby file to use when instantiating the interface.
+      description: Ruby or Python file to use when instantiating the interface.
       values:
         <%= MetaConfigParser.load('_interfaces.yaml').to_meta_config_yaml(8) %>
       documentation: Additional parameters are required. Please see the [Interfaces](../configuration/interfaces.md)

data/data/config/screen.yaml

@@ -60,8 +60,8 @@ GLOBAL_SUBSETTING:
     made up of more than one subwidget. For example, LABELVALUE is made up of a LABEL
     at subwidget index 0 and a VALUE at subwidget index 1. This allows for passing
     settings to specific subwidgets. Some widgets are made up of multiple subwidgets,
-    e.g. LABELVALUELIMITSBAR. To set the label text color, pass '0:0' as the Subwidget
-    Index to first index the LABELVALUE and then the LABEL.
+    e.g. LABELVALUELIMITSBAR. To set the Label widget, pass 0 as the Subwidget
+    Index, pass 1 for the Value widget, and 2 for the LimitsBar widget.
   parameters:
     - name: Widget Class Name
       required: true
@@ -82,7 +82,7 @@ GLOBAL_SUBSETTING:
       values: .*
   example: |
     # Set all text color to white for labelvaluelimitsbars
-    GLOBAL_SUBSETTING LABELVALUELIMITSBAR 0:0 TEXTCOLOR white
+    GLOBAL_SUBSETTING LABELVALUELIMITSBAR 0 TEXTCOLOR white
 SETTING:
   summary: Applies a widget setting to the previously defined widget
   description: |
@@ -102,8 +102,8 @@ SUBSETTING:
     made up of more than one subwidget. For example, LABELVALUE is made up of a LABEL
     at subwidget index 0 and a VALUE at subwidget index 1. This allows for passing
     settings to specific subwidgets. Some widgets are made up of multiple subwidgets,
-    e.g. LABELVALUELIMITSBAR. To set the label text color, pass '0:0' as the Subwidget
-    Index to first index the LABELVALUE and then the LABEL.
+    e.g. LABELVALUELIMITSBAR. To set the Label widget, pass 0 as the Subwidget
+    Index, pass 1 for the Value widget, and 2 for the LimitsBar widget.
   parameters:
     - name: Subwidget Index
       required: true
@@ -121,9 +121,9 @@ SUBSETTING:
   example: |
     VERTICALBOX
       LABELVALUE INST HEALTH_STATUS TEMP1
-      SUBSETTING 0 TEXTCOLOR blue # Change the label's text to blue
+        SUBSETTING 0 TEXTCOLOR blue # Change the label's text to blue
       LABELVALUELIMITSBAR INST HEALTH_STATUS TEMP1
-      SUBSETTING 0:0 TEXTCOLOR green # Change the label's text to green
+        SUBSETTING 0 TEXTCOLOR green # Change the label's text to green
     END
 NAMED_WIDGET:
   summary: Name a widget to allow access to it via the getNamedWidget method

data/data/config/telemetry_modifiers.yaml

@@ -135,7 +135,8 @@ META:
       values: .*
 PROCESSOR:
   summary: Defines a processor class that executes code every time a packet is received
-  example: PROCESSOR TEMP1HIGH watermark_processor.rb TEMP1
+  ruby_example: PROCESSOR TEMP1HIGH watermark_processor.rb TEMP1
+  python_example: PROCESSOR TEMP1HIGH watermark_processor.py TEMP1
   parameters:
     - name: Processor Name
       required: true
@@ -143,9 +144,9 @@ PROCESSOR:
       values: .+
     - name: Processor Class Filename
       required: true
-      description: Name of the Ruby file which implements the processor.
-        This file should be in the config/TARGET/lib directory so it can be found by OpenC3.
-      values: '.+\.rb'
+      description: Name of the Ruby or Python file which implements the processor.
+        This file should be in the target's lib directory.
+      values: '.+'
     - name: Processor Specific Options
       required: false
       description: Variable length number of options that will be passed to the class constructor.
@@ -176,3 +177,7 @@ IGNORE_OVERLAP:
   description: Packet items which overlap normally generate a warning unless each individual item has the OVERLAP keyword.
     This ignores overlaps across the entire packet.
   since: 5.16.0
+VIRTUAL:
+  summary: Marks this packet as virtual and not participating in identification
+  description: Used for packet definitions that can be used as structures for items with a given packet.
+  since: 5.18.0

data/data/config/widgets.yaml

@@ -1023,20 +1023,13 @@ Telemetry Widgets:
           values: .+
         - name: Item name
           required: true
-          description: The item name
+          description: The item name to pull the CONVERTED value from.
+            If additional processing (base64 encoding) is needed consider using a DERIVED item.
           values: .+
         - name: Format
           required: true
           description: The image format of the base64 data (e.g. jpg, png, etc)
           values: .+
-        - name: Width
-          required: false
-          description: Width of the widget
-          values: .*
-        - name: Height
-          required: false
-          description: Height of the widget
-          values: .*
       example: |
         IMAGEVIEWER INST IMAGE IMAGE jpg
     PROGRESSBAR:
@@ -1156,12 +1149,11 @@ Telemetry Widgets:
     #   RANGECOLUMN INST HEALTH_STATUS TEMP1 -100 100
     ROLLUP:
       summary: Displays a notification icon which changes color based on a rollup telemetry
+      since: 5.17.1
       parameters:
         - name: Icon name
           required: true
-          description: |
-            The astro UX icon to display. Valid choices are 'astro' icons taken from
-            https://github.com/RocketCommunicationsInc/astro-components/blob/master/static/json/rux-icons.json
+          description: The astro UX icon to display. Valid choices are 'astro' icons taken from https://github.com/RocketCommunicationsInc/astro-components/blob/master/static/json/rux-icons.json.
           values: .+
         - name: Icon label
           required: false
@@ -1173,13 +1165,48 @@ Telemetry Widgets:
           values: .+
       example: |
         ROLLUP satellite-transmit "SAT 1" "Details"
+          # Screen to open on click
           SETTING SCREEN INST HS
+          # Telemetry items to rollup status
           SETTING TLM INST HEALTH_STATUS TEMP1
           SETTING TLM INST HEALTH_STATUS TEMP2
         ROLLUP antenna "GND 2" "Location"
+          # Screen to open on click
           SETTING SCREEN INST HS
+          # Telemetry items to rollup status
           SETTING TLM INST HEALTH_STATUS TEMP3
           SETTING TLM INST HEALTH_STATUS TEMP4
+    SIGNAL:
+      summary: Displays a cellular signal icon which changes based on telemetry value
+      since: 5.17.2
+      parameters:
+        - name: Target name
+          required: true
+          description: The target name
+          values: .+
+        - name: Packet name
+          required: true
+          description: The packet name
+          values: .+
+        - name: Item name
+          required: true
+          description: The item name
+          values: .+
+        - name: Value type
+          required: false
+          description: The type of the value to display. Default is CONVERTED.
+          values: <%= %w(RAW CONVERTED) %>
+      example: |
+        SIGNAL INST HEALTH_STATUS TEMP1
+          # Screen to open on click
+          SETTING SCREEN INST HS
+          # Values to compare when setting the 1-bar, 2-bar and 3-bar icons
+          # Default is 30, 60, 90 (e.g. 0 to 100 range)
+          # Value < -50 display no bars
+          # Value >= -50 and < 0 displays 1 bar
+          # Value >= 0 and < 50 displays 2 bars
+          # Value >= 50 displays 5 bars
+          SETTING RANGE -50 0 50
     TEXTBOX:
       summary: Provides a large box for multiline text
       parameters:
@@ -1320,7 +1347,7 @@ Interactive Widgets:
     BUTTON:
       summary: Displays a rectangular clickable button
       description: |
-        Upon clicking, the button executes the Ruby code assigned. Buttons
+        Upon clicking, the button executes the Javascript code assigned. Buttons
         can be used to send commands and perform other tasks. If you want your button
         to use values from other widgets, define them as named widgets and read their
         values using the `screen.getNamedWidget("WIDGET_NAME").text()` method.
@@ -1334,7 +1361,7 @@ Interactive Widgets:
         separated by `;;`.
 
         You can send commands with buttons using api.cmd(). The cmd() syntax looks exactly
-        like the standard COSMOS Ruby scripting syntax. You can also request and use
+        like the standard COSMOS scripting syntax. You can also request and use
         telemetry in screens using Javascript Promises.
 
         `api.tlm('INST PARAMS VALUE3', 'RAW').then(dur => api.cmd('INST COLLECT with TYPE NORMAL, DURATION '+dur))"`

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

@@ -61,6 +61,8 @@ static ID id_ivar_stored = 0;
 static ID id_ivar_extra = 0;
 static ID id_ivar_template = 0;
 static ID id_ivar_packet_time = 0;
+static ID id_ivar_ignore_overlap = 0;
+static ID id_ivar_virtual = 0;
 
 /* Sets the target name this packet is associated with. Unidentified packets
  * will have target name set to nil.
@@ -285,6 +287,8 @@ static VALUE packet_initialize(int argc, VALUE *argv, VALUE self)
   rb_ivar_set(self, id_ivar_extra, Qnil);
   rb_ivar_set(self, id_ivar_template, Qnil);
   rb_ivar_set(self, id_ivar_packet_time, Qnil);
+  rb_ivar_set(self, id_ivar_ignore_overlap, Qfalse);
+  rb_ivar_set(self, id_ivar_virtual, Qfalse);
   return self;
 }
 
@@ -326,6 +330,8 @@ void Init_packet(void)
   id_ivar_extra = rb_intern("@extra");
   id_ivar_template = rb_intern("@template");
   id_ivar_packet_time = rb_intern("@packet_time");
+  id_ivar_ignore_overlap = rb_intern("@ignore_overlap");
+  id_ivar_virtual = rb_intern("@virtual");
 
   cPacket = rb_define_class_under(mOpenC3, "Packet", cStructure);
   rb_define_method(cPacket, "initialize", packet_initialize, -1);

data/lib/openc3/accessors/accessor.rb

@@ -104,6 +104,7 @@ module OpenC3
     end
 
     def self.convert_to_type(value, item)
+      return value if value.nil?
       case item.data_type
       when :OBJECT, :ARRAY
         # Do nothing for complex object types