Struct CanFilterModify

pub struct CanFilterModify {
    pub target_system: u8,
    pub target_component: u8,
    pub bus: u8,
    pub operation: CanFilterOp,
    pub num_ids: u8,
    pub ids: [u16; 16],
}

MAVLink CAN_FILTER_MODIFY message.

Minimum supported MAVLink version is MAVLink 2.

Description

Modify the filter of what CAN messages to forward over the mavlink. This can be used to make CAN forwarding work well on low bandwidth links. The filtering is applied on bits 8 to 24 of the CAN id (2nd and 3rd bytes) which corresponds to the DroneCAN message ID for DroneCAN. Filters with more than 16 IDs can be constructed by sending multiple CAN_FILTER_MODIFY messages.

Encoding/Decoding

Message encoding/decoding are provided by implementing core::convert::TryFrom<Payload> for CanFilterModify (encoding) and [IntoPayload] (decoding) traits. These traits are implemented by Message proc macro.

Fields

target_system: u8

MAVLink field target_system.

System ID.

target_component: u8

MAVLink field target_component.

Component ID.

bus: u8

MAVLink field bus.

bus number

operation: CanFilterOp

MAVLink field operation.

what operation to perform on the filter list. See CAN_FILTER_OP enum.

num_ids: u8

MAVLink field num_ids.

number of IDs in filter list

ids: [u16; 16]

MAVLink field ids.

filter IDs, length num_ids

Implementations

impl CanFilterModify

pub const ID: MessageId = 388u32

MavLink message ID.

pub const fn spec() -> MessageInfo

Returns specification for this message.

pub const fn message_id() -> MessageId

Message ID.

pub const fn crc_extra() -> CrcExtra

Message CRC_EXTRA.

pub const fn min_supported_mavlink_version() -> MavLinkVersion

Minimum supported MAVLink version for this message.

Trait Implementations

impl Clone for CanFilterModify

fn clone(&self) -> CanFilterModify

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CanFilterModify

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

Formats the value using the given formatter.

impl Default for CanFilterModify

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CanFilterModify

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CanFilterModify> for Common

fn from(value: CanFilterModify) -> Self

Converts to this type from the input type.

impl IntoPayload for CanFilterModify

fn encode(&self, version: MavLinkVersion) -> Result<Payload, SpecError>

Encodes message into MAVLink payload.

impl MessageSpec for CanFilterModify

fn id(&self) -> MessageId

MAVLink message ID.

fn min_supported_mavlink_version(&self) -> MavLinkVersion

Minimum supported MAVLink protocol version.

fn crc_extra(&self) -> CrcExtra

Message EXTRA_CRC calculated from message XML definition.

impl MessageSpecStatic for CanFilterModify

fn spec() -> MessageInfo

Returns specification for this message.

fn message_id() -> MessageId

Message ID.

fn crc_extra() -> CrcExtra

Message CRC_EXTRA.

fn min_supported_mavlink_version() -> MavLinkVersion

Minimum supported MAVLink version for this message.

impl NamedType for CanFilterModify

fn sid() -> SpectaID

fn named_data_type( type_map: &mut TypeCollection, generics: &[DataType], ) -> NamedDataType

this is equivalent to Type::inline but returns a NamedDataType instead.

fn definition_named_data_type(type_map: &mut TypeCollection) -> NamedDataType

this is equivalent to [Type::definition] but returns a NamedDataType instead.

impl PartialEq for CanFilterModify

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CanFilterModify

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Payload> for CanFilterModify

type Error = SpecError

The type returned in the event of a conversion error.

fn try_from(value: &Payload) -> Result<Self, Self::Error>

Performs the conversion.

impl Type for CanFilterModify

fn inline(type_map: &mut TypeCollection, generics: Generics<'_>) -> DataType

Returns the definition of a type using the provided generics.

fn reference(type_map: &mut TypeCollection, generics: &[DataType]) -> Reference

Generates a datatype corresponding to a reference to this type, as determined by its category. Getting a reference to a type implies that it should belong in the type map (since it has to be referenced from somewhere), so the output of definition will be put into the type map.

impl Flatten for CanFilterModify

impl Message for CanFilterModify

impl StructuralPartialEq for CanFilterModify