diff --git a/io.catenax.fleet.diagnostic_data/2.0.0/DiagnosticData.ttl b/io.catenax.fleet.diagnostic_data/2.0.0/DiagnosticData.ttl new file mode 100644 index 00000000..7d30bbb3 --- /dev/null +++ b/io.catenax.fleet.diagnostic_data/2.0.0/DiagnosticData.ttl @@ -0,0 +1,570 @@ +####################################################################### +# Copyright (c) 2022, 2024 Robert Bosch GmbH +# Copyright (c) 2022, 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +# Copyright (c) 2022, 2024 Volkswagen AG +# Copyright (c) 2022, 2024 ZF Friedrichshafen AG +# Copyright (c) 2022, 2024 SAP SE +# Copyright (c) 2022, 2024 Siemens AG +# Copyright (c) 2022, 2024 Contributors to the Eclipse Foundation +# Copyright (c) 2022 Mercedes Benz AG +# +# See the NOTICE file(s) distributed with this work for additional +# information regarding copyright ownership. +# +# This work is made available under the terms of the +# Creative Commons Attribution 4.0 International (CC-BY-4.0) license, +# which is available at +# https://creativecommons.org/licenses/by/4.0/legalcode. +# +# SPDX-License-Identifier: CC-BY-4.0 +####################################################################### +@prefix samm: . +@prefix samm-c: . +@prefix samm-e: . +@prefix unit: . +@prefix rdf: . +@prefix rdfs: . +@prefix xsd: . +@prefix : . +@prefix ext-uuid: . + +:DiagnosticData a samm:Aspect ; + samm:description "A Catena-X semantic data model for a list of vehicle diagnostic sessions."@en ; + samm:properties ( :diagnosticSessions [ samm:property :metaInformation; samm:optional true ] ) ; + samm:operations ( ) ; + samm:events ( ) . + +:diagnosticSessions a samm:Property ; + samm:preferredName "Diagnostic sessions"@en ; + samm:description "A list of diagnostic sessions."@en ; + samm:characteristic :SessionList . + +:metaInformation a samm:Property ; + samm:preferredName "Meta information"@en ; + samm:description "This meta information is valid for all entries in this data set. The meta information is used to tell the data consumer which selection criteria were applied by the data provider. "@en ; + samm:characteristic :MetaCharacteristic . + +:SessionList a samm-c:List ; + samm:preferredName "Diagnostic sessions"@en ; + samm:description "A list of diagnostic sessions coming from multiple vehicles."@en ; + samm:dataType :DiagnosticSession . + +:MetaCharacteristic a samm:Characteristic ; + samm:preferredName "MetaCharacteristic"@en ; + samm:description "Characteristic for the meta information."@en ; + samm:dataType :MetaInformation . + +:DiagnosticSession a samm:Entity ; + samm:preferredName "Diagnostic Session"@en ; + samm:description "One diagnostic session of one vehicle: Either this is a diagnostic session done in a workshop or via over-the-air diagnostic."@en ; + samm:properties ( [ samm:property :recordStatus; samm:optional true ] :sessionId [ samm:property :anonymizedVIN; samm:optional true ] [ samm:property :catenaXQualityTaskId; samm:optional true ] [ samm:property :catenaXVehicleId; samm:optional true ] [ samm:property :countryCode; samm:optional true ] [ samm:property :diagnosticSoftwareName; samm:optional true ] [ samm:property :diagnosticSoftwareVersion; samm:optional true ] [ samm:property :mileage; samm:optional true ] [ samm:property :sessionEnd; samm:optional true ] [ samm:property :sessionStart; samm:optional true ] [ samm:property :vehicleSoftwareCategory; samm:optional true ] [ samm:property :vehicleSoftwareVersion; samm:optional true ] [ samm:property :workshop; samm:optional true ] [ samm:property :ecuList; samm:optional true ] [ samm:property :procedures; samm:optional true ] ) . + +:MetaInformation a samm:Entity ; + samm:preferredName "Meta Information"@en ; + samm:description "This entity groups all meta information properties. Meta information properties give hints for a Catena-X data consumer to better understand, how this data set was created on the Catena-X data provider side."@en ; + samm:properties ( :selectionCriteria [ samm:property :selectionStart; samm:optional true ] [ samm:property :selectionEnd; samm:optional true ] ) . + +:recordStatus a samm:Property ; + samm:preferredName "Record status"@en ; + samm:description "The record operation enumeration can be used to realize delta update concept.\nDelta update concept means:\n- You transfer an initial load of data\n- After the first week only the delta to the initial load is transferred\n\n\nThe record status describes whether this record is:\n- new=>This record is transferred the first time\n- update=> Some properties of this record have changed compared to a previous transfer\n- delete=> This record was transferred in the initial load or in a previous delta update, but is not used any more and therefore it should be deleted on data consumer side\n- same=> This record was transferred in the initial load or in a previous delta update"@en ; + samm:characteristic :RecordStatusEnumeration ; + samm:exampleValue "update" . + +:sessionId a samm:Property ; + samm:preferredName "Session identifier"@en ; + samm:description "A oem-specific session identifier that is unique in this company."@en ; + samm:characteristic :UniqueID ; + samm:exampleValue "3747429FGH382923974682_Session_2023-11-04T08:00:45" . + +:anonymizedVIN a samm:Property ; + samm:preferredName "Anonymized VIN"@en ; + samm:description "OEM-specific hashed VIN. Unique within OEM."@en ; + samm:characteristic :UniqueID ; + samm:exampleValue "3747429FGH382923934abcf74682" . + +:catenaXQualityTaskId a samm:Property ; + samm:preferredName "Quality Task ID"@en ; + samm:description "The fully anonymous and unique Catena-X ID of this quality task. This id is unique inside Catena-X data space."@en ; + samm:characteristic ext-uuid:UuidV4Trait ; + samm:exampleValue "430f56d3-1234-1234-1234-aaaabbbbcccc" . + +:catenaXVehicleId a samm:Property ; + samm:preferredName "Vehicle Catena-X Identifier"@en ; + samm:description "A unique identifier for the vehicle in the Catena-X data space."@en ; + samm:characteristic ext-uuid:UuidV4Trait ; + samm:exampleValue "580d3adf-1978-44a0-a214-13d6ceed9379" . + +:countryCode a samm:Property ; + samm:preferredName "Country code"@en ; + samm:description "Country code in ISO 3166-1 alpha-3 codes where this session took place"@en ; + samm:characteristic :CountryCodeTrait ; + samm:exampleValue "DEU" . + +:diagnosticSoftwareName a samm:Property ; + samm:preferredName "Diagnostic Software"@en ; + samm:description "The name of the diagnostic software that was used."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Pontiac Car Diagnostic software" . + +:diagnosticSoftwareVersion a samm:Property ; + samm:preferredName "Diagnostic software version"@en ; + samm:description "The version of the used diagnostic software"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "V.411 Patch 2023-02" . + +:mileage a samm:Property ; + samm:preferredName "Mileage"@en ; + samm:description "Mileage counter of the car."@en ; + samm:characteristic :MileageCounter ; + samm:exampleValue "23500"^^xsd:nonNegativeInteger . + +:sessionEnd a samm:Property ; + samm:preferredName "Selection end timestamp"@en ; + samm:description "Describes the end point for this diagnostic session."@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2023-12-31T23:59:59"^^xsd:dateTime . + +:sessionStart a samm:Property ; + samm:preferredName "Selection start timestamp"@en ; + samm:description "Describes the starting point for this diagnostic session."@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2023-01-01T00:00:00"^^xsd:dateTime . + +:vehicleSoftwareCategory a samm:Property ; + samm:preferredName "Vehicle software category"@en ; + samm:description "Software category of this car during the session - only available for OEMs that have a software category on vehicle level."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "TZGH64738" . + +:vehicleSoftwareVersion a samm:Property ; + samm:preferredName "Vehicle software version"@en ; + samm:description "Software version of this car during the session - only available for OEMs that have a software category on vehicle level."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "3.5.0001.001" . + +:workshop a samm:Property ; + samm:preferredName "Workshop"@en ; + samm:description "Groups workshop-related properties"@en ; + samm:characteristic :WorkshopCharacteristic . + +:ecuList a samm:Property ; + samm:preferredName "ECU list"@en ; + samm:description "List of ECUs that had an entry in its internal failure memory during the diagnostic session"@en ; + samm:characteristic :EcuList . + +:procedures a samm:Property ; + samm:preferredName "Procedures"@en ; + samm:description "List of procedures / sub-procedures."@en ; + samm:characteristic :ProcedureList . + +:selectionCriteria a samm:Property ; + samm:preferredName "Selection criteria"@en ; + samm:description "Describes the selection criteria a Catena-X data provider has applied to create this data set."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Export of diagnostic data set that belongs to one or more Catena-X Quality tasks." . + +:selectionStart a samm:Property ; + samm:preferredName "Selection start"@en ; + samm:description "Describes the starting point for providing records in this data set."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "2023-01-01T00:00:00" . + +:selectionEnd a samm:Property ; + samm:preferredName "Selection end"@en ; + samm:description "Describes the end point for providing records in this data set."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "2023-12-31T23:59:59" . + +:RecordStatusEnumeration a samm-c:Enumeration ; + samm:preferredName "Record status enumeration"@en ; + samm:description "Defining the enumeration for the record status"@en ; + samm:dataType xsd:string ; + samm-c:values ( "new" "update" "delete" "same" ) . + +:UniqueID a samm:Characteristic ; + samm:preferredName "unique ID"@en ; + samm:description "This Characteristic describes a property that is truly unque either inside the Company that is providing the data or even in Catena-X dataspace. Only one property in a semantic entity should be a uniqueID. Unique ids can be used to link a data set with other semantic models."@en ; + samm:dataType xsd:string . + +:CountryCodeTrait a samm-c:Trait ; + samm:preferredName "Production Country Code Trait"@en ; + samm:description "Trait to ensure standard data format for country code"@en ; + samm-c:baseCharacteristic :CountryCodeCharacteristic ; + samm-c:constraint :CountryCodeRegularExpression . + +:MileageCounter a samm-c:Measurement ; + samm:preferredName "Mileage"@en ; + samm:description "The mileage counter of the car."@en ; + samm:dataType xsd:nonNegativeInteger ; + samm-c:unit unit:kilometre . + +:WorkshopCharacteristic a samm:Characteristic ; + samm:preferredName "Workshop properties"@en ; + samm:description "Groups all workshop properties."@en ; + samm:dataType :WorkshopProperties . + +:EcuList a samm-c:List ; + samm:preferredName "ECU List"@en ; + samm:description "A list of electronic control units in this diagnostic session."@en ; + samm:dataType :ECU . + +:ProcedureList a samm-c:List ; + samm:preferredName "Procedures"@en ; + samm:description "A list of procedure calls in the diagnostic software."@en ; + samm:dataType :ProcedureCall . + +:CountryCodeCharacteristic a samm:Characteristic ; + samm:preferredName "Country Code Characteristic"@en ; + samm:description "ISO 3166-1 alpha-3 – three-letter country codes "@en ; + samm:see ; + samm:dataType xsd:string . + +:CountryCodeRegularExpression a samm-c:RegularExpressionConstraint ; + samm:preferredName "Country Code Regular Expression"@en ; + samm:description "Regular Expression that ensures a three-letter code "@en ; + samm:value "^[A-Z][A-Z][A-Z]$" . + +:WorkshopProperties a samm:Entity ; + samm:preferredName "Workshop Properties"@en ; + samm:description "All properties to clearly identify a workshop."@en ; + samm:properties ( :workShopId [ samm:property :latitude; samm:optional true ] [ samm:property :longitude; samm:optional true ] ) . + +:ECU a samm:Entity ; + samm:preferredName "ECU"@en ; + samm:description "A single ECU that is present/has a DTC set in the diagnostic session"@en ; + samm:properties ( :oemSerialNumber [ samm:property :assemblyPartNumberVersion; samm:optional true ] [ samm:property :catenaXPartId; samm:optional true ] [ samm:property :calibrationVersion; samm:optional true ] [ samm:property :hwPartNumber; samm:optional true ] [ samm:property :hwVersion; samm:optional true ] [ samm:property :oemPartName; samm:optional true ] [ samm:property :oemPartNumber; samm:optional true ] [ samm:property :readOutDate; samm:optional true ] [ samm:property :swPartNumber; samm:optional true ] [ samm:property :swVersion; samm:optional true ] [ samm:property :variantCoding; samm:optional true ] [ samm:property :dtcs; samm:optional true ] ) . + +:ProcedureCall a samm:Entity ; + samm:preferredName "Procedure Call"@en ; + samm:description "One procedure call in the diagnostic software."@en ; + samm:properties ( :procedureID [ samm:property :procedureDescription; samm:optional true ] [ samm:property :procedureDescription; samm:optional true ] [ samm:property :procedureEnd; samm:optional true ] [ samm:property :procedureStart; samm:optional true ] [ samm:property :procedureResult; samm:optional true ] [ samm:property :ecuList; samm:optional true ] [ samm:property :subProcedures; samm:optional true ] ) . + +:workShopId a samm:Property ; + samm:preferredName "OEM Workshop ID"@en ; + samm:description "OEM-specific identifier for a workshop."@en ; + samm:characteristic :UniqueID ; + samm:exampleValue "workshop-4563328" . + +:latitude a samm:Property ; + samm:preferredName "Latitude"@en ; + samm:description "Latitude property for GPS coordinates."@en ; + samm:characteristic :LatitudeTrait ; + samm:exampleValue "9.165877215355193"^^xsd:float . + +:longitude a samm:Property ; + samm:preferredName "Longitude"@en ; + samm:description "Longitude property for GPS coordinates."@en ; + samm:characteristic :LongitudeTrait ; + samm:exampleValue "48.81109356017604"^^xsd:float . + +:oemSerialNumber a samm:Property ; + samm:preferredName "OEM serial number"@en ; + samm:description "Serial part number of the original equipment manufacturer (OEM). Typically the OEM is installing the part in the car. A serial part number is unique for every single part."@en ; + samm:characteristic :UniqueID ; + samm:exampleValue "ECU20646005020221" . + +:assemblyPartNumberVersion a samm:Property ; + samm:preferredName "ECU assembly part number version"@en ; + samm:description "OEM-specific ecu assembly version"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "0001" . + +:catenaXPartId a samm:Property ; + samm:preferredName "Catena-X Identifier of this part"@en ; + samm:description "The fully anonymous and unique Catena-X ID of this part. This id is unique inside Catena-X data space."@en ; + samm:characteristic ext-uuid:UuidV4Trait ; + samm:exampleValue "430f56d3-1234-1234-1234-efab12341234" . + +:calibrationVersion a samm:Property ; + samm:preferredName "Calibration version"@en ; + samm:description "Calibration version that was put on this ecu. A calibration file works like a parameter file for the ecu software."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Calibration_file_4711" . + +:hwPartNumber a samm:Property ; + samm:preferredName "ECU HW part number"@en ; + samm:description "hardware part number of ECU"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "04C907309AE" . + +:hwVersion a samm:Property ; + samm:preferredName "ECU HW version"@en ; + samm:description "hardware version of ECU"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "0556A" . + +:oemPartName a samm:Property ; + samm:preferredName "Oem part name"@en ; + samm:description "Part name as defined by the original equipment manufacturer (OEM). Typically the OEM is installing the part in the car."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Gear box M63" . + +:oemPartNumber a samm:Property ; + samm:preferredName "OEM part number"@en ; + samm:description "Part number of the original equipment manufacturer (OEM). Typically the OEM is installing the part in the car. A part number is NOT unique: All parts of the same kind share the same part number."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "FZ206460050202212" . + +:readOutDate a samm:Property ; + samm:preferredName "Read out date"@en ; + samm:description "Date when this ECU information was read out from the diagnostic session"@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2022-01-30T14:45:54"^^xsd:dateTime . + +:swPartNumber a samm:Property ; + samm:preferredName "ECU SW part number"@en ; + samm:description "SW part number of this ecu"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "04C906026BH" . + +:swVersion a samm:Property ; + samm:preferredName "ECU SW version"@en ; + samm:description "current version of the software on this ecu"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "0001" . + +:variantCoding a samm:Property ; + samm:preferredName "Variant coding"@en ; + samm:description "Variant coding that was put on this ecu. Variant coding tells the ecus software how to behave."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Variant: No trailer." . + +:dtcs a samm:Property ; + samm:description "list of diagnostic trouble codes"@en ; + samm:characteristic :DTCList . + +:procedureID a samm:Property ; + samm:preferredName "Procedure identifier"@en ; + samm:description "A unique identifier for this procedure/sub-procedure call"@en ; + samm:characteristic :UniqueID ; + samm:exampleValue "ABS_upgrade_deactivate" . + +:procedureDescription a samm:Property ; + samm:preferredName "Procedure Description"@en ; + samm:description "An optional description for this procedure"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Deactivation ABS upgrade capability." . + +:procedureEnd a samm:Property ; + samm:preferredName "Procedure end"@en ; + samm:description "End date and time for this procedure call."@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2023-11-27T08:00:03"^^xsd:dateTime . + +:procedureStart a samm:Property ; + samm:preferredName "Procedure start"@en ; + samm:description "Start date and time for this procedure call."@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2023-11-27T08:00:00"^^xsd:dateTime . + +:procedureResult a samm:Property ; + samm:preferredName "Procedure result"@en ; + samm:description "Result of the procedure"@en ; + samm:characteristic :ProcedureResultCharacterisitc ; + samm:exampleValue "ok" . + +:subProcedures a samm:Property ; + samm:preferredName "Sub procedures"@en ; + samm:description "A list of sub-procedures"@en ; + samm:characteristic :SubProceduresList . + +:LatitudeTrait a samm-c:Trait ; + samm:preferredName "Latitude Trait"@en ; + samm:description "Trait to define the latitude."@en ; + samm-c:baseCharacteristic :Float ; + samm-c:constraint :ConstraintLatitude . + +:LongitudeTrait a samm-c:Trait ; + samm:preferredName "Longitude Trait"@en ; + samm:description "Trait to define the longitude."@en ; + samm-c:baseCharacteristic :Float ; + samm-c:constraint :ConstraintLongitude . + +:DTCList a samm-c:List ; + samm:preferredName "DTC List"@en ; + samm:description "A list of DTCs that are present in this diagnostic session."@en ; + samm:dataType :DiagnosticTroubleCode . + +:ProcedureResultCharacterisitc a samm-c:Enumeration ; + samm:preferredName "Procedure Result Characterisitc"@en ; + samm:description "Characteristic for procedure results."@en ; + samm:dataType xsd:string ; + samm-c:values ( "ok" "nok" "failed" "null" ) . + +:SubProceduresList a samm-c:List ; + samm:preferredName "List of sub-procedures"@en ; + samm:description "A list of sub-procedures"@en ; + samm:dataType :ProcedureCall . + +:Float a samm:Characteristic ; + samm:preferredName "Float"@en ; + samm:description "Characteristic of a float value."@en ; + samm:dataType xsd:float . + +:ConstraintLatitude a samm-c:RangeConstraint ; + samm-c:minValue "-90.0"^^xsd:float ; + samm-c:maxValue "90.0"^^xsd:float ; + samm-c:lowerBoundDefinition samm-c:AT_LEAST ; + samm-c:upperBoundDefinition samm-c:AT_MOST . + +:ConstraintLongitude a samm-c:RangeConstraint ; + samm-c:minValue "-180.0"^^xsd:float ; + samm-c:maxValue "180.0"^^xsd:float ; + samm-c:lowerBoundDefinition samm-c:AT_LEAST ; + samm-c:upperBoundDefinition samm-c:AT_MOST . + +:DiagnosticTroubleCode a samm:Entity ; + samm:preferredName "DTC"@en ; + samm:description "diagnostic trouble codes or short DTCs are used inside ECUs to monitor failures. They were introduced for measuring vehicle emissions. Major DTCs for emissions are standardized by ISO standard ISO 15031-6:2015 - so called OBD2 standard. Over time DTCs were also introduced in other ECUs also besides engine and emission control. Many DTCs are vehicle manufacturer specific.\n"@en ; + samm:see ; + samm:properties ( :dtcHexValue [ samm:property :faultPath; samm:optional true ] [ samm:property :faultPathDescription; samm:optional true ] [ samm:property :freezeFrame; samm:optional true ] [ samm:property :fullDescription; samm:optional true ] [ samm:property :fullName; samm:optional true ] [ samm:property :isMilOn; samm:optional true ] [ samm:property :occurenceCounterTotal; samm:optional true ] [ samm:property :occurenceMileage; samm:optional true ] [ samm:property :occurenceTimeStamp; samm:optional true ] :state :type :envConditionList ) . + +:dtcHexValue a samm:Property ; + samm:preferredName "Hex"@en ; + samm:description "Hex value of this DTC"@en ; + samm:characteristic :HexValueTrait ; + samm:exampleValue "4337499FF" . + +:faultPath a samm:Property ; + samm:preferredName "DTC fault path"@en ; + samm:description "OEM-specific: Fault path for this DTC. Allows further analysis"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "1000761" . + +:faultPathDescription a samm:Property ; + samm:preferredName "DTC fault path description"@en ; + samm:description "OEM-specific description of DTC fault path"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "shortage to plus" . + +:freezeFrame a samm:Property ; + samm:preferredName "DTC freeze frame"@en ; + samm:description "freeze frame from ecu. The freeze frame records many parameters of the DTC and surrounding parameters like outside temperature when the DTC was set. It is a very long HEX string with many OEM-specific and ECU-specific content in"@en ; + samm:characteristic :HexValueTrait ; + samm:exampleValue "100148340349340" . + +:fullDescription a samm:Property ; + samm:preferredName "DTC description"@en ; + samm:description "description of DTC and failure byte. Both description strings are concatenated using a \"-\" as separator"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Brake Switch \"A\" Circuit High-no sub type information" . + +:fullName a samm:Property ; + samm:preferredName "DTC full name:"@en ; + samm:description "Combined string of DTC name plus the so called DTC sub type or DTC failure byte. DTC name starts with B|C|P|U + 4 hex chars + separator \"-\" + DTC failure byte: 2 hex chars. As this only applies for standardized DTCs there is no enforcement. "@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "P0573-00" . + +:isMilOn a samm:Property ; + samm:preferredName "Is MIL On"@en ; + samm:description "describes whether this DTC set the MIL (malfunction indicator light) in the dashboard"@en ; + samm:characteristic samm-c:Boolean ; + samm:exampleValue true . + +:occurenceCounterTotal a samm:Property ; + samm:preferredName "Occurence counter"@en ; + samm:description "Counter how often this DTC was set in total"@en ; + samm:characteristic :Long ; + samm:exampleValue "10"^^xsd:long . + +:occurenceMileage a samm:Property ; + samm:preferredName "DTC first occurence mileage"@en ; + samm:description "mileage in km when the DTC occurred the first time "@en ; + samm:characteristic :MileageCounter ; + samm:exampleValue "15000"^^xsd:nonNegativeInteger . + +:occurenceTimeStamp a samm:Property ; + samm:preferredName "DTC first occurence"@en ; + samm:description "date and time when the DTC occured the first time/was recorded the first time in the ECU"@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2022-01-30T14:48:54"^^xsd:dateTime . + +:state a samm:Property ; + samm:preferredName "DTC state"@en ; + samm:description "OEM-specific state of DTC: 0;1 (permanent/temporary/intermediate), could also be a string with permanent, temporary, intermediate, ...."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "permanent" . + +:type a samm:Property ; + samm:preferredName "Type"@en ; + samm:description "Indicator whether this DTC was stored as Error or Info"@en ; + samm:characteristic :TypeEnumumeration ; + samm:exampleValue "Error" . + +:envConditionList a samm:Property ; + samm:preferredName "Environment Conditions"@en ; + samm:description "A list of environment conditions: E.g. outside temperature measured by the vehicle, a specific value measured by on ECU, ...."@en ; + samm:characteristic :EnvironmentConditions . + +:HexValueTrait a samm-c:Trait ; + samm:preferredName "Hex Value Trait"@en ; + samm:description "This trait allows 0-9, a-f, A-F in a string value. Optional prefix is \"0x\"."@en ; + samm-c:baseCharacteristic :HexCodeCharacteristic ; + samm-c:constraint :HexRegularExpression . + +:Long a samm:Characteristic ; + samm:preferredName "Long"@en ; + samm:description "Characteristic for a long value."@en ; + samm:dataType xsd:long . + +:TypeEnumumeration a samm-c:Enumeration ; + samm:preferredName "Type enumeration"@en ; + samm:description "Enumeration for a DTC."@en ; + samm:dataType xsd:string ; + samm-c:values ( "Error" "Info" ) . + +:EnvironmentConditions a samm-c:List ; + samm:preferredName "Environment Conditions"@en ; + samm:description "A list of environment conditions, like surrounding temperature, rpm, ..."@en ; + samm:dataType :EnvironmentCondition . + +:HexCodeCharacteristic a samm:Characteristic ; + samm:preferredName "Hex code characteristic"@en ; + samm:description "Describing a hex code: 0-9, a-f, A-F, optional 0x"@en ; + samm:dataType xsd:string . + +:HexRegularExpression a samm-c:RegularExpressionConstraint ; + samm:preferredName "Hex regular expression"@en ; + samm:description "This regular expression enforces a hex string. It ensures 0-9, a-f, A-F with an optional prefix 0x.\nValid examples:\n- 0x0123456789abcdefABCDEF\n- 0123456789abcdefABCDEF\n"@en ; + samm:value "^(0x)?[0-9a-fA-F]+$" . + +:EnvironmentCondition a samm:Entity ; + samm:preferredName "Environment Condition"@en ; + samm:description "One environment condition like temperature, rpm,...\nIf the environment condition was measured on vehicle level -> ecuSerialPartNumber is empty"@en ; + samm:properties ( :conditionId [ samm:property :conditionCreationTimeStamp; samm:optional true ] [ samm:property :conditionDescription; samm:optional true ] [ samm:property :conditionValue; samm:optional true ] [ samm:property :measurementUnit; samm:optional true ] ) . + +:conditionId a samm:Property ; + samm:preferredName "Id"@en ; + samm:description "OEM-specific: Primary key for this condition consists of unique identifier of env. condition and DTC"@en ; + samm:characteristic :UniqueID ; + samm:exampleValue "DTC1_EnvCond1" . + +:conditionCreationTimeStamp a samm:Property ; + samm:preferredName "Condition Creation Timestamp"@en ; + samm:description "Date and time when this condition/information was created."@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2022-01-28T14:48:54"^^xsd:dateTime . + +:conditionDescription a samm:Property ; + samm:preferredName "Description"@en ; + samm:description "The description of the environment condition/information"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "RPM" . + +:conditionValue a samm:Property ; + samm:preferredName "Value"@en ; + samm:description "The numeric value of the condition as double."@en ; + samm:characteristic :Double ; + samm:exampleValue "2000.0"^^xsd:double . + +:measurementUnit a samm:Property ; + samm:preferredName "DTC fault path"@en ; + samm:description "The unit of measurement for the environment condition value."@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "rpm" . + +:Double a samm-c:Quantifiable ; + samm:preferredName "Double"@en ; + samm:description "A double value"@en ; + samm:dataType xsd:double . + diff --git a/io.catenax.fleet.diagnostic_data/2.0.0/gen/DiagnosticData-sample.json b/io.catenax.fleet.diagnostic_data/2.0.0/gen/DiagnosticData-sample.json new file mode 100644 index 00000000..ea697029 --- /dev/null +++ b/io.catenax.fleet.diagnostic_data/2.0.0/gen/DiagnosticData-sample.json @@ -0,0 +1,146 @@ +{ + "diagnosticSessions" : [ { + "catenaXQualityTaskId" : "430f56d3-1234-1234-1234-aaaabbbbcccc", + "sessionStart" : "2023-01-01T00:00:00", + "vehicleSoftwareVersion" : "3.5.0001.001", + "workshop" : { + "workShopId" : "workshop-4563328", + "latitude" : 9.165877, + "longitude" : 48.811092 + }, + "sessionEnd" : "2023-12-31T23:59:59", + "sessionId" : "3747429FGH382923974682_Session_2023-11-04T08:00:45", + "diagnosticSoftwareName" : "Pontiac Car Diagnostic software", + "anonymizedVIN" : "3747429FGH382923934abcf74682", + "ecuList" : [ { + "catenaXPartId" : "430f56d3-1234-1234-1234-efab12341234", + "variantCoding" : "Variant: No trailer.", + "oemSerialNumber" : "ECU20646005020221", + "swVersion" : "0001", + "oemPartName" : "Gear box M63", + "assemblyPartNumberVersion" : "0001", + "oemPartNumber" : "FZ206460050202212", + "readOutDate" : "2022-01-30T14:45:54", + "hwVersion" : "0556A", + "dtcs" : [ { + "dtcHexValue" : "4337499FF", + "faultPath" : "1000761", + "faultPathDescription" : "shortage to plus", + "fullName" : "P0573-00", + "fullDescription" : "Brake Switch \"A\" Circuit High-no sub type information", + "type" : "Error", + "occurenceTimeStamp" : "2022-01-30T14:48:54", + "occurenceMileage" : 15000, + "envConditionList" : [ { + "conditionValue" : 2000.0, + "conditionId" : "DTC1_EnvCond1", + "conditionCreationTimeStamp" : "2022-01-28T14:48:54", + "conditionDescription" : "RPM", + "measurementUnit" : "rpm" + } ], + "state" : "permanent", + "freezeFrame" : "100148340349340", + "occurenceCounterTotal" : 10, + "isMilOn" : true + } ], + "calibrationVersion" : "Calibration_file_4711", + "swPartNumber" : "04C906026BH", + "hwPartNumber" : "04C907309AE" + } ], + "diagnosticSoftwareVersion" : "V.411 Patch 2023-02", + "recordStatus" : "new", + "catenaXVehicleId" : "580d3adf-1978-44a0-a214-13d6ceed9379", + "countryCode" : "DEU", + "procedures" : [ { + "procedureStart" : "2023-11-27T08:00:00", + "subProcedures" : [ { + "procedureStart" : "2023-11-27T08:00:00", + "procedureEnd" : "2023-11-27T08:00:03", + "procedureResult" : "ok", + "procedureID" : "ABS_upgrade_deactivate", + "procedureDescription" : "Deactivation ABS upgrade capability.", + "ecuList" : [ { + "catenaXPartId" : "430f56d3-1234-1234-1234-efab12341234", + "variantCoding" : "Variant: No trailer.", + "oemSerialNumber" : "ECU20646005020221", + "swVersion" : "0001", + "oemPartName" : "Gear box M63", + "assemblyPartNumberVersion" : "0001", + "oemPartNumber" : "FZ206460050202212", + "readOutDate" : "2022-01-30T14:45:54", + "hwVersion" : "0556A", + "dtcs" : [ { + "dtcHexValue" : "4337499FF", + "faultPath" : "1000761", + "faultPathDescription" : "shortage to plus", + "fullName" : "P0573-00", + "fullDescription" : "Brake Switch \"A\" Circuit High-no sub type information", + "type" : "Error", + "occurenceTimeStamp" : "2022-01-30T14:48:54", + "occurenceMileage" : 15000, + "envConditionList" : [ { + "conditionValue" : 2000.0, + "conditionId" : "DTC1_EnvCond1", + "conditionCreationTimeStamp" : "2022-01-28T14:48:54", + "conditionDescription" : "RPM", + "measurementUnit" : "rpm" + } ], + "state" : "permanent", + "freezeFrame" : "100148340349340", + "occurenceCounterTotal" : 10, + "isMilOn" : true + } ], + "calibrationVersion" : "Calibration_file_4711", + "swPartNumber" : "04C906026BH", + "hwPartNumber" : "04C907309AE" + } ] + } ], + "procedureResult" : "ok", + "procedureDescription" : "Deactivation ABS upgrade capability.", + "procedureEnd" : "2023-11-27T08:00:03", + "procedureID" : "ABS_upgrade_deactivate", + "ecuList" : [ { + "catenaXPartId" : "430f56d3-1234-1234-1234-efab12341234", + "variantCoding" : "Variant: No trailer.", + "oemSerialNumber" : "ECU20646005020221", + "swVersion" : "0001", + "oemPartName" : "Gear box M63", + "assemblyPartNumberVersion" : "0001", + "oemPartNumber" : "FZ206460050202212", + "readOutDate" : "2022-01-30T14:45:54", + "hwVersion" : "0556A", + "dtcs" : [ { + "dtcHexValue" : "4337499FF", + "faultPath" : "1000761", + "faultPathDescription" : "shortage to plus", + "fullName" : "P0573-00", + "fullDescription" : "Brake Switch \"A\" Circuit High-no sub type information", + "type" : "Error", + "occurenceTimeStamp" : "2022-01-30T14:48:54", + "occurenceMileage" : 15000, + "envConditionList" : [ { + "conditionValue" : 2000.0, + "conditionId" : "DTC1_EnvCond1", + "conditionCreationTimeStamp" : "2022-01-28T14:48:54", + "conditionDescription" : "RPM", + "measurementUnit" : "rpm" + } ], + "state" : "permanent", + "freezeFrame" : "100148340349340", + "occurenceCounterTotal" : 10, + "isMilOn" : true + } ], + "calibrationVersion" : "Calibration_file_4711", + "swPartNumber" : "04C906026BH", + "hwPartNumber" : "04C907309AE" + } ] + } ], + "vehicleSoftwareCategory" : "TZGH64738", + "mileage" : 23500 + } ], + "metaInformation" : { + "selectionEnd" : "2023-12-31T23:59:59", + "selectionStart" : "2023-01-01T00:00:00", + "selectionCriteria" : "Export of diagnostic data set that belongs to one or more Catena-X Quality tasks." + } +} \ No newline at end of file diff --git a/io.catenax.fleet.diagnostic_data/2.0.0/gen/DiagnosticData-schema.json b/io.catenax.fleet.diagnostic_data/2.0.0/gen/DiagnosticData-schema.json new file mode 100644 index 00000000..910b136e --- /dev/null +++ b/io.catenax.fleet.diagnostic_data/2.0.0/gen/DiagnosticData-schema.json @@ -0,0 +1,429 @@ +{ + "$schema" : "http://json-schema.org/draft-04/schema", + "description" : "A Catena-X semantic data model for a list of vehicle diagnostic sessions.", + "type" : "object", + "components" : { + "schemas" : { + "urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_RecordStatusEnumeration" : { + "type" : "string", + "description" : "Defining the enumeration for the record status", + "enum" : [ "new", "update", "delete", "same" ] + }, + "urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_UniqueID" : { + "type" : "string", + "description" : "This Characteristic describes a property that is truly unque either inside the Company that is providing the data or even in Catena-X dataspace. Only one property in a semantic entity should be a uniqueID. Unique ids can be used to link a data set with other semantic models." + }, + "urn_samm_io.catenax.shared.uuid_1.0.0_UuidV4Trait" : { + "type" : "string", + "description" : "The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by \"urn:uuid:\" to make it an IRI.", + "pattern" : "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)" + }, + "urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_CountryCodeTrait" : { + "type" : "string", + "description" : "Regular Expression that ensures a three-letter code ", + "pattern" : "^[A-Z][A-Z][A-Z]$" + }, + "urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" : { + "type" : "string", + "description" : "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." + }, + "urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_MileageCounter" : { + "type" : "number", + "minimum" : 0, + "description" : "The mileage counter of the car." + }, + "urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" : { + "type" : "string", + "pattern" : "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?", + "description" : "Describes a Property which contains the date and time with an optional timezone." + }, + "urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_LatitudeTrait" : { + "type" : "number", + "description" : "Trait to define the latitude.", + "maximum" : 90.0, + "exclusiveMaximum" : false, + "minimum" : -90.0, + "exclusiveMinimum" : false + }, + "urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_LongitudeTrait" : { + "type" : "number", + "description" : "Trait to define the longitude.", + "maximum" : 180.0, + "exclusiveMaximum" : false, + "minimum" : -180.0, + "exclusiveMinimum" : false + }, + "urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_WorkshopCharacteristic" : { + "description" : "Groups all workshop properties.", + "type" : "object", + "properties" : { + "workShopId" : { + "description" : "OEM-specific identifier for a workshop.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_UniqueID" + }, + "latitude" : { + "description" : "Latitude property for GPS coordinates.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_LatitudeTrait" + }, + "longitude" : { + "description" : "Longitude property for GPS coordinates.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_LongitudeTrait" + } + }, + "required" : [ "workShopId" ] + }, + "urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_HexValueTrait" : { + "type" : "string", + "description" : "This regular expression enforces a hex string. It ensures 0-9, a-f, A-F with an optional prefix 0x.\nValid examples:\n- 0x0123456789abcdefABCDEF\n- 0123456789abcdefABCDEF\n", + "pattern" : "^(0x)?[0-9a-fA-F]+$" + }, + "urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" : { + "type" : "boolean", + "description" : "Represents a boolean value (i.e. a \"flag\")." + }, + "urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_Long" : { + "type" : "number", + "maximum" : 9223372036854775807, + "minimum" : -9223372036854775808, + "description" : "Characteristic for a long value." + }, + "urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_TypeEnumumeration" : { + "type" : "string", + "description" : "Enumeration for a DTC.", + "enum" : [ "Error", "Info" ] + }, + "urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_Double" : { + "type" : "number", + "description" : "A double value" + }, + "urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_EnvironmentCondition" : { + "description" : "One environment condition like temperature, rpm,...\nIf the environment condition was measured on vehicle level -> ecuSerialPartNumber is empty", + "type" : "object", + "properties" : { + "conditionId" : { + "description" : "OEM-specific: Primary key for this condition consists of unique identifier of env. condition and DTC", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_UniqueID" + }, + "conditionCreationTimeStamp" : { + "description" : "Date and time when this condition/information was created.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "conditionDescription" : { + "description" : "The description of the environment condition/information", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "conditionValue" : { + "description" : "The numeric value of the condition as double.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_Double" + }, + "measurementUnit" : { + "description" : "The unit of measurement for the environment condition value.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "conditionId" ] + }, + "urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_EnvironmentConditions" : { + "description" : "A list of environment conditions, like surrounding temperature, rpm, ...", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_EnvironmentCondition" + } + }, + "urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_DiagnosticTroubleCode" : { + "description" : "diagnostic trouble codes or short DTCs are used inside ECUs to monitor failures. They were introduced for measuring vehicle emissions. Major DTCs for emissions are standardized by ISO standard ISO 15031-6:2015 - so called OBD2 standard. Over time DTCs were also introduced in other ECUs also besides engine and emission control. Many DTCs are vehicle manufacturer specific.\n", + "type" : "object", + "properties" : { + "dtcHexValue" : { + "description" : "Hex value of this DTC", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_HexValueTrait" + }, + "faultPath" : { + "description" : "OEM-specific: Fault path for this DTC. Allows further analysis", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "faultPathDescription" : { + "description" : "OEM-specific description of DTC fault path", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "freezeFrame" : { + "description" : "freeze frame from ecu. The freeze frame records many parameters of the DTC and surrounding parameters like outside temperature when the DTC was set. It is a very long HEX string with many OEM-specific and ECU-specific content in", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_HexValueTrait" + }, + "fullDescription" : { + "description" : "description of DTC and failure byte. Both description strings are concatenated using a \"-\" as separator", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "fullName" : { + "description" : "Combined string of DTC name plus the so called DTC sub type or DTC failure byte. DTC name starts with B|C|P|U + 4 hex chars + separator \"-\" + DTC failure byte: 2 hex chars. As this only applies for standardized DTCs there is no enforcement. ", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "isMilOn" : { + "description" : "describes whether this DTC set the MIL (malfunction indicator light) in the dashboard", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "occurenceCounterTotal" : { + "description" : "Counter how often this DTC was set in total", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_Long" + }, + "occurenceMileage" : { + "description" : "mileage in km when the DTC occurred the first time ", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_MileageCounter" + }, + "occurenceTimeStamp" : { + "description" : "date and time when the DTC occured the first time/was recorded the first time in the ECU", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "state" : { + "description" : "OEM-specific state of DTC: 0;1 (permanent/temporary/intermediate), could also be a string with permanent, temporary, intermediate, ....", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "type" : { + "description" : "Indicator whether this DTC was stored as Error or Info", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_TypeEnumumeration" + }, + "envConditionList" : { + "description" : "A list of environment conditions: E.g. outside temperature measured by the vehicle, a specific value measured by on ECU, ....", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_EnvironmentConditions" + } + }, + "required" : [ "dtcHexValue", "state", "type", "envConditionList" ] + }, + "urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_DTCList" : { + "description" : "A list of DTCs that are present in this diagnostic session.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_DiagnosticTroubleCode" + } + }, + "urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_ECU" : { + "description" : "A single ECU that is present/has a DTC set in the diagnostic session", + "type" : "object", + "properties" : { + "oemSerialNumber" : { + "description" : "Serial part number of the original equipment manufacturer (OEM). Typically the OEM is installing the part in the car. A serial part number is unique for every single part.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_UniqueID" + }, + "assemblyPartNumberVersion" : { + "description" : "OEM-specific ecu assembly version", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "catenaXPartId" : { + "description" : "The fully anonymous and unique Catena-X ID of this part. This id is unique inside Catena-X data space.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.uuid_1.0.0_UuidV4Trait" + }, + "calibrationVersion" : { + "description" : "Calibration version that was put on this ecu. A calibration file works like a parameter file for the ecu software.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "hwPartNumber" : { + "description" : "hardware part number of ECU", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "hwVersion" : { + "description" : "hardware version of ECU", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "oemPartName" : { + "description" : "Part name as defined by the original equipment manufacturer (OEM). Typically the OEM is installing the part in the car.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "oemPartNumber" : { + "description" : "Part number of the original equipment manufacturer (OEM). Typically the OEM is installing the part in the car. A part number is NOT unique: All parts of the same kind share the same part number.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "readOutDate" : { + "description" : "Date when this ECU information was read out from the diagnostic session", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "swPartNumber" : { + "description" : "SW part number of this ecu", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "swVersion" : { + "description" : "current version of the software on this ecu", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "variantCoding" : { + "description" : "Variant coding that was put on this ecu. Variant coding tells the ecus software how to behave.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "dtcs" : { + "description" : "list of diagnostic trouble codes", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_DTCList" + } + }, + "required" : [ "oemSerialNumber" ] + }, + "urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_EcuList" : { + "description" : "A list of electronic control units in this diagnostic session.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_ECU" + } + }, + "urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_ProcedureResultCharacterisitc" : { + "type" : "string", + "description" : "Characteristic for procedure results.", + "enum" : [ "ok", "nok", "failed", "null" ] + }, + "urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_ProcedureCall" : { + "description" : "One procedure call in the diagnostic software.", + "type" : "object", + "properties" : { + "procedureID" : { + "description" : "A unique identifier for this procedure/sub-procedure call", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_UniqueID" + }, + "procedureDescription" : { + "description" : "An optional description for this procedure", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "procedureEnd" : { + "description" : "End date and time for this procedure call.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "procedureStart" : { + "description" : "Start date and time for this procedure call.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "procedureResult" : { + "description" : "Result of the procedure", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_ProcedureResultCharacterisitc" + }, + "ecuList" : { + "description" : "List of ECUs that had an entry in its internal failure memory during the diagnostic session", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_EcuList" + }, + "subProcedures" : { + "description" : "A list of sub-procedures", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_SubProceduresList" + } + }, + "required" : [ "procedureID" ] + }, + "urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_SubProceduresList" : { + "description" : "A list of sub-procedures", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_ProcedureCall" + } + }, + "urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_ProcedureList" : { + "description" : "A list of procedure calls in the diagnostic software.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_ProcedureCall" + } + }, + "urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_DiagnosticSession" : { + "description" : "One diagnostic session of one vehicle: Either this is a diagnostic session done in a workshop or via over-the-air diagnostic.", + "type" : "object", + "properties" : { + "recordStatus" : { + "description" : "The record operation enumeration can be used to realize delta update concept.\nDelta update concept means:\n- You transfer an initial load of data\n- After the first week only the delta to the initial load is transferred\n\n\nThe record status describes whether this record is:\n- new=>This record is transferred the first time\n- update=> Some properties of this record have changed compared to a previous transfer\n- delete=> This record was transferred in the initial load or in a previous delta update, but is not used any more and therefore it should be deleted on data consumer side\n- same=> This record was transferred in the initial load or in a previous delta update", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_RecordStatusEnumeration" + }, + "sessionId" : { + "description" : "A oem-specific session identifier that is unique in this company.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_UniqueID" + }, + "anonymizedVIN" : { + "description" : "OEM-specific hashed VIN. Unique within OEM.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_UniqueID" + }, + "catenaXQualityTaskId" : { + "description" : "The fully anonymous and unique Catena-X ID of this quality task. This id is unique inside Catena-X data space.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.uuid_1.0.0_UuidV4Trait" + }, + "catenaXVehicleId" : { + "description" : "A unique identifier for the vehicle in the Catena-X data space.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.uuid_1.0.0_UuidV4Trait" + }, + "countryCode" : { + "description" : "Country code in ISO 3166-1 alpha-3 codes where this session took place", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_CountryCodeTrait" + }, + "diagnosticSoftwareName" : { + "description" : "The name of the diagnostic software that was used.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "diagnosticSoftwareVersion" : { + "description" : "The version of the used diagnostic software", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "mileage" : { + "description" : "Mileage counter of the car.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_MileageCounter" + }, + "sessionEnd" : { + "description" : "Describes the end point for this diagnostic session.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "sessionStart" : { + "description" : "Describes the starting point for this diagnostic session.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp" + }, + "vehicleSoftwareCategory" : { + "description" : "Software category of this car during the session - only available for OEMs that have a software category on vehicle level.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "vehicleSoftwareVersion" : { + "description" : "Software version of this car during the session - only available for OEMs that have a software category on vehicle level.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "workshop" : { + "description" : "Groups workshop-related properties", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_WorkshopCharacteristic" + }, + "ecuList" : { + "description" : "List of ECUs that had an entry in its internal failure memory during the diagnostic session", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_EcuList" + }, + "procedures" : { + "description" : "List of procedures / sub-procedures.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_ProcedureList" + } + }, + "required" : [ "sessionId" ] + }, + "urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_SessionList" : { + "description" : "A list of diagnostic sessions coming from multiple vehicles.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_DiagnosticSession" + } + }, + "urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_MetaCharacteristic" : { + "description" : "Characteristic for the meta information.", + "type" : "object", + "properties" : { + "selectionCriteria" : { + "description" : "Describes the selection criteria a Catena-X data provider has applied to create this data set.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "selectionStart" : { + "description" : "Describes the starting point for providing records in this data set.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + }, + "selectionEnd" : { + "description" : "Describes the end point for providing records in this data set.", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text" + } + }, + "required" : [ "selectionCriteria" ] + } + } + }, + "properties" : { + "diagnosticSessions" : { + "description" : "A list of diagnostic sessions.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_SessionList" + }, + "metaInformation" : { + "description" : "This meta information is valid for all entries in this data set. The meta information is used to tell the data consumer which selection criteria were applied by the data provider. ", + "$ref" : "#/components/schemas/urn_samm_io.catenax.fleet.diagnostic_data_2.0.0_MetaCharacteristic" + } + }, + "required" : [ "diagnosticSessions" ] +} \ No newline at end of file diff --git a/io.catenax.fleet.diagnostic_data/2.0.0/gen/DiagnosticData.html b/io.catenax.fleet.diagnostic_data/2.0.0/gen/DiagnosticData.html new file mode 100644 index 00000000..47acd45a --- /dev/null +++ b/io.catenax.fleet.diagnostic_data/2.0.0/gen/DiagnosticData.html @@ -0,0 +1,4307 @@ + + + + + + + + + + + + + + Documentation DiagnosticData + + +
+
+
+
+

