Skip to main content

SimSensor

Struct SimSensor 

Source
pub struct SimSensor { /* private fields */ }
Expand description

A fake sensor that generates a signal from a baseline, drift, and noise.

This is the workhorse for hardware-free development: it implements the core Sensor trait, so it drops into a Node, a profile, or any test exactly where a real probe would, and it produces readings that look like the field rather than a clean constant. A reading is the baseline plus any accumulated drift plus a bounded pseudo-random wobble, so a control loop can be exercised against a signal that warms, sags, or jitters the way a real one does.

The noise is deterministic for a given seed - a small xorshift generator drives it, with no rand dependency - so a test that uses a SimSensor produces the same sequence every run and stays reproducible in CI.

§Examples

A noisy thermometer that warms by 0.1 degrees each reading:

use pamoja_core::Sensor;
use pamoja_sim::SimSensor;

let mut probe = SimSensor::new(20.0).with_drift(0.1).with_noise(0.05).with_seed(7);
let first = probe.read().await?;
assert!((first - 20.0).abs() <= 0.05); // the first reading sits near the baseline

Implementations§

Source§

impl SimSensor

Source

pub fn new(baseline: f32) -> Self

Creates a sensor that reads baseline with no drift or noise.

§Arguments
  • baseline - the value the sensor reads before drift and noise are added.
§Returns

A steady sensor; add with_drift and with_noise to make it lifelike.

Source

pub fn with_drift(self, per_read: f32) -> Self

Sets how much the baseline moves each reading, modelling a slow trend.

§Arguments
  • per_read - the amount added to the baseline after each reading; negative values sag the signal downward.
§Returns

The updated sensor, for chaining.

Source

pub fn with_noise(self, amplitude: f32) -> Self

Sets the amplitude of the bounded noise added to each reading.

§Arguments
  • amplitude - the largest magnitude the noise can reach; its magnitude is used, and each reading wobbles within plus or minus this amount.
§Returns

The updated sensor, for chaining.

Source

pub fn with_seed(self, seed: u32) -> Self

Sets the seed for the noise generator, making a run reproducible.

§Arguments
  • seed - the generator seed; zero is replaced with a fixed non-zero value, since the xorshift generator cannot start from zero.
§Returns

The updated sensor, for chaining.

Trait Implementations§

Source§

impl Clone for SimSensor

Source§

fn clone(&self) -> SimSensor

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for SimSensor

Source§

impl Debug for SimSensor

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Sensor for SimSensor

Source§

type Reading = f32

The value produced by a single read, for example a temperature or a fix.
Source§

async fn read(&mut self) -> Result<f32>

Takes a single reading from the sensor. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.