thormotion 0.4.2

A cross-platform motion control library for Thorlabs systems, written in Rust.
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

/*
Project: thormotion
GitHub: https://github.com/MillieFD/thormotion

BSD 3-Clause License, Copyright (c) 2025, Amelia Fraser-Dale

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the conditions of the LICENSE are met.
*/

use std::fmt::{Debug, Display};
use std::hash::{Hash, Hasher};

use crate::devices::UsbPrimitive;

pub trait ThorlabsDevice<const CH: usize>: Debug + Display + Send + Sync {
    /// Returns a borrow that dereferences to the inner [`UsbPrimitive`]
    fn inner(&self) -> &UsbPrimitive<CH>;

    /// Returns the serial number of the device as a `&str`.
    fn serial_number(&self) -> &str {
        self.inner().serial_number()
    }

    /// Safely brings the [`USB Device`][1] to a resting state and releases the claimed
    /// [`Interface`][2].
    ///
    /// If the device [`Status`][3] is [`Closed`][4], a temporary [`Interface`][2] is [`Opened`][5]
    /// to send the abort command.
    ///
    /// Does not remove the device from the global [`DEVICES`][6] [`HashMap`][7]. You can use
    /// [`Open`][5] to resume communication.
    ///
    /// To release the claimed [`Interface`][2] without bringing the device to a resting state,
    /// use `close`.
    ///
    /// [1]: UsbPrimitive
    /// [2]: nusb::Interface
    /// [3]: crate::devices::usb_primitive::status::Status
    /// [4]: crate::devices::usb_primitive::status::Status::Closed
    /// [5]: UsbPrimitive::open
    /// [6]: crate::devices::utils::DEVICES
    /// [7]: ahash::HashMap
    fn abort(&self);
}

impl<const CH: usize> Hash for dyn ThorlabsDevice<CH> {
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.inner().serial_number().hash(state);
    }
}

impl<const CH: usize> PartialEq for dyn ThorlabsDevice<CH> {
    fn eq(&self, other: &Self) -> bool {
        self.inner().serial_number() == other.inner().serial_number()
    }
}

impl<const CH: usize> Eq for dyn ThorlabsDevice<CH> {}