Merge pull request #197 from cortex-lab/dev_errormessages

add informative error messages to water valve calibration code

Author: k1o0

+hw/WeighingScale.m

@@ -51,6 +51,7 @@ function init(obj)
             % Do nothing
         end
       end
+      obj.tare(); % Tare the scale to ensure LastGrams is never empty
     end
 
     function cleanup(obj)

+hw/calibrate.m

@@ -9,6 +9,11 @@
 
 % 2013-01 CB created
 
+
+% Check that the scale is initialized
+if isempty(scales.Port) || isempty(scales.readGrams)
+    error('Rigbox:hw:calibrate:noscales', 'Unable to communicate with scale. Scales object is not properly initialized')
+end
 % tMin = 30/1000;
 % tMax = 80/1000;
 interval = 0.1;
@@ -34,34 +39,41 @@
 
 origParamsFun = signalGen.ParamsFun;
 
-%deliver some just to get the scales to a new reading
+% deliver some just to check scales are registering changes
+fprintf('Checking the scale...\n');
+
 signalGen.ParamsFun = @(sz) deal(sz(1), sz(3), 1/sum(sz(1:2)));
 
+prevWeight = scales.readGrams;
+rewardController.command([tMax; interval; 50], 'foreground');
+pause(settleWait);
+newWeight = scales.readGrams;
+assert(newWeight > prevWeight + 0.02, ...
+    'Rigbox:hw:calibrate:deadscale',...
+    'Error: Scale is not registering changes in weight. Confirm scale is properly connected and that water is landing into the dish')
+
+prevWeight = newWeight;
+fprintf('Initial scale reading is %.2fg\n', prevWeight);
+
+startTime = GetSecs;
+fprintf('Deliveries will take approximately %.0f minute(s)\n', ceil(approxTime/60));
+
 try
-  % rewardController.deliverMultiple(tMax, interval, 50, true);
-  rewardController.command([tMax; interval; 50], 'foreground');
-  pause(settleWait);
-  prevWeight = scales.readGrams; %now take initial reading
-  fprintf('Initial scale reading is %.2fg\n', prevWeight);
-
-  startTime = GetSecs;
-  fprintf('Deliveries will take approximately %.0f minute(s)\n', ceil(approxTime/60));
-
-  for j = 1:size(t,2)
-    for i = 1:size(t,1)
-      rewardController.command([t(i,j); interval; n(i,j)], 'foreground');
-      % wait just a moment for drops to settle
-      pause(settleWait);
-      newWeight = scales.readGrams;
-      dw(i,j) = newWeight - prevWeight;
-      prevWeight = newWeight;
-      ml = dw(i,j)/n(i,j);
-      fprintf('Weight delta = %.2fg. Delivered %ful per %fms\n', dw(i,j), 1000*ml, 1000*t(i,j));
+    for j = 1:size(t,2)
+        for i = 1:size(t,1)
+            rewardController.command([t(i,j); interval; n(i,j)], 'foreground');
+            % wait just a moment for drops to settle
+            pause(settleWait);
+            newWeight = scales.readGrams;
+            dw(i,j) = newWeight - prevWeight;
+            prevWeight = newWeight;
+            ml = dw(i,j)/n(i,j);
+            fprintf('Weight delta = %.2fg. Delivered %ful per %fms\n', dw(i,j), 1000*ml, 1000*t(i,j));
+        end
     end
-  end
 catch ex
-  signalGen.ParamsFun = origParamsFun;
-  rethrow(ex)
+    signalGen.ParamsFun = origParamsFun;
+    rethrow(ex)
 end
 signalGen.ParamsFun = origParamsFun;
 
@@ -74,8 +86,8 @@
 %from the data, make a measuredDelivery structure
 ul = 1000*mean(dw./n, 1);
 calibration = struct(...
-  'durationSecs', num2cell(t(1,:)),...
-  'volumeMicroLitres', num2cell(ul));
+    'durationSecs', num2cell(t(1,:)),...
+    'volumeMicroLitres', num2cell(ul));
 signalGen.Calibrations(end + 1).dateTime = now;
 signalGen.Calibrations(end).measuredDeliveries = calibration;
 

CHANGELOG.md

@@ -7,5 +7,6 @@ Starting after Rigbox 2.2.0, this file contains a curated, chronologically order
 - Patch in alyx-matlab submodule 2019-07-25
 - updated Signals performance test `993d906` 2019-07-19
 - fixes to tests for the Alyx Panel `eb5e9b9` 2019-07-19
+- improvements to water expServer calibration function `dd0adb7` 2019-08-14
 
 ## [2.2.1](https://github.com/cortex-lab/Rigbox/releases/tag/v2.2.1) (Most Recent Stable Version)