Struct sbp::messages::system::msg_status_report::MsgStatusReport

pub struct MsgStatusReport {
    pub sender_id: Option<u16>,
    pub reporting_system: u16,
    pub sbp_version: u16,
    pub sequence: u32,
    pub uptime: u32,
    pub status: Vec<SubSystemReport>,
}

Status report message

The status report is sent periodically to inform the host or other attached devices that the system is running. It is used to monitor system malfunctions. It contains status reports that indicate to the host the status of each subsystem and whether it is operating correctly.

Interpretation of the subsystem specific status code is product dependent, but if the generic status code is initializing, it should be ignored. Refer to product documentation for details.

Fields

sender_id: Option<u16>

The message sender_id

reporting_system: u16

Identity of reporting system

sbp_version: u16

SBP protocol version

sequence: u32

Increments on each status report sent

uptime: u32

Number of seconds since system start-up

status: Vec<SubSystemReport>

Reported status of individual subsystems

Implementations

impl MsgStatusReport

pub fn system(&self) -> Result<System, u16>

Gets the System stored in the reporting_system bitfield.

Returns Ok if the bitrange contains a known System variant. Otherwise the value of the bitrange is returned as an Err(u16). This may be because of a malformed message, or because new variants of System were added.

pub fn set_system(&mut self, system: System)

Set the bitrange corresponding to the System of the reporting_system bitfield.

pub fn sbp_major_protocol_version_number(&self) -> u8

Gets the sbp_major_protocol_version_number stored in sbp_version.

pub fn set_sbp_major_protocol_version_number(
    &mut self,
    sbp_major_protocol_version_number: u8
)

Sets the sbp_major_protocol_version_number bitrange of sbp_version.

pub fn sbp_minor_protocol_version_number(&self) -> u8

Gets the sbp_minor_protocol_version_number stored in sbp_version.

pub fn set_sbp_minor_protocol_version_number(
    &mut self,
    sbp_minor_protocol_version_number: u8
)

Sets the sbp_minor_protocol_version_number bitrange of sbp_version.

Trait Implementations

impl Clone for MsgStatusReport

fn clone(&self) -> MsgStatusReport

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConcreteMessage for MsgStatusReport

const MESSAGE_TYPE: u16 = 65_534u16

The message type.

const MESSAGE_NAME: &'static str = "MSG_STATUS_REPORT"

The message name.

impl Debug for MsgStatusReport

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

Formats the value using the given formatter.

impl From<MsgStatusReport> for Sbp

fn from(msg: MsgStatusReport) -> Self

Converts to this type from the input type.

impl SbpMessage for MsgStatusReport

fn message_name(&self) -> &'static str

Get the message name.

fn message_type(&self) -> u16

Get the message type.

fn sender_id(&self) -> Option<u16>

Get the sender_id if it is set.

fn set_sender_id(&mut self, new_id: u16)

Set the sender id.

fn encoded_len(&self) -> usize

Number of bytes this message will take on the wire.

impl TryFrom<Sbp> for MsgStatusReport

type Error = TryFromSbpError

The type returned in the event of a conversion error.

fn try_from(msg: Sbp) -> Result<Self, Self::Error>

Performs the conversion.