Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix/traceability-KIT hot fix #1122

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Fix/traceability-KIT hot fix #1122

Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
cf9d1b8
fix: add correct examples
LuisRickert Dec 19, 2024
5b6d0da
chore: fix formatting
LuisRickert Dec 19, 2024
232ef29
chore: formatting
LuisRickert Dec 19, 2024
1843a3c
chore: update changelog
LuisRickert Jan 13, 2025
b165a27
chore: add HotFix to R24.12
LuisRickert Jan 13, 2025
1c781f0
Merge branch 'eclipse-tractusx:main' into fix/Traceability-KIT-HotFix
LuisRickert Jan 15, 2025
39c879b
chore: update DEPENDENCIES File
LuisRickert Jan 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 56 additions & 40 deletions docs-kits/kits/Traceability Kit/Software Development View/part_aspect-models.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Aspect model in GitHub:
```

### SoftwareInformation
The software information aspect model contains the essential information of all software components that have been implemented or flashed in an instantiated part (e.g. serialized part).
The software information aspect model contains the essential information of all software components that have been implemented or flashed in an instantiated part (e.g. serialized part).

Aspect model in GitHub:
- Version 1.0.0: https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.software_information/1.0.0
Expand Down Expand Up @@ -166,10 +166,10 @@ Aspect model in GitHub:
```

### SpecialCharacteristicMeasurement
Special Characteristics are measureable and these measurements are of interest for a consumer who defined these characteristics. The proposal is a data model "result" which represents a measurement related to a specific measurement and product. A measurement result is identified by the identification of a characteristic and the product.
Special Characteristics are measureable and these measurements are of interest for a consumer who defined these characteristics. The proposal is a data model "result" which represents a measurement related to a specific measurement and product. A measurement result is identified by the identification of a characteristic and the product.

Aspect model in GitHub:
- Version 1.0.0: https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.special_characteristics.measurement/1.0.0
- Version 1.0.0: [https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.special_characteristics.measurement/1.0.0/](https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.special_characteristics.measurement/1.0.0/)

#### Example: Submodel `SpecialCharacteristicMeasurement`

Expand All @@ -179,76 +179,92 @@ Aspect model in GitHub:
{
"value": "SN12345678",
"key": "partInstanceId"
},
{
"value": "SN12345678",
"key": "manufactuererId"
}
],
"customerPartId": "PRT-12345",
"revisionIndex": "01",
"measurementType": "simple",
"manufacturerId": "BPNL000000000000",
"measurementType": "simpleMeasurement",
"characteristicId": "S1",
"results": [ ]
"results": [
{
"identifier": "measurementPoint23",
"description": "This text gives you context to the related measurement to help to put it into the necessary context.",
"unit": "unit:hectopascal",
"value": 12.09,
"measurementTimestamp": "2024-12-17T11:09:47.738+01:00"
}
]
}
```

#### Recommended Pattern (Key Value Pair)
Due to the amount of different characteristics we opted not to require a specific format for the measurement objects contained in the **"results": [ ]** object list. We rather provide a set of format we recommend to use. These recommendations depend on the most common characteristics and their requirements for the results.

##### Simple Measurements
We consider for characteristics a simple measurement if it just requires to measure a single value. For example the thickness of a rolled steel plate. We designed the measurement object to be able to represent any measurement where it is required to measure a value with a unit.
We consider for characteristics a simple measurement if it just requires to measure a single value. For example the thickness of a rolled steel plate. We designed the measurement object to be able to represent any measurement where it is required to measure a value with a unit.

**Data model**
| Attribute | Plausability | Type | Example |
| :-- | :-- | :-- | :-- |
| value | mandatory | string | -2.9426523E38 |
| unit | mandatory | string | -eOMtThyhVNLWUZNRcBaQKxI |
| measurementTimeStamp | mandatory | timestamp | 2024-10-01 |

| Attribute | Plausability | Type | Example |
|----------------------|--------------|--------|--------------------------------------------------------------------------------------------------------|
| identifier | mandatory | string | measurementPoint23 |
| description | mandatory | string | "This text gives you context to the related measurement to help to put it into the necessary context." |
| unit | optional | string | "unit:hectopascal" |
| value | mandatory | float | -2.9426523 |
| measurementTimestamp | mandatory | string | 2024-12-17T11:09:47.738+01:00 |

**Example: Submodel Simple Measurements**

```json
{
"measurement" : {
"value" : -2.9426523E38,
"unit" : "eOMtThyhVNLWUZNRcBaQKxI"
},
"measurementTimestamp" : "2024-10-01"
"identifier": "measurementPoint23",
"description": "This text gives you context to the related measurement to help to put it into the necessary context.",
"unit": "unit:hectopascal",
"value": -2.9426523,
"measurementTimestamp": "2024-12-17T11:09:47.738+01:00"
}
```

##### Qualitative Measurements
We consider a qualitative measurement a measurement where a value has to be extracted and a read Qualitity has to be determined. An example would be the serial number which has to be etched onto the product. The result of the etching has to be of a certain quality where this quality is measured by some metric.
We consider a qualitative measurement a measurement where a value has to be extracted and a read Qualitity has to be determined. An example would be the serial number which has to be etched onto the product. The result of the etching has to be of a certain quality where this quality is measured by some metric.

**Data model**
| Attribute | Plausability | Type | Example |
| :-- | :-- | :-- | :-- |
| extractedValue | mandatory | string | eOMtThyhVNLWUZNRcBaQKxI |
| readQuality | mandatory | string | 5 |
| measurementTimeStamp | mandatory | timestamp | 2024-10-01 |

**Example: Submodel Qualitative Measurements**
| Attribute | Plausability | Type | Example |
|----------------------|--------------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| identifier | mandatory | string | measurementPoint23 |
| description | mandatory | string | "Additional to the description add extending information to the measurement if needed. E.g link to an extracted image or values that cannot be represented by a float and how the value field should be interpreted" |
| value | mandatory | float | 12 |
| measurementTimestamp | mandatory | string | 2024-12-17T11:09:47.738+01:00 |

```json
{
"extractedValue" : "eOMtThyhVNLWUZNRcBaQKxI",
"readQuality" : 5,
"measurementTimestamp" : "2024-10-01"
}
"identifier": "measurementPoint23",
"description": "Additional to the description add extending information to the measurement if needed. E.g link to an extracted image or values that cannot be represented by a float and how the value field should be interpreted",
"value": 12.09,
"measurementTimestamp": "2024-12-17T11:09:47.738+01:00"
}

```

##### Functional Measurements
Functional Measurements are for characteristics where the result just confirms that the function is at it is expected.

**Data model**
| Attribute | Plausability | Type | Example |
| :-- | :-- | :-- | :-- |
| value | mandatory | boolean | true |
| measurementTimeStamp | mandatory | timestamp | 2024-10-01 |

**Example**
| Attribute | Plausability | Type | Example |
|----------------------|--------------|--------|------------------------------------------------------------------------------------------------------|
| identifier | mandatory | string | measurementPoint23 |
| description | mandatory | string | This text gives you context to the related measurement to help to put it into the necessary context. |
| value | mandatory | float | 1 |
| measurementTimestamp | mandatory | string | 2024-12-17T11:09:47.738+01:00 |

```json
{
"value" : true,
"measurementTimestamp" : "2024-10-01"
}
"identifier": "measurementPoint23",
"description": "This text gives you context to the related measurement to help to put it into the necessary context.",
"value": 1.0,
"measurementTimestamp": "2024-12-17T11:09:47.738+01:00"
}
```

Loading