Ares LoRa Serial Driver Core
Loading...
Searching...
No Matches
AresFrame::Log Struct Reference

#include <ares_frame.hpp>

Public Member Functions

 Log (bool broadcast, uint8_t tx_cnt, uint16_t id, uint16_t log_id, std::string msg)
 Log ()=default

Public Attributes

bool broadcast = false
uint8_t tx_cnt = 1
uint8_t part = 1
uint8_t num_parts = 1
uint16_t id = 0
uint16_t log_id = 0
std::string msg

Friends

class AresFrame

Detailed Description

Data for AresFrame::LOG frames.

Constructor & Destructor Documentation

◆ Log() [1/2]

AresFrame::Log::Log ( bool broadcast,
uint8_t tx_cnt,
uint16_t id,
uint16_t log_id,
std::string msg )
inline

Constructor.

Parameters
broadcastFlag indicating if the message should be broadcasted.
tx_cntThe number of times to send the message over LoRa.
idThe destination or source ID.
log_idThe ID of the log message.
msgThe log message.

◆ Log() [2/2]

AresFrame::Log::Log ( )
default

Default constructor.

Member Data Documentation

◆ broadcast

bool AresFrame::Log::broadcast = false

Flag indicating if the message was/should be broadcasted.

◆ id

uint16_t AresFrame::Log::id = 0

On transmission, the ID of the node to send the message to if not broadcasting. On reception, the ID of the node the message was sent from.

◆ log_id

uint16_t AresFrame::Log::log_id = 0

The ID of the log message.

◆ msg

std::string AresFrame::Log::msg

The entire log message on transmission. The log message chunk on reception.

◆ num_parts

uint8_t AresFrame::Log::num_parts = 1

The number of chunks in the log message. Automatically managed on serialization.

◆ part

uint8_t AresFrame::Log::part = 1

The chunk ID of the message. 1 indexed and automatically managed on serialization.

◆ tx_cnt

uint8_t AresFrame::Log::tx_cnt = 1

The number of times to transmit the message.


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