INSTALLATION

AND OPERATION
MANUAL

Model GATEWAY 3066 Beta Avenue Burnaby, B.C. V5G 4K4

Phone: 604.294.4465
Fax: 604.294.4471
Revision Rev H [email protected]
 Revision Control 2

Revision Control

Description Revision Date

Updated manual to new standard added commands B 13-Oct-09
for Wireless Serial Gateway configuration and E-VDT
configuration.
Added note for gateway power consumption C 12-Nov-09
Added legend and text formatting
Added PAD=3 mode
Updated section 6.9 to reflect RS-232 standard D 29-Jan-10
Added content to section 6.7,6.8,6.9
Added mechanism to automatically acknowledge E 02-Feb-10
PANIC/MPANIC messages when configured for DTR
Added MTIM=xx (configure MPANIC timeout value)
to commands that the gateway can accept from the
connected DCE device (fw ver 2.x)
Corrected error in description of DRVID operation F 22-Feb-10
when using modem control lines. Added note about
RXDPAGE operation, added timing diagrams.
Added documentation for AT^DSRVIBR=n G 18-Jan-11
Updated $PEVN command to include TY parameter
Updated MTIM command’s description
Corrected error in description of sequence numbers.
Added MST=xx command and related FPANIC
description
Added pendant’s over the air FW updating ability
Updated MST default value and added H 19-July-12
documentation for AT^DIST

Legend

Description Visual Example

Regular instructions Regular text will be shown in a standard font
Gateway Commands will be shown as they AT Gateway Commands will shown in
should be entered. A <CR> and <LF> is “Courier New” font, i.e. AT&W
assumed at the end of each Gateway Response from AT Gateway Commands
command. will be italicized as well, i.e. OK
Gateway output messages Gateway output messages shown in bold
Ie, $PEVN,0013A20040111213,00*79

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Contents 3

1 Contents

1 Contents .................................................................................................................................................. 3
2 Overview ................................................................................................................................................. 5
3 Gateway Physical Characteristics............................................................................................................ 5
3.1 Interface .......................................................................................................................................... 5
3.2 Power .............................................................................................................................................. 5
3.3 Indicator Lights................................................................................................................................ 6
3.4 Form Factors ................................................................................................................................... 6
4 Gateway Installation ............................................................................................................................... 8
4.1 Serial Port I/O PIN Configuration .................................................................................................... 8
4.2 Typical Gateway power Consumption ............................................................................................ 9
5 Gateway Supported Devices ................................................................................................................... 9
6 Using the Gateway ................................................................................................................................ 10
6.1 General Gateway Commands ....................................................................................................... 11
6.1.1 Configuring the Serial Port (HOSTSP) .................................................................................... 11
6.1.2 Configuring the Gateway’s PAN ID (PANID) .......................................................................... 12
6.1.3 Adding a WPAN Device to the Gateway (ZBEEADDDEV…ZBEEDEV?) ................................... 12
6.1.4 Gateway ID (ATOWNID) ........................................................................................................ 13
6.1.5 Data Session Management (AUTOSESSION) ......................................................................... 13
6.1.6 Gateway Serial Connection Detection (RXDSENSE) .............................................................. 14
6.2 Using a Man Down Pendant with the Gateway ............................................................................ 14
6.2.1 Querying a Man Down Pendant’s PAN ID (RMTPANID) ........................................................ 15
6.2.2 Configuring a Man Down Pendant’s PAN ID ......................................................................... 15
6.2.3 Adding Distance Indicator (DIST) .......................................................................................... 15
6.2.4 Man Down Pendant Connection Alert (SESSIONALERT) ....................................................... 16
6.2.5 Wireless Wide Area Network (WWAN) Coverage Detection (WANCTRL, WANSTATUS) ..... 16
6.2.6 Man Down Indication on Modem Control Lines (DTRPANIC…DSRVIBR) .............................. 18
6.2.7 Updating Man Down Pendant Firmware OTA ...................................................................... 22
6.3 Using a Wireless Serial Gateway (WSG) with the Gateway .......................................................... 22
6.3.1 PAD commands (PAD…PADECHO) ........................................................................................ 23
6.3.2 Transparent Mode vs. Multi-Point/Multi-Device.................................................................. 25
6.3.3 Establishing a Connection ..................................................................................................... 25
6.3.4 Temporarily Escaping the Connection (+++) ......................................................................... 26

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Contents 4

6.3.5 Detecting Lost Connections .................................................................................................. 26

6.3.6 PAD Client Device Type (Multi-Point) (PADDEVTYPE)........................................................... 26
6.3.7 Client Side Power Management (PADREGT) ......................................................................... 26
6.4 Using an Engine Vehicle Diagnostics Transmitter (E-VDT) with the Gateway .............................. 27
6.4.1 Protocol Setting Command (OBDSP)..................................................................................... 27
6.4.2 Gateway E-VDT Report Messages ......................................................................................... 28
6.4.3 Creating E-VDT Reports (POBDA…POBDD) ........................................................................... 28
6.4.4 Displaying E-VDT Reports (SHOWPOBDA…SHOWPOBDD) ................................................... 29
6.4.5 Displaying E-VDT Parameter Value(s) (OBDPARAM?)........................................................... 29
6.4.6 E-VDT Pass through mode..................................................................................................... 29
7 NMEA Messages.................................................................................................................................... 30
7.1 NMEA Message Format ................................................................................................................ 30
7.2 Man Down Pendant Message Structure ....................................................................................... 31
7.2.1 Outbound Man Down Pendent/PPEN Messages .................................................................. 31
7.2.2 Inbound Man Down Pendant Messages (DCE to Gateway Messages) ................................. 31
7.2.3 Man Down Pendant Sequence Numbers .............................................................................. 32
7.2.4 Round Trip Response Time ................................................................................................... 32
7.2.5 Gateway to DCE Message List ............................................................................................... 32
7.2.6 DCE to Gateway Message/Commands List ........................................................................... 35
7.3 Wireless Serial Gateway (WSG) Message Structure ..................................................................... 37
7.3.1 Device Header Description.................................................................................................... 37
7.4 E-VDT - Gateway Message Structure ............................................................................................ 38
7.5 Session Management Message Structure..................................................................................... 39
8 Appendix I ............................................................................................................................................. 40
8.1 Gateway Mechanical Drawings ..................................................................................................... 40
8.1.1 Standard Gateway................................................................................................................. 40
8.1.2 Standard Gateway (RP-SMA) ................................................................................................ 41
8.1.3 Windshield Gateway ............................................................................................................. 42
8.1.4 RP-SMA Windshield Gateway ............................................................................................... 43
8.1.5 External Mount Gateway (Internal Antenna and RP-SMA) .................................................. 44
9 OBD II/J1939 Parameter List ................................................................................................................. 45
10 Specifications and Approvals ............................................................................................................ 47
10.1 Environmental Specs..................................................................................................................... 47
11 Technical Support/Warranty............................................................................................................. 47

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Overview 5

2 Overview
The Gateway is a data terminal equipment (DTE) device that allows modems or other data
communication equipment (DCE) to communicate with WPAN (wireless personal area network) devices.
It connects to the RS-232 port of a Chameleon modem or other smart DCE (data communication
equipment), accepting and creating incoming and outgoing messages.

The Gateway accepts messages from Cypress WPAN devices such as the Man Down Pendant, Engine
Vehicle Diagnostic Transmitter (E-VDT) or the Wireless Serial Gateway (WSG). The Gateway creates and
formats messages for the attached Chameleon modem or DCE device. In most cases specific application
development will be required to process the Gateway created NMEA style messages. The Cypress
Chameleon modem has support for Gateway generated messages built in. This manual is primarily
targeted at developers who wish to create a specific application for the connected DCE device. The
Gateway can also work with devices not capable of processing serial messages by indicating alert status
on its modem control lines (Man Down Pendant Alerts only).

3 Gateway Physical Characteristics

 Gateway connects to the serial data port of data communication equipment (DCE)
 Manages connections of multiple WPAN products simultaneously
 Formats messages in an easy to read/understand ASCII message (NMEA format)
 The Gateway is available in 3 form factors: Standard, Windshield and Rooftop mount. An option to
have an external RP-SMA connection for an external antenna is available in each of the 3 form
factors.

3.1 Interface
The serial port on the Gateway is configured as a 9 pin DB-9 connection configured as a DTE device. Data
communication can achieved via RS-232 communications as well as modem control lines for Man Down
Pendant alert notifications.

The Standard Gateway is a DB-9 male connection; the Windshield and Rooftop Gateway are available
with DB-9 or un-terminated.

3.2 Power
Gateways can accept power in 3 ways: (1) DC power jack (Standard Gateway) (2) 2 separate wire
(positive/negative) leads (Windshield, Rooftop) (3) via PIN 9 of the DB-9 connection.

