Skip to main content

DeviceConfig

Struct DeviceConfig 

Source
pub struct DeviceConfig { /* private fields */ }
Expand description

Configuration for KM003C device communication

Specifies which USB interface to use. The interface determines the connection mode:

  • Vendor (Interface 0): Full mode - all features including AdcQueue
  • HID (Interface 3): Basic mode - ADC/PD polling only

§Examples

use km003c_lib::{KM003C, DeviceConfig};

// Full mode with vendor interface (fastest, all features)
let device = KM003C::new(DeviceConfig::vendor()).await?;

// Basic mode with HID interface (most compatible, ADC/PD only)
let device = KM003C::new(DeviceConfig::hid()).await?;

// With options
let device = KM003C::new(DeviceConfig::vendor().skip_reset()).await?;

Implementations§

Source§

impl DeviceConfig

Source

pub fn vendor() -> Self

Vendor interface (Interface 0) - Full mode with all features

This is the fastest option with ~0.6ms latency (6x faster than HID). Enables all features including AdcQueue streaming.

Performance:

  • Latency: ~600 µs per request
  • Throughput: ~200 KB/s

Features: Full mode - ADC, PD, AdcQueue, device info, authentication

Note: On Linux, requires detaching the powerz kernel driver, which this library handles automatically.

Source

pub fn hid() -> Self

HID interface (Interface 3) - Basic mode for ADC/PD polling

This is the most compatible option that works on all platforms without custom drivers. Only supports basic ADC and PD polling.

Performance:

  • Latency: ~3.8 ms per request
  • Throughput: ~60 KB/s

Features: Basic mode - ADC and PD polling only (no AdcQueue, no device info)

Advantages:

  • Works without driver installation on Windows/Mac/Linux
  • Uses standard HID protocol
  • No permission issues
Source

pub fn skip_reset(self) -> Self

Skip USB reset during connection

Some systems (particularly MacOS) may have issues with USB reset. Use this if device connection fails with reset errors.

Source

pub fn is_vendor(&self) -> bool

Check if this config uses vendor interface (full mode)

Source

pub fn is_hid(&self) -> bool

Check if this config uses HID interface (basic mode)

Trait Implementations§

Source§

impl Clone for DeviceConfig

Source§

fn clone(&self) -> DeviceConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for DeviceConfig

Source§

impl Debug for DeviceConfig

Source§

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

Formats the value using the given formatter. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more