From 9dab1a0f936665e3a078f0664545b9fa966cb38f Mon Sep 17 00:00:00 2001 From: rasmuskleist Date: Wed, 9 Aug 2023 09:10:43 +0200 Subject: [PATCH] Update sx128x comment --- src/modm/driver/radio/sx128x.hpp | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/modm/driver/radio/sx128x.hpp b/src/modm/driver/radio/sx128x.hpp index 71d3fcc013..4e81862a13 100644 --- a/src/modm/driver/radio/sx128x.hpp +++ b/src/modm/driver/radio/sx128x.hpp @@ -72,7 +72,7 @@ class Sx128x : public sx128x, public Transport modm::ResumableResult writeBuffer(uint8_t offset, std::span data); - /// This function allows reading (n-3) bytes of payload received starting at offset + /// This function is used to read the received data payload modm::ResumableResult readBuffer(uint8_t offset, std::span data); @@ -98,10 +98,10 @@ class Sx128x : public sx128x, public Transport modm::ResumableResult setTx(PeriodBase periodBase, uint16_t periodBaseCount); - /// Set the device in Reciever mode + /// Set the device in Receiver mode /// @warning The IRQ status must be cleared before using this command - /// @attention Setting periodBaseCount = 0 puts the transciever in RX Single Mode - /// @attention Setting periodBaseCount = 0xFFFF puts the transciever in Rx Continuous mode + /// @attention Setting periodBaseCount = 0 puts the transceiver in RX Single Mode + /// @attention Setting periodBaseCount = 0xFFFF puts the transceiver in Rx Continuous mode modm::ResumableResult setRx(PeriodBase periodBase, uint16_t periodBaseCount); @@ -116,12 +116,12 @@ class Sx128x : public sx128x, public Transport modm::ResumableResult setCad(); - /// Set the transciever to generate a Continuous Wave (RF tone) at a selected frequency and output power + /// Set the transceiver to generate a Continuous Wave (RF tone) at a selected frequency and output power /// @attention The device remains in Tx Continuous Wave until the host sends a mode confiquration command. modm::ResumableResult setTxContinuousWave(); - /// Set the transciever to generate an infinite sequence of alternating 'O's and '1's in GFSK modulation and symbol 0 in LoRa + /// Set the transceiver to generate an infinite sequence of alternating 'O's and '1's in GFSK modulation and symbol 0 in LoRa /// @attention The device remains in transmit until the host sends a mode confiquration command modm::ResumableResult setTxContinuousPreamble();