forked from vshymanskyy/blynk-library-python
-
Notifications
You must be signed in to change notification settings - Fork 0
/
BlynkLib.py
400 lines (349 loc) · 13.8 KB
/
BlynkLib.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
#!/usr/bin/env python3
# The MIT License (MIT)
#
# Copyright (c) 2015 Volodymyr Shymanskyy
# Copyright (c) 2015 Daniel Campora
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
import socket
import struct
import time
import sys
import ssl
try:
import machine
idle_func = machine.idle
except ImportError:
const = lambda x: x
idle_func = None
setattr(sys.modules['time'], 'sleep_ms', lambda ms: time.sleep(ms // 1000))
setattr(sys.modules['time'], 'ticks_ms', lambda: int(time.time() * 1000))
setattr(sys.modules['time'], 'ticks_diff', lambda s, e: e - s)
HDR_LEN = const(5)
HDR_FMT = "!BHH"
MAX_MSG_PER_SEC = const(20)
MSG_RSP = const(0)
MSG_LOGIN = const(2)
MSG_PING = const(6)
MSG_TWEET = const(12)
MSG_EMAIL = const(13)
MSG_NOTIFY = const(14)
MSG_BRIDGE = const(15)
MSG_HW_SYNC = const(16)
MSG_HW_INFO = const(17)
MSG_HW = const(20)
STA_SUCCESS = const(200)
HB_PERIOD = const(10)
NON_BLK_SOCK = const(0)
MIN_SOCK_TO = const(1) # 1 second
MAX_SOCK_TO = const(5) # 5 seconds, must be < HB_PERIOD
RECONNECT_DELAY = const(1) # 1 second
TASK_PERIOD_RES = const(50) # 50 ms
IDLE_TIME_MS = const(5) # 5 ms
RE_TX_DELAY = const(2)
MAX_TX_RETRIES = const(3)
MAX_VIRTUAL_PINS = const(32)
DISCONNECTED = const(0)
CONNECTING = const(1)
AUTHENTICATING = const(2)
AUTHENTICATED = const(3)
EAGAIN = const(11)
def sleep_from_until (start, delay):
if idle_func is not None:
while time.ticks_diff(start, time.ticks_ms()) < delay:
idle_func()
else:
time.sleep(delay/1000)
return start + delay
class VrPin:
def __init__(self, read=None, write=None):
self.read = read
self.write = write
class Terminal:
def __init__(self, blynk, pin):
self._blynk = blynk
self._pin = pin
def write(self, data):
self._blynk.virtual_write(self._pin, data)
def read(self, size):
return ''
def virtual_read(self):
pass
def virtual_write(self, value):
try:
out = eval(value)
if out != None:
print(repr(out))
except:
try:
exec(value)
except Exception as e:
print('Exception:\n ' + repr(e))
class Blynk:
def __init__(self, token, server='blynk-cloud.com', port=None, connect=True, ssl=False, ca_certs='/flash/cert/ca.pem'):
self._vr_pins = {}
self._do_connect = False
self._on_connect = None
self._task = None
self._task_period = 0
self._token = token
if isinstance (self._token, str):
self._token = token.encode('ascii')
self._server = server
if port is None:
if ssl:
port = 8441
else:
port = 8442
self._port = port
self._do_connect = connect
self._ssl = ssl
self._ca_certs = ca_certs
self.state = DISCONNECTED
def _format_msg(self, msg_type, *args):
data = ('\0'.join(map(str, args))).encode('ascii')
return struct.pack(HDR_FMT, msg_type, self._new_msg_id(), len(data)) + data
def _handle_hw(self, data):
params = list(map(lambda x: x.decode('ascii'), data.split(b'\0')))
cmd = params.pop(0)
if cmd == 'info':
pass
elif cmd == 'pm':
pass
elif cmd == 'vw':
pin = int(params.pop(0))
if pin in self._vr_pins and self._vr_pins[pin].write:
for param in params:
self._vr_pins[pin].write(param)
else:
print("Warning: Virtual write to unregistered pin %d" % pin)
elif cmd == 'vr':
pin = int(params.pop(0))
if pin in self._vr_pins and self._vr_pins[pin].read:
self._vr_pins[pin].read()
else:
print("Warning: Virtual read from unregistered pin %d" % pin)
else:
raise ValueError("Unknown message cmd: %s" % cmd)
def _new_msg_id(self):
self._msg_id += 1
if (self._msg_id > 0xFFFF):
self._msg_id = 1
return self._msg_id
def _settimeout(self, timeout):
if timeout != self._timeout:
self._timeout = timeout
self.conn.settimeout(timeout)
def _recv(self, length, timeout=0):
self._settimeout (timeout)
try:
self._rx_data += self.conn.recv(length)
except socket.timeout:
return b''
except socket.error as e:
if e.args[0] == EAGAIN:
return b''
else:
raise
if len(self._rx_data) >= length:
data = self._rx_data[:length]
self._rx_data = self._rx_data[length:]
return data
else:
return b''
def _send(self, data, send_anyway=False):
if self._tx_count < MAX_MSG_PER_SEC or send_anyway:
retries = 0
while retries <= MAX_TX_RETRIES:
try:
self.conn.send(data)
self._tx_count += 1
break
except socket.error as er:
if er.args[0] != EAGAIN:
raise
else:
time.sleep_ms(RE_TX_DELAY)
retries += 1
def _close(self, emsg=None):
self.conn.close()
self.state = DISCONNECTED
time.sleep(RECONNECT_DELAY)
if emsg:
print('Error: %s, connection closed' % emsg)
def _server_alive(self):
c_time = int(time.time())
if self._m_time != c_time:
self._m_time = c_time
self._tx_count = 0
if self._last_hb_id != 0 and c_time - self._hb_time >= MAX_SOCK_TO:
return False
if c_time - self._hb_time >= HB_PERIOD and self.state == AUTHENTICATED:
self._hb_time = c_time
self._last_hb_id = self._new_msg_id()
self._send(struct.pack(HDR_FMT, MSG_PING, self._last_hb_id, 0), True)
return True
def _run_task(self):
if self._task:
c_millis = time.ticks_ms()
if c_millis - self._task_millis >= self._task_period:
self._task_millis += self._task_period
self._task()
def repl(self, pin):
repl = Terminal(self, pin)
self.add_virtual_pin(pin, repl.virtual_read, repl.virtual_write)
return repl
def notify(self, msg):
if self.state == AUTHENTICATED:
self._send(self._format_msg(MSG_NOTIFY, msg))
def tweet(self, msg):
if self.state == AUTHENTICATED:
self._send(self._format_msg(MSG_TWEET, msg))
def email(self, to, subject, body):
if self.state == AUTHENTICATED:
self._send(self._format_msg(MSG_EMAIL, to, subject, body))
def virtual_write(self, pin, val):
if self.state == AUTHENTICATED:
self._send(self._format_msg(MSG_HW, 'vw', pin, val))
def sync_all(self):
if self.state == AUTHENTICATED:
self._send(self._format_msg(MSG_HW_SYNC))
def sync_virtual(self, pin):
if self.state == AUTHENTICATED:
self._send(self._format_msg(MSG_HW_SYNC, 'vr', pin))
def add_virtual_pin(self, pin, read=None, write=None):
if isinstance(pin, int) and pin in range(0, MAX_VIRTUAL_PINS):
self._vr_pins[pin] = VrPin(read, write)
else:
raise ValueError('the pin must be an integer between 0 and %d' % (MAX_VIRTUAL_PINS - 1))
def VIRTUAL_READ(blynk, pin):
class Decorator():
def __init__(self, func):
self.func = func
blynk._vr_pins[pin] = VrPin(func, None)
#print(blynk, func, pin)
def __call__(self):
return self.func()
return Decorator
def VIRTUAL_WRITE(blynk, pin):
class Decorator():
def __init__(self, func):
self.func = func
blynk._vr_pins[pin] = VrPin(None, func)
def __call__(self):
return self.func()
return Decorator
def on_connect(self, func):
self._on_connect = func
def set_user_task(self, task, ms_period):
if ms_period % TASK_PERIOD_RES != 0:
raise ValueError('the user task period must be a multiple of %d ms' % TASK_PERIOD_RES)
self._task = task
self._task_period = ms_period
def connect(self):
self._do_connect = True
def disconnect(self):
self._do_connect = False
def run(self):
self._start_time = time.ticks_ms()
self._task_millis = self._start_time
self._hw_pins = {}
self._rx_data = b''
self._msg_id = 1
self._timeout = None
self._tx_count = 0
self._m_time = 0
self.state = DISCONNECTED
while True:
while self.state != AUTHENTICATED:
self._run_task()
if self._do_connect:
try:
self.state = CONNECTING
if self._ssl:
print('SSL: Connecting to %s:%d' % (self._server, self._port))
# socket module doesn't have IPPROTO_SEC attribute on all implementations.
try:
proto = socket.IPPROTO_SEC
except AttributeError:
proto = 0
ss = socket.socket(socket.AF_INET, socket.SOCK_STREAM, proto)
self.conn = ssl.wrap_socket(ss, cert_reqs=ssl.CERT_REQUIRED, ca_certs=self._ca_certs)
else:
print('TCP: Connecting to %s:%d' % (self._server, self._port))
self.conn = socket.socket()
self.conn.connect(socket.getaddrinfo(self._server, self._port)[0][4])
except:
self._close('connection with the Blynk servers failed')
continue
self.state = AUTHENTICATING
hdr = struct.pack(HDR_FMT, MSG_LOGIN, self._new_msg_id(), len(self._token))
print('Blynk connection successful, authenticating...')
self._send(hdr + self._token, True)
data = self._recv(HDR_LEN, timeout=MAX_SOCK_TO)
if not data:
self._close('Blynk authentication timed out')
continue
msg_type, msg_id, status = struct.unpack(HDR_FMT, data)
if status != STA_SUCCESS or msg_id == 0:
self._close('Blynk authentication failed')
continue
self.state = AUTHENTICATED
self._send(self._format_msg(MSG_HW_INFO, 'ver', '0.0.1+py', 'h-beat', HB_PERIOD, 'dev', sys.platform))
print('Access granted, happy Blynking!')
if self._on_connect:
self._on_connect()
else:
self._start_time = sleep_from_until(self._start_time, TASK_PERIOD_RES)
self._hb_time = 0
self._last_hb_id = 0
self._tx_count = 0
while self._do_connect:
try:
data = self._recv(HDR_LEN, NON_BLK_SOCK)
except:
pass
if data:
# Fix: only take the correct length of data, as sometimes the server seems to send more bytes than needed.
# (appears when using SSL)
msg_type, msg_id, msg_len = struct.unpack(HDR_FMT, data[0:HDR_LEN])
if msg_id == 0:
self._close('invalid msg id %d' % msg_id)
break
if msg_type == MSG_RSP:
if msg_id == self._last_hb_id:
self._last_hb_id = 0
elif msg_type == MSG_PING:
self._send(struct.pack(HDR_FMT, MSG_RSP, msg_id, STA_SUCCESS), True)
elif msg_type == MSG_HW or msg_type == MSG_BRIDGE:
data = self._recv(msg_len, MIN_SOCK_TO)
if data:
self._handle_hw(data)
else:
self._close('unknown message type %d' % msg_type)
break
else:
self._start_time = sleep_from_until(self._start_time, IDLE_TIME_MS)
if not self._server_alive():
self._close('Blynk server is offline')
break
self._run_task()
if not self._do_connect:
self._close()
print('Blynk disconnection requested by the user')