If powered via the DC power jack or external positive and negative leads the input supply is 5-32 Vdc.

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Gateway Physical Characteristics 6

Note: DC power jack configuration is (0.65 mm center pin (+), 2.8 mm outer body(-)).

If powered via pin 9 of the DB-9 connector, 3.9V regulated power supply should be connected between
pin 9 (positive) and pin 5 (ground).

Connector Voltage
DC power jack 5-32 Vdc
Typical DC power jack (0.65mm) used +/- wire leads 5-32 Vdc
to supply power to the Gateway Pin 9 of DB-9 3.9 V

3.3 Indicator Lights

3 green LEDs provide Gateway status: POWER, RX (receive) and TX (transmit).
The Rooftop Gateway has no indicator LEDs.

3.4 Form Factors

Standard Gateway

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Gateway Physical Characteristics 7

Windshield Gateway

Rooftop Gateway

Gateway External
DB-9 Status LEDs DC Power Jack Pin 9 power Weatherproof
Type antenna option
Standard Yes Yes Yes Yes No Yes
Windshield Yes Yes No Yes No Yes
Rooftop Yes No No Yes Yes Yes

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Gateway Installation 8

4 Gateway Installation
The three form factors of the Gateway offer a variety of mounting options. The Standard Gateway
typically mounts directly to the DB-9 port of the DCE device or modem. The Windshield Gateway is
supplied with a piece of double sided adhesive tape so the Gateway can be mounted to a vehicle
windshield for improved RF (Radio Frequency) line of sight performance. The Rooftop Gateway is a
sealed unit and can be mounted externally to a vehicle or building to provide an unobstructed view of the
surroundings. The Rooftop Gateway can be affixed with adhesive tape, screws or mirror mount bracket.
An optional sealing skirt is also available for roof mount applications.

The Gateway can be connected to the DCE device serial port via a DB-9 interface. The WPAN Serial
Gateway provides a “gateway” for communication between the various Cypress WPAN products and
other serial (DCE) data communication equipment such as wireless data modems. The Gateway is defined
as data terminal equipment (DTE) that connects to other data communications equipment (DCE) devices
via a 9 pin DB-9 connector. If the Gateway is connected to a PC, a “null modem cable” is required to
facilitate communications. The Gateway sends/receives text based (NMEA style) messages based on
communications with peripheral Cypress WPAN accessories (Man-Down Pendant, etc). The Gateway can
store customized settings for baud rate, attached devices, general configuration, etc. A maximum of 16
connected devices are supported at any one time.

4.1 Serial Port I/O PIN Configuration

DB-9 Standard Gateway Pin out (left) and tethered DB-9, Windshield and Rooftop (right) configuration

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Gateway Supported Devices 9

DB9 Pin Signal Name Direction

1 DCD Data Carrier Detect Serial Modem  Gateway
2 RxD Received Data (by DTE) Serial Modem  Gateway
3 TxD Transmitted Data (by DTE) Gateway  Serial Modem
4 DTR Data Terminal Ready Gateway  Serial Modem
5 GND Signal Ground
6 DSR Data Set Ready Serial Modem  Gateway
7 RTS Request To Send Gateway  Serial Modem
8 CTS Clear To Send Serial Modem  Gateway
9 RI +3.9 V Serial Modem  Gateway

Note: If Pin 9 on the Serial modem can be configured to deliver 3.9 Vdc ±10% then no external DC power
jack will be required.

4.2 Typical Gateway power Consumption

Voltage Input Average Current Draw Power Consumption

Ext. 12 V (via DC jack or leads) 44mA 528mW
DB9 pin 9, 3.9V 104mA 406mW

5 Gateway Supported Devices

Figure 1: Man- Figure 2: E-VDT (J1939) Figure 3: E-VDT

Figure 4: Wireless Serial Gateways (WSG)
Down Pendant (OBD II)

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Using the Gateway 10

6 Using the Gateway

The WPAN Gateway supports the following commands Page
ATZ Reload configuration from non-volatile (NV) memory -
AT&F1 Recall Factory configuration -
AT&W Save Profile -
ATIn Product Information: 0 Gateway, 1 Cypress Solutions Inc., 2 Version, 3 Build info -
ATEn Echo OFF/ON : 0 turns OFF, 1 turns ON -
ATVn Verbalize: 1 Displays result messages as English words (verbal) (default), 0 -
Displays result messages as code numbers (nonverbal).
ATQn Quiet: 0 results codes displayed (default), 1 turns off the result codes. -
A/ Repeat last command -
AT^VER? View the gateway’s firmware version -
ATO Reestablishes a connection after an escape sequence (+++) (used when the -
gateway is communicating with Wireless Serial Gateways (WSGs))
AT^HOSTSP View (AT^HOSTSP?) and configure the serial port 11
(AT^HOSTSP=bbbbbb,P,D,S)
AT^PANID View (AT^PANID?)and configure gateway PAN ID (AT^PANID=hhhh) 12

AT^ZBEEDEV? View all device IDs that are registered with the gateway 12

AT^ZBEEADDDEV Add a device ID to gateway’s device list 12

(AT^ZBEEADDDEV=hhhhhhhhhhhhhhhh)
AT^ZBEEDELDEV Delete a device ID to gateway’s device list 12
(AT^ZBEEDELDEV=hhhhhhhhhhhhhhhh)
ATOWNID? View the gateway’s device ID 13

AT^AUTOSESSION Required for E-VDT and WSG. View (AT^AUTOSESSION?) and configure 13
(AT^AUTOSESSION=n)
AT^RXDSENSE Configure gateway serial connection detection (AT^RXDSENSE=n) 14

AT^RMTPANID Queries a Man Down Pendant’s PAN ID 15

(AT^RMTPANID?hhhhhhhhhhhhhhhh)
AT^DIST Man Down Pendant. Enables distance indicator. View (AT^DIST?) and 15
configure (AT^DIST=n)
AT^SESSIONALERT Man Down Pendant. View (AT^SESSIONALERT?) and configure 16
(AT^SESSIONALERT=n)
AT^WANCTRL Man Down Pendant. Enables WANSTATUS. View (AT^WANCTRL?) and 16
configure (AT^WANCTRL=n,t)
AT^WANSTATUS Man Down Pendant. Determines if a WAN connection is established. 16
AT^WANSTATUS=n
AT^DTRPANIC Man Down Pendant. View (AT^DTRPANIC?) and configure 18
(AT^DTRPANIC=n)
AT^DTRPANICTIMEOUT Man Down Pendant. View (AT^DTRPANICTIMEOUT?) and configure 18
(AT^DTRPANICTIMEOUT=n)
AT^DTRAUTOACK Man Down Pendant. View (AT^DTRAUTOACK?) and configure 18
(AT^DTRAUTOACK=n)
AT^RXDPAGE Man Down Pendant. View (AT^RXDPAGE?) and configure (AT^RXDPAGE=n) 18

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Using the Gateway 11

AT^DSRVIBR Man Down Pendant. View (AT^DSRVIBR?) and configure (AT^DSRVIBR=n) 18

AT^PAD Sets transparent or multi-point/multi-device mode. View (AT^PAD?) and 25

configure (AT^PAD=n)
AT^PADFWDL Wireless Serial Gateway. Sets forwarding data length. View (AT^PADFWDL?) 25
and configure (AT^PADFWDL=n)
AT^PADFWDT Wireless Serial Gateway. Sets forwarding data time. View ( AT^PADFWDT?) 25
and configure (AT^PADFWDT=n)
AT^PADECHO Enable/disable PAD echo. View (AT^PADECHO?) and configure 25
(AT^PADECHO=n)
AT^PADDEVTYPE User defined device type. View (AT^PADDEVTYPE?) and configure 26
(AT^PADDEVTYPE=n)
AT^PADREGT Configure WSG registration period. View (AT^PADREGT?) and configure 26
(AT^PADREGT=p,i)
AT^OBDSP Sets protocol setting for EVDT. View (AT^OBDSP?) and configure 27
(AT^OBDSP=n)
AT^POBDA… Create EVDT reports. View (AT^POBDA?) and configure 28
AT^POBDD (AT^POBDA=n1[,n2][,n3][,n4])
AT^SHOWPOBDA… Display EVDT reports. View only (AT^SHOWPOBDA) 29
AT^SHOWPOBDD
AT^OBDPARAM? Display EVDT parameter values. View single (AT^OBDPARAM?pn) or all 29
(AT^OBDPARAM?all)
Note: All gateway AT commands must end with <CR> and <LF>

6.1 General Gateway Commands

