Junichi Katsu / SimpleIoTBoardLib

Simple IoT Board用のライブラリです。 ESP8266ライブラリの軽量化 送信のみのソフトシリアルライブラリを含んでいます。

Dependents:   SITB_HttpGetSample SITB_IFTTTSample SITB_INA226PRC AmbientExampleSITB ... more

ESP8266InterfaceTiny/ESP8266Interface.h@0:890c12951e96, 2015-11-15 (annotated)

Committer:
jksoft
Date:
Sun Nov 15 13:36:44 2015 +0000
Revision:
0:890c12951e96
??

Who changed what in which revision?

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