diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.CarbonFootprint/1.0.0/CarbonFootprint.ttl b/SMARTENERGY/BatteriePass/io.BatteryPass.CarbonFootprint/1.0.0/CarbonFootprint.ttl new file mode 100644 index 00000000..6ffca442 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.CarbonFootprint/1.0.0/CarbonFootprint.ttl @@ -0,0 +1,82 @@ +###################################################################### +# Copyright (c) 2024 Circulor GmbH on behalf of the Battery Pass Consortium +# +# 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 : . + +:CarbonFootprint a samm:Aspect ; + samm:description "Data model for battery varbon footprint\nCopyright 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is licensed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution."@en ; + samm:properties ( :batteryCarbonFootprint :carbonFootprintPerLifecycleStage :carbonFootprintPerformanceClass :carbonFootprintStudy ) ; + samm:operations ( ) ; + samm:events ( ) . + +:batteryCarbonFootprint a samm:Property ; + samm:description "The carbon footprint of the battery, calculated as kg of carbon dioxide equivalent per one kWh of the total energy provided by the battery over its expected service life, as declared in the Carbon Footprint Declaration."@en ; + samm:characteristic :BatteryCarbonFootprint . + +:carbonFootprintPerLifecycleStage a samm:Property ; + samm:description "The carbon footprint of the battery as share of total Battery Carbon Footprint, differentiated per life cycle stages raw material extraction, battery production, distribution and recycling."@en ; + samm:characteristic :CarbonFootprints . + +:carbonFootprintPerformanceClass a samm:Property ; + samm:description "The carbon footprint performance class that the relevant battery model per manufacturing plant corresponds to."@en ; + samm:characteristic :CarbonFootprintPerformanceClass . + +:carbonFootprintStudy a samm:Property ; + samm:description "A web link to get access to a public version of the study supporting the carbon footprint values."@en ; + samm:characteristic samm-c:ResourcePath . + +:BatteryCarbonFootprint a samm-c:Measurement ; + samm:description "The battery carbon footprint is an aggregation of the carbon footprint of the individual lifecycle stages"@en ; + samm:dataType xsd:double ; + samm-c:unit :kilogramperkilowatthour . + +:CarbonFootprints a samm-c:List ; + samm:description "CarbainFootprints per lifecycle stage"@en ; + samm:dataType :CarbonFootprintPerLifecycleStageEntity . + +:CarbonFootprintPerformanceClass a samm-c:Code ; + samm:description "EV, industrial and LMT batteries shall bear a conspicuous, clearly legible and indelible label indicating the carbon footprint of the battery and the carbon footprint performance class that the relevant battery model per manufacturing plant corresponds to. The carbon footprint performance class shall be accessible via the battery passport. A meaningful number of classes of performance will be developed (?) with category A being the best class with the lowest carbon footprint life cycle impact."@en ; + samm:dataType xsd:string . + +:kilogramperkilowatthour a samm:Unit ; + samm:commonCode "kg CO2e/kWh" ; + samm:symbol "CO2e/kWh" . + +:CarbonFootprintPerLifecycleStageEntity a samm:Entity ; + samm:description "The carbon footprint of the battery as share of total Battery Carbon Footprint, differentiated per life cycle stage"@en ; + samm:properties ( :lifecycleStage :carbonFootprint ) . + +:lifecycleStage a samm:Property ; + samm:description "The description of the life cycle stage "@en ; + samm:characteristic :LifecycleStage . + +:carbonFootprint a samm:Property ; + samm:description "Carbon footprint of the individual lifecycle stage"@en ; + samm:characteristic :CarbonFootprintValue . + +:LifecycleStage a samm-c:Enumeration ; + samm:dataType xsd:string ; + samm-c:values ( "RawMaterialExtraction" "MainProduction" "Distribution" "Recycling" ) . + +:CarbonFootprintValue a samm-c:Measurement ; + samm:dataType xsd:double ; + samm-c:unit :kilogramperkilowatthour . + diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.CarbonFootprint/1.0.0/gen/CarbonFootprint-aas.xml b/SMARTENERGY/BatteriePass/io.BatteryPass.CarbonFootprint/1.0.0/gen/CarbonFootprint-aas.xml new file mode 100644 index 00000000..5de60c1c --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.CarbonFootprint/1.0.0/gen/CarbonFootprint-aas.xml @@ -0,0 +1,494 @@ + + + + + defaultAdminShell + + + en + defaultAdminShell + + + + urn:samm:BatteryPass:1.0.0#CarbonFootprint + + Type + + + + ModelReference + + + Submodel + urn:samm:BatteryPass:1.0.0#CarbonFootprint/submodel + + + + + + + + + CarbonFootprint + + + en + Data model for battery varbon footprint +Copyright � 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is licensed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution. + + + + urn:samm:BatteryPass:1.0.0#CarbonFootprint/submodel + Template + + ModelReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#CarbonFootprint + + + + + + batteryCarbonFootprint + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#batteryCarbonFootprint + + + + xs:double + + + + carbonFootprintPerLifecycleStage + + + en + The carbon footprint of the battery as share of total Battery Carbon Footprint, differentiated per life cycle stages raw material extraction, battery production, distribution and recycling. + + + true + SubmodelElement + + + CarbonFootprintPerLifecycleStageEntity + + + en + The carbon footprint of the battery as share of total Battery Carbon Footprint, differentiated per life cycle stage + + + + + lifecycleStage + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#lifecycleStage + + + + xs:string + + + + carbonFootprint + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#carbonFootprint + + + + xs:double + + + + + + + + carbonFootprintPerformanceClass + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#carbonFootprintPerformanceClass + + + + xs:string + + + + carbonFootprintStudy + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#carbonFootprintStudy + + + + xs:anyURI + + + + + + + + APPLICATION_CLASS + CarbonFootprint + + + en + Data model for battery varbon footprint +Copyright � 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is licensed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution. + + + urn:samm:BatteryPass:1.0.0#CarbonFootprint + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + CarbonFootprint + + + + + en + CarbonFootprint + + + + + en + Data model for battery varbon footprint +Copyright � 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is licensed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution. + + + + + + + + + batteryCarbonFootprint + urn:samm:BatteryPass:1.0.0#batteryCarbonFootprint + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + batteryCarbonFootprint + + + + + en + batteryCarbonFootprint + + + kilogramperkilowatthour + REAL_MEASURE + + + en + The carbon footprint of the battery, calculated as kg of carbon dioxide equivalent per one kWh of the total energy provided by the battery over its expected service life, as declared in the Carbon Footprint Declaration. + + + + + + + + + lifecycleStage + urn:samm:BatteryPass:1.0.0#lifecycleStage + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + lifecycleStage + + + + + en + lifecycleStage + + + STRING + + + en + The description of the life cycle stage + + + + + + RawMaterialExtraction + + ModelReference + + + DataElement + urn:samm:BatteryPass:1.0.0#LifecycleStage:RawMaterialExtraction + + + + + + MainProduction + + ModelReference + + + DataElement + urn:samm:BatteryPass:1.0.0#LifecycleStage:MainProduction + + + + + + Distribution + + ModelReference + + + DataElement + urn:samm:BatteryPass:1.0.0#LifecycleStage:Distribution + + + + + + Recycling + + ModelReference + + + DataElement + urn:samm:BatteryPass:1.0.0#LifecycleStage:Recycling + + + + + + + + + + + + + carbonFootprint + urn:samm:BatteryPass:1.0.0#carbonFootprint + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + carbonFootprint + + + + + en + carbonFootprint + + + kilogramperkilowatthour + REAL_MEASURE + + + en + Carbon footprint of the individual lifecycle stage + + + + + + + + + carbonFootprintPerLifecycleStage + urn:samm:BatteryPass:1.0.0#carbonFootprintPerLifecycleStage + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + carbonFootprintPerLifecycleStage + + + + + en + carbonFootprintPerLifecycleStage + + + STRING + + + en + The carbon footprint of the battery as share of total Battery Carbon Footprint, differentiated per life cycle stages raw material extraction, battery production, distribution and recycling. + + + + + + + + + carbonFootprintPerformanceClass + urn:samm:BatteryPass:1.0.0#carbonFootprintPerformanceClass + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + carbonFootprintPerformanceClass + + + + + en + carbonFootprintPerformanceClass + + + STRING + + + en + The carbon footprint performance class that the relevant battery model per manufacturing plant corresponds to. + + + + + + + + + carbonFootprintStudy + urn:samm:BatteryPass:1.0.0#carbonFootprintStudy + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + carbonFootprintStudy + + + + + en + carbonFootprintStudy + + + STRING + + + en + A web link to get access to a public version of the study supporting the carbon footprint values. + + + + + + + + + diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.CarbonFootprint/1.0.0/gen/CarbonFootprint-documentation.html b/SMARTENERGY/BatteriePass/io.BatteryPass.CarbonFootprint/1.0.0/gen/CarbonFootprint-documentation.html new file mode 100644 index 00000000..0e67c6d8 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.CarbonFootprint/1.0.0/gen/CarbonFootprint-documentation.html @@ -0,0 +1,564 @@ + + + + + + + + + + + + + + Documentation CarbonFootprint + + +
+
+
+
+

Aspect Model CarbonFootprint

+
urn:samm:BatteryPass:1.0.0#CarbonFootprint
+
+
+
+
+
+
+
+ +
+ + +
+ Data model for battery varbon footprint +Copyright © 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is licensed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution. +
+ + +
+

Overview

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

Properties

+
+ +
+ +
+

batteryCarbonFootprint

+
+ +The carbon footprint of the battery, calculated as kg of carbon dioxide equivalent per one kWh of the total energy provided by the battery over its expected service life, as declared in the Carbon Footprint Declaration. + +
+
Name
+
batteryCarbonFootprint
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
The battery carbon footprint is an aggregation of the carbon footprint of the individual lifecycle stages
+
+
+
Unit
+
+
+
+
    +
  • + kilogramperkilowatthour +
    • +
  • + Symbol CO2e/kWh +
    • +
  • + Code kg CO2e/kWh +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
batteryCarbonFootprint
+
+ + +
+
+ +
+

carbonFootprintPerLifecycleStage

+
+ +The carbon footprint of the battery as share of total Battery Carbon Footprint, differentiated per life cycle stages raw material extraction, battery production, distribution and recycling. + +
+
Name
+
carbonFootprintPerLifecycleStage
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:BatteryPass:1.0.0#CarbonFootprintPerLifecycleStageEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
carbonFootprintPerLifecycleStage
+
+ + +
+
+ +
+

carbonFootprintPerformanceClass

+
+ +The carbon footprint performance class that the relevant battery model per manufacturing plant corresponds to. + +
+
Name
+
carbonFootprintPerformanceClass
+
+ + + +
+
Characteristic
+
+
+
+
Code
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
carbonFootprintPerformanceClass
+
+ + +
+
+ +
+

carbonFootprintStudy

+
+ +A web link to get access to a public version of the study supporting the carbon footprint values. + +
+
Name
+
carbonFootprintStudy
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#anyURI + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
carbonFootprintStudy
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

CarbonFootprintPerLifecycleStageEntity

+
+
+ The carbon footprint of the battery as share of total Battery Carbon Footprint, differentiated per life cycle stage +
+ +
+

Properties

+
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.CarbonFootprint/1.0.0/gen/CarbonFootprint-sample.json b/SMARTENERGY/BatteriePass/io.BatteryPass.CarbonFootprint/1.0.0/gen/CarbonFootprint-sample.json new file mode 100644 index 00000000..e1f4d696 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.CarbonFootprint/1.0.0/gen/CarbonFootprint-sample.json @@ -0,0 +1,11 @@ +{ + "carbonFootprintPerLifecycleStage": [ + { + "lifecycleStage": "RawMaterialExtraction", + "carbonFootprint": 0 + } + ], + "carbonFootprintStudy": "telnet://192.0.2.16:80/", + "batteryCarbonFootprint": 0, + "carbonFootprintPerformanceClass": "eOMtThyhVNLWUZNRcBaQKxI" +} \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.CarbonFootprint/1.0.0/gen/CarbonFootprint-schema.json b/SMARTENERGY/BatteriePass/io.BatteryPass.CarbonFootprint/1.0.0/gen/CarbonFootprint-schema.json new file mode 100644 index 00000000..337c648c --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.CarbonFootprint/1.0.0/gen/CarbonFootprint-schema.json @@ -0,0 +1,97 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CarbonFootprint", + "description": "Data model for battery varbon footprint\nCopyright © 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is licensed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution.", + "type": "object", + "components": { + "schemas": { + "BatteryCarbonFootprint": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#BatteryCarbonFootprint", + "description": "The battery carbon footprint is an aggregation of the carbon footprint of the individual lifecycle stages" + }, + "LifecycleStage": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#LifecycleStage", + "enum": [ + "RawMaterialExtraction", + "MainProduction", + "Distribution", + "Recycling" + ] + }, + "CarbonFootprintValue": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CarbonFootprintValue" + }, + "CarbonFootprintPerLifecycleStageEntity": { + "description": "The carbon footprint of the battery as share of total Battery Carbon Footprint, differentiated per life cycle stage", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CarbonFootprintPerLifecycleStageEntity", + "type": "object", + "properties": { + "lifecycleStage": { + "description": "The description of the life cycle stage ", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#lifecycleStage", + "$ref": "#/components/schemas/LifecycleStage" + }, + "carbonFootprint": { + "description": "Carbon footprint of the individual lifecycle stage", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#carbonFootprint", + "$ref": "#/components/schemas/CarbonFootprintValue" + } + }, + "required": [ + "lifecycleStage", + "carbonFootprint" + ] + }, + "CarbonFootprints": { + "description": "CarbainFootprints per lifecycle stage", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CarbonFootprints", + "type": "array", + "items": { + "$ref": "#/components/schemas/CarbonFootprintPerLifecycleStageEntity" + } + }, + "CarbonFootprintPerformanceClass": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CarbonFootprintPerformanceClass", + "description": "EV, industrial and LMT batteries shall bear a conspicuous, clearly legible and indelible label indicating the carbon footprint of the battery and the carbon footprint performance class that the relevant battery model per manufacturing plant corresponds to. The carbon footprint performance class shall be accessible via the battery passport. A meaningful number of classes of performance will be developed (?) with category A being the best class with the lowest carbon footprint life cycle impact." + }, + "ResourcePath": { + "type": "string", + "format": "uri", + "x-samm-aspect-model-urn": "urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#ResourcePath", + "description": "The path of a resource." + } + } + }, + "properties": { + "batteryCarbonFootprint": { + "description": "The carbon footprint of the battery, calculated as kg of carbon dioxide equivalent per one kWh of the total energy provided by the battery over its expected service life, as declared in the Carbon Footprint Declaration.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#batteryCarbonFootprint", + "$ref": "#/components/schemas/BatteryCarbonFootprint" + }, + "carbonFootprintPerLifecycleStage": { + "description": "The carbon footprint of the battery as share of total Battery Carbon Footprint, differentiated per life cycle stages raw material extraction, battery production, distribution and recycling.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#carbonFootprintPerLifecycleStage", + "$ref": "#/components/schemas/CarbonFootprints" + }, + "carbonFootprintPerformanceClass": { + "description": "The carbon footprint performance class that the relevant battery model per manufacturing plant corresponds to.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#carbonFootprintPerformanceClass", + "$ref": "#/components/schemas/CarbonFootprintPerformanceClass" + }, + "carbonFootprintStudy": { + "description": "A web link to get access to a public version of the study supporting the carbon footprint values.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#carbonFootprintStudy", + "$ref": "#/components/schemas/ResourcePath" + } + }, + "required": [ + "batteryCarbonFootprint", + "carbonFootprintPerLifecycleStage", + "carbonFootprintPerformanceClass", + "carbonFootprintStudy" + ] +} \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.CarbonFootprint/1.0.0/gen/CarbonFootprint_en-async-api.json b/SMARTENERGY/BatteriePass/io.BatteryPass.CarbonFootprint/1.0.0/gen/CarbonFootprint_en-async-api.json new file mode 100644 index 00000000..7372ee49 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.CarbonFootprint/1.0.0/gen/CarbonFootprint_en-async-api.json @@ -0,0 +1,28 @@ +{ + "asyncapi": "3.0.0", + "id": "", + "info": { + "title": "CarbonFootprint MQTT API", + "version": "v1.0.0", + "description": "Data model for battery varbon footprint\nCopyright © 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is licensed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CarbonFootprint" + }, + "defaultContentType": "application/json", + "channels": { + "CarbonFootprint": { + "address": "/BatteryPass/1.0.0/CarbonFootprint", + "description": "This channel for updating CarbonFootprint Aspect.", + "parameters": { + "namespace": "BatteryPass", + "version": "1.0.0", + "aspect-name": "CarbonFootprint" + }, + "messages": {} + } + }, + "operations": {}, + "components": { + "messages": {}, + "schemas": {} + } +} \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.CarbonFootprint/1.0.0/gen/CarbonFootprint_en-open-api.json b/SMARTENERGY/BatteriePass/io.BatteryPass.CarbonFootprint/1.0.0/gen/CarbonFootprint_en-open-api.json new file mode 100644 index 00000000..51ca2367 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.CarbonFootprint/1.0.0/gen/CarbonFootprint_en-open-api.json @@ -0,0 +1,286 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "CarbonFootprint", + "version": "v1.0.0", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CarbonFootprint" + }, + "servers": [ + { + "url": "https://example.com/api/v1.0.0", + "variables": { + "api-version": { + "default": "v1.0.0" + } + } + } + ], + "paths": { + "/null": { + "get": { + "tags": [ + "CarbonFootprint" + ], + "operationId": "getCarbonFootprint", + "parameters": [], + "responses": { + "200": { + "$ref": "#/components/responses/CarbonFootprint" + }, + "401": { + "$ref": "#/components/responses/ClientError" + }, + "402": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFoundError" + } + } + }, + "post": { + "servers": [ + { + "url": "https://example.com/query-api/v1.0.0", + "variables": { + "api-version": { + "default": "v1.0.0" + } + } + } + ], + "tags": [ + "CarbonFootprint" + ], + "operationId": "postCarbonFootprint", + "parameters": [], + "requestBody": { + "$ref": "#/components/requestBodies/Filter" + }, + "responses": { + "200": { + "$ref": "#/components/responses/CarbonFootprint" + }, + "401": { + "$ref": "#/components/responses/ClientError" + }, + "402": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFoundError" + } + } + } + } + }, + "components": { + "schemas": { + "ErrorResponse": { + "type": "object", + "required": [ + "error" + ], + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + } + }, + "Error": { + "type": "object", + "required": [ + "details" + ], + "properties": { + "message": { + "type": "string", + "minLength": 1 + }, + "path": { + "type": "string", + "minLength": 1 + }, + "details": { + "type": "object", + "minLength": 1, + "additionalProperties": { + "type": "object" + } + }, + "code": { + "type": "string", + "nullable": true + } + } + }, + "Filter": { + "type": "object", + "required": [ + "filter" + ], + "properties": { + "filter": { + "type": "string", + "description": "The filter to use.", + "example": "filter={filter expression}" + }, + "option": { + "type": "string", + "description": "The option for the filter.", + "example": "option=limit({start},{count})" + } + } + }, + "BatteryCarbonFootprint": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#BatteryCarbonFootprint", + "description": "The battery carbon footprint is an aggregation of the carbon footprint of the individual lifecycle stages" + }, + "LifecycleStage": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#LifecycleStage", + "enum": [ + "RawMaterialExtraction", + "MainProduction", + "Distribution", + "Recycling" + ] + }, + "CarbonFootprintValue": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CarbonFootprintValue" + }, + "CarbonFootprintPerLifecycleStageEntity": { + "description": "The carbon footprint of the battery as share of total Battery Carbon Footprint, differentiated per life cycle stage", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CarbonFootprintPerLifecycleStageEntity", + "type": "object", + "properties": { + "lifecycleStage": { + "description": "The description of the life cycle stage ", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#lifecycleStage", + "$ref": "#/components/schemas/LifecycleStage" + }, + "carbonFootprint": { + "description": "Carbon footprint of the individual lifecycle stage", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#carbonFootprint", + "$ref": "#/components/schemas/CarbonFootprintValue" + } + }, + "required": [ + "lifecycleStage", + "carbonFootprint" + ] + }, + "CarbonFootprints": { + "description": "CarbainFootprints per lifecycle stage", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CarbonFootprints", + "type": "array", + "items": { + "$ref": "#/components/schemas/CarbonFootprintPerLifecycleStageEntity" + } + }, + "CarbonFootprintPerformanceClass": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CarbonFootprintPerformanceClass", + "description": "EV, industrial and LMT batteries shall bear a conspicuous, clearly legible and indelible label indicating the carbon footprint of the battery and the carbon footprint performance class that the relevant battery model per manufacturing plant corresponds to. The carbon footprint performance class shall be accessible via the battery passport. A meaningful number of classes of performance will be developed (?) with category A being the best class with the lowest carbon footprint life cycle impact." + }, + "ResourcePath": { + "type": "string", + "format": "uri", + "x-samm-aspect-model-urn": "urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#ResourcePath", + "description": "The path of a resource." + }, + "CarbonFootprint": { + "description": "Data model for battery varbon footprint\nCopyright © 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is licensed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution.", + "type": "object", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CarbonFootprint", + "properties": { + "batteryCarbonFootprint": { + "description": "The carbon footprint of the battery, calculated as kg of carbon dioxide equivalent per one kWh of the total energy provided by the battery over its expected service life, as declared in the Carbon Footprint Declaration.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#batteryCarbonFootprint", + "$ref": "#/components/schemas/BatteryCarbonFootprint" + }, + "carbonFootprintPerLifecycleStage": { + "description": "The carbon footprint of the battery as share of total Battery Carbon Footprint, differentiated per life cycle stages raw material extraction, battery production, distribution and recycling.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#carbonFootprintPerLifecycleStage", + "$ref": "#/components/schemas/CarbonFootprints" + }, + "carbonFootprintPerformanceClass": { + "description": "The carbon footprint performance class that the relevant battery model per manufacturing plant corresponds to.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#carbonFootprintPerformanceClass", + "$ref": "#/components/schemas/CarbonFootprintPerformanceClass" + }, + "carbonFootprintStudy": { + "description": "A web link to get access to a public version of the study supporting the carbon footprint values.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#carbonFootprintStudy", + "$ref": "#/components/schemas/ResourcePath" + } + }, + "required": [ + "batteryCarbonFootprint", + "carbonFootprintPerLifecycleStage", + "carbonFootprintPerformanceClass", + "carbonFootprintStudy" + ] + } + }, + "responses": { + "Unauthorized": { + "description": "The requesting user or client is not authenticated." + }, + "Forbidden": { + "description": "The requesting user or client is not authorized to access resources for the given tenant." + }, + "NotFoundError": { + "description": "The requested Twin has not been found." + }, + "ClientError": { + "description": "Payload or user input is invalid. See error details in the payload for more.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "CarbonFootprint": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CarbonFootprint" + } + } + }, + "description": "The request was successful." + } + }, + "requestBodies": { + "CarbonFootprint": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CarbonFootprint" + } + } + } + }, + "Filter": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Filter" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.Circularity/1.0.0/Circularity.ttl b/SMARTENERGY/BatteriePass/io.BatteryPass.Circularity/1.0.0/Circularity.ttl new file mode 100644 index 00000000..23dec97e --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.Circularity/1.0.0/Circularity.ttl @@ -0,0 +1,251 @@ +###################################################################### +# Copyright (c) 2024 Circulor GmbH on behalf of the Battery Pass Consortium +# +# 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-digitaltwin: . + +:Circularity a samm:Aspect ; + samm:description "Dismantling information (including at least: exploded diagrams of the battery system/pack showing the location of battery cells; disassembly sequences; type and number of fastening techniques to be unlocked; tools required for disassembly; warnings if risk of damaging parts exists; amount of cells used and layout); part numbers for components and contact details of sources for replacement spares; safety measures (Annex XIII (2b-d)); usable extinguishing agent (Annex VI, Part A(9)). 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is licensed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold commercially and is given appropriate attribution."@en ; + samm:properties ( :dismantlingAndRemovalInformation :sourceForSpareParts :recycledContent :safetyRequirements :endOfLifeInformation :renewableContent ) ; + samm:operations ( ) ; + samm:events ( ) . + +:dismantlingAndRemovalInformation a samm:Property ; + samm:description "Dismantling and Removal information, including at least:- Exploded diagrams of the battery system/pack showing the location of battery cells- Disassembly sequences- Type and number of fastening techniques to be unlocked- Tools required for disassembly- Warnings if risk of damaging parts exists- Amount of cells used and layout."@en ; + samm:characteristic :SetOfDocumentation . + +:sourceForSpareParts a samm:Property ; + samm:description "Contact details of sources for replacement spares. Postal address, including name and brand names, postal code and place, street and number, country, telephone, if any."@en ; + samm:characteristic :SetOfSparePartSources . + +:recycledContent a samm:Property ; + samm:description "Share of material recovered from waste present in active materials for each battery model per year and per manufacturing plant."@en ; + samm:characteristic :RecycledContentSet . + +:safetyRequirements a samm:Property ; + samm:preferredName "SafetyRequirements"@en ; + samm:description "Safety measures and instructions should also take past negative and extreme events as well as the separate data attributes ?battery status? and ?battery composition/chemistry? into account."@en ; + samm:characteristic :SafetyRequirements . + +:endOfLifeInformation a samm:Property ; + samm:preferredName "EndOfLifeInformation"@en ; + samm:description "Producer or producer responsibility organisations shall make information available to distributors and end-users on: the role of end-users in contributing to waste prevention, including by information on good practices and recommendations concerning the use of batteries aiming at extending their use phase and the possibilities of re-use, preparing for re-use, preparing for repurpose, repurposing and remanufacturing."@en ; + samm:characteristic :EndOfLifeInformation . + +:renewableContent a samm:Property ; + samm:preferredName "RenewableContent"@en ; + samm:description "Share of renewable material content. A renewable material is a material made of natural resources that can be replenished. "@en ; + samm:characteristic :RenewableContent . + +:SetOfDocumentation a samm-c:List ; + samm:description "A set of required documentation to support EoL actions"@en ; + samm:dataType :DismantlingandRemovalDocumentation . + +:SetOfSparePartSources a samm-c:Set ; + samm:dataType :SparePartSupplier . + +:RecycledContentSet a samm-c:Set ; + samm:dataType :RecycledContent . + +:SafetyRequirements a samm-c:SingleEntity ; + samm:dataType :SafetyRequirementEntity . + +:EndOfLifeInformation a samm-c:SingleEntity ; + samm:dataType :EndOfLifeInformationEnity . + +:RenewableContent a samm-c:Measurement ; + samm:dataType xsd:float ; + samm-c:unit unit:percent . + +:DismantlingandRemovalDocumentation a samm:Entity ; + samm:description "Dismantling and Removal information, including at least:- Exploded diagrams of the battery system/pack showing the location of battery cells- Disassembly sequences- Type and number of fastening techniques to be unlocked- Tools required for disassembly- Warnings if risk of damaging parts exists- Amount of cells used and layoutEUBR: Annex XIII (2c)"@en ; + samm:properties ( :documentType :mimeType :documentURL ) . + +:SparePartSupplier a samm:Entity ; + samm:properties ( :nameOfSupplier :addressOfSupplier :emailAddressOfSupplier :supplierWebAddress :components ) . + +:RecycledContent a samm:Entity ; + samm:properties ( :preConsumerShare :recycledMaterial :postConsumerShare ) . + +:SafetyRequirementEntity a samm:Entity ; + samm:properties ( :safetyInstructions :extinguishingAgent ) . + +:EndOfLifeInformationEnity a samm:Entity ; + samm:properties ( :wastePrevention :separateCollection :informationOnCollection ) . + +:documentType a samm:Property ; + samm:description "Describes type for document e.g. Dismantling manual"@en ; + samm:characteristic :Documenttype . + +:mimeType a samm:Property ; + samm:description "Defines internet media typ to determin how to interpret the documentURL"@en ; + samm:characteristic samm-c:MimeType . + +:documentURL a samm:Property ; + samm:description "Link to document"@en ; + samm:characteristic samm-c:ResourcePath . + +:nameOfSupplier a samm:Property ; + samm:description "Name of Supplier"@en ; + samm:characteristic ext-digitaltwin:Text . + +:addressOfSupplier a samm:Property ; + samm:description "Postal address of supplier for spare parts."@en ; + samm:characteristic :AddressOfSupplier . + +:emailAddressOfSupplier a samm:Property ; + samm:description "E-mail address of supplier for spare parts."@en ; + samm:characteristic :EmailAddressOfSupplierTrait . + +:supplierWebAddress a samm:Property ; + samm:description "Web address of supplier for spare parts."@en ; + samm:characteristic samm-c:ResourcePath . + +:components a samm:Property ; + samm:description "Components available at supplier"@en ; + samm:characteristic :ComponentList . + +:preConsumerShare a samm:Property ; + samm:description "Recycled material share from pre-consumer waste (manufacturing waste, excluding run-around scrap) of the active material."@en ; + samm:characteristic :PreConsumerShareTrait . + +:recycledMaterial a samm:Property ; + samm:preferredName "RecycledMaterial"@en ; + samm:characteristic :RecycledMaterial . + +:postConsumerShare a samm:Property ; + samm:description "Recycled material share from post-consumer waste (end-of-life scrap) of the active material."@en ; + samm:characteristic :PostConsumerShareTrait . + +:safetyInstructions a samm:Property ; + samm:description "- Safety measures. - Necessary safety instructions to handle waste batteries, including in relation to the risks associated with, and the handling of, batteries containing lithium."@en ; + samm:characteristic :ResourcePath . + +:extinguishingAgent a samm:Property ; + samm:description "Usable extinguishing agents refering to classes of extinguishers (A, B, C, D, K).EUBR: Annex XIII (1a) ? Annex VI Part A (9)"@en ; + samm:characteristic :ExtinguishingAgentsList . + +:wastePrevention a samm:Property ; + samm:description "Prevention and management of waste batteries: Point (a) of Article 60(1): Information on the role of end-users in contributing to waste prevention, including by information on good practices and recommendations concerning the use of batteries aiming at extending their use phase and the possibilities of re-use, preparing for re-use, preparing for repurpose, repurposing and remanufacturing"@en ; + samm:characteristic :ResourcePath . + +:separateCollection a samm:Property ; + samm:description "Prevention and management of waste batteries: Point (b) of Article 60(1): Information on the role of end-users in contributing to the separate collection of waste batteries in accordance with their obligations under Article 51 so as to allow their treatment"@en ; + samm:characteristic :ResourcePath . + +:informationOnCollection a samm:Property ; + samm:description "Prevention and management of waste batteries: Point (c) of Article 60(1): information on the separate collection, the take back, the collection points and preparing for re-use, preparing for repurposing, and recycling operations available for waste batteries"@en ; + samm:characteristic :ResourcePath . + +:Documenttype a samm-c:Enumeration ; + samm:dataType xsd:string ; + samm-c:values ( "BillOfMaterial" "Model3D" "DismantlingManual" "RemovalManual" "OtherManual" "Drawing" ) . + +ext-digitaltwin:Text a samm:Characteristic ; + samm:preferredName "Text"@en ; + samm:description "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc."@en ; + samm:dataType xsd:string . + +:AddressOfSupplier a samm-c:SingleEntity ; + samm:see ; + samm:dataType :PostalAddress . + +:EmailAddressOfSupplierTrait a samm-c:Trait ; + samm-c:baseCharacteristic samm-c:Text ; + samm-c:constraint :ValidEmailAddress . + +:ComponentList a samm-c:List ; + samm:description "List of components available at supplier"@en ; + samm:dataType :Component . + +:PreConsumerShareTrait a samm-c:Trait ; + samm-c:baseCharacteristic :PreConsumerShare ; + samm-c:constraint :ConsumerShareRange . + +:RecycledMaterial a samm-c:Enumeration ; + samm:dataType xsd:string ; + samm-c:values ( "Cobalt" "Nickel" "Lithium" "Lead" ) . + +:PostConsumerShareTrait a samm-c:Trait ; + samm-c:baseCharacteristic :PostConsumerShare ; + samm-c:constraint :ConsumerShareRange . + +:ResourcePath a samm:Characteristic ; + samm:preferredName "Resource Path"@en ; + samm:description "The path of a resource."@en ; + samm:dataType xsd:anyURI . + +:ExtinguishingAgentsList a samm-c:List ; + samm:dataType xsd:string . + +:PostalAddress a samm:Entity ; + samm:properties ( :addressCountry :postalCode :streetAddress ) . + +:ValidEmailAddress a samm-c:RegularExpressionConstraint ; + samm:value "^[w.-]+@[w.-]+.[A-Za-z]{2,}$" . + +:Component a samm:Entity ; + samm:properties ( :partName :partNumber ) . + +:PreConsumerShare a samm-c:Measurement ; + samm:dataType xsd:float ; + samm-c:unit unit:percent . + +:ConsumerShareRange a samm-c:RangeConstraint ; + samm-c:minValue "0"^^xsd:float ; + samm-c:maxValue "100"^^xsd:float ; + samm-c:lowerBoundDefinition samm-c:AT_LEAST ; + samm-c:upperBoundDefinition samm-c:AT_MOST . + +:PostConsumerShare a samm-c:Measurement ; + samm:dataType xsd:float ; + samm-c:unit unit:percent . + +:addressCountry a samm:Property ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Germany" . + +:postalCode a samm:Property ; + samm:preferredName "PostalCode"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "DE-10719" . + +:streetAddress a samm:Property ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Street 1" . + +:partName a samm:Property ; + samm:preferredName "PartName"@en ; + samm:characteristic :Text ; + samm:exampleValue "Cell" . + +:partNumber a samm:Property ; + samm:description "Part Number of Component"@en ; + samm:characteristic :PartNumber . + +:Text a samm:Characteristic ; + samm:preferredName "Text"@en ; + samm:description "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc."@en ; + samm:dataType xsd:string . + +:PartNumber a samm-c:Code ; + samm:dataType xsd:string . + diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.Circularity/1.0.0/gen/Circularity-aas.xml b/SMARTENERGY/BatteriePass/io.BatteryPass.Circularity/1.0.0/gen/Circularity-aas.xml new file mode 100644 index 00000000..8bc7ec44 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.Circularity/1.0.0/gen/Circularity-aas.xml @@ -0,0 +1,1773 @@ + + + + + defaultAdminShell + + + en + defaultAdminShell + + + + urn:samm:BatteryPass:1.0.0#Circularity + + Type + + + + ModelReference + + + Submodel + urn:samm:BatteryPass:1.0.0#Circularity/submodel + + + + + + + + + Circularity + + + en + Dismantling information (including at least: exploded diagrams of the battery system/pack showing the +location of battery cells; disassembly sequences; type and number of fastening techniques to be un- +locked; tools required for disassembly; warnings if risk of damaging parts exists; amount of cells used +and layout); part numbers for components and contact details of sources for replacement spares; +safety measures (Annex XIII (2b-d)); usable extinguishing agent (Annex VI, Part A(9)). + +2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is licensed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution. + + + + urn:samm:BatteryPass:1.0.0#Circularity/submodel + Template + + ModelReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#Circularity + + + + + + dismantlingAndRemovalInformation + + + en + Dismantling and Removal information, including at least: +- Exploded diagrams of the battery system/pack showing the location of battery cells +- Disassembly sequences +- Type and number of fastening techniques to be unlocked +- Tools required for disassembly +- Warnings if risk of damaging parts exists +- Amount of cells used and layout + + + true + SubmodelElement + + + DismantlingandRemovalDocumentation + + + en + Dismantling and Removal information, including at least: +- Exploded diagrams of the battery system/pack showing the location of battery cells +- Disassembly sequences +- Type and number of fastening techniques to be unlocked +- Tools required for disassembly +- Warnings if risk of damaging parts exists +- Amount of cells used and layout + +EUBR: Annex XIII (2c) + + + + + documentType + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#documentType + + + + xs:string + + + + mimeType + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#mimeType + + + + xs:string + + + + documentURL + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#documentURL + + + + xs:anyURI + + + + + + + + sourceForSpareParts + + + en + Contact details of sources for replacement spares. Postal address, including name and brand names, postal code and place, street and number, country, telephone, if any. + + + true + SubmodelElement + + + SparePartSupplier + + + nameOfSupplier + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#nameOfSupplier + + + + xs:string + + + + PostalAddress + + + addressCountry + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#addressCountry + + + + xs:string + + + + postalCode + + + en + PostalCode + + + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#postalCode + + + + xs:string + + + + streetAddress + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#streetAddress + + + + xs:string + + + + + + emailAddressOfSupplier + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#emailAddressOfSupplier + + + + xs:string + + + + supplierWebAddress + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#supplierWebAddress + + + + xs:anyURI + + + + components + + + en + Components available at supplier + + + true + SubmodelElement + + + Component + + + partName + + + en + PartName + + + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#partName + + + + xs:string + + + + partNumber + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#partNumber + + + + xs:string + + + + + + + + + + + + recycledContent + + + en + Share of material recovered from waste present in active materials for each battery model per year and per manufacturing plant. + + + true + SubmodelElement + + + RecycledContent + + + preConsumerShare + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#preConsumerShare + + + + xs:float + + + + recycledMaterial + + + en + RecycledMaterial + + + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#recycledMaterial + + + + xs:string + + + + postConsumerShare + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#postConsumerShare + + + + xs:float + + + + + + + + SafetyRequirementEntity + + + safetyInstructions + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#safetyInstructions + + + + xs:anyURI + + + + extinguishingAgent + + + en + Usable extinguishing agents refering to classes of extinguishers (A, B, C, D, K). + +EUBR: Annex XIII (1a) ? Annex VI Part A (9) + + + true + SubmodelElement + + + extinguishingAgent + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#extinguishingAgent + + + + xs:string + + + + + + + + EndOfLifeInformationEnity + + + wastePrevention + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#wastePrevention + + + + xs:anyURI + + + + separateCollection + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#separateCollection + + + + xs:anyURI + + + + informationOnCollection + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#informationOnCollection + + + + xs:anyURI + + + + + + renewableContent + + + en + RenewableContent + + + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#renewableContent + + + + xs:float + + + + + + + + APPLICATION_CLASS + Circularity + + + en + Dismantling information (including at least: exploded diagrams of the battery system/pack showing the +location of battery cells; disassembly sequences; type and number of fastening techniques to be un- +locked; tools required for disassembly; warnings if risk of damaging parts exists; amount of cells used +and layout); part numbers for components and contact details of sources for replacement spares; +safety measures (Annex XIII (2b-d)); usable extinguishing agent (Annex VI, Part A(9)). + +2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is licensed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution. + + + urn:samm:BatteryPass:1.0.0#Circularity + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Circularity + + + + + en + Circularity + + + + + en + Dismantling information (including at least: exploded diagrams of the battery system/pack showing the +location of battery cells; disassembly sequences; type and number of fastening techniques to be un- +locked; tools required for disassembly; warnings if risk of damaging parts exists; amount of cells used +and layout); part numbers for components and contact details of sources for replacement spares; +safety measures (Annex XIII (2b-d)); usable extinguishing agent (Annex VI, Part A(9)). + +2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is licensed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution. + + + + + + + + + documentType + urn:samm:BatteryPass:1.0.0#documentType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + documentType + + + + + en + documentType + + + STRING + + + en + Describes type for document e.g. "Dismantling manual" + + + + + + BillOfMaterial + + ModelReference + + + DataElement + urn:samm:BatteryPass:1.0.0#Documenttype:BillOfMaterial + + + + + + Model3D + + ModelReference + + + DataElement + urn:samm:BatteryPass:1.0.0#Documenttype:Model3D + + + + + + DismantlingManual + + ModelReference + + + DataElement + urn:samm:BatteryPass:1.0.0#Documenttype:DismantlingManual + + + + + + RemovalManual + + ModelReference + + + DataElement + urn:samm:BatteryPass:1.0.0#Documenttype:RemovalManual + + + + + + OtherManual + + ModelReference + + + DataElement + urn:samm:BatteryPass:1.0.0#Documenttype:OtherManual + + + + + + Drawing + + ModelReference + + + DataElement + urn:samm:BatteryPass:1.0.0#Documenttype:Drawing + + + + + + + + + + + + + mimeType + urn:samm:BatteryPass:1.0.0#mimeType + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + mimeType + + + + + en + mimeType + + + STRING + + + en + Defines internet media typ to determin how to interpret the documentURL + + + + + + + + + documentURL + urn:samm:BatteryPass:1.0.0#documentURL + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + documentURL + + + + + en + documentURL + + + STRING + + + en + Link to document + + + + + + + + + dismantlingAndRemovalInformation + urn:samm:BatteryPass:1.0.0#dismantlingAndRemovalInformation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + dismantlingAndRemovalInformation + + + + + en + dismantlingAndRemovalInformation + + + STRING + + + en + Dismantling and Removal information, including at least: +- Exploded diagrams of the battery system/pack showing the location of battery cells +- Disassembly sequences +- Type and number of fastening techniques to be unlocked +- Tools required for disassembly +- Warnings if risk of damaging parts exists +- Amount of cells used and layout + + + + + + + + + nameOfSupplier + urn:samm:BatteryPass:1.0.0#nameOfSupplier + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + nameOfSupplier + + + + + en + nameOfSupplier + + + STRING + + + en + Name of Supplier + + + + + + + + + addressCountry + urn:samm:BatteryPass:1.0.0#addressCountry + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + addressCountry + + + + + en + addressCountry + + + STRING + + + + + + + postalCode + + + en + PostalCode + + + urn:samm:BatteryPass:1.0.0#postalCode + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + PostalCode + + + + + en + postalCode + + + STRING + + + + + + + streetAddress + urn:samm:BatteryPass:1.0.0#streetAddress + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + streetAddress + + + + + en + streetAddress + + + STRING + + + + + + + addressOfSupplier + urn:samm:BatteryPass:1.0.0#addressOfSupplier + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + addressOfSupplier + + + + + en + addressOfSupplier + + + STRING + + + en + Postal address of supplier for spare parts. + + + + + + + + + emailAddressOfSupplier + urn:samm:BatteryPass:1.0.0#emailAddressOfSupplier + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + emailAddressOfSupplier + + + + + en + emailAddressOfSupplier + + + STRING + + + en + E-mail address of supplier for spare parts. + + + + + + + + + supplierWebAddress + urn:samm:BatteryPass:1.0.0#supplierWebAddress + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + supplierWebAddress + + + + + en + supplierWebAddress + + + STRING + + + en + Web address of supplier for spare parts. + + + + + + + + + partName + + + en + PartName + + + urn:samm:BatteryPass:1.0.0#partName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + PartName + + + + + en + partName + + + STRING + + + + + + + partNumber + urn:samm:BatteryPass:1.0.0#partNumber + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + partNumber + + + + + en + partNumber + + + STRING + + + en + Part Number of Component + + + + + + + + + components + urn:samm:BatteryPass:1.0.0#components + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + components + + + + + en + components + + + STRING + + + en + Components available at supplier + + + + + + + + + sourceForSpareParts + urn:samm:BatteryPass:1.0.0#sourceForSpareParts + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + sourceForSpareParts + + + + + en + sourceForSpareParts + + + STRING + + + en + Contact details of sources for replacement spares. Postal address, including name and brand names, postal code and place, street and number, country, telephone, if any. + + + + + + + + + preConsumerShare + urn:samm:BatteryPass:1.0.0#preConsumerShare + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + preConsumerShare + + + + + en + preConsumerShare + + + REAL_MEASURE + + + en + Recycled material share from pre-consumer waste (manufacturing waste, excluding run-around scrap) of the active material. + + + + + + + + + recycledMaterial + + + en + RecycledMaterial + + + urn:samm:BatteryPass:1.0.0#recycledMaterial + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + RecycledMaterial + + + + + en + recycledMaterial + + + STRING + + + + Cobalt + + ModelReference + + + DataElement + urn:samm:BatteryPass:1.0.0#RecycledMaterial:Cobalt + + + + + + Nickel + + ModelReference + + + DataElement + urn:samm:BatteryPass:1.0.0#RecycledMaterial:Nickel + + + + + + Lithium + + ModelReference + + + DataElement + urn:samm:BatteryPass:1.0.0#RecycledMaterial:Lithium + + + + + + Lead + + ModelReference + + + DataElement + urn:samm:BatteryPass:1.0.0#RecycledMaterial:Lead + + + + + + + + + + + + + postConsumerShare + urn:samm:BatteryPass:1.0.0#postConsumerShare + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + postConsumerShare + + + + + en + postConsumerShare + + + REAL_MEASURE + + + en + Recycled material share from post-consumer waste (end-of-life scrap) of the active material. + + + + + + + + + recycledContent + urn:samm:BatteryPass:1.0.0#recycledContent + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + recycledContent + + + + + en + recycledContent + + + STRING + + + en + Share of material recovered from waste present in active materials for each battery model per year and per manufacturing plant. + + + + + + + + + safetyInstructions + urn:samm:BatteryPass:1.0.0#safetyInstructions + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + safetyInstructions + + + + + en + safetyInstructions + + + STRING + + + en + - Safety measures. +- Necessary safety instructions to handle waste batteries, including in relation to the risks associated with, and the handling of, batteries containing lithium. + + + + + + + + + extinguishingAgent + urn:samm:BatteryPass:1.0.0#extinguishingAgent + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + extinguishingAgent + + + + + en + extinguishingAgent + + + STRING + + + en + Usable extinguishing agents refering to classes of extinguishers (A, B, C, D, K). + +EUBR: Annex XIII (1a) ? Annex VI Part A (9) + + + + + + + + + safetyRequirements + + + en + SafetyRequirements + + + urn:samm:BatteryPass:1.0.0#safetyRequirements + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + SafetyRequirements + + + + + en + safetyRequirements + + + STRING + + + en + Safety measures and instructions should also take past negative and extreme events as well as the separate data attributes ?battery status? and ?battery composition/chemistry? into account. + + + + + + + + + wastePrevention + urn:samm:BatteryPass:1.0.0#wastePrevention + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + wastePrevention + + + + + en + wastePrevention + + + STRING + + + en + Prevention and management of waste batteries: Point (a) of Article 60(1): Information on "the role of end-users in contributing to waste prevention, including by information on good practices and recommendations concerning the use of batteries aiming at extending their use phase and the possibilities of re-use, preparing for re-use, preparing for repurpose, repurposing and remanufacturing". + + + + + + + + + separateCollection + urn:samm:BatteryPass:1.0.0#separateCollection + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + separateCollection + + + + + en + separateCollection + + + STRING + + + en + Prevention and management of waste batteries: Point (b) of Article 60(1): Information on "the role of end-users in contributing to the separate collection of waste batteries in accordance with their obligations under Article 51 so as to allow their treatment". + + + + + + + + + informationOnCollection + urn:samm:BatteryPass:1.0.0#informationOnCollection + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + informationOnCollection + + + + + en + informationOnCollection + + + STRING + + + en + Prevention and management of waste batteries: Point (c) of Article 60(1): information on "the separate collection, the take back, the collection points and preparing for re-use, preparing for repurposing, and recycling operations available for waste batteries". + + + + + + + + + + + endOfLifeInformation + + + en + EndOfLifeInformation + + + urn:samm:BatteryPass:1.0.0#endOfLifeInformation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + EndOfLifeInformation + + + + + en + endOfLifeInformation + + + STRING + + + en + Producer or producer responsibility organisations shall make information available to distributors and end-users on: the role of end-users in contributing to waste prevention, including by information on good practices and recommendations concerning the use of batteries aiming at extending their use phase and the possibilities of re-use, preparing for re-use, preparing for repurpose, repurposing and remanufacturing. + + + + + + + + + renewableContent + + + en + RenewableContent + + + urn:samm:BatteryPass:1.0.0#renewableContent + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + RenewableContent + + + + + en + renewableContent + + + percent + REAL_MEASURE + + + en + Share of renewable material content. A renewable material is a material made of natural resources that can be replenished. + + + + + + + + + diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.Circularity/1.0.0/gen/Circularity-documentation.html b/SMARTENERGY/BatteriePass/io.BatteryPass.Circularity/1.0.0/gen/Circularity-documentation.html new file mode 100644 index 00000000..fce3ab55 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.Circularity/1.0.0/gen/Circularity-documentation.html @@ -0,0 +1,779 @@ + + + + + + + + + + + + + + Documentation Circularity + + +
+
+
+
+

