SIL Kit Participant Configuration

Configuration file for a Vector SIL Kit Participant

Type object
File match silkit.json silkit.yaml *.silkit.json *.silkit.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/sil-kit-participant-configuration/latest.json
Source https://www.schemastore.org/sil-kit-participant-configuration.json

Validate with Lintel

npx @lintel/lintel check
Type: object

JSON schema for SIL Kit Participant configuration files

Properties

$schema string

The schema file

Default: ""
Examples: "./ParticipantConfiguration.schema.json"
schemaVersion integer | string

Version of the schema used to validate this document

Default: 0
Description string

Free text commenting on or summarizing this configuration. Optional

Default: ""
ParticipantName string

Name of the participant

CanControllers object[]

Reconfigures the CanControllers of the participant

LinControllers object[]

Reconfigures the LinControllers of the participant

FlexrayControllers FlexrayController[]

Reconfigures the FlexrayControllers of the participant

EthernetControllers object[]

Reconfigures the EthernetControllers of the participant

DataPublishers object[]

Reconfigures the DataPublishers of the participant

DataSubscribers object[]

Reconfigures the DataSubscribers of the participant

RpcClients object[]

Reconfigures the RpcClients of the participant

RpcServers object[]

Reconfigures the RpcServers of the participant

Logging object

Configures the properties of the SIL Kit Logging Service

3 nested properties
Sinks object[] required
LogFromRemotes boolean

Enables receiving of remote log messages from other participants

Default: false
Examples: false, true
FlushLevel string
Values: "Critical" "Error" "Warn" "Info" "Debug" "Trace" "Off"
Examples: "Critical", "Error", "Warn", "Info", "Debug", "Trace", "Off"
HealthCheck object

Node to configure properties to determine the health status of the simulation

2 nested properties
SoftResponseTimeout integer

If a simulation step is not finished before this limit, a warning is logged. Optional; Unit is in milliseconds

Examples: 500
HardResponseTimeout integer

If a simulation step is not finished before this limit, the participant enters error state. Optional; Unit is in milliseconds

Examples: 5000
Tracing object

Configures the tracing service of the participant

2 nested properties
TraceSinks object[]
TraceSources object[]
Extensions object

Optional configuration for the extension loading mechanism

1 nested properties
SearchPathHints string[]
Examples: "path/to/extensions1", "path/to/extensions2"
Includes object

Optional configuration to include other participant configurations files

2 nested properties
SearchPathHints string[]
Files string[]
Middleware object

Optional configuration of the SIL Kit middleware

6 nested properties
RegistryUri string
Default: "silkit://localhost:8500"
Examples: "silkit://0.0.0.0:8501", "silkit://localhost:8500"
ConnectAttempts integer
Default: 1
TcpNoDelay boolean
Default: true
TcpQuickAck boolean
Default: false
TcpSendBufferSize integer
Examples: 3456
TcpReceiveBufferSize integer
Examples: 3456

Definitions

Description string

Free text commenting on or summarizing this configuration. Optional

Name string

Name of the endpoint

Network string

Name of the network. Optional; Defaults to the endpoint name

UseTraceSinks array

Names of trace sinks to use

Examples:
  • "Sink1"
Replay object
UseTraceSource string

Name of a trace source used as a simulation message source for this controller

Examples: "Source1"
Direction string

Filter messages to use from the trace source by their direction. May be Send, Receive or Both

Values: "Send" "Receive" "Both"
Examples: "Send", "Receive", "Both"
MdfChannel object
6 nested properties
ChannelName string

Name of an MDF channel in the trace source

Examples: "MyTestChannel1"
ChannelSource string

Name of an MDF channel's source information object

Examples: "path/to/myTestChannel1"
ChannelPath string

Path of an MDF channel's source information object

Examples: "MyTestChannel"
GroupName string

Name of an MDF channel group

Examples: "MyTestGroup"
GroupSource string

Name of an MDF channel group's source information object

Examples: "path/to/myTestGroup1"
GroupPath string

Path of an MDF channel group's source information object

Examples: "MyTestGroup"
FlexrayClusterParameters object
gColdstartAttempts integer

Number of attempts for a cold start before giving up (range 2-31)

Examples: 8
min=2max=31
gCycleCountMax integer

Max cycle count value in a given cluster (range 7-63, must be an odd integer)

Examples: 63
min=7max=63
gdActionPointOffset integer

Time offset for a static slot in macroticks (range 1 - 63)

Examples: 2
min=1max=63
gdDynamicSlotIdlePhase integer

Duration of the idle phase within a dynamic slot in gdMiniSlots (range 0 - 2)

