pros-devices 0.2.1

High level device for pros-rs
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

//! ADI expander module support.
//!
//! The ADI expander API is similar to that of [`Peripherals`].
//! A main difference between the two is that ADI expanders can be created safely without returning an option.
//! This is because they require a [`SmartPort`] to be created which can only be created without either peripherals struct unsafely.

use super::{SmartDevice, SmartDeviceType, SmartPort};
use crate::adi::AdiPort;

/// Represents an ADI expander module plugged into a smart port.
///
/// ADI Expanders allow a smart port to be used as an "adapter" for eight additional ADI slots
/// if all onboard [`AdiPort`]s are used.
///
/// This struct gives access to [`AdiPort`]s similarly to how [`Peripherals`] works. Ports may
/// be partially moved out of this struct to create devices.
#[derive(Debug, Eq, PartialEq)]
pub struct AdiExpander {
    /// ADI port A on the expander.
    pub adi_a: AdiPort,
    /// ADI port B on the expander.
    pub adi_b: AdiPort,
    /// ADI Port C on the expander.
    pub adi_c: AdiPort,
    /// ADI Port D on the expander.
    pub adi_d: AdiPort,
    /// ADI Port E on the expander.
    pub adi_e: AdiPort,
    /// ADI Port F on the expander.
    pub adi_f: AdiPort,
    /// ADI Port G on the expander.
    pub adi_g: AdiPort,
    /// ADI Port H on the expander.
    pub adi_h: AdiPort,

    port: SmartPort,
}

impl AdiExpander {
    /// Create a new expander from a smart port index.
    pub fn new(port: SmartPort) -> Self {
        unsafe {
            Self {
                adi_a: AdiPort::new(1, Some(port.index())),
                adi_b: AdiPort::new(2, Some(port.index())),
                adi_c: AdiPort::new(3, Some(port.index())),
                adi_d: AdiPort::new(4, Some(port.index())),
                adi_e: AdiPort::new(5, Some(port.index())),
                adi_f: AdiPort::new(6, Some(port.index())),
                adi_g: AdiPort::new(7, Some(port.index())),
                adi_h: AdiPort::new(8, Some(port.index())),
                port,
            }
        }
    }
}

impl SmartDevice for AdiExpander {
    fn port_index(&self) -> u8 {
        self.port.index()
    }

    fn device_type(&self) -> SmartDeviceType {
        SmartDeviceType::Adi
    }
}