Adding telemetry for the new features

package.json

@@ -105,7 +105,7 @@
         }
       },
       {
-        "id": "badgeForegroundOverwrite",
+        "id": "badgeForegroundOverride",
         "description": "Color that fixes the issue with midnight blue ",
         "defaults": {
           "dark": "#FFFFFF",

src/adafruit_circuitplayground/constants.py

@@ -15,12 +15,24 @@
 
 VALID_PIXEL_ASSIGN_ERROR = "The pixel color value should be a tuple with three values between 0 and 255 or a hexadecimal color between 0x000000 and 0xFFFFFF."
 
+TELEMETRY_EVENT_NAMES = {
+    'TAPPED': "API.TAPPED",
+    'PLAY_FILE': "API.PLAY.FILE",
+    'PLAY_TONE': "API.PLAY.TONE",
+    'START_TONE': "API.START.TONE",
+    'STOP_TONE': "API.STOP.TONE",
+    'DETECT_TAPS': "API.DETECT.TAPS",
+    'ADJUST_THRESHOLD': "API.ADJUST.THRESHOLD",
+    'RED_LED': "API.RED.LED",
+    'PIXELS': "API.PIXELS"
+}
 ERROR_SENDING_EVENT = "Error trying to send event to the process : "
 
 TIME_DELAY = 0.03
 
 DEFAULT_PORT = "5577"
 
+
 EVENTS_BUTTON_PRESS = ['button_a', 'button_b', 'switch']
 EVENTS_SENSOR_CHANGED = ['temperature',
                          'light', 'motion_x', 'motion_y', 'motion_z']

src/adafruit_circuitplayground/express.py

@@ -9,6 +9,7 @@
 from . import utils
 from . import constants as CONSTANTS
 from collections import namedtuple
+from applicationinsights import TelemetryClient
 
 Acceleration = namedtuple('acceleration', ['x', 'y', 'z'])
 
@@ -40,11 +41,18 @@ def __init__(self):
             'motion_y': 0,
             'motion_z': 0,
             'touch': [False]*7,
-            'detect_taps': 1,
-            'tapped': False,
             'shake': False,
         }
-
+        self.telemetry_state = {
+            "DETECT_TAPS": False,
+            "TAPPED": False,
+            "RED_LED": False,
+            "ADJUST_THRESHOLD": False,
+            "PLAY_FILE": False,
+            "PLAY_TONE": False,
+            "START_TONE": False,
+            "STOP_TONE": False,
+        }
         self.__debug_mode = False
         self.__abs_path_to_code_file = ''
         self.pixels = Pixel(self.__state, self.__debug_mode)
@@ -63,6 +71,9 @@ def button_b(self):
 
     @property
     def detect_taps(self):
+        if(not self.telemetry_state["DETECT_TAPS"]):
+            utils.send_telemetry("DETECT_TAPS")
+            self.telemetry_state["DETECT_TAPS"] = True
         return self.__state['detect_taps']
 
     @detect_taps.setter
@@ -75,15 +86,23 @@ def detect_taps(self, value):
     def tapped(self):
         """  Not Implemented!
         """
-
+        if(not self.telemetry_state["TAPPED"]):
+            utils.send_telemetry("TAPPED")
+            self.telemetry_state["TAPPED"] = True
         raise NotImplementedError(CONSTANTS.NOT_IMPLEMENTED_ERROR)
 
     @property
     def red_led(self):
+        if(not self.telemetry_state["RED_LED"]):
+            utils.send_telemetry("RED_LED")
+            self.telemetry_state["RED_LED"] = True
         return self.__state['red_led']
 
     @red_led.setter
     def red_led(self, value):
+        if(not self.telemetry_state["RED_LED"]):
+            utils.send_telemetry("RED_LED")
+            self.telemetry_state["RED_LED"] = True
         self.__state['red_led'] = bool(value)
         self.__show()
 
@@ -137,13 +156,20 @@ def adjust_touch_threshold(self, adjustement):
         """Not implemented!
         The CPX Simulator doesn't use capacitive touch threshold.
         """
+        if(not self.telemetry_state["ADJUST_THRESHOLD"]):
+            utils.send_telemetry("ADJUST_THRESHOLD")
+            self.telemetry_state["ADJUST_THRESHOLD"] = True
+
         raise NotImplementedError(
-            "this method is not supported by the simulator")
+            CONSTANTS.NOT_IMPLEMENTED_ERROR)
 
     def shake(self, shake_threshold=30):
         return self.__state['shake']
 
     def play_file(self, file_name):
