RF24Ethernet - TCP/IP over RF24Network v1.6.17
TMRh20 - Pushing the practical limits of RF24 modules
|
User configuration options | |
uIP has a number of configuration options that can be overridden for each project. These are kept in a project-specific uip-conf.h file and all configuration names have the prefix UIP_CONF. Some of these options are specific to RF24Ethernet. | |
#define | UIP_CONF_MAX_CONNECTIONS 1 |
Maximum number of TCP connections. | |
#define | UIP_CONF_MAX_LISTENPORTS 1 |
Maximum number of listening TCP ports. | |
#define | UIP_CONF_BUFFER_SIZE MAX_PAYLOAD_SIZE - 2 |
uIP buffer size. | |
#define | UIP_CONNECTION_TIMEOUT 45000 |
Optional: Uncomment to disable | |
#define | UIP_CONF_LLH_LEN 0 |
SLIP/TUN - 14 for Ethernet/TAP & 0 for TUN/SLIP. | |
#define | UIP_CONF_UDP 0 |
UDP support on or off (required for DNS) | |
Advanced Operation | |
For advanced configuration of RF24Ethernet | |
#define | UIP_TIMER_DIVISOR 16 |
Adjust the rate at which the IP stack performs periodic processing. | |
#define | UIP_CONF_ACTIVE_OPEN 1 |
#define | UIP_CONF_UDP_CHECKSUMS 0 |
UDP checksums on or off. | |
#define | UIP_CONF_EXTERNAL_BUFFER |
uIP User Output buffer size | |
#define | OUTPUT_BUFFER_SIZE UIP_CONF_BUFFER_SIZE - UIP_CONF_LLH_LEN - UIP_TCPIP_HLEN |
#define | UIP_WINDOW_REOPEN_DELAY 3550 |
Optional: Used with UIP_CONNECTION_TIMEOUT | |
User Configuration Options
#define UIP_CONF_MAX_CONNECTIONS 1 |
Maximum number of TCP connections.
Definition at line 59 of file uip-conf.h.
#define UIP_CONF_MAX_LISTENPORTS 1 |
Maximum number of listening TCP ports.
Definition at line 62 of file uip-conf.h.
#define UIP_CONF_BUFFER_SIZE MAX_PAYLOAD_SIZE - 2 |
uIP buffer size.
#define DISABLE_USER_PAYLOADS
. This will free memory not used with RF24Ethernet.Definition at line 82 of file uip-conf.h.
#define UIP_CONNECTION_TIMEOUT 45000 |
Optional: Uncomment to disable
Adjust the length of time after which an open connection will be timed out.
If uIP is polling the established connection, but an ack or data is not received for this duration in ms, kill the connection.
Definition at line 90 of file uip-conf.h.
Referenced by RF24Client::connect().
#define UIP_CONF_LLH_LEN 0 |
SLIP/TUN - 14 for Ethernet/TAP & 0 for TUN/SLIP.
Ethernet headers add an additional 14 bytes to each payload.
RF24Mesh generally needs to be used if setting this to 0 and using a TUN or SLIP interface
Definition at line 99 of file uip-conf.h.
#define UIP_CONF_UDP 0 |
UDP support on or off (required for DNS)
Definition at line 107 of file uip-conf.h.
#define UIP_TIMER_DIVISOR 16 |
Adjust the rate at which the IP stack performs periodic processing.
The periodic timer will be called at a rate of 1 second divided by this value
Increase this value to reduce response times and increase throughput during user interactions.
Definition at line 127 of file uip-conf.h.
#define UIP_CONF_ACTIVE_OPEN 1 |
If operating solely as a server, disable the ability to open TCP connections as a client by setting to 0 Saves memory and program space.
Definition at line 133 of file uip-conf.h.
#define UIP_CONF_UDP_CHECKSUMS 0 |
UDP checksums on or off.
Definition at line 136 of file uip-conf.h.
#define UIP_CONF_EXTERNAL_BUFFER |
uIP User Output buffer size
The output buffer size determines the max length of strings that can be sent by the user, and depends on the uip buffer size
Must be <= UIP_BUFSIZE - UIP_LLH_LEN - UIP_TCPIP_HLEN
Definition at line 148 of file uip-conf.h.
#define OUTPUT_BUFFER_SIZE UIP_CONF_BUFFER_SIZE - UIP_CONF_LLH_LEN - UIP_TCPIP_HLEN |
Definition at line 153 of file uip-conf.h.
Referenced by main_page(), and stats_page().
#define UIP_WINDOW_REOPEN_DELAY 3550 |
Optional: Used with UIP_CONNECTION_TIMEOUT
If an open connection is not receiving data, the connection will be restarted.
Adjust the initial delay period before restarting a connection that has already been restarted
For small payloads (96-120 bytes) with a fast connection, this value can be as low as ~750ms or so. When increasing the uip buffer size, this value should be increased, or the window may be reopened while the requested data is still being received, hindering traffic flow.
Definition at line 167 of file uip-conf.h.