Examples: 1
min=0max=2
gdMiniSlot integer

Duration of a mini slot in macroticks (2 - 63)

Examples: 5
min=2max=63
gdMiniSlotActionPointOffset integer

Time offset for a mini slot in macroticks (range 1- 31)

Examples: 2
min=1max=31
gdStaticSlot integer

Duration of a static slot in macroticks (range 3 - 664)

Examples: 31
min=3max=664
gdSymbolWindow integer

Duration of the symbol window in macroticks (range 0 - 162)

Examples: 1
min=0max=162
gdSymbolWindowActionPointOffset integer

Time offset for a static symbol windows in macroticks (range 1 - 63)

Examples: 1
min=1max=63
gdTSSTransmitter integer

Duration of TSS (Transmission Start Sequence) in gdBits (range 1 - 15)

Examples: 9
min=1max=15
gdWakeupTxActive integer

Duration of LOW Phase of a wakeup symbol in gdBit (range 15 - 60)

Examples: 60
min=15max=60
gdWakeupTxIdle integer

Duration of the idle of a wakeup symbol in gdBit (45 - 180)

Examples: 180
min=45max=180
gListenNoise integer

Upper limit for the startup listen timeout and wakeup listen timeout in the presence of noise; Used as a multiplier of pdListenTimeout (range 2 - 16)

Examples: 2
min=2max=16
gMacroPerCycle integer

Number of macroticks per cycle (range 8 - 16000)

Examples: 3636
min=8max=16000
gMaxWithoutClockCorrectionFatal integer

Threshold used for testing the vClockCorrectionFailed counter (range 1 - 15)

Examples: 2
min=1max=15
gMaxWithoutClockCorrectionPassive integer

Threshold used for testing the vClockCorrectionFailed counter (range 1 - 15)

Examples: 2
min=1max=15
gNumberOfMiniSlots integer

Number of mini slots (range 0 - 7988)

Examples: 291
min=0max=7988
gNumberOfStaticSlots integer

Number of static slots in a cycle (range 2 - 1023)

Examples: 70
min=2max=1023
gPayloadLengthStatic integer

Length of the payload of a static frame in 16-Bits words (range 0 - 127)

Examples: 16
min=0max=127
gSyncFrameIDCountMax integer

Maximum number of distinct sync frame identifiers present in a given cluster (range 2 - 15)

Examples: 15
min=2max=15
FlexrayNodeParameters object
pAllowHaltDueToClock integer

Controls the transition to halt state due to clock synchronization errors. (values 0, 1)

Examples: 1
min=0max=1
pAllowPassiveToActive integer

Required number of consecutive even / odd cycle pairs for normal passive to normal active (range 0 - 31)

Examples: 0
min=0max=31
pChannels string

Channel(s) to which the controller is connected

Values: "A" "B" "AB" "None"
Examples: "AB"
pClusterDriftDamping integer

Cluster drift damping factor for rate correction in microticks (range 0 - 10)

Examples: 2
min=0max=10
pdAcceptedStartupRange integer

Allowed deviation for startup frames during integration in microticks (range 29 - 2743)

Examples: 212
min=29max=2743
pdListenTimeout integer

Duration of listen phase in microticks (range 1926 - 2567692)

Examples: 400162
min=1926max=2567692
pKeySlotId integer

Slot ID of the key slot (range 0 - 1023; value 0 means that there is no key slot)

Examples: 10
min=0max=1023
pKeySlotOnlyEnabled integer

Shall the node enter key slot only mode after startup. (values 0, 1) (AUTOSAR pSingleSlotEnabled)

Examples: 0
min=0max=1
pKeySlotUsedForStartup integer

Key slot is used for startup (values 0, 1)

Examples: 1
min=0max=1
pKeySlotUsedForSync integer

Key slot is used for sync (values 0, 1)

Examples: 0
min=0max=1
pLatestTx integer

Last mini slot which can be transmitted (range 0 - 7988)

Examples: 249
min=0max=7988
pMacroInitialOffsetA integer

Initial startup offset for frame reference point on channel A (range 2 - 68 macroticks)

Examples: 3
min=2max=68
pMacroInitialOffsetB integer

Initial startup offset for frame reference point on channel B (range 2 - 68 macroticks)

Examples: 3
min=2max=68
pMicroInitialOffsetA integer

Offset between secondary time reference and MT boundary (range 0 - 239 microticks)

Examples: 6
min=0max=239
pMicroInitialOffsetB integer

Offset between secondary time reference and MT boundary (range 0 - 239 microticks)

Examples: 6
min=0max=239
pMicroPerCycle integer

