Struct esp32c3_hal::twai::filter::SingleStandardFilter

pub struct SingleStandardFilter { /* private fields */ }

A filter that matches against a single 11 bit id, the rtr bit, and the first two bytes of the payload.

Warning: This is not a perfect filter. Extended ids that match the bit layout of this filter will also be accepted.

Implementations

impl SingleStandardFilter

pub const fn new(
    id: &[u8; 11],
    rtr: &[u8; 1],
    payload: [&[u8; 8]; 2]
) -> SingleStandardFilter

Create a new filter that matches against a single 11-bit standard id. The filter can match against the packet’s id, rtr bit, and first two bytes of the payload.

Example matching only even ids, allowing any rtr value and any payload data:

const FILTER: SingleStandardFilter =
    SingleStandardFilter::new(b"xxxxxxxxxx0", b"x", [b"xxxxxxxx", b"xxxxxxxx"]);

pub fn new_from_code_mask(
    id_code: StandardId,
    id_mask: StandardId,
    rtr_code: bool,
    rtr_mask: bool,
    payload_code: [u8; 2],
    payload_mask: [u8; 2]
) -> SingleStandardFilter

The masks indicate which bits of the code the filter should match against. Set bits in the mask indicate that the corresponding bit in the code should match.

Examples

A filter that matches every standard id that is even, is not an rtr frame, with any bytes for the first two payload bytes.

let filter = twai::filter::SingleStandardFilter::new_from_code_mask(
    StandardId::new(0x000).unwrap(),
    StandardId::new(0x001).unwrap(),
    false,
    true,
    [0x00, 0x00],
    [0x00, 0x00],
);

Trait Implementations

impl Filter for SingleStandardFilter

const FILTER_TYPE: FilterType = FilterType::Single

The type of the filter.

fn to_registers(&self) -> [u8; 8]

Get the register level representation of the filter.

fn filter_type(&self) -> FilterType