rccn-gen 1.2.0__py3-none-any.whl → 1.3.0__py3-none-any.whl

rccn_gen/utils.py

@@ -98,6 +98,8 @@ def engineering_bit_number(raw_bit_number):
     while 2**power < raw_bit_number:
         power += 1
     bit_number = 2**power
+    if bit_number < 8:
+        bit_number = 8
     return (bit_number)
 
 def get_data_type(parent_classes):
@@ -190,6 +192,24 @@ def rust_type_definition(pymdb_data_instance, parent_name="MyStruct"):
         definition_text[1] += insert
         definition_text[1] += "}\n\n"
         definition_text[1] += append
+    
+    elif data_type == 'FloatDataType':
+        if pymdb_data_instance.encoding is None or pymdb_data_instance.encoding.bits is None:
+            raw_bit_number = 32
+            print("RCCN-Warning: No encoding for "+base_type+" "+pymdb_data_instance.name+" found. Using 32 as default for raw bit number.")
+        else:
+            raw_bit_number = pymdb_data_instance.encoding.bits
+        raw_bit_number_str = str(raw_bit_number)
+        if raw_bit_number == 32:
+            eng_bit_number = 32
+        elif raw_bit_number == 64:
+            eng_bit_number = 64
+        else:
+            print("RCCN-Warning: Given raw bit number for "+base_type+" \'"+pymdb_data_instance.name+"\' is not equal to 32 or 64. A engineering bit number of 64 will be used.")
+            eng_bit_number = 64
+        eng_bit_number_str = str(eng_bit_number)
+        definition_text[0] += "\t#[bits("+raw_bit_number_str+")]\n"
+        definition_text[0] += ("\tpub "+sc_instance_name+": f"+eng_bit_number_str+",\n")
     else:
         definition_text = ["\t// Please implement datatype "+data_type+" here.\n", ""]
     return definition_text

{rccn_gen-1.2.0.dist-info → rccn_gen-1.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rccn_gen
-Version: 1.2.0
+Version: 1.3.0
 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
@@ -29,10 +29,11 @@ To see whats new, see the [CHANGELOG](CHANGELOG.md).
 ## Using the Generator
 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`.
+- `Service`,
+- `RCCNCommand`, and
+- `RCCNContainer`.
 
-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. 
+The Application and Service classes inherit from pymdb's Subsystem class and extend their functionality. The RCCNCommand extends the Command class and the RCCNContainer extends the Container class of pymdb. 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. 
 
 A root system may be defined for the satellite.
 ```python
@@ -44,7 +45,7 @@ An application can be defined with the following statement.
 ```python
 app = Application(system=root_system, name="ExampleApp", apid=42)
 ```
-It has the obligatory arguments **system**, **name**, **apid** and **export_directory**. After all Applications, Services and RCCNCommands are defined, the rust code generator can be called on the application with `app.generate_rccn_code(export_directory='.')`.
+It has the obligatory arguments **system**, **name** and **apid**. After all Applications, Services and RCCNCommands are defined, the rust code generator can be called on the application with `app.generate_rccn_code(export_directory='.')`.
 
 ### Service
 
@@ -81,7 +82,7 @@ my_command = RCCNCommand(
 service.add_command(my_command)
 ```
 
-The only obligatory arguments are **name** and a **subtype assignment**, like shown in the example. The connection to a service can also be achieved with base commands, where every base command must be unique to a service. For example:
+The only obligatory argument is **name**. If the subtype assignment is not given, a value will be chosen automatically. The connection to a service can also be achieved with base commands, where every base command must be unique to a service. For example:
 
 ```python
 base_cmd = RCCNCommand(
@@ -98,6 +99,34 @@ my_command = RCCNCommand(
 )
 ```
 
+### RCCNContainer
+A container to hold telemetry information can be created with:
+```python
+my_container = RCCNContainer(
+    system=service,
+    name='BatteryInformation',
+    short_description='This container holds information on battery voltage and current'
+)
+my_container.add_integer_parameter_entry(
+    name='BatteryNumber',
+    minimum=1,
+    maximum=4,
+    encoding=IntegerEncoding(bits=3),
+    short_description='Number of the battery'
+)
+my_container.add_float_parameter_entry(
+    name='Current',
+    units='Ampere',
+    encoding=FloatEncoding(bits=32),
+    short_description='Electric current of the battery.'
+)
+my_container.add_float_parameter_entry(
+    name='Voltage',
+    units='Volts',
+    encoding=FloatEncoding(bits=32),
+    short_description='Electric voltage of the battery.'
+)
+```
 ## Output
 From the python configuration, the `main.rs`, `service.rs`, `command.rs`, `mod.rs`, `Cargo.toml` and `telemetry.rs` files are generated and are structured accordingly:
 - rccn_usr_example_app/

{rccn_gen-1.2.0.dist-info → rccn_gen-1.3.0.dist-info}/RECORD

@@ -1,7 +1,7 @@
 rccn_gen/LICENSE,sha256=ixuiBLtpoK3iv89l7ylKkg9rs2GzF9ukPH7ynZYzK5s,35148
 rccn_gen/__init__.py,sha256=rBnqIw3uQk-uBbRh9VnungoTRSr2V0Bqos32xFZ44Eo,168
-rccn_gen/systems.py,sha256=vGsCyVkwrsFgYqHDL_bPPv8FuX3pIHYUwfIRB5YUWrY,37414
-rccn_gen/utils.py,sha256=VKnTC2hrgMyLdneksAifnqEgXO27zLQJ9x5igaF35rE,8269
+rccn_gen/systems.py,sha256=NewVHJVITt3svMBkAigD23Wl3_-srjNBbiMsOqUstg4,83907
+rccn_gen/utils.py,sha256=qcAYBjQ_-YfUQY4QtcRX9ebHoTVXyy7xWb57vpKO6vQ,9314
 rccn_gen/text_modules/cargo_toml/cargo.txt,sha256=AYjSo3WJE7lhOcJaiNgXP9Y-DXHDIFIt6p42rDTVNVE,427
 rccn_gen/text_modules/command/command.txt,sha256=8Y-uJilhFLoinftIbn7uKfia9LLMZno2LkoDJ-4Y-9M,345
 rccn_gen/text_modules/command/command_module_enum.txt,sha256=35sBlAV_CzQw95Uf2dNynrYOxVD2tT2XWfEvS4Zx_KY,121
@@ -14,6 +14,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=qTxoOD5i7wH4yFiDn13rOJW9hIZyACA8W3m6UABe22U,695
 rccn_gen/text_modules/telemetry/telemetry.txt,sha256=Re1d3BfpyXT_CEe7jJzLF3MARik0-J-K98K85iPOE40,193
-rccn_gen-1.2.0.dist-info/METADATA,sha256=h-4mJGYkmnAxOFD5Pn4ART7ml2VjQPrVdENO2eIVj7s,8967
-rccn_gen-1.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-rccn_gen-1.2.0.dist-info/RECORD,,
+rccn_gen-1.3.0.dist-info/METADATA,sha256=EOwcq4lhWocClSHmjO0M12G--1sPtJPfpVHY6ahdPsw,9911
+rccn_gen-1.3.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+rccn_gen-1.3.0.dist-info/RECORD,,