NMEA Forwarding Services (NFS)

NMEA Forwarding Services (NFS)
NMEA Forwarding
Services (NFS)
Installation Guide
December 2011
Notices
The contents of this document and the associated software are the property of Utility Associates, Inc. Any
reproduction in whole or in part is strictly prohibited. For additional copies of this document or software, please
contact Utility Associates.
Information in this document is subject to change without notice and does not represent a commitment on the
part of Utility Associates. The software as described in this document is furnished under a license agreement or
non-disclosure agreement. The software may be used or copied only in accordance with the terms of the
agreement. It is against the law to copy said software on any medium except as specifically allowed in the license
or non-disclosure agreement. No part of this manual may be reproduced or transmitted in any form or by any
means, for any purpose, without the express written permission of Utility Associates. Companies, names, and data
used in examples herein are fictitious unless otherwise noted.
NFS Installation Guide
Page 2 of 34
Table of Contents
Table of Contents ............................................................................................................................................ 3 Overview ......................................................................................................................................................... 4 Requirements for NFS ..................................................................................................................................... 4 NMEA Forwarding Service Installation ........................................................................................................... 5 NFS Setup ........................................................................................................................................................ 6 Storing NFS License File .................................................................................................................................. 9 Determine Outgoing Data Settings ............................................................................................................... 10 Configuring the Settings File ......................................................................................................................... 10 Typical Setup ............................................................................................................................................. 11 Service Delay ............................................................................................................................................. 11 Application Log Settings ............................................................................................................................ 11 Incoming Data Settings ............................................................................................................................. 12 Outgoing Data Settings ............................................................................................................................. 12 Translate Data ........................................................................................................................................... 13 COM Port Settings .................................................................................................................................... 14 Multicast Settings ..................................................................................................................................... 14 Firewall Exceptions ....................................................................................................................................... 15 Best Practices with NetMotion’s Mobility XE ............................................................................................... 17 Accessing Policy Management .................................................................................................................. 17 Create and Name the New NFS Rule ........................................................................................................ 18 Set Rule Conditions ................................................................................................................................... 19 Check Pass Through .................................................................................................................................. 19 Add Programs ........................................................................................................................................... 20 Set Local Networking ................................................................................................................................ 21 Create and Name a New Rule Set for the NFS .......................................................................................... 23 Add Rule to Rule Set ................................................................................................................................. 24 Subscribe the NFS Rule ............................................................................................................................. 26 Verify GPS Data on the Rocket ...................................................................................................................... 28 Confirm Data is being Multicast ................................................................................................................... 29 PuTTY ........................................................................................................................................................ 29 PortPeeker ................................................................................................................................................ 31 Starting the NFS Service ................................................................................................................................ 33 NFS Installation Guide
Page 3 of 34
Overview
The NMEA Forwarding Service (NFS) is a User Datagram Protocol (UDP) listener, which allows the
Rocket’s “live” multicast GPS data to be available to applications on a local computer. Most applications
are not developed to receive multicast data, therefore, NFS is configured to forward the GPS data
through a virtual COM port or UDP port.
Requirements for NFS
To utilize NFS, the following items are required:
•
Powered Rocket with GPS antenna connected and clear access to the horizon
• Active connection to Rockets’ WiFi network
• NFS software
• NET Framework 3.5 (.NET Framework 1.1 if using an earlier version of NFS)
• Listening application
Live and Event GPS data from the Rocket
UA NOC
Rocket GPS Event data
Laptop CAD data
POLICE
UA AVaiL
Application
UA NFS
Service
04
ta
:40
da
.0.1
AD
pC
pto
on
st
CAD Server
La
ltic
a
Mu
Ro
ck
et
22
4.0
GP
SL
ive
da
ta
Internet
COM port
UDP port
CAD
Application
NFS Installation Guide
Page 4 of 34
NMEA Forwarding Service Installation
NFS must be installed on each PC that requires multicast GPS data. Please contact the Utility Associates
Technical Support Team to obtain a copy of the installation files and Administrative login credentials.
The NFS installation includes a Setup program and a licensing xml. After unzipping the zip file to your
hard drive, install the NFS service by double-clicking on the Setup program to open the Windows
Installer. Follow the prompts to complete the NFS installation.
NFS Installation Guide
Page 5 of 34
NFS Setup
Welcome Message
Step 1
NFS is installed by downloading and running the Setup Wizard.
Step 2
Select the Next button at the initial window and follow the prompts to complete the
installation process.
NFS Installation Guide
Page 6 of 34
Step 3
Select Installation Folder
Step 4
Confirm Installation
NFS Installation Guide
Page 7 of 34
Step 5
Installing NMEA Service
Step 6
Installation Complete
NFS Installation Guide
Page 8 of 34
Storing NFS License File
NFS is a licensed service. After running the NFS setup program, please ensure the license xml file,
provided by Utility Associates, is placed in the NFS application directory (C:\Utility\NFS) before starting
the service.
License file (in the application directory)
<?xml version="1.0" ?>
- <license>
<licensor name="Utility Associates, Inc." />
<licensee name="Caribiner" />
<license_info number="0000000001" product="NFS" begin="2010-09-01 00:00:00" end="2015-09-01
00:00:00" />
<license_data
value="/CLyI+RCz1I2r09P79J+A1TGYLASSY4wZGABWvXhBAnN4zXoqHIIp6inlyFgCtuOkXOANzSdG
H1Ic2za0ZPJLdkstrEZP3SCZC8UlMRpFXAflroD8wqgwQ54e8b………………………………………………
……………………………………………..bPjxidLkyNQIGv+Oq7FUXBg==" />
</license>
NFS Installation Guide
Page 9 of 34
Determine Outgoing Data Settings
• Check with your 3rd party application to determine how GPS data may be received.
• If using COM ports, verify what ports are selectable. Some applications may limit useable ports.
• Some laptops, including the Panasonic Toughbook, receive NFS data more efficiently through UDP
ports.
Configuring the Settings File
The settings.xml file is located in the C:\Utility\NFS\conf directory.
If right clicking on file does not provide the option to edit the .xml file, look for ‘open with’ and select
notebook or open notebook then open the settings file from the notebook application.
NFS Installation Guide
Page 10 of 34
Typical Setup
The following is a typical setup. With it, the NFS delays 20 seconds before forwarding data. The logging
mode is set to run. NFS will listen for incoming GPS data on IP and port 224.0.0.1 and 4004. NFS will also
repeat any incoming data through COM3.
Configuration file (in the application\conf directory)
<?xml version="1.0" ?>
- <application_parameters>
<init-param name="service.delay" value="20"
description="Indicates how long NFS should delay before beginning
operation (seconds)" />
<init-param name="logging.mode" value="0" description="possible values = 0(run), 1(debug)" />
<init-param name="in.mcast.ip.port" value="224.0.0.1-4004" description="Incoming multicast data from UA
Rocket" />
<init-param name="out.com.port" value="COM3" description="Recipient application will listen on COM3" />
</application_parameters>
Service Delay
A service delay of 20 seconds is included in the NFS settings .xml. This delay is recommended for proper
port creation. This input can be a COM port, a UDP port, or a multicast port. The default Rocket
multicast IP and port are 224.0.0.1 and 4004 respectively. The service delay system setting is shown
below:
<i <init-param name="service.delay" value="20"
description="Indicates how long NFS should delay before beginning
operation (seconds)" />
Application Log Settings
NFS logs its events and errors to the C:\Utility\NFS\logs directory. NFS creates a daily history log and a
log for the current day. To view the log entries, double click the appropriate log file.
For verbose logging, set the system parameter "logging.mode" to "1". This is considered "debug"
logging mode. This will create many log entries with normal GPS reporting. It should only be used for
debugging purposes so as not to fill up the log too quickly. For normal use, set the "logging.mode"
parameter to "0" as shown below.
<init-param name="logging.mode" value="0" description="possible values = 0(run), 1(debug)" />
NFS Installation Guide
Page 11 of 34
Incoming Data Settings
The NFS can receive incoming data from only one source. This input can be a COM port, a UDP port, or
a multicast port. If the NFS is to receive data from a Utility Associates Rocket, then NFS will need to have
a multicast input. The default Rocket multicast IP and port are 224.0.0.1 and 4004 respectively. This
system setting is shown below:
<init-param name="in.mcast.ip.port"
value="224.0.0.1-4004"
description="" />
Outgoing Data Settings
The NFS is designed to repeat all incoming data out to a new data source. It is capable of repeating data
out to any combination of multicast IP and Port pairs, UDP ports, and COM ports. The NFS can output
data to multiple multicast IP / Port pairs, multiple UDP ports, and multiple COM ports.
Here are some outgoing data setting examples:
out. mcast.ip port
<init-param name="out.mcast.ip.port"
value="224.0.0.1-4005"
description="Intended for AVaiL application" />
out.com.port
<init-param name="out.com.port"
value="COM4"
description="Recipient application will listen on COM4" />
out.udp.ip.port
<init-param name="out.udp.ip.port"
value="127.0.0.1-4040"
description="Recipient application will listen on port 4040 on a computer
with IP address 127.0.0.1" />
NFS Installation Guide
Page 12 of 34
Translate Data
NFS can translate from NMEA to TAIP message formats. To enable this, set the "translate_data"
attribute.
out.udp.ip.port
Possible values for translate_data:
0=(Default)None:NFS will simply forward whatever arrives without translation
1= CP: NFS will send out TAIP Compact Position messages
2=PV: NFS will send out TAIP Position Velocity messages
4=CP + PV: NFS will send out TAIP CP messages and PV messages
5=CP + original: NFS will send out TAIP CP messages along with original incoming messages
6=PV + original: NFS will send out TAIP PV messages along with original incoming messages
7= CP + PV + original:
NFS will send out TAIP CP and PV messages along with original incoming
messages attribute to "1" (translate) or "2" (translate plus original messages) and set the
"translate_output" attribute to "1" (Compact Position), "2" (Position Veclocity), or "4" (Compact
Position and Position Velocity).
out.udp.ip.port
init-param name="out.udp.ip.port"
value="127.0.0.1-9100"
translate_data="1"
description="Port 9100 will receive ONLY CP messages" />
NFS Installation Guide
Page 13 of 34
COM Port Settings
When configuring COM ports, it is important to ensure that the NFS is configured to use ports that are
already free and available. A list of all currently used COM ports can be found in the Device Manager.
Step 1
Make sure that the NFS is not running (Control Panel -> Administrative Tools -> Services ->
uaNFS -> Stop the service)
Step 2
Open the device manager (Control Panel -> System -> Hardware tab -> Device Manager
button -> expand "Ports COM & LPT)" node -> any ports not listed are free and available).
Step 3
When the NFS starts, it will create COM3 as defined in the settings.xml file.
Multicast Settings
Be sure not to use multicast ports that are in use.
Windows will indicate that the port is in use, and your application will not be able to open its multicast
listener. For instance, if the NFS is set up to use a "in.mcast.ip.port" value of "224.0.0.1-4004", then do not
create a "out.mcast.ip.port" system parameter of, for example, "224.0.0.2-4004". Any application that
attempts to open a multicast listener using port 4004 will receive a "port already in use" error from
Windows.
NFS Installation Guide
Page 14 of 34
Firewall Exceptions
Verify there is nothing between the rocket and the laptop which would disrupt communication. The
firewall may be turned off or the NFS service may be added as an exception to the firewall.
NFS Installation Guide
Page 15 of 34
•
•
To add NFS as a firewall exception in Windows XP:
o
Go to Control Panel > System and Security > Windows Firewall
o
On the Exceptions Tab, select Add Program
o
Browse to find uaNFS.exe and add program
Verify program appears in list of exceptions.
NFS Installation Guide
Page 16 of 34
Best Practices with NetMotion’s Mobility XE
This rule will need to be used by clients wishing to receive GPS data from their Rocket to the NMEA
Forwarding Service (NFS) application. This rule will also allow clients to access the Rocket from their
local systems.
Apply this rule:
• for any condition
• set local networking on and
• pass through network traffic for applications(s)
• uaNFS.exe
• and all address(es)/port(s)
• with options else
• continue to the next rule
To create and add this rule, please observe the following steps:
Accessing Policy Management
Step 1
From the NetMotion Server Console, select ‘Tools’ and ‘Policy Management’.
NFS Installation Guide
Page 17 of 34
Create and Name the New NFS Rule
Step 1
From the Policy Management window select the ‘Rules’ tab and click ‘New’.
Step 2
As the rule name enter ‘NFS pass through’ or similar. Click ‘OK’.
NFS Installation Guide
Page 18 of 34
Set Rule Conditions
Step 1
On the following window, click ‘next’ after verifying that the rules description applies ‘For any
condition’.
Check Pass Through
Step 1
Check ‘Pass through network traffic for application(s)’ on the next window. This will add the
parameter to the rule description. In the rule description, click ‘application(s)’.
NFS Installation Guide
Page 19 of 34
Add Programs
Step 1
In the first text box of the edit applications, type ‘uanfs.exe’. Click ‘Add’. This will add
uanfs.exe to the application list. Click ‘OK’.
Step 2
Verify that the uamast.exe program was added to the rule by expanding the ‘+’ box within
the rule description. Click ‘Next’.
NFS Installation Guide
Page 20 of 34
Set Local Networking
Step 1
On the next window, check ‘Set local networking on/off’. This will update the rule
description. Locate the description and click ‘on/off’.
Step 2
From the edit local networking dialog box that appears, ensure ‘On’ is selected and click ‘OK’.
NFS Installation Guide
Page 21 of 34
Step 3
Verify your rule description includes these details and click ‘Finish’.
NFS Installation Guide
Page 22 of 34
Create and Name a New Rule Set for the NFS
Step 1
From the Policy Management page, select the Rule Sets tabs and click ‘New’.
Step 2
For the Rule Set name enter ‘NFS pass through’, or similar.
NFS Installation Guide
Page 23 of 34
Add Rule to Rule Set
Step 1
On the rule set page, click ‘Add’
Step 2
From the list presented, select the NFS pass through rule and click ‘OK’. Checking ‘Hide
Examples’ may make the rule easier to locate.
NFS Installation Guide
Page 24 of 34
Step 3
Verify that the NFS pass through rule was added and click ‘Save’.
NFS Installation Guide
Page 25 of 34
Subscribe the NFS Rule
Step 1
From the Policy Management page, navigate to the Subscribers tab. Check from the list the
group(s) of users to which you would like the rule applied and click ‘Subscribe’.
Step 2
Select the NFS pass through Rule Set and click ‘OK’.
NFS Installation Guide
Page 26 of 34
Step 3
Verify the NFS pass through Rule Set was added.
NFS Installation Guide
Page 27 of 34
Verify GPS Data on the Rocket
NFS only multicasts GPS data if the Rocket is receiving good GPS data.
Step 1
Connect to the Rocket WiFi network.
Step 2
Verify the Rocket is receiving good GPS data on the Rocket’s local configuration pages.
Rocket IP address is 192.162.(2).1:(3001).
Step 3
Confirm there is data listed with latitude and longitude on the GPS Status page.
NFS Installation Guide
Page 28 of 34
Confirm Data is being Multicast
You may confirm GPS data is being forwarded by NFS using listening applications such as PuTTY or
PortPeeker.
PuTTY
PuTTY is an open source telnet interface that may verify UDP or COM port messages from NFS that may
be downloaded at: http://www.putty.org.
Step 1
For UDP, simply enter the Host Name and Port along with the Connection type.
NFS Installation Guide
Page 29 of 34
Step 2
For COM ports, select Serial as the Connection type and enter the Serial line along with a
Speed of 4800.
Step 3
Click Open to start the PuTTY session.
The Rockets multicast, GPS data will appear on the PuTTY screen.
NFS Installation Guide
Page 30 of 34
PortPeeker
PortPeeker is a freeware utility for capturing network traffic for TCP, UDP or ICMP protocols. With Port
Peeker you can see what traffic is being sent to a given port, easily and quickly.
You may download or learn more about PortPeeker by visiting their web site at:
http://www.LinkLogger.com/portpeeker.htm
Step 1
Once you have started PortPeeker, configure it for the protocol and port you would like to
listen on.
Step 2
Select the UDP protocol, enter the port for multicast data, and choose the IP address for the
Interface, then click OK.
Step 3
The Rockets multicast, GPS data will appear on the PortPeeker screen.
NFS Installation Guide
Page 31 of 34
NFS Installation Guide
Page 32 of 34
Starting the NFS Service
After storing the license .xml and configuring the settings.xml file, the NFS service will need to be
restarted.
Step 1
NFS it restarted through Windows Services (Control Panel -> Administrative Tools ->
Services).
Step 2
Anytime the settings file is changed after initial configuration, restart NFS service.
NFS Installation Guide
Page 33 of 34
© 2011 Utility, Inc.
1484 Brockett Road
Tucker, Georgia 30084
(404) 816-0300
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertising