rccn-gen 1.0.0__py3-none-any.whl → 1.0.1__py3-none-any.whl

rccn_gen/systems.py

@@ -16,6 +16,7 @@ class Application(Subsystem):
         system: System,
         name: str,
         apid: int,
+        vcid: int = 0,
         export_file_path = '.',
         snapshot_file_path = './.rccn_snapshots',
         diff_file_path = './.rccn_diffs',
@@ -26,12 +27,13 @@ class Application(Subsystem):
         super().__init__(system=system, name=name, *args, **kwargs)
 
         self.apid = apid
+        self.vcid = vcid
         system._subsystems_by_name[name] = self
         self.export_file_path = export_file_path
         self.snapshot_file_path = snapshot_file_path
         self.snapshot_generated_file_path = os.path.join(snapshot_file_path, 'auto_generated')
         self.diff_file_path = diff_file_path
-        self.text_modules_path = files('pymdb_rust_generation').joinpath('text_modules')
+        self.text_modules_path = files('rccn_gen').joinpath('text_modules')
         print(self.text_modules_path)
         self.text_modules_main_path = os.path.join(self.text_modules_path, 'main')
         print(self.text_modules_main_path)
@@ -98,6 +100,7 @@ class Application(Subsystem):
         # Find and replace service variable keywords
         var_translation = {
             '<<VAR_APID>>':str(self.apid),
+            '<<VAR_VCID>>':str(self.vcid),
             '<<VAR_APP_NAME_SCASE>>':to_snake_case(self.name),
         }
         var_keywords = get_var_keywords(text)
@@ -197,7 +200,7 @@ class Service(Subsystem):
         self.init_kwargs = kwargs
         self.name = name
         self.service_id = service_id
-        self.text_modules_path = files('pymdb_rust_generation').joinpath('text_modules')
+        self.text_modules_path = files('rccn_gen').joinpath('text_modules')
         self.text_modules_service_path = os.path.join(self.text_modules_path, 'service')
         self.text_modules_command_path = os.path.join(self.text_modules_path, 'command')
         self.text_modules_telemetry_path = os.path.join(self.text_modules_path, 'telemetry')
@@ -272,7 +275,7 @@ class Service(Subsystem):
         
         # Call keyword replacement for all associated commands (Later, there needs to be checking to account for user changes to the generated files)
         if len(self.rccn_commands()) == 0:
-            print('Service '+self.name+' does not have any commands associated with it.')
+            print('RCCN-Gen: Service '+self.name+' does not have any commands associated with it.')
         for command in self.rccn_commands():
             text = command.find_and_replace_keywords(text, text_modules_path)
         
@@ -323,7 +326,7 @@ class Service(Subsystem):
             self.generate_snapshot('command', 'command_user_snapshot')
         # Generate command.rs file
         if len(self.rccn_commands()) == 0:
-            print('Service '+self.name+' has no implemented commands. Generation of command.rs file will be skipped.')
+            print('RCCN-Gen: Service '+self.name+' has no implemented commands. Generation of command.rs file will be skipped.')
             return
         command_file_path = self.file_paths()['command_template']
         with open(command_file_path, 'r') as file:

rccn_gen/text_modules/main/main.txt

@@ -5,18 +5,17 @@ use rccn_usr::zenoh::key_expr::OwnedKeyExpr;
 <<SERVICE_MODULE_MOD_SERVICE>>
 
 const APID: u16 = <<VAR_APID>>;
