QGroundControl
Ground Control Station for MAVLink Drones
Loading...
Searching...
No Matches
Classes | Public Member Functions | List of all members
UBX::ReceiverController Class Reference

Owns control-response correlation: decoding reports replies through accept(); only configuration opens requests. More...

#include <UBXReceiverController.h>

Public Member Functions

void requireConfigurationReadback (uint16_t message)
 A baud change can lose its ACK on UART; subsequent VALSETs must prove their values by readback.
 
bool configurationReadbackRequired () const
 
void beginAcknowledgement (uint16_t message)
 
void finishAcknowledgement ()
 
bool lateRejection () const
 
bool awaitingAcknowledgement () const
 
GPSCommandOutcome acknowledgement () const
 
void accept (Acknowledgement response)
 
void beginReadback (std::span< const uint32_t > keys)
 
void finishReadback ()
 
bool readbackPending () const
 
bool readbackReplyOutstanding () const
 A reply to a readback settled without it can still arrive.
 
bool readbackReady () const
 
bool readbackRejected () const
 The receiver rejected the pending readback: at least one of its keys is unknown.
 
const ConfigurationValues & readback () const
 
void accept (const std::optional< ConfigurationValues > &response)
 A CFG-VALGET response; nullopt when it is malformed.
 
void beginRatePoll (uint16_t message)
 
void finishRatePoll ()
 
bool ratePollPending () const
 
std::optional< std::array< uint8_t, 6 > > polledRates () const
 The polled rates, once they arrived.
 
bool ratePollRejected () const
 A NAK came before the polled rates: the receiver rejected the rate or the poll.
 
bool ratePollSettled () const
 
void accept (const MessageRates &response)
 

Detailed Description

Owns control-response correlation: decoding reports replies through accept(); only configuration opens requests.

Definition at line 30 of file UBXReceiverController.h.

Member Function Documentation

◆ accept() [1/3]

void UBX::ReceiverController::accept ( Acknowledgement  response)
inline

Definition at line 58 of file UBXReceiverController.h.

References UBX::Acknowledgement::accepted, Acknowledged, UBX::Msg::CFG_MSG, UBX::Msg::CFG_VALGET, UBX::Acknowledgement::message, Rejected, and UBX::MessageId::value().

◆ accept() [2/3]

void UBX::ReceiverController::accept ( const MessageRates &  response)
inline

Definition at line 167 of file UBXReceiverController.h.

References UBX::MessageRates::message, and UBX::MessageRates::rates.

◆ accept() [3/3]

void UBX::ReceiverController::accept ( const std::optional< ConfigurationValues > &  response)
inline

A CFG-VALGET response; nullopt when it is malformed.

Definition at line 120 of file UBXReceiverController.h.

References UBX::ConfigurationValues::count, and UBX::ConfigurationValues::values.

◆ acknowledgement()

GPSCommandOutcome UBX::ReceiverController::acknowledgement ( ) const
inline

Definition at line 56 of file UBXReceiverController.h.

◆ awaitingAcknowledgement()

bool UBX::ReceiverController::awaitingAcknowledgement ( ) const
inline

Definition at line 54 of file UBXReceiverController.h.

◆ beginAcknowledgement()

void UBX::ReceiverController::beginAcknowledgement ( uint16_t  message)
inline

Definition at line 38 of file UBXReceiverController.h.

References Pending.

◆ beginRatePoll()

void UBX::ReceiverController::beginRatePoll ( uint16_t  message)
inline

Attributes replies to a CFG-MSG poll of message, sent after a rate of it went unanswered. Replies arrive in order and the poll's rates name their message: an ACK or NAK before the rates answers the rate or rejects the poll, and the one after them acknowledges the poll.

Definition at line 148 of file UBXReceiverController.h.

◆ beginReadback()

void UBX::ReceiverController::beginReadback ( std::span< const uint32_t >  keys)
inline

Definition at line 83 of file UBXReceiverController.h.

References UBX::ConfigurationValues::count, keys, and UBX::ConfigurationValues::values.

◆ configurationReadbackRequired()

bool UBX::ReceiverController::configurationReadbackRequired ( ) const
inline

Definition at line 36 of file UBXReceiverController.h.

◆ finishAcknowledgement()

void UBX::ReceiverController::finishAcknowledgement ( )
inline

Definition at line 46 of file UBXReceiverController.h.

◆ finishRatePoll()

void UBX::ReceiverController::finishRatePoll ( )
inline

Definition at line 150 of file UBXReceiverController.h.

◆ finishReadback()

void UBX::ReceiverController::finishReadback ( )
inline

Definition at line 98 of file UBXReceiverController.h.

◆ lateRejection()

bool UBX::ReceiverController::lateRejection ( ) const
inline

Definition at line 52 of file UBXReceiverController.h.

◆ polledRates()

std::optional< std::array< uint8_t, 6 > > UBX::ReceiverController::polledRates ( ) const
inline

The polled rates, once they arrived.

Definition at line 155 of file UBXReceiverController.h.

◆ ratePollPending()

bool UBX::ReceiverController::ratePollPending ( ) const
inline

Definition at line 152 of file UBXReceiverController.h.

◆ ratePollRejected()

bool UBX::ReceiverController::ratePollRejected ( ) const
inline

A NAK came before the polled rates: the receiver rejected the rate or the poll.

Definition at line 158 of file UBXReceiverController.h.

◆ ratePollSettled()

bool UBX::ReceiverController::ratePollSettled ( ) const
inline

Nothing more is to arrive for the rate or its poll: the poll's ACK followed its rates, or the rate's late reply came before the poll's NAK.

Definition at line 162 of file UBXReceiverController.h.

◆ readback()

const ConfigurationValues & UBX::ReceiverController::readback ( ) const
inline

Definition at line 117 of file UBXReceiverController.h.

◆ readbackPending()

bool UBX::ReceiverController::readbackPending ( ) const
inline

Definition at line 107 of file UBXReceiverController.h.

Referenced by UBX::Protocol::completeReceiveCycle().

◆ readbackReady()

bool UBX::ReceiverController::readbackReady ( ) const
inline

Definition at line 112 of file UBXReceiverController.h.

Referenced by UBX::Protocol::completeReceiveCycle().

◆ readbackRejected()

bool UBX::ReceiverController::readbackRejected ( ) const
inline

The receiver rejected the pending readback: at least one of its keys is unknown.

Definition at line 115 of file UBXReceiverController.h.

◆ readbackReplyOutstanding()

bool UBX::ReceiverController::readbackReplyOutstanding ( ) const
inline

A reply to a readback settled without it can still arrive.

Definition at line 110 of file UBXReceiverController.h.

◆ requireConfigurationReadback()

void UBX::ReceiverController::requireConfigurationReadback ( uint16_t  message)
inline

A baud change can lose its ACK on UART; subsequent VALSETs must prove their values by readback.

Definition at line 34 of file UBXReceiverController.h.

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