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

[SX126x] Added notes about preamble detector to Doxygen (#1350)

Browse source
This commit is contained in:
jgromes 2024-12-16 19:01:30 +00:00
parent eeff547aa4
commit 67547615af
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/modules/SX126x/SX126x.h
View file

@ -823,6 +823,10 @@ class SX126x: public PhysicalLayer {
/*! /*!
\brief Sets preamble length for LoRa or FSK modem. Allowed values range from 1 to 65535. \brief Sets preamble length for LoRa or FSK modem. Allowed values range from 1 to 65535.
\param preambleLength Preamble length to be set in symbols (LoRa) or bits (FSK). \param preambleLength Preamble length to be set in symbols (LoRa) or bits (FSK).
NOTE: In FSK mode, sync word length limits the preamble detector length
(the number of preamble bits that must be detected to start receiving packet).
For details, see the note in SX1261 datasheet, Rev 2.1, section 6.2.2.1, page 45.
Preamble detector length is adjusted automatically each time this method is called.
\returns \ref status_codes \returns \ref status_codes
*/ */
int16_t setPreambleLength(size_t preambleLength) override; int16_t setPreambleLength(size_t preambleLength) override;
@ -887,6 +891,10 @@ class SX126x: public PhysicalLayer {
Can also set LR-FHSS sync word, but its length must be 4 bytes. Can also set LR-FHSS sync word, but its length must be 4 bytes.
\param syncWord FSK sync word to be set. \param syncWord FSK sync word to be set.
\param len FSK sync word length in bytes. \param len FSK sync word length in bytes.
NOTE: In FSK mode, sync word length limits the preamble detector length
(the number of preamble bits that must be detected to start receiving packet).
For details, see the note in SX1261 datasheet, Rev 2.1, section 6.2.2.1, page 45.
Preamble detector length is adjusted automatically each time this method is called.
\returns \ref status_codes \returns \ref status_codes
*/ */
int16_t setSyncWord(uint8_t* syncWord, size_t len) override; int16_t setSyncWord(uint8_t* syncWord, size_t len) override;