Easy-to-use, low-cost, open-source solution that includes compatible hardware and software sets of tools. This comprehensive solution is designed to fulfill the need for firmware energy profiling, as well as State of Charge (SoC) and State of Health (SoH) algorithm evaluation for real LiPo battery-powered embedded devices.
Official youtube channel
- Features
- Building and Running the Energy Profiler Probe GUI
- Contributor guide
- Documentation
- Acknowledgments
- Real-time voltage and current streaming
- High-speed data acquisition up to 1 MSPS
- Configurable GUI for advanced control
- Open source hardware
To successfully build and run the OpenEPT GUI application, Qt development environment must be installed and properly configured with the required dependencies. The following steps guide you through the full setup process.
The Qt framework should be obtained from the official Qt website this link.
Once the installer is downloaded and executed, users will be prompted to complete the sign-up process. Following successful registration, the installer will proceed to the component selection stage. For proper compilation and execution of the GUI application, the following components must be selected:
If Qt has been successfully installed, the application named Qt Creator should be launchable without issues. Upon starting Qt Creator, Welcome page will be displayed, which provides quick access to recent projects, examples, tutorials, and version control options. This interface should resemble what is shown in the Figure below.
There are two main methods for downloading the project from the official GitHub repository:
- Method 1: Using a Git console, such as Git Bash, to clone the repository directly via the command line.
- Method 2: Navigate to the repository's GitHub page, click the green Code button, and select Download ZIP. This will download the project files as a compressed archive.
- Launch Qt Creator and On the left-hand sidebar, click on the Welcome tab.
- Click on Open Project (1 and 2 on the figure bellow).
When the Open Project window opens, specify the directory where the project is located (in this case, Source/OpenEPT.pro).
To do so, select the OpenEPT.pro and click Open (Figure bellow).
After project is successfully loaded for the first time, Qt Creator will automatically open the initial project configuration dialog to choose an appropriate build kit and associated settings. It is essential to select the kit labelled Qt 5.12.2 MSVC 2019 64-bit, once the correct kit is selected click on Configure Project to proceed (Figure bellow).
Once the project is fully configured:
- Selecting the desired build configuration (1 on the figure bellow). Choose between the Debug configuration - used during development for troubleshooting and includes additional debugging symbols, while the Release configuration - used for deployment.
- The next step is to compile the project (2 on the figure bellow). This is achieved by clicking the Build button (represented by a hammer icon) located in the lower-left corner of the Qt Creator interface, or by navigating through the top menu via Build > Build Project.
- The application launch (3 on the figure bellow) when Debug configuration is selected, the application should be started by clicking the Run button that includes a small briefcase icon. For Release configuration, the standard Run button (green play icon) next to the configuration selector should be used, or alternatively via Build > Run from the menu.
To start contributing, fork the main repository to your own GitHub account:
- Navigate to the repository you want to contribute to.
- Click the Fork button in the upper-right corner. (This is an example for
OpenEPT/FEPLibrepo.)
- This will create a copy of the repository under your GitHub account.
Once the repository is forked, clone it to your local machine:
# Replace <your-username> with your GitHub username
git clone https://github.com/<your-username>/<repository-name>.git
cd <repository-name>Before making changes, create a new branch based on the type of contribution:
- For new features, name the branch
feature/<name>. - For bug fixes, name the branch
bug/<name>.
To create a branch:
# Replace <branch-name> with your branch name
# Example for a feature: feature/apard32690_lib
# Example for a bug fix: bug/fix_esp12e_lib
git checkout -b <branch-name>Make the necessary changes to your branch. Test thoroughly to ensure your contribution does not introduce new issues.
Before any changes, please read developer Documentation
Once your changes are ready, stage and commit them:
git add .
# Write a descriptive commit message
git commit -m "Description of the changes made"Push the changes to your forked repository:
# Push the branch to your fork
git push origin <branch-name>- Navigate to your forked repository on GitHub.
- Switch to the branch you just pushed.
- Click the Compare & pull request button.
- Ensure the base repository is set to the main/master repository and the base branch is `main
- Provide a descriptive title and detailed description for your pull request.
- Add appropriate reviewers
- Submit the pull request.
Once the pull request is submitted:
- Wait for project maintainers to review your changes.
- Address any feedback provided by making additional commits to your branch.
- Once approved, the maintainers will merge your changes.
After your changes are merged, keep your fork updated with the main repository to avoid conflicts:
git remote add upstream https://github.com/<original-owner>/<repository-name>.git
git fetch upstream
git checkout main
git merge upstream/mainFor detailed developer instructions and additional materials, please see the Documentation->Software under Materials on the offical project website.
