Release notes

Releases of documentation and code are using the same version numbers. The version numbering system (tries and) follows the semantic versioning principles:

Note

Given a version number MAJOR.MINOR.PATCH, increment the:

MAJOR version when you make incompatible API changes

MINOR version when you add functionality in a backward compatible manner

PATCH version when you make backward compatible bug fixes

1.4.0 - 2025-08-22

Updated generated Makefile generated by CLI wizard script to include the configuration YAML file as dependency for the generated files (including the Makefile itself)
Added --*-only options to CLI wizard script to generate only part of the target files
Added log_level option to CLI wizard script configuration file
Fixed variables as being possibly left out from the CLI wizard script configuration file
Verilator extension tested with versions 5.036 and 5.038
[Issue #11] Added optional UUID field to TCP protocol messages header for improved traceability. The reference Python client has also been updated to add the use_uuid option.

1.3.0 - 2025-04-19

Added an API to support integrating Verisocks with Verilator, including full documentation
Included a CLI wizard script to Python package in order to facilitate the creation of top-level C++ code to use Verisocks with Verilated code
Modified the command get(sim_info) to return time_unit and time_precision information

1.2.0 - 2024-03-16

Modified Verisocks constructor and Verisocks.connect() method to include arguments for multiple, delayed connection trials. Examples and test have been simplified accordingly.
Added correct management of system call interrupts while waiting on client connection in the server code (see https://www.gnu.org/software/libc/manual/html_node/Interrupted-Primitives.html for details).
Added section Alternative simulators.
Added method verisocks.utils.setup_sim_run() to simplify foreseen support for alternative simulators.

1.1.0 - 2024-02-07

Added verisocks.utils Python utilitary functions, including documentation.
Added Verisocks.info() method as a shortcut to implement the TCP protocol info command.
Corrected SPI master example for standalone execution.
Added a minimalistic Hello world example, working both for standalone execution or with pytest.

1.0.0 - 2024-01-04

First released, working version