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 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
use crate::hal_pin::{pin_direction::PinDirection, PinRead, PinWrite};
use linuxcnc_hal_sys::{hal_pin_bit_new, hal_pin_float_new, hal_pin_s32_new, hal_pin_u32_new};
/// A pin that can be both read from and written to
///
/// Supported pin types are as follows
///
/// | Type | Storage | Equivalent `linuxcnc_hal_sys` function |
/// | ------------------------ | ------- | -------------------------------------- |
/// | `BidirectionalPin<f64>` | `f64` | [`hal_pin_float_new`] |
/// | `BidirectionalPin<u32>` | `u32` | [`hal_pin_u32_new`] |
/// | `BidirectionalPin<i32>` | `i32` | [`hal_pin_s32_new`] |
/// | `BidirectionalPin<bool>` | `bool` | [`hal_pin_bit_new`] |
///
/// # Examples
///
/// ## Create a pin
///
/// This example creates a `BidirectionalPin` under `demo-component.named-pin`.
///
/// ```rust,no_run
/// use linuxcnc_hal::{
/// error::PinRegisterError,
/// hal_pin::{BidirectionalPin},
/// prelude::*,
/// HalComponent, RegisterResources, Resources,
/// };
/// use std::{
/// error::Error,
/// thread,
/// time::{Duration, Instant},
/// };
///
/// struct Pins {
/// pin: BidirectionalPin<f64>,
/// }
///
/// impl Resources for Pins {
/// type RegisterError = PinRegisterError;
///
/// fn register_resources(comp: &RegisterResources) -> Result<Self, Self::RegisterError> {
/// Ok(Pins {
/// pin: comp.register_pin::<BidirectionalPin<f64>>("named-pin")?,
/// })
/// }
/// }
///
/// fn main() -> Result<(), Box<dyn Error>> {
/// let comp: HalComponent<Pins> = HalComponent::new("demo-component")?;
///
/// let Pins { pin } = comp.resources();
///
/// let start = Instant::now();
///
/// // Main control loop
/// while !comp.should_exit() {
/// println!("Input: {:?}", pin.value());
///
/// pin.set_value(123.45f64);
///
/// thread::sleep(Duration::from_millis(1000));
/// }
///
/// Ok(())
/// }
/// ```
#[derive(Debug)]
pub struct BidirectionalPin<S> {
pub(crate) name: String,
pub(crate) storage: *mut *mut S,
}
impl<S> Drop for BidirectionalPin<S> {
fn drop(&mut self) {
debug!("Drop BidirectionalPin {}", self.name);
}
}
impl_pin!(
BidirectionalPin,
f64,
hal_pin_float_new,
PinDirection::Bidirectional
);
impl_pin!(
BidirectionalPin,
u32,
hal_pin_u32_new,
PinDirection::Bidirectional
);
impl_pin!(
BidirectionalPin,
i32,
hal_pin_s32_new,
PinDirection::Bidirectional
);
impl_pin!(
BidirectionalPin,
bool,
hal_pin_bit_new,
PinDirection::Bidirectional
);
impl PinWrite for BidirectionalPin<f64> {}
impl PinWrite for BidirectionalPin<u32> {}
impl PinWrite for BidirectionalPin<i32> {}
impl PinWrite for BidirectionalPin<bool> {}
impl PinRead for BidirectionalPin<f64> {}
impl PinRead for BidirectionalPin<u32> {}
impl PinRead for BidirectionalPin<i32> {}
impl PinRead for BidirectionalPin<bool> {}