Aspect Model DiagnosticData

+
urn:samm:io.catenax.fleet.diagnostic_data:2.0.0#DiagnosticData
+
+
+
+
+
+
+
+ +
+ + +
+ A Catena-X semantic data model for a list of vehicle diagnostic sessions. +
+ + +
+

Overview

+
+
+
+
+ Aspect Model Diagram +
+
+
+ + +
+
+

Properties

+
+ +
+ +
+

Diagnostic sessions

+
+ +A list of diagnostic sessions. + +
+
Name
+
diagnosticSessions
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.fleet.diagnostic_data:2.0.0#DiagnosticSession + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
diagnosticSessions
+
+ + +
+
+ +
+

Meta information

+
+ +This meta information is valid for all entries in this data set. The meta information is used to tell the data consumer which selection criteria were applied by the data provider. + +
+
Name
+
metaInformation
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.fleet.diagnostic_data:2.0.0#MetaInformation + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
metaInformation
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

DTC

+
+
+ diagnostic trouble codes or short DTCs are used inside ECUs to monitor failures. They were introduced for measuring vehicle emissions. Major DTCs for emissions are standardized by ISO standard ISO 15031-6:2015 - so called OBD2 standard. Over time DTCs were also introduced in other ECUs also besides engine and emission control. Many DTCs are vehicle manufacturer specific. + +
+
+ Reference +
+
    +
  • https://www.iso.org/standard/66369.html
    • +
