summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorDaniel Friesel <daniel.friesel@uos.de>2019-06-24 12:48:14 +0200
committerDaniel Friesel <daniel.friesel@uos.de>2019-06-24 12:48:14 +0200
commitdefe3e47dd837f9f2ae8447b7148893af8e8f1d0 (patch)
treecbed9022046695ffa118c21c581159d48943a1c0 /include
parent0dbe2001333b8f6a01e3082ce16e7326db801991 (diff)
import nRF24 TX code
Diffstat (limited to 'include')
-rw-r--r--include/driver/nrf24l01.h251
1 files changed, 212 insertions, 39 deletions
diff --git a/include/driver/nrf24l01.h b/include/driver/nrf24l01.h
index 911ef58..c10332d 100644
--- a/include/driver/nrf24l01.h
+++ b/include/driver/nrf24l01.h
@@ -5,63 +5,236 @@
#include "driver/gpio.h"
#include "arch.h"
-class Nrf24l01 {
- private:
- Nrf24l01(const Nrf24l01 &copy);
- unsigned char txbuf[2];
- unsigned char rxbuf[2];
-
- uint8_t writeRegister(uint8_t reg, uint8_t value);
- uint8_t readRegister(uint8_t reg);
-
- inline void csnHigh() {
- gpio.write(NRF24L01_CS_PIN, 1);
- arch.delay_us(5);
- }
- inline void csnLow() {
- gpio.write(NRF24L01_CS_PIN, 0);
- arch.delay_us(5);
- }
- inline void beginTransaction() {
- csnLow();
- }
- inline void endTransaction() {
- csnHigh();
- }
-
- public:
- Nrf24l01() {}
-
- /**
+#define rf24_max(a, b) ((a) > (b) ? (a) : (b))
+#define rf24_min(a, b) ((a) < (b) ? (a) : (b))
+
+class Nrf24l01
+{
+private:
+ Nrf24l01(const Nrf24l01 &copy);
+ unsigned char txbuf[2];
+ unsigned char rxbuf[2];
+
+ bool p_variant; /* False for RF24L01 and true for RF24L01P */
+ uint8_t payload_size; /**< Fixed size of payloads */
+ bool dynamic_payloads_enabled; /**< Whether dynamic payloads are enabled. */
+ uint8_t pipe0_reading_address[5]; /**< Last address set on pipe 0 for reading. */
+ uint8_t addr_width; /**< The address width to use - 3,4 or 5 bytes. */
+ uint32_t txRxDelay; /**< Var for adjusting delays depending on datarate */
+
+ uint8_t writeRegister(uint8_t reg, uint8_t value);
+ uint8_t readRegister(uint8_t reg);
+ uint8_t writePayload(const void *buf, uint8_t data_len, const uint8_t writeType);
+
+ inline void csnHigh()
+ {
+ gpio.write(NRF24L01_CS_PIN, 1);
+ arch.delay_us(5);
+ }
+ inline void csnLow()
+ {
+ gpio.write(NRF24L01_CS_PIN, 0);
+ arch.delay_us(5);
+ }
+ inline void beginTransaction()
+ {
+ csnLow();
+ }
+ inline void endTransaction()
+ {
+ csnHigh();
+ }
+
+public:
+ Nrf24l01() : payload_size(32), dynamic_payloads_enabled(false), addr_width(5) {}
+
+ /**
* Power Amplifier level.
*
* For use with setPALevel()
*/
- enum rf24_pa_dbm_e { RF24_PA_MIN = 0,RF24_PA_LOW, RF24_PA_HIGH, RF24_PA_MAX, RF24_PA_ERROR };
+ enum rf24_pa_dbm_e
+ {
+ RF24_PA_MIN = 0,
+ RF24_PA_LOW,
+ RF24_PA_HIGH,
+ RF24_PA_MAX,
+ RF24_PA_ERROR
+ };
- /**
+ /**
* Data rate. How fast data moves through the air.
*
* For use with setDataRate()
*/
- enum rf24_datarate_e { RF24_1MBPS = 0, RF24_2MBPS, RF24_250KBPS };
+ enum rf24_datarate_e
+ {
+ RF24_1MBPS = 0,
+ RF24_2MBPS,
+ RF24_250KBPS
+ };
- /**
+ /**
* CRC Length. How big (if any) of a CRC is included.
*
* For use with setCRCLength()
*/
- enum rf24_crclength_e { RF24_CRC_DISABLED = 0, RF24_CRC_8, RF24_CRC_16 };
+ enum rf24_crclength_e
+ {
+ RF24_CRC_DISABLED = 0,
+ RF24_CRC_8,
+ RF24_CRC_16
+ };
+
+ /**
+ * Enter low-power mode
+ *
+ * To return to normal power mode, call powerUp().
+ *
+ * @note After calling startListening(), a basic radio will consume about 13.5mA
+ * at max PA level.
+ * During active transmission, the radio will consume about 11.5mA, but this will
+ * be reduced to 26uA (.026mA) between sending.
+ * In full powerDown mode, the radio will consume approximately 900nA (.0009mA)
+ *
+ * @code
+ * radio.powerDown();
+ * avr_enter_sleep_mode(); // Custom function to sleep the device
+ * radio.powerUp();
+ * @endcode
+ */
+ void powerDown(void);
+
+ /**
+ * Leave low-power mode - required for normal radio operation after calling powerDown()
+ *
+ * To return to low power mode, call powerDown().
+ * @note This will take up to 5ms for maximum compatibility
+ */
+ void powerUp(void);
+
+ /**
+ * Empty the transmit buffer. This is generally not required in standard operation.
+ * May be required in specific cases after stopListening() , if operating at 250KBPS data rate.
+ *
+ * @return Current value of status register
+ */
+ uint8_t flushTx(void);
+
+ /**
+ * Empty the receive buffer
+ *
+ * @return Current value of status register
+ */
+ uint8_t flushRx(void);
+
+ void setup();
+ /**
+ * Set Power Amplifier (PA) level to one of four levels:
+ * RF24_PA_MIN, RF24_PA_LOW, RF24_PA_HIGH and RF24_PA_MAX
+ *
+ * The power levels correspond to the following output levels respectively:
+ * NRF24L01: -18dBm, -12dBm,-6dBM, and 0dBm
+ *
+ * SI24R1: -6dBm, 0dBm, 3dBM, and 7dBm.
+ *
+ * @param level Desired PA level.
+ */
+ void setPALevel(uint8_t level); // 0 (-18B), 1 (-12dB), 2 (-6dB), 3 (0dB)
+
+ /**
+ * Set the address width from 3 to 5 bytes (24, 32 or 40 bit)
+ *
+ * @param a_width The address width to use: 3,4 or 5
+ */
+
+ void setAddressWidth(uint8_t a_width);
+
+ /**
+ * Set the number and delay of retries upon failed submit
+ *
+ * @param delay How long to wait between each retry, in multiples of 250us,
+ * max is 15. 0 means 250us, 15 means 4000us.
+ * @param count How many retries before giving up, max 15
+ */
+ void setRetries(uint8_t delay, uint8_t count);
+
+ /**
+ * Set RF communication channel
+ *
+ * @param channel Which RF channel to communicate on, 0-125
+ */
+ void setChannel(uint8_t channel);
+
+ /**
+ * Get RF communication channel
+ *
+ * @return The currently configured RF Channel
+ */
+ uint8_t getChannel(void);
+
+ /**
+ * Set Static Payload Size
+ *
+ * This implementation uses a pre-stablished fixed payload size for all
+ * transmissions. If this method is never called, the driver will always
+ * transmit the maximum payload size (32 bytes), no matter how much
+ * was sent to write().
+ *
+ * @todo Implement variable-sized payloads feature
+ *
+ * @param size The number of bytes in the payload
+ */
+ void setPayloadSize(uint8_t size);
+
+ /**
+ * Get Static Payload Size
+ *
+ * @see setPayloadSize()
+ *
+ * @return The number of bytes in the payload
+ */
+ uint8_t getPayloadSize(void);
+
+ /**
+ * Set the transmission data rate
+ *
+ * @warning setting RF24_250KBPS will fail for non-plus units
+ *
+ * @param speed RF24_250KBPS for 250kbs, RF24_1MBPS for 1Mbps, or RF24_2MBPS for 2Mbps
+ * @return true if the change was successful
+ */
+ bool setDataRate(rf24_datarate_e speed);
+ /**
+ * The radio will generate interrupt signals when a transmission is complete,
+ * a transmission fails, or a payload is received. This allows users to mask
+ * those interrupts to prevent them from generating a signal on the interrupt
+ * pin. Interrupts are enabled on the radio chip by default.
+ *
+ * @code
+ * Mask all interrupts except the receive interrupt:
+ *
+ * radio.maskIRQ(1,1,0);
+ * @endcode
+ *
+ * @param tx_ok Mask transmission complete interrupts
+ * @param tx_fail Mask transmit failure interrupts
+ * @param rx_ready Mask payload received interrupts
+ */
+ void maskIRQ(bool tx_ok, bool tx_fail, bool rx_ready);
- void setup();
- void powerOn();
- void powerOff();
+ /**
+ * Turn on or off the special features of the chip
+ *
+ * The chip has certain 'features' which are only available when the 'features'
+ * are enabled. See the datasheet for details.
+ */
+ void toggleFeatures(void);
- void setRetries(uint8_t delay, uint8_t count);
- void setPALevel ( uint8_t level ); // 0 (-18B), 1 (-12dB), 2 (-6dB), 3 (0dB)
+ uint8_t write(const void *buf, uint8_t len, bool blocking);
- uint8_t getStatus();
+ uint8_t getStatus();
};
extern Nrf24l01 nrf24l01;