From a0af38a0d8cd2cb62da89cc5e387168bb943c011 Mon Sep 17 00:00:00 2001 From: tekka Date: Sun, 18 Feb 2018 21:06:28 +0100 Subject: [PATCH] RFM69: Updates and optimizations (#1049) * RFM69: Updates and optimizations * RFM69: Updates and optimizations --- MyConfig.h | 57 +- drivers/RFM69/new/RFM69_new.cpp | 768 ++++++----------------- drivers/RFM69/new/RFM69_new.h | 372 ++++++----- drivers/RFM69/new/RFM69registers_new.h | 72 ++- hal/transport/RFM69/MyTransportRFM69.cpp | 9 +- 5 files changed, 459 insertions(+), 819 deletions(-) diff --git a/MyConfig.h b/MyConfig.h index 5b78c01..6c72ba9 100644 --- a/MyConfig.h +++ b/MyConfig.h @@ -572,7 +572,7 @@ /** * @def MY_RADIO_RFM69 - * @brief Define this to use RFM69 based radios for sensor network communication. + * @brief Define this to use %RFM69 based radios for sensor network communication. */ //#define MY_RADIO_RFM69 @@ -641,7 +641,7 @@ /** * @def MY_RFM69_ATC_TARGET_RSSI_DBM - * @brief Target RSSI level (in dBm) for RFM69 ATC mode. + * @brief Target RSSI level (in dBm) for %RFM69 ATC mode. */ #ifndef MY_RFM69_ATC_TARGET_RSSI_DBM #define MY_RFM69_ATC_TARGET_RSSI_DBM (-80) @@ -649,7 +649,7 @@ /** * @def MY_RFM69_ATC_MODE_DISABLED - * @brief Define to disable ATC mode of RFM69 driver. + * @brief Define to disable ATC mode of %RFM69 driver. */ //#define MY_RFM69_ATC_MODE_DISABLED @@ -668,7 +668,7 @@ /** * @def MY_RFM69_NETWORKID - * @brief RFM69 Network ID. Use the same for all nodes that will talk to each other. + * @brief %RFM69 Network ID. Use the same for all nodes that will talk to each other. */ #ifndef MY_RFM69_NETWORKID #define MY_RFM69_NETWORKID (100) @@ -682,6 +682,7 @@ #ifdef MY_RF69_RESET // legacy, older board files +// not enabled now: #warning MY_RF69_RESET is depreciated, please use MY_RFM69_RST_PIN instead. #define MY_RFM69_RST_PIN MY_RF69_RESET #endif @@ -693,11 +694,12 @@ /** * @def MY_RFM69_IRQ_PIN - * @brief Define this to use the %RFM69 IRQ pin (optional). + * @brief Define this to override the default %RFM69 IRQ pin assignment. */ #ifndef MY_RFM69_IRQ_PIN #ifdef MY_RF69_IRQ_PIN // legacy, older board files +// not enabled now: #warning MY_RF69_IRQ_PIN is depreciated, please use MY_RFM69_IRQ_PIN instead. #define MY_RFM69_IRQ_PIN MY_RF69_IRQ_PIN #else #define MY_RFM69_IRQ_PIN DEFAULT_RFM69_IRQ_PIN @@ -711,19 +713,21 @@ #ifndef MY_RFM69_IRQ_NUM #ifdef MY_RF69_IRQ_NUM // legacy, older board files +// not enabled now: #warning MY_RF69_IRQ_NUM is depreciated, please use MY_RFM69_IRQ_NUM instead. #define MY_RFM69_IRQ_NUM MY_RF69_IRQ_NUM #else -#define MY_RFM69_IRQ_NUM DEFAULT_RFM69_IRQ_NUM +#define MY_RFM69_IRQ_NUM digitalPinToInterrupt(MY_RFM69_IRQ_PIN) #endif #endif /** * @def MY_RFM69_CS_PIN - * @brief RFM69 SPI chip select pin. + * @brief %RFM69 SPI chip select pin. */ #ifndef MY_RFM69_CS_PIN #ifdef MY_RF69_SPI_CS // legacy, older board files +// not enabled now: #warning MY_RF69_SPI_CS is depreciated, please use MY_RFM69_CS_PIN instead. #define MY_RFM69_CS_PIN MY_RF69_SPI_CS #else #define MY_RFM69_CS_PIN DEFAULT_RFM69_CS_PIN @@ -764,29 +768,29 @@ #define MY_RFM69_DEFAULT_LISTEN_IDLE_US (1*1000000ul) #endif -#if !defined(MY_RFM69_BITRATE_MSB) && !defined(MY_RFM69_BITRATE_LSB) /** - * @def MY_RFM69_BITRATE_MSB - * @brief %RFM69 bit rate (most significant bits) + * @def MY_RFM69_MODEM_CONFIGURATION + * @brief %RFM69 modem configuration, default is %RFM69_FSK_BR55_5_FD50 * - * Bitrate between the transmitter and the receiver must be better than 6.5. - * Refer to RFM69registers_old.h (L.153) or RFM69registers_new.h (L.154) for settings or - * http://www.semtech.com/apps/filedown/down.php?file=sx1231.pdf - * @note RFM69_FOSC(Hz)/MSB_LSBVALUE = Bitrate in kbits + * | Configuration | Modulation (xxx) | Bit rate | FD | RXBW | Additional settings + * |-------------------------|------------------|----------|--------|----------|--------------------------- + * | RFM69_xxx_BR2_FD5 | FSK/GFSK/OOK | 2000 | 5000 | 111_24_4 | Whitening + * | RFM69_xxx_BR2_4_FD4_8 | FSK/GFSK/OOK | 2400 | 4800 | 111_24_4 | Whitening + * | RFM69_xxx_BR4_8_FD9_6 | FSK/GFSK/OOK | 4800 | 9600 | 111_24_4 | Whitening + * | RFM69_xxx_BR9_6_FD19_2 | FSK/GFSK/OOK | 9600 | 19200 | 111_24_4 | Whitening + * | RFM69_xxx_BR19_2_FD38_4 | FSK/GFSK/OOK | 19200 | 38400 | 111_24_3 | Whitening + * | RFM69_xxx_BR38_4_FD76_8 | FSK/GFSK/OOK | 38400 | 76800 | 111_24_2 | Whitening + * | RFM69_xxx_BR55_5_FD50 | FSK/GFSK/OOK | 55555 | 50000 | 111_16_2 | Whitening + * | RFM69_xxx_BR57_6_FD120 | FSK/GFSK/OOK | 57600 | 120000 | 111_16_1 | Whitening + * | RFM69_xxx_BR125_FD125 | FSK/GFSK/OOK | 125000 | 125000 | 010_16_2 | Whitening + * | RFM69_xxx_BR250_FD250 | FSK/GFSK/OOK | 250000 | 250000 | 111_16_0 | Whitening + * + * https://www.semtech.com/uploads/documents/sx1231.pdf * */ -#define MY_RFM69_BITRATE_MSB (RFM69_BITRATEMSB_55555) -/** - * @def MY_RFM69_BITRATE_LSB - * @brief %RFM69 bit rate (least significant bits) - * - * Bitrate between the transmitter and the receiver must be better than 6.5. - * Refer to RFM69registers_old.h (L.153) or RFM69registers_new.h (L.154) for settings or - * http://www.semtech.com/apps/filedown/down.php?file=sx1231.pdf - * @note RFM69_FOSC(Hz)/MSB_LSBVALUE = Bitrate in kbits - */ -#define MY_RFM69_BITRATE_LSB (RFM69_BITRATELSB_55555) -#endif +//#define MY_RFM69_MODEM_CONFIGURATION (RFM69_FSK_BR55_5_FD50) + + /** @}*/ // End of RFM69SettingGrpPub group /** @@ -2073,6 +2077,7 @@ #define MY_IS_RFM69HW #define MY_RFM69_NEW_DRIVER #define MY_RFM69_POWER_PIN +#define MY_RFM69_MODEM_CONFIGURATION #define MY_RFM69_ENABLE_ENCRYPTION #define MY_RFM69_ATC_MODE_DISABLED #define MY_RFM69_MAX_POWER_LEVEL_DBM diff --git a/drivers/RFM69/new/RFM69_new.cpp b/drivers/RFM69/new/RFM69_new.cpp index 7cfb8b8..111d83d 100644 --- a/drivers/RFM69/new/RFM69_new.cpp +++ b/drivers/RFM69/new/RFM69_new.cpp @@ -6,7 +6,7 @@ * network topology allowing messages to be routed to nodes. * * Created by Henrik Ekblad - * Copyright (C) 2013-2017 Sensnology AB + * Copyright (C) 2013-2018 Sensnology AB * Full contributor list: https://github.com/mysensors/Arduino/graphs/contributors * * Documentation: http://www.mysensors.org @@ -16,20 +16,20 @@ * modify it under the terms of the GNU General Public License * version 2 as published by the Free Software Foundation. * - * RFM69 driver refactored for Mysensors + * RFM69 driver refactored for MySensors * * Based on : * - LowPowerLab RFM69 Lib Copyright Felix Rusu (2014), felix@lowpowerlab.com * - Automatic Transmit Power Control class derived from RFM69 library. * Discussion and details in this forum post: https://lowpowerlab.com/forum/index.php/topic,688.0.html * Copyright Thomas Studwell (2014,2015) - * - Mysensors generic radio driver implementation Copyright (C) 2017 Olivier Mauti + * - MySensors generic radio driver implementation Copyright (C) 2017, 2018 Olivier Mauti * * Changes by : @tekka, @scalz, @marceloagno * * Definitions for Semtech SX1231/H radios: - * http://www.semtech.com/images/datasheet/sx1231.pdf - * http://www.semtech.com/images/datasheet/sx1231h.pdf + * https://www.semtech.com/uploads/documents/sx1231.pdf + * https://www.semtech.com/uploads/documents/sx1231h.pdf */ #include "RFM69_new.h" @@ -41,18 +41,10 @@ #define RFM69_DEBUG(x,...) //!< DEBUG null #endif -volatile rfm69_internal_t RFM69; //!< internal variables +rfm69_internal_t RFM69; //!< internal variables +volatile uint8_t rfm69_irq; //!< rfm69 irq flag -#if defined (SREG) && !defined(SPI_HAS_TRANSACTION) -uint8_t _SREG; // Used to save and restore the SREG values in SPI transactions -#endif - -#if defined (SPCR) && defined (SPSR) && !defined(SPI_HAS_TRANSACTION) -uint8_t _SPCR; //!< _SPCR -uint8_t _SPSR; //!< _SPSR -#endif - -#ifdef LINUX_SPI_BCM +#if defined(LINUX_SPI_BCM) // SPI RX and TX buffers (max packet len + 1 byte for the command) uint8_t spi_rxbuff[RFM69_MAX_PACKET_LEN + 1]; uint8_t spi_txbuff[RFM69_MAX_PACKET_LEN + 1]; @@ -111,14 +103,14 @@ LOCAL uint8_t RFM69_spiMultiByteTransfer(const uint8_t cmd, uint8_t* buf, uint8_ const bool aReadMode) { uint8_t status; - uint8_t* current = buf; + uint8_t *current = buf; RFM69_prepareSPITransaction(); RFM69_csn(LOW); -#ifdef LINUX_SPI_BCM - uint8_t * prx = spi_rxbuff; - uint8_t * ptx = spi_txbuff; +#if defined(LINUX_SPI_BCM) + uint8_t *prx = spi_rxbuff; + uint8_t *ptx = spi_txbuff; uint8_t size = len + 1; // Add register value to transmit buffer *ptx++ = cmd; @@ -156,33 +148,52 @@ LOCAL uint8_t RFM69_spiMultiByteTransfer(const uint8_t cmd, uint8_t* buf, uint8_ } } #endif - RFM69_csn(HIGH); RFM69_concludeSPITransaction(); - return status; } // low level register access -LOCAL uint8_t RFM69_RAW_readByteRegister(const uint8_t address) +LOCAL inline uint8_t RFM69_RAW_readByteRegister(const uint8_t address) { - const uint8_t value = RFM69_spiMultiByteTransfer(address, NULL, 1, true); - //RFM69_DEBUG(PSTR("RFM69:read register, reg=0x%02" PRIx8 ", value=%" PRIu8 "\n"), address, value); - return value; + return RFM69_spiMultiByteTransfer(address, NULL, 1, true); } -// low level register access -LOCAL uint8_t RFM69_RAW_writeByteRegister(const uint8_t address, uint8_t value) +LOCAL inline uint8_t RFM69_RAW_writeByteRegister(const uint8_t address, uint8_t value) { - //RFM69_DEBUG(PSTR("RFM69:write register, reg=0x%02" PRIx8 ", value=%" PRIu8 "\n"), address & 0x7F, value); return RFM69_spiMultiByteTransfer(address, &value, 1, false); } -// macros, saves space -#define RFM69_readReg(__reg) RFM69_RAW_readByteRegister(__reg & RFM69_READ_REGISTER) -#define RFM69_writeReg(__reg, __value) RFM69_RAW_writeByteRegister((__reg | RFM69_WRITE_REGISTER), __value ) -#define RFM69_burstReadReg(__reg, __buf, __len) RFM69_spiMultiByteTransfer( __reg & RFM69_READ_REGISTER, (uint8_t*)__buf, __len, true ) -#define RFM69_burstWriteReg(__reg, __buf, __len) RFM69_spiMultiByteTransfer( __reg | RFM69_WRITE_REGISTER, (uint8_t*)__buf, __len, false ) +// helper functions +LOCAL inline uint8_t RFM69_readReg(const uint8_t reg) +{ + return RFM69_RAW_readByteRegister(reg & RFM69_READ_REGISTER); +} + +LOCAL inline uint8_t RFM69_writeReg(const uint8_t reg, const uint8_t value) +{ + return RFM69_RAW_writeByteRegister(reg | RFM69_WRITE_REGISTER, value); +} + +LOCAL inline uint8_t RFM69_burstReadReg(const uint8_t reg, void *buf, uint8_t len) +{ + return RFM69_spiMultiByteTransfer(reg & RFM69_READ_REGISTER, (uint8_t *)buf, len, true); +} + +LOCAL inline uint8_t RFM69_burstWriteReg(const uint8_t reg, const void *buf, uint8_t len) +{ + return RFM69_spiMultiByteTransfer(reg | RFM69_WRITE_REGISTER, (uint8_t *)buf, len, false); +} + +LOCAL inline rfm69_RSSI_t RFM69_RSSItoInternal(const int16_t externalRSSI) +{ + return (rfm69_RSSI_t)-(externalRSSI * 2); +} + +LOCAL inline int16_t RFM69_internalToRSSI(const rfm69_RSSI_t internalRSSI) +{ + return (int16_t)-(internalRSSI / 2); +} LOCAL bool RFM69_initialise(const uint32_t frequencyHz) { @@ -219,64 +230,60 @@ LOCAL bool RFM69_initialise(const uint32_t frequencyHz) RFM69.radioMode = RFM69_RADIO_MODE_SLEEP; RFM69.ATCenabled = false; RFM69.listenModeEnabled = false; - RFM69.ATCtargetRSSI = RFM69_RSSItoInternal(RFM69_TARGET_RSSI_DBM); + RFM69.ATCtargetRSSI = RFM69_RSSItoInternal(MY_RFM69_ATC_TARGET_RSSI_DBM); // SPI init hwDigitalWrite(MY_RFM69_CS_PIN, HIGH); hwPinMode(MY_RFM69_CS_PIN, OUTPUT); RFM69_SPI.begin(); - + (void)RFM69_setRadioMode(RFM69_RADIO_MODE_STDBY); + // set configuration, encryption is disabled RFM69_setConfiguration(); RFM69_setFrequency(frequencyHz); - (void)RFM69_setRadioMode(RFM69_RADIO_MODE_STDBY); - - // Encryption is persistent between resets and can trip you up during debugging. - // Disable it during initialization so we always start from a known state. - RFM69_encrypt(0); (void)RFM69_setTxPowerLevel(MY_RFM69_TX_POWER_DBM); - // IRQ - hwPinMode(MY_RFM69_IRQ_PIN, INPUT); -#if defined (SPI_HAS_TRANSACTION) && !defined (ESP8266) && !defined (MY_SOFTSPI) - RFM69_SPI.usingInterrupt(digitalPinToInterrupt(MY_RFM69_IRQ_PIN)); -#endif -#ifdef MY_DEBUG_VERBOSE_RFM69_REGISTERS +#if defined(MY_DEBUG_VERBOSE_RFM69_REGISTERS) RFM69_readAllRegs(); +#else + (void)RFM69_readAllRegs; #endif + //RFM69_DEBUG(PSTR("RFM69:INIT:HWV=%" PRIu8 "\n"),RFM69_readReg(RFM69_REG_VERSION)); if (!RFM69_sanityCheck()) { - RFM69_DEBUG( - PSTR("!RFM69:INIT:SANCHK FAIL\n")); // sanity check failed, check wiring or replace module + // sanity check failed, check wiring or replace module + RFM69_DEBUG(PSTR("!RFM69:INIT:SANCHK FAIL\n")); return false; } - attachInterrupt(digitalPinToInterrupt(MY_RFM69_IRQ_PIN), RFM69_interruptHandler, RISING); + // clear FIFO and flags + RFM69_clearFIFO(); + // IRQ + rfm69_irq = false; + hwPinMode(MY_RFM69_IRQ_PIN, INPUT); + attachInterrupt(MY_RFM69_IRQ_NUM, RFM69_interruptHandler, RISING); return true; } +LOCAL void RFM69_clearFIFO(void) +{ + (void)RFM69_writeReg(RFM69_REG_IRQFLAGS2, 0x10u); +} // IRQ handler: PayloadReady (RX) & PacketSent (TX) mapped to DI0 LOCAL void RFM69_interruptHandler(void) { -#if defined(MY_RFM69_ENABLE_LISTENMODE) - if (RFM69.listenModeEnabled) { - RFM69_listenModeReset(); - //noInterrupts(); - union { // union to simplify addressing of long and short parts of time offset - uint32_t l; - uint8_t b[4]; - } burstRemaining; + // set flag + rfm69_irq = true; +} - burstRemaining.l = 0; - } -#endif +LOCAL void RFM69_interruptHandling(void) +{ const uint8_t regIrqFlags2 = RFM69_readReg(RFM69_REG_IRQFLAGS2); - if ( RFM69.radioMode == RFM69_RADIO_MODE_RX && (regIrqFlags2 & RFM69_IRQFLAGS2_PAYLOADREADY) ) { - RFM69.currentPacket.RSSI = RFM69_readRSSI(); + if (RFM69.radioMode == RFM69_RADIO_MODE_RX && (regIrqFlags2 & RFM69_IRQFLAGS2_PAYLOADREADY)) { (void)RFM69_setRadioMode(RFM69_RADIO_MODE_STDBY); // use the fifo level irq as indicator if header bytes received if (regIrqFlags2 & RFM69_IRQFLAGS2_FIFOLEVEL) { RFM69_prepareSPITransaction(); RFM69_csn(LOW); -#ifdef LINUX_SPI_BCM +#if defined(LINUX_SPI_BCM) char data[RFM69_MAX_PACKET_LEN + 1]; // max packet len + 1 byte for the command data[0] = RFM69_REG_FIFO & RFM69_READ_REGISTER; RFM69_SPI.transfern(data, 3); @@ -292,8 +299,8 @@ LOCAL void RFM69_interruptHandler(void) //SPI.transfern(data, RFM69.currentPacket.header.packetLen - 1); //TODO: Wrong packetLen? RFM69_SPI.transfern(data, RFM69.currentPacket.header.packetLen); - //(void)memcpy((void*)&RFM69.currentPacket.data[2], (void*)&data[1], RFM69.currentPacket.header.packetLen - 2); //TODO: Wrong packetLen? - (void)memcpy((void*)&RFM69.currentPacket.data[2], (void*)&data[1], + //(void)memcpy((void *)&RFM69.currentPacket.data[2], (void *)&data[1], RFM69.currentPacket.header.packetLen - 2); //TODO: Wrong packetLen? + (void)memcpy((void *)&RFM69.currentPacket.data[2], (void *)&data[1], RFM69.currentPacket.header.packetLen - 1); if (RFM69.currentPacket.header.version >= RFM69_MIN_PACKET_HEADER_VERSION) { @@ -303,23 +310,22 @@ LOCAL void RFM69_interruptHandler(void) RFM69.dataReceived = !RFM69.ackReceived; } #else - RFM69_SPI.transfer(RFM69_REG_FIFO & RFM69_READ_REGISTER); + (void)RFM69_SPI.transfer(RFM69_REG_FIFO & RFM69_READ_REGISTER); // set reading pointer - uint8_t* current = (uint8_t*)&RFM69.currentPacket; + uint8_t *current = (uint8_t *)&RFM69.currentPacket; bool headerRead = false; // first read header uint8_t readingLength = RFM69_HEADER_LEN; while (readingLength--) { - *current++ = RFM69_SPI.transfer((uint8_t)0x00); + *current++ = RFM69_SPI.transfer((uint8_t)RFM69_NOP); if (!readingLength && !headerRead) { // header read headerRead = true; if (RFM69.currentPacket.header.version >= RFM69_MIN_PACKET_HEADER_VERSION) { // read payload - readingLength = RFM69.currentPacket.header.packetLen - (RFM69_HEADER_LEN - 1); - if (readingLength > RFM69_MAX_PACKET_LEN) { - readingLength = RFM69_MAX_PACKET_LEN; - } + readingLength = min(RFM69.currentPacket.header.packetLen - (RFM69_HEADER_LEN - 1), + RFM69_MAX_PACKET_LEN); + // save payload length RFM69.currentPacket.payloadLen = readingLength; RFM69.ackReceived = RFM69_getACKReceived(RFM69.currentPacket.header.controlFlags); RFM69.dataReceived = !RFM69.ackReceived; @@ -330,94 +336,106 @@ LOCAL void RFM69_interruptHandler(void) RFM69_csn(HIGH); RFM69_concludeSPITransaction(); } - // radio remains in stdby until paket read - } else if (RFM69.radioMode == RFM69_RADIO_MODE_TX && (regIrqFlags2 & RFM69_IRQFLAGS2_PACKETSENT) ) { - RFM69.dataSent = true; + RFM69.currentPacket.RSSI = RFM69_readRSSI(); + // radio remains in stdby until packet read + } else { // back to RX (void)RFM69_setRadioMode(RFM69_RADIO_MODE_RX); } } +LOCAL void RFM69_handler(void) +{ + if (rfm69_irq) { + // radio is in STDBY + // clear flag, 8bit - no need for critical section + rfm69_irq = false; + RFM69_interruptHandling(); + } +} + LOCAL bool RFM69_available(void) { if (RFM69.dataReceived) { - // data received - we are still in STDBY from IRQ handler - //(void)RFM69_setRadioMode(RFM69_RADIO_MODE_STDBY); + // data received - we are still in STDBY return true; } else if (RFM69.radioMode == RFM69_RADIO_MODE_TX) { + // still in TX return false; - } else if (RFM69.radioMode != RFM69_RADIO_MODE_RX) { - // we are not in RX, and no data received - RFM69_setRadioMode(RFM69_RADIO_MODE_RX); + } else if (RFM69.radioMode != RFM69_RADIO_MODE_RX) { // adding this check speeds up loop() :) + // no data received and not in RX + (void)RFM69_setRadioMode(RFM69_RADIO_MODE_RX); } return false; } - - -LOCAL uint8_t RFM69_recv(uint8_t* buf, const uint8_t maxBufSize) +LOCAL uint8_t RFM69_receive(uint8_t *buf, const uint8_t maxBufSize) { - // atomic - noInterrupts(); - - const uint8_t payloadLen = RFM69.currentPacket.payloadLen < maxBufSize? - RFM69.currentPacket.payloadLen : maxBufSize; + const uint8_t payloadLen = min(RFM69.currentPacket.payloadLen, maxBufSize); const uint8_t sender = RFM69.currentPacket.header.sender; const rfm69_sequenceNumber_t sequenceNumber = RFM69.currentPacket.header.sequenceNumber; const uint8_t controlFlags = RFM69.currentPacket.header.controlFlags; - const rfm69_RSSI_t RSSI = RFM69.currentPacket.RSSI; // of incoming packet + const rfm69_RSSI_t RSSI = RFM69.currentPacket.RSSI; if (buf != NULL) { - (void)memcpy((void*)buf, (void*)RFM69.currentPacket.payload, payloadLen); - // packet read - RFM69.dataReceived = false; + (void)memcpy((void *)buf, (void *)&RFM69.currentPacket.payload, payloadLen); } - - interrupts(); // explicitly re-enable interrupts - + // clear data flag + RFM69.dataReceived = false; if (RFM69_getACKRequested(controlFlags) && !RFM69_getACKReceived(controlFlags)) { - RFM69_sendACK(sender, sequenceNumber,RSSI); +#if defined(MY_GATEWAY_FEATURE) && (F_CPU>16000000) + // delay for fast GW and slow nodes + delay(50); +#endif + RFM69_sendACK(sender, sequenceNumber, RSSI); } - return payloadLen; } -LOCAL bool RFM69_sendFrame(rfm69_packet_t &packet, const bool increaseSequenceCounter) +LOCAL bool RFM69_channelFree(void) { - /* - if(!RFM69_waitCAD()) { - // channel not free - return false; + // returns true if channel activity under RFM69_CSMA_LIMIT_DBM + const rfm69_RSSI_t RSSI = RFM69_readRSSI(false); + RFM69_DEBUG(PSTR("RFM69:CSMA:RSSI=%" PRIi16 "\n"), RFM69_internalToRSSI(RSSI)); + return (RSSI > RFM69_RSSItoInternal(MY_RFM69_CSMA_LIMIT_DBM)); +} + +LOCAL bool RFM69_sendFrame(rfm69_packet_t *packet, const bool increaseSequenceCounter) +{ + // ensure we are in RX for correct RSSI sampling, dirty hack to enforce rx restart :) + RFM69.radioMode = RFM69_RADIO_MODE_STDBY; + (void)RFM69_setRadioMode(RFM69_RADIO_MODE_RX); + delay(1); // timing for correct RSSI sampling + const uint32_t CSMA_START_MS = hwMillis(); + while (!RFM69_channelFree() && + ((hwMillis() - CSMA_START_MS) < MY_RFM69_CSMA_TIMEOUT_MS)) { + doYield(); } - */ - - // set radio to standby to load fifo (void)RFM69_setRadioMode(RFM69_RADIO_MODE_STDBY); if (increaseSequenceCounter) { // increase sequence counter, overflow is ok RFM69.txSequenceNumber++; } - packet.header.sequenceNumber = RFM69.txSequenceNumber; - - RFM69_writeReg(RFM69_REG_PACKETCONFIG2, - (RFM69_readReg(RFM69_REG_PACKETCONFIG2) & 0xFB) | RFM69_PACKET2_RXRESTART); // avoid RX deadlocks + // clear FIFO and flags + RFM69_clearFIFO(); + // assign sequence number + packet->header.sequenceNumber = RFM69.txSequenceNumber; // write packet - const uint8_t finalLen = packet.payloadLen + RFM69_HEADER_LEN; // including length byte - RFM69_burstWriteReg(RFM69_REG_FIFO, packet.data, finalLen); + const uint8_t finalLen = packet->payloadLen + RFM69_HEADER_LEN; // including length byte + (void)RFM69_burstWriteReg(RFM69_REG_FIFO, packet->data, finalLen); // send message - (void)RFM69_setRadioMode(RFM69_RADIO_MODE_TX); - const uint32_t txStart = hwMillis(); - // irq handler set radiomode to rx once packet sent - while (!RFM69.dataSent && hwMillis() - txStart < RFM69_TX_LIMIT_MS) { // wait until packet sent + (void)RFM69_setRadioMode(RFM69_RADIO_MODE_TX); // irq upon txsent + const uint32_t txStartMS = hwMillis(); + while (!rfm69_irq && (hwMillis() - txStartMS < MY_RFM69_TX_TIMEOUT_MS)) { doYield(); - } - return RFM69.dataSent; + }; + return rfm69_irq; } -LOCAL bool RFM69_send(const uint8_t recipient, uint8_t* data, const uint8_t len, +LOCAL bool RFM69_send(const uint8_t recipient, uint8_t *data, const uint8_t len, const rfm69_controlFlags_t flags, const bool increaseSequenceCounter) { // assemble packet @@ -425,20 +443,20 @@ LOCAL bool RFM69_send(const uint8_t recipient, uint8_t* data, const uint8_t len, packet.header.version = RFM69_PACKET_HEADER_VERSION; packet.header.sender = RFM69.address; packet.header.recipient = recipient; - packet.header.controlFlags = 0x00; // reset + packet.header.controlFlags = 0u; // reset packet.payloadLen = min(len, (uint8_t)RFM69_MAX_PAYLOAD_LEN); packet.header.controlFlags = flags; - (void)memcpy(&packet.payload, data, packet.payloadLen); // copy payload + (void)memcpy((void *)&packet.payload, (void *)data, packet.payloadLen); // copy payload packet.header.packetLen = packet.payloadLen + (RFM69_HEADER_LEN - 1); // -1 length byte - return RFM69_sendFrame(packet, increaseSequenceCounter); + return RFM69_sendFrame(&packet, increaseSequenceCounter); } LOCAL void RFM69_setFrequency(const uint32_t frequencyHz) { const uint32_t freqHz = (uint32_t)(frequencyHz / RFM69_FSTEP); - RFM69_writeReg(RFM69_REG_FRFMSB, freqHz >> 16); - RFM69_writeReg(RFM69_REG_FRFMID, freqHz >> 8); - RFM69_writeReg(RFM69_REG_FRFLSB, freqHz); + RFM69_writeReg(RFM69_REG_FRFMSB, (freqHz >> 16) & 0xFF); + RFM69_writeReg(RFM69_REG_FRFMID, (freqHz >> 8) & 0xFF); + RFM69_writeReg(RFM69_REG_FRFLSB, freqHz & 0xFF); } LOCAL void RFM69_setHighPowerRegs(const bool onOff) @@ -521,62 +539,12 @@ LOCAL bool RFM69_setRadioMode(const rfm69_radio_mode_t newRadioMode) RFM69_writeReg(RFM69_REG_PACKETCONFIG2, (RFM69_readReg(RFM69_REG_PACKETCONFIG2) & 0xFB) | RFM69_PACKET2_RXRESTART); // avoid RX deadlocks } else if (newRadioMode == RFM69_RADIO_MODE_TX) { - RFM69.dataSent = false; regMode = RFM69_OPMODE_SEQUENCER_ON | RFM69_OPMODE_LISTEN_OFF | RFM69_OPMODE_TRANSMITTER; RFM69_writeReg(RFM69_REG_DIOMAPPING1, RFM69_DIOMAPPING1_DIO0_00); // Interrupt on PacketSent, DIO0 RFM69_setHighPowerRegs(RFM69.powerLevel >= (rfm69_powerlevel_t)RFM69_HIGH_POWER_DBM); } else if (newRadioMode == RFM69_RADIO_MODE_SYNTH) { regMode = RFM69_OPMODE_SEQUENCER_ON | RFM69_OPMODE_LISTEN_OFF | RFM69_OPMODE_SYNTHESIZER; - } -#if defined(MY_RFM69_ENABLE_LISTENMODE) - else if (newRadioMode == RFM69_RADIO_MODE_LISTEN) { - // Start LISTENMODE - regMode = RFM69_OPMODE_SEQUENCER_ON | RFM69_OPMODE_LISTEN_ON; - - RFM69.listenModeEnabled = true; - - RFM69_DEBUG(PSTR("RFM69:LSM:Start..\n")); - while (RFM69_readReg(RFM69_REG_IRQFLAGS2) & RFM69_IRQFLAGS2_PACKETSENT == - 0x00); // wait for ModeReady - - RFM69_listenModeReset(); - detachInterrupt(digitalPinToInterrupt(MY_RFM69_IRQ_PIN)); - attachInterrupt(digitalPinToInterrupt(MY_RFM69_IRQ_PIN), RFM69_interruptHandler, RISING); - - RFM69_writeReg(RFM69_REG_OPMODE, - RFM69_OPMODE_SEQUENCER_ON | RFM69_OPMODE_LISTEN_OFF | RFM69_OPMODE_STANDBY); //standby mode - - //TODO _isHighSpeed = true; - //TODO _haveEncryptKey = false; - uint32_t rxDuration = RFM69_LISTEN_RX_US; - uint32_t idleDuration = RFM69_LISTEN_IDLE_US; - RFM69_listenModeSetDurations(rxDuration, idleDuration); - - RFM69_writeReg(RFM69_REG_DIOMAPPING1, RFM69_DIOMAPPING1_DIO0_01); - RFM69_writeReg(RFM69_REG_FRFMSB, RFM69_readReg(RFM69_REG_FRFMSB) + 1); - RFM69_writeReg(RFM69_REG_FRFLSB, - RFM69_readReg(RFM69_REG_FRFLSB)); // MUST write to LSB to affect change! - RFM69_listenModeApplyHighSpeedSettings(); - RFM69_writeReg(RFM69_REG_PACKETCONFIG1, - RFM69_PACKET1_FORMAT_VARIABLE | RFM69_PACKET1_DCFREE_WHITENING | RFM69_PACKET1_CRC_ON | - RFM69_PACKET1_CRCAUTOCLEAR_ON); - RFM69_writeReg(RFM69_REG_PACKETCONFIG2, - RFM69_PACKET2_RXRESTARTDELAY_NONE | RFM69_PACKET2_AUTORXRESTART_ON | RFM69_PACKET2_AES_OFF); - RFM69_writeReg(RFM69_REG_SYNCVALUE1, 0x5A); - RFM69_writeReg(RFM69_REG_SYNCVALUE2, 0x5A); - RFM69_setListenConfig(idleListenResolution, rxListenResolution, RFM69_LISTEN1_CRITERIA_RSSI, - RFM69_LISTEN1_END_10); - RFM69_setListenCoefIdle(idleListenCoef); - RFM69_setListenCoefRx(rxListenCoef); - RFM69_writeReg(RFM69_REG_RSSITHRESH, 180); - RFM69_writeReg(RFM69_REG_RXTIMEOUT2, 75); - RFM69_writeReg(RFM69_REG_OPMODE, RFM69_OPMODE_SEQUENCER_ON | RFM69_OPMODE_STANDBY); - RFM69_writeReg(RFM69_REG_OPMODE, - RFM69_OPMODE_SEQUENCER_ON | RFM69_OPMODE_LISTEN_ON | RFM69_OPMODE_STANDBY); - //WIP - } -#endif - else { + } else { regMode = RFM69_OPMODE_SEQUENCER_ON | RFM69_OPMODE_LISTEN_OFF | RFM69_OPMODE_STANDBY; } @@ -597,6 +565,7 @@ LOCAL bool RFM69_setRadioMode(const rfm69_radio_mode_t newRadioMode) LOCAL void RFM69_powerUp(void) { #if defined(MY_RFM69_POWER_PIN) + RFM69_DEBUG(PSTR("RFM69:PWU\n")); // power up radio hwDigitalWrite(MY_RFM69_POWER_PIN, HIGH); delay(RFM69_POWERUP_DELAY_MS); #endif @@ -604,6 +573,7 @@ LOCAL void RFM69_powerUp(void) LOCAL void RFM69_powerDown(void) { #if defined(MY_RFM69_POWER_PIN) + RFM69_DEBUG(PSTR("RFM69:PWD\n")); // power down radio hwDigitalWrite(MY_RFM69_POWER_PIN, LOW); #endif } @@ -630,33 +600,31 @@ LOCAL void RFM69_sendACK(const uint8_t recipient, const rfm69_sequenceNumber_t s rfm69_ack_t ACK; ACK.sequenceNumber = sequenceNumber; ACK.RSSI = RSSI; - rfm69_controlFlags_t flags = 0x00; // reset flags + rfm69_controlFlags_t flags = 0u; // reset flags RFM69_setACKReceived(flags, true); RFM69_setACKRSSIReport(flags, true); - (void)RFM69_send(recipient, (uint8_t*)&ACK, sizeof(rfm69_ack_t), flags); + (void)RFM69_send(recipient, (uint8_t *)&ACK, sizeof(rfm69_ack_t), flags); } LOCAL bool RFM69_executeATC(const rfm69_RSSI_t currentRSSI, const rfm69_RSSI_t targetRSSI) { + // RSSI range -80..-70 = internal representation 160(l)..140(u) rfm69_powerlevel_t newPowerLevel = RFM69.powerLevel; - if (RFM69_internalToRSSI(currentRSSI) < RFM69_internalToRSSI(targetRSSI * - (1 + RFM69_ATC_TARGET_RANGE_PERCENT/100)) && - newPowerLevel < RFM69_MAX_POWER_LEVEL_DBM) { + const rfm69_RSSI_t uRange = targetRSSI - RFM69_RSSItoInternal(RFM69_ATC_TARGET_RANGE_DBM); + const rfm69_RSSI_t lRange = targetRSSI + RFM69_RSSItoInternal(RFM69_ATC_TARGET_RANGE_DBM); + if (currentRSSI > lRange && newPowerLevel < RFM69_MAX_POWER_LEVEL_DBM) { // increase transmitter power newPowerLevel++; - } else if (RFM69_internalToRSSI(currentRSSI) > RFM69_internalToRSSI(targetRSSI * - (1 - RFM69_ATC_TARGET_RANGE_PERCENT/100)) && - newPowerLevel > RFM69_MIN_POWER_LEVEL_DBM) { + } else if (currentRSSI < uRange && newPowerLevel > RFM69_MIN_POWER_LEVEL_DBM) { // decrease transmitter power newPowerLevel--; } else { // nothing to adjust return false; } - RFM69_DEBUG(PSTR("RFM69:ATC:ADJ TXL,cR=%" PRIi16 ",tR=%" PRIi16 ",TXL=%" PRIi16 "\n"), - RFM69_internalToRSSI(currentRSSI), - RFM69_internalToRSSI(targetRSSI), newPowerLevel); - + RFM69_DEBUG(PSTR("RFM69:ATC:ADJ TXL,cR=%" PRIi16 ",tR=%" PRIi16 "..%" PRIi16 ",TXL=%" PRIi8 "\n"), + RFM69_internalToRSSI(currentRSSI), RFM69_internalToRSSI(lRange), RFM69_internalToRSSI(uRange), + RFM69.powerLevel); return RFM69_setTxPowerLevel(newPowerLevel); } @@ -667,15 +635,16 @@ LOCAL void RFM69_ATCmode(const bool onOff, const int16_t targetRSSI) } -LOCAL bool RFM69_sendWithRetry(const uint8_t recipient, const void* buffer, +LOCAL bool RFM69_sendWithRetry(const uint8_t recipient, const void *buffer, const uint8_t bufferSize, const uint8_t retries, const uint32_t retryWaitTimeMS) { for (uint8_t retry = 0; retry <= retries; retry++) { - RFM69_DEBUG(PSTR("RFM69:SWR:SEND,TO=%" PRIu8 ",RETRY=%" PRIu8 "\n"), recipient, retry); - rfm69_controlFlags_t flags = 0x00; // reset all flags + RFM69_DEBUG(PSTR("RFM69:SWR:SEND,TO=%" PRIu8 ",SEQ=%" PRIu16 ",RETRY=%" PRIu8 "\n"), recipient, + RFM69.txSequenceNumber,retry); + rfm69_controlFlags_t flags = 0u; // reset all flags RFM69_setACKRequested(flags, (recipient != RFM69_BROADCAST_ADDRESS)); RFM69_setACKRSSIReport(flags, RFM69.ATCenabled); - (void)RFM69_send(recipient, (uint8_t*)buffer, bufferSize, flags, !retry); + (void)RFM69_send(recipient, (uint8_t *)buffer, bufferSize, flags, !retry); if (recipient == RFM69_BROADCAST_ADDRESS) { // no ACK requested return true; @@ -683,6 +652,7 @@ LOCAL bool RFM69_sendWithRetry(const uint8_t recipient, const void* buffer, // radio is in RX const uint32_t enterMS = hwMillis(); while (hwMillis() - enterMS < retryWaitTimeMS) { + RFM69_handler(); if (RFM69.ackReceived) { // radio is in stdby const uint8_t sender = RFM69.currentPacket.header.sender; @@ -700,24 +670,12 @@ LOCAL bool RFM69_sendWithRetry(const uint8_t recipient, const void* buffer, // ATC if (RFM69.ATCenabled && RFM69_getACKRSSIReport(flags)) { (void)RFM69_executeATC(RSSI,RFM69.ATCtargetRSSI); - } // ATC - // return to RX + } return true; } // seq check } - doYield(); } RFM69_DEBUG(PSTR("!RFM69:SWR:NACK\n")); - if (RFM69.ATCenabled) { - // No ACK received, maybe out of reach: increase power level - RFM69_setTxPowerLevel(RFM69.powerLevel + 1); - } - // random 100ms - const uint32_t enterCSMAMS = hwMillis(); - const uint16_t randDelayCSMA = enterMS & 40; // 61 bytes + ACK take ~40ms - while (hwMillis() - enterCSMAMS < randDelayCSMA) { - doYield(); - } } return false; } @@ -770,90 +728,79 @@ LOCAL uint8_t RFM69_getTxPowerPercent(void) LOCAL bool RFM69_sanityCheck(void) { bool result = true; // default - result &= RFM69_readReg(RFM69_REG_DATAMODUL) == (RFM69_DATAMODUL_DATAMODE_PACKET | - RFM69_DATAMODUL_MODULATIONTYPE_FSK | RFM69_DATAMODUL_MODULATIONSHAPING_00); - // check Bitrate - result &= RFM69_readReg(RFM69_REG_BITRATEMSB) == MY_RFM69_BITRATE_MSB; - result &= RFM69_readReg(RFM69_REG_BITRATELSB) == MY_RFM69_BITRATE_LSB; - // default: 5KHz, (FDEV + BitRate / 2 <= 500KHz) - result &= RFM69_readReg(RFM69_REG_FDEVMSB) == RFM69_FDEVMSB_50000; - result &= RFM69_readReg(RFM69_REG_FDEVLSB) == RFM69_FDEVLSB_50000; - // check network + result &= RFM69_readReg(RFM69_REG_RSSITHRESH) == RFM69_RSSITHRESH_VALUE; + result &= RFM69_readReg(RFM69_REG_SYNCVALUE1) == RFM69_SYNCVALUE1; result &= RFM69_readReg(RFM69_REG_SYNCVALUE2) == MY_RFM69_NETWORKID; return result; } LOCAL void RFM69_setConfiguration(void) { + const uint8_t rfm69_modem_config[] = { MY_RFM69_MODEM_CONFIGURATION }; const uint8_t CONFIG[][2] = { { RFM69_REG_OPMODE, RFM69_OPMODE_SEQUENCER_ON | RFM69_OPMODE_LISTEN_OFF | RFM69_OPMODE_STANDBY }, - { RFM69_REG_DATAMODUL, RFM69_DATAMODUL_DATAMODE_PACKET | RFM69_DATAMODUL_MODULATIONTYPE_FSK | RFM69_DATAMODUL_MODULATIONSHAPING_00 }, - { RFM69_REG_BITRATEMSB, MY_RFM69_BITRATE_MSB }, - { RFM69_REG_BITRATELSB, MY_RFM69_BITRATE_LSB }, - { RFM69_REG_FDEVMSB, RFM69_FDEVMSB_50000 }, - { RFM69_REG_FDEVLSB, RFM69_FDEVLSB_50000 }, - //{ RFM69_REG_FRFMSB, RFM69_FREQ_MSB }, - //{ RFM69_REG_FRFMID, RFM69_FREQ_MID }, - //{ RFM69_REG_FRFLSB, RFM69_FREQ_LSB }, + { RFM69_REG_DATAMODUL, rfm69_modem_config[0] }, + { RFM69_REG_BITRATEMSB, rfm69_modem_config[1] }, + { RFM69_REG_BITRATELSB, rfm69_modem_config[2] }, + { RFM69_REG_FDEVMSB, rfm69_modem_config[3] }, + { RFM69_REG_FDEVLSB, rfm69_modem_config[4] }, { RFM69_REG_LNA, RFM69_LNA_ZIN_200 | RFM69_LNA_CURRENTGAIN }, - { RFM69_REG_RXBW, RFM69_RXBW_DCCFREQ_010 | RFM69_RXBW_MANT_16 | RFM69_RXBW_EXP_2 }, + { RFM69_REG_RXBW, rfm69_modem_config[5] }, + { RFM69_REG_AFCBW, rfm69_modem_config[5] }, // same as rxbw, experimental, based on datasheet //{ RFM69_REG_DIOMAPPING1, RFM69_DIOMAPPING1_DIO0_01 }, { RFM69_REG_DIOMAPPING2, RFM69_DIOMAPPING2_CLKOUT_OFF }, { RFM69_REG_IRQFLAGS2, RFM69_IRQFLAGS2_FIFOOVERRUN }, - { RFM69_REG_RSSITHRESH, 220 /*RFM69_RSSITHRESH_VALUE*/ }, - { RFM69_REG_PREAMBLEMSB, 0 }, // default - { RFM69_REG_PREAMBLELSB, 3 }, // default + { RFM69_REG_RSSITHRESH, RFM69_RSSITHRESH_VALUE }, + { RFM69_REG_PREAMBLEMSB, RFM69_PREAMBLESIZE_MSB_VALUE }, + { RFM69_REG_PREAMBLELSB, RFM69_PREAMBLESIZE_LSB_VALUE }, { RFM69_REG_SYNCCONFIG, RFM69_SYNC_ON | RFM69_SYNC_FIFOFILL_AUTO | RFM69_SYNC_SIZE_2 | RFM69_SYNC_TOL_0 }, { RFM69_REG_SYNCVALUE1, RFM69_SYNCVALUE1 }, { RFM69_REG_SYNCVALUE2, MY_RFM69_NETWORKID }, - // changed from dcfree_none to dcfree_whitening - { RFM69_REG_PACKETCONFIG1, RFM69_PACKET1_FORMAT_VARIABLE | RFM69_PACKET1_DCFREE_WHITENING | RFM69_PACKET1_CRC_ON | RFM69_PACKET1_CRCAUTOCLEAR_ON | RFM69_PACKET1_ADRSFILTERING_NODEBROADCAST }, - { RFM69_REG_PAYLOADLENGTH, 66 }, // in variable length mode: the max frame size, not used in TX + { RFM69_REG_PACKETCONFIG1, rfm69_modem_config[6] }, + { RFM69_REG_PAYLOADLENGTH, RFM69_MAX_PACKET_LEN }, // in variable length mode: the max frame size, not used in TX { RFM69_REG_NODEADRS, RFM69_BROADCAST_ADDRESS }, // init { RFM69_REG_BROADCASTADRS, RFM69_BROADCAST_ADDRESS }, { RFM69_REG_FIFOTHRESH, RFM69_FIFOTHRESH_TXSTART_FIFOTHRESH | (RFM69_HEADER_LEN - 1) }, // start transmitting when rfm69 header loaded, fifo level irq when header bytes received (irq asserted when n bytes exceeded) { RFM69_REG_PACKETCONFIG2, RFM69_PACKET2_RXRESTARTDELAY_2BITS | RFM69_PACKET2_AUTORXRESTART_OFF | RFM69_PACKET2_AES_OFF }, - { RFM69_REG_TESTDAGC, RFM69_DAGC_IMPROVED_LOWBETA0 }, + { RFM69_REG_TESTDAGC, RFM69_DAGC_IMPROVED_LOWBETA0 }, // continuous DAGC mode, use 0x30 if afc offset == 0 { 255, 0} }; - for (uint8_t i = 0; CONFIG[i][0] != 255; i++) { RFM69_writeReg(CONFIG[i][0], CONFIG[i][1]); } - } LOCAL bool RFM69_isModeReady(void) { - const uint32_t enterMS = hwMillis(); - while (hwMillis() - enterMS < RFM69_MODE_READY_TIMEOUT_MS) { - if (RFM69_readReg(RFM69_REG_IRQFLAGS1) & RFM69_IRQFLAGS1_MODEREADY) { - return true; - } - } - return false; + uint16_t timeout = 0xFFFF; + while (!(RFM69_readReg(RFM69_REG_IRQFLAGS1) & RFM69_IRQFLAGS1_MODEREADY) && timeout--) { + }; + return timeout; } -LOCAL void RFM69_encrypt(const char* key) +LOCAL void RFM69_encrypt(const char *key) { (void)RFM69_setRadioMode(RFM69_RADIO_MODE_STDBY); if (key != NULL) { RFM69_burstWriteReg(RFM69_REG_AESKEY1, key, 16); } RFM69_writeReg(RFM69_REG_PACKETCONFIG2, - (RFM69_readReg(RFM69_REG_PACKETCONFIG2) & 0xFE) | (key ? 1 : 0)); + (RFM69_readReg(RFM69_REG_PACKETCONFIG2) & 0xFE) | (key ? RFM69_PACKET2_AES_ON : + RFM69_PACKET2_AES_OFF)); } -LOCAL rfm69_RSSI_t RFM69_readRSSI(bool forceTrigger) +LOCAL rfm69_RSSI_t RFM69_readRSSI(const bool forceTrigger) { - // RSSI trigger not needed if DAGC is in continuous mode (we are) - if (forceTrigger) { + // RssiStart command and RssiDone flags are not usable when DAGC is turned on + /*if (forceTrigger) { RFM69_writeReg(RFM69_REG_RSSICONFIG, RFM69_RSSI_START); uint16_t timeout = 0xFFFF; while (!(RFM69_readReg(RFM69_REG_RSSICONFIG) & RFM69_RSSI_DONE) && timeout--) { }; } - return RFM69_readReg(RFM69_REG_RSSIVALUE); + */ + (void)forceTrigger; + return (rfm69_RSSI_t)RFM69_readReg(RFM69_REG_RSSIVALUE); } /* UNUSED @@ -873,14 +820,6 @@ LOCAL uint8_t RFM69_readTemperature(const uint8_t calFactor) calFactor; // 'complement' corrects the slope, rising temp = rising val } -LOCAL void RFM69_rcCalibration(void) -{ - RFM69_writeReg(RFM69_REG_OSC1, RFM69_OSC1_RCCAL_START); - const uint32_t enterMS = hwMillis(); - while (!(RFM69_readReg(RFM69_REG_OSC1) & RFM69_OSC1_RCCAL_DONE) && hwMillis() - enterMS < 500) { - }; -} - LOCAL uint8_t RFM69_setLNA(const uint8_t newReg) { const uint8_t oldReg = RFM69_readReg(RFM69_REG_LNA); @@ -889,12 +828,6 @@ LOCAL uint8_t RFM69_setLNA(const uint8_t newReg) return oldReg; // return the original value in case we need to restore it } -LOCAL void RFM69_ATCmode(const bool onOff, const int16_t targetRSSI) -{ - RFM69.ATCenabled = onOff; - RFM69.ATCtargetRSSI = RFM69_RSSItoInternal(targetRSSI); -} - LOCAL bool RFM69_waitCAD(void) { const uint32_t enterMS = hwMillis(); @@ -908,309 +841,22 @@ LOCAL bool RFM69_waitCAD(void) return true; } +LOCAL void RFM69_rcCalibration(void) +{ + // RC oscillator calibration + // On the SX1231 V2a, RC calibration at power-up needs to be performed + // This is not required in the version V2b any more, where the calibration is fully automatic + // see SX1231 datasheet, chapter 9 (Chip Revision) + RFM69_writeReg(0x57, 0x80); + RFM69_writeReg(RFM69_REG_OSC1, RFM69_OSC1_RCCAL_START); + while (!(RFM69_readReg(RFM69_REG_OSC1) & RFM69_OSC1_RCCAL_DONE)) {}; + RFM69_writeReg(RFM69_REG_OSC1, RFM69_OSC1_RCCAL_START); + while (!(RFM69_readReg(RFM69_REG_OSC1) & RFM69_OSC1_RCCAL_DONE)) {}; + RFM69_writeReg(0x57, 0x00); +} + */ - -// ************************ LISTENMODE SECTION ************************ - -#if defined(MY_RFM69_ENABLE_LISTENMODE) -LOCAL void RFM69_setListenConfig(const uint8_t listenResolIdle, const uint8_t listenResolRx, - const uint8_t listenCriteria, const uint8_t listenEnd) -{ - /* - ListenResolIdle one of: - RFM69_LISTEN_RESOL_IDLE_64US - RFM69_LISTEN_RESOL_IDLE_4_1MS - RFM69_LISTEN_RESOL_IDLE_262MS - Sets the listen mode idle time to 64 usec, 4.1ms or 262 ms - ListenResolRx one of: - RFM69_LISTEN_RESOL_RX_64US - RFM69_LISTEN_RESOL_RX_4_1MS - RFM69_LISTEN_RESOL_RX_262MS - Sets the listen mode Rx time to 64 usec, 4.1ms or 262 ms - ListenCriteria - Criteria for packet acceptance in listen mode, either: - RFM69_LISTEN_CRITERIA_RSSI - signal strength above RssiThreshold - RFM69_LISTEN_CRITERIA_RSSI_SYNC - Signal strength above RssiThresshold and SyncAddress matched. - ListenEnd: - Action taken after acceptance of a packet in Listen mode: - RFM69_LISTEN_END_STAY_RX_LISTEN_STOP - Chip stays in Rx mode, listen mode stops and must be disabled. - RFM69_LISTEN_END_RX_UNTIL_LISTEN_STOP - Chip stays in Rx mode until PayloadReady or Timeout interrupt - occurs. Listen mode stops and must be disabled. - RFM69_LISTEN_END_RX_UNTIL_LISTEN_RESUME - Chip stays in Rx mode until PayloadReady or Timeout interrupt - occurs. Listen mode then resumes in Idle State. - FIFO lost at next RX wakeup. - Default: (RFM69_LISTEN_RESOL_IDLE_4_1MS, RFM69_LISTEN_RESOL_RX_64US, - RFM69_LISTEN_CRITERIA_RSSI, RFM69_LISTEN_END_RX_UNTIL_LISTEN_STOP) - */ - - RFM69_writeReg(RFM69_REG_LISTEN1, listenResolIdle | listenResolRx | listenCriteria | listenEnd); -} - -LOCAL void RFM69_setListenCoefIdle(const uint8_t coeffIdle) -{ - /* - Duration of the Idle phase in Listen mode. - t ListenIdle = ListenCoefIdle * ListenResolIdle - Default 0xf5; 245 - */ - - RFM69_writeReg(RFM69_REG_LISTEN2, coeffIdle); -} - -LOCAL void RFM69_setListenCoefRx(const uint8_t coeffRX) -{ - /* - Duration of the Rx phase in Listen mode. - t ListenRx = ListenCoefRx * ListenResolRx - Default 0x20; 32 - */ - - RFM69_writeReg(RFM69_REG_LISTEN3, coeffRX); -} - -LOCAL void RFM69_listenModeApplyHighSpeedSettings(void) -{ - if (!_isHighSpeed) { - return; - } - RFM69_writeReg(RFM69_REG_BITRATEMSB, RFM69_BITRATEMSB_200000); - RFM69_writeReg(RFM69_REG_BITRATELSB, RFM69_BITRATELSB_200000); - RFM69_writeReg(RFM69_REG_FDEVMSB, RFM69_FDEVMSB_100000); - RFM69_writeReg(RFM69_REG_FDEVLSB, RFM69_FDEVLSB_100000); - RFM69_writeReg(RFM69_REG_RXBW, RFM69_RXBW_DCCFREQ_000 | RFM69_RXBW_MANT_20 | RFM69_RXBW_EXP_0); - - // Force LNA to the highest gain - //RFM69_writeReg(RFM69_REG_LNA, (RFM69_readReg(REG_LNA) << 2) | RF_LNA_GAINSELECT_MAX); -} - -LOCAL void RFM69_listenModeReset(void) -{ - // reset vars - - //DATALEN = 0; - //SENDERID = 0; - //TARGETID = 0; - //PAYLOADLEN = 0; - //ACK_REQUESTED = 0; - //ACK_RECEIVED = 0; - //LISTEN_BURST_REMAINING_MS = 0; -} - -LOCAL void RFM69_ListenModeStart(void) -{ - (void)RFM69_setRadioMode(RFM69_RADIO_MODE_LISTEN); - /* - RFM69_DEBUG(PSTR("RFM69:LSM:Start..\n")); - while (RFM69_readReg(RFM69_REG_IRQFLAGS2) & RFM69_IRQFLAGS2_PACKETSENT == 0x00); // wait for ModeReady - RFM69_listenModeReset(); - - detachInterrupt(digitalPinToInterrupt(MY_RFM69_IRQ_PIN)); - attachInterrupt(digitalPinToInterrupt(MY_RFM69_IRQ_PIN), RFM69_interruptHandler, RISING); - - (void)RFM69_setRadioMode(RFM69_RADIO_MODE_STDBY); - - RFM69_writeReg(RFM69_REG_DIOMAPPING1, RFM69_DIOMAPPING1_DIO0_01); - RFM69_writeReg(RFM69_REG_FRFMSB, RFM69_readReg(RFM69_REG_FRFMSB) + 1); - RFM69_writeReg(RFM69_REG_FRFLSB, RFM69_readReg(RFM69_REG_FRFLSB)); // MUST write to LSB to affect change! - - RFM69_listenModeApplyHighSpeedSettings(); - - RFM69_writeReg(RFM69_REG_PACKETCONFIG1, RFM69_PACKET1_FORMAT_VARIABLE | RFM69_PACKET1_DCFREE_WHITENING | RFM69_PACKET1_CRC_ON | RFM69_PACKET1_CRCAUTOCLEAR_ON); - RFM69_writeReg(RFM69_REG_PACKETCONFIG2, RFM69_PACKET2_RXRESTARTDELAY_NONE | RFM69_PACKET2_AUTORXRESTART_ON | RFM69_PACKET2_AES_OFF); - RFM69_writeReg(RFM69_REG_SYNCVALUE1, 0x5A); - RFM69_writeReg(RFM69_REG_SYNCVALUE2, 0x5A); - - RFM69_setListenConfig(idleListenResolution, rxListenResolution, RFM69_LISTEN1_CRITERIA_RSSI, RFM69_LISTEN1_END_10); - RFM69_setListenCoefIdle(idleListenCoef); - RFM69_setListenCoefRx(rxListenCoef); - - RFM69_writeReg(RFM69_REG_RSSITHRESH, 180); - RFM69_writeReg(RFM69_REG_RXTIMEOUT2, 75); - RFM69_writeReg(RFM69_REG_OPMODE, RFM69_OPMODE_SEQUENCER_ON | RFM69_OPMODE_STANDBY); - RFM69_writeReg(RFM69_REG_OPMODE, RFM69_OPMODE_SEQUENCER_ON | RFM69_OPMODE_LISTEN_ON | RFM69_OPMODE_STANDBY); - */ -} - -LOCAL bool RFM69_listenModeEnd(void) -{ - RFM69_DEBUG(PSTR("RFM69:LSM:End..\n")); - detachInterrupt(digitalPinToInterrupt(MY_RFM69_IRQ_PIN)); - - RFM69_writeReg(RFM69_REG_OPMODE, - RFM69_OPMODE_SEQUENCER_ON | RFM69_OPMODE_LISTENABORT | RFM69_OPMODE_STANDBY); - RFM69_writeReg(RFM69_REG_OPMODE, RFM69_OPMODE_SEQUENCER_ON | RFM69_OPMODE_STANDBY); - RFM69_writeReg(RFM69_REG_RXTIMEOUT2, 0); - - (void)RFM69_setRadioMode(RFM69_RADIO_MODE_STDBY); - - // wait for ModeReady - //if (!rfm69_ismodeready()) { - // return false; - //} - RFM69_isModeReady(); - RFM69_listenModeReset(); - RFM69_reinitRadio(); -} - -LOCAL bool RFM69_reinitRadio(void) -{ - if (!RFM69_initialise(MY_RFM69_FREQUENCY)) { - return false; - } - //TODO - //if (_haveEncryptKey) RFM69_encrypt(_encryptKey); // Restore the encryption key if necessary - //if (_isHighSpeed) RFM69_writeReg(RFM69_REG_LNA, (RFM69_readReg(RFM69_REG_LNA) & ~0x3) | RFM69_LNA_GAINSELECT_AUTO); - return true; -} - -LOCAL void RFM69_listenModeSendBurst(const uint8_t recipient, uint8_t* data, const uint8_t len) -{ - - detachInterrupt(digitalPinToInterrupt(MY_RFM69_IRQ_PIN)); - (void)RFM69_setRadioMode(RFM69_RADIO_MODE_STDBY); - RFM69_writeReg(RFM69_REG_PACKETCONFIG1, - RFM69_PACKET1_FORMAT_VARIABLE | RFM69_PACKET1_DCFREE_WHITENING | RFM69_PACKET1_CRC_ON | - RFM69_PACKET1_CRCAUTOCLEAR_ON); - RFM69_writeReg(RFM69_REG_PACKETCONFIG2, - RFM69_PACKET2_RXRESTARTDELAY_NONE | RFM69_PACKET2_AUTORXRESTART_ON | RFM69_PACKET2_AES_OFF); - RFM69_writeReg(RFM69_REG_SYNCVALUE1, 0x5A); - RFM69_writeReg(RFM69_REG_SYNCVALUE2, 0x5A); - RFM69_listenModeApplyHighSpeedSettings(); - RFM69_writeReg(RFM69_REG_FRFMSB, RFM69_readReg(RFM69_REG_FRFMSB) + 1); - RFM69_writeReg(RFM69_REG_FRFLSB, - RFM69_readReg(RFM69_REG_FRFLSB)); // MUST write to LSB to affect change! - - // TODO set high power level - - union { // union to simplify addressing of long and short parts of time offset - int32_t l; - uint8_t b[4]; - } timeRemaining; - - uint16_t cycleDurationMs = listenCycleDurationUs / 1000; - - timeRemaining.l = cycleDurationMs; - - RFM69_DEBUG(PSTR("RFM69:LSM:Send burst for %d ms\n"), cycleDurationMs); - - (void)RFM69_setRadioMode(RFM69_RADIO_MODE_TX); - uint32_t startTime = hwMillis(); - - while (timeRemaining.l > 0) { - // send burst - // write to FIFO TODO refactorize with func, check if send/sendframe could be used, and prepare packet struct - RFM69_prepareSPITransaction(); - RFM69_csn(LOW); - RFM69_SPI.transfer(RFM69_REG_FIFO | 0x80); - RFM69_SPI(len + - 4); // two bytes for target and sender node, two bytes for the burst time remaining - RFM69_SPI.transfer(recipient); - RFM69_SPI.transfer(_address); - - // We send the burst time remaining with the packet so the receiver knows how long to wait before trying to reply - RFM69_SPI.transfer(timeRemaining.b[0]); - RFM69_SPI.transfer(timeRemaining.b[1]); - - for (uint8_t i = 0; i < len; i++) { - RFM69_SPI.transfer(((uint8_t*)data)[i]); - } - - RFM69_csn(HIGH); - RFM69_concludeSPITransaction(); - - while ((RFM69_readReg(RFM69_REG_IRQFLAGS2) & RFM69_IRQFLAGS2_FIFONOTEMPTY) != - 0x00); // make sure packet is sent before putting more into the FIFO - timeRemaining.l = cycleDurationMs - (hwMillis() - startTime); - } - - (void)RFM69_setRadioMode(RFM69_RADIO_MODE_TX); - RFM69_reinitRadio(); -} - -LOCAL uint32_t RFM69_getUsForResolution(uint8_t resolution) -{ - switch (resolution) { - case RFM69_LISTEN1_RESOL_RX_64: - case RFM69_LISTEN1_RESOL_IDLE_64: - return 64; - case RFM69_LISTEN1_RESOL_RX_4100: - case RFM69_LISTEN1_RESOL_IDLE_4100: - return 4100; - case RFM69_LISTEN1_RESOL_RX_262000: - case RFM69_LISTEN1_RESOL_IDLE_262000: - return 262000; - default: - // Whoops - return 0; - } -} - -LOCAL uint32_t RFM69_getCoefForResolution(uint8_t resolution, uint32_t duration) -{ - uint32_t resolDuration = RFM69_getUsForResolution(resolution); - uint32_t result = duration / resolDuration; - - // If the next-higher coefficient is closer, use that - if (abs(duration - ((result + 1) * resolDuration)) < abs(duration - (result * resolDuration))) { - return result + 1; - } - - return result; -} - -LOCAL bool RFM69_chooseResolutionAndCoef(uint8_t *resolutions, uint32_t duration, uint8_t& resolOut, - uint8_t& coefOut) -{ - for (int i = 0; resolutions[i]; i++) { - uint32_t coef = RFM69_getCoefForResolution(resolutions[i], duration); - if (coef <= 255) { - coefOut = coef; - resolOut = resolutions[i]; - return true; - } - } - - // out of range - return false; -} - -LOCAL bool RFM69_listenModeSetDurations(uint32_t& rxDuration, uint32_t& idleDuration) -{ - uint8_t rxResolutions[] = { RFM69_LISTEN1_RESOL_RX_64, RFM69_LISTEN1_RESOL_RX_4100, RFM69_LISTEN1_RESOL_RX_262000, 0 }; - uint8_t idleResolutions[] = { RFM69_LISTEN1_RESOL_IDLE_64, RFM69_LISTEN1_RESOL_IDLE_4100, RFM69_LISTEN1_RESOL_IDLE_262000, 0 }; - - if (!RFM69_chooseResolutionAndCoef(rxResolutions, rxDuration, rxListenResolution, rxListenCoef)) { - return false; - } - - if (!RFM69_chooseResolutionAndCoef(idleResolutions, idleDuration, idleListenResolution, - idleListenCoef)) { - return false; - } - - rxDuration = RFM69_getUsForResolution(rxListenResolution) * rxListenCoef; - idleDuration = RFM69_getUsForResolution(idleListenResolution) * idleListenCoef; - listenCycleDurationUs = rxDuration + idleDuration; - - return true; -} - -LOCAL void RFM69_listenModeGetDurations(uint32_t &rxDuration, uint32_t &idleDuration) -{ - rxDuration = RFM69_getUsForResolution(rxListenResolution) * rxListenCoef; - idleDuration = RFM69_getUsForResolution(idleListenResolution) * idleListenCoef; -} - -#endif - -#ifdef MY_DEBUG_VERBOSE_RFM69_REGISTERS - LOCAL void RFM69_readAllRegs(void) { #ifdef RFM69_REGISTER_DETAIL @@ -1470,5 +1116,3 @@ LOCAL void RFM69_readAllRegs(void) (void)regVal; } } - -#endif diff --git a/drivers/RFM69/new/RFM69_new.h b/drivers/RFM69/new/RFM69_new.h index bc5df4a..204ad24 100644 --- a/drivers/RFM69/new/RFM69_new.h +++ b/drivers/RFM69/new/RFM69_new.h @@ -6,7 +6,7 @@ * network topology allowing messages to be routed to nodes. * * Created by Henrik Ekblad - * Copyright (C) 2013-2017 Sensnology AB + * Copyright (C) 2013-2018 Sensnology AB * Full contributor list: https://github.com/mysensors/Arduino/graphs/contributors * * Documentation: http://www.mysensors.org @@ -16,22 +16,23 @@ * modify it under the terms of the GNU General Public License * version 2 as published by the Free Software Foundation. * - * RFM69 driver refactored for Mysensors + * RFM69 driver refactored for MySensors * * Based on : * - LowPowerLab RFM69 Lib Copyright Felix Rusu (2014), felix@lowpowerlab.com * - Automatic Transmit Power Control class derived from RFM69 library. * Discussion and details in this forum post: https://lowpowerlab.com/forum/index.php/topic,688.0.html * Copyright Thomas Studwell (2014,2015) - * - Mysensors generic radio driver implementation, Copyright (C) 2017 Olivier Mauti + * - MySensors generic radio driver implementation Copyright (C) 2017, 2018 Olivier Mauti * * Changes by : @tekka, @scalz, @marceloagno * * Definitions for Semtech SX1231/H radios: - * http://www.semtech.com/images/datasheet/sx1231.pdf - * http://www.semtech.com/images/datasheet/sx1231h.pdf + * https://www.semtech.com/uploads/documents/sx1231.pdf + * https://www.semtech.com/uploads/documents/sx1231h.pdf */ + /** * @file RFM69_new.h * @@ -42,20 +43,24 @@ * RFM69 driver-related log messages, format: [!]SYSTEM:[SUB SYSTEM:]MESSAGE * - [!] Exclamation mark is prepended in case of error * -* |E| SYS | SUB | Message | Comment -* |-|-------|-------|----------------------------------|----------------------------------------------------------------------------------- -* | | RFM69 | INIT | | Initialise RFM69 radio -* | | RFM69 | INIT | PIN,CS=%d,IQP=%d,IQN=%d[,RST=%d] | Pin configuration: chip select (CS), IRQ pin (IQP), IRQ number (IQN), Reset (RST) -* |!| RFM69 | INIT | SANCHK FAIL | Sanity check failed, check wiring or replace module -* | | RFM69 | PTX | NO ADJ | TX power level, no adjustment -* | | RFM69 | PTX | LEVEL=%d dbM | TX power level, set to (LEVEL) dBm -* | | RFM69 | SLEEP | | Radio in sleep mode -* | | RFM69 | SAC | SEND ACK,TO=%d,RSSI=%d | ACK sent to (TO), RSSI of incoming message (RSSI) -* | | RFM69 | ATC | ADJ TXL,cR=%d,tR=%d,TXL=%d | Adjust TX power level (TXL) to match set RSSI (sR), current RSSI (cR) -* | | RFM69 | SWR | SEND,TO=%d,RETRY=%d | Send to (TO), retry if no ACK received (RETRY) -* | | RFM69 | SWR | ACK,FROM=%d,SEQ=%d,RSSI=%d | ACK received from (FROM), sequence nr (SEQ), ACK RSSI (RSSI) -* |!| RFM69 | SWR | NACK | Message sent, no ACK received -* | | RFM69 | SPP | PCT=%d,TX LEVEL=%d | Set TX level, input TX percent (PCT) +* |E| SYS | SUB | Message | Comment +* |-|-------|------|--------------------------------------|----------------------------------------------------------------------------------- +* | | RFM69 | INIT | | Initialise RFM69 radio +* | | RFM69 | INIT | PIN,CS=%%d,IQP=%%d,IQN=%%d[,RST=%%d] | Pin configuration: chip select (CS), IRQ pin (IQP), IRQ number (IQN), Reset (RST) +* | | RFM69 | INIT | HWV=%%d | HW version, see datasheet chapter 9 +* |!| RFM69 | INIT | SANCHK FAIL | Sanity check failed, check wiring or replace module +* | | RFM69 | PTX | NO ADJ | TX power level, no adjustment +* | | RFM69 | PTX | LEVEL=%%d dbM | TX power level, set to (LEVEL) dBm +* | | RFM69 | SAC | SEND ACK,TO=%%d,RSSI=%%d | ACK sent to (TO), RSSI of incoming message (RSSI) +* | | RFM69 | ATC | ADJ TXL,cR=%%d,tR=%%d..%%d,TXL=%%d | Adjust TX level, current RSSI (cR), target RSSI range (tR), TX level (TXL) +* | | RFM69 | SWR | SEND,TO=%%d,SEQ=%%d,RETRY=%%d | Send to (TO), sequence number (SWQ), retry if no ACK received (RETRY) +* | | RFM69 | SWR | ACK,FROM=%%d,SEQ=%%d,RSSI=%%d | ACK received from (FROM), sequence nr (SEQ), ACK RSSI (RSSI) +* |!| RFM69 | SWR | NACK | Message sent, no ACK received +* | | RFM69 | SPP | PCT=%%d,TX LEVEL=%%d | Set TX level, input TX percent (PCT) +* | | RFM69 | RSL | | Radio in sleep mode +* | | RFM69 | RSB | | Radio in standby mode +* | | RFM69 | PWD | | Power down radio +* | | RFM69 | PWU | | Power up radio * * @brief API declaration for RFM69 * @@ -72,27 +77,20 @@ #else #define DEFAULT_RFM69_IRQ_PIN (2) //!< DEFAULT_RFM69_IRQ_PIN #endif -#define DEFAULT_RFM69_IRQ_NUM digitalPinToInterrupt(DEFAULT_RFM69_IRQ_PIN) //!< DEFAULT_RFM69_IRQ_NUM #elif defined(ARDUINO_ARCH_ESP8266) #define DEFAULT_RFM69_IRQ_PIN (2) //!< DEFAULT_RFM69_IRQ_PIN -#define DEFAULT_RFM69_IRQ_NUM digitalPinToInterrupt(DEFAULT_RFM69_IRQ_PIN) //!< DEFAULT_RFM69_IRQ_NUM #elif defined(ARDUINO_ARCH_ESP32) #warning not implemented yet #elif defined(ARDUINO_ARCH_SAMD) #define DEFAULT_RFM69_IRQ_PIN (2) //!< DEFAULT_RFM69_IRQ_PIN -#define DEFAULT_RFM69_IRQ_NUM digitalPinToInterrupt(DEFAULT_RFM69_IRQ_PIN) //!< DEFAULT_RFM69_IRQ_NUM #elif defined(LINUX_ARCH_RASPBERRYPI) #define DEFAULT_RFM69_IRQ_PIN (22) //!< DEFAULT_RFM69_IRQ_PIN -#define DEFAULT_RFM69_IRQ_NUM DEFAULT_RFM69_IRQ_PIN //!< DEFAULT_RFM69_IRQ_NUM #elif defined(ARDUINO_ARCH_STM32F1) #define DEFAULT_RFM69_IRQ_PIN (PA3) //!< DEFAULT_RFM69_IRQ_PIN -#define DEFAULT_RFM69_IRQ_NUM DEFAULT_RFM69_IRQ_PIN //!< DEFAULT_RFM69_IRQ_NUM #elif defined(TEENSYDUINO) #define DEFAULT_RFM69_IRQ_PIN (8) //!< DEFAULT_RFM69_IRQ_PIN -#define DEFAULT_RFM69_IRQ_NUM digitalPinToInterrupt(DEFAULT_RFM69_IRQ_PIN) //!< DEFAULT_RFM69_IRQ_NUM #else #define DEFAULT_RFM69_IRQ_PIN (2) //!< DEFAULT_RFM69_IRQ_PIN -#define DEFAULT_RFM69_IRQ_NUM (2) //!< DEFAULT_RFM69_IRQ_NUM #endif #define DEFAULT_RFM69_CS_PIN (SS) //!< DEFAULT_RFM69_CS_PIN @@ -120,7 +118,7 @@ #define RFM69_CLOCK_DIV SPI_CLOCK_DIV256 //!< SPI clock divider 256 #endif -#if defined (ARDUINO) && !defined (__arm__) && !defined (RFM69_SPI) +#if defined(ARDUINO) && !defined(__arm__) && !defined(RFM69_SPI) #include #if defined(MY_SOFTSPI) SoftSPI @@ -147,7 +145,7 @@ extern HardwareSPI SPI; //!< SPI #if (MY_RFM69HW==true) // RFM69H(C)W #define RFM69_VERSION_HW //!< HW version -#define RFM69_MIN_POWER_LEVEL_DBM ((rfm69_powerlevel_t)-2) //!< min. power level, -18dBm +#define RFM69_MIN_POWER_LEVEL_DBM ((rfm69_powerlevel_t)-2) //!< min. power level, -2dBm #if defined(MY_RFM69_MAX_POWER_LEVEL_DBM) #define RFM69_MAX_POWER_LEVEL_DBM MY_RFM69_MAX_POWER_LEVEL_DBM //!< MY_RFM69_MAX_POWER_LEVEL_DBM #else @@ -163,71 +161,121 @@ extern HardwareSPI SPI; //!< SPI #endif #endif -#define RFM69_FIFO_SIZE (0xFFu) //!< Max number of bytes the Rx/Tx FIFO can hold -#define RFM69_MAX_PACKET_LEN (0x40u) //!< This is the maximum number of bytes that can be carried -#define RFM69_ATC_TARGET_RANGE_PERCENT (5u) //!< ATC target range +/-% -#define RFM69_PACKET_HEADER_VERSION (1u) //!< RFM69 packet header version -#define RFM69_MIN_PACKET_HEADER_VERSION (1u) //!< Minimal RFM69 packet header version -#define RFM69_RETRIES (5u) //!< Retries in case of failed transmission -#define RFM69_RETRY_TIMEOUT_MS (200ul) //!< Timeout for ACK, adjustments needed if modem configuration changed (air time different) -#define RFM69_MODE_READY_TIMEOUT_MS (50ul) //!< Timeout for mode ready -#define RFM69_TX_LIMIT_MS (1*1000ul) //!< Timeout for packet sent +#define RFM69_FIFO_SIZE (0xFFu) //!< Max number of bytes the Rx/Tx FIFO can hold +#define RFM69_MAX_PACKET_LEN (0x40u) //!< This is the maximum number of bytes that can be carried +#define RFM69_ATC_TARGET_RANGE_DBM (2u) //!< ATC target range +/- dBm +#define RFM69_PACKET_HEADER_VERSION (1u) //!< RFM69 packet header version +#define RFM69_MIN_PACKET_HEADER_VERSION (1u) //!< Minimal RFM69 packet header version -#define RFM69_ACK_REQUESTED (7u) //!< RFM69 header, controlFlag, bit 7 -#define RFM69_ACK_RECEIVED (6u) //!< RFM69 header, controlFlag, bit 6 -#define RFM69_ACK_RSSI_REPORT (5u) //!< RFM69 header, controlFlag, bit 5 +#define RFM69_RETRIES (5u) //!< Retries in case of failed transmission +#define RFM69_RETRY_TIMEOUT_MS (200ul) //!< Timeout for ACK, adjustments needed if modem configuration changed (air time different) +#define RFM69_MODE_READY_TIMEOUT_MS (50ul) //!< Timeout for mode ready -#define RFM69_BROADCAST_ADDRESS (255u) //!< Broadcasting address -#define RFM69_TARGET_RSSI_DBM (-60) //!< RSSI target -#define RFM69_HIGH_POWER_DBM (18u) //!< High power threshold, dBm -#define RFM69_PROMISCUOUS (false) //!< RFM69 promiscuous mode +#define RFM69_ACK_REQUESTED (7u) //!< RFM69 header, controlFlag, bit 7 +#define RFM69_ACK_RECEIVED (6u) //!< RFM69 header, controlFlag, bit 6 +#define RFM69_ACK_RSSI_REPORT (5u) //!< RFM69 header, controlFlag, bit 5 -#define RFM69_RSSItoInternal(__value) ((uint8_t)-(__value*2)) //!< RSSI converting macro -#define RFM69_internalToRSSI(__value) ((int16_t)-(__value/2)) //!< RSSI converting macro +#define RFM69_BROADCAST_ADDRESS (255u) //!< Broadcasting address +#define RFM69_TARGET_RSSI_DBM (-75) //!< RSSI target +#define RFM69_HIGH_POWER_DBM (18u) //!< High power threshold, dBm + +#if !defined(MY_RFM69_TX_TIMEOUT_MS) +#define MY_RFM69_TX_TIMEOUT_MS (2*1000ul) //!< Timeout for packet sent +#endif + +// CSMA settings +#if !defined(MY_RFM69_CSMA_LIMIT_DBM) +#define MY_RFM69_CSMA_LIMIT_DBM (-95) //!< upper RX signal sensitivity threshold in dBm for carrier sense access +#endif +#if !defined(MY_RFM69_CSMA_TIMEOUT_MS) +#define MY_RFM69_CSMA_TIMEOUT_MS (500ul) //!< CSMA timeout +#endif +// powerup delay +#define RFM69_POWERUP_DELAY_MS (100ul) //!< Power up delay, allow VCC to settle, transport to become fully operational + +// available frequency bands, non trivial values to avoid misconfiguration +#define RFM69_315MHZ (315000000ul) //!< RFM69_315MHZ +#define RFM69_433MHZ (433920000ul) //!< RFM69_433MHZ, center frequencz 433.92 MHz +#define RFM69_868MHZ (868000000ul) //!< RFM69_868MHZ +#define RFM69_915MHZ (915000000ul) //!< RFM69_915MHZ + +#define RFM69_COURSE_TEMP_COEF (-90) //!< puts the temperature reading in the ballpark, user can fine tune the returned value +#define RFM69_FXOSC (32*1000000ul) //!< OSC freq, 32MHz +#define RFM69_FSTEP (RFM69_FXOSC / 524288.0f) //!< FXOSC / 2^19 = 32MHz / 2^19 (p13 in datasheet) // helper macros #define RFM69_getACKRequested(__value) ((bool)bitRead(__value,RFM69_ACK_REQUESTED)) //!< getACKRequested -#define RFM69_setACKRequested(__value, __flag) bitWrite(__value,RFM69_ACK_REQUESTED,__flag) //!< setACKRequested -#define RFM69_getACKReceived(__value) ((bool)bitRead(__value,RFM69_ACK_RECEIVED)) //!< getACKReceived -#define RFM69_setACKReceived(__value, __flag) bitWrite(__value,RFM69_ACK_RECEIVED,__flag) //!< setACKReceived -#define RFM69_setACKRSSIReport(__value, __flag) bitWrite(__value,RFM69_ACK_RSSI_REPORT,__flag) //!< setACKRSSIReport -#define RFM69_getACKRSSIReport(__value) ((bool)bitRead(__value,RFM69_ACK_RSSI_REPORT)) //!< getACKRSSIReport - +#define RFM69_setACKRequested(__value, __flag) bitWrite(__value,RFM69_ACK_REQUESTED,__flag) //!< setACKRequested +#define RFM69_getACKReceived(__value) ((bool)bitRead(__value,RFM69_ACK_RECEIVED)) //!< getACKReceived +#define RFM69_setACKReceived(__value, __flag) bitWrite(__value,RFM69_ACK_RECEIVED,__flag) //!< setACKReceived +#define RFM69_setACKRSSIReport(__value, __flag) bitWrite(__value,RFM69_ACK_RSSI_REPORT,__flag)//!< setACKRSSIReport +#define RFM69_getACKRSSIReport(__value) ((bool)bitRead(__value,RFM69_ACK_RSSI_REPORT)) //!< getACKRSSIReport // Register access #define RFM69_READ_REGISTER (0x7Fu) //!< reading register #define RFM69_WRITE_REGISTER (0x80u) //!< writing register -// CAD & CSMA -#define RFM69_CAD_TIMEOUT_MS (2*1000ul) //!< Channel activity detection timeout -#define RFM69_CSMA_LIMIT_DBM (-90) //!< upper RX signal sensitivity threshold in dBm for carrier sense access -#define RFM69_CSMA_TIMEOUT_MS (1000ul) //!< CSMA timeout +// Modem configuration section +#define RFM69_CONFIG_FSK (RFM69_DATAMODUL_DATAMODE_PACKET | RFM69_DATAMODUL_MODULATIONTYPE_FSK | RFM69_DATAMODUL_MODULATIONSHAPING_00) //!< RFM69_CONFIG_FSK +#define RFM69_CONFIG_GFSK (RFM69_DATAMODUL_DATAMODE_PACKET | RFM69_DATAMODUL_MODULATIONTYPE_FSK | RFM69_DATAMODUL_MODULATIONSHAPING_10) //!< RFM69_CONFIG_GFSK +#define RFM69_CONFIG_OOK (RFM69_DATAMODUL_DATAMODE_PACKET | RFM69_DATAMODUL_MODULATIONTYPE_OOK | RFM69_DATAMODUL_MODULATIONSHAPING_00) //!< RFM69_CONFIG_OOK -// powerup delay -#define RFM69_POWERUP_DELAY_MS (100u) //!< Power up delay, allow VCC to settle, transport to become fully operational +#define RFM69_CONFIG_NOWHITE (RFM69_PACKET1_FORMAT_VARIABLE | RFM69_PACKET1_DCFREE_OFF | RFM69_PACKET1_CRC_ON | RFM69_PACKET1_CRCAUTOCLEAR_ON | RFM69_PACKET1_ADRSFILTERING_NODEBROADCAST) //!< RFM69_CONFIG_NOWHITE +#define RFM69_CONFIG_WHITE (RFM69_PACKET1_FORMAT_VARIABLE | RFM69_PACKET1_DCFREE_WHITENING | RFM69_PACKET1_CRC_ON | RFM69_PACKET1_CRCAUTOCLEAR_ON | RFM69_PACKET1_ADRSFILTERING_NODEBROADCAST) //!< RFM69_CONFIG_WHITE +#define RFM69_CONFIG_MANCHESTER (RFM69_PACKET1_FORMAT_VARIABLE | RFM69_PACKET1_DCFREE_MANCHESTER | RFM69_PACKET1_CRC_ON | RFM69_PACKET1_CRCAUTOCLEAR_ON | RFM69_PACKET1_ADRSFILTERING_NODEBROADCAST) //!< RFM69_CONFIG_MANCHESTER -// available frequency bands, non trivial values to avoid misconfiguration -#define RFM69_315MHZ (315000000ul) //!< RFM69_315MHZ -#define RFM69_433MHZ (433920000ul) //!< RFM69_433MHZ, center frequencz 433.92 MHz -#define RFM69_868MHZ (868000000ul) //!< RFM69_868MHZ -#define RFM69_915MHZ (915000000ul) //!< RFM69_915MHZ +#define RFM69_RXBW_111_24_4 (RFM69_RXBW_DCCFREQ_111 | RFM69_RXBW_MANT_24 | RFM69_RXBW_EXP_4) //!< RFM69_RXBW_111_24_4 +#define RFM69_RXBW_111_24_3 (RFM69_RXBW_DCCFREQ_111 | RFM69_RXBW_MANT_24 | RFM69_RXBW_EXP_3) //!< RFM69_RXBW_111_24_3 +#define RFM69_RXBW_111_24_2 (RFM69_RXBW_DCCFREQ_111 | RFM69_RXBW_MANT_24 | RFM69_RXBW_EXP_2) //!< RFM69_RXBW_111_24_2 +#define RFM69_RXBW_111_16_2 (RFM69_RXBW_DCCFREQ_111 | RFM69_RXBW_MANT_16 | RFM69_RXBW_EXP_2) //!< RFM69_RXBW_111_16_2 +#define RFM69_RXBW_111_16_1 (RFM69_RXBW_DCCFREQ_111 | RFM69_RXBW_MANT_16 | RFM69_RXBW_EXP_1) //!< RFM69_RXBW_111_16_1 +#define RFM69_RXBW_111_16_0 (RFM69_RXBW_DCCFREQ_111 | RFM69_RXBW_MANT_16 | RFM69_RXBW_EXP_0) //!< RFM69_RXBW_111_16_0 +#define RFM69_RXBW_010_16_2 (RFM69_RXBW_DCCFREQ_010 | RFM69_RXBW_MANT_16 | RFM69_RXBW_EXP_2) //!< RFM69_RXBW_010_16_2 -#define RFM69_COURSE_TEMP_COEF (-90) //!< puts the temperature reading in the ballpark, user can fine tune the returned value -#define RFM69_FXOSC (32*1000000ul) //!< OSC freq, 32MHz -#define RFM69_FSTEP (RFM69_FXOSC / 524288.0f) //!< FXOSC / 2^19 = 32MHz / 2^19 (p13 in datasheet) +#define RFM69_FSK_BR2_FD5 RFM69_CONFIG_FSK, RFM69_BITRATEMSB_2000, RFM69_BITRATELSB_2000, RFM69_FDEVMSB_5000, RFM69_FDEVLSB_5000, RFM69_RXBW_111_24_4, RFM69_CONFIG_WHITE //!< RFM69_FSK_BR2_FD5 +#define RFM69_FSK_BR2_4_FD4_8 RFM69_CONFIG_FSK, RFM69_BITRATEMSB_2400, RFM69_BITRATELSB_2400, RFM69_FDEVMSB_4800, RFM69_FDEVLSB_4800, RFM69_RXBW_111_24_4, RFM69_CONFIG_WHITE //!< RFM69_FSK_BR2_4_FD4_8 +#define RFM69_FSK_BR4_8_FD9_6 RFM69_CONFIG_FSK, RFM69_BITRATEMSB_4800, RFM69_BITRATELSB_4800, RFM69_FDEVMSB_9600, RFM69_FDEVLSB_9600, RFM69_RXBW_111_24_4, RFM69_CONFIG_WHITE //!< RFM69_FSK_BR4_8_FD9_6 +#define RFM69_FSK_BR9_6_FD19_2 RFM69_CONFIG_FSK, RFM69_BITRATEMSB_9600, RFM69_BITRATELSB_9600, RFM69_FDEVMSB_19200, RFM69_FDEVLSB_19200, RFM69_RXBW_111_24_4, RFM69_CONFIG_WHITE //!< RFM69_FSK_BR9_6_FD19_2 +#define RFM69_FSK_BR19_2_FD38_4 RFM69_CONFIG_FSK, RFM69_BITRATEMSB_19200, RFM69_BITRATELSB_19200, RFM69_FDEVMSB_38400, RFM69_FDEVLSB_38400, RFM69_RXBW_111_24_3, RFM69_CONFIG_WHITE //!< RFM69_FSK_BR19_2_FD38_4 +#define RFM69_FSK_BR38_4_FD76_8 RFM69_CONFIG_FSK, RFM69_BITRATEMSB_38400, RFM69_BITRATELSB_38400, RFM69_FDEVMSB_76800, RFM69_FDEVLSB_76800, RFM69_RXBW_111_24_2, RFM69_CONFIG_WHITE //!< RFM69_FSK_BR38_4_FD76_8 +#define RFM69_FSK_BR55_5_FD50 RFM69_CONFIG_FSK, RFM69_BITRATEMSB_55555, RFM69_BITRATELSB_55555, RFM69_FDEVMSB_50000, RFM69_FDEVLSB_50000, RFM69_RXBW_111_16_2, RFM69_CONFIG_WHITE //!< RFM69_FSK_BR55_5_FD50 +#define RFM69_FSK_BR57_6_FD120 RFM69_CONFIG_FSK, RFM69_BITRATEMSB_57600, RFM69_BITRATELSB_57600, RFM69_FDEVMSB_120000, RFM69_FDEVLSB_120000, RFM69_RXBW_111_16_1, RFM69_CONFIG_WHITE //!< RFM69_FSK_BR57_6_FD120 +#define RFM69_FSK_BR125_FD125 RFM69_CONFIG_FSK, RFM69_BITRATEMSB_125000, RFM69_BITRATELSB_125000, RFM69_FDEVMSB_125000, RFM69_FDEVLSB_125000, RFM69_RXBW_010_16_2, RFM69_CONFIG_WHITE //!< RFM69_FSK_BR125_FD125 +#define RFM69_FSK_BR250_FD250 RFM69_CONFIG_FSK, RFM69_BITRATEMSB_250000, RFM69_BITRATELSB_250000, RFM69_FDEVMSB_250000, RFM69_FDEVLSB_250000, RFM69_RXBW_111_16_0, RFM69_CONFIG_WHITE //!< RFM69_FSK_BR250_FD250 -#if defined(MY_RFM69_ENABLE_LISTENMODE) -#define RFM69_LISTEN_RX_US MY_RFM69_DEFAULT_LISTEN_RX_US //!< RFM69_LISTEN_RX_US -#define RFM69_LISTEN_IDLE_US MY_RFM69_DEFAULT_LISTEN_IDLE_US //!< RFM69_LISTEN_IDLE_US +#define RFM69_GFSK_BR2_FD5 RFM69_CONFIG_GFSK, RFM69_BITRATEMSB_2000, RFM69_BITRATELSB_2000, RFM69_FDEVMSB_5000, RFM69_FDEVLSB_5000, RFM69_RXBW_111_24_4, RFM69_CONFIG_WHITE //!< RFM69_GFSK_BR2_FD5 +#define RFM69_GFSK_BR2_4_FD4_8 RFM69_CONFIG_GFSK, RFM69_BITRATEMSB_2400, RFM69_BITRATELSB_2400, RFM69_FDEVMSB_4800, RFM69_FDEVLSB_4800, RFM69_RXBW_111_24_4, RFM69_CONFIG_WHITE //!< RFM69_GFSK_BR2_4_FD4_8 +#define RFM69_GFSK_BR4_8_FD9_6 RFM69_CONFIG_GFSK, RFM69_BITRATEMSB_4800, RFM69_BITRATELSB_4800, RFM69_FDEVMSB_9600, RFM69_FDEVLSB_9600, RFM69_RXBW_111_24_4, RFM69_CONFIG_WHITE //!< RFM69_GFSK_BR4_8_FD9_6 +#define RFM69_GFSK_BR9_6_FD19_2 RFM69_CONFIG_GFSK, RFM69_BITRATEMSB_9600, RFM69_BITRATELSB_9600, RFM69_FDEVMSB_19200, RFM69_FDEVLSB_19200, RFM69_RXBW_111_24_4, RFM69_CONFIG_WHITE //!< RFM69_GFSK_BR9_6_FD19_2 +#define RFM69_GFSK_BR19_2_FD38_4 RFM69_CONFIG_GFSK, RFM69_BITRATEMSB_19200, RFM69_BITRATELSB_19200, RFM69_FDEVMSB_38400, RFM69_FDEVLSB_38400, RFM69_RXBW_111_24_3, RFM69_CONFIG_WHITE //!< RFM69_GFSK_BR19_2_FD38_4 +#define RFM69_GFSK_BR38_4_FD76_8 RFM69_CONFIG_GFSK, RFM69_BITRATEMSB_38400, RFM69_BITRATELSB_38400, RFM69_FDEVMSB_76800, RFM69_FDEVLSB_76800, RFM69_RXBW_111_24_2, RFM69_CONFIG_WHITE //!< RFM69_GFSK_BR38_4_FD76_8 +#define RFM69_GFSK_BR55_5_FD50 RFM69_CONFIG_GFSK, RFM69_BITRATEMSB_55555, RFM69_BITRATELSB_55555, RFM69_FDEVMSB_50000, RFM69_FDEVLSB_50000, RFM69_RXBW_111_16_2, RFM69_CONFIG_WHITE //!< RFM69_GFSK_BR55_5_FD50 +#define RFM69_GFSK_BR57_6_FD120 RFM69_CONFIG_GFSK, RFM69_BITRATEMSB_57600, RFM69_BITRATELSB_57600, RFM69_FDEVMSB_120000, RFM69_FDEVLSB_120000, RFM69_RXBW_111_16_1, RFM69_CONFIG_WHITE //!< RFM69_GFSK_BR57_6_FD120 +#define RFM69_GFSK_BR125_FD125 RFM69_CONFIG_GFSK, RFM69_BITRATEMSB_125000, RFM69_BITRATELSB_125000, RFM69_FDEVMSB_125000, RFM69_FDEVLSB_125000, RFM69_RXBW_010_16_2, RFM69_CONFIG_WHITE //!< RFM69_GFSK_BR125_FD125 +#define RFM69_GFSK_BR250_FD250 RFM69_CONFIG_GFSK, RFM69_BITRATEMSB_250000, RFM69_BITRATELSB_250000, RFM69_FDEVMSB_250000, RFM69_FDEVLSB_250000, RFM69_RXBW_111_16_0, RFM69_CONFIG_WHITE //!< RFM69_GFSK_BR250_FD250 + +#define RFM69_OOK_BR2_FD5 RFM69_CONFIG_OOK, RFM69_BITRATEMSB_2000, RFM69_BITRATELSB_2000, RFM69_FDEVMSB_5000, RFM69_FDEVLSB_5000, RFM69_RXBW_111_24_4, RFM69_CONFIG_WHITE //!< RFM69_OOK_BR2_FD5 +#define RFM69_OOK_BR2_4_FD4_8 RFM69_CONFIG_OOK, RFM69_BITRATEMSB_2400, RFM69_BITRATELSB_2400, RFM69_FDEVMSB_4800, RFM69_FDEVLSB_4800, RFM69_RXBW_111_24_4, RFM69_CONFIG_WHITE //!< RFM69_OOK_BR2_4_FD4_8 +#define RFM69_OOK_BR4_8_FD9_6 RFM69_CONFIG_OOK, RFM69_BITRATEMSB_4800, RFM69_BITRATELSB_4800, RFM69_FDEVMSB_9600, RFM69_FDEVLSB_9600, RFM69_RXBW_111_24_4, RFM69_CONFIG_WHITE //!< RFM69_OOK_BR4_8_FD9_6 +#define RFM69_OOK_BR9_6_FD19_2 RFM69_CONFIG_OOK, RFM69_BITRATEMSB_9600, RFM69_BITRATELSB_9600, RFM69_FDEVMSB_19200, RFM69_FDEVLSB_19200, RFM69_RXBW_111_24_4, RFM69_CONFIG_WHITE //!< RFM69_OOK_BR9_6_FD19_2 +#define RFM69_OOK_BR19_2_FD38_4 RFM69_CONFIG_OOK, RFM69_BITRATEMSB_19200, RFM69_BITRATELSB_19200, RFM69_FDEVMSB_38400, RFM69_FDEVLSB_38400, RFM69_RXBW_111_24_3, RFM69_CONFIG_WHITE //!< RFM69_OOK_BR19_2_FD38_4 +#define RFM69_OOK_BR38_4_FD76_8 RFM69_CONFIG_OOK, RFM69_BITRATEMSB_38400, RFM69_BITRATELSB_38400, RFM69_FDEVMSB_76800, RFM69_FDEVLSB_76800, RFM69_RXBW_111_24_2, RFM69_CONFIG_WHITE //!< RFM69_OOK_BR38_4_FD76_8 +#define RFM69_OOK_BR55_5_FD50 RFM69_CONFIG_OOK, RFM69_BITRATEMSB_55555, RFM69_BITRATELSB_55555, RFM69_FDEVMSB_50000, RFM69_FDEVLSB_50000, RFM69_RXBW_111_16_2, RFM69_CONFIG_WHITE //!< RFM69_OOK_BR55_5_FD50 +#define RFM69_OOK_BR57_6_FD120 RFM69_CONFIG_OOK, RFM69_BITRATEMSB_57600, RFM69_BITRATELSB_57600, RFM69_FDEVMSB_120000, RFM69_FDEVLSB_120000, RFM69_RXBW_111_16_1, RFM69_CONFIG_WHITE //!< RFM69_OOK_BR57_6_FD120 +#define RFM69_OOK_BR125_FD125 RFM69_CONFIG_OOK, RFM69_BITRATEMSB_125000, RFM69_BITRATELSB_125000, RFM69_FDEVMSB_125000, RFM69_FDEVLSB_125000, RFM69_RXBW_010_16_2, RFM69_CONFIG_WHITE //!< RFM69_OOK_BR125_FD125 +#define RFM69_OOK_BR250_FD250 RFM69_CONFIG_OOK, RFM69_BITRATEMSB_250000, RFM69_BITRATELSB_250000, RFM69_FDEVMSB_250000, RFM69_FDEVLSB_250000, RFM69_RXBW_111_16_0, RFM69_CONFIG_WHITE //!< RFM69_OOK_BR250_FD250 + +#if !defined(MY_RFM69_MODEM_CONFIGURATION) +#define MY_RFM69_MODEM_CONFIGURATION RFM69_FSK_BR55_5_FD50 //!< default setting, RFM69_FSK_BR55_5_FD50 #endif /** * @brief Radio modes */ typedef enum { - RFM69_RADIO_MODE_RX = 0, //!< RX mode - RFM69_RADIO_MODE_TX = 1, //!< TX mode - RFM69_RADIO_MODE_CAD = 2, //!< CAD mode + RFM69_RADIO_MODE_RX = 0, //!< RX mode + RFM69_RADIO_MODE_TX = 1, //!< TX mode + RFM69_RADIO_MODE_CAD = 2, //!< CAD mode RFM69_RADIO_MODE_SLEEP = 3, //!< SLEEP mode RFM69_RADIO_MODE_STDBY = 4, //!< STDBY mode RFM69_RADIO_MODE_SYNTH = 5, //!< SYNTH mode @@ -260,19 +308,20 @@ typedef int8_t rfm69_powerlevel_t; * IMPORTANT: Do not change order (see datasheet for packet structure) */ typedef struct { - uint8_t packetLen; //!< Packet length - uint8_t recipient; //!< Payload recipient - uint8_t version; //!< Header version - uint8_t sender; //!< Payload sender - rfm69_controlFlags_t controlFlags; //!< Control flags, used for ACK - rfm69_sequenceNumber_t sequenceNumber; //!< Packet sequence number, used for ACK + uint8_t packetLen; //!< packet length + uint8_t recipient; //!< payload recipient + uint8_t version; //!< header version (20180128tk: >=3.0.0 fused with controlFlags) + uint8_t sender; //!< payload sender + rfm69_controlFlags_t controlFlags; //!< control flags, used for ACK + rfm69_sequenceNumber_t sequenceNumber; //!< packet sequence number, used for ACK } __attribute__((packed)) rfm69_header_t; + /** * @brief RFM69 ACK packet structure */ typedef struct { - rfm69_sequenceNumber_t sequenceNumber; //!< sequence number - rfm69_RSSI_t RSSI; //!< RSSI + rfm69_sequenceNumber_t sequenceNumber; //!< sequence number + rfm69_RSSI_t RSSI; //!< RSSI } __attribute__((packed)) rfm69_ack_t; #define RFM69_HEADER_LEN sizeof(rfm69_header_t) //!< Size header inside payload @@ -280,6 +329,7 @@ typedef struct { /** * @brief Packet structure +* IMPORTANT: Do not change order */ typedef struct { union { @@ -301,30 +351,43 @@ typedef struct { * @brief RFM69 internal variables */ typedef struct { - uint8_t address; //!< Node address - rfm69_packet_t currentPacket; //!< Buffer for current packet - rfm69_sequenceNumber_t txSequenceNumber; //!< RFM69_txSequenceNumber - rfm69_powerlevel_t powerLevel; //!< TX power level dBm - uint8_t ATCtargetRSSI; //!< ATC: target RSSI + uint8_t address; //!< Node address + rfm69_packet_t currentPacket; //!< Buffer for current packet + rfm69_sequenceNumber_t txSequenceNumber; //!< RFM69_txSequenceNumber + rfm69_powerlevel_t powerLevel; //!< TX power level dBm + uint8_t ATCtargetRSSI; //!< ATC: target RSSI // 8 bit - rfm69_radio_mode_t radioMode : 3; //!< current transceiver state - bool dataSent : 1; //!< Data sent - bool dataReceived : 1; //!< data received - bool ackReceived : 1; //!< ack received - bool ATCenabled : 1; //!< ATC enabled - bool listenModeEnabled : 1; //!< Listen Mode enabled + rfm69_radio_mode_t radioMode : 3; //!< current transceiver state + bool dataReceived : 1; //!< data received + bool ackReceived : 1; //!< ACK received + bool ATCenabled : 1; //!< ATC enabled + bool listenModeEnabled : 1; //!< Listen mode enabled + bool reserved : 1; //!< Reserved } rfm69_internal_t; -#if defined(MY_RFM69_ENABLE_LISTENMODE) -uint8_t rxListenCoef; -uint8_t rxListenResolution; -uint8_t idleListenCoef; -uint8_t idleListenResolution; -uint32_t listenCycleDurationUs; -#endif - #define LOCAL static //!< static +/** +* @brief RFM69_handler +*/ +LOCAL void RFM69_handler(void); + +/** +* @brief Clear flags and FIFO +*/ +LOCAL void RFM69_clearFIFO(void); + +/** +* @brief Check for channel activity +* @return True if channel activity under RFM69_CSMA_LIMIT_DBM +*/ +LOCAL bool RFM69_channelFree(void); + +/** +* @brief RFM69_interruptHandling +*/ +LOCAL void RFM69_interruptHandling(void); + /** * @brief Initialise the driver transport hardware and software * @param frequencyHz Frequency in Hz @@ -346,7 +409,7 @@ LOCAL uint8_t RFM69_getAddress(void); /** * @brief Tests whether a new message is available -* @return True if a new, complete, error-free uncollected message is available to be retreived by @ref RFM69_recv() +* @return True if a new, complete, error-free uncollected message is available to be retreived by @ref RFM69_receive() */ LOCAL bool RFM69_available(void); @@ -356,7 +419,7 @@ LOCAL bool RFM69_available(void); * @param maxBufSize Max buffer size * @return Number of bytes */ -LOCAL uint8_t RFM69_recv(uint8_t* buf, const uint8_t maxBufSize); +LOCAL uint8_t RFM69_receive(uint8_t *buf, const uint8_t maxBufSize); /** * @brief RFM69_sendFrame @@ -364,7 +427,7 @@ LOCAL uint8_t RFM69_recv(uint8_t* buf, const uint8_t maxBufSize); * @param increaseSequenceCounter * @return True if packet sent */ -LOCAL bool RFM69_sendFrame(rfm69_packet_t &packet, const bool increaseSequenceCounter = true); +LOCAL bool RFM69_sendFrame(rfm69_packet_t *packet, const bool increaseSequenceCounter = true); /** * @brief RFM69_send @@ -375,7 +438,7 @@ LOCAL bool RFM69_sendFrame(rfm69_packet_t &packet, const bool increaseSequenceCo * @param increaseSequenceCounter * @return True if frame sent */ -LOCAL bool RFM69_send(const uint8_t recipient, uint8_t* data, const uint8_t len, +LOCAL bool RFM69_send(const uint8_t recipient, uint8_t *data, const uint8_t len, const rfm69_controlFlags_t flags, const bool increaseSequenceCounter = true); /** @@ -396,25 +459,30 @@ LOCAL bool RFM69_setTxPowerLevel(rfm69_powerlevel_t newPowerLevel); * @return power level */ LOCAL rfm69_powerlevel_t RFM69_getTxPowerLevel(void); + /** * @brief Reports the transmitter power output level in percents * @return power level */ LOCAL uint8_t RFM69_getTxPowerPercent(void); + /** * @brief Sets the radio into low-power sleep mode * @return true if sleep mode was successfully entered */ LOCAL bool RFM69_sleep(void); + /** * @brief Sets the radio to standby mode * @return true if standby mode was successfully entered */ LOCAL bool RFM69_standBy(void); + /** * @brief Power down radio (HW) */ LOCAL void RFM69_powerDown(void); + /** * @brief Power up radio (HW) */ @@ -438,7 +506,7 @@ LOCAL void RFM69_sendACK(const uint8_t recipient, const rfm69_sequenceNumber_t s * @param retryWaitTimeMS * @return True if packet successfully sent */ -LOCAL bool RFM69_sendWithRetry(const uint8_t recipient, const void* buffer, +LOCAL bool RFM69_sendWithRetry(const uint8_t recipient, const void *buffer, const uint8_t bufferSize, const uint8_t retries = RFM69_RETRIES, const uint32_t retryWaitTimeMS = RFM69_RETRY_TIMEOUT_MS); @@ -465,6 +533,7 @@ LOCAL int16_t RFM69_getSendingRSSI(void); * @return RSSI Signal strength of last received packet */ LOCAL int16_t RFM69_getReceivingRSSI(void); + /** * @brief RFM69_executeATC * @param currentRSSI @@ -491,12 +560,11 @@ LOCAL bool RFM69_isModeReady(void); */ LOCAL bool RFM69_sanityCheck(void); - /** * @brief RFM69_encrypt Set encryption mode * @param key if key is null, encryption is disabled. Key has to be 16 bytes! */ -LOCAL void RFM69_encrypt(const char* key); +LOCAL void RFM69_encrypt(const char *key); /** * @brief RFM69_setHighPowerRegs @@ -509,7 +577,7 @@ LOCAL void RFM69_setHighPowerRegs(const bool onOff); * @param forceTrigger * @return RSSI (internal format) */ -LOCAL rfm69_RSSI_t RFM69_readRSSI(bool forceTrigger = false); +LOCAL rfm69_RSSI_t RFM69_readRSSI(const bool forceTrigger = false); /** * @brief RFM69_ATCmode @@ -518,96 +586,12 @@ LOCAL rfm69_RSSI_t RFM69_readRSSI(bool forceTrigger = false); */ LOCAL void RFM69_ATCmode(const bool onOff, const int16_t targetRSSI = RFM69_TARGET_RSSI_DBM); -#ifdef MY_DEBUG_VERBOSE_RFM69_REGISTERS /** -* @brief RFM69_readAllRegs Read and display RFM69 register contents +* @brief RFM69_readAllRegs +* Read and display all RFM69 register contents. +* @note define RFM69_REGISTER_DETAIL for register content decoding. */ LOCAL void RFM69_readAllRegs(void); -#endif -// ************************ LISTENMODE SECTION ************************ - -#if defined(MY_RFM69_ENABLE_LISTENMODE) - -/** -* @brief RFM69_listenModeApplyHighSpeedSettings Set high speed settings -*/ -LOCAL void RFM69_listenModeApplyHighSpeedSettings(void); - -/** -* @brief RFM69_ListenModeStart Switch radio to listen Mode in prep for sleep until burst -*/ -LOCAL void RFM69_ListenModeStart(void); - -/** -* @brief RFM69_listenModeEnd Exit listen mode and reinit the radio -* @return -*/ -LOCAL bool RFM69_listenModeEnd(void); - -/** -* @brief RFM69_listenModeReset Reset listen mode -*/ -LOCAL void RFM69_listenModeReset(void); - -/** -* @brief RFM69_reinitRadio Restore previous radio settigns for normal mode -* @return -*/ -LOCAL bool RFM69_reinitRadio(void); - -/** -* @brief RFM69_listenModeSendBurst This repeatedly sends the message to the target node for - * the duration of an entire listen cycle. The amount of time remaining in the burst is - * transmitted to the receiver, and it is expected that the receiver - * wait for the burst to end before attempting a reply. -* @param recipient -* @param data -* @param len -*/ -LOCAL void RFM69_listenModeSendBurst(const uint8_t recipient, uint8_t* data, const uint8_t len); - -/** -* @brief getUsForResolution -* @param resolution -* @return -*/ -LOCAL uint32_t RFM69_getUsForResolution(uint8_t resolution); - -/** -* @brief getCoefForResolution -* @param resolution -* @param duration -* @return -*/ -LOCAL uint32_t RFM69_getCoefForResolution(uint8_t resolution, uint32_t duration); - -/** -* @brief RFM69_chooseResolutionAndCoef -* @param resolutions -* @param duration -* @param resolOut -* @param coefOut -* @return -*/ -LOCAL bool RFM69_chooseResolutionAndCoef(uint8_t *resolutions, uint32_t duration, uint8_t& resolOut, - uint8_t& coefOut); - -/** -* @brief RFM69_listenModeSetDurations -* @param rxDuration -* @param idleDuration -* @return -*/ -LOCAL bool RFM69_listenModeSetDurations(uint32_t& rxDuration, uint32_t& idleDuration); - -/** -* @brief RFM69_listenModeGetDurations -* @param rxDuration -* @param idleDuration -*/ -LOCAL void RFM69_listenModeGetDurations(uint32_t &rxDuration, uint32_t &idleDuration); - -#endif #endif diff --git a/drivers/RFM69/new/RFM69registers_new.h b/drivers/RFM69/new/RFM69registers_new.h index 19af8ea..2c2dade 100644 --- a/drivers/RFM69/new/RFM69registers_new.h +++ b/drivers/RFM69/new/RFM69registers_new.h @@ -6,7 +6,7 @@ * network topology allowing messages to be routed to nodes. * * Created by Henrik Ekblad - * Copyright (C) 2013-2016 Sensnology AB + * Copyright (C) 2013-2018 Sensnology AB * Full contributor list: https://github.com/mysensors/Arduino/graphs/contributors * * Documentation: http://www.mysensors.org @@ -16,20 +16,20 @@ * modify it under the terms of the GNU General Public License * version 2 as published by the Free Software Foundation. * - * RFM69 driver refactored for Mysensors + * RFM69 driver refactored for MySensors * * Based on : * - LowPowerLab RFM69 Lib Copyright Felix Rusu (2014), felix@lowpowerlab.com * - Automatic Transmit Power Control class derived from RFM69 library. * Discussion and details in this forum post: https://lowpowerlab.com/forum/index.php/topic,688.0.html * Copyright Thomas Studwell (2014,2015) - * - Mysensors generic radio driver implementation, Copyright (C) 2017 Olivier Mauti + * - MySensors generic radio driver implementation Copyright (C) 2017, 2018 Olivier Mauti * * Changes by : @tekka, @scalz, @marceloagno * * Definitions for Semtech SX1231/H radios: - * http://www.semtech.com/images/datasheet/sx1231.pdf - * http://www.semtech.com/images/datasheet/sx1231h.pdf + * https://www.semtech.com/uploads/documents/sx1231.pdf + * https://www.semtech.com/uploads/documents/sx1231h.pdf */ #define RFM69_REG_FIFO 0x00 @@ -150,71 +150,69 @@ #define RFM69_DATAMODUL_MODULATIONSHAPING_10 0x02 #define RFM69_DATAMODUL_MODULATIONSHAPING_11 0x03 - // RegBitRate (bits/sec) example bit rates #define RFM69_BITRATEMSB_1200 0x68 #define RFM69_BITRATELSB_1200 0x2B +#define RFM69_BITRATEMSB_2000 0x3e +#define RFM69_BITRATELSB_2000 0x80 #define RFM69_BITRATEMSB_2400 0x34 #define RFM69_BITRATELSB_2400 0x15 #define RFM69_BITRATEMSB_4800 0x1A // Default #define RFM69_BITRATELSB_4800 0x0B // Default #define RFM69_BITRATEMSB_9600 0x0D #define RFM69_BITRATELSB_9600 0x05 -#define RFM69_BITRATEMSB_19200 0x06 -#define RFM69_BITRATELSB_19200 0x83 -#define RFM69_BITRATEMSB_38400 0x03 -#define RFM69_BITRATELSB_38400 0x41 - -#define RFM69_BITRATEMSB_38323 0x03 -#define RFM69_BITRATELSB_38323 0x43 - -#define RFM69_BITRATEMSB_34482 0x03 -#define RFM69_BITRATELSB_34482 0xA0 - -#define RFM69_BITRATEMSB_76800 0x01 -#define RFM69_BITRATELSB_76800 0xA1 -#define RFM69_BITRATEMSB_153600 0x00 -#define RFM69_BITRATELSB_153600 0xD0 -#define RFM69_BITRATEMSB_57600 0x02 -#define RFM69_BITRATELSB_57600 0x2C -#define RFM69_BITRATEMSB_115200 0x01 -#define RFM69_BITRATELSB_115200 0x16 #define RFM69_BITRATEMSB_12500 0x0A #define RFM69_BITRATELSB_12500 0x00 +#define RFM69_BITRATEMSB_19200 0x06 +#define RFM69_BITRATELSB_19200 0x83 #define RFM69_BITRATEMSB_25000 0x05 #define RFM69_BITRATELSB_25000 0x00 +#define RFM69_BITRATEMSB_32768 0x03 +#define RFM69_BITRATELSB_32768 0xD1 +#define RFM69_BITRATEMSB_38400 0x03 +#define RFM69_BITRATELSB_38400 0x41 #define RFM69_BITRATEMSB_50000 0x02 #define RFM69_BITRATELSB_50000 0x80 +#define RFM69_BITRATEMSB_55555 0x02 +#define RFM69_BITRATELSB_55555 0x40 +#define RFM69_BITRATEMSB_57600 0x02 +#define RFM69_BITRATELSB_57600 0x2C +#define RFM69_BITRATEMSB_76800 0x01 +#define RFM69_BITRATELSB_76800 0xA1 #define RFM69_BITRATEMSB_100000 0x01 #define RFM69_BITRATELSB_100000 0x40 +#define RFM69_BITRATEMSB_115200 0x01 +#define RFM69_BITRATELSB_115200 0x16 +#define RFM69_BITRATEMSB_125000 0x01 +#define RFM69_BITRATELSB_125000 0x00 #define RFM69_BITRATEMSB_150000 0x00 #define RFM69_BITRATELSB_150000 0xD5 +#define RFM69_BITRATEMSB_153600 0x00 +#define RFM69_BITRATELSB_153600 0xD0 #define RFM69_BITRATEMSB_200000 0x00 #define RFM69_BITRATELSB_200000 0xA0 #define RFM69_BITRATEMSB_250000 0x00 #define RFM69_BITRATELSB_250000 0x80 #define RFM69_BITRATEMSB_300000 0x00 #define RFM69_BITRATELSB_300000 0x6B -#define RFM69_BITRATEMSB_32768 0x03 -#define RFM69_BITRATELSB_32768 0xD1 -// custom bit rates -#define RFM69_BITRATEMSB_55555 0x02 -#define RFM69_BITRATELSB_55555 0x40 -#define RFM69_BITRATEMSB_200KBPS 0x00 -#define RFM69_BITRATELSB_200KBPS 0xa0 - // RegFdev - frequency deviation (Hz) #define RFM69_FDEVMSB_2000 0x00 #define RFM69_FDEVLSB_2000 0x21 +#define RFM69_FDEVMSB_4800 0x00 +#define RFM69_FDEVLSB_4800 0x4f #define RFM69_FDEVMSB_5000 0x00 // Default #define RFM69_FDEVLSB_5000 0x52 // Default #define RFM69_FDEVMSB_7500 0x00 #define RFM69_FDEVLSB_7500 0x7B +#define RFM69_FDEVMSB_9600 0x00 +#define RFM69_FDEVLSB_9600 0x9d #define RFM69_FDEVMSB_10000 0x00 #define RFM69_FDEVLSB_10000 0xA4 #define RFM69_FDEVMSB_15000 0x00 #define RFM69_FDEVLSB_15000 0xF6 +#define RFM69_FDEVMSB_19200 0x01 +#define RFM69_FDEVLSB_19200 0x3b #define RFM69_FDEVMSB_20000 0x01 #define RFM69_FDEVLSB_20000 0x48 #define RFM69_FDEVMSB_25000 0x01 @@ -223,6 +221,8 @@ #define RFM69_FDEVLSB_30000 0xEC #define RFM69_FDEVMSB_35000 0x02 #define RFM69_FDEVLSB_35000 0x3D +#define RFM69_FDEVMSB_38400 0x02 +#define RFM69_FDEVLSB_38400 0x75 #define RFM69_FDEVMSB_40000 0x02 #define RFM69_FDEVLSB_40000 0x8F #define RFM69_FDEVMSB_45000 0x02 @@ -239,6 +239,8 @@ #define RFM69_FDEVLSB_70000 0x7B #define RFM69_FDEVMSB_75000 0x04 #define RFM69_FDEVLSB_75000 0xCD +#define RFM69_FDEVMSB_76800 0x04 +#define RFM69_FDEVLSB_76800 0xea #define RFM69_FDEVMSB_80000 0x05 #define RFM69_FDEVLSB_80000 0x1F #define RFM69_FDEVMSB_85000 0x05 @@ -253,6 +255,8 @@ #define RFM69_FDEVLSB_110000 0x0A #define RFM69_FDEVMSB_120000 0x07 #define RFM69_FDEVLSB_120000 0xAE +#define RFM69_FDEVMSB_125000 0x08 +#define RFM69_FDEVLSB_125000 0x00 #define RFM69_FDEVMSB_130000 0x08 #define RFM69_FDEVLSB_130000 0x52 #define RFM69_FDEVMSB_140000 0x08 @@ -290,7 +294,7 @@ #define RFM69_FDEVMSB_300000 0x13 #define RFM69_FDEVLSB_300000 0x33 -#define RFM69_NOP 0x00 +#define RFM69_NOP 0x00 // RegOsc1 #define RFM69_OSC1_RCCAL_START 0x80 diff --git a/hal/transport/RFM69/MyTransportRFM69.cpp b/hal/transport/RFM69/MyTransportRFM69.cpp index 7cc6973..b35f3ba 100644 --- a/hal/transport/RFM69/MyTransportRFM69.cpp +++ b/hal/transport/RFM69/MyTransportRFM69.cpp @@ -25,8 +25,8 @@ bool transportInit(void) { const bool result = RFM69_initialise(MY_RFM69_FREQUENCY); #if defined(MY_GATEWAY_FEATURE) || defined(MY_RFM69_ATC_MODE_DISABLED) - // ATC mode disabled on GW - RFM69_ATCmode(false); + // ATC mode function not used + (void)RFM69_ATCmode; #else RFM69_ATCmode(true, MY_RFM69_ATC_TARGET_RSSI_DBM); #endif @@ -41,6 +41,8 @@ bool transportInit(void) #endif RFM69_encrypt((const char*)RFM69_psk); (void)memset(RFM69_psk, 0, 16); // Make sure it is purged from memory when set +#else + (void)RFM69_encrypt; #endif return result; } @@ -66,6 +68,7 @@ bool transportSend(const uint8_t to, const void* data, uint8_t len, const bool n bool transportAvailable(void) { + RFM69_handler(); return RFM69_available(); } @@ -76,7 +79,7 @@ bool transportSanityCheck(void) uint8_t transportReceive(void* data) { - return RFM69_recv((uint8_t*)data, MAX_MESSAGE_LENGTH); + return RFM69_receive((uint8_t*)data, MAX_MESSAGE_LENGTH); } void transportSleep(void)