Struct ActuateSimulator

pub struct ActuateSimulator<'a> {
    config: ActuateControllinoConfig,
    actuate_simulator_channels: &'a mut ActuateSimulatorChannels,
}

Contains trait implementation for system testing purposes.

Fields

config: ActuateControllinoConfig

actuate_simulator_channels: &'a mut ActuateSimulatorChannels

Implementations

impl<'a> ActuateSimulator<'a>

pub fn new( actuate_simulator_channels: &'a mut ActuateSimulatorChannels, config: ActuateControllinoConfig, ) -> Self

Creates a new ActuateSimulator instance.

This constructor initializes the simulator with an optional sender channel for TCP communication and the Controllino-specific configuration. It’s used to set up the mock actuation logic for testing purposes.

Arguments

• actuate_simulator_channels - A mutable reference to the struct containing the channel.
• config - The ActuateControllinoConfig struct, providing device-to-relay mappings and other configuration relevant when simulating Controllino behavior.

Returns

A new ActuateSimulator struct.

Trait Implementations

impl<'a> RelayActuationTrait for ActuateSimulator<'a>

fn actuate( &mut self, internal_command: &InternalCommand, ) -> Result<(), RelayError>

Simulates relay actuation by sending a command over a channel, typically for testing.

This function translates a high-level InternalCommand (like SwitchOn or SwitchOff) into a low-level relay command (e.g., SetRelay) using the same logic as the physical Controllino actuator. The resulting command is then sent over an mpsc channel, presumably to a test harness or a TCP listener that simulates the hardware.

This implementation is intended solely for development and system testing and does not interact with physical hardware.

Arguments

• internal_command - The InternalCommand specifying the AquariumDevice and the desired state (SwitchOn or SwitchOff).

Returns

An empty Result (Ok(())) if the translated command was successfully sent via the channel.

Errors

This function will return a RelayError if any part of the simulation fails:

• RelayError::SimulatorNotInitialized: If the simulator was created without a valid sender channel (tx_to_tcp_opt was None).
• RelayError::IrrelevantCommand: If the provided internal_command is not one that can be translated into a relay action (e.g., RequestSignal).
• RelayError::PulseNotAllowedForDevice: If a Pulse command is attempted for a device that doesn’t support it (propagated from get_relay_command).
• RelayError::SimulatorSendFailed: If sending the command over the mpsc channel fails, which typically means the receiver has been dropped.

fn get_heartbeat_interval_seconds(&self) -> Option<u64>

Returns the heartbeat interval, which is not applicable for the simulator.

The simulator does not require a keep-alive signal, so this implementation always returns None.

Returns

Always returns None.

fn heartbeat(&mut self) -> Result<(), RelayError>

Performs a heartbeat action, which is not applicable for the simulator.

This is a no-op for the simulator implementation as there is no persistent communication channel that needs to be kept alive.

Returns

Always returns Ok(()).

Errors

This function will never return an error.

fn flush_buffer(&mut self) -> Result<(), RelayError>

Flushes a communication buffer, which is not applicable for the simulator.

This is a no-op for the simulator implementation as there is no serial communication buffer to flush.

Returns

Always returns Ok(()).

Errors

This function will never return an error.