Skip to content

Commit e221e8d

Browse files
committed
Clarify values not saved by OTOS in examples
1 parent e96647d commit e221e8d

File tree

3 files changed

+15
-9
lines changed

3 files changed

+15
-9
lines changed

examples/Example2_SetUnits/Example2_SetUnits.ino

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ void setup()
2323

2424
// Set the desired units for linear and angular measurements. Can be either
2525
// meters or inches for linear, and radians or degrees for angular. If not
26-
// set, the default is inches and degrees.
26+
// set, the default is inches and degrees. Note that this setting is not
27+
// stored in the sensor, it's part of the library, so you need to set at the
28+
// start of all your programs.
2729
myOtos.setLinearUnit(kOtosLinearUnitMeters);
2830
// myOtos.setLinearUnit(kOtosLinearUnitInches);
2931
myOtos.setAngularUnit(kOtosAngularUnitRadians);

examples/Example3_Calibration/Example3_Calibration.ino

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,15 @@ void setup()
2222
Serial.println("OTOS connected!");
2323

2424
// The IMU on the OTOS includes a gyroscope and accelerometer, which could
25-
// have an offset. The OTOS performs a quick calibration when it powers up,
26-
// but it is recommended to perform a more thorough calibration at the start
27-
// of your programs. Note that the sensor must be completely stationary and
28-
// flat during calibration! When calling calibrateImu(), you can specify the
29-
// number of samples to take and whether to wait until the calibration is
30-
// complete. If no parameters are provided, it will take 255 samples and
31-
// wait until done; each sample takes about 1.2ms, so about 306ms total
25+
// have an offset. Note that as of firmware version 1.0, the calibration
26+
// will be lost after a power cycle; the OTOS performs a quick calibration
27+
// when it powers up, but it is recommended to perform a more thorough
28+
// calibration at the start of all your programs. Note that the sensor must
29+
// be completely stationary and flat during calibration! When calling
30+
// calibrateImu(), you can specify the number of samples to take and whether
31+
// to wait until the calibration is complete. If no parameters are provided,
32+
// it will take 255 samples and wait until done; each sample takes about
33+
// 1.2ms, so about 306ms total
3234
myOtos.calibrateImu();
3335
// myOtos.calibrateImu(255, true);
3436

examples/Example4_SetOffsetAndPosition/Example4_SetOffsetAndPosition.ino

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ void setup()
2323

2424
// Here you can set the offset for the sensor relative to the center of the
2525
// robot. The units default to inches and degrees, but if you want to use
26-
// different units, specify them before setting the offset! For example, if
26+
// different units, specify them before setting the offset! Note that as of
27+
// firmware version 1.0, these values will be lost after a power cycle, so
28+
// you will need to set them each time you power up the sensor. For example, if
2729
// the sensor is mounted 5 inches to the left (negative X) and 10 inches
2830
// forward (positive Y) of the center of the robot, and mounted 90 degrees
2931
// clockwise (negative rotation) from the robot's orientation, the offset

0 commit comments

Comments
 (0)