Components / ESP8266Interface

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

Committer:
sam_grove
Date:
2015-06-17
Revision:
10:80ece8d5aa2d

File content as of revision 10:80ece8d5aa2d:

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

#ifndef ESP8266INTERFACE_H
#define ESP8266INTERFACE_H

#include "WiFiInterface.h"

/** ESP8266Interface class.
    This is a interface to the ESP8266 WiFi radio
 */
class ESP8266Interface : public WiFiInterface
{
public:

    ESP8266Interface();
    ESP8266Interface(const char *ap, const char *pass_phrase = 0, wifi_security_t security = WI_NONE, uint32_t timeout_ms = 15000);
    virtual int32_t init(void) const;
    virtual int32_t init(const char *ip, const char *mask, const char *gateway) const;
    virtual int32_t connect(uint32_t timeout_ms) const;
    virtual int32_t connect(const char *ap, const char *pass_phrase = 0, wifi_security_t security = WI_NONE, uint32_t timeout_ms = 15000) const;
    virtual int32_t disconnect(void) const;
    virtual char *getIPAddress(void) const;
    virtual char *getGateway(void) const;
    virtual char *getNetworkMask(void) const;
    virtual char *getMACAddress(void) const;
    virtual int32_t isConnected(void) const;
};

#endif