Collaboration diagram for RFM69:

Detailed Description

These options are specific to the RFM69 family of wireless transport modules.

The following chips are supported by this driver:

Semtech sx1231

If using the HW variant of the RFM69 module, define MY_IS_RFM69HW.

Macros
#define	MY_RADIO_RFM69
	Define this to use RFM69 based radios for sensor network communication.

#define	MY_DEBUG_VERBOSE_RFM69
	Define this for verbose debug prints related to the RFM69 driver.

#define	MY_DEBUG_VERBOSE_RFM69_REGISTERS
	Define this for verbose dumping of the RFM69 registers.

#define	MY_RFM69_NEW_DRIVER
	Define this to enable the improved RFM69 driver. More...

#define	MY_RFM69_FREQUENCY (RFM69_868MHZ)
	The frequency to use. More...

#define	MY_IS_RFM69HW
	Define this if you are using the RFM69HW model.

#define	MY_RFM69HW false
	Set to true if MY_IS_RFM69HW is set. More...

#define	MY_RFM69_TX_POWER_DBM (5)
	Set TX power level, default 5dBm (overridden if ATC mode enabled).

#define	MY_RFM69_ATC_TARGET_RSSI_DBM (-80)
	Target RSSI level (in dBm) for RFM69 ATC mode.

#define	MY_RFM69_ATC_MODE_DISABLED
	Define to disable ATC mode of RFM69 driver.

#define	MY_RFM69_MAX_POWER_LEVEL_DBM
	Set max TX power in dBm if local legislation requires this. More...

#define	MY_RFM69_NETWORKID (100)
	RFM69 Network ID. Use the same for all nodes that will talk to each other.

#define	MY_RFM69_RST_PIN
	Define this to use the RFM69 reset pin (optional).

#define	MY_RFM69_POWER_PIN
	Define this to use the RFM69 power pin (optional).

#define	MY_RFM69_IRQ_PIN DEFAULT_RFM69_IRQ_PIN
	Define this to override the default RFM69 IRQ pin assignment.

#define	MY_RFM69_IRQ_NUM digitalPinToInterrupt(MY_RFM69_IRQ_PIN)
	RFM69 IRQ number.

#define	MY_RFM69_CS_PIN DEFAULT_RFM69_CS_PIN
	RFM69 SPI chip select pin.

#define	MY_RFM69_SPI_SPEED (4*1000000ul)
	Set to overrule default RFM69 SPI speed.

#define	MY_RFM69_ENABLE_ENCRYPTION
	Define this to enable AES encryption in the RFM69 module. More...

#define	MY_RFM69_MODEM_CONFIGURATION
	RFM69 modem configuration, default is RFM69_FSK_BR55_5_FD50 More...

Macro Definition Documentation

◆ MY_RFM69_ENABLE_ENCRYPTION

#define MY_RFM69_ENABLE_ENCRYPTION

Define this to enable AES encryption in the RFM69 module.

All nodes and gateway must have this enabled, and all must be personalized with the same AES key.

See also: personalization

Definition at line 2756 of file MyConfig.h.

◆ MY_RFM69_FREQUENCY

#define MY_RFM69_FREQUENCY (RFM69_868MHZ)

The frequency to use.

RFM69_315MHZ
RFM69_433MHZ
RFM69_865MHZ
RFM69_868MHZ
RFM69_915MHZ
Custom frequency in Hz (new RFM69 driver only)
See also
MY_RFM69_NEW_DRIVER
This must match the hardware version of the RFM69 radio. Additional information: https://en.wikipedia.org/wiki/Short_Range_Devices

Definition at line 696 of file MyConfig.h.

◆ MY_RFM69_MAX_POWER_LEVEL_DBM

#define MY_RFM69_MAX_POWER_LEVEL_DBM

Set max TX power in dBm if local legislation requires this.

1mW = 0dBm
10mW = 10dBm
25mW = 14dBm
100mW = 20dBm

See here: https://en.wikipedia.org/wiki/Short_Range_Devices

Definition at line 2758 of file MyConfig.h.

◆ MY_RFM69_MODEM_CONFIGURATION

#define MY_RFM69_MODEM_CONFIGURATION

RFM69 modem configuration, default is RFM69_FSK_BR55_5_FD50

Configuration	Modulation (xxx)	Bit rate	FD	RXBW	Additional settings
RFM69_xxx_BR2_FD5	FSK/GFSK/OOK	2000	5000	111_24_4	Whitening
RFM69_xxx_BR2_4_FD4_8	FSK/GFSK/OOK	2400	4800	111_24_4	Whitening
RFM69_xxx_BR4_8_FD9_6	FSK/GFSK/OOK	4800	9600	111_24_4	Whitening
RFM69_xxx_BR9_6_FD19_2	FSK/GFSK/OOK	9600	19200	111_24_4	Whitening
RFM69_xxx_BR19_2_FD38_4	FSK/GFSK/OOK	19200	38400	111_24_3	Whitening
RFM69_xxx_BR38_4_FD76_8	FSK/GFSK/OOK	38400	76800	111_24_2	Whitening
RFM69_xxx_BR55_5_FD50	FSK/GFSK/OOK	55555	50000	111_16_2	Whitening
RFM69_xxx_BR57_6_FD120	FSK/GFSK/OOK	57600	120000	111_16_1	Whitening
RFM69_xxx_BR125_FD125	FSK/GFSK/OOK	125000	125000	010_16_2	Whitening
RFM69_xxx_BR250_FD250	FSK/GFSK/OOK	250000	250000	111_16_0	Whitening

https://www.semtech.com/uploads/documents/sx1231.pdf

Definition at line 2755 of file MyConfig.h.

◆ MY_RFM69_NEW_DRIVER

#define MY_RFM69_NEW_DRIVER

Define this to enable the improved RFM69 driver.

Note: This driver is not compatible with the old (=default) RFM69 driver.

Definition at line 2753 of file MyConfig.h.

◆ MY_RFM69HW

#define MY_RFM69HW false

Set to true if MY_IS_RFM69HW is set.

Todo:: Mark this internals

Definition at line 714 of file MyConfig.h.