Aspect Model Circularity

+
urn:samm:BatteryPass:1.0.0#Circularity
+
+
+
+
+
+
+
+ +
+ + +
+ Dismantling information (including at least: exploded diagrams of the battery system/pack showing the +location of battery cells; disassembly sequences; type and number of fastening techniques to be un- +locked; tools required for disassembly; warnings if risk of damaging parts exists; amount of cells used +and layout); part numbers for components and contact details of sources for replacement spares; +safety measures (Annex XIII (2b-d)); usable extinguishing agent (Annex VI, Part A(9)). + +2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is licensed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution. +
+ + +
+

Overview

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

Properties

+
+ +
+ +
+

EndOfLifeInformation

+
+ +Producer or producer responsibility organisations shall make information available to distributors and end-users on: the role of end-users in contributing to waste prevention, including by information on good practices and recommendations concerning the use of batteries aiming at extending their use phase and the possibilities of re-use, preparing for re-use, preparing for repurpose, repurposing and remanufacturing. + +
+
Name
+
endOfLifeInformation
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:BatteryPass:1.0.0#EndOfLifeInformationEnity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
endOfLifeInformation
+
+ + +
+
+ +
+

RenewableContent

+
+ +Share of renewable material content. A renewable material is a material made of natural resources that can be replenished. + +
+
Name
+
renewableContent
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
+
+
+
Unit
+
+
+
+
    +
  • + percent +
    • +
  • + Symbol % +
    • +
  • + Code P1 +
    • +
  • + Conversion factor 1 × 10⁻² +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
renewableContent
+
+ + +
+
+ +
+

SafetyRequirements

+
+ +Safety measures and instructions should also take past negative and extreme events as well as the separate data attributes ?battery status? and ?battery composition/chemistry? into account. + +
+
Name
+
safetyRequirements
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:BatteryPass:1.0.0#SafetyRequirementEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
safetyRequirements
+
+ + +
+
+ +
+

dismantlingAndRemovalInformation

+
+ +Dismantling and Removal information, including at least: +- Exploded diagrams of the battery system/pack showing the location of battery cells +- Disassembly sequences +- Type and number of fastening techniques to be unlocked +- Tools required for disassembly +- Warnings if risk of damaging parts exists +- Amount of cells used and layout + +
+
Name
+
dismantlingAndRemovalInformation
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:BatteryPass:1.0.0#DismantlingandRemovalDocumentation + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
dismantlingAndRemovalInformation
+
+ + +
+
+ +
+

recycledContent

+
+ +Share of material recovered from waste present in active materials for each battery model per year and per manufacturing plant. + +
+
Name
+
recycledContent
+
+ + + +
+
Characteristic
+
+
+
+
Set
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:BatteryPass:1.0.0#RecycledContent + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
recycledContent
+
+ + +
+
+ +
+

sourceForSpareParts

+
+ +Contact details of sources for replacement spares. Postal address, including name and brand names, postal code and place, street and number, country, telephone, if any. + +
+
Name
+
sourceForSpareParts
+
+ + + +
+
Characteristic
+
+
+
+
Set
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:BatteryPass:1.0.0#SparePartSupplier + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
sourceForSpareParts
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

Component

+
+
+ +
+ +
+

Properties

+
+
+
+
+

DismantlingandRemovalDocumentation

+
+
+ Dismantling and Removal information, including at least: +- Exploded diagrams of the battery system/pack showing the location of battery cells +- Disassembly sequences +- Type and number of fastening techniques to be unlocked +- Tools required for disassembly +- Warnings if risk of damaging parts exists +- Amount of cells used and layout + +EUBR: Annex XIII (2c) +
+ +
+

Properties

+
+
+
+
+

EndOfLifeInformationEnity

+
+
+ +
+ +
+

Properties

+
+
+
+
+

PostalAddress

+
+
+ +
+ +
+

Properties

+
+
+
+
+

RecycledContent

+
+
+ +
+ +
+

Properties

+
+
+
+
+

SafetyRequirementEntity

+
+
+ +
+ +
+

Properties

+
+
+
+
+

SparePartSupplier

+
+
+ +
+ +
+

Properties

+
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.Circularity/1.0.0/gen/Circularity-sample.json b/SMARTENERGY/BatteriePass/io.BatteryPass.Circularity/1.0.0/gen/Circularity-sample.json new file mode 100644 index 00000000..1686b8ce --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.Circularity/1.0.0/gen/Circularity-sample.json @@ -0,0 +1,46 @@ +{ + "renewableContent": 0, + "sourceForSpareParts": [ + { + "nameOfSupplier": "yedUsFwdkelQbxeTeQOvaScfqIOOmaa", + "components": [ + { + "partName": "Cell", + "partNumber": "JxkyvRnL" + } + ], + "supplierWebAddress": "ftp://ftp.is.co.za/rfc/rfc1808.txt", + "emailAddressOfSupplier": "TbdCGZhKQBMw-PAm5NG0Nqa-qa@xmPfauoZYeyoW1timGU8jEIkUKlM7njoOuNvMLupaDh4JbQQQDfANQCTZmyOu.JfRjlRoSSpzOUZAweQkcYucrkJzXIaorinIruGsqJeWbXhaJqvJpyyuCOHIEFhgiupjNeaeOHbajvDHoTJUVSMwo", + "addressOfSupplier": { + "addressCountry": "Germany", + "streetAddress": "Street 1", + "postalCode": "DE-10719" + } + } + ], + "dismantlingAndRemovalInformation": [ + { + "documentType": "BillOfMaterial", + "mimeType": "eOMtThyhVNLWUZNRcBaQKxI", + "documentURL": "telnet://192.0.2.16:80/" + } + ], + "recycledContent": [ + { + "preConsumerShare": 75.246895, + "recycledMaterial": "Cobalt", + "postConsumerShare": 95.9721 + } + ], + "safetyRequirements": { + "safetyInstructions": "http://www.ietf.org/rfc/rfc2396.txt", + "extinguishingAgent": [ + "RYtGKbgicZaHCBRQDSx" + ] + }, + "endOfLifeInformation": { + "separateCollection": "ftp://ftp.is.co.za/rfc/rfc1808.txt", + "wastePrevention": "http://www.wikipedia.org", + "informationOnCollection": "telnet://192.0.2.16:80/" + } +} \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.Circularity/1.0.0/gen/Circularity-schema.json b/SMARTENERGY/BatteriePass/io.BatteryPass.Circularity/1.0.0/gen/Circularity-schema.json new file mode 100644 index 00000000..30c84dac --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.Circularity/1.0.0/gen/Circularity-schema.json @@ -0,0 +1,378 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#Circularity", + "description": "Dismantling information (including at least: exploded diagrams of the battery system/pack showing the\nlocation of battery cells; disassembly sequences; type and number of fastening techniques to be un-\nlocked; tools required for disassembly; warnings if risk of damaging parts exists; amount of cells used\nand layout); part numbers for components and contact details of sources for replacement spares;\nsafety measures (Annex XIII (2b-d)); usable extinguishing agent (Annex VI, Part A(9)).\n\n2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is licensed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution.", + "type": "object", + "components": { + "schemas": { + "Documenttype": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#Documenttype", + "enum": [ + "BillOfMaterial", + "Model3D", + "DismantlingManual", + "RemovalManual", + "OtherManual", + "Drawing" + ] + }, + "MimeType": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#MimeType", + "description": "A MIME type as defined in RFC 2046, for example \"application/pdf\"." + }, + "ResourcePath": { + "type": "string", + "format": "uri", + "x-samm-aspect-model-urn": "urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#ResourcePath", + "description": "The path of a resource." + }, + "DismantlingandRemovalDocumentation": { + "description": "Dismantling and Removal information, including at least:\n- Exploded diagrams of the battery system/pack showing the location of battery cells\n- Disassembly sequences\n- Type and number of fastening techniques to be unlocked\n- Tools required for disassembly\n- Warnings if risk of damaging parts exists\n- Amount of cells used and layout\n\nEUBR: Annex XIII (2c)", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#DismantlingandRemovalDocumentation", + "type": "object", + "properties": { + "documentType": { + "description": "Describes type for document e.g. \"Dismantling manual\"", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#documentType", + "$ref": "#/components/schemas/Documenttype" + }, + "mimeType": { + "description": "Defines internet media typ to determin how to interpret the documentURL", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#mimeType", + "$ref": "#/components/schemas/MimeType" + }, + "documentURL": { + "description": "Link to document", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#documentURL", + "$ref": "#/components/schemas/ResourcePath" + } + }, + "required": [ + "documentType", + "mimeType", + "documentURL" + ] + }, + "SetOfDocumentation": { + "description": "A set of required documentation to support EoL actions", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#SetOfDocumentation", + "type": "array", + "items": { + "$ref": "#/components/schemas/DismantlingandRemovalDocumentation" + } + }, + "Text": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:org.eclipse.digitaltwin:1.0.0#Text", + "description": "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." + }, + "Text0": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text", + "description": "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." + }, + "PostalAddress": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#PostalAddress", + "type": "object", + "properties": { + "addressCountry": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#addressCountry", + "$ref": "#/components/schemas/Text0" + }, + "postalCode": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#postalCode", + "$ref": "#/components/schemas/Text0" + }, + "streetAddress": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#streetAddress", + "$ref": "#/components/schemas/Text0" + } + }, + "required": [ + "addressCountry", + "postalCode", + "streetAddress" + ] + }, + "AddressOfSupplier": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#AddressOfSupplier", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/PostalAddress" + } + ] + }, + "EmailAddressOfSupplierTrait": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#EmailAddressOfSupplierTrait", + "description": "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.", + "pattern": "^[\\w.-]+@[\\w.-]+\\.[A-Za-z]{2,}$" + }, + "Text1": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#Text", + "description": "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." + }, + "PartNumber": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#PartNumber" + }, + "Component": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#Component", + "type": "object", + "properties": { + "partName": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#partName", + "$ref": "#/components/schemas/Text1" + }, + "partNumber": { + "description": "Part Number of Component", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#partNumber", + "$ref": "#/components/schemas/PartNumber" + } + }, + "required": [ + "partName", + "partNumber" + ] + }, + "ComponentList": { + "description": "List of components available at supplier", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#ComponentList", + "type": "array", + "items": { + "$ref": "#/components/schemas/Component" + } + }, + "SparePartSupplier": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#SparePartSupplier", + "type": "object", + "properties": { + "nameOfSupplier": { + "description": "Name of Supplier", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#nameOfSupplier", + "$ref": "#/components/schemas/Text" + }, + "addressOfSupplier": { + "description": "Postal address of supplier for spare parts.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#addressOfSupplier", + "$ref": "#/components/schemas/AddressOfSupplier" + }, + "emailAddressOfSupplier": { + "description": "E-mail address of supplier for spare parts.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#emailAddressOfSupplier", + "$ref": "#/components/schemas/EmailAddressOfSupplierTrait" + }, + "supplierWebAddress": { + "description": "Web address of supplier for spare parts.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#supplierWebAddress", + "$ref": "#/components/schemas/ResourcePath" + }, + "components": { + "description": "Components available at supplier", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#components", + "$ref": "#/components/schemas/ComponentList" + } + }, + "required": [ + "nameOfSupplier", + "addressOfSupplier", + "emailAddressOfSupplier", + "supplierWebAddress", + "components" + ] + }, + "SetOfSparePartSources": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#SetOfSparePartSources", + "type": "array", + "items": { + "$ref": "#/components/schemas/SparePartSupplier" + }, + "uniqueItems": true + }, + "PreConsumerShareTrait": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#PreConsumerShareTrait", + "maximum": 100, + "exclusiveMaximum": false, + "minimum": 0, + "exclusiveMinimum": false + }, + "RecycledMaterial": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RecycledMaterial", + "enum": [ + "Cobalt", + "Nickel", + "Lithium", + "Lead" + ] + }, + "PostConsumerShareTrait": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#PostConsumerShareTrait", + "maximum": 100, + "exclusiveMaximum": false, + "minimum": 0, + "exclusiveMinimum": false + }, + "RecycledContent": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RecycledContent", + "type": "object", + "properties": { + "preConsumerShare": { + "description": "Recycled material share from pre-consumer waste (manufacturing waste, excluding run-around scrap) of the active material.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#preConsumerShare", + "$ref": "#/components/schemas/PreConsumerShareTrait" + }, + "recycledMaterial": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#recycledMaterial", + "$ref": "#/components/schemas/RecycledMaterial" + }, + "postConsumerShare": { + "description": "Recycled material share from post-consumer waste (end-of-life scrap) of the active material.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#postConsumerShare", + "$ref": "#/components/schemas/PostConsumerShareTrait" + } + }, + "required": [ + "preConsumerShare", + "recycledMaterial", + "postConsumerShare" + ] + }, + "RecycledContentSet": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RecycledContentSet", + "type": "array", + "items": { + "$ref": "#/components/schemas/RecycledContent" + }, + "uniqueItems": true + }, + "ResourcePath0": { + "type": "string", + "format": "uri", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#ResourcePath", + "description": "The path of a resource." + }, + "ExtinguishingAgentsList": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#ExtinguishingAgentsList", + "type": "array", + "items": { + "type": "string" + } + }, + "SafetyRequirementEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#SafetyRequirementEntity", + "type": "object", + "properties": { + "safetyInstructions": { + "description": "- Safety measures. \n- Necessary safety instructions to handle waste batteries, including in relation to the risks associated with, and the handling of, batteries containing lithium.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#safetyInstructions", + "$ref": "#/components/schemas/ResourcePath0" + }, + "extinguishingAgent": { + "description": "Usable extinguishing agents refering to classes of extinguishers (A, B, C, D, K).\n\nEUBR: Annex XIII (1a) ? Annex VI Part A (9)", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#extinguishingAgent", + "$ref": "#/components/schemas/ExtinguishingAgentsList" + } + }, + "required": [ + "safetyInstructions", + "extinguishingAgent" + ] + }, + "SafetyRequirements": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#SafetyRequirements", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/SafetyRequirementEntity" + } + ] + }, + "EndOfLifeInformationEnity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#EndOfLifeInformationEnity", + "type": "object", + "properties": { + "wastePrevention": { + "description": "Prevention and management of waste batteries: Point (a) of Article 60(1): Information on \"the role of end-users in contributing to waste prevention, including by information on good practices and recommendations concerning the use of batteries aiming at extending their use phase and the possibilities of re-use, preparing for re-use, preparing for repurpose, repurposing and remanufacturing\".", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#wastePrevention", + "$ref": "#/components/schemas/ResourcePath0" + }, + "separateCollection": { + "description": "Prevention and management of waste batteries: Point (b) of Article 60(1): Information on \"the role of end-users in contributing to the separate collection of waste batteries in accordance with their obligations under Article 51 so as to allow their treatment\".", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#separateCollection", + "$ref": "#/components/schemas/ResourcePath0" + }, + "informationOnCollection": { + "description": "Prevention and management of waste batteries: Point (c) of Article 60(1): information on \"the separate collection, the take back, the collection points and preparing for re-use, preparing for repurposing, and recycling operations available for waste batteries\". \n\n", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#informationOnCollection", + "$ref": "#/components/schemas/ResourcePath0" + } + }, + "required": [ + "wastePrevention", + "separateCollection", + "informationOnCollection" + ] + }, + "EndOfLifeInformation": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#EndOfLifeInformation", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/EndOfLifeInformationEnity" + } + ] + }, + "RenewableContent": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RenewableContent" + } + } + }, + "properties": { + "dismantlingAndRemovalInformation": { + "description": "Dismantling and Removal information, including at least:\n- Exploded diagrams of the battery system/pack showing the location of battery cells\n- Disassembly sequences\n- Type and number of fastening techniques to be unlocked\n- Tools required for disassembly\n- Warnings if risk of damaging parts exists\n- Amount of cells used and layout", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#dismantlingAndRemovalInformation", + "$ref": "#/components/schemas/SetOfDocumentation" + }, + "sourceForSpareParts": { + "description": "Contact details of sources for replacement spares. Postal address, including name and brand names, postal code and place, street and number, country, telephone, if any.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#sourceForSpareParts", + "$ref": "#/components/schemas/SetOfSparePartSources" + }, + "recycledContent": { + "description": "Share of material recovered from waste present in active materials for each battery model per year and per manufacturing plant.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#recycledContent", + "$ref": "#/components/schemas/RecycledContentSet" + }, + "safetyRequirements": { + "description": "Safety measures and instructions should also take past negative and extreme events as well as the separate data attributes ?battery status? and ?battery composition/chemistry? into account.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#safetyRequirements", + "$ref": "#/components/schemas/SafetyRequirements" + }, + "endOfLifeInformation": { + "description": "Producer or producer responsibility organisations shall make information available to distributors and end-users on: the role of end-users in contributing to waste prevention, including by information on good practices and recommendations concerning the use of batteries aiming at extending their use phase and the possibilities of re-use, preparing for re-use, preparing for repurpose, repurposing and remanufacturing.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#endOfLifeInformation", + "$ref": "#/components/schemas/EndOfLifeInformation" + }, + "renewableContent": { + "description": "Share of renewable material content. A renewable material is a material made of natural resources that can be replenished. ", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#renewableContent", + "$ref": "#/components/schemas/RenewableContent" + } + }, + "required": [ + "dismantlingAndRemovalInformation", + "sourceForSpareParts", + "recycledContent", + "safetyRequirements", + "endOfLifeInformation", + "renewableContent" + ] +} \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.Circularity/1.0.0/gen/Circularity_en-async-api.json b/SMARTENERGY/BatteriePass/io.BatteryPass.Circularity/1.0.0/gen/Circularity_en-async-api.json new file mode 100644 index 00000000..5ec45844 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.Circularity/1.0.0/gen/Circularity_en-async-api.json @@ -0,0 +1,28 @@ +{ + "asyncapi": "3.0.0", + "id": "", + "info": { + "title": "Circularity MQTT API", + "version": "v1.0.0", + "description": "Dismantling information (including at least: exploded diagrams of the battery system/pack showing the\nlocation of battery cells; disassembly sequences; type and number of fastening techniques to be un-\nlocked; tools required for disassembly; warnings if risk of damaging parts exists; amount of cells used\nand layout); part numbers for components and contact details of sources for replacement spares;\nsafety measures (Annex XIII (2b-d)); usable extinguishing agent (Annex VI, Part A(9)).\n\n2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is licensed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#Circularity" + }, + "defaultContentType": "application/json", + "channels": { + "Circularity": { + "address": "/BatteryPass/1.0.0/Circularity", + "description": "This channel for updating Circularity Aspect.", + "parameters": { + "namespace": "BatteryPass", + "version": "1.0.0", + "aspect-name": "Circularity" + }, + "messages": {} + } + }, + "operations": {}, + "components": { + "messages": {}, + "schemas": {} + } +} \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.Circularity/1.0.0/gen/Circularity_en-open-api.json b/SMARTENERGY/BatteriePass/io.BatteryPass.Circularity/1.0.0/gen/Circularity_en-open-api.json new file mode 100644 index 00000000..643b8964 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.Circularity/1.0.0/gen/Circularity_en-open-api.json @@ -0,0 +1,567 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "Circularity", + "version": "v1.0.0", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#Circularity" + }, + "servers": [ + { + "url": "https://example.com/api/v1.0.0", + "variables": { + "api-version": { + "default": "v1.0.0" + } + } + } + ], + "paths": { + "/null": { + "get": { + "tags": [ + "Circularity" + ], + "operationId": "getCircularity", + "parameters": [], + "responses": { + "200": { + "$ref": "#/components/responses/Circularity" + }, + "401": { + "$ref": "#/components/responses/ClientError" + }, + "402": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFoundError" + } + } + }, + "post": { + "servers": [ + { + "url": "https://example.com/query-api/v1.0.0", + "variables": { + "api-version": { + "default": "v1.0.0" + } + } + } + ], + "tags": [ + "Circularity" + ], + "operationId": "postCircularity", + "parameters": [], + "requestBody": { + "$ref": "#/components/requestBodies/Filter" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Circularity" + }, + "401": { + "$ref": "#/components/responses/ClientError" + }, + "402": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFoundError" + } + } + } + } + }, + "components": { + "schemas": { + "ErrorResponse": { + "type": "object", + "required": [ + "error" + ], + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + } + }, + "Error": { + "type": "object", + "required": [ + "details" + ], + "properties": { + "message": { + "type": "string", + "minLength": 1 + }, + "path": { + "type": "string", + "minLength": 1 + }, + "details": { + "type": "object", + "minLength": 1, + "additionalProperties": { + "type": "object" + } + }, + "code": { + "type": "string", + "nullable": true + } + } + }, + "Filter": { + "type": "object", + "required": [ + "filter" + ], + "properties": { + "filter": { + "type": "string", + "description": "The filter to use.", + "example": "filter={filter expression}" + }, + "option": { + "type": "string", + "description": "The option for the filter.", + "example": "option=limit({start},{count})" + } + } + }, + "Documenttype": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#Documenttype", + "enum": [ + "BillOfMaterial", + "Model3D", + "DismantlingManual", + "RemovalManual", + "OtherManual", + "Drawing" + ] + }, + "MimeType": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#MimeType", + "description": "A MIME type as defined in RFC 2046, for example \"application/pdf\"." + }, + "ResourcePath": { + "type": "string", + "format": "uri", + "x-samm-aspect-model-urn": "urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#ResourcePath", + "description": "The path of a resource." + }, + "DismantlingandRemovalDocumentation": { + "description": "Dismantling and Removal information, including at least:\n- Exploded diagrams of the battery system/pack showing the location of battery cells\n- Disassembly sequences\n- Type and number of fastening techniques to be unlocked\n- Tools required for disassembly\n- Warnings if risk of damaging parts exists\n- Amount of cells used and layout\n\nEUBR: Annex XIII (2c)", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#DismantlingandRemovalDocumentation", + "type": "object", + "properties": { + "documentType": { + "description": "Describes type for document e.g. \"Dismantling manual\"", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#documentType", + "$ref": "#/components/schemas/Documenttype" + }, + "mimeType": { + "description": "Defines internet media typ to determin how to interpret the documentURL", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#mimeType", + "$ref": "#/components/schemas/MimeType" + }, + "documentURL": { + "description": "Link to document", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#documentURL", + "$ref": "#/components/schemas/ResourcePath" + } + }, + "required": [ + "documentType", + "mimeType", + "documentURL" + ] + }, + "SetOfDocumentation": { + "description": "A set of required documentation to support EoL actions", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#SetOfDocumentation", + "type": "array", + "items": { + "$ref": "#/components/schemas/DismantlingandRemovalDocumentation" + } + }, + "Text": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:org.eclipse.digitaltwin:1.0.0#Text", + "description": "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." + }, + "Text0": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text", + "description": "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." + }, + "PostalAddress": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#PostalAddress", + "type": "object", + "properties": { + "addressCountry": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#addressCountry", + "$ref": "#/components/schemas/Text0" + }, + "postalCode": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#postalCode", + "$ref": "#/components/schemas/Text0" + }, + "streetAddress": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#streetAddress", + "$ref": "#/components/schemas/Text0" + } + }, + "required": [ + "addressCountry", + "postalCode", + "streetAddress" + ] + }, + "AddressOfSupplier": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#AddressOfSupplier", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/PostalAddress" + } + ] + }, + "EmailAddressOfSupplierTrait": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#EmailAddressOfSupplierTrait", + "description": "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.", + "pattern": "^[\\w.-]+@[\\w.-]+\\.[A-Za-z]{2,}$" + }, + "Text1": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#Text", + "description": "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." + }, + "PartNumber": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#PartNumber" + }, + "Component": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#Component", + "type": "object", + "properties": { + "partName": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#partName", + "$ref": "#/components/schemas/Text1" + }, + "partNumber": { + "description": "Part Number of Component", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#partNumber", + "$ref": "#/components/schemas/PartNumber" + } + }, + "required": [ + "partName", + "partNumber" + ] + }, + "ComponentList": { + "description": "List of components available at supplier", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#ComponentList", + "type": "array", + "items": { + "$ref": "#/components/schemas/Component" + } + }, + "SparePartSupplier": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#SparePartSupplier", + "type": "object", + "properties": { + "nameOfSupplier": { + "description": "Name of Supplier", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#nameOfSupplier", + "$ref": "#/components/schemas/Text" + }, + "addressOfSupplier": { + "description": "Postal address of supplier for spare parts.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#addressOfSupplier", + "$ref": "#/components/schemas/AddressOfSupplier" + }, + "emailAddressOfSupplier": { + "description": "E-mail address of supplier for spare parts.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#emailAddressOfSupplier", + "$ref": "#/components/schemas/EmailAddressOfSupplierTrait" + }, + "supplierWebAddress": { + "description": "Web address of supplier for spare parts.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#supplierWebAddress", + "$ref": "#/components/schemas/ResourcePath" + }, + "components": { + "description": "Components available at supplier", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#components", + "$ref": "#/components/schemas/ComponentList" + } + }, + "required": [ + "nameOfSupplier", + "addressOfSupplier", + "emailAddressOfSupplier", + "supplierWebAddress", + "components" + ] + }, + "SetOfSparePartSources": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#SetOfSparePartSources", + "type": "array", + "items": { + "$ref": "#/components/schemas/SparePartSupplier" + }, + "uniqueItems": true + }, + "PreConsumerShareTrait": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#PreConsumerShareTrait", + "maximum": 100, + "exclusiveMaximum": false, + "minimum": 0, + "exclusiveMinimum": false + }, + "RecycledMaterial": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RecycledMaterial", + "enum": [ + "Cobalt", + "Nickel", + "Lithium", + "Lead" + ] + }, + "PostConsumerShareTrait": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#PostConsumerShareTrait", + "maximum": 100, + "exclusiveMaximum": false, + "minimum": 0, + "exclusiveMinimum": false + }, + "RecycledContent": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RecycledContent", + "type": "object", + "properties": { + "preConsumerShare": { + "description": "Recycled material share from pre-consumer waste (manufacturing waste, excluding run-around scrap) of the active material.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#preConsumerShare", + "$ref": "#/components/schemas/PreConsumerShareTrait" + }, + "recycledMaterial": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#recycledMaterial", + "$ref": "#/components/schemas/RecycledMaterial" + }, + "postConsumerShare": { + "description": "Recycled material share from post-consumer waste (end-of-life scrap) of the active material.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#postConsumerShare", + "$ref": "#/components/schemas/PostConsumerShareTrait" + } + }, + "required": [ + "preConsumerShare", + "recycledMaterial", + "postConsumerShare" + ] + }, + "RecycledContentSet": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RecycledContentSet", + "type": "array", + "items": { + "$ref": "#/components/schemas/RecycledContent" + }, + "uniqueItems": true + }, + "ResourcePath0": { + "type": "string", + "format": "uri", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#ResourcePath", + "description": "The path of a resource." + }, + "ExtinguishingAgentsList": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#ExtinguishingAgentsList", + "type": "array", + "items": { + "type": "string" + } + }, + "SafetyRequirementEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#SafetyRequirementEntity", + "type": "object", + "properties": { + "safetyInstructions": { + "description": "- Safety measures. \n- Necessary safety instructions to handle waste batteries, including in relation to the risks associated with, and the handling of, batteries containing lithium.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#safetyInstructions", + "$ref": "#/components/schemas/ResourcePath0" + }, + "extinguishingAgent": { + "description": "Usable extinguishing agents refering to classes of extinguishers (A, B, C, D, K).\n\nEUBR: Annex XIII (1a) ? Annex VI Part A (9)", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#extinguishingAgent", + "$ref": "#/components/schemas/ExtinguishingAgentsList" + } + }, + "required": [ + "safetyInstructions", + "extinguishingAgent" + ] + }, + "SafetyRequirements": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#SafetyRequirements", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/SafetyRequirementEntity" + } + ] + }, + "EndOfLifeInformationEnity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#EndOfLifeInformationEnity", + "type": "object", + "properties": { + "wastePrevention": { + "description": "Prevention and management of waste batteries: Point (a) of Article 60(1): Information on \"the role of end-users in contributing to waste prevention, including by information on good practices and recommendations concerning the use of batteries aiming at extending their use phase and the possibilities of re-use, preparing for re-use, preparing for repurpose, repurposing and remanufacturing\".", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#wastePrevention", + "$ref": "#/components/schemas/ResourcePath0" + }, + "separateCollection": { + "description": "Prevention and management of waste batteries: Point (b) of Article 60(1): Information on \"the role of end-users in contributing to the separate collection of waste batteries in accordance with their obligations under Article 51 so as to allow their treatment\".", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#separateCollection", + "$ref": "#/components/schemas/ResourcePath0" + }, + "informationOnCollection": { + "description": "Prevention and management of waste batteries: Point (c) of Article 60(1): information on \"the separate collection, the take back, the collection points and preparing for re-use, preparing for repurposing, and recycling operations available for waste batteries\". \n\n", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#informationOnCollection", + "$ref": "#/components/schemas/ResourcePath0" + } + }, + "required": [ + "wastePrevention", + "separateCollection", + "informationOnCollection" + ] + }, + "EndOfLifeInformation": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#EndOfLifeInformation", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/EndOfLifeInformationEnity" + } + ] + }, + "RenewableContent": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RenewableContent" + }, + "Circularity": { + "description": "Dismantling information (including at least: exploded diagrams of the battery system/pack showing the\nlocation of battery cells; disassembly sequences; type and number of fastening techniques to be un-\nlocked; tools required for disassembly; warnings if risk of damaging parts exists; amount of cells used\nand layout); part numbers for components and contact details of sources for replacement spares;\nsafety measures (Annex XIII (2b-d)); usable extinguishing agent (Annex VI, Part A(9)).\n\n2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is licensed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution.", + "type": "object", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#Circularity", + "properties": { + "dismantlingAndRemovalInformation": { + "description": "Dismantling and Removal information, including at least:\n- Exploded diagrams of the battery system/pack showing the location of battery cells\n- Disassembly sequences\n- Type and number of fastening techniques to be unlocked\n- Tools required for disassembly\n- Warnings if risk of damaging parts exists\n- Amount of cells used and layout", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#dismantlingAndRemovalInformation", + "$ref": "#/components/schemas/SetOfDocumentation" + }, + "sourceForSpareParts": { + "description": "Contact details of sources for replacement spares. Postal address, including name and brand names, postal code and place, street and number, country, telephone, if any.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#sourceForSpareParts", + "$ref": "#/components/schemas/SetOfSparePartSources" + }, + "recycledContent": { + "description": "Share of material recovered from waste present in active materials for each battery model per year and per manufacturing plant.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#recycledContent", + "$ref": "#/components/schemas/RecycledContentSet" + }, + "safetyRequirements": { + "description": "Safety measures and instructions should also take past negative and extreme events as well as the separate data attributes ?battery status? and ?battery composition/chemistry? into account.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#safetyRequirements", + "$ref": "#/components/schemas/SafetyRequirements" + }, + "endOfLifeInformation": { + "description": "Producer or producer responsibility organisations shall make information available to distributors and end-users on: the role of end-users in contributing to waste prevention, including by information on good practices and recommendations concerning the use of batteries aiming at extending their use phase and the possibilities of re-use, preparing for re-use, preparing for repurpose, repurposing and remanufacturing.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#endOfLifeInformation", + "$ref": "#/components/schemas/EndOfLifeInformation" + }, + "renewableContent": { + "description": "Share of renewable material content. A renewable material is a material made of natural resources that can be replenished. ", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#renewableContent", + "$ref": "#/components/schemas/RenewableContent" + } + }, + "required": [ + "dismantlingAndRemovalInformation", + "sourceForSpareParts", + "recycledContent", + "safetyRequirements", + "endOfLifeInformation", + "renewableContent" + ] + } + }, + "responses": { + "Unauthorized": { + "description": "The requesting user or client is not authenticated." + }, + "Forbidden": { + "description": "The requesting user or client is not authorized to access resources for the given tenant." + }, + "NotFoundError": { + "description": "The requested Twin has not been found." + }, + "ClientError": { + "description": "Payload or user input is invalid. See error details in the payload for more.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "Circularity": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Circularity" + } + } + }, + "description": "The request was successful." + } + }, + "requestBodies": { + "Circularity": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Circularity" + } + } + } + }, + "Filter": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Filter" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.DueDiligence/1.0.0/SupplyChainDueDiligence.ttl b/SMARTENERGY/BatteriePass/io.BatteryPass.DueDiligence/1.0.0/SupplyChainDueDiligence.ttl new file mode 100644 index 00000000..b7952d7b --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.DueDiligence/1.0.0/SupplyChainDueDiligence.ttl @@ -0,0 +1,42 @@ +###################################################################### +# Copyright (c) 2024 Circulor GmbH on behalf of the Battery Pass Consortium +# +# 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 : . + +:SupplyChainDueDiligence a samm:Aspect ; + samm:description "Data model for Battery due diligence\n\nCopyright ? 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution."@en ; + samm:properties ( :supplyChainDueDiligenceReport :thirdPartyAussurances :euTaxonomyDisclosureStatement :sustainabilityReport ) ; + samm:operations ( ) ; + samm:events ( ) . + +:supplyChainDueDiligenceReport a samm:Property ; + samm:description "Information on responsible sourcing as indicated in the report on its due diligence policies referred to in Article 45e(3) (...) That report shall contain, in a manner that is easily comprehensible for end-users and clearly identifies the batteries concerned, the data and information on steps taken by that economic operator to comply with the requirements set out in Articles 45b and 45c, including findings of significant adverse impacts in the risk categories listed in Annex X, point 2, and how they have been addressed, as well as a summary report of the third-party verifications carried out in accordance with Article 45d, including the name of the notified body, with due regard for business confidentiality and other competitive concerns. It shall also elaborate, where relevant, on access to information, public participation in decision-making and access to justice in environmental matters in relation the sourcing, processing and trading of the raw materials. "@en ; + samm:characteristic samm-c:ResourcePath . + +:thirdPartyAussurances a samm:Property ; + samm:characteristic samm-c:ResourcePath . + +:euTaxonomyDisclosureStatement a samm:Property ; + samm:characteristic samm-c:ResourcePath . + +:sustainabilityReport a samm:Property ; + samm:characteristic samm-c:ResourcePath . + diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.DueDiligence/1.0.0/gen/SDD_en-async-api.json b/SMARTENERGY/BatteriePass/io.BatteryPass.DueDiligence/1.0.0/gen/SDD_en-async-api.json new file mode 100644 index 00000000..74ea6235 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.DueDiligence/1.0.0/gen/SDD_en-async-api.json @@ -0,0 +1,28 @@ +{ + "asyncapi": "3.0.0", + "id": "", + "info": { + "title": "SupplyChainDueDiligence MQTT API", + "version": "v1.0.0", + "description": "Data model for Battery due diligence\n\nCopyright © 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#SupplyChainDueDiligence" + }, + "defaultContentType": "application/json", + "channels": { + "SupplyChainDueDiligence": { + "address": "/BatteryPass/1.0.0/SupplyChainDueDiligence", + "description": "This channel for updating SupplyChainDueDiligence Aspect.", + "parameters": { + "namespace": "BatteryPass", + "version": "1.0.0", + "aspect-name": "SupplyChainDueDiligence" + }, + "messages": {} + } + }, + "operations": {}, + "components": { + "messages": {}, + "schemas": {} + } +} \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.DueDiligence/1.0.0/gen/SDD_en-open-api.json b/SMARTENERGY/BatteriePass/io.BatteryPass.DueDiligence/1.0.0/gen/SDD_en-open-api.json new file mode 100644 index 00000000..7f927ab8 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.DueDiligence/1.0.0/gen/SDD_en-open-api.json @@ -0,0 +1,230 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "SupplyChainDueDiligence", + "version": "v1.0.0", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#SupplyChainDueDiligence" + }, + "servers": [ + { + "url": "https://example.com/api/v1.0.0", + "variables": { + "api-version": { + "default": "v1.0.0" + } + } + } + ], + "paths": { + "/null": { + "get": { + "tags": [ + "SupplyChainDueDiligence" + ], + "operationId": "getSupplyChainDueDiligence", + "parameters": [], + "responses": { + "200": { + "$ref": "#/components/responses/SupplyChainDueDiligence" + }, + "401": { + "$ref": "#/components/responses/ClientError" + }, + "402": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFoundError" + } + } + }, + "post": { + "servers": [ + { + "url": "https://example.com/query-api/v1.0.0", + "variables": { + "api-version": { + "default": "v1.0.0" + } + } + } + ], + "tags": [ + "SupplyChainDueDiligence" + ], + "operationId": "postSupplyChainDueDiligence", + "parameters": [], + "requestBody": { + "$ref": "#/components/requestBodies/Filter" + }, + "responses": { + "200": { + "$ref": "#/components/responses/SupplyChainDueDiligence" + }, + "401": { + "$ref": "#/components/responses/ClientError" + }, + "402": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFoundError" + } + } + } + } + }, + "components": { + "schemas": { + "ErrorResponse": { + "type": "object", + "required": [ + "error" + ], + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + } + }, + "Error": { + "type": "object", + "required": [ + "details" + ], + "properties": { + "message": { + "type": "string", + "minLength": 1 + }, + "path": { + "type": "string", + "minLength": 1 + }, + "details": { + "type": "object", + "minLength": 1, + "additionalProperties": { + "type": "object" + } + }, + "code": { + "type": "string", + "nullable": true + } + } + }, + "Filter": { + "type": "object", + "required": [ + "filter" + ], + "properties": { + "filter": { + "type": "string", + "description": "The filter to use.", + "example": "filter={filter expression}" + }, + "option": { + "type": "string", + "description": "The option for the filter.", + "example": "option=limit({start},{count})" + } + } + }, + "ResourcePath": { + "type": "string", + "format": "uri", + "x-samm-aspect-model-urn": "urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#ResourcePath", + "description": "The path of a resource." + }, + "SupplyChainDueDiligence": { + "description": "Data model for Battery due diligence\n\nCopyright © 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution.", + "type": "object", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#SupplyChainDueDiligence", + "properties": { + "supplyChainDueDiligenceReport": { + "description": "Information on responsible sourcing as indicated in the report on its due diligence policies referred to in Article 45e(3) (...) That report shall contain, in a manner that is easily comprehensible for end-users and clearly identifies the batteries concerned, the data and information on steps taken by that economic operator to comply with the requirements set out in Articles 45b and 45c, including findings of significant adverse impacts in the risk categories listed in Annex X, point 2, and how they have been addressed, as well as a summary report of the third-party verifications carried out in accordance with Article 45d, including the name of the notified body, with due regard for business confidentiality and other competitive concerns. It shall also elaborate, where relevant, on access to information, public participation in decision-making and access to justice in environmental matters in relation the sourcing, processing and trading of the raw materials. ", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#supplyChainDueDiligenceReport", + "$ref": "#/components/schemas/ResourcePath" + }, + "thirdPartyAussurances": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#thirdPartyAussurances", + "$ref": "#/components/schemas/ResourcePath" + }, + "euTaxonomyDisclosureStatement": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#euTaxonomyDisclosureStatement", + "$ref": "#/components/schemas/ResourcePath" + }, + "sustainabilityReport": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#sustainabilityReport", + "$ref": "#/components/schemas/ResourcePath" + } + }, + "required": [ + "supplyChainDueDiligenceReport", + "thirdPartyAussurances", + "euTaxonomyDisclosureStatement", + "sustainabilityReport" + ] + } + }, + "responses": { + "Unauthorized": { + "description": "The requesting user or client is not authenticated." + }, + "Forbidden": { + "description": "The requesting user or client is not authorized to access resources for the given tenant." + }, + "NotFoundError": { + "description": "The requested Twin has not been found." + }, + "ClientError": { + "description": "Payload or user input is invalid. See error details in the payload for more.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "SupplyChainDueDiligence": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SupplyChainDueDiligence" + } + } + }, + "description": "The request was successful." + } + }, + "requestBodies": { + "SupplyChainDueDiligence": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SupplyChainDueDiligence" + } + } + } + }, + "Filter": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Filter" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.DueDiligence/1.0.0/gen/SupplyChainDueDiligence-aas.xml b/SMARTENERGY/BatteriePass/io.BatteryPass.DueDiligence/1.0.0/gen/SupplyChainDueDiligence-aas.xml new file mode 100644 index 00000000..a6ab9325 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.DueDiligence/1.0.0/gen/SupplyChainDueDiligence-aas.xml @@ -0,0 +1,307 @@ + + + + + defaultAdminShell + + + en + defaultAdminShell + + + + urn:samm:BatteryPass:1.0.0#SupplyChainDueDiligence + + Type + + + + ModelReference + + + Submodel + urn:samm:BatteryPass:1.0.0#SupplyChainDueDiligence/submodel + + + + + + + + + SupplyChainDueDiligence + + + en + Data model for Battery due diligence + +Copyright � 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution. + + + + urn:samm:BatteryPass:1.0.0#SupplyChainDueDiligence/submodel + Template + + ModelReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#SupplyChainDueDiligence + + + + + + supplyChainDueDiligenceReport + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#supplyChainDueDiligenceReport + + + + xs:anyURI + + + + thirdPartyAussurances + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#thirdPartyAussurances + + + + xs:anyURI + + + + euTaxonomyDisclosureStatement + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#euTaxonomyDisclosureStatement + + + + xs:anyURI + + + + sustainabilityReport + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#sustainabilityReport + + + + xs:anyURI + + + + + + + + APPLICATION_CLASS + SupplyChainDueDiligence + + + en + Data model for Battery due diligence + +Copyright � 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution. + + + urn:samm:BatteryPass:1.0.0#SupplyChainDueDiligence + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + SupplyChainDueDiligence + + + + + en + SupplyChainDueDiligence + + + + + en + Data model for Battery due diligence + +Copyright � 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution. + + + + + + + + + supplyChainDueDiligenceReport + urn:samm:BatteryPass:1.0.0#supplyChainDueDiligenceReport + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + supplyChainDueDiligenceReport + + + + + en + supplyChainDueDiligenceReport + + + STRING + + + en + Information on responsible sourcing as indicated in the report on its due diligence policies referred to in Article 45e(3) (...) That report shall contain, in a manner that is easily comprehensible for end-users and clearly identifies the batteries concerned, the data and information on steps taken by that economic operator to comply with the requirements set out in Articles 45b and 45c, including findings of significant adverse impacts in the risk categories listed in Annex X, point 2, and how they have been addressed, as well as a summary report of the third-party verifications carried out in accordance with Article 45d, including the name of the notified body, with due regard for business confidentiality and other competitive concerns. It shall also elaborate, where relevant, on access to information, public participation in decision-making and access to justice in environmental matters in relation the sourcing, processing and trading of the raw materials. + + + + + + + + + thirdPartyAussurances + urn:samm:BatteryPass:1.0.0#thirdPartyAussurances + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + thirdPartyAussurances + + + + + en + thirdPartyAussurances + + + STRING + + + + + + + euTaxonomyDisclosureStatement + urn:samm:BatteryPass:1.0.0#euTaxonomyDisclosureStatement + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + euTaxonomyDisclosureStatement + + + + + en + euTaxonomyDisclosureStatement + + + STRING + + + + + + + sustainabilityReport + urn:samm:BatteryPass:1.0.0#sustainabilityReport + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + sustainabilityReport + + + + + en + sustainabilityReport + + + STRING + + + + + + + diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.DueDiligence/1.0.0/gen/SupplyChainDueDiligence-documentation.html b/SMARTENERGY/BatteriePass/io.BatteryPass.DueDiligence/1.0.0/gen/SupplyChainDueDiligence-documentation.html new file mode 100644 index 00000000..f6f38165 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.DueDiligence/1.0.0/gen/SupplyChainDueDiligence-documentation.html @@ -0,0 +1,508 @@ + + + + + + + + + + + + + + Documentation SupplyChainDueDiligence + + +
+
+
+
+