+
+
+ +
+

Properties

+
+
+ +
+
Hex
+
+ +Hex value of this DTC + +
+
Name
+
dtcHexValue
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
4337499FF
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
dtcHexValue
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Hex regular expression +
    + +
    +
    Description
    +
    This regular expression enforces a hex string. It ensures 0-9, a-f, A-F with an optional prefix 0x. +Valid examples: +- 0x0123456789abcdefABCDEF +- 0123456789abcdefABCDEF +
    +
    + + +
    +
    Regular expression
    +
    ^(0x)?[0-9a-fA-F]+$
    +
    + +
    • +
+
+
+
+
+ +
+
DTC fault path
+
+ +OEM-specific: Fault path for this DTC. Allows further analysis + +
+
Name
+
faultPath
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
1000761
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
faultPath
+
+ + +
+
+ +
+
DTC fault path description
+
+ +OEM-specific description of DTC fault path + +
+
Name
+
faultPathDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
shortage to plus
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
faultPathDescription
+
+ + +
+
+ +
+
DTC freeze frame
+
+ +freeze frame from ecu. The freeze frame records many parameters of the DTC and surrounding parameters like outside temperature when the DTC was set. It is a very long HEX string with many OEM-specific and ECU-specific content in + +
+
Name
+
freezeFrame
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
100148340349340
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
freezeFrame
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Hex regular expression +
    + +
    +
    Description
    +
    This regular expression enforces a hex string. It ensures 0-9, a-f, A-F with an optional prefix 0x. +Valid examples: +- 0x0123456789abcdefABCDEF +- 0123456789abcdefABCDEF +
    +
    + + +
    +
    Regular expression
    +
    ^(0x)?[0-9a-fA-F]+$
    +
    + +
    • +
