Skip to content

Commit

Permalink
document new parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
caveman99 authored Sep 26, 2024
1 parent 23967b2 commit 144d035
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/modules/LR11x0/LR11x0.h
Original file line number Diff line number Diff line change
Expand Up @@ -776,6 +776,7 @@ class LR11x0: public PhysicalLayer {
\param syncWord 1-byte LoRa sync word.
\param preambleLength LoRa preamble length in symbols
\param tcxoVoltage TCXO reference voltage to be set.
\param high defaults to false for Sub-GHz band, true for frequencies above 1.8GHz
\returns \ref status_codes
*/
int16_t begin(float bw, uint8_t sf, uint8_t cr, uint8_t syncWord, uint16_t preambleLength, float tcxoVoltage, bool high = false);
Expand Down Expand Up @@ -996,8 +997,9 @@ class LR11x0: public PhysicalLayer {
// configuration methods

/*!
\brief Sets LoRa bandwidth. Allowed values are 62.5, 125.0, 250.0 and 500.0 kHz.
\brief Sets LoRa bandwidth. Allowed values are 62.5, 125.0, 250.0 and 500.0 kHz. (default, high = false)
\param bw LoRa bandwidth to be set in kHz.
\param high if set to true, allowed bandwidth is 203.125, 406.25 and 812.5 kHz, frequency must be above 1.8GHz
\returns \ref status_codes
*/
int16_t setBandwidth(float bw, bool high = false);
Expand Down

0 comments on commit 144d035

Please sign in to comment.