PhidgetSpatial |
A class for controlling a PhidgetSpatial. See your product manual for more specific API details, supported functionality, units, etc.
| PhidgetSpatial | A class for controlling a PhidgetSpatial. |
| Events | Events supported by PhidgetSpatial. |
| Properties and Functions | |
| AccelerationAxisCount | Gets the number of acceleration axes. |
| getAcceleration | Gets the acceleration of a axis. |
| getAccelerationMin | Gets the minimum acceleration that an axis will return. |
| getAccelerationMax | Gets the maximum acceleration that an axis will return. |
| GyroAxisCount | Gets the number of gyroscope axes. |
| getAngularRate | Gets the angularRate of a axis. |
| getAngularRateMin | Gets the minimum angularRate that an axis will return. |
| getAngularRateMax | Gets the maximum angularRate that an axis will return. |
| CompassAxisCount | Gets the number of compass axes. |
| getMagneticField | Gets the magneticField of a axis. |
| getMagneticFieldMin | Gets the minimum magneticField that an axis will return. |
| getMagneticFieldMax | Gets the maximum magneticField that an axis will return. |
| DataRate | Gets the data rate, in milliseconds. |
| DataRateMin | Gets the minimum data rate, in milliseconds. |
| DataRateMax | Gets the maximum data rate, in milliseconds. |
| setDataRate | Sets the data rate for a sensor, in milliseconds. |
| zeroGyro | Re-Zeroes the gyro. |
| setCompassCorrectionParameters | Sets the compass correction factors. |
| setCompassCorrectionParameters | Sets the compass correction factors. |
public function setCompassCorrectionParameters( magField: Number, offset0: Number, offset1: Number, offset2: Number, gain0: Number, gain1: Number, gain2: Number, T0: Number, T1: Number, T2: Number, T3: Number, T4: Number, T5: Number ):void
Sets the compass correction factors. This can be used to correcting any sensor errors, including hard and soft iron offsets and sensor error factors.
| magField | Local magnetic field strength. |
| offset0 | Axis 0 offset correction. |
| offset1 | Axis 1 offset correction. |
| offset2 | Axis 2 offset correction. |
| gain0 | Axis 0 gain correction. |
| gain1 | Axis 1 gain correction. |
| gain2 | Axis 2 gain correction. |
| T0 | Non-orthogonality correction factor 0. |
| T1 | Non-orthogonality correction factor 1. |
| T2 | Non-orthogonality correction factor 2. |
| T3 | Non-orthogonality correction factor 3. |
| T4 | Non-orthogonality correction factor 4. |
| T5 | Non-orthogonality correction factor 5. |
public function resetCompassCorrectionParameters():void
Sets the compass correction factors. This can be used to correcting any sensor errors, including hard and soft iron offsets and sensor error factors.
| magField | Local magnetic field strength. |
| offset0 | Axis 0 offset correction. |
| offset1 | Axis 1 offset correction. |
| offset2 | Axis 2 offset correction. |
| gain0 | Axis 0 gain correction. |
| gain1 | Axis 1 gain correction. |
| gain2 | Axis 2 gain correction. |
| T0 | Non-orthogonality correction factor 0. |
| T1 | Non-orthogonality correction factor 1. |
| T2 | Non-orthogonality correction factor 2. |
| T3 | Non-orthogonality correction factor 3. |
| T4 | Non-orthogonality correction factor 4. |
| T5 | Non-orthogonality correction factor 5. |
Gets the number of acceleration axes.
public function get AccelerationAxisCount():int
Gets the acceleration of a axis.
public function getAcceleration( index: int ):Number
Gets the minimum acceleration that an axis will return.
public function getAccelerationMin( index: int ):Number
Gets the maximum acceleration that an axis will return.
public function getAccelerationMax( index: int ):Number
Gets the number of gyroscope axes.
public function get GyroAxisCount():int
Gets the angularRate of a axis.
public function getAngularRate( index: int ):Number
Gets the minimum angularRate that an axis will return.
public function getAngularRateMin( index: int ):Number
Gets the maximum angularRate that an axis will return.
public function getAngularRateMax( index: int ):Number
Gets the number of compass axes.
public function get CompassAxisCount():int
Gets the magneticField of a axis.
public function getMagneticField( index: int ):Number
Gets the minimum magneticField that an axis will return.
public function getMagneticFieldMin( index: int ):Number
Gets the maximum magneticField that an axis will return.
public function getMagneticFieldMax( index: int ):Number
Gets the data rate, in milliseconds.
public function get DataRate():int
Gets the minimum data rate, in milliseconds.
public function get DataRateMin():int
Gets the maximum data rate, in milliseconds.
public function get DataRateMax():int
Re-Zeroes the gyro.
public function zeroGyro( val: int ):void
Sets the compass correction factors.
public function setCompassCorrectionParameters( magField: Number, offset0: Number, offset1: Number, offset2: Number, gain0: Number, gain1: Number, gain2: Number, T0: Number, T1: Number, T2: Number, T3: Number, T4: Number, T5: Number ):void