deimos 0.16.2

Control-loop and data pipeline for the Deimos data acquisition system
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169

//! A control program with several DAQ modules connected via UDP and time-synchronized.
//!
//! Demonstrated here:
//!   * Setting up a simple control program and connecting to hardware
//!   * Storing data
//!   * Performing calculations in the loop
//!   * Serialization and deserialization of the control program

use std::collections::BTreeMap;
use std::path::PathBuf;
use std::time::Duration;

use crate::calc::{Constant, Sin};
use crate::peripheral::{AnalogIRev3, AnalogIRev4, DeimosDaqRev6};
use controller::context::ControllerCtx;
use deimos::calc::SequenceMachine;
use deimos::calc::sequence_machine::{MachineCfg, ThreshOp, Timeout, Transition};
use deimos::*;
use tracing::info;

fn main() {
    // Set op name
    // None -> Let the controller set the name of the op automatically
    let op_dir: PathBuf = "./software/deimos/examples".into();
    let op_name_path = op_dir.join("op_name.tmp");
    let op_name = std::fs::read_to_string(&op_name_path).unwrap_or_else(|_| {
        format!(
            "{:?}",
            std::time::SystemTime::now()
                .duration_since(std::time::UNIX_EPOCH)
                .unwrap()
                .as_nanos() as u64
        )
    });
    std::fs::write(op_name_path, &op_name).unwrap();

    // Collect initalizers for custom peripherals, if needed
    let peripheral_plugins = None;

    // Set control rate
    let rate_hz = 200.0;
    let dt_ns = (1e9_f64 / rate_hz).ceil() as u32;

    // Define idle controller
    let mut ctx = ControllerCtx::default();
    ctx.op_name = op_name;
    ctx.dt_ns = dt_ns;
    ctx.op_dir = op_dir.clone();
    //   For a demo control network, assume that the control server does not have
    //   a static address and may drop out for a few seconds while renewing its IP address.
    //   For a real network, the control server and peripherals should be assigned
    //   static addresses, and this limit can be comfortably set as low as 2-3 cycles.
    ctx.controller_loss_of_contact_limit = 10;
    ctx.peripheral_loss_of_contact_limit = 10;
    ctx.loss_of_contact_policy = LossOfContactPolicy::Reconnect(Some(Duration::from_secs(10)));
    //   At higher control rate, switch to busy-waiting mode to maintain timing.
    if rate_hz > 50.0 {
        ctx.loop_method = LoopMethod::Performant;
    } else {
        ctx.loop_method = LoopMethod::Efficient;
    }
    //   Build the controller, but don't connect sockets or run anything yet.
    let mut controller = Controller::new(ctx);

    // Scan for peripherals on LAN
    let scanned_peripherals = controller
        .scan(10, &peripheral_plugins)
        .expect("Failed to scan for peripherals");
    info!("Scan found: {scanned_peripherals:?}\n");

    // Associate peripherals
    controller.add_peripheral("p1", Box::new(AnalogIRev3 { serial_number: 1 }));
    controller.add_peripheral("p2", Box::new(AnalogIRev3 { serial_number: 2 }));
    controller.add_peripheral("p3", Box::new(AnalogIRev4 { serial_number: 1 }));
    controller.add_peripheral("p4", Box::new(AnalogIRev4 { serial_number: 2 }));
    controller.add_peripheral("p5", Box::new(AnalogIRev4 { serial_number: 3 }));
    controller.add_peripheral("p6", Box::new(AnalogIRev4 { serial_number: 4 }));
    // controller.add_peripheral("p7", Box::new(AnalogIRev4 { serial_number: 5 }));
    // controller.add_peripheral("p8", Box::new(AnalogIRev4 { serial_number: 6 }));
    controller.add_peripheral("p8", Box::new(DeimosDaqRev6 { serial_number: 5 }));

    // Set up database dispatchers
    let timescale_dispatcher: Box<dyn Dispatcher> = TimescaleDbDispatcher::new(
        "tsdb",
        "/run/postgresql/", // Unix socket interface; TCP works as well
        "jlogan",
        "POSTGRES_PW",
        Duration::from_nanos(1),
        Duration::from_secs(60 * 60),
    );
    let csv_dispatcher: Box<dyn Dispatcher> = CsvDispatcher::new(50, dispatcher::Overflow::Wrap);
    controller.add_dispatcher("tsdb", timescale_dispatcher);
    controller.add_dispatcher("csv", csv_dispatcher);

    // Set up calc graph
    let duty = Constant::new(0.5, true);
    let freq = Sin::new(1.0 / (rate_hz / 100.0), 0.25, 100.0, 250_000.0, true);
    let freq1 = Sin::new(20.0, 0.25, 10.0, 200.0, true);
    let dac1 = Sin::new(20.0, 0.0, 0.0, 2.5, true);
    let dac2 = Sin::new(20.0, 5.0, 0.0, 2.5 / 25.7, true);
    controller.add_calc("duty", duty);
    controller.add_calc("freq0", freq);
    controller.add_calc("freq1", freq1);
    controller.add_calc("dac0", dac1);
    controller.add_calc("dac1", dac2);
    controller.set_peripheral_input_source("p1.pwm0_duty", "duty.y");
    controller.set_peripheral_input_source("p1.pwm0_freq", "freq0.y");
    controller.set_peripheral_input_source("p1.pwm1_duty", "duty.y");
    controller.set_peripheral_input_source("p1.pwm1_freq", "freq1.y");
    controller.set_peripheral_input_source("p1.pwm3_duty", "sequence_machine.duty");
    controller.set_peripheral_input_source("p1.pwm3_freq", "freq0.y");

    controller.set_peripheral_input_source("p8.pwm0_duty", "duty.y");
    controller.set_peripheral_input_source("p8.pwm0_freq", "freq0.y");
    controller.set_peripheral_input_source("p8.dac0", "dac0.y");
    controller.set_peripheral_input_source("p8.dac1", "dac1.y");

    let timeouts = BTreeMap::from([
        ("low".to_owned(), Timeout::Loop),
        ("high".to_owned(), Timeout::Transition("low".to_owned())),
    ]);

    let transitions: BTreeMap<String, BTreeMap<String, Vec<Transition>>> = BTreeMap::from([
        (
            "low".to_owned(),
            BTreeMap::from([(
                "high".to_owned(),
                vec![Transition::ConstantThresh(
                    "freq0.y".to_owned(),
                    ThreshOp::Gt { by: 0.0 },
                    100_000.0,
                )],
            )]),
        ),
        ("high".to_owned(), BTreeMap::from([])),
    ]);

    let cfg = MachineCfg {
        save_outputs: true,
        entry: "low".to_owned(),
        link_folder: Some("machine".to_owned()),
        timeouts,
        transitions,
    };
    let cfg_str = serde_json::to_string_pretty(&cfg).unwrap();

    let machine_dir = op_dir.join("machine");
    let fp = machine_dir.join("cfg.json");
    std::fs::write(fp, cfg_str).unwrap();

    let machine = SequenceMachine::load_folder(&machine_dir).unwrap();
    controller.add_calc("sequence_machine", machine);

    // Serialize and deserialize the controller (for demonstration purposes)
    let serialized_controller = serde_json::to_string_pretty(&controller).unwrap();
    let _: Controller = serde_json::from_str(&serialized_controller).unwrap();
    // std::fs::write("./multi_daq.json", &serialized_controller);

    // Print graphviz dot representation of expression graph
    println!("{}", controller.graphviz_dot());

    // Print graphviz dot representation of sequence machine
    let machine = SequenceMachine::load_folder(&machine_dir).unwrap();
    println!("{}", machine.graphviz_dot());

    // Run the control program
    info!("Starting controller");
    controller.run(&peripheral_plugins, None).unwrap();
}