The Gateway supports AT style commands (AT^). These commands can be entered using a terminal
windows program such as HyperTerminal®. A “null-modem” cable is required to enable communications
between a PC/laptop and the Gateway. In order to save the configuration, the AT&W command must be
used. Configuration will be lost after a power cycle if the configuration is not saved.

6.1.1 Configuring the Serial Port (HOSTSP)

AT^HOSTSP=bbbbbb,P,D,S bbbbbb is data rate,
(1200/2400/4800/9600/19,200/38,400/57,600/115,200)
P is parity, N or n=none/E or e=even/O or o=odd
D is data bits, 7/8 data bits
S is stop bits, 1/2 stop bit(s)

AT^HOSTSP=115200,N,8,1 Sets communication to 115,200bps, no parity, 8 data bits, 1 stop bit

AT^HOSTSP? Displays current parameters

The default serial port configuration for the WPAN Gateway is:
Data rate 9600 baud Stop bits 1
Data bits 8 Flwo control None
Parity None

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Using the Gateway 12

6.1.2 Configuring the Gateway’s PAN ID (PANID)

Each WPAN Device and Gateway communicates using a 4 digit hex number. The PAN ID must match
between WPAN device and Gateway in order to have any communication between devices. By default
this number is 4465 and does not normally need to be changed. The PAN ID on the Engine Vehicle
Diagnostics Transmitter can only be changed at the factory.

AT^PANID=nnnn nnnn = 4-digit PAN ID in hex (0000 to FFFE, Defaults to 4465, FFFF is reserved)

AT^PANID? Query current PAN ID.

Note: This command takes effect immediately. To save the command enter AT&W

6.1.3 Adding a WPAN Device to the Gateway (ZBEEADDDEV…ZBEEDEV?)

WPAN devices must have their device IDs registered with the Gateway to allow the device to
communicate with that specific Gateway.

AT^ZBEEADDDEV=<string> Add a new device, where <string> = device id (eg.

0013A20040440658), hyphens optional, not case
sensitive.

AT^ZBEEDELDEV=<string> Delete a device, where <string> = device id (eg.

0013A2004044066F), hyphens optional, not case
sensitive.

AT^ZBEEADDDEV=FFFFFFFFFFFFFFFF If this value is entered as a device ID, the gateway

will accept messages from any pendant in range
with the same PAN ID.
Previous device IDs entered are superseded.
Note: This command is valid for Man Down
Pendants only.

AT^ZBEEDEV? View all device IDs registered with the Gateway.

For example, to query and add a device ID:

AT^ZBEEDEV?
0013A20040531EC5

AT^ZBEEADDDEV=0013A20040531EC4
OK
AT&W (to save the configuration, otherwise settings will be lost after a reset)

AT^ZBEEDEV?
0013A20040531EC5
0013A20040531EC4

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Using the Gateway 13

6.1.4 Gateway ID (ATOWNID)

ATOWNID? Query the unique 16 digit (64 bit, Hex) gateway ID

For example:

ATOWNID?
0013A200404B959D

6.1.5 Data Session Management (AUTOSESSION)

Some WPAN devices (e.g. E-VDT and WSG) require a point to point connection to be established before
the communication can take place. This creates a communication session. Other devices such as the Man
Down Pendant do not require this connection and simply transmit data. For those devices that require a
valid session to communicate, session management can be handled by the Gateway itself
(AT^AUTOSESSION=1) or the external DCE device (AT^AUTOSESSION=0). If handled by the Gateway,
only notification messages will be output. Otherwise, the external DCE device is responsible for
acknowledging registration requests by sending $PEVA responses.

AT^AUTOSESSION=n n = 0 Disabled (Default)

n = 1 Enabled (required for EVDT and WSG)

AT^AUTOSESSION? Queries the value of autosession

Note: Autosession setting takes effect immediately after entering AT&W and a power cycle.

The following events need to be reported in the case of manual session management or Autosession=0
 Endpoint registration attempt
 Endpoint connection established
 Endpoint connection lost

Event notification will use NMEA messages in the following format:

$PEVN,ID,TY,CODE*hh<CR><LF> Generated by WPAN device

Where:
ID is the 64-bit hex address of the endpoint device
TY is the 8-bit hex value for the device type
CODE is 7-bit hex event code
hh is NMEA checksum

Event code can have the following values:

Code Description
00 Registration Attempt
01 Connection Established
02 Connection Lost

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Using the Gateway 14

$PEVA,ID,CODE*hh<CR><LF> Generated by DCE device

Where:
ID is the 64-bit hex address of the endpoint device
CODE is 8-bit hex event code with bit 7 set to 1 to allow or 0 to reject. If CODE=FF the session must be
broken
hh is NMEA checksum

For example:
$PEVN,0013A20040111213,03,00*79
If automatic session management is disabled on the Gateway, the external DCE device such as a modem
must acknowledge the above messages using the following format:

$PEVA,0013A20040111213,80*7E => Allow session establishment

$PEVA,0013A20040111213,00*76 => Reject session with the device
$PEVA,0013A20040111213,FF*76 => Close current session with this device.

6.1.6 Gateway Serial Connection Detection (RXDSENSE)

The Gateway has the capability to detect if there is a signal on the gateway RxD input line. The purpose of
this feature is to disable Gateway functionality when nothing is connected to it. When this feature is
ENABLED, the Gateway will enter low power mode if RxD is detected as "disconnected" for 10s. It will
resume normal operation if RxD is detected as “connected” for 1s. RxD line is considered “connected”
when its input voltage is +5V and above or -5V and below.

AT^RXDSENSE=n n = 0 Disabled (Default)

n = 1 Enabled

This command takes effect immediately, to save the command enter AT&W

6.2 Using a Man Down Pendant with the Gateway

Man Down Pendants have been designed to be used with a Gateway with minimal configuration. In most
cases, they can be used immediately after adding the pendant’s device ID to a gateway as follows:

AT^ZBEEADDDEV=hhhhhhhhhhhhhhhh hhhhhhhhhhhhhhhh is the pendant’s device ID. Please

ensure both the Man Down Pendant and the Gateway
are using the same PAN ID.
AT&W To save the pendant’s device ID into the gateway.

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Using the Gateway 15

6.2.1 Querying a Man Down Pendant’s PAN ID (RMTPANID)

As with all WPAN devices, the PAN ID of the Man Down Pendant must match the gateway’s in order to
communicate. If the PAN ID of a Man Down Pendant is unknown, it can be determined by the following
two step process:

1. Send the Gateway the following AT command:

AT^RMTPANID?hhhhhhhhhhhhhhhh hhhhhhhhhhhhhhhh = 64-bit hex address of the Pendant

2. Trigger the pendant to broadcast its PAN ID:

Press and hold the pendant button for ≥20 seconds until the pendant makes 2 short beeps.
Panic alert messages will still be generated during the press and hold process, this is normal.

Note: The PANID will be broadcast from the pendant. The Gateway will stay in this mode until a character
is received on its serial port. Once a character has been received, the Gateway goes back into AT
command mode.

The response should be a 4-digit hex value of the PAN ID as follows:

PANIDACKnnnn nnnn= PAN ID in hex where nnnn is a 4 digit hex number (0000-FFFE)

6.2.2 Configuring a Man Down Pendant’s PAN ID

If the Serial Gateway Chat application is available1, the following command can be sent to the pendant to
change its PAN ID:

PANID=nnnn nnnn=4-digit hex value of the new PAN ID (0000-FFFE, Defaults to 4465)

Example of PPQ message:

$PPQ,PAN,0013A200403047EE,30,PANID=4465*18

The pendant will respond with PANIDACKnnnn, and the gateway will generate something similar below:
$PPEN,0013A200403047EE,30,PANIDACK4465*45

6.2.3 Adding Distance Indicator (DIST)

If enabled, PANIC messages will include an extra message indicating the minimum distance in meters the
pendant is from the gateway in one of the following steps: 20, 50, 100, or 999. If the pendant is out of
range or the distance is greater than 100m, 999 will be returned. It cannot be used with range extenders.

AT^DIST=n n = 0 Disabled (Default)

n = 1 Enabled

Example of additional NMEA message:

$PPEN,0013A2004000DBA9,08,DIST=020*21
1
Please contact Cypress Solutions at 1-877-985-2878 for more information on how to obtain the Serial Gateway
Chat application.

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Using the Gateway 16

6.2.4 Man Down Pendant Connection Alert (SESSIONALERT)

When Session alert is enabled, the Gateway will create an “Out of Range” message when the Man Down
Pendant leaves the coverage area. A “back in range” message will be generated when the pendant
reenters the coverage area.

AT^SESSIONALERT=n n=1 If wildcard ID is configured in the Gateway, in/out of range

messages will be generated for any pendant. (Default)

n=2 If wildcard ID is configured, no in/out of range messages will be

