Struct sbp::messages::system::msg_heartbeat::MsgHeartbeat
source · pub struct MsgHeartbeat {
pub sender_id: Option<u16>,
pub flags: u32,
}
Expand description
System heartbeat message
The heartbeat message is sent periodically to inform the host or other attached devices that the system is running. It is used to monitor system malfunctions. It also contains status flags that indicate to the host the status of the system and whether it is operating correctly. Currently, the expected heartbeat interval is 1 sec.
The system error flag is used to indicate that an error has occurred in the system. To determine the source of the error, the remaining error flags should be inspected.
Fields§
§sender_id: Option<u16>
The message sender_id
flags: u32
Status flags
Implementations§
source§impl MsgHeartbeat
impl MsgHeartbeat
sourcepub fn external_antenna_present(&self) -> Result<ExternalAntennaPresent, u8>
pub fn external_antenna_present(&self) -> Result<ExternalAntennaPresent, u8>
Gets the ExternalAntennaPresent stored in the flags
bitfield.
Returns Ok
if the bitrange contains a known ExternalAntennaPresent
variant.
Otherwise the value of the bitrange is returned as an Err(u8)
. This may be because of a malformed message,
or because new variants of ExternalAntennaPresent
were added.
sourcepub fn set_external_antenna_present(
&mut self,
external_antenna_present: ExternalAntennaPresent
)
pub fn set_external_antenna_present( &mut self, external_antenna_present: ExternalAntennaPresent )
Set the bitrange corresponding to the ExternalAntennaPresent of the flags
bitfield.
sourcepub fn external_antenna_short(&self) -> Result<ExternalAntennaShort, u8>
pub fn external_antenna_short(&self) -> Result<ExternalAntennaShort, u8>
Gets the ExternalAntennaShort stored in the flags
bitfield.
Returns Ok
if the bitrange contains a known ExternalAntennaShort
variant.
Otherwise the value of the bitrange is returned as an Err(u8)
. This may be because of a malformed message,
or because new variants of ExternalAntennaShort
were added.
sourcepub fn set_external_antenna_short(
&mut self,
external_antenna_short: ExternalAntennaShort
)
pub fn set_external_antenna_short( &mut self, external_antenna_short: ExternalAntennaShort )
Set the bitrange corresponding to the ExternalAntennaShort of the flags
bitfield.
sourcepub fn sbp_major_protocol_version_number(&self) -> u8
pub fn sbp_major_protocol_version_number(&self) -> u8
Gets the sbp_major_protocol_version_number
stored in flags
.
sourcepub fn set_sbp_major_protocol_version_number(
&mut self,
sbp_major_protocol_version_number: u8
)
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 flags
.
sourcepub fn sbp_minor_protocol_version_number(&self) -> u8
pub fn sbp_minor_protocol_version_number(&self) -> u8
Gets the sbp_minor_protocol_version_number
stored in flags
.
sourcepub fn set_sbp_minor_protocol_version_number(
&mut self,
sbp_minor_protocol_version_number: u8
)
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 flags
.
sourcepub fn swift_nap_error(&self) -> Result<SwiftNapError, u8>
pub fn swift_nap_error(&self) -> Result<SwiftNapError, u8>
Gets the SwiftNapError stored in the flags
bitfield.
Returns Ok
if the bitrange contains a known SwiftNapError
variant.
Otherwise the value of the bitrange is returned as an Err(u8)
. This may be because of a malformed message,
or because new variants of SwiftNapError
were added.
sourcepub fn set_swift_nap_error(&mut self, swift_nap_error: SwiftNapError)
pub fn set_swift_nap_error(&mut self, swift_nap_error: SwiftNapError)
Set the bitrange corresponding to the SwiftNapError of the flags
bitfield.
sourcepub fn io_error(&self) -> Result<IoError, u8>
pub fn io_error(&self) -> Result<IoError, u8>
Gets the IoError stored in the flags
bitfield.
Returns Ok
if the bitrange contains a known IoError
variant.
Otherwise the value of the bitrange is returned as an Err(u8)
. This may be because of a malformed message,
or because new variants of IoError
were added.
sourcepub fn set_io_error(&mut self, io_error: IoError)
pub fn set_io_error(&mut self, io_error: IoError)
Set the bitrange corresponding to the IoError of the flags
bitfield.
sourcepub fn system_error_flag(&self) -> Result<SystemErrorFlag, u8>
pub fn system_error_flag(&self) -> Result<SystemErrorFlag, u8>
Gets the SystemErrorFlag stored in the flags
bitfield.
Returns Ok
if the bitrange contains a known SystemErrorFlag
variant.
Otherwise the value of the bitrange is returned as an Err(u8)
. This may be because of a malformed message,
or because new variants of SystemErrorFlag
were added.
sourcepub fn set_system_error_flag(&mut self, system_error_flag: SystemErrorFlag)
pub fn set_system_error_flag(&mut self, system_error_flag: SystemErrorFlag)
Set the bitrange corresponding to the SystemErrorFlag of the flags
bitfield.
Trait Implementations§
source§impl Clone for MsgHeartbeat
impl Clone for MsgHeartbeat
source§fn clone(&self) -> MsgHeartbeat
fn clone(&self) -> MsgHeartbeat
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl ConcreteMessage for MsgHeartbeat
impl ConcreteMessage for MsgHeartbeat
source§const MESSAGE_TYPE: u16 = 65_535u16
const MESSAGE_TYPE: u16 = 65_535u16
source§const MESSAGE_NAME: &'static str = "MSG_HEARTBEAT"
const MESSAGE_NAME: &'static str = "MSG_HEARTBEAT"
source§impl Debug for MsgHeartbeat
impl Debug for MsgHeartbeat
source§impl<'de> Deserialize<'de> for MsgHeartbeat
impl<'de> Deserialize<'de> for MsgHeartbeat
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
source§impl FriendlyName for MsgHeartbeat
impl FriendlyName for MsgHeartbeat
fn friendly_name() -> &'static str
source§impl From<MsgHeartbeat> for Sbp
impl From<MsgHeartbeat> for Sbp
source§fn from(msg: MsgHeartbeat) -> Self
fn from(msg: MsgHeartbeat) -> Self
source§impl PartialEq for MsgHeartbeat
impl PartialEq for MsgHeartbeat
source§fn eq(&self, other: &MsgHeartbeat) -> bool
fn eq(&self, other: &MsgHeartbeat) -> bool
self
and other
values to be equal, and is used
by ==
.