ESP8266 Socket Library. AT Thinker firmware.
Dependents: ESP8266_MQTT_HelloWorld ESP8266_IFTTT_Test ECE_4180_Lab_4 websocketmbed ... more
Fork of ESP8266Interface by
This repository has been superceded
This project has moved to https://developer.mbed.org/teams/ESP8266/code/esp8266-driver/
This library works with the AT Thinker firmware.
Note
This library is currently in Beta. It is not feature complete and has some bugs, proceed with caution! Fixes and patches are welcome and appreciated!
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 implemented
- 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)
Socket/Endpoint.h@31:fd0eaf273b11, 2015-04-30 (annotated)
- Committer:
- mbedAustin
- Date:
- Thu Apr 30 04:53:21 2015 +0000
- Revision:
- 31:fd0eaf273b11
- Parent:
- 30:c035696b9397
safety commit
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
samux | 1:fb4494783863 | 1 | /* Copyright (C) 2012 mbed.org, MIT License |
samux | 1:fb4494783863 | 2 | * |
samux | 1:fb4494783863 | 3 | * Permission is hereby granted, free of charge, to any person obtaining a copy of this software |
samux | 1:fb4494783863 | 4 | * and associated documentation files (the "Software"), to deal in the Software without restriction, |
samux | 1:fb4494783863 | 5 | * including without limitation the rights to use, copy, modify, merge, publish, distribute, |
samux | 1:fb4494783863 | 6 | * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is |
samux | 1:fb4494783863 | 7 | * furnished to do so, subject to the following conditions: |
samux | 1:fb4494783863 | 8 | * |
samux | 1:fb4494783863 | 9 | * The above copyright notice and this permission notice shall be included in all copies or |
samux | 1:fb4494783863 | 10 | * substantial portions of the Software. |
samux | 1:fb4494783863 | 11 | * |
samux | 1:fb4494783863 | 12 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING |
samux | 1:fb4494783863 | 13 | * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
samux | 1:fb4494783863 | 14 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, |
samux | 1:fb4494783863 | 15 | * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
samux | 1:fb4494783863 | 16 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
samux | 1:fb4494783863 | 17 | */ |
samux | 1:fb4494783863 | 18 | #ifndef ENDPOINT_H |
samux | 1:fb4494783863 | 19 | #define ENDPOINT_H |
samux | 1:fb4494783863 | 20 | |
michaeljkoster | 13:41098c907200 | 21 | #include "ESP8266.h" |
samux | 1:fb4494783863 | 22 | |
samux | 1:fb4494783863 | 23 | class UDPSocket; |
samux | 1:fb4494783863 | 24 | |
samux | 1:fb4494783863 | 25 | /** |
samux | 1:fb4494783863 | 26 | IP Endpoint (address, port) |
samux | 1:fb4494783863 | 27 | */ |
samux | 1:fb4494783863 | 28 | class Endpoint { |
samux | 1:fb4494783863 | 29 | friend class UDPSocket; |
samux | 1:fb4494783863 | 30 | |
samux | 1:fb4494783863 | 31 | public: |
samux | 1:fb4494783863 | 32 | /** IP Endpoint (address, port) |
samux | 1:fb4494783863 | 33 | */ |
samux | 1:fb4494783863 | 34 | Endpoint(void); |
samux | 1:fb4494783863 | 35 | |
samux | 1:fb4494783863 | 36 | ~Endpoint(void); |
samux | 1:fb4494783863 | 37 | |
samux | 1:fb4494783863 | 38 | /** Reset the address of this endpoint |
samux | 1:fb4494783863 | 39 | */ |
samux | 1:fb4494783863 | 40 | void reset_address(void); |
samux | 1:fb4494783863 | 41 | |
samux | 1:fb4494783863 | 42 | /** Set the address of this endpoint |
samux | 1:fb4494783863 | 43 | \param host The endpoint address (it can either be an IP Address or a hostname that will be resolved with DNS). |
samux | 1:fb4494783863 | 44 | \param port The endpoint port |
samux | 1:fb4494783863 | 45 | \return 0 on success, -1 on failure (when an hostname cannot be resolved by DNS). |
samux | 1:fb4494783863 | 46 | */ |
samux | 1:fb4494783863 | 47 | int set_address(const char* host, const int port); |
samux | 1:fb4494783863 | 48 | |
samux | 1:fb4494783863 | 49 | /** Get the IP address of this endpoint |
samux | 1:fb4494783863 | 50 | \return The IP address of this endpoint. |
samux | 1:fb4494783863 | 51 | */ |
samux | 1:fb4494783863 | 52 | char* get_address(void); |
samux | 1:fb4494783863 | 53 | |
samux | 1:fb4494783863 | 54 | /** Get the port of this endpoint |
samux | 1:fb4494783863 | 55 | \return The port of this endpoint |
samux | 1:fb4494783863 | 56 | */ |
samux | 1:fb4494783863 | 57 | int get_port(void); |
mbedAustin | 30:c035696b9397 | 58 | |
mbedAustin | 30:c035696b9397 | 59 | /** Get the id of this endpoint |
mbedAustin | 30:c035696b9397 | 60 | \return The id of this endpoint |
mbedAustin | 30:c035696b9397 | 61 | */ |
mbedAustin | 30:c035696b9397 | 62 | int get_id(void); |
samux | 1:fb4494783863 | 63 | |
samux | 1:fb4494783863 | 64 | protected: |
samux | 1:fb4494783863 | 65 | char _ipAddress[16]; |
samux | 1:fb4494783863 | 66 | int _port; |
mbedAustin | 31:fd0eaf273b11 | 67 | int _id; |
michaeljkoster | 16:3f0efaa57a12 | 68 | |
michaeljkoster | 13:41098c907200 | 69 | ESP8266 * ESP8266; |
samux | 1:fb4494783863 | 70 | }; |
samux | 1:fb4494783863 | 71 | |
samux | 1:fb4494783863 | 72 | #endif |