generated unless pendant’s ID has been programmed into the
Gateway. Note that communication still works for any pendant.

n=0 Disabled

AT^SESSIONALERT? Query session status

Examples of Gateway generated messages:

$PPEN,0013A200402CB49A,2E,OUTOFRANGE*42
$PPEN,0013A200402CB49A,39,BACKINRANGE*74

6.2.5 Wireless Wide Area Network (WWAN) Coverage Detection (WANCTRL,

WANSTATUS)
In certain scenarios there may be a requirement where the DCE device communicates to the Gateway
indicating that it is in a connected state with the WAN (cellular, satellite, etc.) in order to successfully
communicate data to a monitoring server. This information then determines whether the Gateway
acknowledges Pendant’s range checks or not. WAN connection indication can be communicated to the
Gateway in two ways: Serial port AT command or setting the CTS signal level (pin 8 of RS-232).

In order to use this feature it needs to be enabled first using the WANCTRL command:

AT^WANCTRL=n,t n = 0 Disabled (Default)

n = 1 Enabled (AT Command Trigger)
n = 2 Enabled (CTS Line Trigger)

t is the watchdog timeout (seconds). If no status updates are received

within x seconds, WAN connection is assumed to be lost.
t=0 Disabled (default)
t=x x seconds
t = 255 Maximum timeout

Note: The watchdog timer is valid in WANCTRL mode 1 only. It is useful if there is a possibility of the host
device malfunctioning and leaving the Gateway in “WAN Connected” state. Also, if t parameter is
omitted, it is assumed to be 0 (WANCTRL=1 <=> WANCTRL=1,0).

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Using the Gateway 17

This command takes effect immediately, to save the command enter AT&W

AT^WANCTRL? Queries the setting

To enable the WAN connected state indicator:

AT^WANSTATUS=n n = 0 Disconnected (Default)

n = 1 Connected

The command returns OK if WANCTRL=1, otherwise it returns ERROR. This setting is not saved in non-
volatile memory.
Man Down RANGE messages will be acknowledged by the Gateway if:

WANCTRL==0
OR
WANCTRL==1,0 AND WANSTATUS=1
OR
WANCTRL==1,x AND WANSTATUS=1 AND WANSTATUS updated less than x
seconds ago (x>0)
OR
WANCTRL==2 AND CTS=Inactive

Note: CTS Active state is defined as (+3V to +15V), Inactive state is defined as (-3V to -15V)

Otherwise RANGE messages will not be acknowledged and the Man Down Pendant will indicate an out of
range condition.

Timing Diagram – WWAN Coverage Detection

Man Down RANGE message will not be acknowledged by the Gateway

CTS
+5V
(Active)

WANCTRL = 2
-5V
(Inactive)
Man Down RANGE message will be
acknowledged by the Gateway

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Using the Gateway 18

6.2.6 Man Down Indication on Modem Control Lines (DTRPANIC…DSRVIBR)

Gateways and Man Down Pendants can also be used with devices that do not support serial data
communication. For these devices, certain pins of the RS-232 port are toggled to indicate various events.

To indicate a Man Down request, the state of the DTR (pin 4) RS-232 line needs to be changed. The state
of the RTS (pin 7) line is also changed based on whether a DRVID (Driver ID) message has been triggered.

The following command is used to control this feature:

AT^DTRPANIC=n n = 0 Disabled (Default)

n = 1 Enabled

AT^DTRPANIC? Queries the current value.

Note: Active state is defined as (+5V), Inactive state is defined as (-5V)

PANIC or MPANIC operation:

1. In normal mode (no PANIC or MPANIC requests) DTR should be Active.

2. Once a PANIC or MPANIC is received, DTR is set to Inactive.
3. DTR stays Inactive until one of the following occurs:
a. CPANIC message is received from the pendant that triggered the PANIC or MPANIC state
b. DSR (pin 6) is set to Inactive state.
c. DTRPANICTIMEOUT expires

Timing Diagram – DTR Panic

DSR 3 – Host sets DSR

to inactive state 5 – Host sets DSR back to active state
+5V
(Active)

-5V
(Inactive)

1 – PANIC/MPANIC 4 – this triggers the Gateway to generate

DTR
received an ACK and reset DTR back to active
DTRPANIC +5V
(Active)

-5V
(Inactive)
2 – DTR stays inactive until one of the following occurs:
a. CPANIC message is received from the Pendant that
triggered PANIC or MPANIC state
b. DSR is set to Inactive state.
c. DTRPANICTIMEOUT expires

The Gateway sends ACKs in both cases so the pendant clears its panic state.

If more than 1 pendant sends Man Down, PANIC requests at the same time, only the first one will be
acknowledged. The next PANIC request from the second one will trigger the DTR output again.

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Using the Gateway 19

If local ACK is desired (no external modem involved), DSR can be connected to DTR.

DRVID operation:

1. In normal mode (no DRVID requests) RTS should be Active.

2. Once a DRVID is received, RTS is set to Inactive state. Note that the NMEA message still goes out
on the RxD/TxD pins (pins 2&3).
3. RTS is kept Inactive for 8 seconds and then is set to Active; the state of the CTS (pin 8) line is
ignored.

Timing Diagram – Driver ID

CTS
CTS state is ignored
+5V
(Active)

Don’t care
-5V
(Inactive)

RTS 3 – RTS line sets back to active state after 8 seconds

1 – DRVID generated
+5V
(Active)

-5V
(Inactive)
2 – RTS sets to inactive state and stays inactive for 8 seconds

The Gateway sends an ACK back as soon it receives the DRVID message.

Clearing PANIC/MPANIC:

In order to clear panic indication for situations where the Man Down Pendant goes out of range after
generating PANIC alert, a timeout can be set using the DTRPANICTIMEOUT command. If this timeout is
set, the DTR line will be cleared automatically if no communication is detected from the Man Down
Pendant that triggered the PANIC or MPANIC state.

AT^DTRPANICTIMEOUT=n Where n is the number of seconds (0-65535)

n = 0 Disables the timeout
Default value is 60.

AT^DTRPANICTIMEOUT? Returns the value for the timeout

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Using the Gateway 20

For some connected equipment without the ability to acknowledge generated PANIC/MPANIC messages
on the DSR line, the DTRAUTOACK command can be used to automatically acknowledge the
PANIC/MPANIC requests. When PANIC/MPANIC is received, the DTR line is pulsed for a period of time
and the DSR state is ignored.

AT^DTRAUTOACK=n n = 0 => DSR line is used to detect ACKs (Default)

n = 1-255 => DTR Pulse is generated for n seconds. Panic messages
are acknowledged right away.

AT^DTRAUTOACK? Returns the value for the timeout

Note: DTRPANIC feature must be enabled in order to use this feature.

Timing Diagram – DTR Panic with auto acknowledgement

DSR
DSR state is ignored
+5V
(Active)

Don’t care
-5V
(Inactive)

1 – PANIC/MPANIC 3 – DTR line sets back to active state

DTR
generated after DTRAUTOACK preset time period
+5V
DTRAUTOACK (Active)

-5V
(Inactive)
2 – DTR stays inactive until the preset DTRAUTOACK timeout
expires. The state of DSR line is ignored. Panic messages are
acknowledged right away

Paging/ATT operation:

The RxD input and TxD output lines can be used to enable the paging function of the pendant. The RxD
input is used to detect when a page is to be sent to a connected Pendant. TxD output is used to indicate
when the page was delivered to the Pendant.

TxD goes Active when ATT message is sent to the Pendant.

TxD goes Inactive as soon as ACK is received from the Pendant or if ATT times out while RxD is Inactive.

AT^RXDPAGE=n n=0 Disabled (Default)

n=1 Enabled

Note: DTRPANIC must be enabled and only one pendant/gateway is supported by this feature.

When RXDPAGE is enabled, the Gateway will constantly monitor its RxD input. When RxD is detected
active for 100ms, the TxD line is set to Active and an ATT message is sent to the ID stored as the first line
in the ZBEEDEV list. Once an ACK is received from the Pendant, TxD line is set back to Inactive. If no ACK is

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Using the Gateway 21

received within 15s and RxD is still Active, another ATT message is sent out while TxD stays Active. If no
ACK is received within 15s and RxD is Inactive, TxD is set to Inactive.

When RXDPAGE is enabled and an ATTACK message is received from the Pendant, the Gateway will
acknowledge it by setting the RTS line to Inactive state for 8 seconds.

Timing Diagram – RXD Paging

2 – TXD line is set to active and an ATT message is sent to

TXD
the ID stored as the first line in the ZBEEADDDEV list
+5V
(Active)

