A test framework for embedded systems that's open-source, offering full visibility and controllability of your target and its environment.
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
·
Follow Tutorials
Table of Contents
Omni is a testing framework for embedded systems, It gives developers the ability to fully control both the target device and its environment. This control is achieved by interfacing with the device through the debugger and by manipulating environment conditions using laboratory equipment.
The framework allows for the integration of hardware tests directly with the development of new features. This means developers can write tests that are immediately run on a continuous testing server, enabling quick feedback on how the new features perform.
Omni supports the GDB debugger and a variety of laboratory devices, including power supplies, oscilloscopes, and logic analyzers, among others. This support ensures developers can set up a comprehensive testing environment tailored to the specific needs of their system.
As Omni decouples the test execution from the control of the laboratory equipment the tests can be executed from within a docker container.
- python3
- drivers for the laboratory devices (test specific)
pip install omni-testing- Clone the repo
git clone https://github.com/Omni-Embedded-Testing/Omni
- Build python package
python3 setup.py sdist
- Install python package
pip install dist/Omni-0.0.1.tar.gz
Substitute the package version by the current version beeing built.
Imagine a setup like the one below on your CI server or desktop:
This setup allows you to test the communication between your microcontroller unit (MCU) and a sensor. Here is an example of a test case using Omni and the Robot Framework to verify the interaction:
*** Test Cases ***
SPI CAPTURE TEMPERATURE SENSOR DATA
[Documentation] SPI CAPTURE TEMPERATURE SENSOR DATA
Debuger.Load Test my_application.elf
Debuger.Breakpoint on Line And Go TemperatureLogger.cpp get_temperature();
Logic.Set Timed Capture Mode 5
Logic.Start Spi Capture
Debuger.Continue Execution
Logic.Wait Capture End
Logic.Save Raw TEMPERATURE_SENSOR.cap
Logic.Export To Csv TEMPERATURE_SENSOR.csv
Logic.Verify Data TEMPERATURE_SENSOR.csv
- Flash Application: Loads and flashes my_application.elf onto the target MCU.
- Set Breakpoint: Sets a breakpoint at the line containing get_temperature(); in the file TemperatureLogger.cpp.
- Start SPI Capture: Initiates a 5-second SPI bus capture to record temperature sensor data.
- Continue Execution: Resumes the program execution in the debugger, similar to pressing the play button in an IDE.
- Wait for Capture End: Holds the test until the SPI capture is complete.
- Save and Export Data: Saves the raw capture data as TEMPERATURE_SENSOR.cap and exports it to a CSV file for easier analysis.
- Verify Logs: Checks the CSV data file to ensure the capture data meets expected parameters.
For more examples, please refer to the Documentation
- Tutorials documentation
- Omni as a CLI application
- Sigrok integration
- Usage behavior
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt for more information.
Erick Setubal Bacurau - erickbacurau1989@gmail.com
Vitor Santiago - vitorsanti99@gmail.com
Project Link: https://github.com/Embedded-Testing/Omni
- Erick Setubal Bacurau - project creator
- Vitor Santiago - current project owner & mantainer