diff --git a/docs-kits/kits/Traceability Kit/Software Development View/part_aspect-models.mdx b/docs-kits/kits/Traceability Kit/Software Development View/part_aspect-models.mdx index cd60fc7f943..2c4fc985393 100644 --- a/docs-kits/kits/Traceability Kit/Software Development View/part_aspect-models.mdx +++ b/docs-kits/kits/Traceability Kit/Software Development View/part_aspect-models.mdx @@ -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` @@ -179,76 +179,90 @@ 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 | -**Example: Submodel Simple Measurements** +| 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 |**Example** + ```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" + } ```