Struct ads::client::Device

source · [−]

pub struct Device<'c> {
    pub client: &'c Client,
    /* private fields */
}

Expand description

A Client wrapper that talks to a specific ADS device.

Fields

client: &'c Client

The underlying Client.

Implementations

source

impl<'c> Device<'c>

source

pub fn get_info(&self) -> Result<DeviceInfo>

Read the device’s name + version.

source

pub fn read(
 &self,
 index_group: u32,
 index_offset: u32,
 data: &mut [u8 ]
) -> Result<usize>

Read some data at a given index group/offset. Returned data can be shorter than the buffer, the length is the return value.

source

pub fn read_exact(
 &self,
 index_group: u32,
 index_offset: u32,
 data: &mut [u8 ]
) -> Result<()>

Read some data at a given index group/offset, ensuring that the returned data has exactly the size of the passed buffer.

source

pub fn write(
 &self,
 index_group: u32,
 index_offset: u32,
 data: &[u8 ]
) -> Result<()>

Write some data to a given index group/offset.

source

pub fn write_read(
 &self,
 index_group: u32,
 index_offset: u32,
 write_data: &[u8 ],
 read_data: &mut [u8 ]
) -> Result<usize>

Write some data to a given index group/offset and then read back some reply from there. This is not the same as a write() followed by read(); it is used as a kind of RPC call.

source

pub fn write_read_exact(
 &self,
 index_group: u32,
 index_offset: u32,
 write_data: &[u8 ],
 read_data: &mut [u8 ]
) -> Result<()>

Like write_read, but ensure the returned data length matches the output buffer.

source

pub fn get_state(&self) -> Result<(AdsState, u16 )>

Return the ADS and device state of the device.

source

pub fn write_control(&self, ads_state: AdsState, dev_state: u16) -> Result<()>

(Try to) set the ADS and device state of the device.

source

pub fn add_notification(
 &self,
 index_group: u32,
 index_offset: u32,
 attributes: &Attributes
) -> Result<Handle>

Add a notification handle for some index group/offset.

Notifications are delivered via a MPMC channel whose reading end can be obtained from get_notification_channel on the Client object. The returned Handle can be used to check which notification has fired.

If the notification is not deleted explictly using delete_notification and the Handle, it is deleted when the Client object is dropped.

source