Merge pull request #454 from cterwilliger/documentation-updates

Documentation updates
pull/457/head
Jan Gromeš 2022-01-28 18:52:10 +01:00 zatwierdzone przez GitHub
commit 6acf8feacc
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: 4AEE18F83AFDEB23
2 zmienionych plików z 3 dodań i 2 usunięć

Wyświetl plik

@ -869,7 +869,8 @@ class CC1101: public PhysicalLayer {
int16_t setDataShaping(uint8_t sh) override; 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. \param encoding Encoding to be used.

Wyświetl plik

@ -791,7 +791,7 @@ class SX127x: public PhysicalLayer {
float getAFCError(); 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). \returns Last packet signal-to-noise ratio (SNR).
*/ */