Skip to main content

Appendix

What You Will Do​

This appendix is reference material, not a chapter you follow along with. Use it after finishing ARXML Export to review your design, or to find again which value you entered in which chapter.

  • Checklist of the finished design — what the screen must show in a design finished through chapter 7
  • All value tables — every value entered in chapters 1 to 6
  • Project file layout — the files under design/ and the chapters that write them
  • Differences from the reference design — where your export differs from the reference design System_Design.arxml, and why
  • Common problems — validation messages and symptoms, and the chapter that fixes each

Before You Begin​

  • The values in this appendix are the same as in the bodies of chapters 1 to 7. If a value looks different, follow the body of that chapter.
  • The finished design is the state after Validation and ARXML Export. The VALIDATION panel shows No validation issues..

Checklist of the Finished Design​

Nodes and System​

  • The System editor (tab TopologyDesign:System) holds the nodes ECU, ZONE, SLAVE_ECU and HPC. The first three show the panel title ECU, and HPC shows HPC.
  • Selecting each of ECU, ZONE and SLAVE_ECU shows both SLEEP MODE SUPPORTED and WAKE-UP OVER BUS of POWER MANAGEMENT turned on.
  • Selecting HPC shows no POWER MANAGEMENT section.
  • VERSION in the SYSTEM panel is 1.0.0;POPCORNSAR, and ECU MAPPING holds four rows: ECU, ZONE, SLAVE_ECU, HPC.

CAN Bus​

  • ECU has the CAN controller CanController (CAN on, four bit timing fields 0) and the CAN connector CanConnector (CONTROLLER = CanController).
  • ZONE has the CAN controller CanCommController and the CAN connector CanConnector (CONTROLLER = CanCommController).
  • CHANNEL NAME of the cluster CanCluster is PhysicalChannel, and Connected Connectors (2) lists ZONE/CanConnector and ECU/CanConnector, in that order.
  • In Communication Cluster Configuration [CanCluster], the tabs NM CLUSTER, TRANSPORT PROTOCOL and TIME DOMAIN have a hollow dot in front of their names.

Ethernet Bus​

  • ZONE has the Ethernet controller EthernetCommController (MAC ADDRESS 11:22:ee:44:55:66) and the Ethernet connector EthernetConnector (CONTROLLER = EthernetCommController, UNICAST IPV4 ADDRESS 192.168.0.19, FIXED).
  • HPC has the Ethernet controller EthernetController (MAC ADDRESS 00:11:22:33:44:55) and the Ethernet connector EthernetConnector (CONTROLLER = EthernetController, UNICAST IPV4 ADDRESS 192.168.0.11, FIXED, MULTICAST IPV4 ADDRESS 224.0.0.1).
  • All three values of MAC LAYER TYPE are off on both Ethernet controllers.
  • CHANNEL NAME of the cluster EthernetCluster is PhysicalChannel, VLAN ID is 13, and Connected Connectors (2) lists ZONE/EthernetConnector and HPC/EthernetConnector, in that order.
  • In Communication Cluster Configuration [EthernetCluster], the tabs NM CLUSTER and TIME DOMAIN have a hollow dot in front of their names.

LIN Bus​

  • ECU has the LIN master controller LinController_Master (PROTOCOL VERSION LIN 2.0, TIME BASE 1 ms, TIME BASE JITTER 1 ms) and the LIN connector LinConnector_Master (CONTROLLER = LinController_Master).
  • SLAVE_ECU has the LIN slave controller LinSlaveController (PROTOCOL VERSION LIN 2.0) and the LIN connector LinConnector (CONTROLLER = LinSlaveController).
  • CHANNEL NAME of the cluster LinCluster is PhysicalChannel, IDLE TIMEOUT is empty, and Connected Connectors (2) lists SLAVE_ECU/LinConnector and ECU/LinConnector_Master, in that order.