Nominal number of microticks in the communication cycle (range 960 - 1280000)

Examples: 200000
min=960max=1280000
pOffsetCorrectionOut integer

Maximum permissible offset correction value (range 15 - 16082 microticks)

Examples: 127
min=15max=16082
pOffsetCorrectionStart integer

Start of the offset correction phase within the NIT, (7 - 15999 macroticks)

Examples: 3632
min=7max=15999
pRateCorrectionOut integer

Maximum permissible rate correction value (range 3 - 3846 microticks)

Examples: 81
min=3max=3846
pWakeupChannel string

Channel used by the node to send a wakeup pattern

Values: "A" "B"
Examples: "A"
pWakeupPattern integer

Number of repetitions of the wakeup symbol (range 0 - 63, value 0 or 1 prevents sending of WUP)

Examples: 33
min=0max=63
pdMicrotick string

Duration of a FlexRay microtick

Values: "12.5ns" "25ns" "50ns"
Examples: "25ns"
pSamplesPerMicrotick integer

Number of samples per microtick (values 1, 2)

Examples: 2
min=1max=2
FlexrayTxBufferConfigurations object[]
FlexrayController object
Name string required

Name of the endpoint

Network string

Name of the network. Optional; Defaults to the endpoint name

UseTraceSinks array

Names of trace sinks to use

Examples: "Sink1"
Replay object
3 nested properties
UseTraceSource string

Name of a trace source used as a simulation message source for this controller

Examples: "Source1"
Direction string

Filter messages to use from the trace source by their direction. May be Send, Receive or Both

Values: "Send" "Receive" "Both"
Examples: "Send", "Receive", "Both"
MdfChannel object
6 nested properties
ChannelName string

Name of an MDF channel in the trace source

Examples: "MyTestChannel1"
ChannelSource string

Name of an MDF channel's source information object

Examples: "path/to/myTestChannel1"
ChannelPath string

Path of an MDF channel's source information object

Examples: "MyTestChannel"
GroupName string

Name of an MDF channel group

Examples: "MyTestGroup"
GroupSource string

Name of an MDF channel group's source information object

Examples: "path/to/myTestGroup1"
GroupPath string

Path of an MDF channel group's source information object

Examples: "MyTestGroup"
ClusterParameters object
20 nested properties
gColdstartAttempts integer

Number of attempts for a cold start before giving up (range 2-31)

Examples: 8
min=2max=31
gCycleCountMax integer

Max cycle count value in a given cluster (range 7-63, must be an odd integer)

Examples: 63
min=7max=63
gdActionPointOffset integer

Time offset for a static slot in macroticks (range 1 - 63)

Examples: 2
min=1max=63
gdDynamicSlotIdlePhase integer

Duration of the idle phase within a dynamic slot in gdMiniSlots (range 0 - 2)

Examples: 1
min=0max=2
gdMiniSlot integer

Duration of a mini slot in macroticks (2 - 63)

Examples: 5
min=2max=63
gdMiniSlotActionPointOffset integer

Time offset for a mini slot in macroticks (range 1- 31)

Examples: 2
min=1max=31
gdStaticSlot integer

Duration of a static slot in macroticks (range 3 - 664)

Examples: 31
min=3max=664
gdSymbolWindow integer

Duration of the symbol window in macroticks (range 0 - 162)

Examples: 1
min=0max=162
gdSymbolWindowActionPointOffset integer

Time offset for a static symbol windows in macroticks (range 1 - 63)

Examples: 1
min=1max=63
gdTSSTransmitter integer

Duration of TSS (Transmission Start Sequence) in gdBits (range 1 - 15)

Examples: 9
min=1max=15
gdWakeupTxActive integer

Duration of LOW Phase of a wakeup symbol in gdBit (range 15 - 60)

Examples: 60
min=15max=60
gdWakeupTxIdle integer

Duration of the idle of a wakeup symbol in gdBit (45 - 180)

Examples: 180
min=45max=180
gListenNoise integer

Upper limit for the startup listen timeout and wakeup listen timeout in the presence of noise; Used as a multiplier of pdListenTimeout (range 2 - 16)

Examples: 2
min=2max=16
gMacroPerCycle integer

Number of macroticks per cycle (range 8 - 16000)

Examples: 3636
min=8max=16000
gMaxWithoutClockCorrectionFatal integer

Threshold used for testing the vClockCorrectionFailed counter (range 1 - 15)

Examples: 2
min=1max=15
gMaxWithoutClockCorrectionPassive integer

Threshold used for testing the vClockCorrectionFailed counter (range 1 - 15)

