Artemis::Devices::RFM23::rfm23_config Struct Reference

The RFM23 configuration structure. More...

#include <rfm23.h>

Classes
struct	pins
	The pins used to connect the RFM23 to the Teensy. More...

Public Attributes
uint16_t	freq
	The operating frequency of the radio in MHz.
uint8_t	tx_power
	The transmitter power level in dBm.
struct Artemis::Devices::RFM23::rfm23_config::pins	pins

Detailed Description

The RFM23 configuration structure.

This defines the configuration settings structure for the RFM23 radio.

The configuration structure consists of three members: the operating frequency (freq), the transmission power (tx_power), and the pins connecting the RFM23 and the Teensy (pins).

IMPORTANT: Ensure that frequency and power settings are correct before transmitting. Damage to the radio can occur if output power is too high, and frequency selected must be legally permitted.A diagram of the RFM23 configuration struct is included below.

2 bytes 1 byte     7 bytes
+-------+----------+------+
| freq  | tx_power | pins |
+-------+----------+------+

Member Data Documentation

freq

uint16_t Artemis::Devices::RFM23::rfm23_config::freq

The operating frequency of the radio in MHz.

For the RFM23B, valid values are from 413 to 453 MHz.

pins

struct Artemis::Devices::RFM23::rfm23_config::pins Artemis::Devices::RFM23::rfm23_config::pins

A diagram of the pins struct is included below.

 1 byte     1 byte     1 byte    1 byte 1 byte 1 byte  1 byte
+----------+----------+---------+------+------+-------+-------+
| spi_miso | spi_mosi | spi_sck | nirq | cs   | tx_on | rx_on |
+----------+----------+---------+------+------+-------+-------+

tx_power

uint8_t Artemis::Devices::RFM23::rfm23_config::tx_power

The transmitter power level in dBm.

For the RFM23B, valid values are from -8 to +13. These values are not directly set as integer values, but defined as RadioHead macros. Possible options are:

• RH_RF22_RF23B_TXPOW_M8DBM: -8dBm
• RH_RF22_RF23B_TXPOW_M5DBM: -5dBm
• RH_RF22_RF23B_TXPOW_M2DBM: -2dBm
• RH_RF22_RF23B_TXPOW_1DBM: +1dBm
• RH_RF22_RF23B_TXPOW_4DBM: +4dBm
• RH_RF22_RF23B_TXPOW_7DBM: +7dBm
• RH_RF22_RF23B_TXPOW_10DBM: +10dBm
• RH_RF22_RF23B_TXPOW_13DBM: +13dBm

For RFM23BP, additional higher output power is available, up to +30dBm. These higher output power options replace the higher output options of the RFM23B. Possible options are:

• RH_RF22_RF23BP_TXPOW_28DBM: +28dBm (replaces RH_RF22_RF23B_TXPOW_7DBM)
• RH_RF22_RF23BP_TXPOW_29DBM: +29dBm (replaces RH_RF22_RF23B_TXPOW_10DBM)
• RH_RF22_RF23BP_TXPOW_30DBM: +30dBm (replaces RH_RF22_RF23B_TXPOW_13DBM)

---

The documentation for this struct was generated from the following file:

• lib/rfm23/rfm23.h