Validation and Export​

  • The VALIDATION panel shows No validation issues., and the V icon in the footer has no badge.
  • The export folder has the four files TopologyDesign_COM.arxml, TopologyDesign_DataType.arxml, TopologyDesign_SWC.arxml and TopologyDesign_System.arxml, and the status bar of TopologyDesign_System.arxml and TopologyDesign_COM.arxml opened in the XML editor shows Schema: R25-11 and ✓ No problems.
  • The HPC connector in TopologyDesign_COM.arxml points at /System/MachineDesign/HPC/EthernetController and HPC_EthernetConnector_Endpoint.
  • The tab TopologyDesign:System carries no modified mark.

The LIN cluster with two connectors connected

Figure 8-1. The System editor canvas of the finished design (Figure 5-14 in LIN Bus). ECU and HPC are at the top, SLAVE_ECU and ZONE at the bottom, and the cluster squares in the middle row are, from the left, LinCluster, CanCluster and EthernetCluster. ① Auto Layout, ② Fit to View, ③ LinCluster, ④ CHANNEL NAME PhysicalChannel, the empty IDLE TIMEOUT and Connected Connectors (2). The positions of nodes and clusters depend on the Auto Layout result and are not design values. The figure shows the state before Ctrl+S, so the tab still carries the modified mark.

All Value Tables​

Project and System (Chapters 1 and 2)​

ItemValueChapter
Project nameTopologyDesign1
System nameSystem (default of a new project, unchanged)1
SYSTEM panel VERSION1.0.0;POPCORNSAR (default 1.0.0)2
SYSTEM panel ECU MAPPINGECU, ZONE, SLAVE_ECU, HPC (all No composition mapped, only checked)2

Nodes and Power Management (Chapters 1 and 2)​

Order addedRight-click positionMenu itemDefault nameNAMEPanel titleSLEEP MODE SUPPORTED / WAKE-UP OVER BUS
1Top left of the canvasAdd ECUECU_0ECUECUOn / on
2Top right of the canvasAdd ECUECU_0ZONEECUOn / on
3Bottom left of the canvasAdd ECUECU_0SLAVE_ECUECUOn / on
4Bottom right of the canvasAdd HPCHPC_0HPCHPCNo section

Keep the order ECU → ZONE → SLAVE_ECU → HPC. A node appears where you right-click, and Auto Layout is used from CAN Bus onward.

Partition of the reference designEXEC-IN-USER-MODEThis tutorial
ECU_Partition0 (ECU)trueNot created. The System editor has no input field for it
ECU_Partition1 (ECU)falseNot created. The System editor has no input field for it

Controllers (Chapters 3 to 5)​

NodeMenuPanel titleDefault nameNAMEOther valuesChapter
ECUAdd Controller › CANCAN CONTROLLERECU_Can_Controller_0CanControllerCAN on, SYNC JUMP WIDTH, PROPAGATION SEGMENT, TIME SEGMENT 1, TIME SEGMENT 2 all 03
ZONEAdd Controller › CANCAN CONTROLLERZONE_Can_Controller_0CanCommControllerCAN on, the four bit timing fields left empty3
ZONEAdd Controller › EthernetETHERNET CONTROLLERZONE_Ethernet_Controller_0EthernetCommControllerMAC ADDRESS 11:22:EE:44:55:66 entered (saved as 11:22:ee:44:55:66), MAC LAYER TYPE not clicked4
HPCAdd Controller › EthernetETHERNET CONTROLLERHPC_Ethernet_Controller_0EthernetControllerMAC ADDRESS 00:11:22:33:44:55, MAC LAYER TYPE not clicked4
ECUAdd Controller › LIN MasterLIN MASTERECU_LinMaster_Controller_0LinController_MasterPROTOCOL VERSION LIN 2.0, TIME BASE 1 ms, TIME BASE JITTER 1 ms, WAKE-UP BY CONTROLLER not clicked5
SLAVE_ECUAdd Controller › LIN SlaveLIN SLAVESLAVE_ECU_LinSlave_Controller_0LinSlaveControllerPROTOCOL VERSION LIN 2.0. The fields below it are left empty5

