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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

//! ESP32 device adapter.
//!
//! ASCII protocol (all commands terminated with \r\n):
//! - Version:    send `V`       → "MM-ESP32,<version>"
//! - Stage range: send `U,<axis>` → "U,<range_um>"   (axis 0=X, 1=Y, 2=Z)
//! - Switch:     send `S,<val>\r\n` (simplex, no handshake)
//! - DA/PWM:     send `O,<ch>,<val>\r\n`
//! - XY move (relative): send `mrx <steps>\r\n` then `mry <steps>\r\n`
//! - Z move (relative):  send `mrz <steps>\r\n`
//! - Trigger:    send `R\r\n` (start), `E\r\n` (end) → "E,<count>"
//!
//! Devices exported:
//! - `ESP32-Hub`     — Hub
//! - `ESP32-Switch`  — 8-bit StateDevice (12 positions)
//! - `ESP32-Shutter` — Shutter
//! - `ESP32-PWM0..4` — SignalIO PWM channels (5 channels, 0-based)
//! - `ZStage`        — Z Stage
//! - `XYStage`       — XY Stage

pub mod hub;
pub mod shutter;
pub mod switch;
pub mod pwm;
pub mod zstage;
pub mod xystage;

pub use hub::Esp32Hub;
pub use shutter::Esp32Shutter;
pub use switch::Esp32Switch;
pub use pwm::Esp32Pwm;
pub use zstage::Esp32ZStage;
pub use xystage::Esp32XYStage;

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

pub const DEVICE_NAME_HUB: &str = "ESP32-Hub";
pub const DEVICE_NAME_SWITCH: &str = "ESP32-Switch";
pub const DEVICE_NAME_SHUTTER: &str = "ESP32-Shutter";
pub const DEVICE_NAME_PWM0: &str = "ESP32-PWM0";
pub const DEVICE_NAME_PWM1: &str = "ESP32-PWM1";
pub const DEVICE_NAME_PWM2: &str = "ESP32-PWM2";
pub const DEVICE_NAME_PWM3: &str = "ESP32-PWM3";
pub const DEVICE_NAME_PWM4: &str = "ESP32-PWM4";
pub const DEVICE_NAME_ZSTAGE: &str = "ZStage";
pub const DEVICE_NAME_XYSTAGE: &str = "XYStage";

static DEVICE_LIST: &[DeviceInfo] = &[
    DeviceInfo { name: DEVICE_NAME_HUB,     description: "ESP32 Hub (required)",          device_type: DeviceType::Hub },
    DeviceInfo { name: DEVICE_NAME_SWITCH,   description: "ESP32 digital output switch",   device_type: DeviceType::State },
    DeviceInfo { name: DEVICE_NAME_SHUTTER,  description: "ESP32 shutter",                 device_type: DeviceType::Shutter },
    DeviceInfo { name: DEVICE_NAME_PWM0,     description: "ESP32 PWM channel 0",           device_type: DeviceType::SignalIO },
    DeviceInfo { name: DEVICE_NAME_PWM1,     description: "ESP32 PWM channel 1",           device_type: DeviceType::SignalIO },
    DeviceInfo { name: DEVICE_NAME_PWM2,     description: "ESP32 PWM channel 2",           device_type: DeviceType::SignalIO },
    DeviceInfo { name: DEVICE_NAME_PWM3,     description: "ESP32 PWM channel 3",           device_type: DeviceType::SignalIO },
    DeviceInfo { name: DEVICE_NAME_PWM4,     description: "ESP32 PWM channel 4",           device_type: DeviceType::SignalIO },
    DeviceInfo { name: DEVICE_NAME_ZSTAGE,   description: "ESP32 Z stage",                 device_type: DeviceType::Stage },
    DeviceInfo { name: DEVICE_NAME_XYSTAGE,  description: "ESP32 XY stage",                device_type: DeviceType::XYStage },
];

pub struct Esp32Adapter;

impl AdapterModule for Esp32Adapter {
    fn module_name(&self) -> &'static str { "esp32" }
    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(Esp32Hub::new()))),
            DEVICE_NAME_SWITCH  => Some(AnyDevice::StateDevice(Box::new(Esp32Switch::new()))),
            DEVICE_NAME_SHUTTER => Some(AnyDevice::Shutter(Box::new(Esp32Shutter::new()))),
            DEVICE_NAME_PWM0    => Some(AnyDevice::SignalIO(Box::new(Esp32Pwm::new(0)))),
            DEVICE_NAME_PWM1    => Some(AnyDevice::SignalIO(Box::new(Esp32Pwm::new(1)))),
            DEVICE_NAME_PWM2    => Some(AnyDevice::SignalIO(Box::new(Esp32Pwm::new(2)))),
            DEVICE_NAME_PWM3    => Some(AnyDevice::SignalIO(Box::new(Esp32Pwm::new(3)))),
            DEVICE_NAME_PWM4    => Some(AnyDevice::SignalIO(Box::new(Esp32Pwm::new(4)))),
            DEVICE_NAME_ZSTAGE  => Some(AnyDevice::Stage(Box::new(Esp32ZStage::new()))),
            DEVICE_NAME_XYSTAGE => Some(AnyDevice::XYStage(Box::new(Esp32XYStage::new()))),
            _ => None,
        }
    }
}