forks/RadioLibSmol
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[SX127x] Fixed doxygen warnings

Browse source
This commit is contained in:
jgromes 2024-04-01 10:48:41 +02:00
parent 32a7095989
commit 400c5af941
2 changed files with 6 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
src/modules/SX127x/SX1272.h
View file

@ -111,8 +111,7 @@ class SX1272: public SX127x {
\param sf %LoRa link spreading factor. Allowed values range from 6 to 12. \param sf %LoRa link spreading factor. Allowed values range from 6 to 12.
\param cr %LoRa link coding rate denominator. Allowed values range from 5 to 8. \param cr %LoRa link coding rate denominator. Allowed values range from 5 to 8.
\param syncWord %LoRa sync word. Can be used to distinguish different networks. Note that value 0x34 is reserved for LoRaWAN networks. \param syncWord %LoRa sync word. Can be used to distinguish different networks. Note that value 0x34 is reserved for LoRaWAN networks.
\param currentLimit Trim value for OCP (over current protection) in mA. Can be set to multiplies of 5 in range 45 to 120 mA and to multiples of 10 in range 120 to 240 mA. \param power Transmission output power in dBm. Allowed values range from 2 to 17 dBm.
Set to 0 to disable OCP (not recommended).
\param preambleLength Length of %LoRa transmission preamble in symbols. The actual preamble length is 4.25 symbols longer than the set number. \param preambleLength Length of %LoRa transmission preamble in symbols. The actual preamble length is 4.25 symbols longer than the set number.
Allowed values range from 6 to 65535. Allowed values range from 6 to 65535.
\param gain Gain of receiver LNA (low-noise amplifier). Can be set to any integer in range 1 to 6 where 1 is the highest gain. \param gain Gain of receiver LNA (low-noise amplifier). Can be set to any integer in range 1 to 6 where 1 is the highest gain.

17
src/modules/SX127x/SX127x.h
View file

@ -600,7 +600,7 @@ class SX127x: public PhysicalLayer {
/*! /*!
\brief Initialization method. Will be called with appropriate parameters when calling initialization method from derived class. \brief Initialization method. Will be called with appropriate parameters when calling initialization method from derived class.
\param chipVersion Array of possible values in SPI version register. Used to verify the connection and hardware version. \param chipVersions Array of possible values in SPI version register. Used to verify the connection and hardware version.
\param numVersions Number of possible chip versions. \param numVersions Number of possible chip versions.
\param syncWord %LoRa sync word. \param syncWord %LoRa sync word.
\param preambleLength Length of %LoRa transmission preamble in symbols. \param preambleLength Length of %LoRa transmission preamble in symbols.
@ -615,7 +615,7 @@ class SX127x: public PhysicalLayer {
/*! /*!
\brief Initialization method for FSK modem. Will be called with appropriate parameters when calling FSK initialization method from derived class. \brief Initialization method for FSK modem. Will be called with appropriate parameters when calling FSK initialization method from derived class.
\param chipVersion Array of possible values in SPI version register. Used to verify the connection and hardware version. \param chipVersions Array of possible values in SPI version register. Used to verify the connection and hardware version.
\param numVersions Number of possible chip versions. \param numVersions Number of possible chip versions.
\param freqDev Frequency deviation of the FSK transmission in kHz. \param freqDev Frequency deviation of the FSK transmission in kHz.
\param rxBw Receiver bandwidth in kHz. \param rxBw Receiver bandwidth in kHz.
@ -928,7 +928,7 @@ class SX127x: public PhysicalLayer {
/*! /*!
\brief Sets FSK automatic frequency correction bandwidth. Allowed values range from 2.6 to 250 kHz. Only available in FSK mode. \brief Sets FSK automatic frequency correction bandwidth. Allowed values range from 2.6 to 250 kHz. Only available in FSK mode.
\param rxBw Receiver AFC bandwidth to be set (in kHz). \param afcBw Receiver AFC bandwidth to be set (in kHz).
\returns \ref status_codes \returns \ref status_codes
*/ */
int16_t setAFCBandwidth(float afcBw); int16_t setAFCBandwidth(float afcBw);
@ -1038,7 +1038,7 @@ class SX127x: public PhysicalLayer {
/*! /*!
\brief Set modem in variable packet length mode. Available in FSK mode only. \brief Set modem in variable packet length mode. Available in FSK mode only.
\param len Maximum packet length. \param maxLen Maximum packet length.
\returns \ref status_codes \returns \ref status_codes
*/ */
int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_SX127X_MAX_PACKET_LENGTH_FSK); int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_SX127X_MAX_PACKET_LENGTH_FSK);
@ -1201,14 +1201,6 @@ class SX127x: public PhysicalLayer {
*/ */
int16_t setDIOPreambleDetect(bool usePreambleDetect); int16_t setDIOPreambleDetect(bool usePreambleDetect);
/*!
\brief Gets recorded signal strength indicator.
\param packet Whether to read last packet RSSI, or the current value. LoRa mode only, ignored for FSK.
\param skipReceive Set to true to skip putting radio in receive mode for the RSSI measurement in FSK/OOK mode.
\returns RSSI value in dBm.
*/
float getRSSI(bool packet, bool skipReceive, int16_t offset);
/*! /*!
\brief Sets the RSSI value above which the RSSI interrupt is signaled \brief Sets the RSSI value above which the RSSI interrupt is signaled
\param dbm A dBm value between -127.5 and 0 inclusive \param dbm A dBm value between -127.5 and 0 inclusive
@ -1246,6 +1238,7 @@ class SX127x: public PhysicalLayer {
int16_t getActiveModem(); int16_t getActiveModem();
int16_t setFrequencyRaw(float newFreq); int16_t setFrequencyRaw(float newFreq);
int16_t setBitRateCommon(float br, uint8_t fracRegAddr); int16_t setBitRateCommon(float br, uint8_t fracRegAddr);
float getRSSI(bool packet, bool skipReceive, int16_t offset);
#if !RADIOLIB_GODMODE #if !RADIOLIB_GODMODE
private: private: