Terminal example completed

blynkkk · antohaUa · Mar 4, 2019 · Feb 11, 2019 · Feb 12, 2019 · Feb 13, 2019
commit f84f246cd91b6d9912ece85bec3ed7e6aaf73881
diff --git a/blynklib.py b/blynklib.py
@@ -72,9 +72,10 @@ def _get_msg_id(self):
         self._msg_id += 1
         return self._msg_id if self._msg_id <= 0xFFFF else 1
 
-    def _pack_msg(self, msg_type, *args):
-        data = ('\0'.join([str(curr_arg) for curr_arg in args])).encode('ascii')
-        return struct.pack('!BHH', msg_type, self._get_msg_id(), len(data)) + data
+    def _pack_msg(self, msg_type, *args, **kwargs):
+        msg_id = kwargs['msg_id'] if 'msg_id' in kwargs else self._get_msg_id()
+        data = ('\0'.join([str(curr_arg) for curr_arg in args])).encode('utf8')
+        return struct.pack('!BHH', msg_type, msg_id, len(data)) + data
 
     def parse_response(self, rsp_data, expected_msg_type=None):
         msg_args = []
@@ -100,8 +101,11 @@ def heartbeat_msg(self):
     def login_msg(self, token):
         return self._pack_msg(self._MSG_LOGIN, token)
 
-    def ping_reply_msg(self, msg_id, status):
-        return self._pack_msg(self._MSG_RSP, msg_id, status)
+    def ping_msg(self):
+        return self._pack_msg(self._MSG_PING)
+
+    def response_msg(self, *args, **kwargs):
+        return self._pack_msg(self._MSG_RSP, *args, **kwargs)
 
     def virtual_write_msg(self, v_pin, *val):
         return self._pack_msg(self._MSG_HW, 'vw', v_pin, *val)
@@ -185,10 +189,10 @@ def is_server_alive(self):
         receive_delta = now - self._last_receive_time
         ping_delta = now - self._last_ping_time
         send_delta = now - self._last_send_time
