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/BlynkApi.h@0:58b20b438383, 2016-05-07 (annotated)

Committer:
vshymanskyy
Date:
Sat May 07 08:02:50 2016 +0000
Revision:
0:58b20b438383
Child:
2:c5b857d4f9f6
First commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
vshymanskyy 0:58b20b438383 1 /**
vshymanskyy 0:58b20b438383 2 * @file BlynkApi.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 High-level functions
vshymanskyy 0:58b20b438383 8 *
vshymanskyy 0:58b20b438383 9 */
vshymanskyy 0:58b20b438383 10
vshymanskyy 0:58b20b438383 11 #ifndef BlynkApi_h
vshymanskyy 0:58b20b438383 12 #define BlynkApi_h
vshymanskyy 0:58b20b438383 13
vshymanskyy 0:58b20b438383 14 #include <Blynk/BlynkConfig.h>
vshymanskyy 0:58b20b438383 15 #include <Blynk/BlynkDebug.h>
vshymanskyy 0:58b20b438383 16 #include <Blynk/BlynkParam.h>
vshymanskyy 0:58b20b438383 17 #include <Blynk/BlynkHandlers.h>
vshymanskyy 0:58b20b438383 18 #include <Blynk/BlynkProtocolDefs.h>
vshymanskyy 0:58b20b438383 19
vshymanskyy 0:58b20b438383 20 /**
vshymanskyy 0:58b20b438383 21 * Represents high-level functions of Blynk
vshymanskyy 0:58b20b438383 22 */
vshymanskyy 0:58b20b438383 23 template <class Proto>
vshymanskyy 0:58b20b438383 24 class BlynkApi
vshymanskyy 0:58b20b438383 25 {
vshymanskyy 0:58b20b438383 26 public:
vshymanskyy 0:58b20b438383 27 BlynkApi() {
vshymanskyy 0:58b20b438383 28 Init();
vshymanskyy 0:58b20b438383 29 }
vshymanskyy 0:58b20b438383 30
vshymanskyy 0:58b20b438383 31 #ifdef DOXYGEN // These API here are only for the documentation
vshymanskyy 0:58b20b438383 32
vshymanskyy 0:58b20b438383 33 /**
vshymanskyy 0:58b20b438383 34 * Connects to the server.
vshymanskyy 0:58b20b438383 35 * Blocks until connected or timeout happens.
vshymanskyy 0:58b20b438383 36 * May take less or more then timeout value.
vshymanskyy 0:58b20b438383 37 *
vshymanskyy 0:58b20b438383 38 * @param timeout Connection timeout
vshymanskyy 0:58b20b438383 39 * @returns True if connected to the server
vshymanskyy 0:58b20b438383 40 */
vshymanskyy 0:58b20b438383 41 bool connect(unsigned long timeout = BLYNK_TIMEOUT_MS*3);
vshymanskyy 0:58b20b438383 42
vshymanskyy 0:58b20b438383 43 /**
vshymanskyy 0:58b20b438383 44 * Disconnects from the server.
vshymanskyy 0:58b20b438383 45 * It will not try to reconnect, until connect() is called
vshymanskyy 0:58b20b438383 46 */
vshymanskyy 0:58b20b438383 47 void disconnect();
vshymanskyy 0:58b20b438383 48
vshymanskyy 0:58b20b438383 49 /**
vshymanskyy 0:58b20b438383 50 * @returns True if connected to the server
vshymanskyy 0:58b20b438383 51 */
vshymanskyy 0:58b20b438383 52 bool connected();
vshymanskyy 0:58b20b438383 53
vshymanskyy 0:58b20b438383 54 /**
vshymanskyy 0:58b20b438383 55 * Performs Blynk-related housekeeping
vshymanskyy 0:58b20b438383 56 * and processes incoming commands
vshymanskyy 0:58b20b438383 57 *
vshymanskyy 0:58b20b438383 58 * @param available True if there is incoming data to process
vshymanskyy 0:58b20b438383 59 * Only used when user manages connection manually.
vshymanskyy 0:58b20b438383 60 */
vshymanskyy 0:58b20b438383 61 bool run(bool available = false);
vshymanskyy 0:58b20b438383 62
vshymanskyy 0:58b20b438383 63 #endif // DOXYGEN
vshymanskyy 0:58b20b438383 64
vshymanskyy 0:58b20b438383 65 /**
vshymanskyy 0:58b20b438383 66 * Sends value to a Virtual Pin
vshymanskyy 0:58b20b438383 67 *
vshymanskyy 0:58b20b438383 68 * @param pin Virtual Pin number
vshymanskyy 0:58b20b438383 69 * @param data Value to be sent
vshymanskyy 0:58b20b438383 70 */
vshymanskyy 0:58b20b438383 71 template <typename T>
vshymanskyy 0:58b20b438383 72 void virtualWrite(int pin, const T& data) {
vshymanskyy 0:58b20b438383 73 char mem[BLYNK_MAX_SENDBYTES];
vshymanskyy 0:58b20b438383 74 BlynkParam cmd(mem, 0, sizeof(mem));
vshymanskyy 0:58b20b438383 75 cmd.add("vw");
vshymanskyy 0:58b20b438383 76 cmd.add(pin);
vshymanskyy 0:58b20b438383 77 cmd.add(data);
vshymanskyy 0:58b20b438383 78 static_cast<Proto*>(this)->sendCmd(BLYNK_CMD_HARDWARE, 0, cmd.getBuffer(), cmd.getLength()-1);
vshymanskyy 0:58b20b438383 79 }
vshymanskyy 0:58b20b438383 80
vshymanskyy 0:58b20b438383 81 template <typename T1, typename T2>
vshymanskyy 0:58b20b438383 82 void virtualWrite(int pin, const T1& data1, const T2& data2) {
vshymanskyy 0:58b20b438383 83 char mem[BLYNK_MAX_SENDBYTES];
vshymanskyy 0:58b20b438383 84 BlynkParam cmd(mem, 0, sizeof(mem));
vshymanskyy 0:58b20b438383 85 cmd.add("vw");
vshymanskyy 0:58b20b438383 86 cmd.add(pin);
vshymanskyy 0:58b20b438383 87 cmd.add(data1);
vshymanskyy 0:58b20b438383 88 cmd.add(data2);
vshymanskyy 0:58b20b438383 89 static_cast<Proto*>(this)->sendCmd(BLYNK_CMD_HARDWARE, 0, cmd.getBuffer(), cmd.getLength()-1);
vshymanskyy 0:58b20b438383 90 }
vshymanskyy 0:58b20b438383 91
vshymanskyy 0:58b20b438383 92 template <typename T1, typename T2, typename T3>
vshymanskyy 0:58b20b438383 93 void virtualWrite(int pin, const T1& data1, const T2& data2, const T3& data3) {
vshymanskyy 0:58b20b438383 94 char mem[BLYNK_MAX_SENDBYTES];
vshymanskyy 0:58b20b438383 95 BlynkParam cmd(mem, 0, sizeof(mem));
vshymanskyy 0:58b20b438383 96 cmd.add("vw");
vshymanskyy 0:58b20b438383 97 cmd.add(pin);
vshymanskyy 0:58b20b438383 98 cmd.add(data1);
vshymanskyy 0:58b20b438383 99 cmd.add(data2);
vshymanskyy 0:58b20b438383 100 cmd.add(data3);
vshymanskyy 0:58b20b438383 101 static_cast<Proto*>(this)->sendCmd(BLYNK_CMD_HARDWARE, 0, cmd.getBuffer(), cmd.getLength()-1);
vshymanskyy 0:58b20b438383 102 }
vshymanskyy 0:58b20b438383 103
vshymanskyy 0:58b20b438383 104 template <typename T1, typename T2, typename T3, typename T4>
vshymanskyy 0:58b20b438383 105 void virtualWrite(int pin, const T1& data1, const T2& data2, const T3& data3, const T4& data4) {
vshymanskyy 0:58b20b438383 106 char mem[BLYNK_MAX_SENDBYTES];
vshymanskyy 0:58b20b438383 107 BlynkParam cmd(mem, 0, sizeof(mem));
vshymanskyy 0:58b20b438383 108 cmd.add("vw");
vshymanskyy 0:58b20b438383 109 cmd.add(pin);
vshymanskyy 0:58b20b438383 110 cmd.add(data1);
vshymanskyy 0:58b20b438383 111 cmd.add(data2);
vshymanskyy 0:58b20b438383 112 cmd.add(data3);
vshymanskyy 0:58b20b438383 113 cmd.add(data4);
vshymanskyy 0:58b20b438383 114 static_cast<Proto*>(this)->sendCmd(BLYNK_CMD_HARDWARE, 0, cmd.getBuffer(), cmd.getLength()-1);
vshymanskyy 0:58b20b438383 115 }
vshymanskyy 0:58b20b438383 116
vshymanskyy 0:58b20b438383 117 /**
vshymanskyy 0:58b20b438383 118 * Sends buffer to a Virtual Pin
vshymanskyy 0:58b20b438383 119 *
vshymanskyy 0:58b20b438383 120 * @param pin Virtual Pin number
vshymanskyy 0:58b20b438383 121 * @param buff Data buffer
vshymanskyy 0:58b20b438383 122 * @param len Length of data
vshymanskyy 0:58b20b438383 123 */
vshymanskyy 0:58b20b438383 124 void virtualWriteBinary(int pin, const void* buff, size_t len) {
vshymanskyy 0:58b20b438383 125 char mem[8];
vshymanskyy 0:58b20b438383 126 BlynkParam cmd(mem, 0, sizeof(mem));
vshymanskyy 0:58b20b438383 127 cmd.add("vw");
vshymanskyy 0:58b20b438383 128 cmd.add(pin);
vshymanskyy 0:58b20b438383 129 static_cast<Proto*>(this)->sendCmd(BLYNK_CMD_HARDWARE, 0, cmd.getBuffer(), cmd.getLength(), buff, len);
vshymanskyy 0:58b20b438383 130 }
vshymanskyy 0:58b20b438383 131
vshymanskyy 0:58b20b438383 132 /**
vshymanskyy 0:58b20b438383 133 * Sends BlynkParam to a Virtual Pin
vshymanskyy 0:58b20b438383 134 *
vshymanskyy 0:58b20b438383 135 * @param pin Virtual Pin number
vshymanskyy 0:58b20b438383 136 * @param param
vshymanskyy 0:58b20b438383 137 */
vshymanskyy 0:58b20b438383 138 void virtualWrite(int pin, const BlynkParam& param) {
vshymanskyy 0:58b20b438383 139 virtualWriteBinary(pin, param.getBuffer(), param.getLength());
vshymanskyy 0:58b20b438383 140 }
vshymanskyy 0:58b20b438383 141
vshymanskyy 0:58b20b438383 142 /**
vshymanskyy 0:58b20b438383 143 * Requests Server to re-send current values for all widgets.
vshymanskyy 0:58b20b438383 144 */
vshymanskyy 0:58b20b438383 145 void syncAll() {
vshymanskyy 0:58b20b438383 146 static_cast<Proto*>(this)->sendCmd(BLYNK_CMD_HARDWARE_SYNC);
vshymanskyy 0:58b20b438383 147 }
vshymanskyy 0:58b20b438383 148
vshymanskyy 0:58b20b438383 149 /**
vshymanskyy 0:58b20b438383 150 * Requests App or Server to re-send current value of a Virtual Pin.
vshymanskyy 0:58b20b438383 151 * This will probably cause user-defined BLYNK_WRITE handler to be called.
vshymanskyy 0:58b20b438383 152 *
vshymanskyy 0:58b20b438383 153 * @param pin Virtual Pin number
vshymanskyy 0:58b20b438383 154 */
vshymanskyy 0:58b20b438383 155 void syncVirtual(int pin) {
vshymanskyy 0:58b20b438383 156 char mem[8];
vshymanskyy 0:58b20b438383 157 BlynkParam cmd(mem, 0, sizeof(mem));
vshymanskyy 0:58b20b438383 158 cmd.add("vr");
vshymanskyy 0:58b20b438383 159 cmd.add(pin);
vshymanskyy 0:58b20b438383 160 static_cast<Proto*>(this)->sendCmd(BLYNK_CMD_HARDWARE_SYNC, 0, cmd.getBuffer(), cmd.getLength()-1);
vshymanskyy 0:58b20b438383 161 }
vshymanskyy 0:58b20b438383 162
vshymanskyy 0:58b20b438383 163 /**
vshymanskyy 0:58b20b438383 164 * Tweets a message
vshymanskyy 0:58b20b438383 165 *
vshymanskyy 0:58b20b438383 166 * @param msg Text of the message
vshymanskyy 0:58b20b438383 167 */
vshymanskyy 0:58b20b438383 168 template<typename T>
vshymanskyy 0:58b20b438383 169 void tweet(const T& msg) {
vshymanskyy 0:58b20b438383 170 char mem[BLYNK_MAX_SENDBYTES];
vshymanskyy 0:58b20b438383 171 BlynkParam cmd(mem, 0, sizeof(mem));
vshymanskyy 0:58b20b438383 172 cmd.add(msg);
vshymanskyy 0:58b20b438383 173 static_cast<Proto*>(this)->sendCmd(BLYNK_CMD_TWEET, 0, cmd.getBuffer(), cmd.getLength()-1);
vshymanskyy 0:58b20b438383 174 }
vshymanskyy 0:58b20b438383 175
vshymanskyy 0:58b20b438383 176 /**
vshymanskyy 0:58b20b438383 177 * Sends a push notification to the App
vshymanskyy 0:58b20b438383 178 *
vshymanskyy 0:58b20b438383 179 * @param msg Text of the message
vshymanskyy 0:58b20b438383 180 */
vshymanskyy 0:58b20b438383 181 template<typename T>
vshymanskyy 0:58b20b438383 182 void notify(const T& msg) {
vshymanskyy 0:58b20b438383 183 char mem[BLYNK_MAX_SENDBYTES];
vshymanskyy 0:58b20b438383 184 BlynkParam cmd(mem, 0, sizeof(mem));
vshymanskyy 0:58b20b438383 185 cmd.add(msg);
vshymanskyy 0:58b20b438383 186 static_cast<Proto*>(this)->sendCmd(BLYNK_CMD_NOTIFY, 0, cmd.getBuffer(), cmd.getLength()-1);
vshymanskyy 0:58b20b438383 187 }
vshymanskyy 0:58b20b438383 188
vshymanskyy 0:58b20b438383 189 /**
vshymanskyy 0:58b20b438383 190 * Sends an SMS
vshymanskyy 0:58b20b438383 191 *
vshymanskyy 0:58b20b438383 192 * @param msg Text of the message
vshymanskyy 0:58b20b438383 193 */
vshymanskyy 0:58b20b438383 194 template<typename T>
vshymanskyy 0:58b20b438383 195 void sms(const T& msg) {
vshymanskyy 0:58b20b438383 196 char mem[BLYNK_MAX_SENDBYTES];
vshymanskyy 0:58b20b438383 197 BlynkParam cmd(mem, 0, sizeof(mem));
vshymanskyy 0:58b20b438383 198 cmd.add(msg);
vshymanskyy 0:58b20b438383 199 static_cast<Proto*>(this)->sendCmd(BLYNK_CMD_SMS, 0, cmd.getBuffer(), cmd.getLength()-1);
vshymanskyy 0:58b20b438383 200 }
vshymanskyy 0:58b20b438383 201
vshymanskyy 0:58b20b438383 202 /**
vshymanskyy 0:58b20b438383 203 * Sends an email message
vshymanskyy 0:58b20b438383 204 *
vshymanskyy 0:58b20b438383 205 * @param email Email to send to
vshymanskyy 0:58b20b438383 206 * @param subject Subject of message
vshymanskyy 0:58b20b438383 207 * @param msg Text of the message
vshymanskyy 0:58b20b438383 208 */
vshymanskyy 0:58b20b438383 209 template <typename T1, typename T2>
vshymanskyy 0:58b20b438383 210 void email(const char* email, const T1& subject, const T2& msg) {
vshymanskyy 0:58b20b438383 211 char mem[BLYNK_MAX_SENDBYTES];
vshymanskyy 0:58b20b438383 212 BlynkParam cmd(mem, 0, sizeof(mem));
vshymanskyy 0:58b20b438383 213 cmd.add(email);
vshymanskyy 0:58b20b438383 214 cmd.add(subject);
vshymanskyy 0:58b20b438383 215 cmd.add(msg);
vshymanskyy 0:58b20b438383 216 static_cast<Proto*>(this)->sendCmd(BLYNK_CMD_EMAIL, 0, cmd.getBuffer(), cmd.getLength()-1);
vshymanskyy 0:58b20b438383 217 }
vshymanskyy 0:58b20b438383 218
vshymanskyy 0:58b20b438383 219 #if defined(BLYNK_EXPERIMENTAL)
vshymanskyy 0:58b20b438383 220 // Attention!
vshymanskyy 0:58b20b438383 221 // Every function in this section may be changed, removed or renamed.
vshymanskyy 0:58b20b438383 222
vshymanskyy 0:58b20b438383 223 /**
vshymanskyy 0:58b20b438383 224 * Refreshes value of a widget by running
vshymanskyy 0:58b20b438383 225 * user-defined BLYNK_READ handler of a pin.
vshymanskyy 0:58b20b438383 226 *
vshymanskyy 0:58b20b438383 227 * @experimental
vshymanskyy 0:58b20b438383 228 *
vshymanskyy 0:58b20b438383 229 * @param pin Virtual Pin number
vshymanskyy 0:58b20b438383 230 */
vshymanskyy 0:58b20b438383 231 void refresh(int pin) {
vshymanskyy 0:58b20b438383 232 if (WidgetReadHandler handler = GetReadHandler(pin)) {
vshymanskyy 0:58b20b438383 233 BlynkReq req = { 0, BLYNK_SUCCESS, (uint8_t)pin };
vshymanskyy 0:58b20b438383 234 handler(req);
vshymanskyy 0:58b20b438383 235 }
vshymanskyy 0:58b20b438383 236 }
vshymanskyy 0:58b20b438383 237
vshymanskyy 0:58b20b438383 238 /**
vshymanskyy 0:58b20b438383 239 * Delays for N milliseconds, handling server communication in background.
vshymanskyy 0:58b20b438383 240 *
vshymanskyy 0:58b20b438383 241 * @experimental
vshymanskyy 0:58b20b438383 242 * @warning Should be used very carefully, especially on platforms with small RAM.
vshymanskyy 0:58b20b438383 243 *
vshymanskyy 0:58b20b438383 244 * @param ms Milliseconds to wait
vshymanskyy 0:58b20b438383 245 */
vshymanskyy 0:58b20b438383 246 void delay(unsigned long ms) {
vshymanskyy 0:58b20b438383 247 uint16_t start = (uint16_t)micros();
vshymanskyy 0:58b20b438383 248 while (ms > 0) {
vshymanskyy 0:58b20b438383 249 static_cast<Proto*>(this)->run();
vshymanskyy 0:58b20b438383 250 #if !defined(BLYNK_NO_YIELD)
vshymanskyy 0:58b20b438383 251 yield();
vshymanskyy 0:58b20b438383 252 #endif
vshymanskyy 0:58b20b438383 253 if (((uint16_t)micros() - start) >= 1000) {
vshymanskyy 0:58b20b438383 254 ms--;
vshymanskyy 0:58b20b438383 255 start += 1000;
vshymanskyy 0:58b20b438383 256 }
vshymanskyy 0:58b20b438383 257 }
vshymanskyy 0:58b20b438383 258 }
vshymanskyy 0:58b20b438383 259
vshymanskyy 0:58b20b438383 260 #endif
vshymanskyy 0:58b20b438383 261
vshymanskyy 0:58b20b438383 262 protected:
vshymanskyy 0:58b20b438383 263 void Init();
vshymanskyy 0:58b20b438383 264 static millis_time_t getMillis();
vshymanskyy 0:58b20b438383 265 void processCmd(const void* buff, size_t len);
vshymanskyy 0:58b20b438383 266 void sendInfo();
vshymanskyy 0:58b20b438383 267
vshymanskyy 0:58b20b438383 268 };
vshymanskyy 0:58b20b438383 269
vshymanskyy 0:58b20b438383 270
vshymanskyy 0:58b20b438383 271 #endif