schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
venvironment-schema.json
full
List of scenarios with the option to define / override variables or defines.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"name": "my_scenario_name"}], [{"name": "my_scenario_name"}, {"name": "override_variables", "variables": [{"name": "three", "value": 3}]}, {"name": "override_defines", "defines": ["mydefine", "mydevine_with_value=42"]}]]}
venvironment-schema.json
full
List of variables to be used in this configuration file.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"name": "var", "value": -42}], [{"name": "my_string", "value": "implicit-type"}, {"name": "var", "value": 422200000000.0, "type": "float"}, {"name": "path_var", "value": "path/to/somewhere", "type": "path"}, {"name": "uint_enum", "value": 43, "type": "uint", "options": [1, 43, 127]}]]}
venvironment-schema.json
full
List of defines to be passed to capl / vcdl. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"define": "mydefine1"}], [{"define": ["mydefine1", "mydefine2"]}, {"define": ["mydefine1", "mydefine2"], "when": "SCENARIO_NAME == \"my_scenario_name\""}, {"define": ["mydefine_with_value=42", "${var_with_define_name}=${var_with_define_value}"]}]]}
venvironment-schema.json
full
Global settings for all scenarios.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "properties": {"ethernet": {}, "flexray": {}, "database": {}, "database-dotnet-namespace-generation": {"type": "array", "minItems": 1, "items": {"anyOf": [{"type": "string", "enum": ["use-network", "use-database", "use-frame", "use-node"]}, {}]}, "examples": [["use-network", "use-database", "use-frame", "use-node"]]}, "time-scaling-factor": {"oneOf": [{"type": "number", "exclusiveMinimum": 0, "maximum": 1e+37}, {"const": "as-fast-as-possible"}, {}], "default": "as-fast-as-possible"}, "time-source": {"default": "internal-realtime", "anyOf": [{"enum": ["internal-realtime", "external-software", "internal-scaled"]}, {}], "examples": ["internal-realtime", "internal-scaled", "external-software"]}}, "allOf": [{"if": {"required": ["time-source"], "properties": {"time-source": {"const": "internal-scaled"}}}, "then": {"required": ["time-scaling-factor"], "properties": {"time-scaling-factor": true}}}, {"if": {"required": ["time-source"], "properties": {"time-source": {"anyOf": [{"const": "internal-realtime"}, {"const": "external-software"}]}}}, "then": {"properties": {"time-scaling-factor": false}}}], "examples": [{"ethernet": {"access-mode": "network-based"}}, {"ethernet": {"access-mode": "channel-based", "signal-updates": "always"}}, {"time-source": "internal-realtime"}, {"time-source": "internal-scaled", "time-scaling-factor": "as-fast-as-possible"}, {"time-source": "internal-scaled", "time-scaling-factor": 0.01}, {"time-source": "internal-scaled", "time-scaling-factor": 0.5}, {"time-source": "internal-scaled", "time-scaling-factor": 1}, {"time-source": "internal-scaled", "time-scaling-factor": 6}, {"time-source": "internal-scaled", "time-scaling-factor": 10}, {"time-source": "internal-scaled", "time-scaling-factor": 500}, {"database-dotnet-namespace-generation": ["use-network", "${someVariable}"]}]}
venvironment-schema.json
database-dotnet-namespace-generation
User defined settings for namespace generation in the .Net typelib. Default complies with the setting "Automatic Qualification". With this setting the namespaces for signals are automatically generated so that each class is unique. For each frame a class is generated in the namespace "NetworkDB.Frames".
{"type": "array", "minItems": 1, "items": {"anyOf": [{"type": "string", "enum": ["use-network", "use-database", "use-frame", "use-node"]}, {}]}, "examples": [["use-network", "use-database", "use-frame", "use-node"]]}
venvironment-schema.json
time-scaling-factor
'number': The measurement is slowed-down by this factor. For scaling factors between zero and one, the simulation is accelerated accordingly. For example, if you enter the value 0.1 the measurement is accelerated by a factor of 10. 'as-fast-as-possible': Run the simulation as fast as possible. The simulation speed is not constant and depends on the performance of the computer and the load that is provoked by simulation.
{"oneOf": [{"type": "number", "exclusiveMinimum": 0, "maximum": 1e+37}, {"const": "as-fast-as-possible"}, {}], "default": "as-fast-as-possible"}
venvironment-schema.json
time-source
Time source for the simulation. Operate without hardware and simulate all buses completely. 'internal-realtime': The time response of the measurement (time basis) is controlled internally. 'external-software': The time response of the measurement (time basis) is controlled by an external program. 'internal-scaled': The simulation speed is provided through the property time-scaling-factor.
{"default": "internal-realtime", "anyOf": [{"enum": ["internal-realtime", "external-software", "internal-scaled"]}, {}], "examples": ["internal-realtime", "internal-scaled", "external-software"]}
venvironment-schema.json
full
A lists of system variables to be used by the simulation. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"file-path": "path/to/my.vsysvar"}], [{"file-path": ["${path_in_variable}", "path/${name_in_variable}"]}, {"file-path": "path/to/my.vsysvar", "when": "SCENARIO_NAME == \"my_scenario_name\""}]]}
venvironment-schema.json
full
List of databases. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"name": "mydbname", "file-path": "path/to/some.dbc"}], [{"name": "mydbname", "file-path": "path/to/some.dbc"}, {"name": "mydbname", "file-path": "path/to/some.arxml", "network-name": "network_in_db"}, {"name": "mydbname", "file-path": "path/to/some.dbc", "when": "SCENARIO_NAME == \"my_scenario_name\""}]]}
venvironment-schema.json
full
List of CAN networks. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"name": "my_can_network"}], [{"name": "my_can_network", "when": "SCENARIO_NAME == \"my_scenario_name\""}, {"name": "my_can_network", "database": "DB_1", "application-channel": 42, "baudrate": 500000, "mapping": "internal-simulator", "when": "SCENARIO_NAME == \"another_scenario\""}]]}
venvironment-schema.json
full
List of CANFD networks. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"name": "my_canfd_network"}], [{"name": "my_canfd_network", "when": "SCENARIO_NAME == \"my_scenario_name\""}, {"name": "my_canfd_network", "database": "DB_1", "application-channel": 42, "mode": "iso", "arbitration-baudrate": 500000, "data-baudrate": 1000000, "mapping": "internal-simulator"}]]}
venvironment-schema.json
full
List of Ethernet networks. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"name": "my_eth_network"}], [{"name": "my_eth_network", "when": "SCENARIO_NAME == \"my_scenario_name\""}, {"name": "my_eth_network", "database": "DB", "application-channel": 12, "tcp-ip-stack-adapter": {"mac-address": "02:84:cf:3b:be:01"}, "mapping": "external-sil-kit"}, {"name": "my_eth_network", "database": "DB", "application-channel": 12, "mapping": "internal-simulator", "tcp-ip-stack-adapter": {"mtu": 1500, "ipv4-settings": {"address-configuration": "static", "addresses": [{"address": "192.168.0.1", "subnet-mask": "255.255.0.0"}]}, "ipv6-settings": {"address-configuration": "dhcp"}, "vlans": [{"id": 42, "priority": 0}]}}]]}
venvironment-schema.json
full
List of FlexRay clusters. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}}
venvironment-schema.json
full
List of LIN networks. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}}
venvironment-schema.json
full
A list of simulation nodes used in a simulation. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"name": "mynode", "network-assignments": [{"network": "my_can_network_1"}]}], [{"name": "mynode", "network-assignments": [{"network": "my_can_network_1"}], "file-path": "path/to/my_capl_script.can", "when": "SCENARIO_NAME == \"my_scenario_name1\""}, {"name": "mynode", "file-path": "path/to/my_dotnet.cs", "database-node": true, "network-assignments": [{"network": "my_can_network_1"}], "defines": ["mydefine1", "mydefine2"], "modeling-libraries": ["modeling/lib/1.vmodule", "${path_in_var}"], "when": "SCENARIO_NAME == \"my_scenario_name2\""}]]}
venvironment-schema.json
full
The definition of datasources used by application models. Input files can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "properties": {"input-files": {"type": "array", "items": {"type": "object", "additionalProperties": false, "required": ["file-path"], "properties": {"when": {}, "file-path": {}, "defines": {}}}}}, "examples": [{"input-files": [{"file-path": "path/to/my.vcdl"}]}, {"input-files": [{"file-path": ["path/to/my.vcodm", "${path_in_variable}", "path/${name_in_variable}"]}]}, {"input-files": [{"file-path": "path/to/my.vcdl", "defines": ["A", "B=42"], "when": "SCENARIO_NAME == \"my_scenario_name\""}]}]}
venvironment-schema.json
full
List of application models representing some program. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"file-path": "path/to/my/file.can", "defines": ["mydefine1", "mydefine=2"]}]]}
venvironment-schema.json
full
Lists of programming modules to be used by the simulation. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"capl-library-path": "path/to/my.vmodule"}], [{"c-library-path": ["${path_in_variable}", "path/${name_in_variable}"]}], [{"capl-library-path": "path/to/my.vmodule", "when": "SCENARIO_NAME == \"my_scenario_name\""}, {"c-library-path": "path/to/my.vmodule", "when": "SCENARIO_NAME == \"my_scenario_name\""}]]}
venvironment-schema.json
full
List of user files. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"file-path": "path/to/my.txt"}], [{"file-path": ["${path_in_variable}", "path/${name_in_variable}"]}, {"file-path": "path/to/my_file.txt", "when": "SCENARIO_NAME == \"my_scenario_name\""}]]}
venvironment-schema.json
full
List of XCP configuration files (entries can be deactivated with when)
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"file-path": "path/to/my.xcpcfg"}], [{"file-path": ["${path_in_variable}", "path/${name_in_variable}"]}, {"file-path": "path/to/my.yaml", "when": "SCENARIO_NAME == \"my_scenario_name\""}]]}
venvironment-schema.json
full
FDX settings. Entry can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "required": ["transport-layer", "port"], "properties": {"when": {}, "transport-layer": {"default": "udp/ipv4", "anyOf": [{"type": "string", "enum": ["udp/ipv4", "udp/ipv6", "tcp/ipv4", "tcp/ipv6"]}, {}]}, "port": {"default": 2809, "anyOf": [{"type": "integer", "minimum": 0, "maximum": 65535}, {}]}, "description-files": {"type": "array", "items": {"type": "object", "additionalProperties": false, "required": ["file-path"], "properties": {"when": {}, "file-path": {}}}}}, "examples": [{"transport-layer": "udp/ipv4", "port": 2809}, {"transport-layer": "tcp/ipv6", "port": 5555, "description-files": [{"file-path": "path/to/first.xml"}, {"file-path": "path/to/second.xml"}]}]}
venvironment-schema.json
transport-layer
Protocol to be used as transport layer for the FDX protocol
{"default": "udp/ipv4", "anyOf": [{"type": "string", "enum": ["udp/ipv4", "udp/ipv6", "tcp/ipv4", "tcp/ipv6"]}, {}]}
venvironment-schema.json
port
Number of the UDP or TCP port to be used for the FDX protocol
{"default": 2809, "anyOf": [{"type": "integer", "minimum": 0, "maximum": 65535}, {}]}
venvironment-schema.json
description-files
List of XML files that describe which signals or variables are to be exchanged and the manner in which this is to occur (e.g., with regard to grouping). Each entry can be deactivated with when.
{"type": "array", "items": {"type": "object", "additionalProperties": false, "required": ["file-path"], "properties": {"when": {}, "file-path": {}}}}
venvironment-schema.json
full
List of functional mockup units. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"file-path": "path/to/some.fmu", "stepsize-in-sec": 0.001}], [{"file-path": "path/to/some.fmu", "stepsize-in-sec": 0.001, "debug-output": true}], [{"file-path": "path/to/some.fmu", "stepsize-in-sec": 0.001, "debug-output": false, "active-model-variables": ["Variable1", "Variable2"]}], [{"file-path": "path/to/some.fmu", "stepsize-in-sec": 0.001, "debug-output": false, "inactive-model-variables": ["Variable3"]}]]}
venvironment-schema.json
full
SIL Kit settings. Entry can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "required": ["participant-name"], "properties": {"when": {}, "registry-uri": {"type": "string", "anyOf": [{"pattern": "^[^:]+://[^:/]+(:[0-9]+)?(/[^?#/]+)*(\\?([^=#&]+=[^=#&]+)(&([^=#&]+=[^=#&]+))*)?(#.+)?", "default": "silkit://localhost:8500"}, {}], "examples": ["silkit://localhost:8500"]}, "participant-name": {"anyOf": [{"type": "string"}, {}], "examples": ["CANoe4SW-SE"]}, "config-file-path": {}, "simulation-step-in-micro-sec": {"anyOf": [{"type": "integer", "minimum": 0, "maximum": 9223372036854775, "default": 100}, {}]}, "life-cycle-event-timeout-in-sec": {"anyOf": [{"type": "integer", "minimum": 0, "maximum": 9223372036, "default": 30}, {}]}}, "examples": [{"participant-name": "CANoe4SW-SE"}, {"registry-uri": "silkit://localhost:8500", "participant-name": "CANoe4SW-SE", "config-file-path": "path/to/config-file.json"}, {"registry-uri": "silkit://localhost:8500", "participant-name": "CANoe4SW-SE", "config-file-path": "path/to/config-file.json", "simulation-step-in-micro-sec": 150}, {"registry-uri": "silkit://localhost:8500", "participant-name": "CANoe4SW-SE", "config-file-path": "path/to/config-file.json", "simulation-step-in-micro-sec": 150, "life-cycle-event-timeout-in-sec": 30}]}
venvironment-schema.json
registry-uri
The URI of the registry.
{"type": "string", "anyOf": [{"pattern": "^[^:]+://[^:/]+(:[0-9]+)?(/[^?#/]+)*(\\?([^=#&]+=[^=#&]+)(&([^=#&]+=[^=#&]+))*)?(#.+)?", "default": "silkit://localhost:8500"}, {}], "examples": ["silkit://localhost:8500"]}
venvironment-schema.json
participant-name
Name used by the simulation tool to join a simulation as a participant at the start of a measurement.
{"anyOf": [{"type": "string"}, {}], "examples": ["CANoe4SW-SE"]}
venvironment-schema.json
simulation-step-in-micro-sec
Time length of a single simulation step. Valid only for the time-source "external-software".
{"anyOf": [{"type": "integer", "minimum": 0, "maximum": 9223372036854775, "default": 100}, {}]}
venvironment-schema.json
life-cycle-event-timeout-in-sec
Maximum waiting time for the other simulation participants. Valid only for the time-source "external-software".
{"anyOf": [{"type": "integer", "minimum": 0, "maximum": 9223372036, "default": 30}, {}]}
venvironment-schema.json
full
Configuration of the logging for the environment.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "required": ["file-name"], "properties": {"file-name": {}, "logging-events": {"type": "array", "default": ["application-layer", "bus", "diagnostic", "internal", "statistic", "system-variable", "test"], "items": {"anyOf": [{"type": "string", "enum": ["application-layer", "bus", "diagnostic", "internal", "statistic", "system-variable", "test"]}, {}]}}, "advanced": {}}, "examples": [{"file-name": "file-name.blf", "logging-events": ["bus", "diagnostic", "internal", "${someVariable}"], "advanced": {"warn-overwritten-log-file": true, "show-error-on-data-loss": false}}]}
venvironment-schema.json
full
List of CAN replay blocks. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"name": "my_can_replay_block", "file-path": "my_logging_file.blf"}], [{"name": "my_can_replay_block", "file-path": "my_logging_file.blf", "when": "SCENARIO_NAME == \"my_scenario_name\""}, {"name": "my_can_replay_block", "file-path": "another_logging_file.blf", "when": "SCENARIO_NAME == \"another_scenario_name\""}]]}
venvironment-schema.json
full
List of ethernet replay blocks. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"name": "my_ethernet_replay_block", "file-path": "my_logging_file.blf"}], [{"name": "my_ethernet_replay_block", "file-path": "my_logging_file.blf", "when": "SCENARIO_NAME == \"my_scenario_name\""}, {"name": "my_ethernet_replay_block", "file-path": "another_logging_file.blf", "when": "SCENARIO_NAME == \"another_scenario_name\""}]]}
venvironment-schema.json
full
List of LIN replay blocks. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"name": "my_lin_replay_block", "file-path": "my_logging_file.blf"}], [{"name": "my_lin_replay_block", "file-path": "my_logging_file.blf", "when": "SCENARIO_NAME == \"my_scenario_name\""}, {"name": "my_lin_replay_block", "file-path": "another_logging_file.blf", "when": "SCENARIO_NAME == \"another_scenario_name\""}]]}
venvironment-schema.json
full
Json schema version for the vEnvironment configuration file. Acceptance criteria: equal major version, less/equal minor and patch version.
{"$schema": "http://json-schema.org/draft-07/schema#", "const": "2.0.0", "type": "string", "examples": ["2.0.0"]}
venvironment-schema.json
full
Global settings for all scenarios.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "properties": {"ethernet": {}, "database": {}, "database-dotnet-namespace-generation": {"type": "array", "minItems": 1, "items": {"anyOf": [{"type": "string", "enum": ["use-network", "use-database", "use-frame", "use-node"]}, {}]}, "examples": [["use-network", "use-database", "use-frame", "use-node"]]}, "time-scaling-factor": true, "time-source": {"default": "internal-realtime", "anyOf": [{"type": "string", "enum": ["internal-realtime", "external-software", "internal-scaled"]}, {}], "examples": ["internal-realtime", "internal-scaled", "external-software"]}}, "allOf": [{"if": {"required": ["time-source"], "properties": {"time-source": {"const": "internal-scaled"}}}, "then": {"properties": {"time-scaling-factor": {"anyOf": [{"type": "number", "exclusiveMinimum": 0, "maximum": 1e+37}, {"const": "as-fast-as-possible"}, {}], "default": "as-fast-as-possible", "examples": ["as-fast-as-possible", "0.01", "0.05", "0.1", "0.5", "1", "5", "10", "50", "100", "500"]}}}}], "examples": [{"ethernet": {"access-mode": "network-based"}}, {"ethernet": {"access-mode": "channel-based", "signal-updates": "always"}}, {"time-source": "internal-realtime"}, {"time-source": "internal-scaled", "time-scaling-factor": 6}, {"database-dotnet-namespace-generation": ["use-network", "${someVariable}"]}]}
venvironment-schema.json
database-dotnet-namespace-generation
User defined settings for namespace generation in the .Net typelib. Default complies with the setting "Automatic Qualification"
{"type": "array", "minItems": 1, "items": {"anyOf": [{"type": "string", "enum": ["use-network", "use-database", "use-frame", "use-node"]}, {}]}, "examples": [["use-network", "use-database", "use-frame", "use-node"]]}
venvironment-schema.json
time-source
Time source for the simulation. Operate without hardware and simulate all buses completely. 'internal-realtime': The time response of the measurement (time basis) is controlled internally. 'external-software': The time response of the measurement (time basis) is controlled by an external program. 'internal-scaled': The simulation speed is provided through the property time-scaling-factor.
{"default": "internal-realtime", "anyOf": [{"type": "string", "enum": ["internal-realtime", "external-software", "internal-scaled"]}, {}], "examples": ["internal-realtime", "internal-scaled", "external-software"]}
venvironment-schema.json
time-scaling-factor
The measurement is slowed-down by this factor. For scaling factors between zero and one, the simulation is accelerated accordingly. For example, if you enter the value 0.1 the measurement is accelerated by a factor of 10.
{"type": "number", "exclusiveMinimum": 0, "maximum": 1e+37}
venvironment-schema.json
time-scaling-factor
Run the simulation as fast as possible. The simulation speed is not constant and depends on the performance of the computer and the load that is provoked by simulation.
{"const": "as-fast-as-possible"}
venvironment-schema.json
full
A list of simulation nodes used in a simulation. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"name": "mynode", "network-assignments": [{"network": "my_can_network_1"}]}], [{"name": "mynode", "network-assignments": [{"network": "my_can_network_1"}], "file-path": "path/to/my_capl_script.can", "when": "SCENARIO_NAME == \"my_scenario_name1\""}, {"name": "mynode", "file-path": "path/to/my_dotnet.cs", "database-node": true, "network-assignments": [{"network": "my_can_network_1"}], "defines": ["mydefine1", "mydefine2"], "modeling-libraries": ["modeling/lib/1.vmodule", "${path_in_var}"], "when": "SCENARIO_NAME == \"my_scenario_name2\""}]]}
venvironment-schema.json
full
List of CAN networks. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"name": "my_can_network"}], [{"name": "my_can_network", "when": "SCENARIO_NAME == \"my_scenario_name\""}, {"name": "my_can_network", "database": "DB_1", "application-channel": 42, "baudrate": 500000, "mapping": "internal-simulator", "when": "SCENARIO_NAME == \"another_scenario\""}]]}
venvironment-schema.json
full
List of CANFD networks. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"name": "my_canfd_network"}], [{"name": "my_canfd_network", "when": "SCENARIO_NAME == \"my_scenario_name\""}, {"name": "my_canfd_network", "database": "DB_1", "application-channel": 42, "mode": "iso", "arbitration-baudrate": 500000, "data-baudrate": 1000000, "mapping": "internal-simulator"}]]}
venvironment-schema.json
full
List of Ethernet networks. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"name": "my_eth_network"}], [{"name": "my_eth_network", "when": "SCENARIO_NAME == \"my_scenario_name\""}, {"name": "my_eth_network", "database": "DB", "application-channel": 12, "tcp-ip-stack-adapter": {"mac-address": "02:84:cf:3b:be:01"}, "mapping": "external-sil-kit"}, {"name": "my_eth_network", "database": "DB", "application-channel": 12, "mapping": "internal-simulator", "tcp-ip-stack-adapter": {"mtu": 1500, "ipv4-settings": {"address-configuration": "static", "addresses": [{"address": "192.168.0.1", "subnet-mask": "255.255.0.0"}]}, "ipv6-settings": {"address-configuration": "dhcp"}, "vlans": [{"id": 42, "priority": 0}]}}]]}
venvironment-schema.json
full
List of LIN networks. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}}
venvironment-schema.json
full
Json schema version for the vEnvironment configuration file. Acceptance criteria: equal major version, less/equal minor and patch version.
{"$schema": "http://json-schema.org/draft-07/schema#", "const": "1.1.1", "type": "string", "examples": ["1.1.1"]}
venvironment-schema.json
full
Global settings for all scenarios.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "properties": {"ethernet-settings": {}, "time-scaling-factor": true, "time-source": {"default": "internal-realtime", "anyOf": [{}, {"const": "internal-realtime"}, {"const": "external-software"}, {"const": "internal-scaled"}], "examples": ["internal-realtime", "internal-scaled", "external-software"]}}, "allOf": [{"if": {"required": ["time-source"], "properties": {"time-source": {"const": "internal-scaled"}}}, "then": {"properties": {"time-scaling-factor": {"anyOf": [{"type": "number", "exclusiveMinimum": 0, "maximum": 1.7976931348623157e+308}, {"const": "as-fast-as-possible"}, {}], "default": "as-fast-as-possible", "examples": ["as-fast-as-possible", "0.01", "0.05", "0.1", "0.5", "1", "5", "10", "50", "100", "500"]}}}}], "examples": [{"ethernet-settings": {"access-mode": "network-based"}}, {"ethernet-settings": {"access-mode": "channel-based", "signal-updates": "always"}}, {"time-source": "internal-realtime"}, {"time-source": "internal-scaled", "time-scaling-factor": 6}]}
venvironment-schema.json
time-source
Time source for the simulation.
{"default": "internal-realtime", "anyOf": [{}, {"const": "internal-realtime"}, {"const": "external-software"}, {"const": "internal-scaled"}], "examples": ["internal-realtime", "internal-scaled", "external-software"]}
venvironment-schema.json
time-source
Operate without hardware and simulate all buses completely. The time response of the measurement (time basis) is controlled internally.
{"const": "internal-realtime"}
venvironment-schema.json
time-source
Operate without hardware and simulate all buses completely. The time response of the measurement (time basis) is controlled by an external program.
{"const": "external-software"}
venvironment-schema.json
time-source
Operate without hardware and simulate all buses completely. The simulation speed is provided through the property time-scaling-factor.
{"const": "internal-scaled"}
venvironment-schema.json
time-scaling-factor
The measurement is slowed-down by this factor. For scaling factors between zero and one, the simulation is accelerated accordingly. For example, if you enter the value 0.1 the measurement is accelerated by a factor of 10.
{"type": "number", "exclusiveMinimum": 0, "maximum": 1.7976931348623157e+308}
venvironment-schema.json
time-scaling-factor
Run the simulation as fast as possible. The simulation speed is not constant and depends on the performance of the computer and the load that is provoked by simulation.
{"const": "as-fast-as-possible"}
venvironment-schema.json
full
List of variables to be used in this configuration file.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"name": "var", "value": -42}], [{"name": "my_string", "value": "implicit-type"}, {"name": "var", "value": 422200000000.0, "type": "float"}, {"name": "path_var", "value": "path/to/somewhere", "type": "path"}, {"name": "uint_enum", "value": 43, "type": "uint", "options": [1, 43, 127]}]]}
venvironment-schema.json
full
List of application models representing some program. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"file-path": "path/to/my/file.can", "defines": ["mydefine1", "mydefine=2"]}]]}
venvironment-schema.json
full
The definition of datasources used by application models. Input files can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "properties": {"input-files": {"type": "array", "items": {"type": "object", "additionalProperties": false, "required": ["file-path"], "properties": {"when": {}, "file-path": {}}}}}, "examples": [{"input-files": [{"file-path": "path/to/my.vcdl"}]}, {"input-files": [{"file-path": ["path/to/my.vcodm", "${path_in_variable}", "path/${name_in_variable}"]}]}, {"input-files": [{"file-path": "path/to/my.vcdl", "when": "SCENARIO_NAME == \"my_scenario_name\""}]}]}
venvironment-schema.json
full
List of functional mockup units. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"file-path": "path/to/some.fmu", "stepsize-in-sec": 0.001}], [{"file-path": "path/to/some.fmu", "stepsize-in-sec": 0.001, "debug-output": true}], [{"file-path": "path/to/some.fmu", "stepsize-in-sec": 0.001, "debug-output": false, "active-model-variables": ["Variable1", "Variable2"]}], [{"file-path": "path/to/some.fmu", "stepsize-in-sec": 0.001, "debug-output": false, "inactive-model-variables": ["Variable3"]}]]}
venvironment-schema.json
full
SIL Kit settings. Entry can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "required": ["participant-name"], "properties": {"when": {}, "registry-uri": {"type": "string", "anyOf": [{"pattern": "^[^:]+://[^:/]+(:[0-9]+)?(/[^?#/]+)*(\\?([^=#&]+=[^=#&]+)(&([^=#&]+=[^=#&]+))*)?(#.+)?"}, {}], "examples": ["silkit://localhost:8500"]}, "participant-name": {"anyOf": [{"type": "string"}, {}], "examples": ["CANoe4SW"]}, "config-file-path": {}, "simulation-step-in-micro-sec": {"anyOf": [{"type": "integer", "minimum": 0, "maximum": 9223372036854775807, "default": 100}, {}]}, "life-cycle-event-timeout-in-sec": {"anyOf": [{"type": "integer", "minimum": 0, "maximum": 9223372036854775807, "default": 30}, {}]}}, "examples": [{"registry-uri": "silkit://localhost:8500", "participant-name": "CANoe4SW", "config-file-path": "path/to/config-file.json"}, {"registry-uri": "silkit://localhost:8500", "participant-name": "CANoe4SW", "config-file-path": "path/to/config-file.json", "simulation-step-in-micro-sec": 150}, {"registry-uri": "silkit://localhost:8500", "participant-name": "CANoe4SW", "config-file-path": "path/to/config-file.json", "simulation-step-in-micro-sec": 150, "life-cycle-event-timeout-in-sec": 30}]}
venvironment-schema.json
registry-uri
registry URI
{"type": "string", "anyOf": [{"pattern": "^[^:]+://[^:/]+(:[0-9]+)?(/[^?#/]+)*(\\?([^=#&]+=[^=#&]+)(&([^=#&]+=[^=#&]+))*)?(#.+)?"}, {}], "examples": ["silkit://localhost:8500"]}
venvironment-schema.json
participant-name
Name used by CANoe4SW to join a simulation as a participant at the start of a measurement.
{"anyOf": [{"type": "string"}, {}], "examples": ["CANoe4SW"]}
venvironment-schema.json
simulation-step-in-micro-sec
Time length of a single simulation step. Valid only for the time-source "external-software". Default: 100 us.
{"anyOf": [{"type": "integer", "minimum": 0, "maximum": 9223372036854775807, "default": 100}, {}]}
venvironment-schema.json
life-cycle-event-timeout-in-sec
Maximum waiting time for the other simulation participants. Valid only for the time-source "external-software". Default: 30s.
{"anyOf": [{"type": "integer", "minimum": 0, "maximum": 9223372036854775807, "default": 30}, {}]}
venvironment-schema.json
full
List of XCP configuration files (entries can be deactivated with when)
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"file-path": "path/to/my.xcpcfg"}], [{"file-path": ["${path_in_variable}", "path/${name_in_variable}"]}, {"file-path": "path/to/my.xcpcfg", "when": "SCENARIO_NAME == \"my_scenario_name\""}]]}
venvironment-schema.json
full
Configuration of the standalone logging block.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "required": ["file-name"], "properties": {"file-name": {}, "logging-events": {"type": "array", "default": ["bus", "diagnostic", "internal", "statistic", "system-variable", "test"], "items": {"anyOf": [{"type": "string", "enum": ["bus", "diagnostic", "internal", "statistic", "system-variable", "test"]}, {}]}}, "advanced": {}}, "examples": [{"file-name": "file-name.blf", "logging-events": ["bus", "diagnostic", "internal", "${someVariable}"], "advanced": {"warn-overwritten-log-file": true, "show-error-on-data-loss": false}}]}
venvironment-schema.json
full
A list of simulation nodes used in a simulation. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"name": "mynode", "network-assignments": [{"network": "my_can_network_1"}]}], [{"name": "mynode", "network-assignments": [{"network": "my_can_network_1"}], "file-path": "path/to/my_capl_script.can", "when": "SCENARIO_NAME == \"my_scenario_name1\""}, {"name": "mynode", "file-path": "path/to/my_dotnet.cs", "network-assignments": [{"network": "my_can_network_1", "database-node": {"database": "mydatabase", "node": "mynode"}}], "defines": ["mydefine1", "mydefine2"], "modeling-libraries": ["modeling/lib/1.vmodule", "${path_in_var}"], "when": "SCENARIO_NAME == \"my_scenario_name2\""}]]}
venvironment-schema.json
full
List of databases. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"name": "mydbname", "file-path": "path/to/some.dbc"}], [{"name": "mydbname", "file-path": "path/to/some.dbc"}, {"name": "mydbname", "file-path": "path/to/some.arxml", "network-name": "network_in_db"}, {"name": "mydbname", "file-path": "path/to/some.dbc", "when": "SCENARIO_NAME == \"my_scenario_name\""}]]}
venvironment-schema.json
full
List of CAN networks. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"name": "my_can_network"}], [{"name": "my_can_network", "when": "SCENARIO_NAME == \"my_scenario_name\""}, {"name": "my_can_network", "databases": ["DB_1", "DB_2"], "application-channel": 42, "baudrate": 500000, "mapping": "internal-simulator", "when": "SCENARIO_NAME == \"another_scenario\""}]]}
venvironment-schema.json
full
List of CANFD networks. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"name": "my_canfd_network"}], [{"name": "my_canfd_network", "when": "SCENARIO_NAME == \"my_scenario_name\""}, {"name": "my_canfd_network", "databases": ["DB_1", "DB_2"], "application-channel": 42, "mode": "iso", "arbitration-baudrate": 500000, "data-baudrate": 1000000, "mapping": "internal-simulator"}]]}
venvironment-schema.json
full
List of Ethernet networks. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"name": "my_eth_network"}], [{"name": "my_eth_network", "when": "SCENARIO_NAME == \"my_scenario_name\""}, {"name": "my_eth_network", "databases": ["DB_1", "DB_2"], "application-channel": 12, "tcp-ip-stack-adapter": {"mac-address": "02:84:cf:3b:be:01"}, "mapping": "external-sil-kit"}, {"name": "my_eth_network", "databases": ["DB_1", "DB_2"], "application-channel": 12, "mapping": "internal-simulator", "tcp-ip-stack-adapter": {"mtu": 1500, "ipv4-settings": {"address-configuration": "static", "addresses": [{"address": "192.168.0.1", "subnet-mask": "255.255.0.0"}]}, "ipv6-settings": {"address-configuration": "dhcp"}, "vlans": [{"id": 42, "priority": 0}]}}]]}
venvironment-schema.json
full
List of CAN replay blocks. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"name": "my_can_replay_block", "file-path": "my_logging_file.blf"}], [{"name": "my_can_replay_block", "file-path": "my_logging_file.blf", "when": "SCENARIO_NAME == \"my_scenario_name\""}, {"name": "my_can_replay_block", "file-path": "another_logging_file.blf", "when": "SCENARIO_NAME == \"another_scenario_name\""}]]}
venvironment-schema.json
full
List of ethernet replay blocks. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"name": "my_ethernet_replay_block", "file-path": "my_logging_file.blf"}], [{"name": "my_ethernet_replay_block", "file-path": "my_logging_file.blf", "when": "SCENARIO_NAME == \"my_scenario_name\""}, {"name": "my_ethernet_replay_block", "file-path": "another_logging_file.blf", "when": "SCENARIO_NAME == \"another_scenario_name\""}]]}
venvironment-schema.json
full
List of scenarios with the option to define / override variables or defines.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"name": "my_scenario_name"}], [{"name": "my_scenario_name"}, {"name": "override_variables", "variables": [{"name": "three", "value": 3}]}, {"name": "override_defines", "defines": ["mydefine", "mydevine_with_value=42"]}]]}
venvironment-schema.json
full
Json schema version for the vEnvironment configuration file. Acceptance criteria: equal major version, less/equal minor and patch version.
{"$schema": "http://json-schema.org/draft-07/schema#", "const": "1.1.0", "type": "string", "examples": ["1.1.0"]}
venvironment-schema.json
full
Json schema version for the vEnvironment configuration file. Acceptance criteria: equal major version, less/equal minor and patch version.
{"$schema": "http://json-schema.org/draft-07/schema#", "const": "1.0.0", "type": "string", "examples": ["1.0.0"]}
venvironment-schema.json
full
Include a different file (similar to #include of the c preprocessor). The order of includes does not matter. Circular / multiple includes are resolved correctly.
{"$schema": "http://json-schema.org/draft-07/schema#", "oneOf": [{}, {"type": "array", "items": {}}], "examples": ["my_include.yaml", ["my_include.yaml", "my_other_include.json"]]}
venvironment-schema.json
full
List of application models representing some program. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"file-path": "path/to/my/file.can", "defines": ["mydefine1", "mydefine=2"]}]]}
venvironment-schema.json
full
List of defines to be passed to capl / vcdl. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"define": "mydefine1"}], [{"define": ["mydefine1", "mydefine2"]}, {"define": ["mydefine1", "mydefine2"], "when": "SCENARIO_NAME == \"my_scenario_name\""}, {"define": ["mydefine_with_value=42", "${var_with_define_name}=${var_with_define_value}"]}]]}
venvironment-schema.json
full
A list of simulation nodes used in a simulation. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"name": "mynode", "network-assignments": [{"network": "my_can_network_1"}]}], [{"name": "mynode", "network-assignments": [{"network": "my_can_network_1"}], "file-path": "path/to/my_capl_script.can", "when": "SCENARIO_NAME == \"my_scenario_name\""}, {"name": "mynode", "file-path": "path/to/my_dotnet.cs", "network-assignments": [{"network": "my_can_network_1", "database-node": {"database": "mydatabase", "node": "mynode"}, "modeling-libraries": ["modeling/lib/2.dll"]}], "defines": ["mydefine1", "mydefine2"], "modeling-libraries": ["modeling/lib/1.dll", "${path_in_var}"], "when": "SCENARIO_NAME == \"my_scenario_name\""}]]}
venvironment-schema.json
full
List of CAN networks. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"name": "my_can_network"}], [{"name": "my_can_network", "when": "SCENARIO_NAME == \"my_scenario_name\""}, {"name": "my_can_network", "databases": ["DB_1", "DB_2"], "application-channel": 42, "baudrate": 500000}]]}
venvironment-schema.json
full
List of CANFD networks. Entries can be deactivated with when.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"name": "my_canfd_network"}], [{"name": "my_canfd_network", "when": "SCENARIO_NAME == \"my_scenario_name\""}, {"name": "my_canfd_network", "databases": ["DB_1", "DB_2"], "application-channel": 42, "mode": "iso", "arbitration-baudrate": 500000, "data-baudrate": 1000000}]]}
venvironment-schema.json
full
List of scenarios with the option to define / override variables or defines.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"name": "my_scenario_name"}], [{"name": "my_scenario_name"}, {"name": "override_variables", "variables": [{"name": "three", "value": 3}]}, {"name": "override_defines", "defines": ["mydefine", "mydevine_with_value=42"]}]]}
venvironment-schema.json
full
A scenario with the option to define / override variables or defines.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "required": ["name"], "properties": {"name": {"type": "string", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", "not": {"const": "Default"}}, "variables": {}, "defines": {}}, "examples": [{"name": "my_scenario_name"}, {"name": "override_variables", "variables": [{"name": "three", "value": 3}]}, {"name": "override_defines", "defines": ["mydefine", "mydevine_with_value=42"]}]}
venvironment-schema.json
name
A C-identifier for this variable (case sensitive).
{"type": "string", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", "allOf": [{"not": {"pattern": "^[cC][aA][nN][oO][eE]_.*$"}}, {"not": {"pattern": "^[aA][nN][dD]$"}}, {"not": {"pattern": "^[aA][sS]$"}}, {"not": {"pattern": "^[aA][sS][sS][eE][rR][tT]$"}}, {"not": {"pattern": "^[bB][oO][oO][lL]$"}}, {"not": {"pattern": "^[bB][rR][eE][aA][kK]$"}}, {"not": {"pattern": "^[cC][aA][sS][eE]$"}}, {"not": {"pattern": "^[cC][aA][tT][cC][hH]$"}}, {"not": {"pattern": "^[cC][lL][aA][sS][sS]$"}}, {"not": {"pattern": "^[cC][oO][nN][tT][iI][nN][uU][eE]$"}}, {"not": {"pattern": "^[dD][eE][fF]$"}}, {"not": {"pattern": "^[dD][eE][lL][eE][tT][eE]$"}}, {"not": {"pattern": "^[eE][lL][iI][fF]$"}}, {"not": {"pattern": "^[eE][lL][sS][eE]$"}}, {"not": {"pattern": "^[eE][xX][cC][eE][pP][tT]$"}}, {"not": {"pattern": "^[fF][aA][lL][sS][eE]$"}}, {"not": {"pattern": "^[fF][iI][nN][aA][lL][lL][yY]$"}}, {"not": {"pattern": "^[fF][lL][oO][aA][tT]$"}}, {"not": {"pattern": "^[fF][oO][rR]$"}}, {"not": {"pattern": "^[fF][rR][oO][mM]$"}}, {"not": {"pattern": "^[gG][lL][oO][bB][aA][lL]$"}}, {"not": {"pattern": "^[iI][fF]$"}}, {"not": {"pattern": "^[iI][mM][pP][oO][rR][tT]$"}}, {"not": {"pattern": "^[iI][nN]$"}}, {"not": {"pattern": "^[iI][nN][tT]$"}}, {"not": {"pattern": "^[iI][nN][tT][eE][gG][eE][rR]$"}}, {"not": {"pattern": "^[iI][sS]$"}}, {"not": {"pattern": "^[lL][oO][nN][gG]$"}}, {"not": {"pattern": "^[nN][oO][nN][eE]$"}}, {"not": {"pattern": "^[nN][oO][tT]$"}}, {"not": {"pattern": "^[oO][rR]$"}}, {"not": {"pattern": "^[pP][aA][sS][sS]$"}}, {"not": {"pattern": "^[rR][aA][iI][sS][eE]$"}}, {"not": {"pattern": "^[rR][eE][tT][uU][rR][nN]$"}}, {"not": {"pattern": "^[sS][cC][eE][nN][aA][rR][iI][oO]_[nN][aA][mM][eE]$"}}, {"not": {"pattern": "^[sS][eE][lL][fF]$"}}, {"not": {"pattern": "^[sS][tT][rR][uU][cC][tT]$"}}, {"not": {"pattern": "^[sS][wW][iI][tT][cC][hH]$"}}, {"not": {"pattern": "^[tT][hH][iI][sS]$"}}, {"not": {"pattern": "^[tT][rR][uU][eE]$"}}, {"not": {"pattern": "^[tT][rR][yY]$"}}, {"not": {"pattern": "^[uU][iI][nN][tT]$"}}, {"not": {"pattern": "^[uU][nN][sS][iI][gG][nN][eE][dD]$"}}, {"not": {"pattern": "^[vV][oO][iI][dD]$"}}, {"not": {"pattern": "^[wW][hH][iI][lL][eE]$"}}, {"not": {"pattern": "^[wW][iI][tT][hH]$"}}, {"not": {"pattern": "^[xX][oO][rR]$"}}, {"not": {"pattern": "^[yY][iI][eE][lL][dD]$"}}], "examples": ["my_var"]}
venvironment-schema.json
from-environment
Take the value from a system environment variable.
{"type": "boolean", "default": false}
venvironment-schema.json
full
This variable can be used in any other node and overwritten by a scenario.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "oneOf": [{"additionalProperties": false, "required": ["value", "name"], "properties": {"name": {}, "from-environment": {}, "value": {"oneOf": [{"type": "string"}, {"type": "number"}, {"type": "boolean"}]}}}, {"additionalProperties": false, "required": ["type", "name"], "properties": {"name": {}, "from-environment": {}, "value": {}, "type": {"const": "int"}, "options": {"type": "array", "items": {}}}}, {"additionalProperties": false, "required": ["type", "name"], "properties": {"name": {}, "from-environment": {}, "value": {}, "type": {"const": "uint"}, "options": {"type": "array", "items": {}}}}, {"additionalProperties": false, "required": ["type", "name"], "properties": {"name": {}, "from-environment": {}, "value": {"type": "string"}, "type": {"enum": ["string", "path"]}, "options": {"type": "array", "items": {"type": "string"}}}}, {"additionalProperties": false, "required": ["type", "name"], "properties": {"name": {}, "from-environment": {}, "value": {"type": "boolean"}, "type": {"const": "bool"}, "options": {"type": "array", "items": {"type": "boolean"}}}}, {"additionalProperties": false, "required": ["type", "name"], "properties": {"name": {}, "from-environment": {}, "value": {}, "type": {"const": "float"}, "options": {"type": "array", "items": {}}}}], "examples": [{"name": "var", "value": -42}, {"name": "my_string", "value": "implicit-type"}, {"name": "var", "value": 422200000000.0, "type": "float"}, {"name": "path_var", "value": "path/to/somewhere", "type": "path"}, {"name": "uint_enum", "value": 43, "type": "uint", "options": [1, 43, 127]}]}
venvironment-schema.json
full
Variable of type implicit type (string, number or bool).
{"additionalProperties": false, "required": ["value", "name"], "properties": {"name": {}, "from-environment": {}, "value": {"oneOf": [{"type": "string"}, {"type": "number"}, {"type": "boolean"}]}}}
venvironment-schema.json
full
Variable of type integer.
{"additionalProperties": false, "required": ["type", "name"], "properties": {"name": {}, "from-environment": {}, "value": {}, "type": {"const": "int"}, "options": {"type": "array", "items": {}}}}
venvironment-schema.json
full
Variable of type unsigned integer.
{"additionalProperties": false, "required": ["type", "name"], "properties": {"name": {}, "from-environment": {}, "value": {}, "type": {"const": "uint"}, "options": {"type": "array", "items": {}}}}
venvironment-schema.json
full
Variable of type string or path.
{"additionalProperties": false, "required": ["type", "name"], "properties": {"name": {}, "from-environment": {}, "value": {"type": "string"}, "type": {"enum": ["string", "path"]}, "options": {"type": "array", "items": {"type": "string"}}}}
venvironment-schema.json
full
Variable of type bool.
{"additionalProperties": false, "required": ["type", "name"], "properties": {"name": {}, "from-environment": {}, "value": {"type": "boolean"}, "type": {"const": "bool"}, "options": {"type": "array", "items": {"type": "boolean"}}}}
venvironment-schema.json
full
Variable of type float.
{"additionalProperties": false, "required": ["type", "name"], "properties": {"name": {}, "from-environment": {}, "value": {}, "type": {"const": "float"}, "options": {"type": "array", "items": {}}}}
venvironment-schema.json
full
Defines to be passed to capl / vcdl.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "required": ["define"], "properties": {"when": {}, "define": {"anyOf": [{}, {}]}}, "examples": [{"define": "mydefine1"}, {"define": ["mydefine1", "mydefine2"]}, {"define": ["mydefine1", "mydefine2"], "when": "SCENARIO_NAME == \"my_scenario_name\""}, {"define": ["mydefine_with_value=42", "${var_with_define_name}=${var_with_define_value}"]}]}
venvironment-schema.json
access-mode
Mode of the underlying Ethernet bus. Classic approach is the 'Channel-based' setup. More recent and recommended mode is the switched 'Network-based' mode (port based).
{"anyOf": [{}, {"type": "string", "enum": ["network-based", "channel-based"], "default": "network-based"}], "examples": ["network-based", "channel-based"]}
venvironment-schema.json
signal-updates
Specifies how signals are updated on Network-based access. Will be ignored on Channel-based setups. Always: Events of all ports are used to update a signal without qualified ethernet port. rx-only: Only packets received by the interface are used, which leads to less duplicated updates. never: Signals without qualified ethernet ports are not updated.
{"anyOf": [{}, {"const": "always"}, {"const": "rx-only"}, {"const": "never"}], "examples": ["always", "rx-only", "never"]}
venvironment-schema.json
signal-updates
Events of all ports are used to update a signal without qualified ethernet port.
{"const": "always"}
venvironment-schema.json
signal-updates
Only packets received by the interface are used, which leads to less duplicated updates.
{"const": "rx-only"}
venvironment-schema.json
signal-updates
Signals without qualified ethernet ports are not updated.
{"const": "never"}
venvironment-schema.json
full
These settings control the interpretation of frames and PDUs of FlexRay configurations with channels A and B.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "properties": {"enable-dual-channel-support": {"anyOf": [{}, {"type": "boolean"}], "default": true}, "postfixes-for-ambiguous-pdus-on-channel": {"oneOf": [{"enum": ["A", "B", "A&B", "no-postfixes"]}, {}], "default": "A&B"}}, "allOf": [{"if": {"required": ["enable-dual-channel-support"], "properties": {"enable-dual-channel-support": {"const": true}}}, "then": {"properties": {"postfixes-for-ambiguous-pdus-on-channel": false}}}, {"if": {"required": ["enable-dual-channel-support"], "properties": {"enable-dual-channel-support": {"const": false}}}, "then": {"required": ["postfixes-for-ambiguous-pdus-on-channel"], "properties": {"postfixes-for-ambiguous-pdus-on-channel": true}}}], "examples": [{"enable-dual-channel-support": true}, {"enable-dual-channel-support": false, "postfixes-for-ambiguous-pdus-on-channel": "no-postfixes"}]}
venvironment-schema.json
enable-dual-channel-support
If active, PDUs on both channels will be configured with channel mask 'AB' and channel postfixes (e.g. xy_Ch_A, xy_Ch_B) will be created for ambiguous objects.
{"anyOf": [{}, {"type": "boolean"}], "default": true}
venvironment-schema.json
postfixes-for-ambiguous-pdus-on-channel
Definition of postfix settings if dual channel support is not activated.
{"oneOf": [{"enum": ["A", "B", "A&B", "no-postfixes"]}, {}], "default": "A&B"}