Skip to content

Commit 6c7cd51

Browse files
authored
revise design format (#18)
* Update system design format to version 0.3.0 - Changed the key names from `parameter_files` and `parameters` to `param_files` and `param_values` across multiple YAML configuration files for consistency with the new format. - Updated the autoware_system_design_format version in all affected files to 0.3.0. - Introduced a new JSON schema for version 0.3.0 to validate the updated structure of node and parameter set entities. This update enhances clarity and aligns with the latest design specifications. Signed-off-by: Taekjin LEE <taekjin.lee@tier4.jp> * fix: all combined parameters is named 'parameters' not param_values Signed-off-by: Taekjin LEE <taekjin.lee@tier4.jp> * refactor: update parameter naming in linter and schema files - Changed references from `parameters` and `parameter_files` to `param_values` and `param_files` in the NamingLinter and related schema files for consistency with the updated design format. - Adjusted validation logic in the data validator to accommodate the new parameter naming conventions. - Removed deprecated parameter definitions from JSON schema files to streamline the structure. This update ensures alignment with the latest design specifications and improves code clarity. Signed-off-by: Taekjin LEE <taekjin.lee@tier4.jp> * remove alias of parameter_files, parameter_values Signed-off-by: Taekjin LEE <taekjin.lee@tier4.jp> * refactor: enforce strict property definitions in schema files - Updated multiple JSON schema files to set "additionalProperties" to false, ensuring stricter validation of properties. - Removed the optional input "objects3" from Tracker.node.yaml to streamline the input requirements. - These changes enhance the clarity and integrity of the schema definitions, aligning with the latest design specifications. Signed-off-by: Taekjin LEE <taekjin.lee@tier4.jp> * feat: add parameter_set definition to system schema - Introduced a new "parameter_set" property in the system.json schema, allowing for either a string or an array of strings. - This addition enhances the flexibility of parameter definitions, aligning with the evolving design requirements. Signed-off-by: Taekjin LEE <taekjin.lee@tier4.jp> * feat: add remap_target property to node schema - Introduced a new "remap_target" property in the node.json schema for both versions 0.2.1 and 0.3.0, allowing for string type definitions. - This addition enhances the flexibility of node configurations, aligning with evolving design requirements. Signed-off-by: Taekjin LEE <taekjin.lee@tier4.jp> * fix: add validation for missing param_files and param_values - Implemented a check in the ConfigParser to raise a ValidationError if both param_files and param_values are missing, ensuring better error handling and data integrity during configuration parsing. Signed-off-by: Taekjin LEE <taekjin.lee@tier4.jp> * fix: enhance validation for configuration parameters - Updated the ConfigParser to include a check for the presence of the "base" key in the configuration. This ensures that either param_files or param_values must be provided, improving error handling and data integrity during configuration parsing. Signed-off-by: Taekjin LEE <taekjin.lee@tier4.jp> * fix: correct parameter naming in template file - Updated the parameter_set.yaml.jinja2 template to replace incorrect references of `parameter_files` and `parameters` with `param_files` and `param_values`, respectively. This change ensures consistency with the updated naming conventions established in previous commits. Signed-off-by: Taekjin LEE <taekjin.lee@tier4.jp> * fix: remove deprecated parameter key references in parameter_set_applier.py - Updated the apply_parameter_set function to eliminate references to the old keys `parameter_files` and `parameters`, ensuring consistency with the latest naming conventions. This change aligns with previous updates and enhances code clarity. Signed-off-by: Taekjin LEE <taekjin.lee@tier4.jp> * fix: streamline type definition in system.json schema - Consolidated the "type" definition for the "value" property in system.json to a single line for improved readability and consistency. This change enhances the clarity of the schema structure. Signed-off-by: Taekjin LEE <taekjin.lee@tier4.jp> --------- Signed-off-by: Taekjin LEE <taekjin.lee@tier4.jp>
1 parent a19a176 commit 6c7cd51

40 files changed

Lines changed: 588 additions & 509 deletions

autoware_system_design_examples/design/node/ControlDummy.node.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
autoware_system_design_format: 0.2.0
1+
autoware_system_design_format: 0.3.0
22

33
name: ControlDummy.node
44

@@ -29,8 +29,8 @@ outputs:
2929
- name: command/turn_indicators_cmd
3030
message_type: autoware_vehicle_msgs/msg/TurnIndicatorsCommand
3131

32-
parameter_files: []
33-
parameters: []
32+
param_files: []
33+
param_values: []
3434

3535
# processes
3636
processes:

autoware_system_design_examples/design/node/LocalizationDummy.node.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
autoware_system_design_format: 0.2.0
1+
autoware_system_design_format: 0.3.0
22

33
name: LocalizationDummy.node
44

@@ -49,9 +49,9 @@ outputs:
4949
- name: pose_estimator/pose_with_covariance
5050
message_type: geometry_msgs/msg/PoseWithCovarianceStamped
5151

52-
parameter_files: []
52+
param_files: []
5353

54-
parameters: []
54+
param_values: []
5555

5656
# processes
5757
processes:

autoware_system_design_examples/design/node/MapDummy.node.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
autoware_system_design_format: 0.2.0
1+
autoware_system_design_format: 0.3.0
22

33
name: MapDummy.node
44

@@ -28,9 +28,9 @@ outputs:
2828
- name: get_partial_pointcloud_map
2929
message_type: autoware_map_msgs/srv/GetPartialPointCloudMap
3030

31-
parameter_files: []
31+
param_files: []
3232

33-
parameters: []
33+
param_values: []
3434

3535
# processes
3636
processes:

autoware_system_design_examples/design/node/PlanningDummy.node.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
autoware_system_design_format: 0.2.0
1+
autoware_system_design_format: 0.3.0
22

33
name: PlanningDummy.node
44

@@ -26,8 +26,8 @@ outputs:
2626
- name: mission_planning/route
2727
message_type: autoware_planning_msgs/msg/LaneletRoute
2828

29-
parameter_files: []
30-
parameters: []
29+
param_files: []
30+
param_values: []
3131

3232
# processes
3333
processes:

autoware_system_design_examples/design/node/perception/DetectorA.node.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
autoware_system_design_format: 0.2.0
1+
autoware_system_design_format: 0.3.0
22

33
name: DetectorA.node
44

@@ -25,7 +25,7 @@ outputs:
2525
reliability: reliable
2626
durability: transient_local
2727

28-
parameter_files:
28+
param_files:
2929
- name: model_param_path
3030
default: path/to/model_param.yaml
3131
schema: path/to/model_param.schema.json
@@ -37,7 +37,7 @@ parameter_files:
3737
- name: class_remapper_param_path
3838
default: path/to/class_remapper_param.yaml
3939

40-
parameters:
40+
param_values:
4141
- name: build_only
4242
type: bool
4343
default: false

autoware_system_design_examples/design/node/perception/FilterA.node.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
autoware_system_design_format: 0.2.0
1+
autoware_system_design_format: 0.3.0
22

33
name: FilterA.node
44

@@ -28,11 +28,11 @@ outputs:
2828
reliability: reliable
2929
durability: transient_local
3030

31-
parameter_files:
31+
param_files:
3232
- name: filtering_range_param
3333
default: path/to/filtering_range_param.yaml
3434

35-
parameters: []
35+
param_values: []
3636

3737
# processes
3838
processes:

autoware_system_design_examples/design/node/perception/Predictor.node.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
autoware_system_design_format: 0.2.0
1+
autoware_system_design_format: 0.3.0
22

33
name: Predictor.node
44

@@ -24,9 +24,9 @@ outputs:
2424
reliability: reliable
2525
durability: transient_local
2626

27-
parameter_files: []
27+
param_files: []
2828

29-
parameters: []
29+
param_values: []
3030

3131
# processes
3232
processes:

autoware_system_design_examples/design/node/perception/Tracker.node.yaml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
autoware_system_design_format: 0.2.0
1+
autoware_system_design_format: 0.3.0
22

33
name: Tracker.node
44

@@ -18,23 +18,22 @@ inputs:
1818
message_type: autoware_perception_msgs/msg/DetectedObjects
1919
- name: objects3
2020
message_type: autoware_perception_msgs/msg/DetectedObjects
21-
required: false
2221
outputs:
2322
- name: objects
2423
message_type: autoware_perception_msgs/msg/TrackedObjects
2524
qos:
2625
reliability: reliable
2726
durability: transient_local
2827

29-
parameter_files:
28+
param_files:
3029
- name: tracker_setting_path
3130
default: path/to/tracker_setting_path.yaml
3231
- name: data_association_matrix_path
3332
default: path/to/data_association_matrix_path.yaml
3433
- name: input_channels_path
3534
default: path/to/input_channels_path.yaml
3635

37-
parameters: []
36+
param_values: []
3837

3938
# processes
4039
processes:

autoware_system_design_examples/design/node/perception/TrafficLightRecognitionDummy.node.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
autoware_system_design_format: 0.2.0
1+
autoware_system_design_format: 0.3.0
22

33
name: TrafficLightRecognitionDummy.node
44

@@ -29,8 +29,8 @@ outputs:
2929
reliability: reliable
3030
durability: transient_local
3131

32-
parameter_files: []
33-
parameters: []
32+
param_files: []
33+
param_values: []
3434

3535
# processes
3636
processes:

autoware_system_design_examples/design/node/sensing/CameraDummyDriver.node.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
autoware_system_design_format: 0.2.0
1+
autoware_system_design_format: 0.3.0
22

33
name: CameraDummyDriver.node
44

@@ -22,9 +22,9 @@ outputs:
2222
- name: camera_info
2323
message_type: sensor_msgs/msg/CameraInfo
2424

25-
parameter_files: []
25+
param_files: []
2626

27-
parameters:
27+
param_values:
2828
- name: composable_node
2929
type: bool
3030
default: false

0 commit comments

Comments
 (0)