Enum Packet 

pub enum Packet {
    DataResponse {
        payloads: Vec<PayloadData>,
    },
    GetData {
        attributes: AttributeSet,
    },
    StartGraph {
        rate: GraphSampleRate,
    },
    StopGraph,
    Accept {
        id: u8,
    },
    Reject {
        id: u8,
    },
    NotReadable {
        id: u8,
    },
    Connect,
    Disconnect,
    EnablePdMonitor,
    DisablePdMonitor,
    MemoryRead {
        address: u32,
        size: u32,
    },
    StreamingAuth {
        credential: AuthCredential,
    },
    StreamingAuthResponse(StreamingAuthResult),
    Generic(RawPacket),
}

Variants

DataResponse

Data response with parsed payload data

Fields

payloads: Vec<PayloadData>

GetData

Request data with attribute set

Fields

attributes: AttributeSet

StartGraph

Start AdcQueue graph mode with sample rate.

CtrlHeader places the logical rate index (0=2SPS, 1=10SPS, 2=50SPS, 3=1000SPS) in the wire header, producing byte 2 values 0, 2, 4, and 6 respectively. A header carrying an index outside that range parses as Packet::Generic rather than being coerced into a known rate.

Fields

rate: GraphSampleRate

StopGraph

Stop AdcQueue graph mode

Accept

Accept response

Fields

id: u8

Reject

Reject response

Fields

id: u8

NotReadable

NotReadable response - memory address not accessible

Fields

id: u8

Connect

Connect command

Disconnect

Disconnect command

EnablePdMonitor

Enable PD monitor/sniffer

DisablePdMonitor

Disable PD monitor/sniffer

MemoryRead

MemoryRead command (0x44) - read device memory with encrypted payload

Fields

address: u32

Memory address to read from

size: u32

Number of bytes to read

StreamingAuth

StreamingAuth command (0x4C) - authenticate for AdcQueue streaming

Fields

credential: AuthCredential

Device or calibration credential to authenticate with

StreamingAuthResponse(StreamingAuthResult)

StreamingAuth response (0x4C) - authentication result

Generic(RawPacket)

Generic packet for types we haven’t specifically implemented yet

Implementations

impl Packet

pub fn find_payload<'a, T: ?Sized>( &'a self, select: impl Fn(&'a PayloadData) -> Option<&'a T>, ) -> Option<&'a T>

Return the first payload for which select yields a value.

Only Packet::DataResponse carries payloads; every other variant yields None.

pub fn get_adc(&self) -> Option<&AdcDataSimple>

Get ADC data from the packet, if present.

pub fn get_adc_queue(&self) -> Option<&AdcQueueData>

Get AdcQueue data from the packet, if present.

Examples found in repository

examples/calibration_auth.rs (line 23)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut device = KM003C::new(DeviceConfig::vendor().skip_reset()).await?;
    let initial_level = device.state().map(|state| state.auth_level).unwrap_or(0);
    println!("Initial authentication level: {initial_level}");

    let result = device.authenticate_calibration().await?;
    println!(
        "Calibration authentication level: {} (attribute 0x{:04x})",
        result.auth_level, result.attribute
    );

    device.start_graph_mode(GraphSampleRate::Sps50).await?;
    tokio::time::sleep(Duration::from_millis(200)).await;
    let response = device.request_data(AttributeSet::single(Attribute::AdcQueue)).await;
    device.stop_graph_mode().await?;

    let response = response?;
    let samples = response.get_adc_queue().map(|queue| queue.samples.len()).unwrap_or(0);
    println!("AdcQueue samples received after level-2 auth: {samples}");

    Ok(())
}

pub fn get_adc_queue_raw(&self) -> Option<&AdcQueueRawData>

Get losslessly parsed AdcQueue data whose graph rate is unknown.

pub fn get_pd_status(&self) -> Option<&PdStatus>

Get PD status from the packet, if present.

pub fn get_pd_events(&self) -> Option<&PdEventStream>

Get PD events from the packet, if present.

pub fn get_pd_trace(&self) -> Option<&PdTrace>

Get the internal PD state-machine trace, if present.

pub fn get_settings(&self) -> Option<&Settings>

Get the read-only settings payload, if present.

pub fn get_log_metadata(&self) -> Option<&LogMetadataResponse>

Get the response to a LogMetadata request, if present.

pub fn has_payload(&self, attr: Attribute) -> bool

Check if packet has a specific payload type

impl Packet

pub fn from_raw_with_graph_rate( raw_packet: RawPacket, rate: GraphSampleRate, ) -> Result<Self, KMError>

Parse a raw packet using the configured AdcQueue graph rate.

Live device users should supply the rate used with StartGraph because auxiliary AdcQueue voltage fields use rate-dependent units.

impl Packet

pub fn to_raw_packet(self, id: u8) -> Result<RawPacket, KMError>

Convert a high-level packet to a raw packet with the given transaction ID

Trait Implementations

impl Clone for Packet

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Packet

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

Formats the value using the given formatter.

impl PartialEq for Packet

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Packet

impl TryFrom<RawPacket> for Packet

type Error = KMError

The type returned in the event of a conversion error.

fn try_from(raw_packet: RawPacket) -> Result<Self, Self::Error>

Performs the conversion.