Solidify hardware channel specification to 'doX'.

This allows for correct auto widget creation.
It also move specification out of hex to to decimal, matching the labeling of the GPIO pins.

Author: dihm

docs/source/devices/prawndo.rst

@@ -45,16 +45,15 @@ Usage
 
 The pinout for the PrawnDO is as follows:
 
-* Outputs 0-15 (labelled by default in hex 0-F): GPIO pins 0-15, respectively.
+* Outputs 0-15: GPIO pins 0-15, respectively.
 * External Trigger input: GPIO 16
 * External Clock input: GPIO 20
 
 Note that signal cables should be connected to the Pico digital grounds for proper operation.
 
 The PrawnDO can provide up to 16 digital outputs, which are accessed via `name.outputs`.
-Each channel is specified using the corresponding hex character (spanning 0-F for 0-15).
-The channel string must end with a single character between 0-F to be valid
-(i.e. `'flag 0'`, `'do 0'`, and `'0'` are all valid channel specifications for GPIO 0 of the PrawnDO).
+Each channel is specified using with a string of the form `'doD'`, where `'D'` is the GPIO number
+(i.e. `'do10'`, is the specification for GPIO 10 of the PrawnDO).
 
 An example connection table that uses the PrawnBlaster and PrawnDO:
 
@@ -69,9 +68,9 @@ An example connection table that uses the PrawnBlaster and PrawnDO:
 
     PrawnDO(name='prawn_do', com_port='COM5', clock_line=prawn.clocklines[0])
 
-    DigitalOut('do0', prawn_do.outputs, 'flag 0')
-    DigitalOut('do1', prawn_do.outputs, 'chan 1')
-    DigitalOut('do10', prawn_do.outputs, 'flag C')
+    DigitalOut('do0', prawn_do.outputs, 'do0')
+    DigitalOut('do1', prawn_do.outputs, 'do1')
+    DigitalOut('do12', prawn_do.outputs, 'do12')
 
     if __name__ == "__main__":
 
@@ -138,9 +137,9 @@ An example connection table using external clocks with the default frequency of
     PrawnDO(name='prawn_do', com_port='COM5', clock_line=prawn.clocklines[0],
             external_clock=True)
 
-    DigitalOut('do0', prawn_do.outputs, 'flag 0')
-    DigitalOut('do1', prawn_do.outputs, 'chan 1')
-    DigitalOut('do10', prawn_do.outputs, 'flag C')
+    DigitalOut('do0', prawn_do.outputs, 'do0')
+    DigitalOut('do1', prawn_do.outputs, 'do1')
+    DigitalOut('do12', prawn_do.outputs, 'do12')
 
     if __name__ == "__main__":
 
@@ -172,7 +171,7 @@ the second instruction (`do0.go_low(t)`) must be at least 5 clock cycles after t
 .. code-block:: python
 
     t = 0
-    do.go_high(t)
+    do0.go_high(t)
     t = 1e-3
     wait('my_wait', t)
     do0.go_low(t)

labscript_devices/PrawnDO/blacs_tabs.py

@@ -16,11 +16,14 @@ class PrawnDOTab(DeviceTab):
     def initialise_GUI(self):
         do_prop = {}
         for i in range(0, 16):
-            do_prop['0x{:01X}'.format(i)] = {}
+            do_prop['do{:01d}'.format(i)] = {}
         self.create_digital_outputs(do_prop)
 
+        def sort(channel):
+            return int(channel.split('do')[-1])
+
         _, _, do_widgets = self.auto_create_widgets()
-        self.auto_place_widgets(do_widgets)
+        self.auto_place_widgets(('Digital Outputs', do_widgets, sort))
 
         device = self.settings['connection_table'].find_by_name(self.device_name)
 

labscript_devices/PrawnDO/blacs_workers.py

@@ -173,7 +173,7 @@ def _dict_to_int(self, d):
         """
         val = 0
         for conn, value in d.items():
-            val |= value << int(conn, 16)
+            val |= value << int(conn)
 
         return val
 
@@ -186,7 +186,7 @@ def _int_to_dict(self, val):
         Returns:
             dict: Dictonary with output channels as keys and values are boolean states
         """
-        return {f'0x{i:X}':((val >> i) & 1) for i in range(16)}
+        return {f'do{i:d}':((val >> i) & 1) for i in range(16)}
 
     def check_status(self):
         '''Checks operational status of the PrawnDO.

labscript_devices/PrawnDO/labscript_devices.py

@@ -58,10 +58,7 @@ def add_device(self, device):
 class _PrawnDigitalOutputs(IntermediateDevice):
     allowed_children = [DigitalOut]
 
-    allowed_channels = ('0', '1', '2', '3',
-                        '4', '5', '6', '7',
-                        '8', '9', 'A', 'B',
-                        'C', 'D', 'E', 'F')
+    allowed_channels = tuple(range(16))
 
     def __init__(self, name, parent_device,
                  **kwargs):
@@ -88,7 +85,7 @@ def add_device(self, device):
         """
 
         conn = device.connection
-        chan = conn.split(' ')[-1]
+        chan = int(conn.split('do')[-1])
 
         if chan not in self.allowed_channels:
             raise LabscriptError(f'Invalid channel specification: {conn}')
@@ -268,8 +265,8 @@ def generate_code(self, hdf5_file):
         # as the output word for the pins
         for output in outputs:  
             output.make_timeseries(times)
-            chan = output.connection.split(' ')[-1]
-            bits[int(chan, 16)] = np.asarray(output.timeseries, dtype = np.uint16)
+            chan = int(output.connection.split('do')[-1])
+            bits[chan] = np.asarray(output.timeseries, dtype = np.uint16)
         # Merge list of lists into an array with a single 16 bit integer column
         bit_sets = np.array(bitfield(bits, dtype=np.uint16))