Notice: This page contains information for the legacy Phidget21 Library. Phidget21 does not support VINT Phidgets, and will not support any new Phidgets. Phidget21 will be maintained until 2020. We recommend that new projects be developed against the Phidget22 Library. Click on the button in the menu bar to go to the Phidget22 version of this page.

# 1056 User Guide

## Getting Started

### Checking the Contents

 You should have received: A PhidgetSpatial 3/3/3 A Mini-B USB cable

### Connecting the Pieces

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

### 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:

3. You should see the icon on the right hand corner of the Task Bar.

### Running Phidgets Sample Program

Double clicking on the 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 icon to activate the Phidget Control Panel and make sure that the Phidget Spatial 3/3/3 is properly attached to your PC. 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. You can adjust the Data Rate by moving the slider. Move the 1056 board around and you should see the data change to reflect the change of position along the 3 axes.

### Testing Using Mac OS X

1. Go to the Quick Downloads section on the Mac OS X page
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

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

## Technical Details

### 3-Axis Accelerometer

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

### 3-Axis Magnetometer (Compass)

The magnetometer reports the sum of all magnetic fields acting on the 1056 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 1056 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 1056 device cannot be easily calibrated out.

Magnetic field data will become unavailable for ~28ms every 2 seconds as the compass perform internal calibrations. During this time, polling the magnetic field will return EPHIDGET_UNKNOWNVAL, or throw an UNKNOWNVAL exception. The magnetic field data in the SpatialData event will equal PUNK_DBL.

#### Magnetic Error Correction (Calibration)

In order to get numbers of useful accuracy from the 1056'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.

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

• 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.

• Enter the magnetic field value into the calibration program. Note that it wants the field strength in Gauss, not nT like the website gives you. 1T = 10000 Gauss so you can divide by 1x10^5 to convert to Gauss.
• 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 1056 onto a large vehicle such as a car then you should mount the 1056 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 1056 and use the 3-axis calibration instead. Click 'Start'.

• 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. This can be done by simply driving around for a few minutes making sure to do complete ${\displaystyle 360^{o}}$ turns in the process.

• Take the parameters displayed in the text box and use them for your compass. For example in C#:

```
setCompassCorrectionParameters(0.51075, 0.18820, -0.07456, -0.02209, 1.87163, 1.87640, 2.12565, -0.04000, -0.04084, -0.03552, 0.09073, -0.04258, 0.11056);
```

## API

We document API Calls specific to this product in this section. Functions common to all Phidgets and functions not applicable to this device are not covered here. This section is deliberately generic. For calling conventions under a specific language, refer to the associated API manual in the Quick Downloads section for that language. For exact values, refer to the device specifications.

### 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

int AccelerationAxisCount() [get] : Constant = 3

Returns the number of axes the PhidgetSpatial can measure acceleration on.

double Acceleration (int AxisIndex) [get] : Units = g (standard gravity = 9.81m/s²)

Returns the acceleration of an axis. At a standstill each axis will measure between -1.0 and 1.0 g’s depending on orientation - the effect of gravity. This value will always be between AccelerationMin and AccelerationMax.

double AccelerationMax (int AxisIndex) [get] : Constant = 5.1g

Returns the maximum acceleration value that this axis will report. Acceleration can be accurately measured up to 5.0g - any value past this will be reported as 5.1g, which represents saturation. If the acceleration data is equal to AccelerationMax, it should be treated as suspect, as the real acceleration could be far greater than the reported number.

double AccelerationMin (int AxisIndex) [get] : Constant = -5.1g

Returns the maximum negative acceleration value that this axis will report. Negative acceleration can be accurately measured up to -5.0g - any value past this will be reported as -5.1g, which represents saturation. If the acceleration data is equal to AccelerationMin, it should be treated as suspect, as the real acceleration could be far greater than the reported number.

int GyroAxisCount() [get] : Constant = 3

Returns the number of axes the PhidgetSpatial can measure angular momentum on.

int AngularRate(int AxisIndex) [get] : Units = °/s (degrees/second)

