nlabapi 1.0.6

Communication with nLab devices
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

use std::thread;
use std::time::Duration;
use pyo3::exceptions::*;
use pyo3::prelude::*;
use crate::{LabBench, python};

#[pymethods]
impl python::LabBench {
    #[staticmethod]
    fn open_first_available() -> PyResult<python::Nlab> {
        if let Ok(bench) = LabBench::new() {
            return match bench.open_first_available(true) {
                Ok(scope) => Ok(python::Nlab(scope)),
                Err(err) => {
                    if err.to_string().contains("downgrade") {
                        let error_lines = [
                            "Device detected with newer firmware than the installed nlabapi.",
                            "To ensure compatibility, please update nlabapi by running:",
                            "    pip install --upgrade nlabapi",
                        ];
                        Err(PyRuntimeError::new_err(error_lines.join("\n")))
                    } else {
                        Err(PyRuntimeError::new_err(err))
                    }
                },
            };
        }
        Err(PyRuntimeError::new_err("Cannot create LabBench"))
    }

    #[staticmethod]
    fn list_all_nlabs() {
        if let Ok(bench) = LabBench::new() {
            for nlab_link in bench.list() {
                println!("{nlab_link:?}");
            }
        } else {
            println!("Cannot create LabBench");
        }
    }

    #[staticmethod]
    fn count_connected_nlabs() -> usize {
        if let Ok(bench) = LabBench::new() {
            return bench.list().count();
        }
        0
    }

    #[staticmethod]
    #[pyo3(signature = (force_downgrade=false))]
    pub(super) fn update_all_nlabs(force_downgrade:bool) -> PyResult<()> {
        if let Ok(mut bench) = LabBench::new() {
            if bench.list().count() == 0 {
                return Err(PyRuntimeError::new_err("No nLab devices found."));
            }

            for nlab_link in bench.list() {
                if nlab_link.must_be_downgraded() {
                    let error_lines = [
                        "Device detected with newer firmware than the installed nlabapi.",
                        "To ensure compatibility, please update nlabapi by running:",
                        "    pip install --upgrade nlabapi",
                    ];
                    if force_downgrade {
                        println!("{}", error_lines.join("\n"));
                        println!("Forcing downgrade by request")
                    } else {
                        return Err(PyRuntimeError::new_err(error_lines.join("\n")));
                    }
                }
            }

            let mut device_update_count = 0;
            for nlab_link in bench.list() {
                if nlab_link.needs_update {
                    if let Err(e) = nlab_link.request_dfu() {
                        println!("Failed to request DFU on an available nLab: {e}");
                        return Err(PyRuntimeError::new_err(format!("{e}")));
                    } else {
                        device_update_count += 1;
                    }
                }
            }

            if device_update_count == 0 {
                println!("No firmware updates are needed for connected nLab devices.");
                return Ok(());
            }
            match device_update_count {
                1 => { println!("Updating connected nLab...") }
                _ => { println!("Updating {device_update_count} connected nLabs...") }
            }

            // Wait 500ms for the scope to detach and re-attach as DFU
            thread::sleep(Duration::from_millis(500));
            bench.refresh();

            for nlab_link in bench.list() {
                if nlab_link.in_dfu {
                    if let Err(e) = nlab_link.update() {
                        println!("Encountered an error updating nLab: {e}");
                        return Err(PyRuntimeError::new_err(format!("{e}")));
                    } else {
                        device_update_count -= 1;
                    }
                }
            }
            if device_update_count == 0 {
                println!("Update complete!");
            } else {
                match device_update_count {
                    1 => { println!("Failed to update {device_update_count} nLab") }
                    _ => { println!("Failed to update {device_update_count} nLabs") }
                }
            }
        }
        Ok(())
    }
}