Datasets:
dataunitylab
/
json-schema-descriptions

Dataset card Data Studio Files
xet
 Community
1
schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
venvironment-schema.json
application-channel
Index of the Application Channel. Each busytype should provide consecutive indices. Starts counting at 1. Value between 1 and 32. Value '0' is not allowed.
{"anyOf": [{}, {"type": "integer", "minimum": 1, "maximum": 32}]}
venvironment-schema.json
full
A replay block for the CAN protocol.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "required": ["name", "file-path"], "properties": {"name": {}, "when": {}, "file-path": {}, "replay-on-measurement-start": {"anyOf": [{"type": "boolean", "default": true}, {}], "examples": [true, false, "${variable}"]}, "send-system-variables": {"anyOf": [{"type": "boolean", "default": true}, {}], "examples": [true, false, "${variable}"]}, "start-timing-condition": {}, "channel-mapping": {}, "send-tx-messages": {"anyOf": [{"type": "boolean", "default": true}, {}], "examples": [true, false, "${variable}"]}, "send-rx-messages": {"anyOf": [{"type": "boolean", "default": true}, {}], "examples": [true, false, "${variable}"]}}, "examples": [{"name": "ReplayBlock", "file-path": "MyLoggingFile.blf"}, {"name": "ReplayBlock", "file-path": "MyLoggingFile.blf", "when": "SCENARIO_NAME == \"MyScenario\""}, {"name": "ReplayBlock", "file-path": "MyLoggingFile.blf", "replay-on-measurement-start": true, "send-system-variables": false, "send-tx-messages": true, "send-rx-messages": false, "start-timing-condition": {"condition": "immediately"}, "channel-mapping": {"default-mapping": "as-in-original"}}]}
venvironment-schema.json
replay-on-measurement-start
Replay starts with measurement start
{"anyOf": [{"type": "boolean", "default": true}, {}], "examples": [true, false, "${variable}"]}
venvironment-schema.json
send-system-variables
Send system variable values.
{"anyOf": [{"type": "boolean", "default": true}, {}], "examples": [true, false, "${variable}"]}
venvironment-schema.json
send-tx-messages
Replay the tx messages.
{"anyOf": [{"type": "boolean", "default": true}, {}], "examples": [true, false, "${variable}"]}
venvironment-schema.json
send-rx-messages
Replay the rx messages.
{"anyOf": [{"type": "boolean", "default": true}, {}], "examples": [true, false, "${variable}"]}
venvironment-schema.json
full
A replay block for the ethernet protocol.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "required": ["name", "file-path"], "properties": {"name": {}, "when": {}, "file-path": {}, "replay-on-measurement-start": {"anyOf": [{"type": "boolean", "default": true}, {}], "examples": [true, false, "${variable}"]}, "send-system-variables": {"anyOf": [{"type": "boolean", "default": true}, {}], "examples": [true, false, "${variable}"]}, "start-timing-condition": {}, "channel-mapping": {}}, "examples": [{"name": "ReplayBlock", "file-path": "MyLoggingFile.blf"}, {"name": "ReplayBlock", "file-path": "MyLoggingFile.blf", "when": "SCENARIO_NAME == \"MyScenario\""}, {"name": "ReplayBlock", "file-path": "MyLoggingFile.blf", "replay-on-measurement-start": true, "send-system-variables": false, "start-timing-condition": {"condition": "immediately"}, "channel-mapping": {"default-mapping": "as-in-original"}}]}
venvironment-schema.json
replay-on-measurement-start
Replay starts with measurement start
{"anyOf": [{"type": "boolean", "default": true}, {}], "examples": [true, false, "${variable}"]}
venvironment-schema.json
send-system-variables
Send system variable values.
{"anyOf": [{"type": "boolean", "default": true}, {}], "examples": [true, false, "${variable}"]}
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
full
Represents an application used in a scenario
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "required": ["file-path"], "properties": {"when": {}, "file-path": {}, "defines": {}}, "examples": [{"file-path": "path/to/my/file.can", "defines": ["mydefine1", "mydefine=2"]}, {"file-path": "path/to/my/file.can", "defines": ["mydefine1", "mydefine=2"], "when": "SCENARIO_NAME == \"my_scenario_name\""}]}
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
full
Represents a simulation node used in a simulation
{"$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "type": "object", "required": ["name", "network-assignments"], "properties": {"name": {}, "when": {}, "file-path": {}, "network-assignments": {}, "defines": {}, "modeling-libraries": {"type": "array", "items": {}}}, "examples": [{"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
modeling-libraries
For assignment of modeling libraries to this simulation node
{"type": "array", "items": {}}
venvironment-schema.json
full
A Network using the CAN protocol taking part in a simulation.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "required": ["name"], "properties": {"name": {}, "when": {}, "databases": {}, "baudrate": {"anyOf": [{"type": "integer", "minimum": 0, "maximum": 9223372036854775807, "default": 500000}, {}]}, "application-channel": {"anyOf": [{"type": "integer", "minimum": 1, "maximum": 255, "default": 1}, {}]}}, "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
baudrate
Baudrate in Baud.
{"anyOf": [{"type": "integer", "minimum": 0, "maximum": 9223372036854775807, "default": 500000}, {}]}
venvironment-schema.json
application-channel
Index of the Application Channel. Each busytype should provide consecutive indices. Starts counting at 1. Value between 1 and 255. Value '0' is not allowed. Caution: CAN and CANFD share the Application Channels!
{"anyOf": [{"type": "integer", "minimum": 1, "maximum": 255, "default": 1}, {}]}
venvironment-schema.json
full
A Network using the CANFD protocol taking part in a simulation.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "required": ["name"], "properties": {"name": {}, "when": {}, "databases": {}, "mode": {"anyOf": [{"type": "string", "enum": ["iso", "non-iso"], "default": "iso"}, {}]}, "arbitration-baudrate": {"anyOf": [{"type": "integer", "minimum": 0, "maximum": 9223372036854775807, "default": 500000}, {}]}, "data-baudrate": {"anyOf": [{"type": "integer", "minimum": 0, "maximum": 9223372036854775807, "default": 1000000}, {}]}, "application-channel": {"anyOf": [{"type": "integer", "minimum": 1, "maximum": 255, "default": 1}, {}]}}, "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
mode
Operation Mode setting (iso or non-iso Mode).
{"anyOf": [{"type": "string", "enum": ["iso", "non-iso"], "default": "iso"}, {}]}
venvironment-schema.json
arbitration-baudrate
Baudrate for the arbitration phase of CAN FD in Baud.
{"anyOf": [{"type": "integer", "minimum": 0, "maximum": 9223372036854775807, "default": 500000}, {}]}
venvironment-schema.json
data-baudrate
Baudrate for the data phase of CAN FD in Baud.
{"anyOf": [{"type": "integer", "minimum": 0, "maximum": 9223372036854775807, "default": 1000000}, {}]}
venvironment-schema.json
application-channel
Index of the Application Channel. Each busytype should provide consecutive indices. Starts counting at 1. Value between 1 and 255. Value '0' is not allowed. Caution: CAN and CANFD share the Application Channels!
{"anyOf": [{"type": "integer", "minimum": 1, "maximum": 255, "default": 1}, {}]}
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
full
Define to be passed to capl / vcdl.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "string", "pattern": "^([a-zA-Z_]|([a-zA-Z_][a-zA-Z0-9_]*)?\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\})[a-zA-Z0-9_]*(=((0|[1-9][0-9]*)|(\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\})|[Tt]rue|[Ff]alse))?$", "examples": ["mydefine1", "mydefine2", "mydefine_with_value=42", "${var_with_define_name}=${var_with_define_value}"]}
venvironment-schema.json
full
Global configuration for the TCP/IP stack.
{"$schema": "http://json-schema.org/draft-07/schema#", "anyOf": [{"type": "object", "additionalProperties": false, "required": ["selected-stack"], "properties": {"selected-stack": {"anyOf": [{"const": "operating-system"}], "examples": ["canoe", "operating-system"]}}}, {"type": "object", "additionalProperties": false, "required": ["selected-stack"], "properties": {"selected-stack": {"anyOf": [{"const": "canoe"}, {}], "examples": ["canoe", "operating-system"]}, "activate-routing": {}, "tcp-delayed-ack": {}, "ipv4-gateway": {}, "ipv6-gateway": {}}}], "examples": [{"selected-stack": "canoe", "activate-routing": true, "tcp-delayed-ack": true, "ipv4-gateway": "192.168.0.33", "ipv6-gateway": "::1"}, {"selected-stack": "operating-system"}]}
venvironment-schema.json
selected-stack
If set to operating-system, the machines configuration is used. If set to canoe, a custom configuration can be provided
{"anyOf": [{"const": "operating-system"}], "examples": ["canoe", "operating-system"]}
venvironment-schema.json
selected-stack
If set to operating-system, the machines configuration is used. (use 'canoe' if settings should be manually provided)
{"const": "operating-system"}
venvironment-schema.json
selected-stack
If set to operating-system, the machines configuration is used. If set to canoe, a custom configuration can be provided
{"anyOf": [{"const": "canoe"}, {}], "examples": ["canoe", "operating-system"]}
venvironment-schema.json
selected-stack
If set to canoe, a custom configuration can be provided. (remove other elements for option operating-system)
{"const": "canoe"}
venvironment-schema.json
full
Absolute or relative path to a vsysvar file. Relative path specifications are resolved relative to the configuration file.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "string", "anyOf": [{"pattern": "^.*\\.[vV][sS][yY][sS][vV][aA][rR]$"}, {"pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$"}], "examples": ["path/to/my.vsysvar", "${path_in_variable}", "path/${name_in_variable}"]}
venvironment-schema.json
full
A C-identifier for this element (case sensitive)
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "string", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", "examples": ["myid", "THIS_IS_CASE_SENSITIVE", "__1_2_3_4_5__"]}
venvironment-schema.json
full
Absolute or relative path to an external database file (.arxml/.dbc/.ldf). Relative path specifications are resolved relative to the YAML configuration file.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "string", "anyOf": [{"pattern": "^.*\\.[Aa][Rr][Xx][Mm][Ll]$"}, {"pattern": "^.*\\.[Dd][Bb][Cc]$"}, {"pattern": "^.*\\.[Ll][Dd][Ff]$"}, {"pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$"}], "examples": ["path/to/some.dbc", "path/to/some.arxml", "path/to/some.ldf", "path/${var_with_name}", "${var_with_path}"]}
venvironment-schema.json
full
Define the mapping of application channels to an underlying layer.
{"$schema": "http://json-schema.org/draft-07/schema#", "anyOf": [{}, {"const": "internal-simulator"}, {"const": "external-sil-kit"}], "default": "internal-simulator", "examples": ["internal-simulator", "external-sil-kit"]}
venvironment-schema.json
full
Connect application channel to simulated network.
{"const": "internal-simulator"}
venvironment-schema.json
full
Connect application channel to SIL Kit.
{"const": "external-sil-kit"}
venvironment-schema.json
full
Address configuration for an TCP/IP stack.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "properties": {"mac-address": {}, "mtu": {}, "ipv4-settings": {}, "ipv6-settings": {}, "vlans": {}}, "examples": [{"mac-address": "02:84:cf:3b:be:01"}, {"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
Via the key slot configuration it is possible to transmit two start-up/sync frames. Thus an external start-up node is not required for the start-up of a flexray cluster.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "properties": {"slot-1": {}, "slot-2": {}}}
venvironment-schema.json
full
Absolute or relative path to a source file of a simulation node. Relative path specifications are resolved relative to the defining configuration file.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "string", "anyOf": [{"pattern": "^.*\\.[Cc][Aa][Nn]$"}, {"pattern": "^.*\\.[Cc][Aa][Nn][Ee][Nn][Cc][Rr]$"}, {"pattern": "^.*\\.[Cc][Ss]$"}, {"pattern": "^.*\\.[Ss][Ll][Nn]$"}, {"pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$"}], "examples": ["path/to/my_capl_script.can", "path/to/my_encrypted_capl_file.canencr", "path/to/my_dotnet.cs", "path/to/my_visual_studio.sln", "${path_in_variable}", "path/${name_in_variable}"]}
venvironment-schema.json
full
List of networks represented by this application.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"network": "my_can_network_1"}]]}
venvironment-schema.json
full
Absolute or relative path to a vmodule modeling library. Relative path specifications are resolved relative to the configuration file.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "string", "anyOf": [{"pattern": "^.*\\.[vV][mM][oO][dD][uU][lL][eE]$"}, {"pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$"}], "examples": ["CANoeILNLVector.vmodule", "SomeIP_IL.vmodule", "AsrPDUIL2.vmodule", "OSEKNM01.vmodule", "DMOSEKNM.vmodule", "AsrNM30.vmodule", "AsrNM33.vmodule", "AsrUdpNm.vmodule", "AVB_IL.vmodule", "CANoeILNL_AUTOSAR_Eth.vmodule", "LINtp.vmodule", "SCC_ChargePoint.vmodule", "SCC_Monitor.vmodule", "SCC_Vehicle.vmodule", "path/to/my.vmodule", "${path_in_variable}", "path/${name_in_variable}"]}
venvironment-schema.json
full
Simulation node configuration for the TCP/IP stack.
{"$schema": "http://json-schema.org/draft-07/schema#", "anyOf": [{"type": "object", "additionalProperties": false, "required": ["selected-stack"], "properties": {"selected-stack": {"enum": ["operating-system", "canoe"], "default": "individual", "examples": ["operating-system", "canoe", "individual"]}}}, {"type": "object", "additionalProperties": false, "required": ["selected-stack"], "properties": {"selected-stack": {"anyOf": [{"enum": ["individual"]}, {}], "default": "individual", "examples": ["operating-system", "canoe", "individual"]}, "activate-routing": {}, "tcp-delayed-ack": {}, "ipv4-gateway": {}, "ipv6-gateway": {}}}]}
venvironment-schema.json
selected-stack
If set to operating-system, the machines configuration is used. If set to canoe, the configuration on the global level is used (this requires globals-settings/ethernet/tcp-ip-stack/selected-stack to be set to canoe). If set to individual, a custom configuration can be provided
{"enum": ["operating-system", "canoe"], "default": "individual", "examples": ["operating-system", "canoe", "individual"]}
venvironment-schema.json
selected-stack
If set to operating-system, the machines configuration is used. If set to canoe, the configuration on the global level is used (this requires globals-settings/ethernet/tcp-ip-stack/selected-stack to be set to canoe). If set to individual, a custom configuration can be provided
{"anyOf": [{"enum": ["individual"]}, {}], "default": "individual", "examples": ["operating-system", "canoe", "individual"]}
venvironment-schema.json
full
Reference to external datasource files (.vcdl/.vcodm). Absolute or relative path. Relative path specifications are resolved relative to the defining configuration file.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "string", "anyOf": [{"pattern": "^.*\\.[vV][cC][dD][lL]$"}, {"pattern": "^.*\\.[vV][cC][oO][dD][mM]$"}, {"pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$"}], "examples": ["path/to/my.vcdl", "path/to/my.vcodm", "${path_in_variable}", "path/${name_in_variable}"]}
venvironment-schema.json
full
Absolute or relative path to a source file of an application model (can/canencr/cs/sln/py/vmodule). Relative path specifications are resolved relative to the defining configuration file.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "string", "anyOf": [{"pattern": "^.*\\.[Cc][Ss]$"}, {"pattern": "^.*\\.[Pp][Yy]$"}, {"pattern": "^.*\\.[Ss][Ll][Nn]$"}, {"pattern": "^.*\\.[Cc][Aa][Nn]$"}, {"pattern": "^.*\\.[Cc][Aa][Nn][Ee][Nn][Cc][Rr]$"}, {"pattern": "^.*\\.[vV][mM][oO][dD][uU][lL][eE]$"}, {"pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$"}], "examples": ["my_dotnet.cs", "my_python.py", "my_visual_studio.sln", "my_capl_file.can", "my_encrypted_capl_file.canencr", "my_module.vmodule", "${some_variable}"]}
venvironment-schema.json
full
Absolute or relative path to a vmodule file. Relative path specifications are resolved relative to the configuration file.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "string", "anyOf": [{"pattern": "^.*\\.[vV][mM][oO][dD][uU][lL][eE]$"}, {"pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$"}], "examples": ["path/to/my.vmodule", "${path_in_variable}", "path/${name_in_variable}"]}
venvironment-schema.json
full
Absolute or relative path to a xcpcfg file. Relative path specifications are resolved relative to the configuration file.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "string", "anyOf": [{"pattern": "^.*\\.[xX][cC][pP][cC][fF][gG]$"}, {"pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$"}], "examples": ["path/to/my.xcpcfg", "${path_in_variable}", "path/${name_in_variable}"]}
venvironment-schema.json
full
Absolute or relative path to a YAML file. Relative path specifications are resolved relative to the configuration file.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "string", "anyOf": [{"pattern": "^.*\\.[Yy][Aa]?[Mm][Ll]$"}, {"pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$"}], "examples": ["path/to/my.yaml", "path/to/my.yml", "${path_in_variable}", "path/${name_in_variable}"]}
venvironment-schema.json
full
Absolute or relative path to a source file of a functional mockup unit (.fmu). Relative path specifications are resolved relative to the defining configuration file.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "string", "anyOf": [{"pattern": "^.*\\.[Ff][Mm][Uu]$"}, {"pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$"}], "examples": ["my_functional_mockup_unit.fmu", "Inputs/MyFmu.FMU", "${some_variable}"]}
venvironment-schema.json
full
Absolute or relative path to a replay file. Relative path specifications are resolved relative to the configuration file.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "string", "anyOf": [{"pattern": "^.*\\.[bB][lL][fF]$"}, {"pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$"}], "examples": ["path/to/my.blf", "${path_in_variable}", "path/${name_in_variable}"]}
venvironment-schema.json
full
Timing conditions for a replay block.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "required": [], "properties": {"condition": {"anyOf": [{"const": "immediately"}, {"const": "first-event-time"}, {"const": "delayed"}, {}]}, "delay-ms": {}}, "examples": [{"condition": "immediately"}, {"condition": "first-event-time"}, {"condition": "delayed", "delay-ms": 1000}, {"condition": "${variable}"}]}
venvironment-schema.json
condition
The condition when the replay shall start.
{"anyOf": [{"const": "immediately"}, {"const": "first-event-time"}, {"const": "delayed"}, {}]}
venvironment-schema.json
condition
The first event of the replayed file occurs with measurement start.
{"const": "immediately"}
venvironment-schema.json
condition
The original timestamp of the replayed file are used.
{"const": "first-event-time"}
venvironment-schema.json
condition
The first event is delayed. Can be configured by the 'delayed-ms' element.
{"const": "delayed"}
venvironment-schema.json
delay-ms
The delay in ms if the condition 'delayed' is selected. No effect otherwise.
{}
venvironment-schema.json
full
The channel mapping for a replay block.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "required": [], "properties": {"default-mapping": {"anyOf": [{"const": "as-in-original"}, {"const": "ignore-all"}, {}]}, "mappings": {"type": "array", "items": {"anyOf": [{"type": "object", "additionalProperties": false, "required": ["source-channel", "target-network"], "properties": {"source-channel": {}, "target-network": {"anyOf": [{}, {}]}}}, {"type": "object", "additionalProperties": false, "required": ["source-network", "target-network"], "properties": {"source-network": {"type": "string"}, "target-network": {"anyOf": [{}, {}]}}}, {"type": "object", "additionalProperties": false, "required": ["ignore-source-channel"], "properties": {"ignore-source-channel": {}}}, {"type": "object", "additionalProperties": false, "required": ["ignore-source-network"], "properties": {"ignore-source-network": {"type": "string"}}}]}}}, "examples": [{"default-mapping": "as-in-original"}, {"default-mapping": "ignore-all", "mappings": [{"source-channel": 1, "target-network": "CAN1"}]}, {"default-mapping": "as-in-original", "mappings": [{"source-network": "CAN1", "target-network": "CAN2"}]}, {"default-mapping": "as-in-original", "mappings": [{"ignore-source-channel": 2}, {"ignore-source-network": "CAN4"}]}]}
venvironment-schema.json
default-mapping
The default mapping of a channel if it is not explicitely mapped.
{"anyOf": [{"const": "as-in-original"}, {"const": "ignore-all"}, {}]}
venvironment-schema.json
default-mapping
The channel is mapped to itself if there is an active network.
{"const": "as-in-original"}
venvironment-schema.json
default-mapping
The channels are ignored by default.
{"const": "ignore-all"}
venvironment-schema.json
mappings
The explicitly mapped channels. Overwrites the default mapping for the source.
{"type": "array", "items": {"anyOf": [{"type": "object", "additionalProperties": false, "required": ["source-channel", "target-network"], "properties": {"source-channel": {}, "target-network": {"anyOf": [{}, {}]}}}, {"type": "object", "additionalProperties": false, "required": ["source-network", "target-network"], "properties": {"source-network": {"type": "string"}, "target-network": {"anyOf": [{}, {}]}}}, {"type": "object", "additionalProperties": false, "required": ["ignore-source-channel"], "properties": {"ignore-source-channel": {}}}, {"type": "object", "additionalProperties": false, "required": ["ignore-source-network"], "properties": {"ignore-source-network": {"type": "string"}}}]}}
venvironment-schema.json
items
Mapping from application channel of the replay file to a target network.
{"type": "object", "additionalProperties": false, "required": ["source-channel", "target-network"], "properties": {"source-channel": {}, "target-network": {"anyOf": [{}, {}]}}}
venvironment-schema.json
source-channel
The source application channel from the replayed file.
{}
venvironment-schema.json
target-network
The target network name.
{"anyOf": [{}, {}]}
venvironment-schema.json
items
Mapping from a named source network of the replay file to a named target network.
{"type": "object", "additionalProperties": false, "required": ["source-network", "target-network"], "properties": {"source-network": {"type": "string"}, "target-network": {"anyOf": [{}, {}]}}}
venvironment-schema.json
source-network
The source network name. Only works if the replay file was created by CANoe and contains the relevant metadata.
{"type": "string"}
venvironment-schema.json
target-network
The target network name.
{"anyOf": [{}, {}]}
venvironment-schema.json
items
Ignores an application channel of the replay file.
{"type": "object", "additionalProperties": false, "required": ["ignore-source-channel"], "properties": {"ignore-source-channel": {}}}
venvironment-schema.json
ignore-source-channel
The ignored source channel.
{}
venvironment-schema.json
items
Ignores a named source network of the replay file.
{"type": "object", "additionalProperties": false, "required": ["ignore-source-network"], "properties": {"ignore-source-network": {"type": "string"}}}
venvironment-schema.json
ignore-source-network
The ignored source network name. Only works if the replay file was created by CANoe and contains the relevant metadata.
{"type": "string"}
venvironment-schema.json
full
Absolute or relative path to a vmodule file. Relative path specifications are resolved relative to the configuration file.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "string", "anyOf": [{"pattern": "^.*\\.[vV][mM][oO][dD][uU][lL][eE]$"}, {"pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$"}], "examples": ["CANoeILNLVector.vmodule", "SomeIP_IL.vmodule", "AsrPDUIL2.vmodule", "OSEKNM01.vmodule", "DMOSEKNM.vmodule", "AsrNM30.vmodule", "AsrNM33.vmodule", "AsrUdpNm.vmodule", "AVB_IL.vmodule", "CANoeILNL_AUTOSAR_Eth.vmodule", "SCC_ChargePoint.vmodule", "SCC_Monitor.vmodule", "SCC_Vehicle.vmodule", "path/to/my.vmodule", "${path_in_variable}", "path/${name_in_variable}"]}
venvironment-schema.json
full
Global configuration for the TCP/IP stack.
{"$schema": "http://json-schema.org/draft-07/schema#", "anyOf": [{"type": "object", "additionalProperties": false, "required": ["selected-stack"], "properties": {"selected-stack": {"anyOf": [{"const": "operating-system"}], "examples": ["canoe", "operating-system"]}}}, {"type": "object", "additionalProperties": false, "required": ["selected-stack"], "properties": {"selected-stack": {"anyOf": [{"const": "canoe"}, {}], "examples": ["canoe", "operating-system"]}, "activate-routing": {}, "tcp-delayed-ack": {}, "timestamp-option-RFC1323": {}, "ttl": {}, "ipv4-gateway": {}, "ipv6-gateway": {}}}]}
venvironment-schema.json
selected-stack
If set to operating-system, the machines configuration is used. If set to canoe, a custom configuration can be provided
{"anyOf": [{"const": "operating-system"}], "examples": ["canoe", "operating-system"]}
venvironment-schema.json
selected-stack
If set to operating-system, the machines configuration is used. (use 'canoe' if settings should be manually provided)
{"const": "operating-system"}
venvironment-schema.json
selected-stack
If set to operating-system, the machines configuration is used. If set to canoe, a custom configuration can be provided
{"anyOf": [{"const": "canoe"}, {}], "examples": ["canoe", "operating-system"]}
venvironment-schema.json
selected-stack
If set to canoe, a custom configuration can be provided. (remove other elements for option operating-system)
{"const": "canoe"}
venvironment-schema.json
full
Absolute or relative path to a source file of an application model (can/cs/sln/py/vmodule). Relative path specifications are resolved relative to the defining configuration file.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "string", "anyOf": [{"pattern": "^.*\\.[Cc][Ss]$"}, {"pattern": "^.*\\.[Pp][Yy]$"}, {"pattern": "^.*\\.[Ss][Ll][Nn]$"}, {"pattern": "^.*\\.[Cc][Aa][Nn]$"}, {"pattern": "^.*\\.[vV][mM][oO][dD][uU][lL][eE]$"}, {"pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$"}], "examples": ["my_dotnet.cs", "my_python.py", "my_visual_studio.sln", "my_caplfile.can", "my_module.vmodule", "${some_variable}"]}
venvironment-schema.json
full
Absolute or relative path to a source file of a simulation node. Relative path specifications are resolved relative to the defining configuration file.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "string", "anyOf": [{"pattern": "^.*\\.[Cc][Aa][Nn]$"}, {"pattern": "^.*\\.[Cc][Ss]$"}, {"pattern": "^.*\\.[Ss][Ll][Nn]$"}, {"pattern": "^.*\\$\\{[a-zA-Z_][a-zA-Z0-9_]*\\}$"}], "examples": ["path/to/my_capl_script.can", "path/to/my_dotnet.cs", "path/to/my_visual_studio.sln", "${path_in_variable}", "path/${name_in_variable}"]}
venvironment-schema.json
full
List of network nodes represented by this application
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [[{"network": "my_can_network_1"}], [{"network": "my_can_network_1", "lin-role": "master"}, {"network": "my_can_network_1", "lin-role": ["master", "config-tester"]}, {"network": "my_can_network_1", "database-node": {"database": "mydatabase", "node": "mynode"}}]]}
venvironment-schema.json
full
Simulation node configuration for the TCP/IP stack.
{"$schema": "http://json-schema.org/draft-07/schema#", "anyOf": [{"type": "object", "additionalProperties": false, "required": ["selected-stack"], "properties": {"selected-stack": {"enum": ["operating-system", "canoe"], "default": "individual", "examples": ["operating-system", "canoe", "individual"]}}}, {"type": "object", "additionalProperties": false, "required": ["selected-stack"], "properties": {"selected-stack": {"anyOf": [{"enum": ["individual"]}, {}], "default": "individual", "examples": ["operating-system", "canoe", "individual"]}, "activate-routing": {}, "tcp-delayed-ack": {}, "timestamp-option-RFC1323": {}, "ttl": {}, "ipv4-gateway": {}, "ipv6-gateway": {}}}]}
venvironment-schema.json
selected-stack
If set to operating-system, the machines configuration is used. If set to canoe, the configuration on the global level is used (this requires globals-settings/ethernet-settings/tcp-ip-stack/selected-stack to be set to canoe). If set to individual, a custom configuration can be provided
{"enum": ["operating-system", "canoe"], "default": "individual", "examples": ["operating-system", "canoe", "individual"]}
venvironment-schema.json
selected-stack
If set to operating-system, the machines configuration is used. If set to canoe, the configuration on the global level is used (this requires globals-settings/ethernet-settings/tcp-ip-stack/selected-stack to be set to canoe). If set to individual, a custom configuration can be provided
{"anyOf": [{"enum": ["individual"]}, {}], "default": "individual", "examples": ["operating-system", "canoe", "individual"]}
venvironment-schema.json
full
A list of C-identifiers for referenced elements (case sensitive)
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "array", "items": {}, "examples": [["myid"], ["THIS_IS_CASE_SENSITIVE", "__1_2_3_4_5__"], ["${id_in_variable}", "prefix_${infix_in_variable}_suffix"]]}
venvironment-schema.json
full
Define the mapping of application channels to an underlying layer
{"$schema": "http://json-schema.org/draft-07/schema#", "anyOf": [{}, {"const": "internal-simulator"}, {"const": "external-sil-kit"}], "default": "internal-simulator", "examples": ["internal-simulator", "external-sil-kit"]}
venvironment-schema.json
full
Connect application channel to simulated network.
{"const": "internal-simulator"}
venvironment-schema.json
full
Connect application channel to SIL Kit.
{"const": "external-sil-kit"}
venvironment-schema.json
full
Timing conditions for a replay block.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "required": [], "properties": {"condition": {"anyOf": [{"const": "immediately"}, {"const": "first-event-time"}, {"const": "delayed"}, {}]}, "delay-ms": {"anyOf": [{"type": "integer", "minimum": 0, "maximum": 9223372036854775807, "default": 0}, {}]}}, "examples": [{"condition": "immediately"}, {"condition": "first-event-time"}, {"condition": "delayed", "delay-ms": 1000}, {"condition": "${variable}"}]}
venvironment-schema.json
condition
The condition when the replay shall start.
{"anyOf": [{"const": "immediately"}, {"const": "first-event-time"}, {"const": "delayed"}, {}]}
venvironment-schema.json
condition
The first event of the replayed file occurs with measurement start.
{"const": "immediately"}
venvironment-schema.json
condition
The original timestamp of the replayed file are used.
{"const": "first-event-time"}
venvironment-schema.json
condition
The first event is delayed. Can be configured by the 'delayed-ms' element.
{"const": "delayed"}
venvironment-schema.json
delay-ms
The delay in ms if the condition 'delayed' is selected. No effect otherwise.
{"anyOf": [{"type": "integer", "minimum": 0, "maximum": 9223372036854775807, "default": 0}, {}]}
venvironment-schema.json
full
The channel mapping for a replay block.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "additionalProperties": false, "required": [], "properties": {"default-mapping": {"anyOf": [{"const": "as-in-original"}, {"const": "ignore-all"}, {}]}, "mappings": {"type": "array", "items": {"anyOf": [{"type": "object", "additionalProperties": false, "required": ["source-channel", "target-network"], "properties": {"source-channel": {"anyOf": [{"type": "integer", "minimum": 0, "maximum": 65535, "default": 0}, {}]}, "target-network": {"anyOf": [{}, {}]}}}, {"type": "object", "additionalProperties": false, "required": ["source-network", "target-network"], "properties": {"source-network": {"type": "string"}, "target-network": {"anyOf": [{}, {}]}}}, {"type": "object", "additionalProperties": false, "required": ["ignore-source-channel"], "properties": {"ignore-source-channel": {"anyOf": [{"type": "integer", "minimum": 0, "maximum": 65535, "default": 0}, {}]}}}, {"type": "object", "additionalProperties": false, "required": ["ignore-source-network"], "properties": {"ignore-source-network": {"type": "string"}}}]}}}, "examples": [{"default-mapping": "as-in-original"}, {"default-mapping": "ignore-all", "mappings": [{"source-channel": 1, "target-network": "CAN1"}]}, {"default-mapping": "as-in-original", "mappings": [{"source-network": "CAN1", "target-network": "CAN2"}]}, {"default-mapping": "as-in-original", "mappings": [{"ignore-source-channel": 2}, {"ignore-source-network": "CAN4"}]}]}
venvironment-schema.json
default-mapping
The default mapping of a channel if it is not explicitely mapped.
{"anyOf": [{"const": "as-in-original"}, {"const": "ignore-all"}, {}]}
venvironment-schema.json
default-mapping
The channel is mapped to itself if there is an active network.
{"const": "as-in-original"}
venvironment-schema.json
default-mapping
The channels are ignored by default.
{"const": "ignore-all"}
venvironment-schema.json
mappings
The explicitly mapped channels. Overwrites the default mapping for the source.
{"type": "array", "items": {"anyOf": [{"type": "object", "additionalProperties": false, "required": ["source-channel", "target-network"], "properties": {"source-channel": {"anyOf": [{"type": "integer", "minimum": 0, "maximum": 65535, "default": 0}, {}]}, "target-network": {"anyOf": [{}, {}]}}}, {"type": "object", "additionalProperties": false, "required": ["source-network", "target-network"], "properties": {"source-network": {"type": "string"}, "target-network": {"anyOf": [{}, {}]}}}, {"type": "object", "additionalProperties": false, "required": ["ignore-source-channel"], "properties": {"ignore-source-channel": {"anyOf": [{"type": "integer", "minimum": 0, "maximum": 65535, "default": 0}, {}]}}}, {"type": "object", "additionalProperties": false, "required": ["ignore-source-network"], "properties": {"ignore-source-network": {"type": "string"}}}]}}
venvironment-schema.json
items
Mapping from application channel of the replay file to a target network.
{"type": "object", "additionalProperties": false, "required": ["source-channel", "target-network"], "properties": {"source-channel": {"anyOf": [{"type": "integer", "minimum": 0, "maximum": 65535, "default": 0}, {}]}, "target-network": {"anyOf": [{}, {}]}}}
venvironment-schema.json
source-channel
The source application channel from the replayed file.
{"anyOf": [{"type": "integer", "minimum": 0, "maximum": 65535, "default": 0}, {}]}