SetMessageRate Struct
Set the output rate for the requested message types (MessageType::SET_MESSAGE_RATE, version 1). More...
Declaration
Included Headers
Base struct
| struct | MessagePayload |
|
The base class for all message payloads. More... | |
Public Member Attributes Index
| uint8_t | flags = 0 |
|
Bitmask of additional flags to modify the command. More... | |
| 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 configure. More... | |
| ProtocolType | protocol = ProtocolType::INVALID |
|
The message protocol being configured. More... | |
| MessageRate | rate = MessageRate::OFF |
|
The desired message rate. More... | |
Public Static Attributes Index
| static constexpr uint8_t | FLAG_APPLY_AND_SAVE = 0x01 |
|
Flag to immediately save the config after applying this setting. More... | |
| static constexpr uint8_t | FLAG_INCLUDE_DISABLED_MESSAGES = 0x02 |
|
Flag to apply bulk interval changes to all messages instead of just enabled messages. More... | |
| static constexpr MessageType | MESSAGE_TYPE = MessageType::SET_MESSAGE_RATE |
| static constexpr uint8_t | MESSAGE_VERSION = 0 |
Description
Set the output rate for the requested message types (MessageType::SET_MESSAGE_RATE, version 1).
Multiple message rates can be configured with a single command if wild cards are used for the interface, protocol, or message ID. When multiple messages are specified, the following behaviors apply:
- Messages that are currently MessageRate::OFF will not be changed unless the FLAG_INCLUDE_DISABLED_MESSAGES bit is set in the flags or the new rate is MessageRate::DEFAULT.
- If the rate is an interval, it will only affect the messages that support being rate controlled.
Setting all the messages on an interface to MessageRate::DEFAULT will also restore the default *_OUTPUT_DIAGNOSTICS_MESSAGES configuration option value for that interface. See ConfigType.
When specifying ProtocolType::ALL, message ID ALL_MESSAGES_ID must also be specified. Further, the rate must be set to either MessageRate::OFF or MessageRate::DEFAULT.
Typical Use Cases
Restore Default Settings For All Messages
To restore the default configuration on UART1 for all message types across all supported protocols, specify the following:
- Interface transport type: TransportType::SERIAL
- Interface index: 1
- Protocol: ProtocolType::ALL
- Message ID: ALL_MESSAGES_ID
- Rate: MessageRate::DEFAULT
Restore Default Settings For All NMEA
To restore the default configuration on UART1 for all NMEA message types, specify the following:
- Interface transport type: TransportType::SERIAL
- Interface index: 1
- Protocol: ProtocolType::NMEA
- Message ID: ALL_MESSAGES_ID
- Rate: MessageRate::DEFAULT
Change UART1 Output Rate To 1 Hz:
To change the rate of all NMEA message types to 1 Hz on UART1, specify the following:
- Interface transport type: TransportType::SERIAL
- Interface index: 1
- Protocol: ProtocolType::NMEA
- Message ID: ALL_MESSAGES_ID
- Rate: MessageRate::INTERVAL_1_S
Note that this will not affect any message types that are not rate controlled (e.g., MessageType::EVENT_NOTIFICATION).
Change The Uart1 Output Rates For All Messages To Be Off:
To change the rate of all messages to their max rate on UART1, specify the following:
- Interface transport type: TransportType::SERIAL
- Interface index: 1
- Protocol: ProtocolType::ALL
- flags: FLAG_INCLUDE_DISABLED_MESSAGES
- Message ID: ALL_MESSAGES_ID
- Rate: MessageRate::OFF
This will disable every message.
Change And Save The UART1 Output Rates For All Messages To Be Off:
To change the rate of all messages to their max rate on UART1, specify the following:
- Interface transport type: TransportType::SERIAL
- Interface index: 1
- Protocol: ProtocolType::ALL
- flags: 0x03 (FLAG_INCLUDE_DISABLED_MESSAGES | FLAG_APPLY_AND_SAVE)
- Message ID: ALL_MESSAGES_ID
- Rate: MessageRate::OFF
Both of the bit flags are set for this message. This will cause the configuration to be saved to non-volatile memory.
Expected Response
The device will respond with a CommandResponseMessage indicating whether or not the request succeeded.
Definition at line 2384 of file configuration.h.
Public Member Attributes
flags
|
Bitmask of additional flags to modify the command.
Definition at line 2410 of file configuration.h.
message_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, set the rate for all messages on the selected interface and protocol.
Definition at line 2418 of file configuration.h.
output_interface
|
The output interface to configure.
If TransportType::ALL, set rates on all supported interfaces.
Definition at line 2401 of file configuration.h.
protocol
|
The message protocol being configured.
If ProtocolType::ALL, set rates on all supported protocols.
Definition at line 2407 of file configuration.h.
rate
|
The desired message rate.
Definition at line 2421 of file configuration.h.
Public Static Attributes
FLAG_APPLY_AND_SAVE
| constexpr static |
Flag to immediately save the config after applying this setting.
Definition at line 2389 of file configuration.h.
FLAG_INCLUDE_DISABLED_MESSAGES
| constexpr static |
Flag to apply bulk interval changes to all messages instead of just enabled messages.
Definition at line 2395 of file configuration.h.
MESSAGE_TYPE
| constexpr static |
Definition at line 2385 of file configuration.h.
MESSAGE_VERSION
| constexpr static |
Definition at line 2386 of file configuration.h.
The documentation for this struct was generated from the following file:
Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.