Struct ParamRequestRead 

pub struct ParamRequestRead {
    pub target_system: u8,
    pub target_component: u8,
    pub param_id: [u8; 16],
    pub param_index: i16,
}

MAVLink PARAM_REQUEST_READ message.

The minimum supported MAVLink version is MAVLink 1.

Description

Request to read the onboard parameter with the param_id string id. Onboard parameters are stored as key[const char*] -> value[float]. This allows to send a parameter to any other component (such as the GCS) without the need of previous knowledge of possible parameter names. Thus the same GCS can store different parameters for different autopilots. See also https://mavlink.io/en/services/parameter.html for a full documentation of QGroundControl and IMU code.

Encoding/Decoding

Message encoding/decoding are provided by implementing core::convert::TryFrom<Payload> for ParamRequestRead (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

param_id: [u8; 16]

MAVLink field param_id.

Onboard parameter id, terminated by NULL if the length is less than 16 human-readable chars and WITHOUT null termination (NULL) byte if the length is exactly 16 chars

• applications have to provide 16+1 bytes storage if the ID is stored as string

param_index: i16

MAVLink field param_index.

Parameter index. Send -1 to use the param ID field as identifier (else the param id will be ignored)

Implementations

impl ParamRequestRead

pub const ID: u32 = 20u32

MavLink message ID.

pub const fn spec() -> MessageInfo

Returns specification for this message.

pub const fn message_id() -> u32

Message ID.

pub const fn crc_extra() -> u8

Message CRC_EXTRA.

pub const fn min_supported_mavlink_version() -> MavLinkVersion

Minimum supported MAVLink version for this message.

Trait Implementations

impl Clone for ParamRequestRead

fn clone(&self) -> ParamRequestRead

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParamRequestRead

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

Formats the value using the given formatter.

impl Default for ParamRequestRead

fn default() -> ParamRequestRead

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ParamRequestRead

fn deserialize<__D>( __deserializer: __D, ) -> Result<ParamRequestRead, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ParamRequestRead> for Common

fn from(value: ParamRequestRead) -> Common

Converts to this type from the input type.

impl IntoPayload for ParamRequestRead

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

Encodes message into MAVLink payload.

impl MessageSpec for ParamRequestRead

fn id(&self) -> u32

MAVLink message ID.

fn min_supported_mavlink_version(&self) -> MavLinkVersion

Minimum supported MAVLink protocol version.

fn crc_extra(&self) -> u8

Message EXTRA_CRC calculated from message XML definition.

impl MessageSpecStatic for ParamRequestRead

fn spec() -> MessageInfo

Returns specification for this message.

fn message_id() -> u32

Message ID.

fn crc_extra() -> u8

Message CRC_EXTRA.

fn min_supported_mavlink_version() -> MavLinkVersion

Minimum supported MAVLink version for this message.

impl NamedType for ParamRequestRead

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 ParamRequestRead

fn eq(&self, other: &ParamRequestRead) -> 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 ParamRequestRead

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Payload> for ParamRequestRead

type Error = SpecError

The type returned in the event of a conversion error.

fn try_from( value: &Payload, ) -> Result<ParamRequestRead, <ParamRequestRead as TryFrom<&Payload>>::Error>

Performs the conversion.

impl Type for ParamRequestRead

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 ParamRequestRead

impl Message for ParamRequestRead

impl StructuralPartialEq for ParamRequestRead