+        if(not self.telemetry_state["PLAY_FILE"]):
+            utils.send_telemetry("PLAY_FILE")
+            self.telemetry_state["PLAY_FILE"] = True
         file_name = utils.remove_leading_slashes(file_name)
         abs_path_parent_dir = os.path.abspath(
             os.path.join(self.__abs_path_to_code_file, os.pardir))
@@ -165,19 +191,27 @@ def play_file(self, file_name):
     def play_tone(self, frequency, duration):
         """ Not Implemented!
         """
+        if(not self.telemetry_state["PLAY_TONE"]):
+            utils.send_telemetry("PLAY_TONE")
+            self.telemetry_state["PLAY_TONE"] = True
         raise NotImplementedError(
             CONSTANTS.NOT_IMPLEMENTED_ERROR)
 
     def start_tone(self, frequency):
         """ Not Implemented!
         """
+        if(not self.telemetry_state["START_TONE"]):
+            utils.send_telemetry("START_TONE")
+            self.telemetry_state["START_TONE"] = True
         raise NotImplementedError(
             CONSTANTS.NOT_IMPLEMENTED_ERROR)
 
     def stop_tone(self):
         """ Not Implemented!
         """
-        # Stop playing any tones.
+        if(not self.telemetry_state["STOP_TONE"]):
+            utils.send_telemetry("STOP_TONE")
+            self.telemetry_state["STOP_TONE"] = True
         raise NotImplementedError(
             CONSTANTS.NOT_IMPLEMENTED_ERROR)
 

src/adafruit_circuitplayground/pixel.py

@@ -5,13 +5,16 @@
 import sys
 from . import constants as CONSTANTS
 from . import utils
+from applicationinsights import TelemetryClient
+from . import constants as CONSTANTS
 
 
 class Pixel:
     def __init__(self, state, debug_mode=False):
         self.__state = state
         self.auto_write = True
         self.__debug_mode = debug_mode
+        self.telemetry_state = False
 
     def show(self):
         # Send the state to the extension so that React re-renders the Webview
@@ -28,9 +31,15 @@ def __getitem__(self, index):
         if type(index) is not slice:
             if not self.__valid_index(index):
                 raise IndexError(CONSTANTS.INDEX_ERROR)
+        if(not self.telemetry_state):
+            utils.send_telemetry("PIXELS")
+            self.telemetry_state = True
         return self.__state['pixels'][index]
 
     def __setitem__(self, index, val):
+        if(not self.telemetry_state):
+            utils.send_telemetry("PIXELS")
+            self.telemetry_state = True
         is_slice = False
         if type(index) is slice:
             is_slice = True
@@ -80,7 +89,6 @@ def __extract_pixel_value(self, val, is_slice=False):
             if len(rgb_value) != 3 or any(not self.__valid_rgb_value(pix) for pix in rgb_value):
                 raise ValueError(CONSTANTS.VALID_PIXEL_ASSIGN_ERROR)
             extracted_values.append(rgb_value)
-
         return rgb_value if not is_slice else extracted_values
 
     def __hex_to_rgb(self, hexValue):
@@ -90,7 +98,6 @@ def __hex_to_rgb(self, hexValue):
             hexToRgbValue[0] = int(hexColor[0:2], 16)  # R
             hexToRgbValue[1] = int(hexColor[2:4], 16)  # G
             hexToRgbValue[2] = int(hexColor[4:6], 16)  # B
-
             return tuple(hexToRgbValue)
         else:
             raise ValueError(CONSTANTS.PIXEL_RANGE_ERROR)

src/adafruit_circuitplayground/utils.py

@@ -7,11 +7,16 @@
 import time
 from . import constants as CONSTANTS
 from . import debugger_communication_client
+from applicationinsights import TelemetryClient
 
 
 previous_state = {}
 
 
+telemetry_client = TelemetryClient('__AIKEY__')
+EXTENSION_NAME = '__EXTENSIONNAME__'
+
+
 def show(state, debug_mode=False):
     global previous_state
     if state != previous_state:
@@ -28,3 +33,9 @@ def show(state, debug_mode=False):
 def remove_leading_slashes(string):
     string = string.lstrip('\\/')
     return string
+
+
+def send_telemetry(event_name):
+    telemetry_client.track_event(
+        '{}/{}'.format(EXTENSION_NAME, CONSTANTS.TELEMETRY_EVENT_NAMES[event_name]))
+    telemetry_client.flush()

src/constants.ts