Aspect Model SupplyChainDueDiligence

+
urn:samm:BatteryPass:1.0.0#SupplyChainDueDiligence
+
+
+
+
+
+
+
+ +
+ + +
+ Data model for Battery due diligence + +Copyright © 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution. +
+ + +
+

Overview

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

Properties

+
+ +
+ +
+

euTaxonomyDisclosureStatement

+
+ + +
+
Name
+
euTaxonomyDisclosureStatement
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#anyURI + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
euTaxonomyDisclosureStatement
+
+ + +
+
+ +
+

supplyChainDueDiligenceReport

+
+ +Information on responsible sourcing as indicated in the report on its due diligence policies referred to in Article 45e(3) (...) That report shall contain, in a manner that is easily comprehensible for end-users and clearly identifies the batteries concerned, the data and information on steps taken by that economic operator to comply with the requirements set out in Articles 45b and 45c, including findings of significant adverse impacts in the risk categories listed in Annex X, point 2, and how they have been addressed, as well as a summary report of the third-party verifications carried out in accordance with Article 45d, including the name of the notified body, with due regard for business confidentiality and other competitive concerns. It shall also elaborate, where relevant, on access to information, public participation in decision-making and access to justice in environmental matters in relation the sourcing, processing and trading of the raw materials. + +
+
Name
+
supplyChainDueDiligenceReport
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#anyURI + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
supplyChainDueDiligenceReport
+
+ + +
+
+ +
+

sustainabilityReport

+
+ + +
+
Name
+
sustainabilityReport
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#anyURI + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
sustainabilityReport
+
+ + +
+
+ +
+

thirdPartyAussurances

+
+ + +
+
Name
+
thirdPartyAussurances
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#anyURI + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
thirdPartyAussurances
+
+ + +
+
+ + + + +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.DueDiligence/1.0.0/gen/SupplyChainDueDiligence-sample.json b/SMARTENERGY/BatteriePass/io.BatteryPass.DueDiligence/1.0.0/gen/SupplyChainDueDiligence-sample.json new file mode 100644 index 00000000..50737c51 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.DueDiligence/1.0.0/gen/SupplyChainDueDiligence-sample.json @@ -0,0 +1,6 @@ +{ + "supplyChainDueDiligenceReport": "telnet://192.0.2.16:80/", + "thirdPartyAussurances": "ftp://ftp.is.co.za/rfc/rfc1808.txt", + "sustainabilityReport": "http://www.wikipedia.org", + "euTaxonomyDisclosureStatement": "http://www.ietf.org/rfc/rfc2396.txt" +} \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.DueDiligence/1.0.0/gen/SupplyChainDueDiligence-schema.json b/SMARTENERGY/BatteriePass/io.BatteryPass.DueDiligence/1.0.0/gen/SupplyChainDueDiligence-schema.json new file mode 100644 index 00000000..a26ef025 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.DueDiligence/1.0.0/gen/SupplyChainDueDiligence-schema.json @@ -0,0 +1,41 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#SupplyChainDueDiligence", + "description": "Data model for Battery due diligence\n\nCopyright © 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution.", + "type": "object", + "components": { + "schemas": { + "ResourcePath": { + "type": "string", + "format": "uri", + "x-samm-aspect-model-urn": "urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#ResourcePath", + "description": "The path of a resource." + } + } + }, + "properties": { + "supplyChainDueDiligenceReport": { + "description": "Information on responsible sourcing as indicated in the report on its due diligence policies referred to in Article 45e(3) (...) That report shall contain, in a manner that is easily comprehensible for end-users and clearly identifies the batteries concerned, the data and information on steps taken by that economic operator to comply with the requirements set out in Articles 45b and 45c, including findings of significant adverse impacts in the risk categories listed in Annex X, point 2, and how they have been addressed, as well as a summary report of the third-party verifications carried out in accordance with Article 45d, including the name of the notified body, with due regard for business confidentiality and other competitive concerns. It shall also elaborate, where relevant, on access to information, public participation in decision-making and access to justice in environmental matters in relation the sourcing, processing and trading of the raw materials. ", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#supplyChainDueDiligenceReport", + "$ref": "#/components/schemas/ResourcePath" + }, + "thirdPartyAussurances": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#thirdPartyAussurances", + "$ref": "#/components/schemas/ResourcePath" + }, + "euTaxonomyDisclosureStatement": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#euTaxonomyDisclosureStatement", + "$ref": "#/components/schemas/ResourcePath" + }, + "sustainabilityReport": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#sustainabilityReport", + "$ref": "#/components/schemas/ResourcePath" + } + }, + "required": [ + "supplyChainDueDiligenceReport", + "thirdPartyAussurances", + "euTaxonomyDisclosureStatement", + "sustainabilityReport" + ] +} \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.GeneralProductInformation/1.0.0/GeneralProductInformation.ttl b/SMARTENERGY/BatteriePass/io.BatteryPass.GeneralProductInformation/1.0.0/GeneralProductInformation.ttl new file mode 100644 index 00000000..5181d81a --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.GeneralProductInformation/1.0.0/GeneralProductInformation.ttl @@ -0,0 +1,146 @@ +###################################################################### +# Copyright (c) 2024 Circulor GmbH on behalf of the Battery Pass Consortium +# +# 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 : . + +:GeneralProductInformation a samm:Aspect ; + samm:description "Mandatory data: Product identification; manufacturer?s identification; manufacturing place; manufacturing date; battery category; battery weight; battery status (Annex VI, Part A and Annex XIII)\nCopyright ? 2023 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution."@en ; + samm:properties ( :productIdentifier :productPassportIdentifier :batteryCategory :manufacturerIdentification :manufacturingDate :batteryStatus :batteryWeight :manufacturingPlace :economicOperator ) ; + samm:operations ( ) ; + samm:events ( ) . + +:productIdentifier a samm:Property ; + samm:preferredName "ProductIdentifier"@en ; + samm:description "Unique identifier allowing for the unambiguous identification of each individual battery and hence each corresponding battery passport (exploration of a potential additional battery passport identifier (not requried per Battery Regulation) ongoing)."@en ; + samm:characteristic :ProductIdentifierCode . + +:productPassportIdentifier a samm:Property ; + samm:preferredName "ProductPassportIdentifier"@en ; + samm:description "Unique identifier allowing for the unambiguous identification of each individual battery and hence each corresponding battery passport (exploration of a potential additional battery passport identifier (not requried per Battery Regulation) ongoing)."@en ; + samm:characteristic :ProductPassportIdentifierTrait ; + samm:exampleValue "urn:bmwk:123456687678" . + +:batteryCategory a samm:Property ; + samm:preferredName "BatteryCategory"@en ; + samm:description "Categories relevant for the battery passport: ?LMT battery?, ?electric vehicle battery? or ?industrial battery?."@en ; + samm:characteristic :BatteryCategoryEnum . + +:manufacturerIdentification a samm:Property ; + samm:preferredName "ManufacturerIdentification"@en ; + samm:description "Unambiguous identification of the manufacturer of the battery, suggested via a unique operator identifier (as \"unique string of characters for the identification of actors involved in the value chain of products\", ESPR Art. 2(32)). "@en ; + samm:characteristic :ManufacturerIdentificationCode . + +:manufacturingDate a samm:Property ; + samm:description "Manufacturing date (month and year), suggested in form of manufacturing date codes."@en ; + samm:characteristic :ManufacturingDateTimeStamp . + +:batteryStatus a samm:Property ; + samm:preferredName "BatteryStatus"@en ; + samm:description "Lifecycle status of the battery. Status defined from a list, with the options suggested as follows: 'original', 'repurposed', 'reused', 'remanufactured', 'waste'."@en ; + samm:characteristic :BatteryStatusEnumeration ; + samm:exampleValue "Original" . + +:batteryWeight a samm:Property ; + samm:description "Mass of the entire battery in kilograms. Voluntary: if the battery is defined on pack or module level: also weight of the modules and/or cells."@en ; + samm:characteristic :BatteryWeightMeasurement ; + samm:exampleValue "699"^^xsd:float . + +:manufacturingPlace a samm:Property ; + samm:preferredName "ManufacturingPlace"@en ; + samm:description "Unambiguous identification of the manufacturing facility (e.g. country, city, street, building (if needed)), suggested via a unique facility identifier (as \"unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product\", ESPR Art. 2(33))."@en ; + samm:see ; + samm:characteristic :ManufacturingPlaceEntity . + +:economicOperator a samm:Property ; + samm:preferredName "economicOperator"@en ; + samm:description "State the name, trade name or mark, postal address, web ad-dress, e-mail address. Suggested reporting via a unique operator identifier (see requirements of unique battery identifier)."@en ; + samm:characteristic :EconomicOperatorCode . + +:ProductIdentifierCode a samm-c:Code ; + samm:preferredName "ProductIdentifierCode"@en ; + samm:description "A unique identifier is defined as \"a unique string of characters for the identification of batteries that also enables a web link to the battery passport\" (Art. 3(66)), to be attributed by the economic operator placing the battery on the market (Art. 77(3)). The unique identifier shall comply with the standard (?ISO/IEC?) 15459:2015 or equivalent (Art. 77(3)). A QR code shall provide access to the battery passport and be linked to the unique identifier (Art. 77(3)). Batteries shall ?bear a model identification and batch or serial number, or product number or another element allowing their identification? (Art. 38(6)). \n\nBattery Regulation Reference: Art. 77(3); Art. 3(66); Art. 38(6)"@en ; + samm:dataType xsd:string . + +:ProductPassportIdentifierTrait a samm-c:Trait ; + samm-c:baseCharacteristic :ProductPassportIdentifierCode ; + samm-c:constraint :CodeConstraint . + +:BatteryCategoryEnum a samm-c:Enumeration ; + samm:dataType xsd:string ; + samm-c:values ( "lmt" "ev" "industrial" "stationary" ) . + +:ManufacturerIdentificationCode a samm-c:Code ; + samm:preferredName "ManufacturerIdentificationCode"@en ; + samm:description "Manufacturer's identification by stating the name; registered trade name or registered trademark; the postal address, indicating a single contact point; a web address, where one exists; an e-mail address, where one exists (Art. 38(7)). Manufacturer as ?any natural or legal person who manufactures a battery or has a battery designed or manufactured, and markets that battery under its own name or trademark or puts it into service for its own purposes? (Art. 3(33)). \n\nRegulation reference: Annex XIII (1a) ? Annex VI Part A (1); Art. 3(33); Art. 38(7); ESPR Art. 2(32)"@en ; + samm:dataType xsd:string . + +:ManufacturingDateTimeStamp a samm:Characteristic ; + samm:preferredName "ManufacturingDate"@en ; + samm:description "Manufacturing date (month and year)\nRegulation Reference: Annex XIII (1a) ? Annex VI Part A (4); Annex VII Part B (1)"@en ; + samm:dataType xsd:dateTimeStamp . + +:BatteryStatusEnumeration a samm-c:Enumeration ; + samm:description "Lifecycle status of the battery. Status defined from a list, with the options suggested as follows: 'original', 'repurposed', 'reused', 'remanufactured', 'waste'\n\nEUBR: Annex XIII (4c)"@en ; + samm:dataType xsd:string ; + samm-c:values ( "Original" "Repurposed" "Reused" "Remanufactured" "Waste" ) . + +:BatteryWeightMeasurement a samm-c:Measurement ; + samm:description "Weight of the battery\nEUBR: Annex XIII (1a) ? Annex VI Part A (5)"@en ; + samm:dataType xsd:float ; + samm-c:unit unit:kilogram . + +:ManufacturingPlaceEntity a samm-c:SingleEntity ; + samm:see ; + samm:dataType :PostalAddress . + +:EconomicOperatorCode a samm-c:Code ; + samm:preferredName "EconomicOperatorCode"@en ; + samm:description "Not demanded by the EU Battery Regulation"@en ; + samm:dataType xsd:string . + +:ProductPassportIdentifierCode a samm-c:Code ; + samm:preferredName "ProductPassportIdentifierCode"@en ; + samm:description "A unique identifier is defined as \"a unique string of characters for the identification of batteries that also enables a web link to the battery passport\" (Art. 3(66)), to be attributed by the economic operator placing the battery on the market (Art. 77(3)). The unique identifier shall comply with the standard (?ISO/IEC?) 15459:2015 or equivalent (Art. 77(3)). A QR code shall provide access to the battery passport and be linked to the unique identifier (Art. 77(3)). Batteries shall ?bear a model identification and batch or serial number, or product number or another element allowing their identification? (Art. 38(6)). \n\nBattery Regulation Reference: Art. 77(3); Art. 3(66); Art. 38(6)"@en ; + samm:dataType xsd:string . + +:CodeConstraint a samm-c:RegularExpressionConstraint ; + samm:description "Code constraint for URN"@en ; + samm:value "^urn:[a-z0-9]+:[a-z0-9]+$" . + +:PostalAddress a samm:Entity ; + samm:see ; + samm:properties ( :addressCountry :postalCode :streetAddress ) . + +:addressCountry a samm:Property ; + samm:see ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Germany" . + +:postalCode a samm:Property ; + samm:see ; + samm:characteristic samm-c:Text ; + samm:exampleValue "30890" . + +:streetAddress a samm:Property ; + samm:see ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Hindenburgstr. 10" . + diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.GeneralProductInformation/1.0.0/gen/GeneralProductInformation-documentation.html b/SMARTENERGY/BatteriePass/io.BatteryPass.GeneralProductInformation/1.0.0/gen/GeneralProductInformation-documentation.html new file mode 100644 index 00000000..6b5fa594 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.GeneralProductInformation/1.0.0/gen/GeneralProductInformation-documentation.html @@ -0,0 +1,909 @@ + + + + + + + + + + + + + + Documentation GeneralProductInformation + + +
+
+
+
+

Aspect Model GeneralProductInformation

+
urn:samm:io.BatteryPass.GeneralProductInformation:1.0.0#GeneralProductInformation
+
+
+
+
+
+
+
+ +
+ + +
+ Mandatory data: Product identification; manufacturer?s identification; manufacturing place; manufacturing date; battery category; battery weight; battery status (Annex VI, Part A and Annex XIII) +Copyright ? 2023 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution. +
+ + +
+

Overview

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

Properties

+
+ +
+ +
+

BatteryCategory

+
+ +Categories relevant for the battery passport: ?LMT battery?, ?electric vehicle battery? or ?industrial battery?. + +
+
Name
+
batteryCategory
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
batteryCategory
+
+ + +
+
+ +
+

BatteryStatus

+
+ +Lifecycle status of the battery. Status defined from a list, with the options suggested as follows: 'original', 'repurposed', 'reused', 'remanufactured', 'waste'. + +
+
Name
+
batteryStatus
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
$property.getExampleValue().get().getValue()
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
batteryStatus
+
+ + +
+
+ +
+

ManufacturerIdentification

+
+ +Unambiguous identification of the manufacturer of the battery, suggested via a unique operator identifier (as "unique string of characters for the identification of actors involved in the value chain of products", ESPR Art. 2(32)). + +
+
Name
+
manufacturerIdentification
+
+ + + +
+
Characteristic
+
+
+
+
Code
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturerIdentification
+
+ + +
+
+ +
+

ManufacturingPlace

+
+ +Unambiguous identification of the manufacturing facility (e.g. country, city, street, building (if needed)), suggested via a unique facility identifier (as "unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product", ESPR Art. 2(33)). + +
+
Name
+
manufacturingPlace
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Reference +
+
    +
  • https://schema.org/PostalAddress
    • +
+
+
+
+
+
+ Type urn:samm:io.BatteryPass.GeneralProductInformation:1.0.0#PostalAddress + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturingPlace
+
+ +
+
Reference
+
+
    +
  • https://schema.org/PostalAddress
    • +
+
+
+ +
+
+ +
+

ProductIdentifier

+
+ +Unique identifier allowing for the unambiguous identification of each individual battery and hence each corresponding battery passport (exploration of a potential additional battery passport identifier (not requried per Battery Regulation) ongoing). + +
+
Name
+
productIdentifier
+
+ + + +
+
Characteristic
+
+
+
+
Code
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productIdentifier
+
+ + +
+
+ +
+

ProductPassportIdentifier

+
+ +Unique identifier allowing for the unambiguous identification of each individual battery and hence each corresponding battery passport (exploration of a potential additional battery passport identifier (not requried per Battery Regulation) ongoing). + +
+
Name
+
productPassportIdentifier
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
$property.getExampleValue().get().getValue()
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productPassportIdentifier
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + CodeConstraint +
    + +
    +
    Description
    +
    Code constraint for URN
    +
    + + +
    +
    Regular expression
    +
    $regularExpressionConstraint.getValue()
    +
    + +
    • +
+
+
+
+
+ +
+

batteryWeight

+
+ +Mass of the entire battery in kilograms. Voluntary: if the battery is defined on pack or module level: also weight of the modules and/or cells. + +
+
Name
+
batteryWeight
+
+ + + +
+
Characteristic
+
+
+
+
Measurement
+
+
+
Weight of the battery +EUBR: Annex XIII (1a) ? Annex VI Part A (5)
+
+
+
Unit
+
+
+
+
    +
  • + kilogram +
    • +
  • + Symbol kg +
    • +
  • + Code KGM +
    • +
  • + Conversion factor kg +
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float + +
+
+
+
+
+ +
+
Example
+
$property.getExampleValue().get().getValue()
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
batteryWeight
+
+ + +
+
+ +
+

economicOperator

+
+ +State the name, trade name or mark, postal address, web ad-dress, e-mail address. Suggested reporting via a unique operator identifier (see requirements of unique battery identifier). + +
+
Name
+
economicOperator
+
+ + + +
+
Characteristic
+
+
+
+
Code
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
economicOperator
+
+ + +
+
+ +
+

manufacturingDate

+
+ +Manufacturing date (month and year), suggested in form of manufacturing date codes. + +
+
Name
+
manufacturingDate
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTimeStamp + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
manufacturingDate
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

PostalAddress

+
+
+ +
+
+ Reference +
+
    +
  • https://schema.org/PostalAddress
    • +
+
+
+ +
+

Properties