Examples: 2
min=1max=15
gNumberOfMiniSlots integer

Number of mini slots (range 0 - 7988)

Examples: 291
min=0max=7988
gNumberOfStaticSlots integer

Number of static slots in a cycle (range 2 - 1023)

Examples: 70
min=2max=1023
gPayloadLengthStatic integer

Length of the payload of a static frame in 16-Bits words (range 0 - 127)

Examples: 16
min=0max=127
gSyncFrameIDCountMax integer

Maximum number of distinct sync frame identifiers present in a given cluster (range 2 - 15)

Examples: 15
min=2max=15
NodeParameters object
23 nested properties
pAllowHaltDueToClock integer

Controls the transition to halt state due to clock synchronization errors. (values 0, 1)

Examples: 1
min=0max=1
pAllowPassiveToActive integer

Required number of consecutive even / odd cycle pairs for normal passive to normal active (range 0 - 31)

Examples: 0
min=0max=31
pChannels string

Channel(s) to which the controller is connected

Values: "A" "B" "AB" "None"
Examples: "AB"
pClusterDriftDamping integer

Cluster drift damping factor for rate correction in microticks (range 0 - 10)

Examples: 2
min=0max=10
pdAcceptedStartupRange integer

Allowed deviation for startup frames during integration in microticks (range 29 - 2743)

Examples: 212
min=29max=2743
pdListenTimeout integer

Duration of listen phase in microticks (range 1926 - 2567692)

Examples: 400162
min=1926max=2567692
pKeySlotId integer

Slot ID of the key slot (range 0 - 1023; value 0 means that there is no key slot)

Examples: 10
min=0max=1023
pKeySlotOnlyEnabled integer

Shall the node enter key slot only mode after startup. (values 0, 1) (AUTOSAR pSingleSlotEnabled)

Examples: 0
min=0max=1
pKeySlotUsedForStartup integer

Key slot is used for startup (values 0, 1)

Examples: 1
min=0max=1
pKeySlotUsedForSync integer

Key slot is used for sync (values 0, 1)

Examples: 0
min=0max=1
pLatestTx integer

Last mini slot which can be transmitted (range 0 - 7988)

Examples: 249
min=0max=7988
pMacroInitialOffsetA integer

Initial startup offset for frame reference point on channel A (range 2 - 68 macroticks)

Examples: 3
min=2max=68
pMacroInitialOffsetB integer

Initial startup offset for frame reference point on channel B (range 2 - 68 macroticks)

Examples: 3
min=2max=68
pMicroInitialOffsetA integer

Offset between secondary time reference and MT boundary (range 0 - 239 microticks)

Examples: 6
min=0max=239
pMicroInitialOffsetB integer

Offset between secondary time reference and MT boundary (range 0 - 239 microticks)

Examples: 6
min=0max=239
pMicroPerCycle integer

Nominal number of microticks in the communication cycle (range 960 - 1280000)

Examples: 200000
min=960max=1280000
pOffsetCorrectionOut integer

Maximum permissible offset correction value (range 15 - 16082 microticks)

Examples: 127
min=15max=16082
pOffsetCorrectionStart integer

Start of the offset correction phase within the NIT, (7 - 15999 macroticks)

Examples: 3632
min=7max=15999
pRateCorrectionOut integer

Maximum permissible rate correction value (range 3 - 3846 microticks)

Examples: 81
min=3max=3846
pWakeupChannel string

Channel used by the node to send a wakeup pattern

Values: "A" "B"
Examples: "A"
pWakeupPattern integer

Number of repetitions of the wakeup symbol (range 0 - 63, value 0 or 1 prevents sending of WUP)

Examples: 33
min=0max=63
pdMicrotick string

Duration of a FlexRay microtick

Values: "12.5ns" "25ns" "50ns"
Examples: "25ns"
pSamplesPerMicrotick integer

Number of samples per microtick (values 1, 2)

Examples: 2
min=1max=2
TxBufferConfigurations object[]
FlexrayControllers FlexrayController[]

Reconfigures the FlexrayControllers of the participant

Topic string

Name of the communication channel between DataPublisher and DataSubscribers

RpcFunctionName string

Name of the RPC function called by RpcClients on RpcServers

Logging object

Configures the properties of the SIL Kit Logging Service

Sinks object[] required
LogFromRemotes boolean

Enables receiving of remote log messages from other participants

Default: false
Examples: false, true
FlushLevel string
Values: "Critical" "Error" "Warn" "Info" "Debug" "Trace" "Off"
Examples: "Critical", "Error", "Warn", "Info", "Debug", "Trace", "Off"