+
+
+
+
+ +
+
DTC description
+
+ +description of DTC and failure byte. Both description strings are concatenated using a "-" as separator + +
+
Name
+
fullDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Brake Switch "A" Circuit High-no sub type information
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
fullDescription
+
+ + +
+
+ +
+
DTC full name:
+
+ +Combined string of DTC name plus the so called DTC sub type or DTC failure byte. DTC name starts with B|C|P|U + 4 hex chars + separator "-" + DTC failure byte: 2 hex chars. As this only applies for standardized DTCs there is no enforcement. + +
+
Name
+
fullName
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
P0573-00
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
fullName
+
+ + +
+
+ +
+
Is MIL On
+
+ +describes whether this DTC set the MIL (malfunction indicator light) in the dashboard + +
+
Name
+
isMilOn
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
true
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
isMilOn
+
+ + +
+
+ +
+
Occurence counter
+
+ +Counter how often this DTC was set in total + +
+
Name
+
occurenceCounterTotal
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#long + +
+
+
+
+
+ +
+
Example
+
10
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
occurenceCounterTotal
+
+ + +
+
+ +
+
DTC first occurence mileage
+
+ +mileage in km when the DTC occurred the first time + +
+
Name
+
occurenceMileage
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
The mileage counter of the car.
+
+
+
Unit
+
+
+
+
    +
  • + kilometre +
    • +
  • + Symbol km +
    • +
  • + Code KMT +
    • +
  • + Conversion factor 10³ m +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#nonNegativeInteger + +
