nicompiler_backend 0.3.0

A backend interface for National Instrument (NI) integration, offering streamlined experimental control systems with Rust's performance and safety guarantees.
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

pub mod channel;
pub mod device;
pub mod experiment;
pub mod instruction;
pub mod utils;

use nicompiler_backend::*;

// fn main() {
//     let mut exp = Experiment::new();
//     exp.add_do_device("PXI1Slot6", 1e6, None, None, None, None, None, None);
//     exp.add_do_channel("PXI1Slot6", 0, 0);
//     exp.add_do_channel("PXI1Slot6", 0, 4);
//     exp.high("PXI1Slot6", "port0/line0", 1., 4.);
//     exp.high("PXI1Slot6", "port0/line4", 2., 5.);
//     exp.compile_with_stoptime(10.);
//     println!(
//         "{:?}",
//         exp.devices()
//             .get("PXI1Slot6")
//             .unwrap()
//             .calc_signal_nsamps(0, 10, 10, true, false)
//     );
// }

fn main() {
    let mut exp = Experiment::new();
    // Define devices and associated channels
    exp.add_ao_device("PXI1Slot3", 1e6);
    exp.add_ao_channel("PXI1Slot3", 0);

    exp.add_ao_device("PXI1Slot4", 1e6);
    exp.add_ao_channel("PXI1Slot4", 0);

    exp.add_do_device("PXI1Slot6", 1e7);
    exp.add_do_channel("PXI1Slot6", 0, 0);
    exp.add_do_channel("PXI1Slot6", 0, 4);

    // Define synchronization behavior (refer to the "Device" struct for more information)
    exp.device_cfg_trig("PXI1Slot3", "PXI1_Trig0", true);
    exp.device_cfg_ref_clk("PXI1Slot3", "PXI1_Trig7", 1e7, true);

    exp.device_cfg_trig("PXI1Slot4", "PXI1_Trig0", false);
    exp.device_cfg_ref_clk("PXI1Slot4", "PXI1_Trig7", 1e7, false);

    exp.device_cfg_samp_clk_src("PXI1Slot6", "PXI1_Trig7");
    exp.device_cfg_trig("PXI1Slot6", "PXI1_Trig0", false);

    // PXI1Slot3/ao0 starts with a 1s-long 7Hz sine wave with offset 1
    // and unit amplitude, zero phase. Does not keep its value.
    exp.sine("PXI1Slot3", "ao0", 0., 1., false, 7., None, None, Some(1.));
    // Ends with a half-second long 1V constant signal which returns to zero
    exp.constant("PXI1Slot3", "ao0", 9., 0.5, 1., false);

    // We can also leave a defined channel empty: the device / channel will simply not be compiled

    // Both lines of PXI1Slot6 start with a one-second "high" at t=0 and a half-second high at t=9
    exp.high("PXI1Slot6", "port0/line0", 0., 1.);
    exp.high("PXI1Slot6", "port0/line0", 9., 0.5);
    // Alternatively, we can also define the same behavior via go_high/go_low
    exp.go_high("PXI1Slot6", "port0/line4", 0.);
    exp.go_low("PXI1Slot6", "port0/line4", 1.);

    exp.go_high("PXI1Slot6", "port0/line4", 9.);
    exp.go_low("PXI1Slot6", "port0/line4", 9.5);

    // Compile the experiment: this will stop the experiment at the last edit-time plus one tick
    exp.compile();

    // We can compile again with a specific stop_time (and add instructions in between)
    exp.compile_with_stoptime(10.); // Experiment signal will stop at t=10 now
    assert_eq!(exp.compiled_stop_time(), 10.);
}