Xtce generator

[maxinelasp]

Change Summary

Updates to the XTCE generator code to make it more generic, including some API changes.

Overview

Codice needs two events for scientific data from telemetry. Rather than hardcoding these two event mnemonics, I changed the code to accept a dictionary. This makes it easier to overwrite methods for instrument specific changes without needing to update the writer/generator parts.

Making this change also required updating all the codice python files to provide the events through a dictionary instead of assuming them.

Long term, codice could benefit from a specific CodiceTelemetryGenerator class which has codice-specific code or helper functions. I have an example of this in my GLOWS code, which is still incomplete.

I also split up some methods which people may want to override in the future.

Please double check my docstrings, I'm not sure if I accurately represented what the mnemonics are used for.

New Files

• new file 1
  • description of new file 1's purpose

Updated Files

• telemetry_generator.py
  • Moved science mnemonics to dictionary
• codice files
  • updated to match changed api

Testing

I checked, and the output codice file matches the existing one in the repository. So I didn't change any functionality.

[maxinelasp]

Done as part of issue #104

[GFMoraga]

This looks great. Thank you for making these changes for more flexible use!

[tech3371]

Thank you for making it more generic!

[tech3371]

Can we update the doc string of this function as well?

[tech3371]

What is difference between this function input parameter sci_byte and self.sci_byte?

[maxinelasp]

Good catch! I actually removed the sci_byte input to this function and moved it entirely to the class variable. In the future, hopefully we can move this variable, since it is codice specific (?). In glows, I override this function and don't use it.

[GFMoraga]

It was built for packets with BYTE as a dataType. So, it is optional I think I put it as.

[tech3371]

So this is where we give in names of science data that are specific to each instrument such as SCIENCE_DATA or HIST_DATA field in packet definition?

[maxinelasp]

Yes, exactly!

[sdhoyt]

is "EventData" a CoDICE specific thing? I'm getting an error because I don't have "EventData" defined as a key

[GFMoraga]

Yes it is codice specific. But you can change the mnemonic. I also think Maxine might have fixed this, so when pushed, it should work..... If this helps, I have packets with "Data" OR "Event_Data" so it was my way of calling the correct one depending on what was in the row.

• data_type_event_data: The data type for the "Event_Data" mnemonic

[maxinelasp]

Ah yes, it is codice specific. In my GLOWs code, I override it:

def create_parameter_types(
        self,
        parameter_type_set,
        unique_lengths,
        data_types,
        sci_byte=None,
    ):
        """
        Create parameter types based on 'dataType' for the unique 'lengthInBits' values.
        This will loop through the unique lengths and create a ParameterType element
        for each length representing a UINT type.

        Parameters:
        - parameter_type_set: The ParameterTypeSet element where parameter types are.
        - unique_lengths: Unique values from the 'lengthInBits' column.
        - data_type_data: The data type for the "Data" mnemonic.
        - data_type_event_data: The data type for the "Event_Data" mnemonic.
        - sci_byte: The BYTE number of lengthInBits in both "Data" and "Event_Data"

        Returns:
        - parameter_type_set: The updated ParameterTypeSet element.
        """
        for size in unique_lengths:
            # All bins equal?
            # Are bins the only thing that matters? -> check glows code for this
            parameter_type_ref = data_types["BIN"]  # Use UINT for other sizes
            print(parameter_type_ref)
            parameter_type = Et.SubElement(parameter_type_set, "xtce:ParameterType")
            parameter_type.attrib["name"] = f"uint{size}"
            parameter_type.attrib["signed"] = "false"

            encoding = Et.SubElement(parameter_type, "xtce:IntegerDataEncoding")
            encoding.attrib["sizeInBits"] = str(size)
            encoding.attrib["encoding"] = "unsigned"

            # Create BinaryParameterType if parameter_type_ref is "BYTE"
            if parameter_type_ref == "BYTE":
                binary_parameter_type = Et.SubElement(
                    parameter_type_set, "xtce:BinaryParameterType"
                )
                binary_parameter_type.attrib["name"] = parameter_type_ref

                Et.SubElement(binary_parameter_type, "xtce:UnitSet")

                binary_data_encoding = Et.SubElement(
                    binary_parameter_type, "xtce:BinaryDataEncoding"
                )
                binary_data_encoding.attrib["bitOrder"] = "mostSignificantBitFirst"

                size_in_bits = Et.SubElement(binary_data_encoding, "xtce:SizeInBits")
                fixed_value = Et.SubElement(size_in_bits, "xtce:FixedValue")
                fixed_value.text = str(sci_byte)  # Set the size in bits to sci_byte

        return parameter_type_set

[maxinelasp]

Ideally, in the future, this will be something that is probably overridden in most instruments, or the more generic code above can be modified so it can be used in all cases where there are very simple parameters.

[sdhoyt]

Looks good!