+
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.GeneralProductInformation/1.0.0/gen/GeneralProductInformation-sample.json b/SMARTENERGY/BatteriePass/io.BatteryPass.GeneralProductInformation/1.0.0/gen/GeneralProductInformation-sample.json new file mode 100644 index 00000000..501dfad0 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.GeneralProductInformation/1.0.0/gen/GeneralProductInformation-sample.json @@ -0,0 +1,15 @@ +{ + "batteryCategory": "lmt", + "productIdentifier": "eOMtThyhVNLWUZNRcBaQKxI", + "productPassportIdentifier": "urn:bmwk:123456687678", + "manufacturerIdentification": "yedUsFwdkelQbxeTeQOvaScfqIOOmaa", + "batteryStatus": "Original", + "economicOperator": "JxkyvRnL", + "manufacturingDate": "2024-05-28T11:05:22.232+02:00", + "batteryWeight": 699, + "manufacturingPlace": { + "addressCountry": "Germany", + "streetAddress": "Hindenburgstr. 10", + "postalCode": "30890" + } +} \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.GeneralProductInformation/1.0.0/gen/GeneralProductInformation-schema.json b/SMARTENERGY/BatteriePass/io.BatteryPass.GeneralProductInformation/1.0.0/gen/GeneralProductInformation-schema.json new file mode 100644 index 00000000..ec6809c7 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.GeneralProductInformation/1.0.0/gen/GeneralProductInformation-schema.json @@ -0,0 +1,159 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#GeneralProductInformation", + "description": "Mandatory data: Product identification; manufacturer?s identification; manufacturing place; manufac\u0002turing date; battery category; battery weight; battery status (Annex VI, Part A and Annex XIII)\nCopyright © 2023 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution.", + "type": "object", + "components": { + "schemas": { + "ProductIdentifierCode": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#ProductIdentifierCode", + "description": "A unique identifier is defined as \"a unique string of characters for the identification of batteries that also enables a web link to the battery passport\" (Art. 3(66)), to be attributed by the economic operator placing the battery on the market (Art. 77(3)). The unique identifier shall comply with the standard (?ISO/IEC?) 15459:2015 or equivalent (Art. 77(3)). A QR code shall provide access to the battery passport and be linked to the unique identifier (Art. 77(3)). Batteries shall ?bear a model identification and batch or serial number, or product number or another element allowing their identification? (Art. 38(6)). \n\nBattery Regulation Reference: Art. 77(3); Art. 3(66); Art. 38(6)" + }, + "ProductPassportIdentifierTrait": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#ProductPassportIdentifierTrait", + "description": "Code constraint for URN", + "pattern": "^urn:[a-z0-9]+:[a-z0-9]+$" + }, + "BatteryCategoryEnum": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#BatteryCategoryEnum", + "enum": [ + "lmt", + "ev", + "industrial", + "stationary" + ] + }, + "ManufacturerIdentificationCode": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#ManufacturerIdentificationCode", + "description": "Manufacturer's identification by stating the name; registered trade name or registered trademark; the postal address, indicating a single contact point; a web address, where one exists; an e-mail address, where one exists (Art. 38(7)). Manufacturer as ?any natural or legal person who manufactures a battery or has a battery designed or manufactured, and markets that battery under its own name or trademark or puts it into service for its own purposes? (Art. 3(33)). \n\nRegulation reference: Annex XIII (1a) ? Annex VI Part A (1); Art. 3(33); Art. 38(7); ESPR Art. 2(32)" + }, + "ManufacturingDateTimeStamp": { + "type": "string", + "format": "date-time", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#ManufacturingDateTimeStamp", + "description": "Manufacturing date (month and year)\nRegulation Reference: Annex XIII (1a) ? Annex VI Part A (4); Annex VII Part B (1)" + }, + "BatteryStatusEnumeration": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#BatteryStatusEnumeration", + "description": "Lifecycle status of the battery. Status defined from a list, with the options suggested as follows: 'original', 'repurposed', 'reused', 'remanufactured', 'waste'\n\nEUBR: Annex XIII (4c)", + "enum": [ + "Original", + "Repurposed", + "Reused", + "Remanufactured", + "Waste" + ] + }, + "BatteryWeightMeasurement": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#BatteryWeightMeasurement", + "description": "Weight of the battery\nEUBR: Annex XIII (1a) ? Annex VI Part A (5)" + }, + "Text": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text", + "description": "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." + }, + "PostalAddress": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#PostalAddress", + "type": "object", + "properties": { + "addressCountry": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#addressCountry", + "$ref": "#/components/schemas/Text" + }, + "postalCode": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#postalCode", + "$ref": "#/components/schemas/Text" + }, + "streetAddress": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#streetAddress", + "$ref": "#/components/schemas/Text" + } + }, + "required": [ + "addressCountry", + "postalCode", + "streetAddress" + ] + }, + "ManufacturingPlaceEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#ManufacturingPlaceEntity", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/PostalAddress" + } + ] + }, + "EconomicOperatorCode": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#EconomicOperatorCode", + "description": "Not demanded by the EU Battery Regulation" + } + } + }, + "properties": { + "productIdentifier": { + "description": "Unique identifier allowing for the unambiguous identification of each individual battery and hence each corresponding battery passport (exploration of a potential additional battery passport identifier (not requried per Battery Regulation) ongoing).", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#productIdentifier", + "$ref": "#/components/schemas/ProductIdentifierCode" + }, + "productPassportIdentifier": { + "description": "Unique identifier allowing for the unambiguous identification of each individual battery and hence each corresponding battery passport (exploration of a potential additional battery passport identifier (not requried per Battery Regulation) ongoing).", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#productPassportIdentifier", + "$ref": "#/components/schemas/ProductPassportIdentifierTrait" + }, + "batteryCategory": { + "description": "Categories relevant for the battery passport: ?LMT battery?, ?electric vehicle battery? or ?industrial battery?.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#batteryCategory", + "$ref": "#/components/schemas/BatteryCategoryEnum" + }, + "manufacturerIdentification": { + "description": "Unambiguous identification of the manufacturer of the battery, suggested via a unique operator identifier (as \"unique string of characters for the identification of actors involved in the value chain of products\", ESPR Art. 2(32)). ", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#manufacturerIdentification", + "$ref": "#/components/schemas/ManufacturerIdentificationCode" + }, + "manufacturingDate": { + "description": "Manufacturing date (month and year), suggested in form of manufacturing date codes.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#manufacturingDate", + "$ref": "#/components/schemas/ManufacturingDateTimeStamp" + }, + "batteryStatus": { + "description": "Lifecycle status of the battery. Status defined from a list, with the options suggested as follows: 'original', 'repurposed', 'reused', 'remanufactured', 'waste'.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#batteryStatus", + "$ref": "#/components/schemas/BatteryStatusEnumeration" + }, + "batteryWeight": { + "description": "Mass of the entire battery in kilograms. Voluntary: if the battery is defined on pack or module level: also weight of the modules and/or cells.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#batteryWeight", + "$ref": "#/components/schemas/BatteryWeightMeasurement" + }, + "manufacturingPlace": { + "description": "Unambiguous identification of the manufacturing facility (e.g. country, city, street, building (if needed)), suggested via a unique facility identifier (as \"unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product\", ESPR Art. 2(33)).", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#manufacturingPlace", + "$ref": "#/components/schemas/ManufacturingPlaceEntity" + }, + "economicOperator": { + "description": "State the name, trade name or mark, postal address, web ad-dress, e-mail address. Suggested reporting via a unique operator identifier (see requirements of unique battery identifier).", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#economicOperator", + "$ref": "#/components/schemas/EconomicOperatorCode" + } + }, + "required": [ + "productIdentifier", + "productPassportIdentifier", + "batteryCategory", + "manufacturerIdentification", + "manufacturingDate", + "batteryStatus", + "batteryWeight", + "manufacturingPlace", + "economicOperator" + ] +} \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.GeneralProductInformation/1.0.0/gen/GeneralProductInformation_en-async-api.json b/SMARTENERGY/BatteriePass/io.BatteryPass.GeneralProductInformation/1.0.0/gen/GeneralProductInformation_en-async-api.json new file mode 100644 index 00000000..046ba88f --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.GeneralProductInformation/1.0.0/gen/GeneralProductInformation_en-async-api.json @@ -0,0 +1,28 @@ +{ + "asyncapi": "3.0.0", + "id": "", + "info": { + "title": "GeneralProductInformation MQTT API", + "version": "v1.0.0", + "description": "Mandatory data: Product identification; manufacturer?s identification; manufacturing place; manufac\u0002turing date; battery category; battery weight; battery status (Annex VI, Part A and Annex XIII)\nCopyright © 2023 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#GeneralProductInformation" + }, + "defaultContentType": "application/json", + "channels": { + "GeneralProductInformation": { + "address": "/BatteryPass/1.0.0/GeneralProductInformation", + "description": "This channel for updating GeneralProductInformation Aspect.", + "parameters": { + "namespace": "BatteryPass", + "version": "1.0.0", + "aspect-name": "GeneralProductInformation" + }, + "messages": {} + } + }, + "operations": {}, + "components": { + "messages": {}, + "schemas": {} + } +} \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.GeneralProductInformation/1.0.0/gen/GeneralProductInformation_en-open-api.json b/SMARTENERGY/BatteriePass/io.BatteryPass.GeneralProductInformation/1.0.0/gen/GeneralProductInformation_en-open-api.json new file mode 100644 index 00000000..c7c61bb5 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.GeneralProductInformation/1.0.0/gen/GeneralProductInformation_en-open-api.json @@ -0,0 +1,348 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "GeneralProductInformation", + "version": "v1.0.0", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#GeneralProductInformation" + }, + "servers": [ + { + "url": "https://example.com/api/v1.0.0", + "variables": { + "api-version": { + "default": "v1.0.0" + } + } + } + ], + "paths": { + "/null": { + "get": { + "tags": [ + "GeneralProductInformation" + ], + "operationId": "getGeneralProductInformation", + "parameters": [], + "responses": { + "200": { + "$ref": "#/components/responses/GeneralProductInformation" + }, + "401": { + "$ref": "#/components/responses/ClientError" + }, + "402": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFoundError" + } + } + }, + "post": { + "servers": [ + { + "url": "https://example.com/query-api/v1.0.0", + "variables": { + "api-version": { + "default": "v1.0.0" + } + } + } + ], + "tags": [ + "GeneralProductInformation" + ], + "operationId": "postGeneralProductInformation", + "parameters": [], + "requestBody": { + "$ref": "#/components/requestBodies/Filter" + }, + "responses": { + "200": { + "$ref": "#/components/responses/GeneralProductInformation" + }, + "401": { + "$ref": "#/components/responses/ClientError" + }, + "402": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFoundError" + } + } + } + } + }, + "components": { + "schemas": { + "ErrorResponse": { + "type": "object", + "required": [ + "error" + ], + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + } + }, + "Error": { + "type": "object", + "required": [ + "details" + ], + "properties": { + "message": { + "type": "string", + "minLength": 1 + }, + "path": { + "type": "string", + "minLength": 1 + }, + "details": { + "type": "object", + "minLength": 1, + "additionalProperties": { + "type": "object" + } + }, + "code": { + "type": "string", + "nullable": true + } + } + }, + "Filter": { + "type": "object", + "required": [ + "filter" + ], + "properties": { + "filter": { + "type": "string", + "description": "The filter to use.", + "example": "filter={filter expression}" + }, + "option": { + "type": "string", + "description": "The option for the filter.", + "example": "option=limit({start},{count})" + } + } + }, + "ProductIdentifierCode": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#ProductIdentifierCode", + "description": "A unique identifier is defined as \"a unique string of characters for the identification of batteries that also enables a web link to the battery passport\" (Art. 3(66)), to be attributed by the economic operator placing the battery on the market (Art. 77(3)). The unique identifier shall comply with the standard (?ISO/IEC?) 15459:2015 or equivalent (Art. 77(3)). A QR code shall provide access to the battery passport and be linked to the unique identifier (Art. 77(3)). Batteries shall ?bear a model identification and batch or serial number, or product number or another element allowing their identification? (Art. 38(6)). \n\nBattery Regulation Reference: Art. 77(3); Art. 3(66); Art. 38(6)" + }, + "ProductPassportIdentifierTrait": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#ProductPassportIdentifierTrait", + "description": "Code constraint for URN", + "pattern": "^urn:[a-z0-9]+:[a-z0-9]+$" + }, + "BatteryCategoryEnum": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#BatteryCategoryEnum", + "enum": [ + "lmt", + "ev", + "industrial", + "stationary" + ] + }, + "ManufacturerIdentificationCode": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#ManufacturerIdentificationCode", + "description": "Manufacturer's identification by stating the name; registered trade name or registered trademark; the postal address, indicating a single contact point; a web address, where one exists; an e-mail address, where one exists (Art. 38(7)). Manufacturer as ?any natural or legal person who manufactures a battery or has a battery designed or manufactured, and markets that battery under its own name or trademark or puts it into service for its own purposes? (Art. 3(33)). \n\nRegulation reference: Annex XIII (1a) ? Annex VI Part A (1); Art. 3(33); Art. 38(7); ESPR Art. 2(32)" + }, + "ManufacturingDateTimeStamp": { + "type": "string", + "format": "date-time", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#ManufacturingDateTimeStamp", + "description": "Manufacturing date (month and year)\nRegulation Reference: Annex XIII (1a) ? Annex VI Part A (4); Annex VII Part B (1)" + }, + "BatteryStatusEnumeration": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#BatteryStatusEnumeration", + "description": "Lifecycle status of the battery. Status defined from a list, with the options suggested as follows: 'original', 'repurposed', 'reused', 'remanufactured', 'waste'\n\nEUBR: Annex XIII (4c)", + "enum": [ + "Original", + "Repurposed", + "Reused", + "Remanufactured", + "Waste" + ] + }, + "BatteryWeightMeasurement": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#BatteryWeightMeasurement", + "description": "Weight of the battery\nEUBR: Annex XIII (1a) ? Annex VI Part A (5)" + }, + "Text": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text", + "description": "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." + }, + "PostalAddress": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#PostalAddress", + "type": "object", + "properties": { + "addressCountry": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#addressCountry", + "$ref": "#/components/schemas/Text" + }, + "postalCode": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#postalCode", + "$ref": "#/components/schemas/Text" + }, + "streetAddress": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#streetAddress", + "$ref": "#/components/schemas/Text" + } + }, + "required": [ + "addressCountry", + "postalCode", + "streetAddress" + ] + }, + "ManufacturingPlaceEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#ManufacturingPlaceEntity", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/PostalAddress" + } + ] + }, + "EconomicOperatorCode": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#EconomicOperatorCode", + "description": "Not demanded by the EU Battery Regulation" + }, + "GeneralProductInformation": { + "description": "Mandatory data: Product identification; manufacturer?s identification; manufacturing place; manufac\u0002turing date; battery category; battery weight; battery status (Annex VI, Part A and Annex XIII)\nCopyright © 2023 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution.", + "type": "object", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#GeneralProductInformation", + "properties": { + "productIdentifier": { + "description": "Unique identifier allowing for the unambiguous identification of each individual battery and hence each corresponding battery passport (exploration of a potential additional battery passport identifier (not requried per Battery Regulation) ongoing).", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#productIdentifier", + "$ref": "#/components/schemas/ProductIdentifierCode" + }, + "productPassportIdentifier": { + "description": "Unique identifier allowing for the unambiguous identification of each individual battery and hence each corresponding battery passport (exploration of a potential additional battery passport identifier (not requried per Battery Regulation) ongoing).", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#productPassportIdentifier", + "$ref": "#/components/schemas/ProductPassportIdentifierTrait" + }, + "batteryCategory": { + "description": "Categories relevant for the battery passport: ?LMT battery?, ?electric vehicle battery? or ?industrial battery?.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#batteryCategory", + "$ref": "#/components/schemas/BatteryCategoryEnum" + }, + "manufacturerIdentification": { + "description": "Unambiguous identification of the manufacturer of the battery, suggested via a unique operator identifier (as \"unique string of characters for the identification of actors involved in the value chain of products\", ESPR Art. 2(32)). ", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#manufacturerIdentification", + "$ref": "#/components/schemas/ManufacturerIdentificationCode" + }, + "manufacturingDate": { + "description": "Manufacturing date (month and year), suggested in form of manufacturing date codes.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#manufacturingDate", + "$ref": "#/components/schemas/ManufacturingDateTimeStamp" + }, + "batteryStatus": { + "description": "Lifecycle status of the battery. Status defined from a list, with the options suggested as follows: 'original', 'repurposed', 'reused', 'remanufactured', 'waste'.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#batteryStatus", + "$ref": "#/components/schemas/BatteryStatusEnumeration" + }, + "batteryWeight": { + "description": "Mass of the entire battery in kilograms. Voluntary: if the battery is defined on pack or module level: also weight of the modules and/or cells.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#batteryWeight", + "$ref": "#/components/schemas/BatteryWeightMeasurement" + }, + "manufacturingPlace": { + "description": "Unambiguous identification of the manufacturing facility (e.g. country, city, street, building (if needed)), suggested via a unique facility identifier (as \"unique string of characters for the identification of locations or buildings involved in the value chain of a product or used by actors involved in the value chain of a product\", ESPR Art. 2(33)).", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#manufacturingPlace", + "$ref": "#/components/schemas/ManufacturingPlaceEntity" + }, + "economicOperator": { + "description": "State the name, trade name or mark, postal address, web ad-dress, e-mail address. Suggested reporting via a unique operator identifier (see requirements of unique battery identifier).", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#economicOperator", + "$ref": "#/components/schemas/EconomicOperatorCode" + } + }, + "required": [ + "productIdentifier", + "productPassportIdentifier", + "batteryCategory", + "manufacturerIdentification", + "manufacturingDate", + "batteryStatus", + "batteryWeight", + "manufacturingPlace", + "economicOperator" + ] + } + }, + "responses": { + "Unauthorized": { + "description": "The requesting user or client is not authenticated." + }, + "Forbidden": { + "description": "The requesting user or client is not authorized to access resources for the given tenant." + }, + "NotFoundError": { + "description": "The requested Twin has not been found." + }, + "ClientError": { + "description": "Payload or user input is invalid. See error details in the payload for more.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "GeneralProductInformation": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GeneralProductInformation" + } + } + }, + "description": "The request was successful." + } + }, + "requestBodies": { + "GeneralProductInformation": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GeneralProductInformation" + } + } + } + }, + "Filter": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Filter" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.Labels/1.0.0/Labels.ttl b/SMARTENERGY/BatteriePass/io.BatteryPass.Labels/1.0.0/Labels.ttl new file mode 100644 index 00000000..3d6ebe21 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.Labels/1.0.0/Labels.ttl @@ -0,0 +1,86 @@ +###################################################################### +# Copyright (c) 2024 Circulor GmbH on behalf of the Battery Pass Consortium +# +# 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-digitaltwin: . + +:Labels a samm:Aspect ; + samm:description "Data model for battery labels and conformity\n\nCopyright 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution."@en ; + samm:properties ( :declarationOfConformity :resultOfTestReport :euDeclarationOfConformityId :separateCollection :materialSymbols ) ; + samm:operations ( ) ; + samm:events ( ) . + +:declarationOfConformity a samm:Property ; + samm:description "URL to EU declaration of conformity signed by responsible economic operators to declare compliance with the regulatory requirements in the context of the market conformity assessment procedure and assume full responsibility."@en ; + samm:characteristic samm-c:ResourcePath . + +:resultOfTestReport a samm:Property ; + samm:description "URL to a document that includes results of tests reports proving compliance in the market conformity assessment procedure with the requirements as per the technical documentation (Art. 7-10, Art. 12-14 and due diligence policies )."@en ; + samm:characteristic ext-digitaltwin:ResourcePath . + +:euDeclarationOfConformityId a samm:Property ; + samm:description "Identification number of the EU declaration of conformity of the battery, linked to the Battery Carbon Footprint Declaration."@en ; + samm:characteristic :EuDeclarationOfConformityId . + +:separateCollection a samm:Property ; + samm:description "'Separate collection' or 'WEEE label' indicating that a product should not be discarded as unsorted waste but must be sent to separate collection facilities for recovery and recycling. To be printed on the physical label and displayed via the battery passport, suggested to be translated also to text to ensure machine readability."@en ; + samm:characteristic :SeperateCollection . + +:materialSymbols a samm:Property ; + samm:characteristic :MaterialSymbols . + +ext-digitaltwin:ResourcePath a samm:Characteristic ; + samm:preferredName "Resource Path"@en ; + samm:description "The path of a resource."@en ; + samm:dataType xsd:anyURI . + +:EuDeclarationOfConformityId a samm-c:Code ; + samm:dataType xsd:string . + +:SeperateCollection a samm-c:SingleEntity ; + samm:dataType :SeparateCollection . + +:MaterialSymbols a samm-c:Set ; + samm:description "Cadmium and lead symbols indicating the metal is contained in the battery above a defined threshold. To be printed on the physical label and displayed via the battery passport, suggested to be translated also to text to ensure machine readability."@en ; + samm:dataType :MaterialSymbol . + +:SeparateCollection a samm:Entity ; + samm:description "Explanation of the meaning of all symbols and labels (including separate collection; cadmium and lead; and carbon footprint and carbon footprint performance class symbols; and symbols and labels printed on batteries or their accompanying documents but not accessible via the battery passport)."@en ; + samm:properties ( :separateCollectionSymbol :separateCollectionDescription ) . + +:MaterialSymbol a samm:Entity ; + samm:properties ( :materialSymbol :materialText ) . + +:separateCollectionSymbol a samm:Property ; + samm:characteristic samm-c:ResourcePath . + +:separateCollectionDescription a samm:Property ; + samm:description "Explanation of the meaning of all symbols and labels (including separate collection; cadmium and lead; and carbon footprint and carbon footprint performance class symbols; and symbols and labels printed on batteries or their accompanying documents but not accessible via the battery passport)."@en ; + samm:characteristic samm-c:MultiLanguageText . + +:materialSymbol a samm:Property ; + samm:description "Battery containing more than 0.002% cadmium or 0.004% lead to be marked with the symbol(s) for the metal concerned: Cd or Pb (Art. 13(4))."@en ; + samm:characteristic samm-c:ResourcePath . + +:materialText a samm:Property ; + samm:description "Clear text information Battery containing more than 0.002% cadmium or 0.004% lead to be marked with the symbol(s) for the metal concerned: Cd or Pb (Art. 13(4))."@en ; + samm:characteristic samm-c:MultiLanguageText . + diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.Labels/1.0.0/gen/Labels-aas.xml b/SMARTENERGY/BatteriePass/io.BatteryPass.Labels/1.0.0/gen/Labels-aas.xml new file mode 100644 index 00000000..a38e0b98 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.Labels/1.0.0/gen/Labels-aas.xml @@ -0,0 +1,586 @@ + + + + + defaultAdminShell + + + en + defaultAdminShell + + + + urn:samm:BatteryPass:1.0.0#Labels + + Type + + + + ModelReference + + + Submodel + urn:samm:BatteryPass:1.0.0#Labels/submodel + + + + + + + + + Labels + + + en + Data model for battery labels and conformity + +Copyright � 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution. + + + + urn:samm:BatteryPass:1.0.0#Labels/submodel + Template + + ModelReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#Labels + + + + + + declarationOfConformity + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#declarationOfConformity + + + + xs:anyURI + + + + resultOfTestReport + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#resultOfTestReport + + + + xs:anyURI + + + + euDeclarationOfConformityId + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#euDeclarationOfConformityId + + + + xs:string + + + + SeparateCollection + + + en + Explanation of the meaning of all symbols and labels (including separate collection; cadmium and lead; and carbon footprint and carbon footprint performance class symbols; and symbols and labels printed on batteries or their accompanying documents but not accessible via the battery passport). + + + + + separateCollectionSymbol + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#separateCollectionSymbol + + + + xs:anyURI + + + + separateCollectionDescription + + + en + Explanation of the meaning of all symbols and labels (including separate collection; cadmium and lead; and carbon footprint and carbon footprint performance class symbols; and symbols and labels printed on batteries or their accompanying documents but not accessible via the battery passport). + + + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#separateCollectionDescription + + + + + + + + materialSymbols + true + SubmodelElement + + + MaterialSymbol + + + materialSymbol + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#materialSymbol + + + + xs:anyURI + + + + materialText + + + en + Clear text information Battery containing more than 0.002% cadmium or 0.004% lead to be marked with the symbol(s) for the metal concerned: Cd or Pb (Art. 13(4)). + + + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#materialText + + + + + + + + + + + + + + APPLICATION_CLASS + Labels + + + en + Data model for battery labels and conformity + +Copyright � 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution. + + + urn:samm:BatteryPass:1.0.0#Labels + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Labels + + + + + en + Labels + + + + + en + Data model for battery labels and conformity + +Copyright � 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution. + + + + + + + + + declarationOfConformity + urn:samm:BatteryPass:1.0.0#declarationOfConformity + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + declarationOfConformity + + + + + en + declarationOfConformity + + + STRING + + + en + URL to EU declaration of conformity signed by responsible economic operators to declare compliance with the regulatory requirements in the context of the market conformity assessment procedure and assume full responsibility. + + + + + + + + + resultOfTestReport + urn:samm:BatteryPass:1.0.0#resultOfTestReport + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + resultOfTestReport + + + + + en + resultOfTestReport + + + STRING + + + en + URL to a document that includes results of tests reports proving compliance in the market conformity assessment procedure with the requirements as per the technical documentation (Art. 7-10, Art. 12-14 and due diligence policies ). + + + + + + + + + euDeclarationOfConformityId + urn:samm:BatteryPass:1.0.0#euDeclarationOfConformityId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + euDeclarationOfConformityId + + + + + en + euDeclarationOfConformityId + + + STRING + + + en + Identification number of the EU declaration of conformity of the battery, linked to the Battery Carbon Footprint Declaration. + + + + + + + + + separateCollectionSymbol + urn:samm:BatteryPass:1.0.0#separateCollectionSymbol + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + separateCollectionSymbol + + + + + en + separateCollectionSymbol + + + STRING + + + + + + + separateCollectionDescription + urn:samm:BatteryPass:1.0.0#separateCollectionDescription + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + separateCollectionDescription + + + + + en + separateCollectionDescription + + + STRING + + + en + Explanation of the meaning of all symbols and labels (including separate collection; cadmium and lead; and carbon footprint and carbon footprint performance class symbols; and symbols and labels printed on batteries or their accompanying documents but not accessible via the battery passport). + + + + + + + + + separateCollection + urn:samm:BatteryPass:1.0.0#separateCollection + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + separateCollection + + + + + en + separateCollection + + + STRING + + + en + 'Separate collection' or 'WEEE label' indicating that a product should not be discarded as unsorted waste but must be sent to separate collection facilities for recovery and recycling. To be printed on the physical label and displayed via the battery passport, suggested to be translated also to text to ensure machine readability. + + + + + + + + + materialSymbol + urn:samm:BatteryPass:1.0.0#materialSymbol + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + materialSymbol + + + + + en + materialSymbol + + + STRING + + + en + Battery containing more than 0.002% cadmium or 0.004% lead to be marked with the symbol(s) for the metal concerned: Cd or Pb (Art. 13(4)). + + + + + + + + + materialText + urn:samm:BatteryPass:1.0.0#materialText + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + materialText + + + + + en + materialText + + + STRING + + + en + Clear text information Battery containing more than 0.002% cadmium or 0.004% lead to be marked with the symbol(s) for the metal concerned: Cd or Pb (Art. 13(4)). + + + + + + + + + materialSymbols + urn:samm:BatteryPass:1.0.0#materialSymbols + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + materialSymbols + + + + + en + materialSymbols + + + STRING + + + + + + + diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.Labels/1.0.0/gen/Labels-documentation.html b/SMARTENERGY/BatteriePass/io.BatteryPass.Labels/1.0.0/gen/Labels-documentation.html new file mode 100644 index 00000000..341fd13b --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.Labels/1.0.0/gen/Labels-documentation.html @@ -0,0 +1,605 @@ + + + + + + + + + + + + + + Documentation Labels + + +
+
+
+
+

Aspect Model Labels

+
urn:samm:BatteryPass:1.0.0#Labels
+
+
+
+
+
+
+
+ +
+ + +
+ Data model for battery labels and conformity + +Copyright © 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution. +
+ + +
+

Overview

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

Properties

+
+ +
+ +
+

declarationOfConformity

+
+ +URL to EU declaration of conformity signed by responsible economic operators to declare compliance with the regulatory requirements in the context of the market conformity assessment procedure and assume full responsibility. + +
+
Name
+
declarationOfConformity
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#anyURI + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
declarationOfConformity
+
+ + +
+
+ +
+

euDeclarationOfConformityId

+
+ +Identification number of the EU declaration of conformity of the battery, linked to the Battery Carbon Footprint Declaration. + +
+
Name
+
euDeclarationOfConformityId
+
+ + + +
+
Characteristic
+
+
+
+
Code
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
euDeclarationOfConformityId
+
+ + +
+
+ +
+

materialSymbols

+
+ + +
+
Name
+
materialSymbols
+
+ + + +
+
Characteristic
+
+
+
+
Set
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:BatteryPass:1.0.0#MaterialSymbol + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materialSymbols
+
+ + +
+
+ +
+

resultOfTestReport

+
+ +URL to a document that includes results of tests reports proving compliance in the market conformity assessment procedure with the requirements as per the technical documentation (Art. 7-10, Art. 12-14 and due diligence policies ). + +
+
Name
+
resultOfTestReport
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#anyURI + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
resultOfTestReport
+
+ + +
+
+ +
+

separateCollection

+
+ +'Separate collection' or 'WEEE label' indicating that a product should not be discarded as unsorted waste but must be sent to separate collection facilities for recovery and recycling. To be printed on the physical label and displayed via the battery passport, suggested to be translated also to text to ensure machine readability. + +
+
Name
+
separateCollection
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:BatteryPass:1.0.0#SeparateCollection + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
separateCollection
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

MaterialSymbol

+
+
+ +
+ +
+

Properties

+
+
+
+
+

SeparateCollection

+
+
+ Explanation of the meaning of all symbols and labels (including separate collection; cadmium and lead; and carbon footprint and carbon footprint performance class symbols; and symbols and labels printed on batteries or their accompanying documents but not accessible via the battery passport). +
+ +
+

Properties