+
+
+
+
+ +
+
Example
+
15000
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
occurenceMileage
+
+ + +
+
+ +
+
DTC first occurence
+
+ +date and time when the DTC occured the first time/was recorded the first time in the ECU + +
+
Name
+
occurenceTimeStamp
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2022-01-30T14:48:54
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
occurenceTimeStamp
+
+ + +
+
+ +
+
DTC state
+
+ +OEM-specific state of DTC: 0;1 (permanent/temporary/intermediate), could also be a string with permanent, temporary, intermediate, .... + +
+
Name
+
state
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
permanent
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
state
+
+ + +
+
+ +
+
Type
+
+ +Indicator whether this DTC was stored as Error or Info + +
+
Name
+
type
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • Error
    • +
  • Info
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Error
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
type
+
+ + +
+
+ +
+
Environment Conditions
+
+ +A list of environment conditions: E.g. outside temperature measured by the vehicle, a specific value measured by on ECU, .... + +
+
Name
+
envConditionList
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.fleet.diagnostic_data:2.0.0#EnvironmentCondition + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
envConditionList
+
+ + +
+
+
+
+

Diagnostic Session

+
+
+ One diagnostic session of one vehicle: Either this is a diagnostic session done in a workshop or via over-the-air diagnostic. +
+ +
+

