Zoltan Hudak / UIPEthernet Featured

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.

Last commit 23 Jul 2020 by Zoltan Hudak

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>.

Last commit 23 Jul 2020 by Zoltan Hudak

Import programTcpServer_ENC28J60

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

Last commit 23 Jul 2020 by Zoltan Hudak

Import programTcpClient_ENC28J60

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

Last commit 23 Jul 2020 by Zoltan Hudak

Import programUdpServer_ENC28J60

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

Last commit 23 Jul 2020 by Zoltan Hudak

Import programUdpClient_ENC28J60

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

Last commit 23 Jul 2020 by Zoltan Hudak

Import programMQTT_Hello_ENC28J60

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

Last commit 23 Jul 2020 by Zoltan Hudak

utility/Enc28j60Eth.h

Committer:
hudakz
Date:
2019-09-07
Revision:
15:53715cc81c63
Parent:
14:7648334eb41b

File content as of revision 15:53715cc81c63:

/*
 Enc28J60Network.h
 UIPEthernet network driver for Microchip ENC28J60 Ethernet Interface.

 Copyright (c) 2013 Norbert Truchsess <norbert.truchsess@t-online.de>
 All rights reserved.

 based on enc28j60.c file from the AVRlib library by Pascal Stang.
 For AVRlib See http://www.procyonengineering.com/

 Modified (ported to mbed) by Zoltan Hudak <hudakz@inbox.com>

 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef ENC28J60PHY_H
#define ENC28J60PHY_H

#include "mbed.h"
#include "MemPool.h"

#define UIP_RECEIVEBUFFERHANDLE 0xff

//#define ENC28J60DEBUG

class Enc28j60Eth : public MemPool
{
private:
    SPI             _spi;
    DigitalOut      _cs;
    static uint16_t nextPacketPtr;
    static uint8_t  bank;

    static struct memblock  receivePkt;

    uint16_t    setReadPtr(memhandle handle, memaddress position, uint16_t len);
    void        setERXRDPT();
    void        readBuffer(uint16_t len, uint8_t* data);
    void        writeBuffer(uint16_t len, uint8_t* data);
    void        setBank(uint8_t address);
    uint8_t     readReg(uint8_t address);
    void        writeReg(uint8_t address, uint8_t data);
    void        phyWrite(uint8_t address, uint16_t data);
    uint16_t    phyRead(uint8_t address);
    void        clkout(uint8_t clk);

    friend void enc28j60_mempool_block_move_callback(memaddress, memaddress, memaddress);
public:
    Enc28j60Eth(PinName mosi, PinName miso, PinName sclk, PinName cs);
    uint8_t     getrev();
    void        powerOn();
    void        powerOff();
    bool        linkStatus();

    void        init(uint8_t* macaddr);
    memhandle   receivePacket();
    void        freePacket();
    size_t      blockSize(memhandle handle);
    void        sendPacket(memhandle handle);
    uint16_t    readPacket(memhandle handle, memaddress position, uint8_t* buffer, uint16_t len);
    uint16_t    writePacket(memhandle handle, memaddress position, uint8_t* buffer, uint16_t len);
    void        copyPacket(memhandle dest, memaddress dest_pos, memhandle src, memaddress src_pos, uint16_t len);
    uint16_t    chksum(uint16_t sum, memhandle handle, memaddress pos, uint16_t len);

    uint8_t     readOp(uint8_t op, uint8_t address);
    uint8_t     readByte(uint16_t addr);
    void        writeOp(uint8_t op, uint8_t address, uint8_t data);
    void        writeRegPair(uint8_t address, uint16_t data);
    void        writeByte(uint16_t addr, uint8_t data);
};

#endif