hilsim 0.1.0__tar.gz

hilsim-0.1.0/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026 Clint Carafelli
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

hilsim-0.1.0/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.4
+Name: hilsim
+Version: 0.1.0
+Summary: A Hardware-in-the-Loop / Software-in-the-Loop simulation framework
+Author: Clint Carafelli
+License: MIT License
+        
+        Copyright (c) 2026 Clint Carafelli
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click
+Requires-Dist: jinja2
+Requires-Dist: tomllib; python_version < "3.11"
+Requires-Dist: pyserial
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: rich; extra == "dev"
+Dynamic: license-file
+
+# hilsim
+A Python package for rapid hardware-in-the-loop (HIL) and software-in-the-loop (SIL) simulation, 
+designed for software/hardware testing, deployment, and development. 
+
+## Installation
+pip install hilsim
+
+## Quick Start
+See the [examples](examples/) folder for a host of configuration files, sensors, and actuators. 
+
+## How It Works
+hilsim generates a project structure where the developer has four main tasks: 
+   1) fill out configuration files
+   2) Writes basic drivers for sensors based on a template. 
+   3) Describe the physics/behavior of actuators (anything that changes the state of the world), also based on a template.
+   4) Write the main logic.
+
+A simple run command then simulates the entire system. Switching the "sim" keyword for either a sensor, device, or actuator allows the user to rapidly switch between simulating a component and deploying the actual hardware. No need to worry about any middleware or fatal exceptions in the background.
+
+## Features
+- Data recording. 
+- User defined event driven log file management with a built-in detailed message logging system. 
+- Standardized serial protocol with built-in recovery.
+- High-level i2c bus interactions with built-in recovery.
+- Simulate latency between the host and peripheral device communication and actual hardware deployment.
+- Simulate sensor errors/failures.
+- Simulate noise and drift in sensors. 
+- Simulate host-peripheral device communication failures. 
+- Simulate hardware failures.
+- Background dynamics simulation. Background dynamics run on a high-speed background thread (on the ms level) which sensors may routinely pull from, mirroring the continuous nature of system dynamics and separating them from the discrete nature of sensor reads.
+
+## Current Limitations
+Currently, the "supported" i2c_bus wraps the board and busio libraries, allowing hilsim to accommodate a wide range of readily-available/cheap sensors from manufacturers like Adafruit. A future release will include support for the smbus library, allowing the the use of custom sensors / i2c devices at a lower level. 
+
+## Roadmap
+- Add detailed examples and walkthroughs. 
+- Support for the smbus library.
+- Rapid power cycling / software cycling integration. The current release flags errors that the developer can accommodate in main, but does not have the capability to rapidly integrate software cycling or power cycling. 
+- SPI support
+- Virtual serial ports with socat, ideal for testing microcontroller code alongside the host.  

hilsim-0.1.0/README.md

@@ -0,0 +1,40 @@
+# hilsim
+A Python package for rapid hardware-in-the-loop (HIL) and software-in-the-loop (SIL) simulation, 
+designed for software/hardware testing, deployment, and development. 
+
+## Installation
+pip install hilsim
+
+## Quick Start
+See the [examples](examples/) folder for a host of configuration files, sensors, and actuators. 
+
+## How It Works
+hilsim generates a project structure where the developer has four main tasks: 
+   1) fill out configuration files
+   2) Writes basic drivers for sensors based on a template. 
+   3) Describe the physics/behavior of actuators (anything that changes the state of the world), also based on a template.
+   4) Write the main logic.
+
+A simple run command then simulates the entire system. Switching the "sim" keyword for either a sensor, device, or actuator allows the user to rapidly switch between simulating a component and deploying the actual hardware. No need to worry about any middleware or fatal exceptions in the background.
+
+## Features
+- Data recording. 
+- User defined event driven log file management with a built-in detailed message logging system. 
+- Standardized serial protocol with built-in recovery.
+- High-level i2c bus interactions with built-in recovery.
+- Simulate latency between the host and peripheral device communication and actual hardware deployment.
+- Simulate sensor errors/failures.
+- Simulate noise and drift in sensors. 
+- Simulate host-peripheral device communication failures. 
+- Simulate hardware failures.
+- Background dynamics simulation. Background dynamics run on a high-speed background thread (on the ms level) which sensors may routinely pull from, mirroring the continuous nature of system dynamics and separating them from the discrete nature of sensor reads.
+
+## Current Limitations
+Currently, the "supported" i2c_bus wraps the board and busio libraries, allowing hilsim to accommodate a wide range of readily-available/cheap sensors from manufacturers like Adafruit. A future release will include support for the smbus library, allowing the the use of custom sensors / i2c devices at a lower level. 
+
+## Roadmap
+- Add detailed examples and walkthroughs. 
+- Support for the smbus library.
+- Rapid power cycling / software cycling integration. The current release flags errors that the developer can accommodate in main, but does not have the capability to rapidly integrate software cycling or power cycling. 
+- SPI support
+- Virtual serial ports with socat, ideal for testing microcontroller code alongside the host.  

