123
Diff: Readme.txt
- Revision:
- 10:e4ddab81e6a8
- Parent:
- 4:d774541a34da
diff -r a156d3de5647 -r e4ddab81e6a8 Readme.txt --- a/Readme.txt Tue Aug 27 15:01:10 2019 +0000 +++ b/Readme.txt Tue Aug 27 22:08:54 2019 +0000 @@ -1,9 +1,9 @@ -This is UIPEthernet version 1.09 +This is UIPEthernet for Mbed OS 2 and Mbed OS 5 -An plugin-replacement of the stock Arduino Ethernet library for ENC28J60 shields and breakout boards. Full support for persistent (streaming) TCP-connections and UDP (Client and Server each), ARP, ICMP, DHCP and DNS. -Just include 'UIPEthernet.h' instead of 'Ethernet.h' and use all your code written for the stock Arduino Ethernet lib! +Full support for persistent (streaming) TCP-connections and UDP (Client and Server each), ARP, ICMP, DHCP and DNS. -UIPEthernet is written as a wrapper around the mature uIP Stack by Adam Dunkels, which provides the low-level implementation for all supported protocols. To overcome the memory-constrains (a 'regular' uIP-application does all processing in RAM) the ENC28J60 internal memory is used for all stream buffers (in and out). Only 400-600 Bytes of Arduinos RAM are used (depending on the number of concurrently open connections). As of Flash-memory a ATmega368-based Arduino is the minimum requirenment. +UIPEthernet is written as a wrapper around the mature uIP Stack by Adam Dunkels, which provides the low-level implementation for all supported protocols. +To overcome the memory-constrains (a 'regular' uIP-application does all processing in RAM) the ENC28J60 internal memory is used for all stream buffers (in and out). This library is written by Norbert Truchsess <norbert.truchsess@t-online.de> @@ -11,26 +11,7 @@ This library was inspired by the SerialIP implementation by Adam Nielsen <malvineous@shikadi.net>, actually I took this code as a starting point, but in the latest versions there are very few lines left. -This library was ported to mbed by Zoltan Hudak <hudakz@inbox.com> - -Installation ------------- - -To install the libraries, you need to place them into your "libraries" folder. You can find it within your Arduino IDE distribution within the "hardware" folder. - - C:\> cd [path to Arduino distribution]\libraries - C:\> git clone https://github.com/ntruchsess/arduino_uip UIPEthernet - -Be sure to restart the IDE if it was running. - -On a Mac, you will want to create a folder named "libraries" in in the "Documents" -> "Arduino" folder within your home directory. Clone the project there (and restart the IDE, if it was running during this process). - - $ cd ~/Documents/Arduino/libraries - $ git clone https://github.com/ntruchsess/arduino_uip UIPEthernet - -Or you download the zipped version of the library from https://github.com/ntruchsess/arduino_uip/releases, and copy the contained directory UIPEthernet to [path to Arduino distribution]\libraries\UIPEthernet. - -If you are running Arduino-IDE 1.5.x use release-version 1.59 or checkout branch 'Arduino_1.5.x' +This library was ported to mbed by Zoltan Hudak <hudakz@outlook.com> Additional information can be found on the Arduino website: http://www.arduino.cc/en/Hacking/Libraries @@ -44,7 +25,6 @@ - Arduino Ethernet library description http://arduino.cc/en/Reference/Ethernet - (Arduino_uip uses the same API as that, just include "UIPEthernet.h", "UIPClient.h", "UIPServer.h" and "UIPUDP.h" instead of the stock "Ethernet.h", "EthernetClient.h", "EthernetServer.h " and "EthernetUDP.h") - uIP API reference: http://www.sics.se/~adam/uip/uip-1.0-refman/ @@ -58,25 +38,21 @@ Licenses ------------- -UIPEthernet.h -UIPEthernet.cpp -UIPUdp.h -UIPClient.cpp +UipEthernet.h +UipEthernet.cpp +UdpSocket.h +UdpSocket.cpp +TcpClient.h +TcpClient.cpp +TcpServer.h +TcpServer.cpp +utility/MemPool.h +utility/MemPool.cpp Copyright (c) 2013 Norbert Truchsess <norbert.truchsess@t-online.de> All rights reserved. -Modified (ported to mbed) by Zoltan Hudak <hudakz@inbox.com> - -UIPServer.h -UIPServer.cpp -UIPClient.h -UIPUdp.cpp -utility/mempool.h -utility/mempool.cpp - -Copyright (c) 2013 Norbert Truchsess <norbert.truchsess@t-online.de> -All rights reserved. +Modified (ported to mbed) by Zoltan Hudak <hudakz@outlook.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 @@ -95,21 +71,21 @@ utility/enc28j60.h -Author : Pascal Stang (c)2005 +Author: Pascal Stang (c)2005 Modified by Norbert Truchsess Copyright: GPL V2 -------------- -utility/Enc28J60Network.h -utility/Enc28J60Network.cpp +utility/Enc28j60Py.h +utility/Enc28j60Py.cpp Copyright (c) 2013 Norbert Truchsess <norbert.truchsess@t-online.de> All rights reserved. inspired and based on enc28j60.c file from the AVRlib library by Pascal Stang. -Modified (ported to mbed) by Zoltan Hudak <hudakz@inbox.com> +Modified (ported to mbed) by Zoltan Hudak <hudakz@outlook.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 @@ -199,17 +175,19 @@ -------------- -Dhcp.h -Dhcp.cpp +DhcpClient.h +DhcpClient.cpp DHCP Library v0.3 - April 25, 2009 Author: Jordan Terrell - blog.jordanterrell.com - as included in Arduinos stock Ethernet-library, no special licence mentioned here +Modified (ported to mbed) by Zoltan Hudak <hudakz@outlook.com> + -------------- -Dns.h -Dns.cpp +DnsClient.h +DnsClient.cpp (c) Copyright 2009-2010 MCQN Ltd. Released under Apache License, version 2.0 @@ -238,13 +216,11 @@ -------------- -Client.h -IPAddress.h -IPAddress.cpp -Server.h +IpAddress.h +IpAddress.cpp Copyright (c) 2011 Adrian McEwen. All right reserved. -Modified (ported to mbed) by Zoltan Hudak <hudakz@inbox.com> +Modified (ported to mbed) by Zoltan Hudak <hudakz@outlook.com> This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public @@ -259,24 +235,3 @@ You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA - --------------- - -utility/millis.h -utility/millis.cpp - -Copyright (c) 2015 Zoltan Hudak <hudakz@inbox.com>. -All right reserved. - -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/>.