Merge branch 'beta' into release

Pilar-TG0 · Pilar-TG0 · commit bf7abb6d7377 · 2023-04-13T16:52:08.000+01:00
diff --git a/etee/_version.py b/etee/_version.py
@@ -1 +1 @@
-__version__ = "1.0.0"
+__version__ = "1.0.1"
diff --git a/etee/driver_eteecontroller.py b/etee/driver_eteecontroller.py
@@ -118,17 +118,17 @@ def __init__(self):
         :type: Event """
 
         self.left_hand_lost = EteeControllerEvent()
-        """Event for losing left controller connection. Occurs when data is not received for more than 0.5 seconds.
+        """Event for losing left controller connection. Occurs when data is not received for more than 1.5 seconds.
         
         :type: Event """
 
         self.right_hand_lost = EteeControllerEvent()
-        """Event for losing right controller connection. Occurs when data is not received for more than 0.5 seconds.
+        """Event for losing right controller connection. Occurs when data is not received for more than 1.5 seconds.
         
         :type: Event """
 
         self.data_lost = EteeControllerEvent()
-        """Event for losing data from both controllers. Occurs when data is not received for more than 0.5 seconds.
+        """Event for losing data from both controllers. Occurs when data is not received for more than 1.5 seconds.
         
         :type: Event """
 
@@ -256,7 +256,6 @@ def _api_data_callback(self, frameno, data):
         :param dict data: Dictionary of the parsed controller data.
         """
         if data["hand"] == 0:
-            # print(time.time() - self.hand_last_on_left)
             self._api_data_left = data
             self._hand_last_on_left = time.time()
             self._frameno_left += 1
@@ -272,10 +271,10 @@ def _api_data_callback(self, frameno, data):
 
         self.hand_received.emit()
 
-        if time.time() - self._hand_last_on_left > 0.1 and self._api_data_left is not None:
+        if (time.time() - self._hand_last_on_left) > 1.5 and self._api_data_left is not None:
             self._api_data_left = None
             self.left_hand_lost.emit()
-        if time.time() - self._hand_last_on_right > 0.1 and self._api_data_left is not None:
+        if (time.time() - self._hand_last_on_right) > 1.5 and self._api_data_right is not None:
             self._api_data_right = None
             self.right_hand_lost.emit()
 
@@ -314,8 +313,8 @@ def _rest_callback(self, reading):
         """
         if reading is not None:
             return
-        left_lost = time.time() - self._hand_last_on_left > 0.1 and self._api_data_left is not None
-        right_lost = time.time() - self._hand_last_on_right > 0.1 and self._api_data_right is not None
+        left_lost = (time.time() - self._hand_last_on_left) > 1.5 and self._api_data_left is not None
+        right_lost = (time.time() - self._hand_last_on_right) > 1.5 and self._api_data_right is not None
         if left_lost:
             self._api_data_left = None
             self.left_hand_lost.emit()
@@ -531,7 +530,7 @@ def all_hands_on(self):
         :return: Returns true if data has been recently received from both controllers.
         :rtype: bool
         """
-        return (self.get_left is not None) and (self.get_right is not None)
+        return (self._api_data_left is not None) and (self._api_data_right is not None)
 
     def any_hand_on(self):
         """
diff --git a/examples/01_Retrieving_Data/right_index_events_based.py b/examples/01_Retrieving_Data/right_index_events_based.py
@@ -15,6 +15,9 @@
 
 
 def process_right_index():
+    """
+    Retrieve the pressure data for the right index finger from the etee driver. Print the values.
+    """
     right_index_pull = etee.get_index_pull('right')
     right_index_force = etee.get_index_force('right')
     current_time = datetime.now().strftime("%H:%M:%S.%f")
diff --git a/examples/01_Retrieving_Data/right_index_getter_function.py b/examples/01_Retrieving_Data/right_index_getter_function.py
@@ -16,6 +16,12 @@
 
 
 def process_right_index():
+    """
+    Retrieve the pressure data for the right index finger from the etee driver.
+
+    :return: Index finger pull pressure and force pressure, from the right eteeController.
+    :rtype: int, int
+    """
     right_index_pull = etee.get_index_pull('right')
     right_index_force = etee.get_index_force('right')
     return right_index_pull, right_index_force
diff --git a/examples/02_Print_Data/print_etee_euler_angles.py b/examples/02_Print_Data/print_etee_euler_angles.py
@@ -16,6 +16,9 @@
 
 
 def print_title():
+    """
+    Print CLI graphics for the application title.
+    """
     print("======================================================")
     print(r"        __               ___    ____  ____")
     print(r"  ___  / /____  ___     /   |  / __ \/  _/")
diff --git a/examples/02_Print_Data/print_etee_finger_data.py b/examples/02_Print_Data/print_etee_finger_data.py
@@ -13,6 +13,15 @@
 
 
 def process_finger(dev, finger):
+    """
+    Retrieve the selected device's finger values from the etee driver.
+
+    :param str dev: Selected device hand. Possible values: "left", "right".
+    :param str finger: Selected finger. Possible values: "thumb", "index", "middle", "ring", "pinky".
+    :return: Array containing the selected controller's index finger values: pull pressure, force pressure,
+    touch and click.
+    :rtype: list[Any]
+    """
     finger_pull = finger + "_pull"
     finger_force = finger + "_force"
     finger_touch = finger + "_touched"
@@ -24,6 +33,9 @@ def process_finger(dev, finger):
 
 
 def print_title():
+    """
+    Print CLI graphics for the application title.
+    """
     print("======================================================")
     print(r"        __               ___    ____  ____")
     print(r"  ___  / /____  ___     /   |  / __ \/  _/")
diff --git a/examples/02_Print_Data/print_etee_fingers_all_data.py b/examples/02_Print_Data/print_etee_fingers_all_data.py
@@ -14,6 +14,9 @@
 
 
 def print_title():
+    """
+    Print CLI graphics for the application title.
+    """
     print("======================================================")
     print(r"        __               ___    ____  ____")
     print(r"  ___  / /____  ___     /   |  / __ \/  _/")
diff --git a/examples/02_Print_Data/print_etee_imu.py b/examples/02_Print_Data/print_etee_imu.py
@@ -13,6 +13,9 @@
 
 
 def print_title():
+    """
+    Print CLI graphics for the application title.
+    """
     print("======================================================")
     print(r"        __               ___    ____  ____")
     print(r"  ___  / /____  ___     /   |  / __ \/  _/")
@@ -25,6 +28,14 @@ def print_title():
 
 
 def adjust_imu(original_arr, offsets_arr):
+    """
+    Apply offsets to the original array.
+
+    :param list[int] original_arr: Original IMU (i.e. accel, gyro or mag) XYZ array without offsets.
+    :param list[int] offsets_arr: Array of XYZ offsets to be applied to the original array.
+    :return: Adjusted IMU array after applying offsets.
+    :rtype: list[int]
+    """
     adj_arr = [0, 0, 0]
     if original_arr is None or offsets_arr is None:
         pass
diff --git a/examples/02_Print_Data/print_etee_quaternions.py b/examples/02_Print_Data/print_etee_quaternions.py
@@ -14,6 +14,9 @@
 
 
 def print_title():
+    """
+    Print CLI graphics for the application title.
+    """
     print("======================================================")
     print(r"        __               ___    ____  ____")
     print(r"  ___  / /____  ___     /   |  / __ \/  _/")
diff --git a/examples/02_Print_Data/print_etee_slider_data.py b/examples/02_Print_Data/print_etee_slider_data.py
@@ -13,13 +13,23 @@
 
 
 def process_slider(dev):
+    """
+    Retrieve the selected device's slider values from the etee driver.
+
+    :param str dev: Selected device hand. Possible values: "left", "right".
+    :return: Array containing the selected controller's slider values: Y-axis position, touch, up and down button values.
+    :rtype: list[Any]
+    """
     slider = [etee.get_slider_value(dev),
               etee.get_slider_touched(dev),
               etee.get_slider_up_button(dev), etee.get_slider_down_button(dev)]
     return slider
 
 
 def print_title():
+    """
+    Print CLI graphics for the application title.
+    """
     print("======================================================")
     print(r"        __               ___    ____  ____")
     print(r"  ___  / /____  ___     /   |  / __ \/  _/")
diff --git a/examples/02_Print_Data/print_etee_sliders_buttons.py b/examples/02_Print_Data/print_etee_sliders_buttons.py
@@ -13,16 +13,31 @@
 
 
 def process_left_slider_buttons():
+    """
+    Retrieve the left slider button values from the etee driver.
+
+    :return: Array containing the left controller's slider button values: up and down button states.
+    :rtype: list[bool]
+    """
     left_slider = [etee.get_slider_up_button('left'), etee.get_slider_down_button('left')]
     return left_slider
 
 
 def process_right_slider_buttons():
+    """
+    Retrieve the right slider button values from the etee driver.
+
+    :return: Array containing the right controller's slider button values: up and down button states.
+    :rtype: list[bool]
+    """
     right_slider = [etee.get_slider_up_button('right'), etee.get_slider_down_button('right')]
     return right_slider
 
 
 def print_title():
