Maxim Integrated / Mbed 2 deprecated DeepCover Embedded Security in IoT

MAXREFDES143#: DeepCover Embedded Security in IoT Authenticated Sensing & Notification

Dependencies:   MaximInterface mbed

The MAXREFDES143# is an Internet of Things (IoT) embedded security reference design, built to protect an industrial sensing node by means of authentication and notification to a web server. The hardware includes a peripheral module representing a protected sensor node monitoring operating temperature and remaining life of a filter (simulated through ambient light sensing) and an mbed shield representing a controller node responsible for monitoring one or more sensor nodes. The design is hierarchical with each controller node communicating data from connected sensor nodes to a web server that maintains a centralized log and dispatches notifications as necessary. The mbed shield contains a Wi-Fi module, a DS2465 coprocessor with 1-Wire® master function, an LCD, LEDs, and pushbuttons. The protected sensor node contains a DS28E15 authenticator, a DS7505 temperature sensor, and a MAX44009 light sensor. The mbed shield communicates to a web server by the onboard Wi-Fi module and to the protected sensor node with I2C and 1-Wire. The MAXREFDES143# is equipped with a standard shield connector for immediate testing using an mbed board such as the MAX32600MBED#. The simplicity of this design enables rapid integration into any star-topology IoT network requiring the heightened security with low overhead provided by the SHA-256 symmetric-key algorithm.

More information about the MAXREFDES143# is available on the Maxim Integrated website.

esp8266-driver/ESP8266/ESP8266.h@28:e5cdaf13d299, 2017-01-26 (annotated)

Committer:
IanBenzMaxim
Date:
Thu Jan 26 14:18:21 2017 -0600
Revision:
28:e5cdaf13d299
Migrated the web interface to the mbed 5 networking stack to improve system compatibility.

Who changed what in which revision?

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