micromanager 0.2.0

/// ArduinoShutter — controls the LSB of the digital output as a shutter.
///
/// In the original firmware, shutter state is bit 0 of the switch state.
/// This implementation owns a reference to the hub's shared state so it can
/// compose the full switch_state before sending to the hub.
use parking_lot::Mutex;
use std::sync::Arc;

use crate::error::{MmError, MmResult};
use crate::property::PropertyMap;
use crate::traits::{Device, Shutter};
use crate::types::{DeviceType, PropertyValue};

use super::hub::HubState;

/// A write callback: the shutter calls this to push a new switch state.
pub type SwitchWriter = Arc<dyn Fn(u16) -> MmResult<()> + Send + Sync>;

pub struct ArduinoShutter {
    props: PropertyMap,
    initialized: bool,
    shared: Option<Arc<Mutex<HubState>>>,
    writer: Option<SwitchWriter>,
}

impl ArduinoShutter {
    pub fn new() -> Self {
        let mut props = PropertyMap::new();
        props.define_property("OnOff", PropertyValue::String("Off".into()), false).unwrap();
        props.set_allowed_values("OnOff", &["On", "Off"]).unwrap();

        Self {
            props,
            initialized: false,
            shared: None,
            writer: None,
        }
    }

    /// Connect to hub's shared state and write callback.
    pub fn connect(mut self, shared: Arc<Mutex<HubState>>, writer: SwitchWriter) -> Self {
        self.shared = Some(shared);
        self.writer = Some(writer);
        self
    }

    fn write_state(&self, open: bool) -> MmResult<()> {
        let shared = self.shared.as_ref().ok_or(MmError::NotConnected)?;
        let writer = self.writer.as_ref().ok_or(MmError::NotConnected)?;

        let mut state = shared.lock();
        if open {
            state.switch_state |= 1;  // set bit 0
        } else {
            state.switch_state &= !1; // clear bit 0
        }
        let new_state = state.switch_state;
        drop(state);
        writer(new_state)
    }
}

impl Default for ArduinoShutter {
    fn default() -> Self {
        Self::new()
    }
}

impl Device for ArduinoShutter {
    fn name(&self) -> &str { "Arduino-Shutter" }
    fn description(&self) -> &str { "Arduino shutter (digital out LSB)" }

    fn initialize(&mut self) -> MmResult<()> {
        if self.shared.is_none() {
            return Err(MmError::CommHubMissing);
        }
        self.initialized = true;
        Ok(())
    }

    fn shutdown(&mut self) -> MmResult<()> {
        if self.initialized {
            let _ = self.write_state(false);
            self.initialized = false;
        }
        Ok(())
    }

    fn get_property(&self, name: &str) -> MmResult<PropertyValue> {
        self.props.get(name).cloned()
    }

    fn set_property(&mut self, name: &str, val: PropertyValue) -> MmResult<()> {
        if name == "OnOff" {
            let s = val.as_str().to_string();
            let open = s == "On";
            if self.initialized {
                self.write_state(open)?;
            }
        }
        self.props.set(name, val)
    }

    fn property_names(&self) -> Vec<String> {
        self.props.property_names().to_vec()
    }

    fn has_property(&self, name: &str) -> bool {
        self.props.has_property(name)
    }

    fn is_property_read_only(&self, name: &str) -> bool {
        self.props.entry(name).map(|e| e.read_only).unwrap_or(false)
    }

    fn device_type(&self) -> DeviceType { DeviceType::Shutter }
    fn busy(&self) -> bool { false }
}

impl Shutter for ArduinoShutter {
    fn set_open(&mut self, open: bool) -> MmResult<()> {
        if !self.initialized {
            return Err(MmError::NotConnected);
        }
        self.write_state(open)?;
        let val = PropertyValue::String(if open { "On" } else { "Off" }.into());
        let _ = self.props.set("OnOff", val);
        Ok(())
    }

    fn get_open(&self) -> MmResult<bool> {
        let shared = self.shared.as_ref().ok_or(MmError::NotConnected)?;
        Ok(shared.lock().switch_state & 1 != 0)
    }

    fn fire(&mut self, _delta_t: f64) -> MmResult<()> {
        self.set_open(true)
    }
}