Welcome to the Battery Pass Data Model repository! This project provides a comprehensive data model based on the Battery Pass Content Guidance, aimed at standardizing and streamlining the exchange of battery-related information across the value chain.
Details
The Battery Pass Data Model is designed to facilitate the digital representation of battery-related data, ensuring compliance with industry standards and regulatory requirements. This model supports the efficient exchange of data between various stakeholders in the battery lifecycle, including manufacturers, suppliers, recyclers, and regulators. The content of the data model is derived from the Battery Pass Project Data Point List
- Standardized Data Representation: Ensures uniformity in the way battery data is recorded and shared.
- Comprehensive Coverage: Includes all critical aspects of battery data as specified in the Battery Pass Content Guidance.
- Scalability: Suitable for use in projects of varying scales, from small businesses to large enterprises.
- Interoperability: Facilitates seamless data exchange between different systems and platforms.
To use the Battery Pass Data Model, you can clone the repository and integrate it into your project. Ensure you have Git installed.
git clone https://github.com/batterypass/BatteryPassDataModel.git
cd BatteryPassDataModelTo incorporate the data model into your application, follow these steps:
-
Clone the Repository:
git clone https://github.com/batterypass/BatteryPassDataModel.git
-
Import the Data Model: Integrate the provided data model definitions into your database or application schema. Refer to the documentation in the
/docsdirectory for detailed description of the battery pass data attributes. -
Customize as Needed: Adapt the data model to fit your specific requirements. Ensure any modifications remain compliant with the Battery Pass Content Guidance.
The data model is organized into several parameter categories, each representing a different dedicated aspect of battery data, that can be composed to a complete battery pass data model. Below is a high-level overview. You'll find a detailed list with descriptions of the individual data points in the /doc folder. Follow the links for the different data attribute categories for further information on the individual sub-models.
- General Product Information:
- Battery ID
- Manufacturer
- Battery status
- Production Date
Class Diagram |
 Sample JSON |
 JSON Schema |
 OpenAPI Spec |
|---|
- Carbon Footprint:
- Battery Carbon footprint
- Carbon footprint of different lifecycle stages of the battery
- Carbon footprint study and perfromance class
Class Diagram |
Sample JSON |
JSON Schema |
OpenAPI Spec |
|---|
- Circularity:
- End of live management
- Safety requirements
- Recycled and renewable content
Class Diagram |
Sample JSON |
JSON Schema |
OpenAPI Spec |
|---|
- Material Composition:
- Battery chemistry
- Critical raw materials
- Hazardous substances
Class Diagram |
Sample JSON |
JSON Schema |
OpenAPI Spec |
|---|
- Performance & Durability:
- Static performance KPIs (Capacity, power capibility, etc. )
- Dynamic performance KPI (SoH, full charge cycles, )
- Negative events
Class Diagram |
Sample JSON |
JSON Schema |
OpenAPI Spec |
|---|
- Labels and Certification:
- Declaration of conformity
- Labels (Separate collection, materials)
- Test reports
Class Diagram |
Sample JSON |
JSON Schema |
OpenAPI Spec |
|---|
- Due Diligence
- Third party verifications
- Sustainability report
Class Diagram |
Sample JSON |
JSON Schema |
OpenAPI Spec |
|---|
Detailed schema definitions and relationships between entities are provided in the /BatteryPass directory.
For the compilation of the data model schema, the Eclipse Semantic Modeling Framework was used, that provides a meta model for data modelling for data exchange purpose that build upon the Resource Description Framework (RDF) and its compact textual syntax called Turtle (*.ttl). In each sub model schema folder you'll find the corresponding Turtle file and a ./gen folder that includes several derivations of the data model in differnet formats:
- JSON-Schema (
*-schema.json) - JSON-Payload(
*-sample.json) - OpenAPI Specification (
*_en-open-api.json) - Asset Administration Shell XML (
*.aasx.xml) - Documentation (
*-documentation.html)
An example of the concrete implementation of a battery passport system based on that data model could be found here: https://thebatterypass.io/
The architectural structure of the software demonstrator and the implementation concepts behind the implementation are published in the Battery Passport Technical Guidance. The rationale for the usage of RDF and the Semantic Modelling Framework can be found in chalter 4.9 of this document.
We welcome contributions to the Battery Pass Data Model. To contribute:
- Fork the repository.
- Create a new branch (
git checkout -b feature-branch). - Make your changes.
- Commit your changes (
git commit -m 'Add new feature'). - Push to the branch (
git push origin feature-branch). - Create a pull request.
Please ensure that your contributions adhere to the project's coding standards and guidelines.
The battery pass data model is still in draft mode and not finished yet. The purpose of this publication is to initiate further technical alignment with other relevant stakeholders. The data model schemas are for demonstration purposes only. Therefore, none of the project partners can be held liable for any errors or omissions in the data model schemas provided, and no representation or warranty, express or implied, is made as to the accuracy, adequacy, completeness, legality, reliability or usefulness of the data model. The data model is subject to change without notice.
This work is made available under Creative Commons Attribution 4.0 International (CC-BY-4.0) license. See the LICENSE file for more details.
For questions, feedback, or support, please contact:
- Project website: Battery Passport Project website
- Project work package maintainer: Niko D'Agostino, Circulor GmbH, WP4 lead Battery Pass project software demonstrator
- GitHub Issues: Submit an Issue
- Follow us on LinkedIn
Thank you for using the Battery Pass Data Model! We look forward to your contributions and feedback.
This Battery Pass project receives funding from the German Federal Ministry for Economic Affairs and Climate Action by resolution of the German Bundestag under grant agreement No BZF335.
