Skip to content

Latest commit

 

History

History
67 lines (39 loc) · 2.82 KB

README.md

File metadata and controls

67 lines (39 loc) · 2.82 KB
Raw

PC Simulator for firmware

Why using a simulator?

The reasons for using a simulator are explained in the main README.

Architecture

Simulation consists of:

  • Firmware (.so file)
    • High-level logic is used as-is, without modification for simulation mode. This code is located in the Application/BuissnesLogic/ and Application/Device/ folders within the firmware directory.
    • The Stub folder replaces low-level classes (Driver folder within the firmware directory).
    • The exception is LCD driver which uses already existing monoliticall library, this driver is not stubbed because it contains a lot of high level logic
    • An exception is the LCD driver, which uses an existing monolithic library. This driver is not stubbed because it contains a significant amount of high-level logic.
  • device_under_test.py: Loads the firmware .so file and provides a Python API interface.
  • hmi.py: Provides the graphical interface.

Remarks

  • Do Not Inherit from Firmware Driver Headers, as they include many HAL dependencies that are difficult to stub and not needed in simulation mode. Instead, use driver interface headers and create stub drivers based on inheritance from those interfaces. The only exception to this rule is the Display driver.

  • No Stubs for Business Logic or Device Layers. Having a stub in these layers would indicate that the classes are too tightly coupled with low-level code. If a stub is required, it means the firmware code needs refactoring to better separate concerns.

How to use it

  • Build the Firmware in simulation mode:

    TODO

  • Build and run the Docker Container:

    TODO

  • Once inside the Docker container, navigate to the simulation directory:

    TODO

  • Execute the simulation script:

    python3 hmi.py

Remarks

TODO: synthesis into the above chapter.

If you're using Windows, you need MobaXterm, if you are using Linux you (probably, I didn't test it) can just use a terminal.

Simulation is a graphic app, configure the console so that it is able to launch them:

export DISPLAY=:0

Build the image:

docker build -t hmi .

Start the image:

docker run -it --rm -e DISPLAY=$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix hmi

Note that console has changed it's prompt.

Now launch the simulation:

python3 hmi.py

Alternatively if you don't like Docker, you can look on the Docker file, it contains the lists of packages that need to be installed in order to launch the simulation.