Using the HIL SDK Examples

The examples provided in this documentation are minimal and are designed to showcase a certain interface or feature of the HIL system. Most examples assume that you have a valid HIL project already set up and running properly. If you don't, follow the quick start guide. Once you have a running project, use the file content given in the examples to modify your project (this may require creating a copy of your existing project that you can modify locally outside of your repository).

The examples are not "complete" in the sense that they don't contain all of the code you would need in a regular project. For example, the conftest.py files do not contain flashing fixtures, because this can vary widely across projects. To keep the examples as simple and broad as possible, the file contents represent the code that must be added to a given project in order to use a certain feature.

You will notice that most of the examples have more content in the conftest.py file than the test_XXX.py file. This is intentional, and highlights the importance of good fixtures. If you invest time into creating intentional test architecture using fixtures, your tests become smaller, simpler, and easier to maintain.