+
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.Labels/1.0.0/gen/Labels-sample.json b/SMARTENERGY/BatteriePass/io.BatteryPass.Labels/1.0.0/gen/Labels-sample.json new file mode 100644 index 00000000..01d6562a --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.Labels/1.0.0/gen/Labels-sample.json @@ -0,0 +1,19 @@ +{ + "euDeclarationOfConformityId": "eOMtThyhVNLWUZNRcBaQKxI", + "materialSymbols": [ + { + "materialSymbol": "http://www.wikipedia.org", + "materialText": { + "en": "Example multi language string" + } + } + ], + "separateCollection": { + "separateCollectionSymbol": "http://www.ietf.org/rfc/rfc2396.txt", + "separateCollectionDescription": { + "en": "Example multi language string" + } + }, + "resultOfTestReport": "ftp://ftp.is.co.za/rfc/rfc1808.txt", + "declarationOfConformity": "telnet://192.0.2.16:80/" +} \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.Labels/1.0.0/gen/Labels-schema.json b/SMARTENERGY/BatteriePass/io.BatteryPass.Labels/1.0.0/gen/Labels-schema.json new file mode 100644 index 00000000..cbcc4358 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.Labels/1.0.0/gen/Labels-schema.json @@ -0,0 +1,122 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#Labels", + "description": "Data model for battery labels and conformity\n\nCopyright © 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution.", + "type": "object", + "components": { + "schemas": { + "ResourcePath": { + "type": "string", + "format": "uri", + "x-samm-aspect-model-urn": "urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#ResourcePath", + "description": "The path of a resource." + }, + "ResourcePath0": { + "type": "string", + "format": "uri", + "x-samm-aspect-model-urn": "urn:samm:org.eclipse.digitaltwin:1.0.0#ResourcePath", + "description": "The path of a resource." + }, + "EuDeclarationOfConformityId": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#EuDeclarationOfConformityId" + }, + "MultiLanguageText": { + "type": "object", + "x-samm-aspect-model-urn": "urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#MultiLanguageText", + "description": "Describes a Property which contains plain text in multiple languages. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." + }, + "SeparateCollection": { + "description": "Explanation of the meaning of all symbols and labels (including separate collection; cadmium and lead; and carbon footprint and carbon footprint performance class symbols; and symbols and labels printed on batteries or their accompanying documents but not accessible via the battery passport).", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#SeparateCollection", + "type": "object", + "properties": { + "separateCollectionSymbol": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#separateCollectionSymbol", + "$ref": "#/components/schemas/ResourcePath" + }, + "separateCollectionDescription": { + "description": "Explanation of the meaning of all symbols and labels (including separate collection; cadmium and lead; and carbon footprint and carbon footprint performance class symbols; and symbols and labels printed on batteries or their accompanying documents but not accessible via the battery passport).", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#separateCollectionDescription", + "$ref": "#/components/schemas/MultiLanguageText" + } + }, + "required": [ + "separateCollectionSymbol", + "separateCollectionDescription" + ] + }, + "SeperateCollection": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#SeperateCollection", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/SeparateCollection" + } + ] + }, + "MaterialSymbol": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#MaterialSymbol", + "type": "object", + "properties": { + "materialSymbol": { + "description": "Battery containing more than 0.002% cadmium or 0.004% lead to be marked with the symbol(s) for the metal concerned: Cd or Pb (Art. 13(4)).", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#materialSymbol", + "$ref": "#/components/schemas/ResourcePath" + }, + "materialText": { + "description": "Clear text information Battery containing more than 0.002% cadmium or 0.004% lead to be marked with the symbol(s) for the metal concerned: Cd or Pb (Art. 13(4)).", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#materialText", + "$ref": "#/components/schemas/MultiLanguageText" + } + }, + "required": [ + "materialSymbol", + "materialText" + ] + }, + "MaterialSymbols": { + "description": "Cadmium and lead symbols indicating the metal is contained in the battery above a defined threshold. To be printed on the physical label and displayed via the battery passport, suggested to be translated also to text to ensure machine readability.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#MaterialSymbols", + "type": "array", + "items": { + "$ref": "#/components/schemas/MaterialSymbol" + }, + "uniqueItems": true + } + } + }, + "properties": { + "declarationOfConformity": { + "description": "URL to EU declaration of conformity signed by responsible economic operators to declare compliance with the regulatory requirements in the context of the market conformity assessment procedure and assume full responsibility.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#declarationOfConformity", + "$ref": "#/components/schemas/ResourcePath" + }, + "resultOfTestReport": { + "description": "URL to a document that includes results of tests reports proving compliance in the market conformity assessment procedure with the requirements as per the technical documentation (Art. 7-10, Art. 12-14 and due diligence policies ).", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#resultOfTestReport", + "$ref": "#/components/schemas/ResourcePath0" + }, + "euDeclarationOfConformityId": { + "description": "Identification number of the EU declaration of conformity of the battery, linked to the Battery Carbon Footprint Declaration.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#euDeclarationOfConformityId", + "$ref": "#/components/schemas/EuDeclarationOfConformityId" + }, + "separateCollection": { + "description": "'Separate collection' or 'WEEE label' indicating that a product should not be discarded as unsorted waste but must be sent to separate collection facilities for recovery and recycling. To be printed on the physical label and displayed via the battery passport, suggested to be translated also to text to ensure machine readability.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#separateCollection", + "$ref": "#/components/schemas/SeperateCollection" + }, + "materialSymbols": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#materialSymbols", + "$ref": "#/components/schemas/MaterialSymbols" + } + }, + "required": [ + "declarationOfConformity", + "resultOfTestReport", + "euDeclarationOfConformityId", + "separateCollection", + "materialSymbols" + ] +} \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.Labels/1.0.0/gen/Labels_en-async-api.json b/SMARTENERGY/BatteriePass/io.BatteryPass.Labels/1.0.0/gen/Labels_en-async-api.json new file mode 100644 index 00000000..33139685 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.Labels/1.0.0/gen/Labels_en-async-api.json @@ -0,0 +1,28 @@ +{ + "asyncapi": "3.0.0", + "id": "", + "info": { + "title": "Labels MQTT API", + "version": "v1.0.0", + "description": "Data model for battery labels and conformity\n\nCopyright © 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#Labels" + }, + "defaultContentType": "application/json", + "channels": { + "Labels": { + "address": "/BatteryPass/1.0.0/Labels", + "description": "This channel for updating Labels Aspect.", + "parameters": { + "namespace": "BatteryPass", + "version": "1.0.0", + "aspect-name": "Labels" + }, + "messages": {} + } + }, + "operations": {}, + "components": { + "messages": {}, + "schemas": {} + } +} \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.Labels/1.0.0/gen/Labels_en-open-api.json b/SMARTENERGY/BatteriePass/io.BatteryPass.Labels/1.0.0/gen/Labels_en-open-api.json new file mode 100644 index 00000000..8931a9d2 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.Labels/1.0.0/gen/Labels_en-open-api.json @@ -0,0 +1,311 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "Labels", + "version": "v1.0.0", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#Labels" + }, + "servers": [ + { + "url": "https://example.com/api/v1.0.0", + "variables": { + "api-version": { + "default": "v1.0.0" + } + } + } + ], + "paths": { + "/null": { + "get": { + "tags": [ + "Labels" + ], + "operationId": "getLabels", + "parameters": [], + "responses": { + "200": { + "$ref": "#/components/responses/Labels" + }, + "401": { + "$ref": "#/components/responses/ClientError" + }, + "402": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFoundError" + } + } + }, + "post": { + "servers": [ + { + "url": "https://example.com/query-api/v1.0.0", + "variables": { + "api-version": { + "default": "v1.0.0" + } + } + } + ], + "tags": [ + "Labels" + ], + "operationId": "postLabels", + "parameters": [], + "requestBody": { + "$ref": "#/components/requestBodies/Filter" + }, + "responses": { + "200": { + "$ref": "#/components/responses/Labels" + }, + "401": { + "$ref": "#/components/responses/ClientError" + }, + "402": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFoundError" + } + } + } + } + }, + "components": { + "schemas": { + "ErrorResponse": { + "type": "object", + "required": [ + "error" + ], + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + } + }, + "Error": { + "type": "object", + "required": [ + "details" + ], + "properties": { + "message": { + "type": "string", + "minLength": 1 + }, + "path": { + "type": "string", + "minLength": 1 + }, + "details": { + "type": "object", + "minLength": 1, + "additionalProperties": { + "type": "object" + } + }, + "code": { + "type": "string", + "nullable": true + } + } + }, + "Filter": { + "type": "object", + "required": [ + "filter" + ], + "properties": { + "filter": { + "type": "string", + "description": "The filter to use.", + "example": "filter={filter expression}" + }, + "option": { + "type": "string", + "description": "The option for the filter.", + "example": "option=limit({start},{count})" + } + } + }, + "ResourcePath": { + "type": "string", + "format": "uri", + "x-samm-aspect-model-urn": "urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#ResourcePath", + "description": "The path of a resource." + }, + "ResourcePath0": { + "type": "string", + "format": "uri", + "x-samm-aspect-model-urn": "urn:samm:org.eclipse.digitaltwin:1.0.0#ResourcePath", + "description": "The path of a resource." + }, + "EuDeclarationOfConformityId": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#EuDeclarationOfConformityId" + }, + "MultiLanguageText": { + "type": "object", + "x-samm-aspect-model-urn": "urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#MultiLanguageText", + "description": "Describes a Property which contains plain text in multiple languages. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." + }, + "SeparateCollection": { + "description": "Explanation of the meaning of all symbols and labels (including separate collection; cadmium and lead; and carbon footprint and carbon footprint performance class symbols; and symbols and labels printed on batteries or their accompanying documents but not accessible via the battery passport).", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#SeparateCollection", + "type": "object", + "properties": { + "separateCollectionSymbol": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#separateCollectionSymbol", + "$ref": "#/components/schemas/ResourcePath" + }, + "separateCollectionDescription": { + "description": "Explanation of the meaning of all symbols and labels (including separate collection; cadmium and lead; and carbon footprint and carbon footprint performance class symbols; and symbols and labels printed on batteries or their accompanying documents but not accessible via the battery passport).", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#separateCollectionDescription", + "$ref": "#/components/schemas/MultiLanguageText" + } + }, + "required": [ + "separateCollectionSymbol", + "separateCollectionDescription" + ] + }, + "SeperateCollection": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#SeperateCollection", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/SeparateCollection" + } + ] + }, + "MaterialSymbol": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#MaterialSymbol", + "type": "object", + "properties": { + "materialSymbol": { + "description": "Battery containing more than 0.002% cadmium or 0.004% lead to be marked with the symbol(s) for the metal concerned: Cd or Pb (Art. 13(4)).", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#materialSymbol", + "$ref": "#/components/schemas/ResourcePath" + }, + "materialText": { + "description": "Clear text information Battery containing more than 0.002% cadmium or 0.004% lead to be marked with the symbol(s) for the metal concerned: Cd or Pb (Art. 13(4)).", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#materialText", + "$ref": "#/components/schemas/MultiLanguageText" + } + }, + "required": [ + "materialSymbol", + "materialText" + ] + }, + "MaterialSymbols": { + "description": "Cadmium and lead symbols indicating the metal is contained in the battery above a defined threshold. To be printed on the physical label and displayed via the battery passport, suggested to be translated also to text to ensure machine readability.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#MaterialSymbols", + "type": "array", + "items": { + "$ref": "#/components/schemas/MaterialSymbol" + }, + "uniqueItems": true + }, + "Labels": { + "description": "Data model for battery labels and conformity\n\nCopyright © 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution.", + "type": "object", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#Labels", + "properties": { + "declarationOfConformity": { + "description": "URL to EU declaration of conformity signed by responsible economic operators to declare compliance with the regulatory requirements in the context of the market conformity assessment procedure and assume full responsibility.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#declarationOfConformity", + "$ref": "#/components/schemas/ResourcePath" + }, + "resultOfTestReport": { + "description": "URL to a document that includes results of tests reports proving compliance in the market conformity assessment procedure with the requirements as per the technical documentation (Art. 7-10, Art. 12-14 and due diligence policies ).", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#resultOfTestReport", + "$ref": "#/components/schemas/ResourcePath0" + }, + "euDeclarationOfConformityId": { + "description": "Identification number of the EU declaration of conformity of the battery, linked to the Battery Carbon Footprint Declaration.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#euDeclarationOfConformityId", + "$ref": "#/components/schemas/EuDeclarationOfConformityId" + }, + "separateCollection": { + "description": "'Separate collection' or 'WEEE label' indicating that a product should not be discarded as unsorted waste but must be sent to separate collection facilities for recovery and recycling. To be printed on the physical label and displayed via the battery passport, suggested to be translated also to text to ensure machine readability.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#separateCollection", + "$ref": "#/components/schemas/SeperateCollection" + }, + "materialSymbols": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#materialSymbols", + "$ref": "#/components/schemas/MaterialSymbols" + } + }, + "required": [ + "declarationOfConformity", + "resultOfTestReport", + "euDeclarationOfConformityId", + "separateCollection", + "materialSymbols" + ] + } + }, + "responses": { + "Unauthorized": { + "description": "The requesting user or client is not authenticated." + }, + "Forbidden": { + "description": "The requesting user or client is not authorized to access resources for the given tenant." + }, + "NotFoundError": { + "description": "The requested Twin has not been found." + }, + "ClientError": { + "description": "Payload or user input is invalid. See error details in the payload for more.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "Labels": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Labels" + } + } + }, + "description": "The request was successful." + } + }, + "requestBodies": { + "Labels": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Labels" + } + } + } + }, + "Filter": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Filter" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.MaterialComposition/1.0.0/MaterialComposition.ttl b/SMARTENERGY/BatteriePass/io.BatteryPass.MaterialComposition/1.0.0/MaterialComposition.ttl new file mode 100644 index 00000000..e9dff3ec --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.MaterialComposition/1.0.0/MaterialComposition.ttl @@ -0,0 +1,192 @@ +###################################################################### +# Copyright (c) 2024 Circulor GmbH on behalf of the Battery Pass Consortium +# +# 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 : . + +:MaterialComposition a samm:Aspect ; + samm:preferredName "MaterialComposition"@en ; + samm:description "Mandatory data: Battery chemistry; critical raw materials; materials used in the cathode, anode, and \nelectrolyte; hazardous substances; impact of substances on the environment and on human health or \nsafety\n\nCopyright ? 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution."@en ; + samm:properties ( :criticalRawMaterials :productChemistry :batteryMaterials :hazardousSubstances ) ; + samm:operations ( ) ; + samm:events ( ) . + +:criticalRawMaterials a samm:Property ; + samm:preferredName "CriticalRawMaterials"@en ; + samm:description "Raw materials being economically important and vulnerable to supply disruption. List of the Commission is subject to updating, at least every three years to reflect production, market and technological developments. The latest list will be made available via the Raw Materials Information System (RMIS) of the EU Science Hub. In the battery passport, all critical raw materials above a concentration of 0.1 % weight by weight within each (sub)-component of the battery should be specified in an aggregated way for the entire battery. For anode, cathode, and electrolyte critical raw materials can be derived from \"cathode materials\", \"anode materials\", and \"electrolyte materials\"."@en ; + samm:characteristic :CriticalRawMaterialsList . + +:productChemistry a samm:Property ; + samm:preferredName "ProductChemistry"@en ; + samm:description "Composition of a product in general terms by specifying the cathode and anode active material as well as electrolyte."@en ; + samm:characteristic :BatteryChemistryEntityList . + +:batteryMaterials a samm:Property ; + samm:preferredName "BatteryMaterials"@en ; + samm:description "\"Component materials used\" (No. 17.a-c): Naming the materials (as a composition of substances) in cathode, anode, electrolyte according to public standards, including specification of the corresponding component (i.e., cathode, anode, or electrolyte). We suggest a reporting threshold of 0.1 % weight by weight."@en ; + samm:characteristic :BatteryMaterialList . + +:hazardousSubstances a samm:Property ; + samm:preferredName "HazardousSubstances"@en ; + samm:description "\"Hazardous substances\" (No 20.a-e): Name (agreed substance nomenclature, e.g. IUPAC or chemical name) all hazardous substance (as ?any substance that poses a threat to human health and the environment?). Suggested above 0.1 % weight by weight within each (sub-)component."@en ; + samm:characteristic :HazardousSubstancesList . + +:CriticalRawMaterialsList a samm-c:List ; + samm:description "'Critical raw materials contained in the battery above a concentration of 0.1 % weight by weight. Reference to COM(2020)474: ?Those raw materials that are most important economically and have a high supply risk?. The fourth list of critical raw materials for the EU lists 30 raw materials as critical in 2020. An updated version has been included in Annex II of the EU Critical Raw Materials Act Regulation (CRMA)\n\nEUBR: Annex XIII (1b) ? Annex VI Part A (10)"@en ; + samm:see ; + samm:dataType xsd:string . + +:BatteryChemistryEntityList a samm-c:SingleEntity ; + samm:preferredName "BatteryChemistryEntity"@en ; + samm:description "Detailed composition, including materials used in the cathode, anode, and electrolyte.\nAll common cells have two electrodes and an electrolyte. The specific combination of materials used to make these components is called \"chemistry.\" A cell's chemistry largely determines its properties, while most variations within it are caused by additives, purification, and design elements.\n\nEUBR: Annex XIII (1b) ? Annex VI Part A (7)"@en ; + samm:dataType :BatteryChemistry . + +:BatteryMaterialList a samm-c:List ; + samm:preferredName "Battery Material List"@en ; + samm:description "Detailed composition, including materials used in the cathode, anode, and electrolyte\n\nEUBR: Annex XIII (2a)"@en ; + samm:dataType :BatteryMaterial . + +:HazardousSubstancesList a samm-c:List ; + samm:preferredName "HazardousSubstances"@en ; + samm:description "Hazardous substances contained in the battery other than mercury, cadmium or lead. Substance as a chemical element and its compounds in the natural state or the result of a manufacturing process (ECHA). Battery Regulation narrows reporting to substances falling under defined hazard classes and categories of the CLP regulation.\n\nEUBR: Annex XIII (1b) ? Annex VI Part A (8)"@en ; + samm:dataType :HazardousSubstance . + +:BatteryChemistry a samm:Entity ; + samm:preferredName "Chemistry"@en ; + samm:properties ( :shortName :clearName ) . + +:BatteryMaterial a samm:Entity ; + samm:preferredName "Material"@en ; + samm:properties ( :batteryMaterialLocation :materialIdentifier :batteryMaterialName :batteryMaterialWeight ) . + +:HazardousSubstance a samm:Entity ; + samm:description "Hazardous substances (No. 19-23): Name (agreed substance nomenclature, e.g. IUPAC or chemical name) all hazardous substance (as ?any substance that poses a threat to human health and the environment?). Suggested above 0.1 % weight by weight within each (sub-)component."@en ; + samm:properties ( :hazardousSubstanceClass :hazardousSubstanceName :hazardousSubstanceConcentration :hazardousSubstanceImpact :hazardousSubstanceLocation :hazardousSubstanceIdentifier ) . + +:shortName a samm:Property ; + samm:characteristic :Text ; + samm:exampleValue "NMC" . + +:clearName a samm:Property ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Lithium nickel manganese cobalt oxides" . + +:batteryMaterialLocation a samm:Property ; + samm:preferredName "Location"@en ; + samm:description "Battery component that relates to the material"@en ; + samm:characteristic :BatteryMaterialLocation . + +:materialIdentifier a samm:Property ; + samm:preferredName "Identifier"@en ; + samm:description "CAS Number "@en ; + samm:characteristic :MaterialIdentifierTrait ; + samm:exampleValue "7439-93-2 " . + +:batteryMaterialName a samm:Property ; + samm:preferredName "Name"@en ; + samm:description "Clear name of Material"@en ; + samm:characteristic :Text ; + samm:exampleValue "Lithium" . + +:batteryMaterialWeight a samm:Property ; + samm:preferredName "Weight"@en ; + samm:description "Weight of component material"@en ; + samm:characteristic :Weight . + +:hazardousSubstanceClass a samm:Property ; + samm:preferredName "Class"@en ; + samm:description "Battery Regulation narrows reporting to substances falling under defined hazard classes and categories of the CLP regulation."@en ; + samm:characteristic :HazardousSubstanceClassChrateristicEnum . + +:hazardousSubstanceName a samm:Property ; + samm:preferredName "Name"@en ; + samm:description "Clear name of hazardous substance"@en ; + samm:characteristic :Text . + +:hazardousSubstanceConcentration a samm:Property ; + samm:preferredName "Concentration"@en ; + samm:description "Concentration of hazardous substance"@en ; + samm:characteristic :HazardousSubstanceConcentrationCharacteristic . + +:hazardousSubstanceImpact a samm:Property ; + samm:preferredName "Impact"@en ; + samm:description "Impact statements based on, e.g., REACH or GHS for all hazard classes applicable to substances in the battery."@en ; + samm:characteristic :ImpactList . + +:hazardousSubstanceLocation a samm:Property ; + samm:preferredName "Location"@en ; + samm:description "Hazardous substances (No. 19-23): Location on a (sub-)component-level of all hazardous substances (as ?any substance that poses a threat to human health and the environment?). Suggested via a unique identifier or nomenclature."@en ; + samm:characteristic :HubstanceSubstanceLocationEntity . + +:hazardousSubstanceIdentifier a samm:Property ; + samm:preferredName "Identifier"@en ; + samm:description "CAS identifier of hazardous substance"@en ; + samm:see ; + samm:characteristic :MaterialIdentifierTrait . + +:Text a samm:Characteristic ; + samm:preferredName "Text"@en ; + samm:description "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc."@en ; + samm:dataType xsd:string . + +:BatteryMaterialLocation a samm-c:SingleEntity ; + samm:preferredName "Location"@en ; + samm:dataType :BatteryComponent . + +:MaterialIdentifierTrait a samm-c:Trait ; + samm-c:baseCharacteristic :Text ; + samm-c:constraint :CASNumberConstraint . + +:Weight a samm-c:Measurement ; + samm:dataType xsd:float ; + samm-c:unit unit:gram . + +:HazardousSubstanceClassChrateristicEnum a samm-c:Enumeration ; + samm:dataType xsd:string ; + samm-c:values ( "AcuteToxicity" "SkinCorrosionOrIrritation" "EyeDamageOrIrritation" ) . + +:HazardousSubstanceConcentrationCharacteristic a samm-c:Measurement ; + samm:dataType xsd:double ; + samm-c:unit unit:percent . + +:ImpactList a samm-c:List ; + samm:dataType xsd:string ; + samm-c:elementCharacteristic :Text . + +:HubstanceSubstanceLocationEntity a samm-c:SingleEntity ; + samm:preferredName "Location"@en ; + samm:description "\"The impact of substances, in particular, hazardous substances, contained in batteries on the environment and on human health or safety of persons, including impact due to inappropriate discarding of waste batteries such as littering or discarding as unsorted municipal waste?."@en ; + samm:dataType :BatteryComponent . + +:BatteryComponent a samm:Entity ; + samm:preferredName "Component"@en ; + samm:properties ( :componentName [ samm:property :componentId; samm:optional true ] ) . + +:CASNumberConstraint a samm-c:RegularExpressionConstraint ; + samm:value "\\d{4}-\\d{2}-\\d" . + +:componentName a samm:Property ; + samm:preferredName "Name"@en ; + samm:characteristic samm-c:Text . + +:componentId a samm:Property ; + samm:preferredName "SubstanceId"@en ; + samm:characteristic samm-c:Text . + diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.MaterialComposition/1.0.0/gen/MaterialComposition-aas.xml b/SMARTENERGY/BatteriePass/io.BatteryPass.MaterialComposition/1.0.0/gen/MaterialComposition-aas.xml new file mode 100644 index 00000000..f87deea1 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.MaterialComposition/1.0.0/gen/MaterialComposition-aas.xml @@ -0,0 +1,1476 @@ + + + + + defaultAdminShell + + + en + defaultAdminShell + + + + urn:samm:BatteryPass:1.0.0#MaterialComposition + + Type + + + + ModelReference + + + Submodel + urn:samm:BatteryPass:1.0.0#MaterialComposition/submodel + + + + + + + + + MaterialComposition + + + en + Mandatory data: Battery chemistry; critical raw materials; materials used in the cathode, anode, and +electrolyte; hazardous substances; impact of substances on the environment and on human health or +safety + +Copyright � 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution. + + + + urn:samm:BatteryPass:1.0.0#MaterialComposition/submodel + Template + + ModelReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#MaterialComposition + + + + + + criticalRawMaterials + + + en + CriticalRawMaterials + + + + + en + Raw materials being economically important and vulnerable to supply disruption. List of the Commission is subject to updating, at least every three years to reflect production, market and technological developments. The latest list will be made available via the Raw Materials Information System (RMIS) of the EU Science Hub. In the battery passport, all critical raw materials above a concentration of 0.1 % weight by weight within each (sub)-component of the battery should be specified in an aggregated way for the entire battery. For anode, cathode, and electrolyte critical raw materials can be derived from "cathode materials", "anode materials", and "electrolyte materials". + + + + + ExternalReference + + + GlobalReference + https://rmis.jrc.ec.europa.eu/ + + + + + true + SubmodelElement + + + criticalRawMaterials + + + en + CriticalRawMaterials + + + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#criticalRawMaterials + + + + xs:string + + + + + + BatteryChemistry + + + en + Chemistry + + + + + shortName + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#shortName + + + + xs:string + + + + clearName + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#clearName + + + + xs:string + + + + + + batteryMaterials + + + en + BatteryMaterials + + + + + en + "Component materials used" (No. 17.a-c): Naming the materials (as a composition of substances) in cathode, anode, electrolyte according to public standards, including specification of the corresponding component (i.e., cathode, anode, or electrolyte). We suggest a reporting threshold of 0.1 % weight by weight. + + + true + SubmodelElement + + + BatteryMaterial + + + en + Material + + + + + BatteryComponent + + + en + Component + + + + + componentName + + + en + Name + + + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#componentName + + + + xs:string + + + + componentId + + + en + SubstanceId + + + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#componentId + + + + xs:string + + + + + + materialIdentifier + + + en + Identifier + + + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#materialIdentifier + + + + xs:string + + + + batteryMaterialName + + + en + Name + + + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#batteryMaterialName + + + + xs:string + + + + batteryMaterialWeight + + + en + Weight + + + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#batteryMaterialWeight + + + + xs:float + + + + + + + + hazardousSubstances + + + en + HazardousSubstances + + + + + en + "Hazardous substances" (No 20.a-e): Name (agreed substance nomenclature, e.g. IUPAC or chemical name) all hazardous substance (as ?any substance that poses a threat to human health and the environment?). Suggested above 0.1 % weight by weight within each (sub-)component. + + + true + SubmodelElement + + + HazardousSubstance + + + en + Hazardous substances (No. 19-23): Name (agreed substance nomenclature, e.g. IUPAC or chemical name) all hazardous substance (as ?any substance that poses a threat to human health and the environment?). Suggested above 0.1 % weight by weight within each (sub-)component. + + + + + hazardousSubstanceClass + + + en + Class + + + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#hazardousSubstanceClass + + + + xs:string + + + + hazardousSubstanceName + + + en + Name + + + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#hazardousSubstanceName + + + + xs:string + + + + hazardousSubstanceConcentration + + + en + Concentration + + + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#hazardousSubstanceConcentration + + + + xs:double + + + + hazardousSubstanceImpact + + + en + Impact + + + + + en + Impact statements based on, e.g., REACH or GHS for all hazard classes applicable to substances in the battery. + + + true + SubmodelElement + + + hazardousSubstanceImpact + + + en + Impact + + + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#hazardousSubstanceImpact + + + + xs:string + + + + + + BatteryComponent + + + en + Component + + + + + componentName + + + en + Name + + + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#componentName + + + + xs:string + + + + componentId + + + en + SubstanceId + + + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#componentId + + + + xs:string + + + + + + hazardousSubstanceIdentifier + + + en + Identifier + + + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#hazardousSubstanceIdentifier + + + + + + ExternalReference + + + GlobalReference + https://www.cas.org/cas-data/cas-registry + + + + + xs:string + + + + + + + + + + + + APPLICATION_CLASS + MaterialComposition + + + en + MaterialComposition + + + + + en + Mandatory data: Battery chemistry; critical raw materials; materials used in the cathode, anode, and +electrolyte; hazardous substances; impact of substances on the environment and on human health or +safety + +Copyright � 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution. + + + urn:samm:BatteryPass:1.0.0#MaterialComposition + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + MaterialComposition + + + + + en + MaterialComposition + + + + + en + Mandatory data: Battery chemistry; critical raw materials; materials used in the cathode, anode, and +electrolyte; hazardous substances; impact of substances on the environment and on human health or +safety + +Copyright � 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution. + + + + + + + + + criticalRawMaterials + + + en + CriticalRawMaterials + + + urn:samm:BatteryPass:1.0.0#criticalRawMaterials + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + CriticalRawMaterials + + + + + en + criticalRawMaterials + + + STRING + + + en + Raw materials being economically important and vulnerable to supply disruption. List of the Commission is subject to updating, at least every three years to reflect production, market and technological developments. The latest list will be made available via the Raw Materials Information System (RMIS) of the EU Science Hub. In the battery passport, all critical raw materials above a concentration of 0.1 % weight by weight within each (sub)-component of the battery should be specified in an aggregated way for the entire battery. For anode, cathode, and electrolyte critical raw materials can be derived from "cathode materials", "anode materials", and "electrolyte materials". + + + + + + + + + shortName + urn:samm:BatteryPass:1.0.0#shortName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + shortName + + + + + en + shortName + + + STRING + + + + + + + clearName + urn:samm:BatteryPass:1.0.0#clearName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + clearName + + + + + en + clearName + + + STRING + + + + + + + productChemistry + + + en + ProductChemistry + + + urn:samm:BatteryPass:1.0.0#productChemistry + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + ProductChemistry + + + + + en + productChemistry + + + STRING + + + en + Composition of a product in general terms by specifying the cathode and anode active material as well as electrolyte. + + + + + + + + + componentName + + + en + Name + + + urn:samm:BatteryPass:1.0.0#componentName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Name + + + + + en + componentName + + + STRING + + + + + + + componentId + + + en + SubstanceId + + + urn:samm:BatteryPass:1.0.0#componentId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + SubstanceId + + + + + en + componentId + + + STRING + + + + + + + batteryMaterialLocation + + + en + Location + + + urn:samm:BatteryPass:1.0.0#batteryMaterialLocation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Location + + + + + en + batteryMaterialLocation + + + STRING + + + en + Battery component that relates to the material + + + + + + + + + materialIdentifier + + + en + Identifier + + + urn:samm:BatteryPass:1.0.0#materialIdentifier + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Identifier + + + + + en + materialIdentifier + + + STRING + + + en + CAS Number + + + + + + + + + batteryMaterialName + + + en + Name + + + urn:samm:BatteryPass:1.0.0#batteryMaterialName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Name + + + + + en + batteryMaterialName + + + STRING + + + en + Clear name of Material + + + + + + + + + batteryMaterialWeight + + + en + Weight + + + urn:samm:BatteryPass:1.0.0#batteryMaterialWeight + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Weight + + + + + en + batteryMaterialWeight + + + gram + REAL_MEASURE + + + en + Weight of component material + + + + + + + + + batteryMaterials + + + en + BatteryMaterials + + + urn:samm:BatteryPass:1.0.0#batteryMaterials + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + BatteryMaterials + + + + + en + batteryMaterials + + + STRING + + + en + "Component materials used" (No. 17.a-c): Naming the materials (as a composition of substances) in cathode, anode, electrolyte according to public standards, including specification of the corresponding component (i.e., cathode, anode, or electrolyte). We suggest a reporting threshold of 0.1 % weight by weight. + + + + + + + + + hazardousSubstanceClass + + + en + Class + + + urn:samm:BatteryPass:1.0.0#hazardousSubstanceClass + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Class + + + + + en + hazardousSubstanceClass + + + STRING + + + en + Battery Regulation narrows reporting to substances falling under defined hazard classes and categories of the CLP regulation. + + + + + + AcuteToxicity + + ModelReference + + + DataElement + urn:samm:BatteryPass:1.0.0#HazardousSubstanceClassChrateristicEnum:AcuteToxicity + + + + + + SkinCorrosionOrIrritation + + ModelReference + + + DataElement + urn:samm:BatteryPass:1.0.0#HazardousSubstanceClassChrateristicEnum:SkinCorrosionOrIrritation + + + + + + EyeDamageOrIrritation + + ModelReference + + + DataElement + urn:samm:BatteryPass:1.0.0#HazardousSubstanceClassChrateristicEnum:EyeDamageOrIrritation + + + + + + + + + + + + + hazardousSubstanceName + + + en + Name + + + urn:samm:BatteryPass:1.0.0#hazardousSubstanceName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Name + + + + + en + hazardousSubstanceName + + + STRING + + + en + Clear name of hazardous substance + + + + + + + + + hazardousSubstanceConcentration + + + en + Concentration + + + urn:samm:BatteryPass:1.0.0#hazardousSubstanceConcentration + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Concentration + + + + + en + hazardousSubstanceConcentration + + + percent + REAL_MEASURE + + + en + Concentration of hazardous substance + + + + + + + + + hazardousSubstanceImpact + + + en + Impact + + + urn:samm:BatteryPass:1.0.0#hazardousSubstanceImpact + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Impact + + + + + en + hazardousSubstanceImpact + + + STRING + + + en + Impact statements based on, e.g., REACH or GHS for all hazard classes applicable to substances in the battery. + + + + + + + + + componentName + + + en + Name + + + urn:samm:BatteryPass:1.0.0#componentName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Name + + + + + en + componentName + + + STRING + + + + + + + componentId + + + en + SubstanceId + + + urn:samm:BatteryPass:1.0.0#componentId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + SubstanceId + + + + + en + componentId + + + STRING + + + + + + + hazardousSubstanceLocation + + + en + Location + + + urn:samm:BatteryPass:1.0.0#hazardousSubstanceLocation + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Location + + + + + en + hazardousSubstanceLocation + + + STRING + + + en + Hazardous substances (No. 19-23): Location on a (sub-)component-level of all hazardous substances (as ?any substance that poses a threat to human health and the environment?). Suggested via a unique identifier or nomenclature. + + + + + + + + + hazardousSubstanceIdentifier + + + en + Identifier + + + urn:samm:BatteryPass:1.0.0#hazardousSubstanceIdentifier + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Identifier + + + + + en + hazardousSubstanceIdentifier + + + STRING + + + en + CAS identifier of hazardous substance + + + + + + + + + hazardousSubstances + + + en + HazardousSubstances + + + urn:samm:BatteryPass:1.0.0#hazardousSubstances + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + HazardousSubstances + + + + + en + hazardousSubstances + + + STRING + + + en + "Hazardous substances" (No 20.a-e): Name (agreed substance nomenclature, e.g. IUPAC or chemical name) all hazardous substance (as ?any substance that poses a threat to human health and the environment?). Suggested above 0.1 % weight by weight within each (sub-)component. + + + + + + + + + diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.MaterialComposition/1.0.0/gen/MaterialComposition-documentation.html b/SMARTENERGY/BatteriePass/io.BatteryPass.MaterialComposition/1.0.0/gen/MaterialComposition-documentation.html new file mode 100644 index 00000000..88cf23a0 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.MaterialComposition/1.0.0/gen/MaterialComposition-documentation.html @@ -0,0 +1,607 @@ + + + + + + + + + + + + + + Documentation MaterialComposition + + +
+
+
+
+

Aspect Model MaterialComposition

+
urn:samm:BatteryPass:1.0.0#MaterialComposition
+
+
+
+
+
+
+
+ +
+ + +
+ Mandatory data: Battery chemistry; critical raw materials; materials used in the cathode, anode, and +electrolyte; hazardous substances; impact of substances on the environment and on human health or +safety + +Copyright © 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution. +
+ + +
+

Overview

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

Properties

+
+ +
+ +
+

BatteryMaterials

+
+ +"Component materials used" (No. 17.a-c): Naming the materials (as a composition of substances) in cathode, anode, electrolyte according to public standards, including specification of the corresponding component (i.e., cathode, anode, or electrolyte). We suggest a reporting threshold of 0.1 % weight by weight. + +
+
Name
+
batteryMaterials
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:BatteryPass:1.0.0#BatteryMaterial + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
batteryMaterials
+
+ + +
+
+ +
+

CriticalRawMaterials

+
+ +Raw materials being economically important and vulnerable to supply disruption. List of the Commission is subject to updating, at least every three years to reflect production, market and technological developments. The latest list will be made available via the Raw Materials Information System (RMIS) of the EU Science Hub. In the battery passport, all critical raw materials above a concentration of 0.1 % weight by weight within each (sub)-component of the battery should be specified in an aggregated way for the entire battery. For anode, cathode, and electrolyte critical raw materials can be derived from "cathode materials", "anode materials", and "electrolyte materials". + +
+
Name
+
criticalRawMaterials
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Reference +
+
    +
  • https://rmis.jrc.ec.europa.eu/
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
criticalRawMaterials
+
+ + +
+
+ +
+

HazardousSubstances

+
+ +"Hazardous substances" (No 20.a-e): Name (agreed substance nomenclature, e.g. IUPAC or chemical name) all hazardous substance (as ?any substance that poses a threat to human health and the environment?). Suggested above 0.1 % weight by weight within each (sub-)component. + +
+
Name
+
hazardousSubstances
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:BatteryPass:1.0.0#HazardousSubstance + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
hazardousSubstances
+
+ + +
+
+ +
+

ProductChemistry

+
+ +Composition of a product in general terms by specifying the cathode and anode active material as well as electrolyte. + +
+
Name
+
productChemistry
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:BatteryPass:1.0.0#BatteryChemistry + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productChemistry
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

Chemistry

+
+
+ +
+ +
+

Properties

+
+
+
+
+

Component

+
+
+ +
+ +
+

Properties

+
+
+
+
+

HazardousSubstance

+
+
+ Hazardous substances (No. 19-23): Name (agreed substance nomenclature, e.g. IUPAC or chemical name) all hazardous substance (as ?any substance that poses a threat to human health and the environment?). Suggested above 0.1 % weight by weight within each (sub-)component. +
+ +
+

Properties

+
+
+
+
+

Material

+
+
+ +
+ +
+

Properties

