diff --git a/libraries/MySensors/MyConfig.h b/libraries/MySensors/MyConfig.h index ffe3978..f24c700 100644 --- a/libraries/MySensors/MyConfig.h +++ b/libraries/MySensors/MyConfig.h @@ -35,11 +35,6 @@ // final sketch but is helpful to see what is actually is happening during development //#define MY_DEBUG -// Enable MY_DEBUG_VERBOSE flag for verbose debug prints related to RF24 radio. -// Requires DEBUG to be enabled. -// This will add even more to the size of the final sketch! -//#define MY_DEBUG_VERBOSE - // Enable MY_DEBUG_VERBOSE_SIGNING flag for verbose debug prints related to signing. // Requires DEBUG to be enabled. // This will add even more to the size of the final sketch! @@ -327,12 +322,18 @@ #endif /********************************** -* NRF24L01 Driver Defaults +* NRF24L01P Driver Defaults ***********************************/ // Enables RF24 encryption (all nodes and gateway must have this enabled, and all must be personalized with the same AES key) //#define MY_RF24_ENABLE_ENCRYPTION +/** + * @def MY_DEBUG_VERBOSE_RF24 + * @brief Enable MY_DEBUG_VERBOSE_RF24 flag for verbose debug prints related to the RF24 driver. Requires DEBUG to be enabled. + */ +//#define MY_DEBUG_VERBOSE_RF24 + /** * @def MY_RF24_CE_PIN * @brief Default RF24 chip enable pin setting. Override in sketch if needed. @@ -399,12 +400,30 @@ * @def MY_RF24_BASE_RADIO_ID * @brief RF24 radio network identifier. * - * This is also act as base value for sensor nodeId addresses. Change this (or channel) if you have more than one sensor network. + * This acts as base value for sensor nodeId addresses. Change this (or channel) if you have more than one sensor network. */ #ifndef MY_RF24_BASE_RADIO_ID -#define MY_RF24_BASE_RADIO_ID ((uint64_t)0xA8A8E1FC00LL) +#define MY_RF24_BASE_RADIO_ID 0x00,0xFC,0xE1,0xA8,0xA8 #endif +/** + * @def MY_RF24_ADDR_WIDTH + * @brief RF24 address width. + * + * This defines the width of the base address. + */ +#ifndef MY_RF24_ADDR_WIDTH +#define MY_RF24_ADDR_WIDTH 5 +#endif + +/** + * @def MY_RF24_SANITY_CHECK + * @brief RF24 sanity check to verify functional RF module + * + * This reads back and compares configuration registers. Disable if using non-P modules + */ +#define MY_RF24_SANITY_CHECK + // Enable SOFTSPI for NRF24L01, useful for the W5100 Ethernet module //#define MY_SOFTSPI diff --git a/libraries/MySensors/core/MyTransportNRF24.cpp b/libraries/MySensors/core/MyTransportNRF24.cpp index 3d2ac1d..8af2ec6 100644 --- a/libraries/MySensors/core/MyTransportNRF24.cpp +++ b/libraries/MySensors/core/MyTransportNRF24.cpp @@ -19,22 +19,14 @@ #include "MyConfig.h" #include "MyTransport.h" -#include #include "drivers/RF24/RF24.h" -#include "drivers/RF24/RF24_config.h" + #if defined(MY_RF24_ENABLE_ENCRYPTION) #include "drivers/AES/AES.h" #endif -#define TO_ADDR(x) (MY_RF24_BASE_RADIO_ID + x) - -#define WRITE_PIPE ((uint8_t)0) -#define CURRENT_NODE_PIPE ((uint8_t)1) -#define BROADCAST_PIPE ((uint8_t)2) -RF24 _rf24(MY_RF24_CE_PIN, MY_RF24_CS_PIN); -uint8_t _address; #if defined(MY_RF24_ENABLE_ENCRYPTION) AES _aes; uint8_t _dataenc[32] = {0}; @@ -42,95 +34,60 @@ uint8_t _address; #endif bool transportInit() { - // Start up the radio library - _rf24.begin(); - - if (!_rf24.isPVariant()) { - return false; - } - _rf24.setAutoAck(1); - _rf24.setAutoAck(BROADCAST_PIPE,false); // Turn off auto ack for broadcast - _rf24.enableAckPayload(); - _rf24.setChannel(MY_RF24_CHANNEL); - _rf24.setPALevel(MY_RF24_PA_LEVEL); - if (!_rf24.setDataRate(MY_RF24_DATARATE)) { - return false; - } - _rf24.setRetries(5,15); - _rf24.setCRCLength(RF24_CRC_16); - _rf24.enableDynamicPayloads(); - - // All nodes listen to broadcast pipe (for FIND_PARENT_RESPONSE messages) - _rf24.openReadingPipe(BROADCAST_PIPE, TO_ADDR(BROADCAST_ADDRESS)); - - + #if defined(MY_RF24_ENABLE_ENCRYPTION) hwReadConfigBlock((void*)_psk, (void*)EEPROM_RF_ENCRYPTION_AES_KEY_ADDRESS, 16); - _aes.set_key(_psk, 16); //set up AES-key - memset(_psk, 0, 16); // Make sure it is purged from memory when set + //set up AES-key + _aes.set_key(_psk, 16); + // Make sure it is purged from memory when set + memset(_psk, 0, 16); #endif - - //_rf24.printDetails(); - - return true; + + return initializeRF24(); } void transportSetAddress(uint8_t address) { - _address = address; - _rf24.openReadingPipe(WRITE_PIPE, TO_ADDR(address)); - _rf24.openReadingPipe(CURRENT_NODE_PIPE, TO_ADDR(address)); - _rf24.startListening(); + setNodeAddress(address); + startListening(); } uint8_t transportGetAddress() { - return _address; + return getNodeID(); } -bool transportSend(uint8_t to, const void* data, uint8_t len) { +bool transportSend(uint8_t recipient, const void* data, uint8_t len) { #if defined(MY_RF24_ENABLE_ENCRYPTION) - memcpy(_dataenc,data,len); // copy input data because it is read-only - - _aes.set_IV(0);//not sure if necessary + // copy input data because it is read-only + memcpy(_dataenc,data,len); + // has to be adjusted, WIP! + _aes.set_IV(0); len = len > 16 ? 32 : 16; - _aes.cbc_encrypt(_dataenc, _dataenc, len/16); //encrypt - #endif - - // Make sure radio has powered up - - _rf24.powerUp(); - _rf24.stopListening(); - _rf24.openWritingPipe(TO_ADDR(to)); - #if defined(MY_RF24_ENABLE_ENCRYPTION) - bool ok = _rf24.write(_dataenc, len, to == BROADCAST_ADDRESS); + //encrypt data + _aes.cbc_encrypt(_dataenc, _dataenc, len/16); + bool status = sendMessage( recipient, _dataenc, len ); #else - bool ok = _rf24.write(data, len, to == BROADCAST_ADDRESS); + bool status = sendMessage( recipient, data, len ); #endif - _rf24.startListening(); - return ok; + + return status; } bool transportAvailable(uint8_t *to) { - uint8_t pipe = 255; - boolean avail = _rf24.available(&pipe); - - (void)avail; //until somebody makes use of 'avail' - if (pipe == CURRENT_NODE_PIPE) - *to = _address; - else if (pipe == BROADCAST_PIPE) - *to = BROADCAST_ADDRESS; - return (_rf24.available() && pipe < 6); + bool avail = IsDataAvailable(to); + return avail; } uint8_t transportReceive(void* data) { - uint8_t len = _rf24.getDynamicPayloadSize(); - _rf24.read(data, len); + uint8_t len = readMessage(data); #if defined(MY_RF24_ENABLE_ENCRYPTION) - _aes.set_IV(0);//not sure if necessary - _aes.cbc_decrypt((byte*)(data), (byte*)(data), len>16?2:1); // decrypt + // has to be adjusted, WIP! + _aes.set_IV(0); + // decrypt data + _aes.cbc_decrypt((byte*)(data), (byte*)(data), len>16?2:1); #endif return len; } void transportPowerDown() { - _rf24.powerDown(); + powerDown(); } diff --git a/libraries/MySensors/drivers/RF24/RF24.cpp b/libraries/MySensors/drivers/RF24/RF24.cpp index 4941c91..5f637a4 100644 --- a/libraries/MySensors/drivers/RF24/RF24.cpp +++ b/libraries/MySensors/drivers/RF24/RF24.cpp @@ -1,1416 +1,273 @@ -/* - Copyright (C) 2011 J. Coliz - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - version 2 as published by the Free Software Foundation. +/** + * The MySensors Arduino library handles the wireless radio link and protocol + * between your home built sensors/actuators and HA controller of choice. + * The sensors forms a self healing radio network with optional repeaters. Each + * repeater and gateway builds a routing tables in EEPROM which keeps track of the + * network topology allowing messages to be routed to nodes. + * + * Created by Henrik Ekblad + * Copyright (C) 2013-2015 Sensnology AB + * Full contributor list: https://github.com/mysensors/Arduino/graphs/contributors + * + * Documentation: http://www.mysensors.org + * Support Forum: http://forum.mysensors.org + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * version 2 as published by the Free Software Foundation. + * + * Based on maniacbug's RF24 library, copyright (C) 2011 J. Coliz + * Driver refactored and optimized for speed and size by Olivier Mauti */ -#include "nRF24L01.h" -#include "RF24_config.h" + #include "RF24.h" -/****************************************************************************/ -#ifdef MY_DEBUG_VERBOSE -static void print_hex( uint8_t v, const bool prefix0x = false ) -{ - if (prefix0x) - Serial.print(F("0x")); - - Serial.print(v >> 4, HEX); - Serial.print(v & 0x0F, HEX); -} -#endif - -void RF24::csn(bool mode) -{ - // Minimum ideal SPI bus speed is 2x data rate - // If we assume 2Mbs data rate and 16Mhz clock, a - // divider of 4 is the minimum we want. - // CLK:BUS 8Mhz:2Mhz, 16Mhz:4Mhz, or 20Mhz:5Mhz -#ifdef ARDUINO - #if ( !defined(RF24_TINY) && !defined (__arm__) && !defined (MY_SOFTSPI)) || defined (CORE_TEENSY) - //_SPI.setBitOrder(MSBFIRST); - //_SPI.setDataMode(SPI_MODE0); - //_SPI.setClockDivider(SPI_CLOCK_DIV2); - #endif -#endif +// static variables +uint8_t MYS_RF24_base_addr[MY_RF24_ADDR_WIDTH] = { MY_RF24_BASE_RADIO_ID }; +uint8_t MYS_RF24_rxaddr_register; +uint8_t MYS_RF24_nodeAddress = AUTO; -#if defined (RF24_TINY) - if (ce_pin != csn_pin) { - digitalWrite(csn_pin,mode); - } - else { - if (mode == HIGH) { - PORTB |= (1<CSN HIGH - delayMicroseconds(100); // allow csn to settle. - } - else { - PORTB &= ~(1<CSN LOW - delayMicroseconds(11); // allow csn to settle - } - } -#elif !defined (__arm__) || defined (CORE_TEENSY) || defined(ARDUINO_ARCH_SAMD) - digitalWrite(csn_pin,mode); -#endif - +void csn(bool level) { + digitalWrite(MY_RF24_CS_PIN, level); } -/****************************************************************************/ - -void RF24::ce(bool level) -{ - //Allow for 3-pin use on ATTiny - if (ce_pin != csn_pin) digitalWrite(ce_pin,level); +void ce(bool level) { + digitalWrite(MY_RF24_CE_PIN, level); } -/****************************************************************************/ - -uint8_t RF24::read_register(uint8_t reg, uint8_t* buf, uint8_t len) -{ - uint8_t status; - -#if defined (__arm__) && !defined ( CORE_TEENSY ) && !defined (ARDUINO_ARCH_SAMD) - status = _SPI.transfer(csn_pin, R_REGISTER | ( REGISTER_MASK & reg ), SPI_CONTINUE ); - while ( len-- > 1 ){ - *buf++ = _SPI.transfer(csn_pin,0xff, SPI_CONTINUE); - } - *buf++ = _SPI.transfer(csn_pin,0xff); - -#else - csn(LOW); - status = _SPI.transfer( R_REGISTER | ( REGISTER_MASK & reg ) ); - while ( len-- ){ - *buf++ = _SPI.transfer(0xff); - } - csn(HIGH); - -#endif - - return status; -} - -/****************************************************************************/ - -uint8_t RF24::read_register(uint8_t reg) -{ - - #if defined (__arm__) && !defined ( CORE_TEENSY ) && !defined (ARDUINO_ARCH_SAMD) - _SPI.transfer(csn_pin, R_REGISTER | ( REGISTER_MASK & reg ) , SPI_CONTINUE); - uint8_t result = _SPI.transfer(csn_pin,0xff); - #else - csn(LOW); - _SPI.transfer( R_REGISTER | ( REGISTER_MASK & reg ) ); - uint8_t result = _SPI.transfer(0xff); - - csn(HIGH); - #endif - - return result; -} - -/****************************************************************************/ - -uint8_t RF24::write_register(uint8_t reg, const uint8_t* buf, uint8_t len) -{ - uint8_t status; - - #if defined (__arm__) && !defined ( CORE_TEENSY ) && !defined (ARDUINO_ARCH_SAMD) - status = _SPI.transfer(csn_pin, W_REGISTER | ( REGISTER_MASK & reg ), SPI_CONTINUE ); - while ( --len){ - _SPI.transfer(csn_pin,*buf++, SPI_CONTINUE); - } - _SPI.transfer(csn_pin,*buf++); - #else - - csn(LOW); - status = _SPI.transfer( W_REGISTER | ( REGISTER_MASK & reg ) ); - while ( len-- ) - _SPI.transfer(*buf++); - - csn(HIGH); - - #endif - - return status; -} - -/****************************************************************************/ - -uint8_t RF24::write_register(uint8_t reg, uint8_t value) -{ - uint8_t status; - -#ifdef MY_DEBUG_VERBOSE - Serial.print(F("write_register(")); print_hex(reg, true); Serial.print(F(",")); print_hex(value, true); Serial.println(F(")")); -#endif - -#if defined (__arm__) && !defined ( CORE_TEENSY ) && !defined (ARDUINO_ARCH_SAMD) - status = _SPI.transfer(csn_pin, W_REGISTER | ( REGISTER_MASK & reg ), SPI_CONTINUE); - _SPI.transfer(csn_pin,value); -#else - csn(LOW); - status = _SPI.transfer( W_REGISTER | ( REGISTER_MASK & reg ) ); - _SPI.transfer(value); - csn(HIGH); -#endif - - return status; -} - -/****************************************************************************/ - -uint8_t RF24::write_payload(const void* buf, uint8_t data_len, const uint8_t writeType) -{ - uint8_t status; - const uint8_t* current = reinterpret_cast(buf); - - data_len = min(data_len, payload_size); - uint8_t blank_len = dynamic_payloads_enabled ? 0 : payload_size - data_len; - - //printf("[Writing %u bytes %u blanks]",data_len,blank_len); - - #if defined (__arm__) && !defined ( CORE_TEENSY ) && !defined (ARDUINO_ARCH_SAMD) - - status = _SPI.transfer(csn_pin, writeType , SPI_CONTINUE); - - if(blank_len){ - while ( data_len--){ - _SPI.transfer(csn_pin,*current++, SPI_CONTINUE); - } - while ( --blank_len ){ - _SPI.transfer(csn_pin,0, SPI_CONTINUE); - } - _SPI.transfer(csn_pin,0); - }else{ - while( --data_len ){ - _SPI.transfer(csn_pin,*current++, SPI_CONTINUE); - } - _SPI.transfer(csn_pin,*current); - } - - #else - - csn(LOW); - status = _SPI.transfer( writeType ); - while ( data_len-- ) { - _SPI.transfer(*current++); - } - while ( blank_len-- ) { - _SPI.transfer(0); - } - csn(HIGH); - - #endif - - return status; -} - -/****************************************************************************/ - -uint8_t RF24::read_payload(void* buf, uint8_t data_len) -{ - uint8_t status; - uint8_t* current = reinterpret_cast(buf); - - if(data_len > payload_size) data_len = payload_size; - uint8_t blank_len = dynamic_payloads_enabled ? 0 : payload_size - data_len; - - //printf("[Reading %u bytes %u blanks]",data_len,blank_len); - - - #if defined (__arm__) && !defined ( CORE_TEENSY ) && !defined (ARDUINO_ARCH_SAMD) - - status = _SPI.transfer(csn_pin, R_RX_PAYLOAD, SPI_CONTINUE ); - - if( blank_len ){ - while ( data_len-- ){ - *current++ = _SPI.transfer(csn_pin,0xFF, SPI_CONTINUE); - } - - while ( --blank_len ){ - _SPI.transfer(csn_pin,0xFF, SPI_CONTINUE); - } - _SPI.transfer(csn_pin,0xFF); - }else{ - while ( --data_len ){ - *current++ = _SPI.transfer(csn_pin,0xFF, SPI_CONTINUE); - } - *current = _SPI.transfer(csn_pin,0xFF); - } - - #else - - csn(LOW); - status = _SPI.transfer( R_RX_PAYLOAD ); - while ( data_len-- ) { - *current++ = _SPI.transfer(0xFF); - } - while ( blank_len-- ) { - _SPI.transfer(0xff); - } - csn(HIGH); - - #endif - - return status; -} - -/****************************************************************************/ - -uint8_t RF24::flush_rx(void) -{ - return spiTrans( FLUSH_RX ); -} - -/****************************************************************************/ - -uint8_t RF24::flush_tx(void) -{ - return spiTrans( FLUSH_TX ); -} - -/****************************************************************************/ - -uint8_t RF24::spiTrans(uint8_t cmd){ - - uint8_t status; - #if defined (__arm__) && !defined ( CORE_TEENSY ) && !defined (ARDUINO_ARCH_SAMD) - status = _SPI.transfer(csn_pin, cmd ); - #else - - csn(LOW); - status = _SPI.transfer( cmd ); - csn(HIGH); - #endif - return status; - -} - -/****************************************************************************/ - -uint8_t RF24::get_status(void) -{ - return spiTrans(NOP); -} - -/****************************************************************************/ -void RF24::print_feature(void) -{ -#ifdef MY_DEBUG_VERBOSE - Serial.print(F("FEATURE=")); - print_hex(read_register(FEATURE), true); - Serial.println(F("")); -#endif -} - -/****************************************************************************/ -void RF24::print_status(uint8_t status) const -{ -#ifdef MY_DEBUG_VERBOSE - const uint8_t one = uint8_t(1); - const uint8_t zero = uint8_t(0); - print_hex(status, true); - Serial.print(F(" RX_DR=")); Serial.print((status & _BV(RX_DR)) ? one : zero ); - Serial.print(F(" TX_DS=")); Serial.print((status & _BV(TX_DS)) ? one : zero ); - Serial.print(F(" MAX_RT=")); Serial.print((status & _BV(MAX_RT)) ? one : zero ); - Serial.print(F(" RX_P_NO=")); Serial.print((status >> RX_P_NO) & uint8_t(B111)); - Serial.print(F(" TX_FULL=")); Serial.println((status & _BV(TX_FULL)) ? one : zero ); -#else - (void)status; -#endif -} - -/****************************************************************************/ -void RF24::print_observe_tx(uint8_t value) const -{ -#ifdef MY_DEBUG_VERBOSE - print_hex(value, true); - Serial.print(F(": POLS_CNT=")); Serial.print((value >> PLOS_CNT) & uint8_t(B1111)); - Serial.print(F(" ARC_CNT=")); Serial.println((value >> ARC_CNT) & uint8_t(B1111)); -#else - (void)value; -#endif -} - -/****************************************************************************/ -void RF24::print_byte_register(uint8_t reg, uint8_t qty) -{ -#ifdef MY_DEBUG_VERBOSE - bool prefix0x = true; - while (qty--) - { - print_hex(read_register(reg++), prefix0x); - Serial.print(F(" ")); - prefix0x = false; - } - Serial.println(F("")); -#else - (void)reg; - (void)qty; -#endif -} - -/****************************************************************************/ -void RF24::print_address_register(uint8_t reg, uint8_t qty) -{ -#ifdef MY_DEBUG_VERBOSE - bool prefix0x = true; - while (qty--) - { - uint8_t buffer[addr_width]; - read_register(reg++,buffer,sizeof buffer); - - uint8_t* bufptr = buffer + sizeof buffer; - while( --bufptr >= buffer ) - { - print_hex(read_register(*bufptr), prefix0x); - prefix0x = false; - } - Serial.print(F(" ")); - } - Serial.println(F("")); -#else - (void)reg; - (void)qty; -#endif -} -/****************************************************************************/ - -RF24::RF24(uint8_t _cepin, uint8_t _cspin): - ce_pin(_cepin), csn_pin(_cspin), p_variant(false), - payload_size(32), dynamic_payloads_enabled(false), addr_width(5)//,pipe0_reading_address(0) -{ -} - -/****************************************************************************/ - -void RF24::setChannel(uint8_t channel) -{ - const uint8_t max_channel = 125; - write_register(RF_CH,min(channel,max_channel)); -} - -/****************************************************************************/ - -void RF24::setPayloadSize(uint8_t size) -{ - payload_size = min(size,32); -} - -/****************************************************************************/ - -uint8_t RF24::getPayloadSize(void) -{ - return payload_size; -} - -/****************************************************************************/ -#ifdef MY_DEBUG_VERBOSE -static const char rf24_datarate_e_str_0[] PROGMEM = "1MBPS"; -static const char rf24_datarate_e_str_1[] PROGMEM = "2MBPS"; -static const char rf24_datarate_e_str_2[] PROGMEM = "250KBPS"; -static const char * const rf24_datarate_e_str_P[] PROGMEM = { - rf24_datarate_e_str_0, - rf24_datarate_e_str_1, - rf24_datarate_e_str_2, -}; -static const char rf24_model_e_str_0[] PROGMEM = "nRF24L01"; -static const char rf24_model_e_str_1[] PROGMEM = "nRF24L01+"; -static const char * const rf24_model_e_str_P[] PROGMEM = { - rf24_model_e_str_0, - rf24_model_e_str_1, -}; -static const char rf24_crclength_e_str_0[] PROGMEM = "Disabled"; -static const char rf24_crclength_e_str_1[] PROGMEM = "8 bits"; -static const char rf24_crclength_e_str_2[] PROGMEM = "16 bits" ; -static const char * const rf24_crclength_e_str_P[] PROGMEM = { - rf24_crclength_e_str_0, - rf24_crclength_e_str_1, - rf24_crclength_e_str_2, -}; -static const char rf24_pa_dbm_e_str_0[] PROGMEM = "PA_MIN"; -static const char rf24_pa_dbm_e_str_1[] PROGMEM = "PA_LOW"; -static const char rf24_pa_dbm_e_str_2[] PROGMEM = "PA_HIGH"; -static const char rf24_pa_dbm_e_str_3[] PROGMEM = "PA_MAX"; -static const char * const rf24_pa_dbm_e_str_P[] PROGMEM = { - rf24_pa_dbm_e_str_0, - rf24_pa_dbm_e_str_1, - rf24_pa_dbm_e_str_2, - rf24_pa_dbm_e_str_3, -}; -#endif - -#if (INTPTR_MAX == INT16_MAX) -// 16-bit architecture -> read word from flash and cast to ptr -#define PGM_READ_PTR(adr) (reinterpret_cast<__FlashStringHelper*>(pgm_read_word(adr))) -#elif (INTPTR_MAX == INT32_MAX) -// 32-bit architecture -> read double-word from flash and cast to ptr -#define PGM_READ_PTR(adr) (reinterpret_cast<__FlashStringHelper*>(pgm_read_dword(adr))) -#else -#error Unsupported processor architecture! -#endif - -void RF24::printDetails(void) -{ -#ifdef MY_DEBUG_VERBOSE - Serial.print(F("STATUS\t\t")); print_status(get_status()); - Serial.print(F("RX_ADDR_P0-1\t")); print_address_register(RX_ADDR_P0,2); - Serial.print(F("RX_ADDR_P2-5\t")); print_byte_register(RX_ADDR_P2,4); - Serial.print(F("TX_ADDR\t\t")); print_address_register(TX_ADDR); - - Serial.print(F("RX_PW_P0-6\t")); print_byte_register(RX_PW_P0,6); - Serial.print(F("EN_AA\t\t")); print_byte_register(EN_AA); - Serial.print(F("EN_RXADDR\t")); print_byte_register(EN_RXADDR); - Serial.print(F("RF_CH\t\t")); print_byte_register(RF_CH); - Serial.print(F("RF_SETUP\t")); print_byte_register(RF_SETUP); - Serial.print(F("CONFIG\t\t")); print_byte_register(NRF_CONFIG); - Serial.print(F("DYNPD/FEATURE\t")); print_byte_register(DYNPD,2); - - Serial.print(F("Data Rate\t")); Serial.println(PGM_READ_PTR(&rf24_datarate_e_str_P[getDataRate()])); - Serial.print(F("Model\t\t")); Serial.println(PGM_READ_PTR(&rf24_model_e_str_P[isPVariant()])); - Serial.print(F("CRC Length\t")); Serial.println(PGM_READ_PTR(&rf24_crclength_e_str_P[getCRCLength()])); - Serial.print(F("PA Power\t")); Serial.println(PGM_READ_PTR(&rf24_pa_dbm_e_str_P[getPALevel()])); -#endif -} -/****************************************************************************/ - -void RF24::begin(void) -{ - // Initialize pins - if (ce_pin != csn_pin) pinMode(ce_pin,OUTPUT); - - #if defined(__arm__) && ! defined( CORE_TEENSY ) && !defined (ARDUINO_ARCH_SAMD) - _SPI.begin(csn_pin); // Using the extended SPI features of the DUE - _SPI.setClockDivider(csn_pin, 9); // Set the bus speed to 8.4mhz on Due - _SPI.setBitOrder(csn_pin,MSBFIRST); // Set the bit order and mode specific to this device - _SPI.setDataMode(csn_pin,SPI_MODE0); - ce(LOW); - //csn(HIGH); - #else - if (ce_pin != csn_pin) pinMode(csn_pin,OUTPUT); - _SPI.begin(); - ce(LOW); - csn(HIGH); - #endif - - // Must allow the radio time to settle else configuration bits will not necessarily stick. - // This is actually only required following power up but some settling time also appears to - // be required after resets too. For full coverage, we'll always assume the worst. - // Enabling 16b CRC is by far the most obvious case if the wrong timing is used - or skipped. - // Technically we require 4.5ms + 14us as a worst case. We'll just call it 5ms for good measure. - // WARNING: Delay is based on P-variant whereby non-P *may* require different timing. - delay( 5 ) ; - - // Set 1500uS (minimum for 32B payload in ESB@250KBPS) timeouts, to make testing a little easier - // WARNING: If this is ever lowered, either 250KBS mode with AA is broken or maximum packet - // sizes must never be used. See documentation for a more complete explanation. - setRetries(5,15); - - // Reset value is MAX - //setPALevel( RF24_PA_MAX ) ; - - // Determine if this is a p or non-p RF24 module and then - // reset our data rate back to default value. This works - // because a non-P variant won't allow the data rate to - // be set to 250Kbps. - if( setDataRate( RF24_250KBPS ) ) - { - p_variant = true ; - } - - // Then set the data rate to the slowest (and most reliable) speed supported by all - // hardware. - setDataRate( RF24_1MBPS ) ; - - // Initialize CRC and request 2-byte (16bit) CRC - setCRCLength( RF24_CRC_16 ) ; - - // Disable dynamic payloads, to match dynamic_payloads_enabled setting - Reset value is 0 - //write_register(DYNPD,0); - - // Reset current status - // Notice reset and flush is the last thing we do - write_register(RF24_STATUS,_BV(RX_DR) | _BV(TX_DS) | _BV(MAX_RT) ); - - // Set up default configuration. Callers can always change it later. - // This channel should be universally safe and not bleed over into adjacent - // spectrum. - setChannel(76); - - // Flush buffers - flush_rx(); - flush_tx(); - - powerUp(); //Power up by default when begin() is called - - // Enable PTX, do not write CE high so radio will remain in standby I mode ( 130us max to transition to RX or TX instead of 1500us from powerUp ) - // PTX should use only 22uA of power - write_register(NRF_CONFIG, ( read_register(NRF_CONFIG) ) & ~_BV(PRIM_RX) ); - - // Dump register values - printDetails(); -} - -/****************************************************************************/ - -void RF24::startListening(void) -{ - #if !defined (RF24_TINY) - powerUp(); - #endif - write_register(NRF_CONFIG, read_register(NRF_CONFIG) | _BV(PRIM_RX)); - write_register(RF24_STATUS, _BV(RX_DR) | _BV(TX_DS) | _BV(MAX_RT) ); - - // Restore the pipe0 adddress, if exists - if (pipe0_reading_address[0] > 0) { - write_register(RX_ADDR_P0, pipe0_reading_address, addr_width); - } else { - closeReadingPipe(0); - } - - // Flush buffers - //flush_rx(); - if(read_register(FEATURE) & _BV(EN_ACK_PAY)) { - flush_tx(); - } - - // Go! - ce(HIGH); -} - -/****************************************************************************/ -static uint8_t get_child_pipe_mask(const uint8_t idx) -{ -#ifdef ESP8266 - static const uint8_t child_pipe_enable[] = - { - _BV(ERX_P0), _BV(ERX_P1), _BV(ERX_P2), _BV(ERX_P3), _BV(ERX_P4), _BV(ERX_P5) - }; - return child_pipe_enable[idx]; -#else - static const uint8_t child_pipe_enable[] PROGMEM = - { - _BV(ERX_P0), _BV(ERX_P1), _BV(ERX_P2), _BV(ERX_P3), _BV(ERX_P4), _BV(ERX_P5) - }; - return pgm_read_byte(&child_pipe_enable[idx]); -#endif -} - -void RF24::stopListening(void) -{ - ce(LOW); -#if defined(__arm__) - delayMicroseconds(300); -#endif - delayMicroseconds(130); - - if(read_register(FEATURE) & _BV(EN_ACK_PAY)) { - flush_tx(); - } - - //flush_rx(); - write_register(NRF_CONFIG, ( read_register(NRF_CONFIG) ) & ~_BV(PRIM_RX) ); - - #if defined (RF24_TINY) - // for 3 pins solution TX mode is only left with additonal powerDown/powerUp cycle - if (ce_pin == csn_pin) { - powerDown(); - powerUp(); - } - #endif - - write_register(EN_RXADDR,read_register(EN_RXADDR) | get_child_pipe_mask(0)); // Enable RX on pipe0 - - delayMicroseconds(100); -} - -/****************************************************************************/ - -void RF24::powerDown(void) -{ - ce(LOW); // Guarantee CE is low on powerDown - write_register(NRF_CONFIG,read_register(NRF_CONFIG) & ~_BV(PWR_UP)); -} - -/****************************************************************************/ - -//Power up now. Radio will not power down unless instructed by MCU for config changes etc. -void RF24::powerUp(void) -{ - uint8_t cfg = read_register(NRF_CONFIG); - - // if not powered up then power up and wait for the radio to initialize - if (!(cfg & _BV(PWR_UP))){ - write_register(NRF_CONFIG,read_register(NRF_CONFIG) | _BV(PWR_UP)); - - // For nRF24L01+ to go from power down mode to TX or RX mode it must first pass through stand-by mode. - // There must be a delay of Tpd2stby (see Table 16.) after the nRF24L01+ leaves power down mode before - // the CEis set high. - Tpd2stby can be up to 5ms per the 1.0 datasheet - delay(5); - - } -} - -/******************************************************************/ -#if defined (FAILURE_HANDLING) -void RF24::errNotify(){ -#ifdef MY_DEBUG - Serial.println(F("RF24 HARDWARE FAIL")); -#endif - failureDetected = 1; -} -#endif -/******************************************************************/ - -//Similar to the previous write, clears the interrupt flags -bool RF24::write( const void* buf, uint8_t len, const bool multicast ) -{ - //Start Writing - startFastWrite(buf,len,multicast); - - //Wait until complete or failed - #if defined (FAILURE_HANDLING) - uint32_t timer = millis(); - #endif - - while( ! ( get_status() & ( _BV(TX_DS) | _BV(MAX_RT) ))) { - #if defined (FAILURE_HANDLING) - if(millis() - timer > 75){ - errNotify(); - return 0; - } - #endif - #if defined(ARDUINO_ARCH_ESP8266) - yield(); - #endif - } - - ce(LOW); - - uint8_t status = write_register(RF24_STATUS,_BV(RX_DR) | _BV(TX_DS) | _BV(MAX_RT) ); - - //Max retries exceeded - if( status & _BV(MAX_RT)){ - flush_tx(); //Only going to be 1 packet int the FIFO at a time using this method, so just flush - return 0; - } - //TX OK 1 or 0 - return 1; -} - -bool RF24::write( const void* buf, uint8_t len ){ - return write(buf,len,0); -} -/****************************************************************************/ - -//For general use, the interrupt flags are not important to clear -bool RF24::writeBlocking( const void* buf, uint8_t len, uint32_t timeout ) -{ - //Block until the FIFO is NOT full. - //Keep track of the MAX retries and set auto-retry if seeing failures - //This way the FIFO will fill up and allow blocking until packets go through - //The radio will auto-clear everything in the FIFO as long as CE remains high - - uint32_t timer = millis(); //Get the time that the payload transmission started - - while( ( get_status() & ( _BV(TX_FULL) ))) { //Blocking only if FIFO is full. This will loop and block until TX is successful or timeout - - if( get_status() & _BV(MAX_RT)){ //If MAX Retries have been reached - reUseTX(); //Set re-transmit and clear the MAX_RT interrupt flag - if(millis() - timer > timeout){ return 0; } //If this payload has exceeded the user-defined timeout, exit and return 0 - } - #if defined (FAILURE_HANDLING) - if(millis() - timer > (timeout+75) ){ - errNotify(); - return 0; - } - #endif - - } - - //Start Writing - startFastWrite(buf,len,0); //Write the payload if a buffer is clear - - return 1; //Return 1 to indicate successful transmission -} - -/****************************************************************************/ - -void RF24::reUseTX(){ - write_register(RF24_STATUS,_BV(MAX_RT) ); //Clear max retry flag - spiTrans( REUSE_TX_PL ); - ce(LOW); //Re-Transfer packet - ce(HIGH); -} - -/****************************************************************************/ - -bool RF24::writeFast( const void* buf, uint8_t len, const bool multicast ) -{ - //Block until the FIFO is NOT full. - //Keep track of the MAX retries and set auto-retry if seeing failures - //Return 0 so the user can control the retrys and set a timer or failure counter if required - //The radio will auto-clear everything in the FIFO as long as CE remains high - - #if defined (FAILURE_HANDLING) - uint32_t timer = millis(); - #endif - - while( ( get_status() & ( _BV(TX_FULL) ))) { //Blocking only if FIFO is full. This will loop and block until TX is successful or fail - - if( get_status() & _BV(MAX_RT)){ - //reUseTX(); //Set re-transmit - write_register(RF24_STATUS,_BV(MAX_RT) ); //Clear max retry flag - return 0; //Return 0. The previous payload has been retransmitted - //From the user perspective, if you get a 0, just keep trying to send the same payload - } - #if defined (FAILURE_HANDLING) - if(millis() - timer > 75 ){ - errNotify(); - return 0; - } - #endif - } - //Start Writing - startFastWrite(buf,len,multicast); - - return 1; -} - -bool RF24::writeFast( const void* buf, uint8_t len ){ - return writeFast(buf,len,0); -} - -/****************************************************************************/ - -//Per the documentation, we want to set PTX Mode when not listening. Then all we do is write data and set CE high -//In this mode, if we can keep the FIFO buffers loaded, packets will transmit immediately (no 130us delay) -//Otherwise we enter Standby-II mode, which is still faster than standby mode -//Also, we remove the need to keep writing the config register over and over and delaying for 150 us each time if sending a stream of data - -void RF24::startFastWrite( const void* buf, uint8_t len, const bool multicast){ //TMRh20 - - //write_payload( buf,len); - write_payload( buf, len,multicast ? W_TX_PAYLOAD_NO_ACK : W_TX_PAYLOAD ) ; - ce(HIGH); - -} - -/****************************************************************************/ - -//Added the original startWrite back in so users can still use interrupts, ack payloads, etc -//Allows the library to pass all tests -void RF24::startWrite( const void* buf, uint8_t len, const bool multicast ){ - - // Send the payload - - //write_payload( buf, len ); - write_payload( buf, len,multicast? W_TX_PAYLOAD_NO_ACK : W_TX_PAYLOAD ) ; - ce(HIGH); - #if defined(CORE_TEENSY) || !defined(ARDUINO) +uint8_t spiMultiByteTransfer(uint8_t cmd, uint8_t* buf, uint8_t len, boolean aReadMode) { + uint8_t* current = buf; + csn(LOW); delayMicroseconds(10); - #endif - ce(LOW); - - -} - -/****************************************************************************/ - -bool RF24::rxFifoFull(){ - return read_register(FIFO_STATUS) & _BV(RX_FULL); -} -/****************************************************************************/ - -bool RF24::txStandBy(){ - #if defined (FAILURE_HANDLING) - uint32_t timeout = millis(); - #endif - while( ! (read_register(FIFO_STATUS) & _BV(TX_EMPTY)) ){ - if( get_status() & _BV(MAX_RT)){ - write_register(RF24_STATUS,_BV(MAX_RT) ); - ce(LOW); - flush_tx(); //Non blocking, flush the data - return 0; - } - #if defined (FAILURE_HANDLING) - if( millis() - timeout > 75){ - errNotify(); - return 0; - } - #endif + uint8_t status = _SPI.transfer( cmd ); + while ( len-- ) { + if (aReadMode) { + status = _SPI.transfer( NOP ); + if(buf!=NULL) *current++ = status; + } else status = _SPI.transfer(*current++); } + csn(HIGH); + delayMicroseconds(10); + return status; +} - ce(LOW); //Set STANDBY-I mode - return 1; +#define readRegister(reg) _readRegister( R_REGISTER | ( REGISTER_MASK & (reg) ) ) +uint8_t _readRegister(uint8_t cmd) { + uint8_t value = spiMultiByteTransfer(cmd, NULL, 1, true); + RF24_DEBUG(PSTR("read register, reg=%d, value=%d\n"), cmd & (R_REGISTER ^ 0xFF), value); + return value; } -/****************************************************************************/ +#define writeByteRegister(reg, value) _writeByteRegister( W_REGISTER | ( REGISTER_MASK & (reg) ), value ) +uint8_t _writeByteRegister(uint8_t cmd, uint8_t value) { + RF24_DEBUG(PSTR("write register, reg=%d, value=%d\n"), cmd & (W_REGISTER ^ 0xFF), value); + return spiMultiByteTransfer( cmd , &value, 1, false); +} -bool RF24::txStandBy(uint32_t timeout){ +#define writeMultiByteRegister(reg, buf, len) spiMultiByteTransfer( W_REGISTER | ( REGISTER_MASK & (reg) ), (uint8_t*)buf, len, false ) +uint8_t spiByteTransfer(uint8_t cmd) { + return spiMultiByteTransfer( cmd , NULL, 0, false); +} - uint32_t start = millis(); +void flushRX(void) { + RF24_DEBUG(PSTR("flushRX\n")); + spiByteTransfer( FLUSH_RX ); +} - while( ! (read_register(FIFO_STATUS) & _BV(TX_EMPTY)) ){ - if( get_status() & _BV(MAX_RT)){ - write_register(RF24_STATUS,_BV(MAX_RT) ); - ce(LOW); //Set re-transmit - ce(HIGH); - if(millis() - start >= timeout){ - ce(LOW); flush_tx(); return 0; - } - } - #if defined (FAILURE_HANDLING) - if( millis() - start > (timeout+75)){ - errNotify(); - return 0; - } - #endif +void flushTX(void) { + RF24_DEBUG(PSTR("flushTX\n")); + spiByteTransfer( FLUSH_TX ); +} + +uint8_t getStatus(void) { + return spiByteTransfer( NOP ); +} + +void openWritingPipe(uint8_t recipient) { + RF24_DEBUG(PSTR("open writing pipe, recipient=%d\n"), recipient); + // only write LSB of RX0 and TX pipe + writeByteRegister(RX_ADDR_P0, recipient); + writeByteRegister(TX_ADDR, recipient); +} + +void startListening(void) { + + RF24_DEBUG(PSTR("start listening\n")); + // toggle PRX + writeByteRegister(NRF_CONFIG, _CONFIGURATION | _BV(PWR_UP) | _BV(PRIM_RX) ); + // all RX pipe addresses must be unique, therefore skip if node ID is 0xFF + if(MYS_RF24_nodeAddress!=AUTO) writeByteRegister(RX_ADDR_P0, MYS_RF24_nodeAddress); + // start listening + ce(HIGH); +} + +void stopListening(void) { + RF24_DEBUG(PSTR("stop listening\n")); + ce(LOW); + delayMicroseconds(130); + writeByteRegister(NRF_CONFIG, _CONFIGURATION | _BV(PWR_UP) ); + delayMicroseconds(100); +} + +void powerDown(void) { + ce(LOW); + writeByteRegister(NRF_CONFIG, 0x00); + RF24_DEBUG(PSTR("power down\n")); +} + +bool sendMessage( uint8_t recipient, const void* buf, uint8_t len ) { + uint8_t status; + + stopListening(); + openWritingPipe( recipient ); + RF24_DEBUG(PSTR("send message to %d, len=%d\n"),recipient,len); + // flush TX FIFO + flushTX(); + // this command is affected in clones (e.g. Si24R1): flipped NoACK bit when using W_TX_PAYLOAD_NO_ACK / W_TX_PAYLOAD + // spiMultiByteTransfer( recipient==BROADCAST_ADDRESS ? W_TX_PAYLOAD_NO_ACK : W_TX_PAYLOAD, (uint8_t*)buf, len, false ); + // we are safe by disabling AutoACK on the broadcasting pipe + spiMultiByteTransfer( W_TX_PAYLOAD, (uint8_t*)buf, len, false ); + // go + ce(HIGH); + // TX starts after ~10us + do { + status = getStatus(); + } while (!(status & ( _BV(MAX_RT) | _BV(TX_DS) ))); + + ce(LOW); + // reset interrupts + writeByteRegister(RF24_STATUS, _BV(TX_DS) | _BV(MAX_RT) ); + // Max retries exceeded + if( status & _BV(MAX_RT)){ + // flush packet + RF24_DEBUG(PSTR("MAX_RT\n")); + flushTX(); } - + + startListening(); - ce(LOW); //Set STANDBY-I mode - return 1; - -} -/****************************************************************************/ - -void RF24::maskIRQ(bool tx, bool fail, bool rx){ - - write_register(NRF_CONFIG, ( read_register(NRF_CONFIG) ) | fail << MASK_MAX_RT | tx << MASK_TX_DS | rx << MASK_RX_DR ); + return (status & _BV(TX_DS)); } -/****************************************************************************/ - -uint8_t RF24::getDynamicPayloadSize(void) -{ - uint8_t result = 0; - - #if defined (__arm__) && ! defined( CORE_TEENSY ) && !defined (ARDUINO_ARCH_SAMD) - _SPI.transfer(csn_pin, R_RX_PL_WID, SPI_CONTINUE ); - result = _SPI.transfer(csn_pin,0xff); - #else - csn(LOW); - _SPI.transfer( R_RX_PL_WID ); - result = _SPI.transfer(0xff); - csn(HIGH); - - #endif - - if(result > 32) { flush_rx(); delay(2); return 0; } - return result; -} - -/****************************************************************************/ - -bool RF24::available(void) -{ - return available(NULL); -} - -/****************************************************************************/ - -bool RF24::available(uint8_t* pipe_num) -{ - //Check the FIFO buffer to see if data is waiting to be read - if(listeningStarted){ - while(micros() - lastAvailableCheck < 800 && listeningStarted){}; - lastAvailableCheck = micros(); - listeningStarted = 0; +uint8_t getDynamicPayloadSize(void) { + uint8_t result = spiMultiByteTransfer( R_RX_PL_WID ,NULL,1,true); + if(result > 32) { + RF24_DEBUG(PSTR("invalid payload length = %d\n"),result); + flushRX(); + result = 0; } - if (!( read_register(FIFO_STATUS) & _BV(RX_EMPTY) )){ - - // If the caller wants the pipe number, include that - if ( pipe_num ){ - uint8_t status = get_status(); - *pipe_num = ( status >> RX_P_NO ) & B111; - } - return 1; - } + return result; +} - return 0; +bool IsDataAvailable(uint8_t* to) { + uint8_t pipe_num = ( getStatus() >> RX_P_NO ) & 0b0111; + #if defined(MY_DEBUG_VERBOSE_RF24) + if(pipe_num <= 5) + RF24_DEBUG(PSTR("Data available on pipe %d\n"),pipe_num); + #endif + + if (pipe_num == NODE_PIPE) + *to = MYS_RF24_nodeAddress; + else if (pipe_num == BROADCAST_PIPE) + *to = BROADCAST_ADDRESS; + + return (pipe_num <= 5); +} +uint8_t readMessage( void* buf) { + uint8_t len = getDynamicPayloadSize(); + RF24_DEBUG(PSTR("read message, len=%d\n"), len); + spiMultiByteTransfer( R_RX_PAYLOAD , (uint8_t*)buf, len, true ); + // clear RX interrupt + writeByteRegister(RF24_STATUS, _BV(RX_DR) ); + return len; +} + +void setNodeAddress(uint8_t address) { + MYS_RF24_nodeAddress = address; + // activate node pipe + writeByteRegister(EN_RXADDR, _BV(ERX_P0 + BROADCAST_PIPE) | _BV(ERX_P0) ); + // enable autoACK on pipe 0 + writeByteRegister(EN_AA, _BV(ENAA_P0) ); + } -/****************************************************************************/ - -void RF24::read( void* buf, uint8_t len ){ - - // Fetch the payload - read_payload( buf, len ); - - //Clear the two possible interrupt flags with one command - write_register(RF24_STATUS,_BV(RX_DR) | _BV(MAX_RT) | _BV(TX_DS) ); - +uint8_t getNodeID(void) { + return MYS_RF24_nodeAddress; } -/****************************************************************************/ - -void RF24::whatHappened(bool& tx_ok,bool& tx_fail,bool& rx_ready) -{ - // Read the status & reset the status in one easy call - // Or is that such a good idea? - uint8_t status = write_register(RF24_STATUS,_BV(RX_DR) | _BV(TX_DS) | _BV(MAX_RT) ); - - // Report to the user what happened - tx_ok = status & _BV(TX_DS); - tx_fail = status & _BV(MAX_RT); - rx_ready = status & _BV(RX_DR); -} - -/****************************************************************************/ - -void RF24::openWritingPipe(uint64_t value) -{ - // Note that AVR 8-bit uC's store this LSB first, and the NRF24L01(+) - // expects it LSB first too, so we're good. - - write_register(RX_ADDR_P0, reinterpret_cast(&value), addr_width); - write_register(TX_ADDR, reinterpret_cast(&value), addr_width); - - - //const uint8_t max_payload_size = 32; - //write_register(RX_PW_P0,min(payload_size,max_payload_size)); - write_register(RX_PW_P0,payload_size); -} - -/****************************************************************************/ -void RF24::openWritingPipe(const uint8_t *address) -{ - // Note that AVR 8-bit uC's store this LSB first, and the NRF24L01(+) - // expects it LSB first too, so we're good. - - write_register(RX_ADDR_P0,address, addr_width); - write_register(TX_ADDR, address, addr_width); - - //const uint8_t max_payload_size = 32; - //write_register(RX_PW_P0,min(payload_size,max_payload_size)); - write_register(RX_PW_P0,payload_size); -} - -/****************************************************************************/ -static const uint8_t child_pipe[] PROGMEM = -{ - RX_ADDR_P0, RX_ADDR_P1, RX_ADDR_P2, RX_ADDR_P3, RX_ADDR_P4, RX_ADDR_P5 -}; -static const uint8_t child_payload_size[] PROGMEM = -{ - RX_PW_P0, RX_PW_P1, RX_PW_P2, RX_PW_P3, RX_PW_P4, RX_PW_P5 -}; - - -void RF24::openReadingPipe(uint8_t child, uint64_t address) -{ - // If this is pipe 0, cache the address. This is needed because - // openWritingPipe() will overwrite the pipe 0 address, so - // startListening() will have to restore it. - if (child == 0){ - memcpy(pipe0_reading_address,&address,addr_width); - } - - if (child <= 6) - { - // For pipes 2-5, only write the LSB - if ( child < 2 ) - write_register(pgm_read_byte(&child_pipe[child]), reinterpret_cast(&address), addr_width); - else - write_register(pgm_read_byte(&child_pipe[child]), reinterpret_cast(&address), 1); - - write_register(pgm_read_byte(&child_payload_size[child]),payload_size); - - // Note it would be more efficient to set all of the bits for all open - // pipes at once. However, I thought it would make the calling code - // more simple to do it this way. - write_register(EN_RXADDR,read_register(EN_RXADDR) | get_child_pipe_mask(child)); - } -} - -/****************************************************************************/ -void RF24::setAddressWidth(uint8_t a_width){ - - if(a_width -= 2){ - write_register(SETUP_AW,a_width%4); - addr_width = (a_width%4) + 2; +boolean initializeRF24(void) { + // Initialize pins + pinMode(MY_RF24_CE_PIN,OUTPUT); + pinMode(MY_RF24_CS_PIN,OUTPUT); + // Initialize SPI + _SPI.begin(); + // SoftSPI runs at ~2Mhz, no adjustments needed + #if !defined(MY_SOFTSPI) + // SPI speed max ~2Mhz + #if (F_CPU > 128000000) + _SPI.setClockDivider(SPI_CLOCK_DIV128); + #elif (F_CPU > 64000000) + _SPI.setClockDivider(SPI_CLOCK_DIV64); + #elif (F_CPU > 32000000) + _SPI.setClockDivider(SPI_CLOCK_DIV32); + #elif (F_CPU > 16000000) + _SPI.setClockDivider(SPI_CLOCK_DIV16); + #elif (F_CPU > 8000000) + _SPI.setClockDivider(SPI_CLOCK_DIV8); + #elif (F_CPU > 4000000) + _SPI.setClockDivider(SPI_CLOCK_DIV4); + #else + _SPI.setClockDivider(SPI_CLOCK_DIV2); + #endif + #endif + ce(LOW); + csn(HIGH); + // CRC and power up + writeByteRegister(NRF_CONFIG, _CONFIGURATION | _BV(PWR_UP) ) ; + // settle >2ms + delay(5); + // set address width + writeByteRegister(SETUP_AW, MY_RF24_ADDR_WIDTH - 2 ); + // auto retransmit delay 1500us, auto retransmit count 15 + writeByteRegister(SETUP_RETR, 5 << ARD | 15 << ARC); + // set channel + writeByteRegister(RF_CH, MY_RF24_CHANNEL); + // set data rate and pa level + writeByteRegister(RF_SETUP, _RF_SETUP); + // sanity check + #if defined(MY_RF24_SANITY_CHECK) + if(readRegister(RF_SETUP)!=_RF_SETUP) { + RF24_DEBUG(PSTR("Sanity check failed: RF_SETUP register=%d instead of %d, check wiring, replace module or non-P version\n"),readRegister(RF_SETUP), _RF_SETUP); + return false; } + #endif + // toggle features, not necessary on all chips/clones + writeByteRegister(ACTIVATE,0x73); + // enable ACK payload and dynamic payload + writeByteRegister(FEATURE, _FEATURE ); + // enable broadcasting pipe + writeByteRegister(EN_RXADDR, _BV(ERX_P0 + BROADCAST_PIPE) ); + // disable AA on all pipes, activcate when node pipe set + writeByteRegister(EN_AA, 0x00 ); + // enable dynamic payloads on used pipes + writeByteRegister(DYNPD, _BV(DPL_P0 + BROADCAST_PIPE) | _BV(DPL_P0)); + // listen to broadcast pipe + MYS_RF24_base_addr[0] = BROADCAST_ADDRESS; + writeMultiByteRegister(RX_ADDR_P0 + BROADCAST_PIPE, (uint8_t*)&MYS_RF24_base_addr, BROADCAST_PIPE > 1 ? 1 : MY_RF24_ADDR_WIDTH); + // pipe 0, set full address, later only LSB is updated + writeMultiByteRegister(RX_ADDR_P0, (uint8_t*)&MYS_RF24_base_addr, MY_RF24_ADDR_WIDTH); + writeMultiByteRegister(TX_ADDR, (uint8_t*)&MYS_RF24_base_addr, MY_RF24_ADDR_WIDTH); + // reset FIFO + flushRX(); + flushTX(); + // reset interrupts + writeByteRegister(RF24_STATUS, _BV(TX_DS) | _BV(MAX_RT) | _BV(RX_DR)); + return true; } -/****************************************************************************/ - -void RF24::openReadingPipe(uint8_t child, const uint8_t *address) -{ - // If this is pipe 0, cache the address. This is needed because - // openWritingPipe() will overwrite the pipe 0 address, so - // startListening() will have to restore it. - if (child == 0){ - memcpy(pipe0_reading_address,address,addr_width); - } - if (child <= 6) - { - // For pipes 2-5, only write the LSB - if ( child < 2 ){ - write_register(pgm_read_byte(&child_pipe[child]), address, addr_width); - }else{ - write_register(pgm_read_byte(&child_pipe[child]), address, 1); - } - write_register(pgm_read_byte(&child_payload_size[child]),payload_size); - - // Note it would be more efficient to set all of the bits for all open - // pipes at once. However, I thought it would make the calling code - // more simple to do it this way. - write_register(EN_RXADDR,read_register(EN_RXADDR) | get_child_pipe_mask(child)); - - } -} - -/****************************************************************************/ - -void RF24::closeReadingPipe( uint8_t pipe ) -{ - write_register(EN_RXADDR,read_register(EN_RXADDR) & ~get_child_pipe_mask(pipe)); -} - -/****************************************************************************/ - -void RF24::toggle_features(void) -{ - - #if defined (__arm__) && ! defined( CORE_TEENSY ) && !defined (ARDUINO_ARCH_SAMD) - _SPI.transfer(csn_pin, ACTIVATE, SPI_CONTINUE ); - _SPI.transfer(csn_pin, 0x73 ); - #else - csn(LOW); - _SPI.transfer( ACTIVATE ); - _SPI.transfer( 0x73 ); - csn(HIGH); - #endif -} - -/****************************************************************************/ -void RF24::enableDynamicPayloads(void) -{ - // Enable dynamic payload throughout the system - toggle_features(); - write_register(FEATURE,read_register(FEATURE) | _BV(EN_DPL) ); - print_feature(); - - // Enable dynamic payload on all pipes - // - // Not sure the use case of only having dynamic payload on certain - // pipes, so the library does not support it. - write_register(DYNPD,read_register(DYNPD) | _BV(DPL_P5) | _BV(DPL_P4) | _BV(DPL_P3) | _BV(DPL_P2) | _BV(DPL_P1) | _BV(DPL_P0)); - - dynamic_payloads_enabled = true; -} - -/****************************************************************************/ - -void RF24::enableAckPayload(void) -{ - // - // enable ack payload and dynamic payload features - // - toggle_features(); - write_register(FEATURE,read_register(FEATURE) | _BV(EN_ACK_PAY) | _BV(EN_DPL) ); - print_feature(); - - // - // Enable dynamic payload on pipes 0 & 1 - // - - write_register(DYNPD,read_register(DYNPD) | _BV(DPL_P1) | _BV(DPL_P0)); - dynamic_payloads_enabled = true; -} - -/****************************************************************************/ - -void RF24::enableDynamicAck(void){ - // - // enable dynamic ack features - // - toggle_features(); - write_register(FEATURE,read_register(FEATURE) | _BV(EN_DYN_ACK) ); - print_feature(); -} - -/****************************************************************************/ - -void RF24::writeAckPayload(uint8_t pipe, const void* buf, uint8_t len) -{ - const uint8_t* current = reinterpret_cast(buf); - - uint8_t data_len = min(len,32); - - #if defined (__arm__) && ! defined( CORE_TEENSY ) && !defined (ARDUINO_ARCH_SAMD) - _SPI.transfer(csn_pin, W_ACK_PAYLOAD | ( pipe & B111 ), SPI_CONTINUE); - while ( data_len-- > 1 ){ - _SPI.transfer(csn_pin,*current++, SPI_CONTINUE); - } - _SPI.transfer(csn_pin,*current++); - - #else - csn(LOW); - _SPI.transfer(W_ACK_PAYLOAD | ( pipe & B111 ) ); - - while ( data_len-- ) - _SPI.transfer(*current++); - - csn(HIGH); - - #endif -} - -/****************************************************************************/ - -bool RF24::isAckPayloadAvailable(void) -{ - return !(read_register(FIFO_STATUS) & _BV(RX_EMPTY)); -} - -/****************************************************************************/ - -bool RF24::isPVariant(void) -{ - return p_variant ; -} - -/****************************************************************************/ - -void RF24::setAutoAck(bool enable) -{ - if ( enable ) - write_register(EN_AA, B111111); - else - write_register(EN_AA, 0); -} - -/****************************************************************************/ - -void RF24::setAutoAck( uint8_t pipe, bool enable ) -{ - if ( pipe <= 6 ) - { - uint8_t en_aa = read_register( EN_AA ) ; - if( enable ) - { - en_aa |= _BV(pipe) ; - } - else - { - en_aa &= ~_BV(pipe) ; - } - write_register( EN_AA, en_aa ) ; - } -} - -/****************************************************************************/ - -bool RF24::testCarrier(void) -{ - return ( read_register(CD) & 1 ); -} - -/****************************************************************************/ - -bool RF24::testRPD(void) -{ - return ( read_register(RPD) & 1 ) ; -} - -/****************************************************************************/ - -void RF24::setPALevel(uint8_t level) -{ - - uint8_t setup = read_register(RF_SETUP) & 0b11111000; - - if(level > 3){ // If invalid level, go to max PA - level = (RF24_PA_MAX << 1) + 1; // +1 to support the SI24R1 chip extra bit - }else{ - level = (level << 1) + 1; // Else set level as requested - } - - - write_register( RF_SETUP, setup |= level ) ; // Write it to the chip -} - -/****************************************************************************/ - -uint8_t RF24::getPALevel(void) -{ - - return (read_register(RF_SETUP) & (_BV(RF_PWR_LOW) | _BV(RF_PWR_HIGH))) >> 1 ; -} - -/****************************************************************************/ - -bool RF24::setDataRate(rf24_datarate_e speed) -{ - bool result = false; - uint8_t setup = read_register(RF_SETUP) ; - - // HIGH and LOW '00' is 1Mbs - our default - setup &= ~(_BV(RF_DR_LOW) | _BV(RF_DR_HIGH)) ; - if( speed == RF24_250KBPS ) - { - // Must set the RF_DR_LOW to 1; RF_DR_HIGH (used to be RF_DR) is already 0 - // Making it '10'. - setup |= _BV( RF_DR_LOW ) ; - } - else - { - // Set 2Mbs, RF_DR (RF_DR_HIGH) is set 1 - // Making it '01' - if ( speed == RF24_2MBPS ) - { - setup |= _BV(RF_DR_HIGH); - } - } - write_register(RF_SETUP,setup); - - // Verify our result - if ( read_register(RF_SETUP) == setup ) - { - result = true; - } - - return result; -} - -/****************************************************************************/ - -rf24_datarate_e RF24::getDataRate( void ) -{ - rf24_datarate_e result ; - uint8_t dr = read_register(RF_SETUP) & (_BV(RF_DR_LOW) | _BV(RF_DR_HIGH)); - - // switch uses RAM (evil!) - // Order matters in our case below - if ( dr == _BV(RF_DR_LOW) ) - { - // '10' = 250KBPS - result = RF24_250KBPS ; - } - else if ( dr == _BV(RF_DR_HIGH) ) - { - // '01' = 2MBPS - result = RF24_2MBPS ; - } - else - { - // '00' = 1MBPS - result = RF24_1MBPS ; - } - return result ; -} - -/****************************************************************************/ - -void RF24::setCRCLength(rf24_crclength_e length) -{ - uint8_t config = read_register(NRF_CONFIG) & ~( _BV(CRCO) | _BV(EN_CRC)) ; - - // switch uses RAM (evil!) - if ( length == RF24_CRC_DISABLED ) - { - // Do nothing, we turned it off above. - } - else if ( length == RF24_CRC_8 ) - { - config |= _BV(EN_CRC); - } - else - { - config |= _BV(EN_CRC); - config |= _BV( CRCO ); - } - write_register( NRF_CONFIG, config ) ; -} - -/****************************************************************************/ - -rf24_crclength_e RF24::getCRCLength(void) -{ - rf24_crclength_e result = RF24_CRC_DISABLED; - - uint8_t config = read_register(NRF_CONFIG) & ( _BV(CRCO) | _BV(EN_CRC)) ; - uint8_t AA = read_register(EN_AA); - - if ( config & _BV(EN_CRC ) || AA) - { - if ( config & _BV(CRCO) ) - result = RF24_CRC_16; - else - result = RF24_CRC_8; - } - - return result; -} - -/****************************************************************************/ - -void RF24::disableCRC( void ) -{ - uint8_t disable = read_register(NRF_CONFIG) & ~_BV(EN_CRC) ; - write_register( NRF_CONFIG, disable ) ; -} - -/****************************************************************************/ -void RF24::setRetries(uint8_t delay, uint8_t count) -{ - write_register(SETUP_RETR,(delay&0xf)< - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - version 2 as published by the Free Software Foundation. - */ - /** - * @file RF24.h - * - * Class declaration for RF24 and helper enums - */ +* The MySensors Arduino library handles the wireless radio link and protocol +* between your home built sensors/actuators and HA controller of choice. +* The sensors forms a self healing radio network with optional repeaters. Each +* repeater and gateway builds a routing tables in EEPROM which keeps track of the +* network topology allowing messages to be routed to nodes. +* +* Created by Henrik Ekblad +* Copyright (C) 2013-2015 Sensnology AB +* Full contributor list: https://github.com/mysensors/Arduino/graphs/contributors +* +* Documentation: http://www.mysensors.org +* Support Forum: http://forum.mysensors.org +* +* This program is free software; you can redistribute it and/or +* modify it under the terms of the GNU General Public License +* version 2 as published by the Free Software Foundation. +* +* Based on maniacbug's RF24 library, copyright (C) 2011 J. Coliz +* Driver refactored and optimized for speed and size by Olivier Mauti +*/ #ifndef __RF24_H__ #define __RF24_H__ -#include "RF24_config.h" +#include +#include #if defined SOFTSPI -#include + #include #endif -/** - * Power Amplifier level. - * - * For use with setPALevel() - */ -typedef enum { RF24_PA_MIN = 0,RF24_PA_LOW, RF24_PA_HIGH, RF24_PA_MAX, RF24_PA_ERROR } rf24_pa_dbm_e ; -/** - * Data rate. How fast data moves through the air. - * - * For use with setDataRate() - */ -typedef enum { RF24_1MBPS = 0, RF24_2MBPS, RF24_250KBPS } rf24_datarate_e; +// settings +#define _CONFIGURATION (uint8_t) (RF24_CRC_16 << 1) +#define _FEATURE (uint8_t)( _BV(EN_DPL) | _BV(EN_ACK_PAY) ) +#define _RF_SETUP (uint8_t)( ((MY_RF24_DATARATE & 0b10 ) << 4) | ((MY_RF24_DATARATE & 0b01 ) << 3) | (MY_RF24_PA_LEVEL << 1) ) + 1 // +1 for Si24R1 -/** - * CRC Length. How big (if any) of a CRC is included. - * - * For use with setCRCLength() - */ -typedef enum { RF24_CRC_DISABLED = 0, RF24_CRC_8, RF24_CRC_16 } rf24_crclength_e; +// pipes +#define BROADCAST_PIPE 1 +#define NODE_PIPE 0 -/** - * Driver for nRF24L01(+) 2.4GHz Wireless Transceiver - */ +// debug +#if defined(MY_DEBUG_VERBOSE_RF24) + #define RF24_DEBUG(x,...) debug(x, ##__VA_ARGS__) +#else + #define RF24_DEBUG(x,...) +#endif -class RF24 -{ -private: -#ifdef MY_SOFTSPI - SoftSPI spi; +// PA levels +#define RF24_PA_MIN 0 +#define RF24_PA_LOW 1 +#define RF24_PA_HIGH 2 +#define RF24_PA_MAX 3 + +// data rate +#define RF24_1MBPS 0 +#define RF24_2MBPS 1 +#define RF24_250KBPS 2 + +// CRC +#define RF24_CRC_DISABLED 0 +#define RF24_CRC_8 2 +#define RF24_CRC_16 3 + +#if defined (ARDUINO) && !defined (__arm__) && !defined (_SPI) + #if defined(SPI_UART) + #include + #define _SPI uspi + #elif defined(MY_SOFTSPI) + #include "drivers/AVR/DigitalIO/DigitalIO.h" + // change these pins to your liking + const uint8_t SOFT_SPI_MISO_PIN = MY_SOFT_SPI_MOSI_PIN; + const uint8_t SOFT_SPI_MOSI_PIN = MY_SOFT_SPI_MISO_PIN; + const uint8_t SOFT_SPI_SCK_PIN = MY_SOFT_SPI_SCK_PIN; + const uint8_t SPI_MODE = 0; + #define _SPI spi + #elif defined(ARDUINO_ARCH_SAMD) + #include + #define _SPI SPI1 + #else + #include + #define _SPI SPI + #endif +#else + #include + #include + #include + #if defined(__arm__) || defined (CORE_TEENSY) + #include + #endif + + #if !defined(CORE_TEENSY) + #define _BV(x) (1<<(x)) + #if !defined(__arm__) + extern HardwareSPI SPI; + #endif + #else + #define printf MY_SERIALDEVICE.printf + #endif + #if !defined(_SPI) + #define _SPI SPI + #endif +#endif + +#if defined(MY_SOFTSPI) + SoftSPI spi; #elif defined (SPI_UART) - SPIUARTClass uspi; + SPIUARTClass uspi; #endif - uint8_t ce_pin; /**< "Chip Enable" pin, activates the RX or TX role */ - uint8_t csn_pin; /**< SPI Chip select */ - 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 lastAvailableCheck; /**< Limits the amount of time between reading data, only when switching between modes */ - boolean listeningStarted; /**< Var for delaying available() after start listening */ - -public: - /** - * @name Primary public interface - * - * These are the main methods you need to operate the chip - */ - /**@{*/ - /** - * Constructor - * - * Creates a new instance of this driver. Before using, you create an instance - * and send in the unique pins that this chip is connected to. - * - * @param _cepin The pin attached to Chip Enable on the RF module - * @param _cspin The pin attached to Chip Select - */ - RF24(uint8_t _cepin, uint8_t _cspin); +// nRF24L01(+) register definitions +#define NRF_CONFIG 0x00 +#define EN_AA 0x01 +#define EN_RXADDR 0x02 +#define SETUP_AW 0x03 +#define SETUP_RETR 0x04 +#define RF_CH 0x05 +#define RF_SETUP 0x06 +#define RF24_STATUS 0x07 +#define OBSERVE_TX 0x08 +#define CD 0x09 +#define RX_ADDR_P0 0x0A +#define RX_ADDR_P1 0x0B +#define RX_ADDR_P2 0x0C +#define RX_ADDR_P3 0x0D +#define RX_ADDR_P4 0x0E +#define RX_ADDR_P5 0x0F +#define TX_ADDR 0x10 +#define RX_PW_P0 0x11 +#define RX_PW_P1 0x12 +#define RX_PW_P2 0x13 +#define RX_PW_P3 0x14 +#define RX_PW_P4 0x15 +#define RX_PW_P5 0x16 +#define FIFO_STATUS 0x17 +#define DYNPD 0x1C +#define FEATURE 0x1D + +// instructions +#define R_REGISTER 0x00 +#define RPD 0x09 +#define W_REGISTER 0x20 +#define REGISTER_MASK 0x1F +#define ACTIVATE 0x50 +#define R_RX_PL_WID 0x60 +#define R_RX_PAYLOAD 0x61 +#define W_TX_PAYLOAD 0xA0 +#define W_ACK_PAYLOAD 0xA8 +#define W_TX_PAYLOAD_NO_ACK 0xB0 +#define FLUSH_TX 0xE1 +#define FLUSH_RX 0xE2 +#define REUSE_TX_PL 0xE3 +#define NOP 0xFF + +// bit mnemonics +#define MASK_RX_DR 6 +#define MASK_TX_DS 5 +#define MASK_MAX_RT 4 +#define EN_CRC 3 +#define CRCO 2 +#define PWR_UP 1 +#define PRIM_RX 0 + +// auto ACK +#define ENAA_P5 5 +#define ENAA_P4 4 +#define ENAA_P3 3 +#define ENAA_P2 2 +#define ENAA_P1 1 +#define ENAA_P0 0 + +// rx pipe +#define ERX_P5 5 +#define ERX_P4 4 +#define ERX_P3 3 +#define ERX_P2 2 +#define ERX_P1 1 +#define ERX_P0 0 + +// dynamic payload +#define DPL_P5 5 +#define DPL_P4 4 +#define DPL_P3 3 +#define DPL_P2 2 +#define DPL_P1 1 +#define DPL_P0 0 + +#define AW 0 +#define ARD 4 +#define ARC 0 +#define PLL_LOCK 4 +#define RF_DR 3 +#define RF_PWR 6 +#define RX_DR 6 +#define TX_DS 5 +#define MAX_RT 4 +#define RX_P_NO 1 +#define TX_FULL 0 +#define PLOS_CNT 4 +#define ARC_CNT 0 +#define TX_REUSE 6 +#define FIFO_FULL 5 +#define TX_EMPTY 4 +#define RX_FULL 1 +#define RX_EMPTY 0 + +// features +#define EN_DPL 2 +#define EN_ACK_PAY 1 +#define EN_DYN_ACK 0 + +#define LNA_HCURR 0 +#define RF_DR_LOW 5 +#define RF_DR_HIGH 3 +#define RF_PWR_LOW 1 +#define RF_PWR_HIGH 2 - /** - * Begin operation of the chip - * - * Call this in setup(), before calling any other methods. - */ - void begin(void); - /** - * Start listening on the pipes opened for reading. - * - * Be sure to call openReadingPipe() first. Do not call write() while - * in this mode, without first calling stopListening(). Call - * Available() to check for incoming traffic, and read() to get it. - */ - void startListening(void); - - /** - * Stop listening for incoming messages - * - * Do this before calling write(). - */ - void stopListening(void); - - /** - * Test whether there are bytes available to be read - * - * @return True if there is a payload available, false if none is - */ - bool available(void); - - /** - * Read the payload - * - * The size of data read is the fixed payload size, see getPayloadSize() - * - * @note I specifically chose 'void*' as a data type to make it easier - * for beginners to use. No casting needed. - * - * @note No longer boolean. Use available to determine if packets are - * available. Interrupt flags are now cleared during reads instead of - * when calling available(). - * - * @param buf Pointer to a buffer where the data should be written - * @param len Maximum number of bytes to read into the buffer - * @return No return value. Use available(). - */ - void read( void* buf, uint8_t len ); - - /** - * Be sure to call openWritingPipe() first to set the destination - * of where to write to. - * - * This blocks until the message is successfully acknowledged by - * the receiver or the timeout/retransmit maxima are reached. In - * the current configuration, the max delay here is 60-70ms. - * - * The maximum size of data written is the fixed payload size, see - * getPayloadSize(). However, you can write less, and the remainder - * will just be filled with zeroes. - * - * TX/RX/RT interrupt flags will be cleared every time write is called - * - * @param buf Pointer to the data to be sent - * @param len Number of bytes to be sent - * @return True if the payload was delivered successfully false if not - */ - bool write( const void* buf, uint8_t len ); - - /** - * New: Open a pipe for writing via byte array. Old addressing format retained - * for compatibility. - * - * Only one writing pipe can be open at once, but you can change the address - * you'll write to. Call stopListening() first. - * - * Addresses are assigned via a byte array, default is 5 byte address length - * - * Usage is exactly the same as before, except for declaring the array - * - * @code - * uint8_t addresses[][6] = {"1Node","2Node"}; - * openWritingPipe(addresses[0]); - * @endcode - * @see setAddressWidth - * - * @param address The address of the pipe to open. Coordinate these pipe - * addresses amongst nodes on the network. - */ - - void openWritingPipe(const uint8_t *address); - - /** - * Open a pipe for reading - * - * Up to 6 pipes can be open for reading at once. Open all the - * reading pipes, and then call startListening(). - * - * @see openWritingPipe - * @see setAddressWidth - * - * @warning Pipes 1-5 should share the same address, except the first byte. - * Only the first byte in the array should be unique, e.g. - * @code - * uint8_t addresses[][6] = {"1Node","2Node"}; - * openReadingPipe(1,addresses[0]); - * openReadingPipe(2,addresses[1]); - * @endcode - * - * @warning Pipe 0 is also used by the writing pipe. So if you open - * pipe 0 for reading, and then startListening(), it will overwrite the - * writing pipe. Ergo, do an openWritingPipe() again before write(). - * - * @param number Which pipe# to open, 0-5. - * @param address The 24, 32 or 40 bit address of the pipe to open. - */ - - void openReadingPipe(uint8_t number, const uint8_t *address); - - /**@}*/ - /** - * @name Advanced Operation - * - * Methods you can use to drive the chip in more advanced ways - */ - /**@{*/ - - /** - * Print a giant block of debugging information to serial - * - * @warning Does nothing if MY_DEBUG_VERBOSE is not defined - */ - void printDetails(void); - - /** - * Test whether there are bytes available to be read in the - * FIFO buffers. This optimized version does not rely on interrupt - * flags, but checks the actual FIFO buffers. - * - * @param[out] pipe_num Which pipe has the payload available - * @return True if there is a payload available, false if none is - */ - bool available(uint8_t* pipe_num); - - /** - * Check if the radio needs to be read. Can be used to prevent data loss - * @@return True if all three 32-byte radio buffers are full - */ - bool rxFifoFull(); - - /** - * Enter low-power mode - * - * To return to normal power mode, either write() some data or - * startListening, or 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) - */ - 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) ; - - /** - * Write for single NOACK writes. Optionally disables acknowledgements/autoretries for a single write. - * - * @note enableDynamicAck() must be called to enable this feature - * - * Can be used with enableAckPayload() to request a response - * @see enableDynamicAck() - * @see setAutoAck() - * @see write() - * - * @param buf Pointer to the data to be sent - * @param len Number of bytes to be sent - * @param multicast Request ACK (0), NOACK (1) - */ - bool write( const void* buf, uint8_t len, const bool multicast ); - - /** - * This will not block until the 3 FIFO buffers are filled with data. - * Once the FIFOs are full, writeFast will simply wait for success or - * timeout, and return 1 or 0 respectively. From a user perspective, just - * keep trying to send the same data. The library will keep auto retrying - * the current payload using the built in functionality. - * @warning It is important to never keep the nRF24L01 in TX mode and FIFO full for more than 4ms at a time. If the auto - * retransmit is enabled, the nRF24L01 is never in TX mode long enough to disobey this rule. Allow the FIFO - * to clear by issuing txStandBy() or ensure appropriate time between transmissions. - * - * ONLY max retry interrupt flags will be cleared when writeFast is called - * - * @code - * Example (Partial blocking): - * - * radio.writeFast(&buf,32); // Writes 1 payload to the buffers - * txStandBy(); // Returns 0 if failed. 1 if success. Blocks only until MAX_RT timeout or success. Data flushed on fail. - * - * radio.writeFast(&buf,32); // Writes 1 payload to the buffers - * txStandBy(1000); // Using extended timeouts, returns 1 if success. Retries failed payloads for 1 seconds before returning 0. - * @endcode - * - * @see txStandBy() - * @see write() - * @see writeBlocking() - * - * @param buf Pointer to the data to be sent - * @param len Number of bytes to be sent - * @return True if the payload was delivered successfully false if not - */ - bool writeFast( const void* buf, uint8_t len ); - - /** - * WriteFast for single NOACK writes. Disables acknowledgements/autoretries for a single write. - * - * @note enableDynamicAck() must be called to enable this feature - * @see enableDynamicAck() - * @see setAutoAck() - * - * @param buf Pointer to the data to be sent - * @param len Number of bytes to be sent - * @param multicast Request ACK (0) or NOACK (1) - */ - bool writeFast( const void* buf, uint8_t len, const bool multicast ); - - /** - * This function extends the auto-retry mechanism to any specified duration. - * It will not block until the 3 FIFO buffers are filled with data. - * If so the library will auto retry until a new payload is written - * or the user specified timeout period is reached. - * @warning It is important to never keep the nRF24L01 in TX mode and FIFO full for more than 4ms at a time. If the auto - * retransmit is enabled, the nRF24L01 is never in TX mode long enough to disobey this rule. Allow the FIFO - * to clear by issuing txStandBy() or ensure appropriate time between transmissions. - * - * ONLY max retry interrupt flags will be cleared when writeBlocking is called - * @code - * Example (Full blocking): - * - * radio.writeBlocking(&buf,32,1000); //Wait up to 1 second to write 1 payload to the buffers - * txStandBy(1000); //Wait up to 1 second for the payload to send. Return 1 if ok, 0 if failed. - * //Blocks only until user timeout or success. Data flushed on fail. - * @endcode - * @note If used from within an interrupt, the interrupt should be disabled until completion, and sei(); called to enable millis(). - * @see txStandBy() - * @see write() - * @see writeFast() - * - * @param buf Pointer to the data to be sent - * @param len Number of bytes to be sent - * @param timeout User defined timeout in milliseconds. - * @return True if the payload was loaded into the buffer successfully false if not - */ - bool writeBlocking( const void* buf, uint8_t len, uint32_t timeout ); - - /** - * This function should be called as soon as transmission is finished to - * drop the radio back to STANDBY-I mode. If not issued, the radio will - * remain in STANDBY-II mode which, per the data sheet, is not a recommended - * operating mode. - * - * @note When transmitting data in rapid succession, it is still recommended by - * the manufacturer to drop the radio out of TX or STANDBY-II mode if there is - * time enough between sends for the FIFOs to empty. - * - * Relies on built-in auto retry functionality. - * - * @code - * Example (Partial blocking): - * - * radio.writeFast(&buf,32); - * radio.writeFast(&buf,32); - * radio.writeFast(&buf,32); //Fills the FIFO buffers up - * bool ok = txStandBy(); //Returns 0 if failed. 1 if success. - * //Blocks only until MAX_RT timeout or success. Data flushed on fail. - * @endcode - * @see txStandBy(unsigned long timeout) - * @return True if transmission is successful - * - */ - bool txStandBy(); - - /** - * This function allows extended blocking and auto-retries per a user defined timeout - * @code - * Fully Blocking Example: - * - * radio.writeFast(&buf,32); - * radio.writeFast(&buf,32); - * radio.writeFast(&buf,32); //Fills the FIFO buffers up - * bool ok = txStandBy(1000); //Returns 0 if failed after 1 second of retries. 1 if success. - * //Blocks only until user defined timeout or success. Data flushed on fail. - * @endcode - * @note If used from within an interrupt, the interrupt should be disabled until completion, and sei(); called to enable millis(). - * @param timeout Number of milliseconds to retry failed payloads - * @return True if transmission is successful - * - */ - bool txStandBy(uint32_t timeout); - - /** - * Write an ack payload for the specified pipe - * - * The next time a message is received on @p pipe, the data in @p buf will - * be sent back in the acknowledgement. - * - * @warning Only three of these can be pending at any time as there are only 3 FIFO buffers. - * - * @param pipe Which pipe# (typically 1-5) will get this response. - * @param buf Pointer to data that is sent - * @param len Length of the data to send, up to 32 bytes max. Not affected - * by the static payload set by setPayloadSize(). - */ - void writeAckPayload(uint8_t pipe, const void* buf, uint8_t len); - - /** - * Enable dynamic ACKs (single write multicasting) for chosen messages - * - * @note To enable full multicasting or per-pipe multicast, use setAutoAck() - * - * @warning This MUST be called prior to attempting single write NOACK calls - * @code - * radio.enableDynamicAck(); - * radio.write(&data,32,1); // Sends a payload with no acknowledgement requested - * radio.write(&data,32,0); // Sends a payload using auto-retry/autoACK - * @endcode - */ - void enableDynamicAck(); - - /** - * Determine if an ack payload was received in the most recent call to - * write(). The regular available() can also be used. - * - * Call read() to retrieve the ack payload. - * - * @return True if an ack payload is available. - */ - bool isAckPayloadAvailable(void); - - /** - * Call this when you get an interrupt to find out why - * - * Tells you what caused the interrupt, and clears the state of - * interrupts. - * - * @param[out] tx_ok The send was successful (TX_DS) - * @param[out] tx_fail The send failed, too many retries (MAX_RT) - * @param[out] rx_ready There is a message waiting to be read (RX_DS) - */ - void whatHappened(bool& tx_ok,bool& tx_fail,bool& rx_ready); - - /** - * Non-blocking write to the open writing pipe used for buffered writes - * - * @note Optimization: This function now leaves the CE pin high, so the radio - * will remain in TX or STANDBY-II Mode until a txStandBy() command is issued. - * This allows the chip to be used to its full potential in TX mode. - * @warning It is important to never keep the nRF24L01 in TX mode with FIFO full for more than 4ms at a time. If the auto - * retransmit is enabled, the nRF24L01 is never in TX mode long enough to disobey this rule. Allow the FIFO - * to clear by issuing txStandBy() or ensure appropriate time between transmissions. - * - * @see write() - * @see writeFast() - * @see startWrite() - * @see writeBlocking() - * - * For single noAck writes see: - * @see enableDynamicAck() - * @see setAutoAck() - * - * @param buf Pointer to the data to be sent - * @param len Number of bytes to be sent - * @param multicast Request ACK (0) or NOACK (1) - * @return True if the payload was delivered successfully false if not - */ - void startFastWrite( const void* buf, uint8_t len, const bool multicast ); - - /** - * Non-blocking write to the open writing pipe - * - * Just like write(), but it returns immediately. To find out what happened - * to the send, catch the IRQ and then call whatHappened(). - * - * @see write() - * @see writeFast() - * @see startFastWrite() - * @see whatHappened() - * - * For single noAck writes see: - * @see enableDynamicAck() - * @see setAutoAck() - * - * @param buf Pointer to the data to be sent - * @param len Number of bytes to be sent - * @param multicast Request ACK (0) or NOACK (1) - * - */ - void startWrite( const void* buf, uint8_t len, const bool multicast ); - - /** - * This function is mainly used internally to take advantage of the auto payload - * re-use functionality of the chip, but can be beneficial to users as well. - * - * The function will instruct the radio to re-use the data in the FIFO buffers, - * and instructs the radio to re-send once the timeout limit has been reached. - * Used by writeFast and writeBlocking to initiate retries when a TX failure - * occurs. Retries are automatically initiated except with the standard write(). - * This way, data is not flushed from the buffer until switching between modes. - * - * @note This is to be used AFTER auto-retry fails if wanting to resend - * using the built-in payload reuse features. - * After issuing reUseTX(), it will keep reending the same payload forever or until - * a payload is written to the FIFO, or a flush_tx command is given. - */ - void reUseTX(); - - /** - * Empty the transmit buffer - * - * @return Current value of status register - */ - uint8_t flush_tx(void); - - /** - * Test whether there was a carrier on the line for the - * previous listening period. - * - * Useful to check for interference on the current channel. - * - * @return true if was carrier, false if not - */ - bool testCarrier(void); - - /** - * Test whether a signal (carrier or otherwise) greater than - * or equal to -64dBm is present on the channel. Valid only - * on nRF24L01P (+) hardware. On nRF24L01, use testCarrier(). - * - * Useful to check for interference on the current channel and - * channel hopping strategies. - * - * @return true if signal => -64dBm, false if not - */ - bool testRPD(void) ; - - /** - * Test whether this is a real radio, or a mock shim for - * debugging. Setting either pin to 0xff is the way to - * indicate that this is not a real radio. - * - * @return true if this is a legitimate radio - */ - bool isValid() { return ce_pin != 0xff && csn_pin != 0xff; } - - /** - * 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. - * - * @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); - - /** - * 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); - - - /** - * Close a pipe after it has been previously opened. - * Can be safely called without having previously opened a pipe. - * @param pipe Which pipe # to close, 0-5. - */ - void closeReadingPipe( uint8_t pipe ) ; - - /**@}*/ - - /**@}*/ - /** - * @name Optional Configurators - * - * Methods you can use to get or set the configuration of the chip. - * None are required. Calling begin() sets up a reasonable set of - * defaults. - */ - /**@{*/ - - /** - * 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); - - /** - * 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); - - /** - * Get Dynamic Payload Size - * - * For dynamic payloads, this pulls the size of the payload off - * the chip - * - * @note Corrupt packets are now detected and flushed per the - * manufacturer. - * - * @return Payload length of last-received dynamic payload - */ - uint8_t getDynamicPayloadSize(void); - - /** - * Enable custom payloads on the acknowledge packets - * - * Ack payloads are a handy way to return data back to senders without - * manually changing the radio modes on both units. - * - * @see examples/GettingStarted_CallResponse/GettingStarted_CallResponse.ino - */ - void enableAckPayload(void); - - /** - * Enable dynamically-sized payloads - * - * This way you don't always have to send large packets just to send them - * once in a while. This enables dynamic payloads on ALL pipes. - * - * @see examples/pingpair_pl/pingpair_dyn.pde - */ - void enableDynamicPayloads(void); - - /** - * Determine whether the hardware is an nRF24L01+ or not. - * - * @return true if the hardware is nRF24L01+ (or compatible) and false - * if its not. - */ - bool isPVariant(void) ; - - /** - * Enable or disable auto-acknowlede packets - * - * This is enabled by default, so it's only needed if you want to turn - * it off for some reason. - * - * @param enable Whether to enable (true) or disable (false) auto-acks - */ - void setAutoAck(bool enable); - - /** - * Enable or disable auto-acknowlede packets on a per pipeline basis. - * - * AA is enabled by default, so it's only needed if you want to turn - * it off/on for some reason on a per pipeline basis. - * - * @param pipe Which pipeline to modify - * @param enable Whether to enable (true) or disable (false) auto-acks - */ - void setAutoAck( uint8_t pipe, bool enable ) ; - - /** - * 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 ); - - /** - * Fetches the current PA level. - * - * NRF24L01: -18dBm, -12dBm, -6dBm and 0dBm - * SI24R1: -6dBm, 0dBm, 3dBm, 7dBm - * - * @return Returns values 0 to 3 representing the PA Level. - */ - uint8_t getPALevel( 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); - - /** - * Fetches the transmission data rate - * - * @return Returns the hardware's currently configured datarate. The value - * is one of 250kbs, RF24_1MBPS for 1Mbps, or RF24_2MBPS, as defined in the - * rf24_datarate_e enum. - */ - rf24_datarate_e getDataRate( void ) ; - - /** - * Set the CRC length - * - * @param length RF24_CRC_8 for 8-bit or RF24_CRC_16 for 16-bit - */ - void setCRCLength(rf24_crclength_e length); - - /** - * Get the CRC length - * - * @return RF24_DISABLED if disabled or RF24_CRC_8 for 8-bit or RF24_CRC_16 for 16-bit - */ - rf24_crclength_e getCRCLength(void); - - /** - * Disable CRC validation - * - */ - void disableCRC( void ) ; - - /** - * Enable error detection by un-commenting \#define FAILURE_HANDLING in RF24_config.h - * If a failure has been detected, it usually indicates a hardware issue. By default the library - * will cease operation when a failure is detected. - * This should allow advanced users to detect and resolve intermittent hardware issues. - * - * In most cases, the radio must be re-enabled via radio.begin(); and the appropriate settings - * applied after a failure occurs, if wanting to re-enable the device immediately. - * - * Usage: (Failure handling must be enabled per above) - * @code - * if(radio.failureDetected){ - * radio.begin(); // Attempt to re-configure the radio with defaults - * radio.failureDetected = 0; // Reset the detection value - * radio.openWritingPipe(addresses[1]); // Re-configure pipe addresses - * radio.openReadingPipe(1,addresses[0]); - * report_failure(); // Blink leds, send a message, etc. to indicate failure - * } - * @endcode - */ - //#if defined (FAILURE_HANDLING) - bool failureDetected; - //#endif - - - /**@}*/ - /** - * @name Deprecated - * - * Methods provided for backwards compabibility. - */ - /**@{*/ - - - /** - * Open a pipe for reading - * @note For compatibility with old code only, see new function - * - * @warning Pipes 1-5 should share the first 32 bits. - * Only the least significant byte should be unique, e.g. - * @code - * openReadingPipe(1,0xF0F0F0F0AA); - * openReadingPipe(2,0xF0F0F0F066); - * @endcode - * - * @warning Pipe 0 is also used by the writing pipe. So if you open - * pipe 0 for reading, and then startListening(), it will overwrite the - * writing pipe. Ergo, do an openWritingPipe() again before write(). - * - * @param number Which pipe# to open, 0-5. - * @param address The 40-bit address of the pipe to open. - */ - void openReadingPipe(uint8_t number, uint64_t address); - - /** - * Open a pipe for writing - * @note For compatibility with old code only, see new function - * Addresses are 40-bit hex values, e.g.: - * - * @code - * openWritingPipe(0xF0F0F0F0F0); - * @endcode - * - * @param address The 40-bit address of the pipe to open. - */ - void openWritingPipe(uint64_t address); - -private: - - /** - * @name Low-level internal interface. - * - * Protected methods that address the chip directly. Regular users cannot - * ever call these. They are documented for completeness and for developers who - * may want to extend this class. - */ - /**@{*/ - - /** - * Set chip select pin - * - * Running SPI bus at PI_CLOCK_DIV2 so we don't waste time transferring data - * and best of all, we make use of the radio's FIFO buffers. A lower speed - * means we're less likely to effectively leverage our FIFOs and pay a higher - * AVR runtime cost as toll. - * - * @param mode HIGH to take this unit off the SPI bus, LOW to put it on - */ - void csn(bool mode); - - /** - * Set chip enable - * - * @param level HIGH to actively begin transmission or LOW to put in standby. Please see data sheet - * for a much more detailed description of this pin. - */ - void ce(bool level); - - /** - * Read a chunk of data in from a register - * - * @param reg Which register. Use constants from nRF24L01.h - * @param buf Where to put the data - * @param len How many bytes of data to transfer - * @return Current value of status register - */ - uint8_t read_register(uint8_t reg, uint8_t* buf, uint8_t len); - - /** - * Read single byte from a register - * - * @param reg Which register. Use constants from nRF24L01.h - * @return Current value of register @p reg - */ - uint8_t read_register(uint8_t reg); - - /** - * Write a chunk of data to a register - * - * @param reg Which register. Use constants from nRF24L01.h - * @param buf Where to get the data - * @param len How many bytes of data to transfer - * @return Current value of status register - */ - uint8_t write_register(uint8_t reg, const uint8_t* buf, uint8_t len); - - /** - * Write a single byte to a register - * - * @param reg Which register. Use constants from nRF24L01.h - * @param value The new value to write - * @return Current value of status register - */ - uint8_t write_register(uint8_t reg, uint8_t value); - - /** - * Write the transmit payload - * - * The size of data written is the fixed payload size, see getPayloadSize() - * - * @param buf Where to get the data - * @param len Number of bytes to be sent - * @return Current value of status register - */ - uint8_t write_payload(const void* buf, uint8_t len, const uint8_t writeType); - - /** - * Read the receive payload - * - * The size of data read is the fixed payload size, see getPayloadSize() - * - * @param buf Where to put the data - * @param len Maximum number of bytes to read - * @return Current value of status register - */ - uint8_t read_payload(void* buf, uint8_t len); - - /** - * Empty the receive buffer - * - * @return Current value of status register - */ - uint8_t flush_rx(void); - - /** - * Retrieve the current status of the chip - * - * @return Current value of status register - */ - uint8_t get_status(void); - - /** - * Print the current feature register value to serial - * - * @warning Does nothing if MY_DEBUG is not defined - */ - void print_feature(void); - - /** - * Decode and print the given status to serial - * - * @warning Does nothing if MY_DEBUG_VERBOSE is not defined - * - * @param status Status value to print - */ - void print_status(uint8_t status) const; - - /** - * Decode and print the given 'observe_tx' value to serial - * - * @warning Does nothing if MY_DEBUG_VERBOSE is not defined - * - * @param value The observe_tx value to print - */ - void print_observe_tx(uint8_t value) const; - - /** - * Print the value of an 8-bit register to serial - * - * Optionally it can print some quantity of successive - * registers on the same line. This is useful for printing a group - * of related registers on one line. - * - * @warning Does nothing if MY_DEBUG_VERBOSE is not defined - * - * @param reg Which register. Use constants from nRF24L01.h - * @param qty How many successive registers to print - */ - void print_byte_register(uint8_t reg, uint8_t qty = 1); - - /** - * Print the value of a 40-bit address register to serial - * - * Optionally it can print some quantity of successive - * registers on the same line. This is useful for printing a group - * of related registers on one line. - * - * @warning Does nothing if MY_DEBUG_VERBOSE is not defined - * - * @param reg Which register. Use constants from nRF24L01.h - * @param qty How many successive registers to print - */ - void print_address_register(uint8_t reg, uint8_t qty = 1); - - /** - * 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 toggle_features(void); - - /** - * Built in spi transfer function to simplify repeating code repeating code - */ - - uint8_t spiTrans(uint8_t cmd); - - #if defined (FAILURE_HANDLING) - void errNotify(void); - #endif - - /**@}*/ - -}; - -/** - * @defgroup rf24 Optimized High Speed Driver for nRF24L01(+) 2.4GHz Wireless Transceiver - * @ingroup internals - * - * @section Goals Design Goals - * - * This library fork is designed to be... - * @li More compliant with the manufacturer specified operation of the chip, while allowing advanced users - * to work outside the recommended operation. - * @li Utilize the capabilities of the radio to their full potential via Arduino - * @li More reliable, responsive and feature rich - * @li Easy for beginners to use, with well documented examples and features - * @li Consumed with a public interface that's similiar to other Arduino standard libraries - * - * @section News News - * - * Main changes:
- * - The library has been tweaked to allow full use of the FIFO buffers for maximum transfer speeds - * - Many issues and bugs have been resolved - * - Changes to read() and available () functionality have increased reliability and response - * - Extended timeout periods have been added to aid in noisy or otherwise unreliable environments - * - Delays have been removed where possible to ensure maximum efficiency - * - Full Due support with extended SPI functions - * - ATTiny now supported. - * - Raspberry Pi now supported - * - More! See the links below and class documentation for more info. - * - * If issues are discovered with the documentation, please report them here - * @section Useful Useful References - * - * Please refer to: - * - * @li Documentation Main Page - * @li RF24 Class Documentation - * @li My Blog: RF24 Optimization Overview - * @li Source Code - * @li Download - * @li Chip Datasheet - * @li RF24Network: Easily create a home or long-range RF24 sensor network - * @li My Blog: RF24 Wireless Audio - * @li Original Library - * - * This chip uses the SPI bus, plus two chip control pins. Remember that pin 10 must still remain an output, or - * the SPI hardware will go into 'slave' mode. - * - * @section Board_Support Board Support - * - * Most standard Arduino based boards are supported: - * - ATMega 328 based boards (Uno, Nano, etc) - * - Mega Boards (1280, 2560, etc) - * - Arduino Due: Must use one of the hardware SS/CSN pins as extended SPI methods are used. - * Initial Due support taken from https://github.com/mcrosson/RF24/tree/due - * - ATTiny board support initially added from https://github.com/jscrane/RF24 - * Note: ATTiny support is built into the library. Do not include SPI.h.
- * See the included examples for more info on using ATTiny with RF24
- * See https://github.com/TCWORLD/ATTinyCore/tree/master/PCREL%20Patch%20for%20GCC for ATTiny patch - * - Raspberry Pi Support: See the readme at https://github.com/TMRh20/RF24/tree/master/RPi/RF24 - * - * @section More More Information - * - * @section Info and Projects - * - * @li Project blog: - * @li TMRh20.blogspot.com - * @li RF24 Wireless Audio Library - * @li Optimized RF24 Network Layer - * @li ManiacBug on GitHub (Original Library Author) - */ #endif // __RF24_H__ diff --git a/libraries/MySensors/drivers/RF24/nRF24L01.h b/libraries/MySensors/drivers/RF24/nRF24L01.h deleted file mode 100644 index 181dae1..0000000 --- a/libraries/MySensors/drivers/RF24/nRF24L01.h +++ /dev/null @@ -1,127 +0,0 @@ -/* - Copyright (c) 2007 Stefan Engelke - Portions Copyright (C) 2011 Greg Copeland - - Permission is hereby granted, free of charge, to any person - obtaining a copy of this software and associated documentation - files (the "Software"), to deal in the Software without - restriction, including without limitation the rights to use, copy, - modify, merge, publish, distribute, sublicense, and/or sell copies - of the Software, and to permit persons to whom the Software is - furnished to do so, subject to the following conditions: - - The above copyright notice and this permission notice shall be - included in all copies or substantial portions of the Software. - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND - NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT - HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, - WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER - DEALINGS IN THE SOFTWARE. -*/ - -/* Memory Map */ -#define NRF_CONFIG 0x00 -#define EN_AA 0x01 -#define EN_RXADDR 0x02 -#define SETUP_AW 0x03 -#define SETUP_RETR 0x04 -#define RF_CH 0x05 -#define RF_SETUP 0x06 -#define RF24_STATUS 0x07 -#define OBSERVE_TX 0x08 -#define CD 0x09 -#define RX_ADDR_P0 0x0A -#define RX_ADDR_P1 0x0B -#define RX_ADDR_P2 0x0C -#define RX_ADDR_P3 0x0D -#define RX_ADDR_P4 0x0E -#define RX_ADDR_P5 0x0F -#define TX_ADDR 0x10 -#define RX_PW_P0 0x11 -#define RX_PW_P1 0x12 -#define RX_PW_P2 0x13 -#define RX_PW_P3 0x14 -#define RX_PW_P4 0x15 -#define RX_PW_P5 0x16 -#define FIFO_STATUS 0x17 -#define DYNPD 0x1C -#define FEATURE 0x1D - -/* Bit Mnemonics */ -#define MASK_RX_DR 6 -#define MASK_TX_DS 5 -#define MASK_MAX_RT 4 -#define EN_CRC 3 -#define CRCO 2 -#define PWR_UP 1 -#define PRIM_RX 0 -#define ENAA_P5 5 -#define ENAA_P4 4 -#define ENAA_P3 3 -#define ENAA_P2 2 -#define ENAA_P1 1 -#define ENAA_P0 0 -#define ERX_P5 5 -#define ERX_P4 4 -#define ERX_P3 3 -#define ERX_P2 2 -#define ERX_P1 1 -#define ERX_P0 0 -#define AW 0 -#define ARD 4 -#define ARC 0 -#define PLL_LOCK 4 -#define RF_DR 3 -#define RF_PWR 6 -#define RX_DR 6 -#define TX_DS 5 -#define MAX_RT 4 -#define RX_P_NO 1 -#define TX_FULL 0 -#define PLOS_CNT 4 -#define ARC_CNT 0 -#define TX_REUSE 6 -#define FIFO_FULL 5 -#define TX_EMPTY 4 -#define RX_FULL 1 -#define RX_EMPTY 0 -#define DPL_P5 5 -#define DPL_P4 4 -#define DPL_P3 3 -#define DPL_P2 2 -#define DPL_P1 1 -#define DPL_P0 0 -#define EN_DPL 2 -#define EN_ACK_PAY 1 -#define EN_DYN_ACK 0 - -/* Instruction Mnemonics */ -#define R_REGISTER 0x00 -#define W_REGISTER 0x20 -#define REGISTER_MASK 0x1F -#define ACTIVATE 0x50 -#define R_RX_PL_WID 0x60 -#define R_RX_PAYLOAD 0x61 -#define W_TX_PAYLOAD 0xA0 -#define W_ACK_PAYLOAD 0xA8 -#define FLUSH_TX 0xE1 -#define FLUSH_RX 0xE2 -#define REUSE_TX_PL 0xE3 -#define NOP 0xFF - -/* Non-P omissions */ -#define LNA_HCURR 0 - -/* P model memory Map */ -#define RPD 0x09 -#define W_TX_PAYLOAD_NO_ACK 0xB0 - -/* P model bit Mnemonics */ -#define RF_DR_LOW 5 -#define RF_DR_HIGH 3 -#define RF_PWR_LOW 1 -#define RF_PWR_HIGH 2 diff --git a/libraries/MySensors/keywords.txt b/libraries/MySensors/keywords.txt index 6685179..5cde348 100644 --- a/libraries/MySensors/keywords.txt +++ b/libraries/MySensors/keywords.txt @@ -34,6 +34,7 @@ AUTO LITERAL1 MY_DEBUG LITERAL1 MY_CORE_ONLY LITERAL1 MY_DEBUG_VERBOSE LITERAL1 +MY_DEBUG_VERBOSE_RF24 LITERAL1 MY_DEBUG_VERBOSE_SIGNING LITERAL1 MY_REPEATER_FEATURE LITERAL1 MY_RADIO_NRF24 LITERAL1