Properties

+
+
+ +
+
Record status
+
+ +The record operation enumeration can be used to realize delta update concept. +Delta update concept means: +- You transfer an initial load of data +- After the first week only the delta to the initial load is transferred + + +The record status describes whether this record is: +- new=>This record is transferred the first time +- update=> Some properties of this record have changed compared to a previous transfer +- delete=> This record was transferred in the initial load or in a previous delta update, but is not used any more and therefore it should be deleted on data consumer side +- same=> This record was transferred in the initial load or in a previous delta update + +
+
Name
+
recordStatus
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • new
    • +
  • update
    • +
  • delete
    • +
  • same
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
update
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
recordStatus
+
+ + +
+
+ +
+
Session identifier
+
+ +A oem-specific session identifier that is unique in this company. + +
+
Name
+
sessionId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
3747429FGH382923974682_Session_2023-11-04T08:00:45
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
sessionId
+
+ + +
+
+ +
+
Anonymized VIN
+
+ +OEM-specific hashed VIN. Unique within OEM. + +
+
Name
+
anonymizedVIN
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
3747429FGH382923934abcf74682
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
anonymizedVIN
+
+ + +
+
+ +
+
Quality Task ID
+
+ +The fully anonymous and unique Catena-X ID of this quality task. This id is unique inside Catena-X data space. + +
+
Name
+
catenaXQualityTaskId
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://tools.ietf.org/html/rfc4122
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
430f56d3-1234-1234-1234-aaaabbbbcccc
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
catenaXQualityTaskId
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + UUID v4 Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by "urn:uuid:" to make it an IRI.
    +
    + +
    +
    Reference
    +
    +
    +
      +
    • https://datatracker.ietf.org/doc/html/rfc4122
      • +
    +
    +
    +
    + +
    +
    Regular expression
    +
    (^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)
    +
    + +
    • +