-        if receive_delta > heartbeat_ms * 1.5:
+        if receive_delta > heartbeat_ms + (heartbeat_ms // 2):
             return False
-        if (ping_delta > heartbeat_ms / 10) and (send_delta > heartbeat_ms or receive_delta > heartbeat_ms):
-            self.send(self.ping_reply_msg(self._get_msg_id(), 0))
+        if (ping_delta > heartbeat_ms // 10) and (send_delta > heartbeat_ms or receive_delta > heartbeat_ms):
+            self.send(self.ping_msg())
             print('Heartbeat time: {}'.format(now))
             self._last_ping_time = now
         return True
@@ -315,7 +319,6 @@ def __in
10000
it__(self, func):
                     event_base_name = str(event_name).split(blynk.VPIN_WILDCARD)[0]
                     for i in range(1, blynk._VIRTUAL_PIN_MAX_NUM + 1):
                         blynk.events['{}{}'.format(event_base_name, i)] = func
-                        print('Registered {}{}'.format(event_base_name, i))
                 else:
                     blynk.events[str(event_name)] = func
 
@@ -333,7 +336,7 @@ def process(self, msg_type, msg_id, msg_len, msg_args):
         if msg_type == self._MSG_RSP:
             print(msg_len)
         elif msg_type == self._MSG_PING:
-            self.send(self.ping_reply_msg(msg_id, self._STATUS_SUCCESS))
+            self.send(self.response_msg(self._STATUS_SUCCESS, msg_id=msg_id))
         elif msg_type in (self._MSG_HW, self._MSG_BRIDGE):
             if len(msg_args) >= 2:
                 if msg_args[0] == 'vw':

diff --git a/examples/06_terminal_widget.py b/examples/06_terminal_widget.py
@@ -1,31 +1,97 @@
-# todo add caption and finish
+"""
+[TERMINAL WIDGET EXAMPLE] ==========================================================================================
+
+Environment prepare:
+In your Blynk App project:
+  - add "Terminal" widget,
+  - bind it to Virtual Pin V6,
+  - add input line option in widget settings
+  - Run the App (green triangle in the upper right corner).
+  - define your auth token for current example
+  - optionally you can define your own "ALLOWED_COMMANDS_LIST"
+  - run current example
+
+
+This started program will periodically call and execute event handler "write_virtual_pin_handler".
+In App Terminal widget you can type commands. If command present in allowed list, script will try
+to execute it in current running environment and will send back to terminal execution results.
+Additionally can be used 'help' command to get in terminal list of available commands.
+
+Schema:
+=====================================================================================================================
++-----+             +-----------+                        +--------------+                    +--------------+
+|     |             |           |                        |              |                    |              |
+| env |             | blynk lib |                        | blynk server |                    |  blynk app   |
+|     |             |           |                        |  virtual pin |                    |              |
+|     |             |           |                        |              |                    |              |
++--+--+             +-----+-----+                        +------+-------+                    +-------+------+
+   |                      |                                     |                                    |
+   |                      |                                     | write command from terminal widget |
+   |                      |                                     |                                    |
+   |                      |                                     +<-----------------------------------+
+   |       event handler  |   write event to hw from server     |                                    |
+   |      (user function) |                                     |                                    |
+   |  exec     +-----------<------------------------------------+                                    |
+   +<----------+          |                                     |                                    |
+   |           |          |      write cmd out back to pin      |                                    |
+   +---------->+--------->------------------------------------->+                                    |
+   |                      |                                     |           was pin updated?         |
+   |                      |                                     +<-----------------------------------+
+   |                      |                                     |                                    |
+   |                      |                                     |                                    |
+   |                      |                                     |  take vpin data to widget output   |
+   |                      |                                     |                                    |
+   |                      |                                     +----------------------------------->+
+   |                      |                                     |                                    |
+   +                      +                                     +                                    +
+
+=====================================================================================================================
+Additional info about blynk you can find by examining such resources:
+
+    Downloads, docs, tutorials:     http://www.blynk.cc
+    Sketch generator:               http://examples.blynk.cc
+    Blynk community:                http://community.blynk.cc
+    Social networks:                http://www.fb.com/blynkapp
+                                    http://twitter.com/blynk_app
+=====================================================================================================================
+"""
 
-import time
 import blynklib
 import subprocess
 
 BLYNK_AUTH = 'YourAuthToken'
-USB_DEV_PATTERN = 'Linux'
-
-blynk = blynklib.Blynk(BLYNK_AUTH)
 
+# last command in example - just to show error handling
+ALLOWED_COMMANDS_LIST = ['ls', 'lsusb', 'ip a', 'ip abc']
 
-@blynk.handle_event("connect")
-def connect_handler():
-    print('smth')
-    blynk.virtual_write(22, 'Command22:')
+blynk = blynklib.Blynk(BLYNK_AUTH)
 
 
-@blynk.handle_event('write V22')
+@blynk.handle_event('write V6')
 def write_handler(pin, values):
-    if values and values[0] == u'lsusb':
-        found_usb_dev = subprocess.check_output("lsusb")
-        dev_list = found_usb_dev.split('\n')
-        target_dev_list = [dev_rec for dev_rec in dev_list if USB_DEV_PATTERN in dev_rec]
-        print('{}'.format(target_dev_list))
-        print('=' * 20)
-        # todo understand why this is not working always
-        blynk.virtual_write(22, 'USB: 123\n')
+    header = ''
+    result = ''
+    delimiter = '{}\n'.format('=' * 30)
+    if values and values[0] in ALLOWED_COMMANDS_LIST:
+        cmd_params = values[0].split(' ')
+        try:
+            result = subprocess.check_output(cmd_params).decode('utf-8')
+            header = '[output]\n'
+        except subprocess.CalledProcessError as exe_err:
+            header = '[error]\n'
+            result = 'Return Code: {}\n'.format(exe_err.returncode)
+        except Exception as g_err:
+            print("Command caused '{}'".format(g_err))
+    elif values and values[0] == 'help':
+        header = '[help -> allowed commands]\n'
+        result = '{}\n'.format('\n'.join(ALLOWED_COMMANDS_LIST))
+
+    # communicate with terminal if help or some allowed command
+    if result:
+        output = '{}{}{}{}'.format(header, delimiter, result, delimiter)
+        print(output)
+        blynk.virtual_write(pin, output)
+        blynk.virtual_write(pin, '\n')
 
 
 ###########################################################