-5V
RXDPAGE (Inactive) 3 – ACK is received from
(No Page Retries) 1 – RXDPAGE is generated the Pendant OR no ACK
by setting the RXD line active received within 15 seconds
RXD
for >100ms
+5V
(Active)

-5V
(Inactive)

2 – TXD line is set to active and an ATT

TXD message is sent to the ID stored as the 3 – No ACK received after
+5V first line in the ZBEEADDDEV list 15 seconds, page re-sent
(Active)

-5V
(Inactive) 4 – ACK received
RXDPAGE
1 – RXDPAGE is generated
(Page Retries) RXD by setting the RXD line active
5 – Host drives RXD inactive within
+5V 1 second of TXD going inactive
(Active)

-5V
(Inactive)

Timing Diagram – RXD Page ACK

1 – RXDPAGE has
been previously generated; when the
user acknowledges the ‘page’ by
button press and hold (for 1-2s) until
the right LED blinks green, the
Gateway will set the RTS line inactive
RTS for 8s. 3 – RTS line sets back to active state after 8 seconds
+5V
(Active)
RXDPAGE

-5V
(Inactive)
2 – RTS sets to inactive state and stays inactive for 8 seconds

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Using the Gateway 22

Vibration Control:

A vibration sequence can be triggered by changing the state of the DSR RS-232 line.

AT^DSRVIBR=n n = 0 Disabled (Default)

n = 1 Enabled

Note: DTRPANIC feature must be enabled in order to use this feature.

If DSRVIBR is enabled, the Gateway will constantly monitor its DSR line. When DSR is detected at logic
high for 100ms, a VIBR message is sent to the ID stored as the first line in the ZBEEDEV list. Once an ACK is
received from the Pendant, the Gateway will wait for 1s before sensing the DSR line again. If no ACK is
received within 15s and DSR is still at logic high, another VIBR message is sent out. Note that there is no
feedback to the user whether the message was successfully received on the Pendant or not.

Note: DSR input goes through an inverter on the RS232 transceiver so voltage levels on the DB9 port are
mapped as follows:
RS232 Voltage Level Logic Level
-12V to +0.8V High(1)
+3V to +12V Low(0)

6.2.7 Updating Man Down Pendant Firmware OTA

The Man Down Pendant can now be updated over the air using Cypress’ Chameleon Pendant Upgrade
application2. In order to upgrade the firmware, the gateway must be connected directly to the user’s PC,
and the pendant’s 64-bit ID as well as its PANID must be available. The baud rate should be set to 9600.

6.3 Using a Wireless Serial Gateway (WSG) with the Gateway

The commands listed in this section refer to the configuration of the Gateway and Wireless Serial
Gateway (WSG) when used as a serial line replacement solution. The Gateway is the server connected to
the DCE device and the WSG is the client and is connected to the remote serial device (i.e. RTU).
2
Please contact Cypress Solutions at 1-877-985-2878 for more information on how to obtain the Chameleon
Pendant Upgrade application.

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Using the Gateway 23

6.3.1 PAD commands (PAD…PADECHO)

To enable this function, the PAD command is used. PAD refers to Packet Assembly and Disassembly and is
the protocol by which serial data is packetized to be sent over the wireless link. The receiving side
disassembles these packets and outputs raw serial data. There are two modes of operation of the WSG
and Gateway: Transparent Mode and Multi-Point/Multi-Device.
In Transparent PAD mode (WSG Client PAD=1 and Gateway PAD=2), serial data is buffered until a
condition is met for sending it over the wireless link. The condition can be one of the following:

1. Maximum data length reached (PADFWDL)

2. Maximum packetization timeout expired (PADFWDT)

In Multi-Point/Multi-Device mode, Gateway data is formatted into sentences in the form:

$PWPAN,ID,HeaderPayload*hh<CR><LF>

Where:
ID = 64-bit hex address of the device that sent the message
HeaderPayload = 3-byte header and variable length payload formatted as hex digits.

Messages to the WSG or client are in the form of:

$PPQ,WPAN,ID,HeaderPayload*hh<CR><LF>

Where:
ID = 64-bit hex address of the endpoint device
HeaderPayload = 3-byte header and variable length payload formatted as hex digits.

Mode Gateway (Server) WSG (Client)

Transparent PAD=2 PAD=1
Multi-point/multi-device PAD=0 PAD=1

The following diagrams illustrate the topology of the different modes:

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Using the Gateway 24

AT^PAD=n n = 0 => PAD disabled (Default)

n = 1 => PAD client enabled (transparent client mode)
n = 2 => PAD server enabled (transparent server mode)
n = 3 => PAD server mode customized to work with E-VDT (treating it like a PAD
client.) This mode allows the user to communicate directly with the E-VDT. All
gateway specific E-VDT commands/messages are disabled in this mode.

AT^PAD? Queries the current value.

AT^PADFWDL=n n is forwarding data length in characters (1-64). Default=20.

AT^PADFWDL? Queries the current value.

AT^PADFWDT=n n is the forwarding data time in 50ms increments.

n = 0 => Disabled
n = 20 => (50ms * 20) => 1s (Default)
n = 255 => maximum value

AT^PADFWDT? Queries the current value.

AT^PADECHO=n n = 0 => PAD echo disabled

n = 1 => PAD echo enabled (Default)

AT^PADECHO? Queries the current value.

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Using the Gateway 25

6.3.2 Transparent Mode vs. Multi-Point/Multi-Device

The Wireless Serial Gateway (WSG) or client is always using transparent mode. Data from the serial port is
encapsulated into packets with a proprietary 3-byte header and sent out to the Gateway (server) using
point to point communication.

The server can be in transparent mode as well (PAD=2). In this mode, the 2 devices, one Wireless Serial
Gateway and one Gateway act as a wireless serial link. No other device types are supported in this mode
and only 1 client is allowed.

In PAD=0 mode, the server Gateway outputs data using the PWPAN/PPQ message structure. In this
mode, the server Gateway can simultaneously communicate with multiple devices (Man Down Pendants,
etc.) and also multiple PAD client devices.

6.3.3 Establishing a Connection

The following is an example of how to configure the two devices for connection establishment. The client
refers to the Wireless Serial Gateway connected to the remote serial device and the server refers to the
Gateway connected to the DCE device.

Transparent Mode Configurations:

Client settings (Wireless Serial Gateway (WSG)):
AT^PADECHO=0
AT^PAD=1
AT&W

Server settings (Gateway):

AT^PADECHO=0
AT^PAD=2
AT^ZBEEADDDEV=0013A200........
AT&W

Multi-point Mode Configurations:

Client settings (Wireless Serial Gateway (WSG)):
AT^PADECHO=0
AT^PAD=1

Server settings (Gateway):

AT^PADECHO=0
AT^PAD=0
AT^ZBEEADDDEV=0013A200........
AT^ZBEEADDDEV=0013A200........
AT^ZBEEADDDEV=0013A200........

Connection is automatically established after a reset in PAD=1 and 2 modes. Once a client connection is
established, a CONNECT message is displayed. Note that this can be disabled with ATQ1. When in
transparent mode, the server side also displays a CONNECT message with the ID of the client device.

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Using the Gateway 26

6.3.4 Temporarily Escaping the Connection (+++)

When a connection has been established, entering +++ with 1 second pause time before and after the
sequence will allow the gateway to temporarily exit the connection. Typing the command ATO is required
to reconnect after the escape sequence.

6.3.5 Detecting Lost Connections

Once a client (WSG) connection is established, the client (WSG) detects if the connection is broken and
tries to re-establishes the connection. If there is data being sent, the client (WSG) keeps retrying for up to
5 seconds until it gets a positive acknowledgment. If communication still fails after 5 seconds, the
connection is detected as broken and the registration sequence begins again and keeps retrying until a
successful connection is established. A no carrier message is displayed on the client side (PAD=1) and
server side in transparent mode (PAD=2).

6.3.6 PAD Client Device Type (Multi-Point) (PADDEVTYPE)

In order to be able to distinguish between different kinds of devices, the device type needs to be
programmable on the PAD client side. The configuration is done using the following command:

AT^PADDEVTYPE=n n = 10-20 (default = 10)

AT^PADDEVTYPE? Queries the current value.

6.3.7 Client Side Power Management (PADREGT)

In order to reduce power consumption of the WSG client side and extend operating life, a power saving
mode has been implemented. It works by reducing the frequency of registration attempts by the client
and keeping the device in low power mode between attempts. To set, use the following command:

AT^PADREGT=p,i p is the registration period in seconds.

p = 0 => try registering with no delay
p = 10 => 10 seconds (default)
p = 255 => maximum value

i is the registration period increment

i = 1 => minimum value
i = 10 => 10s (default)
i = 255 => maximum value