+const VCID: u8 = <<VAR_VCID>>;
 
 fn main() -> Result<()> {
     env_logger::init();
     let mut app = PusApp::new(APID);
 
     app
-        .add_tc_tm_channel(
-            OwnedKeyExpr::new("vc/bus_realtime/rx").unwrap(),
-            OwnedKeyExpr::new("vc/bus_realtime/tx").unwrap(),
-        )
+        .add_tc_tm_channel(VCID)
         .unwrap();
 
+
     <<SERVICE_MODULE_REGISTER_SERVICE>>
 
     app.run();

rccn_gen/utils.py

@@ -1,4 +1,5 @@
 import re
+import inflect
 import os
 from yamcs.pymdb import IntegerArgument, FloatArgument, BooleanArgument, EnumeratedArgument, StringArgument
 
@@ -106,18 +107,36 @@ def get_data_type(parent_classes):
             return class_name
     return None
 
-def rust_type_definition(pymdb_data_instance):
-    sc_instance_name = to_snake_case(pymdb_data_instance.name)
+def get_base_type(parent_classes):
+    for base_type in ["Argument", "Member", "Parameter"]:
+        if base_type in parent_classes:
+            return base_type
+    if "DataType" in parent_classes:
+        return "DataType"
+    return None
+
+def rust_type_definition(pymdb_data_instance, parent_name="MyStruct"):
     parent_classes = list(map(lambda type: type.__name__, type(pymdb_data_instance).mro()))
     data_type = get_data_type(parent_classes)
-    base_type = pymdb_data_instance.__class__.__name__
+    base_type = get_base_type(parent_classes)
+    if base_type is None:
+        base_type = pymdb_data_instance.__class__.__name__
     if data_type is None:
-        raise ValueError("Data type not found in parent classes.")
+        raise ValueError("RCCN-Gen: Data type not found in parent classes.")
+    if not hasattr(pymdb_data_instance, 'name') or pymdb_data_instance.name is None:
+        p = inflect.engine()
+        singular_name = p.singular_noun(parent_name)
+        if singular_name is False:
+            pymdb_data_instance.name = parent_name
+        else:
+            pymdb_data_instance.name = singular_name
+        print("RCCN-Gen: Information: An unnamed "+base_type+" has been named \""+to_upper_camel_case(pymdb_data_instance.name)+"\" in the generated RCCN code.")
+    sc_instance_name = to_snake_case(pymdb_data_instance.name)
 
     if data_type == 'IntegerDataType':
         if pymdb_data_instance.encoding is None or pymdb_data_instance.encoding.bits is None:
             raw_bit_number = 8
-            print("Warning: No encoding for "+base_type+" "+pymdb_data_instance.name+" found. Using 8 as default for raw bit number.")
+            print("RCCN-Gen: Warning: No encoding for "+base_type+" "+pymdb_data_instance.name+" found. Using 8 as default for raw bit number.")
         else:
             raw_bit_number = pymdb_data_instance.encoding.bits
         raw_bit_number_str = str(raw_bit_number)
@@ -127,7 +146,7 @@ def rust_type_definition(pymdb_data_instance):
         if pymdb_data_instance.signed:
             definition_text[0] += ("\tpub "+sc_instance_name+": i"+eng_bit_number_str+",\n")
         else:
-            definition_text += ("\tpub "+sc_instance_name+": u"+eng_bit_number_str+",\n")
+            definition_text[0] += ("\tpub "+sc_instance_name+": u"+eng_bit_number_str+",\n")
         definition_text.append("")
     
     elif data_type == 'BooleanDataType':
@@ -138,14 +157,8 @@ def rust_type_definition(pymdb_data_instance):
         definition_text = ["\t#[null_terminated]\n\tpub "+sc_instance_name+": String,\n", ""]
     
     elif data_type == 'ArrayDataType':
-        struct_name = to_upper_camel_case(pymdb_data_instance.name)
-        definition_text = ["\tpub "+sc_instance_name+": Vec<"+struct_name+">,\n"]
-        definition_text.append("pub struct "+struct_name+" {\n")
-        for member in pymdb_data_instance.data_type.members:
-            definition_text[1] += rust_type_definition(member)[0]
-        definition_text[1] += "}\n"
-        for member in pymdb_data_instance.data_type.members:
-            definition_text[1] += rust_type_definition(member)[1]
+        definition_text = rust_type_definition(pymdb_data_instance.data_type, parent_name=pymdb_data_instance.name)
+        definition_text[0] = definition_text[0].replace(': ', ': Vec<').replace(',\n', '>,\n')
     
     elif data_type == 'EnumeratedDataType':
         definition_text = ["\tpub "+pymdb_data_instance.name+": "+to_upper_camel_case(pymdb_data_instance.name)+",\n"]
@@ -154,6 +167,16 @@ def rust_type_definition(pymdb_data_instance):
             definition_text[1] += "\t"+str(choice[1])+" = "+str(choice[0])+",\n"
         definition_text[1] += "}\n"
     
+    elif data_type == 'AggregateDataType':
+        struct_name = to_upper_camel_case(pymdb_data_instance.name)
+        definition_text = ["\tpub "+sc_instance_name+": "+struct_name+",\n"]
+        definition_text.append("pub struct "+struct_name+" {\n")
+        for member in pymdb_data_instance.members:
+            definition_text[1] += rust_type_definition(member, parent_name=pymdb_data_instance.name)[0]
+        definition_text[1] += "}\n"
+        for member in pymdb_data_instance.members:
+            definition_text[1] += rust_type_definition(member, parent_name=pymdb_data_instance.name)[1]
+
     else:
         definition_text = ["\t// Please implement datatype "+data_type+" here.\n", ""]
     return definition_text

{rccn_gen-1.0.0.dist-info → rccn_gen-1.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rccn_gen
-Version: 1.0.0
+Version: 1.0.1
 Summary: A python based generator for RACCOON OS source files in Rust from yamcs-pymdb config files.
 Project-URL: Homepage, https://gitlab.com/rccn/pymdb_code_generation
 Project-URL: Issues, https://gitlab.com/rccn/pymdb_code_generation/issues
@@ -16,7 +16,7 @@ Description-Content-Type: text/markdown
 This generator is used to generate Rust files to deploy on the RACCOON OS satellite based on the pymdb config files used to generate the ground station XTCE files.
 ## Setup
 - Pull the repo
-- Set up a virtual python environment with python 13 kernel and activate:
+- Set up a virtual python environment with `python3` and activate:
     ```zsh
     python -m venv .venv
     source .venv/bin/activate
@@ -24,10 +24,12 @@ This generator is used to generate Rust files to deploy on the RACCOON OS satell
 - Install pymdb with `pip install yamcs-pymdb`
 
 ## Using the Generator
-The generator is based on pymdb and uses the same structure. Where pymdb gives the user freedom in defining systems, subsystems and their respective relations, the definitions for rust code generation is more restricted. For the rust generation, the user is binded to the following classes:
+The generator is based on [`pymdb`](https://github.com/yamcs/pymdb) and uses the same structure. Where `pymdb` gives the user freedom in defining systems, subsystems and their respective relations, the definitions for rust code generation is more restricted. For the rust generation, the user is bound to the following classes:
 - Application,
 - Service, and
-- RCCNCommand.
+- `Application`,
+- `Service`, and
+- `RCCNCommand`.
 
 All classes inherit from pymdb's Subsystem class and extend their functionality. This means that an existing pymdb definition can be used to generate rust code by renaming the respective instances. No functionality for pymdb's XTCE generation will be lost. 
 
@@ -117,7 +119,7 @@ The sequence from above is changed accordingly if no previous snapshot exists. I
 Snapshots of the .rs files in the export directory are stored in `/user/`. These can be used to undo code regeneration if conflicts arise during the patching. Please note that by default, only the last 10 user snapshots are stored. You can change this property with the following command.
 
 ```python
-app.keep_snapshots = 15 # What ever value you want
+app.keep_snapshots = 15 # Whatever value you want
 ```
 
 With the sequence from above, it becomes apperant that changes to the .rs file in the export directory always trump changes to the pymdb config. If for example, a main.rs file is generated for an application with and APID of 42, and this apid is changed in the main.rs file to 45, this change will persist after regenerating from the python config. Even if changes to the pymdb config where made after the changes to the main.rs file. 

{rccn_gen-1.0.0.dist-info → rccn_gen-1.0.1.dist-info}/RECORD

@@ -2,14 +2,14 @@ rccn_gen/LICENSE,sha256=ixuiBLtpoK3iv89l7ylKkg9rs2GzF9ukPH7ynZYzK5s,35148
 rccn_gen/__init__.py,sha256=XVvKYcWw9K1P3J1BTbzbODY71Nc1FApCc0wf7ezd4Gc,193
 rccn_gen/application.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rccn_gen/service.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-rccn_gen/systems.py,sha256=ar_SzX0XLzO8AlvH3ABRTeWF0pOcvFattHxleyiYzUk,26813
+rccn_gen/systems.py,sha256=oLm0_jcxV0MZ3Bg7YsCraQ_zTj_yD_geoQpdJs_ATys,26898
 rccn_gen/telemetry.py,sha256=huVcqGs95IXlpETWdlIyR9lK4ctZUsq7czgJwvTYtBk,3855
-rccn_gen/utils.py,sha256=uGyXo0A7oUhH9doSO9YZMId30RFB_U1StxkDH-dZHg4,6134
+rccn_gen/utils.py,sha256=tBzL6ZCSpjYnz4vtV7vzIAT6lcemCtIqxrmWMtzPEZU,7302
 rccn_gen/text_modules/cargo_toml/cargo.txt,sha256=2e6xKomkml6-onfQ0QHNqvKnhGLYMUl8zYgbykmm83Y,292
 rccn_gen/text_modules/command/command.txt,sha256=8Y-uJilhFLoinftIbn7uKfia9LLMZno2LkoDJ-4Y-9M,345
 rccn_gen/text_modules/command/command_module_enum.txt,sha256=ApzRDQIs-BHJHtFA4ysfpYuWElGntXakkzZkgy57b74,94
 rccn_gen/text_modules/command/command_module_struct.txt,sha256=FT7Ke0uOVxWYpGC_oj9zafr1ahrH-nf0nSxQje6kToY,22
-rccn_gen/text_modules/main/main.txt,sha256=uhtN7WzdqQpqvHGu0eQ08cLVCvi7daB_vi2c5B3Frcs,523
+rccn_gen/text_modules/main/main.txt,sha256=UQ0oHbzH7H3G4mxfeiTh5UeQ-X4C0Fw7IrCyZNH2clQ,426
 rccn_gen/text_modules/main/service_module_import_service.txt,sha256=qPrU4fLs7Y65X5KJ868ut-izV5pHq7hU2nVRLxPnFCE,57
 rccn_gen/text_modules/main/service_module_mod_service.txt,sha256=guvXFdV_-YezhTD_PWA-Z0tL8ReSZc0rh3RuWraJnQE,25
 rccn_gen/text_modules/main/service_module_register_service.txt,sha256=4EIsgaxDLh51u0WjXfy7Xgo-6UFTdb4Nh2O4J7uFjS0,115
@@ -17,6 +17,6 @@ rccn_gen/text_modules/mod/mod.txt,sha256=BF8LablBE4ddutdl5m0prvpvLdBRejueVOujkyr
 rccn_gen/text_modules/service/command_module_match_cmd.txt,sha256=eVGo6ltuerG37rVxpXtL-JYuLyLW4c0i6NXb5g1_U-A,89
 rccn_gen/text_modules/service/service.txt,sha256=0KwwrfrjXuY4e3VNpCdTTzgW8bmYRQ21i-Lvhkz3hVA,691
 rccn_gen/text_modules/telemetry/telemetry.txt,sha256=Re1d3BfpyXT_CEe7jJzLF3MARik0-J-K98K85iPOE40,193
-rccn_gen-1.0.0.dist-info/METADATA,sha256=vxX9R-Y_2If6PTBVpIM0nGlYSsw3N8vJwbod02d4-KE,8128
-rccn_gen-1.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-rccn_gen-1.0.0.dist-info/RECORD,,
+rccn_gen-1.0.1.dist-info/METADATA,sha256=dm4UtqPyzUKNv_hnmprPaSmQtRrjE-lCuU-X_O9wnHc,8193
+rccn_gen-1.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+rccn_gen-1.0.1.dist-info/RECORD,,