+    """
+    Print CLI graphics for the application title.
+    """
     print("======================================================")
     print(r"        __               ___    ____  ____")
     print(r"  ___  / /____  ___     /   |  / __ \/  _/")
@@ -35,6 +50,14 @@ def print_title():
 
 
 def check_controller_connection(left_data, right_data):
+    """
+    Check that both controllers are connected. If not, attempt re-connection.
+
+    :param str left_data: Left controller button values from the etee driver. If a controller disconnects, the values in the buffer will reset to None.
+    :param str right_data: Right controller button values from the etee driver. If a controller disconnects, the values in the buffer will reset to None.
+    :return: True if both controllers are still connected; False if otherwise
+    :rtype: bool
+    """
     connection = True
     if left_data[0] == None and right_data[0] == None:
         print("---")
@@ -56,6 +79,7 @@ def check_controller_connection(left_data, right_data):
         connection = False
     return connection
 
+
 if __name__ == "__main__":
     # Initialise the etee driver and find dongle
     etee = EteeController()
diff --git a/examples/02_Print_Data/print_etee_trackpad_data.py b/examples/02_Print_Data/print_etee_trackpad_data.py
@@ -13,13 +13,24 @@
 
 
 def process_trackpad(dev):
+    """
+    Retrieve the selected device's trackpad values from the etee driver.
+
+    :param str dev: Selected device hand. Possible values: "left", "right".
+    :return: Two arrays containing the selected controller's trackpad values. One containing the location
+    (X-axis position, Y-axis position), and another the pressure (pull pressure, force pressure, touch and click).
+    :rtype: list[int], list[Any]
+    """
     loc = [etee.get_data(dev, "trackpad_x"), etee.get_data(dev, "trackpad_y")]
     pressure = [etee.get_data(dev, "trackpad_pull"), etee.get_data(dev, "trackpad_force"),
                 etee.get_data(dev, "trackpad_touched"), etee.get_data(dev, "trackpad_clicked")]
     return loc, pressure
 
 
 def print_title():
+    """
+    Print CLI graphics for the application title.
+    """
     print("======================================================")
     print(r"        __               ___    ____  ____")
     print(r"  ___  / /____  ___     /   |  / __ \/  _/")
diff --git a/examples/03_Plot_Data/plot_etee_euler_angles.py b/examples/03_Plot_Data/plot_etee_euler_angles.py
@@ -15,6 +15,12 @@
 
 # Ask user to select between left or right controller
 def select_hand():
+    """
+    Request user to select a controller for the application through the CLI.
+
+    :return: Name of the controller selected, either "right" or "left".
+    :rtype: str
+    """
     # Prompt for user to select the hand to print values from
     print("Please, enter what controller hand you would like to print the values from. Valid options: right, left.")
     valid_controllers = ["right", "left"]
@@ -28,6 +34,15 @@ def select_hand():
 
 # This function is called periodically from FuncAnimation
 def animate(i, y_1, y_2, y_3):
+    """
+    Animate the graph functions.
+
+    :param list[int] y_1: Array of last values for the roll angle value.
+    :param list[int] y_2: Array of last values for the pitch angle value.
+    :param list[int] y_3: Array of last values for the yaw angle value.
+    :return: Updated lines with new Y values.
+    :rtype: line, line, line
+    """
     # Retrieve euler angles
     euler_angles_rad = etee.get_euler(device)
 
diff --git a/examples/03_Plot_Data/plot_etee_quaternions.py b/examples/03_Plot_Data/plot_etee_quaternions.py
@@ -13,6 +13,12 @@
 
 # Ask user to select between left or right controller
 def select_hand():
+    """
+    Request user to select a controller for the application through the CLI.
+
+    :return: Name of the controller selected, either "right" or "left".
+    :rtype: str
+    """
     # Prompt for user to select the hand to print values from
     print("Please, enter what controller hand you would like to print the values from. Valid options: right, left.")
     valid_controllers = ["right", "left"]
@@ -26,6 +32,16 @@ def select_hand():
 
 # This function is called periodically from FuncAnimation
 def animate(i, y_1, y_2, y_3, y_4):
+    """
+    Animate the graph functions.
+
+    :param list[int] y_1: Array of last values for the q0 quaternion value.
+    :param list[int] y_2: Array of last values for the q1 quaternion value.
+    :param list[int] y_3: Array of last values for the q2 quaternion value.
+    :param list[int] y_4: Array of last values for the q3 quaternion value.
+    :return: Updated lines with new Y values.
+    :rtype: line, line, line, line
+    """
     # Retrieve euler angles
     quaternions = etee.get_quaternion(device)
 

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__version__ = "1.0.0"`
	`1`	`+__version__ = "1.0.1"`