Updated purpose of 'manufacturer_name'

iohub eye tracker device manufacturer_name is used by Builder as the name to display in the eye tracker interface selection list.
psychopy · Mar 17, 2021 · ebbfaf3 · ebbfaf3
1 parent de32c3e
commit ebbfaf3
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 9 deletions.
diff --git a/psychopy/iohub/devices/eyetracker/default_eyetracker.yaml b/psychopy/iohub/devices/eyetracker/default_eyetracker.yaml
@@ -19,8 +19,8 @@ eyetracker.EyeTrackerDevice:
     # Some implementations of the eye tracker interface will use this value to determine 
     # the appropriate logic to be run for a given eye tracker model supported by the vendor implementation. 
     model_name: Default
-    # manufacturer_name can be used to store the name of the maker of the eye tracking
-    # device being used. This is for informational purposes only.
+    # manufacturer_name: Used by Builder as the displayed name in the eye tracker selection dropdown.
+    #
     manufacturer_name: Unknown
     # serial_number can be used to store the unique serial number of the eye tracking
     # device being used. This is for informational purposes only. The serial number should be in

diff --git a/psychopy/iohub/devices/eyetracker/hw/gazepoint/gp3/default_eyetracker.yaml b/psychopy/iohub/devices/eyetracker/hw/gazepoint/gp3/default_eyetracker.yaml
@@ -55,8 +55,8 @@ eyetracker.hw.gazepoint.gp3.EyeTracker:
     # The model name of the device.
     model_name: GP3
 
-    # manufacturer_name is used to store the name of the maker of the eye tracking
-    # device. This is for informational purposes only.
+    # manufacturer_name: Used by Builder as the displayed name in the eye tracker selection dropdown.
+    #
     manufacturer_name: GazePoint
 
     # Do not change this value.

diff --git a/psychopy/iohub/devices/eyetracker/hw/sr_research/eyelink/default_eyetracker.yaml b/psychopy/iohub/devices/eyetracker/hw/sr_research/eyelink/default_eyetracker.yaml
@@ -211,10 +211,9 @@ eyetracker.hw.sr_research.eyelink.EyeTracker:
     #       'EYELINK 1000 LONG RANGE'
     model_name: EYELINK 1000 DESKTOP
 
-    # manufacturer_name:    manufacturer_name is used to store the name of the
-    #   maker of the eye tracking device. This is for informational purposes only.
+    # manufacturer_name: Used by Builder as the displayed name in the eye tracker selection dropdown.
     #
-    manufacturer_name: SR Research Ltd.
+    manufacturer_name: SR Research Ltd
 
     # device_number: The device number to assign to the Analog Input device. 
     #   device_number is not used by this device type.

diff --git a/psychopy/iohub/devices/eyetracker/hw/sr_research/eyelink/supported_config_settings.yaml b/psychopy/iohub/devices/eyetracker/hw/sr_research/eyelink/supported_config_settings.yaml
@@ -90,6 +90,8 @@ eyetracker.hw.sr_research.eyelink.EyeTracker:
             min_length: 0
             max_length: 1            
     device_number: 0
+    # manufacturer_name:    Used by Builder as the displayed name in the eye tracker selection dropdown.
+    #
     manufacturer_name:
         IOHUB_STRING:
             min_length: 1

diff --git a/psychopy/iohub/devices/eyetracker/hw/tobii/default_eyetracker.yaml b/psychopy/iohub/devices/eyetracker/hw/tobii/default_eyetracker.yaml
@@ -156,8 +156,8 @@ eyetracker.hw.tobii.EyeTracker:
         # Tobii supports BINOCULAR tracking mode only.
         track_eyes: BINOCULAR
 
-    # manufacturer_name is used to store the name of the maker of the eye tracking
-    # device. This is for informational purposes only.
+    # manufacturer_name: Used by Builder as the displayed name in the eye tracker selection dropdown.
+    #
     manufacturer_name: Tobii Technology
 
     # Do not change this value.

diff --git a/psychopy/iohub/devices/eyetracker/supported_config_settings.yaml b/psychopy/iohub/devices/eyetracker/supported_config_settings.yaml
@@ -34,6 +34,8 @@ eyetracker.EyeTrackerDevice:
             min_length: 1
             max_length: 32
     device_number: 0
+    # manufacturer_name: Used by Builder as the displayed name in the eye tracker selection dropdown.
+    #
     manufacturer_name:
         IOHUB_STRING:
             min_length: 1