1040 User Guide: Difference between revisions

From Phidgets Support
No edit summary
 
(15 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOINDEX__
<metadesc>Measure global position, velocity and heading with the Phidget GPS on your computer via USB. Best case accuracy of 2.5m CEP.</metadesc>
[[Category:UserGuide]]
[[Category:UserGuide]]
{{UserguideTOC|1040.jpg|1040}}
==Getting Started==
==Getting Started==
{{UGIntro|1040}}
*[{{SERVER}}/products.php?product_id=1040 1040 GPS Phidget]
*USB cable and computer
*GPS antenna


===Checking the Contents===
{{UGbox|
'''You should have received:'''
* A PhidgetGPS
* A GPS Antenna
* A Mini-USB cable
* A Hardware Mounting Kit
|
'''In order to test your new Phidget you will also need:'''
* A location that is likely to get a GPS signal
||}}


===Connecting the Pieces===
Next, you will need to connect the pieces:
{{UGbox|
[[Image:1040_0_Connecting_The_Hardware.jpg|500px|right|link=]]
# Connect the antenna to the PhidgetGPS
# Connect the GPS antenna to the 1040 GPS Phidget.
# Connect the PhidgetGPS to your computer using the Mini-USB cable.
# Connect the Phidget to your computer using the USB cable.
|
[[File:1040_0_Connecting_The_Hardware.jpg|400px|link=]]
||}}


===Testing Using Windows 2000 / XP / Vista / 7===
<br clear="all">
{{UGIntroDone|1040}}


{{UGwin}}
==Using the 1040==


===Running Phidgets Sample Program===
{{UGcontrolpanel|1040}}


{{UGwin2|'''GPS-full'''}}
{{ugGPS}}


{{UGbox|
{{ugAddressingInformation}}
Double Click on the [[File:Ph.jpg|link=]] icon to activate the Phidget Control Panel and make sure that the PhidgetGPS is properly attached to your PC.
|[[File:1040_0_Control_Panel_Screen.jpg|400px|link=]]
|
#Double Click on Phidget GPS in the Phidget Control Panel to bring up GPS-full and check that the box labelled Attached contains the word True.
# A tick mark will appear in the box when a satellite fix has been acquired. If you areinside a building, you might have to go outside to get a satellite fix.
# Displays the latitude.
# Displays the longitude.
# Displays the velocity when the PhidgetGPS is moving.
# Displays the Heading (0 is north) when the PhidgetGPS is moving.
# Displays Time and Date as transmitted by the satellites.
# Opens Google Map and displays the GPS location.  The red dot shows the GPS location on the map. To close the Map click on the Close Map button.
|[[File:1040_0_GPS_Screen.jpg|400px|link=]]
}}


===Testing Using Mac OS X===
{{ugUsingYourOwnProgram|1040}}
 
{{UGmac|PhidgetGPS|GPS-full}}
 
===Using Linux===
 
{{UGlinux}}
 
===Using Windows Mobile / CE 5.0 / CE 6.0===
 
{{UGce}}


==Technical Details==
==Technical Details==
===Mounting===
===Mounting===
The 1040 has been sized so it may be mounted directly on top of the 1056 - PhidgetSpatial 3/3/3 and the 1049 - PhidgetSpatial 0/0/3.  
The 1040 has been sized so it may be mounted directly on top of any of our Spatial Phidgets:
 
*[{{SERVER}}/products.php?product_id=1041 PhidgetSpatial 0/0/3 Basic]
===Further Reading===
*[{{SERVER}}/products.php?product_id=1042 PhidgetSpatial 3/3/3 Basic]
 
*[{{SERVER}}/products.php?product_id=1043 PhidgetSpatial Precision 0/0/3 High Resolution]
For more information, check out the [[GPS Primer]].
*[{{SERVER}}/products.php?product_id=1044 PhidgetSpatial Precision 3/3/3 High Resolution]


===WAAS===
===WAAS===
The 1040 is [[GPS Primer#WAAS| capable]] though in order to get the functionality you must be using C as the NMEA data is only available in the C API.
The 1040 does not support [[GPS Guide#WAAS|WAAS]].


==API==
===Further Reading===
{{UGapih}}
For more information, check out the [[GPS Guide]].
 
===Data Structures===
 
 
===Functions===
 
{{UGapi|boolean PositionFixStatus [get]
|Returns the position fix status. True indicated that a position fix is available, and latitude, longitude, and altitude can be read. False indicates that no position fix is available.
}}
 
{{UGapi|double Latitude [get] 
|Returns the current latitude of the active antenna in signed decimal degree format.
}}
 
{{UGapi|double Longitude [get]
|Returns the current longitude of the active antenna in signed decimal degree format.
}}
 
{{UGapi|double Altitude [get]
|Returns the current altitude of the active antenna from mean sea level (geoid), range is from -9999.9 to 17999.9. Units are in meters.
}}
 
{{UGapi|double Velocity [get]
|Returns the current speed over ground of the active antenna in km/h. Has a maximum value of 1800.0.
}}
 
{{UGapi|double Heading [get]
|Returns the current true course over ground of the active antenna in degrees (000.0 - 359.9). 000.0 indicates True North, 180.0 indicates True South.
}}
 
{{UGapi|struct Time [get]
|Returns the current time as transmitted by the GPS receiver. Time is in UTC format.
}}
 
{{UGapi|struct Date [get]  
|Returns the date of the last received position. Date is in UTC.
}}
 
===Events===
 
{{UGapi|OnPositionChange() [event]
|An event that is issued whenever a change in position occurs. Event arguments are latitude, longitude, altitude, velocity,  heading.
}}


{{UGapi|OnPositionFixChange() [event]
{{UGnext|}}
|An event that is issued when a position fix is obtained or lost. The event argument can be used to inform you whether or not you are getting a signal.
}}
==Product History==
{{UGhist}}
{{UGrow|March 2011|0|100|Product Release, requires phidget21 libraries 2.1.8 or newer}}

Latest revision as of 20:03, 1 June 2023


Getting Started

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


Next, you will need to connect the pieces:

1040 0 Connecting The Hardware.jpg
  1. Connect the GPS antenna to the 1040 GPS Phidget.
  2. Connect the Phidget to your computer using the USB cable.


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

Using the 1040

Phidget Control Panel

In order to demonstrate the functionality of the 1040, 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 1040.

First Look

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

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

GPS

Double-click on the GPS object labelled PhidgetGPS in order to run the example:

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

  • GPS data will be displayed in real-time once a fix has been acquired.
  • Latitude: the current latitude position of the GPS antenna.
  • Longitude: the current longitude position of the GPS antenna.
  • Altitude: the current altitude of the GPS antenna in meters from mean sea level.
  • Velocity: the current speed over ground of the antenna in km/h.
  • Heading the current true course over ground in degrees.
  • Time and Date: the current time as transmitted by the GPS receiver.


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

Mounting

The 1040 has been sized so it may be mounted directly on top of any of our Spatial Phidgets:

WAAS

The 1040 does not support WAAS.

Further Reading

For more information, check out the GPS 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 "http:///docs/index.php?title=1040_User_Guide&oldid=33717"