Merge pull request #147 from Luos-io/feat/telemetry

Add telemetry on pyluos, fix #146

Author: JeromeGalan

README.md

@@ -30,3 +30,11 @@ This section details the features of Luos technology as an embedded development
 * Definition of [Packages](https://docs.luos.io/docs/luos-technology/package/package), and how to make a portable and reusable development.
 * Definition of [Services](https://docs.luos.io/docs/luos-technology/services/services), how to create and declare features in your product.
 * Definition of [Messages](https://docs.luos.io/docs/luos-technology/message/message), when, why, and how to handle them, explaining the more advanced features of Luos.
+
+## Disclaimer
+This library send some anonymous information to Luos allowing to improve Pyluos experience.
+To disable the telemetry please add `telemetry=False` parameter at Device creation.
+For example:
+```python
+device = Device('/dev/cu.usbserial-DN2EUDGP', telemetry=False)
+```

pyluos/device.py

@@ -3,7 +3,9 @@
 import sys
 import json
 import time
+import uuid
 import logging
+import requests
 import threading
 import logging.config
 import numpy as np
@@ -89,6 +91,7 @@ def __init__(self, host,
                  log_conf=_base_log_conf,
                  test_mode=False,
                  background_task=True,
+                 telemetry=True,
                  *args, **kwargs):
         if IO is not None:
             self._io = IO(host=host, *args, **kwargs)
@@ -101,6 +104,7 @@ def __init__(self, host,
                 config = json.load(f)
             logging.config.dictConfig(config)
 
+        self.telemetry = telemetry
         self.logger = logging.getLogger(__name__)
         self.logger.info('Connected to "{}".'.format(host))
 
@@ -228,6 +232,23 @@ def _setup(self):
         self._cmd_data = []
         self._binary = []
 
+        if (self.telemetry == True):
+            from pyluos.version import version
+            self.logger.info('Sending telemetry...')
+            luos_telemetry = {"telemetry_type": "pyluos",
+                  "mac": hex(uuid.getnode()),
+                  "system": sys.platform,
+                  "unix_time": int(time.time()),
+                  "pyluos_rev": version,
+                  "routing_table":state['routing_table']}
+            try:
+                requests.post("https://monorepo-services.vercel.app/api/telemetry",
+                           data=luos_telemetry)
+            except:
+                print("Telemetry request failed.")
+        else:
+            self.logger.info("Telemetry disabled, please consider enabling it by removing the 'telemetry=False' argument of your Device creation.")
+
         # We push our current state to make sure that
         # both our model and the hardware are synced.
         self._push_once()

pyluos/tools/shell.py

@@ -40,7 +40,8 @@ def main():
     args = parser.parse_args()
 
     def print_version():
-        sys.stderr.write("luos control utility v" + pyluos.__version__ + "\n")
+        from pyluos.version import version
+        sys.stderr.write("luos control utility v" + version + "\n")
         sys.stderr.flush()
         return 0
 

pyluos/version.py

@@ -1 +1 @@
-version = '2.2.2'
+version = '2.2.3'

setup.py

@@ -25,7 +25,8 @@
                         'numpy',
                         'anytree',
                         'crc8',
-                        'ipython'
+                        'ipython',
+                        'requests'
                         ],
       extras_require={
           'tests': ['pytest', 'flake8'],