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

SocketAddress.cpp@17:1123c3fe86ca, 2020-06-05 (annotated)

Committer:
hudakz
Date:
Fri Jun 05 15:21:49 2020 +0000
Revision:
17:1123c3fe86ca
Parent:
14:7648334eb41b 
Library for the ENC28J60 Ethernet modules.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
hudakz 14:7648334eb41b 1 /* Socket
hudakz 14:7648334eb41b 2 * Copyright (c) 2015 ARM Limited
hudakz 14:7648334eb41b 3 *
hudakz 14:7648334eb41b 4 * Licensed under the Apache License, Version 2.0 (the "License");
hudakz 14:7648334eb41b 5 * you may not use this file except in compliance with the License.
hudakz 14:7648334eb41b 6 * You may obtain a copy of the License at
hudakz 14:7648334eb41b 7 *
hudakz 14:7648334eb41b 8 * http://www.apache.org/licenses/LICENSE-2.0
hudakz 14:7648334eb41b 9 *
hudakz 14:7648334eb41b 10 * Unless required by applicable law or agreed to in writing, software
hudakz 14:7648334eb41b 11 * distributed under the License is distributed on an "AS IS" BASIS,
hudakz 14:7648334eb41b 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
hudakz 14:7648334eb41b 13 * See the License for the specific language governing permissions and
hudakz 14:7648334eb41b 14 * limitations under the License.
hudakz 14:7648334eb41b 15 */
hudakz 14:7648334eb41b 16
hudakz 14:7648334eb41b 17 #include "mbed_version.h"
hudakz 14:7648334eb41b 18
hudakz 14:7648334eb41b 19 #if MBED_MAJOR_VERSION == 2
hudakz 14:7648334eb41b 20
hudakz 14:7648334eb41b 21 #include "SocketAddress.h"
hudakz 14:7648334eb41b 22 //#include "NetworkInterface.h"
hudakz 14:7648334eb41b 23 //#include "NetworkStack.h"
hudakz 14:7648334eb41b 24 #include <string.h>
hudakz 14:7648334eb41b 25 #include <stdio.h>
hudakz 14:7648334eb41b 26 #include "ip4string.h"
hudakz 14:7648334eb41b 27 #include "ip6string.h"
hudakz 14:7648334eb41b 28
hudakz 14:7648334eb41b 29 /**
hudakz 14:7648334eb41b 30 * @brief
hudakz 14:7648334eb41b 31 * @note
hudakz 14:7648334eb41b 32 * @param
hudakz 14:7648334eb41b 33 * @retval
hudakz 14:7648334eb41b 34 */
hudakz 14:7648334eb41b 35 SocketAddress::SocketAddress(nsapi_addr_t addr, uint16_t port)
hudakz 14:7648334eb41b 36 {
hudakz 14:7648334eb41b 37 mem_init();
hudakz 14:7648334eb41b 38 _ip_address = NULL;
hudakz 14:7648334eb41b 39 set_addr(addr);
hudakz 14:7648334eb41b 40 set_port(port);
hudakz 14:7648334eb41b 41 }
hudakz 14:7648334eb41b 42
hudakz 14:7648334eb41b 43 /**
hudakz 14:7648334eb41b 44 * @brief
hudakz 14:7648334eb41b 45 * @note
hudakz 14:7648334eb41b 46 * @param
hudakz 14:7648334eb41b 47 * @retval
hudakz 14:7648334eb41b 48 */
hudakz 14:7648334eb41b 49 SocketAddress::SocketAddress(const char* addr, uint16_t port)
hudakz 14:7648334eb41b 50 {
hudakz 14:7648334eb41b 51 mem_init();
hudakz 14:7648334eb41b 52 _ip_address = NULL;
hudakz 14:7648334eb41b 53 set_ip_address(addr);
hudakz 14:7648334eb41b 54 set_port(port);
hudakz 14:7648334eb41b 55 }
hudakz 14:7648334eb41b 56
hudakz 14:7648334eb41b 57 /**
hudakz 14:7648334eb41b 58 * @brief
hudakz 14:7648334eb41b 59 * @note
hudakz 14:7648334eb41b 60 * @param
hudakz 14:7648334eb41b 61 * @retval
hudakz 14:7648334eb41b 62 */
hudakz 14:7648334eb41b 63 SocketAddress::SocketAddress(const void* bytes, nsapi_version_t version, uint16_t port)
hudakz 14:7648334eb41b 64 {
hudakz 14:7648334eb41b 65 mem_init();
hudakz 14:7648334eb41b 66 _ip_address = NULL;
hudakz 14:7648334eb41b 67 set_ip_bytes(bytes, version);
hudakz 14:7648334eb41b 68 set_port(port);
hudakz 14:7648334eb41b 69 }
hudakz 14:7648334eb41b 70
hudakz 14:7648334eb41b 71 /**
hudakz 14:7648334eb41b 72 * @brief
hudakz 14:7648334eb41b 73 * @note
hudakz 14:7648334eb41b 74 * @param
hudakz 14:7648334eb41b 75 * @retval
hudakz 14:7648334eb41b 76 */
hudakz 14:7648334eb41b 77 SocketAddress::SocketAddress(const SocketAddress& addr)
hudakz 14:7648334eb41b 78 {
hudakz 14:7648334eb41b 79 mem_init();
hudakz 14:7648334eb41b 80 _ip_address = NULL;
hudakz 14:7648334eb41b 81 set_addr(addr.get_addr());
hudakz 14:7648334eb41b 82 set_port(addr.get_port());
hudakz 14:7648334eb41b 83 }
hudakz 14:7648334eb41b 84
hudakz 14:7648334eb41b 85 /**
hudakz 14:7648334eb41b 86 * @brief
hudakz 14:7648334eb41b 87 * @note
hudakz 14:7648334eb41b 88 * @param
hudakz 14:7648334eb41b 89 * @retval
hudakz 14:7648334eb41b 90 */
hudakz 14:7648334eb41b 91 void SocketAddress::mem_init(void)
hudakz 14:7648334eb41b 92 {
hudakz 14:7648334eb41b 93 _addr.version = NSAPI_UNSPEC;
hudakz 14:7648334eb41b 94 memset(_addr.bytes, 0, NSAPI_IP_BYTES);
hudakz 14:7648334eb41b 95 _port = 0;
hudakz 14:7648334eb41b 96 }
hudakz 14:7648334eb41b 97
hudakz 14:7648334eb41b 98 /**
hudakz 14:7648334eb41b 99 * @brief
hudakz 14:7648334eb41b 100 * @note
hudakz 14:7648334eb41b 101 * @param
hudakz 14:7648334eb41b 102 * @retval
hudakz 14:7648334eb41b 103 */
hudakz 14:7648334eb41b 104 bool SocketAddress::set_ip_address(const char* addr)
hudakz 14:7648334eb41b 105 {
hudakz 14:7648334eb41b 106 delete[] _ip_address;
hudakz 14:7648334eb41b 107 _ip_address = NULL;
hudakz 14:7648334eb41b 108
hudakz 14:7648334eb41b 109 if (addr && stoip4(addr, strlen(addr), _addr.bytes)) {
hudakz 14:7648334eb41b 110 _addr.version = NSAPI_IPv4;
hudakz 14:7648334eb41b 111 return true;
hudakz 14:7648334eb41b 112 }
hudakz 14:7648334eb41b 113 else
hudakz 14:7648334eb41b 114 if (addr && stoip6(addr, strlen(addr), _addr.bytes)) {
hudakz 14:7648334eb41b 115 _addr.version = NSAPI_IPv6;
hudakz 14:7648334eb41b 116 return true;
hudakz 14:7648334eb41b 117 }
hudakz 14:7648334eb41b 118 else {
hudakz 14:7648334eb41b 119 _addr = nsapi_addr_t();
hudakz 14:7648334eb41b 120 return false;
hudakz 14:7648334eb41b 121 }
hudakz 14:7648334eb41b 122 }
hudakz 14:7648334eb41b 123
hudakz 14:7648334eb41b 124 /**
hudakz 14:7648334eb41b 125 * @brief
hudakz 14:7648334eb41b 126 * @note
hudakz 14:7648334eb41b 127 * @param
hudakz 14:7648334eb41b 128 * @retval
hudakz 14:7648334eb41b 129 */
hudakz 14:7648334eb41b 130 void SocketAddress::set_ip_bytes(const void* bytes, nsapi_version_t version)
hudakz 14:7648334eb41b 131 {
hudakz 14:7648334eb41b 132 nsapi_addr_t addr;
hudakz 14:7648334eb41b 133
hudakz 14:7648334eb41b 134 addr = nsapi_addr_t();
hudakz 14:7648334eb41b 135 addr.version = version;
hudakz 14:7648334eb41b 136 if (version == NSAPI_IPv6) {
hudakz 14:7648334eb41b 137 memcpy(addr.bytes, bytes, NSAPI_IPv6_BYTES);
hudakz 14:7648334eb41b 138 }
hudakz 14:7648334eb41b 139 else
hudakz 14:7648334eb41b 140 if (version == NSAPI_IPv4) {
hudakz 14:7648334eb41b 141 memcpy(addr.bytes, bytes, NSAPI_IPv4_BYTES);
hudakz 14:7648334eb41b 142 }
hudakz 14:7648334eb41b 143
hudakz 14:7648334eb41b 144 set_addr(addr);
hudakz 14:7648334eb41b 145 }
hudakz 14:7648334eb41b 146
hudakz 14:7648334eb41b 147 /**
hudakz 14:7648334eb41b 148 * @brief
hudakz 14:7648334eb41b 149 * @note
hudakz 14:7648334eb41b 150 * @param
hudakz 14:7648334eb41b 151 * @retval
hudakz 14:7648334eb41b 152 */
hudakz 14:7648334eb41b 153 void SocketAddress::set_addr(nsapi_addr_t addr)
hudakz 14:7648334eb41b 154 {
hudakz 14:7648334eb41b 155 delete[] _ip_address;
hudakz 14:7648334eb41b 156 _ip_address = NULL;
hudakz 14:7648334eb41b 157 _addr = addr;
hudakz 14:7648334eb41b 158 }
hudakz 14:7648334eb41b 159
hudakz 14:7648334eb41b 160 /**
hudakz 14:7648334eb41b 161 * @brief
hudakz 14:7648334eb41b 162 * @note
hudakz 14:7648334eb41b 163 * @param
hudakz 14:7648334eb41b 164 * @retval
hudakz 14:7648334eb41b 165 */
hudakz 14:7648334eb41b 166 void SocketAddress::set_port(uint16_t port)
hudakz 14:7648334eb41b 167 {
hudakz 14:7648334eb41b 168 _port = port;
hudakz 14:7648334eb41b 169 }
hudakz 14:7648334eb41b 170
hudakz 14:7648334eb41b 171 /**
hudakz 14:7648334eb41b 172 * @brief
hudakz 14:7648334eb41b 173 * @note
hudakz 14:7648334eb41b 174 * @param
hudakz 14:7648334eb41b 175 * @retval
hudakz 14:7648334eb41b 176 */
hudakz 14:7648334eb41b 177 const char* SocketAddress::get_ip_address() const
hudakz 14:7648334eb41b 178 {
hudakz 14:7648334eb41b 179 if (_addr.version == NSAPI_UNSPEC) {
hudakz 14:7648334eb41b 180 return NULL;
hudakz 14:7648334eb41b 181 }
hudakz 14:7648334eb41b 182
hudakz 14:7648334eb41b 183 if (!_ip_address) {
hudakz 14:7648334eb41b 184 _ip_address = new char[NSAPI_IP_SIZE];
hudakz 14:7648334eb41b 185 if (_addr.version == NSAPI_IPv4) {
hudakz 14:7648334eb41b 186 ip4tos(_addr.bytes, _ip_address);
hudakz 14:7648334eb41b 187 }
hudakz 14:7648334eb41b 188 else
hudakz 14:7648334eb41b 189 if (_addr.version == NSAPI_IPv6) {
hudakz 14:7648334eb41b 190 ip6tos(_addr.bytes, _ip_address);
hudakz 14:7648334eb41b 191 }
hudakz 14:7648334eb41b 192 }
hudakz 14:7648334eb41b 193
hudakz 14:7648334eb41b 194 return _ip_address;
hudakz 14:7648334eb41b 195 }
hudakz 14:7648334eb41b 196
hudakz 14:7648334eb41b 197 /**
hudakz 14:7648334eb41b 198 * @brief
hudakz 14:7648334eb41b 199 * @note
hudakz 14:7648334eb41b 200 * @param
hudakz 14:7648334eb41b 201 * @retval
hudakz 14:7648334eb41b 202 */
hudakz 14:7648334eb41b 203 const void* SocketAddress::get_ip_bytes() const
hudakz 14:7648334eb41b 204 {
hudakz 14:7648334eb41b 205 return _addr.bytes;
hudakz 14:7648334eb41b 206 }
hudakz 14:7648334eb41b 207
hudakz 14:7648334eb41b 208 /**
hudakz 14:7648334eb41b 209 * @brief
hudakz 14:7648334eb41b 210 * @note
hudakz 14:7648334eb41b 211 * @param
hudakz 14:7648334eb41b 212 * @retval
hudakz 14:7648334eb41b 213 */
hudakz 14:7648334eb41b 214 nsapi_version_t SocketAddress::get_ip_version() const
hudakz 14:7648334eb41b 215 {
hudakz 14:7648334eb41b 216 return _addr.version;
hudakz 14:7648334eb41b 217 }
hudakz 14:7648334eb41b 218
hudakz 14:7648334eb41b 219 /**
hudakz 14:7648334eb41b 220 * @brief
hudakz 14:7648334eb41b 221 * @note
hudakz 14:7648334eb41b 222 * @param
hudakz 14:7648334eb41b 223 * @retval
hudakz 14:7648334eb41b 224 */
hudakz 14:7648334eb41b 225 nsapi_addr_t SocketAddress::get_addr() const
hudakz 14:7648334eb41b 226 {
hudakz 14:7648334eb41b 227 return _addr;
hudakz 14:7648334eb41b 228 }
hudakz 14:7648334eb41b 229
hudakz 14:7648334eb41b 230 /**
hudakz 14:7648334eb41b 231 * @brief
hudakz 14:7648334eb41b 232 * @note
hudakz 14:7648334eb41b 233 * @param
hudakz 14:7648334eb41b 234 * @retval
hudakz 14:7648334eb41b 235 */
hudakz 14:7648334eb41b 236 uint16_t SocketAddress::get_port() const
hudakz 14:7648334eb41b 237 {
hudakz 14:7648334eb41b 238 return _port;
hudakz 14:7648334eb41b 239 }
hudakz 14:7648334eb41b 240
hudakz 14:7648334eb41b 241 /**
hudakz 14:7648334eb41b 242 * @brief
hudakz 14:7648334eb41b 243 * @note
hudakz 14:7648334eb41b 244 * @param
hudakz 14:7648334eb41b 245 * @retval
hudakz 14:7648334eb41b 246 */
hudakz 14:7648334eb41b 247 SocketAddress::operator bool() const
hudakz 14:7648334eb41b 248 {
hudakz 14:7648334eb41b 249 if (_addr.version == NSAPI_IPv4) {
hudakz 14:7648334eb41b 250 for (int i = 0; i < NSAPI_IPv4_BYTES; i++) {
hudakz 14:7648334eb41b 251 if (_addr.bytes[i]) {
hudakz 14:7648334eb41b 252 return true;
hudakz 14:7648334eb41b 253 }
hudakz 14:7648334eb41b 254 }
hudakz 14:7648334eb41b 255
hudakz 14:7648334eb41b 256 return false;
hudakz 14:7648334eb41b 257 }
hudakz 14:7648334eb41b 258 else
hudakz 14:7648334eb41b 259 if (_addr.version == NSAPI_IPv6) {
hudakz 14:7648334eb41b 260 for (int i = 0; i < NSAPI_IPv6_BYTES; i++) {
hudakz 14:7648334eb41b 261 if (_addr.bytes[i]) {
hudakz 14:7648334eb41b 262 return true;
hudakz 14:7648334eb41b 263 }
hudakz 14:7648334eb41b 264 }
hudakz 14:7648334eb41b 265
hudakz 14:7648334eb41b 266 return false;
hudakz 14:7648334eb41b 267 }
hudakz 14:7648334eb41b 268 else {
hudakz 14:7648334eb41b 269 return false;
hudakz 14:7648334eb41b 270 }
hudakz 14:7648334eb41b 271 }
hudakz 14:7648334eb41b 272
hudakz 14:7648334eb41b 273 /**
hudakz 14:7648334eb41b 274 * @brief
hudakz 14:7648334eb41b 275 * @note
hudakz 14:7648334eb41b 276 * @param
hudakz 14:7648334eb41b 277 * @retval
hudakz 14:7648334eb41b 278 */
hudakz 14:7648334eb41b 279 SocketAddress &SocketAddress::operator=(const SocketAddress& addr)
hudakz 14:7648334eb41b 280 {
hudakz 14:7648334eb41b 281 delete[] _ip_address;
hudakz 14:7648334eb41b 282 _ip_address = NULL;
hudakz 14:7648334eb41b 283 set_addr(addr.get_addr());
hudakz 14:7648334eb41b 284 set_port(addr.get_port());
hudakz 14:7648334eb41b 285 return *this;
hudakz 14:7648334eb41b 286 }
hudakz 14:7648334eb41b 287
hudakz 14:7648334eb41b 288 /**
hudakz 14:7648334eb41b 289 * @brief
hudakz 14:7648334eb41b 290 * @note
hudakz 14:7648334eb41b 291 * @param
hudakz 14:7648334eb41b 292 * @retval
hudakz 14:7648334eb41b 293 */
hudakz 14:7648334eb41b 294 bool operator==(const SocketAddress& a, const SocketAddress& b)
hudakz 14:7648334eb41b 295 {
hudakz 14:7648334eb41b 296 if (!a && !b) {
hudakz 14:7648334eb41b 297 return true;
hudakz 14:7648334eb41b 298 }
hudakz 14:7648334eb41b 299 else
hudakz 14:7648334eb41b 300 if (a._addr.version != b._addr.version) {
hudakz 14:7648334eb41b 301 return false;
hudakz 14:7648334eb41b 302 }
hudakz 14:7648334eb41b 303 else
hudakz 14:7648334eb41b 304 if (a._addr.version == NSAPI_IPv4) {
hudakz 14:7648334eb41b 305 return memcmp(a._addr.bytes, b._addr.bytes, NSAPI_IPv4_BYTES) == 0;
hudakz 14:7648334eb41b 306 }
hudakz 14:7648334eb41b 307 else
hudakz 14:7648334eb41b 308 if (a._addr.version == NSAPI_IPv6) {
hudakz 14:7648334eb41b 309 return memcmp(a._addr.bytes, b._addr.bytes, NSAPI_IPv6_BYTES) == 0;
hudakz 14:7648334eb41b 310 }
hudakz 14:7648334eb41b 311
hudakz 14:7648334eb41b 312 MBED_UNREACHABLE;
hudakz 14:7648334eb41b 313 }
hudakz 14:7648334eb41b 314
hudakz 14:7648334eb41b 315 /**
hudakz 14:7648334eb41b 316 * @brief
hudakz 14:7648334eb41b 317 * @note
hudakz 14:7648334eb41b 318 * @param
hudakz 14:7648334eb41b 319 * @retval
hudakz 14:7648334eb41b 320 */
hudakz 14:7648334eb41b 321 bool operator!=(const SocketAddress& a, const SocketAddress& b)
hudakz 14:7648334eb41b 322 {
hudakz 14:7648334eb41b 323 return !(a == b);
hudakz 14:7648334eb41b 324 }
hudakz 14:7648334eb41b 325
hudakz 14:7648334eb41b 326 //void SocketAddress::_SocketAddress(NetworkStack *iface, const char *host, uint16_t port)
hudakz 14:7648334eb41b 327 //{
hudakz 14:7648334eb41b 328 // _ip_address = NULL;
hudakz 14:7648334eb41b 329 // // gethostbyname must check for literals, so can call it directly
hudakz 14:7648334eb41b 330 // int err = iface->gethostbyname(host, this);
hudakz 14:7648334eb41b 331 // _port = port;
hudakz 14:7648334eb41b 332 // if (err) {
hudakz 14:7648334eb41b 333 // _addr = nsapi_addr_t();
hudakz 14:7648334eb41b 334 // _port = 0;
hudakz 14:7648334eb41b 335 // }
hudakz 14:7648334eb41b 336 //}
hudakz 14:7648334eb41b 337
hudakz 14:7648334eb41b 338 /**
hudakz 14:7648334eb41b 339 * @brief
hudakz 14:7648334eb41b 340 * @note
hudakz 14:7648334eb41b 341 * @param
hudakz 14:7648334eb41b 342 * @retval
hudakz 14:7648334eb41b 343 */
hudakz 14:7648334eb41b 344 SocketAddress::~SocketAddress()
hudakz 14:7648334eb41b 345 {
hudakz 14:7648334eb41b 346 delete[] _ip_address;
hudakz 14:7648334eb41b 347 }
hudakz 14:7648334eb41b 348
hudakz 14:7648334eb41b 349 #endif