Toyomasa Watarai / ESP8266Interface

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   IFTTT_BME280_demo

Fork of ESP8266Interface by ESP8266

ESP8266Interface.h@16:3f0efaa57a12, 2014-12-01 (annotated)

Committer:
michaeljkoster
Date:
Mon Dec 01 06:22:00 2014 +0000
Revision:
16:3f0efaa57a12
Parent:
14:4d1128f72e00
Child:
28:91e65e22e63a
sync

Who changed what in which revision?

UserRevisionLine numberNew contents of line
michaeljkoster 13:41098c907200 1 /* ESP8266Interface.h */
mbed_official 0:302ec35139ec 2 /* Copyright (C) 2012 mbed.org, MIT License
mbed_official 0:302ec35139ec 3 *
mbed_official 0:302ec35139ec 4 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
mbed_official 0:302ec35139ec 5 * and associated documentation files (the "Software"), to deal in the Software without restriction,
mbed_official 0:302ec35139ec 6 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
mbed_official 0:302ec35139ec 7 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
mbed_official 0:302ec35139ec 8 * furnished to do so, subject to the following conditions:
mbed_official 0:302ec35139ec 9 *
mbed_official 0:302ec35139ec 10 * The above copyright notice and this permission notice shall be included in all copies or
mbed_official 0:302ec35139ec 11 * substantial portions of the Software.
mbed_official 0:302ec35139ec 12 *
mbed_official 0:302ec35139ec 13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
mbed_official 0:302ec35139ec 14 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
mbed_official 0:302ec35139ec 15 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
mbed_official 0:302ec35139ec 16 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
mbed_official 0:302ec35139ec 17 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
mbed_official 0:302ec35139ec 18 */
mbed_official 0:302ec35139ec 19
michaeljkoster 13:41098c907200 20 #ifndef ESP8266INTERFACE_H_
michaeljkoster 13:41098c907200 21 #define ESP8266INTERFACE_H_
mbed_official 0:302ec35139ec 22
michaeljkoster 13:41098c907200 23 #include "ESP8266.h"
michaeljkoster 16:3f0efaa57a12 24 #include "Endpoint.h"
samux 1:fb4494783863 25
screamer 6:5176e0864078 26 /**
michaeljkoster 13:41098c907200 27 * Interface using ESP8266 to connect to an IP-based network
samux 1:fb4494783863 28 */
michaeljkoster 13:41098c907200 29 class ESP8266Interface: public ESP8266 {
samux 1:fb4494783863 30 public:
samux 1:fb4494783863 31
samux 1:fb4494783863 32 /**
samux 1:fb4494783863 33 * Constructor
samux 1:fb4494783863 34 *
samux 1:fb4494783863 35 * \param tx mbed pin to use for tx line of Serial interface
samux 1:fb4494783863 36 * \param rx mbed pin to use for rx line of Serial interface
samux 1:fb4494783863 37 * \param reset reset pin of the wifi module ()
samux 1:fb4494783863 38 * \param ssid ssid of the network
samux 1:fb4494783863 39 * \param phrase WEP or WPA key
samux 1:fb4494783863 40 */
michaeljkoster 13:41098c907200 41 ESP8266Interface(PinName tx, PinName rx, PinName reset, const char * ssid, const char * phrase );
samux 1:fb4494783863 42
samux 1:fb4494783863 43 /** Initialize the interface with DHCP.
samux 1:fb4494783863 44 * Initialize the interface and configure it to use DHCP (no connection at this point).
samux 1:fb4494783863 45 * \return 0 on success, a negative number on failure
samux 1:fb4494783863 46 */
samux 1:fb4494783863 47 int init(); //With DHCP
samux 1:fb4494783863 48
samux 1:fb4494783863 49 /** Connect
samux 1:fb4494783863 50 * Bring the interface up, start DHCP if needed.
samux 1:fb4494783863 51 * \return 0 on success, a negative number on failure
samux 1:fb4494783863 52 */
michaeljkoster 16:3f0efaa57a12 53 bool connect();
samux 1:fb4494783863 54
samux 1:fb4494783863 55 /** Disconnect
samux 1:fb4494783863 56 * Bring the interface down
samux 1:fb4494783863 57 * \return 0 on success, a negative number on failure
samux 1:fb4494783863 58 */
samux 1:fb4494783863 59 int disconnect();
samux 1:fb4494783863 60
samux 1:fb4494783863 61 /** Get IP address
samux 1:fb4494783863 62 *
screamer 6:5176e0864078 63 * \return ip address
samux 1:fb4494783863 64 */
samux 1:fb4494783863 65 char* getIPAddress();
samux 1:fb4494783863 66
samux 1:fb4494783863 67 private:
samux 1:fb4494783863 68 };
samux 1:fb4494783863 69
samux 1:fb4494783863 70 #include "UDPSocket.h"
samux 1:fb4494783863 71
michaeljkoster 13:41098c907200 72 #endif /* ESP8266INTERFACE_H_ */