+
+
+
+
+ +
+
Vehicle Catena-X Identifier
+
+ +A unique identifier for the vehicle in the Catena-X data space. + +
+
Name
+
catenaXVehicleId
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://tools.ietf.org/html/rfc4122
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
580d3adf-1978-44a0-a214-13d6ceed9379
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
catenaXVehicleId
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + UUID v4 Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by "urn:uuid:" to make it an IRI.
    +
    + +
    +
    Reference
    +
    +
    +
      +
    • https://datatracker.ietf.org/doc/html/rfc4122
      • +
    +
    +
    +
    + +
    +
    Regular expression
    +
    (^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)
    +
    + +
    • +
+
+
+
+
+ +
+
Country code
+
+ +Country code in ISO 3166-1 alpha-3 codes where this session took place + +
+
Name
+
countryCode
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://www.iso.org/iso-3166-country-codes.html
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
DEU
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
countryCode
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Country Code Regular Expression +
    + +
    +
    Description
    +
    Regular Expression that ensures a three-letter code
    +
    + + +
    +
    Regular expression
    +
    ^[A-Z][A-Z][A-Z]$
    +
    + +
    • +
+
+
+
+
+ +
+
Diagnostic Software
+
+ +The name of the diagnostic software that was used. + +
+
Name
+
diagnosticSoftwareName
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Pontiac Car Diagnostic software
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
diagnosticSoftwareName
+
+ + +
+
+ +
+
Diagnostic software version
+
+ +The version of the used diagnostic software + +
+
Name
+
diagnosticSoftwareVersion
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
V.411 Patch 2023-02
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
diagnosticSoftwareVersion
+
+ + +
+
+ +
+
Mileage
+
+ +Mileage counter of the car. + +
+
Name
+
mileage
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
The mileage counter of the car.
+
+
+
Unit
+
+
+
+
    +
  • + kilometre +
    • +
  • + Symbol km +
    • +
  • + Code KMT +
    • +
  • + Conversion factor 10³ m +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#nonNegativeInteger + +
+
+
+
+
+ +
+
Example
+
23500
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
mileage
+
+ + +
+
+ +
+
Selection end timestamp
+
+ +Describes the end point for this diagnostic session. + +
+
Name
+
sessionEnd
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-12-31T23:59:59
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
sessionEnd
+
+ + +
+
+ +
+
Selection start timestamp
+
+ +Describes the starting point for this diagnostic session. + +
+
Name
+
sessionStart
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-01-01T00:00:00
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
sessionStart
+
+ + +
+
+ +
+
Vehicle software category
+
+ +Software category of this car during the session - only available for OEMs that have a software category on vehicle level. + +
+
Name
+
vehicleSoftwareCategory
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
TZGH64738
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
vehicleSoftwareCategory
+
+ + +
+
+ +
+
Vehicle software version
+
+ +Software version of this car during the session - only available for OEMs that have a software category on vehicle level. + +
+
Name
+
vehicleSoftwareVersion
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
3.5.0001.001
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
vehicleSoftwareVersion
+
+ + +
+
+ +
+
Workshop
+
+ +Groups workshop-related properties + +
+
Name
+
workshop
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.fleet.diagnostic_data:2.0.0#WorkshopProperties + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
workshop
+
+ + +
+
+ +
+
ECU list
+
+ +List of ECUs that had an entry in its internal failure memory during the diagnostic session + +
+
Name
+
ecuList
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.fleet.diagnostic_data:2.0.0#ECU + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
ecuList
+
+ + +
+
+ +
+
Procedures
+
+ +List of procedures / sub-procedures. + +
+
Name
+
procedures
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.fleet.diagnostic_data:2.0.0#ProcedureCall + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
procedures
+
+ + +
+
+
+
+

ECU

+
+
+ A single ECU that is present/has a DTC set in the diagnostic session +
+ +
+

Properties

+
+
+ +
+
OEM serial number
+
+ +Serial part number of the original equipment manufacturer (OEM). Typically the OEM is installing the part in the car. A serial part number is unique for every single part. + +
+
Name
+
oemSerialNumber
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
ECU20646005020221
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
oemSerialNumber
+
+ + +
+
+ +
+
ECU assembly part number version
+
+ +OEM-specific ecu assembly version + +
+
Name
+
assemblyPartNumberVersion
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
0001
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
assemblyPartNumberVersion
+
+ + +
+
+ +
+
Catena-X Identifier of this part
+
+ +The fully anonymous and unique Catena-X ID of this part. This id is unique inside Catena-X data space. + +
+
Name
+
catenaXPartId
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://tools.ietf.org/html/rfc4122
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
430f56d3-1234-1234-1234-efab12341234
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
catenaXPartId
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + UUID v4 Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by "urn:uuid:" to make it an IRI.
    +
    + +
    +
    Reference
    +
    +
    +
      +
    • https://datatracker.ietf.org/doc/html/rfc4122
      • +
    +
    +
    +
    + +
    +
    Regular expression
    +
    (^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)
    +
    + +
    • +
