CanOpenInterface

Struct CanOpenInterface 

Source
pub struct CanOpenInterface {
    pub connection: Arc<Mutex<Connection>>,
    pub tx: Sender<TxPacket>,
    pub rx: Receiver<RxMessage>,
    pub sdo_clients: HashMap<u8, Arc<Mutex<SdoClient>>>,
    pub info: Arc<Mutex<CanOpenInfo>>,
    /* private fields */
}
Expand description

Struct representing a CANopen interface.

Fields§

§connection: Arc<Mutex<Connection>>

Connection details.

§tx: Sender<TxPacket>

Transmitter channel.

§rx: Receiver<RxMessage>

Receiver channel.

§sdo_clients: HashMap<u8, Arc<Mutex<SdoClient>>>

Map of SDO clients.

§info: Arc<Mutex<CanOpenInfo>>

CANopen information.

Implementations§

Source§

impl CanOpenInterface

Source

pub fn get_sdo_client(&self, node_id: u8) -> Option<Arc<Mutex<SdoClient>>>

Retrieves an SDO client for a given node ID.

§Arguments
  • node_id - The ID of the node.
§Returns

An Option containing an Arc<Mutex<SdoClient>> if found, otherwise None.

§Examples
let client = can_interface.get_sdo_client(2).unwrap();
client.lock().await.download(0x1801, 2, &[1u8]).await;
Source

pub async fn close()

Source§

impl CanOpenInterface

Source

pub async fn send_nmt(&self, nmt: NmtCommand) -> Result<(), CoError>

Sends an NMT command through the CANopen interface.

§Arguments
  • nmt - The NMT command to be sent.
§Returns

A Result indicating success or failure.

§Examples
use oze_canopen::CanOpenInterface;
use oze_canopen::proto::nmt::{NmtCommand, NmtCommandSpecifier};

let interface = oze_canopen::start_interface();
let result = interface.send_nmt(NmtCommand::new(NmtCommandSpecifier::StartRemoteNode, 0)).await;
Source

pub async fn send_nmt_command( &self, nmt_command: NmtCommandSpecifier, ) -> Result<(), CoError>

Sends an NMT command through the CANopen interface using a command specifier.

§Arguments
  • nmt_command - The NMT command specifier to be used.
§Returns

A Result indicating success or failure.

§Examples
use oze_canopen::CanOpenInterface;
use oze_canopen::proto::nmt::NmtCommandSpecifier;

let interface = oze_canopen::start_interface();
let result = interface.send_nmt_command(NmtCommandSpecifier::StartRemoteNode).await;
Source§

impl CanOpenInterface

Source

pub async fn send_sync(&self) -> Result<(), CoError>

Trait Implementations§

Source§

impl Clone for CanOpenInterface

Source§

fn clone(&self) -> Self

Clones the CanOpenInterface.

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.