rccn-gen 1.2.0__tar.gz → 1.3.1__tar.gz

{rccn_gen-1.2.0 → rccn_gen-1.3.1}/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGE LOG
 
+### [1.3.1] - 2025-05-15
+- Added documentation for utils.py
+
+## [1.3.0] - 2025-05-15
+- Added methods to the RCCNContainer class to directly add parameters
+- Added documentation for Application, Service, RCCNCommand and RCCNContainer classes
+- Added support for Float datatype Rust generation in Arguments and ParameterEntries
+
 ## [1.2.0] - 2025-05-05
 - Added argument hints for RCCNCommand, Service and RCCNContainer
 - New create_and_add_service() method for the Application

{rccn_gen-1.2.0 → rccn_gen-1.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rccn_gen
-Version: 1.2.0
+Version: 1.3.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
@@ -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 → rccn_gen-1.3.1}/README.md

@@ -13,10 +13,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
@@ -28,7 +29,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
 
@@ -65,7 +66,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(
@@ -82,6 +83,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 → rccn_gen-1.3.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "rccn_gen"
-version = "1.2.0"
+version = "1.3.1"
 authors = [
   { name="Fabian Krech", email="f.krech@tu-berlin.de" },
 ]