Volodymyr Shymanskyy / Blynk Featured

Blynk library for embedded hardware. Works with Arduino, ESP8266, Raspberry Pi, Intel Edison/Galileo, LinkIt ONE, Particle Core/Photon, Energia, ARM mbed, etc. http://www.blynk.cc/

Dependents:   Blynk_RBL_BLE_Nano Blynk_MicroBit Blynk_Serial Blynk_RBL_BLE_Nano

Blynk/BlynkProtocol.h@21:fd9a3d7ddadb, 2017-12-21 (annotated)

Committer:
Volodymyr Shymanskyy
Date:
Thu Dec 21 14:34:46 2017 +0200
Revision:
21:fd9a3d7ddadb
Parent:
19:bae78e167b11 
Update version

Who changed what in which revision?

UserRevisionLine numberNew contents of line
vshymanskyy 0:58b20b438383 1 /**
vshymanskyy 0:58b20b438383 2 * @file BlynkProtocol.h
vshymanskyy 0:58b20b438383 3 * @author Volodymyr Shymanskyy
vshymanskyy 0:58b20b438383 4 * @license This project is released under the MIT License (MIT)
vshymanskyy 0:58b20b438383 5 * @copyright Copyright (c) 2015 Volodymyr Shymanskyy
vshymanskyy 0:58b20b438383 6 * @date Jan 2015
vshymanskyy 0:58b20b438383 7 * @brief Blynk protocol implementation
vshymanskyy 0:58b20b438383 8 *
vshymanskyy 0:58b20b438383 9 */
vshymanskyy 0:58b20b438383 10
vshymanskyy 0:58b20b438383 11 #ifndef BlynkProtocol_h
vshymanskyy 0:58b20b438383 12 #define BlynkProtocol_h
vshymanskyy 0:58b20b438383 13
vshymanskyy 0:58b20b438383 14 #include <string.h>
vshymanskyy 0:58b20b438383 15 #include <stdlib.h>
vshymanskyy 0:58b20b438383 16 #include <Blynk/BlynkDebug.h>
vshymanskyy 0:58b20b438383 17 #include <Blynk/BlynkProtocolDefs.h>
vshymanskyy 0:58b20b438383 18 #include <Blynk/BlynkApi.h>
vshymanskyy 0:58b20b438383 19 #include <utility/BlynkUtility.h>
vshymanskyy 0:58b20b438383 20
vshymanskyy 0:58b20b438383 21 template <class Transp>
vshymanskyy 0:58b20b438383 22 class BlynkProtocol
vshymanskyy 0:58b20b438383 23 : public BlynkApi< BlynkProtocol<Transp> >
vshymanskyy 0:58b20b438383 24 {
vshymanskyy 0:58b20b438383 25 friend class BlynkApi< BlynkProtocol<Transp> >;
vshymanskyy 0:58b20b438383 26 public:
vshymanskyy 0:58b20b438383 27 enum BlynkState {
vshymanskyy 0:58b20b438383 28 CONNECTING,
vshymanskyy 0:58b20b438383 29 CONNECTED,
vshymanskyy 0:58b20b438383 30 DISCONNECTED,
vshymanskyy 0:58b20b438383 31 };
vshymanskyy 0:58b20b438383 32
vshymanskyy 0:58b20b438383 33 BlynkProtocol(Transp& transp)
vshymanskyy 0:58b20b438383 34 : conn(transp)
vshymanskyy 0:58b20b438383 35 , authkey(NULL)
Volodymyr Shymanskyy 9:7369ec77a3ea 36 , redir_serv(NULL)
vshymanskyy 0:58b20b438383 37 , lastActivityIn(0)
vshymanskyy 0:58b20b438383 38 , lastActivityOut(0)
vshymanskyy 0:58b20b438383 39 , lastHeartbeat(0)
Volodymyr Shymanskyy 14:76d8fd871a4d 40 , msgIdOut(0)
Volodymyr Shymanskyy 14:76d8fd871a4d 41 , msgIdOutOverride(0)
Volodymyr Shymanskyy 18:c328c1a97f90 42 , nesting(0)
vshymanskyy 0:58b20b438383 43 , state(CONNECTING)
vshymanskyy 0:58b20b438383 44 {}
vshymanskyy 0:58b20b438383 45
vshymanskyy 0:58b20b438383 46 bool connected() { return state == CONNECTED; }
vshymanskyy 0:58b20b438383 47
vshymanskyy 0:58b20b438383 48 bool connect(uint32_t timeout = BLYNK_TIMEOUT_MS*3) {
Volodymyr Shymanskyy 9:7369ec77a3ea 49 conn.disconnect();
Volodymyr Shymanskyy 9:7369ec77a3ea 50 state = CONNECTING;
Volodymyr Shymanskyy 15:975b60f7a8ff 51 millis_time_t started = BlynkMillis();
Volodymyr Shymanskyy 9:7369ec77a3ea 52 while ((state != CONNECTED) &&
Volodymyr Shymanskyy 15:975b60f7a8ff 53 (BlynkMillis() - started < timeout))
Volodymyr Shymanskyy 9:7369ec77a3ea 54 {
Volodymyr Shymanskyy 9:7369ec77a3ea 55 run();
Volodymyr Shymanskyy 9:7369ec77a3ea 56 }
Volodymyr Shymanskyy 9:7369ec77a3ea 57 return state == CONNECTED;
vshymanskyy 0:58b20b438383 58 }
vshymanskyy 0:58b20b438383 59
vshymanskyy 0:58b20b438383 60 void disconnect() {
vshymanskyy 0:58b20b438383 61 conn.disconnect();
vshymanskyy 0:58b20b438383 62 state = DISCONNECTED;
vshymanskyy 0:58b20b438383 63 BLYNK_LOG1(BLYNK_F("Disconnected"));
vshymanskyy 0:58b20b438383 64 }
vshymanskyy 0:58b20b438383 65
vshymanskyy 0:58b20b438383 66 bool run(bool avail = false);
vshymanskyy 0:58b20b438383 67
Volodymyr Shymanskyy 3:31e4b850b126 68 // TODO: Fixme
vshymanskyy 0:58b20b438383 69 void startSession() {
Volodymyr Shymanskyy 3:31e4b850b126 70 conn.connect();
Volodymyr Shymanskyy 9:7369ec77a3ea 71 state = CONNECTING;
Volodymyr Shymanskyy 14:76d8fd871a4d 72 msgIdOut = 0;
Volodymyr Shymanskyy 19:bae78e167b11 73 lastHeartbeat = lastActivityIn = lastActivityOut = (BlynkMillis() - 5000UL);
vshymanskyy 0:58b20b438383 74 }
vshymanskyy 0:58b20b438383 75
vshymanskyy 0:58b20b438383 76 void sendCmd(uint8_t cmd, uint16_t id = 0, const void* data = NULL, size_t length = 0, const void* data2 = NULL, size_t length2 = 0);
vshymanskyy 0:58b20b438383 77
vshymanskyy 0:58b20b438383 78 private:
Volodymyr Shymanskyy 14:76d8fd871a4d 79
Volodymyr Shymanskyy 14:76d8fd871a4d 80 void internalReconnect() {
Volodymyr Shymanskyy 14:76d8fd871a4d 81 state = CONNECTING;
Volodymyr Shymanskyy 14:76d8fd871a4d 82 conn.disconnect();
Volodymyr Shymanskyy 14:76d8fd871a4d 83 BlynkOnDisconnected();
Volodymyr Shymanskyy 14:76d8fd871a4d 84 }
Volodymyr Shymanskyy 14:76d8fd871a4d 85
vshymanskyy 0:58b20b438383 86 int readHeader(BlynkHeader& hdr);
vshymanskyy 0:58b20b438383 87 uint16_t getNextMsgId();
vshymanskyy 0:58b20b438383 88
vshymanskyy 0:58b20b438383 89 protected:
vshymanskyy 0:58b20b438383 90 void begin(const char* auth) {
Volodymyr Shymanskyy 9:7369ec77a3ea 91 this->authkey = auth;
Volodymyr Shymanskyy 19:bae78e167b11 92 lastHeartbeat = lastActivityIn = lastActivityOut = (BlynkMillis() - 5000UL);
Volodymyr Shymanskyy 9:7369ec77a3ea 93
Volodymyr Shymanskyy 9:7369ec77a3ea 94 #if defined(BLYNK_NO_FANCY_LOGO)
vshymanskyy 0:58b20b438383 95 BLYNK_LOG1(BLYNK_F("Blynk v" BLYNK_VERSION " on " BLYNK_INFO_DEVICE));
Volodymyr Shymanskyy 9:7369ec77a3ea 96 #elif defined(BLYNK_FANCY_LOGO_3D)
Volodymyr Shymanskyy 9:7369ec77a3ea 97 BLYNK_LOG1(BLYNK_F("\n"
Volodymyr Shymanskyy 9:7369ec77a3ea 98 " ____ ___ __\n"
Volodymyr Shymanskyy 9:7369ec77a3ea 99 " /\\ _`\\ /\\_ \\ /\\ \\ _\n"
Volodymyr Shymanskyy 9:7369ec77a3ea 100 " \\ \\ \\_\\ \\\\//\\ \\ __ __ ___ \\ \\ \\/ \\\n"
Volodymyr Shymanskyy 9:7369ec77a3ea 101 " \\ \\ _ < \\ \\ \\ /\\ \\/\\ \\ /' _ `\\\\ \\ , <\n"
Volodymyr Shymanskyy 9:7369ec77a3ea 102 " \\ \\ \\_\\ \\ \\_\\ \\_\\ \\ \\_\\ \\ /\\ \\/\\ \\\\ \\ \\\\`\\\n"
Volodymyr Shymanskyy 9:7369ec77a3ea 103 " \\ \\____/ /\\____\\\\/`____ \\\\ \\_\\ \\_\\\\ \\_\\\\_\\\n"
Volodymyr Shymanskyy 9:7369ec77a3ea 104 " \\/___/ \\/____/ `/___/\\ \\\\/_/\\/_/ \\/_//_/\n"
Volodymyr Shymanskyy 9:7369ec77a3ea 105 " /\\___/\n"
Volodymyr Shymanskyy 9:7369ec77a3ea 106 " \\/__/ " BLYNK_VERSION " on " BLYNK_INFO_DEVICE "\n"
Volodymyr Shymanskyy 9:7369ec77a3ea 107 ));
Volodymyr Shymanskyy 9:7369ec77a3ea 108 #else
Volodymyr Shymanskyy 9:7369ec77a3ea 109 BLYNK_LOG1(BLYNK_F("\n"
Volodymyr Shymanskyy 9:7369ec77a3ea 110 " ___ __ __\n"
Volodymyr Shymanskyy 9:7369ec77a3ea 111 " / _ )/ /_ _____ / /__\n"
Volodymyr Shymanskyy 9:7369ec77a3ea 112 " / _ / / // / _ \\/ '_/\n"
Volodymyr Shymanskyy 9:7369ec77a3ea 113 " /____/_/\\_, /_//_/_/\\_\\\n"
Volodymyr Shymanskyy 9:7369ec77a3ea 114 " /___/ v" BLYNK_VERSION " on " BLYNK_INFO_DEVICE "\n"
Volodymyr Shymanskyy 9:7369ec77a3ea 115 ));
Volodymyr Shymanskyy 9:7369ec77a3ea 116 #endif
vshymanskyy 0:58b20b438383 117 }
vshymanskyy 0:58b20b438383 118 bool processInput(void);
vshymanskyy 0:58b20b438383 119
vshymanskyy 0:58b20b438383 120 Transp& conn;
vshymanskyy 0:58b20b438383 121
vshymanskyy 0:58b20b438383 122 private:
vshymanskyy 0:58b20b438383 123 const char* authkey;
Volodymyr Shymanskyy 9:7369ec77a3ea 124 char* redir_serv;
vshymanskyy 0:58b20b438383 125 millis_time_t lastActivityIn;
vshymanskyy 0:58b20b438383 126 millis_time_t lastActivityOut;
vshymanskyy 0:58b20b438383 127 union {
Volodymyr Shymanskyy 9:7369ec77a3ea 128 millis_time_t lastHeartbeat;
Volodymyr Shymanskyy 9:7369ec77a3ea 129 millis_time_t lastLogin;
vshymanskyy 0:58b20b438383 130 };
Volodymyr Shymanskyy 14:76d8fd871a4d 131 uint16_t msgIdOut;
Volodymyr Shymanskyy 14:76d8fd871a4d 132 uint16_t msgIdOutOverride;
Volodymyr Shymanskyy 18:c328c1a97f90 133 uint8_t nesting;
Volodymyr Shymanskyy 3:31e4b850b126 134 protected:
vshymanskyy 0:58b20b438383 135 BlynkState state;
vshymanskyy 0:58b20b438383 136 };
vshymanskyy 0:58b20b438383 137
vshymanskyy 0:58b20b438383 138 template <class Transp>
vshymanskyy 0:58b20b438383 139 bool BlynkProtocol<Transp>::run(bool avail)
vshymanskyy 0:58b20b438383 140 {
Volodymyr Shymanskyy 9:7369ec77a3ea 141 BLYNK_RUN_YIELD();
vshymanskyy 0:58b20b438383 142
vshymanskyy 0:58b20b438383 143 if (state == DISCONNECTED) {
vshymanskyy 0:58b20b438383 144 return false;
vshymanskyy 0:58b20b438383 145 }
vshymanskyy 0:58b20b438383 146
Volodymyr Shymanskyy 18:c328c1a97f90 147 // Detect nesting
Volodymyr Shymanskyy 18:c328c1a97f90 148 BlynkHelperAutoInc guard(nesting);
Volodymyr Shymanskyy 18:c328c1a97f90 149 if (msgIdOutOverride || nesting > 2) {
Volodymyr Shymanskyy 19:bae78e167b11 150 #ifdef BLYNK_DEBUG_ALL
Volodymyr Shymanskyy 18:c328c1a97f90 151 BLYNK_LOG1(BLYNK_F("Nested run() skipped"));
Volodymyr Shymanskyy 18:c328c1a97f90 152 #endif
Volodymyr Shymanskyy 18:c328c1a97f90 153 return true;
Volodymyr Shymanskyy 18:c328c1a97f90 154 }
Volodymyr Shymanskyy 18:c328c1a97f90 155
Volodymyr Shymanskyy 21:fd9a3d7ddadb 156 if (conn.connected()) {
Volodymyr Shymanskyy 18:c328c1a97f90 157 while (avail || conn.available() > 0) {
vshymanskyy 0:58b20b438383 158 //BLYNK_LOG2(BLYNK_F("Available: "), conn.available());
vshymanskyy 0:58b20b438383 159 //const unsigned long t = micros();
vshymanskyy 0:58b20b438383 160 if (!processInput()) {
vshymanskyy 0:58b20b438383 161 conn.disconnect();
vshymanskyy 0:58b20b438383 162 // TODO: Only when in direct mode?
vshymanskyy 0:58b20b438383 163 #ifdef BLYNK_USE_DIRECT_CONNECT
vshymanskyy 0:58b20b438383 164 state = CONNECTING;
vshymanskyy 0:58b20b438383 165 #endif
Volodymyr Shymanskyy 14:76d8fd871a4d 166 BlynkOnDisconnected();
vshymanskyy 0:58b20b438383 167 return false;
vshymanskyy 0:58b20b438383 168 }
Volodymyr Shymanskyy 18:c328c1a97f90 169 avail = false;
vshymanskyy 0:58b20b438383 170 //BLYNK_LOG2(BLYNK_F("Proc time: "), micros() - t);
vshymanskyy 0:58b20b438383 171 }
vshymanskyy 0:58b20b438383 172 }
vshymanskyy 0:58b20b438383 173
Volodymyr Shymanskyy 15:975b60f7a8ff 174 const millis_time_t t = BlynkMillis();
vshymanskyy 0:58b20b438383 175
Volodymyr Shymanskyy 21:fd9a3d7ddadb 176 // Update connection status after running commands
Volodymyr Shymanskyy 21:fd9a3d7ddadb 177 const bool tconn = conn.connected();
Volodymyr Shymanskyy 21:fd9a3d7ddadb 178
vshymanskyy 0:58b20b438383 179 if (state == CONNECTED) {
vshymanskyy 0:58b20b438383 180 if (!tconn) {
vshymanskyy 0:58b20b438383 181 lastHeartbeat = t;
Volodymyr Shymanskyy 14:76d8fd871a4d 182 internalReconnect();
vshymanskyy 0:58b20b438383 183 return false;
vshymanskyy 0:58b20b438383 184 }
vshymanskyy 0:58b20b438383 185
vshymanskyy 0:58b20b438383 186 if (t - lastActivityIn > (1000UL * BLYNK_HEARTBEAT + BLYNK_TIMEOUT_MS*3)) {
vshymanskyy 0:58b20b438383 187 #ifdef BLYNK_DEBUG
vshymanskyy 0:58b20b438383 188 BLYNK_LOG6(BLYNK_F("Heartbeat timeout: "), t, BLYNK_F(", "), lastActivityIn, BLYNK_F(", "), lastHeartbeat);
vshymanskyy 0:58b20b438383 189 #else
vshymanskyy 0:58b20b438383 190 BLYNK_LOG1(BLYNK_F("Heartbeat timeout"));
vshymanskyy 0:58b20b438383 191 #endif
Volodymyr Shymanskyy 14:76d8fd871a4d 192 internalReconnect();
vshymanskyy 0:58b20b438383 193 return false;
vshymanskyy 0:58b20b438383 194 } else if ((t - lastActivityIn > 1000UL * BLYNK_HEARTBEAT ||
vshymanskyy 0:58b20b438383 195 t - lastActivityOut > 1000UL * BLYNK_HEARTBEAT) &&
vshymanskyy 0:58b20b438383 196 t - lastHeartbeat > BLYNK_TIMEOUT_MS)
vshymanskyy 0:58b20b438383 197 {
vshymanskyy 0:58b20b438383 198 // Send ping if we didn't either send or receive something
vshymanskyy 0:58b20b438383 199 // for BLYNK_HEARTBEAT seconds
vshymanskyy 0:58b20b438383 200 sendCmd(BLYNK_CMD_PING);
vshymanskyy 0:58b20b438383 201 lastHeartbeat = t;
vshymanskyy 0:58b20b438383 202 }
vshymanskyy 0:58b20b438383 203 } else if (state == CONNECTING) {
Volodymyr Shymanskyy 9:7369ec77a3ea 204 #ifdef BLYNK_USE_DIRECT_CONNECT
Volodymyr Shymanskyy 9:7369ec77a3ea 205 if (!tconn)
Volodymyr Shymanskyy 9:7369ec77a3ea 206 conn.connect();
Volodymyr Shymanskyy 9:7369ec77a3ea 207 #else
vshymanskyy 0:58b20b438383 208 if (tconn && (t - lastLogin > BLYNK_TIMEOUT_MS)) {
vshymanskyy 0:58b20b438383 209 BLYNK_LOG1(BLYNK_F("Login timeout"));
vshymanskyy 0:58b20b438383 210 conn.disconnect();
vshymanskyy 0:58b20b438383 211 state = CONNECTING;
vshymanskyy 0:58b20b438383 212 return false;
vshymanskyy 0:58b20b438383 213 } else if (!tconn && (t - lastLogin > 5000UL)) {
vshymanskyy 0:58b20b438383 214 conn.disconnect();
vshymanskyy 0:58b20b438383 215 if (!conn.connect()) {
vshymanskyy 0:58b20b438383 216 lastLogin = t;
vshymanskyy 0:58b20b438383 217 return false;
vshymanskyy 0:58b20b438383 218 }
vshymanskyy 0:58b20b438383 219
Volodymyr Shymanskyy 14:76d8fd871a4d 220 msgIdOut = 1;
vshymanskyy 0:58b20b438383 221 sendCmd(BLYNK_CMD_LOGIN, 1, authkey, strlen(authkey));
vshymanskyy 0:58b20b438383 222 lastLogin = lastActivityOut;
vshymanskyy 0:58b20b438383 223 return true;
vshymanskyy 0:58b20b438383 224 }
vshymanskyy 0:58b20b438383 225 #endif
vshymanskyy 0:58b20b438383 226 }
vshymanskyy 0:58b20b438383 227 return true;
vshymanskyy 0:58b20b438383 228 }
vshymanskyy 0:58b20b438383 229
vshymanskyy 0:58b20b438383 230 template <class Transp>
vshymanskyy 0:58b20b438383 231 BLYNK_FORCE_INLINE
vshymanskyy 0:58b20b438383 232 bool BlynkProtocol<Transp>::processInput(void)
vshymanskyy 0:58b20b438383 233 {
vshymanskyy 0:58b20b438383 234 BlynkHeader hdr;
vshymanskyy 0:58b20b438383 235 const int ret = readHeader(hdr);
vshymanskyy 0:58b20b438383 236
vshymanskyy 0:58b20b438383 237 if (ret == 0) {
vshymanskyy 0:58b20b438383 238 return true; // Considered OK (no data on input)
vshymanskyy 0:58b20b438383 239 }
vshymanskyy 0:58b20b438383 240
vshymanskyy 0:58b20b438383 241 if (ret < 0 || hdr.msg_id == 0) {
vshymanskyy 0:58b20b438383 242 #ifdef BLYNK_DEBUG
Volodymyr Shymanskyy 3:31e4b850b126 243 BLYNK_LOG2(BLYNK_F("Bad hdr len: "), ret);
vshymanskyy 0:58b20b438383 244 #endif
vshymanskyy 0:58b20b438383 245 return false;
vshymanskyy 0:58b20b438383 246 }
vshymanskyy 0:58b20b438383 247
vshymanskyy 0:58b20b438383 248 if (hdr.type == BLYNK_CMD_RESPONSE) {
Volodymyr Shymanskyy 15:975b60f7a8ff 249 lastActivityIn = BlynkMillis();
vshymanskyy 0:58b20b438383 250
vshymanskyy 0:58b20b438383 251 #ifndef BLYNK_USE_DIRECT_CONNECT
vshymanskyy 0:58b20b438383 252 if (state == CONNECTING && (1 == hdr.msg_id)) {
vshymanskyy 0:58b20b438383 253 switch (hdr.length) {
vshymanskyy 0:58b20b438383 254 case BLYNK_SUCCESS:
Volodymyr Shymanskyy 9:7369ec77a3ea 255 case BLYNK_ALREADY_REGISTERED:
vshymanskyy 0:58b20b438383 256 BLYNK_LOG3(BLYNK_F("Ready (ping: "), lastActivityIn-lastHeartbeat, BLYNK_F("ms)."));
vshymanskyy 0:58b20b438383 257 lastHeartbeat = lastActivityIn;
vshymanskyy 0:58b20b438383 258 state = CONNECTED;
Volodymyr Shymanskyy 18:c328c1a97f90 259 #ifdef BLYNK_DEBUG
Volodymyr Shymanskyy 18:c328c1a97f90 260 if (size_t ram = BlynkFreeRam()) {
Volodymyr Shymanskyy 18:c328c1a97f90 261 BLYNK_LOG2(BLYNK_F("Free RAM: "), ram);
Volodymyr Shymanskyy 18:c328c1a97f90 262 }
Volodymyr Shymanskyy 18:c328c1a97f90 263 #endif
vshymanskyy 0:58b20b438383 264 this->sendInfo();
Volodymyr Shymanskyy 9:7369ec77a3ea 265 BLYNK_RUN_YIELD();
vshymanskyy 0:58b20b438383 266 BlynkOnConnected();
vshymanskyy 0:58b20b438383 267 return true;
vshymanskyy 0:58b20b438383 268 case BLYNK_INVALID_TOKEN:
vshymanskyy 0:58b20b438383 269 BLYNK_LOG1(BLYNK_F("Invalid auth token"));
vshymanskyy 0:58b20b438383 270 break;
vshymanskyy 0:58b20b438383 271 default:
vshymanskyy 0:58b20b438383 272 BLYNK_LOG2(BLYNK_F("Connect failed. code: "), hdr.length);
vshymanskyy 0:58b20b438383 273 }
vshymanskyy 0:58b20b438383 274 return false;
vshymanskyy 0:58b20b438383 275 }
vshymanskyy 0:58b20b438383 276 if (BLYNK_NOT_AUTHENTICATED == hdr.length) {
vshymanskyy 0:58b20b438383 277 return false;
vshymanskyy 0:58b20b438383 278 }
vshymanskyy 0:58b20b438383 279 #endif
vshymanskyy 0:58b20b438383 280 // TODO: return code may indicate App presence
vshymanskyy 0:58b20b438383 281 return true;
vshymanskyy 0:58b20b438383 282 }
vshymanskyy 0:58b20b438383 283
vshymanskyy 0:58b20b438383 284 if (hdr.length > BLYNK_MAX_READBYTES) {
vshymanskyy 0:58b20b438383 285 BLYNK_LOG2(BLYNK_F("Packet too big: "), hdr.length);
Volodymyr Shymanskyy 3:31e4b850b126 286 // TODO: Flush
Volodymyr Shymanskyy 15:975b60f7a8ff 287 internalReconnect();
Volodymyr Shymanskyy 3:31e4b850b126 288 return true;
vshymanskyy 0:58b20b438383 289 }
vshymanskyy 0:58b20b438383 290
vshymanskyy 0:58b20b438383 291 uint8_t inputBuffer[hdr.length+1]; // Add 1 to zero-terminate
vshymanskyy 0:58b20b438383 292 if (hdr.length != conn.read(inputBuffer, hdr.length)) {
Volodymyr Shymanskyy 19:bae78e167b11 293 #ifdef BLYNK_DEBUG
vshymanskyy 0:58b20b438383 294 BLYNK_LOG1(BLYNK_F("Can't read body"));
vshymanskyy 0:58b20b438383 295 #endif
vshymanskyy 0:58b20b438383 296 return false;
vshymanskyy 0:58b20b438383 297 }
vshymanskyy 0:58b20b438383 298 inputBuffer[hdr.length] = '\0';
vshymanskyy 0:58b20b438383 299
vshymanskyy 0:58b20b438383 300 BLYNK_DBG_DUMP(">", inputBuffer, hdr.length);
vshymanskyy 0:58b20b438383 301
Volodymyr Shymanskyy 15:975b60f7a8ff 302 lastActivityIn = BlynkMillis();
vshymanskyy 0:58b20b438383 303
vshymanskyy 0:58b20b438383 304 switch (hdr.type)
vshymanskyy 0:58b20b438383 305 {
Volodymyr Shymanskyy 3:31e4b850b126 306 case BLYNK_CMD_LOGIN: {
vshymanskyy 0:58b20b438383 307 #ifdef BLYNK_USE_DIRECT_CONNECT
Volodymyr Shymanskyy 13:ed6276c0afb7 308 if (strncmp(authkey, (char*)inputBuffer, 32)) {
Volodymyr Shymanskyy 13:ed6276c0afb7 309 BLYNK_LOG1(BLYNK_F("Invalid token"));
Volodymyr Shymanskyy 13:ed6276c0afb7 310 sendCmd(BLYNK_CMD_RESPONSE, hdr.msg_id, NULL, BLYNK_INVALID_TOKEN);
Volodymyr Shymanskyy 13:ed6276c0afb7 311 break;
Volodymyr Shymanskyy 13:ed6276c0afb7 312 }
Volodymyr Shymanskyy 13:ed6276c0afb7 313 #endif
Volodymyr Shymanskyy 13:ed6276c0afb7 314 if (state == CONNECTING) {
Volodymyr Shymanskyy 3:31e4b850b126 315 BLYNK_LOG1(BLYNK_F("Ready"));
vshymanskyy 0:58b20b438383 316 state = CONNECTED;
Volodymyr Shymanskyy 18:c328c1a97f90 317 #ifdef BLYNK_DEBUG
Volodymyr Shymanskyy 18:c328c1a97f90 318 if (size_t ram = BlynkFreeRam()) {
Volodymyr Shymanskyy 18:c328c1a97f90 319 BLYNK_LOG2(BLYNK_F("Free RAM: "), ram);
Volodymyr Shymanskyy 18:c328c1a97f90 320 }
Volodymyr Shymanskyy 18:c328c1a97f90 321 #endif
vshymanskyy 0:58b20b438383 322 this->sendInfo();
Volodymyr Shymanskyy 18:c328c1a97f90 323 BLYNK_RUN_YIELD();
Volodymyr Shymanskyy 3:31e4b850b126 324 BlynkOnConnected();
vshymanskyy 0:58b20b438383 325 }
Volodymyr Shymanskyy 9:7369ec77a3ea 326 sendCmd(BLYNK_CMD_RESPONSE, hdr.msg_id, NULL, BLYNK_SUCCESS);
vshymanskyy 0:58b20b438383 327 } break;
vshymanskyy 0:58b20b438383 328 case BLYNK_CMD_PING: {
vshymanskyy 0:58b20b438383 329 sendCmd(BLYNK_CMD_RESPONSE, hdr.msg_id, NULL, BLYNK_SUCCESS);
vshymanskyy 0:58b20b438383 330 } break;
Volodymyr Shymanskyy 9:7369ec77a3ea 331 case BLYNK_CMD_REDIRECT: {
Volodymyr Shymanskyy 9:7369ec77a3ea 332 if (!redir_serv) {
Volodymyr Shymanskyy 9:7369ec77a3ea 333 redir_serv = (char*)malloc(32);
Volodymyr Shymanskyy 9:7369ec77a3ea 334 }
Volodymyr Shymanskyy 9:7369ec77a3ea 335 BlynkParam param(inputBuffer, hdr.length);
Volodymyr Shymanskyy 9:7369ec77a3ea 336 uint16_t redir_port = BLYNK_DEFAULT_PORT; // TODO: Fixit
Volodymyr Shymanskyy 9:7369ec77a3ea 337
Volodymyr Shymanskyy 9:7369ec77a3ea 338 BlynkParam::iterator it = param.begin();
Volodymyr Shymanskyy 9:7369ec77a3ea 339 if (it >= param.end())
Volodymyr Shymanskyy 9:7369ec77a3ea 340 return false;
Volodymyr Shymanskyy 9:7369ec77a3ea 341 strncpy(redir_serv, it.asStr(), 32);
Volodymyr Shymanskyy 9:7369ec77a3ea 342 if (++it < param.end())
Volodymyr Shymanskyy 9:7369ec77a3ea 343 redir_port = it.asLong();
Volodymyr Shymanskyy 9:7369ec77a3ea 344 BLYNK_LOG4(BLYNK_F("Redirecting to "), redir_serv, ':', redir_port);
Volodymyr Shymanskyy 9:7369ec77a3ea 345 conn.disconnect();
Volodymyr Shymanskyy 9:7369ec77a3ea 346 conn.begin(redir_serv, redir_port);
Volodymyr Shymanskyy 9:7369ec77a3ea 347 state = CONNECTING;
Volodymyr Shymanskyy 21:fd9a3d7ddadb 348 lastHeartbeat = lastActivityIn = lastActivityOut = (BlynkMillis() - 5000UL);
Volodymyr Shymanskyy 9:7369ec77a3ea 349 } break;
vshymanskyy 0:58b20b438383 350 case BLYNK_CMD_HARDWARE:
vshymanskyy 0:58b20b438383 351 case BLYNK_CMD_BRIDGE: {
Volodymyr Shymanskyy 14:76d8fd871a4d 352 msgIdOutOverride = hdr.msg_id;
vshymanskyy 0:58b20b438383 353 this->processCmd(inputBuffer, hdr.length);
Volodymyr Shymanskyy 14:76d8fd871a4d 354 msgIdOutOverride = 0;
vshymanskyy 0:58b20b438383 355 } break;
Volodymyr Shymanskyy 10:c241e4227173 356 case BLYNK_CMD_INTERNAL: {
Volodymyr Shymanskyy 10:c241e4227173 357 BlynkReq req = { 0 };
Volodymyr Shymanskyy 10:c241e4227173 358 BlynkParam param(inputBuffer, hdr.length);
Volodymyr Shymanskyy 10:c241e4227173 359 BlynkParam::iterator it = param.begin();
Volodymyr Shymanskyy 10:c241e4227173 360 if (it >= param.end())
Volodymyr Shymanskyy 10:c241e4227173 361 return true;
Volodymyr Shymanskyy 10:c241e4227173 362
Volodymyr Shymanskyy 10:c241e4227173 363 uint32_t cmd32;
Volodymyr Shymanskyy 10:c241e4227173 364 memcpy(&cmd32, it.asStr(), sizeof(cmd32));
Volodymyr Shymanskyy 10:c241e4227173 365
Volodymyr Shymanskyy 14:76d8fd871a4d 366 ++it;
Volodymyr Shymanskyy 14:76d8fd871a4d 367 char* start = (char*)(it).asStr();
Volodymyr Shymanskyy 14:76d8fd871a4d 368 unsigned length = hdr.length - (start - (char*)inputBuffer);
Volodymyr Shymanskyy 14:76d8fd871a4d 369 BlynkParam param2(start, length);
Volodymyr Shymanskyy 10:c241e4227173 370
Volodymyr Shymanskyy 10:c241e4227173 371 switch (cmd32) {
Volodymyr Shymanskyy 10:c241e4227173 372 case BLYNK_INT_RTC: BlynkWidgetWriteInternalPinRTC(req, param2); break;
Volodymyr Shymanskyy 10:c241e4227173 373 case BLYNK_INT_OTA: BlynkWidgetWriteInternalPinOTA(req, param2); break;
Volodymyr Shymanskyy 10:c241e4227173 374 case BLYNK_INT_ACON: BlynkWidgetWriteInternalPinACON(req, param2); break;
Volodymyr Shymanskyy 10:c241e4227173 375 case BLYNK_INT_ADIS: BlynkWidgetWriteInternalPinADIS(req, param2); break;
Volodymyr Shymanskyy 19:bae78e167b11 376 #ifdef BLYNK_DEBUG
Volodymyr Shymanskyy 14:76d8fd871a4d 377 default: BLYNK_LOG2(BLYNK_F("Invalid internal cmd:"), param.asStr());
Volodymyr Shymanskyy 14:76d8fd871a4d 378 #endif
Volodymyr Shymanskyy 10:c241e4227173 379 }
Volodymyr Shymanskyy 9:7369ec77a3ea 380 } break;
Volodymyr Shymanskyy 9:7369ec77a3ea 381 case BLYNK_CMD_DEBUG_PRINT: {
Volodymyr Shymanskyy 9:7369ec77a3ea 382 if (hdr.length) {
Volodymyr Shymanskyy 9:7369ec77a3ea 383 BLYNK_LOG2(BLYNK_F("Server: "), (char*)inputBuffer);
Volodymyr Shymanskyy 9:7369ec77a3ea 384 }
Volodymyr Shymanskyy 9:7369ec77a3ea 385 } break;
vshymanskyy 0:58b20b438383 386 default: {
vshymanskyy 0:58b20b438383 387 #ifdef BLYNK_DEBUG
vshymanskyy 0:58b20b438383 388 BLYNK_LOG2(BLYNK_F("Invalid header type: "), hdr.type);
vshymanskyy 0:58b20b438383 389 #endif
Volodymyr Shymanskyy 3:31e4b850b126 390 // TODO: Flush
Volodymyr Shymanskyy 15:975b60f7a8ff 391 internalReconnect();
vshymanskyy 0:58b20b438383 392 } break;
vshymanskyy 0:58b20b438383 393 }
vshymanskyy 0:58b20b438383 394
vshymanskyy 0:58b20b438383 395 return true;
vshymanskyy 0:58b20b438383 396 }
vshymanskyy 0:58b20b438383 397
vshymanskyy 0:58b20b438383 398 template <class Transp>
vshymanskyy 0:58b20b438383 399 int BlynkProtocol<Transp>::readHeader(BlynkHeader& hdr)
vshymanskyy 0:58b20b438383 400 {
vshymanskyy 0:58b20b438383 401 size_t rlen = conn.read(&hdr, sizeof(hdr));
vshymanskyy 0:58b20b438383 402 if (rlen == 0) {
vshymanskyy 0:58b20b438383 403 return 0;
vshymanskyy 0:58b20b438383 404 }
vshymanskyy 0:58b20b438383 405
vshymanskyy 0:58b20b438383 406 if (sizeof(hdr) != rlen) {
vshymanskyy 0:58b20b438383 407 return -1;
vshymanskyy 0:58b20b438383 408 }
Volodymyr Shymanskyy 3:31e4b850b126 409
Volodymyr Shymanskyy 3:31e4b850b126 410 BLYNK_DBG_DUMP(">", &hdr, sizeof(BlynkHeader));
Volodymyr Shymanskyy 3:31e4b850b126 411
vshymanskyy 0:58b20b438383 412 hdr.msg_id = ntohs(hdr.msg_id);
vshymanskyy 0:58b20b438383 413 hdr.length = ntohs(hdr.length);
vshymanskyy 0:58b20b438383 414
vshymanskyy 0:58b20b438383 415 return rlen;
vshymanskyy 0:58b20b438383 416 }
vshymanskyy 0:58b20b438383 417
vshymanskyy 0:58b20b438383 418 #ifndef BLYNK_SEND_THROTTLE
vshymanskyy 0:58b20b438383 419 #define BLYNK_SEND_THROTTLE 0
vshymanskyy 0:58b20b438383 420 #endif
vshymanskyy 0:58b20b438383 421
vshymanskyy 0:58b20b438383 422 #ifndef BLYNK_SEND_CHUNK
vshymanskyy 0:58b20b438383 423 #define BLYNK_SEND_CHUNK 1024 // Just a big number
vshymanskyy 0:58b20b438383 424 #endif
vshymanskyy 0:58b20b438383 425
vshymanskyy 0:58b20b438383 426 template <class Transp>
vshymanskyy 0:58b20b438383 427 void BlynkProtocol<Transp>::sendCmd(uint8_t cmd, uint16_t id, const void* data, size_t length, const void* data2, size_t length2)
vshymanskyy 0:58b20b438383 428 {
vshymanskyy 0:58b20b438383 429 if (!conn.connected() || (cmd != BLYNK_CMD_RESPONSE && cmd != BLYNK_CMD_PING && cmd != BLYNK_CMD_LOGIN && state != CONNECTED) ) {
Volodymyr Shymanskyy 19:bae78e167b11 430 #ifdef BLYNK_DEBUG_ALL
vshymanskyy 0:58b20b438383 431 BLYNK_LOG2(BLYNK_F("Cmd skipped:"), cmd);
vshymanskyy 0:58b20b438383 432 #endif
vshymanskyy 0:58b20b438383 433 return;
vshymanskyy 0:58b20b438383 434 }
vshymanskyy 0:58b20b438383 435
Volodymyr Shymanskyy 18:c328c1a97f90 436 if (0 == id) {
Volodymyr Shymanskyy 18:c328c1a97f90 437 id = getNextMsgId();
Volodymyr Shymanskyy 18:c328c1a97f90 438 }
Volodymyr Shymanskyy 18:c328c1a97f90 439
Volodymyr Shymanskyy 18:c328c1a97f90 440 #if defined(BLYNK_MSG_LIMIT) && BLYNK_MSG_LIMIT > 0
Volodymyr Shymanskyy 18:c328c1a97f90 441 if (cmd >= BLYNK_CMD_TWEET && cmd <= BLYNK_CMD_HARDWARE) {
Volodymyr Shymanskyy 18:c328c1a97f90 442 const millis_time_t allowed_time = BlynkMax(lastActivityOut, lastActivityIn) + 1000/BLYNK_MSG_LIMIT;
Volodymyr Shymanskyy 18:c328c1a97f90 443 long wait_time = allowed_time - BlynkMillis();
Volodymyr Shymanskyy 18:c328c1a97f90 444 if (wait_time >= 0) {
Volodymyr Shymanskyy 19:bae78e167b11 445 #ifdef BLYNK_DEBUG_ALL
Volodymyr Shymanskyy 18:c328c1a97f90 446 BLYNK_LOG2(BLYNK_F("Waiting:"), wait_time);
Volodymyr Shymanskyy 18:c328c1a97f90 447 #endif
Volodymyr Shymanskyy 18:c328c1a97f90 448 while (wait_time >= 0) {
Volodymyr Shymanskyy 18:c328c1a97f90 449 run();
Volodymyr Shymanskyy 18:c328c1a97f90 450 wait_time = allowed_time - BlynkMillis();
Volodymyr Shymanskyy 18:c328c1a97f90 451 }
Volodymyr Shymanskyy 19:bae78e167b11 452 } else if (nesting == 0) {
Volodymyr Shymanskyy 19:bae78e167b11 453 run();
Volodymyr Shymanskyy 18:c328c1a97f90 454 }
Volodymyr Shymanskyy 18:c328c1a97f90 455 }
Volodymyr Shymanskyy 18:c328c1a97f90 456 #endif
Volodymyr Shymanskyy 18:c328c1a97f90 457
Volodymyr Shymanskyy 7:8879692d4e6c 458 const size_t full_length = (sizeof(BlynkHeader)) +
Volodymyr Shymanskyy 7:8879692d4e6c 459 (data ? length : 0) +
Volodymyr Shymanskyy 7:8879692d4e6c 460 (data2 ? length2 : 0);
vshymanskyy 0:58b20b438383 461
Volodymyr Shymanskyy 19:bae78e167b11 462 #if defined(BLYNK_SEND_ATOMIC) || defined(ESP8266) || defined(ESP32) || defined(SPARK) || defined(PARTICLE) || defined(ENERGIA)
vshymanskyy 0:58b20b438383 463 // Those have more RAM and like single write at a time...
vshymanskyy 0:58b20b438383 464
vshymanskyy 0:58b20b438383 465 uint8_t buff[full_length];
vshymanskyy 0:58b20b438383 466
vshymanskyy 0:58b20b438383 467 BlynkHeader* hdr = (BlynkHeader*)buff;
vshymanskyy 0:58b20b438383 468 hdr->type = cmd;
vshymanskyy 0:58b20b438383 469 hdr->msg_id = htons(id);
vshymanskyy 0:58b20b438383 470 hdr->length = htons(length+length2);
vshymanskyy 0:58b20b438383 471
vshymanskyy 0:58b20b438383 472 size_t pos = sizeof(BlynkHeader);
vshymanskyy 0:58b20b438383 473 if (data && length) {
vshymanskyy 0:58b20b438383 474 memcpy(buff + pos, data, length);
vshymanskyy 0:58b20b438383 475 pos += length;
vshymanskyy 0:58b20b438383 476 }
vshymanskyy 0:58b20b438383 477 if (data2 && length2) {
vshymanskyy 0:58b20b438383 478 memcpy(buff + pos, data2, length2);
vshymanskyy 0:58b20b438383 479 }
vshymanskyy 0:58b20b438383 480
vshymanskyy 0:58b20b438383 481 size_t wlen = 0;
vshymanskyy 0:58b20b438383 482 while (wlen < full_length) {
vshymanskyy 0:58b20b438383 483 const size_t chunk = BlynkMin(size_t(BLYNK_SEND_CHUNK), full_length - wlen);
Volodymyr Shymanskyy 9:7369ec77a3ea 484 BLYNK_DBG_DUMP("<", buff + wlen, chunk);
vshymanskyy 0:58b20b438383 485 const size_t w = conn.write(buff + wlen, chunk);
Volodymyr Shymanskyy 15:975b60f7a8ff 486 BlynkDelay(BLYNK_SEND_THROTTLE);
Volodymyr Shymanskyy 9:7369ec77a3ea 487 if (w == 0) {
vshymanskyy 0:58b20b438383 488 #ifdef BLYNK_DEBUG
vshymanskyy 0:58b20b438383 489 BLYNK_LOG1(BLYNK_F("Cmd error"));
vshymanskyy 0:58b20b438383 490 #endif
vshymanskyy 0:58b20b438383 491 conn.disconnect();
vshymanskyy 0:58b20b438383 492 state = CONNECTING;
Volodymyr Shymanskyy 15:975b60f7a8ff 493 BlynkOnDisconnected();
vshymanskyy 0:58b20b438383 494 return;
Volodymyr Shymanskyy 9:7369ec77a3ea 495 }
vshymanskyy 0:58b20b438383 496 wlen += w;
vshymanskyy 0:58b20b438383 497 }
vshymanskyy 0:58b20b438383 498
vshymanskyy 0:58b20b438383 499 #else
vshymanskyy 0:58b20b438383 500
vshymanskyy 0:58b20b438383 501 BlynkHeader hdr;
vshymanskyy 0:58b20b438383 502 hdr.type = cmd;
vshymanskyy 0:58b20b438383 503 hdr.msg_id = htons(id);
vshymanskyy 0:58b20b438383 504 hdr.length = htons(length+length2);
vshymanskyy 0:58b20b438383 505
Volodymyr Shymanskyy 9:7369ec77a3ea 506 BLYNK_DBG_DUMP("<", &hdr, sizeof(hdr));
vshymanskyy 0:58b20b438383 507 size_t wlen = conn.write(&hdr, sizeof(hdr));
Volodymyr Shymanskyy 15:975b60f7a8ff 508 BlynkDelay(BLYNK_SEND_THROTTLE);
vshymanskyy 0:58b20b438383 509
vshymanskyy 0:58b20b438383 510 if (cmd != BLYNK_CMD_RESPONSE) {
vshymanskyy 0:58b20b438383 511 if (length) {
vshymanskyy 0:58b20b438383 512 BLYNK_DBG_DUMP("<", data, length);
vshymanskyy 0:58b20b438383 513 wlen += conn.write(data, length);
Volodymyr Shymanskyy 15:975b60f7a8ff 514 BlynkDelay(BLYNK_SEND_THROTTLE);
vshymanskyy 0:58b20b438383 515 }
vshymanskyy 0:58b20b438383 516 if (length2) {
vshymanskyy 0:58b20b438383 517 BLYNK_DBG_DUMP("<", data2, length2);
vshymanskyy 0:58b20b438383 518 wlen += conn.write(data2, length2);
Volodymyr Shymanskyy 15:975b60f7a8ff 519 BlynkDelay(BLYNK_SEND_THROTTLE);
vshymanskyy 0:58b20b438383 520 }
vshymanskyy 0:58b20b438383 521 }
vshymanskyy 0:58b20b438383 522
vshymanskyy 0:58b20b438383 523 #endif
vshymanskyy 0:58b20b438383 524
vshymanskyy 0:58b20b438383 525 if (wlen != full_length) {
vshymanskyy 0:58b20b438383 526 #ifdef BLYNK_DEBUG
vshymanskyy 0:58b20b438383 527 BLYNK_LOG4(BLYNK_F("Sent "), wlen, '/', full_length);
vshymanskyy 0:58b20b438383 528 #endif
Volodymyr Shymanskyy 14:76d8fd871a4d 529 internalReconnect();
vshymanskyy 0:58b20b438383 530 return;
vshymanskyy 0:58b20b438383 531 }
vshymanskyy 0:58b20b438383 532
Volodymyr Shymanskyy 18:c328c1a97f90 533 lastActivityOut = BlynkMillis();
vshymanskyy 0:58b20b438383 534
vshymanskyy 0:58b20b438383 535 }
vshymanskyy 0:58b20b438383 536
vshymanskyy 0:58b20b438383 537 template <class Transp>
vshymanskyy 0:58b20b438383 538 uint16_t BlynkProtocol<Transp>::getNextMsgId()
vshymanskyy 0:58b20b438383 539 {
Volodymyr Shymanskyy 14:76d8fd871a4d 540 if (msgIdOutOverride != 0)
Volodymyr Shymanskyy 14:76d8fd871a4d 541 return msgIdOutOverride;
Volodymyr Shymanskyy 14:76d8fd871a4d 542 if (++msgIdOut == 0)
Volodymyr Shymanskyy 14:76d8fd871a4d 543 msgIdOut = 1;
Volodymyr Shymanskyy 14:76d8fd871a4d 544 return msgIdOut;
vshymanskyy 0:58b20b438383 545 }
vshymanskyy 0:58b20b438383 546
vshymanskyy 0:58b20b438383 547 #endif