1049 User Guide: Difference between revisions

From Phidgets Support
(Created page with "Category:DELETE_ME_BEFORE_WE_GO_LIVE ==Getting Started== ===Checking the Contents=== {{UGbox| '''You should have received:''' * A PhidgetSpatial 0/0/3 * A Mini-USB Cable...")
 
No edit summary
 
(20 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:DELETE_ME_BEFORE_WE_GO_LIVE]]
__NOINDEX__
 
<metadesc>The PhidgetSpatial 0/0/3 has a 3-axis, ±5g accelerometer and connects to your computer via USB.</metadesc>
[[Category:UserGuide]]
==Getting Started==
==Getting Started==
{{UGIntro|1049}}
*[{{SERVER}}/products.php?product_id=1049 1049 PhidgetSpatial 0/0/3]
*USB Cable and computer


===Checking the Contents===
{{UGbox|
'''You should have received:'''
* A PhidgetSpatial 0/0/3
* A Mini-USB Cable
* A mounting hardware kit
|||}}
===Connecting the Pieces===
{{UGbox|
Connect the PhidgetSpatial 3-Axis 5G to your PC using the Mini-USB cable.
|
[[File:1049_0_Connecting_The_Hardware.jpg|400px|link=]]
||}}
===Testing Using Windows 2000 / XP / Vista / 7===
{{UGwin}}


===Running Phidgets Sample Program===
Next, you will need to connect the pieces:
[[Image:1049_0_Connecting_The_Hardware.jpg|500px|right|link=]]
# Connect the PhidgetSpatial to your computer using the USB cable.


{{UGwin2|'''Spatial-full'''}}
<br clear="all">
{{UGIntroDone|1049}}


{{UGbox|
==Using the 1049==
Double Click on the [[File:Ph.jpg|link=]] icon to activate the Phidget Control Panel and make sure that the Phidget Spatial 0/0/3 is properly attached  to your PC.
{{UGcontrolpanel|1049}}
|[[File:1049_0_Control_Panel.jpg|400px|link=]]
|
# Double Click on Phidget Spatial 0/0/3 in the Phidget Control Panel to bring up Spatialfull and check that the box labelled Attached contains the word True.
# Move the 1049 board and you should see the data change to reflect the change of position along the 3 axes.
# You can also see the changes plotted in the Accelerometer Graph. The line describes the movement in the x and y axes and the red circle displays movement in the z axis.
# You can adjust the data rate by moving the slider.
|[[File:1049_0_Spatial_Screen.jpg|400px|link=]]
}}


===Testing Using Mac OS X===
===Accelerometer===
Double-click on the Accelerometer object, labelled ''PhidgetSpatial 0/0/3'', in order to run the example:
[[Image:1049_Accelerometer_Example.jpg|center|link=]]


{{UGmac|Phidget Spatial 0/0/3|Spatial-full}}


===Using Linux===
{{UGExampleDescription}}
*Modify the change trigger and/or data interval value by dragging the sliders. For more information on these settings, see the [[Data_Rate_and_Change_Trigger|data interval/change trigger]] page. Try tilting the 1049 in different directions to see the labels and graphics change.
*An extremely accurate timestamp is also reported with the g-force values.
<br clear="all">


{{UGlinux}}
{{ugAddressingInformation}}


===Using Windows Mobile / CE 5.0 / CE 6.0===
{{ugUsingYourOwnProgram|1049}}
 
{{UGce}}


==Technical Details==
==Technical Details==
For more information on testing and calibrating this device, check the [[Accelerometer Guide]].


For more information on the PhidgetSpatial 0/0/3, check the [[Accelerometer Primer]].
{{UGnext|}}
 
==API==
{{UGapih}}
 
===Data Structures===
{{UGapi|
'''SpatialData <nowiki>{</nowiki>'''
 
:'''double acceleration[3];'''
 
:'''Timestamp time;'''
 
'''<nowiki>}</nowiki>;'''
|
::The SpatialData Structure is used by the OnSpatialData event. This contains acceleration data, as well as a timestamp. The timestamp is an accurate measurement streamed from the hardware, and can be trusted over a local software timestamp.
 
::Note the the structure also contains angularRate and magneticField fields, but these are not shown, as they don’tapply to the PhidgetSpatial 3-axis 5G.
}}
 
===Functions===
 
{{UGapi|int AccelerationAxisCount() [get] : Constant <nowiki>=</nowiki> 3
|Returns the number of axes the PhidgetSpatial can measure acceleration on.
}}
 
