Skip to content

Commit

Permalink
Update sx128x comment
Browse files Browse the repository at this point in the history
  • Loading branch information
rasmuskleist committed Aug 9, 2023
1 parent b7648b1 commit 9dab1a0
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions src/modm/driver/radio/sx128x.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ class Sx128x : public sx128x, public Transport
modm::ResumableResult<bool>
writeBuffer(uint8_t offset, std::span<const uint8_t> 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<bool>
readBuffer(uint8_t offset, std::span<uint8_t> data);

Expand All @@ -98,10 +98,10 @@ class Sx128x : public sx128x, public Transport
modm::ResumableResult<bool>
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<bool>
setRx(PeriodBase periodBase, uint16_t periodBaseCount);

Expand All @@ -116,12 +116,12 @@ class Sx128x : public sx128x, public Transport
modm::ResumableResult<bool>
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<bool>
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<bool>
setTxContinuousPreamble();
Expand Down

0 comments on commit 9dab1a0

Please sign in to comment.