@@ -244,6 +244,13 @@ export enum TelemetryEventName {
   SIMULATOR_BUTTON_AB = "SIMULATOR.BUTTON.AB",
   SIMULATOR_SWITCH = "SIMULATOR.SWITCH",
 
+  //Sensors
+  SIMULATOR_TEMPERATURE_SENSOR = "SIMULATOR.TEMPERATURE",
+  SIMULATOR_LIGHT_SENSOR = " SIMULATOR.LIGHT",
+  SIMULATOR_MOTION_SENSOR = "SIMULATOR.MOTION",
+  SIMULATOR_SHAKE = "SIMULATOR.SHAKE",
+  SIMULATOR_CAPACITIVE_TOUCH = "SIMULATOR.CAPACITIVE.TOUCH",
+
   // Pop-up dialog
   CLICK_DIALOG_DONT_SHOW = "CLICK.DIALOG.DONT.SHOW",
   CLICK_DIALOG_EXAMPLE_CODE = "CLICK.DIALOG.EXAMPLE.CODE",
@@ -267,7 +274,8 @@ export enum WebviewMessages {
   BUTTON_PRESS = "button-press",
   PLAY_SIMULATOR = "play-simulator",
   SENSOR_CHANGED = "sensor-changed",
-  REFRESH_SIMULATOR = "refresh-simulator"
+  REFRESH_SIMULATOR = "refresh-simulator",
+  SLIDER_TELEMETRY = "slider-telemetry"
 }
 
 // tslint:disable-next-line: no-namespace

src/extension.ts

@@ -131,6 +131,7 @@ export async function activate(context: vscode.ExtensionContext) {
                 }
                 break;
               case WebviewMessages.SENSOR_CHANGED:
+                checkForTelemetry(message.text);
                 console.log(`Sensor changed ${messageJson} \n`);
                 if (inDebugMode && debuggerCommunicationHandler) {
                   debuggerCommunicationHandler.emitSensorChanged(messageJson);
@@ -142,6 +143,9 @@ export async function activate(context: vscode.ExtensionContext) {
                 console.log("Refresh button");
                 runSimulatorCommand();
                 break;
+              case WebviewMessages.SLIDER_TELEMETRY:
+                handleSensorTelemetry(message.text);
+                break;
               default:
                 vscode.window.showInformationMessage(
                   CONSTANTS.ERROR.UNEXPECTED_MESSAGE
@@ -743,6 +747,45 @@ const handleButtonPressTelemetry = (buttonState: any) => {
   }
 };
 
+const handleSensorTelemetry = (sensor: string) => {
+  switch (sensor) {
+    case "temperature":
+      telemetryAI.trackFeatureUsage(
+        TelemetryEventName.SIMULATOR_TEMPERATURE_SENSOR
+      );
+      break;
+    case "light":
+      telemetryAI.trackFeatureUsage(TelemetryEventName.SIMULATOR_LIGHT_SENSOR);
+      break;
+    case "motion_x":
+      telemetryAI.trackFeatureUsage(TelemetryEventName.SIMULATOR_MOTION_SENSOR);
+      break;
+    case "motion_y":
+      telemetryAI.trackFeatureUsage(TelemetryEventName.SIMULATOR_MOTION_SENSOR);
+      break;
+    case "motion_z":
+      telemetryAI.trackFeatureUsage(TelemetryEventName.SIMULATOR_MOTION_SENSOR);
+      break;
+    case "shake":
+      telemetryAI.trackFeatureUsage(TelemetryEventName.SIMULATOR_SHAKE);
+      break;
+    case "touch":
+      telemetryAI.trackFeatureUsage(
+        TelemetryEventName.SIMULATOR_CAPACITIVE_TOUCH
+      );
+      break;
+  }
+};
+
+const checkForTelemetry = (sensorState: any) => {
+  if (sensorState["shake"]) {
+    console.log(`telemtry sending`);
+    handleSensorTelemetry("shake");
+  } else if (sensorState["touch"]) {
+    handleSensorTelemetry("touch");
+  }
+};
+
 const updatePythonExtraPaths = () => {
   const pathToLib: string = __dirname;
   const currentExtraPaths: string[] =
@@ -780,6 +823,7 @@ function getWebviewContent(context: vscode.ExtensionContext) {
           </html>`;
 }
 
+// this method is called when your extension is deactivated
 export async function deactivate() {
   const monitor: SerialMonitor = SerialMonitor.getInstance();
   await monitor.closeSerialMonitor(null, false);

src/process_user_code.py

@@ -32,7 +32,6 @@ def __init__(self):
         threading.Thread.__init__(self)
 
     def run(self):
-        from adafruit_circuitplayground.express import cpx
         while True:
             read_val = sys.stdin.readline()
             sys.stdin.flush()

src/python_constants.py

@@ -13,7 +13,8 @@
     "shake",
     "motion_x",
     "motion_y",
-    "motion_z"
+    "motion_z",
+    "touch"
 ]
 
 EXEC_COMMAND = "exec"

src/requirements.txt

@@ -1,3 +1,4 @@
 playsound
 pytest
+applicationinsights
 python-socketio