Difference between revisions of "Importing Boat Data"

From VRTool wiki
Jump to: navigation, search
(Getting boat data directly from a game server)
m (Importing boat and wind data from the Firefox cache)
 
(14 intermediate revisions by 2 users not shown)
Line 4: Line 4:
  
 
[[File:VRLogo.gif|left]] This method works for '''Virtual Regatta''' games only. Once it's set up the method is completely automatic and reliable. Until someone writes a TCP/IP proxy for the VR server this is the best way to import data from VR games.
 
[[File:VRLogo.gif|left]] This method works for '''Virtual Regatta''' games only. Once it's set up the method is completely automatic and reliable. Until someone writes a TCP/IP proxy for the VR server this is the best way to import data from VR games.
<br style="clear: both" />
 
Here's how it works: When your game console wants an update it instructs your browser to send a request to the VR game server. The game server has to know who you are, so the request includes your username as an encrypted string. This means the request is unique to each player (and to each game). If you want '''VRTool''' to request data from the server you have to figure out the contents of the request message for your boat. Fortunately you can use the developer tools built into modern browsers to "sniff" out the request on its way to the server.
 
 
[[File:CPBoatData.gif|right]]Once you have the request string for your boat you can configure VRTool to send the same request to the VR server. This is done in the '''Boat Data''' control panel on the '''Boats''' tab. The VR server responds with your boat data and your friends. VRTool then uses the data to generate a track for each boat on the chart.
 
 
'''Didier''', the skipper of '''"Le Grand DIC"''' in VR games, has prepared an excellent set of instructions for sniffing out the request string for various browsers, and for configuring the '''Boat Data''' control panel. These instructions are available [https://docs.google.com/open?id=0B802msoVS6zJdXliS3JrX0wxeGc here].
 
 
The developer tools in web browsers change with every browser update, so it's next to impossible to keep the instructions for "sniffing" the request string exactly up to date. But if you read Didier's instructions carefully you will figure it out.
 
  
{|class="wikitable"
+
Setting up this method is a little complex and is described in detail on the separate page [[Importing Data from VR Games]].
|''Tip: When you first set up the link, VRTool can't draw the track or the boat icon on the chart until it receives the '''second''' set of data. So you won't see the tracks for '''at least''' 10 minutes. However you can verify that the link is established by observing the data on the Boat Data control panel.''
 
|}
 
 
 
[[File:TabBoats.gif]] See the [[Boats Tab|Boats Tab]] for an explanation of the other controls the '''Boat Data''' control panel.
 
 
<br style="clear: both" />
 
<br style="clear: both" />
  
Line 28: Line 16:
  
 
===Connecting to a wired COM port===
 
===Connecting to a wired COM port===
 +
 +
You may use the computer's serial COM port (RS232)
 +
to connect VRTool to a NMEA compatible GPS device.
 +
 +
Old GPS devices normally used RS422 interfaces,
 +
which could be connected to RS232 (in most cases).
 +
See [http://www.nolandeng.com/downloads/Interfaces.pdf]
 +
 +
Newer GPS devices have USB ports. In this case,
 +
use a USB cable and set the device to COM port emulation mode
 +
(most GPS devices can emulate COM port. Check device documentation)
 +
 +
Make sure to match baud rates (default=4800 bps) and
 +
COM port number.
  
 
===Importing NMEA messages from a text file===
 
===Importing NMEA messages from a text file===
 +
You can simulate a GPS feed into VRTool by saving GPS NMEA messages to a text file and then loading in VRTool.
  
 
==Importing boat and wind data from the Firefox cache==
 
==Importing boat and wind data from the Firefox cache==
 +
 +
  Tip: This method is obsolete and not supported anymore.
 +
  Use ''boat data directly from a game server'', as described above.
 +
 
For Virtual Regatta games: If you are running the game console in the Firefox browser you can recover boat positions and game weather from the Firefox browser cache. Read more about that in this [http://www.tecepe.com.br/NAV/VRTool/offline/TutorialFCI.htm tutorial]. This method depends on both the game file format and the browser cache management - it may stop working unexpectedly if either of these changes.
 
For Virtual Regatta games: If you are running the game console in the Firefox browser you can recover boat positions and game weather from the Firefox browser cache. Read more about that in this [http://www.tecepe.com.br/NAV/VRTool/offline/TutorialFCI.htm tutorial]. This method depends on both the game file format and the browser cache management - it may stop working unexpectedly if either of these changes.
  
 
==When all else fails...==
 
==When all else fails...==
 
For other games, or as a last resort in an emergency, simply place a mark on the chart, rename it to "Boat Position" or similar, then edit the Lat/Long of the mark manually as you go. How to do this is explained [[here]]. While this doesn't lay a track on the chart, it gives you a convenient start point for routing.
 
For other games, or as a last resort in an emergency, simply place a mark on the chart, rename it to "Boat Position" or similar, then edit the Lat/Long of the mark manually as you go. How to do this is explained [[here]]. While this doesn't lay a track on the chart, it gives you a convenient start point for routing.

Latest revision as of 10:08, 6 February 2015

There are several ways to import boat data into VRTool. All of them require a little work to establish a reliable connection, but you only need to do this once for each voyage or game.

Getting boat data directly from a game server

VRLogo.gif
This method works for Virtual Regatta games only. Once it's set up the method is completely automatic and reliable. Until someone writes a TCP/IP proxy for the VR server this is the best way to import data from VR games.

Setting up this method is a little complex and is described in detail on the separate page Importing Data from VR Games.

Using the GPS interface

Connecting to an TCP/IP network

VRTool's ToolbarGPS.gif GPS interface contains a TCP/IP client that can read an NMEA data stream from on an on-board wired or wireless TCP/IP network. VRTool can plot the position of your boat (using NMEA GPS messages) and nearby boats (using AIS messages).

Connecting to a game server through a TCP/IP proxy

The same facility can read game data streamed as NMEA messages over the internet via a TCP/IP proxy server. Your friends boats can also be plotted if the proxy serves these as NMEA AIS messages.

Connecting to a wired COM port

You may use the computer's serial COM port (RS232) to connect VRTool to a NMEA compatible GPS device.

Old GPS devices normally used RS422 interfaces, which could be connected to RS232 (in most cases). See [1]

Newer GPS devices have USB ports. In this case, use a USB cable and set the device to COM port emulation mode (most GPS devices can emulate COM port. Check device documentation)

Make sure to match baud rates (default=4800 bps) and COM port number.

Importing NMEA messages from a text file

You can simulate a GPS feed into VRTool by saving GPS NMEA messages to a text file and then loading in VRTool.

Importing boat and wind data from the Firefox cache

 Tip: This method is obsolete and not supported anymore. 
 Use boat data directly from a game server, as described above.

For Virtual Regatta games: If you are running the game console in the Firefox browser you can recover boat positions and game weather from the Firefox browser cache. Read more about that in this tutorial. This method depends on both the game file format and the browser cache management - it may stop working unexpectedly if either of these changes.

When all else fails...

For other games, or as a last resort in an emergency, simply place a mark on the chart, rename it to "Boat Position" or similar, then edit the Lat/Long of the mark manually as you go. How to do this is explained here. While this doesn't lay a track on the chart, it gives you a convenient start point for routing.