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@19:bae78e167b11, 2017-12-15 (annotated)

Committer:
Volodymyr Shymanskyy
Date:
Fri Dec 15 00:17:41 2017 +0200
Revision:
19:bae78e167b11
Parent:
18:c328c1a97f90
Child:
21:fd9a3d7ddadb
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
vshymanskyy 0:58b20b438383 156 const bool tconn = conn.connected();
vshymanskyy 0:58b20b438383 157
vshymanskyy 0:58b20b438383 158 if (tconn) {
Volodymyr Shymanskyy 18:c328c1a97f90 159 while (avail || conn.available() > 0) {
vshymanskyy 0:58b20b438383 160 //BLYNK_LOG2(BLYNK_F("Available: "), conn.available());
vshymanskyy 0:58b20b438383 161 //const unsigned long t = micros();
vshymanskyy 0:58b20b438383 162 if (!processInput()) {
vshymanskyy 0:58b20b438383 163 conn.disconnect();
vshymanskyy 0:58b20b438383 164 // TODO: Only when in direct mode?
vshymanskyy 0:58b20b438383 165 #ifdef BLYNK_USE_DIRECT_CONNECT
vshymanskyy 0:58b20b438383 166 state = CONNECTING;
vshymanskyy 0:58b20b438383 167 #endif
Volodymyr Shymanskyy 14:76d8fd871a4d 168 BlynkOnDisconnected();
vshymanskyy 0:58b20b438383 169 return false;
vshymanskyy 0:58b20b438383 170 }
Volodymyr Shymanskyy 18:c328c1a97f90 171 avail = false;
vshymanskyy 0:58b20b438383 172 //BLYNK_LOG2(BLYNK_F("Proc time: "), micros() - t);
vshymanskyy 0:58b20b438383 173 }
vshymanskyy 0:58b20b438383 174 }
vshymanskyy 0:58b20b438383 175
Volodymyr Shymanskyy 15:975b60f7a8ff 176 const millis_time_t t = BlynkMillis();
vshymanskyy 0:58b20b438383 177
vshymanskyy 0:58b20b438383 178 if (state == CONNECTED) {
vshymanskyy 0:58b20b438383 179 if (!tconn) {
vshymanskyy 0:58b20b438383 180 lastHeartbeat = t;
Volodymyr Shymanskyy 14:76d8fd871a4d 181 internalReconnect();
vshymanskyy 0:58b20b438383 182 return false;
vshymanskyy 0:58b20b438383 183 }
vshymanskyy 0:58b20b438383 184
vshymanskyy 0:58b20b438383 185 if (t - lastActivityIn > (1000UL * BLYNK_HEARTBEAT + BLYNK_TIMEOUT_MS*3)) {
vshymanskyy 0:58b20b438383 186 #ifdef BLYNK_DEBUG
vshymanskyy 0:58b20b438383 187 BLYNK_LOG6(BLYNK_F("Heartbeat timeout: "), t, BLYNK_F(", "), lastActivityIn, BLYNK_F(", "), lastHeartbeat);
vshymanskyy 0:58b20b438383 188 #else
vshymanskyy 0:58b20b438383 189 BLYNK_LOG1(BLYNK_F("Heartbeat timeout"));
vshymanskyy 0:58b20b438383 190 #endif
Volodymyr Shymanskyy 14:76d8fd871a4d 191 internalReconnect();
vshymanskyy 0:58b20b438383 192 return false;
vshymanskyy 0:58b20b438383 193 } else if ((t - lastActivityIn > 1000UL * BLYNK_HEARTBEAT ||
vshymanskyy 0:58b20b438383 194 t - lastActivityOut > 1000UL * BLYNK_HEARTBEAT) &&
vshymanskyy 0:58b20b438383 195 t - lastHeartbeat > BLYNK_TIMEOUT_MS)
vshymanskyy 0:58b20b438383 196 {
vshymanskyy 0:58b20b438383 197 // Send ping if we didn't either send or receive something
vshymanskyy 0:58b20b438383 198 // for BLYNK_HEARTBEAT seconds
vshymanskyy 0:58b20b438383 199 sendCmd(BLYNK_CMD_PING);
vshymanskyy 0:58b20b438383 200 lastHeartbeat = t;
vshymanskyy 0:58b20b438383 201 }
vshymanskyy 0:58b20b438383 202 } else if (state == CONNECTING) {
Volodymyr Shymanskyy 9:7369ec77a3ea 203 #ifdef BLYNK_USE_DIRECT_CONNECT
Volodymyr Shymanskyy 9:7369ec77a3ea 204 if (!tconn)
Volodymyr Shymanskyy 9:7369ec77a3ea 205 conn.connect();
Volodymyr Shymanskyy 9:7369ec77a3ea 206 #else
vshymanskyy 0:58b20b438383 207 if (tconn && (t - lastLogin > BLYNK_TIMEOUT_MS)) {
vshymanskyy 0:58b20b438383 208 BLYNK_LOG1(BLYNK_F("Login timeout"));
vshymanskyy 0:58b20b438383 209 conn.disconnect();
vshymanskyy 0:58b20b438383 210 state = CONNECTING;
vshymanskyy 0:58b20b438383 211 return false;
vshymanskyy 0:58b20b438383 212 } else if (!tconn && (t - lastLogin > 5000UL)) {
vshymanskyy 0:58b20b438383 213 conn.disconnect();
vshymanskyy 0:58b20b438383 214 if (!conn.connect()) {
vshymanskyy 0:58b20b438383 215 lastLogin = t;
vshymanskyy 0:58b20b438383 216 return false;
vshymanskyy 0:58b20b438383 217 }
vshymanskyy 0:58b20b438383 218
Volodymyr Shymanskyy 14:76d8fd871a4d 219 msgIdOut = 1;
vshymanskyy 0:58b20b438383 220 sendCmd(BLYNK_CMD_LOGIN, 1, authkey, strlen(authkey));
vshymanskyy 0:58b20b438383 221 lastLogin = lastActivityOut;
vshymanskyy 0:58b20b438383 222 return true;
vshymanskyy 0:58b20b438383 223 }
vshymanskyy 0:58b20b438383 224 #endif
vshymanskyy 0:58b20b438383 225 }
vshymanskyy 0:58b20b438383 226 return true;
vshymanskyy 0:58b20b438383 227 }
vshymanskyy 0:58b20b438383 228
vshymanskyy 0:58b20b438383 229 template <class Transp>
vshymanskyy 0:58b20b438383 230 BLYNK_FORCE_INLINE
vshymanskyy 0:58b20b438383 231 bool BlynkProtocol<Transp>::processInput(void)
vshymanskyy 0:58b20b438383 232 {
vshymanskyy 0:58b20b438383 233 BlynkHeader hdr;
vshymanskyy 0:58b20b438383 234 const int ret = readHeader(hdr);
vshymanskyy 0:58b20b438383 235
vshymanskyy 0:58b20b438383 236 if (ret == 0) {
vshymanskyy 0:58b20b438383 237 return true; // Considered OK (no data on input)
vshymanskyy 0:58b20b438383 238 }
vshymanskyy 0:58b20b438383 239
vshymanskyy 0:58b20b438383 240 if (ret < 0 || hdr.msg_id == 0) {
vshymanskyy 0:58b20b438383 241 #ifdef BLYNK_DEBUG
Volodymyr Shymanskyy 3:31e4b850b126 242 BLYNK_LOG2(BLYNK_F("Bad hdr len: "), ret);
vshymanskyy 0:58b20b438383 243 #endif
vshymanskyy 0:58b20b438383 244 return false;
vshymanskyy 0:58b20b438383 245 }
vshymanskyy 0:58b20b438383 246
vshymanskyy 0:58b20b438383 247 if (hdr.type == BLYNK_CMD_RESPONSE) {
Volodymyr Shymanskyy 15:975b60f7a8ff 248 lastActivityIn = BlynkMillis();
vshymanskyy 0:58b20b438383 249
vshymanskyy 0:58b20b438383 250 #ifndef BLYNK_USE_DIRECT_CONNECT
vshymanskyy 0:58b20b438383 251 if (state == CONNECTING && (1 == hdr.msg_id)) {
vshymanskyy 0:58b20b438383 252 switch (hdr.length) {
vshymanskyy 0:58b20b438383 253 case BLYNK_SUCCESS:
Volodymyr Shymanskyy 9:7369ec77a3ea 254 case BLYNK_ALREADY_REGISTERED:
vshymanskyy 0:58b20b438383 255 BLYNK_LOG3(BLYNK_F("Ready (ping: "), lastActivityIn-lastHeartbeat, BLYNK_F("ms)."));
vshymanskyy 0:58b20b438383 256 lastHeartbeat = lastActivityIn;
vshymanskyy 0:58b20b438383 257 state = CONNECTED;
Volodymyr Shymanskyy 18:c328c1a97f90 258 #ifdef BLYNK_DEBUG
Volodymyr Shymanskyy 18:c328c1a97f90 259 if (size_t ram = BlynkFreeRam()) {
Volodymyr Shymanskyy 18:c328c1a97f90 260 BLYNK_LOG2(BLYNK_F("Free RAM: "), ram);
Volodymyr Shymanskyy 18:c328c1a97f90 261 }
Volodymyr Shymanskyy 18:c328c1a97f90 262 #endif
vshymanskyy 0:58b20b438383 263 this->sendInfo();
Volodymyr Shymanskyy 9:7369ec77a3ea 264 BLYNK_RUN_YIELD();
vshymanskyy 0:58b20b438383 265 BlynkOnConnected();
vshymanskyy 0:58b20b438383 266 return true;
vshymanskyy 0:58b20b438383 267 case BLYNK_INVALID_TOKEN:
vshymanskyy 0:58b20b438383 268 BLYNK_LOG1(BLYNK_F("Invalid auth token"));
vshymanskyy 0:58b20b438383 269 break;
vshymanskyy 0:58b20b438383 270 default:
vshymanskyy 0:58b20b438383 271 BLYNK_LOG2(BLYNK_F("Connect failed. code: "), hdr.length);
vshymanskyy 0:58b20b438383 272 }
vshymanskyy 0:58b20b438383 273 return false;
vshymanskyy 0:58b20b438383 274 }
vshymanskyy 0:58b20b438383 275 if (BLYNK_NOT_AUTHENTICATED == hdr.length) {
vshymanskyy 0:58b20b438383 276 return false;
vshymanskyy 0:58b20b438383 277 }
vshymanskyy 0:58b20b438383 278 #endif
vshymanskyy 0:58b20b438383 279 // TODO: return code may indicate App presence
vshymanskyy 0:58b20b438383 280 return true;
vshymanskyy 0:58b20b438383 281 }
vshymanskyy 0:58b20b438383 282
vshymanskyy 0:58b20b438383 283 if (hdr.length > BLYNK_MAX_READBYTES) {
vshymanskyy 0:58b20b438383 284 BLYNK_LOG2(BLYNK_F("Packet too big: "), hdr.length);
Volodymyr Shymanskyy 3:31e4b850b126 285 // TODO: Flush
Volodymyr Shymanskyy 15:975b60f7a8ff 286 internalReconnect();
Volodymyr Shymanskyy 3:31e4b850b126 287 return true;
vshymanskyy 0:58b20b438383 288 }
vshymanskyy 0:58b20b438383 289
vshymanskyy 0:58b20b438383 290 uint8_t inputBuffer[hdr.length+1]; // Add 1 to zero-terminate
vshymanskyy 0:58b20b438383 291 if (hdr.length != conn.read(inputBuffer, hdr.length)) {
Volodymyr Shymanskyy 19:bae78e167b11 292 #ifdef BLYNK_DEBUG
vshymanskyy 0:58b20b438383 293 BLYNK_LOG1(BLYNK_F("Can't read body"));
vshymanskyy 0:58b20b438383 294 #endif
vshymanskyy 0:58b20b438383 295 return false;
vshymanskyy 0:58b20b438383 296 }
vshymanskyy 0:58b20b438383 297 inputBuffer[hdr.length] = '\0';
vshymanskyy 0:58b20b438383 298
vshymanskyy 0:58b20b438383 299 BLYNK_DBG_DUMP(">", inputBuffer, hdr.length);
vshymanskyy 0:58b20b438383 300
Volodymyr Shymanskyy 15:975b60f7a8ff 301 lastActivityIn = BlynkMillis();
vshymanskyy 0:58b20b438383 302
vshymanskyy 0:58b20b438383 303 switch (hdr.type)
vshymanskyy 0:58b20b438383 304 {
Volodymyr Shymanskyy 3:31e4b850b126 305 case BLYNK_CMD_LOGIN: {
vshymanskyy 0:58b20b438383 306 #ifdef BLYNK_USE_DIRECT_CONNECT
Volodymyr Shymanskyy 13:ed6276c0afb7 307 if (strncmp(authkey, (char*)inputBuffer, 32)) {
Volodymyr Shymanskyy 13:ed6276c0afb7 308 BLYNK_LOG1(BLYNK_F("Invalid token"));
Volodymyr Shymanskyy 13:ed6276c0afb7 309 sendCmd(BLYNK_CMD_RESPONSE, hdr.msg_id, NULL, BLYNK_INVALID_TOKEN);
Volodymyr Shymanskyy 13:ed6276c0afb7 310 break;
Volodymyr Shymanskyy 13:ed6276c0afb7 311 }
Volodymyr Shymanskyy 13:ed6276c0afb7 312 #endif
Volodymyr Shymanskyy 13:ed6276c0afb7 313 if (state == CONNECTING) {
Volodymyr Shymanskyy 3:31e4b850b126 314 BLYNK_LOG1(BLYNK_F("Ready"));
vshymanskyy 0:58b20b438383 315 state = CONNECTED;
Volodymyr Shymanskyy 18:c328c1a97f90 316 #ifdef BLYNK_DEBUG
Volodymyr Shymanskyy 18:c328c1a97f90 317 if (size_t ram = BlynkFreeRam()) {
Volodymyr Shymanskyy 18:c328c1a97f90 318 BLYNK_LOG2(BLYNK_F("Free RAM: "), ram);
Volodymyr Shymanskyy 18:c328c1a97f90 319 }
Volodymyr Shymanskyy 18:c328c1a97f90 320 #endif
vshymanskyy 0:58b20b438383 321 this->sendInfo();
Volodymyr Shymanskyy 18:c328c1a97f90 322 BLYNK_RUN_YIELD();
Volodymyr Shymanskyy 3:31e4b850b126 323 BlynkOnConnected();
vshymanskyy 0:58b20b438383 324 }
Volodymyr Shymanskyy 9:7369ec77a3ea 325 sendCmd(BLYNK_CMD_RESPONSE, hdr.msg_id, NULL, BLYNK_SUCCESS);
vshymanskyy 0:58b20b438383 326 } break;
vshymanskyy 0:58b20b438383 327 case BLYNK_CMD_PING: {
vshymanskyy 0:58b20b438383 328 sendCmd(BLYNK_CMD_RESPONSE, hdr.msg_id, NULL, BLYNK_SUCCESS);
vshymanskyy 0:58b20b438383 329 } break;
Volodymyr Shymanskyy 9:7369ec77a3ea 330 case BLYNK_CMD_REDIRECT: {
Volodymyr Shymanskyy 9:7369ec77a3ea 331 if (!redir_serv) {
Volodymyr Shymanskyy 9:7369ec77a3ea 332 redir_serv = (char*)malloc(32);
Volodymyr Shymanskyy 9:7369ec77a3ea 333 }
Volodymyr Shymanskyy 9:7369ec77a3ea 334 BlynkParam param(inputBuffer, hdr.length);
Volodymyr Shymanskyy 9:7369ec77a3ea 335 uint16_t redir_port = BLYNK_DEFAULT_PORT; // TODO: Fixit
Volodymyr Shymanskyy 9:7369ec77a3ea 336
Volodymyr Shymanskyy 9:7369ec77a3ea 337 BlynkParam::iterator it = param.begin();
Volodymyr Shymanskyy 9:7369ec77a3ea 338 if (it >= param.end())
Volodymyr Shymanskyy 9:7369ec77a3ea 339 return false;
Volodymyr Shymanskyy 9:7369ec77a3ea 340 strncpy(redir_serv, it.asStr(), 32);
Volodymyr Shymanskyy 9:7369ec77a3ea 341 if (++it < param.end())
Volodymyr Shymanskyy 9:7369ec77a3ea 342 redir_port = it.asLong();
Volodymyr Shymanskyy 9:7369ec77a3ea 343 BLYNK_LOG4(BLYNK_F("Redirecting to "), redir_serv, ':', redir_port);
Volodymyr Shymanskyy 9:7369ec77a3ea 344 conn.disconnect();
Volodymyr Shymanskyy 9:7369ec77a3ea 345 conn.begin(redir_serv, redir_port);
Volodymyr Shymanskyy 9:7369ec77a3ea 346 lastLogin = lastActivityIn - 5000L; // Reconnect immediately
Volodymyr Shymanskyy 9:7369ec77a3ea 347 state = CONNECTING;
Volodymyr Shymanskyy 9:7369ec77a3ea 348 } break;
vshymanskyy 0:58b20b438383 349 case BLYNK_CMD_HARDWARE:
vshymanskyy 0:58b20b438383 350 case BLYNK_CMD_BRIDGE: {
Volodymyr Shymanskyy 14:76d8fd871a4d 351 msgIdOutOverride = hdr.msg_id;
vshymanskyy 0:58b20b438383 352 this->processCmd(inputBuffer, hdr.length);
Volodymyr Shymanskyy 14:76d8fd871a4d 353 msgIdOutOverride = 0;
vshymanskyy 0:58b20b438383 354 } break;
Volodymyr Shymanskyy 10:c241e4227173 355 case BLYNK_CMD_INTERNAL: {
Volodymyr Shymanskyy 10:c241e4227173 356 BlynkReq req = { 0 };
Volodymyr Shymanskyy 10:c241e4227173 357 BlynkParam param(inputBuffer, hdr.length);
Volodymyr Shymanskyy 10:c241e4227173 358 BlynkParam::iterator it = param.begin();
Volodymyr Shymanskyy 10:c241e4227173 359 if (it >= param.end())
Volodymyr Shymanskyy 10:c241e4227173 360 return true;
Volodymyr Shymanskyy 10:c241e4227173 361
Volodymyr Shymanskyy 10:c241e4227173 362 uint32_t cmd32;
Volodymyr Shymanskyy 10:c241e4227173 363 memcpy(&cmd32, it.asStr(), sizeof(cmd32));
Volodymyr Shymanskyy 10:c241e4227173 364
Volodymyr Shymanskyy 14:76d8fd871a4d 365 ++it;
Volodymyr Shymanskyy 14:76d8fd871a4d 366 char* start = (char*)(it).asStr();
Volodymyr Shymanskyy 14:76d8fd871a4d 367 unsigned length = hdr.length - (start - (char*)inputBuffer);
Volodymyr Shymanskyy 14:76d8fd871a4d 368 BlynkParam param2(start, length);
Volodymyr Shymanskyy 10:c241e4227173 369
Volodymyr Shymanskyy 10:c241e4227173 370 switch (cmd32) {
Volodymyr Shymanskyy 10:c241e4227173 371 case BLYNK_INT_RTC: BlynkWidgetWriteInternalPinRTC(req, param2); break;
Volodymyr Shymanskyy 10:c241e4227173 372 case BLYNK_INT_OTA: BlynkWidgetWriteInternalPinOTA(req, param2); break;
Volodymyr Shymanskyy 10:c241e4227173 373 case BLYNK_INT_ACON: BlynkWidgetWriteInternalPinACON(req, param2); break;
Volodymyr Shymanskyy 10:c241e4227173 374 case BLYNK_INT_ADIS: BlynkWidgetWriteInternalPinADIS(req, param2); break;
Volodymyr Shymanskyy 19:bae78e167b11 375 #ifdef BLYNK_DEBUG
Volodymyr Shymanskyy 14:76d8fd871a4d 376 default: BLYNK_LOG2(BLYNK_F("Invalid internal cmd:"), param.asStr());
Volodymyr Shymanskyy 14:76d8fd871a4d 377 #endif
Volodymyr Shymanskyy 10:c241e4227173 378 }
Volodymyr Shymanskyy 9:7369ec77a3ea 379 } break;
Volodymyr Shymanskyy 9:7369ec77a3ea 380 case BLYNK_CMD_DEBUG_PRINT: {
Volodymyr Shymanskyy 9:7369ec77a3ea 381 if (hdr.length) {
Volodymyr Shymanskyy 9:7369ec77a3ea 382 BLYNK_LOG2(BLYNK_F("Server: "), (char*)inputBuffer);
Volodymyr Shymanskyy 9:7369ec77a3ea 383 }
Volodymyr Shymanskyy 9:7369ec77a3ea 384 } break;
vshymanskyy 0:58b20b438383 385 default: {
vshymanskyy 0:58b20b438383 386 #ifdef BLYNK_DEBUG
vshymanskyy 0:58b20b438383 387 BLYNK_LOG2(BLYNK_F("Invalid header type: "), hdr.type);
vshymanskyy 0:58b20b438383 388 #endif
Volodymyr Shymanskyy 3:31e4b850b126 389 // TODO: Flush
Volodymyr Shymanskyy 15:975b60f7a8ff 390 internalReconnect();
vshymanskyy 0:58b20b438383 391 } break;
vshymanskyy 0:58b20b438383 392 }
vshymanskyy 0:58b20b438383 393
vshymanskyy 0:58b20b438383 394 return true;
vshymanskyy 0:58b20b438383 395 }
vshymanskyy 0:58b20b438383 396
vshymanskyy 0:58b20b438383 397 template <class Transp>
vshymanskyy 0:58b20b438383 398 int BlynkProtocol<Transp>::readHeader(BlynkHeader& hdr)
vshymanskyy 0:58b20b438383 399 {
vshymanskyy 0:58b20b438383 400 size_t rlen = conn.read(&hdr, sizeof(hdr));
vshymanskyy 0:58b20b438383 401 if (rlen == 0) {
vshymanskyy 0:58b20b438383 402 return 0;
vshymanskyy 0:58b20b438383 403 }
vshymanskyy 0:58b20b438383 404
vshymanskyy 0:58b20b438383 405 if (sizeof(hdr) != rlen) {
vshymanskyy 0:58b20b438383 406 return -1;
vshymanskyy 0:58b20b438383 407 }
Volodymyr Shymanskyy 3:31e4b850b126 408
Volodymyr Shymanskyy 3:31e4b850b126 409 BLYNK_DBG_DUMP(">", &hdr, sizeof(BlynkHeader));
Volodymyr Shymanskyy 3:31e4b850b126 410
vshymanskyy 0:58b20b438383 411 hdr.msg_id = ntohs(hdr.msg_id);
vshymanskyy 0:58b20b438383 412 hdr.length = ntohs(hdr.length);
vshymanskyy 0:58b20b438383 413
vshymanskyy 0:58b20b438383 414 return rlen;
vshymanskyy 0:58b20b438383 415 }
vshymanskyy 0:58b20b438383 416
vshymanskyy 0:58b20b438383 417 #ifndef BLYNK_SEND_THROTTLE
vshymanskyy 0:58b20b438383 418 #define BLYNK_SEND_THROTTLE 0
vshymanskyy 0:58b20b438383 419 #endif
vshymanskyy 0:58b20b438383 420
vshymanskyy 0:58b20b438383 421 #ifndef BLYNK_SEND_CHUNK
vshymanskyy 0:58b20b438383 422 #define BLYNK_SEND_CHUNK 1024 // Just a big number
vshymanskyy 0:58b20b438383 423 #endif
vshymanskyy 0:58b20b438383 424
vshymanskyy 0:58b20b438383 425 template <class Transp>
vshymanskyy 0:58b20b438383 426 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 427 {
vshymanskyy 0:58b20b438383 428 if (!conn.connected() || (cmd != BLYNK_CMD_RESPONSE && cmd != BLYNK_CMD_PING && cmd != BLYNK_CMD_LOGIN && state != CONNECTED) ) {
Volodymyr Shymanskyy 19:bae78e167b11 429 #ifdef BLYNK_DEBUG_ALL
vshymanskyy 0:58b20b438383 430 BLYNK_LOG2(BLYNK_F("Cmd skipped:"), cmd);
vshymanskyy 0:58b20b438383 431 #endif
vshymanskyy 0:58b20b438383 432 return;
vshymanskyy 0:58b20b438383 433 }
vshymanskyy 0:58b20b438383 434
Volodymyr Shymanskyy 18:c328c1a97f90 435 if (0 == id) {
Volodymyr Shymanskyy 18:c328c1a97f90 436 id = getNextMsgId();
Volodymyr Shymanskyy 18:c328c1a97f90 437 }
Volodymyr Shymanskyy 18:c328c1a97f90 438
Volodymyr Shymanskyy 18:c328c1a97f90 439 #if defined(BLYNK_MSG_LIMIT) && BLYNK_MSG_LIMIT > 0
Volodymyr Shymanskyy 18:c328c1a97f90 440 if (cmd >= BLYNK_CMD_TWEET && cmd <= BLYNK_CMD_HARDWARE) {
Volodymyr Shymanskyy 18:c328c1a97f90 441 const millis_time_t allowed_time = BlynkMax(lastActivityOut, lastActivityIn) + 1000/BLYNK_MSG_LIMIT;
Volodymyr Shymanskyy 18:c328c1a97f90 442 long wait_time = allowed_time - BlynkMillis();
Volodymyr Shymanskyy 18:c328c1a97f90 443 if (wait_time >= 0) {
Volodymyr Shymanskyy 19:bae78e167b11 444 #ifdef BLYNK_DEBUG_ALL
Volodymyr Shymanskyy 18:c328c1a97f90 445 BLYNK_LOG2(BLYNK_F("Waiting:"), wait_time);
Volodymyr Shymanskyy 18:c328c1a97f90 446 #endif
Volodymyr Shymanskyy 18:c328c1a97f90 447 while (wait_time >= 0) {
Volodymyr Shymanskyy 18:c328c1a97f90 448 run();
Volodymyr Shymanskyy 18:c328c1a97f90 449 wait_time = allowed_time - BlynkMillis();
Volodymyr Shymanskyy 18:c328c1a97f90 450 }
Volodymyr Shymanskyy 19:bae78e167b11 451 } else if (nesting == 0) {
Volodymyr Shymanskyy 19:bae78e167b11 452 run();
Volodymyr Shymanskyy 18:c328c1a97f90 453 }
Volodymyr Shymanskyy 18:c328c1a97f90 454 }
Volodymyr Shymanskyy 18:c328c1a97f90 455 #endif
Volodymyr Shymanskyy 18:c328c1a97f90 456
Volodymyr Shymanskyy 7:8879692d4e6c 457 const size_t full_length = (sizeof(BlynkHeader)) +
Volodymyr Shymanskyy 7:8879692d4e6c 458 (data ? length : 0) +
Volodymyr Shymanskyy 7:8879692d4e6c 459 (data2 ? length2 : 0);
vshymanskyy 0:58b20b438383 460
Volodymyr Shymanskyy 19:bae78e167b11 461 #if defined(BLYNK_SEND_ATOMIC) || defined(ESP8266) || defined(ESP32) || defined(SPARK) || defined(PARTICLE) || defined(ENERGIA)
vshymanskyy 0:58b20b438383 462 // Those have more RAM and like single write at a time...
vshymanskyy 0:58b20b438383 463
vshymanskyy 0:58b20b438383 464 uint8_t buff[full_length];
vshymanskyy 0:58b20b438383 465
vshymanskyy 0:58b20b438383 466 BlynkHeader* hdr = (BlynkHeader*)buff;
vshymanskyy 0:58b20b438383 467 hdr->type = cmd;
vshymanskyy 0:58b20b438383 468 hdr->msg_id = htons(id);
vshymanskyy 0:58b20b438383 469 hdr->length = htons(length+length2);
vshymanskyy 0:58b20b438383 470
vshymanskyy 0:58b20b438383 471 size_t pos = sizeof(BlynkHeader);
vshymanskyy 0:58b20b438383 472 if (data && length) {
vshymanskyy 0:58b20b438383 473 memcpy(buff + pos, data, length);
vshymanskyy 0:58b20b438383 474 pos += length;
vshymanskyy 0:58b20b438383 475 }
vshymanskyy 0:58b20b438383 476 if (data2 && length2) {
vshymanskyy 0:58b20b438383 477 memcpy(buff + pos, data2, length2);
vshymanskyy 0:58b20b438383 478 }
vshymanskyy 0:58b20b438383 479
vshymanskyy 0:58b20b438383 480 size_t wlen = 0;
vshymanskyy 0:58b20b438383 481 while (wlen < full_length) {
vshymanskyy 0:58b20b438383 482 const size_t chunk = BlynkMin(size_t(BLYNK_SEND_CHUNK), full_length - wlen);
Volodymyr Shymanskyy 9:7369ec77a3ea 483 BLYNK_DBG_DUMP("<", buff + wlen, chunk);
vshymanskyy 0:58b20b438383 484 const size_t w = conn.write(buff + wlen, chunk);
Volodymyr Shymanskyy 15:975b60f7a8ff 485 BlynkDelay(BLYNK_SEND_THROTTLE);
Volodymyr Shymanskyy 9:7369ec77a3ea 486 if (w == 0) {
vshymanskyy 0:58b20b438383 487 #ifdef BLYNK_DEBUG
vshymanskyy 0:58b20b438383 488 BLYNK_LOG1(BLYNK_F("Cmd error"));
vshymanskyy 0:58b20b438383 489 #endif
vshymanskyy 0:58b20b438383 490 conn.disconnect();
vshymanskyy 0:58b20b438383 491 state = CONNECTING;
Volodymyr Shymanskyy 15:975b60f7a8ff 492 BlynkOnDisconnected();
vshymanskyy 0:58b20b438383 493 return;
Volodymyr Shymanskyy 9:7369ec77a3ea 494 }
vshymanskyy 0:58b20b438383 495 wlen += w;
vshymanskyy 0:58b20b438383 496 }
vshymanskyy 0:58b20b438383 497
vshymanskyy 0:58b20b438383 498 #else
vshymanskyy 0:58b20b438383 499
vshymanskyy 0:58b20b438383 500 BlynkHeader hdr;
vshymanskyy 0:58b20b438383 501 hdr.type = cmd;
vshymanskyy 0:58b20b438383 502 hdr.msg_id = htons(id);
vshymanskyy 0:58b20b438383 503 hdr.length = htons(length+length2);
vshymanskyy 0:58b20b438383 504
Volodymyr Shymanskyy 9:7369ec77a3ea 505 BLYNK_DBG_DUMP("<", &hdr, sizeof(hdr));
vshymanskyy 0:58b20b438383 506 size_t wlen = conn.write(&hdr, sizeof(hdr));
Volodymyr Shymanskyy 15:975b60f7a8ff 507 BlynkDelay(BLYNK_SEND_THROTTLE);
vshymanskyy 0:58b20b438383 508
vshymanskyy 0:58b20b438383 509 if (cmd != BLYNK_CMD_RESPONSE) {
vshymanskyy 0:58b20b438383 510 if (length) {
vshymanskyy 0:58b20b438383 511 BLYNK_DBG_DUMP("<", data, length);
vshymanskyy 0:58b20b438383 512 wlen += conn.write(data, length);
Volodymyr Shymanskyy 15:975b60f7a8ff 513 BlynkDelay(BLYNK_SEND_THROTTLE);
vshymanskyy 0:58b20b438383 514 }
vshymanskyy 0:58b20b438383 515 if (length2) {
vshymanskyy 0:58b20b438383 516 BLYNK_DBG_DUMP("<", data2, length2);
vshymanskyy 0:58b20b438383 517 wlen += conn.write(data2, length2);
Volodymyr Shymanskyy 15:975b60f7a8ff 518 BlynkDelay(BLYNK_SEND_THROTTLE);
vshymanskyy 0:58b20b438383 519 }
vshymanskyy 0:58b20b438383 520 }
vshymanskyy 0:58b20b438383 521
vshymanskyy 0:58b20b438383 522 #endif
vshymanskyy 0:58b20b438383 523
vshymanskyy 0:58b20b438383 524 if (wlen != full_length) {
vshymanskyy 0:58b20b438383 525 #ifdef BLYNK_DEBUG
vshymanskyy 0:58b20b438383 526 BLYNK_LOG4(BLYNK_F("Sent "), wlen, '/', full_length);
vshymanskyy 0:58b20b438383 527 #endif
Volodymyr Shymanskyy 14:76d8fd871a4d 528 internalReconnect();
vshymanskyy 0:58b20b438383 529 return;
vshymanskyy 0:58b20b438383 530 }
vshymanskyy 0:58b20b438383 531
Volodymyr Shymanskyy 18:c328c1a97f90 532 lastActivityOut = BlynkMillis();
vshymanskyy 0:58b20b438383 533
vshymanskyy 0:58b20b438383 534 }
vshymanskyy 0:58b20b438383 535
vshymanskyy 0:58b20b438383 536 template <class Transp>
vshymanskyy 0:58b20b438383 537 uint16_t BlynkProtocol<Transp>::getNextMsgId()
vshymanskyy 0:58b20b438383 538 {
Volodymyr Shymanskyy 14:76d8fd871a4d 539 if (msgIdOutOverride != 0)
Volodymyr Shymanskyy 14:76d8fd871a4d 540 return msgIdOutOverride;
Volodymyr Shymanskyy 14:76d8fd871a4d 541 if (++msgIdOut == 0)
Volodymyr Shymanskyy 14:76d8fd871a4d 542 msgIdOut = 1;
Volodymyr Shymanskyy 14:76d8fd871a4d 543 return msgIdOut;
vshymanskyy 0:58b20b438383 544 }
vshymanskyy 0:58b20b438383 545
vshymanskyy 0:58b20b438383 546 #endif