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

Merge pull request #454 from cterwilliger/documentation-updates

Browse source 
Documentation updates
This commit is contained in:
Jan Gromeš 2022-01-28 18:52:10 +01:00 • committed by GitHub
commit 6acf8feacc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -869,7 +869,8 @@ class CC1101: public PhysicalLayer {
int16_t setDataShaping(uint8_t sh) override;
/*!
\brief Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ and RADIOLIB_ENCODING_WHITENING.
\brief Sets transmission encoding. Allowed values are RADIOLIB_ENCODING_NRZ, RADIOLIB_ENCODING_MANCHESTER, and RADIOLIB_ENCODING_WHITENING.
Note that encoding on CC1101 is applied to the entire stream including preamble, sync word, and CRC.
\param encoding Encoding to be used.

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

@ -791,7 +791,7 @@ class SX127x: public PhysicalLayer {
float getAFCError();
/*!
\brief Gets signal-to-noise ratio of the latest received packet.
\brief Gets signal-to-noise ratio of the latest received packet. Only available in LoRa mode.
\returns Last packet signal-to-noise ratio (SNR).
*/