Mbed library for ENC28J60 Ethernet modules. Full support for TCP/IP and UDP Server, Client and HTTP server (webserver). DHCP and DNS is included.

Dependents:   mBuino_ENC28_MQTT Nucleo_Web_ENC28J60 Nucleo_Web_ENC28J60_ADC Serial_over_Ethernet ... more

Library for ENC28J60 Ethernet modules.

/media/uploads/hudakz/enc28j60_module01.jpg

Ported to mbed from Norbert Truchsess's UIPEthernet library for Arduino. Thank you Norbert!

  • Full support for persistent (streaming) TCP/IP and UDP connections Client and Server each, ARP, ICMP, DHCP and DNS.
  • Works with both Mbed OS 2 and Mbed OS 5.

Usage:

  • Import the library into your project.
  • Add #include "UipEthernet.h" to main.cpp
  • Create one instance of the UipEthernet class initialized with the MAC address you'd like to use and SPI pins of the connected Mbed board.

Example programs:

Import programWebSwitch_ENC28J60

HTTP Server serving a simple webpage which enables to remotely turn a digital output on/off. Compile, download, run and type 'IP_address/secret/' (don't forget the last '/') into your web browser and hit ENTER.

Import programHTTPServer_Echo_ENC28J60

A simple HTTP server echoing received requests. Ethernet connection is over an ENC28J60 board. Usage: Type the server's IP address into you web browser and hit <ENTER>.

Import programTcpServer_ENC28J60

Simple TCP/IP Server using the UIPEthernet library for ENC28J60 Ethernet boards.

Import programTcpClient_ENC28J60

Simple TCP/IP Client using the UIPEthernet library for ENC28J60 Ethernet boards.

Import programUdpServer_ENC28J60

Simple UDP Server using the UIPEthernet library for ENC28J60 Ethernet boards.

Import programUdpClient_ENC28J60

Simple UDP Client using the UIPEthernet library for ENC28J60 Ethernet boards.

Import programMQTT_Hello_ENC28J60

MQTT Client example program. Ethernet connection is via an ENC28J60 module.

utility/uip-conf.h

Committer:
hudakz
Date:
2020-07-23
Revision:
18:8d5738a6646e
Parent:
15:53715cc81c63

File content as of revision 18:8d5738a6646e:

/**
 * UIPEthernet Project-specific configuration options
 * Copyright (c) 2013 Norbert Truchsess <norbert.truchsess@t-online.de>
 * @{
 *
 * 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.
 */
/*
 * Copyright (c) 2006, Swedish Institute of Computer Science.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the Institute nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * This file is part of the UIP TCP/IP stack
 *
 */
#ifndef __UIP_CONF_H__
#define __UIP_CONF_H__

#include <inttypes.h>
#include "uipethernet-conf.h"

/**
 * 8 bit datatype
 *
 * This typedef defines the 8-bit type used throughout UIP.
 *
 * \hideinitializer
 */
typedef uint8_t         u8_t;

/**
 * 16 bit datatype
 *
 * This typedef defines the 16-bit type used throughout UIP.
 *
 * \hideinitializer
 */
typedef uint16_t        u16_t;

/**
 * Statistics datatype
 *
 * This typedef defines the dataype used for keeping statistics in
 * UIP.
 *
 * \hideinitializer
 */
typedef unsigned short  uip_stats_t;

/**
 * Maximum number of TCP connections.
 * (see uipethernet-conf.h)
 * \hideinitializer
 *
 * #define UIP_CONF_MAX_CONNECTIONS 4
 */

/**
 * Maximum number of listening TCP ports.
 *
 * \hideinitializer
 */
#define UIP_CONF_MAX_LISTENPORTS    4

/**
 * UIP buffer size.
 *
 * \hideinitializer
 */

#define UIP_CONF_BUFFER_SIZE    98
//#define UIP_CONF_BUFFER_SIZE     118

/**
 * The TCP maximum segment size.
 *
 * This is should not be to set to more than
 * UIP_BUFSIZE - UIP_LLH_LEN - UIP_TCPIP_HLEN.
 */
#define UIP_CONF_TCP_MSS    512

/**
 * The size of the advertised receiver's window.
 *
 * Should be set low (i.e., to the size of the uip_buf buffer) is the
 * application is slow to process incoming data, or high (32768 bytes)
 * if the application processes data quickly.
 *
 * \hideinitializer
 */

#define UIP_CONF_RECEIVE_WINDOW 512

/**
 * CPU byte order.
 *
 * \hideinitializer
 */

#define UIP_CONF_BYTE_ORDER UIP_LITTLE_ENDIAN

/**
 * Logging on or off
 *
 * \hideinitializer
 */

#define UIP_CONF_LOGGING    0

/**
 * UDP support on or off
 * (see uipethernet-conf.h)
 * \hideinitializer
 *
 * #define UIP_CONF_UDP             1
 *
 * #define UIP_CONF_UDP_CONNS       4
 */

/**
 * UDP checksums on or off
 *
 * \hideinitializer
 */
#define UIP_CONF_UDP_CHECKSUMS  1

/**
 * UDP Broadcast (receive) on or off
 * (see uipethernet-conf.h)
 * \hideinitializer
 * #define UIP_CONF_BROADCAST    1
 */

/**
 * UIP statistics on or off
 *
 * \hideinitializer
 */
#define UIP_CONF_STATISTICS 0
//#define UIP_CONF_LLH_LEN 0
typedef void*   uip_tcp_appstate_t;
void            uipclient_appcall(void);
#define UIP_APPCALL uipclient_appcall
typedef void*   uip_udp_appstate_t;
void            uipudp_appcall(void);
#define UIP_UDP_APPCALL uipudp_appcall
#define CC_REGISTER_ARG register
#define UIP_ARCH_CHKSUM 1
#endif /* __UIP_CONF_H__ */