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.

SocketAddress.cpp

Committer:
hudakz
Date:
2020-06-05
Revision:
17:1123c3fe86ca
Parent:
14:7648334eb41b

File content as of revision 17:1123c3fe86ca:

/* Socket
 * Copyright (c) 2015 ARM Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include "mbed_version.h"

#if MBED_MAJOR_VERSION == 2

#include "SocketAddress.h"
//#include "NetworkInterface.h"
//#include "NetworkStack.h"
#include <string.h>
#include <stdio.h>
#include "ip4string.h"
#include "ip6string.h"

/**
 * @brief
 * @note
 * @param
 * @retval
 */
SocketAddress::SocketAddress(nsapi_addr_t addr, uint16_t port)
{
    mem_init();
    _ip_address = NULL;
    set_addr(addr);
    set_port(port);
}

/**
 * @brief
 * @note
 * @param
 * @retval
 */
SocketAddress::SocketAddress(const char* addr, uint16_t port)
{
    mem_init();
    _ip_address = NULL;
    set_ip_address(addr);
    set_port(port);
}

/**
 * @brief
 * @note
 * @param
 * @retval
 */
SocketAddress::SocketAddress(const void* bytes, nsapi_version_t version, uint16_t port)
{
    mem_init();
    _ip_address = NULL;
    set_ip_bytes(bytes, version);
    set_port(port);
}

/**
 * @brief
 * @note
 * @param
 * @retval
 */
SocketAddress::SocketAddress(const SocketAddress& addr)
{
    mem_init();
    _ip_address = NULL;
    set_addr(addr.get_addr());
    set_port(addr.get_port());
}

/**
 * @brief
 * @note
 * @param
 * @retval
 */
void SocketAddress::mem_init(void)
{
    _addr.version = NSAPI_UNSPEC;
    memset(_addr.bytes, 0, NSAPI_IP_BYTES);
    _port = 0;
}

/**
 * @brief
 * @note
 * @param
 * @retval
 */
bool SocketAddress::set_ip_address(const char* addr)
{
    delete[] _ip_address;
    _ip_address = NULL;

    if (addr && stoip4(addr, strlen(addr), _addr.bytes)) {
        _addr.version = NSAPI_IPv4;
        return true;
    }
    else
    if (addr && stoip6(addr, strlen(addr), _addr.bytes)) {
        _addr.version = NSAPI_IPv6;
        return true;
    }
    else {
        _addr = nsapi_addr_t();
        return false;
    }
}

/**
 * @brief
 * @note
 * @param
 * @retval
 */
void SocketAddress::set_ip_bytes(const void* bytes, nsapi_version_t version)
{
    nsapi_addr_t    addr;

    addr = nsapi_addr_t();
    addr.version = version;
    if (version == NSAPI_IPv6) {
        memcpy(addr.bytes, bytes, NSAPI_IPv6_BYTES);
    }
    else
    if (version == NSAPI_IPv4) {
        memcpy(addr.bytes, bytes, NSAPI_IPv4_BYTES);
    }

    set_addr(addr);
}

/**
 * @brief
 * @note
 * @param
 * @retval
 */
void SocketAddress::set_addr(nsapi_addr_t addr)
{
    delete[] _ip_address;
    _ip_address = NULL;
    _addr = addr;
}

/**
 * @brief
 * @note
 * @param
 * @retval
 */
void SocketAddress::set_port(uint16_t port)
{
    _port = port;
}

/**
 * @brief
 * @note
 * @param
 * @retval
 */
const char* SocketAddress::get_ip_address() const
{
    if (_addr.version == NSAPI_UNSPEC) {
        return NULL;
    }

    if (!_ip_address) {
        _ip_address = new char[NSAPI_IP_SIZE];
        if (_addr.version == NSAPI_IPv4) {
            ip4tos(_addr.bytes, _ip_address);
        }
        else
        if (_addr.version == NSAPI_IPv6) {
            ip6tos(_addr.bytes, _ip_address);
        }
    }

    return _ip_address;
}

/**
 * @brief
 * @note
 * @param
 * @retval
 */
const void* SocketAddress::get_ip_bytes() const
{
    return _addr.bytes;
}

/**
 * @brief
 * @note
 * @param
 * @retval
 */
nsapi_version_t SocketAddress::get_ip_version() const
{
    return _addr.version;
}

/**
 * @brief
 * @note
 * @param
 * @retval
 */
nsapi_addr_t SocketAddress::get_addr() const
{
    return _addr;
}

/**
 * @brief
 * @note
 * @param
 * @retval
 */
uint16_t SocketAddress::get_port() const
{
    return _port;
}

/**
 * @brief
 * @note
 * @param
 * @retval
 */
SocketAddress::operator bool() const
{
    if (_addr.version == NSAPI_IPv4) {
        for (int i = 0; i < NSAPI_IPv4_BYTES; i++) {
            if (_addr.bytes[i]) {
                return true;
            }
        }

        return false;
    }
    else
    if (_addr.version == NSAPI_IPv6) {
        for (int i = 0; i < NSAPI_IPv6_BYTES; i++) {
            if (_addr.bytes[i]) {
                return true;
            }
        }

        return false;
    }
    else {
        return false;
    }
}

/**
 * @brief
 * @note
 * @param
 * @retval
 */
SocketAddress &SocketAddress::operator=(const SocketAddress& addr)
{
    delete[] _ip_address;
    _ip_address = NULL;
    set_addr(addr.get_addr());
    set_port(addr.get_port());
    return *this;
}

/**
 * @brief
 * @note
 * @param
 * @retval
 */
bool operator==(const SocketAddress& a, const SocketAddress& b)
{
    if (!a && !b) {
        return true;
    }
    else
    if (a._addr.version != b._addr.version) {
        return false;
    }
    else
    if (a._addr.version == NSAPI_IPv4) {
        return memcmp(a._addr.bytes, b._addr.bytes, NSAPI_IPv4_BYTES) == 0;
    }
    else
    if (a._addr.version == NSAPI_IPv6) {
        return memcmp(a._addr.bytes, b._addr.bytes, NSAPI_IPv6_BYTES) == 0;
    }

    MBED_UNREACHABLE;
}

/**
 * @brief
 * @note
 * @param
 * @retval
 */
bool operator!=(const SocketAddress& a, const SocketAddress& b)
{
    return !(a == b);
}

//void SocketAddress::_SocketAddress(NetworkStack *iface, const char *host, uint16_t port)
//{
//    _ip_address = NULL;
//    // gethostbyname must check for literals, so can call it directly
//    int err = iface->gethostbyname(host, this);
//    _port = port;
//    if (err) {
//        _addr = nsapi_addr_t();
//        _port = 0;
//    }
//}

/**
 * @brief
 * @note
 * @param
 * @retval
 */
SocketAddress::~SocketAddress()
{
    delete[] _ip_address;
}

#endif