Junichi Katsu / MultiIoTBoardLib

MultiIoTBoard library

Dependencies:   BME280 SB1602E

Dependents:   MITB_Sample

ESP8266InterfaceTiny/ESP8266Interface.h@0:bad9495b4215, 2017-07-28 (annotated)

Committer:
jksoft
Date:
Fri Jul 28 02:23:25 2017 +0000
Revision:
0:bad9495b4215
First edition

Who changed what in which revision?

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