{{UGapi|double Acceleration (int AxisIndex) [get] : Units <nowiki>=</nowiki> g (standard gravity <nowiki>=</nowiki> 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.
}}
 
{{UGapi|double AccelerationMax (int AxisIndex) [get] : Constant <nowiki>=</nowiki> 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.
}}
 
{{UGapi|double AccelerationMin (int AxisIndex) [get] : Constant <nowiki>=</nowiki> -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.
}}
 
{{UGapi|int DataRate () [get,set] : Units <nowiki>=</nowiki> ms (milliseconds)
|Gets/sets the data rate, in ms. This is corresponds to the rate 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. This defaults to 8ms.  Supported data rates are: 1, 2, 4, 8, and every multiple of 8 until DataRateMin.
 
:Note that data rate is limited to 16ms when opening over the Phidget Webservice. Actual data rate will depend on network latency.
}}
 
{{UGapi|int DataRateMax () [get] : Constant <nowiki>=</nowiki> 1ms
|The maximum supported data rate.
}}
 
{{UGapi|int DataRateMin () [get] : Constant <nowiki>=</nowiki> 1000ms
|The minimum supported data rate.
}}
 
===Events===
{{UGapi|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 <nowiki>>=</nowiki> 8ms, there will only be one item in the data array.
}}
 
==Product History==
{{UGhist}}
{{UGrow|June 2010|0|101|Product Release}}

Latest revision as of 19:55, 1 June 2023


Getting Started

Welcome to the 1049 user guide! In order to get started, make sure you have the following hardware on hand:


Next, you will need to connect the pieces:

1049 0 Connecting The Hardware.jpg
  1. Connect the PhidgetSpatial to your computer using the USB cable.


Now that you have everything together, let's start using the 1049!

Using the 1049

Phidget Control Panel

In order to demonstrate the functionality of the 1049, the Phidget Control Panel running on a Windows machine will be used.


The Phidget Control Panel is available for use on both macOS and Windows machines.

Windows

To open the Phidget Control Panel on Windows, find the Ph.jpg icon in the taskbar. If it is not there, open up the start menu and search for Phidget Control Panel

Windows PhidgetTaskbar.PNG

macOS

To open the Phidget Control Panel on macOS, open Finder and navigate to the Phidget Control Panel in the Applications list. Double click on the Ph.jpg icon to bring up the Phidget Control Panel.


For more information, take a look at the getting started guide for your operating system:


Linux users can follow the getting started with Linux guide and continue reading here for more information about the 1049.

First Look

After plugging the 1049 into your computer and opening the Phidget Control Panel, you will see something like this:

1049 Panel.jpg


The Phidget Control Panel will list all connected Phidgets and associated objects, as well as the following information:

  • Serial number: allows you to differentiate between similar Phidgets.
  • Channel: allows you to differentiate between similar objects on a Phidget.
  • Version number: corresponds to the firmware version your Phidget is running. If your Phidget is listed in red, your firmware is out of date. Update the firmware by double-clicking the entry.


The Phidget Control Panel can also be used to test your device. Double-clicking on an object will open an example.

Accelerometer

Double-click on the Accelerometer object, labelled PhidgetSpatial 0/0/3, in order to run the example:

1049 Accelerometer Example.jpg


General information about the selected object will be displayed at the top of the window. You can also experiment with the following functionality:

  • Modify the change trigger and/or data interval value by dragging the sliders. For more information on these settings, see the data interval/change trigger page. Try tilting the 1049 in different directions to see the labels and graphics change.
  • An extremely accurate timestamp is also reported with the g-force values.


Finding The Addressing Information

Before you can access the device in your own code, and from our examples, you'll need to take note of the addressing parameters for your Phidget. These will indicate how the Phidget is physically connected to your application. For simplicity, these parameters can be found by clicking the button at the top of the Control Panel example for that Phidget.

The locate Phidget button is found in the device information box

In the Addressing Information window, the section above the line displays information you will need to connect to your Phidget from any application. In particular, note the Channel Class field as this will be the API you will need to use with your Phidget, and the type of example you should use to get started with it. The section below the line provides information about the network the Phidget is connected on if it is attached remotely. Keep track of these parameters moving forward, as you will need them once you start running our examples or your own code.

All the information you need to address your Phidget

Using Your Own Program

You are now ready to start writing your own code for the device. The best way to do that is to start from our Code Samples.

Select your programming language of choice from the drop-down list to get an example for your device. You can use the options provided to further customize the example to best suit your needs.

Code Sample Choose Language.png


Once you have your example, you will need to follow the instructions on the page for your programming language to get it running. To find these instructions, select your programming language from the Programming Languages page.

Technical Details

For more information on testing and calibrating this device, check the Accelerometer Guide.

What to do Next

  • Programming Languages - Find your preferred programming language here and learn how to write your own code with Phidgets!
  • Phidget Programming Basics - Once you have set up Phidgets to work with your programming environment, we recommend you read our page on to learn the fundamentals of programming with Phidgets.


Retrieved from "https://www.phidgets.com/docs/index.php?title=1049_User_Guide&oldid=33704"