After power up or lost connection, the client will try registering immediately. If it fails, it will wait for a
period that increments by i every failed attempt until it reaches the value of p, where it will continue to
attempt to register until a valid connection is made.

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Using the Gateway 27

For example: p=60, i=10

Attempt Delay (seconds)
1 0
2 10
3 20
4 30
5 40
6 50
7 60
8 60
9 60
.. ..
… …
…. ….

6.4 Using an Engine Vehicle Diagnostics Transmitter (E-VDT) with the Gateway
In order to successfully connect to an engine or vehicle diagnostic port, the protocol must match between
the transmitter and engine/vehicle.

With the default setting, the E-VDT will search for a valid protocol and connect to it. However, this auto
search feature may not work on some vehicles; in this case, the user will need to change the protocol
setting of the E-VDT. Protocols 1 to 9 are for OBD II compliant vehicles.

0 – Automatic
1 – SAE J1850 PWM
2 – SAE J1850 VPW
3 – ISO 9141-2
4 – ISO 14230-4 KWP (slow)
5 – ISO 14230-4 KWP (fast)
6 – ISO 15765-4 CAN (11-bit ID, 500k baud)
7 – ISO 15765-4 CAN (29-bit ID, 500k baud)
8 – ISO 15765-4 CAN (11-bit ID, 250k baud)
9 – ISO 15765-4 CAN (29-bit ID, 250k baud)
10 – SAE J1939 CAN (29-bit ID, 250k baud)
11 – USER1 CAN (11-bit ID, 125k baud)
12 – USER2 CAN (11-bit ID, 50k baud)

6.4.1 Protocol Setting Command (OBDSP)

AT^OBDSP=n n = 0-12, the number of the protocol being used (see above.)

AT^OBDSP? Queries the current protocol being used.

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Using the Gateway 28

For example, to change the protocol setting to ISO 9141-2 and to read back the value:
AT^OBDSP=3 Set the protocol to ISO 9141-2
AT&W Save the new setting.

AT^OBDSP? Queries the current protocol being used.

3 Returned value.

6.4.2 Gateway E-VDT Report Messages

The Gateway receives data from the E-VDT on a continual basis; the Gateway can be configured to format
engine/vehicle parameters into messages available for the DCE device. A message can hold up to 4
parameters. Users can define up to 4 messages named POBDA to POBDD for a total of 16 parameters.

6.4.3 Creating E-VDT Reports (POBDA…POBDD)

AT^POBDA=n1[,n2][,n3][,n4] Configures report A
AT^POBDB=n1[,n2][,n3][,n4] Configures report B
AT^POBDC=n1[,n2][,n3][,n4] Configures report C
AT^POBDD=n1[,n2][,n3][,n4] Configures report D

Where:
n1..n4 are parameters to be displayed, n2..n4 are optional.
These commands and their associated parameters are not case sensitive.
The valid values for n1 – n4 are parameters from the E-VDT table (9).

For example:
AT^POBDA=p2,p8,p25 Configure POBDA message to report parameters P2,P8 and P25

To view the report configuration:

AT^POBDA? View the configuration of report A
AT^POBDB? View the configuration of report B
AT^POBDC? View the configuration of report C
AT^POBDD? View the configuration of report D

Gateway to DCE message:

n1[,n2][,n3][,n4]<CR><LF>

Where:
n1..n4 are parameters to be displayed, n2..n4 are optional.
These commands and their associated parameters are not case sensitive.
The valid values for n1 – n4 are parameters from the E-VDT table.

For example:
AT^POBDA=P1,P2,P3,P5 Set the parameters for report A
AT^POBDA? Query the parameters chosen for report A
P1,P2,P3,P5 Returned result

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Using the Gateway 29

6.4.4 Displaying E-VDT Reports (SHOWPOBDA…SHOWPOBDD)

AT^SHOWPOBDA Display E-VDT report A
AT^SHOWPOBDB Display E-VDT report B
AT^SHOWPOBDC Display E-VDT report C
AT^SHOWPOBDD Display E-VDT report D

For example:
AT^POBDA=P1,P2,P3,P5 Set the parameters for report A
AT^SHOWPOBDA Query the value of the parameters in report A
$POBDA,A,p1=85,p2=1544,p3=50,0*74 Returned result

If a parameter is not supported by the engine or vehicle, only commas will be displayed:
$POBDA,A,,,p2=1544*19

Available parameters are listed in 9.

6.4.5 Displaying E-VDT Parameter Value(s) (OBDPARAM?)

To poll individual or all of the engine parameters from the Gateway, the following command can be used:

AT^OBDPARAM?pn pn is the engine parameter

If the parameter is available and valid, the response should be in the following format:
pn=value

AT^OBDPARAM?ALL Will query all available engine/vehicle parameters

If no engine diagnostic device is connected the command will return ERROR

For example, to query parameter P1:

AT^OBDPARAM?P1
$POBDA,A,p1=125*53

6.4.6 E-VDT Pass through mode

When the Gateway is configured by AT^PAD=3 the gateway will pass all E-VDT (OBDII/J1939) data
transparently to the Gateway serial port. This command is useful for applications where 3rd party engine
diagnostic programs are used to monitor engine/vehicle parameters. In this mode, all Gateway E-VDT
commands are disabled.

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 NMEA Messages 30

7 NMEA Messages

