Detailed Description

Get the configured output rate for the he requested message type on the specified interface (MessageType::GET_MESSAGE_RATE, version 1.0).

Multiple message rates can be requested with a single command if wild cards are used for the protocol, or message ID.

Expected Response

The device will respond with a MessageRateResponse containing the requested values or an error Response value if the request did not succeed.

Definition at line 2429 of file configuration.h.

Inheritance diagram for point_one::fusion_engine::messages::GetMessageRate:
point_one::fusion_engine::messages::MessagePayload

#include <point_one/fusion_engine/messages/configuration.h>

Public Attributes

uint16_t message_id = ALL_MESSAGES_ID
 The ID of the desired message type (e.g., 10000 for FusionEngine MessageType::POSE messages). More...
 
InterfaceID output_interface {TransportType::CURRENT}
 The output interface to be queried. More...
 
ProtocolType protocol = ProtocolType::INVALID
 The desired message protocol. More...
 
ConfigurationSource request_source = ConfigurationSource::ACTIVE
 The source of the parameter value (active, saved, etc.). More...
 

Static Public Attributes

static constexpr MessageType MESSAGE_TYPE = MessageType::GET_MESSAGE_RATE
 
static constexpr uint8_t MESSAGE_VERSION = 0
 

Member Data Documentation

◆ message_id

uint16_t point_one::fusion_engine::messages::GetMessageRate::message_id = ALL_MESSAGES_ID

The ID of the desired message type (e.g., 10000 for FusionEngine MessageType::POSE messages).

See NmeaMessageType for NMEA-0183 messages. If ALL_MESSAGES_ID, return the current settings for all supported messages on the selected interface and protocol.

Definition at line 2456 of file configuration.h.

◆ MESSAGE_TYPE

constexpr MessageType point_one::fusion_engine::messages::GetMessageRate::MESSAGE_TYPE = MessageType::GET_MESSAGE_RATE
staticconstexpr

Definition at line 2430 of file configuration.h.

◆ MESSAGE_VERSION

constexpr uint8_t point_one::fusion_engine::messages::GetMessageRate::MESSAGE_VERSION = 0
staticconstexpr

Definition at line 2431 of file configuration.h.

◆ output_interface

InterfaceID point_one::fusion_engine::messages::GetMessageRate::output_interface {TransportType::CURRENT}

The output interface to be queried.

TransportType::ALL is not supported. To query for multiple transports, send separate requests.

Definition at line 2439 of file configuration.h.

◆ protocol

ProtocolType point_one::fusion_engine::messages::GetMessageRate::protocol = ProtocolType::INVALID

The desired message protocol.

If ProtocolType::ALL, return the current settings for all supported protocols.

Definition at line 2445 of file configuration.h.

◆ request_source

ConfigurationSource point_one::fusion_engine::messages::GetMessageRate::request_source = ConfigurationSource::ACTIVE

The source of the parameter value (active, saved, etc.).

Definition at line 2448 of file configuration.h.


The documentation for this struct was generated from the following file: