Socket interface for ESP8266. Implements the NetworkSocketAPI. Requires device to use the Espressif Firmware.

Dependencies:   ESP8266

Dependents:   ESP8266InterfaceTests HelloESP8266Interface

Fork of ESP8266Interface by NetworkSocketAPI

Note

This library assumes your ESP8266 is running the Espressif Firmware. For instructions on how to update your ESP8266 to use the correct firmware see the Firmware Update Wiki Page.

Currently the ESP8266Interface LIbrary has the following Abilities:

Working

  • TCP Client
  • UDP Client
  • Transparent mode (single connection of 1 type at a time)
  • Station Mode (connects to AP)

To be implimented

  • TCP Server
  • UDP Server
  • Multi Connection Mode (able to have up to 5 sockets at a time)
  • AP Mode (Make ESP Chip act like access point)
  • DNS Support (currently websites must be looked up by IP)
  • Error Recovery

Nice but not necessary

  • colorized text for ESP AT Commands in Command line (easier to differentiate from other text)

ESP8266Interface.cpp

Committer:
Christopher Haster
Date:
2016-02-25
Branch:
api-changes
Revision:
47:60a4b49e8b83
Parent:
46:6b1bd1268074
Child:
49:750ed1b67483

File content as of revision 47:60a4b49e8b83:

/* ESP8266Interface Example
 * 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 "ESP8266Interface.h"

// Various timeouts for different ESP8266 operations
#define ESP8266_CONNECT_TIMEOUT 15000
#define ESP8266_SEND_TIMEOUT    500
#define ESP8266_RECV_TIMEOUT    0
#define ESP8266_MISC_TIMEOUT    500


/** ESP8266Socket class
 *  Implementation of the SocketInterface for the ESP8266
 */
class ESP8266Socket : public SocketInterface
{
public:
    // ESP8266 specific methods
    ESP8266Socket(
        ESP8266 *esp,
        socket_protocol_t proto,
        int id);

    virtual ~ESP8266Socket();

    int getID() const;

    // Implementation of SocketInterface
    virtual int32_t open(const char *ip, uint16_t port);
    virtual int32_t close();

    virtual int32_t send(const void *data, uint32_t size);
    virtual int32_t recv(void *data, uint32_t size);

private:
    ESP8266 *_esp;
    socket_protocol_t _proto;
    int _id;
};


// ESP8266Interface implementation
ESP8266Interface::ESP8266Interface(PinName tx, PinName rx, bool debug)
    : _esp(tx, rx, debug)
{
    memset(_ids, 0, sizeof(_ids));
}

ESP8266Interface::~ESP8266Interface()
{
}

int32_t ESP8266Interface::connect(
    const char *ap, 
    const char *pass_phrase, 
    wifi_security_t)
{
    _esp.setTimeout(ESP8266_CONNECT_TIMEOUT);

    if (!_esp.startup(3)) {
        return NS_ERROR_DEVICE_ERROR;
    }

    if (!_esp.dhcp(true, 1)) {
        return NS_ERROR_DHCP_FAILURE;
    }

    if (!_esp.connect(ap, pass_phrase)) {
        return NS_ERROR_NO_CONNECTION;
    }

    if (!_esp.getIPAddress()) {
        return NS_ERROR_DHCP_FAILURE;
    }

    return 0;
}

int32_t ESP8266Interface::disconnect()
{
    _esp.setTimeout(ESP8266_MISC_TIMEOUT);

    if (!_esp.disconnect()) {
        return NS_ERROR_DEVICE_ERROR;
    }

    return 0;
}

const char *ESP8266Interface::getIPAddress()
{
    return _esp.getIPAddress();
}

const char *ESP8266Interface::getMACAddress()
{
    return _esp.getMACAddress();
}

SocketInterface *ESP8266Interface::createSocket(socket_protocol_t proto)
{
    // Look for an unused socket
    int id = -1;

    for (int i = 0; i < ESP8266_SOCKET_COUNT; i++) {
        if (!_ids[i]) {
            id = i;
            _ids[i] = true;
            break;
        }
    }

    if (id == -1) {
        return 0;
    }

    return new ESP8266Socket(&_esp, proto, id);
}

void ESP8266Interface::destroySocket(SocketInterface *iface)
{
    ESP8266Socket *socket = (ESP8266Socket *)iface;
    _ids[socket->getID()] = false;
    delete socket;
}


// ESP8266Socket implementation
ESP8266Socket::ESP8266Socket(
        ESP8266 *esp,
        socket_protocol_t proto,
        int id)
    : _esp(esp)
    , _proto(proto)
    , _id(id)
{
}

ESP8266Socket::~ESP8266Socket()
{
}

int32_t ESP8266Socket::open(const char *ip, uint16_t port)
{
    _esp->setTimeout(ESP8266_MISC_TIMEOUT);

    const char *proto = (_proto == SOCK_UDP) ? "UDP" : "TCP";

    if (!_esp->open(proto, _id, ip, port)) {
        return NS_ERROR_TIMEOUT;
    }

    return 0;
}

int32_t ESP8266Socket::close()
{
    _esp->setTimeout(ESP8266_MISC_TIMEOUT);

    if (!_esp->close(_id)) {
        return NS_ERROR_TIMEOUT;
    }

    return 0;
}

int32_t ESP8266Socket::send(const void *data, uint32_t size)
{
    _esp->setTimeout(ESP8266_SEND_TIMEOUT);

    if (!_esp->send(_id, data, size)) {
        return NS_ERROR_TIMEOUT;
    }

    return 0;
}

int32_t ESP8266Socket::recv(void *data, uint32_t size)
{
    _esp->setTimeout(ESP8266_RECV_TIMEOUT);

    int32_t recv = _esp->recv(_id, data, size);

    if (recv < 0) {
        return 0;
    }

    return recv;
}

int ESP8266Socket::getID() const {
    return _id;
}