+
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.MaterialComposition/1.0.0/gen/MaterialComposition-sample.json b/SMARTENERGY/BatteriePass/io.BatteryPass.MaterialComposition/1.0.0/gen/MaterialComposition-sample.json new file mode 100644 index 00000000..9ee35516 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.MaterialComposition/1.0.0/gen/MaterialComposition-sample.json @@ -0,0 +1,35 @@ +{ + "hazardousSubstances": [ + { + "hazardousSubstanceClass": "AcuteToxicity", + "hazardousSubstanceConcentration": 0, + "hazardousSubstanceImpact": [ + "VLhpfQGTMDYpsBZxvfBoeygjb" + ], + "hazardousSubstanceIdentifier": "9757-28-9", + "hazardousSubstanceLocation": { + "componentName": "UMaAIKKIkknjWEXJUfPxxQHeWKEJ", + "componentId": "dpHYZGhtgdntugzvvKAXLhM" + }, + "hazardousSubstanceName": "RYtGKbgicZaHCBRQDSx" + } + ], + "productChemistry": { + "shortName": "NMC", + "clearName": "Lithium nickel manganese cobalt oxides" + }, + "criticalRawMaterials": [ + "eOMtThyhVNLWUZNRcBaQKxI" + ], + "batteryMaterials": [ + { + "materialIdentifier": "7439-93-2 ", + "batteryMaterialName": "Lithium", + "batteryMaterialWeight": 0, + "batteryMaterialLocation": { + "componentName": "yedUsFwdkelQbxeTeQOvaScfqIOOmaa", + "componentId": "JxkyvRnL" + } + } + ] +} \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.MaterialComposition/1.0.0/gen/MaterialComposition-schema.json b/SMARTENERGY/BatteriePass/io.BatteryPass.MaterialComposition/1.0.0/gen/MaterialComposition-schema.json new file mode 100644 index 00000000..5a65b8ea --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.MaterialComposition/1.0.0/gen/MaterialComposition-schema.json @@ -0,0 +1,245 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#MaterialComposition", + "description": "Mandatory data: Battery chemistry; critical raw materials; materials used in the cathode, anode, and \nelectrolyte; hazardous substances; impact of substances on the environment and on human health or \nsafety\n\nCopyright © 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution.", + "type": "object", + "components": { + "schemas": { + "CriticalRawMaterialsList": { + "description": "'Critical raw materials contained in the battery above a concentration of 0.1 % weight by weight. Reference to COM(2020)474: ?Those raw materials that are most important economically and have a high supply risk?. The fourth list of critical raw materials for the EU lists 30 raw materials as critical in 2020. An updated version has been included in Annex II of the EU Critical Raw Materials Act Regulation (CRMA)\n\nEUBR: Annex XIII (1b) ? Annex VI Part A (10)", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CriticalRawMaterialsList", + "type": "array", + "items": { + "type": "string" + } + }, + "Text": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#Text", + "description": "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." + }, + "Text0": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text", + "description": "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." + }, + "BatteryChemistry": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#BatteryChemistry", + "type": "object", + "properties": { + "shortName": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#shortName", + "$ref": "#/components/schemas/Text" + }, + "clearName": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#clearName", + "$ref": "#/components/schemas/Text0" + } + }, + "required": [ + "shortName", + "clearName" + ] + }, + "BatteryChemistryEntityList": { + "description": "Detailed composition, including materials used in the cathode, anode, and electrolyte.\nAll common cells have two electrodes and an electrolyte. The specific combination of materials used to make these components is called \"chemistry.\" A cell's chemistry largely determines its properties, while most variations within it are caused by additives, purification, and design elements.\n\nEUBR: Annex XIII (1b) ? Annex VI Part A (7)", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#BatteryChemistryEntityList", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BatteryChemistry" + } + ] + }, + "BatteryComponent": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#BatteryComponent", + "type": "object", + "properties": { + "componentName": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#componentName", + "$ref": "#/components/schemas/Text0" + }, + "componentId": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#componentId", + "$ref": "#/components/schemas/Text0" + } + }, + "required": [ + "componentName" + ] + }, + "BatteryMaterialLocation": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#BatteryMaterialLocation", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BatteryComponent" + } + ] + }, + "MaterialIdentifierTrait": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#MaterialIdentifierTrait", + "description": "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.", + "pattern": "\\d{4}-\\d{2}-\\d" + }, + "Weight": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#Weight" + }, + "BatteryMaterial": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#BatteryMaterial", + "type": "object", + "properties": { + "batteryMaterialLocation": { + "description": "Battery component that relates to the material", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#batteryMaterialLocation", + "$ref": "#/components/schemas/BatteryMaterialLocation" + }, + "materialIdentifier": { + "description": "CAS Number ", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#materialIdentifier", + "$ref": "#/components/schemas/MaterialIdentifierTrait" + }, + "batteryMaterialName": { + "description": "Clear name of Material", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#batteryMaterialName", + "$ref": "#/components/schemas/Text" + }, + "batteryMaterialWeight": { + "description": "Weight of component material", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#batteryMaterialWeight", + "$ref": "#/components/schemas/Weight" + } + }, + "required": [ + "batteryMaterialLocation", + "materialIdentifier", + "batteryMaterialName", + "batteryMaterialWeight" + ] + }, + "BatteryMaterialList": { + "description": "Detailed composition, including materials used in the cathode, anode, and electrolyte\n\nEUBR: Annex XIII (2a)", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#BatteryMaterialList", + "type": "array", + "items": { + "$ref": "#/components/schemas/BatteryMaterial" + } + }, + "HazardousSubstanceClassChrateristicEnum": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#HazardousSubstanceClassChrateristicEnum", + "enum": [ + "AcuteToxicity", + "SkinCorrosionOrIrritation", + "EyeDamageOrIrritation" + ] + }, + "HazardousSubstanceConcentrationCharacteristic": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#HazardousSubstanceConcentrationCharacteristic" + }, + "ImpactList": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#ImpactList", + "type": "array", + "items": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#Text", + "description": "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." + } + }, + "HubstanceSubstanceLocationEntity": { + "description": "\"The impact of substances, in particular, hazardous substances, contained in batteries on the environment and on human health or safety of persons, including impact due to inappropriate discarding of waste batteries such as littering or discarding as unsorted municipal waste?.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#HubstanceSubstanceLocationEntity", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BatteryComponent" + } + ] + }, + "HazardousSubstance": { + "description": "Hazardous substances (No. 19-23): Name (agreed substance nomenclature, e.g. IUPAC or chemical name) all hazardous substance (as ?any substance that poses a threat to human health and the environment?). Suggested above 0.1 % weight by weight within each (sub-)component.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#HazardousSubstance", + "type": "object", + "properties": { + "hazardousSubstanceClass": { + "description": "Battery Regulation narrows reporting to substances falling under defined hazard classes and categories of the CLP regulation.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#hazardousSubstanceClass", + "$ref": "#/components/schemas/HazardousSubstanceClassChrateristicEnum" + }, + "hazardousSubstanceName": { + "description": "Clear name of hazardous substance", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#hazardousSubstanceName", + "$ref": "#/components/schemas/Text" + }, + "hazardousSubstanceConcentration": { + "description": "Concentration of hazardous substance", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#hazardousSubstanceConcentration", + "$ref": "#/components/schemas/HazardousSubstanceConcentrationCharacteristic" + }, + "hazardousSubstanceImpact": { + "description": "Impact statements based on, e.g., REACH or GHS for all hazard classes applicable to substances in the battery.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#hazardousSubstanceImpact", + "$ref": "#/components/schemas/ImpactList" + }, + "hazardousSubstanceLocation": { + "description": "Hazardous substances (No. 19-23): Location on a (sub-)component-level of all hazardous substances (as ?any substance that poses a threat to human health and the environment?). Suggested via a unique identifier or nomenclature.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#hazardousSubstanceLocation", + "$ref": "#/components/schemas/HubstanceSubstanceLocationEntity" + }, + "hazardousSubstanceIdentifier": { + "description": "CAS identifier of hazardous substance", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#hazardousSubstanceIdentifier", + "$ref": "#/components/schemas/MaterialIdentifierTrait" + } + }, + "required": [ + "hazardousSubstanceClass", + "hazardousSubstanceName", + "hazardousSubstanceConcentration", + "hazardousSubstanceImpact", + "hazardousSubstanceLocation", + "hazardousSubstanceIdentifier" + ] + }, + "HazardousSubstancesList": { + "description": "Hazardous substances contained in the battery other than mercury, cadmium or lead. Substance as a chemical element and its compounds in the natural state or the result of a manufacturing process (ECHA). Battery Regulation narrows reporting to substances falling under defined hazard classes and categories of the CLP regulation.\n\nEUBR: Annex XIII (1b) ? Annex VI Part A (8)", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#HazardousSubstancesList", + "type": "array", + "items": { + "$ref": "#/components/schemas/HazardousSubstance" + } + } + } + }, + "properties": { + "criticalRawMaterials": { + "description": "Raw materials being economically important and vulnerable to supply disruption. List of the Commission is subject to updating, at least every three years to reflect production, market and technological developments. The latest list will be made available via the Raw Materials Information System (RMIS) of the EU Science Hub. In the battery passport, all critical raw materials above a concentration of 0.1 % weight by weight within each (sub)-component of the battery should be specified in an aggregated way for the entire battery. For anode, cathode, and electrolyte critical raw materials can be derived from \"cathode materials\", \"anode materials\", and \"electrolyte materials\".", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#criticalRawMaterials", + "$ref": "#/components/schemas/CriticalRawMaterialsList" + }, + "productChemistry": { + "description": "Composition of a product in general terms by specifying the cathode and anode active material as well as electrolyte.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#productChemistry", + "$ref": "#/components/schemas/BatteryChemistryEntityList" + }, + "batteryMaterials": { + "description": "\"Component materials used\" (No. 17.a-c): Naming the materials (as a composition of substances) in cathode, anode, electrolyte according to public standards, including specification of the corresponding component (i.e., cathode, anode, or electrolyte). We suggest a reporting threshold of 0.1 % weight by weight.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#batteryMaterials", + "$ref": "#/components/schemas/BatteryMaterialList" + }, + "hazardousSubstances": { + "description": "\"Hazardous substances\" (No 20.a-e): Name (agreed substance nomenclature, e.g. IUPAC or chemical name) all hazardous substance (as ?any substance that poses a threat to human health and the environment?). Suggested above 0.1 % weight by weight within each (sub-)component.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#hazardousSubstances", + "$ref": "#/components/schemas/HazardousSubstancesList" + } + }, + "required": [ + "criticalRawMaterials", + "productChemistry", + "batteryMaterials", + "hazardousSubstances" + ] +} \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.MaterialComposition/1.0.0/gen/MaterialComposition_en-async-api.json b/SMARTENERGY/BatteriePass/io.BatteryPass.MaterialComposition/1.0.0/gen/MaterialComposition_en-async-api.json new file mode 100644 index 00000000..2f1df6af --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.MaterialComposition/1.0.0/gen/MaterialComposition_en-async-api.json @@ -0,0 +1,28 @@ +{ + "asyncapi": "3.0.0", + "id": "", + "info": { + "title": "MaterialComposition MQTT API", + "version": "v1.0.0", + "description": "Mandatory data: Battery chemistry; critical raw materials; materials used in the cathode, anode, and \nelectrolyte; hazardous substances; impact of substances on the environment and on human health or \nsafety\n\nCopyright © 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#MaterialComposition" + }, + "defaultContentType": "application/json", + "channels": { + "MaterialComposition": { + "address": "/BatteryPass/1.0.0/MaterialComposition", + "description": "This channel for updating MaterialComposition Aspect.", + "parameters": { + "namespace": "BatteryPass", + "version": "1.0.0", + "aspect-name": "MaterialComposition" + }, + "messages": {} + } + }, + "operations": {}, + "components": { + "messages": {}, + "schemas": {} + } +} \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.MaterialComposition/1.0.0/gen/MaterialComposition_en-open-api.json b/SMARTENERGY/BatteriePass/io.BatteryPass.MaterialComposition/1.0.0/gen/MaterialComposition_en-open-api.json new file mode 100644 index 00000000..35bbf868 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.MaterialComposition/1.0.0/gen/MaterialComposition_en-open-api.json @@ -0,0 +1,434 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "MaterialComposition", + "version": "v1.0.0", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#MaterialComposition" + }, + "servers": [ + { + "url": "https://example.com/api/v1.0.0", + "variables": { + "api-version": { + "default": "v1.0.0" + } + } + } + ], + "paths": { + "/null": { + "get": { + "tags": [ + "MaterialComposition" + ], + "operationId": "getMaterialComposition", + "parameters": [], + "responses": { + "200": { + "$ref": "#/components/responses/MaterialComposition" + }, + "401": { + "$ref": "#/components/responses/ClientError" + }, + "402": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFoundError" + } + } + }, + "post": { + "servers": [ + { + "url": "https://example.com/query-api/v1.0.0", + "variables": { + "api-version": { + "default": "v1.0.0" + } + } + } + ], + "tags": [ + "MaterialComposition" + ], + "operationId": "postMaterialComposition", + "parameters": [], + "requestBody": { + "$ref": "#/components/requestBodies/Filter" + }, + "responses": { + "200": { + "$ref": "#/components/responses/MaterialComposition" + }, + "401": { + "$ref": "#/components/responses/ClientError" + }, + "402": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFoundError" + } + } + } + } + }, + "components": { + "schemas": { + "ErrorResponse": { + "type": "object", + "required": [ + "error" + ], + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + } + }, + "Error": { + "type": "object", + "required": [ + "details" + ], + "properties": { + "message": { + "type": "string", + "minLength": 1 + }, + "path": { + "type": "string", + "minLength": 1 + }, + "details": { + "type": "object", + "minLength": 1, + "additionalProperties": { + "type": "object" + } + }, + "code": { + "type": "string", + "nullable": true + } + } + }, + "Filter": { + "type": "object", + "required": [ + "filter" + ], + "properties": { + "filter": { + "type": "string", + "description": "The filter to use.", + "example": "filter={filter expression}" + }, + "option": { + "type": "string", + "description": "The option for the filter.", + "example": "option=limit({start},{count})" + } + } + }, + "CriticalRawMaterialsList": { + "description": "'Critical raw materials contained in the battery above a concentration of 0.1 % weight by weight. Reference to COM(2020)474: ?Those raw materials that are most important economically and have a high supply risk?. The fourth list of critical raw materials for the EU lists 30 raw materials as critical in 2020. An updated version has been included in Annex II of the EU Critical Raw Materials Act Regulation (CRMA)\n\nEUBR: Annex XIII (1b) ? Annex VI Part A (10)", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CriticalRawMaterialsList", + "type": "array", + "items": { + "type": "string" + } + }, + "Text": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#Text", + "description": "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." + }, + "Text0": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text", + "description": "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." + }, + "BatteryChemistry": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#BatteryChemistry", + "type": "object", + "properties": { + "shortName": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#shortName", + "$ref": "#/components/schemas/Text" + }, + "clearName": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#clearName", + "$ref": "#/components/schemas/Text0" + } + }, + "required": [ + "shortName", + "clearName" + ] + }, + "BatteryChemistryEntityList": { + "description": "Detailed composition, including materials used in the cathode, anode, and electrolyte.\nAll common cells have two electrodes and an electrolyte. The specific combination of materials used to make these components is called \"chemistry.\" A cell's chemistry largely determines its properties, while most variations within it are caused by additives, purification, and design elements.\n\nEUBR: Annex XIII (1b) ? Annex VI Part A (7)", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#BatteryChemistryEntityList", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BatteryChemistry" + } + ] + }, + "BatteryComponent": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#BatteryComponent", + "type": "object", + "properties": { + "componentName": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#componentName", + "$ref": "#/components/schemas/Text0" + }, + "componentId": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#componentId", + "$ref": "#/components/schemas/Text0" + } + }, + "required": [ + "componentName" + ] + }, + "BatteryMaterialLocation": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#BatteryMaterialLocation", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BatteryComponent" + } + ] + }, + "MaterialIdentifierTrait": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#MaterialIdentifierTrait", + "description": "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.", + "pattern": "\\d{4}-\\d{2}-\\d" + }, + "Weight": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#Weight" + }, + "BatteryMaterial": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#BatteryMaterial", + "type": "object", + "properties": { + "batteryMaterialLocation": { + "description": "Battery component that relates to the material", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#batteryMaterialLocation", + "$ref": "#/components/schemas/BatteryMaterialLocation" + }, + "materialIdentifier": { + "description": "CAS Number ", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#materialIdentifier", + "$ref": "#/components/schemas/MaterialIdentifierTrait" + }, + "batteryMaterialName": { + "description": "Clear name of Material", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#batteryMaterialName", + "$ref": "#/components/schemas/Text" + }, + "batteryMaterialWeight": { + "description": "Weight of component material", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#batteryMaterialWeight", + "$ref": "#/components/schemas/Weight" + } + }, + "required": [ + "batteryMaterialLocation", + "materialIdentifier", + "batteryMaterialName", + "batteryMaterialWeight" + ] + }, + "BatteryMaterialList": { + "description": "Detailed composition, including materials used in the cathode, anode, and electrolyte\n\nEUBR: Annex XIII (2a)", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#BatteryMaterialList", + "type": "array", + "items": { + "$ref": "#/components/schemas/BatteryMaterial" + } + }, + "HazardousSubstanceClassChrateristicEnum": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#HazardousSubstanceClassChrateristicEnum", + "enum": [ + "AcuteToxicity", + "SkinCorrosionOrIrritation", + "EyeDamageOrIrritation" + ] + }, + "HazardousSubstanceConcentrationCharacteristic": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#HazardousSubstanceConcentrationCharacteristic" + }, + "ImpactList": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#ImpactList", + "type": "array", + "items": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#Text", + "description": "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." + } + }, + "HubstanceSubstanceLocationEntity": { + "description": "\"The impact of substances, in particular, hazardous substances, contained in batteries on the environment and on human health or safety of persons, including impact due to inappropriate discarding of waste batteries such as littering or discarding as unsorted municipal waste?.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#HubstanceSubstanceLocationEntity", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BatteryComponent" + } + ] + }, + "HazardousSubstance": { + "description": "Hazardous substances (No. 19-23): Name (agreed substance nomenclature, e.g. IUPAC or chemical name) all hazardous substance (as ?any substance that poses a threat to human health and the environment?). Suggested above 0.1 % weight by weight within each (sub-)component.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#HazardousSubstance", + "type": "object", + "properties": { + "hazardousSubstanceClass": { + "description": "Battery Regulation narrows reporting to substances falling under defined hazard classes and categories of the CLP regulation.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#hazardousSubstanceClass", + "$ref": "#/components/schemas/HazardousSubstanceClassChrateristicEnum" + }, + "hazardousSubstanceName": { + "description": "Clear name of hazardous substance", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#hazardousSubstanceName", + "$ref": "#/components/schemas/Text" + }, + "hazardousSubstanceConcentration": { + "description": "Concentration of hazardous substance", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#hazardousSubstanceConcentration", + "$ref": "#/components/schemas/HazardousSubstanceConcentrationCharacteristic" + }, + "hazardousSubstanceImpact": { + "description": "Impact statements based on, e.g., REACH or GHS for all hazard classes applicable to substances in the battery.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#hazardousSubstanceImpact", + "$ref": "#/components/schemas/ImpactList" + }, + "hazardousSubstanceLocation": { + "description": "Hazardous substances (No. 19-23): Location on a (sub-)component-level of all hazardous substances (as ?any substance that poses a threat to human health and the environment?). Suggested via a unique identifier or nomenclature.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#hazardousSubstanceLocation", + "$ref": "#/components/schemas/HubstanceSubstanceLocationEntity" + }, + "hazardousSubstanceIdentifier": { + "description": "CAS identifier of hazardous substance", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#hazardousSubstanceIdentifier", + "$ref": "#/components/schemas/MaterialIdentifierTrait" + } + }, + "required": [ + "hazardousSubstanceClass", + "hazardousSubstanceName", + "hazardousSubstanceConcentration", + "hazardousSubstanceImpact", + "hazardousSubstanceLocation", + "hazardousSubstanceIdentifier" + ] + }, + "HazardousSubstancesList": { + "description": "Hazardous substances contained in the battery other than mercury, cadmium or lead. Substance as a chemical element and its compounds in the natural state or the result of a manufacturing process (ECHA). Battery Regulation narrows reporting to substances falling under defined hazard classes and categories of the CLP regulation.\n\nEUBR: Annex XIII (1b) ? Annex VI Part A (8)", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#HazardousSubstancesList", + "type": "array", + "items": { + "$ref": "#/components/schemas/HazardousSubstance" + } + }, + "MaterialComposition": { + "description": "Mandatory data: Battery chemistry; critical raw materials; materials used in the cathode, anode, and \nelectrolyte; hazardous substances; impact of substances on the environment and on human health or \nsafety\n\nCopyright © 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution.", + "type": "object", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#MaterialComposition", + "properties": { + "criticalRawMaterials": { + "description": "Raw materials being economically important and vulnerable to supply disruption. List of the Commission is subject to updating, at least every three years to reflect production, market and technological developments. The latest list will be made available via the Raw Materials Information System (RMIS) of the EU Science Hub. In the battery passport, all critical raw materials above a concentration of 0.1 % weight by weight within each (sub)-component of the battery should be specified in an aggregated way for the entire battery. For anode, cathode, and electrolyte critical raw materials can be derived from \"cathode materials\", \"anode materials\", and \"electrolyte materials\".", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#criticalRawMaterials", + "$ref": "#/components/schemas/CriticalRawMaterialsList" + }, + "productChemistry": { + "description": "Composition of a product in general terms by specifying the cathode and anode active material as well as electrolyte.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#productChemistry", + "$ref": "#/components/schemas/BatteryChemistryEntityList" + }, + "batteryMaterials": { + "description": "\"Component materials used\" (No. 17.a-c): Naming the materials (as a composition of substances) in cathode, anode, electrolyte according to public standards, including specification of the corresponding component (i.e., cathode, anode, or electrolyte). We suggest a reporting threshold of 0.1 % weight by weight.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#batteryMaterials", + "$ref": "#/components/schemas/BatteryMaterialList" + }, + "hazardousSubstances": { + "description": "\"Hazardous substances\" (No 20.a-e): Name (agreed substance nomenclature, e.g. IUPAC or chemical name) all hazardous substance (as ?any substance that poses a threat to human health and the environment?). Suggested above 0.1 % weight by weight within each (sub-)component.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#hazardousSubstances", + "$ref": "#/components/schemas/HazardousSubstancesList" + } + }, + "required": [ + "criticalRawMaterials", + "productChemistry", + "batteryMaterials", + "hazardousSubstances" + ] + } + }, + "responses": { + "Unauthorized": { + "description": "The requesting user or client is not authenticated." + }, + "Forbidden": { + "description": "The requesting user or client is not authorized to access resources for the given tenant." + }, + "NotFoundError": { + "description": "The requested Twin has not been found." + }, + "ClientError": { + "description": "Payload or user input is invalid. See error details in the payload for more.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "MaterialComposition": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MaterialComposition" + } + } + }, + "description": "The request was successful." + } + }, + "requestBodies": { + "MaterialComposition": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MaterialComposition" + } + } + } + }, + "Filter": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Filter" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.Performance/1.0.0/PerformanceAndDurability.ttl b/SMARTENERGY/BatteriePass/io.BatteryPass.Performance/1.0.0/PerformanceAndDurability.ttl new file mode 100644 index 00000000..af9c96f8 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.Performance/1.0.0/PerformanceAndDurability.ttl @@ -0,0 +1,489 @@ +###################################################################### +# Copyright (c) 2024 Circulor GmbH on behalf of the Battery Pass Consortium +# +# 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 : . + +:PerformanceAndDurability a samm:Aspect ; + samm:description "Battery performance and durability data model\n\nCopyright ? 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution."@en ; + samm:properties ( :powerCapability :batteryLifetime :temperatureConditions :negativeEvents :technicalSpecification :internalResistance :roundtripEfficiency :dynamicAttribute ) ; + samm:operations ( ) ; + samm:events ( ) . + +:powerCapability a samm:Property ; + samm:description "This property covers all power capability related properties"@en ; + samm:characteristic :PowerCapability . + +:batteryLifetime a samm:Property ; + samm:description "'- Expected battery lifetime expressed in cycles, and reference test used.\n- Their expected life-time under the reference conditions for which they have been designed in terms of cycles, except for non-cycle applications, and calendar years."@en ; + samm:characteristic :BatteryLifetime . + +:temperatureConditions a samm:Property ; + samm:characteristic :TemperatureConditions . + +:negativeEvents a samm:Property ; + samm:characteristic :NegativeEvents . + +:technicalSpecification a samm:Property ; + samm:characteristic :TechnicalSpecification . + +:internalResistance a samm:Property ; + samm:characteristic :InternalResistance . + +:roundtripEfficiency a samm:Property ; + samm:characteristic :RoundtripEfficiency . + +:dynamicAttribute a samm:Property ; + samm:characteristic :DynamicAttribute . + +:PowerCapability a samm-c:SingleEntity ; + samm:dataType :PowerCapabilityEntity . + +:BatteryLifetime a samm-c:SingleEntity ; + samm:description "'- Expected battery lifetime expressed in cycles, and reference test used.\n- Their expected life-time under the reference conditions for which they have been designed in terms of cycles, except for non-cycle applications, and calendar years."@en ; + samm:dataType :BatteryLifetimeEntity . + +:TemperatureConditions a samm-c:SingleEntity ; + samm:dataType :TemperatureConditionsEntity . + +:NegativeEvents a samm-c:List ; + samm:dataType :NegativeEventEntity . + +:TechnicalSpecification a samm-c:SingleEntity ; + samm:dataType :TechnicalSpecifiationEntity . + +:InternalResistance a samm-c:SingleEntity ; + samm:dataType :InternalResistanceEntity . + +:RoundtripEfficiency a samm-c:SingleEntity ; + samm:dataType :RoundtripEfficiencyEntity . + +:DynamicAttribute a samm-c:SingleEntity ; + samm:dataType :DynamicAttributeEntity . + +:PowerCapabilityEntity a samm:Entity ; + samm:description "Covers all Capability related data attributes"@en ; + samm:properties ( :originalPowerCapability :remainingPowerCapability :powerCapabilityFade :maximumPermittedBatteryPower :powerCapabilityRatio ) . + +:BatteryLifetimeEntity a samm:Entity ; + samm:description "Covers all battery lifetime relevant properties"@en ; + samm:properties ( :lifetimeReferenceTest :energyThroughput :expectedNumberOfCycles :cRate :capacityThroughput :capacityThresholdExhaustion :soceThresholdForExhaustion :warrantyPeriod :putIntoService :ratedCapacity :numberOfFullCycles ) . + +:TemperatureConditionsEntity a samm:Entity ; + samm:properties ( :temperatureRangeIdleState :timeExtremeHighTemp :timeExtremeLowTemp ) . + +:NegativeEventEntity a samm:Entity ; + samm:properties ( :negativeEvent ) . + +:TechnicalSpecifiationEntity a samm:Entity ; + samm:properties ( :stateOfCertifiedEnergy :ubeCertified :ubeRemaining :initialSelfDischarge :remainingCapacity :capacityFade :stateOfCharge :nominalVoltage :minimumVoltage :maximumVoltage ) . + +:InternalResistanceEntity a samm:Entity ; + samm:properties ( :initialInternalResistancePack :currentInternalResistancePack ) . + +:RoundtripEfficiencyEntity a samm:Entity ; + samm:properties ( :initialSelfDischargingRate :currentSelfDischargingRate ) . + +:DynamicAttributeEntity a samm:Entity ; + samm:properties ( :lastUpdate ) . + +:originalPowerCapability a samm:Property ; + samm:description "Pre-use power capability: Definition of power capability as given in Battery Regulation. \nAnnex IV Part B, point 4 --> measurement at 80 % and 20 % SoC required. This requirement may not be implementable for remaining power capability and power fade(see below). It, thus, should be reviewed together with SoC definition."@en ; + samm:characteristic :OriginalPowerCapability . + +:remainingPowerCapability a samm:Property ; + samm:description "'- Original power capability (in Watts) and limits, with temperature range when relevant.\n- The amount of energy that a battery is capable to provide over a given period of time under reference conditions.\n- Power capability at 80% and 20% state of charge."@en ; + samm:characteristic :RemainingPowerCapability . + +:powerCapabilityFade a samm:Property ; + samm:description "'- Power fade? (in %) means the decrease over time and upon usage in the amount of power that a battery can deliver at the rated voltage.\n- Power capability at 80% and 20% state of charge."@en ; + samm:characteristic :PowerCapabilityFade . + +:maximumPermittedBatteryPower a samm:Property ; + samm:description "Maximum permitted power the battery is rated for, includes the data relevant for 'power limits'"@en ; + samm:characteristic :MaximumPermittedBatteryPower . + +:powerCapabilityRatio a samm:Property ; + samm:preferredName "PowerCapabilityRatio"@en ; + samm:description "Provides information on nominal/recommended charge rate (C-rate); equal to regulation definition."@en ; + samm:characteristic :PowerCapabilityRatio . + +:lifetimeReferenceTest a samm:Property ; + samm:description " Reference test that was used for investigation of number of full discharge cycles."@en ; + samm:characteristic samm-c:Text . + +:energyThroughput a samm:Property ; + samm:characteristic :EnergyThroughput . + +:expectedNumberOfCycles a samm:Property ; + samm:preferredName "ExpectedNumberOfCycles"@en ; + samm:description "Expected battery lifetime expressed in cycles.\nThe exception for non-cycle applications in Article 10 appears sensible, but is not included in the Annex XIII provision.\nThe data attribute is defined by measurement conditions of the cycle-life test such as the C-Rate (see below) and the depth of discharge in the cycle-life test"@en ; + samm:characteristic :ExpectedNumberOfCycles . + +:cRate a samm:Property ; + samm:characteristic :CRate . + +:capacityThroughput a samm:Property ; + samm:description "Overall sum of the capacity throughput over the battery lifetime.\nThe data attribute should be reported as measured for further potential processing. In addition, the normalisation by capacity could add a further useful value that ensures comparability among battery sizes."@en ; + samm:characteristic :CapacityThroughput . + +:capacityThresholdExhaustion a samm:Property ; + samm:description "Overall sum of the capacity throughput over the battery lifetime.\nThe data attribute should be reported as measured for further potential processing. In addition, the normalisation by capacity could add a further useful value that ensures comparability among battery sizes."@en ; + samm:characteristic :CapacityThresholdExhaustion . + +:soceThresholdForExhaustion a samm:Property ; + samm:description "Derived as analogue to, and potential future replacement of ?Capacity threshold for exhaustion?. Interpreted as minimum percentage of SOCE, above which the battery is still considered operational as EV battery in its current life. The value has to be provided by the economic operator. \nThe SOCE standard is only applicable to electric vehicle batteries.\nThis metric may serve as indicator for a necessary end of current life as EV and may be understood in the context of warranty. A clarified definition is required."@en ; + samm:characteristic :SOCEThresholdForExhaustion . + +:warrantyPeriod a samm:Property ; + samm:description "Warranty period of the battery.\nAlso includes the expected life-time under the reference conditions in calendar years.?"@en ; + samm:characteristic :WarrantyPeriod . + +:putIntoService a samm:Property ; + samm:description "Date of putting the battery into service."@en ; + samm:characteristic :Timestamp . + +:ratedCapacity a samm:Property ; + samm:description "Rated capacity means the total number of ampere-hours (Ah) that can be withdrawn from a fully charged battery under specific conditions; ?Capacity fade? means the decrease over time and upon usage in the amount of charge that a battery can deliver at the rated voltage, with respect to the original measured capacity."@en ; + samm:characteristic :RatedCapacity . + +:numberOfFullCycles a samm:Property ; + samm:description "Number of (full) charging and discharging cycles."@en ; + samm:characteristic :NumberOfFullCycles . + +:temperatureRangeIdleState a samm:Property ; + samm:description "Upper an lower boundary of the surrounding temperature range, which the battery can safely withstand. "@en ; + samm:characteristic :TemperatureRangeIdleStateTrait . + +:timeExtremeHighTemp a samm:Property ; + samm:description "Cumulated time spent above the given upper boundary of temperature."@en ; + samm:characteristic :TimeExtremeHighTemp . + +:timeExtremeLowTemp a samm:Property ; + samm:description "Cumulated time spent below the given lower boundary of temperature."@en ; + samm:characteristic :TimeExtremeLowTemp . + +:negativeEvent a samm:Property ; + samm:preferredName "Negative events, such as accidents. No further definition provided by regulation."@en ; + samm:characteristic :NegativeEventsList . + +:stateOfCertifiedEnergy a samm:Property ; + samm:preferredName "SOCE"@en ; + samm:description "Definition based on UNECE GTR 22: The measured or on-board UBE performance at a specific point in its lifetime, expressed as a percentage of the certified usable battery energy."@en ; + samm:characteristic :StateOfCertifiedEnergy . + +:ubeCertified a samm:Property ; + samm:description "Definition from UNECE GTR 22, applicable only to EVs.\nThe energy supplied by the battery from the beginning of the test procedure used for certification until the applicable break-off criterion of the test procedure used for certification is reached."@en ; + samm:characteristic :UBECertified . + +:ubeRemaining a samm:Property ; + samm:description "Definition from UNECE GTR 22, applicable only to EVs.\nThe energy supplied by the battery from the beginning of the test procedure used for certification until the applicable break-off criterion of the test procedure used for certification is reached."@en ; + samm:characteristic :UBERemaining . + +:initialSelfDischarge a samm:Property ; + samm:description "Initial self-discharge in % of capacity per unit of time in defined conditions (temperature range etc) as pre-use metric. "@en ; + samm:characteristic :InitialSelfDischarge . + +:remainingCapacity a samm:Property ; + samm:description "The in-use data attribute on capacity, corresponding with the definition of rated capacity."@en ; + samm:characteristic :RemainingCapacity . + +:capacityFade a samm:Property ; + samm:description "Capacity fade defined as per reulation: \"Decrease over time and upon usage in the amount of charge that a battery can deliver at the rated voltage, with respect to the original rated capacity declared by the manufacturer."@en ; + samm:characteristic :CapacityFade . + +:stateOfCharge a samm:Property ; + samm:preferredName "SoC"@en ; + samm:description "The Battery Pass consortium proposes to change the definition to: \"available capacity in a battery expressed as a percentage of remaining capacity\" to reflect use of SoC in practice. "@en ; + samm:characteristic :StateOfCharge . + +:nominalVoltage a samm:Property ; + samm:description "Nominal voltage the battery is rated for."@en ; + samm:characteristic :NominalVoltage . + +:minimumVoltage a samm:Property ; + samm:description "Minimum voltage the battery is rated for."@en ; + samm:characteristic :MinimumVoltage . + +:maximumVoltage a samm:Property ; + samm:description "Maximum voltage the battery is rated for."@en ; + samm:characteristic :MaximumVoltage . + +:initialInternalResistancePack a samm:Property ; + samm:description "Initial (Pre-Use) internal resistance on battery pack level. \n\nDefinition of internal resistance should differ from regulation definition, as \"opposition\" is not an electrotechnical term and may be based on IEV 131-12-04: \"internal resistance means the absolute value of the quotient of the voltage drop between the terminals by the electric current increase in the battery circuit during a current pulse\""@en ; + samm:characteristic :InitialInternalResistance . + +:currentInternalResistancePack a samm:Property ; + samm:characteristic :CurrentInternalResistance . + +:initialSelfDischargingRate a samm:Property ; + samm:characteristic :InitialSelfDischargingRate . + +:currentSelfDischargingRate a samm:Property ; + samm:characteristic :CurrentSelfDischargingRate . + +:lastUpdate a samm:Property ; + samm:characteristic samm-c:Timestamp . + +:OriginalPowerCapability a samm-c:List ; + samm:dataType :PowerCapabilityAtEntity . + +:RemainingPowerCapability a samm-c:List ; + samm:dataType :RemainingPowerCapabilityEntity . + +:PowerCapabilityFade a samm-c:Measurement ; + samm:description "'- Original power capability (in Watts) and limits, with temperature range when relevant.\n- The amount of energy that a battery is capable to provide over a given period of time under reference conditions.\n- Power capability at 80% and 20% state of charge."@en ; + samm:dataType xsd:float ; + samm-c:unit unit:percent . + +:MaximumPermittedBatteryPower a samm-c:Measurement ; + samm:dataType xsd:double ; + samm-c:unit unit:kilowatt . + +:PowerCapabilityRatio a samm-c:Measurement ; + samm:description "Ratio between nominal allowed battery power (W) and battery energy (Wh)."@en ; + samm:dataType xsd:float ; + samm-c:unit unit:percent . + +:EnergyThroughput a samm-c:Measurement ; + samm:dataType xsd:double ; + samm-c:unit unit:kilowattHour . + +:ExpectedNumberOfCycles a samm-c:Quantifiable ; + samm:dataType xsd:long . + +:CRate a samm-c:Quantifiable ; + samm:dataType xsd:float . + +:CapacityThroughput a samm-c:Measurement ; + samm:description "Capacity throughput."@en ; + samm:dataType xsd:double ; + samm-c:unit unit:ampereHour . + +:CapacityThresholdExhaustion a samm-c:Measurement ; + samm:dataType xsd:double ; + samm-c:unit unit:percent . + +:SOCEThresholdForExhaustion a samm-c:Measurement ; + samm:dataType xsd:double ; + samm-c:unit unit:percent . + +:WarrantyPeriod a samm-c:Measurement ; + samm:dataType xsd:double ; + samm-c:unit unit:year . + +:Timestamp a samm:Characteristic ; + samm:preferredName "Timestamp"@en ; + samm:description "Describes a Property which contains the date and time with an optional timezone."@en ; + samm:dataType xsd:dateTime . + +:RatedCapacity a samm-c:Measurement ; + samm:dataType xsd:float ; + samm-c:unit unit:ampereHour . + +:NumberOfFullCycles a samm-c:Measurement ; + samm:description "- Information and data as a result of its use, including the number of charging and discharging cycles."@en ; + samm:dataType xsd:float ; + samm-c:unit unit:cycle . + +:TemperatureRangeIdleStateTrait a samm-c:Trait ; + samm-c:baseCharacteristic :TemperatureRangeIdleState ; + samm-c:constraint :TemperatureRange . + +:TimeExtremeHighTemp a samm-c:Measurement ; + samm:dataType xsd:double ; + samm-c:unit unit:minuteUnitOfTime . + +:TimeExtremeLowTemp a samm-c:Measurement ; + samm:dataType xsd:double ; + samm-c:unit unit:minuteUnitOfTime . + +:NegativeEventsList a samm-c:List ; + samm:dataType xsd:string . + +:StateOfCertifiedEnergy a samm-c:Measurement ; + samm:dataType xsd:double ; + samm-c:unit unit:percent . + +:UBECertified a samm-c:Measurement ; + samm:dataType xsd:float ; + samm-c:unit unit:kilowattHour . + +:UBERemaining a samm-c:SingleEntity ; + samm:dataType :UBERemainingEntity . + +:InitialSelfDischarge a samm-c:Measurement ; + samm:description "vcbvb"@en ; + samm:dataType xsd:double ; + samm-c:unit unit:percent . + +:RemainingCapacity a samm-c:SingleEntity ; + samm:dataType :RemainingCapacityEntity . + +:CapacityFade a samm-c:SingleEntity ; + samm:dataType :CapacityFadeEntity . + +:StateOfCharge a samm-c:SingleEntity ; + samm:dataType :StateOfChargeEntity . + +:NominalVoltage a samm-c:Measurement ; + samm:description "s"@en ; + samm:dataType xsd:float ; + samm-c:unit unit:volt . + +:MinimumVoltage a samm-c:Measurement ; + samm:dataType xsd:float ; + samm-c:unit unit:volt . + +:MaximumVoltage a samm-c:Measurement ; + samm:dataType xsd:float ; + samm-c:unit unit:volt . + +:InitialInternalResistance a samm-c:Measurement ; + samm:dataType xsd:double ; + samm-c:unit unit:ohm . + +:CurrentInternalResistance a samm-c:SingleEntity ; + samm:dataType :CurrentInternalResistanceEntity . + +:InitialSelfDischargingRate a samm-c:Measurement ; + samm:dataType xsd:double ; + samm-c:unit unit:percentPerMonth . + +:CurrentSelfDischargingRate a samm-c:SingleEntity ; + samm:dataType :CurrentSelfDischargingRateEntity . + +:PowerCapabilityAtEntity a samm:Entity ; + samm:properties ( :atSoC :powerCapabilityAt ) . + +:RemainingPowerCapabilityEntity a samm:Entity ; + samm:extends :DynamicAttributeEntity ; + samm:properties ( :remainingPowerCapabilityValue ) . + +:TemperatureRangeIdleState a samm-c:Measurement ; + samm:dataType xsd:double ; + samm-c:unit unit:degreeCelsius . + +:TemperatureRange a samm-c:RangeConstraint ; + samm-c:minValue "-20.0"^^xsd:double ; + samm-c:maxValue "+60.0"^^xsd:double ; + samm-c:lowerBoundDefinition samm-c:AT_LEAST ; + samm-c:upperBoundDefinition samm-c:AT_MOST . + +:UBERemainingEntity a samm:Entity ; + samm:extends :DynamicAttributeEntity ; + samm:preferredName "UBERemainingEntity"@en ; + samm:properties ( :uBERemainingValue ) . + +:RemainingCapacityEntity a samm:Entity ; + samm:extends :DynamicAttributeEntity ; + samm:properties ( :remainingCapacityValue ) . + +:CapacityFadeEntity a samm:Entity ; + samm:extends :DynamicAttributeEntity ; + samm:properties ( :capacityFadeValue ) . + +:StateOfChargeEntity a samm:Entity ; + samm:extends :DynamicAttributeEntity ; + samm:properties ( :stateOfChargeValue ) . + +:CurrentInternalResistanceEntity a samm:Entity ; + samm:extends :DynamicAttributeEntity ; + samm:properties ( :currentInternalResistanceValue ) . + +:CurrentSelfDischargingRateEntity a samm:Entity ; + samm:extends :DynamicAttributeEntity ; + samm:properties ( :currentSelfDischargingRateEntity ) . + +:atSoC a samm:Property ; + samm:characteristic :AtSoC . + +:powerCapabilityAt a samm:Property ; + samm:characteristic :PowerCapabilityAtSoc . + +:remainingPowerCapabilityValue a samm:Property ; + samm:characteristic :RemainingPowerCapabilityValue . + +:uBERemainingValue a samm:Property ; + samm:characteristic :UBERemainingValue . + +:remainingCapacityValue a samm:Property ; + samm:characteristic :RemainingCapacityValue . + +:capacityFadeValue a samm:Property ; + samm:characteristic :CapacityFadeValue . + +:stateOfChargeValue a samm:Property ; + samm:characteristic :StateOfChargeValue . + +:currentInternalResistanceValue a samm:Property ; + samm:preferredName "Value"@en ; + samm:characteristic :CurrentInternalResistanceValue . + +:currentSelfDischargingRateEntity a samm:Property ; + samm:characteristic :CurrentSelfDischargingRateValue . + +:AtSoC a samm-c:Measurement ; + samm:dataType xsd:float ; + samm-c:unit unit:percent . + +:PowerCapabilityAtSoc a samm-c:Measurement ; + samm:dataType xsd:float ; + samm-c:unit unit:percent . + +:RemainingPowerCapabilityValue a samm-c:SingleEntity ; + samm:preferredName "RemainingPowerCapabilityValue"@en ; + samm:dataType :RemainingPowerCapabilityDynamicAt . + +:UBERemainingValue a samm-c:Measurement ; + samm:dataType xsd:float ; + samm-c:unit unit:kilowattHour . + +:RemainingCapacityValue a samm-c:Measurement ; + samm:dataType xsd:float ; + samm-c:unit unit:kilowattHour . + +:CapacityFadeValue a samm-c:Measurement ; + samm:dataType xsd:float ; + samm-c:unit unit:percent . + +:StateOfChargeValue a samm-c:Measurement ; + samm:preferredName "Value"@en ; + samm:dataType xsd:float ; + samm-c:unit unit:percent . + +:CurrentInternalResistanceValue a samm-c:Measurement ; + samm:dataType xsd:float ; + samm-c:unit unit:ohm . + +:CurrentSelfDischargingRateValue a samm-c:Measurement ; + samm:dataType xsd:float ; + samm-c:unit unit:percent . + +:RemainingPowerCapabilityDynamicAt a samm:Entity ; + samm:extends :PowerCapabilityAtEntity ; + samm:properties ( :rPCLastUpdated ) . + +:rPCLastUpdated a samm:Property ; + samm:characteristic samm-c:Timestamp . + +:lastUpdated a samm:Property ; + samm:characteristic :Timestamp . + diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.Performance/1.0.0/gen/PerformanceAndDurability-aas.xml b/SMARTENERGY/BatteriePass/io.BatteryPass.Performance/1.0.0/gen/PerformanceAndDurability-aas.xml new file mode 100644 index 00000000..1511572b --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.Performance/1.0.0/gen/PerformanceAndDurability-aas.xml @@ -0,0 +1,3289 @@ + + + + + defaultAdminShell + + + en + defaultAdminShell + + + + urn:samm:BatteryPass:1.0.0#PerformanceAndDurability + + Type + + + + ModelReference + + + Submodel + urn:samm:BatteryPass:1.0.0#PerformanceAndDurability/submodel + + + + + + + + + PerformanceAndDurability + + + en + Battery performance and durability data model + +Copyright � 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution. + + + + urn:samm:BatteryPass:1.0.0#PerformanceAndDurability/submodel + Template + + ModelReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#PerformanceAndDurability + + + + + + PowerCapabilityEntity + + + en + Covers all Capability related data attributes + + + + + originalPowerCapability + + + en + Pre-use power capability: Definition of power capability as given in Battery Regulation. +Annex IV Part B, point 4 --> measurement at 80 % and 20 % SoC required. This requirement may not be implementable for remaining power capability and power fade(see below). It, thus, should be reviewed together with SoC definition. + + + true + SubmodelElement + + + PowerCapabilityAtEntity + + + atSoC + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#atSoC + + + + xs:float + + + + powerCapabilityAt + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#powerCapabilityAt + + + + xs:float + + + + + + + + remainingPowerCapability + + + en + '- Original power capability (in Watts) and limits, with temperature range when relevant. +- The amount of energy that a battery is capable to provide over a given period of time under reference conditions. +- Power capability at 80% and 20% state of charge. + + + true + SubmodelElement + + + RemainingPowerCapabilityEntity + + + RemainingPowerCapabilityDynamicAt + + + rPCLastUpdated + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#rPCLastUpdated + + + + xs:dateTime + + + + atSoC + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#atSoC + + + + xs:float + + + + powerCapabilityAt + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#powerCapabilityAt + + + + xs:float + + + + + + lastUpdate + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#lastUpdate + + + + xs:dateTime + + + + + + + + powerCapabilityFade + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#powerCapabilityFade + + + + xs:float + + + + maximumPermittedBatteryPower + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#maximumPermittedBatteryPower + + + + xs:double + + + + powerCapabilityRatio + + + en + PowerCapabilityRatio + + + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#powerCapabilityRatio + + + + xs:float + + + + + + BatteryLifetimeEntity + + + en + Covers all battery lifetime relevant properties + + + + + lifetimeReferenceTest + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#lifetimeReferenceTest + + + + xs:string + + + + energyThroughput + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#energyThroughput + + + + xs:double + + + + expectedNumberOfCycles + + + en + ExpectedNumberOfCycles + + + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#expectedNumberOfCycles + + + + xs:long + + + + cRate + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#cRate + + + + xs:float + + + + capacityThroughput + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#capacityThroughput + + + + xs:double + + + + capacityThresholdExhaustion + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#capacityThresholdExhaustion + + + + xs:double + + + + soceThresholdForExhaustion + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#soceThresholdForExhaustion + + + + xs:double + + + + warrantyPeriod + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#warrantyPeriod + + + + xs:double + + + + putIntoService + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#putIntoService + + + + xs:dateTime + + + + ratedCapacity + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#ratedCapacity + + + + xs:float + + + + numberOfFullCycles + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#numberOfFullCycles + + + + xs:float + + + + + + TemperatureConditionsEntity + + + temperatureRangeIdleState + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#temperatureRangeIdleState + + + + xs:double + + + + timeExtremeHighTemp + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#timeExtremeHighTemp + + + + xs:double + + + + timeExtremeLowTemp + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#timeExtremeLowTemp + + + + xs:double + + + + + + negativeEvents + true + SubmodelElement + + + NegativeEventEntity + + + negativeEvent + + + en + Negative events, such as accidents. No further definition provided by regulation. + + + true + SubmodelElement + + + negativeEvent + + + en + Negative events, such as accidents. No further definition provided by regulation. + + + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#negativeEvent + + + + xs:string + + + + + + + + + + TechnicalSpecifiationEntity + + + stateOfCertifiedEnergy + + + en + SOCE + + + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#stateOfCertifiedEnergy + + + + xs:double + + + + ubeCertified + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#ubeCertified + + + + xs:float + + + + UBERemainingEntity + + + en + UBERemainingEntity + + + + + uBERemainingValue + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#uBERemainingValue + + + + xs:float + + + + lastUpdate + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#lastUpdate + + + + xs:dateTime + + + + + + initialSelfDischarge + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#initialSelfDischarge + + + + xs:double + + + + RemainingCapacityEntity + + + remainingCapacityValue + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#remainingCapacityValue + + + + xs:float + + + + lastUpdate + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#lastUpdate + + + + xs:dateTime + + + + + + CapacityFadeEntity + + + capacityFadeValue + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#capacityFadeValue + + + + xs:float + + + + lastUpdate + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#lastUpdate + + + + xs:dateTime + + + + + + StateOfChargeEntity + + + stateOfChargeValue + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#stateOfChargeValue + + + + xs:float + + + + lastUpdate + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#lastUpdate + + + + xs:dateTime + + + + + + nominalVoltage + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#nominalVoltage + + + + xs:float + + + + minimumVoltage + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#minimumVoltage + + + + xs:float + + + + maximumVoltage + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#maximumVoltage + + + + xs:float + + + + + + InternalResistanceEntity + + + initialInternalResistancePack + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#initialInternalResistancePack + + + + xs:double + + + + CurrentInternalResistanceEntity + + + currentInternalResistanceValue + + + en + Value + + + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#currentInternalResistanceValue + + + + xs:float + + + + lastUpdate + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#lastUpdate + + + + xs:dateTime + + + + + + + + RoundtripEfficiencyEntity + + + initialSelfDischargingRate + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#initialSelfDischargingRate + + + + xs:double + + + + CurrentSelfDischargingRateEntity + + + currentSelfDischargingRateEntity + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#currentSelfDischargingRateEntity + + + + xs:float + + + + lastUpdate + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#lastUpdate + + + + xs:dateTime + + + + + + + + DynamicAttributeEntity + + + lastUpdate + + ExternalReference + + + ConceptDescription + urn:samm:BatteryPass:1.0.0#lastUpdate + + + + xs:dateTime + + + + + + + + + + APPLICATION_CLASS + PerformanceAndDurability + + + en + Battery performance and durability data model + +Copyright � 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution. + + + urn:samm:BatteryPass:1.0.0#PerformanceAndDurability + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + PerformanceAndDurability + + + + + en + PerformanceAndDurability + + + + + en + Battery performance and durability data model + +Copyright � 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution. + + + + + + + + + atSoC + urn:samm:BatteryPass:1.0.0#atSoC + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + atSoC + + + + + en + atSoC + + + percent + REAL_MEASURE + + + + + + + powerCapabilityAt + urn:samm:BatteryPass:1.0.0#powerCapabilityAt + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + powerCapabilityAt + + + + + en + powerCapabilityAt + + + percent + REAL_MEASURE + + + + + + + originalPowerCapability + urn:samm:BatteryPass:1.0.0#originalPowerCapability + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + originalPowerCapability + + + + + en + originalPowerCapability + + + STRING + + + en + Pre-use power capability: Definition of power capability as given in Battery Regulation. +Annex IV Part B, point 4 --> measurement at 80 % and 20 % SoC required. This requirement may not be implementable for remaining power capability and power fade(see below). It, thus, should be reviewed together with SoC definition. + + + + + + + + + rPCLastUpdated + urn:samm:BatteryPass:1.0.0#rPCLastUpdated + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + rPCLastUpdated + + + + + en + rPCLastUpdated + + + STRING + + + + + + + atSoC + urn:samm:BatteryPass:1.0.0#atSoC + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + atSoC + + + + + en + atSoC + + + REAL_MEASURE + + + + + + + powerCapabilityAt + urn:samm:BatteryPass:1.0.0#powerCapabilityAt + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + powerCapabilityAt + + + + + en + powerCapabilityAt + + + REAL_MEASURE + + + + + + + remainingPowerCapabilityValue + urn:samm:BatteryPass:1.0.0#remainingPowerCapabilityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + remainingPowerCapabilityValue + + + + + en + remainingPowerCapabilityValue + + + STRING + + + + + + + lastUpdate + urn:samm:BatteryPass:1.0.0#lastUpdate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + lastUpdate + + + + + en + lastUpdate + + + STRING + + + + + + + remainingPowerCapability + urn:samm:BatteryPass:1.0.0#remainingPowerCapability + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + remainingPowerCapability + + + + + en + remainingPowerCapability + + + STRING + + + en + '- Original power capability (in Watts) and limits, with temperature range when relevant. +- The amount of energy that a battery is capable to provide over a given period of time under reference conditions. +- Power capability at 80% and 20% state of charge. + + + + + + + + + powerCapabilityFade + urn:samm:BatteryPass:1.0.0#powerCapabilityFade + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + powerCapabilityFade + + + + + en + powerCapabilityFade + + + percent + REAL_MEASURE + + + en + '- Power fade? (in %) means the decrease over time and upon usage in the amount of power that a battery can deliver at the rated voltage. +- Power capability at 80% and 20% state of charge. + + + + + + + + + maximumPermittedBatteryPower + urn:samm:BatteryPass:1.0.0#maximumPermittedBatteryPower + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + maximumPermittedBatteryPower + + + + + en + maximumPermittedBatteryPower + + + kilowatt + REAL_MEASURE + + + en + Maximum permitted power the battery is rated for, includes the data relevant for 'power limits' + + + + + + + + + powerCapabilityRatio + + + en + PowerCapabilityRatio + + + urn:samm:BatteryPass:1.0.0#powerCapabilityRatio + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + PowerCapabilityRatio + + + + + en + powerCapabilityRatio + + + percent + REAL_MEASURE + + + en + Provides information on nominal/recommended charge rate (C-rate); equal to regulation definition. + + + + + + + + + powerCapability + urn:samm:BatteryPass:1.0.0#powerCapability + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + powerCapability + + + + + en + powerCapability + + + STRING + + + en + This property covers all power capability related properties + + + + + + + + + lifetimeReferenceTest + urn:samm:BatteryPass:1.0.0#lifetimeReferenceTest + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + lifetimeReferenceTest + + + + + en + lifetimeReferenceTest + + + STRING + + + en + Reference test that was used for investigation of number of full discharge cycles. + + + + + + + + + energyThroughput + urn:samm:BatteryPass:1.0.0#energyThroughput + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + energyThroughput + + + + + en + energyThroughput + + + kilowattHour + REAL_MEASURE + + + + + + + expectedNumberOfCycles + + + en + ExpectedNumberOfCycles + + + urn:samm:BatteryPass:1.0.0#expectedNumberOfCycles + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + ExpectedNumberOfCycles + + + + + en + expectedNumberOfCycles + + + INTEGER_COUNT + + + en + Expected battery lifetime expressed in cycles. +The exception for non-cycle applications in Article 10 appears sensible, but is not included in the Annex XIII provision. +The data attribute is defined by measurement conditions of the cycle-life test such as the C-Rate (see below) and the depth of discharge in the cycle-life test + + + + + + + + + cRate + urn:samm:BatteryPass:1.0.0#cRate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + cRate + + + + + en + cRate + + + REAL_MEASURE + + + + + + + capacityThroughput + urn:samm:BatteryPass:1.0.0#capacityThroughput + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + capacityThroughput + + + + + en + capacityThroughput + + + ampereHour + REAL_MEASURE + + + en + Overall sum of the capacity throughput over the battery lifetime. +The data attribute should be reported as measured for further potential processing. In addition, the normalisation by capacity could add a further useful value that ensures comparability among battery sizes. + + + + + + + + + capacityThresholdExhaustion + urn:samm:BatteryPass:1.0.0#capacityThresholdExhaustion + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + capacityThresholdExhaustion + + + + + en + capacityThresholdExhaustion + + + percent + REAL_MEASURE + + + en + Overall sum of the capacity throughput over the battery lifetime. +The data attribute should be reported as measured for further potential processing. In addition, the normalisation by capacity could add a further useful value that ensures comparability among battery sizes. + + + + + + + + + soceThresholdForExhaustion + urn:samm:BatteryPass:1.0.0#soceThresholdForExhaustion + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + soceThresholdForExhaustion + + + + + en + soceThresholdForExhaustion + + + percent + REAL_MEASURE + + + en + Derived as analogue to, and potential future replacement of ?Capacity threshold for exhaustion?. Interpreted as minimum percentage of SOCE, above which the battery is still considered operational as EV battery in its current life. The value has to be provided by the economic operator. +The SOCE standard is only applicable to electric vehicle batteries. +This metric may serve as indicator for a necessary end of current life as EV and may be understood in the context of warranty. A clarified definition is required. + + + + + + + + + warrantyPeriod + urn:samm:BatteryPass:1.0.0#warrantyPeriod + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + warrantyPeriod + + + + + en + warrantyPeriod + + + year + REAL_MEASURE + + + en + Warranty period of the battery. +Also includes the expected life-time under the reference conditions in calendar years.? + + + + + + + + + putIntoService + urn:samm:BatteryPass:1.0.0#putIntoService + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + putIntoService + + + + + en + putIntoService + + + STRING + + + en + Date of putting the battery into service. + + + + + + + + + ratedCapacity + urn:samm:BatteryPass:1.0.0#ratedCapacity + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + ratedCapacity + + + + + en + ratedCapacity + + + ampereHour + REAL_MEASURE + + + en + Rated capacity means the total number of ampere-hours (Ah) that can be withdrawn from a fully charged battery under specific conditions; ?Capacity fade? means the decrease over time and upon usage in the amount of charge that a battery can deliver at the rated voltage, with respect to the original measured capacity. + + + + + + + + + numberOfFullCycles + urn:samm:BatteryPass:1.0.0#numberOfFullCycles + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + numberOfFullCycles + + + + + en + numberOfFullCycles + + + cycle + REAL_MEASURE + + + en + Number of (full) charging and discharging cycles. + + + + + + + + + batteryLifetime + urn:samm:BatteryPass:1.0.0#batteryLifetime + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + batteryLifetime + + + + + en + batteryLifetime + + + STRING + + + en + '- Expected battery lifetime expressed in cycles, and reference test used. +- Their expected life-time under the reference conditions for which they have been designed in terms of cycles, except for non-cycle applications, and calendar years. + + + + + + + + + temperatureRangeIdleState + urn:samm:BatteryPass:1.0.0#temperatureRangeIdleState + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + temperatureRangeIdleState + + + + + en + temperatureRangeIdleState + + + REAL_MEASURE + + + en + Upper an lower boundary of the surrounding temperature range, which the battery can safely withstand. + + + + + + + + + timeExtremeHighTemp + urn:samm:BatteryPass:1.0.0#timeExtremeHighTemp + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + timeExtremeHighTemp + + + + + en + timeExtremeHighTemp + + + minuteUnitOfTime + REAL_MEASURE + + + en + Cumulated time spent above the given upper boundary of temperature. + + + + + + + + + timeExtremeLowTemp + urn:samm:BatteryPass:1.0.0#timeExtremeLowTemp + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + timeExtremeLowTemp + + + + + en + timeExtremeLowTemp + + + minuteUnitOfTime + REAL_MEASURE + + + en + Cumulated time spent below the given lower boundary of temperature. + + + + + + + + + temperatureConditions + urn:samm:BatteryPass:1.0.0#temperatureConditions + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + temperatureConditions + + + + + en + temperatureConditions + + + STRING + + + + + + + negativeEvent + + + en + Negative events, such as accidents. No further definition provided by regulation. + + + urn:samm:BatteryPass:1.0.0#negativeEvent + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Negative events, such as accidents. No further definition provided by regulation. + + + + + en + negativeEvent + + + STRING + + + + + + + negativeEvents + urn:samm:BatteryPass:1.0.0#negativeEvents + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + negativeEvents + + + + + en + negativeEvents + + + STRING + + + + + + + stateOfCertifiedEnergy + + + en + SOCE + + + urn:samm:BatteryPass:1.0.0#stateOfCertifiedEnergy + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + SOCE + + + + + en + stateOfCertifiedEnergy + + + percent + REAL_MEASURE + + + en + Definition based on UNECE GTR 22: The measured or on-board UBE performance at a specific point in its lifetime, expressed as a percentage of the certified usable battery energy. + + + + + + + + + ubeCertified + urn:samm:BatteryPass:1.0.0#ubeCertified + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + ubeCertified + + + + + en + ubeCertified + + + kilowattHour + REAL_MEASURE + + + en + Definition from UNECE GTR 22, applicable only to EVs. +The energy supplied by the battery from the beginning of the test procedure used for certification until the applicable break-off criterion of the test procedure used for certification is reached. + + + + + + + + + uBERemainingValue + urn:samm:BatteryPass:1.0.0#uBERemainingValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + uBERemainingValue + + + + + en + uBERemainingValue + + + kilowattHour + REAL_MEASURE + + + + + + + lastUpdate + urn:samm:BatteryPass:1.0.0#lastUpdate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + lastUpdate + + + + + en + lastUpdate + + + STRING + + + + + + + ubeRemaining + urn:samm:BatteryPass:1.0.0#ubeRemaining + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + ubeRemaining + + + + + en + ubeRemaining + + + STRING + + + en + Definition from UNECE GTR 22, applicable only to EVs. +The energy supplied by the battery from the beginning of the test procedure used for certification until the applicable break-off criterion of the test procedure used for certification is reached. + + + + + + + + + initialSelfDischarge + urn:samm:BatteryPass:1.0.0#initialSelfDischarge + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + initialSelfDischarge + + + + + en + initialSelfDischarge + + + percent + REAL_MEASURE + + + en + Initial self-discharge in % of capacity per unit of time in defined conditions (temperature range etc) as pre-use metric. + + + + + + + + + remainingCapacityValue + urn:samm:BatteryPass:1.0.0#remainingCapacityValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + remainingCapacityValue + + + + + en + remainingCapacityValue + + + kilowattHour + REAL_MEASURE + + + + + + + lastUpdate + urn:samm:BatteryPass:1.0.0#lastUpdate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + lastUpdate + + + + + en + lastUpdate + + + STRING + + + + + + + remainingCapacity + urn:samm:BatteryPass:1.0.0#remainingCapacity + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + remainingCapacity + + + + + en + remainingCapacity + + + STRING + + + en + The in-use data attribute on capacity, corresponding with the definition of rated capacity. + + + + + + + + + capacityFadeValue + urn:samm:BatteryPass:1.0.0#capacityFadeValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + capacityFadeValue + + + + + en + capacityFadeValue + + + percent + REAL_MEASURE + + + + + + + lastUpdate + urn:samm:BatteryPass:1.0.0#lastUpdate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + lastUpdate + + + + + en + lastUpdate + + + STRING + + + + + + + capacityFade + urn:samm:BatteryPass:1.0.0#capacityFade + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + capacityFade + + + + + en + capacityFade + + + STRING + + + en + Capacity fade defined as per reulation: "Decrease over time and upon usage in the amount of charge that a battery can deliver at the rated voltage, with respect to the original rated capacity declared by the manufacturer. + + + + + + + + + stateOfChargeValue + urn:samm:BatteryPass:1.0.0#stateOfChargeValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + stateOfChargeValue + + + + + en + stateOfChargeValue + + + percent + REAL_MEASURE + + + + + + + lastUpdate + urn:samm:BatteryPass:1.0.0#lastUpdate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + lastUpdate + + + + + en + lastUpdate + + + STRING + + + + + + + stateOfCharge + + + en + SoC + + + urn:samm:BatteryPass:1.0.0#stateOfCharge + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + SoC + + + + + en + stateOfCharge + + + STRING + + + en + The Battery Pass consortium proposes to change the definition to: "available capacity in a battery expressed as a percentage of remaining capacity" to reflect use of SoC in practice. + + + + + + + + + nominalVoltage + urn:samm:BatteryPass:1.0.0#nominalVoltage + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + nominalVoltage + + + + + en + nominalVoltage + + + volt + REAL_MEASURE + + + en + Nominal voltage the battery is rated for. + + + + + + + + + minimumVoltage + urn:samm:BatteryPass:1.0.0#minimumVoltage + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + minimumVoltage + + + + + en + minimumVoltage + + + volt + REAL_MEASURE + + + en + Minimum voltage the battery is rated for. + + + + + + + + + maximumVoltage + urn:samm:BatteryPass:1.0.0#maximumVoltage + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + maximumVoltage + + + + + en + maximumVoltage + + + volt + REAL_MEASURE + + + en + Maximum voltage the battery is rated for. + + + + + + + + + technicalSpecification + urn:samm:BatteryPass:1.0.0#technicalSpecification + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + technicalSpecification + + + + + en + technicalSpecification + + + STRING + + + + + + + initialInternalResistancePack + urn:samm:BatteryPass:1.0.0#initialInternalResistancePack + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + initialInternalResistancePack + + + + + en + initialInternalResistancePack + + + ohm + REAL_MEASURE + + + en + Initial (Pre-Use) internal resistance on battery pack level. + +Definition of internal resistance should differ from regulation definition, as "opposition" is not an electrotechnical term and may be based on IEV 131-12-04: "internal resistance means the absolute value of the quotient of the voltage drop between the terminals by the electric current increase in the battery circuit during a current pulse" + + + + + + + + + currentInternalResistanceValue + + + en + Value + + + urn:samm:BatteryPass:1.0.0#currentInternalResistanceValue + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Value + + + + + en + currentInternalResistanceValue + + + ohm + REAL_MEASURE + + + + + + + lastUpdate + urn:samm:BatteryPass:1.0.0#lastUpdate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + lastUpdate + + + + + en + lastUpdate + + + STRING + + + + + + + currentInternalResistancePack + urn:samm:BatteryPass:1.0.0#currentInternalResistancePack + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + currentInternalResistancePack + + + + + en + currentInternalResistancePack + + + STRING + + + + + + + internalResistance + urn:samm:BatteryPass:1.0.0#internalResistance + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + internalResistance + + + + + en + internalResistance + + + STRING + + + + + + + initialSelfDischargingRate + urn:samm:BatteryPass:1.0.0#initialSelfDischargingRate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + initialSelfDischargingRate + + + + + en + initialSelfDischargingRate + + + percentPerMonth + REAL_MEASURE + + + + + + + currentSelfDischargingRateEntity + urn:samm:BatteryPass:1.0.0#currentSelfDischargingRateEntity + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + currentSelfDischargingRateEntity + + + + + en + currentSelfDischargingRateEntity + + + percent + REAL_MEASURE + + + + + + + lastUpdate + urn:samm:BatteryPass:1.0.0#lastUpdate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + lastUpdate + + + + + en + lastUpdate + + + STRING + + + + + + + currentSelfDischargingRate + urn:samm:BatteryPass:1.0.0#currentSelfDischargingRate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + currentSelfDischargingRate + + + + + en + currentSelfDischargingRate + + + STRING + + + + + + + roundtripEfficiency + urn:samm:BatteryPass:1.0.0#roundtripEfficiency + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + roundtripEfficiency + + + + + en + roundtripEfficiency + + + STRING + + + + + + + lastUpdate + urn:samm:BatteryPass:1.0.0#lastUpdate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + lastUpdate + + + + + en + lastUpdate + + + STRING + + + + + + + dynamicAttribute + urn:samm:BatteryPass:1.0.0#dynamicAttribute + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + dynamicAttribute + + + + + en + dynamicAttribute + + + STRING + + + + + + + diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.Performance/1.0.0/gen/PerformanceAndDurability-documentation.html b/SMARTENERGY/BatteriePass/io.BatteryPass.Performance/1.0.0/gen/PerformanceAndDurability-documentation.html new file mode 100644 index 00000000..79e722ae --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.Performance/1.0.0/gen/PerformanceAndDurability-documentation.html @@ -0,0 +1,946 @@ + + + + + + + + + + + + + + Documentation PerformanceAndDurability + + +
+
+
+
+