+
+
+
+
+ +
+
Calibration version
+
+ +Calibration version that was put on this ecu. A calibration file works like a parameter file for the ecu software. + +
+
Name
+
calibrationVersion
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Calibration_file_4711
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
calibrationVersion
+
+ + +
+
+ +
+
ECU HW part number
+
+ +hardware part number of ECU + +
+
Name
+
hwPartNumber
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
04C907309AE
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
hwPartNumber
+
+ + +
+
+ +
+
ECU HW version
+
+ +hardware version of ECU + +
+
Name
+
hwVersion
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
0556A
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
hwVersion
+
+ + +
+
+ +
+
Oem part name
+
+ +Part name as defined by the original equipment manufacturer (OEM). Typically the OEM is installing the part in the car. + +
+
Name
+
oemPartName
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Gear box M63
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
oemPartName
+
+ + +
+
+ +
+
OEM part number
+
+ +Part number of the original equipment manufacturer (OEM). Typically the OEM is installing the part in the car. A part number is NOT unique: All parts of the same kind share the same part number. + +
+
Name
+
oemPartNumber
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
FZ206460050202212
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
oemPartNumber
+
+ + +
+
+ +
+
Read out date
+
+ +Date when this ECU information was read out from the diagnostic session + +
+
Name
+
readOutDate
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2022-01-30T14:45:54
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
readOutDate
+
+ + +
+
+ +
+
ECU SW part number
+
+ +SW part number of this ecu + +
+
Name
+
swPartNumber
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
04C906026BH
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
swPartNumber
+
+ + +
+
+ +
+
ECU SW version
+
+ +current version of the software on this ecu + +
+
Name
+
swVersion
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
0001
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
swVersion
+
+ + +
+
+ +
+
Variant coding
+
+ +Variant coding that was put on this ecu. Variant coding tells the ecus software how to behave. + +
+
Name
+
variantCoding
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Variant: No trailer.
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
variantCoding
+
+ + +
+
+ +
+
dtcs
+
+ +list of diagnostic trouble codes + +
+
Name
+
dtcs
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.fleet.diagnostic_data:2.0.0#DiagnosticTroubleCode + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
dtcs
+
+ + +
+
+
+
+

Environment Condition

+
+
+ One environment condition like temperature, rpm,... +If the environment condition was measured on vehicle level -> ecuSerialPartNumber is empty +
+ +
+

Properties

+
+
+ +
+
Id
+
+ +OEM-specific: Primary key for this condition consists of unique identifier of env. condition and DTC + +
+
Name
+
conditionId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
DTC1_EnvCond1
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
conditionId
+
+ + +
+
+ +
+
Condition Creation Timestamp
+
+ +Date and time when this condition/information was created. + +
+
Name
+
conditionCreationTimeStamp
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2022-01-28T14:48:54
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
conditionCreationTimeStamp
+
+ + +
+
+ +
+
Description
+
+ +The description of the environment condition/information + +
+
Name
+
conditionDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
RPM
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
conditionDescription
+
+ + +
+
+ +
+
Value
+
+ +The numeric value of the condition as double. + +
+
Name
+
conditionValue
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
A double value
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
2000.0
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
conditionValue
+
+ + +
+
+ +
+
DTC fault path
+
+ +The unit of measurement for the environment condition value. + +
+
Name
+
measurementUnit
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
rpm
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
measurementUnit
+
+ + +
+
+
+
+

Meta Information

+
+
+ This entity groups all meta information properties. Meta information properties give hints for a Catena-X data consumer to better understand, how this data set was created on the Catena-X data provider side. +
+ +
+

Properties

+
+
+ +
+
Selection criteria
+
+ +Describes the selection criteria a Catena-X data provider has applied to create this data set. + +
+
Name
+
selectionCriteria
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Export of diagnostic data set that belongs to one or more Catena-X Quality tasks.
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
selectionCriteria
+
+ + +
+
+ +
+
Selection start
+
+ +Describes the starting point for providing records in this data set. + +
+
Name
+
selectionStart
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2023-01-01T00:00:00
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
selectionStart
+
+ + +
+
+ +
+
Selection end
+
+ +Describes the end point for providing records in this data set. + +
+
Name
+
selectionEnd
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2023-12-31T23:59:59
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
selectionEnd
+
+ + +
+
+
+
+

Procedure Call

+
+
+ One procedure call in the diagnostic software. +
+ +
+

Properties

+
+
+ +
+
Procedure identifier
+
+ +A unique identifier for this procedure/sub-procedure call + +
+
Name
+
procedureID
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
ABS_upgrade_deactivate
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
procedureID
+
+ + +
+
+ +
+
Procedure Description
+
+ +An optional description for this procedure + +
+
Name
+
procedureDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Deactivation ABS upgrade capability.
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
procedureDescription
+
+ + +
+
+ +
+
Procedure Description
+
+ +An optional description for this procedure + +
+
Name
+
procedureDescription
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
Deactivation ABS upgrade capability.
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
procedureDescription
+
+ + +
+
+ +
+
Procedure end
+
+ +End date and time for this procedure call. + +
+
Name
+
procedureEnd
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-11-27T08:00:03
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
procedureEnd
+
+ + +
+
+ +
+
Procedure start
+
+ +Start date and time for this procedure call. + +
+
Name
+
procedureStart
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-11-27T08:00:00
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
procedureStart
+
+ + +
+
+ +
+
Procedure result
+
+ +Result of the procedure + +
+
Name
+
procedureResult
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • ok
    • +
  • nok
    • +
  • failed
    • +
  • null
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
ok
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
procedureResult
+
+ + +
+
+ +
+
ECU list
+
+ +List of ECUs that had an entry in its internal failure memory during the diagnostic session + +
+
Name
+
ecuList
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.fleet.diagnostic_data:2.0.0#ECU + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
ecuList
+
+ + +
+
+ +
+
Sub procedures
+
+ +A list of sub-procedures + +
+
Name
+
subProcedures
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.fleet.diagnostic_data:2.0.0#ProcedureCall + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
subProcedures
+
+ + +
+
+
+
+

Workshop Properties

+
+
+ All properties to clearly identify a workshop. +
+ +
+

Properties

+
+
+ +
+
OEM Workshop ID
+
+ +OEM-specific identifier for a workshop. + +
+
Name
+
workShopId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
workshop-4563328
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
workShopId
+
+ + +
+
+ +
+
Latitude
+
+ +Latitude property for GPS coordinates. + +
+
Name
+
latitude
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
9.165877
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
latitude
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + ConstraintLatitude +
    + + + +
    +
    +>= +
    + DefaultScalarValue[value=-90.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    ...
    +
    +< + DefaultScalarValue[value=90.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    + +
    • +
+
+
+
+
+ +
+
Longitude
+
+ +Longitude property for GPS coordinates. + +
+
Name
+
longitude
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
48.811092
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
longitude
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + ConstraintLongitude +
    + + + +
    +
    +>= +
    + DefaultScalarValue[value=-180.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    +
    ...
    +
    +< + DefaultScalarValue[value=180.0, typeUri='DefaultScalar[metaModelVersion=SAMM_2_1_0, urn='http://www.w3.org/2001/XMLSchema#float']'] +
    + +
    • +
+
+
+
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/io.catenax.fleet.diagnostic_data/2.0.0/gen/DiagnosticData.png b/io.catenax.fleet.diagnostic_data/2.0.0/gen/DiagnosticData.png new file mode 100644 index 00000000..59e0d4ef Binary files /dev/null and b/io.catenax.fleet.diagnostic_data/2.0.0/gen/DiagnosticData.png differ diff --git a/io.catenax.fleet.diagnostic_data/2.0.0/metadata.json b/io.catenax.fleet.diagnostic_data/2.0.0/metadata.json new file mode 100644 index 00000000..a182c7b8 --- /dev/null +++ b/io.catenax.fleet.diagnostic_data/2.0.0/metadata.json @@ -0,0 +1 @@ +{ "status" : "release"} \ No newline at end of file diff --git a/io.catenax.fleet.diagnostic_data/RELEASE_NOTES.md b/io.catenax.fleet.diagnostic_data/RELEASE_NOTES.md index 2c16263d..30615e3b 100644 --- a/io.catenax.fleet.diagnostic_data/RELEASE_NOTES.md +++ b/io.catenax.fleet.diagnostic_data/RELEASE_NOTES.md @@ -3,6 +3,23 @@ All notable changes to this model will be documented in this file. ## [Unreleased] +## [2.0.0] - 2024-01-29 +### Added +- metaInformation property added to root entity +- integration of the shared UUID characteristic and RegEx for Catena-X identifiers +- introducing new characteristic for unique identifiers +- end date of a diagnostic session added +- procedures entity added to support failure-tree-based analysis in the workshop: Procedures can have sub-procedures could also be linked to ecuList +- for Ecus: calibration and variant coding properties + +### Changed +- changed all properties to optional except unique identifier per entity +- Clear structure: session has ecuList as child, ecuList has dtcList as child, dtcList has envConditionList as child + +### Removed +- vehicle entity: Properties now located one level up on DiagnosticSession +- eventList: Removed completely - instead procedures list was introduced + ## [1.0.0] - 2022-12-13 ### Added - initial version of this model