hilsim-0.1.0/pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "hilsim"
+version = "0.1.0"
+description = "A Hardware-in-the-Loop / Software-in-the-Loop simulation framework"
+readme = "README.md"
+requires-python = ">=3.10"
+license = {file = "LICENSE"}
+authors = [
+    {name = "Clint Carafelli"}
+]
+dependencies = [
+    "click",
+    "jinja2",
+    "tomllib; python_version < '3.11'",
+    "pyserial",
+]
+
+[project.scripts]
+hilsim = "hilsim.cli.commands:cli"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"hilsim" = ["scaffold/templates/**/*"]
+
+[project.optional-dependencies]
+dev = ["pytest", "pytest-cov", "rich"]

hilsim-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

hilsim-0.1.0/src/hilsim/cli/commands.py

@@ -0,0 +1,20 @@
+import click
+from hilsim.scaffold.engine import scaffold_project
+
+@click.group()
+def cli():
+    """hilsim: hardware-in-the-loop simulation framework"""
+    pass
+
+@cli.command()
+@click.argument("project_name")
+def create(project_name): 
+    """Scaffold a new hilsim project in the current directory"""
+    click.echo(f"Creating project '{project_name}'...")
+    try: 
+        scaffold_project(project_name)
+        click.echo(f"Project '{project_name}' created successfully")
+    except FileExistsError:
+        """Note: engine won't create a project that already exists
+        (i.e. has the same name)"""
+        click.echo(f"Error: directory '{project_name}' already exists", err=True)

hilsim-0.1.0/src/hilsim/core/actuators.py

@@ -0,0 +1,150 @@
+"""Define a world state class that serves as truth for all system variables"""
+
+import inspect
+import logging
+from random import gauss, random, uniform
+from typing import Any
+
+from hilsim.core.controls import Controls
+from hilsim.core.world_state import WorldState
+
+logger = logging.getLogger(__name__)
+#---------------------------------------------------------------------------------------
+class ActuatorBase:
+    """Actuator Base Class to enforce actuator class standards"""
+
+    registry: dict[str, Any] = {}
+
+    def __init_subclass__(cls, **kwargs):
+        super().__init_subclass__(**kwargs)
+        ActuatorBase.registry[cls.__name__] = cls
+
+    def __init__(
+        self, actuator_config: dict, world_state: WorldState, controller: Controls
+    ) -> None:
+        self.dt: float = 0.0
+        self.cst: float  = 0.0
+        self.time = world_state.state["time"]
+        self.world_state = world_state
+        self.failure_sim = actuator_config["failure_sim"]
+        self.settings = actuator_config["settings"]
+        self.effects = actuator_config["effects"]
+        self.sim = actuator_config["settings"]["sim"]
+        self.commanded_state = actuator_config["settings"]["initial_state"]
+        self.hardware_state = actuator_config["settings"]["initial_state"]
+        self.name = actuator_config["settings"]["name"]
+        self._stuck_counter: int = 0
+        self._transition_state: str = "settled"
+        self._stuck: bool = False
+        self._latency_remaining: float = 0.0
+        self._discover_effects()
+        self._controller = controller
+
+    def send_command(self, target_state: str, advanced_connection: bool = True) -> dict[str,bool]:
+        """Send command to microcontroller for target_state"""
+        device_name = self.settings["device"]
+        logger.info("Command triggered for %s, sending command to %s", self.name, device_name)
+        logger.info("Command has target_state: %s", target_state)
+        package = self.build_command(target_state)
+        if advanced_connection:
+            confirmation = self._controller.advanced_send(device_name, package)
+        else:
+            confirmation = self._controller.send(device_name, package)
+
+        self._update_commanded_state(confirmation, target_state)
+        return confirmation
+
+    def _update_commanded_state(self, confirmation: dict[str, bool], commanded_state: str) -> None:
+        """Update the commanded state attribute"""
+        if confirmation["confirmed"]:
+            self.commanded_state = commanded_state
+            self._transition_state = "commanded"
+
+    def _resolve_state_transition(self) -> None:
+        """Determine latency and encode failure mode of hardware (i.e. actuator is stuck)"""
+        if self._stuck and self._stuck_counter == 0:
+            self._stuck_counter += 1 
+            logger.critical("%s is stuck in state %s.", self.name, self.hardware_state)
+
+        if not self._stuck:
+            self._stuck_counter = 0
+
+        if self._transition_state == "settled":
+            return
+
+        if self._transition_state == "commanded":
+            self._latency_remaining = self._sample_latency()
+            self._stuck = self._sample_stuck()
+            self._transition_state = "pending_latency"
+
+        if self._transition_state == "pending_latency":
+            self._latency_remaining -= self.dt
+            if self._latency_remaining <= 0:
+                if self._stuck:
+                    self._transition_state = "stuck"
+                    logger.critical("%s is stuck", self.name)
+                else:
+                    self._transition_state = "settled"
+                    self.hardware_state = self.commanded_state
+                    self.cst = 0
+
+    def _sample_latency(self) -> float:
+        """Sample latency in milliseconds
+        Note, all values divided by 1000 to convert millesconds to seconds to
+        reflect the standard of self._dt"""
+
+        dist_type = self.failure_sim["cta_latency"]["distribution"]
+        if dist_type == "normal":
+            mean_val = self.failure_sim["cta_latency"]["mean"] / 1000
+            std_val = self.failure_sim["cta_latency"]["std"] / 1000
+            return max(0, gauss(mean_val, std_val))
+
+        if dist_type == "uniform":
+            max_lat = self.failure_sim["cta_latency"]["max"] / 1000
+            min_lat = self.failure_sim["cta_latency"]["min"] / 1000
+            return uniform(min_lat, max_lat)
+
+        # Could raise an error here sense dist_type would be unknown
+        # sorta a silent failure right now
+        logger.warning("Unknown distribution type: %s. Setting latency to zero", dist_type)
+        return 0
+
+    def _sample_stuck(self) -> bool:
+        "Determine if in this sim case the actuator gets stuck in its current state"
+        if random() <= self.failure_sim["stuck_probability"]:
+            return True
+        return False
+
+    def update(self, dt: float) -> None:
+        """Update world state based on commands, actuator latency, and effects"""
+        self.cst += dt
+        self.dt = dt
+        if self.sim:
+            self._resolve_state_transition()
+            self._apply_effects()
+
+    def _discover_effects(self):
+        """Find developer effects"""
+        self._effect_methods = {
+            name.replace("effect_", ""): method
+            for name, method in inspect.getmembers(self, predicate=inspect.ismethod)
+            if name.startswith("effect_")
+        }
+
+    def _apply_effects(self) -> None:
+        """Apply developer defined effects"""
+        for variable_name, method in self._effect_methods.items():
+            magnitude = method()
+            memory_type = self._get_memory_type(variable_name)
+
+            if "p" in memory_type:
+                self.world_state.apply_delta(variable_name, magnitude)
+            else:
+                self.world_state.add_contributions(variable_name, self.name, magnitude)
+
+    def _get_memory_type(self, variable_name: str) -> str:
+        """Get the memory type of an actuator-effected variable"""
+        return self.effects[variable_name]["effect_types"]
+
+#---------------------------------------------------------------------------------------
+

hilsim-0.1.0/src/hilsim/core/builders.py