For TIME BASE and TIME BASE JITTER, change the unit box to ms first and then type 1. The saved value is 0.001, in seconds.

Connectors (Chapters 3 to 5)​

NodeMenuDefault nameNAMECONTROLLERCluster / channelChapter
ECUAdd Connector › CANECU_Can_Connector_0CanConnectorCanControllerCanCluster / PhysicalChannel3
ZONEAdd Connector › CANZONE_Can_Connector_0CanConnectorCanCommControllerCanCluster / PhysicalChannel3
ZONEAdd Connector › EthernetZONE_Ethernet_Connector_0EthernetConnectorEthernetCommControllerEthernetCluster / PhysicalChannel4
HPCAdd Connector › EthernetHPC_Ethernet_Connector_0EthernetConnectorEthernetControllerEthernetCluster / PhysicalChannel4
ECUAdd Connector › LINECU_Lin_Connector_0LinConnector_MasterLinController_MasterLinCluster / PhysicalChannel5
SLAVE_ECUAdd Connector › LINSLAVE_ECU_Lin_Connector_0LinConnectorLinSlaveControllerLinCluster / PhysicalChannel5

After connecting, CONNECTED CHANNEL shows EthernetCluster / PhysicalChannel (VLAN: 13) on the Ethernet connectors and LinCluster / PhysicalChannel on the LIN connectors.

Clusters and Channels (Chapters 3 to 5)​

ClusterCreated fromDefault namePanel titleCHANNEL NAMEChannel valueConnected Connectors orderChapter
CanClusterCanConnector of ZONE › + › Create CommunicationCluster [Can]CanCluster_0CAN CLUSTERPhysicalChannel (default)—ZONE/CanConnector, ECU/CanConnector3
EthernetClusterEthernetConnector of ZONE › + › Create CommunicationCluster [Ethernet]EthernetCluster_0ETHERNET CLUSTERPhysicalChannel (default)VLAN ID 13ZONE/EthernetConnector, HPC/EthernetConnector4
LinClusterLinConnector of SLAVE_ECU › + › Create CommunicationCluster [Lin]LinCluster_0LIN CLUSTERPhysicalChannel (default)IDLE TIMEOUT empty (10 ms is refused)SLAVE_ECU/LinConnector, ECU/LinConnector_Master5

The second connector is connected with + › Connect to Channel... › the cluster name › PhysicalChannel. The Ethernet channel appears in the menu as PhysicalChannel (VLAN: 13). You do not enter a baud rate. None of the buttons of BAUDRATE (ARBITRATION, KBPS) in the CAN CLUSTER panel or BAUDRATE (BPS) in the LIN CLUSTER panel is on, but PAIO saves 500000 into CanCluster and 19200 into LinCluster.

Endpoints and VLAN (Chapter 4)​

Reference design elementValueWhere you enter itExport name
ZONE_Endpoint192.168.0.19 (FIXED)UNICAST IPV4 ADDRESS and FIXED of ADDRESS SOURCE on the ZONE connectorZONE_EthernetConnector_Endpoint
HPC_Endpoint192.168.0.11 (FIXED)UNICAST IPV4 ADDRESS and FIXED of ADDRESS SOURCE on the HPC connectorHPC_EthernetConnector_Endpoint
SOMEIP_SD_Multicast224.0.0.1MULTICAST IPV4 ADDRESS on the HPC connector. MULTICAST PORT is left emptyHPC_EthernetConnector_Multicast
Vlan_13VLAN-IDENTIFIER 13VLAN ID of the channelVLAN_13

NM Clusters and TP Configurations (Chapters 3 to 5)​

Network management (NM), the transport protocol (TP) and the time domain are turned on per cluster with Enable on the tabs of the Communication Cluster Configuration window that opens when you double-click the cluster. A new cluster has them all off. The reference design has neither NM nor TP, so this tutorial leaves them off, and the design has no NM cluster and no TP configuration.