A proprietary NMEA message format is used to communicate to and from the remote connected devices.
The message structure varies slightly for the type of device (Man Down Pendant, Wireless Serial Gateway
(WSG), or Engine Vehicle Diagnostics Transmitter (E-VDT), but the format follows the table defined below.

7.1 NMEA Message Format

ASCII Description
$ Start character
ABC or PABC Message type. Messages starting with P are non-standard proprietary.
<string>,<string> Message body. Multiple strings are separated with commas.
* Message terminator
hh Message checksum
<CR><LF> Carriage return, line feed

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 NMEA Messages 31

7.2 Man Down Pendant Message Structure

The Gateway will format messages for a remotely connected server based on input from Cypress’ Man
Down Pendant. No configuration is required on the Man Down Pendant; the Gateway will understand
incoming messages and create outbound Gateway NMEA messages.

7.2.1 Outbound Man Down Pendent/PPEN Messages

The Gateway will create and format PPEN messages based on input from the pendant:

$PPEN,AAAAAAAAAAAAAAAA,BB,XXXXXXX*hh<CR><LF>

Where:
AAAAAAAAAAAAAAAA is the Pendant/Device ID
BB is the Sequence number
XXXXX is the message payload see table below
hh is the message checksum

For example:
$PPEN,ID,SEQ,PANIC*hh<CR><LF> ID = pendant’s ID, SEQ=sequence number, PANIC = Alert
notification (“Man Down”) message

$PPEN,ID,SEQ,DRVID*hh<CR><LF> ID = pendant’s ID, SEQ=sequence number, DRVID = Device

id message

7.2.2 Inbound Man Down Pendant Messages (DCE to Gateway Messages)

The Gateway will understand messages in PPQ format and will relay/query the message to the pendant:

$PPQ,PAN,AAAAAAAAAAAAAAAA,BB,XXXXXXX*hh<CR><LF>

Where:
AAAAAAAAAAAAAAAA is the Pendant/Device ID
BB is the Sequence number
XXXXX is the message payload see table below
hh is the message checksum

The following are some examples:

$PPQ,PAN,ID,SEQ,ACK*hh<CR><LF> ID= pendant’s ID, SEQ=sequence number, ACK=
acknowledgement string

$PPQ,PAN,ID,SEQ,NACK*hh<CR><LF> ID= pendant’s ID, SEQ=sequence number, NACK=

Negative acknowledgement string
$PPQ,PAN,ID,SEQ,CONF=xx*hh<CR><LF> ID= pendant’s ID, SEQ=sequence number,
CONF=configures sound and vibration state

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 NMEA Messages 32

7.2.3 Man Down Pendant Sequence Numbers

When the Man Down Pendant is powered on and generates messages, each message will have a
sequence number associated with it. The sequence number starts at 01 and increments to FF (hex) at
which point it will roll over to 01. The sequence numbers must match for the message to be considered
valid.

For example, if the following outbound message is generated:

$PPEN,0123456789ABCDEF,35,PANIC

It must be acknowledged by an inbound message with the same sequence number:

$PPQ,PAN,0123456789ABCDEF,35,ACK

7.2.4 Round Trip Response Time

When a PPEN message (PANIC, MPANIC, CPANIC, DRVID, ATTACK) is generated that expects a PPQ
acknowledgement (ACK) string, there is a minimum round trip time within which the message must be
delivered to the pendant before a negative acknowledgement is indicated to the user. By default this
time is set to 12 seconds. The round trip response time can be configured from 12 to 63 seconds using
bits 2 to 7 of the CONF command if the Serial Gateway Chat application is available3. The round trip
response time should not be set to a time interval of less than 12 seconds.

For example:
$PPQ,PAN,0123456789ABCDEF,35,CONF=43 will define the round trip time to be 16 seconds.

43=0100 0011 is 16 seconds with sound and vibration configured to be on

83=1000 0011 is 32 seconds with sound and vibration configured to be on

7.2.5 Gateway to DCE Message List

This table explains the different messages that may appear during while operating a Man Down Pendant.

PPEN PPQ
Description
Outgoing Gateway message Expected response
ACK Acknowledge a configuration None
change
ACKxx Return round trip response time, None
sound, vibration state in hex.
ACKxxx Return battery voltage in None
decimal, i.e. ACK300 = 3.00 V
ON Pendant sends this message None
every time it transitions from OFF
to ON state.

3
Please contact Cypress Solutions at 1-877-985-2878 for more information on how to obtain the Serial Gateway
Chat application.

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 NMEA Messages 33

OFF Pendant sends this message None

every time it transition from ON
to OFF state.
DRVID ID message ACK means that the driver’s ID has
been accepted. NACK means that it
has been rejected. The pendant will
continue to send DRVID messages
until either a NACK or ACK has been
received or up to a total of 5 retries.
The response will trigger either
positive or negative audible-
vibrating indication. The timing of
the resending of the DRVID message
is controlled by the CONF value.
PANIC Panic message (push button ACK means that the message has
activated) been received. The pendant will
keep sending PANIC messages until
either a NACK or ACK has been
received. The response will trigger
either positive or negative audible-
vibrating indication. The timing of
the resending of the PANIC message
is controlled by the CONF value.
FPANIC Panic message (free fall ACK means that the message has
activated) been received. The pendant will
keep sending FPANIC messages until
either a NACK or ACK has been
received. The response will trigger
either positive or negative audible-
vibrating indication. The timing of
the resending of the PANIC message
is controlled by the CONF value.
MPANIC Panic message (motion sensor ACK means that the message has
activated) been received. The pendant will
keep sending MPANIC messages
until either a NACK or ACK has been
received. The response will trigger
either positive or negative audible-
vibrating indication. The timing of
the resending of the PANIC message
is controlled by the CONF value.

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 NMEA Messages 34

ATTACK Incoming message receipt ACK means that the message has
acknowledgement. been successfully acknowledged.
If there is no response, pendant will
retry up to 5 times. The timing of the
resending of the ATTACK message is
controlled by the CONF value
The response will trigger either
positive or negative audible-
vibrating indication.
CPANIC Cancel panic message ACK means that the message has
been received. The pendant will
keep sending CPANIC messages until
either a NACK or ACK has been
received or up to a total of 5 retries.
The response will trigger either
positive or negative audible-
vibrating indication. The timing of
the resending of the CPANIC
message is controlled by the CONF
value.
OUTOFRANGE Gateway generates “out of None
range” message when associated
Pendant moves out of coverage
area. Controlled by
AT^SESSIONALERT command

BACKINRANGE Gateway generates “back in None

range” message when associated
Pendant moves back into
coverage area. Controlled by
AT^SESSIONALERT command

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 NMEA Messages 35

7.2.6 DCE to Gateway Message/Commands List

This table explains the different commands that may be used to configure a Man Down Pendant. The use
of the Serial Gateway Chat application or other similar application capable of generating checksums is
required4.

PPQ
PPEN
Incoming Gateway Description
message response
message
ACK Acknowledge PPEN message None

NACK Negative Acknowledge message None

CONF=xx Configure panic button. xx is a hex value of ACK means that the configuration has
the configuration byte, bit mapped as been saved.
follows:
Bit 0: Sound ON(1)/OFF(0)
Bit 1: Vibration ON/OFF
Bit 2 to Bit 7: defines round trip response
time for ACK generation. (1-63 seconds)
CONF? Query pendant configuration byte ACKxx where xx is a hex value
described above.
BATT? Query pendant battery voltage level ACKxxx where xxx is a decimal value:
E.g. Vbat=3.00V would return ACK300.
ATT Incoming message for User ATTACK

TEMP? Query the pendant temperature ACKxx

xx is a hex value as signed char in °C.
E.g. 19 => 25°C, FB => -5°C
BUZZER=xx Make the pendant beep until power down ACK
xx is a hex value of frequency divided
by 100.
E.g. 10 => 1.6 KHz
BUZZER=s1 preconfigured parameter
to play “positive ACK” sound sequence
BUZZER=s2 preconfigured parameter
to play “negative ACK” sound
sequence
BUZZER=s3 preconfigured parameter
to play “out of range” sound sequence
PD Make the pendant power down None

VIBR Make the pendant vibrate twice ACK

4
Please contact Cypress Solutions at 1-877-985-2878 for more information on how to obtain the Serial Gateway
Chat application.

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 NMEA Messages 36

VER? Query the pendant’s firmware version Vx.xx

x.xx is the pendant firmware version.
PANID=nnnn Configure the PAN ID of the pendant. PANIDACKnnnn where nnnn is the 4
(Default is 4465. FFFF is reserved and digit hex value of the PAN ID (0000 to
cannot be used.) FFFE)
MST=xx Configure accelerometer thresholds and ACK means that the configuration has
free fall settings (FPANIC) been saved.
xx is in hex, bit mapped as follows:
Bit 3-0: Motion sensing threshold (0: least
sensitive, F: most sensitive. Default 7.)
Bit 5-4: Free fall time threshold (0: 0.1sec,
1: 0.5s, 2: 1s, 3: 2s. Default 1.)
Bit 7-6: Free fall magnitude threshold (0:
Disabled, 1: 0.25g/fastest, 2: 0.5g, 3:
0.75g/slowest freefall. Default 1.)
MST? Query the current value for MST. ACKxx where xx is the hex value
described in MST=xx
MTIM=xx Configure panic button motion panic ACK means that the MTIM
(MPANIC) timeout. xx is a hex value in configuration has been saved.
seconds
xx=00 : 30 seconds (Default)
xx=FF : 255 seconds
If no motion is detected for xx seconds,
notification starts. If the pendant has not
moved for another 30s an MPANIC
message is generated.

For example, using default values, an

MPANIC message will be generated and
sent after a total of 1 min of inactivity (30s
default xx value + 30s during notification.)
MTIM? Query the current value for MTIM. ACKxx where xx is the hex value
described in MTIM=xx

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 NMEA Messages 37

7.3 Wireless Serial Gateway (WSG) Message Structure

When a Gateway receives data from a Wireless Serial Gateway and is configured to receive multi-point
data (PAD=0), output from the WSG will have the following format:

$PWPAN,ID,HeaderPayload*hh<CR><LF>

Where:
ID = 64-bit hex address of the device that sent the message
HeaderPayload = 3-byte header and variable length payload formatted as hex digits.

Messages can be sent from the DCE device via the Gateway to the Wireless Serial Gateway device by
using the following NMEA message:

$PPQ,WPAN,ID,HeaderPayload*hh<CR><LF>

Where:
ID = 64-bit hex address of the endpoint device
HeaderPayload = 3-byte header and variable length payload formatted as hex digits.

For example:
A data packet from the DCE device destined for the Wireless Serial Gateway would be formatted:
$PPQ,WPAN,0013A20040111213,0C470041434B*21

7.3.1 Device Header Description

A 3 byte header is included with every $PWPAN message. The structure of this header is:

Byte 1 = Device Type

Byte 2 = Sequence Number
Byte 3 = Packet Type

List of device and payload types currently supported:

Device Type (HEX) Description
0 Gateway
1 Man Down Pendant
3 EVDT (OBDII,J1939)
4 Marine Asset Tracker/Boom
Tracker
10 PAD - Loopback
11 PAD - J1708/J1587
12-20 Reserved for other PAD devices
(RTU,etc)
254 Range Extender for Man Down
Pendants

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 NMEA Messages 38

Packet Type (HEX) Description

0 Data
1 Registration
2 Diagnostics
16 Raw data, no 3-byte header
254 Encapsulated packet

For example:
A data message from a device with a user defined device type=12 (0xC) with sequence number 0x47 will
be formatted as:
$PWPAN,0013A20040111213,0C470050414E4943*03

In the above example 0C4700 would comprise the 3 byte header where 0x0C (decimal 12) is the device
type, 47 is the message sequence number and 00 defines the packet type as “data”.

7.4 E-VDT - Gateway Message Structure

The Gateway receives data from the E-VDT on a continual basis. The Gateway can report up to a
maximum of 16 parameters by configuring each of the 4 $POBD messages to report 4 parameters each.
Once configured via the AT^POBD{A…D} command (see 0) the Gateway will respond with messages in
the following format:

$PBOBDA,X,n1=a…a[,n2=b…b][,n3=c…c][,n4=d…d]*hh<CR><LF>
$PBOBDB,X,n1=a…a[,n2=b…b][,n3=c…c][,n4=d…d]*hh<CR><LF>
$PBOBDC,X,n1=a…a[,n2=b…b][,n3=c…c][,n4=d…d]*hh<CR><LF>
$PBOBDD,X,n1=a…a[,n2=b…b][,n3=c…c][,n4=d…d]*hh<CR><LF>

Where:
X is the validity flag (A= valid, V= invalid)
a…a,b…b, etc… is the parameter value information.

For example:
If parameters P1, P2, P3, and P5 are to be in message A:
AT^POBDA=P1,P2,P3,P5

Then querying message A will return:

AT^SHOWPOBDA
$POBDA,A,p1=85,p2=1544,p3=50,0*74

If a parameter is not supported by the engine or vehicle, only commas will be displayed
$POBDA,A,,,p2=1544*19

The AT^OBDPARAM?pn command will always return a result in the form of

$PBOBDA,X,pn=a…a*hh<CR><LF>

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 NMEA Messages 39

7.5 Session Management Message Structure

In the case where manual session management is used with WPAN devices that require a connection
based protocol (AT^AUTOSESSION=0), the following commands are valid:

$PEVN,ID,TY,CODE*hh<CR><LF> Generated by WPAN device

Where:
ID is the 64-bit hex address of the endpoint device
TY is the 8-bit hex value for device type
CODE is 7-bit hex event code
hh is NMEA checksum

Event code can have the following values:

Code Description
00 Registration Attempt
01 Connection Established
02 Connection Lost

$PEVA,ID,CODE*hh<CR><LF> Generated by DCE device

Where:
ID is the 64-bit hex address of the endpoint device
CODE is 8-bit hex event code with bit 7 set to 1 to allow or 0 to reject. If CODE=FF the session must be
broken
hh is NMEA checksum

For example:
$PEVN,0013A20040111213,03,00*79
If automatic session management is disabled on the gateway, the external DCE device such as a modem
must acknowledge the above messages using the following format:

$PEVA,0013A20040111213,80*7E => Allow session establishment

$PEVA,0013A20040111213,00*76 => Reject session with the device
$PEVA,0013A20040111213,FF*76 => Close current session with this device.

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Appendix I 40

8 Appendix I
8.1 Gateway Mechanical Drawings
8.1.1 Standard Gateway

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Appendix I 41

8.1.2 Standard Gateway (RP-SMA)

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Appendix I 42

8.1.3 Windshield Gateway

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Appendix I 43

8.1.4 RP-SMA Windshield Gateway

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Appendix I 44

8.1.5 External Mount Gateway (Internal Antenna and RP-SMA)

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 OBD II/J1939 Parameter List 45

9 OBD II/J1939 Parameter List

Para- Min/Max()for
OBD II J1939 Description Unit PID Response of PID PGN Response of PGN
meter J1939 Only

0 to 255(0 to
Yes Yes p1 vehicle speed 250.996) km/h 010D 1 byte FE6C byte7~8((1/256)Km/bit)
engine RPM(Revolutions 0 to 16,383(0 to 2 bytes,
Yes Yes p2 Per Minute) 8,031.875) min^-1 010C ((A*256)+B)/4 F004 byte4~5(0.125rpm/bit)
1 byte,
Yes Yes p3 throttle position 0 to 100 % 111 A*100/255 FEF2 byte7(0.4%/bit)
VIN(Vehicle Identification
Yes No p4 Number) 17 characters ASCII 902 multiple lines
MIL(Malfunction Indicator
Yes Yes p5 Lamp) indicator 0=off, 1=on 101 4 bytes, bit7 in A FECA bit6~7 of byte1
4 bytes, bit0~6 in
Yes No p6 number of trouble codes 0 to 127 decimal 101 A
calculated engine load 1 byte,
Yes No p7 value 0 to 100 % 104 A*100/255
engine coolant -40 to 215(-40 to
Yes Yes p8 temperature 210) °C 105 1 byte, A-40 FEEE byte1-40
Yes No p9 fuel rail pressure (gauge) 0 to 765 kPa 010A 1 byte, A*3
intake manifold absolute
Yes No p10 pressure 0 to 255 kPa 010B 1 byte
ignition timing advance for
Yes No p11 cylinder number 1 -64 to 63.5 ° 010E 1 byte, A/2-64
-40 to 215(-273 to byte4~5(0.03125°C/bit)-
Yes Yes p12 intake air temperature 1735) °C 010F 1 byte, A-40 FEF5 273
MAF(mass flow sensor) air 2 bytes,
Yes No p13 flow rate 0 to 655.35 g/s 110 ((256*A)+B)/100
2 bytes,
Yes No p14 run-time since engine start 0 to 65,535 second 011F (A*256)+B
1 byte,
Yes No p15 fuel level input 0 to 100 % 012F 100*A/255
2 bytes,
Yes No p16 control module voltage 0 to 65.535 v 142 ((A*256)+B)/1000
2 bytes,
((A*256)+B)*100/
Yes No p17 absolute load value 0 to 25700 % 143 255
Yes No p18 power take off status 0=off, 1=on 011E 1 byte, bit0 in A
distance travelled while 2 bytes,
Yes No p19 MIL is activated 0 to 65,535 km 121 (A*256)+B
distance since diagnostic 2 Bytes,
Yes No p20 trouble codes cleared 0 to 65,535 km 131 (A*256)+B
minutes run on the engine 2 Bytes,
Yes No p21 while MIL activated 0 to 65,535 min 014D (A*256)+B
time since diagnostic 2 Bytes,
Yes No p22 trouble codes cleared 0 to 65,535 min 014E (A*256)+B
No Yes p23 odometer 0 to 526385151.9 km proprietary FEE0 byte5~8(0.125Km/bit)
No Yes p24 high resolution odometer 0 to 21055406 km FEC1 byte1~4(5m/bit)
0 to
Yes Yes p25 total engine hours 210554060.75 hour proprietary FEE5 byte1~4(0.05hr/bit)
percent load at current
No Yes p26 RPM 0 to 125 % F003 byte3(1%/bit)
No Yes p27 actual engine - % torque -125 to 125 % F004 byte3(1%/bit)
No Yes p28 fuel temperature -40 to 210 °C FEEE byte2(1°C/bit)
No Yes p29 boost pressure 0 to 500 kPa FEF6 byte2(2kPa/bit)

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 OBD II/J1939 Parameter List 46

intake manifold 1
No Yes p30 temperature 0 to 500 kPa FEF6 byte3(1°C/bit)
0 to
No Yes p31 total fuel used 2,105,540.607.5 L FEE9 bytes5~8(0.5L/bit)
No Yes p32 fuel deliver pressure 0 to 1,000 kPa FEEF byte1(4kPa/bit)
No Yes p33 engine oil pressure 0 to 1,000 kPa FEEF byte4(4kPa/bit)
No Yes p34 fuel rate 0 to 3,212.75 L/h FEF2 bytes1~2(0.05L/bit)
battery pot. voltage
No Yes p35 (switched) 0 to 3,212.75 V FEF7 bytes7~8(0.05V/bit)
No Yes p36 accelerator pedal position 0 to 100 % F003 byte2(0.4%/bit)
Yes Yes id XBee device ID of Gateway 16 digits hex
calculated peak (km/h)/s
Yes Yes pa acceleration 0 to 512 ec
calculated peak (km/h)/s
Yes Yes pb deceleration(braking) 0 to 512 ec

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)

 Specifications and Approvals 47

10 Specifications and Approvals

10.1 Environmental Specs
 Operating temp = MIL-STD 810F Method 502-II, -30 to +60 Celsius.
 Storage Temp = SAE 1455 4.2.3, -40 to +75 Celsius
 Humidity = SAE J1455 Humidity test 4.2.3, 85 to 95% RH for five 48 hour cycles.
Enclosure sealing = IP 2X for PENDANT, STANDARD and WINDSHIELD GATEWAY, IP=66 EXTERNAL
MOUNT GATEWAY

The Gateway and associated WPAN devices have been tested to comply with regulations for license free
operation in 2.4GHz band (FCC Title 47, Part 15, Sub part 247)

11 Technical Support/Warranty
The Cypress Solutions website provides product support information including:
 Support bulletins
 How To guides
 Software tools
 Firmware upgrades

www.cypress.bc.ca

For advanced technical support on Chameleon products contact:

Cypress Solutions Service

Support Group
1.877.985.2878 or 604.294.4465
9.00am to 5.00pm PST
[email protected]

© 2012 Cypress Solutions MANUAL: Gateway (Revision G)