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

[CC1101] Fixed doxygen warnings

Browse source
This commit is contained in:
jgromes 2024-04-01 10:43:56 +02:00
parent a2f1493898
commit 81e030ce65
1 changed files with 20 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
src/modules/CC1101/CC1101.h
View file

@ -537,7 +537,7 @@ class CC1101: public PhysicalLayer {
/*! /*!
\brief Default constructor. \brief Default constructor.
\param mod Instance of Module that will be used to communicate with the radio. \param module Instance of Module that will be used to communicate with the radio.
*/ */
CC1101(Module* module); CC1101(Module* module);
@ -797,6 +797,7 @@ class CC1101: public PhysicalLayer {
/*! /*!
\brief Sets preamble length. \brief Sets preamble length.
\param preambleLength Preamble length to be set (in bits), allowed values: 16, 24, 32, 48, 64, 96, 128 and 192. \param preambleLength Preamble length to be set (in bits), allowed values: 16, 24, 32, 48, 64, 96, 128 and 192.
\param qualityThreshold Preamble quality threshold (PQT) to set.
\returns \ref status_codes \returns \ref status_codes
*/ */
int16_t setPreambleLength(uint8_t preambleLength, uint8_t qualityThreshold); int16_t setPreambleLength(uint8_t preambleLength, uint8_t qualityThreshold);
@ -834,52 +835,52 @@ class CC1101: public PhysicalLayer {
\brief Gets LQI (Link Quality Indicator) of the last received packet. \brief Gets LQI (Link Quality Indicator) of the last received packet.
\returns Last packet LQI (lower is better). \returns Last packet LQI (lower is better).
*/ */
uint8_t getLQI() const; uint8_t getLQI() const;
/*! /*!
\brief Query modem for the packet length of received payload. \brief Query modem for the packet length of received payload.
\param update Update received packet length. Will return cached value when set to false. \param update Update received packet length. Will return cached value when set to false.
\returns Length of last received packet in bytes. \returns Length of last received packet in bytes.
*/ */
size_t getPacketLength(bool update = true) override; size_t getPacketLength(bool update = true) override;
/*! /*!
\brief Set modem in fixed packet length mode. \brief Set modem in fixed packet length mode.
\param len Packet length. \param len Packet length.
\returns \ref status_codes \returns \ref status_codes
*/ */
int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_CC1101_MAX_PACKET_LENGTH); int16_t fixedPacketLengthMode(uint8_t len = RADIOLIB_CC1101_MAX_PACKET_LENGTH);
/*! /*!
\brief Set modem in variable packet length mode. \brief Set modem in variable packet length mode.
\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_CC1101_MAX_PACKET_LENGTH); int16_t variablePacketLengthMode(uint8_t maxLen = RADIOLIB_CC1101_MAX_PACKET_LENGTH);
/*! /*!
\brief Enable sync word filtering and generation. \brief Enable sync word filtering and generation.
\param numBits Sync word length in bits. \param maxErrBits Maximum number of allowed error bits in sync word.
\param requireCarrierSense Require carrier sense above threshold in addition to sync word. \param requireCarrierSense Require carrier sense above threshold in addition to sync word.
\returns \ref status_codes \returns \ref status_codes
*/ */
int16_t enableSyncWordFiltering(uint8_t maxErrBits = 0, bool requireCarrierSense = false); int16_t enableSyncWordFiltering(uint8_t maxErrBits = 0, bool requireCarrierSense = false);
/*! /*!
\brief Disable preamble and sync word filtering and generation. \brief Disable preamble and sync word filtering and generation.
\param requireCarrierSense Require carrier sense above threshold. \param requireCarrierSense Require carrier sense above threshold.
\returns \ref status_codes \returns \ref status_codes
*/ */
int16_t disableSyncWordFiltering(bool requireCarrierSense = false); int16_t disableSyncWordFiltering(bool requireCarrierSense = false);
/*! /*!
\brief Enable CRC filtering and generation. \brief Enable CRC filtering and generation.
\param enable Set or unset CRC generation and filtering. \param enable Set or unset CRC generation and filtering.
\returns \ref status_codes \returns \ref status_codes
*/ */
int16_t setCrcFiltering(bool enable = true); int16_t setCrcFiltering(bool enable = true);
/*! /*!
\brief Set modem in "sniff" mode: no packet filtering (e.g., no preamble, sync word, address, CRC). \brief Set modem in "sniff" mode: no packet filtering (e.g., no preamble, sync word, address, CRC).
\param enable Set or unset promiscuous mode. \param enable Set or unset promiscuous mode.
\param requireCarrierSense Set carriersense required above threshold, defaults to false. \param requireCarrierSense Set carriersense required above threshold, defaults to false.
@ -887,7 +888,7 @@ class CC1101: public PhysicalLayer {
*/ */
int16_t setPromiscuousMode(bool enable = true, bool requireCarrierSense = false); int16_t setPromiscuousMode(bool enable = true, bool requireCarrierSense = false);
/*! /*!
\brief Get whether the modem is in promiscuous mode: no packet filtering \brief Get whether the modem is in promiscuous mode: no packet filtering
(e.g., no preamble, sync word, address, CRC). (e.g., no preamble, sync word, address, CRC).
\returns Whether the modem is in promiscuous mode. \returns Whether the modem is in promiscuous mode.
@ -917,16 +918,16 @@ class CC1101: public PhysicalLayer {
void setRfSwitchTable(const uint32_t (&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[]); void setRfSwitchTable(const uint32_t (&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[]);
/*! /*!
\brief Get one truly random byte from RSSI noise. \brief Get one truly random byte from RSSI noise.
\returns TRNG byte. \returns TRNG byte.
*/ */
uint8_t randomByte(); uint8_t randomByte();
/*! /*!
\brief Read version SPI register. Should return CC1101_VERSION_LEGACY (0x04) or \brief Read version SPI register. Should return CC1101_VERSION_LEGACY (0x04) or
CC1101_VERSION_CURRENT (0x14) if CC1101 is connected and working. CC1101_VERSION_CURRENT (0x14) if CC1101 is connected and working.
\returns Version register contents or \ref status_codes \returns Version register contents or \ref status_codes
*/ */
int16_t getChipVersion(); int16_t getChipVersion();
#if !RADIOLIB_EXCLUDE_DIRECT_RECEIVE #if !RADIOLIB_EXCLUDE_DIRECT_RECEIVE