ClusterTabs of the windowTabs left offChapter
CanClusterCLUSTER, NM CLUSTER, TRANSPORT PROTOCOL, TIME DOMAINNM CLUSTER, TRANSPORT PROTOCOL, TIME DOMAIN (hollow dot in front of the name)3
EthernetClusterCLUSTER, NM CLUSTER, TIME DOMAINNM CLUSTER, TIME DOMAIN (hollow dot in front of the name)4
LinClusterCLUSTER, TRANSPORT PROTOCOLTRANSPORT PROTOCOL. Chapter 5 does not open the window5

A LIN cluster has no NM CLUSTER tab, because NM does not apply to LIN.

Defects in the Validation Chapter (Chapter 6)​

Validation starts from a design that contains the three defects below and restores the original values. The fixed design is the same as the design at the end of LIN Bus.

LocationDefect valueFixed valueValidation error
EthernetConnector of HPC › UNICAST IPV4 ADDRESS224.0.0.1192.168.0.11constr_3288
LinConnector of SLAVE_ECU › CONTROLLEREmpty (Select controller...)LinSlaveControllerconstr_5398
LinSlaveController of SLAVE_ECU › PROTOCOL VERSIONEmpty (no button on)LIN 2.0constr_5449

Project File Layout​

The files of a project finished through chapter 7 are listed below. The right column names the chapters that create or change each file.

TopologyDesign/
├── TopologyDesign.io.prj
├── design/
│ ├── IVC.io.model Chapters 1 to 6
│ ├── SYSTEM.io.model Chapters 1, 2
│ └── VFB.io.model Chapter 1
└── export/
├── TopologyDesign_COM.arxml Chapter 7
├── TopologyDesign_DataType.arxml Chapter 7
├── TopologyDesign_SWC.arxml Chapter 7
└── TopologyDesign_System.arxml Chapter 7
  • The nodes, controllers, connectors and clusters are all stored in the single file IVC.io.model, the model that the System editor edits. The design has no NM or TP configuration. View state such as node positions and the canvas zoom is stored in this file as well, and is not exported to ARXML.
  • SYSTEM.io.model holds the information of the system System, such as VERSION. The SYSTEM panel writes VERSION into it as you type in ECU Properties. ECU MAPPING shows the nodes of the canvas and is not stored in this file.
  • VFB.io.model is a file the new project creates, and this tutorial does not change it.
  • The export does not change the files in design/ and writes only to export/.
  • The project folder also has the folders doc, code, workflow and import. This tutorial does not use them.

Differences from the Reference Design​

Your export has almost the same design content as the reference design file System_Design.arxml. The four nodes with their controllers and connectors, the sleep and bus wake-up settings, the three clusters and their channels, the addresses of the three endpoints, the VLAN ID and the system version are all there. Only the two partitions are missing as whole elements.

Reference designYour export
Files14
Elements with a name (packages excluded)2979
Elements with the same path11
Elements moved to another package2222
Elements renamed in the same place44
Elements only in the reference design2—
Elements only in your export—52

Of the 27 elements that have a counterpart, 14 differ in values or references and 13 have the same values and references. The line numbers and the reason for each element are in the section "How Your Export Differs from the Reference Design" of ARXML Export.

Deliberate Departures in This Tutorial​

DifferenceReasonChapter
EthernetConnector of HPC has an extra COMM-CONTROLLER-REF (/System/MachineDesign/HPC/EthernetController), and its unicast endpoint is HPC_EthernetConnector_Endpoint (192.168.0.11) instead of ZONE_EndpointIn the reference design this connector has no controller and points at the address of ZONE. Following it would give the two connectors the same address 192.168.0.19, and HPC_Endpoint would be used by no connector4, 7
The two Ethernet controllers have no MAC-LAYER-TYPE X-MIIClicking XMII of MAC LAYER TYPE exports XMII, a value not in the schema, which the schema check of the XML editor reports as an error4

PAIO Naming Rules​

DifferenceContent
Node packages/System/VehicleTopology/Ecu/<node> becomes /System/EcuInstance/<node>. The HPC node is placed as a MACHINE-DESIGN in /System/MachineDesign/HPC
Cluster packages/System/VehicleTopology/Cluster/… becomes /System/CommunicationCluster/Can/…, /System/CommunicationCluster/Ethernet/… and /System/CommunicationCluster/Lin/…
System categoryCATEGORY SYSTEM_DESCRIPTION of SYSTEM becomes SYSTEM_DESIGN_DESCRIPTION
Endpoint namesZONE_Endpoint, HPC_Endpoint and SOMEIP_SD_Multicast become ZONE_EthernetConnector_Endpoint, HPC_EthernetConnector_Endpoint and HPC_EthernetConnector_Multicast
VLAN nameVlan_13 becomes VLAN_13. VLAN-IDENTIFIER 13 is the same
MAC address notation11:22:EE:44:55:66 goes out in lowercase as 11:22:ee:44:55:66. It is the same address
Empty CAN controllerCanCommController has no empty CAN-COMMUNICATION-CONTROLLER-CONDITIONAL. The design content is the same

Elements PAIO Adds on Its Own​

ElementContentChapter
BAUDRATE 500000, 19200Values PAIO saves into a new CAN cluster and a new LIN cluster3, 5
SERVICE-DISCOVERY-CONFIGS of HPC, 2 SD socket elementsWhen the HPC connector has a MULTICAST IPV4 ADDRESS, the export creates the SD configuration, the socket HPC_EthernetConnector_Multicast_Socket and the APPLICATION-ENDPOINT ApplicationEndpoint4
ASSIGNMENT-PRIORITY 0 and TTL 0 of the multicast endpointValues the export puts into a multicast endpoint4
49 basic data typesThe SW-BASE-TYPE, IMPLEMENTATION-DATA-TYPE and other data type elements of TopologyDesign_DataType.arxml. This design does not use them7
The root composition SystemThe ROOT-SW-COMPOSITION-PROTOTYPE that the system of a new project has1

The export has no NM or TP elements, because this design leaves NM and TP off on every cluster that offers them.

Values You Do Not Create on Screen​

Reference design valueLocationYour exportChapter
ECU_Partition0 (EXEC-IN-USER-MODE true), ECU_Partition1 (false)ECUNone. The System editor has no field for partitions2
PROTOCOL-NAME CAN-FDCanClusterNone. PROTOCOL NAME of the CAN CLUSTER panel is left empty3
PROTOCOL-NAME IEEE 802.3EthernetClusterNone. The ETHERNET CLUSTER panel has no PROTOCOL section4
CATEGORY WIREDThe Ethernet channel, 2 controllers, 2 connectorsNone. There is no field for it4
WAKE-UP-BY-CONTROLLER-SUPPORTED falseEthernetController of HPCNone. The ETHERNET CONTROLLER panel has no field for it4
WAKE-UP-BY-CONTROLLER-SUPPORTED trueLinController_MasterNone. WAKE-UP BY CONTROLLER of the LIN MASTER panel is not clicked5
BUS-IDLE-TIMEOUT-PERIOD 0.01PhysicalChannel of LinClusterNone. IDLE TIMEOUT accepts only 0.1 seconds or more5
CREATE-ECU-WAKEUP-SOURCE falseEthernetConnector of HPCNone. You do not touch PARTIAL NETWORK › CREATE ECU WAKEUP SOURCE of the connector, so it has no value, and items without a value are left out of the export7

Defects on the Reference Design Side​

DifferenceContent
EthernetConnector of HPCIt has no COMM-CONTROLLER-REF, and its unicast endpoint is the address of ZONE, ZONE_Endpoint (192.168.0.19). HPC_Endpoint (192.168.0.11) is used by no connector. The error constr_5398 for a connector without a controller checks only the connectors of ECU nodes, so importing the reference design into PAIO as is and validating it gives No validation issues.

