From 3bb368f3e1d7e0d4dd79680aa0594a3c1e28d51a Mon Sep 17 00:00:00 2001 From: TMRh20 Date: Mon, 25 Sep 2023 23:50:35 -0600 Subject: [PATCH] Small doc updates - Fix enum description for PA Level - Fix stoplistening doc - Adjust openReadingPipe doc --- src/nrf_to_nrf.h | 24 ++++++------------------ 1 file changed, 6 insertions(+), 18 deletions(-) diff --git a/src/nrf_to_nrf.h b/src/nrf_to_nrf.h index d681ef2..caa80eb 100644 --- a/src/nrf_to_nrf.h +++ b/src/nrf_to_nrf.h @@ -35,31 +35,19 @@ typedef enum { /** - * (0) represents: - * nRF24L01 | Si24R1 with
lnaEnabled = 1 | Si24R1 with
lnaEnabled = 0 - * :-------:|:-----------------------------:|:----------------------------: - * -18 dBm | -6 dBm | -12 dBm + * (0) represents -12dBm */ NRF_PA_MIN = 0, /** - * (1) represents: - * nRF24L01 | Si24R1 with
lnaEnabled = 1 | Si24R1 with
lnaEnabled = 0 - * :-------:|:-----------------------------:|:----------------------------: - * -12 dBm | 0 dBm | -4 dBm + * (1) represents 2dBm */ NRF_PA_LOW, /** - * (2) represents: - * nRF24L01 | Si24R1 with
lnaEnabled = 1 | Si24R1 with
lnaEnabled = 0 - * :-------:|:-----------------------------:|:----------------------------: - * -6 dBm | 3 dBm | 1 dBm + * (2) represents 6dBm */ NRF_PA_HIGH, /** - * (3) represents: - * nRF24L01 | Si24R1 with
lnaEnabled = 1 | Si24R1 with
lnaEnabled = 0 - * :-------:|:-----------------------------:|:----------------------------: - * 0 dBm | 7 dBm | 4 dBm + * (3) represents 8dBm */ NRF_PA_MAX, /** @@ -171,13 +159,13 @@ class nrf_to_nrf /** * Same as NRF24 - * @param setWritingPipe Same as RF24 + * @param setWritingPipe Used internally * @param resetAddresses Used internally to reset addresses */ void stopListening(bool setWritingPipe = true, bool resetAddresses = true); /** - * Same as NRF24 + * Same as NRF24 except the 52840 has 8 pipes */ void openReadingPipe(uint8_t child, const uint8_t* address);