@@ -0,0 +1,115 @@
+"""Build instances of actuators, sensors, and set up device connections"""
+
+import importlib
+import logging
+from pathlib import Path
+
+from hilsim.core.actuators import ActuatorBase
+from hilsim.core.controls import (AdvancedCommunication, Controls,
+                                      SerialInterface)
+from hilsim.core.device_exceptions import DeviceConnectionError
+from hilsim.core.i2c_bus import I2CBus
+from hilsim.core.load_toml import LoadTOML
+from hilsim.core.sensors import DriverBase, SensorBase
+from hilsim.core.world_state import WorldState
+
+logger = logging.getLogger(__name__)
+
+# ---------------------------------------------------------------------------------------
+
+class BuildComponents:
+    """Build instances of actuators, sensors, and set up device connections"""
+
+    def __init__(self, build_ctx: dict) -> None:
+        self.sensor_config = build_ctx["sensor_config"]
+        self.device_config = build_ctx["device_config"]
+        self.actuator_config = build_ctx["actuator_config"]
+        self.world_state = build_ctx["world_state"]
+        self.i2c_bus = build_ctx["i2c_bus"]
+        self.project_root = build_ctx["project_root"]
+        self._auto_discover(
+            self.project_root / "sensors"
+        )  # Populates SensorBase.registry and DriverBase.Registry
+        self._auto_discover(
+            self.project_root / "actuators"
+        )  # Populates ActuatorBase.registry
+
+    def _auto_discover(self, directory: str) -> None:
+        """Import all modules in a directory to trigger the __init_subclass__ registration"""
+        path = Path(directory)
+        for module_file in path.glob("*.py"):
+            if module_file.name.startswith("_"):
+                continue
+            module_name = module_file.stem
+            try:
+                spec = importlib.util.spec_from_file_location(module_name, module_file)
+                module = importlib.util.module_from_spec(spec)
+                spec.loader.exec_module(module)
+            except Exception as e:
+                raise ImportError(f"failed to load module '{module_file}': {e}") from e
+
+    def _build_actuators(self) -> dict:
+        """Create dictonary of instances of each actuator"""
+        actuators = {}
+        for name, config in self.actuator_config.items():
+            driver_name = config["settings"]["driver"]
+            driver_class = ActuatorBase.registry[driver_name]
+            actuators[name] = driver_class(config, self.world_state, self.controller)
+
+        return actuators
+
+    def _build_fake_sensors_with_drivers(self):
+        """Construct instances of drivers"""
+        drivers = {}
+        for sensor in self.sensor_config["sensor_params"]["enabled_sensors"]:
+
+            # Query important parameters
+            sensor_config = self.sensor_config["sensors"][sensor]
+            fake_sensor_name = sensor_config["fake_sensor_name"]
+            driver_name = sensor_config["driver_name"]
+
+            # Create instance of fake sensor
+            fake_sensor_class = SensorBase.registry[fake_sensor_name]
+            fake_sensor = fake_sensor_class(sensor_config, self.world_state)
+
+            # Create instance of driver
+            driver_class = DriverBase.registry[driver_name]
+            drivers[sensor] = driver_class(
+                sensor, sensor_config, self.i2c_bus, fake_sensor
+            )
+            logger.info("Registered %s → %s", sensor, driver_class.__name__)
+
+        return drivers
+
+    def _build_devices(self) -> dict:
+        """Build peripherial devices and open serial connections to them"""
+        device_configs = self.device_config["devices"]
+        advanced_comms_config = self.device_config["advanced_communication"]
+        logger.info("building peripherial microcontrollers")
+
+        device_dict = {}
+        for device in self.device_config["enabled_devices"]:
+            sub_config = device_configs[device]
+            device_comms = SerialInterface(sub_config, device)
+            device_w_advanced_comms = AdvancedCommunication(
+                sub_config, advanced_comms_config, device_comms
+            )
+            connected = device_w_advanced_comms.device.connect()
+            if not connected:
+                logger.error("Error connecting to %s", device)
+                raise DeviceConnectionError(
+                    device, "Failed to connect to device. See message logs."
+                )
+            logger.info("successfully connected to %s", device)
+            device_dict[device] = device_w_advanced_comms
+        return device_dict
+
+    def build_all(self) -> dict:
+        """Build all sensors, devices, and actuators"""
+        self.controller = Controls(self._build_devices()) # actuators depend on the Controller!
+        actuators = self._build_actuators()
+        sensors = self._build_fake_sensors_with_drivers()
+        return {"actuators": actuators, "sensors": sensors}
+
+
+# ---------------------------------------------------------------------------------------