In addition, the reference design has a UUID attribute on all 33 elements with a name, and your export has none. The element order also differs. The namespace http://autosar.org/schema/r4.0 and the schema AUTOSAR_00054.xsd are the same.

Common Problems​

Symptom or validation messageCauseFixChapter
Connector "EthernetConnector" unicast IPv4 "224.0.0.1" is not in the unicast range (first octet 224 > 223). (constr_3288)UNICAST IPV4 ADDRESS of the HPC connector holds a multicast address. Clicking the row selects the connector of ZONEClick the HPC connector directly on the canvas, enter 192.168.0.11 in UNICAST IPV4 ADDRESS and press Ctrl+SEthernet Bus, Validation
Connector "LinConnector" on "SLAVE_ECU" has no commController reference; each CommunicationConnector shall reference exactly one communication controller. (constr_5398)CONTROLLER of the connector is empty. Clicking the row selects this connectorChoose LinSlaveController in the CONTROLLER list and press Ctrl+SLIN Bus, Validation
LIN slave controller "LinSlaveController" on "SLAVE_ECU" has no protocolVersion. (constr_5449)No button of PROTOCOL VERSION is on. Clicking the row selects the node SLAVE_ECUClick the controller square inside the node, click LIN 2.0 under PROTOCOL VERSION and press Ctrl+SLIN Bus, Validation
TIME BASE becomes one second, IDLE TIMEOUT ten secondsThe unit box defaults to sChange the unit box to ms first, then type the number. For IDLE TIMEOUT, delete the number and press the Tab key so that the field is emptyLIN Bus
An extra cluster appearsCreate CommunicationCluster was clicked on the + badge of the second connectorConnect the second connector to the channel created earlier with Connect to Channel... on its + badgeCAN Bus, Ethernet Bus, LIN Bus
The order of Connected Connectors is the reverse of the reference designThe connector from which the cluster is created becomes the first connector of the channelCreate the CAN and Ethernet clusters from the connector of ZONE, and the LIN cluster from the connector of SLAVE_ECUCAN Bus, Ethernet Bus, LIN Bus
The exported Ethernet controller contains XMII, and the XML editor reports a schema errorXMII of MAC LAYER TYPE was clicked. The schema value is X-MIIDo not click MAC LAYER TYPEEthernet Bus
All three values of ADDRESS SOURCE are offFIXED was not clickedClick FIXED of ADDRESS SOURCE on both Ethernet connectorsEthernet Bus
A MAC ADDRESS typed in uppercase is shown in lowercasePAIO stores MAC addresses in lowercaseNo fix is needed. It is the same addressEthernet Bus
A value entered in the property panel is not appliedA field in the property panel commits its value only when you leave the fieldPress the Tab key after entering a valueCAN Bus, Ethernet Bus, LIN Bus
Clicking the empty canvas does not clear the selectionThe click landed on the edge of the canvas, especially near the toolbar at the bottomClick the middle of the canvas where there is no nodeProject and Nodes
The line numbers quoted in ARXML Export do not match your exportThe nodes were added in a different order. The ECU nodes are saved and exported in the order you add themAdd the nodes in the order ECU → ZONE → SLAVE_ECU → HPCProject and Nodes
The + badge of the HPC connector is hard to click, or the third menu covers the earlier onesThe badge of the HPC connector is small, and near the right edge of the screen the menu opens to the leftZoom in before clicking, or close the menu, click Zoom Out once more and open it againEthernet Bus

Checklist​

  • Every item of "Checklist of the Finished Design" matches.
  • The values in "All Value Tables" match the values on the screens of your design.
  • The files under design/ match "Project File Layout".
  • The only differences between your export and the reference design are those in "Differences from the Reference Design".

Next Step​

To change the design, go back to the chapter concerned, change the value, then follow Validation and ARXML Export again. To start over, return to the Network Topology Design Tutorial.