The OpenEPT project aims to provide innovative tools and solutions for energy profiling and battery algorithm evaluation. To ensure transparency and accessibility, we have made all relevant materials, documentation, and source code available to the community. This blog will guide you through the structure of our project, highlighting where to find key resources.

Project Overview: Software and Hardware Components

The OpenEPT project consists of two primary components: software and hardware. Both aspects are supported by detailed documentation, ensuring that developers, researchers, and enthusiasts can easily understand and leverage our work.

Software Component: Firmware, GUI, and Profiling Library

The software segment of the OpenEPT project is divided into three parts:

1. Firmware for the Acquisition Device
   This section focuses on the embedded firmware that powers the Acquisition Device, responsible for precise energy profiling and data acquisition.
   • Source Code Location:
     You can access the firmware source code on our GitHub repository.
   • Documentation:
     Detailed documentation for this firmware is available on our official Materials page.
2. Graphical User Interface (GUI)
   The GUI provides an intuitive and user-friendly interface for interacting with the OpenEPT system. It is designed to work across multiple platforms, such as Linux and Windows, making it accessible to a broad audience.
   • Source Code Location:
     The GUI source code is hosted on our GitHub repository.
   • Documentation:
     Comprehensive documentation for the GUI can also be found on the Materials page.
3. Firmware Energy Profiling Library (FEPLib)
   This library provides tools for profiling the energy consumption of firmware running on devices whose power usage is measured with the OpenEPT Acquisition Device hardware.
   • Source Code Location:
     The library's source code is available on our GitHub repository.
   • Documentation:
     Further details about this library can also be found on the Materials page.

Figure 1 highlights the publicly available repositories on the OpenEPT project's GitHub organization page. For detailed instructions on how to contribute to our open-source projects, refer to this blog post: Contributor Guide.

Hardware Component: Tools and Resources

In addition to software, the OpenEPT project includes a dedicated hardware component. This involves tools, schematics, and resources necessary for building and using the hardware that powers our system.

• Hardware Materials Location:
  All materials related to the hardware component are now available on the Materials page under the Documentations tab, specifically within the Hardware sub-tab.
• What’s Included:
  The hardware documentation provides detailed schematics, assembly guides, and technical specifications to help you understand and utilize our hardware solutions effectively.

Documentation Hub: Centralized Access to Resources

To simplify access to all project materials, we have created a centralized Materials page on our website. This page includes the following:

• Full documentation for software components, including firmware, GUI, and the FEPLib library.
• Hardware materials and resources, now organized under the Hardware sub-tab.
• Guides and tutorials for setting up and using OpenEPT tools.
• Additional resources for understanding the design and implementation of the system.

Currently, only some of the four previously mentioned aspects are covered on the Materials page as part of the ongoing development phase. However, we plan to include comprehensive coverage of all aspects by the end of the project. Visit the Materials page to explore these resources.

‍