Difference between revisions of "1044 User Guide"

From Phidgets Support
Jump to: navigation, search
(Magnetic Error Correction (Calibration))
(Functions)
Line 190: Line 190:
  
 
===Functions===
 
===Functions===
 +
{{UGapi|void setCompassCorrectionParameters(double magField, double offset0, double offset1, double offset2, double gain0, double gain1, double gain2, double T0, double T1, double T2, double T3, double T4, double T5);
 +
|Sets correction parameters for the magnetometer. This can be used to correct for hard and soft iron offsets, bias errors in the magnetometer, etc. Generally useful for using the magnetometer as an electronic compass. The parameters are determined by the Compass Calibrator application included in the driver package.  The calibrator will also load the parameters onto the compass making this function generally not useful outside of specific corner cases.
 +
 +
'''Parameters:'''
 +
: '''magField:''' The reference field to use. Generally, use the local expected field strength, or 1.0.
 +
: '''offset0,1,2:''' Applies offset to the compass data in axes 0,1,2.
 +
: '''gain0,1,2:''' Applies gain corrections in axes 0,1,2.
 +
: '''T0,1,2,3,4,5:''' Applies corrections for non-orthogonality of the ellipsoid.
 +
}}
 +
 
{{UGapi|void zeroGyro();
 
{{UGapi|void zeroGyro();
 
|Re-zeroes the gyroscope. This takes 1-2 seconds of gyro samples and uses this data as a new zero point. The 1044 must remain stationary during the zeroing process. The angular rate will be reported as zero during zeroing.
 
|Re-zeroes the gyroscope. This takes 1-2 seconds of gyro samples and uses this data as a new zero point. The 1044 must remain stationary during the zeroing process. The angular rate will be reported as zero during zeroing.

Revision as of 18:25, 24 June 2013

1044.jpg
Go to this device's product page


Getting Started

Checking the Contents

You should have received:

  • A PhidgetSpatial 3/3/3 High Resolution
  • A Mini-B USB cable

Connecting the Pieces

Connect the PhidgetSpatial 3/3/3 to your PC using the Mini-B USB cable.

1056 0 Connecting The Hardware.jpg

Testing Using Windows 2000 / XP / Vista / 7

Make sure you have the current version of the Phidget library installed on your PC. If you don't, follow these steps:

  1. Go to the Quick Downloads section on the Windows page
  2. Download and run the Phidget21 Installer (32-bit, or 64-bit, depending on your system)
  3. You should see the Ph.jpg icon on the right hand corner of the Task Bar.

Running Phidgets Sample Program

Double clicking on the Ph.jpg icon loads the Phidget Control Panel; we will use this program to ensure that your new Phidget works properly.

The source code for the Spatial-full sample program can be found in the quick downloads section on the C# Language Page. If you'd like to see examples in other languages, you can visit our Languages page.

Updating Device Firmware

If an entry in this list is red, it means the firmware for that device is out of date. Double click on the entry to be given the option of updating the firmware. If you choose not to update the firmware, you can still run the example for that device after refusing.

Double Click on the Ph.jpg icon to activate the Phidget Control Panel and make sure that the Phidget Spatial 3/3/3 is properly attached to your PC.

1042 0 Control Panel.jpg
  1. Double Click on Phidget Spatial 3/3/3 in the Phidget Control Panel to bring up Spatial-full and check that the box labelled Attached contains the word True.
  2. You can adjust the Data Rate by moving the slider.
  3. Move the 1044 board around and you should see the data change to reflect the change of position along the 3 axes.
1042 0 Spatial Screen.jpg

Testing Using Mac OS X

  1. Go to the Quick Downloads section on the Mac OS X page
  2. Download and run the Phidget OS X Installer
  3. Click on System Preferences >> Phidgets (under Other) to activate the Preference Pane
  4. Make sure that the Phidget Spatial 3/3/3 is properly attached.
  5. Double Click on Phidget Spatial 3/3/3 in the Phidget Preference Pane to bring up the Spatial-full Sample program. This program will function in a similar way as the Windows version.

Using Linux

For a step-by-step guide on getting Phidgets running on Linux, check the Linux page.

Using Windows Mobile / CE 5.0 / CE 6.0

Template:UGce

Technical Details

High Resolution Mode

When the PhidgetSpatial High Resolution 3/3/3 measures an acceleration value with magnitude less than 2g, it will acquire its data from a higher precision accelerometer chip. For these measurements, the average white noise on each axis will be reduced by approximately a factor of ten, and the resolution will increase from 976 μg to 76 μg. Likewise, when the gyroscope measures a rotation value with magnitude less than 300 °/s on the Z-axis or 400 °/s on the X or Y-axis, the noise per axis will be approximately six times lower, and the resolution will increase from 0.07 °/s to 0.02 °/s. The transition from normal to high precision or vice-versa is seamless, with no additional code or equations needed.

3-Axis Accelerometer

The PhidgetSpatial 3/3/3 has a 3-Axis accelerometer that can measure ±8 g (±78 m/s2) per axis. It will measure both dynamic acceleration (change in velocity) and static acceleration (gravity vector).

For more information on how to use the accelerometer, check the Accelerometer Primer.

3-Axis Gyroscope

For more information on the gyroscope, see the Gyroscope Primer.

3-Axis Magnetometer (Compass)

The magnetometer reports the sum of all magnetic fields acting on the 1044 device. The earth’s magnetic field is only one source that affects this measurement. In order to get accurate bearing data from the magnetometer - ie. to find magnetic north as a compass - any interfering magnetic effects need to be calibrated out. For more information about calibration, see the section below, or the Compass Primer.

Any magnetic field that is stationary with respect to the 1044 device, and less than ± 3 Gauss, can be calibrated out of the magnetic field measurement. This includes both hard and soft iron effects caused by nearby ferrous and magnetic materials. Interfering magnetic fields that vary in strength and orientation with respect to the 1044 device cannot be easily calibrated out.

Magnetic field data will become unavailable during every other sample as the compass performs internal calibrations. When this happens, the magneticField array in the SpatialData structure will either have a length of zero, or each element will equal PUNK_DBL, depending on the API being used. This needs to be handled explicitly in the event handling code to avoid erroneous program behavior. The maximum sampling rate of the compass is 125 Hz.


Magnetic Error Correction (Calibration)

In order to get numbers of useful accuracy from the 1044's compass you will need to provide calibration parameters. To make determining them easy, we distribute a program with our drivers that does this for you.

To calibrate your compass:

Calibration1.png
  • Navigate to the Phidgets installation folder on your computer. Open the 'examples' folder and find the Compass Calibrator program.


Calibration2.png


Calibration3.png
  • Select your country and city. Click 'Get Location' and then 'Compute'. A table of values will show up in an overlaid window. The value you will need is the 'Total Field' value in nT.


Calibration4.png
  • Enter the magnetic field value into the calibration program.
  • Depending on what your application is this step as well as the next step might be a bit different. If you are intending on mounting the 1044 onto a large vehicle such as a car then you should mount the 1044 securely to the vehicle in its final intended position then check the 2-axis bubble, click the 'Start' button.
  • If you are using a smaller, more easily handled vehicle such as a small robot (something you could physically pick up) you will mount the 1044 and use the 3-axis calibration instead. Click 'Start'.


Calibration5.png
  • Rotate the compass around (including whatever equipment you have mounted it to) such that the red dots being generated on screen outline as much of a full sphere (in 3-axis) as possible. This will take several minutes. Being perfect is not necessary but try to be as thorough as time permits. Once done, click stop.
  • If you are in a large vehicle, you will be aiming to fill out a disc instead of a sphere (use the 2-axis mode for this). This can be done by simply driving around for a few minutes making sure to do complete 360° turns in the process.


Calibration6.png
  • The calibration tool will automatically write these values to the Flash memory on board and are remembered until the device is calibrated again.


For more information on magnetometers (compasses), see the Compass Primer.

API

Template:UGapih

Data Structures

SpatialData {

double acceleration[3];
double angularRate[3];
double magneticField[3];
Timestamp time;

};

Timestamp {

int seconds; -time since attach event
int microseconds; -time since last second

};

The SpatialData Structure is used by the OnSpatialData event. This contains acceleration data, angular rate data, magnetic field data, and a timestamp. The timestamp is an accurate measurement streamed from the hardware,and can be trusted over a local software timestamp. This timestamp is generally used for integrating angular rate into a heading over time.

Properties

Template:UGapi

Template:UGapi

Template:UGapi

Template:UGapi

Template:UGapi

Template:UGapi

Template:UGapi

Template:UGapi

Template:UGapi

Template:UGapi

Template:UGapi

Template:UGapi

Template:UGapi

Template:UGapi

Template:UGapi

Functions

Template:UGapi

Template:UGapi

Events

Template:UGapi

Product History

Template:UGhist Template:UGrow Template:UGrow