Updated README to reflect boolean return from getMotorReady

scanse · Apr 19, 2017 · dca2eff · dca2eff
1 parent 90d397e
commit dca2eff
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/sweepjs/README.md b/sweepjs/README.md
@@ -42,10 +42,10 @@ sweep = new Sweep('/dev/ttyUSB0');
 sweep.startScanning();
 sweep.stopScanning();
 
-// waits until motor is ready
+// waits until device is ready (calibration routine complete and motor speed stabilized)
 sweep.waitUntilMotorReady();
-// code === 0 -> ready (motor ready), code !== 0 -> not ready
-code = sweep.getMotorReady();
+// ready === true if device is ready, false otherwise
+ready = sweep.getMotorReady();
 // integer value between 0:10 (in HZ)
 speed = sweep.getMotorSpeed();
 // integer value between 0:10 (in HZ)

diff --git a/sweeppy/README.md b/sweeppy/README.md
@@ -63,7 +63,7 @@ class Sweep:
     def stop_scanning(self) -> None
 
     def wait_until_motor_ready(self) -> None
-    def get_motor_ready(self) -> int (0 indicates motor is ready)
+    def get_motor_ready(self) -> bool
     def get_motor_speed(self) -> int (Hz)
     def set_motor_speed(self, speed) -> None