RF24Ethernet - TCP/IP over RF24Network  1.6b
TMRh20 - Pushing the practical limits of RF24 modules
Public Member Functions | Friends | List of all members
RF24EthernetClass Class Reference

#include <RF24Ethernet.h>

Public Member Functions

 RF24EthernetClass (RF24 &_radio, RF24Network &_network, RF24Mesh &_mesh)
 
 RF24EthernetClass ()
 
void use_device ()
 
void begin (IP_ADDR myIP, IP_ADDR subnet)
 
void begin (IPAddress ip)
 
void begin (IPAddress ip, IPAddress dns)
 
void begin (IPAddress ip, IPAddress dns, IPAddress gateway)
 
void begin (IPAddress ip, IPAddress dns, IPAddress gateway, IPAddress subnet)
 
void set_gateway (IPAddress gwIP)
 
void listen (uint16_t port)
 
void setMac (uint16_t address)
 
void setChannel (uint8_t channel)
 
int available ()
 
IPAddress localIP ()
 
IPAddress subnetMask ()
 
IPAddress gatewayIP ()
 
IPAddress dnsServerIP ()
 
void update ()
 

Friends

class RF24Server
 
class RF24Client
 
class RF24UDP
 

Detailed Description

Examples:
Getting_Started_SimpleClient_Mesh.ino, Getting_Started_SimpleServer_Mesh.ino, InteractiveServer_Mesh.ino, mqtt_basic.ino, SimpleClient_Mesh.ino, and SLIP_InteractiveServer.ino.

Definition at line 90 of file RF24Ethernet.h.

Constructor & Destructor Documentation

RF24EthernetClass::RF24EthernetClass ( RF24 &  _radio,
RF24Network &  _network,
RF24Mesh &  _mesh 
)

Constructor to set up the Ethernet layer. Requires the radio and network to be configured by the user this allows users to set custom settings at the radio or network level

Definition at line 35 of file RF24Ethernet.cpp.

RF24EthernetClass::RF24EthernetClass ( )

Basic constructor

Member Function Documentation

void RF24EthernetClass::use_device ( )
Note
Deprecated, maintained for backwards compatibility with old examples

This function is no longer needed, and does nothing

Definition at line 48 of file RF24Ethernet.cpp.

void RF24EthernetClass::begin ( IP_ADDR  myIP,
IP_ADDR  subnet 
)

Configure the IP address and subnet mask of the node. This is independent of the RF24Network layer, so the IP and subnet only have to conform to standard IP routing rules within your network

Referenced by begin().

void RF24EthernetClass::begin ( IPAddress  ip)

Configure the IP address and subnet mask of the node. This is independent of the RF24Network layer, so the IP and subnet only have to conform to standard IP routing rules within your network

Definition at line 85 of file RF24Ethernet.cpp.

References begin().

void RF24EthernetClass::begin ( IPAddress  ip,
IPAddress  dns 
)

Definition at line 92 of file RF24Ethernet.cpp.

References begin().

void RF24EthernetClass::begin ( IPAddress  ip,
IPAddress  dns,
IPAddress  gateway 
)

Definition at line 99 of file RF24Ethernet.cpp.

References begin().

void RF24EthernetClass::begin ( IPAddress  ip,
IPAddress  dns,
IPAddress  gateway,
IPAddress  subnet 
)

Definition at line 105 of file RF24Ethernet.cpp.

void RF24EthernetClass::set_gateway ( IPAddress  gwIP)

Configure the gateway IP address. This is generally going to be your master node with RF24Network address 00.

Definition at line 147 of file RF24Ethernet.cpp.

void RF24EthernetClass::listen ( uint16_t  port)

Listen to a specified port - This will likely be changed to closer match the Arduino Ethernet API with server.begin();

Definition at line 156 of file RF24Ethernet.cpp.

void RF24EthernetClass::setMac ( uint16_t  address)

Definition at line 56 of file RF24Ethernet.cpp.

void RF24EthernetClass::setChannel ( uint8_t  channel)

Sets the Radio channel/frequency to use (0-127)

Definition at line 75 of file RF24Ethernet.cpp.

int RF24EthernetClass::available ( )

Indicates whether data is available.

IPAddress RF24EthernetClass::localIP ( )

Returns the local IP address

Definition at line 163 of file RF24Ethernet.cpp.

IPAddress RF24EthernetClass::subnetMask ( )

Returns the subnet mask

Definition at line 172 of file RF24Ethernet.cpp.

IPAddress RF24EthernetClass::gatewayIP ( )

Returns the gateway IP address

Definition at line 181 of file RF24Ethernet.cpp.

IPAddress RF24EthernetClass::dnsServerIP ( )

Returns the DNS server IP address

Definition at line 190 of file RF24Ethernet.cpp.

void RF24EthernetClass::update ( )

Keeps the TCP/IP stack running & processing incoming data

Definition at line 42 of file RF24Ethernet.cpp.

Friends And Related Function Documentation

friend class RF24Server
friend

Definition at line 197 of file RF24Ethernet.h.

friend class RF24Client
friend

Definition at line 198 of file RF24Ethernet.h.

friend class RF24UDP
friend

Definition at line 199 of file RF24Ethernet.h.