Aspect Model PerformanceAndDurability

+
urn:samm:io.BatteryPass.Performance:1.0.0#PerformanceAndDurability
+
+
+
+
+
+
+
+ +
+ + +
+ Battery performance and durability data model + +Copyright ? 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution. +
+ + +
+

Overview

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

Properties

+
+ +
+ +
+

batteryLifetime

+
+ +'- Expected battery lifetime expressed in cycles, and reference test used. +- Their expected life-time under the reference conditions for which they have been designed in terms of cycles, except for non-cycle applications, and calendar years. + +
+
Name
+
batteryLifetime
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.BatteryPass.Performance:1.0.0#BatteryLifetimeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
batteryLifetime
+
+ + +
+
+ +
+

dynamicAttribute

+
+ + +
+
Name
+
dynamicAttribute
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.BatteryPass.Performance:1.0.0#DynamicAttributeEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
dynamicAttribute
+
+ + +
+
+ +
+

internalResistance

+
+ + +
+
Name
+
internalResistance
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.BatteryPass.Performance:1.0.0#InternalResistanceEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
internalResistance
+
+ + +
+
+ +
+

negativeEvents

+
+ + +
+
Name
+
negativeEvents
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:io.BatteryPass.Performance:1.0.0#NegativeEventEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
negativeEvents
+
+ + +
+
+ +
+

powerCapability

+
+ +This property covers all power capability related properties + +
+
Name
+
powerCapability
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.BatteryPass.Performance:1.0.0#PowerCapabilityEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
powerCapability
+
+ + +
+
+ +
+

roundtripEfficiency

+
+ + +
+
Name
+
roundtripEfficiency
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.BatteryPass.Performance:1.0.0#RoundtripEfficiencyEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
roundtripEfficiency
+
+ + +
+
+ +
+

technicalSpecification

+
+ + +
+
Name
+
technicalSpecification
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.BatteryPass.Performance:1.0.0#TechnicalSpecifiationEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
technicalSpecification
+
+ + +
+
+ +
+

temperatureConditions

+
+ + +
+
Name
+
temperatureConditions
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.BatteryPass.Performance:1.0.0#TemperatureConditionsEntity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
temperatureConditions
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

BatteryLifetimeEntity

+
+
+ Covers all battery lifetime relevant properties +
+ +
+

Properties

+
+
+
+
+

CapacityFadeEntity

+
+
+ +
+ +
+

Properties

+
+
+
+
+

CurrentInternalResistanceEntity

+
+
+ +
+ +
+

Properties

+
+
+
+
+

CurrentSelfDischargingRateEntity

+
+
+ +
+ +
+

Properties

+
+
+
+
+

DynamicAttributeEntity

+
+
+ +
+ +
+

Properties

+
+
+
+
+

InternalResistanceEntity

+
+
+ +
+ +
+

Properties

+
+
+
+
+

NegativeEventEntity

+
+
+ +
+ +
+

Properties

+
+
+
+
+

PowerCapabilityAtEntity

+
+
+ +
+ +
+

Properties

+
+
+
+
+

PowerCapabilityEntity

+
+
+ Covers all Capability related data attributes +
+ +
+

Properties

+
+
+
+
+

RemainingCapacityEntity

+
+
+ +
+ +
+

Properties

+
+
+
+
+

RemainingPowerCapabilityDynamicAt

+
+
+ +
+ +
+

Properties

+
+
+
+
+

RemainingPowerCapabilityEntity

+
+
+ +
+ +
+

Properties

+
+
+
+
+

RoundtripEfficiencyEntity

+
+
+ +
+ +
+

Properties

+
+
+
+
+

StateOfChargeEntity

+
+
+ +
+ +
+

Properties

+
+
+
+
+

TechnicalSpecifiationEntity

+
+
+ +
+ +
+

Properties

+
+
+
+
+

TemperatureConditionsEntity

+
+
+ +
+ +
+

Properties

+
+
+
+
+

UBERemainingEntity

+
+
+ +
+ +
+

Properties

