vspyx.Communication
Subpackages
Package Contents
Classes
AUTOSARDataPrototype |
|
AUTOSARDataType |
|
The endpoint on an ECU in terms of application addressing |
|
Architecture |
|
Used to signal to a communication controller that the transmit buffer |
|
Represents a CAN channel interface |
|
Represents a CAN cluster |
|
Represents a connection between an ECU and a CAN bus interface |
|
Represents a CAN controller device interface |
|
CANDataLinkPDUPoint |
|
Represents a processor which handles PDU points containing CAN frames |
|
CANErrorCountsPoint |
|
Represents the CAN-specific layout of a frame object |
|
CANFramePoint |
|
Represents the timing and channel identification info relating to a transmitted CAN frame |
|
CPPImplementationDataType |
|
CPPImplementationDataTypeElement |
|
A Channel is the transmission medium that is used to send and receive information between |
|
Cluster is the main element to describe the topological connection of communicating ECUs. |
|
A Runtime::Point which holds extra information not visible from the Runtime module |
|
Represents a basic runtime component within the Communication runtime domain |
|
An ECU uses Connector elements in order to describe its bus interfaces and |
|
The Ecu communication relationship defines which signals, Pdus and frames are actually received and |
|
Represents a communication container PDU, defined to contain other PDUs |
|
ContainerIPDUPoint |
|
Controller is a dedicated hardware device by means of which hosts are sending |
|
Represents the CANdbc network topology and message specification |
|
Represents PDU level data point runtime access interface |
|
Represents PDU level data point runtime access interface |
|
A PDUPoint that also holds a header of bytes |
|
Represents a diagnostics communication PDU |
|
ECU describes the presence of a microcontroller in the vehicle. |
|
EthernetChannel |
|
EthernetCluster |
|
EthernetConnector |
|
EthernetController |
|
EthernetDiscoveryProcessor |
|
EthernetFrame |
|
EthernetFrameTriggering |
|
Field |
|
FlexRayBufferUpdatePoint |
|
FlexRayChannel |
|
FlexRayCluster |
|
FlexRayConnector |
|
FlexRayController |
|
FlexRayDataLinkPDUPoint |
|
FlexRayDiscoveryProcessor |
|
FlexRayFrame |
|
FlexRayFrameTriggering |
|
A Frame represents a general design object that is used |
|
FramePoint |
|
FramePort |
|
FrameTriggering describes the instance of a frame sent on a channel and defines the manner of |
|
Represents a general purpose interaction PDU used for XCP, SOME/IP segments, or DLT |
|
Represents a general purpose PDU used for DoIP, service discovery, or global timing |
|
IPDU represents any type of PDU that the Communication system can interact with |
|
Represents the PDU-specific triggered data binding related to a transmitted PDU |
|
Represents the functional implementation of the ISO-15765-2 transport protocol |
|
Represents the signal point processor related to ISO-15765 signals |
|
Represents the generic ISO service handling function framework |
|
Represents the functional implementation of a generic ISO service handler |
|
Signal of the Communication system |
|
Represents a group of related communication signals |
|
ISignalGroupPoint |
|
Signal-based PDU |
|
Group of Signal-based PDUs |
|
Represents the translation between a signal-based PDU and a PDU point |
|
ISignalPoint |
|
ISignalPort |
|
ISignalToIPDUMapping |
|
ISignalTriggering |
|
Base type for structures which will be given as options to PointProcessor::Invoke |
|
LINChannel |
|
LINCluster |
|
LINConnector |
|
LINController |
|
LINDiscoveryProcessor |
|
LINFrameTriggering |
|
Machine |
|
MachineDesign |
|
Represents the functional basis of a message object |
|
Represents the communcation module |
|
MultiplexedIPDU |
|
MultiplexedIPDUPoint |
|
An object defining the network addressing for an endpoint |
|
Represents a network management PDU |
|
NetworkPDU |
|
A collection of bytes moved throughout the Communication Stack. |
|
An instance of PDU that is being processed by the Communication module. |
|
A Point which describes its payload in terms of bytes |
|
PDUTriggering describes on which channel the ComPDU is transmitted. |
|
A connection between a Driver and a Cluster |
|
An element of a Communication::Stack which processes points |
|
SOMEIPServiceInterfaceDeployment |
|
ServiceInterface |
|
ServiceInterfaceDeployment |
|
An instance of a signal group that is being processed by the Communication module. |
|
An instance of a signal that is being processed by the Communication module. |
|
See documentation for Frames.SimResetEvent |
|
Represents the connection between an ApplicationEndpoint |
|
A named group of SocketConnections, holding the connections |
|
Represents a data source and discovery object relationship |
|
A Communication Stack inside of an ECU |
|
StdCPPImplementationDataType |
|
TDataPoint |
|
Definition of a network topology |
|
Network topology subset |
|
Represents a transaction buffer sink |
|
Triggering describes the pairing of a communication object to a channel and defines the manner of |
|
Represents a PDU with user-defined processing |
|
Represents the Intrepid VehicleSpy DB network topology and message specification |
|
VariableDataPrototype |
- class vspyx.Communication.AUTOSARDataPrototype
Bases:
vspyx.Runtime.Traceable
AUTOSARDataPrototype
- DataType :AUTOSARDataType
- class vspyx.Communication.AUTOSARDataType
Bases:
vspyx.Core.ResolverObject
AUTOSARDataType
- class vspyx.Communication.ApplicationEndpoint
Bases:
vspyx.Core.ResolverObject
The endpoint on an ECU in terms of application addressing
- NetworkEndpoint :NetworkEndpoint
Retrieve the network endpoint associated with this application endpoint, if set and resolvable. Returns nullptr if either condition is not met.
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- Port :Any
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) ApplicationEndpoint
- class vspyx.Communication.Architecture
Bases:
vspyx.Runtime.Environment
Architecture
- Stack :Stack
- SubmitPoint(self, point: vspyx.Runtime.Point) Any
- class vspyx.Communication.BufferUpdatePoint
Bases:
PDUPoint
Used to signal to a communication controller that the transmit buffer should be updated. This is the case for time triggered network types, where a DataLinkPDUPoint should not be immediately created by the transmitting entity, rather a buffer update should be initiated and the controller will create the DataLinkPDUPoint (as well as the corresponding network traffic) when it is time.
- NetworkEvent :vspyx.Frames.NetworkEvent
- class vspyx.Communication.CANChannel
Bases:
Channel
Represents a CAN channel interface
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- CloneState(self) Any
- static New() CANChannel
- static New(config: Any) CANChannel
- NewISO11898_1Interface(self) ISO11898.ISO11898_1Interface
- UpdateState(self, state: Any) Any
- class vspyx.Communication.CANCluster
Bases:
Cluster
Represents a CAN cluster
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New() CANCluster
- static New(config: Any) CANCluster
- class vspyx.Communication.CANConnector
Bases:
Connector
Represents a connection between an ECU and a CAN bus interface
- CANController :CANController
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- CloneState(self) Any
- static New() CANConnector
- static New(config: Any) CANConnector
- UpdateState(self, state: Any) Any
- class vspyx.Communication.CANController
Bases:
Controller
Represents a CAN controller device interface
- Driver :vspyx.Frames.CANDriver
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New() CANController
- static New(config: Any) CANController
- NewISO11898_1Interface(self) ISO11898.ISO11898_1Interface
- class vspyx.Communication.CANDataLinkPDUPoint
Bases:
DataLinkPDUPoint
CANDataLinkPDUPoint
- static New(direction: vspyx.Runtime.Point.Direction, controller: Controller) vspyx.Runtime.Point.Consuming_5056ff9b42
- static New(direction: vspyx.Runtime.Point.Direction, controller: Controller, upstreamPoints: List[vspyx.Runtime.Point]) vspyx.Runtime.Point.Consuming_5056ff9b42
- static New(direction: vspyx.Runtime.Point.Direction, controller: Controller, frame: vspyx.Frames.CANFrame) vspyx.Runtime.Point.Consuming_5056ff9b42
- static New(direction: vspyx.Runtime.Point.Direction, controller: Controller, arbID: int, data: vspyx.Core.BytesView) vspyx.Runtime.Point.Consuming_5056ff9b42
- static New(direction: vspyx.Runtime.Point.Direction, controller: Controller, arbID: int, data: vspyx.Core.BytesView, isCANFD: bool) vspyx.Runtime.Point.Consuming_5056ff9b42
- static New(direction: vspyx.Runtime.Point.Direction, controller: Controller, arbID: int, data: vspyx.Core.BytesView, isCANFD: bool, baudrateSwitch: bool) vspyx.Runtime.Point.Consuming_5056ff9b42
- static New(direction: vspyx.Runtime.Point.Direction, controller: Controller, arbID: int, data: vspyx.Core.BytesView, isCANFD: bool, baudrateSwitch: bool, isExtended: Any) vspyx.Runtime.Point.Consuming_5056ff9b42
- static New(direction: vspyx.Runtime.Point.Direction, controller: Controller, arbID: int, data: vspyx.Core.BytesView, isCANFD: bool, baudrateSwitch: bool, isExtended: Any, dlc: Any) vspyx.Runtime.Point.Consuming_5056ff9b42
- static New(direction: vspyx.Runtime.Point.Direction, controller: Controller, arbID: int, data: vspyx.Core.BytesView, isCANFD: bool, baudrateSwitch: bool, isExtended: Any, dlc: Any, isRemote: bool) vspyx.Runtime.Point.Consuming_5056ff9b42
- class vspyx.Communication.CANDiscoveryProcessor
Bases:
PointProcessor
Represents a processor which handles PDU points containing CAN frames
- static New() CANDiscoveryProcessor
- class vspyx.Communication.CANErrorCountsPoint
Bases:
DataLinkEventPoint
CANErrorCountsPoint
- class vspyx.Communication.CANFrame
Bases:
Frame
Represents the CAN-specific layout of a frame object
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) CANFrame
Create a new generic asynchronously updated Traceable.
When working in Python, creating a more specific Traceable is correct rather than creating this generic one, unless you are implementing your own protocol.
- NewPoint(self, direction: vspyx.Runtime.Point.Direction, data: vspyx.Core.BytesView) vspyx.Runtime.Point.Consuming_6aef469678
- NewPoint(self, direction: vspyx.Runtime.Point.Direction, data: vspyx.Core.BytesView, upstreamPoints: List[vspyx.Runtime.Point]) vspyx.Runtime.Point.Consuming_6aef469678
- NewPoint(self, direction: vspyx.Runtime.Point.Direction, data: vspyx.Core.BytesView, upstreamPoints: List[vspyx.Runtime.Point], controller: Controller) vspyx.Runtime.Point.Consuming_6aef469678
- NewPoint(self, direction: vspyx.Runtime.Point.Direction, upstreamPoints: List[vspyx.Runtime.Point], controller: CANController, data: vspyx.Core.BytesView) vspyx.Runtime.Point.Consuming_6aef469678
- NewPoint(self, direction: vspyx.Runtime.Point.Direction, upstreamPoints: List[vspyx.Runtime.Point], controller: CANController, data: vspyx.Core.BytesView, arbID: Any) vspyx.Runtime.Point.Consuming_6aef469678
- NewPoint(self, direction: vspyx.Runtime.Point.Direction, upstreamPoints: List[vspyx.Runtime.Point], controller: CANController, data: vspyx.Core.BytesView, arbID: Any, isCANFD: Any) vspyx.Runtime.Point.Consuming_6aef469678
- NewPoint(self, direction: vspyx.Runtime.Point.Direction, upstreamPoints: List[vspyx.Runtime.Point], controller: CANController, data: vspyx.Core.BytesView, arbID: Any, isCANFD: Any, baudrateSwitch: Any) vspyx.Runtime.Point.Consuming_6aef469678
- NewPoint(self, direction: vspyx.Runtime.Point.Direction, upstreamPoints: List[vspyx.Runtime.Point], controller: CANController, data: vspyx.Core.BytesView, arbID: Any, isCANFD: Any, baudrateSwitch: Any, isExtended: Any) vspyx.Runtime.Point.Consuming_6aef469678
- NewPoint(self, direction: vspyx.Runtime.Point.Direction, upstreamPoints: List[vspyx.Runtime.Point], controller: CANController, data: vspyx.Core.BytesView, arbID: Any, isCANFD: Any, baudrateSwitch: Any, isExtended: Any, dlc: Any) vspyx.Runtime.Point.Consuming_6aef469678
- NewPoint(self, direction: vspyx.Runtime.Point.Direction, upstreamPoints: List[vspyx.Runtime.Point], controller: CANController, data: vspyx.Core.BytesView, arbID: Any, isCANFD: Any, baudrateSwitch: Any, isExtended: Any, dlc: Any, isRemote: Any) vspyx.Runtime.Point.Consuming_6aef469678
- class vspyx.Communication.CANFramePoint
Bases:
FramePoint
CANFramePoint
- static New(direction: vspyx.Runtime.Point.Direction, upstreamPoints: List[vspyx.Runtime.Point], controller: CANController, frame: CANFrame, data: vspyx.Core.BytesView) vspyx.Runtime.Point.Consuming_1dd119a6a6
- static New(direction: vspyx.Runtime.Point.Direction, upstreamPoints: List[vspyx.Runtime.Point], controller: CANController, frame: CANFrame, data: vspyx.Core.BytesView, arbID: Any) vspyx.Runtime.Point.Consuming_1dd119a6a6
- static New(direction: vspyx.Runtime.Point.Direction, upstreamPoints: List[vspyx.Runtime.Point], controller: CANController, frame: CANFrame, data: vspyx.Core.BytesView, arbID: Any, isCANFD: Any) vspyx.Runtime.Point.Consuming_1dd119a6a6
- static New(direction: vspyx.Runtime.Point.Direction, upstreamPoints: List[vspyx.Runtime.Point], controller: CANController, frame: CANFrame, data: vspyx.Core.BytesView, arbID: Any, isCANFD: Any, baudrateSwitch: Any) vspyx.Runtime.Point.Consuming_1dd119a6a6
- static New(direction: vspyx.Runtime.Point.Direction, upstreamPoints: List[vspyx.Runtime.Point], controller: CANController, frame: CANFrame, data: vspyx.Core.BytesView, arbID: Any, isCANFD: Any, baudrateSwitch: Any, isExtended: Any) vspyx.Runtime.Point.Consuming_1dd119a6a6
- static New(direction: vspyx.Runtime.Point.Direction, upstreamPoints: List[vspyx.Runtime.Point], controller: CANController, frame: CANFrame, data: vspyx.Core.BytesView, arbID: Any, isCANFD: Any, baudrateSwitch: Any, isExtended: Any, dlc: Any) vspyx.Runtime.Point.Consuming_1dd119a6a6
- static New(direction: vspyx.Runtime.Point.Direction, upstreamPoints: List[vspyx.Runtime.Point], controller: CANController, frame: CANFrame, data: vspyx.Core.BytesView, arbID: Any, isCANFD: Any, baudrateSwitch: Any, isExtended: Any, dlc: Any, isRemote: Any) vspyx.Runtime.Point.Consuming_1dd119a6a6
- static New(direction: vspyx.Runtime.Point.Direction, controller: CANController, arbID: int, data: vspyx.Core.BytesView) vspyx.Runtime.Point.Consuming_1dd119a6a6
- static New(direction: vspyx.Runtime.Point.Direction, controller: CANController, arbID: int, data: vspyx.Core.BytesView, isCANFD: bool) vspyx.Runtime.Point.Consuming_1dd119a6a6
- static New(direction: vspyx.Runtime.Point.Direction, controller: CANController, arbID: int, data: vspyx.Core.BytesView, isCANFD: bool, baudrateSwitch: bool) vspyx.Runtime.Point.Consuming_1dd119a6a6
- static New(direction: vspyx.Runtime.Point.Direction, controller: CANController, arbID: int, data: vspyx.Core.BytesView, isCANFD: bool, baudrateSwitch: bool, isExtended: Any) vspyx.Runtime.Point.Consuming_1dd119a6a6
- static New(direction: vspyx.Runtime.Point.Direction, controller: CANController, arbID: int, data: vspyx.Core.BytesView, isCANFD: bool, baudrateSwitch: bool, isExtended: Any, dlc: Any) vspyx.Runtime.Point.Consuming_1dd119a6a6
- static New(direction: vspyx.Runtime.Point.Direction, controller: CANController, arbID: int, data: vspyx.Core.BytesView, isCANFD: bool, baudrateSwitch: bool, isExtended: Any, dlc: Any, isRemote: bool) vspyx.Runtime.Point.Consuming_1dd119a6a6
Create a CANFramePoint not associated with a Traceable. This is useful for creating points to send down.
- class vspyx.Communication.CANFrameTriggering
Bases:
FrameTriggering
Represents the timing and channel identification info relating to a transmitted CAN frame
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) CANFrameTriggering
- class vspyx.Communication.CPPImplementationDataType
Bases:
AUTOSARDataType
CPPImplementationDataType
- Category :str
- class vspyx.Communication.CPPImplementationDataTypeElement
Bases:
vspyx.Runtime.Traceable
CPPImplementationDataTypeElement
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) CPPImplementationDataTypeElement
Create a new generic asynchronously updated Traceable.
When working in Python, creating a more specific Traceable is correct rather than creating this generic one, unless you are implementing your own protocol.
- class vspyx.Communication.Channel
Bases:
vspyx.Runtime.Component
A Channel is the transmission medium that is used to send and receive information between communicating ECUs. Each Cluster has at least one Channel. Bus systems like CAN and LIN only have exactly one Channel. A FlexRay Cluster may have more than one Channels that may be used in parallel for redundant communication. An ECU is part of a cluster if it contains at least one controller that is connected to at least one channel of the cluster.
- class SubmissionResult
SubmissionResult
- Acked :int
- AssignedArbitrary :int
- Forwarded :int
- Ignored :int
- Rejected :int
- VotedResult :Connector.IngressActions
The opinion of the Channel about this SubmissionResult. Given every node’s response, this is the overall takeaway.
For instance, for CAN, any node rejecting with a NAK will cause the entire bus to consider the frame to be NAKed.
- AddResult(self, action: Connector.IngressActions) Any
Add a single ingress action to the appropriate counter within the SubmissionResult.
- static Reject() Channel.SubmissionResult
- Cluster :Cluster
Get the Cluster that this Channel is a member of
- Connectors :List[Connector]
- EnableComStack :bool
- LastEvent :vspyx.Frames.NetworkEvent
- OffloadProcessing :bool
- OnFrameTriggeringsChanged :vspyx.Core.Callback_add982ce23
- OnTriggeringsChanged :vspyx.Core.Callback_634bd5c449
Called whenever the Active Triggerings are changed.
It is not guaranteed that this will only be called if an Active Triggering has been added/removed.
- RecommendedMappings :List[str]
- TotalTraffic :int
- UtilizationPercent :vspyx.Runtime.Signal
- AddFrameTriggering(self, frameTriggering: FrameTriggering) Any
- AddFrameTriggering(self, frameTriggering: FrameTriggering, permanent: bool) Any
- AddPDUTriggering(self, pduTriggering: PDUTriggering) Any
- AddPDUTriggering(self, pduTriggering: PDUTriggering, permanent: bool) Any
- ConnectAutoAttachConnectors(self, failSilently: bool) Any
- static Discovery(app: vspyx.Core.Application, driver: vspyx.Frames.Driver) Channel
- IsDiscovery(self) bool
- MeasurePercentOfSecond(self, event: vspyx.Frames.NetworkEvent) float
- NewAttachedController(self, namePrefix: str, listenOnly: bool) Any
Create a new controller of the correct type for this channel and attach it with a new connector.
The caller is responsible for taking ownership of the returned objects.
- Parameter namePrefix:
Prefix for the created controller/connector
names :Parameter listenOnly: Create the controller with parameters such that it will not influence the channel (ACKs, transmits, etc.)
- class vspyx.Communication.Cluster
Bases:
vspyx.Runtime.Component
Cluster is the main element to describe the topological connection of communicating ECUs. A cluster describes the ensemble of ECUs, which are linked by a communication medium of arbitrary topology (bus, star, ring, …). The nodes within the cluster share the same communication protocol, which may be event-triggered, time-triggered or a combination of both. A Cluster aggregates one or more physical channels.
- static Discovery(app: vspyx.Core.Application, source: SourceHandle, driver: vspyx.Frames.Driver) Cluster
- class vspyx.Communication.CommunicationPoint
Bases:
vspyx.Runtime.Point
A Runtime::Point which holds extra information not visible from the Runtime module
- DissectorMessage :vspyx.Dissector.Message
- GetAttribute(self, type: str) vspyx.Runtime.Value
Get an attribute of this point by its tag
If the attribute doesn’t exist, an empty Runtime::Value will be returned.
- class vspyx.Communication.Component
Bases:
vspyx.Runtime.Component
Represents a basic runtime component within the Communication runtime domain
- static New(sources: vspyx.Core.ResolverCollection, topology: Topology) Component
- class vspyx.Communication.Connector
Bases:
vspyx.Runtime.Component
An ECU uses Connector elements in order to describe its bus interfaces and to specify the sending/receiving behavior.
- class IngressActions
Bases:
enum.IntEnum
Enum where members are also (and must be) ints
- Forwarded = 2
- Ignored = 0
- Received = 1
- Rejected = 3
- Channel :Channel
- Controller :Controller
- Egress :vspyx.Core.Function_316d8f46e9
- EgressBlocked :bool
- EgressImmediate :vspyx.Core.Function_a6845211fe
- Ingress :vspyx.Core.Function_a6845211fe
- IngressBlocked :bool
- AddPort(self, port: ConnectorPort, permanent: bool) Any
Add a ConnectorPort to the Connector configuration by reference.
The ConnectorPort will not be owned by the Connector.
- AttachToChannel(self, channel: Channel, permanent: bool) Any
Attach this connector to the given channel, removing the connector from a previously attached channel, if present.
- DefaultEgress(self, event: vspyx.Frames.NetworkEvent) Any
- DefaultEgressImmediate(self, event: vspyx.Frames.NetworkEvent) Connector.IngressActions
- DefaultIngress(self, event: vspyx.Frames.NetworkEvent) Connector.IngressActions
- IncrementEgressCounter(self) Any
- IncrementIngressCounter(self, action: Connector.IngressActions) Any
- RefreshActiveControllerAndChannel(self) Any
- class vspyx.Communication.ConnectorPort
Bases:
vspyx.Core.ResolverObject
The Ecu communication relationship defines which signals, Pdus and frames are actually received and transmitted by this ECU.
For each signal, Pdu or Frame that is transmitted or received and used by the Ecu an association between an ISignalPort, IPduPort or FramePort with the corresponding Triggering shall be created.
- Direction :vspyx.intrepidcs.vspyx.rpc.Communication.Directions
- class vspyx.Communication.ContainerIPDU
Bases:
IPDU
Represents a communication container PDU, defined to contain other PDUs
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) ContainerIPDU
Create a new generic asynchronously updated Traceable.
When working in Python, creating a more specific Traceable is correct rather than creating this generic one, unless you are implementing your own protocol.
- class vspyx.Communication.Controller
Bases:
vspyx.Runtime.Component
Controller is a dedicated hardware device by means of which hosts are sending frames to and receiving frames from the communication medium.
- ChannelName :Any
Returns the name of the connected Channel. If multiple Channels are connected, they will be separated by “, “.
- DriverDescription :str
- ConfigureStack(self, stack: Stack) Any
Configure a Communication::Stack for this Controller, adding PointProcessors and configuring them as necessary.
- NewConnector(self) Connector
Make a connector with a ref pointing at this controller. Does not initialize the connector.
- ObserveEvent(self, event: vspyx.Frames.NetworkEvent) Connector.IngressActions
Notify the controller of a network event that has occurred.
For example, the network may call this function to notify the controller of an incoming Frame.
This function should not be called upstream of the controller (within the ECU).
- SubmitEvent(self, event: vspyx.Frames.NetworkEvent) Any
Ask the controller to schedule/perform an action based on the given event.
For example, the ECU’s communication stack may call this function to ask the controller to transmit a Frame.
This function should not be called downstream of the controller (outside of the ECU, in the greater communication simulation).
- SubmitEventImmediate(self, event: vspyx.Frames.NetworkEvent) Connector.IngressActions
- class vspyx.Communication.DBC
Bases:
TopologySubset
Represents the CANdbc network topology and message specification
- Objects :vspyx.Core.ResolverOwningCollection
- class vspyx.Communication.DataLinkEventPoint
Bases:
CommunicationPoint
Represents PDU level data point runtime access interface
- NetworkEvent :vspyx.Frames.NetworkEvent
- class vspyx.Communication.DataLinkPDUPoint
Bases:
PDUPoint
Represents PDU level data point runtime access interface
- Confirmation :vspyx.Frames.Confirmation
Get the confirmation associated with this DataLinkPDUPoint.
At first, this will be nullptr. When a confirmation is received by the controller, this value will be set. Note that this value may change after the Point has finished being consumed.
- Frame :vspyx.Frames.Frame
- GetAttribute(self, type: str) vspyx.Runtime.Value
Get an attribute of this point by its tag
If the attribute doesn’t exist, an empty Runtime::Value will be returned.
- static NewFromFrame(controller: Controller, frame: vspyx.Frames.Frame) vspyx.Runtime.Point.Consuming_03654c56a8
- static NewFromFrame(controller: Controller, frame: vspyx.Frames.Frame, direction: vspyx.Runtime.Point.Direction) vspyx.Runtime.Point.Consuming_03654c56a8
- class vspyx.Communication.DatagramPoint
Bases:
PDUPoint
A PDUPoint that also holds a header of bytes
- GetAttribute(self, type: str) vspyx.Runtime.Value
Get an attribute of this point by its tag
If the attribute doesn’t exist, an empty Runtime::Value will be returned.
- GetHeader(self) vspyx.Core.BytesView
- SetAttribute(self, type: str, value: vspyx.Runtime.Value) bool
Set an attribute on this point dynamically
Returns true if the attribute could be set
The attribute can not be set if a subclass implements a read-only attribute on this point (built-in attributes are read-only by default, unless a setter is explicitly provided)
This should only be done while the point is Consuming
These “dynamic” attributes are lower in priority than built-in attributes, but higher in priority than any inherited attributes.
- class vspyx.Communication.DiagnosticIPDU
Bases:
IPDU
Represents a diagnostics communication PDU
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) DiagnosticIPDU
Create a new generic asynchronously updated Traceable.
When working in Python, creating a more specific Traceable is correct rather than creating this generic one, unless you are implementing your own protocol.
- class vspyx.Communication.ECU
Bases:
Architecture
ECU describes the presence of a microcontroller in the vehicle.
- Connectors :vspyx.Core.ResolverCollection
- Controllers :vspyx.Core.ResolverCollection
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- OwnedConnectors :vspyx.Core.ResolverOwningCollection
- OwnedControllers :vspyx.Core.ResolverOwningCollection
- Transmits :vspyx.Core.ResolverOwningCollection
- AddTransmit(self, transmit: vspyx.Scripting.FunctionBlock) Any
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- ComponentStart(self) Any
- ComponentStop(self) Any
- ConnectToChannel(self, channel: Channel, listenOnly: bool) Any
Create a new ECU-owned controller and connector, connecting this ECU to the provided Channel.
- Parameter listenOnly:
Create the controller with parameters such
that it will not influence the channel (ACKs, transmits, etc.)
- Initialize(self, app: vspyx.Core.Application, id: str, uuid: Any, params: vspyx.Core.Serialization.CreationParameters) Any
Initialize the object.
This function must be called before the object can be used.
- Parameter app:
the global application object
- Parameter id:
id of the object
- Parameter params:
parameters on how the object was created
- SendSignalGroup(self, signalGroupResolverLookup: str) Any
- SendSignalGroup(self, signalGroup: ISignalGroup) Any
- SetMode(self, newMode: vspyx.intrepidcs.vspyx.rpc.Communication.ECUMode) Any
Set the mode for this ECU. This will update the ECU configuration.
A mode of ECU::Mode::Disabled is equivalent to a real-world ECU completely powered off.
A mode of ECU::Mode::Passive allows the ECU to receive messages, but the ECU will not interact with the network in any way. This may be useful if the real-world ECU is powered on, but you wish to use the perspective of this ECU.
A mode of ECU::Mode::Active attempts to emulate the real-world ECU as closely as possible. It will respond to messages and periodically transmit the messages that the real ECU would, if defined.
- SetSignal(self, signalResolverLookup: str, physicalValue: Any) Any
- SetSignal(self, signal: ISignal, physicalValue: Any) Any
- TriggerIPDUSend(self, signalPduResolverLookup: str) Any
- TriggerIPDUSend(self, signalPdu: ISignalIPDU) Any
- class vspyx.Communication.EthernetChannel
Bases:
Channel
EthernetChannel
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- CloneState(self) Any
- static New() EthernetChannel
- static New(config: Any) EthernetChannel
- UpdateState(self, state: Any) Any
- class vspyx.Communication.EthernetCluster
Bases:
Cluster
EthernetCluster
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New() EthernetCluster
- static New(config: Any) EthernetCluster
- class vspyx.Communication.EthernetConnector
Bases:
Connector
EthernetConnector
- EthernetController :EthernetController
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- CloneState(self) Any
- static New(config: Any) EthernetConnector
- UpdateState(self, state: Any) Any
- class vspyx.Communication.EthernetController
Bases:
Controller
EthernetController
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) EthernetController
- class vspyx.Communication.EthernetDiscoveryProcessor
Bases:
PointProcessor
EthernetDiscoveryProcessor
- static New() EthernetDiscoveryProcessor
- class vspyx.Communication.EthernetFrame
Bases:
Frame
EthernetFrame
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) EthernetFrame
Create a new generic asynchronously updated Traceable.
When working in Python, creating a more specific Traceable is correct rather than creating this generic one, unless you are implementing your own protocol.
- class vspyx.Communication.EthernetFrameTriggering
Bases:
FrameTriggering
EthernetFrameTriggering
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) EthernetFrameTriggering
- class vspyx.Communication.Field
Bases:
AUTOSARDataPrototype
Field
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- class vspyx.Communication.FlexRayBufferUpdatePoint
Bases:
BufferUpdatePoint
FlexRayBufferUpdatePoint
- class vspyx.Communication.FlexRayChannel
Bases:
Channel
FlexRayChannel
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- CloneState(self) Any
- static New() FlexRayChannel
- static New(config: Any) FlexRayChannel
- UpdateState(self, state: Any) Any
- class vspyx.Communication.FlexRayCluster
Bases:
Cluster
FlexRayCluster
- GlobalConfiguration :vspyx.Frames.FlexRayClusterConfiguration
The configuration which is shared by every CC in the cluster.
This value is read-only and can only be changed by modifying the protobuf configuration of the cluster.
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New() FlexRayCluster
- static New(config: Any) FlexRayCluster
- class vspyx.Communication.FlexRayConnector
Bases:
Connector
FlexRayConnector
- FlexRayController :FlexRayController
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- CloneState(self) Any
- static New(config: Any) FlexRayConnector
- UpdateState(self, state: Any) Any
- class vspyx.Communication.FlexRayController
Bases:
Controller
FlexRayController
- AllowColdstart :bool
- CCConfiguration :vspyx.Frames.FlexRayCCConfiguration
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- StartWhenGoingOnline :bool
- WakeupBeforeStart :bool
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- Halt(self) Any
- static New(config: Any) FlexRayController
- Start(self) Any
- class vspyx.Communication.FlexRayDataLinkPDUPoint
Bases:
DataLinkPDUPoint
FlexRayDataLinkPDUPoint
- class vspyx.Communication.FlexRayDiscoveryProcessor
Bases:
PointProcessor
FlexRayDiscoveryProcessor
- static New() FlexRayDiscoveryProcessor
- class vspyx.Communication.FlexRayFrame
Bases:
Frame
FlexRayFrame
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) FlexRayFrame
Create a new generic asynchronously updated Traceable.
When working in Python, creating a more specific Traceable is correct rather than creating this generic one, unless you are implementing your own protocol.
- class vspyx.Communication.FlexRayFrameTriggering
Bases:
FrameTriggering
FlexRayFrameTriggering
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) FlexRayFrameTriggering
- class vspyx.Communication.Frame
Bases:
vspyx.Runtime.Traceable
A Frame represents a general design object that is used to describe the layout of the included Pdus as a reusable asset.
- Length :Any
- NewPoint(self, direction: vspyx.Runtime.Point.Direction, data: vspyx.Core.BytesView) vspyx.Runtime.Point.Consuming_6aef469678
- NewPoint(self, direction: vspyx.Runtime.Point.Direction, data: vspyx.Core.BytesView, upstreamPoints: List[vspyx.Runtime.Point]) vspyx.Runtime.Point.Consuming_6aef469678
- NewPoint(self, direction: vspyx.Runtime.Point.Direction, data: vspyx.Core.BytesView, upstreamPoints: List[vspyx.Runtime.Point], controller: Controller) vspyx.Runtime.Point.Consuming_6aef469678
- class vspyx.Communication.FramePort
Bases:
ConnectorPort
FramePort
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- class vspyx.Communication.FrameTriggering
Bases:
Triggering
FrameTriggering describes the instance of a frame sent on a channel and defines the manner of triggering (timing information) and identification of a frame on the channel, on which it is sent.
- Frame :Frame
- class vspyx.Communication.GeneralPurposeIPDU
Bases:
IPDU
Represents a general purpose interaction PDU used for XCP, SOME/IP segments, or DLT
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New() GeneralPurposeIPDU
- static New(config: Any) GeneralPurposeIPDU
Create a new generic asynchronously updated Traceable.
When working in Python, creating a more specific Traceable is correct rather than creating this generic one, unless you are implementing your own protocol.
- class vspyx.Communication.GeneralPurposePDU
Bases:
PDU
Represents a general purpose PDU used for DoIP, service discovery, or global timing
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New() GeneralPurposePDU
- static New(config: Any) GeneralPurposePDU
Create a new generic asynchronously updated Traceable.
When working in Python, creating a more specific Traceable is correct rather than creating this generic one, unless you are implementing your own protocol.
- class vspyx.Communication.IPDU
Bases:
PDU
IPDU represents any type of PDU that the Communication system can interact with
- class vspyx.Communication.IPDUPort
Bases:
ConnectorPort
Represents the PDU-specific triggered data binding related to a transmitted PDU
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- class vspyx.Communication.ISO15765_2
Bases:
ISOStandardizedServicePrimitiveInterface
,vspyx.Runtime.Component
Represents the functional implementation of the ISO-15765-2 transport protocol
- class Addressing
Bases:
enum.IntEnum
Enum where members are also (and must be) ints
- Extended = 1
- Mixed = 2
- Normal = 0
- class ChangeParametersResult
Bases:
enum.IntEnum
Enum where members are also (and must be) ints
- N_OK = 0
- N_RX_ON = 1
- N_TX_ON = 4
- N_WRONG_PARAMETER = 2
- N_WRONG_VALUE = 3
- class FlowStatus
Bases:
enum.IntEnum
Enum where members are also (and must be) ints
- ContinueToSend = 0
- Overflow = 2
- Wait = 1
- class NetworkAddressType
Bases:
enum.IntEnum
Enum where members are also (and must be) ints
- FunctionalCANFD11Bit = 4
- FunctionalCANFD29Bit = 8
- FunctionalClassicalCAN11Bit = 2
- FunctionalClassicalCAN29Bit = 6
- PhysicalCANFD11Bit = 3
- PhysicalCANFD29Bit = 7
- PhysicalClassicalCAN11Bit = 1
- PhysicalClassicalCAN29Bit = 5
- class Parameters
Bases:
enum.IntEnum
Enum where members are also (and must be) ints
- BS = 1
- Passive = 2
- PassiveStrictFC = 3
- ST_min = 0
- class Result
Bases:
enum.IntEnum
Enum where members are also (and must be) ints
- N_BUFFER_OVFLW = 8
- N_ERROR = 9
- N_INVALID_FS = 5
- N_OK = 0
- N_TIMEOUT_A = 1
- N_TIMEOUT_Bs = 2
- N_TIMEOUT_Cr = 3
- N_UNEXP_PDU = 6
- N_WFT_OVRN = 7
- N_WRONG_SN = 4
- N_ChangeParameters_confirm :vspyx.Core.Callback_a72caefd1b
- N_USData_FF_indication :vspyx.Core.Callback_023e2a5056
- N_USData_confirm :vspyx.Core.Callback_9d4c23c9b0
- N_USData_indication :vspyx.Core.Callback_bac0b1ebba
- OnCANFrameRx :vspyx.Core.Callback_2ddc052380
- OnCANFrameTx :vspyx.Core.Callback_2ddc052380
- OnCFN_PDU :vspyx.Core.Callback_4318dcd5f2
- OnFCN_PDU :vspyx.Core.Callback_caf226155c
- OnFFN_PDU :vspyx.Core.Callback_76273522fe
- OnSFN_PDU :vspyx.Core.Callback_5eaebb1942
- TrackedL_Data_Request :vspyx.Core.Callback_430344869a
- TrackedN_USData_indication :vspyx.Core.Callback_66ad5d2157
- AddRxExtendedAddress(self, Mtype: ISOStandardizedServicePrimitiveInterface.MessageType, N_SA: int, N_SA_CANID: int, N_SAtype: ISO15765_2.NetworkAddressType, N_TA: int, N_TA_CANID: int, N_TAtype: ISO15765_2.NetworkAddressType, N_AE: Any, stMin: int, bs: int) Any
- AddRxFixedAddress(self, Mtype: ISOStandardizedServicePrimitiveInterface.MessageType, N_SA: int, N_TA: int, N_TAtype: ISO15765_2.NetworkAddressType, N_AE: Any, j1939: bool, stMin: int, bs: int) Any
- AddRxNormalAddress(self, Mtype: ISOStandardizedServicePrimitiveInterface.MessageType, N_SA: int, N_SA_CANID: int, N_SAtype: ISO15765_2.NetworkAddressType, N_TA: int, N_TA_CANID: int, N_TAtype: ISO15765_2.NetworkAddressType, N_AE: Any, stMin: int, bs: int) Any
- AddTxExtendedAddress(self, Mtype: ISOStandardizedServicePrimitiveInterface.MessageType, N_SA: int, N_SA_CANID: int, N_SAtype: ISO15765_2.NetworkAddressType, N_TA: int, N_TA_CANID: int, N_TAtype: ISO15765_2.NetworkAddressType, N_AE: Any, stMinMin: Any) Any
- AddTxFixedAddress(self, Mtype: ISOStandardizedServicePrimitiveInterface.MessageType, N_SA: int, N_TA: int, N_TAtype: ISO15765_2.NetworkAddressType, N_AE: Any, j1939: bool, stMinMin: Any) Any
- AddTxNormalAddress(self, Mtype: ISOStandardizedServicePrimitiveInterface.MessageType, N_SA: int, N_SA_CANID: int, N_SAtype: ISO15765_2.NetworkAddressType, N_TA: int, N_TA_CANID: int, N_TAtype: ISO15765_2.NetworkAddressType, N_AE: Any, stMinMin: Any) Any
- Attach(self, L_Data: ISO11898.ISO11898_1Interface) Any
- Detach(self) Any
- static FrameFormatFromNetworkAddressType(nat: ISO15765_2.NetworkAddressType) ISO11898.FrameFormats
- L_Data_Confirm(self, Identifier: int, Transfer_Status: ISO11898.TransferStatuses) Any
- L_Data_Confirm(self, Identifier: int, Transfer_Status: ISO11898.TransferStatuses, consuming: vspyx.Runtime.Point.Consuming_1edf1860a4) Any
- L_Data_Indication(self, Identifier: int, format: ISO11898.FrameFormats, DLC: int, Data: vspyx.Core.BytesView) Any
- L_Data_Indication(self, Identifier: int, format: ISO11898.FrameFormats, DLC: int, Data: vspyx.Core.BytesView, consuming: vspyx.Runtime.Point.Consuming_1edf1860a4) Any
- static MakeNetworkAddressType(frameFormat: ISO11898.FrameFormats, functional: bool) ISO15765_2.NetworkAddressType
- N_ChangeParameters_request(self, Mtype: ISOStandardizedServicePrimitiveInterface.MessageType, N_SA: int, N_TA: int, N_TAtype: int, N_AE: Any, Parameter: ISO15765_2.Parameters, Parameter_Value: int) ISO15765_2.ChangeParametersResult
- N_USData_request(self, Mtype: ISOStandardizedServicePrimitiveInterface.MessageType, N_SA: int, N_TA: int, N_TAtype: int, N_AE: Any, MessageData: vspyx.Core.BytesView, Length: int) Any
- N_USData_request(self, Mtype: ISOStandardizedServicePrimitiveInterface.MessageType, N_SA: int, N_TA: int, N_TAtype: int, N_AE: Any, MessageData: vspyx.Core.BytesView, Length: int, consuming: vspyx.Runtime.Point.Consuming_1edf1860a4) Any
- static NetworkAddressTypeIsFunctional(nat: ISO15765_2.NetworkAddressType) bool
- static New(TX_DL: int) ISO15765_2
- static New(TX_DL: int, padding: Any) ISO15765_2
- static New(TX_DL: int, padding: Any, N_WFTmax: int) ISO15765_2
- static New(TX_DL: int, padding: Any, N_WFTmax: int, receiveBufferSize: int) ISO15765_2
- RemoveAddress(self, Mtype: ISOStandardizedServicePrimitiveInterface.MessageType, N_SA: int, N_TA: int, N_TAtype: ISO15765_2.NetworkAddressType, N_AE: Any) Any
- RemoveAllAddresses(self) Any
- class vspyx.Communication.ISO15765_2Processor
Bases:
PointProcessor
,ISOStandardizedServicePrimitiveInterface
Represents the signal point processor related to ISO-15765 signals
- Interface :ISO15765_2
- static New(interface: ISO15765_2) ISO15765_2Processor
- class vspyx.Communication.ISOStandardizedServicePrimitiveInterface
Represents the generic ISO service handling function framework
- class MessageType
Bases:
enum.IntEnum
Enum where members are also (and must be) ints
- Diagnostics = 0
- RemoteDiagnostics = 1
- TData_SOM_indication :vspyx.Core.Callback_023e2a5056
- TData_SOM_indicationSupported :bool
- TData_confirm :vspyx.Core.Callback_9d4c23c9b0
- TData_indication :vspyx.Core.Callback_bac0b1ebba
- static DebugLogPDU(tag: str, prefix: str, Mtype: ISOStandardizedServicePrimitiveInterface.MessageType, SA: int, TA: int, TAtype: int, AE: Any, Data: Any, rte: vspyx.Runtime.Scheduler) Any
- GetT_TAtype(self, messageType: ISOStandardizedServicePrimitiveInterface.MessageType, sa: int, ta: int, ae: Any, isFunctional: Any) int
- TData_request(self, Mtype: ISOStandardizedServicePrimitiveInterface.MessageType, T_SA: int, T_TA: int, T_TAtype: int, T_AE: Any, T_Data: vspyx.Core.BytesView, Length: int) Any
- T_TAtypeIsFunctional(self, TAtype: int) bool
- T_TAtypeIsPhysical(self, TAtype: int) bool
- class vspyx.Communication.ISOStandardizedServicePrimitiveInterfaceTrampoline
Bases:
ISOStandardizedServicePrimitiveInterface
,vspyx.Runtime.Component
Represents the functional implementation of a generic ISO service handler
- GetT_TAtype_trampoline :vspyx.Core.Function_16f83113e6
- TData_SOM_indication :vspyx.Core.Callback_023e2a5056
- TData_SOM_indicationSupported :bool
- TData_SOM_indicationSupported_trampoline :vspyx.Core.Function_32dce94434
- TData_confirm :vspyx.Core.Callback_9d4c23c9b0
- TData_indication :vspyx.Core.Callback_bac0b1ebba
- TData_request_trampoline :vspyx.Core.Function_633e09e382
- T_TAtypeIsFunctional_trampoline :vspyx.Core.Function_3ca61a3473
- T_TAtypeIsPhysical_trampoline :vspyx.Core.Function_3ca61a3473
- GetT_TAtype(self, messageType: ISOStandardizedServicePrimitiveInterface.MessageType, sa: int, ta: int, ae: Any, isFunctional: Any) int
- TData_request(self, Mtype: ISOStandardizedServicePrimitiveInterface.MessageType, T_SA: int, T_TA: int, T_TAtype: int, T_AE: Any, T_Data: vspyx.Core.BytesView, Length: int) Any
- T_TAtypeIsFunctional(self, TAtype: int) bool
- T_TAtypeIsPhysical(self, TAtype: int) bool
- class vspyx.Communication.ISignal
Bases:
vspyx.Runtime.Signal
Signal of the Communication system
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- SystemSignal :vspyx.Runtime.SystemSignal
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) ISignal
Create a new generic asynchronously updated Traceable.
When working in Python, creating a more specific Traceable is correct rather than creating this generic one, unless you are implementing your own protocol.
- NewPoint(self, direction: vspyx.Runtime.Point.Direction, upstreamPoints: List[vspyx.Runtime.Point], physicalValue: Any, unitString: str, internalValue: Any, valid: bool) vspyx.Runtime.Point.Consuming_e473ff5c76
Python bindable version of NewPoint()
Python can not bind Core::SharedPtr<std::string> so we offer this instead and make the SharedPtr internally.
- NewTxPoint(self, physicalValue: Any) vspyx.Runtime.Point.Consuming_e473ff5c76
Equivalent to NewPoint(vspyx.Runtime.Point.Direction.Transmit, [], physicalValue, ‘’, None, True), this is a shortcut method to create a Point for transmitting.
- class vspyx.Communication.ISignalGroup
Bases:
vspyx.Runtime.Traceable
Represents a group of related communication signals
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- SystemSignalGroup :vspyx.Runtime.SystemSignalGroup
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) ISignalGroup
Create a new generic asynchronously updated Traceable.
When working in Python, creating a more specific Traceable is correct rather than creating this generic one, unless you are implementing your own protocol.
- NewPoint(self, direction: vspyx.Runtime.Point.Direction, upstreamPoints: List[vspyx.Runtime.Point], valid: bool) vspyx.Runtime.Point.Consuming_e1c4fc4e95
- class vspyx.Communication.ISignalGroupPoint
Bases:
vspyx.Runtime.Point
ISignalGroupPoint
- Valid :bool
- class vspyx.Communication.ISignalIPDU
Bases:
IPDU
Signal-based PDU
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) ISignalIPDU
Create a new generic asynchronously updated Traceable.
When working in Python, creating a more specific Traceable is correct rather than creating this generic one, unless you are implementing your own protocol.
- NewPoint(self, direction: vspyx.Runtime.Point.Direction, upstreamPoints: List[vspyx.Runtime.Point], data: vspyx.Core.BytesView) vspyx.Runtime.Point.Consuming_2215b345f6
- class vspyx.Communication.ISignalIPDUGroup
Bases:
vspyx.Core.ResolverObject
Group of Signal-based PDUs
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) ISignalIPDUGroup
- class vspyx.Communication.ISignalIPDUPoint
Bases:
PDUPoint
Represents the translation between a signal-based PDU and a PDU point
- static New(direction: vspyx.Runtime.Point.Direction, upstreamPoints: List[vspyx.Runtime.Point], traceable: vspyx.Runtime.Traceable, data: vspyx.Core.BytesView) vspyx.Runtime.Point.Consuming_2215b345f6
- class vspyx.Communication.ISignalPoint
Bases:
vspyx.Runtime.SignalPoint
ISignalPoint
- UnitString :str
- static New(direction: vspyx.Runtime.Point.Direction, iSignal: ISignal, upstreamPoints: List[vspyx.Runtime.Point], physicalValue: Any, unitString: str, internalValue: Any, valid: bool) vspyx.Runtime.Point.Consuming_e473ff5c76
Python bindable version of New()
Python can not bind Core::SharedPtr<std::string> so we offer this instead and make the SharedPtr internally.
- class vspyx.Communication.ISignalPort
Bases:
ConnectorPort
ISignalPort
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) ISignalPort
- class vspyx.Communication.ISignalToIPDUMapping
Bases:
vspyx.Core.ResolverObject
ISignalToIPDUMapping
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- Signal :Any
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) ISignalToIPDUMapping
- class vspyx.Communication.ISignalTriggering
Bases:
Triggering
ISignalTriggering
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- Trigger :Any
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) ISignalTriggering
- class vspyx.Communication.InvocationOptions
Base type for structures which will be given as options to PointProcessor::Invoke
- class vspyx.Communication.LINChannel
Bases:
Channel
LINChannel
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- CloneState(self) Any
- static New() LINChannel
- static New(config: Any) LINChannel
- UpdateState(self, state: Any) Any
- class vspyx.Communication.LINCluster
Bases:
Cluster
LINCluster
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New() LINCluster
- static New(config: Any) LINCluster
- class vspyx.Communication.LINConnector
Bases:
Connector
LINConnector
- LINController :LINController
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- CloneState(self) Any
- static New(config: Any) LINConnector
- UpdateState(self, state: Any) Any
- class vspyx.Communication.LINController
Bases:
Controller
LINController
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) LINController
- class vspyx.Communication.LINDiscoveryProcessor
Bases:
PointProcessor
LINDiscoveryProcessor
- static New() LINDiscoveryProcessor
- class vspyx.Communication.LINFrameTriggering
Bases:
FrameTriggering
LINFrameTriggering
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) LINFrameTriggering
- class vspyx.Communication.Machine
Bases:
Architecture
Machine
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- ComponentStart(self) Any
- ComponentStop(self) Any
- class vspyx.Communication.MachineDesign
Bases:
vspyx.Core.ResolverObject
MachineDesign
- Connectors :List[Connector]
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) MachineDesign
- class vspyx.Communication.Message
Bases:
vspyx.Core.Object
Represents the functional basis of a message object
- OnReceived :vspyx.Core.Callback_634bd5c449
- Transmit(self) Any
- class vspyx.Communication.Module
Bases:
vspyx.Core.Module
Represents the communcation module
- Component :Component
- Dissector :vspyx.Dissector.Engine
- PhysicalConnectors :vspyx.Core.ResolverCollection
- SourceHandles :vspyx.Core.ResolverCollection
- Topology :Topology
- UserPhysicalConnectors :vspyx.Core.ResolverOwningCollection
- UserSourceHandles :vspyx.Core.ResolverOwningCollection
- UserTopology :Topology
- ConnectControllerToChannel(self, controller: Controller, channel: Channel) Connector
- ConnectControllerToChannel(self, controller: Controller, channel: Channel, permanent: bool) Connector
- ConnectDriverToCluster(self, source: SourceHandle, driverDescription: str, cluster: Cluster) PhysicalConnector
- ConnectDriverToCluster(self, source: SourceHandle, driverDescription: str, cluster: Cluster, permanent: bool) PhysicalConnector
- NewLoadDBCTask(self, path: str, serialized: bool, namespaced: bool, createChannels: bool) vspyx.Core.Task_0431e75dc5
- NewLoadVSDBTask(self, path: str, serialized: bool, namespaced: bool, missingNetworkType: vspyx.Frames.FrameType.Enum, createChannels: bool) vspyx.Core.Task_e80474c995
- NewSourceHandleFromDescription(self, description: str) SourceHandle
- NewSourceHandleFromDescription(self, description: str, owned: bool) SourceHandle
- RefreshSources(self) Any
- SetupDiscoveryClusters(self) Any
- class vspyx.Communication.MultiplexedIPDU
Bases:
IPDU
MultiplexedIPDU
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- StaticPDU :ISignalIPDU
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) MultiplexedIPDU
Create a new generic asynchronously updated Traceable.
When working in Python, creating a more specific Traceable is correct rather than creating this generic one, unless you are implementing your own protocol.
- NewPoint(self, direction: vspyx.Runtime.Point.Direction, upstreamPoints: List[vspyx.Runtime.Point], data: vspyx.Core.BytesView) vspyx.Runtime.Point.Consuming_9f8cd48833
- class vspyx.Communication.MultiplexedIPDUPoint
Bases:
PDUPoint
MultiplexedIPDUPoint
- SelectorFieldValue :int
- static New(direction: vspyx.Runtime.Point.Direction, upstreamPoints: List[vspyx.Runtime.Point], multiplexedIPDU: MultiplexedIPDU, data: vspyx.Core.BytesView, selectorFieldValue: int) vspyx.Runtime.Point.Consuming_9f8cd48833
- class vspyx.Communication.NetworkEndpoint
Bases:
vspyx.Core.ResolverObject
An object defining the network addressing for an endpoint (such as an ECU).
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- ConfigureStack(self, stack: Stack, ctrl: Controller, listenOnly: bool) Any
- static New(config: Any) NetworkEndpoint
- class vspyx.Communication.NetworkManagementPDU
Bases:
PDU
Represents a network management PDU
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) NetworkManagementPDU
Create a new generic asynchronously updated Traceable.
When working in Python, creating a more specific Traceable is correct rather than creating this generic one, unless you are implementing your own protocol.
- class vspyx.Communication.NetworkPDU
Bases:
IPDU
NetworkPDU
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) NetworkPDU
Create a new generic asynchronously updated Traceable.
When working in Python, creating a more specific Traceable is correct rather than creating this generic one, unless you are implementing your own protocol.
- class vspyx.Communication.PDU
Bases:
vspyx.Runtime.Traceable
A collection of bytes moved throughout the Communication Stack.
Short for “Protocol Data Unit”
- Length :int
The defined length of the PDU
- class vspyx.Communication.PDUInstance
An instance of PDU that is being processed by the Communication module. This class is short-lived, and referencing it outside of the immediate callback may result in unpredictable behavior.
- Bytes :vspyx.Core.BytesView
- class vspyx.Communication.PDUPoint
Bases:
CommunicationPoint
A Point which describes its payload in terms of bytes
- GetAttribute(self, type: str) vspyx.Runtime.Value
Get an attribute of this point by its tag
If the attribute doesn’t exist, an empty Runtime::Value will be returned.
- GetPayload(self) vspyx.Core.BytesView
- SetAttribute(self, type: str, value: vspyx.Runtime.Value) bool
Set an attribute on this point dynamically
Returns true if the attribute could be set
The attribute can not be set if a subclass implements a read-only attribute on this point (built-in attributes are read-only by default, unless a setter is explicitly provided)
This should only be done while the point is Consuming
These “dynamic” attributes are lower in priority than built-in attributes, but higher in priority than any inherited attributes.
- class vspyx.Communication.PDUTriggering
Bases:
Triggering
PDUTriggering describes on which channel the ComPDU is transmitted.
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- PDU :PDU
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) PDUTriggering
- class vspyx.Communication.PhysicalConnector
Bases:
vspyx.Runtime.Component
A connection between a Driver and a Cluster
- Cluster :Cluster
- Driver :vspyx.Frames.Driver
- Egress :vspyx.Core.Function_316d8f46e9
- EgressBlocked :bool
- EgressImmediate :vspyx.Core.Function_a6845211fe
- Ingress :vspyx.Core.Function_a6845211fe
- IngressBlocked :bool
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- AttachToCluster(self, cluster: Cluster, permanent: bool) Any
Attach this connector to the given cluster, removing the PhysicalConnector from a previously attached cluster, if present.
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- DefaultEgress(self, event: vspyx.Frames.NetworkEvent) Any
- DefaultEgressImmediate(self, event: vspyx.Frames.NetworkEvent) Connector.IngressActions
- DefaultIngress(self, event: vspyx.Frames.NetworkEvent) Connector.IngressActions
- IncrementEgressCounter(self) Any
- IncrementIngressCounter(self, action: Connector.IngressActions) Any
- static New(config: Any) PhysicalConnector
- RefreshConnections(self) Any
- class vspyx.Communication.PointProcessor
Bases:
vspyx.Runtime.Component
An element of a Communication::Stack which processes points
- class HandlerPriority
Bases:
enum.IntEnum
Enum where members are also (and must be) ints
- NoHandler = 0
- Normal = 1
- class PriorityGroup
Bases:
enum.IntEnum
Enum where members are also (and must be) ints
- Consumer = 1
- LAST = 2
- Tagger = 0
- OnPoint :vspyx.Core.Callback_66dc7ed174
- UseCount :int
Get the current number of objects which have configured this PointProcessor.
The UseCount starts at 1 when the PointProcessor is created.
This allows the PointProcessor to be removed by the Stack if all objects using it are removed.
- DecrementUseCount(self) int
Directly decrement the UseCount of the PointProcessor.
Usually you should use Stack::ReleasePointProcessor instead, which will atomically remove the PointProcessor when the UseCount becomes 0.
- Returns:
the new UseCount
- GetPriorityGroup(self) PointProcessor.PriorityGroup
Get the Priority Group for this PointProcessor.
- IncrementUseCount(self) int
Directly increment the UseCount of the PointProcessor.
The UseCount starts at 1 when the PointProcessor is created, so you are not required to call this function when creating a PointProcessor.
- Returns:
the new UseCount
- Invoke(self, consuming: vspyx.Runtime.Point.Consuming_1edf1860a4, options: InvocationOptions) bool
Invoke will be called by an Invoker PointProcessor when custom filtering logic dictates that this PointProcessor should process this point. Options are PointProcessor specific and are intended to direct this PointProcessor’s behavior. For instance, options may be used to ask that the PointProcessor feeds this point to a non-standard entry point of the stack.
- IsHandlerForPointWithResponse(self, consuming: vspyx.Runtime.Point.Consuming_1edf1860a4) PointProcessor.HandlerPriority
Returns the priority of the handler if this PointProcessor will handle the Point if given through SubmitPointAndGetResponse.
If NoHandler is returned, SubmitPointAndGetResponse should not be called.
- SetController(self, controller: Controller) Any
Set the controller associated with this PointProcessor, or std::nullopt for no association.
See GetController() for an explanation of controllers on PointProcessors.
- SubmitPoint(self, consuming: vspyx.Runtime.Point.Consuming_1edf1860a4) bool
SubmitPoint will be called by the Stack for every incoming point. If this processor will process this point, it should return true.
- SubmitPointAndGetResponse(self, consuming: vspyx.Runtime.Point.Consuming_1edf1860a4, timeout: Any) vspyx.Runtime.Point
This function will be called by the Stack if this PointProcessor declares the highest prioriry for the Point in IsHandlerForPointWithResponse.
The given promise is expected to be fulfilled or excepted at some point in the future.
- SuppressConfigurationUpdates(self) Any
This is called as a performance optimization when doing large updates to the configuration, such as when initially configuring the stack.
No Points will be received until UnsuppressConfigurationUpdates() is called.
- UnsuppressConfigurationUpdates(self) Any
Allow all suppressed confuiguration updates to take place.
See SuppressConfigurationUpdates() for more information.
- class vspyx.Communication.SOMEIPServiceInterfaceDeployment
Bases:
ServiceInterfaceDeployment
SOMEIPServiceInterfaceDeployment
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- ServiceInterfaceID :int
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) SOMEIPServiceInterfaceDeployment
- class vspyx.Communication.ServiceInterface
Bases:
vspyx.Core.ResolverObject
ServiceInterface
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) ServiceInterface
- class vspyx.Communication.ServiceInterfaceDeployment
Bases:
vspyx.Core.ResolverObject
ServiceInterfaceDeployment
- class vspyx.Communication.SignalGroupInstance
An instance of a signal group that is being processed by the Communication module. This class is short-lived, and referencing it outside of the immediate callback may result in unpredictable behavior.
- SignalValues :Any
- Valid :bool
- class vspyx.Communication.SignalInstance
An instance of a signal that is being processed by the Communication module. This class is short-lived, and referencing it outside of the immediate callback may result in unpredictable behavior.
- Valid :bool
- Value :vspyx.Runtime.Value
- class vspyx.Communication.SimResetEventPoint
Bases:
DataLinkEventPoint
See documentation for Frames.SimResetEvent
- Interesting :vspyx.Runtime.Point.Interesting
- NetworkEvent :vspyx.Frames.NetworkEvent
- GetAttribute(self, type: str) vspyx.Runtime.Value
Get an attribute of this point by its tag
If the attribute doesn’t exist, an empty Runtime::Value will be returned.
- class vspyx.Communication.SocketAddress
Bases:
vspyx.Core.ResolverObject
Represents the connection between an ApplicationEndpoint and Connectors, either in a unicast or multicast scenario.
- ApplicationEndpoint :ApplicationEndpoint
Retrieve the ApplicationEndpoint referenced by this SocketAddress if resolvable. Returns nullptr if not resolvable.
- MulticastConnectors :List[Connector]
Retrieve the multicast connectors associated with this socket address if resolvable. Unresolved items are not included.
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- UnicastConnector :Connector
Retrieve the unicast connector associated with this socket address, if set and resolvable. Returns nullptr if either condition is not met.
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- IsAssociatedWith(self, connector: Connector) bool
Returns true if the given connector is the unicast connector, or one of the multicast connectors, associated with this socket address.
- static New(config: Any) SocketAddress
- class vspyx.Communication.SocketConnectionBundle
Bases:
vspyx.Core.ResolverObject
A named group of SocketConnections, holding the connections themselves and common properties between them.
- class Side
Bases:
enum.IntEnum
Enum where members are also (and must be) ints
- Client = 2
- NONE = 0
- Server = 1
- LengthEncoding :vspyx.intrepidcs.vspyx.rpc.Communication.SoAdPduHeaderLengthEncodingEnumType
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- ServerPort :SocketAddress
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- GetSideForConnector(self, connector: Connector) SocketConnectionBundle.Side
- static New(config: Any) SocketConnectionBundle
- class vspyx.Communication.SourceHandle
Bases:
vspyx.Core.ResolverObject
Represents a data source and discovery object relationship
- class NotReadyReason
Bases:
enum.IntEnum
Enum where members are also (and must be) ints
- Initializing = 3
- NotApplicable = 0
- NotFound = 1
- SourceWentAway = 2
- Controllers :vspyx.Core.ResolverCollection
- Discovery :vspyx.Core.ResolverCollection
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- Source :vspyx.Frames.Source
- SourceState :vspyx.Frames.Source.State
- AddDiscovery(self, obj: vspyx.Core.ResolverObject) Any
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- CloneState(self) Any
- Close(self) vspyx.Core.Task_a3295bec43
- GetDriverFromDescription(self, description: str) vspyx.Frames.Driver
- GetNotReadyReason(self) SourceHandle.NotReadyReason
- static New(config: Any) SourceHandle
- Open(self) vspyx.Core.Task_a3295bec43
- ResetSource(self) vspyx.Core.Task_a3295bec43
- SearchFor(self) bool
- SetupDiscoveryClusters(self, forEachCluster: Any) Any
- Start(self) vspyx.Core.Task_a3295bec43
- Stop(self) vspyx.Core.Task_a3295bec43
- UpdateState(self, state: Any) Any
- class vspyx.Communication.Stack
Bases:
vspyx.Runtime.Component
A Communication Stack inside of an ECU
The Stack works as a basic Runtime::Point broadcasting system. When a Point is submitted, it is given to all* of the PointProcessors registered with the Stack, then sent out via the OnPoint handler.
Each of the PointProcessors contain filtering logic which determines whether they will handle the Point. When a PointProcessor generates a Point, it will give the Point back to the Stack so it can be distributed, both to other PointProcessors that may use the new Point, and to the outside world (Runtime::Environment, etc.).
PointProcessors can optionally specify a Controller. If they do,
they will only receive Points associated with that Controller.
- OnPoint :vspyx.Core.Callback_bf2c6c2abd
Called for every Point that the Stack processes or generates.
- AddPointProcessor(self, processor: PointProcessor) Any
Add the given PointProcessor to the Stack.
- GetPointProcessorByID(self, id: str) PointProcessor
Look up a PointProcessor in the Stack by its ID
- Returns:
the PointProcessor
- ReleasePointProcessor(self, processor: PointProcessor) bool
Atomically decrement the UseCount of the PointProcessor, and remove it if no other objects are keeping it in the Stack (UseCount == 0).
- Returns:
true if the PointProcessor was found and removed
- RemovePointProcessor(self, processor: PointProcessor) bool
Remove the given PointProcessor from the Stack.
Use ReleasePointProcessor instead for proper reference counting of the PointProcessor’s attachment.
- Returns:
true if the PointProcessor was found and removed
- SubmitNetworkEvent(self, event: vspyx.Frames.NetworkEvent, controller: Controller) Connector.IngressActions
Submit a NetworkEvent into the stack.
For frames, this will immediately create a new DataLinkPDUPoint with Direction::Receive and submit it into the stack.
For confirmations, this will attempt to match the confirmation to a DataLinkPDUPoint we’ve seen.
For other NetworkEvents, this will immediately create a new DataLinkEventPoint with direction::Receive and submit it into the stack.
- SubmitPoint(self, point: vspyx.Runtime.Point.Consuming_1edf1860a4) Connector.IngressActions
Submit a Point into the Stack for processing.
Use SubmitNetworkEvent if you have a NetworkEvent, a Point will be created for you.
- SubmitPointAndGetResponse(self, point: vspyx.Runtime.Point.Consuming_1edf1860a4) vspyx.Runtime.Point
- SubmitPointAndGetResponse(self, point: vspyx.Runtime.Point.Consuming_1edf1860a4, timeout: Any) vspyx.Runtime.Point
Submit a Point for which we expect a point in response.
Both the submitted Point and the response Point are expected out of OnPoint as well.
- SuppressConfigurationUpdates(self) Any
This is called as a performance optimization when doing large updates to the configuration, such as when initially configuring the Stack.
No Points will be dispatched to PointProcessors until UnsuppressConfigurationUpdates() is called.
- UnsuppressConfigurationUpdates(self) Any
Allow all suppressed confuiguration updates to take place.
See SuppressConfigurationUpdates() for more information.
- class vspyx.Communication.StdCPPImplementationDataType
Bases:
CPPImplementationDataType
StdCPPImplementationDataType
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) StdCPPImplementationDataType
- class vspyx.Communication.TDataPoint
Bases:
PDUPoint
TDataPoint
- Mtype :ISOStandardizedServicePrimitiveInterface.MessageType
- N_AI :Any
- N_Result :Any
- T_AE :Any
- T_SA :int
- T_TA :int
- T_TAtype :int
- static New(direction: vspyx.Runtime.Point.Direction, upstreamPoints: List[vspyx.Runtime.Point], controller: Controller, traceable: vspyx.Runtime.Traceable, Mtype: ISOStandardizedServicePrimitiveInterface.MessageType, T_SA: int, T_TA: int, T_TAtype: int, T_AE: Any, T_Data: vspyx.Core.BytesView, N_Result: Any) vspyx.Runtime.Point.Consuming_fe9efbf398
- class vspyx.Communication.Topology
Bases:
vspyx.Core.ResolverObject
Definition of a network topology
- Channels :vspyx.Core.ResolverCollection
- Clusters :vspyx.Core.ResolverCollection
- Connectors :vspyx.Core.ResolverCollection
- Controllers :vspyx.Core.ResolverCollection
- ECUs :vspyx.Core.ResolverCollection
- Frames :vspyx.Core.ResolverCollection
- PDUGroups :vspyx.Core.ResolverCollection
- PDUs :vspyx.Core.ResolverCollection
- Signals :vspyx.Core.ResolverCollection
- class vspyx.Communication.TopologySubset
Bases:
vspyx.Core.ResolverObject
Network topology subset
- Topology :Topology
- class vspyx.Communication.TrafficSink
Bases:
vspyx.Frames.Buffer
Represents a transaction buffer sink
- ClearFilters(self) Any
- ClearFrames(self) Any
- DetachFromChannel(self) Any
- FindIf(self, predicate: vspyx.Frames.Predicate) vspyx.Frames.NetworkEvent
- FindIf(self, predicate: vspyx.Frames.Predicate, offset: int) vspyx.Frames.NetworkEvent
- static FrameToString(event: vspyx.Frames.NetworkEvent, startTime: vspyx.Runtime.Timestamp, dissector: vspyx.Dissector.Engine) str
- FramesToString(self, dissector: vspyx.Dissector.Engine) str
- GetWatchForResults(self, predicate: vspyx.Frames.Predicate) List[vspyx.Frames.NetworkEvent]
- static New() TrafficSink
- WaitFor(self, predicate: vspyx.Frames.Predicate, sched: vspyx.Runtime.Scheduler, timeout: Any) List[vspyx.Frames.NetworkEvent]
- WatchFor(self, predicate: vspyx.Frames.Predicate) vspyx.Core.Event
- class vspyx.Communication.Triggering
Bases:
vspyx.Core.ResolverObject
Triggering describes the pairing of a communication object to a channel and defines the manner of triggering (timing information) and identification of the object on the channel.
A CANFrameTriggering would, for instance, describe the Arbitration ID that a particular frame is expected to be seen under on a particular channel. It would then go on to define the position of PDUs in the Frame when seen on that channel, which would be PDUTriggerings.
- OnPortsChanged :vspyx.Core.Callback_634bd5c449
Called when the Ports on this Triggering have changed.
It is not guaranteed that this will only be called if a Port has been added/removed.
- AddPort(self, port: ConnectorPort, permanent: bool) Any
Add a Port to this Triggering. If permanent is true, it will be added to the configuration.
The Port will not be owned by the Triggering.
- MakePort(self, direction: vspyx.intrepidcs.vspyx.rpc.Communication.Directions) ConnectorPort
Make a Port for this Triggering, setting the direction as specified and leaving the rest of the options as default.
The object will not be initialized as returned, nor will it be linked anywhere.
- class vspyx.Communication.UserDefinedPDU
Bases:
PDU
Represents a PDU with user-defined processing
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New() UserDefinedPDU
- static New(config: Any) UserDefinedPDU
Create a new generic asynchronously updated Traceable.
When working in Python, creating a more specific Traceable is correct rather than creating this generic one, unless you are implementing your own protocol.
- class vspyx.Communication.VSDB
Bases:
TopologySubset
Represents the Intrepid VehicleSpy DB network topology and message specification
- Objects :vspyx.Core.ResolverOwningCollection
- class vspyx.Communication.VariableDataPrototype
Bases:
AUTOSARDataPrototype
VariableDataPrototype
- OnConfigurationMutation :vspyx.Core.Callback_634bd5c449
- CloneConfiguration(self) Any
Return the immutable configuration of this object.
Except for the resolver parenting relationship, this represents the entire serializable state of the object.
- static New(config: Any) VariableDataPrototype
Create a new generic asynchronously updated Traceable.
When working in Python, creating a more specific Traceable is correct rather than creating this generic one, unless you are implementing your own protocol.