Struct InputPin 

pub struct InputPin<S> { /* private fields */ }

An input pin readable by the component

Supported pin types are as follows

Type	Storage	Equivalent linuxcnc_hal_sys function
InputPin<f64>	f64	hal_pin_float_new
InputPin<u32>	u32	hal_pin_u32_new
InputPin<i32>	i32	hal_pin_s32_new
InputPin<bool>	bool	hal_pin_bit_new

Examples

Create a pin

This example creates an InputPin under demo-component.named-pin.

use linuxcnc_hal::{
   error::PinRegisterError,
   hal_pin::{InputPin},
   prelude::*,
   HalComponent, RegisterResources, Resources,
};
use std::{
   error::Error,
   thread,
   time::{Duration, Instant},
};

struct Pins {
   pin: InputPin<f64>,
}

impl Resources for Pins {
   type RegisterError = PinRegisterError;

   fn register_resources(comp: &RegisterResources) -> Result<Self, Self::RegisterError> {
       Ok(Pins {
           pin: comp.register_pin::<InputPin<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());

            thread::sleep(Duration::from_millis(1000));
        }

   Ok(())
}

Trait Implementations

impl<S: Debug> Debug for InputPin<S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S> Drop for InputPin<S>

fn drop(&mut self)

Executes the destructor for this type.

impl HalPin for InputPin<bool>

type Storage = bool

The underlying storage type for the given pin

fn name(&self) -> &str

Get the pin’s name

fn storage_mut(&self) -> Result<&mut Self::Storage, StorageError>

Get a mutable pointer to underlying shared memory storing this pin’s value

fn storage(&self) -> Result<&Self::Storage, StorageError>

Get a reference to the underlying shared memory storing the pin’s value

fn register( full_pin_name: &str, component_id: i32, ) -> Result<Self, PinRegisterError>

Register the pin with the LinuxCNC HAL

fn allocate_storage() -> Result<*mut *mut Self::Storage, StorageError>

Allocate memory using hal_malloc() for storing pin value in

impl HalPin for InputPin<f64>

type Storage = f64

The underlying storage type for the given pin

fn name(&self) -> &str

Get the pin’s name

fn storage_mut(&self) -> Result<&mut Self::Storage, StorageError>

Get a mutable pointer to underlying shared memory storing this pin’s value

fn storage(&self) -> Result<&Self::Storage, StorageError>

Get a reference to the underlying shared memory storing the pin’s value

fn register( full_pin_name: &str, component_id: i32, ) -> Result<Self, PinRegisterError>

Register the pin with the LinuxCNC HAL

fn allocate_storage() -> Result<*mut *mut Self::Storage, StorageError>

Allocate memory using hal_malloc() for storing pin value in

impl HalPin for InputPin<i32>

type Storage = i32

The underlying storage type for the given pin

fn name(&self) -> &str

Get the pin’s name

fn storage_mut(&self) -> Result<&mut Self::Storage, StorageError>

Get a mutable pointer to underlying shared memory storing this pin’s value

fn storage(&self) -> Result<&Self::Storage, StorageError>

Get a reference to the underlying shared memory storing the pin’s value

fn register( full_pin_name: &str, component_id: i32, ) -> Result<Self, PinRegisterError>

Register the pin with the LinuxCNC HAL

fn allocate_storage() -> Result<*mut *mut Self::Storage, StorageError>

Allocate memory using hal_malloc() for storing pin value in

impl HalPin for InputPin<u32>

type Storage = u32

The underlying storage type for the given pin

fn name(&self) -> &str

Get the pin’s name

fn storage_mut(&self) -> Result<&mut Self::Storage, StorageError>

Get a mutable pointer to underlying shared memory storing this pin’s value

fn storage(&self) -> Result<&Self::Storage, StorageError>

Get a reference to the underlying shared memory storing the pin’s value

fn register( full_pin_name: &str, component_id: i32, ) -> Result<Self, PinRegisterError>

Register the pin with the LinuxCNC HAL

fn allocate_storage() -> Result<*mut *mut Self::Storage, StorageError>

Allocate memory using hal_malloc() for storing pin value in

impl PinRead for InputPin<bool>

fn value(&self) -> Result<&<Self as HalPin>::Storage, StorageError>

Get the value of the pin

impl PinRead for InputPin<f64>

fn value(&self) -> Result<&<Self as HalPin>::Storage, StorageError>

Get the value of the pin

impl PinRead for InputPin<i32>

fn value(&self) -> Result<&<Self as HalPin>::Storage, StorageError>

Get the value of the pin

impl PinRead for InputPin<u32>

fn value(&self) -> Result<&<Self as HalPin>::Storage, StorageError>

Get the value of the pin