Struct ethercat_soem_ctx::Slave

source · [−]

#[repr(C)]
pub struct Slave(_);

Expand description

SOEM ec_slave wrapper

Implementations

source

impl Slave

source

pub const fn state(&self) -> u16

State of slave

source

pub fn set_state(&mut self, s: u16)

Set state slave

source

pub const fn al_status_code(&self) -> u16

AL status code

source

pub const fn config_addr(&self) -> u16

Configured address

source

pub const fn alias_addr(&self) -> u16

Alias address

source

pub const fn eep_man(&self) -> u32

Manufacturer from EEprom

source

pub const fn eep_id(&self) -> u32

ID from EEprom

source

pub const fn eep_rev(&self) -> u32

Revision from EEprom

source

pub const fn interface_type(&self) -> u16

Interface type

source

pub const fn device_type(&self) -> u16

Device type

source

pub const fn output_bits(&self) -> u16

Output bits

source

pub const fn output_bytes(&self) -> u32

Output bytes

if output_bits < 8 then output_bytes = 0

source

pub fn outputs(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl Read for &'_ [u8]impl Write for &'_ mut [u8]`

Imptable access to output data

source

pub fn outputs_mut(&mut self) -> &mut [u8 ]ⓘNotable traits for &'_ [u8 ]`impl Read for &'_ [u8]impl Write for &'_ mut [u8]`

Mutable access to output data

source

pub const fn output_start_bit(&self) -> u8

Startbit in first output byte

source

pub const fn input_bits(&self) -> u16

Input bits

source

pub const fn input_bytes(&self) -> u32

Input bytes

if input_bits < 8 then input_bytes = 0

source

pub fn inputs(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl Read for &'_ [u8]impl Write for &'_ mut [u8]`

Inputs

source

pub const fn input_start_bit(&self) -> u8

Startbit in first input byte

source

pub fn sm(&self) -> &[Sm; 8]

SM structure

source

pub const fn sm_type(&self) -> [u8 ; 8]

SM type

0 = unused 1 = MbxWr 2 = MbxRd 3 = Outputs 4 = Inputs

source

pub const fn fmmu(&self) -> &[ec_fmmut ; 4]

FMMU structure

source

pub const fn fmmu_0_func(&self) -> u8

FMMU 0 function

source

pub const fn fmmu_1_func(&self) -> u8

FMMU 1 function

source

pub const fn fmmu_2_func(&self) -> u8

FMMU 2 function

source

pub const fn fmmu_3_func(&self) -> u8

FMMU 3 function

source

pub const fn mbx_l(&self) -> u16

Length of write mailbox in bytes, if no mailbox then 0

source

pub const fn mbx_wo(&self) -> u16

mailbox write offset

source

pub const fn mbx_rl(&self) -> u16

Length of read mailbox in bytes

source

pub const fn mbx_ro(&self) -> u16

Mailbox read offset

source

pub const fn mbx_proto(&self) -> u16

Mailbox supported protocols

source

pub const fn mbx_cnt(&self) -> u8

Counter value of mailbox link layer protocol 1..7

source

pub const fn has_dc(&self) -> bool

Has DC capability

source

pub const fn parent_port(&self) -> u8

Port number on parent this slave is connected to

source

pub const fn entry_port(&self) -> u8

Port number on this slave the parent is connected to

source

pub const fn dc_recv_times_a(&self) -> i32

DC receivetimes on port A

source

pub const fn dc_recv_times_b(&self) -> i32

DC receivetimes on port B

source

pub const fn dc_recv_times_c(&self) -> i32

DC receivetimes on port C

source

pub const fn dc_recv_times_d(&self) -> i32

DC receivetimes on port D

source

pub const fn propagation_delay(&self) -> Duration

Propagation delay

source

pub const fn coe_details(&self) -> u8

CoE details

source

pub const fn foe_details(&self) -> u8

FoE details

source

pub const fn eoe_details(&self) -> u8

EoE details

source

pub const fn soe_details(&self) -> u8

SoE details

source

pub const fn ebus_current(&self) -> i16

E-bus current

source

pub const fn group(&self) -> u8

Group

source

pub const fn fmmu_unused(&self) -> u8

First unused FMMU

source

pub const fn is_lost(&self) -> bool

Boolean for tracking whether the slave is (not) responding, not used/set by the SOEM library

source

pub fn name(&self) -> String

Readable name

Trait Implementations

source

impl Debug for Slave

source

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

Formats the value using the given formatter. Read more

source

impl Default for Slave

source

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations

impl RefUnwindSafe for Slave

impl !Send for Slave

impl !Sync for Slave

impl Unpin for Slave

impl UnwindSafe for Slave

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct ethercat_soem_ctx::Slave

Implementations

impl Slave

pub const fn state(&self) -> u16

pub fn set_state(&mut self, s: u16)

pub const fn al_status_code(&self) -> u16

pub const fn config_addr(&self) -> u16

pub const fn alias_addr(&self) -> u16

pub const fn eep_man(&self) -> u32

pub const fn eep_id(&self) -> u32

pub const fn eep_rev(&self) -> u32

pub const fn interface_type(&self) -> u16

pub const fn device_type(&self) -> u16

pub const fn output_bits(&self) -> u16

pub const fn output_bytes(&self) -> u32

pub fn outputs(&self) -> &[u8]ⓘNotable traits for &'_ [u8]impl Read for &'_ [u8]impl Write for &'_ mut [u8]

pub fn outputs_mut(&mut self) -> &mut [u8]ⓘNotable traits for &'_ [u8]impl Read for &'_ [u8]impl Write for &'_ mut [u8]

pub const fn output_start_bit(&self) -> u8

pub const fn input_bits(&self) -> u16

pub const fn input_bytes(&self) -> u32

pub fn inputs(&self) -> &[u8]ⓘNotable traits for &'_ [u8]impl Read for &'_ [u8]impl Write for &'_ mut [u8]

pub const fn input_start_bit(&self) -> u8

pub fn sm(&self) -> &[Sm; 8]

pub const fn sm_type(&self) -> [u8; 8]

pub const fn fmmu(&self) -> &[ec_fmmut; 4]

pub const fn fmmu_0_func(&self) -> u8

pub const fn fmmu_1_func(&self) -> u8

pub const fn fmmu_2_func(&self) -> u8

pub const fn fmmu_3_func(&self) -> u8

pub const fn mbx_l(&self) -> u16

pub const fn mbx_wo(&self) -> u16

pub const fn mbx_rl(&self) -> u16

pub const fn mbx_ro(&self) -> u16

pub const fn mbx_proto(&self) -> u16

pub const fn mbx_cnt(&self) -> u8

pub const fn has_dc(&self) -> bool

pub const fn parent_port(&self) -> u8

pub const fn entry_port(&self) -> u8

pub const fn dc_recv_times_a(&self) -> i32

pub const fn dc_recv_times_b(&self) -> i32

pub const fn dc_recv_times_c(&self) -> i32

pub const fn dc_recv_times_d(&self) -> i32

pub const fn propagation_delay(&self) -> Duration

pub const fn coe_details(&self) -> u8

pub const fn foe_details(&self) -> u8

pub const fn eoe_details(&self) -> u8

pub const fn soe_details(&self) -> u8

pub const fn ebus_current(&self) -> i16

pub const fn group(&self) -> u8

pub const fn fmmu_unused(&self) -> u8

pub const fn is_lost(&self) -> bool

pub fn name(&self) -> String

Trait Implementations

impl Debug for Slave

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

impl Default for Slave

fn default() -> Self

Auto Trait Implementations

impl RefUnwindSafe for Slave

impl !Send for Slave

impl !Sync for Slave

impl Unpin for Slave

impl UnwindSafe for Slave

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub fn outputs(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl Read for &'_ [u8]impl Write for &'_ mut [u8]`

pub fn outputs_mut(&mut self) -> &mut [u8 ]ⓘNotable traits for &'_ [u8 ]`impl Read for &'_ [u8]impl Write for &'_ mut [u8]`

pub fn inputs(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl Read for &'_ [u8]impl Write for &'_ mut [u8]`

pub const fn sm_type(&self) -> [u8 ; 8]

pub const fn fmmu(&self) -> &[ec_fmmut ; 4]

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,