Duy tran / easy-connect

CUSTOMIZED FOR WATER MONITOR

ESP8266Interface.h@0:c9094fbda0bd, 2017-12-07 (annotated)

Committer:
DuyLionTran
Date:
Thu Dec 07 17:07:08 2017 +0000
Revision:
0:c9094fbda0bd
CUSTOMIZED FOR WATER MONITOR

Who changed what in which revision?

UserRevisionLine numberNew contents of line
DuyLionTran 0:c9094fbda0bd 1 /* ESP8266 implementation of NetworkInterfaceAPI
DuyLionTran 0:c9094fbda0bd 2 * Copyright (c) 2015 ARM Limited
DuyLionTran 0:c9094fbda0bd 3 *
DuyLionTran 0:c9094fbda0bd 4 * Licensed under the Apache License, Version 2.0 (the "License");
DuyLionTran 0:c9094fbda0bd 5 * you may not use this file except in compliance with the License.
DuyLionTran 0:c9094fbda0bd 6 * You may obtain a copy of the License at
DuyLionTran 0:c9094fbda0bd 7 *
DuyLionTran 0:c9094fbda0bd 8 * http://www.apache.org/licenses/LICENSE-2.0
DuyLionTran 0:c9094fbda0bd 9 *
DuyLionTran 0:c9094fbda0bd 10 * Unless required by applicable law or agreed to in writing, software
DuyLionTran 0:c9094fbda0bd 11 * distributed under the License is distributed on an "AS IS" BASIS,
DuyLionTran 0:c9094fbda0bd 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
DuyLionTran 0:c9094fbda0bd 13 * See the License for the specific language governing permissions and
DuyLionTran 0:c9094fbda0bd 14 * limitations under the License.
DuyLionTran 0:c9094fbda0bd 15 */
DuyLionTran 0:c9094fbda0bd 16
DuyLionTran 0:c9094fbda0bd 17 #ifndef ESP8266_INTERFACE_H
DuyLionTran 0:c9094fbda0bd 18 #define ESP8266_INTERFACE_H
DuyLionTran 0:c9094fbda0bd 19
DuyLionTran 0:c9094fbda0bd 20 #include "mbed.h"
DuyLionTran 0:c9094fbda0bd 21 #include "ESP8266.h"
DuyLionTran 0:c9094fbda0bd 22
DuyLionTran 0:c9094fbda0bd 23
DuyLionTran 0:c9094fbda0bd 24 #define ESP8266_SOCKET_COUNT 5
DuyLionTran 0:c9094fbda0bd 25
DuyLionTran 0:c9094fbda0bd 26 /** ESP8266Interface class
DuyLionTran 0:c9094fbda0bd 27 * Implementation of the NetworkStack for the ESP8266
DuyLionTran 0:c9094fbda0bd 28 */
DuyLionTran 0:c9094fbda0bd 29 class ESP8266Interface : public NetworkStack, public WiFiInterface
DuyLionTran 0:c9094fbda0bd 30 {
DuyLionTran 0:c9094fbda0bd 31 public:
DuyLionTran 0:c9094fbda0bd 32 /** ESP8266Interface lifetime
DuyLionTran 0:c9094fbda0bd 33 * @param tx TX pin
DuyLionTran 0:c9094fbda0bd 34 * @param rx RX pin
DuyLionTran 0:c9094fbda0bd 35 * @param debug Enable debugging
DuyLionTran 0:c9094fbda0bd 36 */
DuyLionTran 0:c9094fbda0bd 37 ESP8266Interface(PinName tx, PinName rx, bool debug = false);
DuyLionTran 0:c9094fbda0bd 38
DuyLionTran 0:c9094fbda0bd 39 /** Start the interface
DuyLionTran 0:c9094fbda0bd 40 *
DuyLionTran 0:c9094fbda0bd 41 * Attempts to connect to a WiFi network. Requires ssid and passphrase to be set.
DuyLionTran 0:c9094fbda0bd 42 * If passphrase is invalid, NSAPI_ERROR_AUTH_ERROR is returned.
DuyLionTran 0:c9094fbda0bd 43 *
DuyLionTran 0:c9094fbda0bd 44 * @return 0 on success, negative error code on failure
DuyLionTran 0:c9094fbda0bd 45 */
DuyLionTran 0:c9094fbda0bd 46 virtual int connect();
DuyLionTran 0:c9094fbda0bd 47
DuyLionTran 0:c9094fbda0bd 48 /** Start the interface
DuyLionTran 0:c9094fbda0bd 49 *
DuyLionTran 0:c9094fbda0bd 50 * Attempts to connect to a WiFi network.
DuyLionTran 0:c9094fbda0bd 51 *
DuyLionTran 0:c9094fbda0bd 52 * @param ssid Name of the network to connect to
DuyLionTran 0:c9094fbda0bd 53 * @param pass Security passphrase to connect to the network
DuyLionTran 0:c9094fbda0bd 54 * @param security Type of encryption for connection (Default: NSAPI_SECURITY_NONE)
DuyLionTran 0:c9094fbda0bd 55 * @param channel This parameter is not supported, setting it to anything else than 0 will result in NSAPI_ERROR_UNSUPPORTED
DuyLionTran 0:c9094fbda0bd 56 * @return 0 on success, or error code on failure
DuyLionTran 0:c9094fbda0bd 57 */
DuyLionTran 0:c9094fbda0bd 58 virtual int connect(const char *ssid, const char *pass, nsapi_security_t security = NSAPI_SECURITY_NONE,
DuyLionTran 0:c9094fbda0bd 59 uint8_t channel = 0);
DuyLionTran 0:c9094fbda0bd 60
DuyLionTran 0:c9094fbda0bd 61 /** Set the WiFi network credentials
DuyLionTran 0:c9094fbda0bd 62 *
DuyLionTran 0:c9094fbda0bd 63 * @param ssid Name of the network to connect to
DuyLionTran 0:c9094fbda0bd 64 * @param pass Security passphrase to connect to the network
DuyLionTran 0:c9094fbda0bd 65 * @param security Type of encryption for connection
DuyLionTran 0:c9094fbda0bd 66 * (defaults to NSAPI_SECURITY_NONE)
DuyLionTran 0:c9094fbda0bd 67 * @return 0 on success, or error code on failure
DuyLionTran 0:c9094fbda0bd 68 */
DuyLionTran 0:c9094fbda0bd 69 virtual int set_credentials(const char *ssid, const char *pass, nsapi_security_t security = NSAPI_SECURITY_NONE);
DuyLionTran 0:c9094fbda0bd 70
DuyLionTran 0:c9094fbda0bd 71 /** Set the WiFi network channel - NOT SUPPORTED
DuyLionTran 0:c9094fbda0bd 72 *
DuyLionTran 0:c9094fbda0bd 73 * This function is not supported and will return NSAPI_ERROR_UNSUPPORTED
DuyLionTran 0:c9094fbda0bd 74 *
DuyLionTran 0:c9094fbda0bd 75 * @param channel Channel on which the connection is to be made, or 0 for any (Default: 0)
DuyLionTran 0:c9094fbda0bd 76 * @return Not supported, returns NSAPI_ERROR_UNSUPPORTED
DuyLionTran 0:c9094fbda0bd 77 */
DuyLionTran 0:c9094fbda0bd 78 virtual int set_channel(uint8_t channel);
DuyLionTran 0:c9094fbda0bd 79
DuyLionTran 0:c9094fbda0bd 80 /** Stop the interface
DuyLionTran 0:c9094fbda0bd 81 * @return 0 on success, negative on failure
DuyLionTran 0:c9094fbda0bd 82 */
DuyLionTran 0:c9094fbda0bd 83 virtual int disconnect();
DuyLionTran 0:c9094fbda0bd 84
DuyLionTran 0:c9094fbda0bd 85 /** Get the internally stored IP address
DuyLionTran 0:c9094fbda0bd 86 * @return IP address of the interface or null if not yet connected
DuyLionTran 0:c9094fbda0bd 87 */
DuyLionTran 0:c9094fbda0bd 88 virtual const char *get_ip_address();
DuyLionTran 0:c9094fbda0bd 89
DuyLionTran 0:c9094fbda0bd 90 /** Get the internally stored MAC address
DuyLionTran 0:c9094fbda0bd 91 * @return MAC address of the interface
DuyLionTran 0:c9094fbda0bd 92 */
DuyLionTran 0:c9094fbda0bd 93 virtual const char *get_mac_address();
DuyLionTran 0:c9094fbda0bd 94
DuyLionTran 0:c9094fbda0bd 95 /** Get the local gateway
DuyLionTran 0:c9094fbda0bd 96 *
DuyLionTran 0:c9094fbda0bd 97 * @return Null-terminated representation of the local gateway
DuyLionTran 0:c9094fbda0bd 98 * or null if no network mask has been recieved
DuyLionTran 0:c9094fbda0bd 99 */
DuyLionTran 0:c9094fbda0bd 100 virtual const char *get_gateway();
DuyLionTran 0:c9094fbda0bd 101
DuyLionTran 0:c9094fbda0bd 102 /** Get the local network mask
DuyLionTran 0:c9094fbda0bd 103 *
DuyLionTran 0:c9094fbda0bd 104 * @return Null-terminated representation of the local network mask
DuyLionTran 0:c9094fbda0bd 105 * or null if no network mask has been recieved
DuyLionTran 0:c9094fbda0bd 106 */
DuyLionTran 0:c9094fbda0bd 107 virtual const char *get_netmask();
DuyLionTran 0:c9094fbda0bd 108
DuyLionTran 0:c9094fbda0bd 109 /** Gets the current radio signal strength for active connection
DuyLionTran 0:c9094fbda0bd 110 *
DuyLionTran 0:c9094fbda0bd 111 * @return Connection strength in dBm (negative value)
DuyLionTran 0:c9094fbda0bd 112 */
DuyLionTran 0:c9094fbda0bd 113 virtual int8_t get_rssi();
DuyLionTran 0:c9094fbda0bd 114
DuyLionTran 0:c9094fbda0bd 115 /** Scan for available networks
DuyLionTran 0:c9094fbda0bd 116 *
DuyLionTran 0:c9094fbda0bd 117 * This function will block.
DuyLionTran 0:c9094fbda0bd 118 *
DuyLionTran 0:c9094fbda0bd 119 * @param ap Pointer to allocated array to store discovered AP
DuyLionTran 0:c9094fbda0bd 120 * @param count Size of allocated @a res array, or 0 to only count available AP
DuyLionTran 0:c9094fbda0bd 121 * @param timeout Timeout in milliseconds; 0 for no timeout (Default: 0)
DuyLionTran 0:c9094fbda0bd 122 * @return Number of entries in @a, or if @a count was 0 number of available networks, negative on error
DuyLionTran 0:c9094fbda0bd 123 * see @a nsapi_error
DuyLionTran 0:c9094fbda0bd 124 */
DuyLionTran 0:c9094fbda0bd 125 virtual int scan(WiFiAccessPoint *res, unsigned count);
DuyLionTran 0:c9094fbda0bd 126
DuyLionTran 0:c9094fbda0bd 127 /** Translates a hostname to an IP address with specific version
DuyLionTran 0:c9094fbda0bd 128 *
DuyLionTran 0:c9094fbda0bd 129 * The hostname may be either a domain name or an IP address. If the
DuyLionTran 0:c9094fbda0bd 130 * hostname is an IP address, no network transactions will be performed.
DuyLionTran 0:c9094fbda0bd 131 *
DuyLionTran 0:c9094fbda0bd 132 * If no stack-specific DNS resolution is provided, the hostname
DuyLionTran 0:c9094fbda0bd 133 * will be resolve using a UDP socket on the stack.
DuyLionTran 0:c9094fbda0bd 134 *
DuyLionTran 0:c9094fbda0bd 135 * @param address Destination for the host SocketAddress
DuyLionTran 0:c9094fbda0bd 136 * @param host Hostname to resolve
DuyLionTran 0:c9094fbda0bd 137 * @param version IP version of address to resolve, NSAPI_UNSPEC indicates
DuyLionTran 0:c9094fbda0bd 138 * version is chosen by the stack (defaults to NSAPI_UNSPEC)
DuyLionTran 0:c9094fbda0bd 139 * @return 0 on success, negative error code on failure
DuyLionTran 0:c9094fbda0bd 140 */
DuyLionTran 0:c9094fbda0bd 141 using NetworkInterface::gethostbyname;
DuyLionTran 0:c9094fbda0bd 142
DuyLionTran 0:c9094fbda0bd 143 /** Add a domain name server to list of servers to query
DuyLionTran 0:c9094fbda0bd 144 *
DuyLionTran 0:c9094fbda0bd 145 * @param addr Destination for the host address
DuyLionTran 0:c9094fbda0bd 146 * @return 0 on success, negative error code on failure
DuyLionTran 0:c9094fbda0bd 147 */
DuyLionTran 0:c9094fbda0bd 148 using NetworkInterface::add_dns_server;
DuyLionTran 0:c9094fbda0bd 149
DuyLionTran 0:c9094fbda0bd 150 protected:
DuyLionTran 0:c9094fbda0bd 151 /** Open a socket
DuyLionTran 0:c9094fbda0bd 152 * @param handle Handle in which to store new socket
DuyLionTran 0:c9094fbda0bd 153 * @param proto Type of socket to open, NSAPI_TCP or NSAPI_UDP
DuyLionTran 0:c9094fbda0bd 154 * @return 0 on success, negative on failure
DuyLionTran 0:c9094fbda0bd 155 */
DuyLionTran 0:c9094fbda0bd 156 virtual int socket_open(void **handle, nsapi_protocol_t proto);
DuyLionTran 0:c9094fbda0bd 157
DuyLionTran 0:c9094fbda0bd 158 /** Close the socket
DuyLionTran 0:c9094fbda0bd 159 * @param handle Socket handle
DuyLionTran 0:c9094fbda0bd 160 * @return 0 on success, negative on failure
DuyLionTran 0:c9094fbda0bd 161 * @note On failure, any memory associated with the socket must still
DuyLionTran 0:c9094fbda0bd 162 * be cleaned up
DuyLionTran 0:c9094fbda0bd 163 */
DuyLionTran 0:c9094fbda0bd 164 virtual int socket_close(void *handle);
DuyLionTran 0:c9094fbda0bd 165
DuyLionTran 0:c9094fbda0bd 166 /** Bind a server socket to a specific port
DuyLionTran 0:c9094fbda0bd 167 * @param handle Socket handle
DuyLionTran 0:c9094fbda0bd 168 * @param address Local address to listen for incoming connections on
DuyLionTran 0:c9094fbda0bd 169 * @return 0 on success, negative on failure.
DuyLionTran 0:c9094fbda0bd 170 */
DuyLionTran 0:c9094fbda0bd 171 virtual int socket_bind(void *handle, const SocketAddress &address);
DuyLionTran 0:c9094fbda0bd 172
DuyLionTran 0:c9094fbda0bd 173 /** Start listening for incoming connections
DuyLionTran 0:c9094fbda0bd 174 * @param handle Socket handle
DuyLionTran 0:c9094fbda0bd 175 * @param backlog Number of pending connections that can be queued up at any
DuyLionTran 0:c9094fbda0bd 176 * one time [Default: 1]
DuyLionTran 0:c9094fbda0bd 177 * @return 0 on success, negative on failure
DuyLionTran 0:c9094fbda0bd 178 */
DuyLionTran 0:c9094fbda0bd 179 virtual int socket_listen(void *handle, int backlog);
DuyLionTran 0:c9094fbda0bd 180
DuyLionTran 0:c9094fbda0bd 181 /** Connects this TCP socket to the server
DuyLionTran 0:c9094fbda0bd 182 * @param handle Socket handle
DuyLionTran 0:c9094fbda0bd 183 * @param address SocketAddress to connect to
DuyLionTran 0:c9094fbda0bd 184 * @return 0 on success, negative on failure
DuyLionTran 0:c9094fbda0bd 185 */
DuyLionTran 0:c9094fbda0bd 186 virtual int socket_connect(void *handle, const SocketAddress &address);
DuyLionTran 0:c9094fbda0bd 187
DuyLionTran 0:c9094fbda0bd 188 /** Accept a new connection.
DuyLionTran 0:c9094fbda0bd 189 * @param handle Handle in which to store new socket
DuyLionTran 0:c9094fbda0bd 190 * @param server Socket handle to server to accept from
DuyLionTran 0:c9094fbda0bd 191 * @return 0 on success, negative on failure
DuyLionTran 0:c9094fbda0bd 192 * @note This call is not-blocking, if this call would block, must
DuyLionTran 0:c9094fbda0bd 193 * immediately return NSAPI_ERROR_WOULD_WAIT
DuyLionTran 0:c9094fbda0bd 194 */
DuyLionTran 0:c9094fbda0bd 195 virtual int socket_accept(void *handle, void **socket, SocketAddress *address);
DuyLionTran 0:c9094fbda0bd 196
DuyLionTran 0:c9094fbda0bd 197 /** Send data to the remote host
DuyLionTran 0:c9094fbda0bd 198 * @param handle Socket handle
DuyLionTran 0:c9094fbda0bd 199 * @param data The buffer to send to the host
DuyLionTran 0:c9094fbda0bd 200 * @param size The length of the buffer to send
DuyLionTran 0:c9094fbda0bd 201 * @return Number of written bytes on success, negative on failure
DuyLionTran 0:c9094fbda0bd 202 * @note This call is not-blocking, if this call would block, must
DuyLionTran 0:c9094fbda0bd 203 * immediately return NSAPI_ERROR_WOULD_WAIT
DuyLionTran 0:c9094fbda0bd 204 */
DuyLionTran 0:c9094fbda0bd 205 virtual int socket_send(void *handle, const void *data, unsigned size);
DuyLionTran 0:c9094fbda0bd 206
DuyLionTran 0:c9094fbda0bd 207 /** Receive data from the remote host
DuyLionTran 0:c9094fbda0bd 208 * @param handle Socket handle
DuyLionTran 0:c9094fbda0bd 209 * @param data The buffer in which to store the data received from the host
DuyLionTran 0:c9094fbda0bd 210 * @param size The maximum length of the buffer
DuyLionTran 0:c9094fbda0bd 211 * @return Number of received bytes on success, negative on failure
DuyLionTran 0:c9094fbda0bd 212 * @note This call is not-blocking, if this call would block, must
DuyLionTran 0:c9094fbda0bd 213 * immediately return NSAPI_ERROR_WOULD_WAIT
DuyLionTran 0:c9094fbda0bd 214 */
DuyLionTran 0:c9094fbda0bd 215 virtual int socket_recv(void *handle, void *data, unsigned size);
DuyLionTran 0:c9094fbda0bd 216
DuyLionTran 0:c9094fbda0bd 217 /** Send a packet to a remote endpoint
DuyLionTran 0:c9094fbda0bd 218 * @param handle Socket handle
DuyLionTran 0:c9094fbda0bd 219 * @param address The remote SocketAddress
DuyLionTran 0:c9094fbda0bd 220 * @param data The packet to be sent
DuyLionTran 0:c9094fbda0bd 221 * @param size The length of the packet to be sent
DuyLionTran 0:c9094fbda0bd 222 * @return The number of written bytes on success, negative on failure
DuyLionTran 0:c9094fbda0bd 223 * @note This call is not-blocking, if this call would block, must
DuyLionTran 0:c9094fbda0bd 224 * immediately return NSAPI_ERROR_WOULD_WAIT
DuyLionTran 0:c9094fbda0bd 225 */
DuyLionTran 0:c9094fbda0bd 226 virtual int socket_sendto(void *handle, const SocketAddress &address, const void *data, unsigned size);
DuyLionTran 0:c9094fbda0bd 227
DuyLionTran 0:c9094fbda0bd 228 /** Receive a packet from a remote endpoint
DuyLionTran 0:c9094fbda0bd 229 * @param handle Socket handle
DuyLionTran 0:c9094fbda0bd 230 * @param address Destination for the remote SocketAddress or null
DuyLionTran 0:c9094fbda0bd 231 * @param buffer The buffer for storing the incoming packet data
DuyLionTran 0:c9094fbda0bd 232 * If a packet is too long to fit in the supplied buffer,
DuyLionTran 0:c9094fbda0bd 233 * excess bytes are discarded
DuyLionTran 0:c9094fbda0bd 234 * @param size The length of the buffer
DuyLionTran 0:c9094fbda0bd 235 * @return The number of received bytes on success, negative on failure
DuyLionTran 0:c9094fbda0bd 236 * @note This call is not-blocking, if this call would block, must
DuyLionTran 0:c9094fbda0bd 237 * immediately return NSAPI_ERROR_WOULD_WAIT
DuyLionTran 0:c9094fbda0bd 238 */
DuyLionTran 0:c9094fbda0bd 239 virtual int socket_recvfrom(void *handle, SocketAddress *address, void *buffer, unsigned size);
DuyLionTran 0:c9094fbda0bd 240
DuyLionTran 0:c9094fbda0bd 241 /** Register a callback on state change of the socket
DuyLionTran 0:c9094fbda0bd 242 * @param handle Socket handle
DuyLionTran 0:c9094fbda0bd 243 * @param callback Function to call on state change
DuyLionTran 0:c9094fbda0bd 244 * @param data Argument to pass to callback
DuyLionTran 0:c9094fbda0bd 245 * @note Callback may be called in an interrupt context.
DuyLionTran 0:c9094fbda0bd 246 */
DuyLionTran 0:c9094fbda0bd 247 virtual void socket_attach(void *handle, void (*callback)(void *), void *data);
DuyLionTran 0:c9094fbda0bd 248
DuyLionTran 0:c9094fbda0bd 249 /** Provide access to the NetworkStack object
DuyLionTran 0:c9094fbda0bd 250 *
DuyLionTran 0:c9094fbda0bd 251 * @return The underlying NetworkStack object
DuyLionTran 0:c9094fbda0bd 252 */
DuyLionTran 0:c9094fbda0bd 253 virtual NetworkStack *get_stack()
DuyLionTran 0:c9094fbda0bd 254 {
DuyLionTran 0:c9094fbda0bd 255 return this;
DuyLionTran 0:c9094fbda0bd 256 }
DuyLionTran 0:c9094fbda0bd 257
DuyLionTran 0:c9094fbda0bd 258 private:
DuyLionTran 0:c9094fbda0bd 259 ESP8266 _esp;
DuyLionTran 0:c9094fbda0bd 260 bool _ids[ESP8266_SOCKET_COUNT];
DuyLionTran 0:c9094fbda0bd 261
DuyLionTran 0:c9094fbda0bd 262 char ap_ssid[33]; /* 32 is what 802.11 defines as longest possible name; +1 for the \0 */
DuyLionTran 0:c9094fbda0bd 263 nsapi_security_t ap_sec;
DuyLionTran 0:c9094fbda0bd 264 uint8_t ap_ch;
DuyLionTran 0:c9094fbda0bd 265 char ap_pass[64]; /* The longest allowed passphrase */
DuyLionTran 0:c9094fbda0bd 266
DuyLionTran 0:c9094fbda0bd 267 void event();
DuyLionTran 0:c9094fbda0bd 268
DuyLionTran 0:c9094fbda0bd 269 struct {
DuyLionTran 0:c9094fbda0bd 270 void (*callback)(void *);
DuyLionTran 0:c9094fbda0bd 271 void *data;
DuyLionTran 0:c9094fbda0bd 272 } _cbs[ESP8266_SOCKET_COUNT];
DuyLionTran 0:c9094fbda0bd 273 };
DuyLionTran 0:c9094fbda0bd 274
DuyLionTran 0:c9094fbda0bd 275 #endif