+
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.Performance/1.0.0/gen/PerformanceAndDurability-sample.json b/SMARTENERGY/BatteriePass/io.BatteryPass.Performance/1.0.0/gen/PerformanceAndDurability-sample.json new file mode 100644 index 00000000..f48c053d --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.Performance/1.0.0/gen/PerformanceAndDurability-sample.json @@ -0,0 +1,96 @@ +{ + "technicalSpecification": { + "nominalVoltage": 0, + "stateOfCharge": { + "stateOfChargeValue": 0, + "@type": "StateOfChargeEntity", + "lastUpdate": "2024-05-28T11:14:10.231+02:00" + }, + "maximumVoltage": 0, + "minimumVoltage": 0, + "initialSelfDischarge": 0, + "ubeCertified": 0, + "remainingCapacity": { + "remainingCapacityValue": 0, + "@type": "RemainingCapacityEntity", + "lastUpdate": "2024-05-28T11:14:10.231+02:00" + }, + "stateOfCertifiedEnergy": 0, + "ubeRemaining": { + "uBERemainingValue": 0, + "@type": "UBERemainingEntity", + "lastUpdate": "2024-05-28T11:14:10.230+02:00" + }, + "capacityFade": { + "@type": "CapacityFadeEntity", + "capacityFadeValue": 0, + "lastUpdate": "2024-05-28T11:14:10.231+02:00" + } + }, + "powerCapability": { + "originalPowerCapability": [ + { + "atSoC": 0, + "powerCapabilityAt": 0 + } + ], + "powerCapabilityRatio": 0, + "powerCapabilityFade": 0, + "remainingPowerCapability": [ + { + "remainingPowerCapabilityValue": { + "atSoC": 0, + "powerCapabilityAt": 0, + "rPCLastUpdated": "2024-05-28T11:14:10.229+02:00", + "@type": "RemainingPowerCapabilityDynamicAt" + }, + "lastUpdate": "2024-05-28T11:14:10.229+02:00" + } + ], + "maximumPermittedBatteryPower": 0 + }, + "internalResistance": { + "currentInternalResistancePack": { + "@type": "CurrentInternalResistanceEntity", + "currentInternalResistanceValue": 0, + "lastUpdate": "2024-05-28T11:14:10.231+02:00" + }, + "initialInternalResistancePack": 0 + }, + "roundtripEfficiency": { + "currentSelfDischargingRate": { + "currentSelfDischargingRateEntity": 0, + "@type": "CurrentSelfDischargingRateEntity", + "lastUpdate": "2024-05-28T11:14:10.231+02:00" + }, + "initialSelfDischargingRate": 0 + }, + "negativeEvents": [ + { + "negativeEvent": [ + "yedUsFwdkelQbxeTeQOvaScfqIOOmaa" + ] + } + ], + "temperatureConditions": { + "timeExtremeHighTemp": 0, + "temperatureRangeIdleState": 55.97384822471584, + "timeExtremeLowTemp": 0 + }, + "batteryLifetime": { + "energyThroughput": 0, + "ratedCapacity": 0, + "warrantyPeriod": 0, + "numberOfFullCycles": 0, + "capacityThresholdExhaustion": 0, + "putIntoService": "2024-05-28T11:14:10.230+02:00", + "lifetimeReferenceTest": "eOMtThyhVNLWUZNRcBaQKxI", + "cRate": 0, + "expectedNumberOfCycles": -3498709441132260400, + "capacityThroughput": 0, + "soceThresholdForExhaustion": 0 + }, + "dynamicAttribute": { + "lastUpdate": "2024-05-28T11:14:10.231+02:00" + } +} \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.Performance/1.0.0/gen/PerformanceAndDurability-schema.json b/SMARTENERGY/BatteriePass/io.BatteryPass.Performance/1.0.0/gen/PerformanceAndDurability-schema.json new file mode 100644 index 00000000..c283a248 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.Performance/1.0.0/gen/PerformanceAndDurability-schema.json @@ -0,0 +1,795 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#PerformanceAndDurability", + "description": "Battery performance and durability data model\n\nCopyright © 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution.", + "type": "object", + "components": { + "schemas": { + "AtSoC": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#AtSoC" + }, + "PowerCapabilityAtSoc": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#PowerCapabilityAtSoc" + }, + "PowerCapabilityAtEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#PowerCapabilityAtEntity", + "type": "object", + "properties": { + "atSoC": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#atSoC", + "$ref": "#/components/schemas/AtSoC" + }, + "powerCapabilityAt": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#powerCapabilityAt", + "$ref": "#/components/schemas/PowerCapabilityAtSoc" + } + }, + "required": [ + "atSoC", + "powerCapabilityAt" + ] + }, + "OriginalPowerCapability": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#OriginalPowerCapability", + "type": "array", + "items": { + "$ref": "#/components/schemas/PowerCapabilityAtEntity" + } + }, + "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))?", + "x-samm-aspect-model-urn": "urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp", + "description": "Describes a Property which contains the date and time with an optional timezone." + }, + "RemainingPowerCapabilityDynamicAt": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RemainingPowerCapabilityDynamicAt", + "type": "object", + "properties": { + "rPCLastUpdated": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#rPCLastUpdated", + "$ref": "#/components/schemas/Timestamp" + } + }, + "required": [ + "rPCLastUpdated" + ], + "allOf": [ + { + "$ref": "#/components/schemas/PowerCapabilityAtEntity" + } + ] + }, + "RemainingPowerCapabilityValue": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RemainingPowerCapabilityValue", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/RemainingPowerCapabilityDynamicAt" + } + ] + }, + "DynamicAttributeEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#DynamicAttributeEntity", + "type": "object", + "properties": { + "lastUpdate": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#lastUpdate", + "$ref": "#/components/schemas/Timestamp" + } + }, + "required": [ + "lastUpdate" + ] + }, + "RemainingPowerCapabilityEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RemainingPowerCapabilityEntity", + "type": "object", + "properties": { + "remainingPowerCapabilityValue": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#remainingPowerCapabilityValue", + "$ref": "#/components/schemas/RemainingPowerCapabilityValue" + } + }, + "required": [ + "remainingPowerCapabilityValue" + ], + "allOf": [ + { + "$ref": "#/components/schemas/DynamicAttributeEntity" + } + ] + }, + "RemainingPowerCapability": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RemainingPowerCapability", + "type": "array", + "items": { + "$ref": "#/components/schemas/RemainingPowerCapabilityEntity" + } + }, + "PowerCapabilityFade": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#PowerCapabilityFade", + "description": "'- Original power capability (in Watts) and limits, with temperature range when relevant.\n- The amount of energy that a battery is capable to provide over a given period of time under reference conditions.\n- Power capability at 80% and 20% state of charge." + }, + "MaximumPermittedBatteryPower": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#MaximumPermittedBatteryPower" + }, + "PowerCapabilityRatio": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#PowerCapabilityRatio", + "description": "Ratio between nominal allowed battery power (W) and battery energy (Wh)." + }, + "PowerCapabilityEntity": { + "description": "Covers all Capability related data attributes", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#PowerCapabilityEntity", + "type": "object", + "properties": { + "originalPowerCapability": { + "description": "Pre-use power capability: Definition of power capability as given in Battery Regulation. \nAnnex IV Part B, point 4 --> measurement at 80 % and 20 % SoC required. This requirement may not be implementable for remaining power capability and power fade(see below). It, thus, should be reviewed together with SoC definition.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#originalPowerCapability", + "$ref": "#/components/schemas/OriginalPowerCapability" + }, + "remainingPowerCapability": { + "description": "'- Original power capability (in Watts) and limits, with temperature range when relevant.\n- The amount of energy that a battery is capable to provide over a given period of time under reference conditions.\n- Power capability at 80% and 20% state of charge.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#remainingPowerCapability", + "$ref": "#/components/schemas/RemainingPowerCapability" + }, + "powerCapabilityFade": { + "description": "'- Power fade? (in %) means the decrease over time and upon usage in the amount of power that a battery can deliver at the rated voltage.\n- Power capability at 80% and 20% state of charge.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#powerCapabilityFade", + "$ref": "#/components/schemas/PowerCapabilityFade" + }, + "maximumPermittedBatteryPower": { + "description": "Maximum permitted power the battery is rated for, includes the data relevant for 'power limits'", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#maximumPermittedBatteryPower", + "$ref": "#/components/schemas/MaximumPermittedBatteryPower" + }, + "powerCapabilityRatio": { + "description": "Provides information on nominal/recommended charge rate (C-rate); equal to regulation definition.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#powerCapabilityRatio", + "$ref": "#/components/schemas/PowerCapabilityRatio" + } + }, + "required": [ + "originalPowerCapability", + "remainingPowerCapability", + "powerCapabilityFade", + "maximumPermittedBatteryPower", + "powerCapabilityRatio" + ] + }, + "PowerCapability": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#PowerCapability", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/PowerCapabilityEntity" + } + ] + }, + "Text": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text", + "description": "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." + }, + "EnergyThroughput": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#EnergyThroughput" + }, + "ExpectedNumberOfCycles": { + "type": "number", + "minimum": -9223372036854776000, + "maximum": 9223372036854776000, + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#ExpectedNumberOfCycles" + }, + "CRate": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CRate" + }, + "CapacityThroughput": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CapacityThroughput", + "description": "Capacity throughput." + }, + "CapacityThresholdExhaustion": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CapacityThresholdExhaustion" + }, + "SOCEThresholdForExhaustion": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#SOCEThresholdForExhaustion" + }, + "WarrantyPeriod": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#WarrantyPeriod" + }, + "Timestamp0": { + "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))?", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#Timestamp", + "description": "Describes a Property which contains the date and time with an optional timezone." + }, + "RatedCapacity": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RatedCapacity" + }, + "NumberOfFullCycles": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#NumberOfFullCycles", + "description": "- Information and data as a result of its use, including the number of charging and discharging cycles." + }, + "BatteryLifetimeEntity": { + "description": "Covers all battery lifetime relevant properties", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#BatteryLifetimeEntity", + "type": "object", + "properties": { + "lifetimeReferenceTest": { + "description": " Reference test that was used for investigation of number of full discharge cycles.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#lifetimeReferenceTest", + "$ref": "#/components/schemas/Text" + }, + "energyThroughput": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#energyThroughput", + "$ref": "#/components/schemas/EnergyThroughput" + }, + "expectedNumberOfCycles": { + "description": "Expected battery lifetime expressed in cycles.\nThe exception for non-cycle applications in Article 10 appears sensible, but is not included in the Annex XIII provision.\nThe data attribute is defined by measurement conditions of the cycle-life test such as the C-Rate (see below) and the depth of discharge in the cycle-life test", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#expectedNumberOfCycles", + "$ref": "#/components/schemas/ExpectedNumberOfCycles" + }, + "cRate": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#cRate", + "$ref": "#/components/schemas/CRate" + }, + "capacityThroughput": { + "description": "Overall sum of the capacity throughput over the battery lifetime.\nThe data attribute should be reported as measured for further potential processing. In addition, the normalisation by capacity could add a further useful value that ensures comparability among battery sizes.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#capacityThroughput", + "$ref": "#/components/schemas/CapacityThroughput" + }, + "capacityThresholdExhaustion": { + "description": "Overall sum of the capacity throughput over the battery lifetime.\nThe data attribute should be reported as measured for further potential processing. In addition, the normalisation by capacity could add a further useful value that ensures comparability among battery sizes.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#capacityThresholdExhaustion", + "$ref": "#/components/schemas/CapacityThresholdExhaustion" + }, + "soceThresholdForExhaustion": { + "description": "Derived as analogue to, and potential future replacement of ?Capacity threshold for exhaustion?. Interpreted as minimum percentage of SOCE, above which the battery is still considered operational as EV battery in its current life. The value has to be provided by the economic operator. \nThe SOCE standard is only applicable to electric vehicle batteries.\nThis metric may serve as indicator for a necessary end of current life as EV and may be understood in the context of warranty. A clarified definition is required.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#soceThresholdForExhaustion", + "$ref": "#/components/schemas/SOCEThresholdForExhaustion" + }, + "warrantyPeriod": { + "description": "Warranty period of the battery.\nAlso includes the expected life-time under the reference conditions in calendar years.?", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#warrantyPeriod", + "$ref": "#/components/schemas/WarrantyPeriod" + }, + "putIntoService": { + "description": "Date of putting the battery into service.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#putIntoService", + "$ref": "#/components/schemas/Timestamp0" + }, + "ratedCapacity": { + "description": "Rated capacity means the total number of ampere-hours (Ah) that can be withdrawn from a fully charged battery under specific conditions; ?Capacity fade? means the decrease over time and upon usage in the amount of charge that a battery can deliver at the rated voltage, with respect to the original measured capacity.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#ratedCapacity", + "$ref": "#/components/schemas/RatedCapacity" + }, + "numberOfFullCycles": { + "description": "Number of (full) charging and discharging cycles.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#numberOfFullCycles", + "$ref": "#/components/schemas/NumberOfFullCycles" + } + }, + "required": [ + "lifetimeReferenceTest", + "energyThroughput", + "expectedNumberOfCycles", + "cRate", + "capacityThroughput", + "capacityThresholdExhaustion", + "soceThresholdForExhaustion", + "warrantyPeriod", + "putIntoService", + "ratedCapacity", + "numberOfFullCycles" + ] + }, + "BatteryLifetime": { + "description": "'- Expected battery lifetime expressed in cycles, and reference test used.\n- Their expected life-time under the reference conditions for which they have been designed in terms of cycles, except for non-cycle applications, and calendar years.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#BatteryLifetime", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BatteryLifetimeEntity" + } + ] + }, + "TemperatureRangeIdleStateTrait": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#TemperatureRangeIdleStateTrait", + "maximum": 60, + "exclusiveMaximum": false, + "minimum": -20, + "exclusiveMinimum": false + }, + "TimeExtremeHighTemp": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#TimeExtremeHighTemp" + }, + "TimeExtremeLowTemp": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#TimeExtremeLowTemp" + }, + "TemperatureConditionsEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#TemperatureConditionsEntity", + "type": "object", + "properties": { + "temperatureRangeIdleState": { + "description": "Upper an lower boundary of the surrounding temperature range, which the battery can safely withstand. ", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#temperatureRangeIdleState", + "$ref": "#/components/schemas/TemperatureRangeIdleStateTrait" + }, + "timeExtremeHighTemp": { + "description": "Cumulated time spent above the given upper boundary of temperature.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#timeExtremeHighTemp", + "$ref": "#/components/schemas/TimeExtremeHighTemp" + }, + "timeExtremeLowTemp": { + "description": "Cumulated time spent below the given lower boundary of temperature.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#timeExtremeLowTemp", + "$ref": "#/components/schemas/TimeExtremeLowTemp" + } + }, + "required": [ + "temperatureRangeIdleState", + "timeExtremeHighTemp", + "timeExtremeLowTemp" + ] + }, + "TemperatureConditions": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#TemperatureConditions", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/TemperatureConditionsEntity" + } + ] + }, + "NegativeEventsList": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#NegativeEventsList", + "type": "array", + "items": { + "type": "string" + } + }, + "NegativeEventEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#NegativeEventEntity", + "type": "object", + "properties": { + "negativeEvent": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#negativeEvent", + "$ref": "#/components/schemas/NegativeEventsList" + } + }, + "required": [ + "negativeEvent" + ] + }, + "NegativeEvents": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#NegativeEvents", + "type": "array", + "items": { + "$ref": "#/components/schemas/NegativeEventEntity" + } + }, + "StateOfCertifiedEnergy": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#StateOfCertifiedEnergy" + }, + "UBECertified": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#UBECertified" + }, + "UBERemainingValue": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#UBERemainingValue" + }, + "UBERemainingEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#UBERemainingEntity", + "type": "object", + "properties": { + "uBERemainingValue": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#uBERemainingValue", + "$ref": "#/components/schemas/UBERemainingValue" + } + }, + "required": [ + "uBERemainingValue" + ], + "allOf": [ + { + "$ref": "#/components/schemas/DynamicAttributeEntity" + } + ] + }, + "UBERemaining": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#UBERemaining", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/UBERemainingEntity" + } + ] + }, + "InitialSelfDischarge": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#InitialSelfDischarge", + "description": "vcbvb" + }, + "RemainingCapacityValue": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RemainingCapacityValue" + }, + "RemainingCapacityEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RemainingCapacityEntity", + "type": "object", + "properties": { + "remainingCapacityValue": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#remainingCapacityValue", + "$ref": "#/components/schemas/RemainingCapacityValue" + } + }, + "required": [ + "remainingCapacityValue" + ], + "allOf": [ + { + "$ref": "#/components/schemas/DynamicAttributeEntity" + } + ] + }, + "RemainingCapacity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RemainingCapacity", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/RemainingCapacityEntity" + } + ] + }, + "CapacityFadeValue": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CapacityFadeValue" + }, + "CapacityFadeEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CapacityFadeEntity", + "type": "object", + "properties": { + "capacityFadeValue": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#capacityFadeValue", + "$ref": "#/components/schemas/CapacityFadeValue" + } + }, + "required": [ + "capacityFadeValue" + ], + "allOf": [ + { + "$ref": "#/components/schemas/DynamicAttributeEntity" + } + ] + }, + "CapacityFade": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CapacityFade", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/CapacityFadeEntity" + } + ] + }, + "StateOfChargeValue": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#StateOfChargeValue" + }, + "StateOfChargeEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#StateOfChargeEntity", + "type": "object", + "properties": { + "stateOfChargeValue": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#stateOfChargeValue", + "$ref": "#/components/schemas/StateOfChargeValue" + } + }, + "required": [ + "stateOfChargeValue" + ], + "allOf": [ + { + "$ref": "#/components/schemas/DynamicAttributeEntity" + } + ] + }, + "StateOfCharge": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#StateOfCharge", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/StateOfChargeEntity" + } + ] + }, + "NominalVoltage": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#NominalVoltage", + "description": "s" + }, + "MinimumVoltage": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#MinimumVoltage" + }, + "MaximumVoltage": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#MaximumVoltage" + }, + "TechnicalSpecifiationEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#TechnicalSpecifiationEntity", + "type": "object", + "properties": { + "stateOfCertifiedEnergy": { + "description": "Definition based on UNECE GTR 22: The measured or on-board UBE performance at a specific point in its lifetime, expressed as a percentage of the certified usable battery energy.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#stateOfCertifiedEnergy", + "$ref": "#/components/schemas/StateOfCertifiedEnergy" + }, + "ubeCertified": { + "description": "Definition from UNECE GTR 22, applicable only to EVs.\nThe energy supplied by the battery from the beginning of the test procedure used for certification until the applicable break-off criterion of the test procedure used for certification is reached.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#ubeCertified", + "$ref": "#/components/schemas/UBECertified" + }, + "ubeRemaining": { + "description": "Definition from UNECE GTR 22, applicable only to EVs.\nThe energy supplied by the battery from the beginning of the test procedure used for certification until the applicable break-off criterion of the test procedure used for certification is reached.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#ubeRemaining", + "$ref": "#/components/schemas/UBERemaining" + }, + "initialSelfDischarge": { + "description": "Initial self-discharge in % of capacity per unit of time in defined conditions (temperature range etc) as pre-use metric. ", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#initialSelfDischarge", + "$ref": "#/components/schemas/InitialSelfDischarge" + }, + "remainingCapacity": { + "description": "The in-use data attribute on capacity, corresponding with the definition of rated capacity.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#remainingCapacity", + "$ref": "#/components/schemas/RemainingCapacity" + }, + "capacityFade": { + "description": "Capacity fade defined as per reulation: \"Decrease over time and upon usage in the amount of charge that a battery can deliver at the rated voltage, with respect to the original rated capacity declared by the manufacturer.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#capacityFade", + "$ref": "#/components/schemas/CapacityFade" + }, + "stateOfCharge": { + "description": "The Battery Pass consortium proposes to change the definition to: \"available capacity in a battery expressed as a percentage of remaining capacity\" to reflect use of SoC in practice. ", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#stateOfCharge", + "$ref": "#/components/schemas/StateOfCharge" + }, + "nominalVoltage": { + "description": "Nominal voltage the battery is rated for.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#nominalVoltage", + "$ref": "#/components/schemas/NominalVoltage" + }, + "minimumVoltage": { + "description": "Minimum voltage the battery is rated for.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#minimumVoltage", + "$ref": "#/components/schemas/MinimumVoltage" + }, + "maximumVoltage": { + "description": "Maximum voltage the battery is rated for.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#maximumVoltage", + "$ref": "#/components/schemas/MaximumVoltage" + } + }, + "required": [ + "stateOfCertifiedEnergy", + "ubeCertified", + "ubeRemaining", + "initialSelfDischarge", + "remainingCapacity", + "capacityFade", + "stateOfCharge", + "nominalVoltage", + "minimumVoltage", + "maximumVoltage" + ] + }, + "TechnicalSpecification": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#TechnicalSpecification", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/TechnicalSpecifiationEntity" + } + ] + }, + "InitialInternalResistance": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#InitialInternalResistance" + }, + "CurrentInternalResistanceValue": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CurrentInternalResistanceValue" + }, + "CurrentInternalResistanceEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CurrentInternalResistanceEntity", + "type": "object", + "properties": { + "currentInternalResistanceValue": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#currentInternalResistanceValue", + "$ref": "#/components/schemas/CurrentInternalResistanceValue" + } + }, + "required": [ + "currentInternalResistanceValue" + ], + "allOf": [ + { + "$ref": "#/components/schemas/DynamicAttributeEntity" + } + ] + }, + "CurrentInternalResistance": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CurrentInternalResistance", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/CurrentInternalResistanceEntity" + } + ] + }, + "InternalResistanceEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#InternalResistanceEntity", + "type": "object", + "properties": { + "initialInternalResistancePack": { + "description": "Initial (Pre-Use) internal resistance on battery pack level. \n\nDefinition of internal resistance should differ from regulation definition, as \"opposition\" is not an electrotechnical term and may be based on IEV 131-12-04: \"internal resistance means the absolute value of the quotient of the voltage drop between the terminals by the electric current increase in the battery circuit during a current pulse\"", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#initialInternalResistancePack", + "$ref": "#/components/schemas/InitialInternalResistance" + }, + "currentInternalResistancePack": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#currentInternalResistancePack", + "$ref": "#/components/schemas/CurrentInternalResistance" + } + }, + "required": [ + "initialInternalResistancePack", + "currentInternalResistancePack" + ] + }, + "InternalResistance": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#InternalResistance", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/InternalResistanceEntity" + } + ] + }, + "InitialSelfDischargingRate": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#InitialSelfDischargingRate" + }, + "CurrentSelfDischargingRateValue": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CurrentSelfDischargingRateValue" + }, + "CurrentSelfDischargingRateEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CurrentSelfDischargingRateEntity", + "type": "object", + "properties": { + "currentSelfDischargingRateEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#currentSelfDischargingRateEntity", + "$ref": "#/components/schemas/CurrentSelfDischargingRateValue" + } + }, + "required": [ + "currentSelfDischargingRateEntity" + ], + "allOf": [ + { + "$ref": "#/components/schemas/DynamicAttributeEntity" + } + ] + }, + "CurrentSelfDischargingRate": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CurrentSelfDischargingRate", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/CurrentSelfDischargingRateEntity" + } + ] + }, + "RoundtripEfficiencyEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RoundtripEfficiencyEntity", + "type": "object", + "properties": { + "initialSelfDischargingRate": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#initialSelfDischargingRate", + "$ref": "#/components/schemas/InitialSelfDischargingRate" + }, + "currentSelfDischargingRate": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#currentSelfDischargingRate", + "$ref": "#/components/schemas/CurrentSelfDischargingRate" + } + }, + "required": [ + "initialSelfDischargingRate", + "currentSelfDischargingRate" + ] + }, + "RoundtripEfficiency": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RoundtripEfficiency", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/RoundtripEfficiencyEntity" + } + ] + }, + "DynamicAttribute": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#DynamicAttribute", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/DynamicAttributeEntity" + } + ] + } + } + }, + "properties": { + "powerCapability": { + "description": "This property covers all power capability related properties", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#powerCapability", + "$ref": "#/components/schemas/PowerCapability" + }, + "batteryLifetime": { + "description": "'- Expected battery lifetime expressed in cycles, and reference test used.\n- Their expected life-time under the reference conditions for which they have been designed in terms of cycles, except for non-cycle applications, and calendar years.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#batteryLifetime", + "$ref": "#/components/schemas/BatteryLifetime" + }, + "temperatureConditions": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#temperatureConditions", + "$ref": "#/components/schemas/TemperatureConditions" + }, + "negativeEvents": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#negativeEvents", + "$ref": "#/components/schemas/NegativeEvents" + }, + "technicalSpecification": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#technicalSpecification", + "$ref": "#/components/schemas/TechnicalSpecification" + }, + "internalResistance": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#internalResistance", + "$ref": "#/components/schemas/InternalResistance" + }, + "roundtripEfficiency": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#roundtripEfficiency", + "$ref": "#/components/schemas/RoundtripEfficiency" + }, + "dynamicAttribute": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#dynamicAttribute", + "$ref": "#/components/schemas/DynamicAttribute" + } + }, + "required": [ + "powerCapability", + "batteryLifetime", + "temperatureConditions", + "negativeEvents", + "technicalSpecification", + "internalResistance", + "roundtripEfficiency", + "dynamicAttribute" + ] +} \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.Performance/1.0.0/gen/PerformanceAndDurability_en-async-api.json b/SMARTENERGY/BatteriePass/io.BatteryPass.Performance/1.0.0/gen/PerformanceAndDurability_en-async-api.json new file mode 100644 index 00000000..8220e432 --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.Performance/1.0.0/gen/PerformanceAndDurability_en-async-api.json @@ -0,0 +1,28 @@ +{ + "asyncapi": "3.0.0", + "id": "", + "info": { + "title": "PerformanceAndDurability MQTT API", + "version": "v1.0.0", + "description": "Battery performance and durability data model\n\nCopyright © 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#PerformanceAndDurability" + }, + "defaultContentType": "application/json", + "channels": { + "PerformanceAndDurability": { + "address": "/BatteryPass/1.0.0/PerformanceAndDurability", + "description": "This channel for updating PerformanceAndDurability Aspect.", + "parameters": { + "namespace": "BatteryPass", + "version": "1.0.0", + "aspect-name": "PerformanceAndDurability" + }, + "messages": {} + } + }, + "operations": {}, + "components": { + "messages": {}, + "schemas": {} + } +} \ No newline at end of file diff --git a/SMARTENERGY/BatteriePass/io.BatteryPass.Performance/1.0.0/gen/PerformanceAndDurability_en-open-api.json b/SMARTENERGY/BatteriePass/io.BatteryPass.Performance/1.0.0/gen/PerformanceAndDurability_en-open-api.json new file mode 100644 index 00000000..16c997dc --- /dev/null +++ b/SMARTENERGY/BatteriePass/io.BatteryPass.Performance/1.0.0/gen/PerformanceAndDurability_en-open-api.json @@ -0,0 +1,984 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "PerformanceAndDurability", + "version": "v1.0.0", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#PerformanceAndDurability" + }, + "servers": [ + { + "url": "https://example.com/api/v1.0.0", + "variables": { + "api-version": { + "default": "v1.0.0" + } + } + } + ], + "paths": { + "/null": { + "get": { + "tags": [ + "PerformanceAndDurability" + ], + "operationId": "getPerformanceAndDurability", + "parameters": [], + "responses": { + "200": { + "$ref": "#/components/responses/PerformanceAndDurability" + }, + "401": { + "$ref": "#/components/responses/ClientError" + }, + "402": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFoundError" + } + } + }, + "post": { + "servers": [ + { + "url": "https://example.com/query-api/v1.0.0", + "variables": { + "api-version": { + "default": "v1.0.0" + } + } + } + ], + "tags": [ + "PerformanceAndDurability" + ], + "operationId": "postPerformanceAndDurability", + "parameters": [], + "requestBody": { + "$ref": "#/components/requestBodies/Filter" + }, + "responses": { + "200": { + "$ref": "#/components/responses/PerformanceAndDurability" + }, + "401": { + "$ref": "#/components/responses/ClientError" + }, + "402": { + "$ref": "#/components/responses/Unauthorized" + }, + "403": { + "$ref": "#/components/responses/Forbidden" + }, + "404": { + "$ref": "#/components/responses/NotFoundError" + } + } + } + } + }, + "components": { + "schemas": { + "ErrorResponse": { + "type": "object", + "required": [ + "error" + ], + "properties": { + "error": { + "$ref": "#/components/schemas/Error" + } + } + }, + "Error": { + "type": "object", + "required": [ + "details" + ], + "properties": { + "message": { + "type": "string", + "minLength": 1 + }, + "path": { + "type": "string", + "minLength": 1 + }, + "details": { + "type": "object", + "minLength": 1, + "additionalProperties": { + "type": "object" + } + }, + "code": { + "type": "string", + "nullable": true + } + } + }, + "Filter": { + "type": "object", + "required": [ + "filter" + ], + "properties": { + "filter": { + "type": "string", + "description": "The filter to use.", + "example": "filter={filter expression}" + }, + "option": { + "type": "string", + "description": "The option for the filter.", + "example": "option=limit({start},{count})" + } + } + }, + "AtSoC": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#AtSoC" + }, + "PowerCapabilityAtSoc": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#PowerCapabilityAtSoc" + }, + "PowerCapabilityAtEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#PowerCapabilityAtEntity", + "type": "object", + "properties": { + "atSoC": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#atSoC", + "$ref": "#/components/schemas/AtSoC" + }, + "powerCapabilityAt": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#powerCapabilityAt", + "$ref": "#/components/schemas/PowerCapabilityAtSoc" + } + }, + "required": [ + "atSoC", + "powerCapabilityAt" + ] + }, + "OriginalPowerCapability": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#OriginalPowerCapability", + "type": "array", + "items": { + "$ref": "#/components/schemas/PowerCapabilityAtEntity" + } + }, + "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))?", + "x-samm-aspect-model-urn": "urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp", + "description": "Describes a Property which contains the date and time with an optional timezone." + }, + "RemainingPowerCapabilityDynamicAt": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RemainingPowerCapabilityDynamicAt", + "type": "object", + "properties": { + "rPCLastUpdated": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#rPCLastUpdated", + "$ref": "#/components/schemas/Timestamp" + } + }, + "required": [ + "rPCLastUpdated" + ], + "allOf": [ + { + "$ref": "#/components/schemas/PowerCapabilityAtEntity" + } + ] + }, + "RemainingPowerCapabilityValue": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RemainingPowerCapabilityValue", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/RemainingPowerCapabilityDynamicAt" + } + ] + }, + "DynamicAttributeEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#DynamicAttributeEntity", + "type": "object", + "properties": { + "lastUpdate": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#lastUpdate", + "$ref": "#/components/schemas/Timestamp" + } + }, + "required": [ + "lastUpdate" + ] + }, + "RemainingPowerCapabilityEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RemainingPowerCapabilityEntity", + "type": "object", + "properties": { + "remainingPowerCapabilityValue": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#remainingPowerCapabilityValue", + "$ref": "#/components/schemas/RemainingPowerCapabilityValue" + } + }, + "required": [ + "remainingPowerCapabilityValue" + ], + "allOf": [ + { + "$ref": "#/components/schemas/DynamicAttributeEntity" + } + ] + }, + "RemainingPowerCapability": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RemainingPowerCapability", + "type": "array", + "items": { + "$ref": "#/components/schemas/RemainingPowerCapabilityEntity" + } + }, + "PowerCapabilityFade": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#PowerCapabilityFade", + "description": "'- Original power capability (in Watts) and limits, with temperature range when relevant.\n- The amount of energy that a battery is capable to provide over a given period of time under reference conditions.\n- Power capability at 80% and 20% state of charge." + }, + "MaximumPermittedBatteryPower": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#MaximumPermittedBatteryPower" + }, + "PowerCapabilityRatio": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#PowerCapabilityRatio", + "description": "Ratio between nominal allowed battery power (W) and battery energy (Wh)." + }, + "PowerCapabilityEntity": { + "description": "Covers all Capability related data attributes", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#PowerCapabilityEntity", + "type": "object", + "properties": { + "originalPowerCapability": { + "description": "Pre-use power capability: Definition of power capability as given in Battery Regulation. \nAnnex IV Part B, point 4 --> measurement at 80 % and 20 % SoC required. This requirement may not be implementable for remaining power capability and power fade(see below). It, thus, should be reviewed together with SoC definition.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#originalPowerCapability", + "$ref": "#/components/schemas/OriginalPowerCapability" + }, + "remainingPowerCapability": { + "description": "'- Original power capability (in Watts) and limits, with temperature range when relevant.\n- The amount of energy that a battery is capable to provide over a given period of time under reference conditions.\n- Power capability at 80% and 20% state of charge.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#remainingPowerCapability", + "$ref": "#/components/schemas/RemainingPowerCapability" + }, + "powerCapabilityFade": { + "description": "'- Power fade? (in %) means the decrease over time and upon usage in the amount of power that a battery can deliver at the rated voltage.\n- Power capability at 80% and 20% state of charge.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#powerCapabilityFade", + "$ref": "#/components/schemas/PowerCapabilityFade" + }, + "maximumPermittedBatteryPower": { + "description": "Maximum permitted power the battery is rated for, includes the data relevant for 'power limits'", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#maximumPermittedBatteryPower", + "$ref": "#/components/schemas/MaximumPermittedBatteryPower" + }, + "powerCapabilityRatio": { + "description": "Provides information on nominal/recommended charge rate (C-rate); equal to regulation definition.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#powerCapabilityRatio", + "$ref": "#/components/schemas/PowerCapabilityRatio" + } + }, + "required": [ + "originalPowerCapability", + "remainingPowerCapability", + "powerCapabilityFade", + "maximumPermittedBatteryPower", + "powerCapabilityRatio" + ] + }, + "PowerCapability": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#PowerCapability", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/PowerCapabilityEntity" + } + ] + }, + "Text": { + "type": "string", + "x-samm-aspect-model-urn": "urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text", + "description": "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc." + }, + "EnergyThroughput": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#EnergyThroughput" + }, + "ExpectedNumberOfCycles": { + "type": "number", + "minimum": -9223372036854776000, + "maximum": 9223372036854776000, + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#ExpectedNumberOfCycles" + }, + "CRate": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CRate" + }, + "CapacityThroughput": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CapacityThroughput", + "description": "Capacity throughput." + }, + "CapacityThresholdExhaustion": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CapacityThresholdExhaustion" + }, + "SOCEThresholdForExhaustion": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#SOCEThresholdForExhaustion" + }, + "WarrantyPeriod": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#WarrantyPeriod" + }, + "Timestamp0": { + "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))?", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#Timestamp", + "description": "Describes a Property which contains the date and time with an optional timezone." + }, + "RatedCapacity": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RatedCapacity" + }, + "NumberOfFullCycles": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#NumberOfFullCycles", + "description": "- Information and data as a result of its use, including the number of charging and discharging cycles." + }, + "BatteryLifetimeEntity": { + "description": "Covers all battery lifetime relevant properties", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#BatteryLifetimeEntity", + "type": "object", + "properties": { + "lifetimeReferenceTest": { + "description": " Reference test that was used for investigation of number of full discharge cycles.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#lifetimeReferenceTest", + "$ref": "#/components/schemas/Text" + }, + "energyThroughput": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#energyThroughput", + "$ref": "#/components/schemas/EnergyThroughput" + }, + "expectedNumberOfCycles": { + "description": "Expected battery lifetime expressed in cycles.\nThe exception for non-cycle applications in Article 10 appears sensible, but is not included in the Annex XIII provision.\nThe data attribute is defined by measurement conditions of the cycle-life test such as the C-Rate (see below) and the depth of discharge in the cycle-life test", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#expectedNumberOfCycles", + "$ref": "#/components/schemas/ExpectedNumberOfCycles" + }, + "cRate": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#cRate", + "$ref": "#/components/schemas/CRate" + }, + "capacityThroughput": { + "description": "Overall sum of the capacity throughput over the battery lifetime.\nThe data attribute should be reported as measured for further potential processing. In addition, the normalisation by capacity could add a further useful value that ensures comparability among battery sizes.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#capacityThroughput", + "$ref": "#/components/schemas/CapacityThroughput" + }, + "capacityThresholdExhaustion": { + "description": "Overall sum of the capacity throughput over the battery lifetime.\nThe data attribute should be reported as measured for further potential processing. In addition, the normalisation by capacity could add a further useful value that ensures comparability among battery sizes.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#capacityThresholdExhaustion", + "$ref": "#/components/schemas/CapacityThresholdExhaustion" + }, + "soceThresholdForExhaustion": { + "description": "Derived as analogue to, and potential future replacement of ?Capacity threshold for exhaustion?. Interpreted as minimum percentage of SOCE, above which the battery is still considered operational as EV battery in its current life. The value has to be provided by the economic operator. \nThe SOCE standard is only applicable to electric vehicle batteries.\nThis metric may serve as indicator for a necessary end of current life as EV and may be understood in the context of warranty. A clarified definition is required.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#soceThresholdForExhaustion", + "$ref": "#/components/schemas/SOCEThresholdForExhaustion" + }, + "warrantyPeriod": { + "description": "Warranty period of the battery.\nAlso includes the expected life-time under the reference conditions in calendar years.?", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#warrantyPeriod", + "$ref": "#/components/schemas/WarrantyPeriod" + }, + "putIntoService": { + "description": "Date of putting the battery into service.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#putIntoService", + "$ref": "#/components/schemas/Timestamp0" + }, + "ratedCapacity": { + "description": "Rated capacity means the total number of ampere-hours (Ah) that can be withdrawn from a fully charged battery under specific conditions; ?Capacity fade? means the decrease over time and upon usage in the amount of charge that a battery can deliver at the rated voltage, with respect to the original measured capacity.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#ratedCapacity", + "$ref": "#/components/schemas/RatedCapacity" + }, + "numberOfFullCycles": { + "description": "Number of (full) charging and discharging cycles.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#numberOfFullCycles", + "$ref": "#/components/schemas/NumberOfFullCycles" + } + }, + "required": [ + "lifetimeReferenceTest", + "energyThroughput", + "expectedNumberOfCycles", + "cRate", + "capacityThroughput", + "capacityThresholdExhaustion", + "soceThresholdForExhaustion", + "warrantyPeriod", + "putIntoService", + "ratedCapacity", + "numberOfFullCycles" + ] + }, + "BatteryLifetime": { + "description": "'- Expected battery lifetime expressed in cycles, and reference test used.\n- Their expected life-time under the reference conditions for which they have been designed in terms of cycles, except for non-cycle applications, and calendar years.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#BatteryLifetime", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BatteryLifetimeEntity" + } + ] + }, + "TemperatureRangeIdleStateTrait": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#TemperatureRangeIdleStateTrait", + "maximum": 60, + "exclusiveMaximum": false, + "minimum": -20, + "exclusiveMinimum": false + }, + "TimeExtremeHighTemp": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#TimeExtremeHighTemp" + }, + "TimeExtremeLowTemp": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#TimeExtremeLowTemp" + }, + "TemperatureConditionsEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#TemperatureConditionsEntity", + "type": "object", + "properties": { + "temperatureRangeIdleState": { + "description": "Upper an lower boundary of the surrounding temperature range, which the battery can safely withstand. ", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#temperatureRangeIdleState", + "$ref": "#/components/schemas/TemperatureRangeIdleStateTrait" + }, + "timeExtremeHighTemp": { + "description": "Cumulated time spent above the given upper boundary of temperature.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#timeExtremeHighTemp", + "$ref": "#/components/schemas/TimeExtremeHighTemp" + }, + "timeExtremeLowTemp": { + "description": "Cumulated time spent below the given lower boundary of temperature.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#timeExtremeLowTemp", + "$ref": "#/components/schemas/TimeExtremeLowTemp" + } + }, + "required": [ + "temperatureRangeIdleState", + "timeExtremeHighTemp", + "timeExtremeLowTemp" + ] + }, + "TemperatureConditions": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#TemperatureConditions", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/TemperatureConditionsEntity" + } + ] + }, + "NegativeEventsList": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#NegativeEventsList", + "type": "array", + "items": { + "type": "string" + } + }, + "NegativeEventEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#NegativeEventEntity", + "type": "object", + "properties": { + "negativeEvent": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#negativeEvent", + "$ref": "#/components/schemas/NegativeEventsList" + } + }, + "required": [ + "negativeEvent" + ] + }, + "NegativeEvents": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#NegativeEvents", + "type": "array", + "items": { + "$ref": "#/components/schemas/NegativeEventEntity" + } + }, + "StateOfCertifiedEnergy": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#StateOfCertifiedEnergy" + }, + "UBECertified": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#UBECertified" + }, + "UBERemainingValue": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#UBERemainingValue" + }, + "UBERemainingEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#UBERemainingEntity", + "type": "object", + "properties": { + "uBERemainingValue": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#uBERemainingValue", + "$ref": "#/components/schemas/UBERemainingValue" + } + }, + "required": [ + "uBERemainingValue" + ], + "allOf": [ + { + "$ref": "#/components/schemas/DynamicAttributeEntity" + } + ] + }, + "UBERemaining": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#UBERemaining", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/UBERemainingEntity" + } + ] + }, + "InitialSelfDischarge": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#InitialSelfDischarge", + "description": "vcbvb" + }, + "RemainingCapacityValue": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RemainingCapacityValue" + }, + "RemainingCapacityEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RemainingCapacityEntity", + "type": "object", + "properties": { + "remainingCapacityValue": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#remainingCapacityValue", + "$ref": "#/components/schemas/RemainingCapacityValue" + } + }, + "required": [ + "remainingCapacityValue" + ], + "allOf": [ + { + "$ref": "#/components/schemas/DynamicAttributeEntity" + } + ] + }, + "RemainingCapacity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RemainingCapacity", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/RemainingCapacityEntity" + } + ] + }, + "CapacityFadeValue": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CapacityFadeValue" + }, + "CapacityFadeEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CapacityFadeEntity", + "type": "object", + "properties": { + "capacityFadeValue": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#capacityFadeValue", + "$ref": "#/components/schemas/CapacityFadeValue" + } + }, + "required": [ + "capacityFadeValue" + ], + "allOf": [ + { + "$ref": "#/components/schemas/DynamicAttributeEntity" + } + ] + }, + "CapacityFade": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CapacityFade", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/CapacityFadeEntity" + } + ] + }, + "StateOfChargeValue": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#StateOfChargeValue" + }, + "StateOfChargeEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#StateOfChargeEntity", + "type": "object", + "properties": { + "stateOfChargeValue": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#stateOfChargeValue", + "$ref": "#/components/schemas/StateOfChargeValue" + } + }, + "required": [ + "stateOfChargeValue" + ], + "allOf": [ + { + "$ref": "#/components/schemas/DynamicAttributeEntity" + } + ] + }, + "StateOfCharge": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#StateOfCharge", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/StateOfChargeEntity" + } + ] + }, + "NominalVoltage": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#NominalVoltage", + "description": "s" + }, + "MinimumVoltage": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#MinimumVoltage" + }, + "MaximumVoltage": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#MaximumVoltage" + }, + "TechnicalSpecifiationEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#TechnicalSpecifiationEntity", + "type": "object", + "properties": { + "stateOfCertifiedEnergy": { + "description": "Definition based on UNECE GTR 22: The measured or on-board UBE performance at a specific point in its lifetime, expressed as a percentage of the certified usable battery energy.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#stateOfCertifiedEnergy", + "$ref": "#/components/schemas/StateOfCertifiedEnergy" + }, + "ubeCertified": { + "description": "Definition from UNECE GTR 22, applicable only to EVs.\nThe energy supplied by the battery from the beginning of the test procedure used for certification until the applicable break-off criterion of the test procedure used for certification is reached.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#ubeCertified", + "$ref": "#/components/schemas/UBECertified" + }, + "ubeRemaining": { + "description": "Definition from UNECE GTR 22, applicable only to EVs.\nThe energy supplied by the battery from the beginning of the test procedure used for certification until the applicable break-off criterion of the test procedure used for certification is reached.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#ubeRemaining", + "$ref": "#/components/schemas/UBERemaining" + }, + "initialSelfDischarge": { + "description": "Initial self-discharge in % of capacity per unit of time in defined conditions (temperature range etc) as pre-use metric. ", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#initialSelfDischarge", + "$ref": "#/components/schemas/InitialSelfDischarge" + }, + "remainingCapacity": { + "description": "The in-use data attribute on capacity, corresponding with the definition of rated capacity.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#remainingCapacity", + "$ref": "#/components/schemas/RemainingCapacity" + }, + "capacityFade": { + "description": "Capacity fade defined as per reulation: \"Decrease over time and upon usage in the amount of charge that a battery can deliver at the rated voltage, with respect to the original rated capacity declared by the manufacturer.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#capacityFade", + "$ref": "#/components/schemas/CapacityFade" + }, + "stateOfCharge": { + "description": "The Battery Pass consortium proposes to change the definition to: \"available capacity in a battery expressed as a percentage of remaining capacity\" to reflect use of SoC in practice. ", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#stateOfCharge", + "$ref": "#/components/schemas/StateOfCharge" + }, + "nominalVoltage": { + "description": "Nominal voltage the battery is rated for.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#nominalVoltage", + "$ref": "#/components/schemas/NominalVoltage" + }, + "minimumVoltage": { + "description": "Minimum voltage the battery is rated for.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#minimumVoltage", + "$ref": "#/components/schemas/MinimumVoltage" + }, + "maximumVoltage": { + "description": "Maximum voltage the battery is rated for.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#maximumVoltage", + "$ref": "#/components/schemas/MaximumVoltage" + } + }, + "required": [ + "stateOfCertifiedEnergy", + "ubeCertified", + "ubeRemaining", + "initialSelfDischarge", + "remainingCapacity", + "capacityFade", + "stateOfCharge", + "nominalVoltage", + "minimumVoltage", + "maximumVoltage" + ] + }, + "TechnicalSpecification": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#TechnicalSpecification", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/TechnicalSpecifiationEntity" + } + ] + }, + "InitialInternalResistance": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#InitialInternalResistance" + }, + "CurrentInternalResistanceValue": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CurrentInternalResistanceValue" + }, + "CurrentInternalResistanceEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CurrentInternalResistanceEntity", + "type": "object", + "properties": { + "currentInternalResistanceValue": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#currentInternalResistanceValue", + "$ref": "#/components/schemas/CurrentInternalResistanceValue" + } + }, + "required": [ + "currentInternalResistanceValue" + ], + "allOf": [ + { + "$ref": "#/components/schemas/DynamicAttributeEntity" + } + ] + }, + "CurrentInternalResistance": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CurrentInternalResistance", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/CurrentInternalResistanceEntity" + } + ] + }, + "InternalResistanceEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#InternalResistanceEntity", + "type": "object", + "properties": { + "initialInternalResistancePack": { + "description": "Initial (Pre-Use) internal resistance on battery pack level. \n\nDefinition of internal resistance should differ from regulation definition, as \"opposition\" is not an electrotechnical term and may be based on IEV 131-12-04: \"internal resistance means the absolute value of the quotient of the voltage drop between the terminals by the electric current increase in the battery circuit during a current pulse\"", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#initialInternalResistancePack", + "$ref": "#/components/schemas/InitialInternalResistance" + }, + "currentInternalResistancePack": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#currentInternalResistancePack", + "$ref": "#/components/schemas/CurrentInternalResistance" + } + }, + "required": [ + "initialInternalResistancePack", + "currentInternalResistancePack" + ] + }, + "InternalResistance": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#InternalResistance", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/InternalResistanceEntity" + } + ] + }, + "InitialSelfDischargingRate": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#InitialSelfDischargingRate" + }, + "CurrentSelfDischargingRateValue": { + "type": "number", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CurrentSelfDischargingRateValue" + }, + "CurrentSelfDischargingRateEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CurrentSelfDischargingRateEntity", + "type": "object", + "properties": { + "currentSelfDischargingRateEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#currentSelfDischargingRateEntity", + "$ref": "#/components/schemas/CurrentSelfDischargingRateValue" + } + }, + "required": [ + "currentSelfDischargingRateEntity" + ], + "allOf": [ + { + "$ref": "#/components/schemas/DynamicAttributeEntity" + } + ] + }, + "CurrentSelfDischargingRate": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#CurrentSelfDischargingRate", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/CurrentSelfDischargingRateEntity" + } + ] + }, + "RoundtripEfficiencyEntity": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RoundtripEfficiencyEntity", + "type": "object", + "properties": { + "initialSelfDischargingRate": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#initialSelfDischargingRate", + "$ref": "#/components/schemas/InitialSelfDischargingRate" + }, + "currentSelfDischargingRate": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#currentSelfDischargingRate", + "$ref": "#/components/schemas/CurrentSelfDischargingRate" + } + }, + "required": [ + "initialSelfDischargingRate", + "currentSelfDischargingRate" + ] + }, + "RoundtripEfficiency": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#RoundtripEfficiency", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/RoundtripEfficiencyEntity" + } + ] + }, + "DynamicAttribute": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#DynamicAttribute", + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/DynamicAttributeEntity" + } + ] + }, + "PerformanceAndDurability": { + "description": "Battery performance and durability data model\n\nCopyright © 2024 Circulor (for and on behalf of the Battery Pass Consortium). This work is li-censed under a Creative Commons License Attribution-NonCommercial 4.0 International (CC BY-NC 4.0). Readers may reproduce material for their own publications, as long as it is not sold com-mercially and is given appropriate attribution.", + "type": "object", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#PerformanceAndDurability", + "properties": { + "powerCapability": { + "description": "This property covers all power capability related properties", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#powerCapability", + "$ref": "#/components/schemas/PowerCapability" + }, + "batteryLifetime": { + "description": "'- Expected battery lifetime expressed in cycles, and reference test used.\n- Their expected life-time under the reference conditions for which they have been designed in terms of cycles, except for non-cycle applications, and calendar years.", + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#batteryLifetime", + "$ref": "#/components/schemas/BatteryLifetime" + }, + "temperatureConditions": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#temperatureConditions", + "$ref": "#/components/schemas/TemperatureConditions" + }, + "negativeEvents": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#negativeEvents", + "$ref": "#/components/schemas/NegativeEvents" + }, + "technicalSpecification": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#technicalSpecification", + "$ref": "#/components/schemas/TechnicalSpecification" + }, + "internalResistance": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#internalResistance", + "$ref": "#/components/schemas/InternalResistance" + }, + "roundtripEfficiency": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#roundtripEfficiency", + "$ref": "#/components/schemas/RoundtripEfficiency" + }, + "dynamicAttribute": { + "x-samm-aspect-model-urn": "urn:samm:BatteryPass:1.0.0#dynamicAttribute", + "$ref": "#/components/schemas/DynamicAttribute" + } + }, + "required": [ + "powerCapability", + "batteryLifetime", + "temperatureConditions", + "negativeEvents", + "technicalSpecification", + "internalResistance", + "roundtripEfficiency", + "dynamicAttribute" + ] + } + }, + "responses": { + "Unauthorized": { + "description": "The requesting user or client is not authenticated." + }, + "Forbidden": { + "description": "The requesting user or client is not authorized to access resources for the given tenant." + }, + "NotFoundError": { + "description": "The requested Twin has not been found." + }, + "ClientError": { + "description": "Payload or user input is invalid. See error details in the payload for more.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "PerformanceAndDurability": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PerformanceAndDurability" + } + } + }, + "description": "The request was successful." + } + }, + "requestBodies": { + "PerformanceAndDurability": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PerformanceAndDurability" + } + } + } + }, + "Filter": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Filter" + } + } + } + } + } + } +} \ No newline at end of file