Returns the angular momentum on an axis. This value will always be between AngularRateMax and AngularRateMin. If the value is equal to AngularRateMax or Min, the data should be treated as suspect, as the sensor may be saturated.

int AngularRateMax(int AxisIndex) [get] : Constant = 400°/s

Returns the maximum angular momentum that this axis will report. If the angular rate is reported as 400°/s, this

should be considered saturated, and any heading integration will have errors.

int AngularRateMin(int AxisIndex) [get] : Constant = -400°/s

Returns the maximum negative angular momentum that this axis will report. If the angular rate is reported as

-400°/s, this should be considered saturated, and any heading integration will have errors.

int CompassAxisCount() [get] : Constant = 3

Returns the number of axes the PhidgetSpatial can measure magnetic field strength on.

int MagneticField(int AxisIndex) [get] : Units = G (gauss)

Returns the magnetic field on an axis. This value will always be between MagneticFieldMax and MagneticFieldMin. If the reported value is equal to MagneticFieldMax or Min, the data should be treated as suspect, as the sensor may be saturated. Magnetic field measurements can be combined to calculate compass bearing (magnetic north).
Magnetic field data will become unavailable for ~28ms every 2 seconds as the compass perform internal calibrations. When this happens this function will return EPHIDGET_UNKNOWNVAL, or throw an UNKNOWNVAL exception, depending on the API being used.

int MagneticFieldMax(int AxisIndex) [get] : Constant = 4.1G

Returns the maximum magnetic field that this axis will report. Magnetic field strength can be accurately measured up to 4.0G - any value past this will be reported as 4.1G, which represents saturation.

If the magnetic field data is equal to MagneticFieldMax, it should be treated as suspect, as the real magnetic field could be far greater than the reported number.

int MagneticFieldMin(int AxisIndex) [get] : Constant = -4.1G

Returns the maximum negative magnetic field that this axis will report. Magnetic field strength can be accurately measured down to -4.0G - any value past this will be reported as -4.1G, which represents saturation. If the magnetic field data is equal to MagneticFieldMin, it should be treated as suspect, as the real magnetic field could be far greater than the reported number.

int DataRate () [get,set] : Units = ms (milliseconds)

Gets/sets the data rate. This is corresponds to the time interval at which SpatialData events will be fired. This is bound by DataRateMax and DataRateMin. When set to less then the maximum data rate, data is still sampled at the maximum rate, and averaged before being sent to the user. At data rates below 8ms, the data event will fire at 8ms intervals with an array of spatial data.

Supported data rates are: 4ms, 8ms and every multiple of 8 up to 1000ms (ie. 8, 16, 24, 32, etc). The default data rate is 8ms. Data rate is limited to at most 16ms when opening over the Phidget Webservice. Actual data rate will depend on network latency.

int DataRateMax () [get] : Constant = 4ms

The maximum supported data rate.

int DataRateMin () [get] : Constant = 1000ms

The minimum supported data rate.

### Functions

void zeroGyro();

Re-zeroes the gyroscope. This takes 1-2 seconds of gyro samples and uses this data as a new zero point. The 1056 must remain stationary during the zeroing process. The angular rate will be reported as zero during zeroing.

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 can be determined from the Phidget supplied calibration program.

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.

void resetCompassCorrectionParameters();

Removes all correction factors applied with setCompassCorrectionParameters.

### Events

OnSpatialData (SpatialData[] data) [event]

An event issued at the specified data rate. If the data rate is set faster then 8ms, then there will be multiple items in the data array - use the timestamp field to get the timing data. When the data rate is >= 8ms, there will only beone item in the data array.
Magnetic field data will become unavailable for ~28ms every 2 seconds as the compass perform 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.

## Product History

Date Board Revision Device Version Comment
May 2010 0 100 Product Release
May 2010 0 101 Fixed setLabel bug
May 2011 0 102 getLabelString fixed for labels longer than 7 characters
June 2011 0 200 Support for negative gain values.
July 2014 Product Discontinued. Succeeded by the 1042 - PhidgetSpatial 3/3/3 Basic or the 1044 - PhidgetSpatial Precision 3/3/3.