Skip to content

๐Ÿš€ Quick Guide: Minimal Setup for HIL Tests

This guide walks you through the simplest possible setup for creating and running HIL tests. It assumes your server is already configured according to the installation manual and has all required tools installed.

๐Ÿ‘‰ Server setup manual


๐Ÿ“ 1. Prepare Your Workspace

Open the directory where you plan to run the framework and store your HIL tests.

Inside this directory:

  • Create a folder called hil_tests
  • Create a file named peripherals_config.yaml

โš™๏ธ 2. Configure Peripherals

In the peripherals_config.yaml file, define and parameterize all peripherals you want to use in your tests.

Use the documentation for reference (hardware configuration section).


๐Ÿงช 3. Create a Test Group

Still in the same directory, create a new test group using the command:

hiltests --create-test-group <group_name>

This will generate a test file inside the hil_tests folder.


โœ๏ธ 4. Write Your Tests

Open the generated file in hil_tests and write your tests following the examples and structure described in the documentation.


โ–ถ๏ธ 5. Run Your Tests

Run your tests using:

hiltest

๐Ÿ“š 6. Additional Options

All advanced options are documented and can also be viewed via:

hiltest -h

๐ŸŽ‰ That's it! You now have the simplest working setup for creating and running HIL tests.