Sierra Wireless AirLink Device User Guide
Below you will find brief information for AirLink Device. This User Guide provides information on configuring various features of the AirLink Device, including network connections, security settings, and event reporting. The guide covers a wide range of topics, from basic configuration to advanced settings. You can use this guide to setup your AirLink Device and have it connect to the internet and communicate with the outside world. You can also configure settings that enhance security. Events, such as changes to network status or security, can also be reported.
Advertisement
Advertisement
ALEOS 4.0.11 Configuration
User Guide
4112515
Rev 6
Important
Notice
Safety and
Hazards
Limitation of
Liability
Preface
Due to the nature of wireless communications, transmission and reception of data can never be guaranteed. Data may be delayed, corrupted (i.e., have errors) or be totally lost. Although significant delays or losses of data are rare when wireless devices such as the Sierra Wireless modem are used in a normal manner with a well-constructed network, the Sierra Wireless modem should not be used in situations where failure to transmit or receive data could result in damage of any kind to the user or any other party, including but not limited to personal injury, death, or loss of property. Sierra Wireless accepts no responsibility for damages of any kind resulting from delays or errors in data transmitted or received using the Sierra Wireless modem, or for failure of the Sierra Wireless modem to transmit or receive such data.
Do not operate the Sierra Wireless modem in areas where blasting is in progress, where explosive atmospheres may be present, near medical equipment, near life support equipment, or any equipment which may be susceptible to any form of radio interference. In such areas, the Sierra Wireless modem MUST BE
POWERED OFF. The Sierra Wireless modem can transmit signals that could interfere with this equipment.
Do not operate the Sierra Wireless modem in any aircraft, whether the aircraft is on the ground or in flight. In aircraft, the Sierra Wireless modem MUST BE
POWERED OFF. When operating, the Sierra Wireless modem can transmit signals that could interfere with various onboard systems.
Note: Some airlines may permit the use of cellular phones while the aircraft is on the ground and the door is open. Sierra Wireless modems may be used at this time.
The driver or operator of any vehicle should not operate the Sierra Wireless modem while in control of a vehicle. Doing so will detract from the driver or operator's control and operation of that vehicle. In some states and provinces, operating such communications devices while in control of a vehicle is an offence.
The information in this manual is subject to change without notice and does not represent a commitment on the part of Sierra Wireless. SIERRA WIRELESS AND
ITS AFFILIATES SPECIFICALLY DISCLAIM LIABILITY FOR ANY AND ALL
DIRECT, INDIRECT, SPECIAL, GENERAL, INCIDENTAL, CONSEQUENTIAL,
PUNITIVE OR EXEMPLARY DAMAGES INCLUDING, BUT NOT LIMITED TO,
LOSS OF PROFITS OR REVENUE OR ANTICIPATED PROFITS OR REVENUE
ARISING OUT OF THE USE OR INABILITY TO USE ANY SIERRA WIRELESS
PRODUCT, EVEN IF SIERRA WIRELESS AND/OR ITS AFFILIATES HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES OR THEY ARE
FORESEEABLE OR FOR CLAIMS BY ANY THIRD PARTY.
Notwithstanding the foregoing, in no event shall Sierra Wireless and/or its affiliates aggregate liability arising under or in connection with the Sierra Wireless product, regardless of the number of events, occurrences, or claims giving rise to liability, be in excess of the price paid by the purchaser for the Sierra Wireless product.
Rev 6 May.13
3
ALEOS User Guide
Patents
Copyright
Trademarks
Contact
Information
This product may contain technology developed by or for Sierra Wireless Inc. This product includes technology licensed from QUALCOMM
®
. This product is manufactured or sold by Sierra Wireless Inc. or its affiliates under one or more patents licensed from InterDigital Group and MMP Portfolio Licensing.
© 2013 Sierra Wireless. All rights reserved.
Sierra Wireless
®
, AirPrime
®
, AirLink
®
, AirVantage
®
and the Sierra Wireless logo are registered trademarks of Sierra Wireless.
Watcher
®
is a registered trademark of NETGEAR, Inc., used under license.
Windows
®
and Windows Vista
®
are registered trademarks of Microsoft
Corporation.
Macintosh
®
and Mac OS X
®
are registered trademarks of Apple Inc., registered in the U.S. and other countries.
QUALCOMM
®
is a registered trademark of QUALCOMM Incorporated. Used under license.
Other trademarks are the property of their respective owners.
International Contact Information
AirLink Sales
AirLink Support*
AirLink RMA Repairs*
AirLink Online Support
Knowledgebase
AirLink Software
Downloads
Corporate Web Site
[email protected]
[email protected]
[email protected]
www.sierrawireless.com/Support/SupportCenter www.sierrawireless.com/Support/Downloads www.sierrawireless.com
* If you have purchased your product from an AirLink Distributor or Reseller, please contact them for first line technical support.
4 4112515
Preface
Sierra Wireless Headquarters Contact Information
Sales
Headquarters:
Post:
Phone: +1-604-232-1488
Hours:
E-mail:
8:00
AM
to 5:00
PM
Pacific Time [email protected]
Sierra Wireless
13811 Wireless Way
Richmond, BC
Canada V6V 3A4
Consult our website for up-to-date product descriptions, documentation, application notes, firmware upgrades, troubleshooting tips, and press releases: www.sierrawireless.com
Rev 6 May.13
5
ALEOS User Guide
6 4112515
Contents
Tools and Reference Documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Fast Template Loading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Other connection options for updating firmware . . . . . . . . . . . . . . . . . . . 27
Wake on LAN Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Rev 6 May.13
7
ALEOS User Guide
Data Usage Using Keep Alive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Public and Private Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
8 4112515
Contents
AMS (AirLink Management Services) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Configuring Engine Hours . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Understanding Domain Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
SMS Routing—Incoming Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
SMS Routing—Outgoing Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
SMS Routing—LAN Side Communication . . . . . . . . . . . . . . . . . . . . . . 105
SMS Password Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
SMS Address Type and Numbering Plan . . . . . . . . . . . . . . . . . . . . . . . 107
Rev 6 May.13
9
ALEOS User Guide
AirLink Device Supported Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Remote Access Protocol (RAP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Before You Configure GPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Raven Line Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
10 4112515
Contents
Transformed Analog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Event Configuration Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Network Data Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Network Traffic (Tx/Rx) Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Device Name Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Miscellaneous (Misc) Data Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Rev 6 May.13
11
ALEOS User Guide
Creating a Dial-Up Networking (PPP) Connection . . . . . . . . . . . . . . . . . . 198
Connecting to the Internet Using DUN . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Configuring the AirLink Device at the Polling Host for Modbus on UDP . . 213
Configuring the Remote AirLink Devices for Modbus with UDP . . . . . . . . 214
Configuring a PPPoE Connection in Windows . . . . . . . . . . . . . . . . . . . . . 217
Connecting to the Internet with PPPoE . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Management Information Base (MIB) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
User Name and Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
SNMP MIB Definition Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Data Usage SNMP Traps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
12 4112515
Contents
Rev 6 May.13
Configuring the AirLink Device for GPS . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Real-Time Clock Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Over-The-Air (Remote) Host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
TCP GPS Report Polling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
Sending Reports Automatically . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
RAP Reports Over-The-Air (Remote) . . . . . . . . . . . . . . . . . . . . . . . . . . 242
RAP Reports over a Local Connection . . . . . . . . . . . . . . . . . . . . . . . . . 243
Configuring Additional RAP Features . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Messages Over-The-Air (Remote) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
Streaming Messages (Local) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
TAIP Emulation Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
TAIP Command Emulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Messages Over-the-Air (Remote) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
Streaming Messages (Local) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
AT Command Set Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
13
ALEOS User Guide
AMS (AirLink Management Services) . . . . . . . . . . . . . . . . . . . . . . . . . . 262
MODBUS Address List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
14 4112515
1: Introduction
•
Overview
•
About
Documentation
•
Tools and
Reference
Documents
Overview
ACEmanager™ is the free utility used to manage and configure the
AirLink device. It is a web application integrated in the ALEOS firmware. ACEmanager™ provides comprehensive configuration and control functionality to all AirLink gateways and routers.
Key benefits of ACEmanager include:
•
Login and configure device parameters
•
Adjust network settings
•
Change security settings
•
Update events reporting.
Since ACEmanager can be accessed either remotely or locally, the many features of ALEOS can be configured from any location.
A template can be created, after a single devices is configured and installed, to program other gateways and routers with the same parameter values. This enables the quick, accurate deployment of large pools of devices.
Other key features of ACEmanager include:
•
Remote device configuration and control
•
Inclusion in every AirLink gateway and router.
1
About Documentation
Each chapter in the ALEOS User Guide is a section (a tab in the User
Interface) of ACEmanager.
Chapters in this user guide explain:
•
Parameter descriptions in ACEmanager
•
Relevant configuration details
•
User scenarios for certain sections in the guide.
The following table is a snapshot of the chapters and the product they correspond to.
Rev. 6 May.13
15
ALEOS User Guide
3
4
5
No.
Chapter Name
1
2
Description
Relevant to all products
Relevant to all products
Relevant to all products
Relevant to all products
Relevant to all products
Note: Wi-Fi Configuration is only for products with Wi-Fi.
8
9
6
7
10
11
12
13
14
15
16
Relevant to all products
Relevant to all products
Relevant to all products
Only for PinPoint and MP line products
Only for products with serial ports
Relevant to all products
Only for Raven line products
Different sections for different product lines have been captured for the display of examples.
Relevant to all products
Relevant to all products
Relevant to all products
This User Guide is provided as a PDF (Portable Document Format) file on the installation CD or from the Sierra Wireless support website.
16 4112515
Introduction
Tools and Reference Documents
Field Description
AirLink Device User
Guide
This hardware document describes how to:
•
Install the AirLink device hardware
•
Connect the radio antennas
•
Connect a notebook computer and other input/output (I/O) devices
•
Install the software
•
Interpret the LEDs and the indicators on the AirLink device.
ACEview User Guide
This document explains the use of the utility tools that are used to monitor the connection state of a Sierra Wireless AirLink device, and the GPS or power status (as applicable) for
MP and PinPoint line devices.
AceNet User Guide
This document explains the use of AceNet services for the remote management of Sierra
Wireless AirLink devices.
Rev. 6 May.13
17
ALEOS User Guide
18 4112515
2: Configuring the AirLink Device
•
Main Menu Tabs
•
Configuring
•
Operation Modes
•
Creating a Template
•
Applying a Template
•
Updating the
Firmware
After powering on the AirLink device and ensuring that you have an
IP-based connection set up (Ethernet, USB/net, DUN, or Wi-Fi), you are ready to log on to ACEmanager. Log on by entering http://192.168.13.31:9191 in your browser, or by entering another IP address depending on the interface you select. (Defaults are shown in the table below).
Change IP addresses in ACEmanager at LAN/Addressing for
Ethernet, on the LAN sub-tab applicable tab for interface type, or on the Serial tab for DUN
.
2
Interface
Ethernet
USB/NET
DUN
Wi-Fi*
AirLink Device
192.168.13.31
192.168.14.31
192.168.15.31
192.168.17.31
First Connected Device
192.168.13.100
192.168.14.100
192.168.15.100
192.168.17.100
* Only for MP devices with Wi-Fi.
The default login credentials are:
•
Login: user
•
Password: 12345
To prevent others from changing the AirLink Device settings, you can change the ACEmanager password (please refer to the Admin chapter).
Figure 2-1: ACEmanager: Main Login screen
Rev. 6 May.13
19
ALEOS User Guide
Main Menu Tabs
The main menu, across the top of the ACEmanager display, is as follows:
•
Upload: Loads configured information, in the form of a template, to the device.
•
Download: Saves and copies checked configuration to create a template. If none of the fields are checked, all fields are selected and saved automatically.
•
Reboot: Reboots the device.
•
Refresh All: Refreshes all the pages.
Configuring
To configure your AirLink device, you have two options. You can either use the browser-based ACEmanager as detailed in this guide, or you can use a terminal emulator application (such as HyperTerminal, PuTTY, etc.) to enter AT commands for many of the configuration options.
Operation Modes
The AirLink device plays the part of a Host when a computer or another device is connected directly to its port and routes data to and from the connected device to the cellular network.
Tip:
If you need to have multiple Ethernet connections, connect the AirLink device to a router, switch, or hub for additional ports.
As the Host, the AirLink device can use different basic communication host modes.
Basic Host Modes
•
AT: The AirLink device accepts and responds to standard AT commands.
•
PassThru: Direct connection to internal hardware (OEM Module) of the
AirLink device.
•
Telnet: The AirLink device auto-answers TCP connections to allow terminal emulation using either a local connection or remotely using the cellular connection.
Tip:
By default, the AirLink device is in AT Mode and allows AT commands to be entered via terminal connection (through the local port connection) or remotely (through the cellular network). PassThru Mode can only be exited by resetting the AirLink device. All serial modes are entered by use of a startup mode command.
20 4112515
Rev. 6 May.13
Configuring the AirLink Device
Serial Modes
•
PPP Mode: The AirLink device uses PPP to communicate with a device or computer connected to the serial port.
•
SLIP Mode: The AirLink device uses SLIP to communicate with a device or computer connected to the serial port.
•
UDP and UDP PAD: Any data received on the serial port is assembled into
UDP packets and sent to the session’s associated IP address and Port
(described later). Any responses received from the associated IP address and port destined for the Device Port are unwrapped and sent out the serial port.
•
TCP and TCP PAD: Any data received on the serial port is packaged into
TCP messages and sent to the associated connection’s IP address and Port
(described later). Any data received from the TCP peer is unwrapped and sent out the serial port.
Data Communication
•
Public and Private Modes: The method used by the AirLink device to pass an IP address to a connected device.
•
Keepalive: How the AirLink device maintains its connection to the cellular network.
AT Mode
Using a terminal connection, AT commands can be used to configure the device, command it to do something, or query a setting. ACEmanager is a GUI (graphical user interface) for most AT commands and includes other parameters without AT counterparts.
•
AT commands must always be terminated by <CR> (ASCII character 0x0D), a carriage return (pressing enter on the keyboard). Some may also include a new line or line feed <LF>.
•
If E=1 (Echo On), the AT command (including the terminating <carriage return) will be displayed (output) before any responses.
•
Two settings affect the format of AT command output: V (Verbose) and Q
(Quiet).
•
If Q=1 (Quiet On), no result codes are output whatsoever, so there is no response generated by a (non query) command.
•
If Q=0 (Quiet Off), result codes are output. The format of this output is then affected by the Verbose setting.
If Quiet mode is off, the result code is affected as follows:
For V=1 (Verbose mode), the textual result code is surrounded by a carriage return and new line. Any AT query response is also surrounded by a carriage return and new line.
For V=0 (Terse mode), a numeric result code is output with a single trailing carriage return (no new line is output), while any AT query response is followed by a carriage return and new line (there is no preceding output).
21
ALEOS User Guide
•
For example, possible outputs to the AT command “AT” with carriage return
(assuming quiet mode is not on) are: carriage return — if V=0 carriage return and new line OK another carriage return and new line — if
V=1
Note: AT commands work for the port on which they are executed. For example, if the user types ATE1 and then AT&W are using a USB/serial port connection, it will set the
USB/serial port to Echo On but not the telnet connection or the RS232 serial port.
PassThru Mode
In PassThru mode, the AirLink device does not behave normally, all port communication is passed directly between the internal hardware, and the computer connected directly to the device. This mode can be used to configure hardware-specific settings. For example, provisioning, troubleshooting, communicating with legacy equipment, etc.
Telnet/SSH Mode
You can configure your device for either Telnet or SSH operation in ACEmanager.
If you need to change the port for Telnet (for example, you have the default port blocked on your firewall), the option is on the Services > Telnet tab. The default
Telnet port is 2332. You can also change the Telnet timeout; if the connection is idle, default timeout is 254 minutes. This is the internal Telnet on the modem to pass AT commands and not TCP pad.
To switch to SSH operation, select SSH from the menu in the AT Server Mode field.
22
Figure 2-2: ACEmanager: Services > Telnet/SSH
4112515
Rev. 6 May.13
Configuring the AirLink Device
Creating a Template
If you have a device configuration that works well for your needs, you can use
ACEmanager to save that configuration as a template and then apply it to other
Sierra Wireless AirLink devices.
Templates can be created as either feature-specific or for all configurable features. Feature-specific templates are quicker and more reliable to apply from one device to another. Because only specific feature fields are included in the template, all other configuration elements are not altered. This allows for different configurations for particular features not to be overwritten. Feature-specific templates are also more reliable since they are less likely to include configuration fields for features not present in the target device.
Templates which are to include every configurable field in the device are more useful for troubleshooting purposes than for transferring feature configurations from one device to another.
To create a template with ACEmanager:
1.
Configure your AirLink device in ACEmanager.
a.
For feature-specific templates, check the boxes in front of the fields to be saved to the template. This allows you to have a template covering only the configuration items you want imported into another device. For tables, click the box at the top of the table to include the entire table.
b. For templates with all configurable fields, do not check any of the boxes.
2.
Click
Download to save the template. A confirmation dialog box displays.
Figure 2-3: ACEmanager: Download Template Message
Note: Template downloads do not work with Internet Explorer
®
9. Use Mozilla
®
Firefox
®
or
Internet Explorer 8 instead.
3.
Click OK. The File Download box displays.
23
ALEOS User Guide
Figure 2-4: ACEmanager: File Download Box
4.
Click Save (or OK depending on your system browser).
Note: Some of the configuration settings are specific to individual devices. Avoid having those settings in your saved template as the devices you configure with the template could cease to work with the cellular or local network. A feature-specific template allows you to omit configuration elements which are not specific to a device.
5.
Type in a file name that is descriptive of the template (to easily find it later) and save it to a location on your computer. Not all browsers will allow you to change the name of the file while downloading. As long as you do not change the extension .xml, you can change the name and location of the file after it has downloaded.
The template will now download.
Applying a Template
You can use a template you created with the above steps, or a template provided by your AirLink representative or someone in your company who has set up a device template. The template to be applied must be saved to your hard drive.
Fast Template Loading
Fast Template Loading is a new ACEmanager feature that allows configured templates to be uploaded to AirLink devices in a shorter time frame than before.
In addition, a list of the parameters to be changed will display before the template is uploaded.
Note: Fast Template Loading is only supported on the Internet Explorer browser.
Two template load options are available:
•
Load to Screen
•
Load to Device
To apply the template to a device:
1.
Connect to the device you want to configure using ACEmanager.
2.
Click the Upload button on the toolbar.
24
Figure 2-5: ACEmanager: Upload
3.
At the Upload window, click Browse, and select the template you have saved.
You may need to change folders if you saved it to a different location.
4112515
Configuring the AirLink Device
Figure 2-6: ACEmanager: Select and Upload Template
4.
Click Open.
Rev. 6 May.13
5.
Click Load &
Apply.
Tip:
After you load the template, it’s best to go back over the ACEmanager tabs to make sure all the settings are what you require. Red asterisks ( * ) will display on the tabs that have been changed.
Note: Field values that have been changed manually are highlighted in yellow. When the template is loaded onto other devices, the changed fields are not highlighted.
25
ALEOS User Guide
Note: Special characters such as !,*, %, etc. may appear as code in the template. For example, an exclamation mark (!) may appear as “#33”. However, when the template is applied, it will appear as an exclamation mark (!).
6.
Click the Refresh button to reset the device.
Caution:
Many of the configuration settings will not take effect until the device has been reset.
Tip:
Use the common settings on one device to configure those same settings on another device. For example, use the serial settings of one device to configure the serial settings of another device.
Updating the Firmware
To check the current firmware version:
•
In ACEmanager, the Status tab, select Home. The ALEOS Software version field shows the current firmware version.
•
Send the AT Command
I1
.
To update the firmware:
1.
Go to http://www.sierrawireless.com/en/Support/Downloads.aspx
.
2.
Select your product and download the latest firmware.
Note any special instructions on the download page.
The filename is in the format: Device name_Radio module_Model number (as shown on the device label)_Firmware version.
3.
Connect your device to your laptop via Ethernet.
4.
Double-click the .exe file to open the Install Wizard.
5.
On the following window, select IP and enter the default IP address
(192.168.13.31). Default password is 12345.
26 4112515
Configuring the AirLink Device
6.
Click Next, and follow the on-screen instructions to complete the firmware installation.
Other connection options for updating firmware
PPP
Use this option for Serial connections.
Rev. 6 May.13
1.
Select the desired COM port.
2.
Click Next, and follow the on-screen instructions to complete the firmware installation.
27
ALEOS User Guide
Boot
This option is used with a Serial connection for troubleshooting.
Note: The Ethernet and SMS options are not recommended.
28 4112515
3: Status
•
Home
•
WAN/Cellular
•
LAN/WiFi
•
VPN
•
Security
•
Services
•
GPS
•
Serial
•
Applications
•
About
The Status tab that displays in ACEmanager is applicable across all
Sierra Wireless AirLink devices.
Note: Categories not applicable to a device line will not appear as selectable. For example, Status >GPS will only be available for devices with the GPS feature set.
All of the fields in the Status group have read-only parameters and provide information about the ALEOS device. Depending on the individual settings and the onboard cellular module of the AirLink device, the actual status pages may look different than the screen shots listed here. The individual status sections give an accurate view of the current running configuration of the AirLink device. Refer to the following sections for information about the individual configuration options.
Home
The Home section of the Status tab is the first page displayed when you log in to ACEmanager. It shows basic information about the cellular network connection and important information about the device you would most likely want to see first.
Tip:
See the WAN/Cellular section for details on configuring the cellular connection.
3
Rev. 6 May.13
29
ALEOS User Guide
30
Figure 3-1: ACEmanager: Status > Home
Phone Number
IP Address
The phone number is part of the carrier account. Depending on the ALEOS device type, the phone number will either be programmed into the device or from the SIM card used with the device.
The current IP address of the device reported by the internal module and is generally obtained from your carrier. This is the address you use to contact the ALEOS device from the Internet if you have a mobile terminated or Internet accessible account.
Current state of the cellular radio and the connection with the cellular network.
Network State
RSSI (dBm)
This is the current RSSI (Receive Signal Strength Indicator) of the ALEOS device as a negative dBm value, and indicates the strength of the cellular signal.
The higher the number, the better the signal strength. The exact numbers vary between cellular carriers, but numbers in the range of -40dBm to -70dBm usually mean that the AirLink device is in an excellent coverage area.
RSSIs lower than -107dBm indicate a very poor signal and most over the air (OTA) services will be non-functional. Depending on your device type, an RSSI of -110dBM or -125dBm indicates a complete loss of signal, and no OTA functions will be available.
Network Operator
Indicates the current network operator.
The type of service being used by the device, for example EV-DO Rev A or HSPA.
Network Service
Type
ALEOS Software
Version
EC/IO (dB)
Channel
Software version of the ALEOS build currently installed in the device.
The current active CDMA/GSM channel number.
Number of bytes sent to the network since system startup.
WAN/Cellular
Bytes Sent
WAN/Cellular
Bytes Rcvd
Device Name
Number of bytes received from the network since system startup.
Name of the device which can be configured as part of the Dynamic DNS settings of the IP
Manager found on the Dynamic DNS subtab of the Services tab.
4112515
Status
WAN/Cellular
The WAN/Cellular sub-tab indicates specific status information about the cellular connection including IP address and how much data has been used. The features displayed on the sub-tab depend on the device and carrier type. Figure 3-2 appears for GSM users, while Figure 3-3 appears only for CDMA users. Some of the information on this page is repeated on the Home page for quick reference.
Figure 3-2: ACEmanager: Status > WAN/Cellular > GSM
Rev. 6 May.13
Figure 3-3: ACEmanager: Status > WAN/Cellular > CDMA
31
ALEOS User Guide
Both
Both
Both
Both
Both
Both
Carrier Type Field
Both
Both
Cellular IP Address
ESN/EID/IMEI
Description
Cellular WAN IP Address.
Electronic Serial Number for the internal radio.
CDMA
CDMA
CDMA
CDMA
PRL Version
SID
NID
Version of the Preferred Roaming List installed in the device.
PRL Update Status
Status of the last PRL update. 0 is there has been none.
Configuration parameter for the cellular account.
Configuration parameter for the cellular account.
CDMA
CDMA
Both
Both
PN Offset
Band Class
Keepalive IP
Address
Keepalive Ping
Time
Configuration parameter for the cellular account.
Configuration parameter for the cellular account.
The IP address that WAN Keepalive uses to test cellular connectivity.
The amount of time between Keepalive pings in seconds.
DNS Server 1
DNS Server 2
Bytes Sent
Bytes Received
Packets Sent
Packets Received
First DNS IP addresses of cellular or Ethernet network.
Second DNS IP addresses of cellular or Ethernet.
Number of bytes sent to the cellular network since the system startup.
Number of bytes received from the network since system startup.
Number of packets sent to the network since system startup.
Number of packets received from the network since system startup.
32 4112515
Status
LAN/WiFi
This tab displays the status of the local network and lists information about the network and connected clients. If the device has Wi-Fi, this section also includes
Wi-Fi status information. After the device is started, the first ACEmanager connection displays:
Figure 3-4: ACEmanager: Status > LAN/WiFi
Clicking the SCAN button will detect other devices connected as hosts to its LAN interfaces:
Figure 3-5: ACEmanager: Status > LAN With Connections
Field
Security Encryption
Type
Ethernet Status
USB Mode
Scan
IP/MAC
Description
Displays the encryption mechanism to be used for Wi-Fi devices.
Indicates if there is an Ethernet connection.
Displays which virtual mode of the USB port is set.
Click the Scan button to detect devices connected as hosts to its LAN interfaces.
Displays a list and the status of the IP and MAC addresses for customer devices connected to a local host port.
Rev. 6 May.13
33
ALEOS User Guide
Field
IP Address
MAC Address
Status
Description
Displays a list of the IP addresses for customer devices connected to a local host port.
Displays a list of the MAC addresses for customer devices connected to a local host port.
Displays the status of each connected host. Displayed statuses include:
•
arp — A connected host with a static IP has been detected using ARP requests and response
•
arp/dhcp — A connected host which has a DHCP allocated IP and is detected as still active with ARP requests and responses
•
dhcp — An active lease exists for this host connection, but there are no active ARP requests or responses. The host may be disconnected.
LAN IP Packets Sent
Displays the number of IP packets sent to the host interface since the system startup.
LAN IP Packets
Received
Displays the number of IP packets received from the host interface since the system startup.
Wake on LAN Support
ALEOS can pass a Wake on LAN “Magic Packet” (a special Ethernet LAN WOL packet) to a connected host which is suspended or in hibernation to initiate its
‘wake-up’ process. The connected host must support Wake on LAN. To configure
Wake on LAN:
1. Connect the host that needs to be awakened to the ALEOS device.
2. On the Status > LAN page, press the Scan button.
3. Note the MAC address of the host.
4. On the LAN > Addressing page, the Host Public Mode can be set to either
Ethernet Uses Public IP or First Host Gets Public IP.
5. On the Security > Port Forwarding page, enter a forwarding rule as in the following example using defaults:
· Public Start Port: 7
· Public End Port: 9
· Host I/F: Ethernet
· Host IP: 192.168.13.255
· Private Port: 7
6. Put the device to be awakened into a suspend or hibernate mode, but leave it connected.
7. Reboot the ALEOS device.
8. From a remote location, send a “Magic Packet” to the NET IP on port 7, 8, or 9 using the MAC address noted in Step 3 of these instructions.
9. After a possible short delay, the host will wake up.
34 4112515
Status
VPN
The VPN section gives an overview of the VPN settings and indicates whether a
VPN connection has been made.
Figure 3-6: ACEmanager: Status > VPN
Field
Incoming out of band
Description
Indicates whether incoming out of band (from outside the VPN tunnel) is allowed or blocked.
Options: Allow, Block
Outgoing out of band
Indicates whether outgoing ALEOS out of band (to sites outside the VPN tunnel) is allowed or blocked.
Options: Allow, Block
Outgoing Host out of band
Indicates whether outgoing Host out of band (to sites outside the VPN tunnel) is allowed or blocked.
Options: Allow, Block
VPN 1 to 5 Status
Disabled, Enabled, Connected. The status of the IPSec VPN client or GRE client.
Rev. 6 May.13
35
ALEOS User Guide
Security
The security section is an overview of the security settings on the AirLink Device.
Figure 3-7: ACEmanager: Status > Security
Field
Port Filtering Inbound
Port Filtering Outbound
Trusted Hosts (Friends)
IP Reject Count
Description
Enabled or disabled. Show status of inbound port filtering.
Enabled or disabled. Show status of outbound port filtering.
Disabled or Enabled. Accepts packets only from specific IPs.
Rejected IP Data.
36 4112515
Status
Services
This section shows the status of AirLink services, including the ACEmanager access level.
Figure 3-8: ACEmanager: Status > Services
Field
AMS
OTA ACEmanager
Access
Tethered Host
ACEmanager Access
WiFi ACEmanager
Access
Enable time update
PinPoint Low Power
Mode State
Description
Indicates the status of the AirLink Management Services: Enabled or Not Enabled
Indicates the over-the-air ACEmanager access mode.
Tethered means Ethernet, USB, or RS232 is physically connected.
Indicates the WiFi ACEmanager access.
Indicates if daily SNTP updates of the system time are enabled or disabled.
Current power state (only available on MP and PP lines).
Rev. 6 May.13
37
ALEOS User Guide
GPS
Note: The GPS tab that displays in ACEmanager is applicable to PinPoint line and MP line devices.
Figure 3-9: ACEmanager: Status > GPS
Field
GPS Fix
Satellite Count
Latitude
Longitude
Heading
Speed
Engine Hours
Description
0 = No Fix, 1 = GPS Fix, 2 = WAAS
Shows how many satellites the GPS receiver can detect.
Displays the latitude of the GPS receiver.
The Map link next to the displayed latitude opens that position in Google Maps either in a new browser or a new browser tab.
Displays the longitude of the GPS receiver.
The direction in which the AirLink device is moving. No configuration is needed for Heading or Speed, they are calculated automatically.
TAIP data — Vertical Speed
Measure of how many hours the engine is on.
38 4112515
Status
Serial
Note: The Serial tab that displays in ACEmanager is applicable to all Sierra Wireless
AirLink devices except the Raven XE.
Figure 3-10: ACEmanager: Status > Serial
Field Description
Serial Port Mode
TCP Auto Answer
UDP Auto Answer
Default power-up mode for the serial port: When the ALEOS device is power-cycled, the serial port enters the mode specified by this command after 5 seconds. On startup, typing
ATMD0 within 5 seconds changes the mode to normal (AT command) mode.
This register determines how the ALEOS device responds to an incoming TCP connection request. The ALEOS device remains in AT command mode until a connection request is received. DTR must be asserted (S211=1 or &D0) and the device must be set for a successful TCP connection. The AirLink device will send a “RING” string to the host. A
“CONNECT” sent to the host indicates acknowledgement of the connection request and the
TCP session is established.
•
Off (Default)
•
On
•
Use Telnet server mode on TCP connections.
With a Telnet connection, overrides the client's default echo, allowing the server on the host port to perform the echo. CRLF sequences from the telnet client will also be edited to simply pass CRs to the server on the host port.
Enables UDP auto answer (half-open) mode.
•
Normal mode
•
Enable UDP auto answer mode.
Serial IP Packets Sent
Number of bytes sent over serial port to host.
Serial IP Packets
Received
Number of bytes received over serial port from host.
Rev. 6 May.13
39
ALEOS User Guide
Applications
The Applications section of the Status group provides information on the current status of the Garmin device and the status of data usage. See Chapter 11
(“Applications”) for details on how to enable or disable Garmin.
Figure 3-11: ACEmanager: Status > Applications
About
The About section of the Status group provides basic information about the cellular device.
Figure 3-12: ACEmanager: Status > About
40 4112515
Field
Device Model
Radio Module Type
Radio Firmware
Version
Description
Identifies the model of the device.
The model number (MC5727) of the type of internal cellular radio module.
Firmware version in the radio module.
Device ID
The 64-bit device ID the device uses to identify itself to the cellular network.
Ethernet Mac Address
The MAC address of the Ethernet port.
Displays version of ALEOS software running on the AirLink Device.
ALEOS Software
Version
Device Hardware
Configuration
Indication of the internally configured hardware.
Boot Version
MSCI Version
The version of boot code installed in the device.
Version of MSCI used by the ALEOS firmware.
Status
Rev. 6 May.13
41
ALEOS User Guide
42 4112515
4: WAN/Cellular Configuration
•
Network Credentials
•
Keep Alive
The WAN/Cellular tab that displays in ACEmanager is applicable for all Sierra Wireless AirLink devices.
The WAN/Cellular section allows changes to the cellular connection and main operating mode of the AirLink device.
4
Network Credentials
Note: The Network Credential and Advanced settings will display differently and are dependent on cellular carrier settings.
CDMA
Rev. 6 May.13
Figure 4-1: ACEmanager: WAN/Cellular > Network Credentials EV-DO/1X
43
ALEOS User Guide
Field
Network Credentials
Dormancy Idle Timer
(secs)
Mobile IP
Description
Inactivity timer, in seconds. Typical network settings cause a link to go dormant after 10 to
20 seconds of inactivity, no packets transmitted or received. This time can be shortened to release the physical RF link sooner when the application only transmits short bursts.
•
n=0 : Allows the cellular network to determine the inactivity timer.
•
n= seconds (maximum 20 seconds)
Mobile IP (MIP) Preferences. On a Mobile IP network, a device connects to the network using PPP. During the negotiation process the AirLink device is NOT required to present a username and password to authenticate because the authentication parameters are stored in the device itself.
•
n=0 : Disabled, SIP Only
•
n=1 : MIP Preferred (default)
•
n=2 : MIP Only
Note: Your account with your cellular carrier may not support Mobile IP.
MSL Code
The NAMLCK is the device's 6-digit OTSL (One Time Subsidy Lock), MSL (Master
Subsidy Lock), or SPC (Service Provisioning Code). Your cellular carrier will provide the unlock code.
•
nnnnnn=6 digit unlock code
Note: If the number is accepted by the device, the OK result code is returned. If the number is rejected, the ERROR result is returned. If three successive Errors are returned, the device must be reset by Sierra Wireless AirLink Solutions to allow any further attempts. The device permits 99 failures of this command during its lifetime. After that, the device becomes permanently disabled.
EV-DO Diversity
EV-DO Data Service
Network Roaming
Preference
EV-DO Diversity allows two antennas to provide a more consistent connection.
•
Disable
•
Enable (default)
If you are not using a diversity antenna, *EVDODIVERSITY should be disabled.
Change the allowable network type. Options:
•
EV-DO Preferred (default) — but can “fall back” on 1x only
•
EV-DO Only — fall back disabled
•
1X Only — EV-DO disabled
Automatically allows home and roaming network preference.
44 4112515
WAN/Cellular Configuration
Field
Keep Alive
Description
Keepalive IP Address
The IP address that the AirLink device will ping to determine if there is internet connectivity and make sure this IP address is accessible.
Set the IP address or valid internet domain name for the AirLink device to ping to keep itself alive (online). *IPPING must to be set to a value other than 0 to enable pinging.
•
d.d.d.d= IP address
•
name= domain name
*IPPINGADDR sets the IP address you want to use for the connection test.
If *IPPINGADDR is left blank or is set to an invalid IP address (example, an IP which is unreachable or one which is not a valid IP address), device performance will be adversely affected.
Keepalive Ping Time
The amount of time between pings when the device is idle.
Set the period to ping (if no valid packets have been received) a specified address
(*IPPINGADDR) to keep the device alive (online).
•
Disable pinging (default)
•
1–255 minutes
*IPPING sets the interval, in minutes, you want Keepalive to test the network connection.
To disable Keepalive, set *IPPING to 0 (default setting).
Force Keepalive Ping
If the ping should occur even if the device is not idle. Options:
•
NO (default)
•
YES—If, after four successive tries, the ping still fails, the device resets.
Note: If the signal strength is too low for a connection to be made, the device stays dormant and IPPing is not initiated.
Advanced
Response to Incoming
Ping
Sets how ALEOS responds when you ping the device OTA. Options:
•
ALEOS Responds (default)
•
No Response
•
Pass to Host
Note: By default, Pass to Host pings the first IP host of the DHCP IP pool.
Force Network
Authentication Mode
Network User ID
Network Password
Specifies the authentication method to be used in the network PPP session. Options:
•
None (default)
•
PAP
•
CHAP
Network User ID
When required, the login that is used to login to the cellular network.
•
uid=user id (up to 64 bytes)
The Network Password is used to login to the cellular network (when required). Passwords can be comprised of any type of character or case.
pw=password (1–255 characters).
Rev. 6 May.13
45
ALEOS User Guide
Field
Check profile 1
Params
NAI
PHA
SHA
MHSS
MASS
Network Watch Dog
Description
Enables checking and updating the Profile 1 Parameters. Not all carriers support this
feature. Options: Disable (default) and Enable
Sets the Network Access ID.
Not all carriers support this feature.
Sets the IP address of the primary home agent.
Not all carriers support this feature.
Sets the IP address of the secondary home agent.
Not all carriers support this feature.
Sets the home agent shared secret key.
Not all carriers support this feature.
Sets the AAA shared secret key.
Not all carriers support this feature.
Network connection watchdog: The number of minutes to wait for a network connection. If no connection is established within the set number of minutes, the device resets.
•
Disabled
•
minute Default = 120 min.
Re-Activation
Re-Activation
Re-Activation Status
Press Re-Activation when a particular module that has already been activated needs to be re-activated.
Indicator of a pending re-activation of your device. When you press the Re-Activation button, the status changes to Not Started.
46 4112515
Rev. 6 May.13
GSM
WAN/Cellular Configuration
Figure 4-2: ACEmanager: WAN/Cellular > Network Credentials GSM
47
ALEOS User Guide
Field
Network Credentials
Set APN
Description
Entry of the APN. If left blank, the device will attempt to use the default subscriber value as defined by the account.
•
apn= access point name
This is the diversity setting. Options: Enabled (default) and Disabled.
Rx Diversity
Network User ID
Network Password
The login that is used to login to the cellular network (when required).
•
uid= user id (up to 64 bytes)
Network Password. The password that is used to login to the cellular network (when required). Passwords can be comprised of any type of character or case.
•
pw= password (1–255 characters)
Enter the SIM PIN.
Band reported by the radio module.
SIM PIN
Current Radio Module
Band
Setting for Band (hex)
Desired band to set by ALEOS in the radio module. To change the value, click Apply, and then Refresh to see the status of the configuration below. Allows you to select
GSM bands — All, 3G only, 2G only, 3G all, and 2G all.
Band configuration Status
Indicator of a pending change for the Setting for Band.
0 = never set, 1= will be set on reboot, 2= set in radio module, 3= This value created an error response.
Keep Alive
Keepalive IP Address
The IP address that the AirLink device will ping to determine if there is internet connectivity and make sure this IP address is accessible.
Set the IP address or valid internet domain name for the AirLink device to ping to keep itself alive (online). *IPPING must to be set to a value other than 0 to enable pinging.
•
d.d.d.d= IP address
•
name= domain name
*IPPINGADDR sets the IP address you want to use for the connection test.
If *IPPINGADDR is left blank or is set to an invalid IP address (example, an IP which is unreachable or one which is not a valid IP address), device performance will be adversely affected.
Keepalive Ping Time
Force Keepalive Ping
The amount of time between pings when the device is idle.
Set the period to ping (if no valid packets have been received) a specified address
(*IPPINGADDR) to keep the device alive (online).
•
Disable pinging (default)
•
1–255 minutes
*IPPING sets the interval, in minutes, you want Keepalive to test the network connection. To disable Keepalive, set *IPPING to 0 (default setting).
If the ping should occur even if the device is not idle. Options:
•
NO (default)
•
YES—If, after four successive tries, the ping still fails, the device resets.
Advanced
48 4112515
WAN/Cellular Configuration
Field
Response to Incoming
Ping
Force Network
Authentication Mode
Network Watch Dog
Define PDP context
Set Carrier (operator)
Selection
On WAN Disconnect
Description
Sets how ALEOS responds when you ping the device OTA. Options:
•
ALEOS Responds (default)
•
No Response
•
Pass to Host
Note: By default, Pass to Host pings the first IP host of the DHCP IP pool.
Specifies the authentication method to be used in the network PPP session. Options:
•
None (default)
•
PAP
•
CHAP
Network connection watchdog: The number of minutes to wait for a network connection. If no connection is established within the set number of minutes, the device resets.
•
Disabled
•
minute Default = 120 min.
Easy entry of the APN. If left blank, the device will attempt to use the default subscriber value as defined by the account.
•
apn= access point name
1 and “IP” are required and not variable. Quotes need to be placed around the APN.
Tip:
When *NETAPN has been configured, +CGDONT will be pre-populated in
ACEmanager.
Manually specify an operator. (Refer also to *NETOP.)
•
mode= 0: Automatic — any affiliated carrier [default]
•
mode= 1: Manual — use only the operator <oper> specified.
•
mode= 4: Manual/Automatic — if manual selection fails, goes to automatic mode
•
format= 0: Alphanumeric ("name") (G3x10 must use this format)
•
format= 2: Numeric.
•
oper= ”name”
This setting enables the On WAN Disconnect feature. This feature resets the radio module after a cellular network disconnect. When set to the default setting of
Reconnect, ALEOS will attempt to reconnect to the network without resetting the radio module. Options:
•
Reconnect (default)
•
Reset Radio
Rev. 6 May.13
49
ALEOS User Guide
Set Roaming
V Carrier Features
The features described in this section apply only to the Raven XE 8795,
SKU H22995E-08.
Select V Carrier Specific if the carrier if a non-standard roaming algorithm needs to be activated in the radio module.
Always on Connection
•
Enabled—Modem always tries to maintain an IP connection.
•
Disabled—A Connection is not established unless an AT Command or SMS
Command is sent.
•
Connect when sending—Same as disabled, except that out-going traffic also initiates a connection.
50
Idle period before disconnect
This field is only visible if Connect when sending is selected in the Always on
Connection field. The IP connection is disabled after the device is idle for the period
(in minutes) set in this field.
SIM PIN
The SIM PIN feature in the Network Credentials GSM section allows users to change the SIM Pin number as per their requirements or keep it the same. The three options offered in the pop up box once you click SIM PIN are:
•
Don’t change — This is selected by default and implies that you do not want to change the SIM Pin number
•
Enable — Choose this option if a PIN SIM is required for startup. In the popup window, enter the PIN twice, and click Save.
•
Disable — Choose this option if you want to disable the SIM Pin feature.
4112515
WAN/Cellular Configuration
Rev. 6 May.13
Figure 4-3: ACEmanager: WAN/Cellular > SIM PIN
To change the SIM PIN number,
1.
Enter the SIM Pin number and retype it.
2.
Click Save.
Keep Alive
Keep Alive is used to test the connection to the cellular network by pinging an IP address after a specified period of inactivity. Keep Alive is only recommended for users who have a remote terminated device that infrequently communicates to the network or if you have experienced issues over time where the device can no longer be reached remotely.
When Keep Alive pings the IP address, an acknowledgement indicates there is an active connection to the network. If the AirLink device does not receive a response from the IP address, it will make additional attempts according to a backoff algorithm before determining the Internet connection is not functioning properly. If it determines the connection is not functioning, the device will then attempt to reconnect to the carrier to reestablish IP connectivity.
Data Usage Using Keep Alive
Keep Alive is an optional feature. If you frequently pass data with your device, you most likely do not need to have Keep Alive enabled. When using Keep Alive, be aware that a ping moves approximately 66 bytes of data over the network and is billable by the carrier. The following *IPPING settings will incur approximate monthly data usage in addition to any other data usage:
Re-Activation
The Re-Activation section of the WAN/Cellular tab only appears for CDMA devices. The Re-Activation feature can only be used when a particular module that has already been activated needs reactivation. If your device needs to be reactivated, click the Re-Activation button. When you click Provision, the status will change to — Not Started.
Note: If the provision fails, the error message “Failed” will display.
51
ALEOS User Guide
After the provision process finishes, the system will automatically restart—this reset is necessary to initiate the new account information.
Figure 4-4: ACEmanager: WAN/Cellular > Re-Activation
52 4112515
5: LAN/WiFi Configuration
•
Ethernet
•
Host Port Routing
•
WiFi
•
USB
•
Global DNS
•
PPPOE
•
On Demand Ping
•
Host Interface
Watchdog
The LAN tab that displays in ACEmanager is applicable across all
Sierra Wireless AirLink devices.
The primary purpose of the AirLink device is to route data from one or more devices connected to one or more of the ports to the cellular network and, ultimately, under most circumstances, to the Internet.
5
Public and Private Mode
To support some legacy installations, the AirLink device has the ability to act as a one-to-one gateway giving the cellular network granted IP address directly to a connected device. This is Public mode.
Since the one-to-one gateway configuration will not allow the flexibility of a LAN environment where several devices can connect to the AirLink device, Private Mode provides a NAT environment with an optional DHCP server.
Tip:
When using Public mode, Sierra Wireless recommends connecting the device directly to the computer or other end device. Using a hub or switch may prevent the AirLink device from updating the IP address of the end device when an IP address is received from the cellular network.
In ACEmanager, the Host Public mode and DHCP settings are part of the LAN tab. The DHCP addresses for USB/net are on the LAN >
USB page, the DHCP addresses for the serial PPP are on the Serial page, and the DHCP addresses for the WiFi, as applicable, are on the WiFi page.
Rev. 6 May.13
53
ALEOS User Guide
Ethernet
This section governs Ethernet port connections and the Public/Private mode of all ports. Changing settings in this area requires a reboot of the AirLink device after applying any change.
Field
Host Public Mode
Device IP
Starting IP
Figure 5-1: ACEmanager: LAN/WiFi > Ethernet > General
Description
Sets the Host Interface that uses the Public IP address granted by the cellular network or if all should use private IP addresses. All host interfaces which are not using the Public IP address will use private IP addresses.
0 = Ethernet Uses Public IP
1 = All Hosts Use Private IPs (default)
2 = USB Uses Public IP
3 = RS232 Uses Public IP
4 = First Host gets Public IP — This implies whichever host you connect to first (e.g.,
Ethernet) will get Public IP and the others will get their respective Private IPs.
Note: The connected computer receives DHCP address from ALEOS, and it also has the default router set up to the device IP.
The Ethernet IP address of the AirLink device. By default this is set to 192.168.13.31.
Ethernet DHCP pool starting IP address.
Note: If you have only one computer or device connected directly to the Ethernet port, this is the IP address it will be assigned.
54 4112515
LAN/WiFi Configuration
Field
Ending IP
DHCP network mask
DHCP Server Mode
Description
The ending IP for the Ethernet Interface.
The subnet mask indicates the range of host IP addresses that can be reached directly.
Changing this will limit or expand the number of clients that can connect to the AirLink device. The default is 255.255.255.0 and means that 254 clients can connect to the AirLink device. Using 192.168.13. as the first three octets of their IP address if the device IP is
192.168.13.31.
Options: Enabled or Disabled. By default, the Ethernet DHCP server is enabled. Disabling the DHCP server will require all connected clients to have static IP addressing.
Note: If the modem (in DHCP mode) attempts unsuccessfully to assign an IP address to a hardware device, the modem resets (on the assumption that there is a hardware/system problem.
DHCP Lease time
(Seconds)
Startup Delay
(seconds)
Link Setting
Configurable DHCP lease time. Default is 14400 (4 hours).
Turns off (in seconds) the Ethernet port at boot time. Maximum value is 300 seconds.
Link Radio Coverage to Interface
Radio Link Delay
(Seconds)
Interface Disabled
Duration
Configures the link Ethernet setting. Options:
•
Auto 100/10 (default)
•
Auto 10MB only
•
100 Mb Full Duplex
•
100 Mb Half Duplex
•
10 Mb Full Duplex
•
10 Mb Half Duplex
This will disable the specified port when there is no cellular coverage. Options: Disabled
(default), Ethernet, and USB.
The delay in seconds before the radio link goes down.
Sets the time (in seconds) that the LAN port is disabled. Use this feature to temporarily disable the LAN port when the cellular connection is down for minor network service changes. Options:
•
5
•
10
•
15
•
20
•
25
•
30
•
Interface Disabled when Radio Disabled
For the last option, the LAN port is disabled for the entire time the cellular connection is down.
Rev. 6 May.13
55
ALEOS User Guide
Field
Turn Off NAT
Host Routing Mask
Description
When enabled, ALEOS routes packets without performing NAT on them. Options: Disabled
(default) and Enabled.
This mask is needed for a LAN host to route to a remote location across the cellular network.
Default: 0.0.0.0
Tip:
If you are using Private Mode for all hosts (*HOSTPRIVMODE=1), you need to make sure that the device IP, Starting IP, and Ending IP are on the same subnet defined by the
DHCP network mask. If the subnet mask is 255.255.255.0, it is safe to use 192.168.x.y for each as long as the x is the same number (0 in the example screen shot above) and the y is different (1 and 2 in the example) and between 0 and 254.
Internal DHCP Server
DHCP (Dynamic Host Configuration Protocol) has become a primary component of today’s network environments. DHCP allows one server to automatically and dynamically allocate network IP addresses and other network related settings
(i.e., subnet masks, routers, etc.) to each computer or device without the need to set up each specifically or keep track of what addresses have already been used.
In a default configuration, the AirLink device acts as a DHCP host to any device connected to its ports, providing that device with an IP address which can be used to communicate on the Internet. In Public Mode, that will be the IP address assigned by the cellular network. In Private Mode, that will be the IP addresses defined in the LAN pages.
Address Assignment in Public Mode
1.
When the AirLink device registers on the cellular network, it is assigned an IP address from the carrier, e.g., 10.1.2.0.
2.
Acting as a DHCP server, with Ethernet, uses Public IP when the AirLink device receives a DHCP request from an Ethernet device connected to its ports, it hands off the assigned address to the device and sets up the default gateway address as 10.1.2.1. If the fourth octet is already a 1, it assigns
10.1.2.2 as the router address.
Note: The primary gateway to the cellular network for any connected device is enabled by default.
3.
The AirLink device also sends a /24 netmask (255.255.255.0 by default) and sets up a static route which maps 192.168.13.31 (or the address configured with *HOSTPEERIP if it is changed) to 10.1.2.1 (or 10.1.2.2 if that was what the gateway address was given as).
56 4112515
LAN/WiFi Configuration
Tip:
When PPPoE is used with the AirLink device, DHCP is not needed. A tunnel is set up connecting a device (such as your computer or a router) with the device. The device will then use the MAC address of the AirLink device to send all outgoing packets.
Host Port Routing
“Host Network” is the equivalent of the IP route command.
Figure 5-2: ACEmanager: LAN/WiFi > Host Port Routing
Field
Primary Gateway
Description
Your device is the Primary Gateway for the network behind a router connected to it, and
ALEOS responds to ARPs for all non-host Ethernet subnets. Options:
•
Enabled (default)
•
Disabled
Host Network 2 and 3 are secondary networks connected to the AirLink device by a router or other gateway. For example, 192.168.10.0.
Host Network 2 and
Host Network 3
Host Network Subnet
Mask 2 and
Host Network Subnet
Mask 3
This is the subnet for the applicable network. For example, 255.255.255.0, which would, with the setting above, define a secondary network of 192.168.10.0/24.
Host Network 2 Route and Host Network 3
Route
Indicates what type of router is being used for the host network. Options: Ethernet port and
Gateway. If the router is a traditional router which handles ARP for addresses on its subnet, select Ethernet. If it is a “dumb” gateway which is a conduit to a subnet but does not handle any ARP, select Gateway.
When Gateway is selected, ALEOS will ARP for the destination address and send it to the defined Host Network Gateway address. Many routers will respond to ARP requests for subnets behind the router. Some routers, however, do not respond to ARP requests for subnets. Hence, users need to enter the gateway address.
WiFi
On supported models, the MP has a WiFi radio for wireless LAN connections.
Rev. 6 May.13
57
ALEOS User Guide
Note: WiFi is only available on MP models designated with a W suffix (e.g., MP 890W or
MP 597W).
WiFi Configuration
Figure 5-3: ACEmanager: LAN/WiFi > WiFi
Field
Enable Wireless
Access Point
SSID/Network Name
Hide SSID
Description
Allows you to disable or enable the WiFi access point. If you are using the MP in an environment where security or safety require that you disable WiFi, you can turn WiFi off here. The WAN and Ethernet LAN connections will remain active. Options:
•
WiFi OFF (draft)
•
WiFi ON
The network name used to identify the wireless LAN. The default network name is 'MP'.
This determines whether the SSID will be broadcast by the MP. Hiding the SSID will not prevent people from connecting to the device if the signal is open. Options:
•
Display (default)
•
Hide
58 4112515
LAN/WiFi Configuration
Field
Wifi Channel
Security Encryption type
Description
The WiFi access point on the MP can use any of 11 channels. If other WiFi networks are in range and operating on nearby channels, you may be able to avoid interference by changing to a different WiFi channel. Options: 1–11. Default: 1–2.412 GHz
The MP device supports Wired Equivalent Privacy (WEP) and WiFi Protected Access/
802.11i (WPA and WPA2 Personal and Enterprise). Both protocols will restrict access to the
MP box and protect data transmitted between the clients and the device. WPA provides the highest level of security if all of the LAN devices on your network support this protocol. WPA
Enterprise is the follow on wireless security method to WPA that provides stronger data protection for multiple users and large managed networks. It prevents unauthorized network access by verifying network users through an authentication server.
Options: Open, Shared WEP, WPA/WPA2 Personal, and WPA/WPA2 Enterprise.
Open
Open WiFi protocol is not password protected and has no additional configuration requirements in ACEmanager.
Note: Selecting the encryption type will enable additional configuration option
Shared WEP
WEP (Wireless Encryption Protocol) is the least secure but most supported encryption method.
Field
Key Length
Figure 5-4: ACEmanager: WiFi > Shared WEP
Description
WEP is available with shorter 64-bit keys or longer 128-bit keys. While 128-bit encryption provides a higher level of security, some computers and WiFi clients only support 64-bit encryption. Use a key length compatible with all of the wireless clients on your network.
Options: 64-bit key (generated from passphrase), 128-bit key, and Custom Key.
Rev. 6 May.13
59
ALEOS User Guide
Field
WEP Passphrase
WEP Hex Key
Description
The default passphrase is 'MPWEP'. Enter your own private WEP passphrase to generate a hex (hexadecimal) key. Treat the passphrase like a password and select one that is difficult for others to guess. After you enter a new passphrase, click the Apply button to make the change effective.
When logging into WiFi from your computer, enter the WEP hex key, not the passphrase.
Most WEP connections only use the hexadecimal format. The passphrase is simply used as an easy way for you to create a hex key. You can configure your own hex key rather than generating one with a passphrase by selecting the 'Custom Key' option from the menu. Make sure your hex key only includes 10 or 26 valid hex digits, created through pairs of characters of 0-9 and/or a-f, with each pair separated by a colon. For example,
80:3a:c9:95:b8.
Note: The WEP hex key is created from the WEP Passphrase and Key Length on system startup. If you configure a WEP Passphrase, reboot the device and then note the generated WEP hex key to use for WiFi connections.
WPA/WPA2 Personal
WiFi Protected Access (WPA and WPA2) requires a pre shared passphrase be known before being able to connect to a network. WPA/WPA2 Personal authenticates the passphrase directly in the device.
Note: WPA or WPA2 is determined by the encryption scheme selected. TKIP is WPA. AES is WPA2.
Figure 5-5: ACEmanager: WiFi > WPA/WPA2 Personal
Field
WiFi Encryption
WPA Passphrase
Description
Defines what encryption scheme to use under WPA. Options: TKIP (Temporal Key Integrity
Protocol) and AES (Advanced Encryption Standard). Default: TKIP
By default this is 'DeviceWPAPassphrase'. You can change this to another phrase with alphanumeric characters and symbols when creating a passphrase.
60 4112515
LAN/WiFi Configuration
WPA Enterprise
WPA Enterprise adds another layer of security to WPA by requiring clients to authenticate with a server before being able to access the network. Clients connecting to the MP when WPA Enterprise is enabled will need to have certificates installed from the RADIUS server, allowing them access to the network before being allowed to connect.
Note: As with WPA/WPA2 Personal, WPA or WPA2 is determined by the encryption scheme selected. TKIP is WPA. AES is WPA2.
Figure 5-6: ACEmanager: WiFi > WPA/WPA 2 Enterprise
Field
WiFi Encryption
Description
Defines what encryption scheme to use under WPA. Options: TKIP (Temporal Key Integrity
Protocol) and AES (Advanced Encryption Standard). Default: TKIP
Radius Interface
Defines the endpoint for the radius server, either via radio over cellular or Ethernet on local
LAN. Options: Cellular (default) or Ethernet
Primary or Secondary
Radius Server IP
This is the IP address of your enterprise RADIUS server. These servers must be accessible ALL the time or clients will not be able to connect via WiFi. The secondary server is optional and used when the primary server is not available.
Primary or Secondary
Radius Server Port
This is the port number of your enterprise RADIUS server. The secondary port is used when the primary is unavailable. Only used when a Secondary Radius Server is specified.
Primary or Secondary
Radius Server Secret
This is the shared secret key used to secure communications with the RADIUS server.
Only used when a Secondary Radius Server is specified.
DHCP
Host WiFi IP
WiFi IP Start
The WiFi IP address of the AirLink device. By default this is set to 192.168.17.31.
Start WiFi IP address
Rev. 6 May.13
61
ALEOS User Guide
WiFi IP End
WiFi IP Netmask
End WiFi IP address
Mask for WiFi subnet
Note: The DHCP Server for WiFi is separate from the Ethernet DHCP Server. If you disable DHCP Server on LAN > Addressing, the WiFi DHCP should be unaffected.
USB
The AirLink device is equipped with a USB port which increases the methods by which you can send and receive data from a connected computer. The USB port can be set to work as either a virtual Ethernet port or a virtual serial port. A driver installation is required to use the USB port in either mode.
By default, the port is set to work as a virtual Ethernet port.
Note: It is recommended that you use a USB 2.0 cable with your AirLink device and connect directly to your computer for best throughput.
To change the USB port to allow virtual serial port communication in
ACEmanager in the LAN > USB group, choose USB Serial as the USB Device
Mode. To disable the USB port, select Disabled from the same menu.
62
Figure 5-7: ACEmanager: LAN/WiFi > USB
Note: There are USB/net and USB/serial drivers available for Windows XP and Windows 7
32-bit with a separate pair of drivers for Windows 7 64-bit.
4112515
Field
USB Device Mode
Device USB IP
Host USB IP
USB Serial Echo
LAN/WiFi Configuration
The change to the USB mode is immediate and generally does not require a reboot.
Description
*USBDEVICE=n
This parameter alters the default startup data mode for the USB port.
Options: USB Serial (Default), USBNET, and Disabled.
The USB/net IP address of the AirLink device. By default, this is set to 192.168.14.31.
The IP address of the computer or device connected to the USB port.
Toggle AT command echo mode when the USB is configured for virtual serial.
Options: Enabled (Default) and Disabled.
Note: USB Serial works with the Linux CDC-ACM driver.
Note: The directions in this section are for
Windows XP. Installing the drivers under Windows 7 takes a few extra steps.
Installing the USB Drivers
Virtual Ethernet is the default setting for the USB port. If you want to install the virtual serial port, change the Device Mode to USB Serial
When you connect the AirLink device for the first time to a USB port on your computer, Windows should detect a new device and prompt you to install the driver.
Note: Windows will see each port type as a different USB device and will see every port on your computer separately. If you change the port type on the AirLink device or connect to a different USB port on your computer or hub, Windows will see it as a new device.
Rev. 6 May.13
Figure 5-8: Found New Hardware Wizard
1.
To start the installation of the USB virtual Ethernet driver, select “No, not this time,” and click Next.
2.
Select Install from a list of specific location and click Next.
63
ALEOS User Guide
Figure 5-9: Hardware Wizard: Location options
3.
Select and/or enter the location of the driver.
•
If the driver is on the CD and the CD is in your drive, you can just select
Search removable media.
•
If you have installed ACEmanager or the Setup Wizard, the drivers will have been conveniently copied to your hard drive. Enter C:\Program Files\Common
Files\AirLink as the location to search.
•
If you will be installing the driver from a file downloaded from the Sierra
Wireless website, select Include this location in the search and type in the location where you downloaded the file.
4.
Click Next.
64
Figure 5-10: Hardware Wizard: Install location
After you select the location, the installation should begin. If you get a message asking if you want to continue the installation, click Continue Anyway.
Figure 5-11: Hardware Wizard: Installing
5.
Click Finish to complete the installation. The driver should be enabled without any need to reboot your computer.
4112515
LAN/WiFi Configuration
Figure 5-12: Hardware Wizard: Finish
Virtual Ethernet
The USB Ethernet connection will show up in your Network Connections as a
Local Area Connection.
Tip:
If you also have an Ethernet card on the computer or have installed the USB Ethernet to more than one USB port on your computer, the USB Ethernet may show up with a number.
Rev. 6 May.13
Figure 5-13: Network Connections
Note: By default, your Host IP for USB/net is 192.168.14.100.
You can also verify the installation by looking in the Device Manager.
1.
Click Start > Control Panel.
2.
Double-click the System icon.
3.
Select the Hardware tab and click the Device Manager button.
65
ALEOS User Guide
Figure 5-14: System Properties
4.
Click the + in front of Network Adapters.
The newly installed driver, AirLink USB Ethernet/RNDIS, should be displayed. If the driver is displayed with a # and number behind the driver name (such as,
AirLink USB Ethernet/RNDIS #2), it means more than one is installed on your computer, most likely for a different USB port. More than one copy of the driver should not cause any problems since only the connected port and its driver would be active.
66
Figure 5-15: Device Manager > Ethernet
Once the driver is installed, you can use the USB port just like a standard
Ethernet port.
Virtual Serial
You can verify the installation by looking in the Device Manager.
4112515
LAN/WiFi Configuration
1.
Click Start > Control Panel.
2.
Double-click the System icon.
3.
Select the Hardware tab and click the Device Manager button.
Figure 5-16: System Properties
4.
Click the + in front of modems.
The newly installed driver, AirLink USB Serial Port, should be displayed.
Tip:
If the driver is displayed with a # and number behind the driver name (such as AirLink
USB Serial Port #2), it means that more than one driver is installed on your computer, most likely for a different USB port. More than one copy of the driver should not cause any problems since only the connected port and its driver would be active.
Rev. 6 May.13
Figure 5-17: Device Manager > Serial
67
ALEOS User Guide
To connect to the device using the USB virtual serial, most applications or utilities will require you to select or enter the serial (COM) port number. The USB connection will appear as a standard serial port, and you will need to determine its number to connect to it. The driver installation will automatically assign a port, or you can change it if you wish to another unused port.
5.
From the Device Manager, right click the driver name and select Properties.
Figure 5-18: Device Manager: Driver menu
6.
Select the Advanced tab and click the Advanced Port Settings button.
68
Figure 5-19: Driver Properties
7.
At the bottom of the screen, the current port used will be listed. Use the drop down menu to select an available COM port number if you need to change it.
4112515
Rev. 6 May.13
LAN/WiFi Configuration
Figure 5-20: Advanced Settings
Note: The COM port number assigned by driver installation is the next port that is available.The port number might vary depending on the number of devices connected
(using serial or virtual serial).
Once the driver is installed, you can use the USB port just like a standard serial port.
69
ALEOS User Guide
Global DNS
When the cellular network grants the IP address to the device, it includes the IP addresses to its DNS servers. Global DNS allows you to override the carrier’s
DNS settings for all connected devices. This is useful when the connected devices need to use a private network.
Note: If there are no alternate DNS defined, the default is the carrier network DNS server.
Figure 5-21: ACEmanager: LAN/WiFi > Global DNS
Field
DNS Updates
Primary DNS
Secondary DNS
Alternate Primary
DNS
Alternate Secondary
DNS
Alternate DNS Port
Description
Sends DNS updates to *DNSUSER server. Options: Disabled or Enabled. By default, this is set to Disabled.
Primary carrier DNS IP Address. This Primary DNS IP Address is granted by the carrier network.
Secondary carrier DNS IP Address. This Secondary DNS IP Address is granted by the carrier network.
Alternate Primary DNS address. Allows you to enter a Primary DNS IP Address of your choosing to override the carrier-granted Primary DNS IP address.
Alternate Secondary DNS address. Allows you to enter a Secondary DNS IP Address of your choosing to override the carrier-granted Secondary DNS IP address.
This port will be used to forward DNS requests OTA using the Primary and Secondary DNS addresses. The response will then be forwarded to the standard DNS port when sent to the connected Host computer or device.
Note: The DNS Servers at the configured DNS IP addresses need to be able to handle
DNS requests using the configured port.
70 4112515
Rev. 6 May.13
LAN/WiFi Configuration
PPPOE
Just like the dial up protocol on which it is based, PPPoE uses traditional user name and password authentication to establish a direct connection between two
Ethernet devices on a network (such as your AirLink device and your computer or router).
Application examples for PPPoE with your AirLink device:
•
Backup connectivity solution for your network
•
Individualized Internet connection on a LAN
•
Password restricted Internet connection
Only one computer, router, or other network device at a time can connect to the
AirLink device using PPPoE. If you are using the AirLink device connected to a router as a backup Internet connection for your network, you should configure the router to use the PPPoE connection and not the individual computers.
Tip:
You may need to use Private Mode to configure the IP address of your AirLink device to be available on a LAN.
Note: To configure a PPPoE connection on Microsoft Windows XP, 2000 or NT, you will need administrator privileges to the computer you are configuring or access granted by an administrator on the network to add/remove devices to your computer.
Figure 5-22: ACEmanager: LAN/WiFi > PPPoE
71
ALEOS User Guide
Field
Host Authentication
Mode
Host User ID
Description
Use PAP or CHAP to request the user login and password during PPP or CHAP negotiation on the host connection. The username and password set in *HOSTUID and *HOSTPW will be used. Options:
•
NONE (Default)
•
PAP and CHAP
•
CHAP
Host login name (User ID) for PAP or CHAP.
•
user id (up to 64 bytes)
Host Password
Note: The User ID/Username ‘user’ is not allowed for PPPoE authentication.
Host Password for PAP or CHAP.
Note: The Password ‘password’ is not allowed for PPPoE authentication.
72
Configure the AirLink Device to Support PPPoE
Note: You MUST disable the DHCP server for PPPoE to work.
To configure the AirLink device to support a PPPoE connection:
•
From the groups on the left, select PPPoE under LAN.
•
Change Host Authentication Mode to 2.
•
Enter a user name for PPP User ID for the PPPoE connection.
•
Enter a password (PPP password) for the PPPoE to connection.
Tip:
If you leave PPP User ID and PPP password blank, any computer or device can connect to the PinPoint device using PPPoE.
Note: ACEmanager shows the existing values for
PPP User ID
and
PPP password
encrypted and character padded.
Optional: Configure *Device Name
1.
In ACEmanager, select Dynamic DNS from the groups on the left (under
Services).
2.
Enter a name for the Device Name, such as AirLink device or the ESN.
The name you choose for Device Name will not affect the connection but may need to be configured in PPPoE settings for the router, device, or computer you will be connecting to your AirLink device.
4112515
On Demand Ping
LAN/WiFi Configuration
Field
On Demand Ping
On Demand Ping
Status
Send Ping now
Figure 5-23: ACEmanager: LAN/WiFi: On Demand Ping
Description
Enter the IP address to be pinged.
Indicates the status of the IP address that can be pinged.
Click the Send Ping now button to initiate a ping.
Host Interface Watchdog
Host Interface Watchdog acts as a watchdog on the ALEOS host interface; if
ALEOS loses communications with the host device, it reboots.
ALEOS pings the device at a configured interval. If the device does not respond,
ALEOS sends five quick pings. If these pings elicit no response then ALEOS will reboot. Once ALEOS reboots, it will not reboot for an hour due to the Host
Interface Watchdog.
Rev. 6 May.13
Figure 5-24: ACEmanager: LAN/WiFi: Host Interface Watchdog
73
ALEOS User Guide
Field
Host Keepalive IP
Address
Host Keepalive Ping
Time (Minutes)
Description
Reset the device if no OTA traffic has been received after the specified number of minutes.
0 = disabled.
Reset the device if no Host traffic has been received after the specified number of minutes.
0 = disabled.
74 4112515
6: VPN Configuration
•
Global Settings
•
VPN 1 to 5
•
Log
The VPN tab that displays in ACEmanager is applicable across all
Sierra Wireless AirLink devices.
The AirLink device can act as a Virtual Private Network (VPN) client, providing enterprise VPN access to any device connected to the
AirLink device even when a device has no VPN client capability on its own. The AirLink device supports two tunneling protocols, IPsec and
GRE. Both can be used at the same time.
6
IPsec
The IP protocol that drives the Internet is inherently insecure. Internet
Protocol Security (IPsec), which is a standards-based protocol, secures communications of IP packets over public networks.
IPsec is a common network layer security control and is used to create a virtual private network (VPN).
The advantages of using IPsec or GRE feature includes:
•
Data Protection: Data Content Confidentiality allows users to protect their data from any unauthorized view since the data is encrypted (encryption algorithms are used).
•
Access Control: Access Control implies a security service that prevents unauthorized use of a Security Gateway, a network behind a gateway or bandwidth on that network.
•
Data Origin Authentication: Data Origin Authentication verifies the actual sender, thus eliminating the possibility of forging the actual sender’s identification by a third-party.
•
Data Integrity: Data Integrity Authentication allows both ends of the communication channel to confirm that the original data sent has been received as transmitted, without being tampered with in transit. This is achieved by using authentication algorithms and their outputs.
Rev. 6 May.13
75
ALEOS User Guide
Global Settings
The AirLink device supports Global Settings with one encrypted tunnel and one open tunnel. Global Settings VPNs should be setup with care, as a Global
Settings configuration with both an enterprise VPN and access to the public
Internet can inadvertently expose company resources.
Figure 6-1: ACEmanager: VPN > Global settings
Field
Incoming Out of Band
Outgoing Management
Out of Band
Outgoing Host Out of
Band
NAT-T Enable
Description
Blocks or Allows incoming out of band settings. Options: Blocked or Allowed.
Outgoing ALEOS out of band can be blocked or allowed. Options: Blocked or Allowed.
Outgoing Host out of band can be blocked or allowed. Options: Blocked or Allowed.
Network Address Translation–Traversal (NAT-T) refers to a number of techniques typically used by IPsec virtual private networks.
Disabled by default. Enable this option if you are setting up an IPsec VPN.
Options: Enabled or Disabled.
76 4112515
VPN Configuration
VPN 1 to 5
Each of the VPN tunnels 1 to 5, can be configured as IPsec or GRE. When you select the VPN type for a tunnel, the configuration settings specific to the VPN type will become available.
The IPsec architecture model includes the Sierra Wireless AirLink gateway as a remote gateway at one end communicating, through a VPN tunnel, with a VPN gateway at the other end. The remote gateway is connected to a Remote network and the VPN is connected to the Local network. The communication of data is secure through the IPsec protocols.
Field
VPN # Type
VPN # Status
Rev. 6 May.13
Figure 6-2: ACEmanager: VPN > VPN 1
Description
Use this field to enable or disable the VPN tunnel. If custom settings are used, they will be saved and the tunnel can be disabled and re-enabled without needing to reenter any of the settings. The IPsec VPN employs the IKE (Internet Key Exchange) protocol to set up a
Security Association (SA) between the ALEOS device and a Cisco (or Cisco compatible) enterprise VPN server. IPsec consists of two phases to setup an SA between peer VPNs.
Phase 1 creates a secure channel between the ALEOS device VPN and the enterprise
VPN, thereby enabling IKE exchanges. Phase 2 sets up the IPsec SA that is used to securely transmit enterprise data. For a successful configuration, all settings for the VPN tunnel must be identical between the AirLink Device VPN and the enterprise VPN server.
Options: Tunnel Disabled, IPsec Tunnel (default), or GRE Tunnel.
Not Enabled, Not Connected, or Connected. This indicates the current status of the VPN connection. Use this as part of troubleshooting a VPN connection.
77
ALEOS User Guide
Field
VPN Gateway
Address
Pre-shared Key 1
My Identity Type
Description
The IP address of the server that this client connects to. This IP address must be open to connections from the AirLink device.
Pre-shared Key (PSK) used to initiate the VPN tunnel.
My Identity — FQDN
or
My Identity — IP
Peer Identity Type
My Identity — FQDN displays only when User FQDN or FQDN is selected from the My
Identity Type menu. Enter an FQDN or User FDQN.
My Identity — IP displays only when IP is selected from the My Identity Type menu. The
WAN IP address assigned by the carrier displays.
Required in some configurations to identify the client or peer side of a VPN connection.
Options:
•
IP (default) — The Peer Identity — IP field displays with the IP address of a VPN server set up by Sierra Wireless for your testing purposes
•
FQDN — The Peer Identity — FQDN field displays. Enter an FQDN
(E.g., modemname.domainname.com)
•
User FQDN — The Peer Identity — FQDN field displays. Enter a User FQDN whose values should include a username (E.g., [email protected]).
Peer Identity — IP or
Peer Identity — FQDN
Peer Identity — FQDN displays only when User FQDN or FQDN is selected from the Peer
Identity Type menu. Enter the Peer FQDN or Peer User FQDN.
Peer Identity — IP displays only when IP is selected from the Peer Identity Type menu. The
VPN Gateway IP Address displays.
Negotiation Mode
IKE Encryption
Algorithm
IKE Authentication
Algorithm
IKE Key Group
Options:
•
IP (default) — The My Identity — IP field displays with the WAN IP address assigned by the carrier
•
FQDN — The My Identity — FQDN field displays. Enter a fully qualified domain name
(FQDN) (E.g., modemname.domainname.com)
•
User FQDN — The My Identity — FQDN field displays. Enter a User FQDN whose values should include a username (E.g., [email protected]).
To operate the onboard VPN under Aggressive mode, enable this configuration. By default, the AirLink Device operates under Main Mode. Aggressive mode offers increased performance at the expense of security. Options: Main Mode or Aggressive.
Determines the type and length of encryption key used to encrypt/decrypt ESP
(Encapsulating Security Payload) packets. 3DES supports 168-bit encryption. AES
(Advanced Encryption Standard) supports 128-bit encryption. Options:
•
DES
•
3DES
•
AES-128 (default)
•
AES-256
Can be configured with MD5 or SHA1. MD5 is an algorithm that produces a 128-bit digest for authentication. SHA1 is a more secure algorithm that produces a 160-bit digest.
Options: SHA1 or MD5.
Options:
•
DH1
•
DH2 (default)
•
DH5
78 4112515
VPN Configuration
Field
IKE SA Life Time
Description
Values: 180 to 86400. Determines how long the VPN tunnel is active in seconds. The default value is 28,800 seconds, or 8 hours.
Local Address Type
The network information of the device. Options:
•
Use the Host Subnet (default) — If selected, Local Address and Local Address Subnet do not display
•
Single Address — If selected, only Local Address displays
•
Subnet Address — If selected, both Local Address and Local Address Subnet display.
Remote Address Type
The network information of the IPsec server behind the IPsec gateway.
Options: Single Address and Subnet Address (default).
Remote Address
The IP address of the device behind the gateway.
Remote Address —
Netmask
Perfect Forward
Secrecy
24-bit netmask (Default).
IPSec Encryption
Algorithm
IPSec Authentication
Algorithm
Determines the type and length of encryption key used to encrypt/decrypt ESP
(Encapsulating Security Payload) packets. 3DES supports 168-bit encryption. AES
(Advanced Encryption Standard) supports 128 and 256 bit encryption.
Options: None, DES, 3DES, AES-128 (default), and AES-256.
Can be configured with MD5 or SHA1. MD5 is an algorithm that produces a 128-bit digest for authentication. SHA1 is a more secure algorithm that produces a 160-bit digest.
Options: None, SHA1 (default), and MD5.
IPSec Key Group
Provides additional security through a DH shared secret value. One key cannot be derived from another. This ensures previous and subsequent encryption keys are secure even if one key is compromised.
IPSec SA Life Time
Determines how the AirLink Device VPN creates an SA with the VPN server. The DH
(Diffie-Hellman) key exchange protocol establishes pre-shared keys during the phase 1 authentication. AirLink Device supports three prime key lengths, including Group 1 (768 bits), Group 2 (1,024 bits), and Group 5 (1,536 bits).
Options: None, DH1, DH2 (default), and DH5.
180 to 86400. Determines how long the VPN tunnel is active in seconds. The default value is 28,800 seconds, or 8 hours.
Keep Tunnel Alive
This implies that the tunnel needs to be established automatically, and if the tunnel is pulled down, it needs to be re-established automatically. Options: No (default) or Yes.
Note: For a SonicWALL VPN gateway, it is best to set Keep Tunnel Alive to “Yes.” If set to
“No,” the tunnel to the SonicWALL may get disconnected.
NAT-T Keep Alive
Interval (Secs)
NAT-T End Timer
(Minutes)
Length of time between NAT-T (NAT Traversal) keep alive packets. The default is set to 20 seconds. For users who have devices behind the carrier firewall, and who need to use
IPsec, the NAT-T feature is useful in such scenarios. As the carrier is performing NAT on the IP traffic, the key exchange required for IPsec cannot be performed, preventing operation of IPsec behind the firewall. With the addition of the NAT-T protocol, IPsec tunnels can be established between devices across the firewall.
If the tunnel is idle for one whole SA-Life time, the tunnel will not rekey itself. After this period, the carrier waits for that given time and then takes away the port and IP associated with this device.
Rev. 6 May.13
79
ALEOS User Guide
GRE
The AirLink Device can act as a Generic Routing Encapsulation (GRE) endpoint providing a means to encapsulate a wide variety of network layer packets inside
IP tunneling packets. With this feature, you can reconfigure IP architectures without worrying about connectivity. GRE creates a point-to-point link between routers on an IP network.
Figure 6-3: ACEmanager: VPN > VPN1> GRE Tunnel
Log
Use the VPN log for troubleshooting purposes when setting up the IPsec and/or
GRE configuration. The Log page allows you to establish the tunnel connection
(Connect to field) and monitor the results directly. To change the intervals at which the log is displayed, you can change the settings in Auto Refresh.
Following are the main action tabs on the log page:
•
Connect — indicates connecting to the tunnel
•
Refresh — is the option to refresh the page manually
•
Clear — clicking on Clear will clear out the tunnels
•
Apply Policy — tears down the existing tunnel and applies the policies for the tunnel selected
80 4112515
Rev. 6 May.13
Figure 6-4: ACEmanager: VPN > Log
VPN Configuration
81
ALEOS User Guide
82 4112515
7: Security Configuration
•
Port Forwarding and DMZ
•
Port Filtering —
Inbound
•
Port Filtering —
Outbound
•
Trusted IPs —
Inbound
•
Trusted IPs —
Outbound
•
MAC Filtering
The Security tab that displays in ACEmanager is applicable across all
Sierra Wireless AirLink devices.
The security tab covers firewall type functions, how data is routed or restricted from one side of the AirLink device to the other, from computers or devices connected to the device (LAN) and from computers or devices contacting it from a remote source (WAN).
These features are set as “rules”.
7
Tip:
For additional security, it is recommended you change the default password for ACEmanager. Refer to the Admin chapter.
Solicited vs. Unsolicited
How the device responds to data being routed from one network connection to the other depends on the origin of the data.
•
If a computer on the LAN initiates a contact to a WAN location
(such as a LAN connected computer accessing an Internet web site), the response to that contact would be solicited.
•
If, however, a remote computer initiates the contact (such as a computer on the Internet accessing a camera connected to the device), the connection is considered unsolicited.
Rev. 6 May.13
83
ALEOS User Guide
Port Forwarding and DMZ
In Port Forwarding, any unsolicited data coming in on a defined Public Port will be routed to the corresponding Private Port and Host IP of a device connected to the specified Physical Interface. In addition to forwarding a single port, you can also forward a range of ports.
DMZ defines a single LAN connected device to where all unsolicited data should be routed. Anything coming into the ALEOS device on a public port will go directly to that LAN connected device using the same private port.
Note: Port Forwarding and DMZ require Private Mode.
Figure 7-1: Port Forwarding
84
Figure 7-2: ACEmanager: Security > Port Forwarding
Note: The maximum number of port forwarding rules that can be configured for port forwarding is 19.
4112515
Security Configuration
Field
DMZ IP
Description
IP address of a DMZ. The AirLink Device allows a single client to connect to the Internet through a demilitarized zone (DMZ). The DMZ is particularly useful for certain services like
VPN, NetMeeting, and streaming video that may not work well with a NAT router. DMZ host is unavailable if IP passthrough is enabled.
Default Interface
Physical connection type to the device. (USB, Ethernet, Serial)
•
Use what is connected
•
Serial PPP
•
Ethernet
•
USB NDIS;
•
Wi-Fi
Number of PF entries
The number of port forwarding rules. This field must be set or port forwarding does not work.
Public Start Port
The first of a range or a single port on the public network (cellular network accessible).
Public End Port
Host Interface (I/F)
Host IP
Private Port
The end of the range on the public network (cellular network accessible).
Physical connection type to the device. (USB, Ethernet, Serial)
Ethernet; Serial PPP; USB NDIS; Wi-Fi
IP address of a device connected to the Host I/F interface.
The single or starting port on the device at the Host IP. If a public end port is defined, the private port range will be the difference of the public start and end point.
Example of configuring a port forward rule for port forwarding range of 5 ports on an Ethernet connected device:
1.
Set number of PF entries to 1.
2.
Click “Add More” to display a rule line.
3.
Enter 8080 for the public start port.
4.
Enter 8085 for the public end port.
5.
Select Ethernet as the Host I/F.
6.
Enter 192.168.13.100 as the Host IP.
7.
Enter 80 as the private port.
An unsolicited data request coming in to the AirLink device on port 8080 is forwarded to the LAN connected device, 192.168.13.100, at port 80. In addition, an unsolicited data request coming in from the internet on port 8081,8082, 8083,
8084, and 8085 is forwarded to 81, 82, 83, 84, and 85 respectively.
Example of configuring the DMZ on an Ethernet connected device:
1.
Enter 192.168.13.100 for the DMZ IP.
2.
Select Ethernet as the Default Interface.
An unsolicited data request coming in to the AirLink device on any port, will be forwarded to the LAN connected device, 192.168.13.100, at the same port.
Rev. 6 May.13
85
ALEOS User Guide
Note: The DMZ settings are independent of the number of Port Forward entries and can be used with port forwarding to pass anything not forwarded to specific ports.
Port Filtering — Inbound
Port Filtering—Inbound restricts unsolicited access to the AirLink device and all
LAN connected devices.
Port Filtering can be enabled to block ports specified or allow ports specified.
When enabled, all ports not matching the rule will be allowed or blocked depending on the mode.
Port Filtering can be configured on individual ports or for a port range. Click Add
More for each port filtering rule you want to add.
Note: Inbound restrictions do not apply to responses to outbound data requests. To restrict outbound access, you need to set the applicable outbound filter.
Figure 7-3: ACEmanager: Security > Port FIltering > Inbound
Field Description
Inbound Port Filtering
Mode
Options: 0 = Not Used (default); 1 = Blocked Ports; 2 = Allowed Ports
Allowed Ports — All ports through which traffic is allowed are listed below.
Blocked Ports — All ports though which traffic is blocked are listed below.
Start Port
End Port
The first of a range or a single port on the public network (cellular network accessible).
The end of the range on the public network (cellular network accessible).
Warning:
Selecting Allowed Ports will *block* all ports not allowed, and will *prevent remote access* if the management ports are not allowed. To allow remote management, the allowed ports list should include 8088, 17339, 17336, and AceManager port 9191 (or the port the user has selected for AceManager).
86 4112515
Security Configuration
Port Filtering — Outbound
Port Filtering —Outbound restricts LAN access to the external network, e.g. the
Internet.
Port Filtering can be enabled to block ports specified or allow ports specified.
When enabled, all ports not matching the rule will be allowed or blocked depending on the mode.
Port Filtering can be configured on individual ports or for a port range. Click Add
More for each port filtering rule you want to add.
Note: Outbound restrictions do not apply to responses to inbound data requests. To restrict inbound access, you need to set the applicable inbound filter.
Figure 7-4: ACEmanager: Security > Port Filtering > outbound
Field
Outbound Port
Filtering Mode
Start Port
End Port
Description
Allowed and blocked ports through which traffic is either allowed or blocked (respectively) are listed. Options:
•
Not Used (default)
•
Blocked Ports
•
Allowed Ports
Note: Outbound IP filter supports up to 9 ports.
The first of a range or a single port on the LAN.
The end of the range on the LAN.
Trusted IPs — Inbound
Trusted IPs — Inbound restricts unsolicited access to the AirLink device and all
LAN connected devices.
Rev. 6 May.13
87
ALEOS User Guide
Tip:
Trusted IPs — Inbound was called Friends List in legacy AirLink products.
When enabled, only packets with source IP addresses matching those in the list or range of trusted hosts will have unrestricted access to the AirLink device and
LAN connected devices.
Note: Inbound restrictions do not apply to responses to outbound data requests. To restrict outbound access, you need to set the applicable outbound filter.
88
Figure 7-5: ACEmanager: Security > Trusted IPs > Inbound (Friends)
Field
Inbound Trusted IP
(Friend’s List) Mode
Non-Friends Port
Forwarding
Trusted IP
Range Start
Range End
Description
Disables or Enables port forwarding rules. Options: Disabled (default) or Enabled.
Non-Friends port forwarding is like an allow rule for any of the forwarded ports. If it is enabled, the port forwarding rules apply to all incoming packets. If it is disabled, only
Friends List IPs get through. Options: Disabled (default) or Enabled.
Each entry can be configured to allow a single IP address, (e.g., 64.100.100.2) or the IP addresses from a complete subnet (such as 64.100.10.255) allowing all IP addresses from
64.100.10.0 to 64.100.10.255.
Specify the IP address range that is allowed access. For example, 64.100.10.2 to start and
64.100.10.15 to end would allow 64.100.10.5 but would not allow 64.100.10.16.
Trusted IPs — Outbound
Trusted IPs—Outbound restricts LAN access to the external network, i.e., the
Internet.
When enabled, only packets with the destination IP addresses matching those in the list of trusted hosts will be routed from the LAN to the external location.
4112515
Security Configuration
Note: Outbound restrictions do not apply to responses to inbound data requests. To restrict inbound access, you need to set the applicable inbound filter.
Figure 7-6: ACEmanager: Security > Trusted IPs > Outbound
Field
Outbound Firewall
Mode
Trusted IP
Description
Disables or Enables port forwarding rules. Options: OFF (default) or ON.
Each entry can be configured to allow a single IP address, for example 64.100.100.2, or the
IP addresses from a complete subnet, such as 64.100.10.255 allowing all IP addresses from 64.100.10.0 to 64.100.10.255.
MAC Filtering
MAC filtering restricts LAN connection access. You can specifically block or allow a connection from a computer or other device by blocking or allowing the MAC address of its network interface adapter.
Figure 7-7: ACEmanager: Security > MAC Filtering
Rev. 6 May.13
89
ALEOS User Guide
Field
MAC Filtering
MAC Filtering Mode
MAC Address
Description
Enable or disable MAC Filtering. Options: Disabled (default) or Enabled.
Allows or blocks the MAC Addresses listed. Add the MAC addresses by clicking on Add
More. Options: Blocked List (default) or Enabled.
This is the MAC Address of the interface adapter on a computer or other device.
90 4112515
8: Services Configuration
•
AMS (AirLink
Management
Services)
•
Low Power
•
Dynamic DNS
•
SMS
•
Telnet/SSH
•
Email (SMTP)
•
Management
(SNMP)
•
Time (SNTP)
•
Passive FTP
•
Logging
The Services tab that displays in ACEmanager is applicable across all Sierra Wireless AirLink devices.
The Services sections allow the configuration of external services that extend the functionality of the AirLink device.
8
AMS (AirLink Management
Services)
Figure 8-1: ACEmanager: Services > AirLink Management Services
Rev. 6 May.13
91
ALEOS User Guide
Field Description
AirLink
Management
Services
Allows you to connect or disconnect the device remotely to AirLink Management
Services.
•
Disabled
•
Enabled (default)
AMS Server URL
This is the AirLink Management Services server URL address. Default address is: http://na.m2mop.net/device/msci.
Heartbeat interval
(Minutes)
Account Name
Identity
Status
This field determines how often the AirLink device checks for software updates and settings changes from AirLink Management Services. AirLink Management Services can also query the AirLink device at a regular interval if settings allow. The default is
7 days.
Refer to AirLink Management Services documentation for more information.
Your account name (the registered company name in AirLink Management
Services).
Reports the identity of the device name on AirLink Management Services.
Displays the last known status of AirLink Management Services connection.
ACEmanager
92
Figure 8-2: ACEmanager: Services > ACEmanager
Field
OTA
ACEmanager
Access
Tethered Host
ACEmanager
Access
Description
The OTA (remote connection) ACEmanager access mode.
Options: OFF, SSL Only, and, Both HTTP and SSL.
Default: OFF
The Tethered Host ACEmanager access mode.
Options: SSL Only and Both HTTP and SSL.
Default: Both HTTP and SSL.
4112515
Services Configuration
Field
WiFi
ACEmanager
Access
ACEmanager
Port
ACEmanager
SSL Port
Description
The WiFi ACEmanager access mode.
Options: OFF or Same as Host.
Default: OFF.
Port for ACEmanager, e. g., 9191. Reboot the device if you change the port settings.
SSL port for ACEmanager. Options: 9443 thru 9449 and 443.
Default: 443.
Low Power
The AirLink device will put itself into a low power using mode when configured events occur. Low Power mode is essentially a standby mode which uses minimal power while being ready to “come alive” quickly. If you are not connecting to an
MP or PinPoint line device, you will not see this group.
Figure 8-3: ACEmanager: Services > Low Power
Rev. 6 May.13
93
ALEOS User Guide
Field Description
Voltage Level Low
Power Enable (.1Volt)
Set or query the voltage level at which the device goes into low power mode.
•
Ignore voltage for power control.
•
Threshold in tenths of volts
Example: ATVLTG=130 would place the device in a low power use standby state if the voltage goes below 13.0V.
Note: When Ignition sense is enabled, there is no need to configure this parameter with ignition sense enable.
Low Power Mode
Delay (Minutes)
Displays the number of minutes after one of the power down events (VTLG or DTRP) happens until the AirLink device enters the low power mode. If DTRP and VLTG are both 0
(zero), this setting does nothing.
•
n=0–255 minutes
Note: There is always a minimum of 1 minute between power down and the actual shutdown (to give the AirLink device time to prepare); entering zero will not power down the device immediately. In the first 5 minutes after the AirLink device powers up, power down events are ignored to give the user time to change configurations.
Standby Ignition
Sense Enable
Standby Ignition Sense Enable: the AirLink device will monitor the ignition sense on the power connector and enter the low power consumption stand-by mode when the ignition is turned-on (Enabled).
•
n=0: Disabled (default)
•
n=1: Enabled
Engine Hours on
Voltage Level (.1 Volt)
Set the voltage above which the Engine should be considered “ON”.
To enter a voltage of 13.0 volts, enter 130.
Engine Hours Ignition
Enable
Engine Hours will be counted when enabled. Options: Disabled (default) and Enabled.
Configuring Engine Hours
ALEOS can keep track of Engine Hours and how long the engine has been on, which is determined by either Ignition Sense or the Power In voltage. In the Low
Power group, under Common, there two configuration fields to govern how
Engine Hours is determined.
•
Engine On Voltage Level (.1 volt) — Use the Power In voltage to monitor engine usage. Set the voltage to higher than the maximum “at rest” voltage of your battery to track how long the device has power.
•
Engine Hours Ignition Enable — Use ignition sense to monitor how long the engine has been on.
A typical battery will be below 13.0 volts, while a typical vehicle maintains the voltage at 14.4 volts. A value of 130 (13.0 volts), therefore, will correctly identify when the engine is on.
94 4112515
Rev. 6 May.13
Services Configuration
Dynamic DNS
Dynamic DNS allows a AirLink Device WAN IP address to be published to a proprietary Sierra Wireless dynamic DNS service called IP Manager.
If you have a fleet of Sierra Wireless AirLink devices or even if you only have one, it can be difficult to keep track of the current IP addresses, especially if the addresses are not static but change every time the devices connect to the cellular network. If you need to connect to a gateway, or the device behind it, it is so much easier when you have a domain name (car54.mydomain.com, where are you?).
Reasons to Contact the Device and/or the Connected
Device:
•
Requesting a location update from a delivery truck
•
Contacting a surveillance camera to download logs or survey a specific area
•
An oil derek that needs to be triggered to begin pumping
•
Sending text to be displayed by a road sign
•
Updating the songs to be played on a juke box
•
Updating advertisements to be displayed in a cab
•
Remote access to a computer, a PLC, an RTU, or other system
•
Monitoring and troubleshooting the status of the device itself without needing to bring it in or go out to it.
A dynamic IP address is suitable for many Internet activities: web browsing, looking up data on another computer system, data only being sent out, or data only being received after an initial request (also called Mobile Originated). If you need to contact the AirLink device directly, however, a device connected to the
AirLink device, or a host system using your AirLink device (also called Mobile
Terminated), a dynamic IP will not give you a reliable address to contact (since it may have changed since the last time it was assigned).
Domain names are often only connected to static IP addresses because of the way most domain name (DNS) servers are set-up. Dynamic DNS servers require notification of IP Address changes so they can update their DNS records and link a dynamic IP address to the correct name.
•
Dynamic IP addresses are granted only when your AirLink device is connected and can change each time the gateway reconnects to the network.
•
Static IP addresses are granted the same address every time your AirLink device is connected and are not in use when your gateway is not connected.
Since many cellular providers, like wire-based ISPs, do not offer static IP addresses or static address accounts cost a premium vs. dynamic accounts,
Sierra Wireless AirLink Solutions developed IP Manager to work with a Dynamic
DNS server to receive notification from Sierra Wireless AirLink devices to translate the dynamic IP address to a fully qualified domain name. Thus, you can contact your AirLink device directly from the Internet using a domain name.
95
ALEOS User Guide
Figure 8-4: ACEmanager: Services > Dynamic DNS
Field
Device Name
Description
The name you want for the device. There are some restrictions listed below for the device name.
Domain
The domain name to be used by the device. This is the domain name of the server configured for *IPMANAGER1
IP Manager Server 1
(IP Address)/IP
Manager Server 2 (IP
Address)
The IP address or domain name of the dynamic DNS server which is running IP Manager.
IP Manager Server
Update1/IP Manager
Server Update 2
IP Manager Server 1
Key/IP Manager
Server 2 Key
How often, in minutes, you want the address sent to IP Manager. If this is set to zero, the device will only send an update if the IP address changes (example, if your AirLink device is reset or is assigned a different IP address).
User defined password key which is used instead of AirLink secret key when using an IP
Manager server other than the one provided by Sierra Wireless.
Tip:
Some PPPoE connections can use a Service Name to differentiate PPPoE devices.
Use the device name to set a Station Name for the PPPoE connection.
Understanding Domain Names
A domain name is a name of a server or device on the Internet which is associated with an IP address. Similar to how the street address of your house is one way to contact you and your phone number is another, both the IP address and the domain name can be used to contact a server or device on the Internet.
While contacting you at your house address or with your phone number employ different methods, using a domain name instead of the IP address actually uses the same method, just a word based name is commonly easier to remember for most people than a string of numbers.
96 4112515
Rev. 6 May.13
Services Configuration
Understanding the parts of a domain name can help to understand how IP
Manager works and what you need to be able to configure the device. A fully qualified domain name (FQDN) generally has several parts.
•
Top Level Domain (TLD): The TLD is the ending suffix for a domain name
(.com, .net, .org, etc.)
•
Country Code Top Level Domain (ccTLD): This suffix is often used after the
TLD for most countries except the US (.ca, .uk, .au, etc.)
•
Domain name: This is the name registered with ICANN (Internet Corporation for Assigned Names and Numbers) or the registry for a the country of the ccTLD (i.e. if a domain is part of the .ca TLD, it would be registered with the
Canadian domain registry). It is necessary to have a name registered before it can be used.
•
Sub-domain or server name: A domain name can have many sub-domain or server names associated with it. Sub-domains need to be registered with the domain, but do not need to be registered with ICANN or any other registry. It is the responsibility of a domain to keep track of its own subs.
car54.mydomain.com
•
.com is the TLD
•
mydomain is the domain (usually noted as mydomain.com since the domain is specific to the TLD)
•
car54 is the subdomain or server name associated with the device, computer, or device registered with mydomain.com
car54.mydomain.com.ca
This would be the same as above, but with the addition of the country code. In this example, the country code (.ca) is for Canada.
Tip:
A URL (Universal Resource Locator) is different from a domain name in that it also indicates information on the protocol used by a web browser to contact that address, such as
http://www.sierrawireless.com
. www.sierrawireless.com is a fully qualified
domain name, but the http://, the protocol identifier, is what makes the whole thing a URL.
Dynamic Names
When an IP address is not expected to change, the DNS server can indicate to all queries that the address can be cached and not looked up for a long period of time. Dynamic DNS servers, conversely, have a short caching period for the domain information to prevent other Internet sites or queries from using the old information. Since the IP address of a device with a dynamic account can change frequently, if the old information was used (such as with a DNS server which indicates the address can be cached for a long period of time) when the IP address changed, the domain would no longer point to the new and correct IP address of the device.
97
ALEOS User Guide
If your AirLink device is configured for Dynamic IP, when it first connects to the
Internet, it sends a IP change notification to IP Manager. IP Manager will acknowledge the change and update the Dynamic DNS server. The new IP address will then be the address for your device’s configured name.
Once your device’s IP address has been updated in IP Manager, it can be contacted via name. If the IP address is needed, you can use the domain name to determine the IP address.
Note: The fully qualified domain name of your AirLink device will be a subdomain of the domain used by the IP Manager server.
SMS
ALEOS has the ability to:
•
Receive commands via SMS message
•
Provide information
•
Perform an action
•
Act as an SMS gateway for hosts connected to its local interfaces.
Warning:
To use SMS with your AirLink device, you will need an account with SMS enabled and your carrier cannot block SMS for data accounts.
Note: The ability to send or receive SMS requires specific security settings.
Command Parser
The ALEOS command parser SMS feature allows some remote management of the AirLink device with SMS messaging. SMS allows users to control:
•
Current status
•
Reset AirLink device
•
Control up to two relays at a device at I/O
98 4112515
Services Configuration
When an SMS command is received from a pre-defined “Trusted” phone number, the AirLink device performs the action requested and sends a response back to that same phone number.
Device Action SMS Response SMS Field
Note: All responses start with “reply from [device name]:”
status None Raven-line, pinpoint-line or MP-line
[Network IP] [Network Status]:
[technology type] RSSS [original]
PinPoint/MP adds
Lat = [Latitude]
Long = [Longitude]
Time = [hh:mm:ss]
Status
reset relay x y
Resets the device 30 seconds after the first response message is sent.
First message: Reset in 30 seconds
Second message: Status message when back up.
Sets the applicable relay to the desired setting.
relay x set to y x can be 1 or 2 y can be 0 or 1
SMS Gateway
The SMS gateway feature allows messages to or from a locally connected host to use SMS for over-the-air transmission.
Rev. 6 May.13
99
ALEOS User Guide
Figure 8-5: ACEmanager: Services > SMS > SMS Receive
100 4112515
Services Configuration
Field
SMS Destination
Description
Allows you to choose where the SMS message is going to be locally received and if it is going to be received by the ALEOS Command Parser or by a host on the other side (serial,
USB serial, or IP). Select your SMS destination; based on your selection, additional fields may become available.
Incoming messages are sent to the specified host. This can be a serial interface or an IP and port. If no host routing is configured, ALEOS treats the message as an ALEOS SMS command.
Messages sent to an IP address and port are put in the AirLink SMS Protocol in a UDP packet. ALEOS then routes this packet to the matching host interface (Ethernet, USBnet,
Wi-Fi)
If you chose:
•
Serial or USB Serial — Select “Yes” or “No” to Incoming Phone number on serial.
•
IP — Enter Destination IP and Destination port.
SMS Send Enable
•
ALEOS CMD Parser — This selection disables the SMS Gateway.
Send SMS from the connected Host. This is the device connected locally to the ALEOS device such as a computer or digital sign. When this field is enabled it will require a ALEOS port.
To send an SMS (outgoing):
•
From the serial port
From the CLI there is a new AT command to send SMS messages:
AT*SMSM2M="<phone> <message>"
This allows an SMS messages to be sent to another modem as a single line item.
•
From a Host device
PC's and other devices connected to the Host IP interfaces (Ethernet, USBNet, Wi-Fi) can also send SMS messages from the modem.
To send an outgoing SMS from the Host device, a program on the PC will need to send a message to a user-defined port in ALEOS. The message has to be in the AirLink SMS
Protocol which contains the phone number and message body (text). ALEOS will parse the message and send an SMS.
See below for examples of the SMS body text.
Rev. 6 May.13
101
ALEOS User Guide
Field
Delimiter
ACK Delimiter
UDP Message Body
Format
Non-Trusted Read
Security
Non-Trusted Write
Security
Description
Start Delimiter — Inbound message at the beginning of the message.
Separator Delimiter — Separates items in the message.
End Delimiter — Inbound message at the end of the message.
E.g., SMS to the phone number is “Left Lane Closed”.
ALEOS to Host — <<<left lane closed>>>
The packet sent to the host will have start and end delimiters which surround the message.
ALEOS will provide an ACK on every SMS message when it is passed to the radio. Wait for the ACK before sending the next SMS message. If ALEOS does not send an ACK, wait 30 seconds and retry.
The only UDP body format available is ASCII-Hex. The other types of UDP body format are set UDP protocols.
This refers to the phone numbers entered in the trusted phone number list.
Indicate with your selection — Allow Access or No Access if you want to allow or block non-trusted and trusted phone numbers to either read or write.
Default is “No Access” and trusted phone number gets read or write.
Trusted Read Security
Note: All four settings of read and write respectively are independent of each other.
Trusted Write
Security
Last Incoming Phone
Number
The last incoming phone number is displayed here and will be erased with a reboot.
SMS Password
Last Incoming
Message
Trusted Phone
Number
See
SMS Password Security on page 106.
The last incoming message is the last incoming SMS from the phone number.
Trusted phone numbers are listed here.
Add a Trusted Phone Number
Follow the instructions below to add a Trusted Phone Number on the SMS page.
1.
Send an SMS command to the device and hit Refresh. No maintenance response will be sent to a number until it is defined as Trusted.
2.
Once you have the Last incoming Phone number that shows up on the SMS screen in ACEmanager, note the exact phone number displayed.
3.
Click Add More to add a Trusted Phone Number.
Note: The Trusted Phone number can be 15 characters and has to be numbers only.
4.
Enter the Last incoming Phone number as the Trusted Phone Number.
5.
Click Apply.
102 4112515
Services Configuration
Note: Do not enter any extra digits and use the Last incoming displayed as a guide to type the phone number. Use “1” only if it is used in the beginning of the Last incoming Phone number.
SMS Wakeup
This feature applies only to the Raven XE 8795.
When the modem is in Always Off mode, this feature enables you to remotely activate a cellular IP connection. The modem later disconnects from the network
after a specified time. (See Idle period before disconnect on page 50.)
Note: Before setting up this feature, set the Always On feature (under WAN/Cellular >
Advanced) to “Disabled”.
1.
On the Services tab, select SMS Wakeup.
Field
SMS Wakeup Trigger
Description
•
Feature Disabled
•
Any class 0 message—Device wakeup triggered on receipt of any class SMS message
•
0 Wake Command—Device wakeup triggered on receipt of class 0 message contained specific “wake command” text
•
Any SMS message—Device wakeup triggered on receipt of any SMS message
•
Wake Command—Device wakeup triggered on receipt of any SMS message containing “wake command” text
Note: Wakeup period is set under WAN/Cellular — Idle time before disconnect.
Rev. 6 May.13
Notes:
•
Every time there is data communication, the timer (Idle time before disconnect) resets.
•
If an SMS Wakeup trigger is received while the device is awake, the time resets.
•
When the device is in SMS Wakeup mode, it can still be woken up by
AT*RADIO_CONNECT=1, and put to sleep by AT*RADIO_CONNECT=0
•
If the device is woken up by the AT Command, a Wakeup SMS still triggers the timer and the device shuts down after the specified time expires.
103
ALEOS User Guide
•
If you select a trigger option that requires a specified message and the message does not match, the message is processed normally. This allows the device to receive information such as status or GPS position while this feature is enabled.
SMS Radio Module Configuration Settings
On some carriers’ networks, SMS will not work using the default radio module configuration. This feature, which is applicable only to the Raven XE (models
H2295E or H2225E) allows the user to change the radio module configuration to enable SMS, and is the same as issuing the AT command: “at*CGSMS=n”.
The default setting for the radio module is 3.
The configuration setting in ACEmanager is on the Services/SMS subtab,
Advanced section. Configuration options are shown in the following figure.
104
Figure 8-6: ACEmanager: Services > SMS > Advanced
SMS Routing
With this feature, you can access multiple devices connected by Ethernet (LAN) using SMS. To use this feature, host devices on the LAN must have static IP addresses.
4112515
Services Configuration
LAN
Ethernet
AirLink device
WAN
SMS
External Host
Devices
Figure 8-7: SMS Routing Network Configuration
SMS Routing—Incoming Messages
Incoming SMS messages have a new field in the message body:
IP <HOST IP> <message>.
SMS Routing—Outgoing Messages
Outgoing messages have the sender’s IP address inserted into the message before the message body. Message syntax is the same as for Incoming
Messages.
SMS Routing for Outgoing messages must be enabled in ACEmanager.
1.
Go to Services > SMS, and click SMS Send.
2.
In the SMS Send Enable drop-down menu, select Include IP.
Rev. 6 May.13
Figure 8-8: ACEmanager > Services > SMS > SMS Send
SMS Routing—LAN Side Communication
For the AirLink device to communicate with a host side (customer) device over the
LAN, both network interfaces must be configured with a static IP address. The
AirLink device and the host side device communicate using a peer-to-peer protocol over UDP.
The AirLink device sends the SMS content to the host devices encapsulated in a
UDP packet. The AirLink UDP packet is addressed to port 17342.
105
ALEOS User Guide
The AirLink device receives SMS content from the host side device encapsulated in a UDP packet. The customer (host side) UDP packet should be addressed to port 17341.
The message format for the UDP packet is:
<start> Phone # <separator> Data Type <separator> Payload Len <separator>
<Message Body> <end>
Note:
•
The same message format is used for incoming and outgoing messages
•
All bytes are ASCII text
•
<start>, <separator>, and <end> are delimiters
Example: You want to send the following message: “Test message” to phone number (510) 624-4200. To use this feature, convert the message to hex:54657374206d657373616765. Then format the message as follows:
<<<15106244200,ASCII,12,54657374206d657373616765>>> where:
•
“<<<” is the opening delimiter
•
“,” is the delimiter between fields
•
“ASCII” indicates that the message is ASCII encoded
•
“12” is the message length
•
“54657374206d657373616765” is the message itself
•
“>>>” is the closing delimiter
SMS Password Security
Only people with security access can send SMS commands to a device. This feature enables you to specify a password to be used with SMS commands, or you can use the ALEOS default password. The default password is generated from the SIM ID (for GSM devices) or the ESN (for CDMA devices).
To set the SMS password:
1.
Go to Services > SMS > SMS Security.
2.
Enter the desired password in the SMS Password field.
3.
Click Apply.
106
Figure 8-9: ACEmanager > Services > SMS > SMS Security
Note: The SMS password is not cleared by a configuration reset.
4112515
Services Configuration
SMS Address Type and Numbering Plan
This feature enables you to specify the SMS Address Type and SMS Address
Numbering Plan for sending SMS messages. The Address Type and Numbering
Plan you select are only used when the AirLink device initiates the SMS messages exchanges. If the SMS message originates from the head end, then
ALEOS uses whatever Address Type and Numbering Plan that are used in the head end message.
1.
On the Services tab, select SMS > Advanced.
Figure 8-10: ACEmanager > Services > SMS > Advanced
Field
SMS Address Type
Address Numbering
Plan
Description
•
Unknown (0 or 000)
•
International Number (1 or 001)
•
National Number (2 or 010)
•
Network Specific Number (3 or 011)
•
Subscriber Number (4 or 100)
•
Abbreviated Number (6 or 110)
•
Default: International Number (1 or 001)
•
Unknown (0 or 0 0 0 0)
•
ISDN/telephone numbering plan (1 or 0001)
•
Data numbering plan (3 or 0011)
•
Telex numbering plan (4 or 0100)
•
National numbering plan (8 or 1000)
•
Private numbering plan (9 or 1001)
•
ERMES numbering plan (10 or 1010)
Default: ISDN/telephone numbering plan (1 or 0001)
AirLink SMS Protocol
There are two new AT commands:
•
at*smsm2m_8 — for 8 bit data mode.
•
at*smsm2m_u — for unicode.
Unlike at*smsm2m, the data following the phone number must be a hex string.
The hex string is converted to bytes before sending.
For example:
Rev. 6 May.13
107
ALEOS User Guide at*smsm2m_8="17604053757 5448495320495320412054455354" sends the message “THIS IS A TEST” but the message is 8 bit data.
Similarly, at*smsm2m_8="17604053757
000102030405060708090a0b0c0d0e0f808182838485868788898A8b8c8d8e8f" will send the bytes:
00 01 02 03 04 05 06 07 08 09 0a 0b 0c 0d 0e 0f
80 81 82 83 84 85 86 87 88 89 8a 8b 8c 8d 8e 8f
Sample message using Ethernet (from the Host to ALEOS):
<start> 8889008989<sep>8BIT<sep>8<sep> 0F0A000989F68898<end>
Format
Message
Telnet/SSH
The device can be connected to using the Telnet protocol. In a Telnet session with the device, you can send AT commands.
A secure mechanism to connect remote clients is a requirement for many users.
Secure Shell (SSH) ensures confidentiality of the information and makes communication less susceptible to snooping and man-in-the-middle attacks. SSH also provides for mutual authentication of the data connection.
Figure 8-11: ACEmanager: Services > Telnet
108 4112515
Services Configuration
Field
AT Telnet/SSH Port
AT Telnet/SSH Port
Timeout (Minutes)
Telnet/SSH Echo
Telnet/SSH Echo
Mode
Description
Sets or queries the port used for the AT Telnet/SSH server. If 0 is specified, the AT Telnet server will be disabled. Default: 2332.
Tip:
As many networks have the ports below 1024 blocked, it is recommended to use a higher numbered port.
After configuring SSH, apply and rest your device.
Telnet port inactivity time out (in minutes). By default, this value is set to close the AT telnet connection if no data is received for 2 minutes.
Enable or disable toggle AT command echo mode.
This is a negotiation protocol. Options:
•
No echo — Neither local nor telnet echo
•
Remote echo — Telnet remote echo
Note: This field is not available for SSH.
Make SSH Keys
Allows you to establish SSH keys.
Note: When you are connected to SSH locally, you cannot have OTA SSH connected.
Email (SMTP)
For some functions, the device needs to be able to send email. Since it does not have an embedded email server, you must specify the email setting for the device to use.
Rev. 6 May.13
Figure 8-12: ACEmanager: Services > Email (SMTP)
109
ALEOS User Guide
Field Description
Server IP Address
Specify the IP address or Fully Qualified Domain Name (FQDN) of the SMTP server to use.
•
d.d.d.d = IP Address
•
name = domain name (maximum: 40 characters).
From email address
Sets the email address from which the SMTP message is being sent.
•
email = email address (maximum: 30 characters).
User Name (optional)
Specifies the username to use when authenticating with the server.
Password (optional)
Sets the password to use when authenticating the email account (*SMTPFROM) with the server (*SMTPADDR).
•
pw = password
Message Subject
Note: Not required to use SMTP settings but may be required by your cellular carrier.
Allows configuration of the default Subject to use if one is not specified in the message by providing a “Subject: xxx” line as the initial message line.
•
subject = message subject
Management (SNMP)
The Simple Network Management Protocol (SNMP) was designed to allow remote management and monitoring of a variety of devices from a central location. The SNMP management system is generally composed of agents (such as your AirLink device, a router, a UPS, a web server, a file server, or other computer equipment) and a Network Management Station (NMS) which monitors all the agents on a specific network. Using the management information base
(MIB), an NMS can include reporting, network topology mapping, tools to allow traffic monitoring and trend analysis, and device monitoring.
Authentication ensures that SNMP messages coming from the agent, such as the
AirLink device, have not been modified and the agent may not be queried by unauthorized users. SNMPv3 uses a User-Based Security Model (USM) to authenticate and, if desired or supported, message encryption. USM uses a user name and password specific to each device.
The AirLink device can be configured to enable the onboard SNMP agent that supports SNMPv2c and SNMPv3.
110 4112515
Services Configuration
Figure 8-13: ACEmanager: Services > Management (SNMP)
Field Description
SNMP Port
This controls which port the SNMP Agent listens on.
•
SNMP is disabled
•
65535
SNMP Security Level
Selects the security level requirements for SNMP communications.
•
No security required. SNMPv2c and SNMPv3 communications are allowed.
•
Authentication equivalent to “authNoPriv” setting in SNMPv3. SNMPv3 is required to do authentication, SNMPv2c transmissions will be silently discarded.
•
Authentication and encryption, equivalent to “authPriv”' setting in SNMPv3. SNMPv3 is required to do authentication and encryption, SNMPv2c and SNMPv3 authNoPriv transmissions will be silently discarded. Messages are both authenticated and encrypted to prevent a hacker from viewing their contents.
SNMP Trap
Destination
SNMP Community
String
Controls destination for SNMP Trap messages. If port is 0 or host is empty, traps are disabled. Traps are sent out according to the SNMP security level (i.e. if the security level is
2, traps will be authenticated and encrypted). Currently, the only trap that can be generated is linkup.
•
host = IP address
•
port = TCP port
The SNMP Community String acts like a password to limit access to the device’s SNMP data.
•
string = string of no more than 20 characters (default = public).
SNMP Contact
SNMP Name
This is a personal identifier of the contact person you want to address queries to. This is a customer defined field.
This is the name of the device you want to refer to. This is a customer defined field.
SNMP Location
Location where your device is stored. This is a customer defined field.
Rev. 6 May.13
111
ALEOS User Guide
Time (SNTP)
The device can be configured to synchronize its internal clock with a time server on the Internet using the Simple Network Time Protocol. You need a time server if you want to use data counters or have the correct time in logs.
Figure 8-14: ACEmanager: Services > Time (SNTP)
Field Description
Enable Time Update
Enables daily SNTP update of the system time.
•
Disabled (Default)
•
Enabled
SNTP Server Address
The SNTP Server IP address, or fully qualified domain name, to use if *SNTP=1. If blank, time.nist.gov is used.
•
d.d.d.d= IP address
•
name= domain name
112 4112515
Services Configuration
Passive FTP
The Passive FTP function may not be required by your FTP server application or by your cellular account.
This function only works with All Hosts Use Private IPs and the first DHCP allocated address from the address pool (such as 192.168.13.100) for both server and client. (if using an ALEOS-connected client). This function will work with
USB/net, but only if there is no Ethernet connection.
Figure 8-15: ACEmanager: Services > Passive FTP
Field
Passive FTP Enable
Passive FTP Port
Description
Enables passive FTP.
•
Enabled (Default)
•
Disabled
Identifies the port number passive FTP will use. Default: 21.
Rev. 6 May.13
113
ALEOS User Guide
Logging
For troubleshooting purposes, tech support may direct you to enable certain logging elements and then, after a span of time, download a log file from the device using Modem Doctor.
Figure 8-16: ACEmanager: Services > Logging
Field
PPP Logging Detail
IP Logging Detail
COM Port Logging
Detail
Description
Sets the logging level for the PPP stack. Options:
•
No PPP Logging
•
Client events (default)
•
Server Events
•
Client+Server events
Sets the logging level for the IP subsystem. Options:
•
No IP Logging
•
invalid packets
•
received packets
•
rcvd+sent packets
Set the logging level for the host or module COM port. Options:
•
No COM Logging
•
Host COM Events
•
Module COM Events
114 4112515
Services Configuration
Field Description
Ethernet Logging
Detail
Sets the detail level for the internal Ethernet logging. Options:
•
No Logging
•
invalid packets
•
received packets: log the header of all received packets. Note that this can quickly exhaust available space for the event log
•
rcvd+sent packets
DHCP Logging Detail
Enable or disable internal DHCP logging. Options:
•
No Logging
•
Log DHCP Events
Rev. 6 May.13
115
ALEOS User Guide
116 4112515
9: GPS Configuration
•
GPS
•
Server 1
•
Server 2 to Server 4
•
Misc
•
Local/Streaming
The GPS tab that displays in ACEmanager is applicable across all
Sierra Wireless AirLink devices.
GPS
This group includes commands specific to GPS features and the
AirLink device.
The AirLink device is equipped with a Global Positioning System receiver (GPS) to ascertain its position and track the movements of a vehicle or other devices which move. The AirLink device relays the information of its location as well as other data for use with tracking applications.
Tracking Applications used with Sierra Wireless PinPoint line devices include:
•
Air-Trak
•
Track Your Truck
•
Track Star
•
DeLorme Street Atlas USA
•
Microsoft Streets and Trips
•
CompassCom
•
Zoll Data
GPS Overview
The Global Positioning System (GPS) is a satellite navigation system used for determining a location and providing a highly accurate time reference almost anywhere on Earth. The US military refers to GPS as Navigation Signal Timing and Ranging Global Positioning System
(NAVSTAR GPS).
GPS consists of a “constellation” of at least 24 satellites in 6 orbital planes. Each satellite circles the Earth twice every day at an altitude of 20,200 kilometers (12,600 miles). Each satellite is equipped with an atomic clock and constantly broadcasts the time, according to its own clock, along with administrative information including the orbital elements of its motion, as determined by ground-based observatories.
A GPS receiver, such as the AirLink device, requires signals from four or more satellites in order to determine its own latitude, longitude, and elevation. Using time synced to the satellite system, the receiver
9
Rev. 6 May.13
117
ALEOS User Guide
118 computes the distance to each satellite from the difference between local time and the time the satellite signals were sent (this distance is called pseudorange).
The locations of the satellites are decoded from their radio signals and a database internal to the receiver. This process yields the location of the receiver.
Getting positioning information from fewer than four satellites, using imprecise time, using satellites too closely positioned together, or using satellites too close to the Earth’s curve will yield inaccurate data.
The GPS data is then transmitted to a central location which uses a tracking application to compile information about location, movement rates, and other pertinent data.
Note: Depending on the location of the satellites in relation to the device’s location and how many signals are being received, the AirLink device may encounter “GPS drift”. The
AirLink device may report it is in a location a few feet from its actual location because it does not employ differential GPS.
AirLink Device Supported Protocols
The AirLink device supports three different GPS reporting protocols: RAP, NMEA, and TAIP.
Remote Access Protocol (RAP)
The Remote Access Protocol (RAP) is a proprietary binary message format developed by Sierra Wireless AirLink Solutions. RAP was originally designed to work specifically with AirLink Tracking System (ATS), but other 3rd party applications have been developed to take advantage of the RAP messaging format.
In the original RAP, a PinPoint line device uses the UDP (User Datagram
Protocol) to communicate with the host server.
In RAP-based AVL, each PinPoint line device sends its command status and responses to the Host server and the Host sends commands to one or more
PinPoint line devices. For reliability, the Host expects each command to be acknowledged within a time-out period. If the acknowledgement packet (ACK) is not received within the time-out period, the Host will retransmit the command.
The RAP messages are in Hex and are referred to by their message ID. Reports can include GPS data alone, as well as GPS data with the date and time, radio frequency data, and state changes of I/O as well as sending reports based on power states.
Examples of tracking applications using RAP:
•
Air-Trak
•
TrackStar
•
CompassCom
•
Zoll Data
•
HTE
•
Spillman
4112515
Rev. 6 May.13
GPS Configuration
National Marine Electronics Association (NMEA)
National Marine Electronics Association (NMEA) is a protocol by which marine instruments and most GPS receivers can communicate with each other. NMEA defines the format of many different GPS message (sentence) types, which are intended for use by navigational equipment.
Example of a tracking application using NMEA:
•
Microsoft Streets and Trips
Tip:
For more information on the AirLink device supported NMEA message formats, please refer to the Appendix.
Trimble ASCII Interface Protocol (TAIP)
Trimble ASCII Interface Protocol (TAIP) is a digital communication interface based on printable ASCII characters over a serial data link. TAIP was designed specifically for vehicle tracking applications but has become common in a number of other applications, such as data terminals and portable computers, because of its ease of use.
Example of a tracking application using TAIP:
•
DeLorme Street Atlas USA
Tip:
For more information on TAIP message formats, refer to the Appendix and to the
Sierra Wireless MP 3G device TAIP Reference.
Datum
The GPS datum is the method of ascertaining the position of the GPS device using a specific reference point location. The datum used can influence the accuracy of the GPS positioning.
In addition to different reporting protocols, the AirLink device supports the most widely used GPS datum:
•
WGS84
•
NAD83
•
NAD27
Before You Configure GPS
To decide what configuration you need for your AirLink device, there are some fundamental considerations you should determine:
•
Protocol: What is the GPS protocol used by your tracking application, and what type of reports will you need?
•
Datum: What is the datum supported by your tracking application?
•
Dynamic IP Address: Will you need DNS support to handle a dynamic IP address account?
119
ALEOS User Guide
•
Multiple GPS servers: Will you need to have GPS data sent to more than one GPS server?
Server 1
Figure 9-1: ACEmanager: GPS Server 1
Table 9-1: GPS: Server 1
Field Description
Report Server IP
Server Port
Report Interval Time
(Seconds)
IP address where GPS reports are sent (ATS Server IP). Also see *PPPORT.
•
d.d.d.d= IP address
Example:
AT*PPIP=192.100.100.100
Port where GPS reports are sent.
•
n=1–65535
GPS Report Time Interval. See also *PPMINTIME, *PPTSV, +CTA.
n= seconds (1–65535)
Note: Your cellular carrier may impose a minimum transmit time.
Caution:
A report time of less than 30 seconds can possibly keep an RF link up continuously. This will eventually cause the AirLink device to overheat and shutdown. An RF resource may continue to be tied up to transfer small amounts of data. Generally, the RF
channel will be released and go dormant in 10–20 seconds if no data is sent or received.
120 4112515
GPS Configuration
Table 9-1: GPS: Server 1
Field Description
Report Interval
Distance (100 Meters)
GPS Report Distance Interval in 100 Meter Units
1 meter is approximately 3.28 feet. 100 meters is approximately 328 feet.
•
n= 0: Disabled
•
n= 1–65535
Stationary Vehicle
Timer (Minutes)
Timer for Stationary Vehicles. Time interval in minutes that the AirLink device will send in reports when it is stationary. Options:
•
Disabled
•
1–255 minutes
For example, if *PPTIME=10, the AirLink device will send in reports at least every 10 seconds while it is moving; however, once it stops moving, it will slow the reports down to this *PPTSV value.
Note: In order for the PPTSV (Stationary Vehicle timer) to take effect, the PPTIME value must be set to a value greater than 0 and less than the PPTSV value. The PPTSV timer checks for vehicle movement at the PPTIME interval, so if PPTIME is disabled, then
PPTSV will also be disabled.
GPS Report Type
(hex)
SNF Enable
Use Device ID in
Location Reports
GPS standard report type. Options:
•
GPS Data
•
GPS+Date
•
GPS+Date+RF
•
GPS+Date+RF+EIO
•
Events Report 6
•
NMEA GGA+VTG
•
NMEA GGA+VTG+RMC
•
TAIP data
•
Compact TAIP data
•
TAIP LN report
•
TAIP TM report
•
XORA data
Enables Store and Forward. Store and Forward will cause GPS reports to be stored up if the AirLink device goes out of network coverage. Once the vehicle is in coverage the GPS reports will be sent en masse to the server.
•
OFF (default)
•
ON
Indicates whether or not the AirLink device should include the 64-bit device ID in its GPS reports. *PPDEVID MUST be 1 if the device uses a Dynamic IP. Options:
•
Disable ID.
•
Enable/display ID.
Rev. 6 May.13
121
ALEOS User Guide
Table 9-1: GPS: Server 1
Field Description
SNF Reliable Mode
SNF Mode
Store and Forward Reliability: GPS reports will be retransmitted if not acknowledged by the server. See Appendix E of this user guide for additional detail. Options:
•
OFF (default)
•
Reliable Mode. Enabled for RAP messages
•
Simple Reliable Mode
•
UDP Sequence Mode
•
TCP Listen Mode
•
TCP
Store and Forward Behavior. When *PPSNF=1, the type of Store and Forward behavior is defined by:
•
n=0: Normal. Data is stored when the AirLink device is out of cellular coverage; when the AirLink device is in coverage, data is sent to server as soon as possible. This is the default form AirLink devices with RAP version 1.3 or lower.
•
n=1: Polled. Data is stored and sent only when polled using the Poll command sent by a server.
•
n=2: Grouped. Data is stored until the desired minimum number of reports (see
*PPSNFM) has been stored. The data is then sent to the server in groups with at least the specified number of reports.
See Appendix E of this user guide for additional detail.
SNF Minimum
Reports
Store and Forward Minimum Reports. Specifies the minimum number of reports that must be stored before they are forwarded to the server. The data is then sent to the server in packets that contain at least this number of reports.
•
n=0–255
Sends a duplicate unreliable report to this server.
Redundant Server 1
IP
Redundant Server 1
Port
Redundant Server 2
IP
Redundant Server 2
Port
SNF Simple Reliable
Max. Retries
Sends a duplicate unreliable report to this port.
Sends a duplicate unreliable report to this server.
Sends a duplicate unreliable report to this port.
Maximum number of SNF retries when in Simple Reliable Mode. Options:
•
Disabled
•
1–255 retries
122 4112515
GPS Configuration
Server 2 to Server 4
There are additional servers where GPS data can be sent simultaneously to server 1.
Figure 9-2: ACEmanager: GPS > Server 2
Field Description
Report Server IP
IP address where GPS reports are sent (ATS Server IP). Also see *PPPORT.
•
d.d.d.d=IP address
Example:
AT*PPIP=192.100.100.100
Server Port
Port where GPS reports are sent.
•
n= 1–65535
Report Interval Time
GPS Report Time Interval. See also *PPMINTIME, *PPTSV, +CTA.
n= seconds (1–65535)
Note: Your cellular carrier may impose a minimum transmit time.
Report Interval
Distance
GPS Report Distance Interval in 100 Meter Units (kilometer). 1 mile is approximately 1609 meters.
•
n=0: Disabled
•
n=1–65535
Rev. 6 May.13
123
ALEOS User Guide
Field
Stationary Vehicle
Timer (Minutes)
GPS Report Type
(hex)
SNF Enable
Use Device ID in
Location Reports
SNF Reliable Mode
Description
Timer for Stationary Vehicles. Time interval in minutes that the AirLink device will send in reports when it is stationary.
•
n=0: Disabled
•
n=1–255 minutes
For example, if *PPTIME=10, the AirLink device will send in reports at least every 10 seconds while it is moving; however, once it stops moving, it will slow the reports down to this *PPTSV value.
Note: In order for the PPTSV (Stationary Vehicle timer) to take effect, the PPTIME value must be set to a value greater than 0 and less than the PPTSV value. The PPTSV timer checks for vehicle movement at the PPTIME interval, so if PPTIME is disabled, then
PPTSV will also be disabled.
GPS standard report type. Options:
•
GPS Data
•
GPS+Date
•
GPS+Date+RF
•
GPS+Date+RF+EIO
•
Events Report 6
•
NMEA GGA+VTG
•
NMEA GGA+VTG+RMC
•
TAIP data
•
Compact TAIP data
•
TAIP LN report
•
TAIP TM report
•
XORA data
Enables Store and Forward. Store and Forward will cause GPS reports to be stored up if the AirLink device goes out of network coverage. Once the vehicle is in coverage the GPS reports will be sent en masse to the server.
•
OFF (default)
•
ON
Indicates whether or not the AirLink device should include the 64-bit device ID in its GPS reports. *PPDEVID MUST be 1 if the device uses a Dynamic IP.
•
n=0: Disable ID
•
n=1: Enable/display ID
Store and Forward Reliability: GPS reports will be retransmitted if not acknowledged by the server. See Appendix E of this user guide for additional detail. Options:
•
OFF (default)
•
Reliable Mode. Enabled for RAP messages
•
Simple Reliable Mode
•
UDP Sequence Mode
•
TCP Listen Mode
•
TCP
124 4112515
GPS Configuration
Field
SNF Mode
SNF Minimum
Reports
SNF Simple Reliable
Max. Retries
Description
Store and Forward Behavior. When *PPSNF=1, the type of Store and Forward behavior is defined by:
•
n=0: Normal. Data is stored when the AirLink device is out of cellular coverage; when the AirLink device is in coverage, data is sent to server as soon as possible. This is the default form AirLink devices with RAP version 1.3 or lower.
•
n=1: Polled. Data is stored and sent only when polled using the Poll command sent by a server.
•
n=2: Grouped. Data is stored until the desired minimum number of reports (see
*PPSNFM) has been stored. The data is then sent to the server in groups with at least the specified number of reports.
See Appendix E of this user guide for additional detail.
Store and Forward Minimum Reports. Specifies the minimum number of reports that must be stored before they are forwarded to the server. The data is then sent to the server in packets that contain at least this number of reports.
•
n=0–255
Default: 0
Maximum number retries when in Simple Reliable Mode.
•
n=0: Disabled
•
n=1–255 retries
Default: 10
Misc
Rev. 6 May.13
Figure 9-3: ACEmanager: GPS > Misc
125
ALEOS User Guide
Table 9-2: GPS: Misc
Field Description
Minimum Report Time
(secs)
Specifies the minimum time (in seconds) between partial packets being sent.
Enable input event reports
Odometer Enable
Odometer Value
(meters)
TAIP ID
Enable sending input changes as events (different report types).
•
n=0: Disable
•
n=1: Enable
Enable odometer reporting.
•
n=0: Disabled (default)
•
n=1: Enabled
The current odometer value of the AirLink device. The value is in meters. Maximum value is approximately 4.3 billion meters (2.67 million miles). 1 mile is approximately 1609 meters.
•
n= meters
Sets/queries the TAIP ID. This ID is returned in TAIP reports if it has been negotiated with the TAIP client. This value is only used in conjunction with TAIP emulation mode
(*PPGPSR=F0).
•
nnnn= TAIP ID (4 characters)
Send SnF Buffer immediately on input
Flushes store and forward buffer when an input event (DTR/RTS) occurs.
•
n=0: Disable
•
n=1: Enable
Report inputs on RAP
Enable input reporting.
•
n=0: Disabled
•
n=1: Enabled
Maximum Speed
Event Report (KPH)
Send Stationary
Vehicle Event in
Seconds
Specifies the speed which will trigger the Maximum Seed Event Report (in kilometers per hour).
Specifies the time (in seconds) in which a Stationary Vehicle Event should be sent.
GPS Datum Mode
TCP GPS Port
Specifies the GPS datum to use for position reports. For accurate results, this value should match the datum used by receiving mapping application.
•
n=0: WGS84
•
n=92: NAD27
•
n=115: NAD83
Specifies the port to listen on for TCP GPS report polling. The request to this port needs to come from the same IP address in *PPIP.
•
n=0: Disabled
•
n=1–65535 (default 9494)
126 4112515
GPS Configuration
Table 9-2: GPS: Misc
Field
Add GPS Time and
Lat/Long
Extra inputs for
COM1000
Description
Options:
•
FALSE (default)
•
TRUE
Enables support for extra inputs from a COM1000.
•
n=0: Disable
•
n=1: Enable
Tip:
If both AT*PPCOM1000=1 and AT*PPREPORTINPUTS=1 are enabled, the AirLink device’s digital inputs will be reported and the COM1000 inputs will be ignored.
Local/Streaming
Figure 9-4: ACEmanager: GPS > Local streaming
Rev. 6 May.13
127
ALEOS User Guide
Field
Local Reporting Time
Interval (secs)
Description
Causes GPS reports to be sent out to either the serial or Ethernet link every n seconds when there is a PPP connection to the serial host or a connection to the Ethernet port is established.
•
Disable
•
1–255 seconds
Tip:
Sends to the PPP peer IP S110 with the Destination Port number S53.
Local Report Type
(hex)
Local Extra Report
Ports
Indicates the type of GPS report to send to the local client (PPP/SLIP peer). See
*PPGPSR. Options:
•
GPS Data: Standard GPS Report
•
GPS+Date: Standard GPS Report + UTC Date
•
GPS+Date+RF: Standard GPS Report + UTC Date + RF data
•
GPS+Date+RF+EIO
•
Events Report 6
•
NMEA GGA+VTG: GGA and VTG NMEA reports
•
NMEA GGA+VTG+RMC: GGA, VTG and RMC NMEA reports (default)
•
TAIP data: TAIP reports
•
TAIP compact data
•
TAIP LN report
•
TAIP TM report
Have local ATS reporting (LATS) send up to 7 extra copies of a GPS report to the subsequent ports.
•
Just the original report is sent (default).
•
Send GPS report copies to that number of ports.
Example: If AT*PPLATSEXTRA=7 and the port in S53 is 1000, then GPS reports will be sent to ports 1000–1007.
Use Device ID in Local
Reports
Use Device ID in Local Reports. Options: False (default) or True.
Persistent GPS
Reports port
Persistent GPS
Coverage
Send NMEA GPS strings out to the serial link. Similar to ATGPS except that the *PGPS value can be saved to NVRAM so that it will continue to operate after resets. Options:
•
NONE
•
DB9 Serial (default): Send NMEA GPS strings out serial link.
•
USB Serial: Send NMEA GPS strings out the USB port.
•
DB9 and USB: Send NMEA GPS strings out both the serial and the USB port.
Allows a PP to be configured to send GPS sentences out of the serial port when the PP loses cellular coverage. This feature is configured by 2 fields. This command controls the status of the sentences.
•
ALWAYS (default): Always sent
•
Out of Coverage: Sent when out of cellular coverage
When set to 1, no reports are saved in SnF.
128 4112515
GPS Configuration
Field
Persistent GPS
Reports Delay
Persistent GPS
Reports Type (hex)
Persistent GPS
Reports Frequency
Description
PGPSD is a 16-bit value that is the number of seconds to wait when “Out of Coverage” occurs before switching to, sending the messages out the serial port and not into SnF.
•
Any messages put into SnF during this switchover delay period will be sent OTA, when coverage is re-acquired.
Note: The two persistent GPS report parameters, *PGPSR and *PGPSF, will control the report type and frequency of the messages sent out the serial port when out of coverage.
Persistent GPS Report type to send via the serial link. Options:
•
NMEA GGA+VTG+RMC: GGA, VTG and RMC NMEA reports (default)
•
TAIP data: TAIP reports
•
TAIP compact data
•
TAIP LN report
•
TAIP TM report
Persistent GPS frequency
•
n= number of seconds per report
Max Value: 65535 up to 18 hours
Rev. 6 May.13
129
ALEOS User Guide
130 4112515
10: Serial Configuration
•
Port Configuration
•
MODBUS Address
List
The Serial tab that displays in ACEmanager is applicable to all Sierra
Wireless AirLink devices with a serial port.
Most AirLink devices are equipped with a serial port which can be used to connect devices or computers with a DB9-RS232 connection.
10
Note: These commands are specific to the RS232 port and generally do not apply to the USB/serial.
Port Configuration
Port Configuration includes four categories of field parameters:
•
Port Configuration
•
Advanced
•
TCP
•
UDP
Each section is documented separately below.
Port Configuration
Rev. 6 May.13
Figure 10-1: ACEmanager: Serial > Port Configuration > Port Configuration
131
ALEOS User Guide
Field Description
Port Configuration
Startup Mode Default
Default power-up mode for the serial port: When the AirLink device is power-cycled, the serial port enters the mode specified by this command after 5 seconds. On startup, typing
ATMD0 into a terminal application connected to the serial port within 5 seconds changes the mode to normal (AT command) mode. See also S53 to set the port for UDP.
•
Normal (AT Command)
•
SLIP
•
PPP
•
UDP
•
TCP
•
PassThru
•
DM mode
•
PinPoint MDT
•
Reliable UDP
•
UDP Multicast
Configure Serial Port
Format: [speed],[data bits][parity][stop bits]
Valid speeds are 300–115200, data bits: 7 or 8, parity: O,E,N,M, stop bits: 1,1.5,2
Flow Control
Serial port flow control setting
•
None — No flow control is being used
•
Hardware — RTS/CTS hardware flow control is being used
•
Transparent SW — Transparent software flow control. Uses escaped XON and XOFF for flow control. XON and XOFF characters in data stream are escaped with the @ character (0x40). @ in data is sent as @@.
DB9 Serial Echo
Toggle AT command Echo mode
•
ON (default)
•
OFF
With more than one connection type (serial, Telnet, and USB/Serial) the Echo command is set differently on each interface.
Data Forwarding
Timeout
Data Forwarding
Character
Device Port
Destination Port
Destination Address
Data forwarding idle timeout. If set to 0, a forwarding timeout of 10ms is used. Used in UDP or TCP PAD mode.
•
tenths of a second
PAD data forwarding character. ASCII code of character that will cause data to be forwarded. Used in UDP or TCP PAD mode.
No forwarding character
Default Device Port to send TCP/UDP communications to
Default Destination Port to send TCP/UDP communications to
IP address to send TCP/UDP communication to
132 4112515
Serial Configuration
Field
Default Dial Code
Host Authentication
Mode
PPP User ID
Description
Default Dial Data Mode. Options:
•
TCP
•
UDP
•
Telnet
Host Authentication Mode: Use PAP or CHAP to request the user login and password during PPP or CHAP negotiation on the host connection. The username and password set in *HOSTUID and *HOSTPW will be used.
•
NONE
•
PAP and CHAP
•
CHAP
Host User ID for PAP or CHAP (up to 64 bytes).
Note: The User ID/Username ‘user’ is not allowed for PPPoE authentication
PPP Password
Host Password for PAP or CHAP.
Note: The Password ‘password’ is not allowed for PPPoE authentication.
Advanced
Rev. 6 May.13
Figure 10-2: ACEmanager: Serial > Port Configuration > Advanced
133
ALEOS User Guide
Field
Advanced
Assert DSR
Description
Assert DCD
Enable CTS
DTR Mode
Quiet Mode
AT Verbose Mode
Call Progress Result
Mode
Convert 12 digit
Number to IP
Disable ATZ Reset
•
Always — assert DSR always
•
In Data Mode — assert DSR when the device is in a data mode (UDP, TCP, etc.)
•
In coverage — assert when the device is in network coverage.
•
Always — assert DCD always
•
In Data Mode — assert DCD when the device is in a data mode (UDP, TCP, etc.)
•
In coverage — assert when the device is in network coverage.
Assert CTS when there is network coverage. Options:
•
Disabled
•
Enabled
•
Use DTR — from serial device
•
Ignore DTR — (Same as S211).
Disable (OFF) or enable (ON) display of device responses.
Configure AT command responses. Options:
•
Verbose
•
Numeric
When enabled adds 19200 to CONNECT messages. Options:
•
OFF
•
ON
Converts12-digit number to an IP address. (E.g., 111222333444 > 111.222.333.444)
Options:
•
Use as Name
•
Use as IP
When ON, +++ ATZ will NOT reset the device. Default: OFF.
134 4112515
TCP
Serial Configuration
Figure 10-3: ACEmanager: Serial > Port Configuration > TCP
Field Description
TCP
TCP Auto Answer
This register determines how the MP device responds to an incoming TCP connection request. The MP device remains in AT command mode until a connection request is received. DTR must be asserted (S211=1 or &D0) and the MP device must be set for a successful TCP connection. The MP device will send a “RING” string to the host. A
“CONNECT” sent to the host indicates acknowledgement of the connection request and the TCP session is established.
•
n=0: OFF (Default)
•
n=1: ON
•
n=2: Telnet Server — use Telnet server mode on TCP connections
•
n=3: Telnet (always Echo) — with a Telnet connection, overrides the client's default echo, allowing the server on the host port to perform the echo. CRLF sequences from the telnet client will also be edited to simply pass CRs to the server on the host port.
•
SSH PAD
TCP Connect Timeout
The wait period (in seconds) before the device considers an attempt a failure, and tries again
TCP Idle Timeout
Interval to terminate a TCP connection when no in or outbound traffic. This value affects only the TCP connection in TCP PAD mode.
•
n= interval
Rev. 6 May.13
135
ALEOS User Guide
Field Description
TCP Idle Timeout Secs
TCP connection time-out (TCPS) units. Specifies a time interval upon which if there is no in or outbound traffic through a TCP connection, the connection will be terminated.
•
n=0: Minutes
•
n=1: Seconds
Telnet Echo Mode
Telnet Client Echo Mode.
•
n=0: No Echo
•
n=1: Local Echo (Default)
•
n=2: Remote Echo
TCP Connect
Response Delay
Enable ENQ on TCP
Connect
Connect Delay: Number of seconds to delay the “CONNECT' response upon establishing a
TCP connection. OR Number of tenths of seconds to delay before outputting ENQ on the serial port after the CONNECT when the ENQ feature is enabled.
•
n=0–255
Outputs an ENQ [0x05] after the TCP CONNECT delayed by the Delay Connect Response time (S221).
•
n=0: Disable (Default).
•
n=1: Enable ENQ on CONNECT.
Keep Connection
Open
Include Device ID on
TCP Connect
This feature keeps a TCP PAD connection active, even when there is no TCP PAD traffic. If the connection goes down for any reason, the device re-opens it. When this feature is enabled, the device initiates a TCP PAD connection shortly after it connects to the network.
The device behaves as it would in TCP mode, except it does not require traffic on the serial port to initiate a connection. TCP connection timeout and Idle timeout are active. Options:
•
Enable
•
Disable (default)
Inserts a Prefix DID, Suffix DID, and carriage return in the device identification packet upon
TCP connection. Allows the identification of which device is sending a particular set of data. Options:
•
Disable (default)
•
Enable
Device ID Prefix
Device ID Suffix
Sets the Prefix DID in the device identification packet upon TCP connection. Maximum length of the prefix is 80 characters.
Sets the Suffix DID in the device identification packet upon TCP connection. Maximum length of the suffix is 80 characters.
Send CR LF after
Device ID
Enables a carriage return to be inserted in the device identification packet after the Suffix
DID. Options:
•
send CR LF (default)
•
no CR LF
•
send CR
136 4112515
Serial Configuration
Field
UDP Auto Answer
Response
Dial UDP Always
UDP Serial Delay
Description
Half-Open Response — In UDP auto answer (half-open) mode.
•
n=0: No response codes when UDP session is initiated
•
n=1: RING CONNECT response codes sent out serial link before the data from the first UDP packet
Note: Quiet Mode must be Off.
The dial command always uses UDP even when using ATDT.
•
n=0: Disable — dial using the means specified (default)
•
n=1: Enable — dial UDP always, even when using ATDT
Note: When this parameter is set you cannot establish a TCP PAD connection.
Waits the specified delay before sending the first UDP packet and the subsequent UDP packets out to the port Ethernet.
•
n=0: No UDP packet delay (Default)
•
n=1–255: Delay in 100ms units, from 100 ms to 25.5 sec
UDP
Rev. 6 May.13
Figure 10-4: ACEmanager: Serial > Port Configuration > UDP
137
ALEOS User Guide
Field Description
UDP
UDP Auto Answer
UDP Idle Timeout
UDP Connect Last
Enables UDP auto answer (half-open) mode. Options:
•
Disable — normal mode
•
Enable — UDP auto answer mode
Set or query UDP auto answer idle time-out. If no data is sent or received before the timeout occurs, the current UDP session will be terminated. While a session is active, packets from other IP addresses will be discarded (unless *UALL is set).
•
n=0: No idle time-out (Default)
•
n=1– 255: Time-out in seconds
If enabled, sets S53 to the last accepted IP address through UDP auto answer. This can be used in conjunction with MD3 so that when there is no UDP session, new ethernet host data will cause a connection to be restored to the last IP accepted through UDP auto answer.
•
n=0: Do not change S53 — does not change S53 setting. (Default)
•
n=1: Set S53 to last IP
Allow Any Incoming IP
Allow IP address.
•
n=0: Allow only S53 — Allow only the IP address specified in S53 to connect when
UDP auto answer is enabled (S82=2).
•
n=1: Allow any IP — Allow any incoming IP address to connect when UDP auto answer is enabled (S82=2).
Always subject to any Friends filters that may be defined.
Allow All UDP
UDP Auto Answer
Response
Accepts UDP packets from any IP address when a UDP session is active. If there is no
UDP session active, an incoming UDP packet will be treated according to the UDP auto answer and AIP settings.
•
n=0: No effect (Default)
•
n=1: Allow all — accept UDP data from all IP addresses when in a UDP session
Half-Open Response — In UDP auto answer (half-open) mode.
•
n=0: No response codes when UDP session is initiated
•
n=1: RING CONNECT response codes sent out serial link before the data from the first UDP packet
Note: Quiet Mode must be Off.
138 4112515
Field
Dial UDP Always
UDP Serial Delay
Serial Configuration
Description
The dial command always uses UDP even when using ATDT.
•
n=0: Disable — dial using the means specified (default)
•
n=1: Enable — dial UDP always, even when using ATDT
Note: When this parameter is set you cannot establish a TCP PAD connection.
Waits the specified delay before sending the first UDP packet and the subsequent UDP packets out to the port Ethernet.
•
n=0: No UDP packet delay (Default)
•
n=1–255: Delay in 100ms units, from 100 ms to 25.5 sec
Raven Line Devices
If you are connected to a Raven line device, the Serial > Port Configuration tab will also display the following sections and their fields:
•
PPP/SLIP
•
PASS THRU
•
TELEMETRY- MODBUS
Rev. 6 May.13
Figure 10-5: ACEmanager: Serial > Port Configuration (Raven line devices only
139
ALEOS User Guide
Table 10-1: Raven-specific Serial Port Configuration Fields
Field Description
PPP/SLIP
Host Authentication
Mode
PPP User ID
Host Authentication Mode: Use PAP or CHAP to request the user login and password during PPP or CHAP negotiation on the host connection. The username and password set in *HOSTUID and *HOSTPW will be used.
•
Disable PAP or CHAP request (Default)
•
PAP and CHAP
•
CHAP
Host User ID for PAP or CHAP.
•
user id (up to 64 bytes)
PPP Password
Note: The User ID/Username ‘user’ is not allowed for PPPoE authentication.
Host Password for PAP or CHAP.
Note: The Password ‘password’ is not allowed for PPPoE authentication.
Modem PPP IP
Host PPP IP
PassThru
Passthrough Init
String
The IP for the AirLink device when coming through RS232.
The IP for the Host RS232 Interface.
Passthrough Init
Refresh (Minutes)
Modem Reset Period
(Hours)
Passthrough Echo
Any AT command string to be passed to the OEM module before entering PASSTHRU mode, e.g. AT&S1V1, etc.
•
string= AT command(s)
Number of minutes of inactivity in PASSTHRU mode to resend the *PTINIT string to the hardware module.
•
n=0: Disabled
•
n=1–255 minutes
In PASSTHRU mode, device will be reset after this period if no data has been sent or received. Value is in hours.
•
n=0: Disabled
•
n=1–255 hours
PassThru Echo: Echo data to the host.
•
n=0: Data will be passed to the host.
•
n=1: PASSTHRU mode will echo all host received data and will not pass the data to the device while the device is not asserting DCD.
Note: If the device is asserting DCD, data will be passed from the host to the device as it normally is when *CSX1=0.
140 4112515
Serial Configuration
Table 10-1: Raven-specific Serial Port Configuration Fields (Continued)
Field Description
Disable AT Escape
AT Escape Sequence detection.
•
n=0: Enable
•
n=1: Disable
Telemetry-MODBUS
Variable Type
Variable Offset
The data-type of the RTU ID in a Modbus-variant protocol. This parameter is used to define the data-type of the RTU ID in Modbus-like protocol data packets. This parameter is used when the Mode Default (MD) is set to 63.
Indicates the offset in the data of where the Modbus ID starts.
Variable Length
Variable Mask (hex)
IP List Dial
Length of the RTU ID in a Modbus-variant protocol, in bytes. This parameter is used to define the length of the RTU ID in Modbus-like protocol data packets. This parameter is used when the when the Mode Default (MD) is set to hex 63
16 bit hex mask to use when extracting the ID. Specify which bits in the ID field to use. This parameter is used when the when the Mode Default (MD) is set to:
•
hex 63 hh= 00–FFFF hex value
•
hh= 00 [default] no mask
•
use all 16 bits hh= 0F
•
use only the low order 4 bits
This allows access the Modbus IP list using the first two digits of the dial string. Example:
ATDT1234567 would go to ID “12” on the Modbus list and use the associated IP as the destination.
Radio Keying Enabled
Enable/disable MDS Radio transceiver keying.
Radio keying is designed to assert CTS when a packet is received with following options:
•
Delay the time as specified
•
Send the data out the serial port
•
Wait the same amount time
•
Drop CTS
This way, the CTS signal can be used to key a transmitter on and give it time to reach its power level before data is sent to it. Delay interval is specified in AT command S221.
MODBUS Address List
This tab will only display in Raven line devices.
To add an Address Entry, click Add More.
Figure 10-6: ACEmanager: MODBUS Address List
Rev. 6 May.13
141
ALEOS User Guide
142 4112515
11: Application Configuration
•
Garmin
•
Data Usage
•
Performance
Monitoring
The Application tab that displays in ACEmanager is applicable to all
AirLink devices.
Applications are special services for the AirLink devices that often require interaction, additional hardware, or specialized settings.
11
Garmin
Garmin provides navigation devices for versatile fleet monitoring solutions. AirLink devices provide an internet access to Garmin devices and a mechanism to enable via cellular. ALEOS also monitors links to the Garmin and communication between the Garmin and the server.
Figure 11-1: ACEmanager: Applications
Rev. 6 May.13
143
ALEOS User Guide
To configure in ACEmanager, Set Host Mode to TCP mode:
1.
Under the Serial – Port Configuration tab, set the Startup Mode Default parameter to TCP.
Figure 11-2: ACEmanager: Serial > Port Configuration
2.
Set the Server Address and Port for TCP. Under the Serial – Port Configu-
ration tab, the Destination Address and Destination Port need to be the address and port of the Server that the TCP application will be communicating with.
144
Figure 11-3: ACEmanager: Serial > Port Configuration
4112515
Application Configuration
3.
Configure the serial port. To communicate with Garmin, set it to 9600, 8n1 with No Flow Control and DTR Mode = 0
Figure 11-4: ACEmanager: Serial > Port Configuration parameters
4.
Configure the Garmin parameters. Under the Applications tab, set Garmin
Device Attached to Enable to enable talking to the Garmin.
Rev. 6 May.13
Figure 11-5: ACEmanager: Applications
After all the parameters have been set, reboot the AirLink device and apply the changes.
The Garmin Status field will display if the Garmin application is “Enabled” or “Not
Enabled”.
Data Usage
The Data Usage feature available in the Application tab and Data Usage group provides users with a way to actively monitor cellular data usage in order to avoid cellular carrier overage charges. The device can be configured to send alerts when data usage levels reach customer defined thresholds. In addition, the customer can also configure the device to suspend all host port traffic when a
“cut-off” threshold is reached. Data usage may be monitored on a daily, weekly, or monthly basis.
For data usage, the device needs an accurate time. If an accurate time is not available from a GPS fix or your service provider, you can set up a time server in
ACEmanager. For details, see Time (SNTP) on page 112.
Note: The Data Usage measurements are not intended to be an identical match to the data usage reported by your cellular carrier. This feature is intended to provide an approximate representation of the data usage in order for users to determine whether their device is going over the carrier usage limits.
145
ALEOS User Guide
146
Figure 11-6: ACEmanager: Application: Data Usage
There are six fields within the Usage group. To activate Usage Monitoring, expand the “Standard” field, and enable Usage Monitoring.
To align the device usage monitoring with your cellular plan, fill in the following fields so that they match your cellular plan:
•
Start Day of the Month
•
Units on Plan Size
•
Plan Size
Once the data plan limit is reached, host traffic will be automatically turned off.
You can still access ACEmanager and PAD mode, and GPS is still operable.
4112515
Application Configuration
Field
Usage Monitoring
Description
Enable or Disable this feature.
Data Usage will consist of bytes transmitted (Tx) plus bytes received (Rx).
Status
Default is Disabled.
If you select Enabled, and if the threshold limit of data usage is not reached, Status will show Enabled- Host traffic not blocked.
If you select Enabled, and if the threshold limit of data usage is reached, Status will show
Enabled- Host traffic blocked.
This date is when the initial billing cycle begins.
Start Day of Month
Next Month Start Date
Month and Week Start dates display. Format: MM/DD/YEAR (E.g., 08/15/2011)
Next Week Start Date
Units on Data Size
Plan Size
Select data size units (MegaBytes or KiloBytes)
The user must specify the monthly data usage limit (KiloBytes/Megabytes) specified by the cellular carrier.
Current Month Usage
This displays the current monthly, weekly, and daily data usage.
Data usage accumulations for monthly, weekly, and daily periods are shown on the Current
Current Week Usage
Usage field. These fields can be used for monitoring data usage. It is more efficient, however, to use the notification features described in later sections of this user guide.
Current Day Usage
Previous Month
Usage
These fields display the previous monthly, weekly, and daily data usage.
Previous Week Usage
Previous Day Usage
Turn off Host Traffic
Turn off Host Traffic at
The user can suspend traffic between the device host ports and the cellular interface based on the amount of data usage accumulation. This feature allows the user to avoid cellular charge overage fees.
The “turn off traffic” feature can be configured on a monthly, weekly, or daily basis. Once the traffic is turned off for a particular period, no further cellular traffic to the host interfaces will be allowed until the time period expires.
The following fields show up for Monthly Usage, Weekly Usage, and Daily Usage categories on the Applications Data Usage page:
•
Turn off Host Traffic — Enable or Disable Host Traffic. Once the threshold limit is crossed, there is no access to the cellular world. However, you can ping the device.
•
Turn Off Host Traffic at — Enter MB or GB unit for monthly, weekly, or daily data usage.
Note: Note that management level interfaces (such as ACEmanager) are still active even if the cellular traffic is suspended.
Time zone adjustment
(in minutes)
Users can adjust their time zone by adding or subtracting from UTC time.
Direction of change
Select Plus or Minus for time zone adjustment.
Rev. 6 May.13
147
ALEOS User Guide
Performance Monitoring
Use this feature to monitor:
•
CPU use
•
Memory use
•
Over-the-Air (OTA) bandwidth
CPU and memory usage
1.
On the Applications tab, select Performance Monitoring.
Figure 11-7: ACEmanager > Event Reporting > Performance Tracking
2.
In the Enable Performance Tracking drop-down menu, select Enabled.
3.
In the CPU and Memory usage period (minutes) field, enter a value for the period you want to track CPU and memory usage. When the default value (0) is entered the feature is disabled.
The remaining fields in this section show you the peak and average CPU and memory usage for the period tracked.
OTA bandwidth monitoring
1.
On the Applications tab, select OTA Bandwidth Monitoring.
148
Figure 11-8: ACEmanager > Event Reporting > Bandwidth Information
4112515
Application Configuration
2.
In the Bandwidth period (minutes) field, enter a value for the period you want to track bandwidth usage. When the default value (0) is entered the feature is disabled.
The data displayed is the total bytes received and sent in each period.
Rev. 6 May.13
149
ALEOS User Guide
150 4112515
12: Report Configuration
•
Server 1
The Report tab that displays in ACEmanager is applicable only across Sierra Wireless AirLink Raven devices.
The Reports Server is the main server where the Events Reports will be sent. It is the same as a RAP or “ATS” server. A primary server can be configured without a failover or redundant server which would be the same as a single server.
Since Raven line devices have no GPS, they will not send RAP messages. Raven devices, however, will be able to send Events
Reporting messages to the server in the same way that a PinPoint or
MP device would send RAP messages to a RAP or “ATS” server.
12
Reports Server
Reports using the Events Protocol are sent to the Reports Server.
Unlike RAP messages of the past which were limited to PinPoint line devices, the enhancements of Event Reporting allow the Raven devices to send reports to a remote server as well. The Reports
Server will be running an application to parse the messages and send responses to the Raven devices.
Note: Whereas the PinPoint and MP lines can use up to 4 different servers for GPS reports, the Raven line is limited to one.
Rev. 6 May.13
151
ALEOS User Guide
Server 1
Figure 12-1: ACEmanager: Report > Server 1
Field Description
Report Server IP
IP address where Event Reports are sent (RAP Server IP). See also *PPPORT.
•
d.d.d.d=IP address
Example: AT*PPIP=192.100.100.100
Server Port
Port where GPS reports are sent.
•
n=1–65535
Ignore RAP Server IP
Update
When enabled, will ignore PinPoint Server IP updates in RAP.
•
Use (default)
•
Ignore
Minimum Report Time
(secs)
Report Time Interval.
n= seconds (1–65535)
Note: Your cellular carrier may impose a minimum transmit time.
Caution:
A report time of less than 30 seconds can possibly keep an RF link up continuously. This could eventually cause the device to overheat and shutdown. An RF resource may continue to be tied up to transfer small amounts of data. Generally, the RF channel will
be released and go dormant in 10–20 seconds if no data is sent or received.
152 4112515
Report Configuration
Field
SNF Enable
Store and Forward will cause GPS reports to be stored up if the device goes out of network coverage. Once the vehicle is in coverage the reports will be sent en masse to the server.
•
n=0: OFF (default)
•
n=1: ON
Device ID in Location
Reports
Enabling this will force the use of the IMEI in the Device ID instead of the phone number.
Use Device ID in
Location Reports
Indicates whether or not the device should include the 64-bit device ID in its reports. The
Device ID MUST be enabled if the device uses a Dynamic IP. This setting MUST be 1 if the device uses a Dynamic IP.
n=0: FALSE n=1: TRUE
SNF Reliable Mode
Description
SNF Mode
SNF Minimum
Reports
SNF Simple Reliable
Max. Retries
Store and Forward Reliability: Reports will be retransmitted if not acknowledged by the server. Options:
•
OFF (default)
•
Reliable Modes
•
Simple Reliable Mode
•
UDP Sequence Mode
•
TCP Listen Mode
•
TCP
Store and Forward Behavior. When Store and forward is enabled, the type of Store and
Forward behavior is defined by:
•
n=0: Normal. Data is stored when the MP is out of cellular coverage; when the MP is in coverage, data is sent to server as soon as possible. This is the default form MP devices with RAP version 1.3 or lower.
•
n=1: Polled. Data is stored until polled using the Poll command sent by a server.
•
n=2: Grouped. Data is stored until the desired minimum number of reports (see
*PPSNFM) has been stored. The data is then sent to the server in groups with at least the specified number of reports.
Store and Forward Minimum Reports. Specifies the minimum number of reports that must be stored before they are forwarded to the server. The data is then sent to the server in packets that contain at least this number of reports.
•
n=0–255
Maximum number retries when in Simple Reliable Mode.
•
n=0: Disabled
•
n=1–255 retries
Send duplicate unreliable report to this server.
Redundant Server 1
IP and Redundant
Server 2 IP
Redundant Server 1
Port and Redundant
Server 2 Port
Send duplicate unreliable report to this port.
Rev. 6 May.13
153
ALEOS User Guide
154
Redundant Server
When a redundant server is enabled, each time a message is sent out to the primary (or failover) server, a second identical message will be sent to the redundant server. This allows the data to be used by two or more different applications.
The redundant servers can be running the same or different application than the primary and failover servers. The messages to the redundant server are independent of the primary/failover server settings or state.
You can set one or both redundant servers. The messages are sent independently to either or both.
Note: Messages will be sent regardless if the server is available or not and do not use any reliable mode format. Receipt of a message is not acknowledged nor is any message resent. Currently, redundant servers cannot use TCP.
Store and Forward
Store and Forward will store reports when the primary Reports Server is unavailable and forwards the reports when the server is available again. Store and Forward can also group multiple reports in to a single message rather than individually.
The Reports Server could be unavailable because the AirLink device leaves coverage, has a very low signal (an RSSI of -105 or lower), or the server is unreachable. Regardless of the situation, the Reports Server will store reports in memory. When the AirLink device is able to reach the server again, it will forward the reports.
The AirLink device can also store messages and send them to the server in a packet, or only when the messages are requested, rather than individually to conserve bandwidth.
Reliability Modes
Reliability Modes provide methods for the AirLink device to receive an acknowledgement from the Reports Server to determine if a sent message was received.
•
Reliable Mode — The AirLink device will transmit a sequence number (1 to
127) as part of a packet of messages that may contain one or more reports.
To reduce overhead, the server only acknowledges receipt of every eighth packet. The AirLink device considers the eight packets a “window” of outstanding packets.
If the AirLink device does not receive acknowledgement for a “window”, the device will PING the server with a message containing the sequence numbers of the first and last packets that have not been acknowledged. The AirLink device will continue until the server acknowledges receipt. When the AirLink device receives the acknowledgement, it will advance its “window” to the next
4112515
Rev. 6 May.13
Report Configuration group. When the AirLink device is first powered on (or reset), it will send a Set
Window message to sync up with the server for the current “window”.
Alternately, if the server receives an out of sequence packet, it will send a message to the device noting the missing sequence and the AirLink device will retransmit.
•
Simple Reliable Mode — The AirLink device will ‘give up’ after a configured number, *PPMAXRETRIES, of attempts and discard messages that cannot be transmitted or received after that number of tries.
The acknowledgement message is the ASCII string “UDPACK” followed by the sequence number.
•
UDP Sequence Reliable — A sequence number is prepended to the report packet in a range of 0c30 to 0x7f inclusive. The sequence number is ASCII readable, allowing test tools to acknowledge the packets.
The acknowledgement message is the ASCII string “SEQACK” followed by the sequence number.
The sequence number is not stored and will be re-initialized to 0x30 when the
AirLink device is reset or power cycled. If a message packet is not acknowledged within the specified number of retries, the packet and its contents will be dropped.
•
TCP Sequence Reliable — The same as UDP Sequence Reliable but using
TCP instead of UDP.
•
TCP Listen Reliable — TCP Listen reliable is same as TCP Sequence
Reliable except the Reports Server must initiate the connection before the
AirLink device will send reports. This allows servers to by-pass some firewalls.
155
ALEOS User Guide
156 4112515
13: I/O Configuration
•
Current State
•
Configuration
The I/O tab that displays in ACEmanager is applicable across all
Sierra Wireless AirLink devices which feature I/O ports.
The I/O group includes configuration commands for the digital and analog inputs and the relay and digital outputs as applicable to a specific device. Some of the values shown as a part of this group are not changeable but reflect the current status. Only those devices with available inputs and outputs will display this group.
Refer to the applicable AirLink device Users Guide, in the Inputs,
Relay Outputs, and Power Status chapter, for more information on the basic features of the I/O settings.
13
Note: The I/O configuration options and displayed status of the I/O depends on the AirLink device.
Current State
The Current State screen will show the current values for the available inputs as well as the current values for pulse counts (digital) and transformed analog. The current state of the Relay or Digital
Output is displayed and can be changed directly.
Rev. 6 May.13
Figure 13-1: ACEmanager: I/0 > Current state
157
ALEOS User Guide
Table 13-1: I/O
Field
Digital IN #
Pulse Count #
Transformed
Analog # (Volts)
Relay Output
Description
Query individual digital inputs. The digital inputs report either a 0 (open) or 1 (closed).
•
n= 1–4 Input number
On devices with a digital input that can be configured for use as a digital output, the pulse count will also reflect output changes.
Query individual analog inputs. The analog inputs report the voltage in volts.
•
n= 1–4 Input number
Transformed Analog # is derived from your coefficient and raw analog.
For example, if your Analog In1 is 2 and Coefficient is 4, with an Offset setting of 2
(definition as below), the Transformed Analog will be 10.
Set or query the relay outputs. Options:
•
OFF (default)
•
Drive Active Low
Configuration
To enhance the usability of the I/O, Configuration allows you to set an initial value for the output relays and a coefficient, offset, and unit label for the analog in.
Figure 13-2: ACEmanager: IO > Configuration
158 4112515
I/O Configuration
Field
Relay # Initial Setting
Description
When the AirLink device reboots, the relay settings you want can be configured here.
The Relay # Initial Setting can be:
•
ON
•
OFF (default)
•
Last Value
Coefficient for Analog # is the multiplier for raw analogs (*ANALOGIN).
Coefficient for
Analog #
Offset for Analog #
Units for Analog #
Point at which Transformed Analog starts its count.
This is the label for the Analog measurement, e.g., liters, mm, etc.
Pulse Count
Following are some Pulse Count details:
•
Pulses are counted on each of the digital inputs
•
Pulse counts 1
–
4 corresponds to digital 1
–
4 respectively
•
Pulses are counted on the falling edge
•
Pulses can not be counted when the device is powered off, or being reset.
However, a single state change while off or reset will be properly counted.
Transformed Analog
The number for the available transformed needs to indicate a variable based on the number of Analog.
The analog input value is transformed into a meaningful value, such as weight or pressure, by multiplying the raw value from the input by the coefficient and adding the offset.
• Coefficient for Analog 1
–
4 — The amount by which the raw analog value should be multiplied.
• Offset for Analog 1
–
4 — The offset to be added to the product of the coefficient and the raw analog value.
• Transformed Analog 1
–
4 — The value of the raw analog value multiplied by the coefficient and then added to the offset.
• Units for Analog 1
–
4 — The name of the unit of measurement to be used in reports.
Rev. 6 May.13
159
ALEOS User Guide
160 4112515
14: Admin
•
Change Password
•
Advanced
The Admin tab that displays in ACEmanager is applicable across all
Sierra Wireless AirLink devices.
The Admin section contains features which are intended for
Administrator configuration only.
Change Password
Sierra Wireless highly recommends that you change the default user and viewer passwords of the AirLink device.
14
Rev. 6 May.13
Figure 14-1: ACEmanager: Admin
To change the default password:
1.
Select user or viewer from the User Name drop-down menu.
2.
Enter the old password.
3.
Enter the new password twice. (Passwords can be comprised of any type of character or case and can be from 1
–
255 characters in length.)
4.
Click Change Password.
You will be prompted to restart the AirLink device. When the device has restarted, reconnect to ACEmanager and enter the new password.
Note: There are two user levels in the User Name drop-down menu. The
‘user’ has full admin rights and can edit the configuration; the ‘viewer’ can only view the configuration and status of the device. Viewers can only change the ‘viewer’ password, while users can change both.
161
ALEOS User Guide
Advanced
Features which should rarely be changed and which will affect the operation of the device are present on this screen.
Figure 14-2: ACEmanager: Admin > Advanced
Field
Date and Time
Description
Sets and queries the internal clock. Either the date and time can be specified, or one of the two can be specified while the unspecified value will remain unchanged. The date and time are always specified in a 24-hour format.
•
mm/dd/yyyy= date in month/day/year format
•
hh:mm:ss= time in a 24-hour format — The time noted by this setting will be changed by the GPS or SNTP as applicable.
Displays only the current date in a month/day/year format (mm/dd/yyyy).
Date only
Periodic Reset Timer
(Hours)
Time of Day Reset – number of days
Resets the device after the specified number of hours. 0 = disabled.
Number of days before the reset occurs.
0 is Disabled.
TOD Time Offset from
GMT
Time zone adjustment (Offset from Greenwich Mean Time)
TOD Hour when reset occurs
Time of day the reset occurs.
The time of reset has an offset of 0–10 minutes
An IP address ending in x.x.x.255 will reset 10 minutes after the time specified.
An IP ending in x.x.x.0 will reset exactly at the time specified.
Having random IP addresses for devices on your system results in random reset times.
Having sequential IP addresses (for example, on a private network) results in the devices resetting in sequential order.
162 4112515
Admin
Field
Block Configuration
Reset button
Enable Over-the-Air
Programming
Description
Blocks the action of the device reset button.
Yes—Pressing the reset button on the device has no effect.
No—Pressing the reset button on the device results in a configuration reset.
Enables/disables over-the-air firmware upgrading of the AirLink device. When Sierra
Wireless releases a new version of ALEOS, you can upgrade your remote devices with
Over-the-Air Programming (OPRG) enabled.
•
Disabled
•
Enabled (default)
Caution:
After installing the new firmware, clear the browser’s cache before using the new firmware.
Enable Event
Reporting
Select one of the options below:
•
Disabled (default)
•
Standard ER
•
Data Usage ER
Click Apply after selecting your option.
Status Update
Address
Device Status Update IP Address where Name/Port is the domain name and port of the machine where the device periodic status updates will be sent. The status parameters are sent in an XML format.
•
name= domain name
•
port= port
Status Update Period
(Seconds)
Enter the Status Update Period in seconds to set how often the Status Update is sent to the
IP in *MSCIUPDADDR
Power IN Voltage
(Volts)
Board Temperature
(°C)
Displays the Power In Voltage in volts.
Displays the temperature of the device board in degrees Celsius.
Radio Module Internal
Temperature
Displays the temperature of the internal radio module in degrees Celsius.
Number of System
Resets
Counter of the number of system resets over the life of the device or since the configuration was reset.
Rev. 6 May.13
163
ALEOS User Guide
164 4112515
6 May.13
15: Standard Events Reporting
•
Inputs — Digital and
Analog
•
Data Usage
•
AVL
•
Network
•
Other
•
Configuring Reports
•
Reports
•
Groups
•
Configuring Data
The Events Reporting tab that displays in ACEmanager is applicable across all Sierra Wireless AirLink devices.
Events Reporting allows the users to generate reports or perform actions in response to the events that are configured in the ALEOS software.
An Event is a measurement of a physical property AND a state change or a threshold crossing. For example, radio module signal strength (RSSI) is a physical property. A threshold crossing could be set to -105 dBm. The user can configure an Event which consists of the RSSI with the -105 dBm threshold. There are many Events that can be configured; these are described in detail below.
Event Reporting Protocol is an intuitive embedded protocol, which automatically formats the messages based on an event trigger. The messages generated are then reported to the remote server.
An event occurs, when any of the following takes place:
•
Customer device opens or closes a switch
•
Customer device raises or lowers analog voltage
•
Device RSSI goes below or above a threshold
•
Device power goes below or above a threshold
A report is generated when the device sends a message caused by an event.
Both events and reports are configured by the customer and can be considered as the “next Generation” of RAP.
The Events groups define the triggers for reports.
15
165
ALEOS User Guide
166
Event Trigger
There are 16 data types that can trigger events. The configuration for the trigger will vary based on the data type. An “event” is when the data in the configured state. Some examples are: a switch is closed, the speed is greater than 70 MPH, the engine has been used for 1000 hours and needs maintenance.
Data Type
Digital Input 1–4
Pulse Accumulator 1–4
Analog Input 1–4
Scaled Analog 1–4
GPS Fix
Vehicle Speed
Heading Change
Engine Hours
RSSI
Network State
Network Service
Network Error Rate
Time – Period Report
Power In
Board Temperature
CDMA HW Temp
Configuration Type
Switch
Delta
Threshold
Threshold
GPS Fix
Threshold
Delta – zero based
Delta
Threshold
Network State
Network Service
Delta – zero based
Delta – zero based
Threshold
Threshold
Threshold
Event Configuration Types
•
Switch — open, closed, on change
•
Delta — change from last report. Value stored
•
Delta – zero based — change from last report. Value not stored
•
Threshold — Above, Below, on crossing
•
GPS Fix — fix obtained, fix lost, on change
•
Network State — when network service has been obtained
•
Network Service — Trigger when service found, lost, or on change
Each event can be triggered to send one more report. In each group, is a related type of data.
4112515
6 May.13
Standard Events Reporting
Enable Events Reporting
Events Reporting is disabled by default but can be enabled by choosing Standard
ER in the Admin tab’s Advanced tab feature. Click Apply for the change to take effect. A new tab namedEvents Reporting will display next to Admin.
Figure 15-1: ACEmanager: Admin > Advanced
Inputs — Digital and Analog
Each Digital Input (1
–
4 shown in the figure) will have a Digital Input check on or off box and a category of Reports that you can select or unselect.
167
ALEOS User Guide
Figure 15-2: ACEmanager: Events Reporting > Events Digital Inputs
168 4112515
Standard Events Reporting
Figure 15-3: ACEmanager: Events Reporting > Analog Input
Data Usage
Notification thresholds are data usage limits the user can configure. Once the data usage exceeds the threshold, a notification message is sent to the user. The notification message type can be email, SNMP, SMS, or Events Protocol.
Notification Threshold in Standard ER Mode
The Standard Notification message feature allows two different Monthly Usage notification thresholds, a single Daily threshold, and any data usage threshold change. There are two Monthly Usage thresholds to support the use case in which a user wants notification on one threshold and suspension of data services on another threshold.
To configure Data Usage notifications, Events Reporting must be enabled. To enable Events Reporting, go to the Admin tab and Advanced sub-tab and set
Enable Event Reporting to “Standard ER”.
6 May.13
Figure 15-4: ACEmanager: Admin > Advanced
169
ALEOS User Guide
Next, go to the Events Reporting tab and Data Usage sub-tab. This tab shows the three threshold settings and the Data Usage Status Change setting.
Figure 15-5: ACEmanager: Events Reporting > Data Usage
Monthly Threshold 1 is displayed in
. In this example, the notification message is sent when the monthly data usage is above 2000 MB (2 GB).
Once the threshold is configured, the user can specify the reports. There are three steps to configuring reports.
1.
Select the report(s) in the Event section, using the check box (see below).
2.
Configure the corresponding report(s) in the Reports section. This requires the use to specify the destination for the report, and then specify which Data
Groups are to be included in the report.
Figure 15-6: ACEmanager: Events Reporting > Date Usage Monthly threshold
3.
For each Data Group, specify which data to include in the Group. Select
“Include in report” from the drop down menu for the data usage option desired.
170 4112515
Standard Events Reporting
Figure 15-7: ACEmanager: Events Reporting > Configure Reports > Groups
AVL
6 May.13
Figure 15-8: ACEmanager: Events Reporting > AVL
171
ALEOS User Guide
Network
Event triggers for the status of the cellular network connection.
Figure 15-9: ACEmanager: Events Reporting > Network
172 4112515
Standard Events Reporting
Other
Event triggers for periodic reports, Power, and the temperature of the AirLink device.
Figure 15-10: ACEmanager: Events Reporting > Other
Table 15-1: Summary of Events
Event Name Event Type
Inputs - Digital and Analog
Digital Input x
State Change
Analog Input 1
Scaled Analog 1
Data Usage
Data Usage Status
Monthly Threshold x
Daily threshold 1
State Change
State Change
Threshold Crossing
Threshold Crossing
Threshold Crossing
Threshold or State Change Options
Switch Closed
Switch Opened
On Any Change
OFF or ON
OFF or ON
Percentage of monthly threshold
Percentage of daily threshold
6 May.13
173
ALEOS User Guide
Table 15-1: Summary of Events
AVL
GPS Fix
State Change
Vehicle Speed
Heading Change
Engine Hours
Network
RSSI
Network State
Network Service
Threshold Crossing
Threshold Crossing
Threshold Crossing
Threshold Crossing
State Change
State Change
Fix Lost
Fix Obtained
Any Fix Change
Vehicle Speed (KM/h)
Heading Change (degrees)
Engine Hours
Signal Power (-dBm)
When Device is Ready
•
Voice
•
Roaming
•
2G
•
3G
•
EVDO Rev A or HSPA
•
Any Service Change
Other Report Types
Periodic Reports
Power In
Board Temperature
CDMA Radio Module
Threshold Crossing (Time)
Threshold Crossing
Threshold Crossing
Threshold Crossing
Period to compare (seconds)
Power threshold (volts)
Degrees Celsius
Degrees Celsius
Configuring Reports
There are six ways to send a report. The configuration will vary.
•
· Destination email address
· Subject, Message
· Data groups
•
SMS text message
· Destination Phone number
· Message
· Data Groups.
•
SNMP Trap notification
· Destination IP is configured in the SNTP menu.
•
Relay
· Select the relay to link to, and Invert if necessary.
•
RAP message
174 4112515
Standard Events Reporting
· Destination report server and report type is configured in the PinPoint
Menu.
•
Events Protocol message to a server
· Destination report server is configured in the PinPoint Menu
· Report format – TLV, Binary, ASCII, XML. See Events Protocol (appendix
A) for details.
The Reports group allows you to configure whose reports are sent and what date they contain.
The Setup page for Reports configures which types of reports will be available.
6 May.13
175
ALEOS User Guide
Reports
Each report type has its own configuration page. If a report type is not set to be allowed, its configuration page will be hidden. Some reports will be hidden by default.
176
Figure 15-11: ACEmanager: Events Reporting > Configure Reports
4112515
Standard Events Reporting
6 May.13
Figure 15-12: ACEmanager: Events Reporting > Configure Reports > Reports 7, 8, and 9
When you allow an additional report type on the Setup page, the sub-group configuration page will be made available. For example, to allow Report 8 and display its configuration page, on the Setup page you would select Allow this
Report. To conceal the report configuration and not make it available for events, select Remove this Report.
•
Email-1 — The AirLink device will send out an email to a specific destination using the SMTP settings.
The Test Email feature allows you to send an email test message to verify the email report configuration in Events Reporting. You can specify a recipient, a report subject, and a report message. Only one email address may be used as the Report To destination. Send by clicking the Test Email button; all data in the Report Message will be transmitted.
The email client (SMTP) must first be configured in the Services > Email page.
177
ALEOS User Guide
178
•
SMS-2 — An SMS will be sent to a specific cellular destination such as your cell phone.
A new feature, Test SMS, allows you to send an SMS test message to verify the SMS report configuration in Events Reporting. You can specify a phone number and test text (154 characters) to send. Send by clicking the Test SMS button, and all data in the Report Message is transmitted.
•
Events Protocol-6 — The AirLink device will send out a report to the Reports
Server to allow an interface with a wider variety of applications.
•
Report-7, Report-8, Report-9 — An additional destination for Email, SMS, or
Events Protocol.
For the message report types Email, SMS, and Events Protocol, you will need to select which data you would like included in the report.
•
Report To — The email address where the report should be sent.
•
Report Subject — The subject that should be displayed.
•
Report Message — The message you want included with each report.
Note: You cannot send an Email with your AirLink device unless the Email server you have configured allows your AirLink device as a relay host. Talk to your network administrator to ensure you can send email through the email server using your AirLink device.
SMS
•
Report To — The cellular phone number where the report should be sent.
•
Report Message — The message you want included with each report.
Note: You can only send SMS from your AirLink device if your cellular account allows
SMS. You may need to have SMS added to the account. SMS from data accounts is blocked on some cellular networks.
•
1 - Relay 1 — Open
•
2 - Relay 1, Inverted — Closed
•
3 - Relay 2 — Open
•
4 - Relay 2, Inverted — Closed
Events Protocol
The Events Reporting protocol is a collection of messaging formats. The messages are sent to the Reports Server.
The Events Protocol includes four message types.
•
1 - Type, Length, Value — The TLV consists of the MSCI ID as the type, the length of the data, and the actual data.
•
2 - Binary — A binary condensed form of the TLV message will be sent.
4112515
6 May.13
Standard Events Reporting
•
3 - ASCII — An ASCII condensed and comma deliminated form of the TLV message will be sent.
•
4 - XML — An XML form of the data will be sent.
Tip:
Because of its flexibility and robustness, the TLV message type is recommended for most reports using the Events Protocol. The Binary and ASCII forms do not contain “A type field” which can result in misinterpretation of data. Since the TLV and XML forms always includes the type as well as the data, an unintentional type can be identified much easier.
Additional Reports
The last three report types allow an additional report of the defined types sent to a separate destination.
Select the Protocol, or report type desired and fill in the appropriate fields. The configuration needed for the report will depend on the protocol chosen. Use the previous report types as the guide for what fields are required.
•
For an additional Email report, you would fill in the Report To, Report Subject, and Report Message the same way as the Email report. The Report To can be the same email address as the Email report or a different one. The Report
Subject and Report Message can also be different.
•
For an additional SMS report, you would specify the phone number in the
Report To field and fill in the Report Message.
•
For an additional Relay report, you would specify the relay value by number in the Report To field.
· 1 — Relay 1
· 2 — Relay 1, Inverted
· 3 — Relay 2
· 4 — Relay 2, Inverted
•
For an additional Events Protocol report, you would use the Report To field to indicate the protocol, by number, to be used.
· 1 — Type, Length, Value
· 2 — Binary
· 3 — ASCII
· 4 — XML
Groups
The data in the device has been put in groups of similar data. For each report, you can specify which groups to include.
The groups are:
•
Standard
•
AVL
•
Digital I/O
•
Analog Input
•
Network Data
179
ALEOS User Guide
•
Network Traffic (Tx/Rx)
•
Modem Name
•
Misc Data
For each group you can enable individual fields. The complete list of fields is given in Appendix.
Note: Each data item included in a report will add to the size of the report. Disabling data not required will allow the report to be more compact. By default, all data is included.
180
Figure 15-13: ACEmanager: Groups > Standard to Analog Input
4112515
Standard Events Reporting
Figure 15-14: ACEmanager: Groups > Network to device Name
6 May.13
Figure 15-15: ACEmanager: Groups > Misc Data
Each report type has its own configuration page. If a data group type is not set to be allowed on the Setup page, its configuration page will be hidden.
181
ALEOS User Guide
182
For each data element, select to Include in Report or Don’t Include. The default is for all data to be included.
Tip:
Excluding data elements can reduce the size of the reports.
Configuring Data
Standard Group
These elements in the Standard group are general identifiers for the AirLink device and the event occurrence. The elements of the Standard group will appear on all reports.
•
Enable for Device ID — The device ID of the AirLink device. This should be enabled for a cellular account with a dynamic IP address.
•
Enable for Network IP — The IP address given by the cellular network.
•
Enable for Time — The time the report was generated. This will be the same time that is displayed with *DATE. The date will be sent as UTC: month, day, year, hour, minute, seconds.
Network Data Group
The Network Data in this group relates to the cellular network and the connection state of the AirLink device.
•
Enable for Network State — The network state for the AirLink device.
•
Enable for Network Channel — The network channel to which AirLink device is connected.
•
Enable for RSSI — The network state for the AirLink device.
• Enable for Network Service
•
Enable for Network IP — The IP address given by the cellular network.
Network Traffic (Tx/Rx) Group
The Network Traffic in this group relates to the cellular network and the network between the AirLink device and any directly connected device(s).
•
Enable for Network Error Rate — The error rate reported by the cellular network.
•
Enable for Bytes Sent — The number of bytes sent on the cellular network since last reset.
•
Enable for Bytes Received — The number of bytes received from the cellular network since last reset.
•
Enable for Host Bytes Sent — The number of bytes sent from the network between the AirLink device and the connected device(s) since last reset.
•
Enable for Host Bytes Received — The number of bytes received from the network between the AirLink device and the connected device(s) since last reset.
4112515
6 May.13
Standard Events Reporting
•
Enable for IP Packets Sent — The number of IP packets sent on the cellular network since last reset.
•
Enable for IP Packets Received — The number of IP packets received from the cellular network since last reset.
•
Enable for Host IP Packets Sent — The number of IP packets sent from the network between the AirLink device and the connected device(s) since last reset.
•
Enable for Host IP Packets Received — The number of IP packets received from the network between the AirLink device and the connected device(s) since last reset.
Device Name Group
These elements in the device Name group are general identifiers for the AirLink device and its cellular account.
•
Enable for Device ID — The device ID of the AirLink device. This should be enabled for a cellular account with a dynamic IP address.
•
Enable for Phone Number — The phone number of the AirLink device.
•
Enable for Modem Name — The device name of the AirLink device.
•
Enable for MAC Address — The MAC Address of the Ethernet port of the
AirLink device.
Miscellaneous (Misc) Data Group
Miscellaneous Data includes temperature rates and other information that does not fit in the other categories.
•
Enable for Power In — The voltage level of the power coming in to the
AirLink device at the time of the report.
•
Enable for Board Temperature — The temperature of the internal hardware of the AirLink device at the time of the report.
•
Enable for Host Comm State — The signal level between the AirLink device and the connected device(s).
183
ALEOS User Guide
184 4112515
16: ER Data Usage
•
Enable ER Data
Usage
•
Data Usage
•
Configuring Reports
•
Groups
ER Data Usage supports Data Usage Events. The Reports and
Groups section is the same as on the Standard Events Reporting screen.
Enable ER Data Usage
ER Data Usage is disabled by default. Select Data Usage ER in the
Advanced tab under the Admin page to configure ER Data Usage.
Click Apply for the change to take effect.
16
Rev. 6 May.13
Figure 16-1: ACEmanager: Admin > Advanced
A new tab named ER Data Usage will display next to Admin. (See
Figure 16-2.)
185
ALEOS User Guide
Data Usage
This section supports the following Data Usage Events:
•
Data Usage Status (off, notify on any change)
•
Monthly Usage (four thresholds)
•
Weekly Usage (two thresholds)
•
Daily Usage (four thresholds)
•
Notification on change of month
•
Notification on change of week
•
Notification on change of day
186
Figure 16-2: ACEmanager: ER Data Usage > Events> Data Usage
4112515
ER Data Usage
Data Notification
Data Notification thresholds are data usage limits the user can configure. Once the data usage exceeds the threshold, a notification message is sent to the user.
The notification message type can be email, SNMP, SMS, or Events Protocol.
Notification Threshold in Data Usage ER Mode
The extended version notification message feature provides more notification thresholds than the Standard version. It supports these notification options:
•
Any threshold status change
•
Four monthly thresholds
•
Two weekly thresholds
•
Four daily thresholds
•
Notification on change of month, or week, or day
To access the Data Usage Events Reporting feature, the Data Usage version of
Events Reporting must be enabled. To enable this version, go to the Admin tab and Advanced subtab, and set Enable Event Reporting to “Data Usage ER”.
Figure 16-3: ACEmanager: Admin > Advanced
To set a notification threshold, go to the Events Reporting tab and click the Data
Usage subtab. The available thresholds will display.
Rev. 6 May.13
Figure 16-4: ACEmanager: Events Reporting > Events > Data Usage
187
ALEOS User Guide
Note: The report specification for each notification is the same as Standard Notifications.
Other
The following categories of events display on the Other page.
•
Digital Input 1
•
Digital Input 2
•
Analog INput 1
•
RSSI
•
Periodic Reports
•
GPS Fix
•
Vehicle Speed
•
Heading Change
Enable or disable an event by selecting “ON” or “OFF” (default). Select the event and corresponding report, and apply to generate reports.
188 4112515
ER Data Usage
Rev. 6 May.13
Figure 16-5: ACEmanager: ER Data Usage > Other
189
ALEOS User Guide
Configuring Reports
This section is similar to the Configuring Reports section from the Events
Reporting tab. For reference purposes, see Configuring Reports
.
190
Figure 16-6: ACEmanager: ER Data Usage > Configure Reports
Groups
The data in the device has been put in groups of similar data. For each report, you can specify which groups to included.
The groups are:
•
Digital I/O
•
Analog Input
•
Network Data
•
Data Usage
For each group you can enable individual fields by selecting “Include in report” from the menu. To know more about the parameters in each sub-category, please
refer to Configuring Data on page 182.
4112515
ER Data Usage
Note: Each data item included in a report will add to the size of the report. Disabling data not required will allow the report to be more compact. By default, all data is included.
Rev. 6 May.13
Figure 16-7: ACEmanager: ER Data Usage > Groups
Note: If a device is upgraded to 4.0.9 (or later), internal configuration items will be corrected for the new data group. If a device is downgraded, the Rx/TX data group will display the wrong configuration.
191
ALEOS User Guide
192 4112515
A: Windows Dial-up Networking (DUN)
•
Installing a Device
Driver
•
Creating a Dial-Up
Networking (PPP)
Connection
•
Connecting to the
Internet Using
DUN
Dial-up Networking (DUN) allows a computer or other device to use the serial, Ethernet, or USB virtual serial port on your AirLink device to connect to the Internet or private network using PPP just like an analog modem using a standard phone line.
A
Caution:
To install any driver on your computer, you may need to be logged in as Administrator or have Administrator privileges for your login.
Microsoft Windows XP is used in the examples below. The modem driver installation and DUN setup and configuration is similar in
Microsoft Windows products. Examples are not provided here for installing the driver or configuring DUN for any other operating system.
Note: If your device is new, or has recently been reset to factory default settings, ensure that the device has been on air at least once before being used with a DUN connection.
Rev. 6 May.13
193
ALEOS User Guide
Installing a Device Driver
Standard installations of Microsoft Windows XP and 2000 include a generic device driver which will work with your AirLink device.
1.
Connect the AirLink device.
a.
Connect the device to the computer with a DB-9 cable or the USB port in serial mode.
b. Plug in the AC adapter, connect the antenna(s), and power on the device.
2.
Install the driver.
a.
Select Start > Control Panel > Phone and Modem Options (in Classic
View).
194
Figure A-1: Phone and Modem Options
b. Select the Modems tab.
Figure A-2: Phone and Modem Options: devices
4112515
c.
Select Add.
Figure A-3: Add Hardware Wizard
d. Check Don’t detect my device; I will select it from a list.
e.
Select Next.
Rev. 6 May.13
Figure A-4: Add Hardware Wizard: Install New Modem
f.
Select (Standard Modem Types) from the Manufacturers column.
g. Select Standard 33600 bps Modem from the Models column.
Tip:
If you have the speed for your device configured as something other than the default, use the Standard device that matches the speed you configured.
h. Select Next.
195
ALEOS User Guide
Figure A-5: Add Hardware Wizard: Select Ports
i.
Check Selected Ports.
j.
Select the COM port the device is connected to (commonly COM1).
k.
Select Next.
196
Figure A-6: Add Hardware Wizard: Finish
l.
Once the device driver is installed, select Finish.
When you return to the Phone and Modem Options window, you should see the newly installed device “attached to” the correct COM port.
4112515
Figure A-7: Phone and Modem Options: devices
m. Highlight the modem, and select Properties. The following window appears:
Rev. 6 May.13
Figure A-8: Modem Properties
n. Select the Modem tab.
197
ALEOS User Guide
198
Figure A-9: Modem Properties: Modem
o. Maximum Port Speed should be set to 115200 (default).
p. Select OK to exit.
q. Select OK again to exit out of the Phone and Modem Options.
Creating a Dial-Up Networking (PPP)
Connection
Once you have the driver for the modem installed on your computer, you can set up and configure Dial Up Networking (DUN) to use the modem as your connection to the Internet using PPP.
Note: No other device or program can be using the same COM port (serial port) configured for the modem driver.
Caution:
If you have an existing LAN connection, installing DUN for the modem may interfere with the LAN connection. We recommend disconnecting your LAN connection before using a PPP connection with your AirLink device.
Once the DUN connection is initiated, it will take over (by default) as the “default route” for network communication and specifically for Internet access. If you want the two connections to co-exist, you will need to de-select “Use default gateway on remote network” (described later) and use the route command in Windows to setup routing through the modem properly. This guide does not provide information on the route command. Consult with your network administrator to properly configure routing.
4112515
1.
Create a new network connection.
a.
Select Start > Connect To > Show All Connections to open the Network
Connections window.
Figure A-10: Windows: Start menu
b. Select Create a New Connection under Network Tasks in the menu area on the left.
Rev. 6 May.13
Figure A-11: Create New Connection
199
ALEOS User Guide
c.
Select Next to start installing and configuring the DUN connection.
200
Figure A-12: New Connection Wizard
d. Select Connect to the Internet.
e.
Select Next.
Figure A-13: New Connection: Type
f.
Select Set up my connection manually.
g. Select Next.
Figure A-14: New Connection: How do you want to connect?
h. Select Connect using a dial-up modem.
i.
Select Next.
4112515
Figure A-15: New Connection: Connect using...
j.
Optional: If you have multiple modems installed on your computer, you may be prompted to select the modem to be used. If you only have one modem installed, this option will not appear.
k.
Check Standard 33600 bps Modem.
l.
Select Next.
Figure A-16: New Connection: Select Modem
m. Type in a name for the connection (e.g., Sierra Wireless AirLink Modem).
n. Select Next.
Rev. 6 May.13
Figure A-17: New Connection: Connection Name
Tip:
The name provided here will not effect the connection in any way; it is only a label for the screen icon. It can be the name of your wireless service provider (Provider), your modem (AirLink device), or any other designation for the connection.
o. Type in 10001 as the phone number for the modem to dial.
p. Select Next.
201
ALEOS User Guide
Figure A-18: New Connection: Phone Number
q. Optional: If you have multiple users configured for your computer, you may be prompted for Connection Availability. If you select My use only, the account currently logged on will be the only one able to use this DUN connection.
r.
Select Next.
Figure A-19: New Connection: Permissions
Generally the modem takes care of the Account Information, User name and
Password, for the connection, so you can leave the fields blank (unless otherwise instructed by Support).
s.
If you want to allow others to use the same login for the modem, select
Use this account name and password....
t.
Select Next.
202
Figure A-20: New Connection: Connection Information
Caution:
If you have a LAN connection to the Internet and select Make this the default
Internet Connection for the DUN configuration, you will not be able to use the LAN to connect to the Internet and may also affect the network connection on your computer to the rest of the LAN. Select this option ONLY if the AirLink device will be your sole network connection.
4112515
u. If you want to add a shortcut for this DUN connection to your desktop, check Add a shortcut.
v.
Select Finish to exit the Network Connection Wizard.
Figure A-21: New Connection: Finish
2.
Configure the DUN connection
After you complete the New Connection Wizard, there are a few more things you will want to configure in the connection.
a.
Select Properties.
Rev. 6 May.13
Figure A-22: DUN Connection
203
ALEOS User Guide
b. Uncheck Use dialing rules.
c.
Check Show icon...when connected.
d. Select Configure which is located below the Connect using line.
Figure A-23: DUN Properties
e.
Select 115200 as the Maximum speed.
f.
Check Enable hardware flow control. Do not check any other option.
g. Select OK.
204
Figure A-24: Modem Configuration
4112515
h. Back at the main properties screen, select the Networking tab.
Figure A-25: Networking
i.
Select Settings.
j.
Remove the checks from all three PPP settings.
k.
Select OK.
Rev. 6 May.13
Figure A-26: PPP Settings
l.
Select (highlight) Internet Protocol (TCP/IP) and then select Properties.
Tip:
For most configurations, you will be obtaining the IP address and the DNS server address automatically.
m. Select Advanced.
205
ALEOS User Guide
Figure A-27: TCP/IP Properties
n. Uncheck Use IP header compression.
o. Check Use default gateway on remote network.
p. Select OK.
206
Figure A-28: Advanced TCP/IP
Tip:
You may want to check the Options tab and change the settings for applications you might be using. The default options are generally applicable for most uses.
Caution:
Unless specifically directed to do so by Support or your network administrator, you do not need to make any changes to the options on the Security tab.
q. Select OK until you return to the Connect window.
4112515
Connecting to the Internet Using DUN
There are two methods you can use to connect the AirLink device to the Internet using DUN: ACEview, and the Windows DUN direct connection.
ACEview
ACEview is a utility which can maintain your DUN connection and monitor the connection of your AirLink device to the provider. If you have not already installed
ACEview, obtain the most recent version from the Sierra Wireless AirLink website.
This guide assumes you have a default installation of ACEview.
1.
Start ACEview.
Start > All Programs > Sierra Wireless > ACEview
Right-click the ACEview window to open the menu.
Figure A-29: ACEview: Menu
a.
Select Connection Settings.
Rev. 6 May.13
Figure A-30: ACEview: Connection Settings
b. Select Auto Start in the DUN section.
c.
Select Maintain Persistent Connection.
207
ALEOS User Guide
When checked, ACEview will continually check the DUN connection to ensure it is not down. If so, ACEview will attempt to connect again.
Tip:
When using the DUN connection, make sure the IP Address is set to the local IP address of the modem, i.e., 192.168.13.31 (by default).
d. Select OK.
Windows DUN
You can directly use the Dial-up link for the DUN connection.
1.
Start the DUN session.
Start > Connect To > Prosoft Technology RadioLinx Modem
If you named the connection differently, use the name of the PPP connection you made earlier.
Figure A-31: DUN Connection
208 4112515
Note: Generally, you will not need to enter a
Username or Password. If you do need to enter
Select Dial to connect to the modem and the cellular network.The speed shown in the connection is the speed between the modem and your computer. It is not the speed of the modem’s connection to the provider or the Internet.
When you are connected, an icon should appear in the system tray showing the connection status.
Figure A-32: Connection indicator
Caution:
For DUN connections on a Windows Mobility or other non-personal computer, the DNS settings may not be configured with the DUN connection. You may need to go into the network settings and add DNS servers manually.
Rev. 6 May.13
209
ALEOS User Guide
210 4112515
B: Modbus/BSAP Configuration
The AirLink device supports Modbus ASCII, Modbus RTU, and BSAP, and can also emulate other protocols like DF1 using its Modbus
Variable feature.
B
Modbus Overview
The Modbus Protocol, developed by Modicon in 1979, provides for client-server (also referred to as master-slave) communications between intelligent devices. As a de facto standard, it is the most widely used network protocol in the industrial manufacturing environment to transfer discrete/analog I/O and register data between control devices. Modbus, BSAP, and other Modbus variations are often used in conjunction with telemetry devices.
Tip:
This section is a brief overview of Modbus. For more information, refer to your Modbus equipment distributor or manufacturer or go to http://www.modbus.org.
Telemetry
Telemetry is an automated communications process by which data is collected from instruments located at remote or inaccessible points and transmitted to receiving equipment for measurement, monitoring, display, and recording. Transmission of the information may be over physical pairs of wires, telecommunication circuits, radios or satellite.
Remote Terminal Unit (RTU)
Modbus was originally designed to be used in a radio environment where packets are broadcast from a central station (also called master or host) to a group of remote units. Each remote unit, Remote
Terminal Unit (RTU), has a hexidecimal identification number (ID).
The first part of the broadcast packet contains an RTU ID which corresponds to the ID of one of the remote units. The Modbus host looks for the ID and sends to only the unit with the matching ID. The
RTU would then reply back to the central station.
The RTU connects to physical equipment such as switches, pumps, and other devices and monitors and controls these devices. The
RTU can be part of a network set up for Supervisory Control and
Data Acquisition.
Rev. 6 May.13
211
ALEOS User Guide
Supervisory Control and Data Acquisition (SCADA)
Supervisory Control and Data Acquisition (SCADA) describes solutions across a large variety of industries and is used in industrial and engineering applications to monitor and control distributed systems from a master location. SCADA encompasses multiple RTUs, a central control room with a host computer (or network), and some sort of communication infrastructure.
SCADA allows for “supervisory” control of remote devices as well as acquiring data from the remote locations. Programmable Logic Controllers allow for a higher degree of automated SCADA.
Programmable Logic Controller (PLC)
A Programmable Logic Controller (PLC) is a small industrial computer which generally monitors several connected sensor inputs and controls attached devices (motor starters, solenoids, pilot lights/displays, speed drives, valves, etc.) according to a user-created program stored in its memory. Containing inputs and outputs similar to an RTU, PLCs are frequently used for typical relay control, sophisticated motion control, process control, Distributed Control System and complex networking.
Modbus TCP/IP
Modbus TCP/IP simply takes the Modbus instruction set and wraps TCP/IP around it. Since TCP/IP is the communications standard for the Internet and most networked computers, this provides a simpler installation. Modbus TCP/IP uses standard Ethernet equipment.
Raven Modbus on UDP
When Sierra Wireless AirLink devices are used in place of radios, a AirLink device is connected to the central station (host) and aAirLink device is connected to each remote unit. When the AirLink device is configured for Modbus with UDP, the
AirLink device connected to the host can store a list of IP addresses or names with matching IDs. When the host at the central station sends serial data as a poll request, the AirLink device at the host matches the RTU ID to a corresponding IP of a AirLink device at a remote unit. A UDP packet is assembled encapsulating the RTU ID and serial data transmitted from the host. The UDP packet is then transmitted to the specific AirLink device at the remote unit matching the RTU ID.
The remote AirLink device then disassembles the packet before transmitting the
RTU ID and serial data to the remote unit. The remote units operate in normal
UDP mode and their data is sent to the host via the remote AirLink device and host AirLink device.
212 4112515
Rev. 6 May.13
Configuring the AirLink Device at the
Polling Host for Modbus on UDP
This section covers a Polling Host with standard Modbus, variations may need additional AT commands.
Configure the Listening/Device Ports
In ACEmanager, select Port Configuration in the side menu.
The destination port for the modem at the host needs to match the device port
(*DPORT) in use on all the modems at the remote sites. For example, if the remote modem’s device port (*DPORT) is “12345”, then the Modbus host modem's S53 destination port should be set to “12345”.
Take note of (or set) the Device Port setting in *DPORT to configure the destination port on the remote modems.
In ACEmanager, select UDP in the side menu. Select the appropriate MD mode from the drop down menu.
•
MD13: Modbus ASCII
•
MD23: Modbus RTU (Binary)
•
MD33: BSAP
•
MD63: Variable Modbus — individual parameters are set up manually
•
modem, i.e. remote1, remote2, etc.
When you configure Dynamic DNS for the host modem, make note of your modem name and domain setting in ACEmanager in the menu selection Dynamic
IP to be used with the remote modems.
With names instead of IP addresses for the Address List, the host modem will query the DNS server for the current IP address assigned to the specific name of a remote modem to send a message corresponding to the ID.
When you use names instead of IP addresses, to ensure your modems are updated quickly with the correct IP addresses for the names, you will want to set the DNS settings as well. In ACEmanager, select DNS.
Configure *DNSUSER to the same IP address as the Dynamic DNS
(*IPMANAGER1). If your modems have dynamic IP addresses and not static (the
IP address can change when it is powered up), configure *DNSUPDATE to a low interval to allow frequent updates.
213
ALEOS User Guide
Note: With a name instead of IPs for the host device, the remote devices will query the DNS server for the current IP assigned to the host device before sending data back to the host.
Configuring the Remote AirLink Devices for Modbus with UDP
This section covers standard Modbus settings for the AirLink device at the remote unit, variations may need additional commands.
1.
Configure the ports
In ACEmanager, select Port Configuration in the side menu.
The destination port for the device at the host needs to match the device port in use on all the devices at the remote sites. For example, if the remote device’s device port (see below) is “12345”, then the Modbus host device’s S53 destination port should be set to “12345”.
Set the destination port (S53) to match the device port of the host device
(*DPORT). Make sure the device port of the remote device (*DPORT) matches the destination port of the host device (S53).
If the Host device has a static IP address, enter it in the Destination Address for
S53.
If the device at the host has a dynamic IP and is using Dynamic DNS, instead of an IP address for S53, specify the name of the host device (*deviceNAME). If the remote devices are using a different DDNS than the host device, you will need to specify the fully qualified domain name (*deviceNAME+*DOMAIN).
Note: Setting the Host device IP address as the S53 Destination Address provides a low level security. The device will not forward UDP traffic unless the source IP/port matches what is in S53. However, if you set *AIP=1, the device will forward UDP traffic from any source IP address as long as it is accessing the device on the configured *DPORT.
2.
Configure the default mode for start-up.
Each device at the remote locations will need to be configured to communicate with the device at the host. In ACEmanager, select UDP in the side menu.
a.
Enable S82, UDP auto answer.
b. Set S83 to the idle time-out applicable to your application, commonly 20.
3.
Configure other RTU settings.
Other parameters may need to be changed, but this is dependent on the RTU type being used. As a minimum, this typically involves setting the proper serial settings to match your RTU.
4.
Optional: Dynamic IP Address
If you do not have a static IP, the host device should be configured to report its current IP to a Dynamic DNS (DDNS) server with Dynamic DNS.
You will need to match the name of the device to the names specified in the host device’s MLIST or MLISTX for the connected RTU.
When you configure Dynamic DNS for the host device, make note of your device name and domain setting in ACEmanager in the menu selection Dynamic IP to be used with the remote devices.
214 4112515
When you use names instead of IP addresses, to ensure that your devices are updated quickly with the correct IP addresses for the names, you should set the
DNS settings as well.
Configure *DNSUSER to the same IP address as the Dynamic DNS
(*IPMANAGER1). If your devices have dynamic IP addresses and not static (the
IP address can change when it is powered up), configure *DNSUPDATE to a low interval to allow frequent updates.
Rev. 6 May.13
215
ALEOS User Guide
216 4112515
C: PPP Over Ethernet (PPPoE)
•
Configuring a
PPPoE
Connection in
Windows
•
Connecting to the
Internet with
PPPoE
Configuring a PPPoE Connection in
Windows
C
Note: These directions are for Windows XP.
1.
Create a new network connection.
a.
Select Start > Connect To > Show all connections. This will open the Network Connections window.
Figure C-1: Windows: Start menu
b. Under Network Tasks in the menu area on the left, select
Create a new connection.
Rev. 6 May.13
Figure C-2: Windows: Network Connections
217
ALEOS User Guide
c.
When the New Connection Wizard displays, click Next to start installing and configuring the PPPoE connection.
Figure C-3: New Connection Wizard
d. Select Connect to the Internet, and click the Next button.
218
Figure C-4: New Connection: Type
e.
Select Set up my connection manually, and click the Next button.
Figure C-5: New Connection: How do you want to connect?
4112515
Rev. 6 May.13
f.
Select Connect using a broadband connection..., and click the Next button.
Figure C-6: New Connection: Connect using broadband
g. Type in a name for the connection (e.g., Sierra Wireless AirLink Modem), and click the Next button.
Figure C-7: New Connection: Connection Name
Tip:
The name provided here will not effect the connection in any way. It is only a label for the icon. It can be the name of your wireless service provider (Provider), your modem
(AirLink device), or any other designation for the connection.
h. Optional: If you have multiple users configured for your computer, you may be prompted for Connection Availability. If you select My use only, the account currently logged on will be the only one able to use this connection.
i.
Enter the user name and password you configured for *HOSTUID and
*HOSTPW in the Serial > Port Configuration tab.
Tip:
If you want to allow others to use the same login for the modem, select Use this account name and password. Click the Next button to continue.
219
ALEOS User Guide
Same *HOSTUID as configured earlier
Same *HOSTPW as configured earlier
Figure C-8: New Connection: Connection Information
Caution:
If you have a LAN connection to the Internet and select Make this the default
Internet connection for the PPPoE configuration, you will not be able to use the LAN to connect to the Internet. This may also affect the network connection on your computer to the rest of the LAN. Select this option ONLY if the AirLink device will be your sole network connection.
j.
If you want to add a shortcut for this PPPoE connection to your desktop, check the Add a shortcut to this connection to my desktop box.
k.
Click the Finish button to exit the Network Connection Wizard.
220
Figure C-9: New Connection: Finish
4112515
2.
Configure the PPPoE connection
After you complete the New Connection Wizard, there are a few more things you will want to configure in the connection.
a.
Select the Properties button.
Rev. 6 May.13
Figure C-10: PPPoE Connection
b. Optional: On the General tab, if you gave the modem a name with
*MODEMNAME above, you can type in that name as the Service Name.
Same as *MODEMNAME configured earlier
Figure C-11: PPPoE Connection: Service Name
221
ALEOS User Guide
c.
Select the Networking tab, and click the Settings button.
222
Figure C-12: PPPoE: Networking
d. Remove the checks from all three PPP settings, and click the OK button.
Figure C-13: PPP Settings
Tip:
You may want to check the Options tab and change the settings for applications you might be using. The default options are generally applicable for most uses.
Caution:
Unless specifically directed to do so by Support or your network administrator, you do not need to make any changes to the options on the Security tab.
e.
Click the
OK button until you return to the Connect window.
4112515
Connecting to the Internet with PPPoE
Now the PPPoE connection can be run and a data connection can be established.
1.
Connect your computer and the modem to the same local network using a hub or a switch.
Note: It is not recommended to connect your computer directly to the modem without a hub or switch.
2.
Start the PPPoE by Start > Connect To > Sierra Wireless AirLink Modem (or whatever you named the connection). It will be listed on your Network
Connections window under the heading Broadband.
Rev. 6 May.13
Same *HOSTUID as configured earlier
Same *HOSTPW as configured earlier
Figure C-14: PPPoE Connection
3.
Enter the User name and Password you configured for *HOSTUID and
*HOSTPW in the Serial > Port Configuration tab.
4.
Click the Connect button to connect to the modem and the Internet.
When you are connected, an icon will appear in the System Tray (near the time display) showing the connection status.
Note: PPPoE over Windows 7 may not be able to access ACEmanager.
223
ALEOS User Guide
224 4112515
D: SNMP: Simple Network Management
Protocol
•
Management
Information Base
(MIB)
•
SNMP MIB
Definition Sample
Management Information Base
(MIB)
The management information base (MIB) is a type of database used to compile the information from the various SNMP agents. Reports from various agents, such as the AirLink device, are sent as data in a form designed to be parsed by the NMS into its MIB. The data is hierarchical with entries addressed through object identifiers.
D
SNMP Traps
SNMP traps are alerts that can be sent from the managed device to the Network Management Station when an event happens. Your
AirLink device is capable of sending the LinkUp trap when the network connection becomes available.
Listening Port
*SNMPPORT
sets the port for the SNMP agent to listen on. If set to zero (Default), SNMP is disabled.
Tip:
SNMP generally uses port 161. Most Internet providers (including cellular), however, block all ports below 1024 as a security measure. You should be able to use a higher numbered port such as 10161.
Security Level
*SNMPSECLVL sets the security level and which version of SNMP communications are used:
•
0 — No security required. SNMPv2c and SMNPv3 communications are allowed
•
1 — Authentication is required. SNMPv3 is required to do authentication, and SNMPv2c transmissions will be silently discarded. Authentication is equivalent to the authNoPriv setting in SNMPv3
•
2 — Authentication is required, and messages are encrypted.
SNMPv3 is required to do authentication. SNMPv2c and
SNMPv3 authNoPriv transmissions will be silently discarded.
Rev. 6 May.13
225
ALEOS User Guide
Authentication and encryption is equivalent to the authPriv setting in
SNMPv3.
User Name and Password
The user name is 'user'. The user name cannot be changed. The AirLink device's password is used as the SNMP password (default is '12345').
Tip:
The eight-character password requirement for SMNPv3 is not enforced by the
PinPoint X Agent to allow the default password to function. Your SNMP administrator or
MIS may require you to change to a more secure or longer password.
To change the password in the AirLink device, go to Admin and change your
ACEmanager password.
226
Figure D-1: ACEmanager: Change Password menu option
For the password, you can use numbers, letters, and/or punctuation marks.
Caution:
The password is case sensitive. “drowssaP” is not the same as “drowssap”.
Trap Destination
*SNMPTRAPDEST needs to be set with the destination IP and port. If either are set to zero or empty, SNMP traps are disabled.
Note: Traps are sent out according to the SNMP security level (i.e. if the security level is 2, traps will be authenticated and encrypted). Currently, the only trap supported is LinkUp.
Community String
The community string can be configured using *SNMPCOMMUNITY. The default is “public”.
4112515
Rev. 6 May.13
SNMP MIB Definition Sample
AIRLINK-MIB DEFINITIONS ::= BEGIN
IMPORTS
ObjectName FROM SNMPv2-SMI
MODULE-COMPLIANCE FROM SNMPv2-CONF; org OBJECT IDENTIFIER ::= { iso 3 } dod OBJECT IDENTIFIER ::= { org 6 } internet OBJECT IDENTIFIER ::= { dod 1 } private OBJECT IDENTIFIER ::= { internet 4 } enterprises OBJECT IDENTIFIER ::= { private 1 } airlink OBJECT IDENTIFIER ::= { enterprises 20542 } general OBJECT IDENTIFIER ::= { airlink 1 } common OBJECT IDENTIFIER ::= { airlink 2 } status OBJECT IDENTIFIER ::= { airlink 3 } gps OBJECT IDENTIFIER ::= { airlink 4 }
-- GENERAL -phoneNumber OBJECT-TYPE
SYNTAX DisplayString (SIZE (10))
MAX-ACCESS read-only
STATUS current
::= { general 1 } deviceID OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
::= { general 2 } electronicID OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
::= { general 3 } modemType OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
::= { general 4 } aleosSWVer OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
::= { general 5 }
227
ALEOS User Guide
aleosHWVer OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
::= { general 6 } modemSWVer OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
::= { general 7 } modemHWVer OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
::= { general 8 }
-- COMMON -date OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
::= { common 1 } otaProgrammingEnable OBJECT-TYPE
SYNTAX INTEGER { disabled(0), enabled(1) }
MAX-ACCESS read-only
STATUS current
::= { common 2 } devicePort OBJECT-TYPE
SYNTAX INTEGER(0..65535)
MAX-ACCESS read-only
STATUS current
::= { common 3 } netUID OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
::= { common 4 } netPW OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
::= { common 5 }
228 4112515
Rev. 6 May.13
requestPAP OBJECT-TYPE
SYNTAX INTEGER { no(0), yes(1) }
MAX-ACCESS read-only
STATUS current
::= { common 6 } destinationAddress OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
::= { common 7 } destinationPort OBJECT-TYPE
SYNTAX INTEGER(0..65535)
MAX-ACCESS read-only
STATUS current
::= { common 8 } serialPortSettings OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
::= { common 9 } serialPortFlowControl OBJECT-TYPE
SYNTAX INTEGER { none(0), hardware(2), software(4) }
MAX-ACCESS read-only
STATUS current
::= { common 10 }
-- STATUS -ipAddress OBJECT-TYPE
SYNTAX IpAddress
MAX-ACCESS read-only
STATUS current
::= { status 1 } netState OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
::= { status 2 }
229
ALEOS User Guide
netChannel OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
::= { status 3 } rssi OBJECT-TYPE
SYNTAX INTEGER(-125..-50)
MAX-ACCESS read-only
STATUS current
::= { status 4 } serialSent OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
::= { status 5 } serialReceived OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
::= { status 6 } hostMode OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
::= { status 7 } powerMode OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
::= { status 8 } fixObtained OBJECT-TYPE
SYNTAX INTEGER { no(0), yes(1) }
MAX-ACCESS read-only
STATUS current
::= { gps 1 } satelliteCount OBJECT-TYPE
SYNTAX INTEGER
MAX-ACCESS read-only
STATUS current
::= { gps 2 }
230 4112515
Rev. 6 May.13
latitude OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
::= { gps 3 } longitude OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
::= { gps 4 } c:\usr\bin>snmpwalk -Os -c public -v 1 192.168.13.31 1 sysDescr.0 = STRING: PinPoint X HSUPA sysObjectID.0 = OID: enterprises.20542.9.17
sysUpTimeInstance = Timeticks: (3404) 0:00:34.04
sysContact.0 = STRING: sysName.0 = STRING: test sysLocation.0 = STRING: sysServices.0 = INTEGER: 76 enterprises.20542.1.1.0 = STRING: "17604053757" enterprises.20542.1.2.0 = STRING: "0x000002F8003DDAFD" enterprises.20542.1.3.0 = STRING: "354220010245369" enterprises.20542.1.4.0 = STRING: "PinPoint X HSUPA" enterprises.20542.1.5.0 = STRING: "H4323_4.0.11.E05 Oct 13 2011" enterprises.20542.1.6.0 = STRING: "09110004000300000000000000000000" enterprises.20542.1.7.0 = STRING: "F1_0_0_12AP C:/WS/FW/F1_0_0_12AP/
MSM7200R3/SR
C/AMSS 2008/01/01 14:18:44" enterprises.20542.1.8.0 = STRING: "MC8781" enterprises.20542.2.1.0 = STRING: "10/14/2011 17:26:02" enterprises.20542.2.2.0 = INTEGER: 1 enterprises.20542.2.3.0 = INTEGER: 12345 enterprises.20542.2.4.0 = "" enterprises.20542.2.5.0 = "" enterprises.20542.2.6.0 = INTEGER: 0 enterprises.20542.2.7.0 = "" enterprises.20542.2.8.0 = INTEGER: 0 enterprises.20542.2.9.0 = STRING: "115200,8N1" enterprises.20542.2.10.0 = INTEGER: 2 enterprises.20542.3.1.0 = IpAddress: 166.130.104.64
enterprises.20542.3.2.0 = STRING: "Network Ready" enterprises.20542.3.3.0 = INTEGER: 0 enterprises.20542.3.4.0 = INTEGER: -90 enterprises.20542.3.5.0 = INTEGER: 2464 enterprises.20542.3.6.0 = INTEGER: 0 enterprises.20542.3.7.0 = STRING: "AT" enterprises.20542.3.8.0 = STRING: "INITIAL" enterprises.20542.3.9.0 = STRING: "-13.0" enterprises.20542.3.10.0 = STRING: "AT&T, 310410" enterprises.20542.3.11.0 = STRING: "HSPA" enterprises.20542.3.12.0 = INTEGER: 321 enterprises.20542.3.13.0 = STRING: "13.44"
231
ALEOS User Guide
enterprises.20542.3.14.0 = INTEGER: 35 enterprises.20542.3.15.0 = INTEGER: 1 enterprises.20542.3.16.0 = INTEGER: 1 enterprises.20542.3.17.0 = INTEGER: 1 enterprises.20542.3.18.0 = INTEGER: 1 enterprises.20542.3.21.0 = STRING: "00.35" enterprises.20542.3.22.0 = STRING: "00.35" enterprises.20542.3.23.0 = STRING: "00.35" enterprises.20542.3.24.0 = STRING: "00.35" enterprises.20542.3.25.0 = INTEGER: 0 enterprises.20542.3.26.0 = INTEGER: 0 enterprises.20542.3.31.0 = INTEGER: 49255 enterprises.20542.4.1.0 = INTEGER: 0 enterprises.20542.4.2.0 = INTEGER: 0 enterprises.20542.4.3.0 = INTEGER: 0 enterprises.20542.4.4.0 = INTEGER: 0 enterprises.20542.5.1.0 = STRING: "Disabled" enterprises.20542.5.2.0 = STRING: "01/01/2008" enterprises.20542.5.3.0 = INTEGER: 5000000 enterprises.20542.5.4.0 = INTEGER: 0 enterprises.20542.5.5.0 = INTEGER: 0 enterprises.20542.5.6.0 = INTEGER: 0 enterprises.20542.5.7.0 = INTEGER: 0 enterprises.20542.5.8.0 = INTEGER: 0 enterprises.20542.5.9.0 = INTEGER: 0 enterprises.20542.6.1.0 = INTEGER: 1 enterprises.20542.6.2.0 = INTEGER: 1 enterprises.20542.6.3.0 = INTEGER: 0 enterprises.20542.6.4.0 = INTEGER: 0 enterprises.20542.6.5.0 = INTEGER: 0 enterprises.20542.6.6.0 = INTEGER: 0 enterprises.20542.6.7.0 = INTEGER: 1 enterprises.20542.6.8.0 = INTEGER: 0 enterprises.20542.6.9.0 = INTEGER: 0 enterprises.20542.6.10.0 = INTEGER: 0 enterprises.20542.6.11.0 = INTEGER: 0 enterprises.20542.6.12.0 = INTEGER: 0 enterprises.20542.6.13.0 = INTEGER: 0 enterprises.20542.6.14.0 = INTEGER: 0 enterprises.20542.6.15.0 = INTEGER: 0 enterprises.20542.6.16.0 = INTEGER: 0 enterprises.20542.6.17.0 = INTEGER: 0 enterprises.20542.6.18.0 = INTEGER: 0 enterprises.20542.6.19.0 = INTEGER: 0 enterprises.20542.6.20.0 = INTEGER: 0 enterprises.20542.6.21.0 = INTEGER: 0 enterprises.20542.6.22.0 = INTEGER: 0 enterprises.20542.6.23.0 = INTEGER: 0 enterprises.20542.6.24.0 = INTEGER: 0 enterprises.20542.6.25.0 = INTEGER: 0 enterprises.20542.6.26.0 = INTEGER: 0 enterprises.20542.6.27.0 = INTEGER: 0
232 4112515
Rev. 6 May.13
enterprises.20542.6.28.0 = INTEGER: 0 enterprises.20542.6.29.0 = INTEGER: 0 enterprises.20542.6.30.0 = INTEGER: 0 enterprises.20542.6.31.0 = INTEGER: 0 enterprises.20542.6.32.0 = INTEGER: 0 enterprises.20542.6.33.0 = INTEGER: 0 enterprises.20542.6.34.0 = INTEGER: 0 enterprises.20542.6.35.0 = INTEGER: 0 enterprises.20542.6.36.0 = INTEGER: 0 enterprises.20542.6.37.0 = INTEGER: 0 enterprises.20542.6.38.0 = INTEGER: 0 enterprises.20542.6.39.0 = INTEGER: 0 enterprises.20542.6.40.0 = INTEGER: 0 enterprises.20542.6.41.0 = INTEGER: 0 enterprises.20542.6.42.0 = INTEGER: 0 enterprises.20542.6.43.0 = INTEGER: 0 enterprises.20542.6.44.0 = INTEGER: 0 enterprises.20542.6.45.0 = INTEGER: 0 enterprises.20542.6.46.0 = INTEGER: 0 enterprises.20542.6.47.0 = INTEGER: 0 enterprises.20542.6.48.0 = INTEGER: 0 enterprises.20542.6.49.0 = INTEGER: 0 enterprises.20542.6.50.0 = INTEGER: 0 enterprises.20542.6.51.0 = INTEGER: 0 enterprises.20542.6.52.0 = INTEGER: 0 enterprises.20542.6.53.0 = INTEGER: 0 enterprises.20542.6.54.0 = INTEGER: 0 enterprises.20542.6.55.0 = INTEGER: 0 enterprises.20542.6.56.0 = INTEGER: 0 enterprises.20542.6.57.0 = INTEGER: 0 enterprises.20542.6.58.0 = INTEGER: 0 enterprises.20542.6.59.0 = INTEGER: 0 enterprises.20542.6.60.0 = INTEGER: 0 enterprises.20542.6.61.0 = INTEGER: 0 enterprises.20542.6.62.0 = INTEGER: 0 enterprises.20542.6.63.0 = INTEGER: 0 enterprises.20542.6.64.0 = INTEGER: 0 enterprises.20542.6.65.0 = INTEGER: 0 enterprises.20542.6.66.0 = INTEGER: 0 enterprises.20542.6.67.0 = INTEGER: 0 enterprises.20542.6.68.0 = INTEGER: 0 enterprises.20542.6.68.0 = No more variables left in this MIB View (It is past the end of the MIB tree)
Data Usage SNMP Traps
SNMP traps can be generated by Events Reporting. The trap can be associated with an Event on the Event subtab. The contents of the trap are dependent on the type of Event which generates the trap.
Traps are generated by events reporting. The trap OID is
1.3.6.1.4.1.20542.7.<MSCI>.0
233
ALEOS User Guide
234
The trap will also contain the data associated with the event. The data OID is
1.3.6.1.4.1.20542.8.<MSCI>.0
In Both cases <MSCI> is the MSCI ID of the Event.
The MSCI ID's of the data usage events are:
6571 Data Usage Status
6561 Data Usage for the Current Month
6558 Data Usage for the Current Week
6555 Data Usage for the Current Day
6573 Data Usage Month Change
1171 Data Change
6575 Data Usage Week Change
Other event MSCI ID's are:
851 Digital Input 1
852 Digital Input 2
855 Analog Input 1
261 RSSI
270 Periodic Timer
900 GPS Fix
905 Vehicle Speed
904 Change in Vehicle Heading
Data Usage SNMP MIB
A new section in the Airlink MIB has been added for Data usage. This new section has an OID starting with:
1.3.6.1.4.1.20542.5.
The following are the fields within that section:
1 = Status
2 = Next Month Start
3 = Plan Size
4 = Current Month Usage
5 = Current Week Usage
6 = Current Day usage
7 = Previous Month Usage
8 = Previous Week Usage
9 = Previous Day Usage
4112515
Rev. 6 May.13
Display Responses
The string that is displayed for these objects is the same display for the corresponding AT command.
Object AT Command phoneNumber deviceID electronicID aleosSWVer aleosHWVer modemSWVer modemHWVer date
I3
I1
*NETPHONE?
*DEVICEID?
I1
I2
I2
*DATE?
otaProgrammingEnable
OPRG?
devicePort
*DPORT?
netUID netPW
*NETUID?
*NETPW?
requestPAP destinationAddress destinationPort serialPortSettings
*HOSTPAP?
S53
S53
S23
serialPortFlowControl ipAddress netState netChannel rssi hostMode powerMode fixObtained satelliteCount latitude longitude ecio
\Q
*NETIP?
*NETSTATE?
*NETCHAN?
*NETRSSI?
*HOSTMODE?
*POWERMODE?
PinPoint line modems only
PinPoint line modems only
PinPoint line modems only
PinPoint line modems only
PinPoint line modems only
+ECIO
235
ALEOS User Guide
Object
Operator
+NETOP
Network Service Type
+NETSERV
System Reboots
AT Command
Number of System Resets
There is no corresponding AT command available. Check on
ACEmanager - Admin - Advanced screen.
*POWERIN
Power In
Board Temp
*BOARDTEMP
Product ID
Each modem type has a unique ID associated with it so you can more easily identify the modem from its type on your network.
236 4112515
E: Global Positioning System (GPS)
•
Configuring the
AirLink Device for
GPS
•
RAP Configuration
•
NMEA
Configuration
•
TAIP Emulation
Configuration
Configuring the AirLink Device for
GPS
E
This section covers general GPS configuration. Configurations for specific protocols are covered in later sections.
To configure your modem’s GPS settings, use either ACEmanager or a terminal connection using AT commands. The configuration examples in this chapter use ACEmanager. Most of the settings are in the group: PinPoint.
Tip:
You can use a fully qualified domain name instead of an IP address for most configuration options calling for an IP address if your AirLink device is configured to use DNS. Refer to the Services chapter for details on how to configure DNS and how to allow your AirLink device use a domain name even with a dynamic IP address account from your cellular provider.
Real-Time Clock Synchronization
Every hour, the AirLink device will sync the internal Real Time Clock
(RTC) with the Universal Time Coordinated (UTC) received from the
GPS satellites.
Many tracking applications will translate the time reported by the
AirLink device as part of the GPS message to the appropriate local time zone using the UTC offset (i.e., California is UTC-8 and New
York is UTC-5).
Tip:
ACEmanager displays the current time (UTC) set in the AirLink device and does not translate it to the local time zone. If the AirLink device is in
California and it is 8 a.m., the modem’s time will be shown as 4 p.m, since
UTC is 8 hours “ahead” of Pacific time (UTC-8).
Rev. 6 May.13
237
ALEOS User Guide
Configuring the Datum
You can change the Datum used by your AirLink device by configuring
*PPGPSDATUM. Match the Datum to the Datum used by your tracking application.
Over-The-Air (Remote) Host
To set the AirLink device to report to an external or remote host, configure *PPIP
(ATS Server IP) and *PPPORT (Server Port). *PPIP will work with any remote host.
Local Host
To set the AirLink device to report to a local host, one directly connected to the serial port, configure the port to be used with S53 - Destination Port. The local IP address will automatically be used for local reports. S53, in ACEmanager, is part of the GPS group.
If you need to send reports to additional local ports, you can specify other ports with *PPLATSEXTRA. Local Reports can be sent to up to 7 additional ports consecutively following the S53 port. If S53=1000 and *PPLATSEXTRA=4, reports will be sent to 1000, 1001, 1002, 1003, and 1004. In PPLATSEXTRA, specify the number of ports where you want the reports sent, 0 to 7 (0 disables extra ports).
TCP GPS Report Polling
The AirLink device can easily and quickly be polled for location by opening a TCP connection to port 9494 (default). Once the connection is established, the AirLink device will send a report with the current position using the GPS report type the modem is configured to use.
You can change the port for the TCP GPS poll using *PPTCPPOLL.
Note: Some Internet providers (including cellular) block ports below 1024.
238 4112515
Rev. 6 May.13
Report Types
There are several report types available. For remote reports, set *PPGPSR. For local reports, set *PPLATSR.
•
0 — *MF, Legacy reports for use with ATS version 4 and older.
•
11 — Global Positioning System (GPS) data.
•
12 — GPS data with the UTC time and date.
•
13 — GPS with time and date and Radio Frequency data from the antenna.
•
D0 — Xora reports.
•
E0 — NMEA GGA and VTG sentences.
•
E1 — NMEA GGA, RMC, and VTG sentences.
•
F0 — TAIP data
•
F1 — TAIP compact data
Tip:
The AirLink device can be configured to supply one type of report to a remote host and a different report type locally through the serial port at same time. However, there may be conflicts due to the local and remote reporting being in different modes and not all features to both modes may be available.
Sending Reports Automatically
Remote
You can configure the AirLink device to send reports based on a time interval and on the movement of a vehicle (based on it’s position from one time to the next).
•
*PPTIME — Location report sent every set time interval (seconds).
•
*PPDIST — Location report sent only if the position is more than the set distance (x 100 meters).
•
*PPTSV — Location report sent if the vehicle has been in one location
(stationary) for more than a set time interval (minutes).
•
*PPMINTIME — Location report sent be sent at no less than this time interval
(seconds).
Note: If you’re implementing both a time interval and distance interval for reports, the
AirLink device will use the timer which expires first. The reporting interval can impact your data usage. If the interval is set frequently, you may want to have a high usage or unlimited data plan.
Tip:
One mile equals 1609 meters. 1000 meters equals one kilometer.
239
ALEOS User Guide
Local
If you are sending reports on the local serial port, and/or if you want them sent automatically, you will need to set *PPLATS. The time interval, just as for
*PPTIME, is in seconds.
Store and Forward
Store and Forward (SNF) can provide seamless coverage even in areas with intermittent cellular coverage. If the AirLink device leaves coverage or has very low signal (an RSSI of -105 or lower), it will store the GPS messages in memory.
When the modem re-enters cellular coverage, it will then forward the messages as configured. The AirLink device can also store messages and send them to the server in a packet rather than individually to conserve bandwidth.
SNF Enable (*PPSNF)
Enable Store and Forward using *PPSNF. This will store up reports if the AirLink device goes out of network coverage or if the Reports Server is unavailable. Once the AirLink device is in coverage, or the Report Server is responding, stored reports will be sent. Default is ‘OFF’.
SNF Reliable Mode (*PPSNFR)
The Store and Forward Reliable Mode allows the AirLink device to ensure all messages are received by the server even if the connection between them goes down for a period of time (such when a vehicle passes through a location where the cellular signal is weak or non-existent).
With SNF Reliable Mode, *PPSNFR, enabled, the AirLink device will transmit a sequence number (1 to 127) as part of a packet of messages (may contain one or more reports). To reduce overhead, the server only acknowledges receipt of every eighth packet.
If the AirLink device does not receive acknowledgement for a “window”, the modem will PING the server with a message containing the sequence numbers of the first and last packets that have not been acknowledged. The AirLink device will continue until the server acknowledges receipt. When the AirLink device receives the acknowledgement, it will advance its “window” to the next group.
When the AirLink device is first powered on (or reset), it will send a Set Window message to sync up with the server for the current “window”.
On the other side, if the server receives an out of sequence packet, it will send a message to the modem noting the missing sequence and the AirLink device will retransmit.
240 4112515
Rev. 6 May.13
SNF Mode (*PPSNFB)
You can determine how you want the messages sent using *PPSNFB.
•
Normal — When the server is reachable, all pending messages are sent immediately
•
Polled — Messages are held and sent only when the AirLink device receives a Poll command from the server
•
Grouped — Messages are held until the total is equal or greater than
*PPSNFM which sets the packet size of grouped reports to store.
SNF Minimum Reports (*PPSNFM)
You can also determine how you want the messages sent using *PPSNFM. You can specify the minimum number of reports that must be stored before they are forwarded to the server. This data is then sent to the server in packets that contain at least this number of reports.
The range of minimum reports is 0
–
255.
SNF Simple Reliable Maximum Entries
(*PPMAXRETRIES)
Simple Reliable Mode will ‘give up’ after a configured number, *PPMAXRETRIES, of attempts and discard messages that cannot be transmitted or received after that number of tries.
Sending Reports Based on an Interval
You can configure the AirLink device to send reports based on a time interval and/ or on the movement of a vehicle (based on its position from one time to the next).
•
*PPTIME — Location report sent every set time interval (seconds).
•
*PPDIST — Location report sent only if the position is more than the set distance (x 100 meters)
•
*PPTSV — Location report sent if the vehicle has been in one location
(stationary) for more than a set time interval (minutes).
•
*PPMINTIME — Location report sent at no less than this time interval
(seconds).
Flush on Event
If you have events enabled, with *PPFLUSHONEVT, you can configure the
AirLink device to flush the SnF buffer when an event occurs. This will immediately send all pending SnF messages to the host. This allows an event, such as a vehicle being powered on or a tow bar activated, to be immediately sent, so its cause can be acted on without delay.
Note: Outstanding packets can include messages already sent to the server that have not been acknowledged (SnF Reliable Mode) whether they have been received by the server or not.
241
ALEOS User Guide
RAP Configuration
RAP has additional features which allow reports based on external physical events, input from a 3rd party devices, store and forward processing, etc.
In addition to being able to configure your AirLink device using ACEmanager or
AT commands, most of the configuration settings for RAP can also be changed with the RAP configuration command message sent by the AVL host.
RAP Reports Over-The-Air (Remote)
To configure your AirLink device to send RAP reports to a remote AVL host server, you will need to set 3 commands: *PPIP, *PPPORT, and *PPGPSR.
1.
Set the IP address of the host with *PPIP and desired port on the host with
*PPPORT.
2.
Set the GPS Report Type, using *PPGPSR, to your preferred RAP report type.
11 — GPS — Global Positioning System data
12 — GPS + Date — GPS data with the UTC time and date
13 — GPS + Date + RF — GPS data with the UTC time and date and Radio
Frequency information from the antenna.
Tip:
If your AVL host server uses a dynamic IP address or needs to change its IP address for any reason, you can use the RAP configuration command to change the value for
*PPIP.
242 4112515
Rev. 6 May.13
RAP Reports over a Local Connection
Local reports are sent to the local IP address of the computer or device connected directly to a port on the AirLink device. The reports are sent using PPP or SLIP for serial or USB virtual serial. To configure the modem to send reports to the local IP address, you need to set three commands: S53 in the GPS group, and *PPLATS and *PPLATSR in the PinPoint group.
1.
Set the S53 port to the local port to which you want the reports sent. The local IP address will automatically be used.
2.
Set the Local Report Type, using *PPLATSR, to your preferred RAP report type.
11 — GPS — Global Positioning System data
12 — GPS + Date — GPS data with the UTC time and date
13 — GPS + Date + RF — GPS data with the UTC time and date and
Radio Frequency information from the antenna.
3.
Set Local Reporting Time Interval, using *PPLATS, to the number of seconds you want as an interval between reports being sent.
Tip:
If *PPLATS is set to 0, reports will only be sent if a poll command is issued by the local client.
Configuring Additional RAP Features
RAP allows additional information to be sent with the reports to enable a richer tracking feature set.
Device ID
By enabling *PPDEVID, a device ID of the AirLink device is sent as part of the
RAP message to make identification easier in a network or fleet of vehicles equipped with PinPoint line devices. With *PPDEVID enabled, the AirLink device uses the value configured for *NETPHONE for the device ID. If *NETPHONE is empty, the ESN of the modem is used.
Tip:
If the AirLink device is using a dynamic IP, *PPDEVID needs to be enabled.
Odometer Data in Reports
When the odometer report is enabled, the AirLink device will calculate distance between reports based on GPS data. The modem’s odometer calculations can be included in the RAP message.
•
*PPODOM enables the odometer reporting.
•
*PPODOMVAL is the current odometer reading in the AirLink device. You can set this to a number to offset the odometer calculation, such as one-time manual synchronization of the AirLink device odometer with the current vehicle odometer.
243
ALEOS User Guide
Note: The odometer calculations of the AirLink device may not match the odometer in the vehicle itself. The AirLink device odometer is not connected to the vehicle’s, it is entirely based on calculations of GPS readings.
I/O Event Reports
You can configure the AirLink device to send reports to the AVL Host based on the state of the digital inputs, analogue inputs, and relay outputs.
Tip:
Setting up the I/O port hardware is covered in the Inputs, Relay Outputs, and Power
Status chapter.
Enable *PPINPUTEVT to have events sent to the Host server.
COM 1000 Support
Support for a COM1000 is enabled with the command *PPCOM1000=1 or
*PPREPORTINPUTS=1. Once enabled, ALEOS will receive the reports from a properly configured COM1000 and add the state of the extra inputs to RAP packets sent to the RAP Host.
If you are replacing an existing PinPoint or PinPoint-E in a vehicle with a
COM1000, simply replace the earlier modem with the PinPoint. Turn on
COM1000 reporting with the command *PPCOM1000=1 to allow a seamless transition with no need to change any commands to support the COM1000 in the same operation as the previous installation.
If you have new vehicle installations for the PinPoint and have previously installed
PinPoints or PinPoint-E modems plus COM1000 in other vehicles, connect the inputs directly to the PinPoint and turn on input reporting with the command
*PPREPORTINPUTS=1. Since the PinPoint reports inputs report using the exact same bit fields as the COM1000, no changes to your software should be required.
Caution:
If both *PPCOM1000 and *PPREPORTINPUTS are enabled, the AirLink device digital inputs will be reported and the COM1000 inputs will be ignored.
The report type will indicate the state of change in the inputs. The contents of the report will be the same as Report Type 0x12 (GPS data with date) or 0x13 (GPS data with date and RF data) with the addition of the event report.
Flush on Event
If Store and Forward is configured and enabled, enable *PPFLUSHONEVT to receive event reports immediately when they occur. This will cause all pending reports, including the triggering event, to be sent immediately to the Host.
244 4112515
Rev. 6 May.13
NMEA Configuration
Messages Over-The-Air (Remote)
To configure the AirLink device to send NMEA reports to a remote server, you will need to set 3 commands: *PPIP, *PPPORT, and *PPGPSR.
1.
Set *PPIP and *PPPORT to the IP address and port of the server to which you want the reports sent.
2.
Set the GPS Report Type (*PPGPSR) to your preferred NMEA sentence format.
•
E0 — NMEA GGA and VTG sentences.
•
E1 — NMEA GGA, RMC, and VTG sentences.
Local Host
Local reports are sent to the local IP address of the computer or device connected to the serial port or USB port of the AirLink device using PPP. To configure the modem to send to the local IP, you will need to set 3 commands:
*S53, *PPLATS, and *PPLATSR.
1.
Set the port (S53) to the local port to which you want the reports sent. The local IP address will automatically be used. S53, in ACEmanager, is part of the GPS group.
2.
Set the Local Report Type, *PPLATSR, to your preferred NMEA sentence format.
•
E0 — NMEA GGA and VTG sentences.
•
E1 — NMEA GGA, RMC, and VTG sentences.
3.
Set Local Reporting Time Interval, using *PPLATS, to the number of seconds you want as an interval between reports being sent.
245
ALEOS User Guide
Streaming Messages (Local)
The AirLink device can be configured to send standard NMEA messages
(sentences) in ASCII over the serial port and/or USB port without a PPP connection to the local computer.
Send the command ATGPS1 to the serial port, ATGPS2 to the USB port, or
ATGPS3 for both to begin the NMEA stream. The example below shows the stream in HyperTerminal connecting directly to a AirLink device via the comport and/or USB port. To stop the stream, with either terminal connection, use the command ATGPS0 (this can be entered even while data is streaming).
246
Figure E-1: HyperTerminal: NMEA Streaming
Persistent Streaming
To have persistent streaming, allowing you to stream the data even after the modem is reset, configure *PGPS and set *PGPSR for NMEA.
•
0 — Disable NMEA streaming.
•
1 — Stream the NMEA strings out the serial port only.
•
2 — Stream the NMEA strings out the USB port only.
•
3 — Stream the NMEA strings out both the serial and the USB ports.
•
E1 — NMEA GGA, RMC, and VTG sentences.
4112515
Rev. 6 May.13
TAIP Emulation Configuration
The TAIP (Trimble ASCII Interface Protocol) emulation functionality allows the
AirLink device to operate in a limited manner with clients which only understand
TAIP. This emulation is enabled by setting the GPS report format, directing the modem to listen for TAIP messages, and disabling RAP formatted messages to the same interface.
TAIP ID
TAIP messages can be configured to send the user specified identification number (ID). This greatly enhances the functional capability of the unit in a network environment. Set the ID using *PPTAIPID.
TAIP Command Emulation
With TAIP emulation, the AirLink device will listen for TAIP messages on port
21000. Set the GPS Report Type, *PPGPSR, to your preferred TAIP data format.
•
F0 — TAIP data (LN): latitude, longitude, altitude, horizontal and vertical speed, and heading.
•
F1 — Compact TAIP data (PV): latitude/longitude, speed, and heading.
Caution:
When TAIP emulation is enabled, RAP will be disabled and no RAP messages or commands will be sent or received on that port.
Supported TAIP Commands
The TAIP emulation will accept the following TAIP message types:
•
SRM (Set Reporting Mode) allows the client to set the reporting mode configuration. The report mode configuration is not stored in non-volatile memory and such should be resent upon a unit reset. This behavior emulates that specified in TAIP specifications.
•
QRM (Query Reporting Mode) reports the reporting mode configuration
(returns an “RRM” message).
•
SID (Set ID) allows the client to set the TAIP ID (AT*PPTAIPID can also be used to set the TAIP ID). The TAIP ID, when set with a “SID” message, will be written to non-volatile memory.
•
QID (Query ID) reports the TAIP ID (returns an “RID” message).
•
DPV configures automatic reporting of PV (Position/Velocity) reports based on distance traveled and a maximum time. The delta distance value specified in the message is converted to hundreds of meters and stored as *PPDIST.
The maximum time interval is stored as *PPTIME. Currently the minimum time and epoch values are ignored.
•
FPV configures periodic reporting of PV (Position/Velocity) reports. The time interval from the message is stored at *PPTIME. The epoch value is ignored.
•
QPV (Query Position Velocity) responds with a PV (Position/Velocity) report.
247
ALEOS User Guide
248
The TAIP emulation will generate the following reports corresponding to the appropriate event (either a query for it, echoed due to a set, or due to an automatic reporting event):
•
RRM (Report Reporting Mode) reports the reporting mode configuration.
•
RID (Report ID) reports the TAIP ID.
•
RPV (Report Position/Velocity) reports Position/Velocity.
Messages Over-the-Air (Remote)
To configure the AirLink device to send NMEA reports to a remote server, you will need to set 3 commands: *PPIP, *PPPORT, and *PPGPSR.
1.
Set *PPIP and *PPPORT to the IP address and port of the server to which you want the reports sent.
Note: Unlike standard TAIP which simply sends to the last client to request automatic reports, the remote reports are sent to the destination address (*PPIP) and destination port
(*PPPORT).
a.
Set the GPS Report Type, *PPGPSR, to your preferred TAIP data format.
•
F0 — TAIP data (LN): latitude, longitude, altitude, the horizontal and vertical speed, and heading.
•
F1 — Compact TAIP data (PV): latitude/longitude, speed, and heading.
Local Connection
Some TAIP client applications can send TAIP requests and listen for reports using a local connection. Generally this is done over the serial port using PPP. This can also be done over the USB virtual serial port using PPP.
The AirLink device will listen for TAIP requests on the local IP address and port.
Once a TAIP request command has been received, the AirLink devicet will begin issuing TAIP reports to the local IP address and port 21000. The client application should be listening for reports on this IP address and port. No unsolicited reports will be sent from the PinPoint to the local client application.
To configure this local TAIP reporting, you will need to set four commands: *PPIP,
S53, *PPGPSR, and *PPLATS.
1.
Set the port (S53) to the local port to which you want the reports sent, 21000 is the common setting. S53, in ACEmanager, is part of the GPS group.
2.
Set *PPIP to the local IP address of the AirLink device. The default IP address of the AirLink device 192.168.14.31.
3.
Set Local Reporting Time Interval, using *PPLATS, to the number of seconds you want as an interval between reports being sent.
4.
Set the GPS Report Type, *PPGPSR, to your preferred TAIP data format.
•
F0 — TAIP data (LN): latitude, longitude, altitude, horizontal and vertical speed, and heading.
•
F1 — Compact TAIP data (PV): latitude/longitude, speed, and heading.
4112515
Rev. 6 May.13
Sending Unsolicited TAIP Messages over the Local
Connection
Standard TAIP requires a request before GPS reports are sent. The AirLink device, however, can be configured to allow TAIP formatted messages to be sent over any UDP port without request commands. This is useful for those applications which can listen for TAIP messages but cannot send UDP request packets.
a.
Set the S53 port to 1000. The local IP address will automatically be used.
b. Set *PPLATSR, Local Report Type, to F0 or F1.
c.
Set *PPLATS, Local Reporting Time Interval, to 5 to send reports every 5 seconds (can be adjusted as circumstances warrant).
Streaming Messages (Local)
The Product Name can be configured to send standard TAIP messages
(sentences) in ASCII over the serial port and/or USB port without a PPP connection to the local computer.
Send the command ATGPS1 to the serial port, ATGPS2 to the USB port, or
ATGPS3 for both to begin the TAIP stream. The example below shows the stream in HyperTerminal connecting directly to a Product Name via the comport and/or
USB port. To stop the stream, with either terminal connection, use the command
ATGPS0 (this can be entered even while data is streaming).
Persistent Streaming
To have persistent streaming, allowing you to stream the data even after the modem is reset, configure *PGPS and set *PGPSR for TAIP.
- *PGPS
0 — Disable TAIP streaming.
1 — Stream the TAIP strings out the serial port only.
2 — Stream the TAIP strings out the USB port only.
3 — Stream the TAIP strings out both the serial and the USB ports.
E1 — TAIP GGA, RMC, and VTG sentences.
E1 — Phrases TAIP GGA, RMC, VTG.
249
ALEOS User Guide
250 4112515
F: AT Commands
•
AT Command Set
Summary
•
Reference Tables
AT Command Set Summary
The reference tables are presented in the order that the
ACEmanager feature tabs appear in the UI. This format allows a quick look-up of each command to verify syntax, parameters, and behaviors. It does not lend itself to finding whether or not the AirLink device has a command to perform a particular service or setting.
This appendix organizes the commands into functional groups to allow you to more quickly locate a desired command when you know the operation but not the command.
F
Note: Some of the configuration commands listed here are only available as
AT commands and some commands require having the device in Passthru mode.
Reference Tables
Result codes are not shown in the command tables unless special conditions apply. Generally the result code
OK is returned when the command has been executed.
ERROR may be returned if parameters are out of range, and is returned if the command is not recognized or is not permitted in the current state or condition of the
AirLink device.
Rev. 6 May.13
251
ALEOS User Guide
Status
The AT commands for the Status tab features have read-only parameters and only provide information about the device. The commands displayed in
ACEmanager and the results of those commands depend on the device model.
The Status tab has more fields that can be displayed on most screens. You can either resize your window or use the scroll bar on the side to display the remainder.
Home
Table F-1: Status > Home Commands
Command Description
*NETPHONE?
*NETIP?
The device's phone number, if applicable or obtainable.
The current IP address of the device reported by the internal module, generally obtained from your cellular carrier. This is the address that can contact the device from the Internet.
Use *NETALLOWZEROIP if you need to allow the display of an IP ending in a zero.
Note: If there is no current network IP address, 0.0.0.0 may be displayed.
*NETALLOWZEROIP
Allow Last Byte of net IP = Zero
*NETSTATE?
*NETRSSI?
Allows the displayed IP address in *NETIP to end in zero (ex. 192.168.1.0).
•
n=0 : Do not allow.
•
n=1 : Allow.
The current network state:
•
Connecting To Network: The device is in the process of trying to connect to the cellular network.
•
Network Authentication Fail: Authentication to the cellular network has failed. Verify settings to activate the device.
Data Connection Failed: The device failed to connect, and it is now waiting a set time interval before it attempts to reconnect. Verify settings to activate the device.
•
Network Negotiation Fail: Network connection negotiation failed. This is usually temporary and often clears up during a subsequent attempt.
•
Network Ready: The device is connected to the 1x cellular network and ready to send data.
•
Network Dormant: The device is connected to the 1x cellular network, but the link is dormant. It will be woken up when data is sent or received.
•
No Service: There is no cellular network detected.
•
Hardware Reset: The internal module is being reset. This is a temporary state.
The current RSSI (Receive Signal Strength Indicator) of the AirLink device as a negative dBm value.
Tip:
The same information is displayed with the command S202?.
*NETOP?
252
Identifies the cellular carrier.
4112515
Table F-1: Status > Home Commands (Continued)
Command Description
I1
I2
I
*NETSERV?
I3
+ECIO
*NETCHAN?
*MODEMNAME
The type of service being used by the device (e.g., Tech EV-DO Rev A).
Device model.
ALEOS software/firmware version, hardware rev string, boot version
Radio model and firmware version
Radio ESN or IMEI
Indicates the signal-to-noise ratio, i.e., the quality of the signal.
The current active CDMA channel number.
The customer device name. Can be up to 20 characters. Prefix to *DOMAIN.
WAN/Cellular
Table F-2: Status > WAN/Cellular Commands
Command Description
+PRL
*PRLSTATUS
*IPPINGADDR
*IPPING
Preferred Roaming List (PRL) version.
•
Set the IP address or valid internet domain name for the device to ping to keep itself alive (online).
*IPPING must to be set to a value other than 0 to enable pinging.
•
d.d.d.d=IP address
•
name=domain name
Set the period to ping (if no valid packets have been received) a specified address
(*IPPINGADDR) to keep the device alive (online).
•
n=0 : Disable pinging (default)
•
n=15–255 minutes
Note: 15 minutes is the minimum interval which can be set for Keep Alive. If you set *IPPING for a value between 0 and 15, the minimum value of 15 will be set.
Rev. 6 May.13
253
ALEOS User Guide
Table F-2: Status > WAN/Cellular Commands
Command Description
*RADIO_CONNE
CT_STARTUP
By default, ALEOS keeps the cellular IP connection active. This AT command changes this setting so that the device is not normally active.
•
0= Normally not connected mode
•
1= Normally connected mode
avms<server>
<interval>
Note: You can also set the device to Normally not connected mode by selecting Disabled in the
Always on connect field on the WAN/Cellular tab.
Enables device-initiated communication from an AVMS device
If device-initiated communication from an AVMS device has been disabled, sending this command immediately renews communication and the device immediately sends a message to AVMS.
<server>= URL of the AVMS server
<interval> = interval in minutes
Both parameters must be present and cannot be 0.
LAN/WiFi
Table F-3: Status > LAN/WiFi Commands
Command Description
*USBDEVICE
USB Device Mode
This parameter alters the default startup data mode.
Security
Table F-4: Status > Security Commands
Command Description
FM
*DMZIP
Firewall mode — Only allow specified IPs to access the device.
•
n=0 : Disable Firewall mode
•
n=1 : Enable Firewall mode — Only packets from friends will be accepted, packets from other IP addresses are ignored.
Sets the DMZ IP address
254 4112515
Services
Table F-5: Status > Services Commands
Command Description
*SNTP
*POWERMODE
Enables daily SNTP update of the system time.
•
n=0 : Off
•
n=1 : On
Displays the current power state/mode. Possible values returned are:
•
Initial: The device is in the initial 5 minutes since power up, so power down event will be ignored
•
On: Regular power on, a power down is not pending
•
Low Cancellable: Power down is pending but still cancelable if the power down trigger goes away
•
Low Pending 1 and Low Pending 2: Power down is pending, any device tasks are gracefully preparing for the power down
•
Low Final: Power down is imminent
•
Low: Power is down.
Rev. 6 May.13
255
ALEOS User Guide
Serial
Table F-6: Status > Serial Commands
Command Description
MD
S0
Default power-up mode for the serial port: When the device is power-cycled, the serial port enters the mode specified by this command after 5 seconds. On startup, typing ATMD0 within 5 seconds changes the mode to normal (AT command) mode. See also S53 to set the port for UDP.
•
hh (hex byte)=00 : normal
•
hh=01 : SLIP
•
hh=02 : PPP
•
hh=03 : UDP
•
hh=04 : TCP
•
hh=07 : PassThru
•
hh=0F : MP MDT
•
hh=13 : Modbus ASCII
•
hh=23 : Modbus RTU (Binary)
•
hh=33 : BSAP
•
hh=63 : Variable Modbus
•
hh=73 : Reliable UDP
•
hh=83 : UDP Multicast
This register determines how the device responds to an incoming TCP connection request. The device remains in AT Command mode until a connection request is received. DTR must be asserted (S211=1 or &D0) and the device must be set for a successful TCP connection. The device will send a “RING” string to the host. A “CONNECT” sent to the host indicates acknowledgement of the connection request and the TCP session is established.
•
n=0 : Off (Default).
•
n=1 : On.
•
n=2 : Use Telnet server mode on TCP connections.
•
n=3 : With a Telnet connection, overrides the client's default echo, allowing the server on the host port to perform the echo. CRLF sequences from the telnet client will also be edited to simply pass CRs to the server on the host port.
S82
Enables UDP auto answer (half-open) mode.
•
n=0 : Normal mode
•
n=2 : Enable UDP auto answer mode.
256 4112515
Applications
Table F-7: Status > Applications Commands
Command Description
*GARMINSTATUS
Status of the externally connected Garmin device.
•
Not connected
•
Not connected/not reporting
•
Connected/not reporting
•
Not enabled
About
Table F-8: Status > About Commands
Command Description
*GLOBALID
*DEVICEID
*ETHMAC
I1
The 64-bit device ID that is used by the device to identify itself to management systems.
The commands displayed in AceManager and the results of those commands depends on the model of the device. This command will retrieve the 64-bit device ID the device uses to identify itself to the cellular network.
The MAC address of the Ethernet port.
ALEOS software/firmware version, hardware rev string, boot version
Rev. 6 May.13
257
ALEOS User Guide
WAN/Cellular
The WAN/Cellular AT commands includes commands specific to 1x and EV-DO.
You will not see this group in ACEmanager if you are not connected to a device which uses EV-DO or 1x.
Table F-9: WAN/Cellular > WAN/Cellular Commands
Command Description
$QCMIP
Mobile IP (MIP) Preferences. On a Mobile IP network, a device connects to the network using PPP. During the negotiation process the device is NOT required to present a username and password to authenticate because the authentication parameters are stored in the device itself.
•
n=0 : Disabled, SIP only
•
n=1 : MIP preferred
•
n=2 : MIP only
*EVDODIVERSITY
*EVDODATASERV
*AUTOPRLFREQ
*IPPINGADDR
*IPPING
Note: Your account with your cellular carrier may not support Mobile IP.
EV-DO Diversity allows two antennas to provide more consistent connection.
•
n=0 : Disabled
•
n=1 : Allow
Note: If you are not using a diversity antenna, *EVDODIVERSITY should be disabled.
Change the allowable Network type.
•
N=0 : EV-DO Preferred — can “fall back” on CDMA/1x
•
N=1 : EV-DO Onl — fall back disabled
•
N=2 : 1x Only — EV-DO disabled
Indicates the PRL update schedule.
•
0=disable
Set the IP address or valid internet domain name for the device to ping to keep itself alive
(online). *IPPING must to be set to a value other than 0 to enable pinging.
•
d.d.d.d=IP address
•
name=domain name
Set the period to ping (if no valid packets have been received) a specified address
(*IPPINGADDR) to keep the device alive (online).
•
n=0 : Disable pinging (default)
•
n=15–255 minutes
Note: 15 minutes is the minimum interval which can be set for Keep Alive. If you set
*IPPING for a value between 0 and 15, the minimum value of 15 will be set.
*IPPINGFORCE
Force the IP ping even if IP traffic has occurred during the time interval.
*CLIENT_PPP_AUTH
Specifies the authentication method to be used in the network PPP session.
258 4112515
Table F-9: WAN/Cellular > WAN/Cellular Commands (Continued)
Command Description
*NETUID
Network User ID
*NETPW
*NETWDOG
The login that is used to login to the cellular network, when required.
•
uid=user id (up to 64 bytes)
Network Password
The password that is used to login to the cellular network (when required). Passwords can be comprised of any type of character or case.
•
pw=password (1–255 characters)
Network connection watchdog: The number of minutes to wait for a network connection. If no connection is established within the set number of minutes, the device resets.
•
n=0 : Disabled.
•
n=minutes : Default = 120 min.
LAN/WiFi
DHCP/Addressing
Table F-10: LAN/WiFi > DHCP/Addressing Commands
Command Description
*HOSTPRIVMODE
*hostdhcpend
Set or query whether a private or public (network) IP is to be used when the Host initiates a
1x connection to the device.
•
n=0 : Public (network) IP Mode: When the Host initiates a PPP connection, the host will be given the network IP address that was obtained from the cellular carrier while registering on the network. If the network issues a new IP address, the cellular connection will be closed (since the IP address has changed) and has to be re-initiated. (default).
•
n=1 : Private IP Mode: When the Host initiates a 1x connection, the host will be given the IP address specified in *HOSTPRIVIP. The device will then perform 1 to 1 NAT-like address translation, which shields the Host from network IP changes.
Sets the DHCP ending IP address.
Rev. 6 May.13
259
ALEOS User Guide
Ethernet
Table F-11: LAN/WiFi > Ethernet Commands
Command Description
*HOSTPEERIP
Set or query the IP address that can be used to directly contact the MP device once a cellular connection is established. If this value is not specified, 192.168.13.31 will be used.
•
d.d.d.d=local or peer IP address of the device.
Note: This is not normally used nor needed by user applications.
*HOSTPRVIP
*HOSTNETMASK
*DHCPSERVER
Set or query the private IP address that is to be negotiated by the 1x connection if
*HOSTPRIVMODE =1.
•
d.d.d.d=IP Address
Subnet mask for the host interface. Allows communication with a subnet behind the host interface.
•
n.n.n.n = subnet mask, example 255.255.255.0.
DHCP Server Mode
USB
Table F-12: LAN/WiFi > USB Commands
Command Description
*USBDEVICE
USB Device Mode
This parameter alters the default startup data mode.
Global DNS
Table F-13: LAN/WiFi > Global DNS Commands
Command Description
*DNS1
*DNS2
Queries the DNS addresses. Your cellular carrier provides the DNS addresses while your device is registering on their network.
•
n=1 or 2 : First and second DNS address.
•
d.d.d.d=IP address of domain server.
260 4112515
Table F-13: LAN/WiFi > Global DNS Commands
Command Description
*DNSUSER
Sets a user-provided DNS to query first when performing name resolutions in the device.
•
d.d.d.d=IP address of domain server
*DNSUPDATE
Note:
Indicates whether the device should send DNS updates to the DNS server specified by
*DNSUSER. These updates are as per RFC2136. They are not secure and are recommended only for a private network. In a public network, the IP Logger services should be used instead.
•
n=0 : DNS updates disabled (Default).
•
n=1 : DNS updates enabled.
PPPoE
Table F-14: LAN/WiFi > PPPoE Commands
Command Description
*HOSTAUTH
*HOSTUID
*HOSTPW
Host Authentication Mode: Use PAP or CHAP to request the user login and password during PPP or CHAP negotiation on the host connection. The username and password set in *HOSTUID and *HOSTPW will be used.
•
n=0 : Disable PAP or CHAP request (Default).
•
n=1 : PAP and CHAP.
•
n=2 : CHAP
Host User ID for PAP, or CHAP, or PPPoE.
•
string=user id (up to 64 bytes)
Host Password for PAP, or CHAP, or PPPoE.
•
string=password
Security
Table F-15: Security > Trusted IPs — Inbound (Friends) Commands
Command Description
FM
FO (F1, F2, ... F9)
Firewall mode — Only allow specified IPs to access the device.
•
n=0 : Disable Firewall mode
•
n=1 : Enable Firewall mode — Only packets from friends will be accepted, packets from other IP addresses are ignored.
Friends List IP address.
•
n=0–9 Friends list index
•
d.d.d.d = IP address
Using 255 in the IP address will allow any number.
Example: 166.129.2.255 allows access by all IPs in the range 166.129.2.0–166.129.2.255.
Rev. 6 May.13
261
ALEOS User Guide
Services
AMS (AirLink Management Services)
Table F-16: Services > AirLink Management Services Commands
Command Description
*AMS_ENABLE
Connect or disconnect the device remotely to AirLink Management Services.
•
n=0 : Disabled
•
n=1 : Enabled
Enter the server URL (e.g., http://na.m2mop.net/device/msci)
Indicate (in minutes) how often the device communicates to AirLink Management Services.
*AMS_SERVER
*AMS_INTERVAL
*AMS_ACCOUNT
*AMS_IDENTITY
*AMS_STATUS
*AMSCHECKIN
Enter the registered company name in AirLink Management Services.
Report the identity of the device name on AirLink Management Services.
Display the last known status of the AirLink Management Services connection.
Prompts the device to send a heartbeat message to AirLink Management Services. Once
AirLink Management Services receives the heartbeat message, it can respond and send an
AT Command to the device.
262 4112515
Low Power
Table F-17: Services > Low Power Commands
Command Description
VLTG
PTMR
SISE
Set or query the voltage level at which the device goes into low power mode.
•
n=0 : Ignore voltage for power control.
•
n=threshhold in tenths of volts
Example: ATVLTG=130 would place the device in a low power use, standby state if the voltage goes below 13.0V.
Number of minutes after the VTLG power down event happens until the device enters the low power mode. If VLTG is 0 (zero), this setting does nothing.
•
n=0–255 minutes
Note: There is always a minimum of 1 minute between power down event and actual shutdown (to give the device time to prepare); entering zero will not power down the device immediately.
Standby Ignition Sense Enable: the AirLink device will monitor the ignition sense on the power connector and enter the low power consumption stand-by mode when the ignition is turned-on (Enabled).
•
n=0 : Disabled (default)
•
n=1 : Enabled
Rev. 6 May.13
263
ALEOS User Guide
Dynamic DNS
Table F-18: Services > Dynamic DNS Commands
Command Description
*dyndns
*MODEMNAME
Configures the Dynamic DNS service.
•
n=0 : Disable (default)
•
n=2 : dyndns.org
•
n=5 : noip.org
•
n=6 : ods.org
•
n=8 : regfish.com
•
n=9 : tzo.org
•
n=10 : IP manager
Name of the device (up to 20 characters long) to use when performing IP address change notifications to IP Manager. The value in *DOMAIN provides the domain zone to add to this name.
•
name=device name (for example, mydevice)
Example: If *deviceNAME=mydevice and *DOMAIN=eairlink.com, then the device's fully qualified domain name is mydevice.eairlink.com.
Automatically Generated Names:
•
#I3 — The ESN/IMEI will be used as the name.
•
#CCID — The CCID will be used as the name.
•
#NETPHONE — The phone number will be used as the name.
Tip:
Each device using IP Manager needs a unique name. I.e., two devices cannot both be called “mydevice”. One could be named “mydevice1” while the other could be named
“mydevice”.
*DOMAIN
*IPMANAGER1
*IPMANAGER2
Domain (or domain zone) of which the device is a part. This value is used during name resolutions if a fully qualified name is not provided and also for DNS updates. This value can be up to 20 characters long.
•
name=domain name (i.e. eairlink.com)
If *DOMAIN=eairlink.com, then when ATDT@remote1 is entered, the fully qualified name remote1.eairlink.com will be used to perform a DNS query to resolve the name to an IP address.
Tip:
Only letters, numbers, hyphens, and periods can be used in a domain name.
Sets a domain name or IP address to send IP change notifications to. Up to two independent IP Manager servers can be set, using either AT*IPMANAGER1 or
AT*IPMANAGER2. Updates to a server can be disabled by setting that entry to nothing (e. g., “AT*IPMANAGER1=”).
•
n=1 : First IP Manager server.
•
n=2 : Second IP Manager server.
264 4112515
Table F-18: Services > Dynamic DNS Commands (Continued)
Command Description
*IPMGRUPDATE1
*IPMGRUPDATE2
*IPMGRKEY1
*IPMGRKEY2
Sets the number of minutes to periodically send an IP update notification to the corresponding server. This will occur even if the IP address of the device does not change.
*IPMGRUPDATE1 is used to set the refresh rate to *IPMANAGER1, while
*IPMGRUPDATE2 is used with *IPMANAGER2. If the value is set to 0, then periodic updates will not be issued (i.e., IP change notifications will only be sent when the IP actually changes).
•
n=1 : First IP Manager server.
•
n=2 : Second IP Manager server.
•
m=0, 5–255 : Number of minutes to send an update.
Sets the 128-bit key to use to authenticate the IP update notifications. If the key's value is all zeros, a default key will be used. If all the bytes in the key are set to FF, then no key will be used (i.e., the IP change notifications will not be authenticated). AT*IPMGRKEY1 is used to set the key to use with AT*IPMANAGER1, while AT*IPMGRKEY2 is used to the key with
AT*IPMANAGER2.
•
n=1 : First IP Manager server.
•
n=2 : Second IP Manager server.
•
key=128-bit key in hexadecimal [32 hex characters]
Rev. 6 May.13
265
ALEOS User Guide
SMS
Table F-19: Services > SMS Commands
Command Description
*securemode
This AT command enables/disables Services.
"AT*securemode=value"
0 — Will be the default, and leave the modem in its normal open state.
1 — Will disable the Aleos Ports for OTA and Wi-Fi access
2 — Will disable the Aleos Ports for OTA and Local Access+ Wi-Fi (All)
3+ — All values larger than 2 will receive an error response.
*SMSM2M
*SMSM2M_8
*SMSM2M_u
*SMSM2M_T
The DHCP and the Telnet ports will not be blocked.
Responses to outgoing Aleos message that are sent OTA will be allowed into Aleos, so
GPS and DNS will work.
*SMSM2M is the command for ASCII text.
*SMSM2M_8 is the command for 8-bit data.
*SMSM2M_u is the command for unicode.
Format:
*smsm2m=”[phone][ascii message]”
*smsm2m_8=”[phone][hex message]”
*smsm2m_u=”[phone][hex message]”
*smsm2m_T=”[phone][address type] message”
[address type] is 2 digits. The first is the address type, the second is the address plan. See
SMS Address Type and Address Numbering Plan on page 107 for details.
Note: The phone number can only consist of numbers (NO spaces or other characters).
The phone number should be as it appears in the Last Incoming Phone Number field.
• Example 1 (US): 14085551212 (including leading 1 and area code)
• Example 2 (US): 4085551212 (ignore leading 1, include area code)
• Example 3 (UK): 447786111717 (remove leading 0 and add country code)
Command Examples:
*smsm2m=”18005551212 THIS IS A TEST” sends in ASCII.
*smsm2m_8="17604053757 5448495320495320412054455354" sends the message “THIS IS A TEST” as 8-bit data.
*smsm2m_u="17604053757
000102030405060708090a0b0c0d0e0f808182838485868788898A8b8c8d8e8f" sends the bytes:
00 01 02 03 04 05 06 07 08 09 0a 0b 0c 0d 0e 0f
80 81 82 83 84 85 86 87 88 89 8a 8b 8c 8d 8e 8f
Note: Not all cellular carriers support 8-bit or unicode SMS messages.
*SMS_PASSWORD
*CGSMS=n
This AT command adds password security to SMS. The password can be both set and queried.
This AT command allows you to change the radio module configuration to enable SMS.
“AT*CGSMS=n” n values are 0, 1, 2, or 3.
266 4112515
Telnet/SSH
Table F-20: Services > Telnet/SSH Commands
Command Description
*TSSH
*TPORT
*TELNETTIMEOUT
E
*SNMPPORT
*SNMPSECLVL
*SNMPTRAPDEST
*SNMPCOMMUNITY
.AT command access mode. Telnet is the default.
Sets or queries the port used for the AT Telnet server. If 0 is specified, the AT Telnet server will be disabled. The default value is 2332.
•
n=0 : Disabled.
•
n=1–65535
Many networks have the ports below 1024 blocked. It is recommended to use a higher numbered port.
Telnet port inactivity time out. By default, this value is set to close the AT telnet connection if no data is received for 2 minutes.
•
n=minutes
Toggle AT command echo mode.
•
n=0 : Echo Off.
•
n=1 : Echo On.
With more than one connection types (serial, and Telnet, and USB) the echo command can be set differently on each interface.
This controls which port the SNMP Agent listens on.
•
n=0 : SNMP is disabled
•
n=1–65535
Selects the security level requirements for SNMP communications.
•
n=0 : No security required. SNMPv2c and SNMPv3 communications are allowed.
•
n=1 : Authentication equivalent to “authNoPriv” setting in SNMPv3. SNMPv3 is required to do authentication, SNMPv2c transmissions will be silently discarded.
•
n=2 : Authentication and encryption equivalent to “authPriv”' setting in SNMPv3.
SNMPv3 is required to do authentication and encryption, SNMPv2c and SNMPv3 authNoPriv transmissions will be silently discarded. Messages are both authenticated and encrypted to prevent a hacker from viewing its contents.
Controls destination for SNMP Trap messages. If the port is 0 or the host is empty, traps are disabled. Traps are sent out according to the SNMP security level (i.e., if the security level is
2, traps will be authenticated and encrypted). Currently, the only trap that can be generated is linkup.
•
host=IP address
•
port=TCP port
The SNMP Community String acts like a password to limit access to the device’s SNMP data.
•
string =string of no more than 20 characters (default = public).
Rev. 6 May.13
267
ALEOS User Guide
Email (SMTP)
Table F-21: Services > Email (SMTP) Commands
Command Description
*SMTPRADDR
*SMTPFROM
*SMTPUSER
Specify the IP address or Fully Qualified Domain Name (FQDN) of the SMTP server to use.
•
d.d.d.d=IP Address
•
name=domain name (maximum: 40 characters).
Sets the email address from which the SMTP message is being sent.
•
email=email address (maximum: 30 characters).
The email account username to authenticate with the SMTP server (*SMTPADDR) for sending email.
•
user=username (maximum: 40 characters).
*SMTPPW
Note: Not required to use SMTP settings but may be required by your cellular carrier.
Sets the password to use when authenticating the email account (*SMTPFROM) with the server (*SMTPADDR).
•
pw= password
Note: Not required to use SMTP settings but may be required by your cellular carrier.
*SMTPSUBJ
Allows configuration of the default Subject to use if one isn't specified in the message by providing a “Subject: xxx” line as the initial message line.
•
subject=message subject
268 4112515
Time (SNTP)
Table F-22: Services > Time (SNTP) Commands
Command Description
*SNTP
*SNTPADDR
Enables daily SNTP update of the system time.
•
n=0 : Off
•
n=1 : On
SNTP Server IP address, or fully-qualified domain name, to use if *SNTP=1. If blank, time.nist.gov is used.
•
d.d.d.d=IP address
•
name=domain name
GPS
The GPS group includes commands specific to GPS features and the device line.
Server 1 — Server 4
Table F-23: GPS > Server 1 — Server 4 Commands
Command Description
*PPTIME
GPS Report Time Interval. See also *PPMINTIME, *PPTSV, +CTA.
n=seconds (1–65535)
Note: Your cellular carrier may impose a minimum transmit time.
*PPDIST
Note: A report time of less than 30 seconds may keep an RF link up continuously, tying up an RF resource to transfer small amounts of data. Generally, the RF channel is released and goes dormant in 10-20 seconds if no data is sent or received.
GPS Report Distance Interval in 100 Meter Units (kilometer). One mile is approximately
1.61 kilometers.
•
n=0 : Disabled
•
n=1–65535
Rev. 6 May.13
269
ALEOS User Guide
Table F-23: GPS > Server 1 — Server 4 Commands (Continued)
Command Description
*PPTSV
Timer for Stationary Vehicles. Time interval in minutes that the device will send in reports when it is stationary.
•
n=0 : Disabled
•
n=1–255 minutes
For example, if *PPTIME=10, the device will send in reports at least once every 10 seconds while it is moving; however, once it stops moving, it will slow the reports down to this
*PPTSV value.
Note: In order for the PPTSV (Stationary Vehicle timer) to take effect, the PPTIME value must be set to a value greater than 0 and less than the PPTSV value. The PPTSV timer checks for vehicle movement at the PPTIME interval, so if PPTIME is disabled, then
PPTSV will also be disabled.
*PPINPUTEVT
*PPGPSR
*PPIP
*PPORT
*PPMINTIME
Enable sending input changes as events (different report types).
•
n=0 : Disable
•
n=1 : Enable
GPS report type.
•
n=0 : Use legacy reports specified in *MF value. Note: Must also have *PPDEVID=0.
•
n=0x11 : Standard GPS Report
•
n=0x12 : Standard GPS Report + UTC Date
•
n=0x13 : Standard GPS Report + UTC Date + RF data
•
n=0xD0 : Xora reports.
•
n=0xE0 : GGA and VTG NMEA reports
•
n=0xE1 : GGA, VTG and RMC NMEA reports
•
n=0xF0 : TAIP reports
•
n=0xF1 : Compact TAIP data
IP address where GPS reports are sent (ATS Server IP). See also *PPPORT.
•
d.d.d.d=IP address
Example:
*PPIP=192.100.100.100
Port where GPS reports are sent.
•
n=1–65535
Specifies the minimum amount of time between reports generated due to either the time interval (*PPTIME) or the distance interval (*PPDIST). This is useful to limit network traffic and make more efficient use of bandwidth. This can be used in conjunction with store and forward. The minimum value which this setting can take depends on the policies of the carrier.
•
n=0 : Disable
•
n=1 – 65535 seconds
270 4112515
Table F-23: GPS > Server 1 — Server 4 Commands (Continued)
Command Description
*PPSNF
*PPSNFB
*PPSNFM
*PPSNFR
*PPMAXRETRIES
*PPSIMPLETO
*PPODOM
*PPREPORTINPUTS
Store and Forward will cause GPS reports to be stored up if the MP goes out of network coverage. Once the vehicle is in coverage the GPS reports will be sent en masse to the server.
•
n=0 : Disabled
•
n=1 : Enabled (default)
Store and Forward Behavior. When *PPSNF=1, the type of Store and Forward behavior is defined by:
•
n=0 : Normal Store and Forward. Data is stored when the MP is out of cellular coverage; when the MP is in coverage, data is sent to server as soon as possible. This is the default form devices with RAP version 1.3 or lower.
•
n=1 : Data sent only when polled. Data is stored until polled using the Poll command sent by a server.
•
n=2 : Grouped Reports. Data is stored until the desired minimum number of reports
(see *PPSNFM) has been stored. The data is then sent to the server in groups with at least the specified number of reports.
Store and Forward Minimum Reports. Specifies the minimum number of reports that must be stored before they are forwarded to the server. The data is then sent to the server in packets that contain at least this number of reports.
•
n=0–255
Store and Forward Reliability: GPS reports will be retransmitted if not acknowledged by the server.
•
n=0 : Disabled
•
n=1 : Reliable mode enabled for RAP messages
•
n=2 : Simple reliable mode
Maximum number retries when in Simple Reliable Mode.
•
n=0 : Disabled
•
n=1–255 retries
Defines the linear back-off base number.
•
n=0 : Disable
Enable odometer reporting.
•
n=0 : Disabled (default)
•
n=1 : Enabled
Enable input reporting and include digital input value in reports.
•
n=0 : Disabled
•
n=1 : Enabled
Note: If both AT*PPCOM1000=1 and AT*PPREPORTINPUTS=1 are enabled, the AirLink
Device digital inputs will be reported and the COM1000 inputs will be ignored.
Rev. 6 May.13
271
ALEOS User Guide
Misc
Table F-24: GPS > Misc Commands
Command Description
*PPGPSDATUM
*UDPRGPS
Specifies the GPS datum to use for position reports. For accurate results, this value should match the datum used by receiving mapping application
•
n=0 : WGS84
•
n=92 : NAD27
•
n=115 : NAD83
Set or query GPS stamping of UDP Reliable packets. When set, data received on the host serial port will be encapsulated with the GPS date and time.
•
n=0 : Disabled (default)
•
n=1 : Enabled
Local/Streaming 1
Table F-25: GPS > Local/Streaming Commands
Command Description
*PGPS
*PGPSR
*PGPSF
Send NMEA GPS strings out serial link. Similar to ATGPS except that the *PGPS value can be saved to NVRAM so that it will continue to operate after resets.
•
n=0 : Disabled
•
n=1 : Send NMEA GPS strings out serial link.
•
n=2 : Send NMEA GPS strings out the USB port.
•
n=3 : Send NMEA GPS strings out both the serial and the USB port.
GPS report type.
•
n=0 : Use legacy reports specified in *MF value. Note: Must also have *PPDEVID=0.
•
n=0x11 : Standard GPS Report
•
n=0x12 : Standard GPS Report + UTC Date
•
n=0x13 : Standard GPS Report + UTC Date + RF data
•
n=0xD0 : Xora reports.
•
n=0xE0 : GGA and VTG NMEA reports
•
n=0xE1 : GGA, VTG and RMC NMEA reports
•
n=0xF0 : TAIP reports
•
n=0xF1 : Compact TAIP data
Persistent GPS frequency
•
n= number of seconds per report
Max Value: 65535 up to 18 hours
272 4112515
Table F-25: GPS > Local/Streaming Commands (Continued)
Command Description
*PGPSC
*PGPSD
Allows a PP to be configured to send GPS sentences out of the serial port when the PP loses cellular coverage. This feature is configured by 2 fields. This command controls the status of the sentences.
•
n=0: Always sent
•
n=1: Sent when out of cellular coverage
When set to 1, no reports are saved in SnF.
PGPSD is a 16-bit value that is the number of seconds to wait when “Out of
Coverage” occurs before switching to, sending the messages out the serial port and not into
SnF.
•
Any messages put into SnF during this switch-over delay period will be sent OTA, when coverage is re-acquired.
Note: The two persistent GPS report parameters, *PGPSR and *PGPSF, will control the report type and frequency of the messages sent out the serial port, when out of coverage.
*PPLATS
*PPLATSR
*PPLATSEXTRA
Local ATS — Causes GPS reports to also be sent out the serial or Ethernet link every n seconds, when there is a PPP connection to the serial host or a connection to the Ethernet port is established.
•
n=0 : Disable
•
n=1–255 seconds
Tip:
Sends to the PPP peer IP S110 with the Destination Port number S53.
Indicates the type of GPS report to send to the local client (PPP/SLIP peer). See *PPGPSR.
•
n=0x11 : Standard GPS Report
•
n=0x12 : Standard GPS Report + UTC Date
•
n=0x13 : Standard GPS Report + UTC Date + RF data
•
n=0xD0 : Xora reports.
•
n=0xE0 : GGA and VTG NMEA reports
•
n=0xE1 : GGA, VTG and RMC NMEA reports
•
n=0xF0 : TAIP reports
•
n=0xF1 : Compact TAIP data
Have local ATS reporting (LATS) send up to 7 extra copies of a GPS report to the subsequent ports.
•
n=0 : Just the original report is sent (default).
•
n=1–7 : Send GPS report copies to that number of ports.
Example: If AT*PPLATSEXTRA=7 and the port in S53 is 1000, then GPS reports will be sent to ports 1000–1007.
Rev. 6 May.13
273
ALEOS User Guide
Table F-25: GPS > Local/Streaming Commands (Continued)
Command Description
*PPREPORTINPUTS
Enable input reporting and include digital input value in reports.
•
n=0 : Disabled
•
n=1 : Enabled
*PPDEVID
Note: If both AT*PPCOM1000=1 and AT*PPREPORTINPUTS=1 are enabled, the AirLink
Device digital inputs will be reported and the COM1000 inputs will be ignored.
Whether or not the MP should include the 64-bit device ID in its GPS reports. *PPDEVID
MUST be 1 if the device uses a Dynamic IP.
•
n=0 : Disable ID.
•
n=1 : Enable/display ID.
Global Settings
Table F-26: GPS > Global Settings Commands
Command Description
*PPODOMVAL
*PPTAIPID
*PPFLUSHONEVT
*PPDEVID
*PPTCPPOLL
DAE
*HOSTMODE?
The current odometer value (in meters) of the device. Maximum value is approximately 4.3 billion meters (2.5 million miles). 1 mile is approximately 1600 meters.
•
n=meters
Sets/queries the TAIP ID. This ID is returned in TAIP reports if it has been negotiated with the TAIP client. This value is only used in conjunction with TAIP emulation mode
(*PPGPSR=F0).
•
nnnn=TAIP ID (4 characters)
Sends store and forward buffer immediately when an input event (DTR/RTS) occurs.
•
n=0 : Disable
•
n=1 : Enable
Whether or not the MP should include the 64-bit device ID in its GPS reports. *PPDEVID
MUST be 1 if the device uses a Dynamic IP.
•
n=0 : Disable ID.
•
n=1 : Enable/display ID.
Specifies the port to listen on for TCP GPS report polling. The request to this port needs to come from the same IP address in *PPIP.
•
n=0 : Disabled
•
n=1–65535 (default 9494)
AT Escape Sequence detection.
•
n=0 : Enable
•
n=1 : Disable
The current host mode (AT, PPP, UDP, etc.). If the device is not in AT mode, Telnet into the device to execute this command.
274 4112515
Serial
Table F-27: Serial > Port Configuration Commands
Command Description
MD
*S23
Default power-up mode for the serial port: When the device is power-cycled, the serial port enters the mode specified by this command after 5 seconds. On startup, typing ATMD0 within 5 seconds changes the mode to normal (AT command) mode. See also S53 to set the port for UDP.
•
hh (hex byte)=00 : Normal
•
hh=01 : SLIP
•
hh=02 : PPP
•
hh=03 : UDP
•
hh=04 : TCP
•
hh=07 : PassThru
•
hh=0F : MP MDT
•
hh=13 : Modbus ASCII
•
hh=23 : Modbus RTU (Binary)
•
hh=33 : BSAP
•
hh=63 : Variable Modbus
•
hh=73 : Reliable UDP
•
hh=83 : UDP Multicast
Configure Serial Port
Format: [speed],[data bits][parity][stop bits]
Valid speeds are 300–115200, data bits: 7 or 8, parity: O,E,N,M, stop bits: 1,1.5,2
\Q
Serial Port Flow Control
E
S50
S51
*DPORT
Set or query the serial port flow control setting. n=0 : No flow control is being used.
n=1 : RTS/CTS hardware flow control is being used. n=4 : Transparent software flow control. Uses escaped XON and XOFF for flow control.
XON and XOFF characters in data stream are escaped with the @ character (0x40). @ in data is sent as @@.
Toggle AT command echo mode.
•
n=0 : Echo Off.
•
n=1 : Echo On.
With more than one connection types (serial, and Telnet, and USB) the echo command can be set differently on each interface.
Data forwarding idle time-out. If set to 0, a forwarding time-out of 10ms is used. Used in
UDP or TCP PAD mode.
•
n=tenths of a second
PAD data forwarding character. ASCII code of character that will cause data to be forwarded. Used in UDP or TCP PAD mode.
•
n=0 : No forwarding character.
The device's Device Port which the device is listening on for inbound packets/data/polls.
Can also be set with the command S110.
•
n=1–65535
Rev. 6 May.13
275
ALEOS User Guide
Table F-27: Serial > Port Configuration Commands (Continued)
Command Description
S53
This AT Command applies to:
•
Destination Address
•
Destination Port
•
Default Dial Code
&S
&C
+CTSE
&D
Q
Destination IP address, port, and method. These are used as defaults for the D (Dial) AT command.
•
method= P : UDP
•
method=T : TCP
•
method=N : Telnet
•
d.d.d.d=IP address or domain name
•
ppppp=the port address
Examples:
ATS53=T192.168.100.23/12345
ATS53=foo.earlink.com
Telnet to the specified IP at port 12345.
ATS53=192.168.100.23/12345
Query the specified IP at port 12345.
ATS53=/12345
Query port 12345.
Set DSR mode.
•
n=0 : Always assert DSR (Default).
•
n=1 : Assert DSR when in a data mode (UDP, TCP, PPP, or SLIP) (Default).
•
n=2 : Assert DSR when the device has network coverage.
S211 can also be used to request that DSR is always asserted. If S211 is set to 3 and &S is changed to a non-zero value, S211 will be changed to 1.
Assert DCD
Clear To Send Enable: This feature asserts CTS when there is a network connection.
•
n=0 : Disabled (Default).
•
n=1 : Enable assertion of CTS when there is network coverage.
RS232 voltage levels:
•
Positive = Network coverage.
•
Negative = No coverage.
Flow control (AT\Q) will override this indication, so if you want to use CTS to indicate network coverage, flow control has to be off (AT\Q0).
Set DTR mode. n=0 : Ignore DTR, same effect as HW DTR always asserted (same as S211=1). n=2 : Use hardware DTR (same as S211=0).
The AT quiet-mode setting. If quiet mode is set, there will be no responses to AT commands except for data queried.
•
n=0 : Off (Default).
•
n=1 : Quiet-mode on.
276 4112515
Table F-27: Serial > Port Configuration Commands (Continued)
Command Description
V
X
*NUMTIOP
*DATZ
IPL
S0
Command Response Mode.
•
n=0 : Terse (numeric) command responses
•
n=1 : Verbose command responses (Default).
Call Progress Results mode
•
n=0; Off (Default)
•
n=1; On
Converts 12-digit number to an IP address
For example, converts 111222333444 to 111.222.333.444
Enables or disables reset on ATZ.
•
n=0 : Enable Reset (Default).
•
n=1 : Disable Reset on ATZ.
Allows access to the Modbus IP address list using the first two digits of the dial string. E.g.,
ATD12345 would imply ID index 12 on the Modbus address list and use the associated IP address as the destination.
This register determines how the device responds to an incoming TCP connection request.
The device remains in AT Command mode until a connection request is received. DTR must be asserted (S211=1 or &D0) and the device must be set for a successful TCP connection.
The device will send a “RING” string to the host. A “CONNECT” sent to the host indicates acknowledgement of the connection request and the TCP session is established.
•
n=0 : Off (Default).
•
n=1 : On.
•
n=2 : Use Telnet server mode on TCP connections.
•
n=3 : With a Telnet connection, overrides the client's default echo, allowing the server on the host port to perform the echo. CRLF sequences from the telnet client will also be edited to simply pass CRs to the server on the host port.
S7
TCPT
TCPS
S60
S221
TCP Connect Timeout
Sets the number of seconds to try to establish an outbound TCP connection
Interval to terminate a TCP connection when no in or outbound traffic. This value affects only the TCP connection in TCP PAD mode.
•
n=interval
TCP connection time-out (TCPS) units. Specifies a time interval upon which if there is no in or outbound traffic through a TCP connection, the connection will be terminated.
•
n=0 : minutes
Telnet Client Echo Mode.
•
n=0 : No Echo
•
n=1 : Local Echo (Default)
•
n=2 : Remote Echo
Connect Delay: Number of seconds to delay the “CONNECT' response upon establishing a
TCP connection. OR Number of tenths of seconds to delay before outputting ENQ on the serial port after the CONNECT when the ENQ feature is enabled.
•
n=0–255
Rev. 6 May.13
277
ALEOS User Guide
Table F-27: Serial > Port Configuration Commands (Continued)
Command Description
*ENQ
S82
S83
UDPLAST
AIP
Outputs an ENQ [0x05] after the TCP CONNECT delayed by the Delay Connect Response time (S221).
•
n=0 : Disabled (Default).
•
n=1 : Enable ENQ on CONNECT.
Enables UDP auto answer (half-open) mode.
•
n=0 : Normal mode
•
n=2 : Enable UDP auto answer mode.
Set or query UDP auto answer idle time-out. If no data is sent or received before the timeout occurs, the current UDP session will be terminated. While a session is active, packets from other IP addresses will be discarded (unless *UALL is set).
•
n=0 : No idle time-out (Default).
•
n=1–255 : Time-out in seconds.
If enabled, sets S53 to the last accepted IP address through UDP auto answer. This can be used in conjunction with MD3 so that when there is no UDP session, new ethernet host data will cause a connection to be restored to the last IP accepted through UDP auto answer.
•
n=0 : Does not change S53 setting. (Default).
•
n=1 : Set S53 to the last accepted IP.
Allow IP address.
•
n=0 : Allow only the IP address specified in S53 to connect when UDP auto answer is enabled (S82=2).
•
n=1 : Allow any incoming IP address to connect when UDP auto answer is enabled
(S82=2).
Always subject to any Friends filters that may be defined.
*UALL
HOR
Accepts UDP packets from any IP address when a UDP session is active. If there is no UDP session active, an incoming UDP packet will be treated according to the UDP auto answer and AIP settings.
•
n=0 : No effect (Default).
•
n=1 : Accept UDP data from all IP addresses when in a UDP session.
Half-Open Response — In UDP auto answer (half-open) mode.
•
n=0 : No response codes when UDP session is initiated.
•
n=1 : RING CONNECT response codes sent out serial link before the data from the first UDP packet.
*DU
Note: Quiet Mode must be Off.
The dial command always uses UDP, even when using ATDT.
•
n=0 : Dial using the means specified (default).
•
n=1 : Dial UDP always, even when using ATDT.
Note: When this parameter is set you cannot establish a TCP PAD connection.
278 4112515
Table F-27: Serial > Port Configuration Commands (Continued)
Command Description
*USD
S211
Waits the specified delay before sending the first UDP packet and the subsequent UDP packets out to the port Ethernet.
•
n=0 : No UDP packet delay (Default).
•
n=1–255 : Delay in 100ms units, from 100 ms to 25.5 sec.
For applications or situations where hardware control of the DTR signal is not possible, the device can be configured to ignore DTR. When Ignore DTR is enabled, the device operates as if the DTR signal is always asserted.
•
n=0 : Use hardware DTR. (default).
•
n=1 : Ignore DTR.
•
n=3 : Ignore DTR and assert DSR. This value is deprecated, and it is recommended to use &S to control the DSR instead. When this value is set to 3, &S will automatically be set to 0. See also: &D and &S.
D[method] [d.d.d.d]
[/ppppp] or
D[method] [[@]name]
[/ppppp]
Dial a connection to a remote IP and Port using either UDP, TCP, or Telnet.
method =
P — Establish a UDP connection
T — Establish a TCP connection
N — Establish a Telnet connection
d.d.d.d = IP address to establish connection to
name = domain name to establish connection to
ppppp = IP port to establish connection to
Examples:
ATD — Dial (establish) default connection per S53
ATDPnnn.nnn.nnn.nnn[/ppppp] — Dial (establish) UDP session to the specified IP address/port.
If the method, IP address, or port is omitted, the values from S53 are used. If a
Telnet connection is requested (N) and the port is not supplied, port 23 will be used instead of the value from S53.
Several special dialing numbers exist to make it easy to establish a PPP or SLIP connection with the modem. ATD#19788 or ATDT#19788 will establish a PPP connection (see \APPP), and ATDT#7547 will establish a SLIP connection (see
\ASLIP).
If a domain name is specified, the ‘@’ symbol can be used to explicitly indicate the start of the name. For example, if “ATDPHONY” is issued, this will be interpreted as dial a UDP connection to “HONY”. To dial using the default method to host
“PHONY”, one would issue “ATD@PHONY”.
To end the connection, issue the +++ escape sequence or drop the DTR line (if
Ignore DTR S211=0 or &D2).
Note: The source port of the session is the Device Port (set by S110 or *DPORT).
Rev. 6 May.13
279
ALEOS User Guide
MODBUS Address List
Table F-28: Serial > MODBUS Address List Commands
Command Description
Decimal[0xHex]=...
Index is decimal. Prefix index with 0x for hex index. 10=... is the same as 0xA=...
Applications
Garmin
Table F-29: Applications > Garmin Commands
Command Description
*GARMINSATTACH
*GARMINSTATUS
Enable attached Garmin GPS device.
Status of the externally connect Garmin device.
•
Not connected
•
Not connected/not reporting
•
Connected/not reporting
•
Not enabled
I/O
I/O includes configuration commands for the digital inputs and relay outputs.
Some values shown as a part of this group are not changeable but reflect the current status. Only those devices with available inputs and outputs will display this group.
Current State
Table F-30: I/O > Current StateCommands
Command Description
*DIGITALIN1
*DIGITALIN2
*DIGITALIN2
*DIGITALIN4
*RELAYOUT1
*RELAYOUT2
Query individual digital inputs. The digital inputs report either a 0 (open) or 1 (closed).
•
n=1–4 Input number
Set or query the relay outputs.
•
n=1–2 Input number
•
s=OPEN or CLOSED
280 4112515
Admin
Table F-31: Admin > Advanced Commands
Command Description
*DATE
Queries the internal clock. Either the date and time can be specified, or just one of the two, in which case the unspecified value will remain unchanged. The date and time are always specified in a 24-hour notation. mm/dd/yyyy=date in month/day/year notation hh:mm:ss=time in 24-hour notation
Note: In AirLink devices, the GPS is used to set the time, and any date/time specified by this command will be ignored.
*OPRG
*MSCIUPADDR
*MSCIUPDPERIOD
*POWERIN
*BOARDTEMP
*BLOCK_RESET_CONFIG
Enables/disables over-the-air firmware upgrading of the MP. When Sierra Wireless releases a new version of ALEOS, you can upgrade your remote devices with OPRG enabled.
•
n=0 : Disables
•
n=1 : Enables
Device Status Update Address — where Name/Port is the domain name and port of the machine where the device status updates will be sent. The status parameters of the device are sent in an XML format.
•
name=domain name
•
port=port
Device Status Update Period — where n defines the update period in seconds.
•
n=0 : Disabled
•
n=1–255 seconds
The voltage input to the internal hardware.
Board temperature (Not available on all devices)
Blocks the function of the device reset button.
0= Reset button causes a configuration reset (default).
1= Reset button is blocked.
Rev. 6 May.13
281
ALEOS User Guide
Radio PassThru
Table F-32: Admin > Radio Passthru Commands
Command
*PTINIT
*PTREFRESH
*RESETPERIOD
*CSX1
Description
Any AT Command string to be passed to the OEM module before entering PASSTHRU mode, e.g. AT&S1V1, etc.
•
string=AT command(s)
Number of minutes of inactivity in PASSTHRU mode to resend the *PTINIT string to the hardware module.
•
n=0: Disabled
•
n=1–255 minutes
In PASSTHRU mode, device will be reset after this period if no data has been sent or received. Value is in hours.
•
n=0: Disabled
•
n=1–255 hours
PassThru Echo: Echo data to the host.
•
n=0: Data will be passed to the host.
•
n=1: PASSTHRU mode will echo all host received data and will not pass the data to the device while the device is not asserting DCD.
Note: If the device is asserting DCD, data will be passed from the host to the device as it normally is when *CSX1=0.
282 4112515
Log
This group includes commands specific to the internal log.
Table F-33: Admin > Log Commands
Command
*DBGPPPLVL
*DBGIPLVL
*DBGCOMMLVL
*DBGETHLVL
*DBGDHCPLVL
Description
Sets the logging level for the PPP stack.
•
n=0: No logging
•
n=1: Log client events (default)
•
n=2: Log server events
•
n=3: Log client and Server events
Sets the logging level for the IP subsystem.
•
n=0: No logging
•
n=1: Log errors (i.e. invalid/corrupt packets, etc.).
•
n=2: Log the header of all received packets. Note that this can quickly exhaust available space for the event log.
•
n=3: Log the header of all received and sent packets. Note that this can quickly exhaust available space for the event log.
Set the logging level for the host or module COM port.
•
n=0: No logging
•
n=1: Host COM Port
•
n=2: Module COM Port
Sets the logging level for the Ethernet port.
•
n=0: No logging
•
n=1: Log errors: invalid/corrupt packets, etc.
•
n=2: Log the header of all received packets. Note that this can quickly exhaust available space for the event log.
Enable or disable internal DHCP logging.
•
n=0: No logging
•
n=1: Log DHCP events.
Miscellaneous
Table F-34: Miscellaneous Commands
Command Description
+++
AT Escape Sequence detection.
•
n=0 : Enable
•
n=1 : Disable
Rev. 6 May.13
283
ALEOS User Guide
Table F-34: Miscellaneous Commands (Continued)
Command Description
*HOSTMODE?
avms<server><interval>
The current host mode (AT, PPP, UDP, etc.). If the device is not in AT mode, Telnet into the device to execute this command.
Enables device management using AirVantage
<server> = server’s URL
<interval> = interval between heartbeat messages sent by the AirLink device (in minutes)
Recommended interval range is 15 minutes–10080 minutes (1 week).
Possible interval range is 1 minute–65000 minutes.
Set the interval to “0” to disable heartbeat messages.
When this command is entered, the AirLink device sends a heartbeat message immediately, and then waits the interval before sending another heartbeat message.
284 4112515
Download
Public link updated
The public link to your chat has been updated. You may view and manage your chat links after registration here.
Document public link
Advertisement
Key features
Remote device configuration and control
Template-based configuration for quick deployment
Comprehensive network settings management
Advanced security configuration options
Event reporting and management
Firmware updates for enhanced functionality
Frequently asked questions
You can access ACEmanager by entering http://192.168.13.31:9191 in your web browser. You can change the IP address to match the interface used to connect to the device, including Ethernet, USB, Wi-Fi, or DUN. The default login credentials are 'user' for the username and '12345' for the password.
The AirLink Device operates in different modes depending on the type of connection and communication method used. These modes include AT, PassThru, Telnet, PPP, SLIP, UDP, TCP, and more. The default mode is AT, which allows you to use AT commands to configure the device. PassThru mode allows direct access to the internal hardware, while Telnet enables remote access through a terminal emulator.
To create a template, you can use the "Download" option in ACEmanager. After selecting the desired configurations, the system will save them as a template file. You can then use this template to quickly configure other devices with the same settings using the "Upload" option.
ACEmanager provides a simple way to update firmware. You can access the "Firmware" tab, upload the correct firmware file, and then follow the on-screen instructions to complete the update process. This step will ensure your AirLink Device is running the latest version and is fully functional.