MySmartHome/MySensors
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Transport update (#722)

Browse Source 
* Major transport rework

* Adjust signal report calculations

* Minor driver optimizations

* Implement sanity check in legacy RFM69 driver

* Additional RFM69 rework

* RFM95 encryption

* Polishing
This commit is contained in:
Olivier
2017-03-28 20:31:08 +02:00
committed by Henrik Ekblad
parent 63b8d935c8
commit b132a8a81e
37 changed files with 5986 additions and 1063 deletions
Download Patch File Download Diff File Expand all files Collapse all files
drivers/RF24/RF24.cpp
+150 -81
View File
@@ -6,7 +6,7 @@
* network topology allowing messages to be routed to nodes.
*
* Created by Henrik Ekblad <henrik.ekblad@mysensors.org>
* Copyright (C) 2013-2015 Sensnology AB
* Copyright (C) 2013-2017 Sensnology AB
* Full contributor list: https://github.com/mysensors/Arduino/graphs/contributors
*
* Documentation: http://www.mysensors.org
@@ -17,13 +17,20 @@
* version 2 as published by the Free Software Foundation.
*
* Based on maniacbug's RF24 library, copyright (C) 2011 J. Coliz <maniacbug@ymail.com>
* RF24 driver refactored and optimized for speed and size, copyright (C) 2016 Olivier Mauti <olivier@mysensors.org>
* RF24 driver refactored and optimized for speed and size, copyright (C) 2017 Olivier Mauti <olivier@mysensors.org>
*/
#include "RF24.h"
LOCAL uint8_t MY_RF24_BASE_ADDR[MY_RF24_ADDR_WIDTH] = { MY_RF24_BASE_RADIO_ID };
LOCAL uint8_t MY_RF24_NODE_ADDRESS = AUTO;
// debug output
#if defined(MY_DEBUG_VERBOSE_RF24)
#define RF24_DEBUG(x,...) DEBUG_OUTPUT(x, ##__VA_ARGS__) //!< DEBUG
#else
#define RF24_DEBUG(x,...) //!< DEBUG null
#endif
LOCAL uint8_t RF24_BASE_ID[MY_RF24_ADDR_WIDTH] = { MY_RF24_BASE_RADIO_ID };
LOCAL uint8_t RF24_NODE_ADDRESS = RF24_BROADCAST_ADDRESS;
#if defined(MY_RX_MESSAGE_BUFFER_FEATURE)
LOCAL RF24_receiveCallbackType RF24_receiveCallback = NULL;
@@ -45,13 +52,13 @@ LOCAL void RF24_ce(const bool level)
}
LOCAL uint8_t RF24_spiMultiByteTransfer(const uint8_t cmd, uint8_t* buf, uint8_t len,
const bool aReadMode)
const bool readMode)
{
uint8_t status;
uint8_t* current = buf;
#if !defined(MY_SOFTSPI)
_SPI.beginTransaction(SPISettings(MY_RF24_SPI_MAX_SPEED, MY_RF24_SPI_DATA_ORDER,
MY_RF24_SPI_DATA_MODE));
#if !defined(MY_SOFTSPI) && defined(SPI_HAS_TRANSACTION)
_SPI.beginTransaction(SPISettings(MY_RF24_SPI_SPEED, RF24_SPI_DATA_ORDER,
RF24_SPI_DATA_MODE));
#endif
RF24_csn(LOW);
// timing
@@ -63,14 +70,14 @@ LOCAL uint8_t RF24_spiMultiByteTransfer(const uint8_t cmd, uint8_t* buf, uint8_t
*ptx++ = cmd;
while ( len-- ) {
if (aReadMode) {
*ptx++ = RF24_NOP;
if (readMode) {
*ptx++ = RF24_CMD_NOP;
} else {
*ptx++ = *current++;
}
}
_SPI.transfernb( (char *) spi_txbuff, (char *) spi_rxbuff, size);
if (aReadMode) {
if (readMode) {
if (size == 2) {
status = *++prx; // result is 2nd byte of receive buffer
} else {
@@ -86,8 +93,8 @@ LOCAL uint8_t RF24_spiMultiByteTransfer(const uint8_t cmd, uint8_t* buf, uint8_t
#else
status = _SPI.transfer(cmd);
while ( len-- ) {
if (aReadMode) {
status = _SPI.transfer(RF24_NOP);
if (readMode) {
status = _SPI.transfer(RF24_CMD_NOP);
if (buf != NULL) {
*current++ = status;
}
@@ -97,7 +104,7 @@ LOCAL uint8_t RF24_spiMultiByteTransfer(const uint8_t cmd, uint8_t* buf, uint8_t
}
#endif
RF24_csn(HIGH);
#if !defined(MY_SOFTSPI)
#if !defined(MY_SOFTSPI) && defined(SPI_HAS_TRANSACTION)
_SPI.endTransaction();
#endif
// timing
@@ -113,86 +120,87 @@ LOCAL uint8_t RF24_spiByteTransfer(const uint8_t cmd)
LOCAL uint8_t RF24_RAW_readByteRegister(const uint8_t cmd)
{
const uint8_t value = RF24_spiMultiByteTransfer(cmd, NULL, 1, true);
RF24_DEBUG(PSTR("RF24:read register, reg=%d, value=%d\n"), cmd & RF24_REGISTER_MASK, value);
RF24_DEBUG(PSTR("RF24:RBR:REG=%d,VAL=%d\n"), cmd & RF24_REGISTER_MASK, value);
return value;
}
LOCAL uint8_t RF24_RAW_writeByteRegister(const uint8_t cmd, uint8_t value)
{
RF24_DEBUG(PSTR("RF24:write register, reg=%d, value=%d\n"), cmd & RF24_REGISTER_MASK, value);
RF24_DEBUG(PSTR("RF24:WBR:REG=%d,VAL=%d\n"), cmd & RF24_REGISTER_MASK, value);
return RF24_spiMultiByteTransfer( cmd , &value, 1, false);
}
LOCAL void RF24_flushRX(void)
{
RF24_DEBUG(PSTR("RF24:flushRX\n"));
RF24_spiByteTransfer(RF24_FLUSH_RX);
RF24_DEBUG(PSTR("RF24:FRX\n"));
RF24_spiByteTransfer(RF24_CMD_FLUSH_RX);
}
LOCAL void RF24_flushTX(void)
{
RF24_DEBUG(PSTR("RF24:flushTX\n"));
RF24_spiByteTransfer(RF24_FLUSH_TX);
RF24_DEBUG(PSTR("RF24:FTX\n"));
RF24_spiByteTransfer(RF24_CMD_FLUSH_TX);
}
LOCAL uint8_t RF24_getStatus(void)
{
return RF24_spiByteTransfer(RF24_NOP);
return RF24_spiByteTransfer(RF24_CMD_NOP);
}
LOCAL uint8_t RF24_getFIFOStatus(void)
{
return RF24_readByteRegister(RF24_FIFO_STATUS);
return RF24_readByteRegister(RF24_REG_FIFO_STATUS);
}
LOCAL void RF24_setChannel(const uint8_t channel)
{
RF24_writeByteRegister(RF24_RF_CH,channel);
RF24_writeByteRegister(RF24_REG_RF_CH,channel);
}
LOCAL void RF24_setRetries(const uint8_t retransmitDelay, const uint8_t retransmitCount)
{
RF24_writeByteRegister(RF24_SETUP_RETR, retransmitDelay << RF24_ARD | retransmitCount << RF24_ARC);
RF24_writeByteRegister(RF24_REG_SETUP_RETR,
retransmitDelay << RF24_ARD | retransmitCount << RF24_ARC);
}
LOCAL void RF24_setAddressWidth(const uint8_t width)
LOCAL void RF24_setAddressWidth(const uint8_t addressWidth)
{
RF24_writeByteRegister(RF24_SETUP_AW, width - 2);
RF24_writeByteRegister(RF24_REG_SETUP_AW, addressWidth - 2);
}
LOCAL void RF24_setRFSetup(const uint8_t RFsetup)
{
RF24_writeByteRegister(RF24_RF_SETUP, RFsetup);
RF24_writeByteRegister(RF24_REG_RF_SETUP, RFsetup);
}
LOCAL void RF24_setFeature(const uint8_t feature)
{
RF24_writeByteRegister(RF24_FEATURE, feature);
RF24_writeByteRegister(RF24_REG_FEATURE, feature);
}
LOCAL void RF24_setPipe(const uint8_t pipe)
{
RF24_writeByteRegister(RF24_EN_RXADDR, pipe);
RF24_writeByteRegister(RF24_REG_EN_RXADDR, pipe);
}
LOCAL void RF24_setAutoACK(const uint8_t pipe)
{
RF24_writeByteRegister(RF24_EN_AA, pipe);
RF24_writeByteRegister(RF24_REG_EN_AA, pipe);
}
LOCAL void RF24_setDynamicPayload(const uint8_t pipe)
{
RF24_writeByteRegister(RF24_DYNPD, pipe);
RF24_writeByteRegister(RF24_REG_DYNPD, pipe);
}
LOCAL void RF24_setRFConfiguration(const uint8_t configuration)
{
RF24_writeByteRegister(RF24_NRF_CONFIG, configuration);
RF24_writeByteRegister(RF24_REG_NRF_CONFIG, configuration);
}
LOCAL void RF24_setPipeAddress(const uint8_t pipe, uint8_t* address, const uint8_t width)
LOCAL void RF24_setPipeAddress(const uint8_t pipe, uint8_t* address, const uint8_t addressWidth)
{
RF24_writeMultiByteRegister(pipe, address, width);
RF24_writeMultiByteRegister(pipe, address, addressWidth);
}
LOCAL void RF24_setPipeLSB(const uint8_t pipe, const uint8_t LSB)
@@ -202,34 +210,34 @@ LOCAL void RF24_setPipeLSB(const uint8_t pipe, const uint8_t LSB)
LOCAL uint8_t RF24_getObserveTX(void)
{
return RF24_readByteRegister(RF24_OBSERVE_TX);
return RF24_readByteRegister(RF24_REG_OBSERVE_TX);
}
LOCAL void RF24_setStatus(const uint8_t status)
{
RF24_writeByteRegister(RF24_STATUS, status);
RF24_writeByteRegister(RF24_REG_STATUS, status);
}
LOCAL void RF24_enableFeatures(void)
{
RF24_RAW_writeByteRegister(RF24_ACTIVATE, 0x73);
RF24_RAW_writeByteRegister(RF24_CMD_ACTIVATE, 0x73);
}
LOCAL void RF24_openWritingPipe(const uint8_t recipient)
{
RF24_DEBUG(PSTR("RF24:OPEN WPIPE,RCPT=%d\n"), recipient); // open writing pipe
RF24_DEBUG(PSTR("RF24:OWP:RCPT=%d\n"), recipient); // open writing pipe
// only write LSB of RX0 and TX pipe
RF24_setPipeLSB(RF24_RX_ADDR_P0, recipient);
RF24_setPipeLSB(RF24_TX_ADDR, recipient);
RF24_setPipeLSB(RF24_REG_RX_ADDR_P0, recipient);
RF24_setPipeLSB(RF24_REG_TX_ADDR, recipient);
}
LOCAL void RF24_startListening(void)
{
RF24_DEBUG(PSTR("RF24:STRT LIS\n")); // start listening
RF24_DEBUG(PSTR("RF24:STL\n")); // start listening
// toggle PRX
RF24_setRFConfiguration(MY_RF24_CONFIGURATION | _BV(RF24_PWR_UP) | _BV(RF24_PRIM_RX) );
// all RX pipe addresses must be unique, therefore skip if node ID is AUTO
if(MY_RF24_NODE_ADDRESS!=AUTO) {
RF24_setPipeLSB(RF24_RX_ADDR_P0, MY_RF24_NODE_ADDRESS);
RF24_setRFConfiguration(RF24_CONFIGURATION | _BV(RF24_PWR_UP) | _BV(RF24_PRIM_RX) );
// all RX pipe addresses must be unique, therefore skip if node ID is RF24_BROADCAST_ADDRESS
if(RF24_NODE_ADDRESS!= RF24_BROADCAST_ADDRESS) {
RF24_setPipeLSB(RF24_REG_RX_ADDR_P0, RF24_NODE_ADDRESS);
}
// start listening
RF24_ce(HIGH);
@@ -237,35 +245,59 @@ LOCAL void RF24_startListening(void)
LOCAL void RF24_stopListening(void)
{
RF24_DEBUG(PSTR("RF24:STP LIS\n")); // stop listening
RF24_DEBUG(PSTR("RF24:SPL\n")); // stop listening
RF24_ce(LOW);
// timing
delayMicroseconds(130);
RF24_setRFConfiguration(MY_RF24_CONFIGURATION | _BV(RF24_PWR_UP) );
RF24_setRFConfiguration(RF24_CONFIGURATION | _BV(RF24_PWR_UP) );
// timing
delayMicroseconds(100);
}
LOCAL void RF24_powerDown(void)
{
RF24_ce(LOW);
RF24_setRFConfiguration(MY_RF24_CONFIGURATION);
RF24_DEBUG(PSTR("RF24:PD\n")); // power down
#if defined(MY_RF24_POWER_PIN)
hwDigitalWrite(MY_RF24_POWER_PIN, LOW);
#endif
}
LOCAL bool RF24_sendMessage(const uint8_t recipient, const void* buf, const uint8_t len)
LOCAL void RF24_powerUp(void)
{
#if defined(MY_RF24_POWER_PIN)
hwDigitalWrite(MY_RF24_POWER_PIN, HIGH);
delay(RF24_POWERUP_DELAY_MS); // allow VCC to settle
#endif
}
LOCAL void RF24_sleep(void)
{
RF24_DEBUG(PSTR("RF24:SLP\n")); // put radio to sleep
RF24_ce(LOW);
RF24_setRFConfiguration(RF24_CONFIGURATION);
}
LOCAL void RF24_standBy(void)
{
RF24_DEBUG(PSTR("RF24:SBY\n")); // put radio to standby
RF24_ce(LOW);
RF24_setRFConfiguration(RF24_CONFIGURATION | _BV(RF24_PWR_UP));
}
LOCAL bool RF24_sendMessage(const uint8_t recipient, const void* buf, const uint8_t len,
const bool noACK)
{
uint8_t RF24_status;
RF24_stopListening();
RF24_openWritingPipe( recipient );
RF24_DEBUG(PSTR("RF24:SND:TO=%d,LEN=%d\n"),recipient,len); // send message
RF24_DEBUG(PSTR("RF24:TXM:TO=%d,LEN=%d\n"),recipient,len); // send message
// flush TX FIFO
RF24_flushTX();
// this command is affected in clones (e.g. Si24R1): flipped NoACK bit when using W_TX_PAYLOAD_NO_ACK / W_TX_PAYLOAD
// AutoACK is disabled on the broadcasting pipe - NO_ACK prevents resending
RF24_spiMultiByteTransfer(recipient == BROADCAST_ADDRESS ? RF24_WRITE_TX_PAYLOAD_NO_ACK :
RF24_WRITE_TX_PAYLOAD, (uint8_t*)buf, len, false );
// go, TX starts after ~10us
RF24_spiMultiByteTransfer((recipient == RF24_BROADCAST_ADDRESS ||
noACK) ? RF24_CMD_WRITE_TX_PAYLOAD_NO_ACK :
RF24_CMD_WRITE_TX_PAYLOAD, (uint8_t*)buf, len, false );
// go, TX starts after ~10us, CE high also enables PA+LNA on supported HW
RF24_ce(HIGH);
// timeout counter to detect HW issues
uint16_t timeout = 0xFFFF;
@@ -279,20 +311,20 @@ LOCAL bool RF24_sendMessage(const uint8_t recipient, const void* buf, const uint
// Max retries exceeded
if(RF24_status & _BV(RF24_MAX_RT)) {
// flush packet
RF24_DEBUG(PSTR("!RF24:SND:MAX_RT\n")); // max retries, no ACK
RF24_DEBUG(PSTR("!RF24:TXM:MAX_RT\n")); // max retries, no ACK
RF24_flushTX();
}
RF24_startListening();
// true if message sent
return (RF24_status & _BV(RF24_TX_DS));
return (RF24_status & _BV(RF24_TX_DS) || noACK);
}
LOCAL uint8_t RF24_getDynamicPayloadSize(void)
{
uint8_t result = RF24_spiMultiByteTransfer(RF24_READ_RX_PL_WID, NULL, 1, true);
uint8_t result = RF24_spiMultiByteTransfer(RF24_CMD_READ_RX_PL_WID, NULL, 1, true);
// check if payload size invalid
if(result > 32) {
RF24_DEBUG(PSTR("!RF24:GDP:PAYL LEN INVALID=%d\n"),result); // payload len invalid
RF24_DEBUG(PSTR("!RF24:GDP:PYL INV\n")); // payload len invalid
RF24_flushRX();
result = 0;
}
@@ -308,8 +340,8 @@ LOCAL bool RF24_isDataAvailable(void)
LOCAL uint8_t RF24_readMessage(void* buf)
{
const uint8_t len = RF24_getDynamicPayloadSize();
RF24_DEBUG(PSTR("RF24:RDM:MSG LEN=%d\n"), len); // read message
RF24_spiMultiByteTransfer(RF24_READ_RX_PAYLOAD,(uint8_t*)buf,len,true);
RF24_DEBUG(PSTR("RF24:RXM:LEN=%d\n"), len); // read message
RF24_spiMultiByteTransfer(RF24_CMD_READ_RX_PAYLOAD,(uint8_t*)buf,len,true);
// clear RX interrupt
RF24_setStatus(_BV(RF24_RX_DR));
return len;
@@ -317,8 +349,8 @@ LOCAL uint8_t RF24_readMessage(void* buf)
LOCAL void RF24_setNodeAddress(const uint8_t address)
{
if(address!=AUTO) {
MY_RF24_NODE_ADDRESS = address;
if(address!= RF24_BROADCAST_ADDRESS) {
RF24_NODE_ADDRESS = address;
// enable node pipe
RF24_setPipe(_BV(RF24_ERX_P0 + RF24_BROADCAST_PIPE) | _BV(RF24_ERX_P0));
// enable autoACK on pipe 0
@@ -328,14 +360,47 @@ LOCAL void RF24_setNodeAddress(const uint8_t address)
LOCAL uint8_t RF24_getNodeID(void)
{
return MY_RF24_NODE_ADDRESS;
return RF24_NODE_ADDRESS;
}
LOCAL bool RF24_sanityCheck(void)
{
// detect HW defect, configuration errors or interrupted SPI line, CE disconnect cannot be detected
return (RF24_readByteRegister(RF24_RF_SETUP) == MY_RF24_RF_SETUP) & (RF24_readByteRegister(
RF24_RF_CH) == MY_RF24_CHANNEL);
return (RF24_readByteRegister(RF24_REG_RF_SETUP) == RF24_RF_SETUP) & (RF24_readByteRegister(
RF24_REG_RF_CH) == MY_RF24_CHANNEL);
}
LOCAL int16_t RF24_getTxPowerLevel(void)
{
// in dBm
return (int16_t)((-6) * (3-((RF24_readByteRegister(RF24_REG_RF_SETUP) >> 1) & 3)));
}
LOCAL uint8_t RF24_getTxPowerPercent(void)
{
// report TX level in %, 0 (LOW) = 25%, 3 (MAX) = 100
const uint8_t result = 25 + (((RF24_readByteRegister(RF24_REG_RF_SETUP) >> 2) & 3) * 25);
return result;
}
LOCAL bool RF24_setTxPowerLevel(const uint8_t newPowerLevel)
{
const uint8_t registerContent = RF24_readByteRegister(RF24_REG_RF_SETUP);
RF24_writeByteRegister(RF24_REG_RF_SETUP, (registerContent & 0xF9) | ((newPowerLevel & 3) << 1));
RF24_DEBUG(PSTR("RF24:STX:LEVEL=%d\n"), newPowerLevel);
return true;
}
LOCAL bool RF24_setTxPowerPercent(const uint8_t newPowerPercent)
{
const uint8_t newPowerLevel = static_cast<uint8_t>(RF24_MIN_POWER_LEVEL + (RF24_MAX_POWER_LEVEL
- RF24_MIN_POWER_LEVEL) * (newPowerPercent / 100.0f));
return RF24_setTxPowerLevel(newPowerLevel);
}
LOCAL int16_t RF24_getSendingRSSI(void)
{
// calculate pseudo-RSSI based on retransmission counter (ARC)
// min -104dBm at 250kBps
// Arbitrary definition: ARC 0 == -29, ARC 15 = -104
return static_cast<int16_t>(-29 - (8 * (RF24_getObserveTX() & 0xF)));
}
#if defined(MY_RX_MESSAGE_BUFFER_FEATURE)
@@ -381,19 +446,23 @@ LOCAL void RF24_registerReceiveCallback(RF24_receiveCallbackType cb)
LOCAL bool RF24_initialize(void)
{
// prevent warning
(void)RF24_getObserveTX;
// Initialize pins
hwPinMode(MY_RF24_CE_PIN,OUTPUT);
hwPinMode(MY_RF24_CS_PIN,OUTPUT);
RF24_DEBUG(PSTR("RF24:INIT\n"));
RF24_DEBUG(PSTR("RF24:INIT:PIN,CE=%d,CS=%d\n"), MY_RF24_CE_PIN, MY_RF24_CS_PIN);
// Initialize pins & HW
#if defined(MY_RF24_POWER_PIN)
hwPinMode(MY_RF24_POWER_PIN, OUTPUT);
#endif
RF24_powerUp();
#if defined(MY_RX_MESSAGE_BUFFER_FEATURE)
hwPinMode(MY_RF24_IRQ_PIN,INPUT);
#endif
// Initialize SPI
_SPI.begin();
hwPinMode(MY_RF24_CE_PIN, OUTPUT);
hwPinMode(MY_RF24_CS_PIN, OUTPUT);
RF24_ce(LOW);
RF24_csn(HIGH);
// Initialize SPI
_SPI.begin();
#if defined(MY_RX_MESSAGE_BUFFER_FEATURE)
// assure SPI can be used from interrupt context
// Note: ESP8266 & SoftSPI currently do not support interrupt usage for SPI,
@@ -403,7 +472,7 @@ LOCAL bool RF24_initialize(void)
attachInterrupt(digitalPinToInterrupt(MY_RF24_IRQ_PIN), RF24_irqHandler, FALLING);
#endif
// CRC and power up
RF24_setRFConfiguration(MY_RF24_CONFIGURATION | _BV(RF24_PWR_UP)) ;
RF24_setRFConfiguration(RF24_CONFIGURATION | _BV(RF24_PWR_UP)) ;
// settle >2ms
delay(5);
// set address width
@@ -413,11 +482,11 @@ LOCAL bool RF24_initialize(void)
// set channel
RF24_setChannel(MY_RF24_CHANNEL);
// set data rate and pa level
RF24_setRFSetup(MY_RF24_RF_SETUP);
RF24_setRFSetup(RF24_RF_SETUP);
// toggle features (necessary on some clones and non-P versions)
RF24_enableFeatures();
// enable ACK payload and dynamic payload
RF24_setFeature(MY_RF24_FEATURE);
RF24_setFeature(RF24_FEATURE);
// sanity check (this function is P/non-P independent)
if (!RF24_sanityCheck()) {
RF24_DEBUG(PSTR("!RF24:INIT:SANCHK FAIL\n")); // sanity check failed, check wiring or replace module
@@ -430,12 +499,12 @@ LOCAL bool RF24_initialize(void)
// enable dynamic payloads on used pipes
RF24_setDynamicPayload(_BV(RF24_DPL_P0 + RF24_BROADCAST_PIPE) | _BV(RF24_DPL_P0));
// listen to broadcast pipe
MY_RF24_BASE_ADDR[0] = BROADCAST_ADDRESS;
RF24_setPipeAddress(RF24_RX_ADDR_P0 + RF24_BROADCAST_PIPE, (uint8_t*)&MY_RF24_BASE_ADDR,
RF24_BASE_ID[0] = RF24_BROADCAST_ADDRESS;
RF24_setPipeAddress(RF24_REG_RX_ADDR_P0 + RF24_BROADCAST_PIPE, (uint8_t*)&RF24_BASE_ID,
RF24_BROADCAST_PIPE > 1 ? 1 : MY_RF24_ADDR_WIDTH);
// pipe 0, set full address, later only LSB is updated
RF24_setPipeAddress(RF24_RX_ADDR_P0, (uint8_t*)&MY_RF24_BASE_ADDR, MY_RF24_ADDR_WIDTH);
RF24_setPipeAddress(RF24_TX_ADDR, (uint8_t*)&MY_RF24_BASE_ADDR, MY_RF24_ADDR_WIDTH);
RF24_setPipeAddress(RF24_REG_RX_ADDR_P0, (uint8_t*)&RF24_BASE_ID, MY_RF24_ADDR_WIDTH);
RF24_setPipeAddress(RF24_REG_TX_ADDR, (uint8_t*)&RF24_BASE_ID, MY_RF24_ADDR_WIDTH);
// reset FIFO
RF24_flushRX();
RF24_flushTX();
drivers/RF24/RF24.h
+291 -171
View File
@@ -6,7 +6,7 @@
* network topology allowing messages to be routed to nodes.
*
* Created by Henrik Ekblad <henrik.ekblad@mysensors.org>
* Copyright (C) 2013-2016 Sensnology AB
* Copyright (C) 2013-2017 Sensnology AB
* Full contributor list: https://github.com/mysensors/Arduino/graphs/contributors
*
* Documentation: http://www.mysensors.org
@@ -17,45 +17,102 @@
* version 2 as published by the Free Software Foundation.
*
* Based on maniacbug's RF24 library, copyright (C) 2011 J. Coliz <maniacbug@ymail.com>
* RF24 driver refactored and optimized for speed and size, copyright (C) 2016 Olivier Mauti <olivier@mysensors.org>
* RF24 driver refactored and optimized for speed and size, copyright (C) 2017 Olivier Mauti <olivier@mysensors.org>
*
* Definitions for Nordic NRF24L01+ radios:
* https://www.nordicsemi.com/eng/Products/2.4GHz-RF/nRF24L01P
*
*/
/**
* @file RF24.h
*
* @defgroup RF24grp RF24
* @ingroup internals
* @{
*
* RF24 driver-related log messages, format: [!]SYSTEM:[SUB SYSTEM:]MESSAGE
* - [!] Exclamation mark is prepended in case of error
*
* |E| SYS | SUB | Message | Comment
* |-|-------|-------|-----------------------------------|---------------------------------------------------------------------
* | | RF24 | INIT | | Initialise RF24 radio
* | | RF24 | INIT | PIN,CE=%d,CS=%d | Pin configuration: chip enable (CE), chip select (CS)
* |!| RF24 | INIT | SANCHK FAIL | Sanity check failed, check wiring or replace module
* | | RF24 | SPP | PCT=%d,TX LEVEL=%d | Set TX level, input TX percent (PCT)
* | | RF24 | RBR | REG=%d,VAL=%d | Read register (REG), value=(VAL)
* | | RF24 | WBR | REG=%d,VAL=%d | Write register (REG), value=(VAL)
* | | RF24 | FRX | | Flush RX buffer
* | | RF24 | FTX | | Flush TX buffer
* | | RF24 | OWP | RCPT=%d | Open writing pipe, recipient=(RCPT)
* | | RF24 | STL | | Start listening
* | | RF24 | SPL | | Stop listening
* | | RF24 | SLP | | Set radio to sleep
* | | RF24 | SBY | | Set radio to standby
* | | RF24 | TXM | TO=%d,LEN=%d | Transmit message to=(TO), length=(LEN)
* |!| RF24 | TXM | MAX_RT | Max TX retries, no ACK received
* |!| RF24 | GDP | PYL INV | Invalid payload size
* | | RF24 | RXM | LEN=%d | Read message, length=(LEN)
* | | RF24 | STX | LEVEL=%d | Set TX level, level=(LEVEL)
*
*/
#ifndef __RF24_H__
#define __RF24_H__
#define LOCAL static
#include "RF24registers.h"
#if defined(ARDUINO_ARCH_AVR)
#define DEFAULT_RF24_CE_PIN (9) //!< DEFAULT_RF24_CE_PIN
#elif defined(ARDUINO_ARCH_ESP8266)
#define DEFAULT_RF24_CE_PIN (4) //!< DEFAULT_RF24_CE_PIN
#elif defined(ARDUINO_ARCH_ESP32)
#warning not implemented yet
#elif defined(ARDUINO_ARCH_SAMD)
#define DEFAULT_RF24_CE_PIN (27) //!< DEFAULT_RF24_CE_PIN
#elif defined(LINUX_ARCH_RASPBERRYPI)
#define DEFAULT_RF24_CE_PIN (22) //!< DEFAULT_RF24_CE_PIN
//#define DEFAULT_RF24_CS_PIN (24) //!< DEFAULT_RF24_CS_PIN
#elif defined(ARDUINO_ARCH_STM32F1)
#define DEFAULT_RF24_CE_PIN (PB0) //!< DEFAULT_RF24_CE_PIN
#else
#define DEFAULT_RF24_CE_PIN (9) //!< DEFAULT_RF24_CE_PIN
#endif
#define DEFAULT_RF24_CS_PIN (SS) //!< DEFAULT_RF24_CS_PIN
#define LOCAL static //!< static
// SPI settings
#if !defined(MY_RF24_SPI_MAX_SPEED)
// default 2Mhz - safe for nRF24L01+ clones
#define MY_RF24_SPI_MAX_SPEED 2000000
#endif
#define MY_RF24_SPI_DATA_ORDER MSBFIRST
#define MY_RF24_SPI_DATA_MODE SPI_MODE0
#define RF24_SPI_DATA_ORDER MSBFIRST //!< RF24_SPI_DATA_ORDER
#define RF24_SPI_DATA_MODE SPI_MODE0 //!< RF24_SPI_DATA_MODE
#if defined (ARDUINO) && !defined (__arm__) && !defined (_SPI)
#define RF24_BROADCAST_ADDRESS (255u) //!< RF24_BROADCAST_ADDRESS
#if defined(ARDUINO) && !defined(__arm__) && !defined(_SPI)
#include <SPI.h>
#if defined(MY_SOFTSPI)
SoftSPI<MY_SOFT_SPI_MISO_PIN, MY_SOFT_SPI_MOSI_PIN, MY_SOFT_SPI_SCK_PIN, MY_RF24_SPI_DATA_MODE>
SoftSPI<MY_SOFT_SPI_MISO_PIN, MY_SOFT_SPI_MOSI_PIN, MY_SOFT_SPI_SCK_PIN, RF24_SPI_DATA_MODE>
_SPI;
#else
#define _SPI SPI
#define _SPI SPI //!< SPI
#endif
#else
#include <stdint.h>
#include <stdio.h>
#include <string.h>
#define _BV(x) (1<<(x))
#define _BV(x) (1<<(x)) //!< _BV()
#if defined(__arm__) || defined(__linux__)
#include <SPI.h>
#else
extern HardwareSPI SPI;
extern HardwareSPI SPI; //!< SPI
#endif
#if !defined(_SPI)
#define _SPI SPI
#define _SPI SPI //!< SPI
#endif
#endif
@@ -84,207 +141,270 @@ extern HardwareSPI SPI;
// RF24 settings
#if defined(MY_RX_MESSAGE_BUFFER_FEATURE)
#define MY_RF24_CONFIGURATION (uint8_t) ((RF24_CRC_16 << 2) | (1 << RF24_MASK_TX_DS) | (1 << RF24_MASK_MAX_RT))
#define RF24_CONFIGURATION (uint8_t) ((RF24_CRC_16 << 2) | (1 << RF24_MASK_TX_DS) | (1 << RF24_MASK_MAX_RT)) //!< MY_RF24_CONFIGURATION
#else
#define MY_RF24_CONFIGURATION (uint8_t) (RF24_CRC_16 << 2)
#define RF24_CONFIGURATION (uint8_t) (RF24_CRC_16 << 2) //!< RF24_CONFIGURATION
#endif
#define MY_RF24_FEATURE (uint8_t)( _BV(RF24_EN_DPL) | _BV(RF24_EN_ACK_PAY) )
#define MY_RF24_RF_SETUP (uint8_t)( ((MY_RF24_DATARATE & 0b10 ) << 4) | ((MY_RF24_DATARATE & 0b01 ) << 3) | (MY_RF24_PA_LEVEL << 1) ) + 1 // +1 for Si24R1
#define RF24_FEATURE (uint8_t)( _BV(RF24_EN_DPL) | _BV(RF24_EN_ACK_PAY) ) //!< RF24_FEATURE
#define RF24_RF_SETUP (uint8_t)( ((MY_RF24_DATARATE & 0b10 ) << 4) | ((MY_RF24_DATARATE & 0b01 ) << 3) | (MY_RF24_PA_LEVEL << 1) ) + 1 //!< RF24_RF_SETUP, +1 for Si24R1 and LNA
// powerup delay
#define RF24_POWERUP_DELAY_MS (100u) //!< Power up delay, allow VCC to settle, transport to become fully operational
// pipes
#define RF24_BROADCAST_PIPE (1)
#define RF24_NODE_PIPE (0)
// debug
#if defined(MY_DEBUG_VERBOSE_RF24)
#define RF24_DEBUG(x,...) debug(x, ##__VA_ARGS__)
#else
#define RF24_DEBUG(x,...)
#endif
// 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)
// ARD, auto retry delay
#define RF24_SET_ARD (5) //=1500us
// ARD, auto retry count
#define RF24_SET_ARC (15)
// nRF24L01(+) register definitions
#define RF24_NRF_CONFIG (0x00)
#define RF24_EN_AA (0x01)
#define RF24_EN_RXADDR (0x02)
#define RF24_SETUP_AW (0x03)
#define RF24_SETUP_RETR (0x04)
#define RF24_RF_CH (0x05)
#define RF24_RF_SETUP (0x06)
#define RF24_STATUS (0x07)
#define RF24_OBSERVE_TX (0x08)
#define RF24_CD (0x09)
#define RF24_RX_ADDR_P0 (0x0A)
#define RF24_RX_ADDR_P1 (0x0B)
#define RF24_RX_ADDR_P2 (0x0C)
#define RF24_RX_ADDR_P3 (0x0D)
#define RF24_RX_ADDR_P4 (0x0E)
#define RF24_RX_ADDR_P5 (0x0F)
#define RF24_TX_ADDR (0x10)
#define RF24_RX_PW_P0 (0x11)
#define RF24_RX_PW_P1 (0x12)
#define RF24_RX_PW_P2 (0x13)
#define RF24_RX_PW_P3 (0x14)
#define RF24_RX_PW_P4 (0x15)
#define RF24_RX_PW_P5 (0x16)
#define RF24_FIFO_STATUS (0x17)
#define RF24_DYNPD (0x1C)
#define RF24_FEATURE (0x1D)
// instructions
#define RF24_READ_REGISTER (0x00)
#define RF24_RPD (0x09)
#define RF24_WRITE_REGISTER (0x20)
#define RF24_REGISTER_MASK (0x1F)
#define RF24_ACTIVATE (0x50)
#define RF24_READ_RX_PL_WID (0x60)
#define RF24_READ_RX_PAYLOAD (0x61)
#define RF24_WRITE_TX_PAYLOAD (0xA0)
#define RF24_WRITE_ACK_PAYLOAD (0xA8)
#define RF24_WRITE_TX_PAYLOAD_NO_ACK (0xB0)
#define RF24_FLUSH_TX (0xE1)
#define RF24_FLUSH_RX (0xE2)
#define RF24_REUSE_TX_PL (0xE3)
#define RF24_NOP (0xFF)
// bit mnemonics
#define RF24_MASK_RX_DR (6)
#define RF24_MASK_TX_DS (5)
#define RF24_MASK_MAX_RT (4)
#define RF24_EN_CRC (3)
#define RF24_CRCO (2)
#define RF24_PWR_UP (1)
#define RF24_PRIM_RX (0)
// auto ACK
#define RF24_ENAA_P5 (5)
#define RF24_ENAA_P4 (4)
#define RF24_ENAA_P3 (3)
#define RF24_ENAA_P2 (2)
#define RF24_ENAA_P1 (1)
#define RF24_ENAA_P0 (0)
// rx pipe
#define RF24_ERX_P5 (5)
#define RF24_ERX_P4 (4)
#define RF24_ERX_P3 (3)
#define RF24_ERX_P2 (2)
#define RF24_ERX_P1 (1)
#define RF24_ERX_P0 (0)
// dynamic payload
#define RF24_DPL_P5 (5)
#define RF24_DPL_P4 (4)
#define RF24_DPL_P3 (3)
#define RF24_DPL_P2 (2)
#define RF24_DPL_P1 (1)
#define RF24_DPL_P0 (0)
#define RF24_AW (0)
#define RF24_ARD (4)
#define RF24_ARC (0)
#define RF24_PLL_LOCK (4)
#define RF24_RF_DR (3)
#define RF24_RF_PWR (6)
#define RF24_RX_DR (6)
#define RF24_TX_DS (5)
#define RF24_MAX_RT (4)
#define RF24_RX_P_NO (1)
#define RF24_TX_FULL (0)
#define RF24_PLOS_CNT (4)
#define RF24_ARC_CNT (0)
#define RF24_TX_REUSE (6)
#define RF24_FIFO_FULL (5)
#define RF24_TX_EMPTY (4)
#define RF24_RX_FULL (1)
#define RF24_RX_EMPTY (0)
// features
#define RF24_EN_DPL (2)
#define RF24_EN_ACK_PAY (1)
#define RF24_EN_DYN_ACK (0)
#define RF24_LNA_HCURR (0)
#define RF24_RF_DR_LOW (5)
#define RF24_RF_DR_HIGH (3)
#define RF24_RF_PWR_LOW (1)
#define RF24_RF_PWR_HIGH (2)
#define RF24_BROADCAST_PIPE (1u) //!< RF24_BROADCAST_PIPE
#define RF24_NODE_PIPE (0u) //!< RF24_NODE_PIPE
// functions
/**
* @brief RF24_csn
* @param level
*/
LOCAL void RF24_csn(const bool level);
/**
* @brief RF24_ce
* @param level
*/
LOCAL void RF24_ce(const bool level);
/**
* @brief RF24_spiMultiByteTransfer
* @param cmd
* @param buf
* @param len
* @param readMode
* @return
*/
LOCAL uint8_t RF24_spiMultiByteTransfer(const uint8_t cmd, uint8_t* buf, const uint8_t len,
const bool aReadMode);
const bool readMode);
/**
* @brief RF24_spiByteTransfer
* @param cmd
* @return
*/
LOCAL uint8_t RF24_spiByteTransfer(const uint8_t cmd);
/**
* @brief RF24_RAW_readByteRegister
* @param cmd
* @return
*/
LOCAL uint8_t RF24_RAW_readByteRegister(const uint8_t cmd);
/**
* @brief RF24_RAW_writeByteRegister
* @param cmd
* @param value
* @return
*/
LOCAL uint8_t RF24_RAW_writeByteRegister(const uint8_t cmd, const uint8_t value);
#define RF24_readByteRegister(__reg) RF24_RAW_readByteRegister(RF24_READ_REGISTER | (RF24_REGISTER_MASK & __reg))
#define RF24_writeByteRegister(__reg,__value) RF24_RAW_writeByteRegister(RF24_WRITE_REGISTER | (RF24_REGISTER_MASK & __reg), __value)
#define RF24_writeMultiByteRegister(__reg,__buf,__len) RF24_spiMultiByteTransfer(RF24_WRITE_REGISTER | (RF24_REGISTER_MASK & __reg),(uint8_t*)__buf, __len,false)
// helper macros
#define RF24_readByteRegister(__reg) RF24_RAW_readByteRegister(RF24_CMD_READ_REGISTER | (RF24_REGISTER_MASK & (__reg))) //!< RF24_readByteRegister
#define RF24_writeByteRegister(__reg,__value) RF24_RAW_writeByteRegister(RF24_CMD_WRITE_REGISTER | (RF24_REGISTER_MASK & (__reg)), __value) //!< RF24_writeByteRegister
#define RF24_writeMultiByteRegister(__reg,__buf,__len) RF24_spiMultiByteTransfer(RF24_CMD_WRITE_REGISTER | (RF24_REGISTER_MASK & (__reg)),(uint8_t*)__buf, __len,false) //!< RF24_writeMultiByteRegister
/**
* @brief RF24_flushRX
*/
LOCAL void RF24_flushRX(void);
/**
* @brief RF24_flushTX
*/
LOCAL void RF24_flushTX(void);
/**
* @brief RF24_getStatus
* @return
*/
LOCAL uint8_t RF24_getStatus(void);
/**
* @brief RF24_getFIFOStatus
* @return
*/
LOCAL uint8_t RF24_getFIFOStatus(void);
/**
* @brief RF24_openWritingPipe
* @param recipient
*/
LOCAL void RF24_openWritingPipe(const uint8_t recipient);
/**
* @brief RF24_startListening
*/
LOCAL void RF24_startListening(void);
/**
* @brief RF24_stopListening
*/
LOCAL void RF24_stopListening(void);
/**
* @brief RF24_sleep
*/
LOCAL void RF24_sleep(void);
/**
* @brief RF24_standBy
*/
LOCAL void RF24_standBy(void);
/**
* @brief RF24_powerDown
*/
LOCAL void RF24_powerDown(void);
LOCAL bool RF24_sendMessage(const uint8_t recipient, const void* buf, const uint8_t len);
/**
* @brief RF24_powerUp
*/
LOCAL void RF24_powerUp(void);
/**
* @brief RF24_sendMessage
* @param recipient
* @param buf
* @param len
* @param noACK set True if no ACK is required
* @return
*/
LOCAL bool RF24_sendMessage(const uint8_t recipient, const void* buf, const uint8_t len,
const bool noACK = false);
/**
* @brief RF24_getDynamicPayloadSize
* @return
*/
LOCAL uint8_t RF24_getDynamicPayloadSize(void);
/**
* @brief RF24_isDataAvailable
* @return
*/
LOCAL bool RF24_isDataAvailable(void);
/**
* @brief RF24_readMessage
* @return
*/
LOCAL uint8_t RF24_readMessage(void* buf);
/**
* @brief RF24_setNodeAddress
* @param address
*/
LOCAL void RF24_setNodeAddress(const uint8_t address);
/**
* @brief RF24_getNodeID
* @return
*/
LOCAL uint8_t RF24_getNodeID(void);
/**
* @brief RF24_sanityCheck
* @return
*/
LOCAL bool RF24_sanityCheck(void);
/**
* @brief RF24_initialize
* @return
*/
LOCAL bool RF24_initialize(void);
/**
* @brief RF24_setChannel
* @param channel
*/
LOCAL void RF24_setChannel(const uint8_t channel);
/**
* @brief RF24_setRetries
* @param retransmitDelay
* @param retransmitCount
*/
LOCAL void RF24_setRetries(const uint8_t retransmitDelay, const uint8_t retransmitCount);
LOCAL void RF24_setAddressWidth(const uint8_t width);
/**
* @brief RF24_setAddressWidth
* @param addressWidth
*/
LOCAL void RF24_setAddressWidth(const uint8_t addressWidth);
/**
* @brief RF24_setRFSetup
* @param RFsetup
*/
LOCAL void RF24_setRFSetup(const uint8_t RFsetup);
/**
* @brief RF24_setFeature
* @param feature
*/
LOCAL void RF24_setFeature(const uint8_t feature);
/**
* @brief RF24_setPipe
* @param pipe
*/
LOCAL void RF24_setPipe(const uint8_t pipe);
/**
* @brief RF24_setAutoACK
* @param pipe
*/
LOCAL void RF24_setAutoACK(const uint8_t pipe);
/**
* @brief RF24_setDynamicPayload
* @param pipe
*/
LOCAL void RF24_setDynamicPayload(const uint8_t pipe);
/**
* @brief RF24_setRFConfiguration
* @param configuration
*/
LOCAL void RF24_setRFConfiguration(const uint8_t configuration);
LOCAL void RF24_setPipeAddress(const uint8_t pipe, uint8_t* address, const uint8_t width);
/**
* @brief RF24_setPipeAddress
* @param pipe
* @param address
* @param addressWidth
*/
LOCAL void RF24_setPipeAddress(const uint8_t pipe, uint8_t* address, const uint8_t addressWidth);
/**
* @brief RF24_setPipeLSB
* @param pipe
* @param LSB
*/
LOCAL void RF24_setPipeLSB(const uint8_t pipe, const uint8_t LSB);
/**
* @brief RF24_getObserveTX
* @return
*/
LOCAL uint8_t RF24_getObserveTX(void);
/**
* @brief RF24_setStatus
* @param status
*/
LOCAL void RF24_setStatus(const uint8_t status);
/**
* @brief RF24_enableFeatures
*/
LOCAL void RF24_enableFeatures(void);
/**
* @brief RF24_getTxPowerPercent
* @return
*/
LOCAL uint8_t RF24_getTxPowerPercent(void);
/**
* @brief RF24_getTxPowerLevel
* @return
*/
LOCAL int16_t RF24_getTxPowerLevel(void);
/**
* @brief RF24_setTxPowerPercent
* @param newPowerPercent
* @return
*/
LOCAL bool RF24_setTxPowerPercent(const uint8_t newPowerPercent);
/**
* @brief RF24_getSendingRSSI
* @return Pseudo-RSSI based on ARC register
*/
LOCAL int16_t RF24_getSendingRSSI(void);
#if defined(MY_RX_MESSAGE_BUFFER_FEATURE)
/**
* @brief Callback type
*/
typedef void (*RF24_receiveCallbackType)(void);
/**
* Register a callback, which will be called (from interrupt context) for every message received.
* @note When a callback is registered, it _must_ retrieve the message from the nRF24
* by calling RF24_readMessage(). Otherwise the interrupt will not get deasserted
* and message reception will stop.
*/
* @brief RF24_registerReceiveCallback
* Register a callback, which will be called (from interrupt context) for every message received.
* @note When a callback is registered, it _must_ retrieve the message from the nRF24
* by calling RF24_readMessage(). Otherwise the interrupt will not get deasserted
* and message reception will stop.
* @param cb
*/
LOCAL void RF24_registerReceiveCallback(RF24_receiveCallbackType cb);
#endif
#endif // __RF24_H__
#endif // __RF24_H__
/** @}*/
drivers/RF24/RF24registers.h
+156
View File
@@ -0,0 +1,156 @@
/*
* 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 <henrik.ekblad@mysensors.org>
* Copyright (C) 2013-2017 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 <maniacbug@ymail.com>
* RF24 driver refactored and optimized for speed and size, copyright (C) 2016 Olivier Mauti <olivier@mysensors.org>
*/
// PA levels
#define RF24_PA_MIN (0)
#define RF24_PA_LOW (1)
#define RF24_PA_HIGH (2)
#define RF24_PA_MAX (3)
// power level limits
#define RF24_MIN_POWER_LEVEL (0)
#define RF24_MAX_POWER_LEVEL (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)
// ARD, auto retry delay
#define RF24_SET_ARD (5) //=1500us
// ARD, auto retry count
#define RF24_SET_ARC (15)
// nRF24L01(+) register definitions
#define RF24_REG_NRF_CONFIG (0x00)
#define RF24_REG_EN_AA (0x01)
#define RF24_REG_EN_RXADDR (0x02)
#define RF24_REG_SETUP_AW (0x03)
#define RF24_REG_SETUP_RETR (0x04)
#define RF24_REG_RF_CH (0x05)
#define RF24_REG_RF_SETUP (0x06)
#define RF24_REG_STATUS (0x07)
#define RF24_REG_OBSERVE_TX (0x08)
#define RF24_REG_CD (0x09)
#define RF24_REG_RX_ADDR_P0 (0x0A)
#define RF24_REG_RX_ADDR_P1 (0x0B)
#define RF24_REG_RX_ADDR_P2 (0x0C)
#define RF24_REG_RX_ADDR_P3 (0x0D)
#define RF24_REG_RX_ADDR_P4 (0x0E)
#define RF24_REG_RX_ADDR_P5 (0x0F)
#define RF24_REG_TX_ADDR (0x10)
#define RF24_REG_RX_PW_P0 (0x11)
#define RF24_REG_RX_PW_P1 (0x12)
#define RF24_REG_RX_PW_P2 (0x13)
#define RF24_REG_RX_PW_P3 (0x14)
#define RF24_REG_RX_PW_P4 (0x15)
#define RF24_REG_RX_PW_P5 (0x16)
#define RF24_REG_FIFO_STATUS (0x17)
#define RF24_REG_DYNPD (0x1C)
#define RF24_REG_FEATURE (0x1D)
// mask
#define RF24_REGISTER_MASK (0x1F)
// instructions
#define RF24_CMD_READ_REGISTER (0x00)
#define RF24_CMD_RPD (0x09)
#define RF24_CMD_WRITE_REGISTER (0x20)
#define RF24_CMD_ACTIVATE (0x50)
#define RF24_CMD_READ_RX_PL_WID (0x60)
#define RF24_CMD_READ_RX_PAYLOAD (0x61)
#define RF24_CMD_WRITE_TX_PAYLOAD (0xA0)
#define RF24_CMD_WRITE_ACK_PAYLOAD (0xA8)
#define RF24_CMD_WRITE_TX_PAYLOAD_NO_ACK (0xB0)
#define RF24_CMD_FLUSH_TX (0xE1)
#define RF24_CMD_FLUSH_RX (0xE2)
#define RF24_CMD_REUSE_TX_PL (0xE3)
#define RF24_CMD_NOP (0xFF)
// bit mnemonics
#define RF24_MASK_RX_DR (6)
#define RF24_MASK_TX_DS (5)
#define RF24_MASK_MAX_RT (4)
#define RF24_EN_CRC (3)
#define RF24_CRCO (2)
#define RF24_PWR_UP (1)
#define RF24_PRIM_RX (0)
// auto ACK
#define RF24_ENAA_P5 (5)
#define RF24_ENAA_P4 (4)
#define RF24_ENAA_P3 (3)
#define RF24_ENAA_P2 (2)
#define RF24_ENAA_P1 (1)
#define RF24_ENAA_P0 (0)
// rx pipe
#define RF24_ERX_P5 (5)
#define RF24_ERX_P4 (4)
#define RF24_ERX_P3 (3)
#define RF24_ERX_P2 (2)
#define RF24_ERX_P1 (1)
#define RF24_ERX_P0 (0)
// dynamic payload
#define RF24_DPL_P5 (5)
#define RF24_DPL_P4 (4)
#define RF24_DPL_P3 (3)
#define RF24_DPL_P2 (2)
#define RF24_DPL_P1 (1)
#define RF24_DPL_P0 (0)
#define RF24_AW (0)
#define RF24_ARD (4)
#define RF24_ARC (0)
#define RF24_PLL_LOCK (4)
#define RF24_RF_DR (3)
#define RF24_RF_PWR (6)
#define RF24_RX_DR (6)
#define RF24_TX_DS (5)
#define RF24_MAX_RT (4)
#define RF24_RX_P_NO (1)
#define RF24_TX_FULL (0)
#define RF24_PLOS_CNT (4)
#define RF24_ARC_CNT (0)
#define RF24_TX_REUSE (6)
#define RF24_FIFO_FULL (5)
#define RF24_TX_EMPTY (4)
#define RF24_RX_FULL (1)
#define RF24_RX_EMPTY (0)
// features
#define RF24_EN_DPL (2)
#define RF24_EN_ACK_PAY (1)
#define RF24_EN_DYN_ACK (0)
#define RF24_LNA_HCURR (0)
#define RF24_RF_DR_LOW (5)
#define RF24_RF_DR_HIGH (3)
#define RF24_RF_PWR_LOW (1)
#define RF24_RF_PWR_HIGH (2)
drivers/RFM69/new/RFM69_new.cpp
+1467
View File
File diff suppressed because it is too large Load Diff
drivers/RFM69/new/RFM69_new.h
+614
View File
@@ -0,0 +1,614 @@
/*
* 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 <henrik.ekblad@mysensors.org>
* Copyright (C) 2013-2017 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.
*
* 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 <olivier@mysensors.org>
*
* 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
*/
/**
* @file RFM69.h
*
* @defgroup RFM69grp RFM69
* @ingroup internals
* @{
*
* 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)
*
* @brief API declaration for RFM69
*
*/
#ifndef _RFM69_h
#define _RFM69_h
#include "RFM69registers_new.h"
#if defined(ARDUINO_ARCH_AVR)
#if defined(__AVR_ATmega32U4__)
#define DEFAULT_RFM69_IRQ_PIN (3) //!< DEFAULT_RFM69_IRQ_PIN
#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
#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
// SPI settings
#define RFM69_SPI_DATA_ORDER MSBFIRST //!< SPI data order
#define RFM69_SPI_DATA_MODE SPI_MODE0 //!< SPI mode
// SPI clock divier for non-transaction implementations
#if (MY_RFM69_SPI_SPEED >= F_CPU / 2)
#define RFM69_CLOCK_DIV SPI_CLOCK_DIV2 //!< SPI clock divider 2
#elif (MY_RFM69_SPI_SPEED >= F_CPU / 4)
#define RFM69_CLOCK_DIV SPI_CLOCK_DIV4 //!< SPI clock divider 4
#elif (MY_RFM69_SPI_SPEED >= F_CPU / 8)
#define RFM69_CLOCK_DIV SPI_CLOCK_DIV8 //!< SPI clock divider 8
#elif (MY_RFM69_SPI_SPEED >= F_CPU / 16)
#define RFM69_CLOCK_DIV SPI_CLOCK_DIV16 //!< SPI clock divider 16
#elif (MY_RFM69_SPI_SPEED >= F_CPU / 32)
#define RFM69_CLOCK_DIV SPI_CLOCK_DIV32 //!< SPI clock divider 32
#elif (MY_RFM69_SPI_SPEED >= F_CPU / 64)
#define RFM69_CLOCK_DIV SPI_CLOCK_DIV64 //!< SPI clock divider 64
#elif (MY_RFM69_SPI_SPEED >= F_CPU / 128)
#define RFM69_CLOCK_DIV SPI_CLOCK_DIV128 //!< SPI clock divider 128
#else
#define RFM69_CLOCK_DIV SPI_CLOCK_DIV256 //!< SPI clock divider 256
#endif
#if defined (ARDUINO) && !defined (__arm__) && !defined (_SPI)
#include <SPI.h>
#if defined(MY_SOFTSPI)
SoftSPI<MY_SOFT_SPI_MISO_PIN, MY_SOFT_SPI_MOSI_PIN, MY_SOFT_SPI_SCK_PIN, RFM69_SPI_DATA_MODE> _SPI;
#else
#define _SPI SPI
#endif
#else
#if defined(__arm__)
#include <SPI.h>
#else
extern HardwareSPI SPI; //!< SPI
#endif
#if !defined(_SPI)
#define _SPI SPI //!< SPI
#endif
#endif
// Additional radio settings
#define RFM69_SYNCVALUE1 (0x2D) //!< Make this compatible with sync1 byte of RFM12B lib
#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
#if !defined(RFM69_MAX_POWER_LEVEL_DBM)
#define RFM69_MAX_POWER_LEVEL_DBM ((rfm69_powerlevel_t)20) //!< max. power level, +20dBm
#endif
#else
// RFM69(C)W
#define RFM69_MIN_POWER_LEVEL_DBM ((rfm69_powerlevel_t)-18) //!< min. power level, -18dBm
#if !defined(RFM69_MAX_POWER_LEVEL_DBM)
#define RFM69_MAX_POWER_LEVEL_DBM ((rfm69_powerlevel_t)13) //!< max. power level, +13dBm
#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_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_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_RSSItoInternal(__value) ((uint8_t)-(__value*2)) //!< RSSI converting macro
#define RFM69_internalToRSSI(__value) ((int16_t)-(__value/2)) //!< RSSI converting macro
// 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
// 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
// powerup delay
#define RFM69_POWERUP_DELAY_MS (100u) //!< 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
/*
#if !defined(RFM69_FREQ_MSB)
#define RFM69_FREQ_MSB (uint8_t)(MY_RFM69_FREQUENCY == RFM69_315MHZ ? RFM69_FRFMSB_315 : (MY_RFM69_FREQUENCY == RFM69_433MHZ ? RFM69_FRFMSB_433_92 : (MY_RFM69_FREQUENCY == RFM69_868MHZ ? RFM69_FRFMSB_868 : RFM69_FRFMSB_915))) //!< FREQ_MSB
#endif
#if !defined(RFM69_FREQ_MID)
#define RFM69_FREQ_MID (uint8_t)(MY_RFM69_FREQUENCY == RFM69_315MHZ ? RFM69_FRFMID_315 : (MY_RFM69_FREQUENCY == RFM69_433MHZ ? RFM69_FRFMID_433_92 : (MY_RFM69_FREQUENCY == RFM69_868MHZ ? RFM69_FRFMID_868 : RFM69_FRFMID_915))) //!< FREQ_MID
#endif
#if !defined(RFM69_FREQ_LSB)
#define RFM69_FREQ_LSB (uint8_t)(MY_RFM69_FREQUENCY == RFM69_315MHZ ? RFM69_FRFLSB_315 : (MY_RFM69_FREQUENCY == RFM69_433MHZ ? RFM69_FRFLSB_433_92 : (MY_RFM69_FREQUENCY == RFM69_868MHZ ? RFM69_FRFLSB_868 : RFM69_FRFLSB_915))) //!< FREQ_LSB
#endif
*/
#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)
#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
#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_SLEEP = 3, //!< SLEEP mode
RFM69_RADIO_MODE_STDBY = 4, //!< STDBY mode
RFM69_RADIO_MODE_SYNTH = 5, //!< SYNTH mode
RFM69_RADIO_MODE_LISTEN = 6 //!< LISTEN mode
} rfm69_radio_mode_t;
/**
* @brief Sequence number data type
*/
typedef uint8_t rfm69_sequenceNumber_t;
/**
* @brief RSSI data type
*/
typedef uint8_t rfm69_RSSI_t;
/**
* @brief SNR data type
*/
typedef int8_t rfm69_SNR_t;
/**
* @brief Control flag data type
*/
typedef uint8_t rfm69_controlFlags_t;
/**
* @brief Power level in dBm
*/
typedef int8_t rfm69_powerlevel_t;
/**
* @brief RFM69 header
* 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
} __attribute__((packed)) rfm69_header_t;
/**
* @brief RFM69 ACK packet structure
*/
typedef struct {
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
#define RFM69_MAX_PAYLOAD_LEN (RFM69_MAX_PACKET_LEN - RFM69_HEADER_LEN) //!< Max payload length
/**
* @brief Packet structure
*/
typedef struct {
union {
struct {
rfm69_header_t header; //!< Packet header
union {
uint8_t payload[RFM69_MAX_PAYLOAD_LEN]; //!< Union: Data Payload, i.e. MySensors message
rfm69_ack_t ACK; //!< Union: ACK payload (internal)
};
};
uint8_t data[RFM69_MAX_PACKET_LEN]; //!< RAW data access
};
uint8_t payloadLen; //!< Length of payload (excluding header)
rfm69_RSSI_t RSSI; //!< RSSI of current packet, RSSI = value - 137
} __attribute__((packed)) rfm69_packet_t;
/**
* @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
// 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_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 Initialise the driver transport hardware and software
* @param frequencyHz Frequency in Hz
* @return True if initialisation succeeded
*/
LOCAL bool RFM69_initialise(const uint32_t frequencyHz);
/**
* @brief Set the driver/node address
* @param addr
*/
LOCAL void RFM69_setAddress(const uint8_t addr);
/**
* @brief Get driver/node address
* @return Node address
*/
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 RFM95_recv()
*/
LOCAL bool RFM69_available(void);
/**
* @brief If a valid message is received, copy it to buf and return length. 0 byte messages are permitted.
* @param buf Location to copy the received message
* @param maxBufSize Max buffer size
* @return Number of bytes
*/
LOCAL uint8_t RFM69_recv(uint8_t* buf, const uint8_t maxBufSize);
/**
* @brief RFM69_sendFrame
* @param packet
* @param increaseSequenceCounter
* @return True if packet sent
*/
LOCAL bool RFM69_sendFrame(rfm69_packet_t &packet, const bool increaseSequenceCounter = true);
/**
* @brief RFM69_send
* @param recipient
* @param data
* @param len
* @param flags
* @param increaseSequenceCounter
* @return True if frame sent
*/
LOCAL bool RFM69_send(const uint8_t recipient, uint8_t* data, const uint8_t len,
const rfm69_controlFlags_t flags, const bool increaseSequenceCounter = true);
/**
* @brief Sets the transmitter and receiver center frequency
* @param frequencyHz Frequency in Hz
*/
LOCAL void RFM69_setFrequency(const uint32_t frequencyHz);
/**
* @brief Sets the transmitter power output level, and configures the transmitter pin
* @param newPowerLevel Transmitter power level in dBm (-18 to +20dBm)
* @return True power level adjusted
*/
LOCAL bool RFM69_setTxPowerLevel(rfm69_powerlevel_t newPowerLevel);
/**
* @brief Reports the transmitter power output level in dBm
* @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)
*/
LOCAL void RFM69_powerUp(void);
/**
* @brief RFM69_sendACK
* @param recipient
* @param sequenceNumber
* @param RSSI (rfm95_RSSI_t)
*/
LOCAL void RFM69_sendACK(const uint8_t recipient, const rfm69_sequenceNumber_t sequenceNumber,
const rfm69_RSSI_t RSSI);
/**
* @brief RFM69_sendWithRetry
* @param recipient
* @param buffer
* @param bufferSize
* @param retries
* @param retryWaitTimeMS
* @return True if packet successfully sent
*/
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);
/**
* @brief RFM69_setRadioMode
* @param newRadioMode
* @return True if mode changed
*/
LOCAL bool RFM69_setRadioMode(const rfm69_radio_mode_t newRadioMode);
/**
* @brief Low level interrupt handler
*/
LOCAL void RFM69_interruptHandler(void);
/**
* @brief RFM69_getSendingRSSI
* @return RSSI Own RSSI as measured at the receiving node of last sent packet (if ACK & ATC enabled)
*/
LOCAL int16_t RFM69_getSendingRSSI(void);
/**
* @brief RFM69_getReceivingRSSI
* @return RSSI Signal strength of last received packet
*/
LOCAL int16_t RFM69_getReceivingRSSI(void);
/**
* @brief RFM69_executeATC
* @param currentRSSI
* @param targetRSSI
* @return True if power level adjusted
*/
LOCAL bool RFM69_executeATC(const rfm69_RSSI_t currentRSSI, const rfm69_RSSI_t targetRSSI);
// TEMP ADDED
/**
* @brief RFM69_setConfiguration Set general radio register configuration TODO temp use setmodemregisters
*/
LOCAL void RFM69_setConfiguration(void);
/**
* @brief RFM69_isModeReady
* @return True if Mode Ready is ok, false is timeout
*/
LOCAL bool RFM69_isModeReady(void);
/**
* @brief RFM69_sanityCheck detect HW defect, configuration errors or interrupted SPI line
* @return True if radio sanity check passed
*/
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);
/**
* @brief RFM69_setHighPowerRegs
* @param onOff
*/
LOCAL void RFM69_setHighPowerRegs(const bool onOff);
/**
* @brief RFM69_readRSSI
* @param forceTrigger
* @return RSSI (internal format)
*/
LOCAL rfm69_RSSI_t RFM69_readRSSI(bool forceTrigger = false);
/**
* @brief RFM69_ATCmode
* @param targetRSSI Target RSSI for transmitter (default -60)
* @param onOff True to enable ATC
*/
LOCAL void RFM69_ATCmode(const bool onOff, const int16_t targetRSSI = RFM69_TARGET_RSSI_DBM);
// ************************ 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
/** @}*/
drivers/RFM69/new/RFM69registers_new.h
+980
View File
@@ -0,0 +1,980 @@
/*
* 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 <henrik.ekblad@mysensors.org>
* Copyright (C) 2013-2016 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.
*
* 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 <olivier@mysensors.org>
*
* 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
*/
#define RFM69_REG_FIFO 0x00
#define RFM69_REG_OPMODE 0x01
#define RFM69_REG_DATAMODUL 0x02
#define RFM69_REG_BITRATEMSB 0x03
#define RFM69_REG_BITRATELSB 0x04
#define RFM69_REG_FDEVMSB 0x05
#define RFM69_REG_FDEVLSB 0x06
#define RFM69_REG_FRFMSB 0x07
#define RFM69_REG_FRFMID 0x08
#define RFM69_REG_FRFLSB 0x09
#define RFM69_REG_OSC1 0x0A
#define RFM69_REG_AFCCTRL 0x0B
#define RFM69_REG_LOWBAT 0x0C
#define RFM69_REG_LISTEN1 0x0D
#define RFM69_REG_LISTEN2 0x0E
#define RFM69_REG_LISTEN3 0x0F
#define RFM69_REG_VERSION 0x10
#define RFM69_REG_PALEVEL 0x11
#define RFM69_REG_PARAMP 0x12
#define RFM69_REG_OCP 0x13
#define RFM69_REG_AGCREF 0x14 // not present on RFM69/SX1231
#define RFM69_REG_AGCTHRESH1 0x15 // not present on RFM69/SX1231
#define RFM69_REG_AGCTHRESH2 0x16 // not present on RFM69/SX1231
#define RFM69_REG_AGCTHRESH3 0x17 // not present on RFM69/SX1231
#define RFM69_REG_LNA 0x18
#define RFM69_REG_RXBW 0x19
#define RFM69_REG_AFCBW 0x1A
#define RFM69_REG_OOKPEAK 0x1B
#define RFM69_REG_OOKAVG 0x1C
#define RFM69_REG_OOKFIX 0x1D
#define RFM69_REG_AFCFEI 0x1E
#define RFM69_REG_AFCMSB 0x1F
#define RFM69_REG_AFCLSB 0x20
#define RFM69_REG_FEIMSB 0x21
#define RFM69_REG_FEILSB 0x22
#define RFM69_REG_RSSICONFIG 0x23
#define RFM69_REG_RSSIVALUE 0x24
#define RFM69_REG_DIOMAPPING1 0x25
#define RFM69_REG_DIOMAPPING2 0x26
#define RFM69_REG_IRQFLAGS1 0x27
#define RFM69_REG_IRQFLAGS2 0x28
#define RFM69_REG_RSSITHRESH 0x29
#define RFM69_REG_RXTIMEOUT1 0x2A
#define RFM69_REG_RXTIMEOUT2 0x2B
#define RFM69_REG_PREAMBLEMSB 0x2C
#define RFM69_REG_PREAMBLELSB 0x2D
#define RFM69_REG_SYNCCONFIG 0x2E
#define RFM69_REG_SYNCVALUE1 0x2F
#define RFM69_REG_SYNCVALUE2 0x30
#define RFM69_REG_SYNCVALUE3 0x31
#define RFM69_REG_SYNCVALUE4 0x32
#define RFM69_REG_SYNCVALUE5 0x33
#define RFM69_REG_SYNCVALUE6 0x34
#define RFM69_REG_SYNCVALUE7 0x35
#define RFM69_REG_SYNCVALUE8 0x36
#define RFM69_REG_PACKETCONFIG1 0x37
#define RFM69_REG_PAYLOADLENGTH 0x38
#define RFM69_REG_NODEADRS 0x39
#define RFM69_REG_BROADCASTADRS 0x3A
#define RFM69_REG_AUTOMODES 0x3B
#define RFM69_REG_FIFOTHRESH 0x3C
#define RFM69_REG_PACKETCONFIG2 0x3D
#define RFM69_REG_AESKEY1 0x3E
#define RFM69_REG_AESKEY2 0x3F
#define RFM69_REG_AESKEY3 0x40
#define RFM69_REG_AESKEY4 0x41
#define RFM69_REG_AESKEY5 0x42
#define RFM69_REG_AESKEY6 0x43
#define RFM69_REG_AESKEY7 0x44
#define RFM69_REG_AESKEY8 0x45
#define RFM69_REG_AESKEY9 0x46
#define RFM69_REG_AESKEY10 0x47
#define RFM69_REG_AESKEY11 0x48
#define RFM69_REG_AESKEY12 0x49
#define RFM69_REG_AESKEY13 0x4A
#define RFM69_REG_AESKEY14 0x4B
#define RFM69_REG_AESKEY15 0x4C
#define RFM69_REG_AESKEY16 0x4D
#define RFM69_REG_TEMP1 0x4E
#define RFM69_REG_TEMP2 0x4F
#define RFM69_REG_TESTLNA 0x58
#define RFM69_REG_TESTPA1 0x5A // only present on RFM69HW/SX1231H
#define RFM69_REG_TESTPA2 0x5C // only present on RFM69HW/SX1231H
#define RFM69_REG_TESTDAGC 0x6F
//******************************************************
// RF69/SX1231 bit control definition
//******************************************************
// RegOpMode
#define RFM69_OPMODE_SEQUENCER_OFF 0x80
#define RFM69_OPMODE_SEQUENCER_ON 0x00 // Default
#define RFM69_OPMODE_LISTEN_ON 0x40
#define RFM69_OPMODE_LISTEN_OFF 0x00 // Default
#define RFM69_OPMODE_LISTENABORT 0x20
#define RFM69_OPMODE_SLEEP 0x00
#define RFM69_OPMODE_STANDBY 0x04 // Default
#define RFM69_OPMODE_SYNTHESIZER 0x08
#define RFM69_OPMODE_TRANSMITTER 0x0C
#define RFM69_OPMODE_RECEIVER 0x10
// RegDataModul
#define RFM69_DATAMODUL_DATAMODE_PACKET 0x00 // Default
#define RFM69_DATAMODUL_DATAMODE_CONTINUOUS 0x40
#define RFM69_DATAMODUL_DATAMODE_CONTINUOUSNOBSYNC 0x60
#define RFM69_DATAMODUL_MODULATIONTYPE_FSK 0x00 // Default
#define RFM69_DATAMODUL_MODULATIONTYPE_OOK 0x08
#define RFM69_DATAMODUL_MODULATIONSHAPING_00 0x00 // Default
#define RFM69_DATAMODUL_MODULATIONSHAPING_01 0x01
#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_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_25000 0x05
#define RFM69_BITRATELSB_25000 0x00
#define RFM69_BITRATEMSB_50000 0x02
#define RFM69_BITRATELSB_50000 0x80
#define RFM69_BITRATEMSB_100000 0x01
#define RFM69_BITRATELSB_100000 0x40
#define RFM69_BITRATEMSB_150000 0x00
#define RFM69_BITRATELSB_150000 0xD5
#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_5000 0x00 // Default
#define RFM69_FDEVLSB_5000 0x52 // Default
#define RFM69_FDEVMSB_7500 0x00
#define RFM69_FDEVLSB_7500 0x7B
#define RFM69_FDEVMSB_10000 0x00
#define RFM69_FDEVLSB_10000 0xA4
#define RFM69_FDEVMSB_15000 0x00
#define RFM69_FDEVLSB_15000 0xF6
#define RFM69_FDEVMSB_20000 0x01
#define RFM69_FDEVLSB_20000 0x48
#define RFM69_FDEVMSB_25000 0x01
#define RFM69_FDEVLSB_25000 0x9A
#define RFM69_FDEVMSB_30000 0x01
#define RFM69_FDEVLSB_30000 0xEC
#define RFM69_FDEVMSB_35000 0x02
#define RFM69_FDEVLSB_35000 0x3D
#define RFM69_FDEVMSB_40000 0x02
#define RFM69_FDEVLSB_40000 0x8F
#define RFM69_FDEVMSB_45000 0x02
#define RFM69_FDEVLSB_45000 0xE1
#define RFM69_FDEVMSB_50000 0x03
#define RFM69_FDEVLSB_50000 0x33
#define RFM69_FDEVMSB_55000 0x03
#define RFM69_FDEVLSB_55000 0x85
#define RFM69_FDEVMSB_60000 0x03
#define RFM69_FDEVLSB_60000 0xD7
#define RFM69_FDEVMSB_65000 0x04
#define RFM69_FDEVLSB_65000 0x29
#define RFM69_FDEVMSB_70000 0x04
#define RFM69_FDEVLSB_70000 0x7B
#define RFM69_FDEVMSB_75000 0x04
#define RFM69_FDEVLSB_75000 0xCD
#define RFM69_FDEVMSB_80000 0x05
#define RFM69_FDEVLSB_80000 0x1F
#define RFM69_FDEVMSB_85000 0x05
#define RFM69_FDEVLSB_85000 0x71
#define RFM69_FDEVMSB_90000 0x05
#define RFM69_FDEVLSB_90000 0xC3
#define RFM69_FDEVMSB_95000 0x06
#define RFM69_FDEVLSB_95000 0x14
#define RFM69_FDEVMSB_100000 0x06
#define RFM69_FDEVLSB_100000 0x66
#define RFM69_FDEVMSB_110000 0x07
#define RFM69_FDEVLSB_110000 0x0A
#define RFM69_FDEVMSB_120000 0x07
#define RFM69_FDEVLSB_120000 0xAE
#define RFM69_FDEVMSB_130000 0x08
#define RFM69_FDEVLSB_130000 0x52
#define RFM69_FDEVMSB_140000 0x08
#define RFM69_FDEVLSB_140000 0xF6
#define RFM69_FDEVMSB_150000 0x09
#define RFM69_FDEVLSB_150000 0x9A
#define RFM69_FDEVMSB_160000 0x0A
#define RFM69_FDEVLSB_160000 0x3D
#define RFM69_FDEVMSB_170000 0x0A
#define RFM69_FDEVLSB_170000 0xE1
#define RFM69_FDEVMSB_180000 0x0B
#define RFM69_FDEVLSB_180000 0x85
#define RFM69_FDEVMSB_190000 0x0C
#define RFM69_FDEVLSB_190000 0x29
#define RFM69_FDEVMSB_200000 0x0C
#define RFM69_FDEVLSB_200000 0xCD
#define RFM69_FDEVMSB_210000 0x0D
#define RFM69_FDEVLSB_210000 0x71
#define RFM69_FDEVMSB_220000 0x0E
#define RFM69_FDEVLSB_220000 0x14
#define RFM69_FDEVMSB_230000 0x0E
#define RFM69_FDEVLSB_230000 0xB8
#define RFM69_FDEVMSB_240000 0x0F
#define RFM69_FDEVLSB_240000 0x5C
#define RFM69_FDEVMSB_250000 0x10
#define RFM69_FDEVLSB_250000 0x00
#define RFM69_FDEVMSB_260000 0x10
#define RFM69_FDEVLSB_260000 0xA4
#define RFM69_FDEVMSB_270000 0x11
#define RFM69_FDEVLSB_270000 0x48
#define RFM69_FDEVMSB_280000 0x11
#define RFM69_FDEVLSB_280000 0xEC
#define RFM69_FDEVMSB_290000 0x12
#define RFM69_FDEVLSB_290000 0x8F
#define RFM69_FDEVMSB_300000 0x13
#define RFM69_FDEVLSB_300000 0x33
#define RFM69_NOP 0x00
// RegOsc1
#define RFM69_OSC1_RCCAL_START 0x80
#define RFM69_OSC1_RCCAL_DONE 0x40
// RegAfcCtrl
#define RFM69_AFCCTRL_LOWBETA_OFF 0x00 // Default
#define RFM69_AFCCTRL_LOWBETA_ON 0x20
// RegLowBat
#define RFM69_LOWBAT_MONITOR 0x10
#define RFM69_LOWBAT_ON 0x08
#define RFM69_LOWBAT_OFF 0x00 // Default
#define RFM69_LOWBAT_TRIM_1695 0x00
#define RFM69_LOWBAT_TRIM_1764 0x01
#define RFM69_LOWBAT_TRIM_1835 0x02 // Default
#define RFM69_LOWBAT_TRIM_1905 0x03
#define RFM69_LOWBAT_TRIM_1976 0x04
#define RFM69_LOWBAT_TRIM_2045 0x05
#define RFM69_LOWBAT_TRIM_2116 0x06
#define RFM69_LOWBAT_TRIM_2185 0x07
// RegListen1
#define RFM69_LISTEN1_RESOL_64 0x50
#define RFM69_LISTEN1_RESOL_4100 0xA0 // Default
#define RFM69_LISTEN1_RESOL_262000 0xF0
#define RFM69_LISTEN1_RESOL_IDLE_64 0x40
#define RFM69_LISTEN1_RESOL_IDLE_4100 0x80 // Default
#define RFM69_LISTEN1_RESOL_IDLE_262000 0xC0
#define RFM69_LISTEN1_RESOL_RX_64 0x10
#define RFM69_LISTEN1_RESOL_RX_4100 0x20 // Default
#define RFM69_LISTEN1_RESOL_RX_262000 0x30
#define RFM69_LISTEN1_CRITERIA_RSSI 0x00 // Default
#define RFM69_LISTEN1_CRITERIA_RSSIANDSYNC 0x08
#define RFM69_LISTEN1_END_00 0x00
#define RFM69_LISTEN1_END_01 0x02 // Default
#define RFM69_LISTEN1_END_10 0x04
// RegListen2
#define RFM69_LISTEN2_COEFIDLE_VALUE 0xF5 // Default
// RegListen3
#define RFM69_LISTEN3_COEFRX_VALUE 0x20 // Default
// RegVersion
#define RFM69_VERSION_VER 0x24 // Default
// RegPaLevel
#define RFM69_PALEVEL_PA0_ON 0x80 // Default
#define RFM69_PALEVEL_PA0_OFF 0x00
#define RFM69_PALEVEL_PA1_ON 0x40
#define RFM69_PALEVEL_PA1_OFF 0x00 // Default
#define RFM69_PALEVEL_PA2_ON 0x20
#define RFM69_PALEVEL_PA2_OFF 0x00 // Default
#define RFM69_PALEVEL_OUTPUTPOWER_00000 0x00
#define RFM69_PALEVEL_OUTPUTPOWER_00001 0x01
#define RFM69_PALEVEL_OUTPUTPOWER_00010 0x02
#define RFM69_PALEVEL_OUTPUTPOWER_00011 0x03
#define RFM69_PALEVEL_OUTPUTPOWER_00100 0x04
#define RFM69_PALEVEL_OUTPUTPOWER_00101 0x05
#define RFM69_PALEVEL_OUTPUTPOWER_00110 0x06
#define RFM69_PALEVEL_OUTPUTPOWER_00111 0x07
#define RFM69_PALEVEL_OUTPUTPOWER_01000 0x08
#define RFM69_PALEVEL_OUTPUTPOWER_01001 0x09
#define RFM69_PALEVEL_OUTPUTPOWER_01010 0x0A
#define RFM69_PALEVEL_OUTPUTPOWER_01011 0x0B
#define RFM69_PALEVEL_OUTPUTPOWER_01100 0x0C
#define RFM69_PALEVEL_OUTPUTPOWER_01101 0x0D
#define RFM69_PALEVEL_OUTPUTPOWER_01110 0x0E
#define RFM69_PALEVEL_OUTPUTPOWER_01111 0x0F
#define RFM69_PALEVEL_OUTPUTPOWER_10000 0x10
#define RFM69_PALEVEL_OUTPUTPOWER_10001 0x11
#define RFM69_PALEVEL_OUTPUTPOWER_10010 0x12
#define RFM69_PALEVEL_OUTPUTPOWER_10011 0x13
#define RFM69_PALEVEL_OUTPUTPOWER_10100 0x14
#define RFM69_PALEVEL_OUTPUTPOWER_10101 0x15
#define RFM69_PALEVEL_OUTPUTPOWER_10110 0x16
#define RFM69_PALEVEL_OUTPUTPOWER_10111 0x17
#define RFM69_PALEVEL_OUTPUTPOWER_11000 0x18
#define RFM69_PALEVEL_OUTPUTPOWER_11001 0x19
#define RFM69_PALEVEL_OUTPUTPOWER_11010 0x1A
#define RFM69_PALEVEL_OUTPUTPOWER_11011 0x1B
#define RFM69_PALEVEL_OUTPUTPOWER_11100 0x1C
#define RFM69_PALEVEL_OUTPUTPOWER_11101 0x1D
#define RFM69_PALEVEL_OUTPUTPOWER_11110 0x1E
#define RFM69_PALEVEL_OUTPUTPOWER_11111 0x1F // Default
// RegPaRamp
#define RFM69_PARAMP_3400 0x00
#define RFM69_PARAMP_2000 0x01
#define RFM69_PARAMP_1000 0x02
#define RFM69_PARAMP_500 0x03
#define RFM69_PARAMP_250 0x04
#define RFM69_PARAMP_125 0x05
#define RFM69_PARAMP_100 0x06
#define RFM69_PARAMP_62 0x07
#define RFM69_PARAMP_50 0x08
#define RFM69_PARAMP_40 0x09 // Default
#define RFM69_PARAMP_31 0x0A
#define RFM69_PARAMP_25 0x0B
#define RFM69_PARAMP_20 0x0C
#define RFM69_PARAMP_15 0x0D
#define RFM69_PARAMP_12 0x0E
#define RFM69_PARAMP_10 0x0F
// RegOcp
#define RFM69_OCP_OFF 0x0F
#define RFM69_OCP_ON 0x1A // Default
#define RFM69_OCP_TRIM_45 0x00
#define RFM69_OCP_TRIM_50 0x01
#define RFM69_OCP_TRIM_55 0x02
#define RFM69_OCP_TRIM_60 0x03
#define RFM69_OCP_TRIM_65 0x04
#define RFM69_OCP_TRIM_70 0x05
#define RFM69_OCP_TRIM_75 0x06
#define RFM69_OCP_TRIM_80 0x07
#define RFM69_OCP_TRIM_85 0x08
#define RFM69_OCP_TRIM_90 0x09
#define RFM69_OCP_TRIM_95 0x0A // Default
#define RFM69_OCP_TRIM_100 0x0B
#define RFM69_OCP_TRIM_105 0x0C
#define RFM69_OCP_TRIM_110 0x0D
#define RFM69_OCP_TRIM_115 0x0E
#define RFM69_OCP_TRIM_120 0x0F
// RegAgcRef - not present on RFM69/SX1231
#define RFM69_AGCREF_AUTO_ON 0x40 // Default
#define RFM69_AGCREF_AUTO_OFF 0x00
#define RFM69_AGCREF_LEVEL_MINUS80 0x00 // Default
#define RFM69_AGCREF_LEVEL_MINUS81 0x01
#define RFM69_AGCREF_LEVEL_MINUS82 0x02
#define RFM69_AGCREF_LEVEL_MINUS83 0x03
#define RFM69_AGCREF_LEVEL_MINUS84 0x04
#define RFM69_AGCREF_LEVEL_MINUS85 0x05
#define RFM69_AGCREF_LEVEL_MINUS86 0x06
#define RFM69_AGCREF_LEVEL_MINUS87 0x07
#define RFM69_AGCREF_LEVEL_MINUS88 0x08
#define RFM69_AGCREF_LEVEL_MINUS89 0x09
#define RFM69_AGCREF_LEVEL_MINUS90 0x0A
#define RFM69_AGCREF_LEVEL_MINUS91 0x0B
#define RFM69_AGCREF_LEVEL_MINUS92 0x0C
#define RFM69_AGCREF_LEVEL_MINUS93 0x0D
#define RFM69_AGCREF_LEVEL_MINUS94 0x0E
#define RFM69_AGCREF_LEVEL_MINUS95 0x0F
#define RFM69_AGCREF_LEVEL_MINUS96 0x10
#define RFM69_AGCREF_LEVEL_MINUS97 0x11
#define RFM69_AGCREF_LEVEL_MINUS98 0x12
#define RFM69_AGCREF_LEVEL_MINUS99 0x13
#define RFM69_AGCREF_LEVEL_MINUS100 0x14
#define RFM69_AGCREF_LEVEL_MINUS101 0x15
#define RFM69_AGCREF_LEVEL_MINUS102 0x16
#define RFM69_AGCREF_LEVEL_MINUS103 0x17
#define RFM69_AGCREF_LEVEL_MINUS104 0x18
#define RFM69_AGCREF_LEVEL_MINUS105 0x19
#define RFM69_AGCREF_LEVEL_MINUS106 0x1A
#define RFM69_AGCREF_LEVEL_MINUS107 0x1B
#define RFM69_AGCREF_LEVEL_MINUS108 0x1C
#define RFM69_AGCREF_LEVEL_MINUS109 0x1D
#define RFM69_AGCREF_LEVEL_MINUS110 0x1E
#define RFM69_AGCREF_LEVEL_MINUS111 0x1F
#define RFM69_AGCREF_LEVEL_MINUS112 0x20
#define RFM69_AGCREF_LEVEL_MINUS113 0x21
#define RFM69_AGCREF_LEVEL_MINUS114 0x22
#define RFM69_AGCREF_LEVEL_MINUS115 0x23
#define RFM69_AGCREF_LEVEL_MINUS116 0x24
#define RFM69_AGCREF_LEVEL_MINUS117 0x25
#define RFM69_AGCREF_LEVEL_MINUS118 0x26
#define RFM69_AGCREF_LEVEL_MINUS119 0x27
#define RFM69_AGCREF_LEVEL_MINUS120 0x28
#define RFM69_AGCREF_LEVEL_MINUS121 0x29
#define RFM69_AGCREF_LEVEL_MINUS122 0x2A
#define RFM69_AGCREF_LEVEL_MINUS123 0x2B
#define RFM69_AGCREF_LEVEL_MINUS124 0x2C
#define RFM69_AGCREF_LEVEL_MINUS125 0x2D
#define RFM69_AGCREF_LEVEL_MINUS126 0x2E
#define RFM69_AGCREF_LEVEL_MINUS127 0x2F
#define RFM69_AGCREF_LEVEL_MINUS128 0x30
#define RFM69_AGCREF_LEVEL_MINUS129 0x31
#define RFM69_AGCREF_LEVEL_MINUS130 0x32
#define RFM69_AGCREF_LEVEL_MINUS131 0x33
#define RFM69_AGCREF_LEVEL_MINUS132 0x34
#define RFM69_AGCREF_LEVEL_MINUS133 0x35
#define RFM69_AGCREF_LEVEL_MINUS134 0x36
#define RFM69_AGCREF_LEVEL_MINUS135 0x37
#define RFM69_AGCREF_LEVEL_MINUS136 0x38
#define RFM69_AGCREF_LEVEL_MINUS137 0x39
#define RFM69_AGCREF_LEVEL_MINUS138 0x3A
#define RFM69_AGCREF_LEVEL_MINUS139 0x3B
#define RFM69_AGCREF_LEVEL_MINUS140 0x3C
#define RFM69_AGCREF_LEVEL_MINUS141 0x3D
#define RFM69_AGCREF_LEVEL_MINUS142 0x3E
#define RFM69_AGCREF_LEVEL_MINUS143 0x3F
// RegAgcThresh1 - not present on RFM69/SX1231
#define RFM69_AGCTHRESH1_SNRMARGIN_000 0x00
#define RFM69_AGCTHRESH1_SNRMARGIN_001 0x20
#define RFM69_AGCTHRESH1_SNRMARGIN_010 0x40
#define RFM69_AGCTHRESH1_SNRMARGIN_011 0x60
#define RFM69_AGCTHRESH1_SNRMARGIN_100 0x80
#define RFM69_AGCTHRESH1_SNRMARGIN_101 0xA0 // Default
#define RFM69_AGCTHRESH1_SNRMARGIN_110 0xC0
#define RFM69_AGCTHRESH1_SNRMARGIN_111 0xE0
#define RFM69_AGCTHRESH1_STEP1_0 0x00
#define RFM69_AGCTHRESH1_STEP1_1 0x01
#define RFM69_AGCTHRESH1_STEP1_2 0x02
#define RFM69_AGCTHRESH1_STEP1_3 0x03
#define RFM69_AGCTHRESH1_STEP1_4 0x04
#define RFM69_AGCTHRESH1_STEP1_5 0x05
#define RFM69_AGCTHRESH1_STEP1_6 0x06
#define RFM69_AGCTHRESH1_STEP1_7 0x07
#define RFM69_AGCTHRESH1_STEP1_8 0x08
#define RFM69_AGCTHRESH1_STEP1_9 0x09
#define RFM69_AGCTHRESH1_STEP1_10 0x0A
#define RFM69_AGCTHRESH1_STEP1_11 0x0B
#define RFM69_AGCTHRESH1_STEP1_12 0x0C
#define RFM69_AGCTHRESH1_STEP1_13 0x0D
#define RFM69_AGCTHRESH1_STEP1_14 0x0E
#define RFM69_AGCTHRESH1_STEP1_15 0x0F
#define RFM69_AGCTHRESH1_STEP1_16 0x10 // Default
#define RFM69_AGCTHRESH1_STEP1_17 0x11
#define RFM69_AGCTHRESH1_STEP1_18 0x12
#define RFM69_AGCTHRESH1_STEP1_19 0x13
#define RFM69_AGCTHRESH1_STEP1_20 0x14
#define RFM69_AGCTHRESH1_STEP1_21 0x15
#define RFM69_AGCTHRESH1_STEP1_22 0x16
#define RFM69_AGCTHRESH1_STEP1_23 0x17
#define RFM69_AGCTHRESH1_STEP1_24 0x18
#define RFM69_AGCTHRESH1_STEP1_25 0x19
#define RFM69_AGCTHRESH1_STEP1_26 0x1A
#define RFM69_AGCTHRESH1_STEP1_27 0x1B
#define RFM69_AGCTHRESH1_STEP1_28 0x1C
#define RFM69_AGCTHRESH1_STEP1_29 0x1D
#define RFM69_AGCTHRESH1_STEP1_30 0x1E
#define RFM69_AGCTHRESH1_STEP1_31 0x1F
// RegAgcThresh2 - not present on RFM69/SX1231
#define RFM69_AGCTHRESH2_STEP2_0 0x00
#define RFM69_AGCTHRESH2_STEP2_1 0x10
#define RFM69_AGCTHRESH2_STEP2_2 0x20
#define RFM69_AGCTHRESH2_STEP2_3 0x30 // XXX wrong -- Default
#define RFM69_AGCTHRESH2_STEP2_4 0x40
#define RFM69_AGCTHRESH2_STEP2_5 0x50
#define RFM69_AGCTHRESH2_STEP2_6 0x60
#define RFM69_AGCTHRESH2_STEP2_7 0x70 // default
#define RFM69_AGCTHRESH2_STEP2_8 0x80
#define RFM69_AGCTHRESH2_STEP2_9 0x90
#define RFM69_AGCTHRESH2_STEP2_10 0xA0
#define RFM69_AGCTHRESH2_STEP2_11 0xB0
#define RFM69_AGCTHRESH2_STEP2_12 0xC0
#define RFM69_AGCTHRESH2_STEP2_13 0xD0
#define RFM69_AGCTHRESH2_STEP2_14 0xE0
#define RFM69_AGCTHRESH2_STEP2_15 0xF0
#define RFM69_AGCTHRESH2_STEP3_0 0x00
#define RFM69_AGCTHRESH2_STEP3_1 0x01
#define RFM69_AGCTHRESH2_STEP3_2 0x02
#define RFM69_AGCTHRESH2_STEP3_3 0x03
#define RFM69_AGCTHRESH2_STEP3_4 0x04
#define RFM69_AGCTHRESH2_STEP3_5 0x05
#define RFM69_AGCTHRESH2_STEP3_6 0x06
#define RFM69_AGCTHRESH2_STEP3_7 0x07
#define RFM69_AGCTHRESH2_STEP3_8 0x08
#define RFM69_AGCTHRESH2_STEP3_9 0x09
#define RFM69_AGCTHRESH2_STEP3_10 0x0A
#define RFM69_AGCTHRESH2_STEP3_11 0x0B // Default
#define RFM69_AGCTHRESH2_STEP3_12 0x0C
#define RFM69_AGCTHRESH2_STEP3_13 0x0D
#define RFM69_AGCTHRESH2_STEP3_14 0x0E
#define RFM69_AGCTHRESH2_STEP3_15 0x0F
// RegAgcThresh3 - not present on RFM69/SX1231
#define RFM69_AGCTHRESH3_STEP4_0 0x00
#define RFM69_AGCTHRESH3_STEP4_1 0x10
#define RFM69_AGCTHRESH3_STEP4_2 0x20
#define RFM69_AGCTHRESH3_STEP4_3 0x30
#define RFM69_AGCTHRESH3_STEP4_4 0x40
#define RFM69_AGCTHRESH3_STEP4_5 0x50
#define RFM69_AGCTHRESH3_STEP4_6 0x60
#define RFM69_AGCTHRESH3_STEP4_7 0x70
#define RFM69_AGCTHRESH3_STEP4_8 0x80
#define RFM69_AGCTHRESH3_STEP4_9 0x90 // Default
#define RFM69_AGCTHRESH3_STEP4_10 0xA0
#define RFM69_AGCTHRESH3_STEP4_11 0xB0
#define RFM69_AGCTHRESH3_STEP4_12 0xC0
#define RFM69_AGCTHRESH3_STEP4_13 0xD0
#define RFM69_AGCTHRESH3_STEP4_14 0xE0
#define RFM69_AGCTHRESH3_STEP4_15 0xF0
#define RFM69_AGCTHRESH3_STEP5_0 0x00
#define RFM69_AGCTHRESH3_STEP5_1 0x01
#define RFM69_AGCTHRESH3_STEP5_2 0x02
#define RFM69_AGCTHRESH3_STEP5_3 0x03
#define RFM69_AGCTHRESH3_STEP5_4 0x04
#define RFM69_AGCTHRESH3_STEP5_5 0x05
#define RFM69_AGCTHRESH3_STEP5_6 0x06
#define RFM69_AGCTHRESH3_STEP5_7 0x07
#define RFM69_AGCTHRES33_STEP5_8 0x08
#define RFM69_AGCTHRESH3_STEP5_9 0x09
#define RFM69_AGCTHRESH3_STEP5_10 0x0A
#define RFM69_AGCTHRESH3_STEP5_11 0x0B // Default
#define RFM69_AGCTHRESH3_STEP5_12 0x0C
#define RFM69_AGCTHRESH3_STEP5_13 0x0D
#define RFM69_AGCTHRESH3_STEP5_14 0x0E
#define RFM69_AGCTHRESH3_STEP5_15 0x0F
// RegLna
#define RFM69_LNA_ZIN_50 0x00 // Reset value
#define RFM69_LNA_ZIN_200 0x80 // Recommended default
#define RFM69_LNA_LOWPOWER_OFF 0x00 // Default
#define RFM69_LNA_LOWPOWER_ON 0x40
#define RFM69_LNA_CURRENTGAIN 0x08
#define RFM69_LNA_GAINSELECT_AUTO 0x00 // Default
#define RFM69_LNA_GAINSELECT_MAX 0x01
#define RFM69_LNA_GAINSELECT_MAXMINUS6 0x02
#define RFM69_LNA_GAINSELECT_MAXMINUS12 0x03
#define RFM69_LNA_GAINSELECT_MAXMINUS24 0x04
#define RFM69_LNA_GAINSELECT_MAXMINUS36 0x05
#define RFM69_LNA_GAINSELECT_MAXMINUS48 0x06
// RegRxBw
#define RFM69_RXBW_DCCFREQ_000 0x00
#define RFM69_RXBW_DCCFREQ_001 0x20
#define RFM69_RXBW_DCCFREQ_010 0x40 // Recommended default
#define RFM69_RXBW_DCCFREQ_011 0x60
#define RFM69_RXBW_DCCFREQ_100 0x80 // Reset value
#define RFM69_RXBW_DCCFREQ_101 0xA0
#define RFM69_RXBW_DCCFREQ_110 0xC0
#define RFM69_RXBW_DCCFREQ_111 0xE0
#define RFM69_RXBW_MANT_16 0x00 // Reset value
#define RFM69_RXBW_MANT_20 0x08
#define RFM69_RXBW_MANT_24 0x10 // Recommended default
#define RFM69_RXBW_EXP_0 0x00
#define RFM69_RXBW_EXP_1 0x01
#define RFM69_RXBW_EXP_2 0x02
#define RFM69_RXBW_EXP_3 0x03
#define RFM69_RXBW_EXP_4 0x04
#define RFM69_RXBW_EXP_5 0x05 // Recommended default
#define RFM69_RXBW_EXP_6 0x06 // Reset value
#define RFM69_RXBW_EXP_7 0x07
// RegAfcBw
#define RFM69_AFCBW_DCCFREQAFC_000 0x00
#define RFM69_AFCBW_DCCFREQAFC_001 0x20
#define RFM69_AFCBW_DCCFREQAFC_010 0x40
#define RFM69_AFCBW_DCCFREQAFC_011 0x60
#define RFM69_AFCBW_DCCFREQAFC_100 0x80 // Default
#define RFM69_AFCBW_DCCFREQAFC_101 0xA0
#define RFM69_AFCBW_DCCFREQAFC_110 0xC0
#define RFM69_AFCBW_DCCFREQAFC_111 0xE0
#define RFM69_AFCBW_MANTAFC_16 0x00
#define RFM69_AFCBW_MANTAFC_20 0x08 // Default
#define RFM69_AFCBW_MANTAFC_24 0x10
#define RFM69_AFCBW_EXPAFC_0 0x00
#define RFM69_AFCBW_EXPAFC_1 0x01
#define RFM69_AFCBW_EXPAFC_2 0x02 // Reset value
#define RFM69_AFCBW_EXPAFC_3 0x03 // Recommended default
#define RFM69_AFCBW_EXPAFC_4 0x04
#define RFM69_AFCBW_EXPAFC_5 0x05
#define RFM69_AFCBW_EXPAFC_6 0x06
#define RFM69_AFCBW_EXPAFC_7 0x07
// RegOokPeak
#define RFM69_OOKPEAK_THRESHTYPE_FIXED 0x00
#define RFM69_OOKPEAK_THRESHTYPE_PEAK 0x40 // Default
#define RFM69_OOKPEAK_THRESHTYPE_AVERAGE 0x80
#define RFM69_OOKPEAK_PEAKTHRESHSTEP_000 0x00 // Default
#define RFM69_OOKPEAK_PEAKTHRESHSTEP_001 0x08
#define RFM69_OOKPEAK_PEAKTHRESHSTEP_010 0x10
#define RFM69_OOKPEAK_PEAKTHRESHSTEP_011 0x18
#define RFM69_OOKPEAK_PEAKTHRESHSTEP_100 0x20
#define RFM69_OOKPEAK_PEAKTHRESHSTEP_101 0x28
#define RFM69_OOKPEAK_PEAKTHRESHSTEP_110 0x30
#define RFM69_OOKPEAK_PEAKTHRESHSTEP_111 0x38
#define RFM69_OOKPEAK_PEAKTHRESHDEC_000 0x00 // Default
#define RFM69_OOKPEAK_PEAKTHRESHDEC_001 0x01
#define RFM69_OOKPEAK_PEAKTHRESHDEC_010 0x02
#define RFM69_OOKPEAK_PEAKTHRESHDEC_011 0x03
#define RFM69_OOKPEAK_PEAKTHRESHDEC_100 0x04
#define RFM69_OOKPEAK_PEAKTHRESHDEC_101 0x05
#define RFM69_OOKPEAK_PEAKTHRESHDEC_110 0x06
#define RFM69_OOKPEAK_PEAKTHRESHDEC_111 0x07
// RegOokAvg
#define RFM69_OOKAVG_AVERAGETHRESHFILT_00 0x00
#define RFM69_OOKAVG_AVERAGETHRESHFILT_01 0x40
#define RFM69_OOKAVG_AVERAGETHRESHFILT_10 0x80 // Default
#define RFM69_OOKAVG_AVERAGETHRESHFILT_11 0xC0
// RegOokFix
#define RFM69_OOKFIX_FIXEDTHRESH_VALUE 0x06 // Default
// RegAfcFei
#define RFM69_AFCFEI_FEI_DONE 0x40
#define RFM69_AFCFEI_FEI_START 0x20
#define RFM69_AFCFEI_AFC_DONE 0x10
#define RFM69_AFCFEI_AFCAUTOCLEAR_ON 0x08
#define RFM69_AFCFEI_AFCAUTOCLEAR_OFF 0x00 // Default
#define RFM69_AFCFEI_AFCAUTO_ON 0x04
#define RFM69_AFCFEI_AFCAUTO_OFF 0x00 // Default
#define RFM69_AFCFEI_AFC_CLEAR 0x02
#define RFM69_AFCFEI_AFC_START 0x01
// RegRssiConfig
#define RFM69_RSSI_FASTRX_ON 0x08 // not present on RFM69/SX1231
#define RFM69_RSSI_FASTRX_OFF 0x00 // Default
#define RFM69_RSSI_DONE 0x02
#define RFM69_RSSI_START 0x01
// RegDioMapping1
#define RFM69_DIOMAPPING1_DIO0_00 0x00 // Default
#define RFM69_DIOMAPPING1_DIO0_01 0x40
#define RFM69_DIOMAPPING1_DIO0_10 0x80
#define RFM69_DIOMAPPING1_DIO0_11 0xC0
#define RFM69_DIOMAPPING1_DIO1_00 0x00 // Default
#define RFM69_DIOMAPPING1_DIO1_01 0x10
#define RFM69_DIOMAPPING1_DIO1_10 0x20
#define RFM69_DIOMAPPING1_DIO1_11 0x30
#define RFM69_DIOMAPPING1_DIO2_00 0x00 // Default
#define RFM69_DIOMAPPING1_DIO2_01 0x04
#define RFM69_DIOMAPPING1_DIO2_10 0x08
#define RFM69_DIOMAPPING1_DIO2_11 0x0C
#define RFM69_DIOMAPPING1_DIO3_00 0x00 // Default
#define RFM69_DIOMAPPING1_DIO3_01 0x01
#define RFM69_DIOMAPPING1_DIO3_10 0x02
#define RFM69_DIOMAPPING1_DIO3_11 0x03
// RegDioMapping2
#define RFM69_DIOMAPPING2_DIO4_00 0x00 // Default
#define RFM69_DIOMAPPING2_DIO4_01 0x40
#define RFM69_DIOMAPPING2_DIO4_10 0x80
#define RFM69_DIOMAPPING2_DIO4_11 0xC0
#define RFM69_DIOMAPPING2_DIO5_00 0x00 // Default
#define RFM69_DIOMAPPING2_DIO5_01 0x10
#define RFM69_DIOMAPPING2_DIO5_10 0x20
#define RFM69_DIOMAPPING2_DIO5_11 0x30
#define RFM69_DIOMAPPING2_CLKOUT_32 0x00
#define RFM69_DIOMAPPING2_CLKOUT_16 0x01
#define RFM69_DIOMAPPING2_CLKOUT_8 0x02
#define RFM69_DIOMAPPING2_CLKOUT_4 0x03
#define RFM69_DIOMAPPING2_CLKOUT_2 0x04
#define RFM69_DIOMAPPING2_CLKOUT_1 0x05 // Reset value
#define RFM69_DIOMAPPING2_CLKOUT_RC 0x06
#define RFM69_DIOMAPPING2_CLKOUT_OFF 0x07 // Recommended default
// RegIrqFlags1
#define RFM69_IRQFLAGS1_MODEREADY 0x80
#define RFM69_IRQFLAGS1_RXREADY 0x40
#define RFM69_IRQFLAGS1_TXREADY 0x20
#define RFM69_IRQFLAGS1_PLLLOCK 0x10
#define RFM69_IRQFLAGS1_RSSI 0x08
#define RFM69_IRQFLAGS1_TIMEOUT 0x04
#define RFM69_IRQFLAGS1_AUTOMODE 0x02
#define RFM69_IRQFLAGS1_SYNCADDRESSMATCH 0x01
// RegIrqFlags2
#define RFM69_IRQFLAGS2_FIFOFULL 0x80
#define RFM69_IRQFLAGS2_FIFONOTEMPTY 0x40
#define RFM69_IRQFLAGS2_FIFOLEVEL 0x20
#define RFM69_IRQFLAGS2_FIFOOVERRUN 0x10
#define RFM69_IRQFLAGS2_PACKETSENT 0x08
#define RFM69_IRQFLAGS2_PAYLOADREADY 0x04
#define RFM69_IRQFLAGS2_CRCOK 0x02
#define RFM69_IRQFLAGS2_LOWBAT 0x01 // not present on RFM69/SX1231
// RegRssiThresh
#define RFM69_RSSITHRESH_VALUE 0xE4 // Default
// RegRxTimeout1
#define RFM69_RXTIMEOUT1_RXSTART_VALUE 0x00 // Default
// RegRxTimeout2
#define RFM69_RXTIMEOUT2_RSSITHRESH_VALUE 0x00 // Default
// RegPreamble
#define RFM69_PREAMBLESIZE_MSB_VALUE 0x00 // Default
#define RFM69_PREAMBLESIZE_LSB_VALUE 0x03 // Default
// RegSyncConfig
#define RFM69_SYNC_ON 0x80 // Default
#define RFM69_SYNC_OFF 0x00
#define RFM69_SYNC_FIFOFILL_AUTO 0x00 // Default -- when sync interrupt occurs
#define RFM69_SYNC_FIFOFILL_MANUAL 0x40
#define RFM69_SYNC_SIZE_1 0x00
#define RFM69_SYNC_SIZE_2 0x08
#define RFM69_SYNC_SIZE_3 0x10
#define RFM69_SYNC_SIZE_4 0x18 // Default
#define RFM69_SYNC_SIZE_5 0x20
#define RFM69_SYNC_SIZE_6 0x28
#define RFM69_SYNC_SIZE_7 0x30
#define RFM69_SYNC_SIZE_8 0x38
#define RFM69_SYNC_TOL_0 0x00 // Default
#define RFM69_SYNC_TOL_1 0x01
#define RFM69_SYNC_TOL_2 0x02
#define RFM69_SYNC_TOL_3 0x03
#define RFM69_SYNC_TOL_4 0x04
#define RFM69_SYNC_TOL_5 0x05
#define RFM69_SYNC_TOL_6 0x06
#define RFM69_SYNC_TOL_7 0x07
// RegSyncValue1-8
#define RFM69_SYNC_BYTE1_VALUE 0x00 // Default
#define RFM69_SYNC_BYTE2_VALUE 0x00 // Default
#define RFM69_SYNC_BYTE3_VALUE 0x00 // Default
#define RFM69_SYNC_BYTE4_VALUE 0x00 // Default
#define RFM69_SYNC_BYTE5_VALUE 0x00 // Default
#define RFM69_SYNC_BYTE6_VALUE 0x00 // Default
#define RFM69_SYNC_BYTE7_VALUE 0x00 // Default
#define RFM69_SYNC_BYTE8_VALUE 0x00 // Default
// RegPacketConfig1
#define RFM69_PACKET1_FORMAT_FIXED 0x00 // Default
#define RFM69_PACKET1_FORMAT_VARIABLE 0x80
#define RFM69_PACKET1_DCFREE_OFF 0x00 // Default
#define RFM69_PACKET1_DCFREE_MANCHESTER 0x20
#define RFM69_PACKET1_DCFREE_WHITENING 0x40
#define RFM69_PACKET1_CRC_ON 0x10 // Default
#define RFM69_PACKET1_CRC_OFF 0x00
#define RFM69_PACKET1_CRCAUTOCLEAR_ON 0x00 // Default
#define RFM69_PACKET1_CRCAUTOCLEAR_OFF 0x08
#define RFM69_PACKET1_ADRSFILTERING_OFF 0x00 // Default
#define RFM69_PACKET1_ADRSFILTERING_NODE 0x02
#define RFM69_PACKET1_ADRSFILTERING_NODEBROADCAST 0x04
// RegPayloadLength
#define RFM69_PAYLOADLENGTH_VALUE 0x40 // Default
// RegBroadcastAdrs
#define RFM69_BROADCASTADDRESS_VALUE 0x00
// RegAutoModes
#define RFM69_AUTOMODES_ENTER_OFF 0x00 // Default
#define RFM69_AUTOMODES_ENTER_FIFONOTEMPTY 0x20
#define RFM69_AUTOMODES_ENTER_FIFOLEVEL 0x40
#define RFM69_AUTOMODES_ENTER_CRCOK 0x60
#define RFM69_AUTOMODES_ENTER_PAYLOADREADY 0x80
#define RFM69_AUTOMODES_ENTER_SYNCADRSMATCH 0xA0
#define RFM69_AUTOMODES_ENTER_PACKETSENT 0xC0
#define RFM69_AUTOMODES_ENTER_FIFOEMPTY 0xE0
#define RFM69_AUTOMODES_EXIT_OFF 0x00 // Default
#define RFM69_AUTOMODES_EXIT_FIFOEMPTY 0x04
#define RFM69_AUTOMODES_EXIT_FIFOLEVEL 0x08
#define RFM69_AUTOMODES_EXIT_CRCOK 0x0C
#define RFM69_AUTOMODES_EXIT_PAYLOADREADY 0x10
#define RFM69_AUTOMODES_EXIT_SYNCADRSMATCH 0x14
#define RFM69_AUTOMODES_EXIT_PACKETSENT 0x18
#define RFM69_AUTOMODES_EXIT_RXTIMEOUT 0x1C
#define RFM69_AUTOMODES_INTERMEDIATE_SLEEP 0x00 // Default
#define RFM69_AUTOMODES_INTERMEDIATE_STANDBY 0x01
#define RFM69_AUTOMODES_INTERMEDIATE_RECEIVER 0x02
#define RFM69_AUTOMODES_INTERMEDIATE_TRANSMITTER 0x03
// RegFifoThresh
#define RFM69_FIFOTHRESH_TXSTART_FIFOTHRESH 0x00 // Reset value
#define RFM69_FIFOTHRESH_TXSTART_FIFONOTEMPTY 0x80 // Recommended default
#define RFM69_FIFOTHRESH_VALUE 0x0F // Default
// RegPacketConfig2
#define RFM69_PACKET2_RXRESTARTDELAY_1BIT 0x00 // Default
#define RFM69_PACKET2_RXRESTARTDELAY_2BITS 0x10
#define RFM69_PACKET2_RXRESTARTDELAY_4BITS 0x20
#define RFM69_PACKET2_RXRESTARTDELAY_8BITS 0x30
#define RFM69_PACKET2_RXRESTARTDELAY_16BITS 0x40
#define RFM69_PACKET2_RXRESTARTDELAY_32BITS 0x50
#define RFM69_PACKET2_RXRESTARTDELAY_64BITS 0x60
#define RFM69_PACKET2_RXRESTARTDELAY_128BITS 0x70
#define RFM69_PACKET2_RXRESTARTDELAY_256BITS 0x80
#define RFM69_PACKET2_RXRESTARTDELAY_512BITS 0x90
#define RFM69_PACKET2_RXRESTARTDELAY_1024BITS 0xA0
#define RFM69_PACKET2_RXRESTARTDELAY_2048BITS 0xB0
#define RFM69_PACKET2_RXRESTARTDELAY_NONE 0xC0
#define RFM69_PACKET2_RXRESTART 0x04
#define RFM69_PACKET2_AUTORXRESTART_ON 0x02 // Default
#define RFM69_PACKET2_AUTORXRESTART_OFF 0x00
#define RFM69_PACKET2_AES_ON 0x01
#define RFM69_PACKET2_AES_OFF 0x00 // Default
// RegAesKey1-16
#define RFM69_AESKEY1_VALUE 0x00 // Default
#define RFM69_AESKEY2_VALUE 0x00 // Default
#define RFM69_AESKEY3_VALUE 0x00 // Default
#define RFM69_AESKEY4_VALUE 0x00 // Default
#define RFM69_AESKEY5_VALUE 0x00 // Default
#define RFM69_AESKEY6_VALUE 0x00 // Default
#define RFM69_AESKEY7_VALUE 0x00 // Default
#define RFM69_AESKEY8_VALUE 0x00 // Default
#define RFM69_AESKEY9_VALUE 0x00 // Default
#define RFM69_AESKEY10_VALUE 0x00 // Default
#define RFM69_AESKEY11_VALUE 0x00 // Default
#define RFM69_AESKEY12_VALUE 0x00 // Default
#define RFM69_AESKEY13_VALUE 0x00 // Default
#define RFM69_AESKEY14_VALUE 0x00 // Default
#define RFM69_AESKEY15_VALUE 0x00 // Default
#define RFM69_AESKEY16_VALUE 0x00 // Default
// RegTemp1
#define RFM69_TEMP1_MEAS_START 0x08
#define RFM69_TEMP1_MEAS_RUNNING 0x04
// not present on RFM69/SX1231
#define RFM69_TEMP1_ADCLOWPOWER_ON 0x01 // Default
#define RFM69_TEMP1_ADCLOWPOWER_OFF 0x00
// RegTestLna
#define RFM69_TESTLNA_NORMAL 0x1B
#define RFM69_TESTLNA_HIGH_SENSITIVITY 0x2D
// RegTestDagc
#define RFM69_DAGC_NORMAL 0x00 // Reset value
#define RFM69_DAGC_IMPROVED_LOWBETA1 0x20
#define RFM69_DAGC_IMPROVED_LOWBETA0 0x30 // Recommended default
drivers/RFM69/RFM69.cpp → drivers/RFM69/old/RFM69_old.cpp
+132 -70
View File
@@ -28,11 +28,11 @@
// Please maintain this license information along with authorship
// and copyright notices in any redistribution of this code
// **********************************************************************************
#include "RFM69.h"
#include "RFM69registers.h"
#include "RFM69_old.h"
#include "RFM69registers_old.h"
#include <SPI.h>
volatile uint8_t RFM69::DATA[RF69_MAX_DATA_LEN];
volatile uint8_t RFM69::DATA[RFM69_MAX_DATA_LEN];
volatile uint8_t RFM69::_mode; // current transceiver state
volatile uint8_t RFM69::DATALEN;
volatile uint8_t RFM69::SENDERID;
@@ -47,6 +47,8 @@ RFM69* RFM69::selfPointer;
bool RFM69::initialize(uint8_t freqBand, uint8_t nodeID, uint8_t networkID)
{
//powerUp();
//reset();
const uint8_t CONFIG[][2] = {
/* 0x01 */ { REG_OPMODE, RF_OPMODE_SEQUENCER_ON | RF_OPMODE_LISTEN_OFF | RF_OPMODE_STANDBY },
/* 0x02 */ { REG_DATAMODUL, RF_DATAMODUL_DATAMODE_PACKET | RF_DATAMODUL_MODULATIONTYPE_FSK | RF_DATAMODUL_MODULATIONSHAPING_00 }, // no shaping
@@ -55,9 +57,9 @@ bool RFM69::initialize(uint8_t freqBand, uint8_t nodeID, uint8_t networkID)
/* 0x05 */ { REG_FDEVMSB, RF_FDEVMSB_50000}, // default: 5KHz, (FDEV + BitRate / 2 <= 500KHz)
/* 0x06 */ { REG_FDEVLSB, RF_FDEVLSB_50000},
/* 0x07 */ { REG_FRFMSB, (uint8_t) (freqBand==RF69_315MHZ ? RF_FRFMSB_315 : (freqBand==RF69_433MHZ ? RF_FRFMSB_433 : (freqBand==RF69_868MHZ ? RF_FRFMSB_868 : RF_FRFMSB_915))) },
/* 0x08 */ { REG_FRFMID, (uint8_t) (freqBand==RF69_315MHZ ? RF_FRFMID_315 : (freqBand==RF69_433MHZ ? RF_FRFMID_433 : (freqBand==RF69_868MHZ ? RF_FRFMID_868 : RF_FRFMID_915))) },
/* 0x09 */ { REG_FRFLSB, (uint8_t) (freqBand==RF69_315MHZ ? RF_FRFLSB_315 : (freqBand==RF69_433MHZ ? RF_FRFLSB_433 : (freqBand==RF69_868MHZ ? RF_FRFLSB_868 : RF_FRFLSB_915))) },
/* 0x07 */ { REG_FRFMSB, (uint8_t) (freqBand==RFM69_315MHZ ? RF_FRFMSB_315 : (freqBand==RFM69_433MHZ ? RF_FRFMSB_433 : (freqBand==RFM69_868MHZ ? RF_FRFMSB_868 : RF_FRFMSB_915))) },
/* 0x08 */ { REG_FRFMID, (uint8_t) (freqBand==RFM69_315MHZ ? RF_FRFMID_315 : (freqBand==RFM69_433MHZ ? RF_FRFMID_433 : (freqBand==RFM69_868MHZ ? RF_FRFMID_868 : RF_FRFMID_915))) },
/* 0x09 */ { REG_FRFLSB, (uint8_t) (freqBand==RFM69_315MHZ ? RF_FRFLSB_315 : (freqBand==RFM69_433MHZ ? RF_FRFLSB_433 : (freqBand==RFM69_868MHZ ? RF_FRFLSB_868 : RF_FRFLSB_915))) },
// looks like PA1 and PA2 are not implemented on RFM69W, hence the max output power is 13dBm
// +17dBm and +20dBm are possible on RFM69HW
@@ -93,18 +95,25 @@ bool RFM69::initialize(uint8_t freqBand, uint8_t nodeID, uint8_t networkID)
hwPinMode(_interruptPin, INPUT);
SPI.begin();
unsigned long start = millis();
uint8_t timeout = 50;
unsigned long start = hwMillis();
const uint8_t timeout = 50;
do {
writeReg(REG_SYNCVALUE1, 0xAA);
yield();
} while (readReg(REG_SYNCVALUE1) != 0xaa && millis()-start < timeout);
start = millis();
doYield();
} while (readReg(REG_SYNCVALUE1) != 0xAA && hwMillis()-start < timeout);
if (hwMillis() - start >= timeout) {
// timeout: checking wiring or replace module
return false;
}
start = hwMillis();
do {
writeReg(REG_SYNCVALUE1, 0x55);
yield();
} while (readReg(REG_SYNCVALUE1) != 0x55 && millis()-start < timeout);
doYield();
} while (readReg(REG_SYNCVALUE1) != 0x55 && hwMillis()-start < timeout);
if (hwMillis() - start >= timeout) {
// timeout: checking wiring or replace module
return false;
}
for (uint8_t i = 0; CONFIG[i][0] != 255; i++) {
writeReg(CONFIG[i][0], CONFIG[i][1]);
}
@@ -114,14 +123,16 @@ bool RFM69::initialize(uint8_t freqBand, uint8_t nodeID, uint8_t networkID)
encrypt(0);
setHighPower(_isRFM69HW); // called regardless if it's a RFM69W or RFM69HW
setMode(RF69_MODE_STANDBY);
start = millis();
while (((readReg(REG_IRQFLAGS1) & RF_IRQFLAGS1_MODEREADY) == 0x00) && millis()-start < timeout) {
yield();
setMode(RFM69_MODE_STANDBY);
start = hwMillis();
while (((readReg(REG_IRQFLAGS1) & RF_IRQFLAGS1_MODEREADY) == 0x00) && hwMillis()-start < timeout) {
doYield();
} // wait for ModeReady
if (millis()-start >= timeout) {
if (hwMillis()-start >= timeout) {
return false;
}
//SPI.usingInterrupt(_interruptNum);
attachInterrupt(_interruptNum, RFM69::isr0, RISING);
selfPointer = this;
@@ -132,23 +143,23 @@ bool RFM69::initialize(uint8_t freqBand, uint8_t nodeID, uint8_t networkID)
// return the frequency (in Hz)
uint32_t RFM69::getFrequency()
{
return RF69_FSTEP * (((uint32_t) readReg(REG_FRFMSB) << 16) + ((uint16_t) readReg(
REG_FRFMID) << 8) + readReg(REG_FRFLSB));
return RFM69_FSTEP * (((uint32_t) readReg(REG_FRFMSB) << 16) + ((uint16_t) readReg(
REG_FRFMID) << 8) + readReg(REG_FRFLSB));
}
// set the frequency (in Hz)
void RFM69::setFrequency(uint32_t freqHz)
{
uint8_t oldMode = _mode;
if (oldMode == RF69_MODE_TX) {
setMode(RF69_MODE_RX);
if (oldMode == RFM69_MODE_TX) {
setMode(RFM69_MODE_RX);
}
freqHz /= RF69_FSTEP; // divide down by FSTEP to get FRF
freqHz /= RFM69_FSTEP; // divide down by FSTEP to get FRF
writeReg(REG_FRFMSB, freqHz >> 16);
writeReg(REG_FRFMID, freqHz >> 8);
writeReg(REG_FRFLSB, freqHz);
if (oldMode == RF69_MODE_RX) {
setMode(RF69_MODE_SYNTH);
if (oldMode == RFM69_MODE_RX) {
setMode(RFM69_MODE_SYNTH);
}
setMode(oldMode);
}
@@ -159,27 +170,29 @@ void RFM69::setMode(uint8_t newMode)
return;
}
const uint8_t currentOPMODE = readReg(REG_OPMODE) & 0xE3;
switch (newMode) {
case RF69_MODE_TX:
writeReg(REG_OPMODE, (readReg(REG_OPMODE) & 0xE3) | RF_OPMODE_TRANSMITTER);
case RFM69_MODE_TX:
writeReg(REG_OPMODE, currentOPMODE | RF_OPMODE_TRANSMITTER);
if (_isRFM69HW) {
setHighPowerRegs(true);
}
break;
case RF69_MODE_RX:
writeReg(REG_OPMODE, (readReg(REG_OPMODE) & 0xE3) | RF_OPMODE_RECEIVER);
case RFM69_MODE_RX:
writeReg(REG_OPMODE, currentOPMODE | RF_OPMODE_RECEIVER);
if (_isRFM69HW) {
setHighPowerRegs(false);
}
break;
case RF69_MODE_SYNTH:
writeReg(REG_OPMODE, (readReg(REG_OPMODE) & 0xE3) | RF_OPMODE_SYNTHESIZER);
case RFM69_MODE_SYNTH:
writeReg(REG_OPMODE, currentOPMODE | RF_OPMODE_SYNTHESIZER);
break;
case RF69_MODE_STANDBY:
writeReg(REG_OPMODE, (readReg(REG_OPMODE) & 0xE3) | RF_OPMODE_STANDBY);
case RFM69_MODE_STANDBY:
writeReg(REG_OPMODE, currentOPMODE | RF_OPMODE_STANDBY);
break;
case RF69_MODE_SLEEP:
writeReg(REG_OPMODE, (readReg(REG_OPMODE) & 0xE3) | RF_OPMODE_SLEEP);
case RFM69_MODE_SLEEP:
writeReg(REG_OPMODE, currentOPMODE | RF_OPMODE_SLEEP);
break;
default:
return;
@@ -187,16 +200,65 @@ void RFM69::setMode(uint8_t newMode)
// we are using packet mode, so this check is not really needed
// but waiting for mode ready is necessary when going from sleep because the FIFO may not be immediately available from previous mode
while (_mode == RF69_MODE_SLEEP &&
while (_mode == RFM69_MODE_SLEEP &&
(readReg(REG_IRQFLAGS1) & RF_IRQFLAGS1_MODEREADY) == 0x00); // wait for ModeReady
_mode = newMode;
}
//put transceiver in sleep mode to save battery - to wake or resume receiving just call receiveDone()
void RFM69::sleep()
void RFM69::sleep(void)
{
setMode(RF69_MODE_SLEEP);
setMode(RFM69_MODE_SLEEP);
}
void RFM69::standBy(void)
{
setMode(RFM69_MODE_STANDBY);
}
void RFM69::powerDown(void)
{
#if defined(MY_RFM69_POWER_PIN)
hwDigitalWrite(MY_RFM69_POWER_PIN, LOW);
#endif
}
void RFM69::powerUp(void)
{
#if defined(MY_RFM69_POWER_PIN)
hwDigitalWrite(MY_RFM69_POWER_PIN, HIGH);
delay(RFM69_POWERUP_DELAY_MS);
#endif
}
void RFM69::reset(void)
{
// reset radio if RESET pin is defined
#ifdef MY_RFM69_RST_PIN
hwPinMode(MY_RFM69_RST_PIN, OUTPUT);
hwDigitalWrite(MY_RFM69_RST_PIN, HIGH);
// 100uS
delayMicroseconds(100);
hwDigitalWrite(MY_RFM69_RST_PIN, LOW);
// wait until chip ready
delay(5);
#endif
}
bool RFM69::sanityCheck(void)
{
bool result = true;
// check Bitrate
result &= readReg(REG_BITRATEMSB) == RF_BITRATEMSB_55555;
result &= readReg(REG_BITRATELSB) == RF_BITRATELSB_55555;
// default: 5KHz, (FDEV + BitRate / 2 <= 500KHz)
result &= readReg(REG_FDEVMSB) == RF_FDEVMSB_50000;
result &= readReg(REG_FDEVLSB) == RF_FDEVLSB_50000;
/*
// Check radio frequency band
result &= readReg(REG_FRFMSB) == (uint8_t)(MY_RFM69_FREQUENCY == RFM69_315MHZ ? RF_FRFMSB_315 : (MY_RFM69_FREQUENCY == RFM69_433MHZ ? RF_FRFMSB_433 : (MY_RFM69_FREQUENCY == RFM69_868MHZ ? RF_FRFMSB_868 : RF_FRFMSB_915)));
result &= readReg(REG_FRFMID) == (uint8_t)(MY_RFM69_FREQUENCY == RFM69_315MHZ ? RF_FRFMID_315 : (MY_RFM69_FREQUENCY == RFM69_433MHZ ? RF_FRFMID_433 : (MY_RFM69_FREQUENCY == RFM69_868MHZ ? RF_FRFMID_868 : RF_FRFMID_915)));
result &= readReg(REG_FRFLSB) == (uint8_t)(MY_RFM69_FREQUENCY == RFM69_315MHZ ? RF_FRFLSB_315 : (MY_RFM69_FREQUENCY == RFM69_433MHZ ? RF_FRFLSB_433 : (MY_RFM69_FREQUENCY == RFM69_868MHZ ? RF_FRFLSB_868 : RF_FRFLSB_915)));
*/
return result;
}
//set this node's address
@@ -230,9 +292,9 @@ void RFM69::setPowerLevel(uint8_t powerLevel)
bool RFM69::canSend()
{
if (_mode == RF69_MODE_RX && PAYLOADLEN == 0 &&
if (_mode == RFM69_MODE_RX && PAYLOADLEN == 0 &&
readRSSI() < CSMA_LIMIT) { // if signal stronger than -100dBm is detected assume channel activity
setMode(RF69_MODE_STANDBY);
setMode(RFM69_MODE_STANDBY);
return true;
}
return false;
@@ -242,8 +304,8 @@ void RFM69::send(uint8_t toAddress, const void* buffer, uint8_t bufferSize, bool
{
writeReg(REG_PACKETCONFIG2, (readReg(REG_PACKETCONFIG2) & 0xFB) |
RF_PACKET2_RXRESTART); // avoid RX deadlocks
uint32_t now = millis();
while (!canSend() && millis() - now < RF69_CSMA_LIMIT_MS) {
uint32_t now = hwMillis();
while (!canSend() && hwMillis() - now < RFM69_CSMA_LIMIT_MS) {
receiveDone();
}
sendFrame(toAddress, buffer, bufferSize, requestACK, false);
@@ -260,8 +322,8 @@ bool RFM69::sendWithRetry(uint8_t toAddress, const void* buffer, uint8_t bufferS
{
for (uint8_t i = 0; i <= retries; i++) {
send(toAddress, buffer, bufferSize, true);
uint32_t sentTime = millis();
while (millis() - sentTime < retryWaitTime) {
uint32_t sentTime = hwMillis();
while (hwMillis() - sentTime < retryWaitTime) {
if (ACKReceived(toAddress)) {
//Serial.print(" ~ms:"); Serial.print(millis() - sentTime);
return true;
@@ -276,7 +338,7 @@ bool RFM69::sendWithRetry(uint8_t toAddress, const void* buffer, uint8_t bufferS
bool RFM69::ACKReceived(uint8_t fromNodeID)
{
if (receiveDone()) {
return (SENDERID == fromNodeID || fromNodeID == RF69_BROADCAST_ADDR) && ACK_RECEIVED;
return (SENDERID == fromNodeID || fromNodeID == RFM69_BROADCAST_ADDR) && ACK_RECEIVED;
}
return false;
}
@@ -284,7 +346,7 @@ bool RFM69::ACKReceived(uint8_t fromNodeID)
// check whether an ACK was requested in the last received packet (non-broadcasted packet)
bool RFM69::ACKRequested()
{
return ACK_REQUESTED && (TARGETID != RF69_BROADCAST_ADDR);
return ACK_REQUESTED && (TARGETID != RFM69_BROADCAST_ADDR);
}
// should be called immediately after reception in case sender wants ACK
@@ -296,10 +358,10 @@ void RFM69::sendACK(const void* buffer, uint8_t bufferSize)
int16_t _RSSI = RSSI; // save payload received RSSI value
writeReg(REG_PACKETCONFIG2, (readReg(REG_PACKETCONFIG2) & 0xFB) |
RF_PACKET2_RXRESTART); // avoid RX deadlocks
uint32_t now = millis();
while (!canSend() && millis() - now < RF69_CSMA_LIMIT_MS) {
uint32_t now = hwMillis();
while (!canSend() && hwMillis() - now < RFM69_CSMA_LIMIT_MS) {
receiveDone();
yield();
doYield();
}
SENDERID = sender; // TWS: Restore SenderID after it gets wiped out by receiveDone()
sendFrame(sender, buffer, bufferSize, false, true);
@@ -315,11 +377,11 @@ void RFM69::interruptHook(uint8_t CTLbyte)
void RFM69::sendFrame(uint8_t toAddress, const void* buffer, uint8_t bufferSize, bool requestACK,
bool sendACK)
{
setMode(RF69_MODE_STANDBY); // turn off receiver to prevent reception while filling fifo
setMode(RFM69_MODE_STANDBY); // turn off receiver to prevent reception while filling fifo
while ((readReg(REG_IRQFLAGS1) & RF_IRQFLAGS1_MODEREADY) == 0x00) {} // wait for ModeReady
writeReg(REG_DIOMAPPING1, RF_DIOMAPPING1_DIO0_00); // DIO0 is "Packet Sent"
if (bufferSize > RF69_MAX_DATA_LEN) {
bufferSize = RF69_MAX_DATA_LEN;
if (bufferSize > RFM69_MAX_DATA_LEN) {
bufferSize = RFM69_MAX_DATA_LEN;
}
// control byte
@@ -344,13 +406,13 @@ void RFM69::sendFrame(uint8_t toAddress, const void* buffer, uint8_t bufferSize,
unselect();
// no need to wait for transmit mode to be ready since its handled by the radio
setMode(RF69_MODE_TX);
uint32_t txStart = millis();
setMode(RFM69_MODE_TX);
uint32_t txStart = hwMillis();
while (hwDigitalRead(_interruptPin) == 0 &&
millis() - txStart <
RF69_TX_LIMIT_MS) {} // wait for DIO0 to turn HIGH signalling transmission finish
hwMillis() - txStart <
RFM69_TX_LIMIT_MS) {} // wait for DIO0 to turn HIGH signalling transmission finish
//while (readReg(REG_IRQFLAGS2) & RF_IRQFLAGS2_PACKETSENT == 0x00); // wait for ModeReady
setMode(RF69_MODE_STANDBY);
setMode(RFM69_MODE_STANDBY);
}
// internal function - interrupt gets called when a packet is received
@@ -358,9 +420,9 @@ void RFM69::interruptHandler()
{
//hwPinMode(4, OUTPUT);
//hwDigitalWrite(4, 1);
if (_mode == RF69_MODE_RX && (readReg(REG_IRQFLAGS2) & RF_IRQFLAGS2_PAYLOADREADY)) {
if (_mode == RFM69_MODE_RX && (readReg(REG_IRQFLAGS2) & RF_IRQFLAGS2_PAYLOADREADY)) {
//RSSI = readRSSI();
setMode(RF69_MODE_STANDBY);
setMode(RFM69_MODE_STANDBY);
select();
SPI.transfer(REG_FIFO & 0x7F);
PAYLOADLEN = SPI.transfer(0);
@@ -368,7 +430,7 @@ void RFM69::interruptHandler()
TARGETID = SPI.transfer(0);
if(!(_promiscuousMode || TARGETID == _address ||
TARGETID ==
RF69_BROADCAST_ADDR) // match this node's address, or broadcast address or anything in promiscuous mode
RFM69_BROADCAST_ADDR) // match this node's address, or broadcast address or anything in promiscuous mode
|| PAYLOADLEN <
3) { // address situation could receive packets that are malformed and don't fit this libraries extra fields
PAYLOADLEN = 0;
@@ -390,11 +452,11 @@ void RFM69::interruptHandler()
for (uint8_t i = 0; i < DATALEN; i++) {
DATA[i] = SPI.transfer(0);
}
if (DATALEN < RF69_MAX_DATA_LEN) {
if (DATALEN < RFM69_MAX_DATA_LEN) {
DATA[DATALEN] = 0; // add null at end of string
}
unselect();
setMode(RF69_MODE_RX);
setMode(RFM69_MODE_RX);
}
RSSI = readRSSI();
//hwDigitalWrite(4, 0);
@@ -421,7 +483,7 @@ void RFM69::receiveBegin()
RF_PACKET2_RXRESTART); // avoid RX deadlocks
}
writeReg(REG_DIOMAPPING1, RF_DIOMAPPING1_DIO0_01); // set DIO0 to "PAYLOADREADY" in receive mode
setMode(RF69_MODE_RX);
setMode(RFM69_MODE_RX);
}
// checks if a packet was received and/or puts transceiver in receive (ie RX or listen) mode
@@ -430,10 +492,10 @@ bool RFM69::receiveDone()
//ATOMIC_BLOCK(ATOMIC_FORCEON)
//{
noInterrupts(); // re-enabled in unselect() via setMode() or via receiveBegin()
if (_mode == RF69_MODE_RX && PAYLOADLEN > 0) {
setMode(RF69_MODE_STANDBY); // enables interrupts
if (_mode == RFM69_MODE_RX && PAYLOADLEN > 0) {
setMode(RFM69_MODE_STANDBY); // enables interrupts
return true;
} else if (_mode == RF69_MODE_RX) { // already in RX no payload yet
} else if (_mode == RFM69_MODE_RX) { // already in RX no payload yet
interrupts(); // explicitly re-enable interrupts
return false;
}
@@ -447,7 +509,7 @@ bool RFM69::receiveDone()
// KEY HAS TO BE 16 bytes !!!
void RFM69::encrypt(const char* key)
{
setMode(RF69_MODE_STANDBY);
setMode(RFM69_MODE_STANDBY);
if (key != 0) {
select();
SPI.transfer(REG_AESKEY1 | 0x80);
@@ -502,7 +564,7 @@ void RFM69::select()
// set RFM69 SPI settings
SPI.setDataMode(SPI_MODE0);
SPI.setBitOrder(MSBFIRST);
SPI.setClockDivider(MY_RF69_SPI_CLOCK_DIV);
SPI.setClockDivider(RFM69_CLOCK_DIV);
hwDigitalWrite(_slaveSelectPin, LOW);
}
@@ -839,7 +901,7 @@ void RFM69::readAllRegs()
uint8_t RFM69::readTemperature(uint8_t calFactor) // returns centigrade
{
setMode(RF69_MODE_STANDBY);
setMode(RFM69_MODE_STANDBY);
writeReg(REG_TEMP1, RF_TEMP1_MEAS_START);
while ((readReg(REG_TEMP1) & RF_TEMP1_MEAS_RUNNING)) {}
return ~readReg(REG_TEMP2) + COURSE_TEMP_COEF +
drivers/RFM69/RFM69.h → drivers/RFM69/old/RFM69_old.h
+80 -59
View File
@@ -33,72 +33,79 @@
#include <Arduino.h> // assumes Arduino IDE v1.0 or greater
#include <SPI.h>
#define RF69_MAX_DATA_LEN 61 // to take advantage of the built in AES/CRC we want to limit the frame size to the internal FIFO size (66 bytes - 3 bytes overhead - 2 bytes crc)
#define RF69_SPI_CS SS // SS is the SPI slave select pin, for instance D10 on ATmega328
#define RFM69_MAX_DATA_LEN 61 // to take advantage of the built in AES/CRC we want to limit the frame size to the internal FIFO size (66 bytes - 3 bytes overhead - 2 bytes crc)
// INT0 on AVRs should be connected to RFM69's DIO0 (ex on ATmega328 it's D2, on ATmega644/1284 it's D2)
#if defined(__AVR_ATmega168__) || defined(__AVR_ATmega328P__) || defined(__AVR_ATmega88) || defined(__AVR_ATmega8__) || defined(__AVR_ATmega88__)
#define RF69_IRQ_PIN 2
#define RF69_IRQ_NUM 0
#elif defined(__AVR_ATmega644P__) || defined(__AVR_ATmega1284P__)
#define RF69_IRQ_PIN 2
#define RF69_IRQ_NUM 2
#elif defined(__AVR_ATmega32U4__)
#define RF69_IRQ_PIN 3
#define RF69_IRQ_NUM 0
#elif defined(__STM32F1__)
#define RF69_IRQ_PIN PA3
#define RF69_IRQ_NUM PA3
#elif defined(__arm__) //generic ARM
#define RF69_IRQ_PIN 10
#define RF69_IRQ_NUM 10
#if defined(ARDUINO_ARCH_AVR)
#if defined(__AVR_ATmega32U4__)
#define DEFAULT_RFM69_IRQ_PIN (3) //!< DEFAULT_RFM69_IRQ_PIN
#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 RF69_IRQ_PIN 2
#define RF69_IRQ_NUM 2
#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
#else
#define RF69_IRQ_PIN 2
#define RF69_IRQ_NUM 0
#define DEFAULT_RFM69_IRQ_PIN (2) //!< DEFAULT_RFM69_IRQ_PIN
#define DEFAULT_RFM69_IRQ_NUM (2) //!< DEFAULT_RFM69_IRQ_NUM
#endif
// SPI clock@2-4Mhz
#if (F_CPU>=512000000)
#define RF69_SPI_CLOCK_DIV SPI_CLOCK_DIV256
#elif (F_CPU>=256000000)
#define RF69_SPI_CLOCK_DIV SPI_CLOCK_DIV128
#elif (F_CPU>=128000000)
#define RF69_SPI_CLOCK_DIV SPI_CLOCK_DIV64
#elif (F_CPU>=64000000)
#define RF69_SPI_CLOCK_DIV SPI_CLOCK_DIV32
#elif (F_CPU>=32000000)
#define RF69_SPI_CLOCK_DIV SPI_CLOCK_DIV16
#elif (F_CPU>=16000000)
#define RF69_SPI_CLOCK_DIV SPI_CLOCK_DIV8
#elif (F_CPU>=8000000)
#define RF69_SPI_CLOCK_DIV SPI_CLOCK_DIV4
#define DEFAULT_RFM69_CS_PIN (SS) //!< DEFAULT_RFM69_CS_PIN
// SPI clock divier for non-transaction implementations
#if (MY_RFM69_SPI_SPEED >= F_CPU / 2)
#define RFM69_CLOCK_DIV SPI_CLOCK_DIV2 //!< SPI clock divider 2
#elif (MY_RFM69_SPI_SPEED >= F_CPU / 4)
#define RFM69_CLOCK_DIV SPI_CLOCK_DIV4 //!< SPI clock divider 4
#elif (MY_RFM69_SPI_SPEED >= F_CPU / 8)
#define RFM69_CLOCK_DIV SPI_CLOCK_DIV8 //!< SPI clock divider 8
#elif (MY_RFM69_SPI_SPEED >= F_CPU / 16)
#define RFM69_CLOCK_DIV SPI_CLOCK_DIV16 //!< SPI clock divider 16
#elif (MY_RFM69_SPI_SPEED >= F_CPU / 32)
#define RFM69_CLOCK_DIV SPI_CLOCK_DIV32 //!< SPI clock divider 32
#elif (MY_RFM69_SPI_SPEED >= F_CPU / 64)
#define RFM69_CLOCK_DIV SPI_CLOCK_DIV64 //!< SPI clock divider 64
#elif (MY_RFM69_SPI_SPEED >= F_CPU / 128)
#define RFM69_CLOCK_DIV SPI_CLOCK_DIV128 //!< SPI clock divider 128
#else
#define RF69_SPI_CLOCK_DIV SPI_CLOCK_DIV2
#define RFM69_CLOCK_DIV SPI_CLOCK_DIV256 //!< SPI clock divider 256
#endif
// powerup delay
#define RFM69_POWERUP_DELAY_MS (100u) //!< Power up delay, allow VCC to settle, transport to become fully operational
#define CSMA_LIMIT -90 // upper RX signal sensitivity threshold in dBm for carrier sense access
#define RF69_MODE_SLEEP 0 // XTAL OFF
#define RF69_MODE_STANDBY 1 // XTAL ON
#define RF69_MODE_SYNTH 2 // PLL ON
#define RF69_MODE_RX 3 // RX MODE
#define RF69_MODE_TX 4 // TX MODE
#define RFM69_MODE_SLEEP 0 // XTAL OFF
#define RFM69_MODE_STANDBY 1 // XTAL ON
#define RFM69_MODE_SYNTH 2 // PLL ON
#define RFM69_MODE_RX 3 // RX MODE
#define RFM69_MODE_TX 4 // TX MODE
// available frequency bands
#define RF69_315MHZ 31 // non trivial values to avoid misconfiguration
#define RF69_433MHZ 43
#define RF69_868MHZ 86
#define RF69_915MHZ 91
#define RFM69_315MHZ 31 // non trivial values to avoid misconfiguration
#define RFM69_433MHZ 43
#define RFM69_868MHZ 86
#define RFM69_915MHZ 91
#define null 0
#define COURSE_TEMP_COEF -90 // puts the temperature reading in the ballpark, user can fine tune the returned value
#define RF69_BROADCAST_ADDR 255
#define RF69_CSMA_LIMIT_MS 1000
#define RF69_TX_LIMIT_MS 1000
#define RF69_FSTEP 61.03515625 // == FXOSC / 2^19 = 32MHz / 2^19 (p13 in datasheet)
#define RFM69_BROADCAST_ADDR 255
#define RFM69_CSMA_LIMIT_MS 1000
#define RFM69_TX_LIMIT_MS 1000
#define RFM69_FXOSC (32*1000000ul) //!< The crystal oscillator frequency of the module, 32MHz
#define RFM69_FSTEP (RFM69_FXOSC / 524288ul) //!< The Frequency Synthesizer step
// TWS: define CTLbyte bits
#define RFM69_CTL_SENDACK 0x80
@@ -108,7 +115,7 @@
class RFM69
{
public:
static volatile uint8_t DATA[RF69_MAX_DATA_LEN]; //!< recv/xmit buf, including hdr & crc bytes
static volatile uint8_t DATA[RFM69_MAX_DATA_LEN]; //!< recv/xmit buf, including hdr & crc bytes
static volatile uint8_t DATALEN; //!< DATALEN
static volatile uint8_t SENDERID; //!< SENDERID
static volatile uint8_t TARGETID; //!< should match _address
@@ -127,21 +134,27 @@ public:
* @param isRFM69HW Set to @c true to indicate RFM69HW variant.
* @param interruptNum Interrupt number.
*/
RFM69(uint8_t slaveSelectPin=RF69_SPI_CS, uint8_t interruptPin=RF69_IRQ_PIN, bool isRFM69HW=false,
uint8_t interruptNum=RF69_IRQ_NUM)
RFM69(uint8_t slaveSelectPin=MY_RFM69_CS_PIN, uint8_t interruptPin=MY_RFM69_IRQ_PIN,
bool isRFM69HW=false,
uint8_t interruptNum=digitalPinToInterrupt(MY_RFM69_IRQ_PIN))
{
_slaveSelectPin = slaveSelectPin;
_interruptPin = interruptPin;
_interruptNum = interruptNum;
_mode = RF69_MODE_STANDBY;
_mode = RFM69_MODE_STANDBY;
_promiscuousMode = false;
_powerLevel = 31;
_isRFM69HW = isRFM69HW;
_address = RF69_BROADCAST_ADDR;
_address = RFM69_BROADCAST_ADDR;
#if !defined(SPI_HAS_TRANSACTION)
#if defined (SPCR) && defined (SPSR)
_SPCR = 0;
_SPSR = 0;
#endif
#if defined (SREG)
_SREG = 0;
#endif
#endif // SPI_HAS_TRANSACTION
}
bool initialize(uint8_t freqBand, uint8_t ID, uint8_t networkID=1); //!< initialize
@@ -151,8 +164,8 @@ public:
virtual void send(uint8_t toAddress, const void* buffer, uint8_t bufferSize,
bool requestACK=false); //!< send
virtual bool sendWithRetry(uint8_t toAddress, const void* buffer, uint8_t bufferSize,
uint8_t retries=2, uint8_t retryWaitTime=
40); //!< sendWithRetry (40ms roundtrip req for 61byte packets)
uint8_t retries=5, uint8_t retryWaitTime=
200); //!< sendWithRetry (40ms roundtrip req for 61byte packets, adjusted)
virtual bool receiveDone(); //!< receiveDone
bool ACKReceived(uint8_t fromNodeID); //!< ACKReceived
bool ACKRequested(); //!< ACKRequested
@@ -166,7 +179,12 @@ public:
virtual void setHighPower(bool onOFF=
true); //!< setHighPower (have to call it after initialize for RFM69HW)
virtual void setPowerLevel(uint8_t level); //!< setPowerLevel (reduce/increase transmit power level)
void sleep(); //!< sleep
void sleep(void); //!< sleep
void standBy(void); //!< standBy
void powerDown(void); //!< powerDown
void powerUp(void); //!< powerUp
void reset(void); //!< reset
bool sanityCheck(void); //!< sanityCheck
uint8_t readTemperature(uint8_t calFactor=0); //!< readTemperature (get CMOS temperature (8bit))
void rcCalibration(); //!< rcCalibration (calibrate the internal RC oscillator for use in wide temperature variations - see datasheet section [4.3.5. RC Timer Accuracy])
@@ -193,6 +211,9 @@ protected:
uint8_t _SPCR; //!< _SPCR
uint8_t _SPSR; //!< _SPSR
#endif
#if defined (SREG)
uint8_t _SREG; //!< _SREG
#endif
virtual void receiveBegin(); //!< receiveBegin
virtual void setMode(uint8_t mode); //!< setMode
drivers/RFM69/RFM69registers.h → drivers/RFM69/old/RFM69registers_old.h
View File
drivers/RFM95/RFM95.cpp
+189 -97
View File
@@ -6,7 +6,7 @@
* network topology allowing messages to be routed to nodes.
*
* Created by Henrik Ekblad <henrik.ekblad@mysensors.org>
* Copyright (C) 2013-2016 Sensnology AB
* Copyright (C) 2013-2017 Sensnology AB
* Full contributor list: https://github.com/mysensors/Arduino/graphs/contributors
*
* Documentation: http://www.mysensors.org
@@ -24,6 +24,22 @@
#include "RFM95.h"
// debug
#if defined(MY_DEBUG_VERBOSE_RFM95)
#define RFM95_DEBUG(x,...) DEBUG_OUTPUT(x, ##__VA_ARGS__) //!< Debug print
#else
#define RFM95_DEBUG(x,...) //!< DEBUG null
#endif
#if defined (SREG) // To identify AVR vs EP8266
uint8_t _SREG; // Used to save and restore the SREG values in SPI transactions
#endif
#if defined (SPCR) && defined (SPSR)
uint8_t _SPCR; //!< _SPCR
uint8_t _SPSR; //!< _SPSR
#endif
#if defined(LINUX_SPI_BCM)
// SPI RX and TX buffers (max packet len + 1 byte for the command)
uint8_t spi_rxbuff[RFM95_MAX_PACKET_LEN + 1];
@@ -34,7 +50,7 @@ volatile rfm95_internal_t RFM95; //!< internal variables
LOCAL void RFM95_csn(const bool level)
{
hwDigitalWrite(MY_RFM95_SPI_CS, level);
hwDigitalWrite(MY_RFM95_CS_PIN, level);
}
LOCAL uint8_t RFM95_spiMultiByteTransfer(const uint8_t cmd, uint8_t* buf, uint8_t len,
@@ -42,8 +58,8 @@ LOCAL uint8_t RFM95_spiMultiByteTransfer(const uint8_t cmd, uint8_t* buf, uint8_
{
uint8_t status;
uint8_t* current = buf;
#if !defined(MY_SOFTSPI)
_SPI.beginTransaction(SPISettings(MY_RFM95_SPI_MAX_SPEED, MY_RFM95_SPI_DATA_ORDER,
#if !defined(MY_SOFTSPI) && defined(SPI_HAS_TRANSACTION)
_SPI.beginTransaction(SPISettings(MY_RFM95_SPI_SPEED, MY_RFM95_SPI_DATA_ORDER,
MY_RFM95_SPI_DATA_MODE));
#endif
RFM95_csn(LOW);
@@ -88,7 +104,7 @@ LOCAL uint8_t RFM95_spiMultiByteTransfer(const uint8_t cmd, uint8_t* buf, uint8_
}
#endif
RFM95_csn(HIGH);
#if !defined(MY_SOFTSPI)
#if !defined(MY_SOFTSPI) && defined(SPI_HAS_TRANSACTION)
_SPI.endTransaction();
#endif
return status;
@@ -116,6 +132,10 @@ LOCAL bool RFM95_initialise(const float frequency)
{
RFM95_DEBUG(PSTR("RFM95:INIT\n"));
// reset radio module if rst pin defined
#if defined(MY_RFM95_POWER_PIN)
hwPinMode(MY_RFM95_POWER_PIN, OUTPUT);
#endif
RFM95_powerUp();
#if defined(MY_RFM95_RST_PIN)
hwPinMode(MY_RFM95_RST_PIN, OUTPUT);
hwDigitalWrite(MY_RFM95_RST_PIN, HIGH);
@@ -124,19 +144,25 @@ LOCAL bool RFM95_initialise(const float frequency)
hwDigitalWrite(MY_RFM95_RST_PIN, LOW);
// wait until chip ready
delay(5);
RFM95_DEBUG(PSTR("RFM95:INIT:PIN,CS=%d,IQP=%d,IQN=%d,RST=%d\n"), MY_RFM95_CS_PIN, MY_RFM95_IRQ_PIN,
MY_RFM95_IRQ_NUM,MY_RFM95_RST_PIN);
#else
RFM95_DEBUG(PSTR("RFM95:INIT:PIN,CS=%d,IQP=%d,IQN=%d\n"), MY_RFM95_CS_PIN, MY_RFM95_IRQ_PIN,
MY_RFM95_IRQ_NUM);
#endif
// set variables
RFM95.address = RFM95_BROADCAST_ADDRESS;
RFM95.rxBufferValid = false;
RFM95.ackReceived = false;
RFM95.dataReceived = false;
RFM95.txSequenceNumber = 0; // initialise TX sequence counter
RFM95.powerLevel = 0;
RFM95.ATCenabled = false;
RFM95.ATCtargetRSSI = RFM95_RSSItoInternal(RFM95_TARGET_RSSI);
// SPI init
hwDigitalWrite(MY_RFM95_SPI_CS, HIGH);
hwPinMode(MY_RFM95_SPI_CS, OUTPUT);
hwDigitalWrite(MY_RFM95_CS_PIN, HIGH);
hwPinMode(MY_RFM95_CS_PIN, OUTPUT);
_SPI.begin();
// Set LoRa mode (during sleep mode)
@@ -156,13 +182,11 @@ LOCAL bool RFM95_initialise(const float frequency)
RFM95_setModemRegisters(&configuration);
RFM95_setPreambleLength(RFM95_PREAMBLE_LENGTH);
RFM95_setFrequency(frequency);
// set power level
RFM95_setTxPower(MY_RFM95_TX_POWER);
(void)RFM95_setTxPowerLevel(MY_RFM95_TX_POWER_DBM);
// IRQ
hwPinMode(MY_RFM95_IRQ_PIN, INPUT);
#if defined (SPI_HAS_TRANSACTION) && !defined (ESP8266)
_SPI.usingInterrupt(digitalPinToInterrupt(MY_RFM95_IRQ_PIN));
#if defined(SPI_HAS_TRANSACTION) && !defined(ESP8266) && !defined(MY_SOFTSPI)
_SPI.usingInterrupt(MY_RFM95_IRQ_NUM);
#endif
if (!RFM95_sanityCheck()) {
@@ -194,20 +218,22 @@ LOCAL void RFM95_interruptHandler(void)
// Reset the fifo read ptr to the beginning of the packet
RFM95_writeReg(RFM95_REG_0D_FIFO_ADDR_PTR, RFM95_readReg(RFM95_REG_10_FIFO_RX_CURRENT_ADDR));
RFM95_burstReadReg(RFM95_REG_00_FIFO, RFM95.currentPacket.data, bufLen);
RFM95.currentPacket.RSSI = RFM95_readReg(
RFM95_REG_1A_PKT_RSSI_VALUE); // RSSI of latest packet received
RFM95.currentPacket.RSSI = static_cast<rfm95_RSSI_t>(RFM95_readReg(
RFM95_REG_1A_PKT_RSSI_VALUE)); // RSSI of latest packet received
RFM95.currentPacket.SNR = static_cast<rfm95_SNR_t>(RFM95_readReg(RFM95_REG_19_PKT_SNR_VALUE));
RFM95.currentPacket.payloadLen = bufLen - RFM95_HEADER_LEN;
// Message for us
if ((RFM95.currentPacket.header.version >= RFM95_MIN_PACKET_HEADER_VERSION) &&
(RFM95_PROMISCUOUS || RFM95.currentPacket.header.recipient == RFM95.address ||
RFM95.currentPacket.header.recipient == RFM95_BROADCAST_ADDRESS)) {
RFM95.rxBufferValid = true;
RFM95.ackReceived = RFM95_getACKReceived(RFM95.currentPacket.header.controlFlags) &&
!RFM95_getACKRequested(RFM95.currentPacket.header.controlFlags);
RFM95.dataReceived = !RFM95.ackReceived;
}
}
} else if (RFM95.radioMode == RFM95_RADIO_MODE_TX && (irqFlags & RFM95_TX_DONE) ) {
(void)RFM95_setRadioMode(RFM95_RADIO_MODE_STDBY);
(void)RFM95_setRadioMode(RFM95_RADIO_MODE_STDBY); // change eventually to RX
} else if (RFM95.radioMode == RFM95_RADIO_MODE_CAD && (irqFlags & RFM95_CAD_DONE) ) {
RFM95.cad = irqFlags & RFM95_CAD_DETECTED;
(void)RFM95_setRadioMode(RFM95_RADIO_MODE_STDBY);
@@ -219,59 +245,67 @@ LOCAL void RFM95_interruptHandler(void)
LOCAL bool RFM95_available(void)
{
if (RFM95.radioMode == RFM95_RADIO_MODE_TX) {
if (RFM95.dataReceived) {
// data received - we are still in STDBY from IRQ handler
return true;
} else if (RFM95.radioMode == RFM95_RADIO_MODE_TX) {
return false;
} else if (RFM95.radioMode != RFM95_RADIO_MODE_RX) {
// we are not in RX, and no data received
(void)RFM95_setRadioMode(RFM95_RADIO_MODE_RX);
}
(void)RFM95_setRadioMode(RFM95_RADIO_MODE_RX);
return RFM95.rxBufferValid;
return false;
}
LOCAL void RFM95_clearRxBuffer(void)
LOCAL uint8_t RFM95_recv(uint8_t* buf, const uint8_t maxBufSize)
{
noInterrupts();
RFM95.rxBufferValid = false;
interrupts();
}
LOCAL uint8_t RFM95_recv(uint8_t* buf)
{
if (!RFM95_available()) {
return false;
}
// atomic
#ifdef SREG
_SREG = SREG;
#endif
noInterrupts();
const uint8_t payloadLen = RFM95.currentPacket.payloadLen;
const uint8_t payloadLen = min(RFM95.currentPacket.payloadLen, maxBufSize);
const uint8_t sender = RFM95.currentPacket.header.sender;
const rfm95_sequenceNumber_t sequenceNumber = RFM95.currentPacket.header.sequenceNumber;
const uint8_t controlFlags = RFM95.currentPacket.header.controlFlags;
const rfm95_RSSI_t RSSI = RFM95.currentPacket.RSSI; // of incoming packet
const rfm95_controlFlags_t controlFlags = RFM95.currentPacket.header.controlFlags;
const rfm95_RSSI_t RSSI = RFM95.currentPacket.RSSI;
const rfm95_SNR_t SNR = RFM95.currentPacket.SNR;
if (buf != NULL) {
(void)memcpy((void*)buf, (void*)RFM95.currentPacket.payload, payloadLen);
RFM95.rxBufferValid = false;
RFM95.dataReceived = false;
}
interrupts();
#ifdef SREG
SREG = _SREG; // restore interrupts
#endif
interrupts(); // explicitly re-enable interrupts
// ACK handling
if (RFM95_getACKRequested(controlFlags)) {
if (RFM95_getACKRequested(controlFlags) && !RFM95_getACKReceived(controlFlags)) {
RFM95_sendACK(sender, sequenceNumber, RSSI, SNR);
}
return payloadLen;
}
LOCAL bool RFM95_send(rfm95_packet_t &packet)
LOCAL bool RFM95_sendFrame(rfm95_packet_t &packet, const bool increaseSequenceCounter)
{
const uint8_t finalLen = packet.payloadLen + RFM95_HEADER_LEN;
// Make sure we dont interrupt an outgoing message
(void)RFM95_waitPacketSent();
(void)RFM95_setRadioMode(RFM95_RADIO_MODE_STDBY);
(void)RFM95_setRadioMode(RFM95_RADIO_MODE_STDBY); //==> not needed
// Check channel activity
if (!RFM95_waitCAD()) {
return false;
}
packet.header.sequenceNumber = RFM95.txSequenceNumber++;
if (increaseSequenceCounter) {
// increase sequence counter, overflow is ok
RFM95.txSequenceNumber++;
}
packet.header.sequenceNumber = RFM95.txSequenceNumber;
// Position at the beginning of the TX FIFO
RFM95_writeReg(RFM95_REG_0D_FIFO_ADDR_PTR, RFM95_TX_FIFO_ADDR);
// write packet
@@ -279,58 +313,66 @@ LOCAL bool RFM95_send(rfm95_packet_t &packet)
// total payload length
RFM95_writeReg(RFM95_REG_22_PAYLOAD_LENGTH, finalLen);
// send message, if sent, irq fires and radio returns to standby
(void)RFM95_setRadioMode(RFM95_RADIO_MODE_TX);
return true;
return RFM95_setRadioMode(RFM95_RADIO_MODE_TX);
}
LOCAL bool RFM95_sendFrame(const uint8_t recipient, uint8_t* data, const uint8_t len,
const rfm95_flag_t flags)
LOCAL bool RFM95_send(const uint8_t recipient, uint8_t* data, const uint8_t len,
const rfm95_controlFlags_t flags, const bool increaseSequenceCounter)
{
rfm95_packet_t packet;
packet.header.version = RFM95_PACKET_HEADER_VERSION;
packet.header.sender = RFM95.address;
packet.header.recipient = recipient;
packet.header.controlFlags = 0x00;
packet.payloadLen = min(len, (uint8_t)RFM95_MAX_PAYLOAD_LEN);
packet.header.controlFlags = flags;
(void)memcpy(&packet.payload, data, packet.payloadLen);
return RFM95_send(packet);
return RFM95_sendFrame(packet, increaseSequenceCounter);
}
LOCAL void RFM95_setFrequency(const float centre)
LOCAL void RFM95_setFrequency(const uint32_t frequencyHz)
{
const uint32_t freq = (centre * 1000000.0) / RFM95_FSTEP;
RFM95_writeReg(RFM95_REG_06_FRF_MSB, (freq >> 16) & 0xff);
RFM95_writeReg(RFM95_REG_07_FRF_MID, (freq >> 8) & 0xff);
RFM95_writeReg(RFM95_REG_08_FRF_LSB, freq & 0xff);
const uint32_t freqReg = (uint32_t)(frequencyHz / RFM95_FSTEP);
RFM95_writeReg(RFM95_REG_06_FRF_MSB, (freqReg >> 16) & 0xff);
RFM95_writeReg(RFM95_REG_07_FRF_MID, (freqReg >> 8) & 0xff);
RFM95_writeReg(RFM95_REG_08_FRF_LSB, freqReg & 0xff);
}
LOCAL bool RFM95_setTxPower(uint8_t powerLevel)
LOCAL bool RFM95_setTxPowerLevel(rfm95_powerLevel_t newPowerLevel)
{
// RFM95/96/97/98 does not have RFO pins connected to anything. Only PA_BOOST
powerLevel = max((uint8_t)RFM95_MIN_POWER_LEVEL_DBM, powerLevel);
powerLevel = min((uint8_t)RFM95_MAX_POWER_LEVEL_DBM, powerLevel);
if (powerLevel != RFM95.powerLevel) {
RFM95.powerLevel = powerLevel;
newPowerLevel = max((uint8_t)RFM95_MIN_POWER_LEVEL_DBM, newPowerLevel);
newPowerLevel = min((uint8_t)RFM95_MAX_POWER_LEVEL_DBM, newPowerLevel);
if (newPowerLevel != RFM95.powerLevel) {
RFM95.powerLevel = newPowerLevel;
uint8_t val;
if (powerLevel > 20) {
if (newPowerLevel > 20) {
// enable DAC, adds 3dBm
// The documentation is pretty confusing on this topic: PaSelect says the max power is 20dBm,
// but OutputPower claims it would be 17dBm. Measurements show 20dBm is correct
RFM95_writeReg(RFM95_REG_4D_PA_DAC, RFM95_PA_DAC_ENABLE);
val = powerLevel - 8;
val = newPowerLevel - 8;
} else {
RFM95_writeReg(RFM95_REG_4D_PA_DAC, RFM95_PA_DAC_DISABLE);
val = powerLevel - 5;
val = newPowerLevel - 5;
}
RFM95_writeReg(RFM95_REG_09_PA_CONFIG, RFM95_PA_SELECT | val);
RFM95_DEBUG(PSTR("RFM95:PTX:LEVEL=%d\n"), powerLevel);
RFM95_DEBUG(PSTR("RFM95:PTX:LEVEL=%d\n"), newPowerLevel);
return true;
}
return false;
}
#if defined(MY_RFM95_TCXO)
LOCAL void RFM95_enableTCXO(void)
{
while ((RFM95_readReg(RFM95_REG_4B_TCXO) & RFM95_TCXO_TCXO_INPUT_ON) != RFM95_TCXO_TCXO_INPUT_ON) {
RFM95_sleep();
RFM95_writeReg(RFM95_REG_4B_TCXO, (RFM95_readReg(RFM95_REG_4B_TCXO) | RFM95_TCXO_TCXO_INPUT_ON));
}
}
#endif
// Sets registers from a canned modem configuration structure
LOCAL void RFM95_setModemRegisters(const rfm95_modemConfig_t* config)
{
@@ -370,6 +412,8 @@ LOCAL bool RFM95_setRadioMode(const rfm95_radioMode_t newRadioMode)
regMode = RFM95_MODE_CAD;
RFM95_writeReg(RFM95_REG_40_DIO_MAPPING1, 0x80); // Interrupt on CadDone, DIO0
} else if (newRadioMode == RFM95_RADIO_MODE_RX) {
RFM95.dataReceived = false;
RFM95.ackReceived = false;
regMode = RFM95_MODE_RXCONTINUOUS;
RFM95_writeReg(RFM95_REG_40_DIO_MAPPING1, 0x00); // Interrupt on RxDone, DIO0
} else if (newRadioMode == RFM95_RADIO_MODE_TX) {
@@ -384,54 +428,80 @@ LOCAL bool RFM95_setRadioMode(const rfm95_radioMode_t newRadioMode)
return true;
}
LOCAL void RFM95_powerUp(void)
{
#if defined(MY_RFM95_POWER_PIN)
hwDigitalWrite(MY_RFM95_POWER_PIN, HIGH);
delay(RFM95_POWERUP_DELAY_MS);
#endif
}
LOCAL void RFM95_powerDown(void)
{
#if defined(MY_RFM95_POWER_PIN)
hwDigitalWrite(RFM69_POWER_PIN, LOW);
#endif
}
LOCAL bool RFM95_sleep(void)
{
RFM95_DEBUG(PSTR("RFM95:RSL\n")); // put radio to sleep
return RFM95_setRadioMode(RFM95_RADIO_MODE_SLEEP);
}
LOCAL bool RFM95_standBy(void)
{
RFM95_DEBUG(PSTR("RFM95:RSB\n")); // put radio to standby
return RFM95_setRadioMode(RFM95_RADIO_MODE_STDBY);
}
// should be called immediately after reception in case sender wants ACK
LOCAL void RFM95_sendACK(const uint8_t recipient, const rfm95_sequenceNumber_t sequenceNumber,
const rfm95_RSSI_t RSSI, const rfm95_RSSI_t SNR)
const rfm95_RSSI_t RSSI, const rfm95_SNR_t SNR)
{
RFM95_DEBUG(PSTR("RFM95:SAC:SEND ACK to=%d,RSSI=%d\n"),recipient,RFM95_internalToRSSI(RSSI));
RFM95_DEBUG(PSTR("RFM95:SAC:SEND ACK,TO=%d,SEQ=%d,RSSI=%d,SNR=%d\n"),recipient,sequenceNumber,
RFM95_internalToRSSI(RSSI),RFM95_internalToSNR(SNR));
rfm95_ack_t ACK;
ACK.sequenceNumber = sequenceNumber;
ACK.RSSI = RSSI;
ACK.SNR = SNR;
rfm95_flag_t flags = 0x00;
rfm95_controlFlags_t flags = 0x00;
RFM95_setACKReceived(flags, true);
RFM95_setACKRSSIReport(flags, true);
(void)RFM95_sendFrame(recipient, (uint8_t*)&ACK, sizeof(rfm95_ack_t), flags);
(void)RFM95_send(recipient, (uint8_t*)&ACK, sizeof(rfm95_ack_t), flags);
}
LOCAL bool RFM95_executeATC(const rfm95_RSSI_t currentRSSI, const rfm95_RSSI_t targetRSSI)
{
// RFM95 internal format RSSI has an offset
if (currentRSSI < (targetRSSI * (1 + RFM95_ATC_TARGET_RANGE_PERCENT / 100)) &&
rfm95_powerLevel_t newPowerLevel = RFM95.powerLevel;
if (RFM95_internalToRSSI(currentRSSI) < RFM95_internalToRSSI(targetRSSI *
(1 + RFM95_ATC_TARGET_RANGE_PERCENT / 100)) &&
RFM95.powerLevel < RFM95_MAX_POWER_LEVEL_DBM) {
// increase transmitter power
RFM95.powerLevel++;
} else if (currentRSSI > (targetRSSI * (1 - RFM95_ATC_TARGET_RANGE_PERCENT / 100)) &&
newPowerLevel++;
} else if (RFM95_internalToRSSI(currentRSSI) > RFM95_internalToRSSI(targetRSSI *
(1 - RFM95_ATC_TARGET_RANGE_PERCENT / 100)) &&
RFM95.powerLevel > RFM95_MIN_POWER_LEVEL_DBM) {
// decrease transmitter power
RFM95.powerLevel--;
newPowerLevel--;
} else {
// nothing to adjust
return false;
}
RFM95_DEBUG(PSTR("RFM95:ATC:ADJ TXL,cR=%d,tR=%d,TXL=%d\n"), RFM95_internalToRSSI(currentRSSI),
RFM95_internalToRSSI(targetRSSI), RFM95.powerLevel);
return RFM95_setTxPower(RFM95.powerLevel);;
return RFM95_setTxPowerLevel(newPowerLevel);
}
LOCAL bool RFM95_sendWithRetry(const uint8_t recipient, const void* buffer,
const uint8_t bufferSize, const uint8_t retries, const uint32_t retryWaitTime)
{
for (uint8_t retry = 0; retry < retries; retry++) {
RFM95_DEBUG(PSTR("RFM95:SWR:SEND TO=%d,RETRY=%d\n"), recipient, retry);
rfm95_flag_t flags = 0x00;
for (uint8_t retry = 0; retry <= retries; retry++) {
RFM95_DEBUG(PSTR("RFM95:SWR:SEND,TO=%d,SEQ=%d,RETRY=%d\n"), recipient, RFM95.txSequenceNumber,
retry);
rfm95_controlFlags_t flags = 0x00;
RFM95_setACKRequested(flags, (recipient != RFM95_BROADCAST_ADDRESS));
(void)RFM95_sendFrame(recipient, (uint8_t*)buffer, bufferSize, flags);
(void)RFM95_send(recipient, (uint8_t*)buffer, bufferSize, flags, !retry);
(void)RFM95_waitPacketSent();
(void)RFM95_setRadioMode(RFM95_RADIO_MODE_RX);
if (recipient == RFM95_BROADCAST_ADDRESS) {
@@ -439,20 +509,23 @@ LOCAL bool RFM95_sendWithRetry(const uint8_t recipient, const void* buffer,
}
const uint32_t enterMS = hwMillis();
while (hwMillis() - enterMS < retryWaitTime) {
if (RFM95.rxBufferValid) {
if (RFM95.ackReceived) {
const uint8_t sender = RFM95.currentPacket.header.sender;
const rfm95_sequenceNumber_t ACKsequenceNumber = RFM95.currentPacket.ACK.sequenceNumber;
const rfm95_flag_t flag = RFM95.currentPacket.header.controlFlags;
if (sender == recipient && RFM95_getACKReceived(flag) &&
(ACKsequenceNumber == RFM95.txSequenceNumber - 1)) {
RFM95_DEBUG(PSTR("RFM95:SWR:ACK FROM=%d,SEQ=%d,RSSI=%d,SNR=%d\n"),sender,ACKsequenceNumber,
RFM95_internalToRSSI(RFM95.currentPacket.ACK.RSSI),
RFM95_internalToSNR(RFM95.currentPacket.ACK.SNR));
RFM95_clearRxBuffer();
const rfm95_controlFlags_t flag = RFM95.currentPacket.header.controlFlags;
const rfm95_RSSI_t RSSI = RFM95.currentPacket.ACK.RSSI;
//const rfm95_SNR_t SNR = RFM95.currentPacket.ACK.SNR;
RFM95.ackReceived = false;
// packet read, back to RX
RFM95_setRadioMode(RFM95_RADIO_MODE_RX);
if (sender == recipient &&
(ACKsequenceNumber == RFM95.txSequenceNumber)) {
RFM95_DEBUG(PSTR("RFM95:SWR:ACK FROM=%d,SEQ=%d,RSSI=%d\n"),sender,ACKsequenceNumber,
RFM95_internalToRSSI(RSSI));
//RFM95_clearRxBuffer();
// ATC
if (RFM95.ATCenabled && RFM95_getACKRSSIReport(flag)) {
(void)RFM95_executeATC(RFM95.currentPacket.ACK.RSSI, RFM95.ATCtargetRSSI);
(void)RFM95_executeATC(RSSI, RFM95.ATCtargetRSSI);
} // ATC
return true;
} // seq check
@@ -460,11 +533,16 @@ LOCAL bool RFM95_sendWithRetry(const uint8_t recipient, const void* buffer,
doYield();
}
RFM95_DEBUG(PSTR("!RFM95:SWR:NACK\n"));
if (RFM95.ATCenabled) {
// No ACK received, maybe out of reach: increase power level
(void)RFM95_setTxPower(RFM95.powerLevel++);
const uint32_t enterCSMAMS = hwMillis();
const uint16_t randDelayCSMA = enterMS & 100;
while (hwMillis() - enterCSMAMS < randDelayCSMA) {
doYield();
}
}
if (RFM95.ATCenabled) {
// No ACK received, maybe out of reach: increase power level
(void)RFM95_setTxPowerLevel(RFM95.powerLevel + 1);
}
return false;
}
@@ -511,39 +589,53 @@ LOCAL int16_t RFM95_getSendingRSSI(void)
return RFM95_internalToRSSI(RFM95.currentPacket.ACK.RSSI);
} else {
// not possible
return RFM95_RSSI_INVALID;
return INVALID_RSSI;
}
}
LOCAL int8_t RFM95_getSendingSNR(void)
LOCAL int16_t RFM95_getSendingSNR(void)
{
// own SNR, as measured by the recipient - ACK part
if (RFM95_getACKRSSIReport(RFM95.currentPacket.header.controlFlags)) {
return RFM95_internalToSNR(RFM95.currentPacket.ACK.SNR);
return static_cast<int16_t>(RFM95_internalToSNR(RFM95.currentPacket.ACK.SNR));
} else {
// not possible
return RFM95_SNR_INVALID;
return INVALID_SNR;
}
}
LOCAL int16_t RFM95_getReceivingRSSI(void)
{
// RSSI from last received packet
return RFM95_internalToRSSI(RFM95.currentPacket.RSSI);
return static_cast<int16_t>(RFM95_internalToRSSI(RFM95.currentPacket.RSSI));
}
LOCAL int8_t RFM95_getReceivingSNR(void)
LOCAL int16_t RFM95_getReceivingSNR(void)
{
// SNR from last received packet
return RFM95_internalToSNR(RFM95.currentPacket.SNR);
return static_cast<int16_t>(RFM95_internalToSNR(RFM95.currentPacket.SNR));
}
LOCAL uint8_t RFM95_getTxPowerLevel(void)
{
return RFM95.powerLevel;
}
LOCAL uint8_t RFM95_getTxPowerPercent(void)
{
// report TX level in %
const uint8_t result = (uint8_t)(100.0f * (RFM95.powerLevel - RFM95_MIN_POWER_LEVEL_DBM) /
(RFM95_MAX_POWER_LEVEL_DBM
- RFM95_MIN_POWER_LEVEL_DBM));
const uint8_t result = static_cast<uint8_t>(100.0f * (RFM95.powerLevel -
RFM95_MIN_POWER_LEVEL_DBM) /
(RFM95_MAX_POWER_LEVEL_DBM
- RFM95_MIN_POWER_LEVEL_DBM));
return result;
}
LOCAL bool RFM95_setTxPowerPercent(const uint8_t newPowerPercent)
{
const rfm95_powerLevel_t newPowerLevel = static_cast<rfm95_powerLevel_t>
(RFM95_MIN_POWER_LEVEL_DBM + (RFM95_MAX_POWER_LEVEL_DBM
- RFM95_MIN_POWER_LEVEL_DBM) * (newPowerPercent / 100.0f));
RFM95_DEBUG(PSTR("RFM95:SPP:PCT=%d,TX LEVEL=%d\n"), newPowerPercent,newPowerLevel);
return RFM95_setTxPowerLevel(newPowerLevel);
}
drivers/RFM95/RFM95.h
+149 -76
View File
@@ -6,7 +6,7 @@
* network topology allowing messages to be routed to nodes.
*
* Created by Henrik Ekblad <henrik.ekblad@mysensors.org>
* Copyright (C) 2013-2016 Sensnology AB
* Copyright (C) 2013-2017 Sensnology AB
* Full contributor list: https://github.com/mysensors/Arduino/graphs/contributors
*
* Documentation: http://www.mysensors.org
@@ -18,7 +18,7 @@
*
* Based on Mike McCauley's RFM95 library, Copyright (C) 2014 Mike McCauley <mikem@airspayce.com>
* Radiohead http://www.airspayce.com/mikem/arduino/RadioHead/index.html
* RFM95 driver refactored and optimized for MySensors, Copyright (C) 2016 Olivier Mauti <olivier@mysensors.org>
* RFM95 driver refactored and optimized for MySensors, Copyright (C) 2017 Olivier Mauti <olivier@mysensors.org>
*
* Changelog:
* - ACK with sequenceNumber
@@ -41,16 +41,18 @@
* - [!] Exclamation mark is prepended in case of error
*
* |E| SYS | SUB | Message | Comment
* |-|-------|-------|-----------------------------------|---------------------------------------------------------------------
* |-|-------|-------|-----------------------------------|-----------------------------------------------------------------------------------
* | | RFM95 | INIT | | Initialise RFM95 radio
* | | RFM95 | INIT | PIN,CS=%d,IQP=%d,IQN=%d[,RST=%d] | Pin configuration: chip select (CS), IRQ pin (IQP), IRQ number (IQN), Reset (RST)
* |!| RFM95 | INIT | SANCHK FAIL | Sanity check failed, check wiring or replace module
* | | RFM95 | RCV | SEND ACK | ACK request received, sending ACK back
* | | RFM95 | PTC | LEVEL=%d | Set TX power level
* | | RFM95 | SAC | SEND ACK TO=%d,RSSI=%d | Send ACK to node (TO), RSSI of received message (RSSI)
* | | RFM95 | SAC | SEND ACK,TO=%d,RSSI=%d,SNR=%d | Send ACK to node (TO), RSSI of received message (RSSI), SNR of message (SNR)
* | | RFM95 | ATC | ADJ TXL,cR=%d,tR=%d,TXL=%d | Adjust TX level, current RSSI (cR), target RSSI (tR), TX level (TXL)
* | | RFM95 | SWR | SEND TO=%d,RETRY=%d | Send message to (TO), NACK retry counter (RETRY)
* | | RFM95 | SWR | SEND,TO=%d,RETRY=%d | Send message to (TO), NACK retry counter (RETRY)
* | | RFM95 | SWR | ACK FROM=%d,SEQ=%d,RSSI=%d,SNR=%d | ACK received from node (FROM), seq ID (SEQ), (RSSI), (SNR)
* |!| RFM95 | SWR | NACK | No ACK received
* | | RFM95 | SPP | PCT=%d,TX LEVEL=%d | Set TX level, input TX percent (PCT)
*
* RFM95 modem configuration
*
@@ -58,12 +60,14 @@
* CR = Error correction code
* SF = Spreading factor, chips / symbol
*
* | CONFIG | REG_1D | REG_1E | REG_26 | BW | CR | SF | Comment
* |------------------|--------|--------|--------|-------|-----|------|-----------------------------
* | BW125CR45SF128 | 0x72 | 0x74 | 0x04 | 125 | 4/5 | 128 | Default, medium range
* | BW500CR45SF128 | 0x92 | 0x74 | 0x04 | 500 | 4/5 | 128 | Fast, short range
* | BW31_25CR48SF512 | 0x48 | 0x94 | 0x04 | 31.25 | 4/8 | 512 | Slow, long range
* | BW125CR48SF4096 | 0x78 | 0xC4 | 0x0C | 125 | 4/8 | 4096 | Slow, long range
* | CONFIG | REG_1D | REG_1E | REG_26 | BW | CR | SF | Comment | air-time (~15 bytes)
* |------------------|--------|--------|--------|-------|-----|------|------------------------------------------------
* | BW125CR45SF128 | 0x72 | 0x74 | 0x04 | 125 | 4/5 | 128 | Default, medium range | 50ms
* | BW500CR45SF128 | 0x92 | 0x74 | 0x04 | 500 | 4/5 | 128 | Fast, short range | 15ms
* | BW31_25CR48SF512 | 0x48 | 0x94 | 0x04 | 31.25 | 4/8 | 512 | Slow, long range | 900ms
* | BW125CR48SF4096 | 0x78 | 0xC4 | 0x0C | 125 | 4/8 | 4096 | Slow, long range | 1500ms
*
* See here for air-time calculation: https://docs.google.com/spreadsheets/d/1voGAtQAjC1qBmaVuP1ApNKs1ekgUjavHuVQIXyYSvNc/edit#gid=0
*
* @brief API declaration for RFM95
*
@@ -75,32 +79,38 @@
#include "RFM95registers.h"
// default PIN assignments, can be overridden
#if defined(__AVR_ATmega168__) || defined(__AVR_ATmega328P__) || defined(__AVR_ATmega328PB__) || defined(__AVR_ATmega88) || defined(__AVR_ATmega8__) || defined(__AVR_ATmega88__)
#define RFM95_IRQ_PIN (2) //!< RFM95_IRQ_PIN
#define RFM95_RST_PIN (9) //!< RFM95_RST_PIN
#elif defined(__AVR_ATmega644P__) || defined(__AVR_ATmega1284P__)
#define RFM95_IRQ_PIN (2)
#define RFM95_RST_PIN (9) //!< RFM95_RST_PIN
#elif defined(__AVR_ATmega32U4__)
#define RFM95_IRQ_PIN (3) //!< RFM95_IRQ_PIN
#define RFM95_RST_PIN (9) //!< RFM95_RST_PIN
#elif defined(__arm__)
#define RFM95_IRQ_PIN (10) //!< RFM95_IRQ_PIN
#define RFM95_RST_PIN (27) //!< RFM95_RST_PIN
#if defined(ARDUINO_ARCH_AVR)
#if defined(__AVR_ATmega32U4__)
#define DEFAULT_RFM95_IRQ_PIN (3) //!< DEFAULT_RFM95_IRQ_PIN
#else
#define RFM95_IRQ_PIN (2) //!< RFM95_IRQ_PIN
#define RFM95_RST_PIN (9) //!< RFM95_RST_PIN
#define DEFAULT_RFM95_IRQ_PIN (2) //!< DEFAULT_RFM95_IRQ_PIN
#endif
#define RFM95_SPI_CS (SS) //!< RFM95_SPI_CS
#define DEFAULT_RFM95_IRQ_NUM digitalPinToInterrupt(DEFAULT_RFM95_IRQ_PIN) //!< DEFAULT_RFM95_IRQ_NUM
#elif defined(ARDUINO_ARCH_ESP8266)
#define DEFAULT_RFM95_IRQ_PIN (2) //!< DEFAULT_RFM95_IRQ_PIN
#define DEFAULT_RFM95_IRQ_NUM digitalPinToInterrupt(DEFAULT_RFM95_IRQ_PIN) //!< DEFAULT_RFM95_IRQ_NUM
#elif defined(ARDUINO_ARCH_ESP32)
#warning not implemented yet
#elif defined(ARDUINO_ARCH_SAMD)
#define DEFAULT_RFM95_IRQ_PIN (2) //!< DEFAULT_RFM95_IRQ_PIN
#define DEFAULT_RFM95_IRQ_NUM digitalPinToInterrupt(DEFAULT_RFM95_IRQ_PIN) //!< DEFAULT_RFM95_IRQ_NUM
#elif defined(LINUX_ARCH_RASPBERRYPI)
#define DEFAULT_RFM95_IRQ_PIN (22) //!< DEFAULT_RFM95_IRQ_PIN
#define DEFAULT_RFM95_IRQ_NUM DEFAULT_RFM95_IRQ_PIN //!< DEFAULT_RFM95_IRQ_NUM
#elif defined(ARDUINO_ARCH_STM32F1)
#define DEFAULT_RFM95_IRQ_PIN (PA3) //!< DEFAULT_RFM95_IRQ_PIN
#define DEFAULT_RFM95_IRQ_NUM DEFAULT_RFM95_IRQ_PIN //!< DEFAULT_RFM95_IRQ_NUM
#else
#define DEFAULT_RFM95_IRQ_PIN (2) //!< DEFAULT_RFM95_IRQ_PIN
#define DEFAULT_RFM95_IRQ_NUM DEFAULT_RFM95_IRQ_PIN //!< DEFAULT_RFM95_IRQ_NUM
#endif
#define DEFAULT_RFM95_CS_PIN (SS) //!< DEFAULT_RFM95_CS_PIN
// SPI settings
#if !defined(MY_RFM95_SPI_MAX_SPEED)
#define MY_RFM95_SPI_MAX_SPEED (4*1000000ul) //!< Max SPI speed, 4Mhz
#endif
#define MY_RFM95_SPI_DATA_ORDER MSBFIRST //!< SPI data order
#define MY_RFM95_SPI_DATA_MODE SPI_MODE0 //!< SPI mode
#if defined (ARDUINO) && !defined (__arm__) && !defined (_SPI)
#include <SPI.h>
#if defined(MY_SOFTSPI)
@@ -121,21 +131,36 @@ extern HardwareSPI SPI; //!< SPI
#endif
#endif
// debug
#if defined(MY_DEBUG_VERBOSE_RFM95)
#define RFM95_DEBUG(x,...) debug(x, ##__VA_ARGS__) //!< Debug print
#else
#define RFM95_DEBUG(x,...) //!< Debug null
// RFM95 radio configurations: reg_1d, reg_1e, reg_26 (see datasheet)
#define RFM95_BW125CR45SF128 RFM95_BW_125KHZ | RFM95_CODING_RATE_4_5, RFM95_SPREADING_FACTOR_128CPS | RFM95_RX_PAYLOAD_CRC_ON, RFM95_AGC_AUTO_ON //!< 0x72,0x74,0x04
#define RFM95_BW500CR45SF128 RFM95_BW_500KHZ | RFM95_CODING_RATE_4_5, RFM95_SPREADING_FACTOR_128CPS | RFM95_RX_PAYLOAD_CRC_ON, RFM95_AGC_AUTO_ON //!< 0x92,0x74,0x04
#define RFM95_BW31_25CR48SF512 RFM95_BW_31_25KHZ | RFM95_CODING_RATE_4_8, RFM95_SPREADING_FACTOR_512CPS | RFM95_RX_PAYLOAD_CRC_ON, RFM95_AGC_AUTO_ON //!< 0x48,0x94,0x04
#define RFM95_BW125CR48SF4096 RFM95_BW_125KHZ | RFM95_CODING_RATE_4_8, RFM95_SPREADING_FACTOR_4096CPS | RFM95_RX_PAYLOAD_CRC_ON, RFM95_AGC_AUTO_ON | RFM95_LOW_DATA_RATE_OPTIMIZE //!< 0x78,0xc4,0x0C
#if !defined(RFM95_RETRY_TIMEOUT_MS)
// air-time approximation for timeout, 1 hop ~15 bytes payload - adjust if needed
// BW125/SF128: 50ms
// BW500/SF128: 15ms
// BW31.25/SF512: 900ms
// BW125/SF4096: 1500ms
#define RFM95_RETRY_TIMEOUT_MS (500ul) //!< Timeout for ACK, adjustments needed if modem configuration changed (air time different)
#endif
// Frequency definitions
#define RFM95_169MHZ (169000000ul) //!< 169 Mhz
#define RFM95_315MHZ (315000000ul) //!< 315 Mhz
#define RFM95_434MHZ (433920000ul) //!< 433.92 Mhz
#define RFM95_868MHZ (868100000ul) //!< 868.1 Mhz
#define RFM95_915MHZ (915000000ul) //!< 915 Mhz
#define RFM95_RETRIES (5u) //!< Retries in case of failed transmission
#define RFM95_FIFO_SIZE (0xFFu) //!< Max number of bytes the LORA Rx/Tx FIFO can hold
#define RFM95_RX_FIFO_ADDR (0x00u) //!< RX FIFO addr pointer
#define RFM95_TX_FIFO_ADDR (0x80u) //!< TX FIFO addr pointer
#define RFM95_MAX_PACKET_LEN (0x40u) //!< This is the maximum number of bytes that can be carried by the LORA
#define RFM95_PREAMBLE_LENGTH (8u) //!< Preamble length, default=8
#define RFM95_RETRIES (2u) //!< Retries in case of failed transmission
#define RFM95_RETRY_TIMEOUT_MS (500ul) //!< Timeout for ACK, adjustments needed if modem configuration changed (air time different)
#define RFM95_CAD_TIMEOUT_MS (2*1000ul) //!< channel activity detection timeout
#define RFM95_POWERUP_DELAY_MS (100u) //!< Power up delay, allow VCC to settle, transport to become fully operational
#define RFM95_PACKET_HEADER_VERSION (1u) //!< RFM95 packet header version
#define RFM95_MIN_PACKET_HEADER_VERSION (1u) //!< Minimal RFM95 packet header version
@@ -147,12 +172,10 @@ extern HardwareSPI SPI; //!< SPI
#define RFM95_ATC_TARGET_RANGE_PERCENT (5u) //!< ATC target range +/-%
#define RFM95_RSSI_OFFSET (137u) //!< RSSI offset
#define RFM95_TARGET_RSSI (-60) //!< RSSI target
#define RFM95_RSSI_INVALID (127) //!< RSSI invalid
#define RFM95_SNR_INVALID (127) //!< SNR invalid
#define RFM95_PROMISCUOUS (false) //!< RFM95 promiscuous mode
#define RFM95_FXOSC (32*1000000ul) //!< The crystal oscillator frequency of the module
#define RFM95_FSTEP (RFM95_FXOSC / 524288ul) //!< The Frequency Synthesizer step = RFM95_FXOSC /
#define RFM95_FSTEP (RFM95_FXOSC / 524288.0f) //!< The Frequency Synthesizer step = RFM95_FXOSC /
// helper macros
#define RFM95_getACKRequested(__value) ((bool)bitRead(__value, RFM95_BIT_ACK_REQUESTED)) //!< getACKRequested
@@ -165,16 +188,10 @@ extern HardwareSPI SPI; //!< SPI
#define RFM95_RSSItoInternal(__value) ((uint8_t)(__value + RFM95_RSSI_OFFSET)) //!< Convert RSSI to internal RSSI
#define RFM95_internalToSNR(__value) ((int8_t)(__value / 4)) //!< Convert internal SNR to SNR
// RFM95 radio configurations: reg_1d, reg_1e, reg_26 (see datasheet)
#define RFM95_BW125CR45SF128 RFM95_BW_125KHZ | RFM95_CODING_RATE_4_5, RFM95_SPREADING_FACTOR_128CPS | RFM95_RX_PAYLOAD_CRC_ON, RFM95_AGC_AUTO_ON //!< 0x72,0x74,0x04
#define RFM95_BW500CR45SF128 RFM95_BW_500KHZ | RFM95_CODING_RATE_4_5, RFM95_SPREADING_FACTOR_128CPS | RFM95_RX_PAYLOAD_CRC_ON, RFM95_AGC_AUTO_ON //!< 0x92,0x74,0x04
#define RFM95_BW31_25CR48SF512 RFM95_BW_31_25KHZ | RFM95_CODING_RATE_4_8, RFM95_SPREADING_FACTOR_512CPS | RFM95_RX_PAYLOAD_CRC_ON, RFM95_AGC_AUTO_ON //!< 0x48,0x94,0x04
#define RFM95_BW125CR48SF4096 RFM95_BW_125KHZ | RFM95_CODING_RATE_4_8, RFM95_SPREADING_FACTOR_4096CPS | RFM95_RX_PAYLOAD_CRC_ON, RFM95_AGC_AUTO_ON | RFM95_LOW_DATA_RATE_OPTIMIZE //!< 0x78,0xc4,0x0C
#define RFM95_MIN_POWER_LEVEL_DBM (5u) //!< min. power level
#define RFM95_MAX_POWER_LEVEL_DBM (23u) //!< max. power level
#define RFM95_MIN_POWER_LEVEL_DBM ((rfm95_powerLevel_t)5u) //!< min. power level
#if !defined(RFM95_MAX_POWER_LEVEL_DBM)
#define RFM95_MAX_POWER_LEVEL_DBM ((rfm95_powerLevel_t)23u) //!< max. power level
#endif
/**
* @brief Radio modes
*/
@@ -210,7 +227,11 @@ typedef int8_t rfm95_SNR_t;
/**
* @brief Control flag data type
*/
typedef uint8_t rfm95_flag_t;
typedef uint8_t rfm95_controlFlags_t;
/**
* @brief Power level in dBm
*/
typedef int8_t rfm95_powerLevel_t;
/**
* @brief RFM95 LoRa header
*/
@@ -218,7 +239,7 @@ typedef struct {
uint8_t version; //!< Header version
uint8_t recipient; //!< Payload recipient
uint8_t sender; //!< Payload sender
rfm95_flag_t controlFlags; //!< Control flags, used for ACK
rfm95_controlFlags_t controlFlags; //!< Control flags, used for ACK
rfm95_sequenceNumber_t sequenceNumber; //!< Packet sequence number, used for ACK
} __attribute__((packed)) rfm95_header_t;
@@ -262,14 +283,15 @@ typedef struct {
uint8_t address; //!< Node address
rfm95_packet_t currentPacket; //!< Buffer for current packet
rfm95_sequenceNumber_t txSequenceNumber; //!< RFM95_txSequenceNumber
uint8_t powerLevel; //!< TX power level dBm
uint8_t ATCtargetRSSI; //!< ATC: target RSSI
rfm95_powerLevel_t powerLevel; //!< TX power level dBm
rfm95_RSSI_t ATCtargetRSSI; //!< ATC: target RSSI
// 8 bit
rfm95_radioMode_t radioMode : 3; //!< current transceiver state
bool cad : 1; //!< RFM95_cad
bool rxBufferValid : 1; //!< RX buffer valid
bool ATCenabled : 1; //!< ATC enabled
uint8_t reserved : 2; //!< reserved
bool ackReceived : 1; //!< ACK received
bool dataReceived : 1; //!< AData received
uint8_t reserved : 1; //!< reserved
} rfm95_internal_t;
#define LOCAL static //!< static
@@ -304,25 +326,28 @@ LOCAL bool RFM95_available(void);
/**
* @brief If a valid message is received, copy it to buf and return length. 0 byte messages are permitted.
* @param buf Location to copy the received message
* @param maxBufSize Max buffer size
* @return Number of bytes
*/
LOCAL uint8_t RFM95_recv(uint8_t* buf);
LOCAL uint8_t RFM95_recv(uint8_t* buf, const uint8_t maxBufSize);
/**
* @brief RFM95_send
* @param packet
* @return True if packet sent
*/
LOCAL bool RFM95_send(rfm95_packet_t &packet);
/**
* @brief RFM95_sendFrame
* @param recipient
* @param data
* @param len
* @param flags
* @param increaseSequenceCounter
* @return True if packet sent
*/
LOCAL bool RFM95_send(const uint8_t recipient, uint8_t* data, const uint8_t len,
const rfm95_controlFlags_t flags, const bool increaseSequenceCounter = true);
/**
* @brief RFM95_sendFrame
* @param packet
* @param increaseSequenceCounter
* @return True if frame sent
*/
LOCAL bool RFM95_sendFrame(const uint8_t recipient, uint8_t* data, const uint8_t len,
const rfm95_flag_t flags);
LOCAL bool RFM95_sendFrame(rfm95_packet_t &packet, const bool increaseSequenceCounter = true);
/**
* @brief RFM95_setPreambleLength
* @param preambleLength
@@ -330,29 +355,62 @@ LOCAL bool RFM95_sendFrame(const uint8_t recipient, uint8_t* data, const uint8_t
LOCAL void RFM95_setPreambleLength(const uint16_t preambleLength);
/**
* @brief Sets the transmitter and receiver centre frequency
* @param centre Frequency in MHz (137.0 to 1020.0)
* @param frequencyHz Frequency in Hz
*/
LOCAL void RFM95_setFrequency(const float centre);
LOCAL void RFM95_setFrequency(const uint32_t frequencyHz);
/**
* @brief Sets the transmitter power output level, and configures the transmitter pin
* @param powerLevel Transmitter power level in dBm (+5 to +23)
* @param newPowerLevel Transmitter power level in dBm (+5 to +23)
* @return True power level adjusted
*/
LOCAL bool RFM95_setTxPower(uint8_t powerLevel);
LOCAL bool RFM95_setTxPowerLevel(rfm95_powerLevel_t newPowerLevel);
/**
* @brief Sets the transmitter power output percent.
* @param newPowerPercent Transmitter power level in percent
* @return True power level adjusted
*/
LOCAL bool RFM95_setTxPowerPercent(const uint8_t newPowerPercent);
#if defined(MY_RFM95_TCXO)
/**
* @brief Enable TCXO mode
* Call this immediately after init(), to force your radio to use an external
* frequency source, such as a Temperature Compensated Crystal Oscillator (TCXO).
* See the comments in the main documentation about the sensitivity of this radio to
* clock frequency especially when using narrow bandwidths.
* Leaves the module in sleep mode.
*/
LOCAL void RFM95_enableTCXO(void);
#endif
/**
* @brief Sets the radio into low-power sleep mode
* @return true if sleep mode was successfully entered
*/
LOCAL bool RFM95_sleep(void);
/**
* @brief Sets the radio into standby mode
* @return true if standby mode was successfully entered
*/
LOCAL bool RFM95_standBy(void);
/**
* @brief Powerdown radio, if RFM95_POWER_PIN defined
*/
LOCAL void RFM95_powerDown(void);
/**
* @brief Powerup radio, if RFM95_POWER_PIN defined
*/
LOCAL void RFM95_powerUp(void);
/**
* @brief RFM95_sendACK
* @param recipient
* @param sequenceNumber
* @param RSSI (rfm95_RSSI_t)
* @param SNR (rfm95_RSSI_t)
* @param SNR (rfm95_SNR_t)
*/
LOCAL void RFM95_sendACK(const uint8_t recipient, const rfm95_sequenceNumber_t sequenceNumber,
const rfm95_RSSI_t RSSI, const rfm95_RSSI_t SNR);
const rfm95_RSSI_t RSSI, const rfm95_SNR_t SNR);
/**
* @brief RFM95_sendWithRetry
* @param recipient
@@ -386,21 +444,36 @@ LOCAL bool RFM95_setRadioMode(const rfm95_radioMode_t newRadioMode);
*/
LOCAL void RFM95_interruptHandler(void);
/**
* @brief RFM95_clearRxBuffer
*/
LOCAL void RFM95_clearRxBuffer(void);
/**
* @brief RFM95_getSendingRSSI
* @return RSSI Signal strength of last packet received
*/
LOCAL int16_t RFM95_getReceivingRSSI(void);
/**
* @brief RFM95_getSendingRSSI
* @return RSSI Signal strength of last packet sent (if ACK and ATC enabled)
*/
LOCAL int16_t RFM95_getSendingRSSI(void);
/**
* @brief RFM95_getReceivingSNR
* @return SNR
*/
LOCAL int16_t RFM95_getReceivingSNR(void);
/**
* @brief RFM95_getSendingSNR
* @return SNR of last packet sent (if ACK and ATC enabled)
*/
LOCAL int16_t RFM95_getSendingSNR(void);
/**
* @brief Get transmitter power level
* @return Transmitter power level in percents
*/
LOCAL uint8_t RFM95_getTxPowerPercent(void);
/**
* @brief Get transmitter power level
* @return Transmitter power level in dBm
*/
LOCAL uint8_t RFM95_getTxPowerLevel(void);
/**
* @brief RFM_executeATC
* @param currentRSSI
* @param targetRSSI
drivers/RFM95/RFM95registers.h
+3
View File
@@ -200,6 +200,9 @@
#define RFM95_LOW_DATA_RATE_OPTIMIZE 0x08 //!< LOW_DATA_RATE_OPTIMIZE
#define RFM95_AGC_AUTO_ON 0x04 //!< AGC_AUTO_ON
// RFM95_REG_4B_TCXO 0x4b
#define RFM95_TCXO_TCXO_INPUT_ON 0x10 //!< TCXO_TCXO_INPUT_ON
// RFM95_REG_4D_PA_DAC 0x4d
#define RFM95_PA_DAC_DISABLE 0x04 //!< PA_DAC_DISABLE
#define RFM95_PA_DAC_ENABLE 0x07 //!< PA_DAC_ENABLE