Taylor Gy / Mbed OS 8-0_OneNet_IoT_demo

OneNet_IoT_demo for ASC platform

Dependencies:   Common_lib ESP8266 EdpKit_lib cJSON_lib driver_mbed_HP20x driver_mbed_TH02 wifi_example

Fork of mbed-os-example-esp8266 by ESP8266

esp8266-driver/ESP8266/ESP8266.h@0:b887535f68bf, 2017-01-12 (annotated)

Committer:
group-ESP8266
Date:
Thu Jan 12 20:21:45 2017 +0000
Revision:
0:b887535f68bf
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
group-ESP8266 0:b887535f68bf 1 /* ESP8266Interface Example
group-ESP8266 0:b887535f68bf 2 * Copyright (c) 2015 ARM Limited
group-ESP8266 0:b887535f68bf 3 *
group-ESP8266 0:b887535f68bf 4 * Licensed under the Apache License, Version 2.0 (the "License");
group-ESP8266 0:b887535f68bf 5 * you may not use this file except in compliance with the License.
group-ESP8266 0:b887535f68bf 6 * You may obtain a copy of the License at
group-ESP8266 0:b887535f68bf 7 *
group-ESP8266 0:b887535f68bf 8 * http://www.apache.org/licenses/LICENSE-2.0
group-ESP8266 0:b887535f68bf 9 *
group-ESP8266 0:b887535f68bf 10 * Unless required by applicable law or agreed to in writing, software
group-ESP8266 0:b887535f68bf 11 * distributed under the License is distributed on an "AS IS" BASIS,
group-ESP8266 0:b887535f68bf 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
group-ESP8266 0:b887535f68bf 13 * See the License for the specific language governing permissions and
group-ESP8266 0:b887535f68bf 14 * limitations under the License.
group-ESP8266 0:b887535f68bf 15 */
group-ESP8266 0:b887535f68bf 16
group-ESP8266 0:b887535f68bf 17 #ifndef ESP8266_H
group-ESP8266 0:b887535f68bf 18 #define ESP8266_H
group-ESP8266 0:b887535f68bf 19
group-ESP8266 0:b887535f68bf 20 #include "ATParser.h"
group-ESP8266 0:b887535f68bf 21
group-ESP8266 0:b887535f68bf 22 /** ESP8266Interface class.
group-ESP8266 0:b887535f68bf 23 This is an interface to a ESP8266 radio.
group-ESP8266 0:b887535f68bf 24 */
group-ESP8266 0:b887535f68bf 25 class ESP8266
group-ESP8266 0:b887535f68bf 26 {
group-ESP8266 0:b887535f68bf 27 public:
group-ESP8266 0:b887535f68bf 28 ESP8266(PinName tx, PinName rx, bool debug=false);
group-ESP8266 0:b887535f68bf 29
group-ESP8266 0:b887535f68bf 30 /**
group-ESP8266 0:b887535f68bf 31 * Startup the ESP8266
group-ESP8266 0:b887535f68bf 32 *
group-ESP8266 0:b887535f68bf 33 * @param mode mode of WIFI 1-client, 2-host, 3-both
group-ESP8266 0:b887535f68bf 34 * @return true only if ESP8266 was setup correctly
group-ESP8266 0:b887535f68bf 35 */
group-ESP8266 0:b887535f68bf 36 bool startup(int mode);
group-ESP8266 0:b887535f68bf 37
group-ESP8266 0:b887535f68bf 38 /**
group-ESP8266 0:b887535f68bf 39 * Reset ESP8266
group-ESP8266 0:b887535f68bf 40 *
group-ESP8266 0:b887535f68bf 41 * @return true only if ESP8266 resets successfully
group-ESP8266 0:b887535f68bf 42 */
group-ESP8266 0:b887535f68bf 43 bool reset(void);
group-ESP8266 0:b887535f68bf 44
group-ESP8266 0:b887535f68bf 45 /**
group-ESP8266 0:b887535f68bf 46 * Enable/Disable DHCP
group-ESP8266 0:b887535f68bf 47 *
group-ESP8266 0:b887535f68bf 48 * @param enabled DHCP enabled when true
group-ESP8266 0:b887535f68bf 49 * @param mode mode of DHCP 0-softAP, 1-station, 2-both
group-ESP8266 0:b887535f68bf 50 * @return true only if ESP8266 enables/disables DHCP successfully
group-ESP8266 0:b887535f68bf 51 */
group-ESP8266 0:b887535f68bf 52 bool dhcp(bool enabled, int mode);
group-ESP8266 0:b887535f68bf 53
group-ESP8266 0:b887535f68bf 54 /**
group-ESP8266 0:b887535f68bf 55 * Connect ESP8266 to AP
group-ESP8266 0:b887535f68bf 56 *
group-ESP8266 0:b887535f68bf 57 * @param ap the name of the AP
group-ESP8266 0:b887535f68bf 58 * @param passPhrase the password of AP
group-ESP8266 0:b887535f68bf 59 * @return true only if ESP8266 is connected successfully
group-ESP8266 0:b887535f68bf 60 */
group-ESP8266 0:b887535f68bf 61 bool connect(const char *ap, const char *passPhrase);
group-ESP8266 0:b887535f68bf 62
group-ESP8266 0:b887535f68bf 63 /**
group-ESP8266 0:b887535f68bf 64 * Disconnect ESP8266 from AP
group-ESP8266 0:b887535f68bf 65 *
group-ESP8266 0:b887535f68bf 66 * @return true only if ESP8266 is disconnected successfully
group-ESP8266 0:b887535f68bf 67 */
group-ESP8266 0:b887535f68bf 68 bool disconnect(void);
group-ESP8266 0:b887535f68bf 69
group-ESP8266 0:b887535f68bf 70 /**
group-ESP8266 0:b887535f68bf 71 * Get the IP address of ESP8266
group-ESP8266 0:b887535f68bf 72 *
group-ESP8266 0:b887535f68bf 73 * @return null-teriminated IP address or null if no IP address is assigned
group-ESP8266 0:b887535f68bf 74 */
group-ESP8266 0:b887535f68bf 75 const char *getIPAddress(void);
group-ESP8266 0:b887535f68bf 76
group-ESP8266 0:b887535f68bf 77 /**
group-ESP8266 0:b887535f68bf 78 * Get the MAC address of ESP8266
group-ESP8266 0:b887535f68bf 79 *
group-ESP8266 0:b887535f68bf 80 * @return null-terminated MAC address or null if no MAC address is assigned
group-ESP8266 0:b887535f68bf 81 */
group-ESP8266 0:b887535f68bf 82 const char *getMACAddress(void);
group-ESP8266 0:b887535f68bf 83
group-ESP8266 0:b887535f68bf 84 /** Get the local gateway
group-ESP8266 0:b887535f68bf 85 *
group-ESP8266 0:b887535f68bf 86 * @return Null-terminated representation of the local gateway
group-ESP8266 0:b887535f68bf 87 * or null if no network mask has been recieved
group-ESP8266 0:b887535f68bf 88 */
group-ESP8266 0:b887535f68bf 89 const char *getGateway();
group-ESP8266 0:b887535f68bf 90
group-ESP8266 0:b887535f68bf 91 /** Get the local network mask
group-ESP8266 0:b887535f68bf 92 *
group-ESP8266 0:b887535f68bf 93 * @return Null-terminated representation of the local network mask
group-ESP8266 0:b887535f68bf 94 * or null if no network mask has been recieved
group-ESP8266 0:b887535f68bf 95 */
group-ESP8266 0:b887535f68bf 96 const char *getNetmask();
group-ESP8266 0:b887535f68bf 97
group-ESP8266 0:b887535f68bf 98 /* Return RSSI for active connection
group-ESP8266 0:b887535f68bf 99 *
group-ESP8266 0:b887535f68bf 100 * @return Measured RSSI
group-ESP8266 0:b887535f68bf 101 */
group-ESP8266 0:b887535f68bf 102 int8_t getRSSI();
group-ESP8266 0:b887535f68bf 103
group-ESP8266 0:b887535f68bf 104 /**
group-ESP8266 0:b887535f68bf 105 * Check if ESP8266 is conenected
group-ESP8266 0:b887535f68bf 106 *
group-ESP8266 0:b887535f68bf 107 * @return true only if the chip has an IP address
group-ESP8266 0:b887535f68bf 108 */
group-ESP8266 0:b887535f68bf 109 bool isConnected(void);
group-ESP8266 0:b887535f68bf 110
group-ESP8266 0:b887535f68bf 111 /** Scan for available networks
group-ESP8266 0:b887535f68bf 112 *
group-ESP8266 0:b887535f68bf 113 * @param ap Pointer to allocated array to store discovered AP
group-ESP8266 0:b887535f68bf 114 * @param limit Size of allocated @a res array, or 0 to only count available AP
group-ESP8266 0:b887535f68bf 115 * @return Number of entries in @a res, or if @a count was 0 number of available networks, negative on error
group-ESP8266 0:b887535f68bf 116 * see @a nsapi_error
group-ESP8266 0:b887535f68bf 117 */
group-ESP8266 0:b887535f68bf 118 int scan(WiFiAccessPoint *res, unsigned limit);
group-ESP8266 0:b887535f68bf 119
group-ESP8266 0:b887535f68bf 120 /**
group-ESP8266 0:b887535f68bf 121 * Open a socketed connection
group-ESP8266 0:b887535f68bf 122 *
group-ESP8266 0:b887535f68bf 123 * @param type the type of socket to open "UDP" or "TCP"
group-ESP8266 0:b887535f68bf 124 * @param id id to give the new socket, valid 0-4
group-ESP8266 0:b887535f68bf 125 * @param port port to open connection with
group-ESP8266 0:b887535f68bf 126 * @param addr the IP address of the destination
group-ESP8266 0:b887535f68bf 127 * @return true only if socket opened successfully
group-ESP8266 0:b887535f68bf 128 */
group-ESP8266 0:b887535f68bf 129 bool open(const char *type, int id, const char* addr, int port);
group-ESP8266 0:b887535f68bf 130
group-ESP8266 0:b887535f68bf 131 /**
group-ESP8266 0:b887535f68bf 132 * Sends data to an open socket
group-ESP8266 0:b887535f68bf 133 *
group-ESP8266 0:b887535f68bf 134 * @param id id of socket to send to
group-ESP8266 0:b887535f68bf 135 * @param data data to be sent
group-ESP8266 0:b887535f68bf 136 * @param amount amount of data to be sent - max 1024
group-ESP8266 0:b887535f68bf 137 * @return true only if data sent successfully
group-ESP8266 0:b887535f68bf 138 */
group-ESP8266 0:b887535f68bf 139 bool send(int id, const void *data, uint32_t amount);
group-ESP8266 0:b887535f68bf 140
group-ESP8266 0:b887535f68bf 141 /**
group-ESP8266 0:b887535f68bf 142 * Receives data from an open socket
group-ESP8266 0:b887535f68bf 143 *
group-ESP8266 0:b887535f68bf 144 * @param id id to receive from
group-ESP8266 0:b887535f68bf 145 * @param data placeholder for returned information
group-ESP8266 0:b887535f68bf 146 * @param amount number of bytes to be received
group-ESP8266 0:b887535f68bf 147 * @return the number of bytes received
group-ESP8266 0:b887535f68bf 148 */
group-ESP8266 0:b887535f68bf 149 int32_t recv(int id, void *data, uint32_t amount);
group-ESP8266 0:b887535f68bf 150
group-ESP8266 0:b887535f68bf 151 /**
group-ESP8266 0:b887535f68bf 152 * Closes a socket
group-ESP8266 0:b887535f68bf 153 *
group-ESP8266 0:b887535f68bf 154 * @param id id of socket to close, valid only 0-4
group-ESP8266 0:b887535f68bf 155 * @return true only if socket is closed successfully
group-ESP8266 0:b887535f68bf 156 */
group-ESP8266 0:b887535f68bf 157 bool close(int id);
group-ESP8266 0:b887535f68bf 158
group-ESP8266 0:b887535f68bf 159 /**
group-ESP8266 0:b887535f68bf 160 * Allows timeout to be changed between commands
group-ESP8266 0:b887535f68bf 161 *
group-ESP8266 0:b887535f68bf 162 * @param timeout_ms timeout of the connection
group-ESP8266 0:b887535f68bf 163 */
group-ESP8266 0:b887535f68bf 164 void setTimeout(uint32_t timeout_ms);
group-ESP8266 0:b887535f68bf 165
group-ESP8266 0:b887535f68bf 166 /**
group-ESP8266 0:b887535f68bf 167 * Checks if data is available
group-ESP8266 0:b887535f68bf 168 */
group-ESP8266 0:b887535f68bf 169 bool readable();
group-ESP8266 0:b887535f68bf 170
group-ESP8266 0:b887535f68bf 171 /**
group-ESP8266 0:b887535f68bf 172 * Checks if data can be written
group-ESP8266 0:b887535f68bf 173 */
group-ESP8266 0:b887535f68bf 174 bool writeable();
group-ESP8266 0:b887535f68bf 175
group-ESP8266 0:b887535f68bf 176 /**
group-ESP8266 0:b887535f68bf 177 * Attach a function to call whenever network state has changed
group-ESP8266 0:b887535f68bf 178 *
group-ESP8266 0:b887535f68bf 179 * @param func A pointer to a void function, or 0 to set as none
group-ESP8266 0:b887535f68bf 180 */
group-ESP8266 0:b887535f68bf 181 void attach(Callback<void()> func);
group-ESP8266 0:b887535f68bf 182
group-ESP8266 0:b887535f68bf 183 /**
group-ESP8266 0:b887535f68bf 184 * Attach a function to call whenever network state has changed
group-ESP8266 0:b887535f68bf 185 *
group-ESP8266 0:b887535f68bf 186 * @param obj pointer to the object to call the member function on
group-ESP8266 0:b887535f68bf 187 * @param method pointer to the member function to call
group-ESP8266 0:b887535f68bf 188 */
group-ESP8266 0:b887535f68bf 189 template <typename T, typename M>
group-ESP8266 0:b887535f68bf 190 void attach(T *obj, M method) {
group-ESP8266 0:b887535f68bf 191 attach(Callback<void()>(obj, method));
group-ESP8266 0:b887535f68bf 192 }
group-ESP8266 0:b887535f68bf 193
group-ESP8266 0:b887535f68bf 194 private:
group-ESP8266 0:b887535f68bf 195 BufferedSerial _serial;
group-ESP8266 0:b887535f68bf 196 ATParser _parser;
group-ESP8266 0:b887535f68bf 197
group-ESP8266 0:b887535f68bf 198 struct packet {
group-ESP8266 0:b887535f68bf 199 struct packet *next;
group-ESP8266 0:b887535f68bf 200 int id;
group-ESP8266 0:b887535f68bf 201 uint32_t len;
group-ESP8266 0:b887535f68bf 202 // data follows
group-ESP8266 0:b887535f68bf 203 } *_packets, **_packets_end;
group-ESP8266 0:b887535f68bf 204 void _packet_handler();
group-ESP8266 0:b887535f68bf 205 bool recv_ap(nsapi_wifi_ap_t *ap);
group-ESP8266 0:b887535f68bf 206
group-ESP8266 0:b887535f68bf 207 char _ip_buffer[16];
group-ESP8266 0:b887535f68bf 208 char _gateway_buffer[16];
group-ESP8266 0:b887535f68bf 209 char _netmask_buffer[16];
group-ESP8266 0:b887535f68bf 210 char _mac_buffer[18];
group-ESP8266 0:b887535f68bf 211 };
group-ESP8266 0:b887535f68bf 212
group-ESP8266 0:b887535f68bf 213 #endif