iotmanager/IoTManager
1
0
Fork 0
mirror of https://github.com/IoTManagerProject/IoTManager.git synced 2026-03-30 20:09:14 +03:00
Code Issues Packages Projects Releases Wiki Activity

gatewayTransportSend

Browse Source
This commit is contained in:
Dmitry Borisenko
2022-12-01 02:10:06 +01:00
parent 2c61580157
commit cb50965c3b
293 changed files with 67232 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1037
lib/MySensors/hal/transport/RFM69/driver/new/RFM69_new.cpp Normal file
View File

File diff suppressed because it is too large Load Diff

561
lib/MySensors/hal/transport/RFM69/driver/new/RFM69_new.h Normal file
View File

@@ -0,0 +1,561 @@
/*
* 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-2019 Sensnology AB
* Full contributor list: https://github.com/mysensors/MySensors/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, 2018 Olivier Mauti <olivier@mysensors.org>
*
* Changes by : @tekka, @scalz, @marceloagno
*
* Definitions for Semtech SX1231/H radios:
* https://www.semtech.com/uploads/documents/sx1231.pdf
* https://www.semtech.com/uploads/documents/sx1231h.pdf
*/
/**
* @file RFM69_new.h
*
* @defgroup RFM69Newgrp RFM69New
* @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 | HWV=%%d | HW version, see datasheet chapter 9
* |!| RFM69 | INIT | SANCHK FAIL | Sanity check failed, check wiring or replace module
* | | RFM69 | PTX | NO ADJ | TX power level, no adjustment
* | | RFM69 | PTX | LEVEL=%%d dbM | TX power level, set to (LEVEL) dBm
* | | RFM69 | SAC | SEND ACK,TO=%%d,RSSI=%%d | ACK sent to (TO), RSSI of incoming message (RSSI)
* | | RFM69 | ATC | ADJ TXL,cR=%%d,tR=%%d..%%d,TXL=%%d | Adjust TX level, current RSSI (cR), target RSSI range (tR), TX level (TXL)
* | | RFM69 | SWR | SEND,TO=%%d,SEQ=%%d,RETRY=%%d | Send to (TO), sequence number (SWQ), retry if no ACK received (RETRY)
* | | RFM69 | SWR | ACK,FROM=%%d,SEQ=%%d,RSSI=%%d | ACK received from (FROM), sequence nr (SEQ), ACK RSSI (RSSI)
* |!| RFM69 | SWR | NACK | Message sent, no ACK received
* | | RFM69 | SPP | PCT=%%d,TX LEVEL=%%d | Set TX level, input TX percent (PCT)
* | | RFM69 | RSL | | Radio in sleep mode
* | | RFM69 | RSB | | Radio in standby mode
* | | RFM69 | PWD | | Power down radio
* | | RFM69 | PWU | | Power up radio
*
* @brief API declaration for RFM69
*
*/
#ifndef _RFM69_h
#define _RFM69_h
#include "RFM69registers_new.h"
#if !defined(RFM69_SPI)
#define RFM69_SPI hwSPI //!< default SPI
#endif
#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
#elif defined(ARDUINO_ARCH_ESP8266)
#define DEFAULT_RFM69_IRQ_PIN (5) //!< DEFAULT_RFM69_IRQ_PIN
#elif defined(ARDUINO_ARCH_ESP32)
#define DEFAULT_RFM69_IRQ_PIN (16) //!< DEFAULT_RFM69_IRQ_PIN
#define DEFAULT_RFM69_IRQ_NUM digitalPinToInterrupt(DEFAULT_RFM69_IRQ_PIN) //!< DEFAULT_RFM69_IRQ_NUM
#elif defined(ARDUINO_ARCH_SAMD)
#define DEFAULT_RFM69_IRQ_PIN (2) //!< DEFAULT_RFM69_IRQ_PIN
#elif defined(LINUX_ARCH_RASPBERRYPI)
#define DEFAULT_RFM69_IRQ_PIN (22) //!< DEFAULT_RFM69_IRQ_PIN
#elif defined(ARDUINO_ARCH_STM32F1)
#define DEFAULT_RFM69_IRQ_PIN (PA3) //!< DEFAULT_RFM69_IRQ_PIN
#elif defined(TEENSYDUINO)
#define DEFAULT_RFM69_IRQ_PIN (8) //!< DEFAULT_RFM69_IRQ_PIN
#else
#define DEFAULT_RFM69_IRQ_PIN (2) //!< DEFAULT_RFM69_IRQ_PIN
#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
// 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, -2dBm
#if defined(MY_RFM69_MAX_POWER_LEVEL_DBM)
#define RFM69_MAX_POWER_LEVEL_DBM MY_RFM69_MAX_POWER_LEVEL_DBM //!< MY_RFM69_MAX_POWER_LEVEL_DBM
#else
#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(MY_RFM69_MAX_POWER_LEVEL_DBM)
#define RFM69_MAX_POWER_LEVEL_DBM MY_RFM69_MAX_POWER_LEVEL_DBM //!< MY_RFM69_MAX_POWER_LEVEL_DBM
#else
#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_DBM (2u) //!< ATC target range +/- dBm
#define RFM69_PACKET_HEADER_VERSION (1u) //!< RFM69 packet header version
#define RFM69_MIN_PACKET_HEADER_VERSION (1u) //!< Minimal RFM69 packet header version
#define RFM69_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_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 (-75) //!< RSSI target
#define RFM69_HIGH_POWER_DBM (18u) //!< High power threshold, dBm
#if !defined(MY_RFM69_TX_TIMEOUT_MS)
#define MY_RFM69_TX_TIMEOUT_MS (2*1000ul) //!< Timeout for packet sent
#endif
// CSMA settings
#if !defined(MY_RFM69_CSMA_LIMIT_DBM)
#define MY_RFM69_CSMA_LIMIT_DBM (-95) //!< upper RX signal sensitivity threshold in dBm for carrier sense access
#endif
#if !defined(MY_RFM69_CSMA_TIMEOUT_MS)
#define MY_RFM69_CSMA_TIMEOUT_MS (500ul) //!< CSMA timeout
#endif
// powerup delay
#define RFM69_POWERUP_DELAY_MS (100ul) //!< Power up delay, allow VCC to settle, transport to become fully operational
// available frequency bands, non trivial values to avoid misconfiguration
#define RFM69_315MHZ (315000000ul) //!< RFM69_315MHZ
#define RFM69_433MHZ (433920000ul) //!< RFM69_433MHZ, center frequency 433.92 MHz
#define RFM69_865MHZ (865500000ul) //!< RFM69_865MHZ, center frequency 865.5 MHz
#define RFM69_868MHZ (868000000ul) //!< RFM69_868MHZ
#define RFM69_915MHZ (915000000ul) //!< RFM69_915MHZ
#define RFM69_COURSE_TEMP_COEF (-90) //!< puts the temperature reading in the ballpark, user can fine tune the returned value
#define RFM69_FXOSC (32*1000000ul) //!< OSC freq, 32MHz
#define RFM69_FSTEP (RFM69_FXOSC / 524288.0f) //!< FXOSC / 2^19 = 32MHz / 2^19 (p13 in datasheet)
// helper macros
#define RFM69_getACKRequested(__value) ((bool)bitRead(__value,RFM69_ACK_REQUESTED)) //!< getACKRequested
#define RFM69_setACKRequested(__value, __flag) bitWrite(__value,RFM69_ACK_REQUESTED,__flag) //!< setACKRequested
#define RFM69_getACKReceived(__value) ((bool)bitRead(__value,RFM69_ACK_RECEIVED)) //!< getACKReceived
#define RFM69_setACKReceived(__value, __flag) bitWrite(__value,RFM69_ACK_RECEIVED,__flag) //!< setACKReceived
#define RFM69_setACKRSSIReport(__value, __flag) bitWrite(__value,RFM69_ACK_RSSI_REPORT,__flag)//!< setACKRSSIReport
#define RFM69_getACKRSSIReport(__value) ((bool)bitRead(__value,RFM69_ACK_RSSI_REPORT)) //!< getACKRSSIReport
// Register access
#define RFM69_READ_REGISTER (0x7Fu) //!< reading register
#define RFM69_WRITE_REGISTER (0x80u) //!< writing register
// Modem configuration section
#define RFM69_CONFIG_FSK (RFM69_DATAMODUL_DATAMODE_PACKET | RFM69_DATAMODUL_MODULATIONTYPE_FSK | RFM69_DATAMODUL_MODULATIONSHAPING_00) //!< RFM69_CONFIG_FSK
#define RFM69_CONFIG_GFSK (RFM69_DATAMODUL_DATAMODE_PACKET | RFM69_DATAMODUL_MODULATIONTYPE_FSK | RFM69_DATAMODUL_MODULATIONSHAPING_10) //!< RFM69_CONFIG_GFSK
#define RFM69_CONFIG_OOK (RFM69_DATAMODUL_DATAMODE_PACKET | RFM69_DATAMODUL_MODULATIONTYPE_OOK | RFM69_DATAMODUL_MODULATIONSHAPING_00) //!< RFM69_CONFIG_OOK
#define RFM69_CONFIG_NOWHITE (RFM69_PACKET1_FORMAT_VARIABLE | RFM69_PACKET1_DCFREE_OFF | RFM69_PACKET1_CRC_ON | RFM69_PACKET1_CRCAUTOCLEAR_ON | RFM69_PACKET1_ADRSFILTERING_NODEBROADCAST) //!< RFM69_CONFIG_NOWHITE
#define RFM69_CONFIG_WHITE (RFM69_PACKET1_FORMAT_VARIABLE | RFM69_PACKET1_DCFREE_WHITENING | RFM69_PACKET1_CRC_ON | RFM69_PACKET1_CRCAUTOCLEAR_ON | RFM69_PACKET1_ADRSFILTERING_NODEBROADCAST) //!< RFM69_CONFIG_WHITE
#define RFM69_CONFIG_MANCHESTER (RFM69_PACKET1_FORMAT_VARIABLE | RFM69_PACKET1_DCFREE_MANCHESTER | RFM69_PACKET1_CRC_ON | RFM69_PACKET1_CRCAUTOCLEAR_ON | RFM69_PACKET1_ADRSFILTERING_NODEBROADCAST) //!< RFM69_CONFIG_MANCHESTER
#define RFM69_RXBW_111_24_4 (RFM69_RXBW_DCCFREQ_111 | RFM69_RXBW_MANT_24 | RFM69_RXBW_EXP_4) //!< RFM69_RXBW_111_24_4
#define RFM69_RXBW_111_24_3 (RFM69_RXBW_DCCFREQ_111 | RFM69_RXBW_MANT_24 | RFM69_RXBW_EXP_3) //!< RFM69_RXBW_111_24_3
#define RFM69_RXBW_111_24_2 (RFM69_RXBW_DCCFREQ_111 | RFM69_RXBW_MANT_24 | RFM69_RXBW_EXP_2) //!< RFM69_RXBW_111_24_2
#define RFM69_RXBW_111_16_2 (RFM69_RXBW_DCCFREQ_111 | RFM69_RXBW_MANT_16 | RFM69_RXBW_EXP_2) //!< RFM69_RXBW_111_16_2
#define RFM69_RXBW_111_16_1 (RFM69_RXBW_DCCFREQ_111 | RFM69_RXBW_MANT_16 | RFM69_RXBW_EXP_1) //!< RFM69_RXBW_111_16_1
#define RFM69_RXBW_111_16_0 (RFM69_RXBW_DCCFREQ_111 | RFM69_RXBW_MANT_16 | RFM69_RXBW_EXP_0) //!< RFM69_RXBW_111_16_0
#define RFM69_RXBW_010_16_2 (RFM69_RXBW_DCCFREQ_010 | RFM69_RXBW_MANT_16 | RFM69_RXBW_EXP_2) //!< RFM69_RXBW_010_16_2
#define RFM69_FSK_BR2_FD5 RFM69_CONFIG_FSK, RFM69_BITRATEMSB_2000, RFM69_BITRATELSB_2000, RFM69_FDEVMSB_5000, RFM69_FDEVLSB_5000, RFM69_RXBW_111_24_4, RFM69_CONFIG_WHITE //!< RFM69_FSK_BR2_FD5
#define RFM69_FSK_BR2_4_FD4_8 RFM69_CONFIG_FSK, RFM69_BITRATEMSB_2400, RFM69_BITRATELSB_2400, RFM69_FDEVMSB_4800, RFM69_FDEVLSB_4800, RFM69_RXBW_111_24_4, RFM69_CONFIG_WHITE //!< RFM69_FSK_BR2_4_FD4_8
#define RFM69_FSK_BR4_8_FD9_6 RFM69_CONFIG_FSK, RFM69_BITRATEMSB_4800, RFM69_BITRATELSB_4800, RFM69_FDEVMSB_9600, RFM69_FDEVLSB_9600, RFM69_RXBW_111_24_4, RFM69_CONFIG_WHITE //!< RFM69_FSK_BR4_8_FD9_6
#define RFM69_FSK_BR9_6_FD19_2 RFM69_CONFIG_FSK, RFM69_BITRATEMSB_9600, RFM69_BITRATELSB_9600, RFM69_FDEVMSB_19200, RFM69_FDEVLSB_19200, RFM69_RXBW_111_24_4, RFM69_CONFIG_WHITE //!< RFM69_FSK_BR9_6_FD19_2
#define RFM69_FSK_BR19_2_FD38_4 RFM69_CONFIG_FSK, RFM69_BITRATEMSB_19200, RFM69_BITRATELSB_19200, RFM69_FDEVMSB_38400, RFM69_FDEVLSB_38400, RFM69_RXBW_111_24_3, RFM69_CONFIG_WHITE //!< RFM69_FSK_BR19_2_FD38_4
#define RFM69_FSK_BR38_4_FD76_8 RFM69_CONFIG_FSK, RFM69_BITRATEMSB_38400, RFM69_BITRATELSB_38400, RFM69_FDEVMSB_76800, RFM69_FDEVLSB_76800, RFM69_RXBW_111_24_2, RFM69_CONFIG_WHITE //!< RFM69_FSK_BR38_4_FD76_8
#define RFM69_FSK_BR55_5_FD50 RFM69_CONFIG_FSK, RFM69_BITRATEMSB_55555, RFM69_BITRATELSB_55555, RFM69_FDEVMSB_50000, RFM69_FDEVLSB_50000, RFM69_RXBW_111_16_2, RFM69_CONFIG_WHITE //!< RFM69_FSK_BR55_5_FD50
#define RFM69_FSK_BR57_6_FD120 RFM69_CONFIG_FSK, RFM69_BITRATEMSB_57600, RFM69_BITRATELSB_57600, RFM69_FDEVMSB_120000, RFM69_FDEVLSB_120000, RFM69_RXBW_111_16_1, RFM69_CONFIG_WHITE //!< RFM69_FSK_BR57_6_FD120
#define RFM69_FSK_BR125_FD125 RFM69_CONFIG_FSK, RFM69_BITRATEMSB_125000, RFM69_BITRATELSB_125000, RFM69_FDEVMSB_125000, RFM69_FDEVLSB_125000, RFM69_RXBW_010_16_2, RFM69_CONFIG_WHITE //!< RFM69_FSK_BR125_FD125
#define RFM69_FSK_BR250_FD250 RFM69_CONFIG_FSK, RFM69_BITRATEMSB_250000, RFM69_BITRATELSB_250000, RFM69_FDEVMSB_250000, RFM69_FDEVLSB_250000, RFM69_RXBW_111_16_0, RFM69_CONFIG_WHITE //!< RFM69_FSK_BR250_FD250
#define RFM69_GFSK_BR2_FD5 RFM69_CONFIG_GFSK, RFM69_BITRATEMSB_2000, RFM69_BITRATELSB_2000, RFM69_FDEVMSB_5000, RFM69_FDEVLSB_5000, RFM69_RXBW_111_24_4, RFM69_CONFIG_WHITE //!< RFM69_GFSK_BR2_FD5
#define RFM69_GFSK_BR2_4_FD4_8 RFM69_CONFIG_GFSK, RFM69_BITRATEMSB_2400, RFM69_BITRATELSB_2400, RFM69_FDEVMSB_4800, RFM69_FDEVLSB_4800, RFM69_RXBW_111_24_4, RFM69_CONFIG_WHITE //!< RFM69_GFSK_BR2_4_FD4_8
#define RFM69_GFSK_BR4_8_FD9_6 RFM69_CONFIG_GFSK, RFM69_BITRATEMSB_4800, RFM69_BITRATELSB_4800, RFM69_FDEVMSB_9600, RFM69_FDEVLSB_9600, RFM69_RXBW_111_24_4, RFM69_CONFIG_WHITE //!< RFM69_GFSK_BR4_8_FD9_6
#define RFM69_GFSK_BR9_6_FD19_2 RFM69_CONFIG_GFSK, RFM69_BITRATEMSB_9600, RFM69_BITRATELSB_9600, RFM69_FDEVMSB_19200, RFM69_FDEVLSB_19200, RFM69_RXBW_111_24_4, RFM69_CONFIG_WHITE //!< RFM69_GFSK_BR9_6_FD19_2
#define RFM69_GFSK_BR19_2_FD38_4 RFM69_CONFIG_GFSK, RFM69_BITRATEMSB_19200, RFM69_BITRATELSB_19200, RFM69_FDEVMSB_38400, RFM69_FDEVLSB_38400, RFM69_RXBW_111_24_3, RFM69_CONFIG_WHITE //!< RFM69_GFSK_BR19_2_FD38_4
#define RFM69_GFSK_BR38_4_FD76_8 RFM69_CONFIG_GFSK, RFM69_BITRATEMSB_38400, RFM69_BITRATELSB_38400, RFM69_FDEVMSB_76800, RFM69_FDEVLSB_76800, RFM69_RXBW_111_24_2, RFM69_CONFIG_WHITE //!< RFM69_GFSK_BR38_4_FD76_8
#define RFM69_GFSK_BR55_5_FD50 RFM69_CONFIG_GFSK, RFM69_BITRATEMSB_55555, RFM69_BITRATELSB_55555, RFM69_FDEVMSB_50000, RFM69_FDEVLSB_50000, RFM69_RXBW_111_16_2, RFM69_CONFIG_WHITE //!< RFM69_GFSK_BR55_5_FD50
#define RFM69_GFSK_BR57_6_FD120 RFM69_CONFIG_GFSK, RFM69_BITRATEMSB_57600, RFM69_BITRATELSB_57600, RFM69_FDEVMSB_120000, RFM69_FDEVLSB_120000, RFM69_RXBW_111_16_1, RFM69_CONFIG_WHITE //!< RFM69_GFSK_BR57_6_FD120
#define RFM69_GFSK_BR125_FD125 RFM69_CONFIG_GFSK, RFM69_BITRATEMSB_125000, RFM69_BITRATELSB_125000, RFM69_FDEVMSB_125000, RFM69_FDEVLSB_125000, RFM69_RXBW_010_16_2, RFM69_CONFIG_WHITE //!< RFM69_GFSK_BR125_FD125
#define RFM69_GFSK_BR250_FD250 RFM69_CONFIG_GFSK, RFM69_BITRATEMSB_250000, RFM69_BITRATELSB_250000, RFM69_FDEVMSB_250000, RFM69_FDEVLSB_250000, RFM69_RXBW_111_16_0, RFM69_CONFIG_WHITE //!< RFM69_GFSK_BR250_FD250
#define RFM69_OOK_BR2_FD5 RFM69_CONFIG_OOK, RFM69_BITRATEMSB_2000, RFM69_BITRATELSB_2000, RFM69_FDEVMSB_5000, RFM69_FDEVLSB_5000, RFM69_RXBW_111_24_4, RFM69_CONFIG_WHITE //!< RFM69_OOK_BR2_FD5
#define RFM69_OOK_BR2_4_FD4_8 RFM69_CONFIG_OOK, RFM69_BITRATEMSB_2400, RFM69_BITRATELSB_2400, RFM69_FDEVMSB_4800, RFM69_FDEVLSB_4800, RFM69_RXBW_111_24_4, RFM69_CONFIG_WHITE //!< RFM69_OOK_BR2_4_FD4_8
#define RFM69_OOK_BR4_8_FD9_6 RFM69_CONFIG_OOK, RFM69_BITRATEMSB_4800, RFM69_BITRATELSB_4800, RFM69_FDEVMSB_9600, RFM69_FDEVLSB_9600, RFM69_RXBW_111_24_4, RFM69_CONFIG_WHITE //!< RFM69_OOK_BR4_8_FD9_6
#define RFM69_OOK_BR9_6_FD19_2 RFM69_CONFIG_OOK, RFM69_BITRATEMSB_9600, RFM69_BITRATELSB_9600, RFM69_FDEVMSB_19200, RFM69_FDEVLSB_19200, RFM69_RXBW_111_24_4, RFM69_CONFIG_WHITE //!< RFM69_OOK_BR9_6_FD19_2
#define RFM69_OOK_BR19_2_FD38_4 RFM69_CONFIG_OOK, RFM69_BITRATEMSB_19200, RFM69_BITRATELSB_19200, RFM69_FDEVMSB_38400, RFM69_FDEVLSB_38400, RFM69_RXBW_111_24_3, RFM69_CONFIG_WHITE //!< RFM69_OOK_BR19_2_FD38_4
#define RFM69_OOK_BR38_4_FD76_8 RFM69_CONFIG_OOK, RFM69_BITRATEMSB_38400, RFM69_BITRATELSB_38400, RFM69_FDEVMSB_76800, RFM69_FDEVLSB_76800, RFM69_RXBW_111_24_2, RFM69_CONFIG_WHITE //!< RFM69_OOK_BR38_4_FD76_8
#define RFM69_OOK_BR55_5_FD50 RFM69_CONFIG_OOK, RFM69_BITRATEMSB_55555, RFM69_BITRATELSB_55555, RFM69_FDEVMSB_50000, RFM69_FDEVLSB_50000, RFM69_RXBW_111_16_2, RFM69_CONFIG_WHITE //!< RFM69_OOK_BR55_5_FD50
#define RFM69_OOK_BR57_6_FD120 RFM69_CONFIG_OOK, RFM69_BITRATEMSB_57600, RFM69_BITRATELSB_57600, RFM69_FDEVMSB_120000, RFM69_FDEVLSB_120000, RFM69_RXBW_111_16_1, RFM69_CONFIG_WHITE //!< RFM69_OOK_BR57_6_FD120
#define RFM69_OOK_BR125_FD125 RFM69_CONFIG_OOK, RFM69_BITRATEMSB_125000, RFM69_BITRATELSB_125000, RFM69_FDEVMSB_125000, RFM69_FDEVLSB_125000, RFM69_RXBW_010_16_2, RFM69_CONFIG_WHITE //!< RFM69_OOK_BR125_FD125
#define RFM69_OOK_BR250_FD250 RFM69_CONFIG_OOK, RFM69_BITRATEMSB_250000, RFM69_BITRATELSB_250000, RFM69_FDEVMSB_250000, RFM69_FDEVLSB_250000, RFM69_RXBW_111_16_0, RFM69_CONFIG_WHITE //!< RFM69_OOK_BR250_FD250
#if !defined(MY_RFM69_MODEM_CONFIGURATION)
#define MY_RFM69_MODEM_CONFIGURATION RFM69_FSK_BR55_5_FD50 //!< default setting, RFM69_FSK_BR55_5_FD50
#endif
/**
* @brief Radio modes
*/
typedef enum {
RFM69_RADIO_MODE_RX = 0, //!< RX mode
RFM69_RADIO_MODE_TX = 1, //!< TX mode
RFM69_RADIO_MODE_CAD = 2, //!< CAD mode
RFM69_RADIO_MODE_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 (20180128tk: >=3.0.0 fused with controlFlags)
uint8_t sender; //!< payload sender
rfm69_controlFlags_t controlFlags; //!< control flags, used for ACK
rfm69_sequenceNumber_t sequenceNumber; //!< packet sequence number, used for ACK
} __attribute__((packed)) rfm69_header_t;
/**
* @brief RFM69 ACK packet structure
*/
typedef struct {
rfm69_sequenceNumber_t sequenceNumber; //!< sequence number
rfm69_RSSI_t RSSI; //!< RSSI
} __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
* IMPORTANT: Do not change order
*/
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 dataReceived : 1; //!< data received
bool ackReceived : 1; //!< ACK received
bool ATCenabled : 1; //!< ATC enabled
uint8_t reserved : 2; //!< Reserved
} rfm69_internal_t;
#define LOCAL static //!< static
/**
* @brief RFM69_handler
*/
LOCAL void RFM69_handler(void);
/**
* @brief Clear flags and FIFO
*/
LOCAL void RFM69_clearFIFO(void);
/**
* @brief Check for channel activity
* @return True if channel activity under RFM69_CSMA_LIMIT_DBM
*/
LOCAL bool RFM69_channelFree(void);
/**
* @brief RFM69_interruptHandling
*/
LOCAL void RFM69_interruptHandling(void);
/**
* @brief Initialise the driver transport hardware and software
* @param frequencyHz Frequency in Hz
* @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 RFM69_receive()
*/
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_receive(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 noACK
* @return True if packet successfully sent
*/
LOCAL bool RFM69_sendWithRetry(const uint8_t recipient, const void *buffer,
const uint8_t bufferSize,
const bool noACK);
/**
* @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(const 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);
/**
* @brief RFM69_readAllRegs
* Read and display all RFM69 register contents.
* @note define RFM69_REGISTER_DETAIL for register content decoding.
*/
LOCAL void RFM69_readAllRegs(void);
#endif
/** @}*/

984
lib/MySensors/hal/transport/RFM69/driver/new/RFM69registers_new.h Normal file
View File

@@ -0,0 +1,984 @@
/*
* 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-2019 Sensnology AB
* Full contributor list: https://github.com/mysensors/MySensors/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, 2018 Olivier Mauti <olivier@mysensors.org>
*
* Changes by : @tekka, @scalz, @marceloagno
*
* Definitions for Semtech SX1231/H radios:
* https://www.semtech.com/uploads/documents/sx1231.pdf
* https://www.semtech.com/uploads/documents/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_2000 0x3e
#define RFM69_BITRATELSB_2000 0x80
#define RFM69_BITRATEMSB_2400 0x34
#define RFM69_BITRATELSB_2400 0x15
#define RFM69_BITRATEMSB_4800 0x1A // Default
#define RFM69_BITRATELSB_4800 0x0B // Default
#define RFM69_BITRATEMSB_9600 0x0D
#define RFM69_BITRATELSB_9600 0x05
#define RFM69_BITRATEMSB_12500 0x0A
#define RFM69_BITRATELSB_12500 0x00
#define RFM69_BITRATEMSB_19200 0x06
#define RFM69_BITRATELSB_19200 0x83
#define RFM69_BITRATEMSB_25000 0x05
#define RFM69_BITRATELSB_25000 0x00
#define RFM69_BITRATEMSB_32768 0x03
#define RFM69_BITRATELSB_32768 0xD1
#define RFM69_BITRATEMSB_38400 0x03
#define RFM69_BITRATELSB_38400 0x41
#define RFM69_BITRATEMSB_50000 0x02
#define RFM69_BITRATELSB_50000 0x80
#define RFM69_BITRATEMSB_55555 0x02
#define RFM69_BITRATELSB_55555 0x40
#define RFM69_BITRATEMSB_57600 0x02
#define RFM69_BITRATELSB_57600 0x2C
#define RFM69_BITRATEMSB_76800 0x01
#define RFM69_BITRATELSB_76800 0xA1
#define RFM69_BITRATEMSB_100000 0x01
#define RFM69_BITRATELSB_100000 0x40
#define RFM69_BITRATEMSB_115200 0x01
#define RFM69_BITRATELSB_115200 0x16
#define RFM69_BITRATEMSB_125000 0x01
#define RFM69_BITRATELSB_125000 0x00
#define RFM69_BITRATEMSB_150000 0x00
#define RFM69_BITRATELSB_150000 0xD5
#define RFM69_BITRATEMSB_153600 0x00
#define RFM69_BITRATELSB_153600 0xD0
#define RFM69_BITRATEMSB_200000 0x00
#define RFM69_BITRATELSB_200000 0xA0
#define RFM69_BITRATEMSB_250000 0x00
#define RFM69_BITRATELSB_250000 0x80
#define RFM69_BITRATEMSB_300000 0x00
#define RFM69_BITRATELSB_300000 0x6B
// RegFdev - frequency deviation (Hz)
#define RFM69_FDEVMSB_2000 0x00
#define RFM69_FDEVLSB_2000 0x21
#define RFM69_FDEVMSB_4800 0x00
#define RFM69_FDEVLSB_4800 0x4f
#define RFM69_FDEVMSB_5000 0x00 // Default
#define RFM69_FDEVLSB_5000 0x52 // Default
#define RFM69_FDEVMSB_7500 0x00
#define RFM69_FDEVLSB_7500 0x7B
#define RFM69_FDEVMSB_9600 0x00
#define RFM69_FDEVLSB_9600 0x9d
#define RFM69_FDEVMSB_10000 0x00
#define RFM69_FDEVLSB_10000 0xA4
#define RFM69_FDEVMSB_15000 0x00
#define RFM69_FDEVLSB_15000 0xF6
#define RFM69_FDEVMSB_19200 0x01
#define RFM69_FDEVLSB_19200 0x3b
#define RFM69_FDEVMSB_20000 0x01
#define RFM69_FDEVLSB_20000 0x48
#define RFM69_FDEVMSB_25000 0x01
#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_38400 0x02
#define RFM69_FDEVLSB_38400 0x75
#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_76800 0x04
#define RFM69_FDEVLSB_76800 0xea
#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_125000 0x08
#define RFM69_FDEVLSB_125000 0x00
#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

913
lib/MySensors/hal/transport/RFM69/driver/old/RFM69_old.cpp Normal file
View File

@@ -0,0 +1,913 @@
// **********************************************************************************
// Driver definition for HopeRF RFM69W/RFM69HW/RFM69CW/RFM69HCW, Semtech SX1231/1231H
// **********************************************************************************
// Copyright Felix Rusu (2014), felix@lowpowerlab.com
// http://lowpowerlab.com/
// **********************************************************************************
// License
// **********************************************************************************
// This program is free software; you can redistribute it
// and/or modify it under the terms of the GNU General
// Public License as published by the Free Software
// Foundation; either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will
// be useful, but WITHOUT ANY WARRANTY; without even the
// implied warranty of MERCHANTABILITY or FITNESS FOR A
// PARTICULAR PURPOSE. See the GNU General Public
// License for more details.
//
// You should have received a copy of the GNU General
// Public License along with this program.
// If not, see <http://www.gnu.org/licenses/>.
//
// Licence can be viewed at
// http://www.gnu.org/licenses/gpl-3.0.txt
//
// Please maintain this license information along with authorship
// and copyright notices in any redistribution of this code
// **********************************************************************************
#include "RFM69_old.h"
#include "RFM69registers_old.h"
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;
volatile uint8_t RFM69::TARGETID; // should match _address
volatile uint8_t RFM69::PAYLOADLEN;
volatile uint8_t RFM69::ACK_REQUESTED;
volatile uint8_t
RFM69::ACK_RECEIVED; // should be polled immediately after sending a packet with ACK request
volatile int16_t
RFM69::RSSI; // most accurate RSSI during reception (closest to the reception)
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
/* 0x03 */ { REG_BITRATEMSB, RF_BITRATEMSB_55555}, // default: 4.8 KBPS
/* 0x04 */ { REG_BITRATELSB, RF_BITRATELSB_55555},
/* 0x05 */ { REG_FDEVMSB, RF_FDEVMSB_50000}, // default: 5KHz, (FDEV + BitRate / 2 <= 500KHz)
/* 0x06 */ { REG_FDEVLSB, RF_FDEVLSB_50000},
/* 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
// +13dBm formula: Pout = -18 + OutputPower (with PA0 or PA1**)
// +17dBm formula: Pout = -14 + OutputPower (with PA1 and PA2)**
// +20dBm formula: Pout = -11 + OutputPower (with PA1 and PA2)** and high power PA settings (section 3.3.7 in datasheet)
///* 0x11 */ { REG_PALEVEL, RF_PALEVEL_PA0_ON | RF_PALEVEL_PA1_OFF | RF_PALEVEL_PA2_OFF | RF_PALEVEL_OUTPUTPOWER_11111},
///* 0x13 */ { REG_OCP, RF_OCP_ON | RF_OCP_TRIM_95 }, // over current protection (default is 95mA)
// RXBW defaults are { REG_RXBW, RF_RXBW_DCCFREQ_010 | RF_RXBW_MANT_24 | RF_RXBW_EXP_5} (RxBw: 10.4KHz)
/* 0x19 */ { REG_RXBW, RF_RXBW_DCCFREQ_010 | RF_RXBW_MANT_16 | RF_RXBW_EXP_2 }, // (BitRate < 2 * RxBw)
//for BR-19200: /* 0x19 */ { REG_RXBW, RF_RXBW_DCCFREQ_010 | RF_RXBW_MANT_24 | RF_RXBW_EXP_3 },
/* 0x25 */ { REG_DIOMAPPING1, RF_DIOMAPPING1_DIO0_01 }, // DIO0 is the only IRQ we're using
/* 0x26 */ { REG_DIOMAPPING2, RF_DIOMAPPING2_CLKOUT_OFF }, // DIO5 ClkOut disable for power saving
/* 0x28 */ { REG_IRQFLAGS2, RF_IRQFLAGS2_FIFOOVERRUN }, // writing to this bit ensures that the FIFO & status flags are reset
/* 0x29 */ { REG_RSSITHRESH, 220 }, // must be set to dBm = (-Sensitivity / 2), default is 0xE4 = 228 so -114dBm
///* 0x2D */ { REG_PREAMBLELSB, RF_PREAMBLESIZE_LSB_VALUE } // default 3 preamble bytes 0xAAAAAA
/* 0x2E */ { REG_SYNCCONFIG, RF_SYNC_ON | RF_SYNC_FIFOFILL_AUTO | RF_SYNC_SIZE_2 | RF_SYNC_TOL_0 },
/* 0x2F */ { REG_SYNCVALUE1, 0x2D }, // attempt to make this compatible with sync1 byte of RFM12B lib
/* 0x30 */ { REG_SYNCVALUE2, networkID }, // NETWORK ID
/* 0x37 */ { REG_PACKETCONFIG1, RF_PACKET1_FORMAT_VARIABLE | RF_PACKET1_DCFREE_OFF | RF_PACKET1_CRC_ON | RF_PACKET1_CRCAUTOCLEAR_ON | RF_PACKET1_ADRSFILTERING_OFF },
/* 0x38 */ { REG_PAYLOADLENGTH, 66 }, // in variable length mode: the max frame size, not used in TX
///* 0x39 */ { REG_NODEADRS, nodeID }, // turned off because we're not using address filtering
/* 0x3C */ { REG_FIFOTHRESH, RF_FIFOTHRESH_TXSTART_FIFONOTEMPTY | RF_FIFOTHRESH_VALUE }, // TX on FIFO not empty
/* 0x3D */ { REG_PACKETCONFIG2, RF_PACKET2_RXRESTARTDELAY_2BITS | RF_PACKET2_AUTORXRESTART_ON | RF_PACKET2_AES_OFF }, // RXRESTARTDELAY must match transmitter PA ramp-down time (bitrate dependent)
//for BR-19200: /* 0x3D */ { REG_PACKETCONFIG2, RF_PACKET2_RXRESTARTDELAY_NONE | RF_PACKET2_AUTORXRESTART_ON | RF_PACKET2_AES_OFF }, // RXRESTARTDELAY must match transmitter PA ramp-down time (bitrate dependent)
/* 0x6F */ { REG_TESTDAGC, RF_DAGC_IMPROVED_LOWBETA0 }, // run DAGC continuously in RX mode for Fading Margin Improvement, recommended default for AfcLowBetaOn=0
{255, 0}
};
hwDigitalWrite(_slaveSelectPin, HIGH);
hwPinMode(_slaveSelectPin, OUTPUT);
hwPinMode(_interruptPin, INPUT);
RFM69_SPI.begin();
unsigned long start = hwMillis();
const uint8_t timeout = 50;
do {
writeReg(REG_SYNCVALUE1, 0xAA);
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);
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]);
}
// Encryption is persistent between resets and can trip you up during debugging.
// Disable it during initialization so we always start from a known state.
encrypt(0);
setHighPower(_isRFM69HW); // called regardless if it's a RFM69W or RFM69HW
setMode(RFM69_MODE_STANDBY);
start = hwMillis();
while (((readReg(REG_IRQFLAGS1) & RF_IRQFLAGS1_MODEREADY) == 0x00) && hwMillis()-start < timeout) {
doYield();
} // wait for ModeReady
if (hwMillis()-start >= timeout) {
return false;
}
//RFM69_SPI.usingInterrupt(_interruptNum);
attachInterrupt(_interruptNum, RFM69::isr0, RISING);
selfPointer = this;
_address = nodeID;
return true;
}
// return the frequency (in Hz)
uint32_t RFM69::getFrequency()
{
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 == RFM69_MODE_TX) {
setMode(RFM69_MODE_RX);
}
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 == RFM69_MODE_RX) {
setMode(RFM69_MODE_SYNTH);
}
setMode(oldMode);
}
void RFM69::setMode(uint8_t newMode)
{
if (newMode == _mode) {
return;
}
const uint8_t currentOPMODE = readReg(REG_OPMODE) & 0xE3;
switch (newMode) {
case RFM69_MODE_TX:
writeReg(REG_OPMODE, currentOPMODE | RF_OPMODE_TRANSMITTER);
if (_isRFM69HW) {
setHighPowerRegs(true);
}
break;
case RFM69_MODE_RX:
writeReg(REG_OPMODE, currentOPMODE | RF_OPMODE_RECEIVER);
if (_isRFM69HW) {
setHighPowerRegs(false);
}
break;
case RFM69_MODE_SYNTH:
writeReg(REG_OPMODE, currentOPMODE | RF_OPMODE_SYNTHESIZER);
break;
case RFM69_MODE_STANDBY:
writeReg(REG_OPMODE, currentOPMODE | RF_OPMODE_STANDBY);
break;
case RFM69_MODE_SLEEP:
writeReg(REG_OPMODE, currentOPMODE | RF_OPMODE_SLEEP);
break;
default:
return;
}
// 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 == 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)
{
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
void RFM69::setAddress(uint8_t addr)
{
_address = addr;
writeReg(REG_NODEADRS, _address);
}
//set this node's network id
void RFM69::setNetwork(uint8_t networkID)
{
writeReg(REG_SYNCVALUE2, networkID);
}
// set *transmit/TX* output power: 0=min, 31=max
// this results in a "weaker" transmitted signal, and directly results in a lower RSSI at the receiver
// the power configurations are explained in the SX1231H datasheet (Table 10 on p21; RegPaLevel p66): http://www.semtech.com/images/datasheet/sx1231h.pdf
// valid powerLevel parameter values are 0-31 and result in a directly proportional effect on the output/transmission power
// this function implements 2 modes as follows:
// - for RFM69W the range is from 0-31 [-18dBm to 13dBm] (PA0 only on RFIO pin)
// - for RFM69HW the range is from 0-31 [5dBm to 20dBm] (PA1 & PA2 on PA_BOOST pin & high Power PA settings - see section 3.3.7 in datasheet, p22)
void RFM69::setPowerLevel(uint8_t powerLevel)
{
_powerLevel = (powerLevel > 31 ? 31 : powerLevel);
if (_isRFM69HW) {
_powerLevel /= 2;
}
writeReg(REG_PALEVEL, (readReg(REG_PALEVEL) & 0xE0) | _powerLevel);
}
bool RFM69::canSend()
{
if (_mode == RFM69_MODE_RX && PAYLOADLEN == 0 &&
readRSSI() < CSMA_LIMIT) { // if signal stronger than -100dBm is detected assume channel activity
setMode(RFM69_MODE_STANDBY);
return true;
}
return false;
}
void RFM69::send(uint8_t toAddress, const void* buffer, uint8_t bufferSize, bool requestACK)
{
writeReg(REG_PACKETCONFIG2, (readReg(REG_PACKETCONFIG2) & 0xFB) |
RF_PACKET2_RXRESTART); // avoid RX deadlocks
uint32_t now = hwMillis();
while (!canSend() && hwMillis() - now < RFM69_CSMA_LIMIT_MS) {
receiveDone();
}
sendFrame(toAddress, buffer, bufferSize, requestACK, false);
}
// to increase the chance of getting a packet across, call this function instead of send
// and it handles all the ACK requesting/retrying for you :)
// The only twist is that you have to manually listen to ACK requests on the other side and send back the ACKs
// The reason for the semi-automaton is that the lib is interrupt driven and
// requires user action to read the received data and decide what to do with it
// replies usually take only 5..8ms at 50kbps@915MHz
bool RFM69::sendWithRetry(uint8_t toAddress, const void* buffer, uint8_t bufferSize,
uint8_t retries, uint8_t retryWaitTime)
{
for (uint8_t i = 0; i <= retries; i++) {
send(toAddress, buffer, bufferSize, true);
uint32_t sentTime = hwMillis();
while (hwMillis() - sentTime < retryWaitTime) {
if (ACKReceived(toAddress)) {
return true;
}
}
//Serial.print(" RETRY#"); Serial.println(i + 1);
}
return false;
}
// should be polled immediately after sending a packet with ACK request
bool RFM69::ACKReceived(uint8_t fromNodeID)
{
if (receiveDone()) {
return (SENDERID == fromNodeID || fromNodeID == RFM69_BROADCAST_ADDR) && ACK_RECEIVED;
}
return false;
}
// check whether an ACK was requested in the last received packet (non-broadcasted packet)
bool RFM69::ACKRequested()
{
return ACK_REQUESTED && (TARGETID != RFM69_BROADCAST_ADDR);
}
// should be called immediately after reception in case sender wants ACK
void RFM69::sendACK(const void* buffer, uint8_t bufferSize)
{
ACK_REQUESTED =
0; // TWS added to make sure we don't end up in a timing race and infinite loop sending Acks
uint8_t sender = SENDERID;
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 = hwMillis();
while (!canSend() && hwMillis() - now < RFM69_CSMA_LIMIT_MS) {
receiveDone();
doYield();
}
SENDERID = sender; // TWS: Restore SenderID after it gets wiped out by receiveDone()
sendFrame(sender, buffer, bufferSize, false, true);
RSSI = _RSSI; // restore payload RSSI
}
void RFM69::interruptHook(uint8_t CTLbyte)
{
(void)CTLbyte;
};
// internal function
void RFM69::sendFrame(uint8_t toAddress, const void* buffer, uint8_t bufferSize, bool requestACK,
bool sendACK)
{
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 > RFM69_MAX_DATA_LEN) {
bufferSize = RFM69_MAX_DATA_LEN;
}
// control byte
uint8_t CTLbyte = 0x00;
if (sendACK) {
CTLbyte = RFM69_CTL_SENDACK;
} else if (requestACK) {
CTLbyte = RFM69_CTL_REQACK;
}
// write to FIFO
select();
RFM69_SPI.transfer(REG_FIFO | 0x80);
RFM69_SPI.transfer(bufferSize + 3);
RFM69_SPI.transfer(toAddress);
RFM69_SPI.transfer(_address);
RFM69_SPI.transfer(CTLbyte);
for (uint8_t i = 0; i < bufferSize; i++) {
RFM69_SPI.transfer(((uint8_t *)buffer)[i]);
}
unselect();
// no need to wait for transmit mode to be ready since its handled by the radio
setMode(RFM69_MODE_TX);
uint32_t txStart = hwMillis();
while (hwDigitalRead(_interruptPin) == 0 &&
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(RFM69_MODE_STANDBY);
}
// internal function - interrupt gets called when a packet is received
void IRQ_HANDLER_ATTR RFM69::interruptHandler()
{
//hwPinMode(4, OUTPUT);
//hwDigitalWrite(4, 1);
if (_mode == RFM69_MODE_RX && (readReg(REG_IRQFLAGS2) & RF_IRQFLAGS2_PAYLOADREADY)) {
//RSSI = readRSSI();
setMode(RFM69_MODE_STANDBY);
select();
RFM69_SPI.transfer(REG_FIFO & 0x7F);
PAYLOADLEN = RFM69_SPI.transfer(0);
PAYLOADLEN = PAYLOADLEN > 66 ? 66 : PAYLOADLEN; // precaution
TARGETID = RFM69_SPI.transfer(0);
if(!(_promiscuousMode || TARGETID == _address ||
TARGETID ==
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;
unselect();
receiveBegin();
//hwDigitalWrite(4, 0);
return;
}
DATALEN = PAYLOADLEN - 3;
SENDERID = RFM69_SPI.transfer(0);
uint8_t CTLbyte = RFM69_SPI.transfer(0);
ACK_RECEIVED = CTLbyte & RFM69_CTL_SENDACK; // extract ACK-received flag
ACK_REQUESTED = CTLbyte & RFM69_CTL_REQACK; // extract ACK-requested flag
interruptHook(CTLbyte); // TWS: hook to derived class interrupt function
for (uint8_t i = 0; i < DATALEN; i++) {
DATA[i] = RFM69_SPI.transfer(0);
}
if (DATALEN < RFM69_MAX_DATA_LEN) {
DATA[DATALEN] = 0; // add null at end of string
}
unselect();
setMode(RFM69_MODE_RX);
}
RSSI = readRSSI();
//hwDigitalWrite(4, 0);
}
// internal function
void IRQ_HANDLER_ATTR RFM69::isr0()
{
selfPointer->interruptHandler();
}
// internal function
void RFM69::receiveBegin()
{
DATALEN = 0;
SENDERID = 0;
TARGETID = 0;
PAYLOADLEN = 0;
ACK_REQUESTED = 0;
ACK_RECEIVED = 0;
RSSI = 0;
if (readReg(REG_IRQFLAGS2) & RF_IRQFLAGS2_PAYLOADREADY) {
writeReg(REG_PACKETCONFIG2, (readReg(REG_PACKETCONFIG2) & 0xFB) |
RF_PACKET2_RXRESTART); // avoid RX deadlocks
}
writeReg(REG_DIOMAPPING1, RF_DIOMAPPING1_DIO0_01); // set DIO0 to "PAYLOADREADY" in receive mode
setMode(RFM69_MODE_RX);
}
// checks if a packet was received and/or puts transceiver in receive (ie RX or listen) mode
bool RFM69::receiveDone()
{
//ATOMIC_BLOCK(ATOMIC_FORCEON)
//{
noInterrupts(); // re-enabled in unselect() via setMode() or via receiveBegin()
if (_mode == RFM69_MODE_RX && PAYLOADLEN > 0) {
setMode(RFM69_MODE_STANDBY); // enables interrupts
return true;
} else if (_mode == RFM69_MODE_RX) { // already in RX no payload yet
interrupts(); // explicitly re-enable interrupts
return false;
}
receiveBegin();
return false;
//}
}
// To enable encryption: radio.encrypt("ABCDEFGHIJKLMNOP");
// To disable encryption: radio.encrypt(null) or radio.encrypt(0)
// KEY HAS TO BE 16 bytes !!!
void RFM69::encrypt(const char* key)
{
setMode(RFM69_MODE_STANDBY);
if (key != 0) {
select();
RFM69_SPI.transfer(REG_AESKEY1 | 0x80);
for (uint8_t i = 0; i < 16; i++) {
RFM69_SPI.transfer(key[i]);
}
unselect();
}
writeReg(REG_PACKETCONFIG2, (readReg(REG_PACKETCONFIG2) & 0xFE) | (key ? 1 : 0));
}
// get the received signal strength indicator (RSSI)
int16_t RFM69::readRSSI(bool forceTrigger)
{
int16_t rssi = 0;
if (forceTrigger) {
// RSSI trigger not needed if DAGC is in continuous mode
writeReg(REG_RSSICONFIG, RF_RSSI_START);
while ((readReg(REG_RSSICONFIG) & RF_RSSI_DONE) == 0x00) {} // wait for RSSI_Ready
}
rssi = -readReg(REG_RSSIVALUE);
rssi >>= 1;
return rssi;
}
uint8_t RFM69::readReg(uint8_t addr)
{
select();
RFM69_SPI.transfer(addr & 0x7F);
uint8_t regval = RFM69_SPI.transfer(0);
unselect();
return regval;
}
void RFM69::writeReg(uint8_t addr, uint8_t value)
{
select();
RFM69_SPI.transfer(addr | 0x80);
RFM69_SPI.transfer(value);
unselect();
}
// select the RFM69 transceiver (save SPI settings, set CS low)
void RFM69::select()
{
noInterrupts();
#if defined (SPCR) && defined (SPSR)
// save current SPI settings
_SPCR = SPCR;
_SPSR = SPSR;
#endif
// set RFM69 SPI settings
RFM69_SPI.setDataMode(SPI_MODE0);
RFM69_SPI.setBitOrder(MSBFIRST);
RFM69_SPI.setClockDivider(RFM69_CLOCK_DIV);
hwDigitalWrite(_slaveSelectPin, LOW);
}
// unselect the RFM69 transceiver (set CS high, restore SPI settings)
void RFM69::unselect()
{
hwDigitalWrite(_slaveSelectPin, HIGH);
// restore SPI settings to what they were before talking to RFM69
#if defined (SPCR) && defined (SPSR)
SPCR = _SPCR;
SPSR = _SPSR;
#endif
interrupts();
}
// true = disable filtering to capture all frames on network
// false = enable node/broadcast filtering to capture only frames sent to this/broadcast address
void RFM69::promiscuous(bool onOff)
{
_promiscuousMode = onOff;
//writeReg(REG_PACKETCONFIG1, (readReg(REG_PACKETCONFIG1) & 0xF9) | (onOff ? RF_PACKET1_ADRSFILTERING_OFF : RF_PACKET1_ADRSFILTERING_NODEBROADCAST));
}
// for RFM69HW only: you must call setHighPower(true) after initialize() or else transmission won't work
void RFM69::setHighPower(bool onOff)
{
_isRFM69HW = onOff;
writeReg(REG_OCP, _isRFM69HW ? RF_OCP_OFF : RF_OCP_ON);
if (_isRFM69HW) { // turning ON
writeReg(REG_PALEVEL, (readReg(REG_PALEVEL) & 0x1F) | RF_PALEVEL_PA1_ON |
RF_PALEVEL_PA2_ON); // enable P1 & P2 amplifier stages
} else {
writeReg(REG_PALEVEL, RF_PALEVEL_PA0_ON | RF_PALEVEL_PA1_OFF | RF_PALEVEL_PA2_OFF |
_powerLevel); // enable P0 only
}
}
// internal function
void RFM69::setHighPowerRegs(bool onOff)
{
writeReg(REG_TESTPA1, onOff ? 0x5D : 0x55);
writeReg(REG_TESTPA2, onOff ? 0x7C : 0x70);
}
// set the slave select (CS) pin
void RFM69::setCS(uint8_t newSPISlaveSelect)
{
_slaveSelectPin = newSPISlaveSelect;
hwDigitalWrite(_slaveSelectPin, HIGH);
hwPinMode(_slaveSelectPin, OUTPUT);
}
//for debugging
#define REGISTER_DETAIL 0
#if REGISTER_DETAIL
// SERIAL PRINT
// replace Serial.print("string") with SerialPrint("string")
#define SerialPrint(x) SerialPrint_P(PSTR(x))
void SerialWrite ( uint8_t c )
{
Serial.write ( c );
}
void SerialPrint_P(PGM_P str, void (*f)(uint8_t) = SerialWrite )
{
for (uint8_t c; (c = pgm_read_byte(str)); str++) {
(*f)(c);
}
}
#endif
void RFM69::readAllRegs()
{
#if REGISTER_DETAIL
int capVal;
//... State Variables for intelligent decoding
uint8_t modeFSK = 0;
int bitRate = 0;
int freqDev = 0;
long freqCenter = 0;
#endif
Serial.println("Address - HEX - BIN");
for (uint8_t regAddr = 1; regAddr <= 0x4F; regAddr++) {
select();
RFM69_SPI.transfer(regAddr & 0x7F); // send address + r/w bit
uint8_t regVal = RFM69_SPI.transfer(0);
unselect();
Serial.print(regAddr, HEX);
Serial.print(" - ");
Serial.print(regVal,HEX);
Serial.print(" - ");
Serial.println(regVal,BIN);
#if REGISTER_DETAIL
switch ( regAddr ) {
case 0x1 : {
SerialPrint ( "Controls the automatic Sequencer ( see section 4.2 )\nSequencerOff : " );
if ( 0x80 & regVal ) {
SerialPrint ( "1 -> Mode is forced by the user\n" );
} else {
SerialPrint ( "0 -> Operating mode as selected with Mode bits in RegOpMode is automatically reached with the Sequencer\n" );
}
SerialPrint( "\nEnables Listen mode, should be enabled whilst in Standby mode:\nListenOn : " );
if ( 0x40 & regVal ) {
SerialPrint ( "1 -> On\n" );
} else {
SerialPrint ( "0 -> Off ( see section 4.3)\n" );
}
SerialPrint( "\nAborts Listen mode when set together with ListenOn=0 See section 4.3.4 for details (Always reads 0.)\n" );
if ( 0x20 & regVal ) {
SerialPrint ( "ERROR - ListenAbort should NEVER return 1 this is a write only register\n" );
}
SerialPrint("\nTransceiver's operating modes:\nMode : ");
capVal = (regVal >> 2) & 0x7;
if ( capVal == 0b000 ) {
SerialPrint ( "000 -> Sleep mode (SLEEP)\n" );
} else if ( capVal = 0b001 ) {
SerialPrint ( "001 -> Standby mode (STDBY)\n" );
} else if ( capVal = 0b010 ) {
SerialPrint ( "010 -> Frequency Synthesizer mode (FS)\n" );
} else if ( capVal = 0b011 ) {
SerialPrint ( "011 -> Transmitter mode (TX)\n" );
} else if ( capVal = 0b100 ) {
SerialPrint ( "100 -> Receiver Mode (RX)\n" );
} else {
Serial.print( capVal, BIN );
SerialPrint ( " -> RESERVED\n" );
}
SerialPrint ( "\n" );
break;
}
case 0x2 : {
SerialPrint("Data Processing mode:\nDataMode : ");
capVal = (regVal >> 5) & 0x3;
if ( capVal == 0b00 ) {
SerialPrint ( "00 -> Packet mode\n" );
} else if ( capVal == 0b01 ) {
SerialPrint ( "01 -> reserved\n" );
} else if ( capVal == 0b10 ) {
SerialPrint ( "10 -> Continuous mode with bit synchronizer\n" );
} else if ( capVal == 0b11 ) {
SerialPrint ( "11 -> Continuous mode without bit synchronizer\n" );
}
SerialPrint("\nModulation scheme:\nModulation Type : ");
capVal = (regVal >> 3) & 0x3;
if ( capVal == 0b00 ) {
SerialPrint ( "00 -> FSK\n" );
modeFSK = 1;
} else if ( capVal == 0b01 ) {
SerialPrint ( "01 -> OOK\n" );
} else if ( capVal == 0b10 ) {
SerialPrint ( "10 -> reserved\n" );
} else if ( capVal == 0b11 ) {
SerialPrint ( "11 -> reserved\n" );
}
SerialPrint("\nData shaping: ");
if ( modeFSK ) {
SerialPrint( "in FSK:\n" );
} else {
SerialPrint( "in OOK:\n" );
}
SerialPrint ("ModulationShaping : ");
capVal = regVal & 0x3;
if ( modeFSK ) {
if ( capVal == 0b00 ) {
SerialPrint ( "00 -> no shaping\n" );
} else if ( capVal == 0b01 ) {
SerialPrint ( "01 -> Gaussian filter, BT = 1.0\n" );
} else if ( capVal == 0b10 ) {
SerialPrint ( "10 -> Gaussian filter, BT = 0.5\n" );
} else if ( capVal == 0b11 ) {
SerialPrint ( "11 -> Gaussian filter, BT = 0.3\n" );
}
} else {
if ( capVal == 0b00 ) {
SerialPrint ( "00 -> no shaping\n" );
} else if ( capVal == 0b01 ) {
SerialPrint ( "01 -> filtering with f(cutoff) = BR\n" );
} else if ( capVal == 0b10 ) {
SerialPrint ( "10 -> filtering with f(cutoff) = 2*BR\n" );
} else if ( capVal == 0b11 ) {
SerialPrint ( "ERROR - 11 is reserved\n" );
}
}
SerialPrint ( "\n" );
break;
}
case 0x3 : {
bitRate = (regVal << 8);
break;
}
case 0x4 : {
bitRate |= regVal;
SerialPrint ( "Bit Rate (Chip Rate when Manchester encoding is enabled)\nBitRate : ");
unsigned long val = 32UL * 1000UL * 1000UL / bitRate;
Serial.println( val );
SerialPrint( "\n" );
break;
}
case 0x5 : {
freqDev = ( (regVal & 0x3f) << 8 );
break;
}
case 0x6 : {
freqDev |= regVal;
SerialPrint( "Frequency deviation\nFdev : " );
unsigned long val = 61UL * freqDev;
Serial.println( val );
SerialPrint ( "\n" );
break;
}
case 0x7 : {
unsigned long tempVal = regVal;
freqCenter = ( tempVal << 16 );
break;
}
case 0x8 : {
unsigned long tempVal = regVal;
freqCenter = freqCenter | ( tempVal << 8 );
break;
}
case 0x9 : {
freqCenter = freqCenter | regVal;
SerialPrint ( "RF Carrier frequency\nFRF : " );
unsigned long val = 61UL * freqCenter;
Serial.println( val );
SerialPrint( "\n" );
break;
}
case 0xa : {
SerialPrint ( "RC calibration control & status\nRcCalDone : " );
if ( 0x40 & regVal ) {
SerialPrint ( "1 -> RC calibration is over\n" );
} else {
SerialPrint ( "0 -> RC calibration is in progress\n" );
}
SerialPrint ( "\n" );
break;
}
case 0xb : {
SerialPrint ( "Improved AFC routine for signals with modulation index lower than 2. Refer to section 3.4.16 for details\nAfcLowBetaOn : " );
if ( 0x20 & regVal ) {
SerialPrint ( "1 -> Improved AFC routine\n" );
} else {
SerialPrint ( "0 -> Standard AFC routine\n" );
}
SerialPrint ( "\n" );
break;
}
case 0xc : {
SerialPrint ( "Reserved\n\n" );
break;
}
case 0xd : {
byte val;
SerialPrint ( "Resolution of Listen mode Idle time (calibrated RC osc):\nListenResolIdle : " );
val = regVal >> 6;
if ( val == 0b00 ) {
SerialPrint ( "00 -> reserved\n" );
} else if ( val == 0b01 ) {
SerialPrint ( "01 -> 64 us\n" );
} else if ( val == 0b10 ) {
SerialPrint ( "10 -> 4.1 ms\n" );
} else if ( val == 0b11 ) {
SerialPrint ( "11 -> 262 ms\n" );
}
SerialPrint ( "\nResolution of Listen mode Rx time (calibrated RC osc):\nListenResolRx : " );
val = (regVal >> 4) & 0x3;
if ( val == 0b00 ) {
SerialPrint ( "00 -> reserved\n" );
} else if ( val == 0b01 ) {
SerialPrint ( "01 -> 64 us\n" );
} else if ( val == 0b10 ) {
SerialPrint ( "10 -> 4.1 ms\n" );
} else if ( val == 0b11 ) {
SerialPrint ( "11 -> 262 ms\n" );
}
SerialPrint ( "\nCriteria for packet acceptance in Listen mode:\nListenCriteria : " );
if ( 0x8 & regVal ) {
SerialPrint ( "1 -> signal strength is above RssiThreshold and SyncAddress matched\n" );
} else {
SerialPrint ( "0 -> signal strength is above RssiThreshold\n" );
}
SerialPrint ( "\nAction taken after acceptance of a packet in Listen mode:\nListenEnd : " );
val = (regVal >> 1 ) & 0x3;
if ( val == 0b00 ) {
SerialPrint ( "00 -> chip stays in Rx mode. Listen mode stops and must be disabled (see section 4.3)\n" );
} else if ( val == 0b01 ) {
SerialPrint ( "01 -> chip stays in Rx mode until PayloadReady or Timeout interrupt occurs. It then goes to the mode defined by Mode. Listen mode stops and must be disabled (see section 4.3)\n" );
} else if ( val == 0b10 ) {
SerialPrint ( "10 -> chip stays in Rx mode until PayloadReady or Timeout occurs. Listen mode then resumes in Idle state. FIFO content is lost at next Rx wakeup.\n" );
} else if ( val == 0b11 ) {
SerialPrint ( "11 -> Reserved\n" );
}
SerialPrint ( "\n" );
break;
}
default : {
}
}
#endif
}
unselect();
}
uint8_t RFM69::readTemperature(uint8_t calFactor) // returns centigrade
{
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 +
calFactor; // 'complement' corrects the slope, rising temp = rising val
} // COURSE_TEMP_COEF puts reading in the ballpark, user can add additional correction
void RFM69::rcCalibration()
{
writeReg(REG_OSC1, RF_OSC1_RCCAL_START);
while ((readReg(REG_OSC1) & RF_OSC1_RCCAL_DONE) == 0x00) {}
}

232
lib/MySensors/hal/transport/RFM69/driver/old/RFM69_old.h Normal file
View File

@@ -0,0 +1,232 @@
// **********************************************************************************
// Driver definition for HopeRF RFM69W/RFM69HW/RFM69CW/RFM69HCW, Semtech SX1231/1231H
// **********************************************************************************
// Copyright Felix Rusu (2014), felix@lowpowerlab.com
// http://lowpowerlab.com/
// **********************************************************************************
// License
// **********************************************************************************
// This program is free software; you can redistribute it
// and/or modify it under the terms of the GNU General
// Public License as published by the Free Software
// Foundation; either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will
// be useful, but WITHOUT ANY WARRANTY; without even the
// implied warranty of MERCHANTABILITY or FITNESS FOR A
// PARTICULAR PURPOSE. See the GNU General Public
// License for more details.
//
// You should have received a copy of the GNU General
// Public License along with this program.
// If not, see <http://www.gnu.org/licenses/>.
//
// Licence can be viewed at
// http://www.gnu.org/licenses/gpl-3.0.txt
//
// Please maintain this license information along with authorship
// and copyright notices in any redistribution of this code
// **********************************************************************************
#ifndef RFM69_h
#define RFM69_h
#if !defined(RFM69_SPI)
#define RFM69_SPI hwSPI //!< default SPI
#endif
#define RFM69_MAX_DATA_LEN (61u) // 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)
#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(MY_RFM69_IRQ_PIN) //!< DEFAULT_RFM69_IRQ_NUM
#elif defined(ARDUINO_ARCH_ESP8266)
#define DEFAULT_RFM69_IRQ_PIN (5) //!< DEFAULT_RFM69_IRQ_PIN
#define DEFAULT_RFM69_IRQ_NUM digitalPinToInterrupt(MY_RFM69_IRQ_PIN) //!< DEFAULT_RFM69_IRQ_NUM
#elif defined(ARDUINO_ARCH_ESP32)
#define DEFAULT_RFM69_IRQ_PIN (16) //!< DEFAULT_RFM69_IRQ_PIN
#define DEFAULT_RFM69_IRQ_NUM digitalPinToInterrupt(DEFAULT_RFM69_IRQ_PIN) //!< DEFAULT_RFM69_IRQ_NUM
#elif defined(ARDUINO_ARCH_SAMD)
#define DEFAULT_RFM69_IRQ_PIN (2) //!< DEFAULT_RFM69_IRQ_PIN
#define DEFAULT_RFM69_IRQ_NUM digitalPinToInterrupt(MY_RFM69_IRQ_PIN) //!< DEFAULT_RFM69_IRQ_NUM
#elif defined(LINUX_ARCH_RASPBERRYPI)
#define DEFAULT_RFM69_IRQ_PIN (22) //!< DEFAULT_RFM69_IRQ_PIN
#define DEFAULT_RFM69_IRQ_NUM DEFAULT_RFM69_IRQ_PIN //!< DEFAULT_RFM69_IRQ_NUM
#elif defined(ARDUINO_ARCH_STM32F1)
#define DEFAULT_RFM69_IRQ_PIN (PA3) //!< DEFAULT_RFM69_IRQ_PIN
#define DEFAULT_RFM69_IRQ_NUM DEFAULT_RFM69_IRQ_PIN //!< DEFAULT_RFM69_IRQ_NUM
#elif defined(TEENSYDUINO)
#define DEFAULT_RFM69_IRQ_PIN (8) //!< DEFAULT_RFM69_IRQ_PIN
#define DEFAULT_RFM69_IRQ_NUM digitalPinToInterrupt(MY_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 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
// 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 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 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 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
#define RFM69_CTL_REQACK 0x40
/** RFM69 class */
class RFM69
{
public:
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
static volatile uint8_t PAYLOADLEN; //!< PAYLOADLEN
static volatile uint8_t ACK_REQUESTED; //!< ACK_REQUESTED
static volatile uint8_t
ACK_RECEIVED; //!< Should be polled immediately after sending a packet with ACK requestwith ACK request
static volatile int16_t RSSI; //!< most accurate RSSI during reception (closest to the reception)
static volatile uint8_t _mode; //!< should be protected?
/**
* @brief Constructor
*
* @param slaveSelectPin ChipSelect pin.
* @param interruptPin Interrupt pin.
* @param isRFM69HW Set to @c true to indicate RFM69HW variant.
* @param interruptNum Interrupt number.
*/
// cppcheck-suppress uninitMemberVar
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 = RFM69_MODE_STANDBY;
_promiscuousMode = false;
_powerLevel = 31;
_isRFM69HW = isRFM69HW;
_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
void setAddress(uint8_t addr); //!< setAddress
void setNetwork(uint8_t networkID); //!< setNetwork
bool canSend(); //!< canSend
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=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
virtual void sendACK(const void* buffer = "", uint8_t bufferSize=0); //!< sendACK
uint32_t getFrequency(); //!< getFrequency
void setFrequency(uint32_t freqHz); //!< setFrequency
void encrypt(const char* key); //!< encrypt
void setCS(uint8_t newSPISlaveSelect); //!< setCS
int16_t readRSSI(bool forceTrigger=false); //!< readRSSI
void promiscuous(bool onOff=true); //!< promiscuous
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(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])
// allow hacking registers by making these public
uint8_t readReg(uint8_t addr); //!< readReg
void writeReg(uint8_t addr, uint8_t val); //!< writeReg
void readAllRegs(); //!< readAllRegs
protected:
static void isr0(); //!< isr0
void virtual interruptHandler(); //!< interruptHandler
virtual void interruptHook(uint8_t CTLbyte); //!< interruptHook
virtual void sendFrame(uint8_t toAddress, const void* buffer, uint8_t size, bool requestACK=false,
bool sendACK=false); //!< sendFrame
static RFM69* selfPointer; //!< selfPointer
uint8_t _slaveSelectPin; //!< _slaveSelectPin
uint8_t _interruptPin; //!< _interruptPin
uint8_t _interruptNum; //!< _interruptNum
uint8_t _address; //!< _address
bool _promiscuousMode; //!< _promiscuousMode
uint8_t _powerLevel; //!< _powerLevel
bool _isRFM69HW; //!< _isRFM69HW
#if defined (SPCR) && defined (SPSR)
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
virtual void setHighPowerRegs(bool onOff); //!< setHighPowerRegs
virtual void select(); //!< select
virtual void unselect(); //!< unselect
};
#endif

1109
lib/MySensors/hal/transport/RFM69/driver/old/RFM69registers_old.h Normal file
View File

File diff suppressed because it is too large Load Diff