1
ESP8266.h
- Committer:
- nikitoslav
- Date:
- 2018-06-27
- Revision:
- 2:3518f7c570de
- Parent:
- 1:af8bf1171171
- Child:
- 4:d53cfe3998bc
File content as of revision 2:3518f7c570de:
/* 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. */ #ifndef ESP8266_H #define ESP8266_H #include "ATParser.h" /** ESP8266Interface class. This is an interface to a ESP8266 radio. */ class ESP8266 { public: ESP8266(PinName tx, PinName rx, int locOutPort, int locInPort, bool debug=false); /** * Startup the ESP8266 * * @param mode mode of WIFI 1-client, 2-host, 3-both * @return true only if ESP8266 was setup correctly */ bool startup(int mode); /** * Reset ESP8266 * * @return true only if ESP8266 resets successfully */ bool reset(void); /** * Connect ESP8266 to AP * * @param ap the name of the AP * @param passPhrase the password of AP * @return true only if ESP8266 is connected successfully */ bool connect(const char *ap, const char *passPhrase); /** * Disconnect ESP8266 from AP * * @return true only if ESP8266 is disconnected successfully */ bool disconnect(void); /** * Get the IP address of ESP8266 * * @return null-teriminated IP address or null if no IP address is assigned */ char *getIPAddress(void); /** * Get the MAC address of ESP8266 * * @return null-terminated MAC address or null if no MAC address is assigned */ const char *getMACAddress(void); /** * Check if ESP8266 is conenected * * @return true only if the chip has an IP address */ bool isConnected(void); /** * Open a socketed connection * * @param type the type of socket to open "UDP" or "TCP" * @param id id to give the new socket, valid 0-4 * @param port port to open connection with * @param addr the IP address of the destination * @return true only if socket opened successfully */ bool open(int linkId, int localPort); /** * Sends data to an open socket * * @param id id of socket to send to * @param data data to be sent * @param amount amount of data to be sent - max 1024 * @return true only if data sent successfully */ bool send(const void *data, uint32_t amount, const char* addr, int port); /** * Receives data from an open socket * * @param id id to receive from * @param data placeholder for returned information * @param amount number of bytes to be received * @return the number of bytes received */ int32_t recv(void *data, uint32_t amount, char* IP, int* port); /** * Closes a socket * * @param id id of socket to close, valid only 0-4 * @return true only if socket is closed successfully */ bool close(int id); /** * Allows timeout to be changed between commands * * @param timeout_ms timeout of the connection */ void setTimeout(uint32_t timeout_ms); /** * Checks if data is available */ bool readable(); /** * Checks if data can be written */ bool writeable(); private: BufferedSerial _serial; ATParser _parser; char _ip_buffer[16]; char _mac_buffer[18]; int localOutPort; int localInPort; }; #endif