Struct TimedOutput 

pub struct TimedOutput<F>
where
    F: FnMut(bool),
{ /* private fields */ }

Simple controller that turns on an output at a specific time and turns it off after a duration has passed.

This is used to repeat the same action every day at the same time.

Potential Use Cases

• Controlling grow lights
• Regularly turning on an O2 pump for a fish tank or bioreactor
• Regularly dumping a sedimentation filter
• Controlling a feed motor for fish feed

Example

In this example, the output will be actuated at 5:00AM and deactivated after 8 hours (1:00PM)

use chrono::{Duration, NaiveTime, Utc};
use equilibrium::controllers::{Controller, TimedOutput};
use equilibrium::Output;

let time = NaiveTime::from_hms_opt(5, 0, 0).unwrap();
let duration = Duration::hours(8);
let mut output = TimedOutput::new(
  Output::default(),
  time,
  duration,
);

output.poll(Utc::now());

Implementations

impl<F> TimedOutput<F>

where F: FnMut(bool),

pub fn new(output: Output<F>, start_time: NaiveTime, duration: Duration) -> Self

Create a new timed output with a scheduled the first event

This is the recommended API for instantiating new TimedOutputs.

pub fn new_without_scheduled( output: Output<F>, start_time: NaiveTime, duration: Duration, ) -> Self

Create a new timed output

This does not schedule the first event and TimedOutput::schedule_first should be used to schedule the first event. It is recommended to use the TimedOutput::new method instead.

This method is only useful for testing purposes.

pub fn schedule_first<T>(self, time: T) -> Self

where T: Into<Option<DateTime<Utc>>>,

Schedule the first event

Trait Implementations

impl<F> Controller for TimedOutput<F>

where F: FnMut(bool),

fn set_name(&mut self, name: String)

Set the name of the controller

fn get_name(&self) -> Option<String>

Get the name of the controller

fn poll(&mut self, time: DateTime<Utc>) -> Option<Message>

Poll the controller for events

impl<F> Debug for TimedOutput<F>

where F: FnMut(bool) + Debug,

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

Formats the value using the given formatter.

impl Default for TimedOutput<fn(bool)>

fn default() -> Self

Returns the “default value” for a type.