micromanager 0.2.0

Rust port of the MicroManager microscopy control framework
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

//! OpenFlexure (Sangaboard) device adapter.
//!
//! ASCII protocol (newline-terminated commands, \r terminated responses):
//! - version:         send "version"       → "Sangaboard v0.5.x"
//! - position query:  send "p"             → "<x> <y> <z>"
//! - relative XY:     send "mrx <steps>"   then "mry <steps>"
//! - relative Z:      send "mrz <steps>"
//! - zero:            send "zero"
//! - stop:            send "stop"
//! - release motors:  send "release"
//! - non-blocking:    send "blocking_moves false" → "done"
//! - busy?:           send "moving?"       → "true" or "false"
//! - step delay:      send "dt <us>"       (set), "dt?" (query → "minimum step delay <n>")
//! - ramp time:       send "ramp_time <us>", "ramp_time?" → "ramp_time <n>"
//!
//! Devices exported:
//! - `SangaBoardHub` — Hub
//! - `OFXYStage`     — XYStage
//! - `OFZStage`      — Stage
//! - `OFShutter`     — Shutter (LED illumination)

pub mod hub;
pub mod xystage;
pub mod zstage;
pub mod shutter;

pub use hub::SangaBoardHub;
pub use xystage::OfXYStage;
pub use zstage::OfZStage;
pub use shutter::OfShutter;

use crate::traits::{AdapterModule, AnyDevice, DeviceInfo};
use crate::types::DeviceType;

pub const DEVICE_NAME_HUB: &str = "SangaBoardHub";
pub const DEVICE_NAME_XYSTAGE: &str = "OFXYStage";
pub const DEVICE_NAME_ZSTAGE: &str = "OFZStage";
pub const DEVICE_NAME_SHUTTER: &str = "OFShutter";

static DEVICE_LIST: &[DeviceInfo] = &[
    DeviceInfo { name: DEVICE_NAME_HUB,     description: "Sangaboard Hub",           device_type: DeviceType::Hub },
    DeviceInfo { name: DEVICE_NAME_XYSTAGE,  description: "OpenFlexure XY stage",     device_type: DeviceType::XYStage },
    DeviceInfo { name: DEVICE_NAME_ZSTAGE,   description: "OpenFlexure Z stage",      device_type: DeviceType::Stage },
    DeviceInfo { name: DEVICE_NAME_SHUTTER,  description: "OpenFlexure LED shutter",  device_type: DeviceType::Shutter },
];

pub struct OpenFlexureAdapter;

impl AdapterModule for OpenFlexureAdapter {
    fn module_name(&self) -> &'static str { "openflexure" }
    fn devices(&self) -> &'static [DeviceInfo] { DEVICE_LIST }
    fn create_device(&self, name: &str) -> Option<AnyDevice> {
        match name {
            DEVICE_NAME_HUB     => Some(AnyDevice::Hub(Box::new(SangaBoardHub::new()))),
            DEVICE_NAME_XYSTAGE => Some(AnyDevice::XYStage(Box::new(OfXYStage::new()))),
            DEVICE_NAME_ZSTAGE  => Some(AnyDevice::Stage(Box::new(OfZStage::new()))),
            DEVICE_NAME_SHUTTER => Some(AnyDevice::Shutter(Box::new(OfShutter::new()))),
            _ => None,
        }
    }
}