Skip to main content

ZWaveLayer

Struct ZWaveLayer 

Source
pub struct ZWaveLayer {
    pub index: LayerIndex,
}
Expand description

Z-Wave layer – a zero-copy view into a packet buffer.

Fields§

§index: LayerIndex

Implementations§

Source§

impl ZWaveLayer

Source

pub fn new(index: LayerIndex) -> Self

Create a new Z-Wave layer from a layer index.

Source

pub fn at_start(end: usize) -> Self

Create a Z-Wave layer starting at offset 0 (for standalone parsing).

Source

pub fn home_id(&self, buf: &[u8]) -> Result<u32, FieldError>

Read the 4-byte Home ID (big-endian u32) at offset 0.

Source

pub fn set_home_id(&self, buf: &mut [u8], value: u32) -> Result<(), FieldError>

Set the Home ID (big-endian u32) at offset 0.

Source

pub fn src(&self, buf: &[u8]) -> Result<u8, FieldError>

Read the source node ID at offset 4.

Source

pub fn set_src(&self, buf: &mut [u8], value: u8) -> Result<(), FieldError>

Set the source node ID at offset 4.

Source

pub fn frame_ctrl(&self, buf: &[u8]) -> Result<u8, FieldError>

Read the raw frame control byte at offset 5.

Source

pub fn set_frame_ctrl( &self, buf: &mut [u8], value: u8, ) -> Result<(), FieldError>

Set the raw frame control byte at offset 5.

Source

pub fn routed(&self, buf: &[u8]) -> Result<bool, FieldError>

Get the routed flag (bit 7 of frame control).

Source

pub fn set_routed(&self, buf: &mut [u8], value: bool) -> Result<(), FieldError>

Set the routed flag (bit 7 of frame control).

Source

pub fn ackreq(&self, buf: &[u8]) -> Result<bool, FieldError>

Get the ack request flag (bit 6 of frame control).

Source

pub fn set_ackreq(&self, buf: &mut [u8], value: bool) -> Result<(), FieldError>

Set the ack request flag (bit 6 of frame control).

Source

pub fn lowpower(&self, buf: &[u8]) -> Result<bool, FieldError>

Get the low power flag (bit 5 of frame control).

Source

pub fn set_lowpower( &self, buf: &mut [u8], value: bool, ) -> Result<(), FieldError>

Set the low power flag (bit 5 of frame control).

Source

pub fn speedmodified(&self, buf: &[u8]) -> Result<bool, FieldError>

Get the speed modified flag (bit 4 of frame control).

Source

pub fn set_speedmodified( &self, buf: &mut [u8], value: bool, ) -> Result<(), FieldError>

Set the speed modified flag (bit 4 of frame control).

Source

pub fn headertype(&self, buf: &[u8]) -> Result<u8, FieldError>

Get the header type (bits 3-0 of frame control).

Source

pub fn set_headertype( &self, buf: &mut [u8], value: u8, ) -> Result<(), FieldError>

Set the header type (bits 3-0 of frame control).

Source

pub fn beam_seqn(&self, buf: &[u8]) -> Result<u8, FieldError>

Read the raw beam/sequence byte at offset 6.

Source

pub fn set_beam_seqn(&self, buf: &mut [u8], value: u8) -> Result<(), FieldError>

Set the raw beam/sequence byte at offset 6.

Source

pub fn beam_control(&self, buf: &[u8]) -> Result<u8, FieldError>

Get the beam control field (bits 6-5 of beam/sequence byte).

Source

pub fn set_beam_control( &self, buf: &mut [u8], value: u8, ) -> Result<(), FieldError>

Set the beam control field (bits 6-5 of beam/sequence byte).

Source

pub fn seqn(&self, buf: &[u8]) -> Result<u8, FieldError>

Get the sequence number (bits 3-0 of beam/sequence byte).

Source

pub fn set_seqn(&self, buf: &mut [u8], value: u8) -> Result<(), FieldError>

Set the sequence number (bits 3-0 of beam/sequence byte).

Source

pub fn length(&self, buf: &[u8]) -> Result<u8, FieldError>

Read the length field at offset 7.

Source

pub fn set_length(&self, buf: &mut [u8], value: u8) -> Result<(), FieldError>

Set the length field at offset 7.

Source

pub fn dst(&self, buf: &[u8]) -> Result<u8, FieldError>

Read the destination node ID at offset 8.

Source

pub fn set_dst(&self, buf: &mut [u8], value: u8) -> Result<(), FieldError>

Set the destination node ID at offset 8.

Source

pub fn crc(&self, buf: &[u8]) -> Result<u8, FieldError>

Read the CRC byte. For ACK frames it is at offset 9. For REQ frames it is the last byte of the frame.

Source

pub fn set_crc(&self, buf: &mut [u8], value: u8) -> Result<(), FieldError>

Set the CRC byte (last byte of the frame).

Source

pub fn is_ack(&self, buf: &[u8]) -> bool

Returns true if this frame is an ACK (no payload – total length is 10).

Source

pub fn cmd_class(&self, buf: &[u8]) -> Result<u8, FieldError>

Read the command class byte at offset 9 (only valid for Req frames). In the wire format, the payload starts at offset 9 (between dst and crc). Layout for Req: [homeId(4), src(1), fc(1), bs(1), len(1), dst(1), cmdClass(1), cmd(1), …data, crc(1)]

Source

pub fn set_cmd_class(&self, buf: &mut [u8], value: u8) -> Result<(), FieldError>

Set the command class byte at offset 9.

Source

pub fn cmd(&self, buf: &[u8]) -> Result<u8, FieldError>

Read the command byte at offset 10 (only valid for Req frames with sufficient payload).

Source

pub fn set_cmd(&self, buf: &mut [u8], value: u8) -> Result<(), FieldError>

Set the command byte at offset 10.

Source

pub fn cmd_data<'a>(&self, buf: &'a [u8]) -> Result<&'a [u8], FieldError>

Read the command data bytes (everything after cmd and before CRC).

Source

pub fn verify_crc(&self, buf: &[u8]) -> bool

Verify the CRC of this frame. Computes XOR of all bytes except the last (starting from 0xFF) and compares with the stored CRC.

Source

pub fn summary(&self, buf: &[u8]) -> String

Generate a one-line summary of this Z-Wave frame.

Source

pub fn field_names() -> &'static [&'static str]

Get the field names for this layer.

Source

pub fn get_field( &self, buf: &[u8], name: &str, ) -> Option<Result<FieldValue, FieldError>>

Get a field value by name.

Source

pub fn set_field( &self, buf: &mut [u8], name: &str, value: FieldValue, ) -> Option<Result<(), FieldError>>

Set a field value by name.

Trait Implementations§

Source§

impl Clone for ZWaveLayer

Source§

fn clone(&self) -> ZWaveLayer

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ZWaveLayer

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Layer for ZWaveLayer

Source§

fn kind(&self) -> LayerKind

Get the kind of this layer
Source§

fn summary(&self, data: &[u8]) -> String

Get a human-readable summary of this layer
Source§

fn header_len(&self, data: &[u8]) -> usize

Get the header length for this layer
Source§

fn field_names(&self) -> &'static [&'static str]

Get the list of field names for this layer
Source§

fn hashret(&self, data: &[u8]) -> Vec<u8>

Compute a hash for packet matching.
Source§

fn answers(&self, data: &[u8], other: &Self, other_data: &[u8]) -> bool

Check if this packet answers another packet.
Source§

fn extract_padding<'a>(&self, data: &'a [u8]) -> (&'a [u8], &'a [u8])

Extract padding from the packet.

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> 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V