Quake global Pl131 User manual

Page

+



Document #1155-4713

Revision E

User Guide to PL131

SENSITIVITY LEVEL: YELLOW

THE LEADER IN

REMOTE ASSET TRACKING

User Guide to PL131

Document Number 1155-4713 Rev E

Page i

CONFIDENTIAL

Information classified Confidential - Do not copy (See last page for obligations)

This document contains confidential and proprietary information of Quake Global corporation. It may be used by recipient only for the purpose for which it was transmitted

and will be returned upon request or when no longer needed by recipient. Disclosure to unauthorized third parties or duplication without the express written permission of

Revision History

Date

Rev

ECO

Description

Oct 2013

Initial Preliminary Release

Oct 2013

Various changes per CAT email 10/16/2013

Mar 2014

Jun 2014

Aug 1 2014

Aug 4 2014

Nov 10 2014

1151

Initial Production Release

Added description of screws in section 2.1.3.1 - Screws.

Corrected Battery voltage in Table 4-2 and Table 4-2.2.

Corrected Reason field in Table 4-2.2.

Updated Location, Reason and Timestamp fields in Table 4-2.

Updated Data field in Table 4-2.1.

Added Time Offset field to Configuration Message in:

oTable 4-6

oTable 4-6.1

oTable 4-6.2.

Corrected size of first Length field to 1 byte in Table 4-1.

Corrected size of Length field to 12 in example in Table 4-1.1.

Added Table 2-1: Battery voltage/LED operation to section 2.5.

Corrected opcode in first message in Table 4-1.1 and Table 4-2.1.

Corrected opcode in status message in Table 4-2 and Table 4-2.2.

Updated last 2 bits in Reason field in Table 4-2.

Updated Reason definitions in Reason field in Table 4-4.

Added 2 figures to section 2.1.1 - Battery.

Added push button shutdown and activation in sections 2.4.1 and 2.4.2.

Added mention of initial blink upon start-up in section 2.5 - Testing.

May 2015

1513

Updated section 1.2 - Scope.

Updated Table 4-6: Configuration message.

Updated section 4.2.1 - Message reporting flowchart.

Added section 6 - File Over-the-Air transfer (FOTA) specification.

Aug 2015

1592

Added Warning Note in section 2.1 - Installation.

Updated battery label image in section 2.1.1 - Battery.

Sep 2015

1620

Updated the modem image and label in section 2.1.1 - Battery.

Removed Approvals signature block –not needed for this doc.

Dec 2015

1705

Added Time Offset parameter definition in section 3.1.1

User Guide to PL131

Document Number 1155-4713 Rev E

Page ii

CONFIDENTIAL

Information classified Confidential - Do not copy (See last page for obligations)

This document contains confidential and proprietary information of Quake Global corporation. It may be used by recipient only for the purpose for which it was transmitted

and will be returned upon request or when no longer needed by recipient. Disclosure to unauthorized third parties or duplication without the express written permission of

Table of Contents

1INTRODUCTION....................................................................................................... 1

1.1 Overview........................................................................................................................1

1.2 Scope.............................................................................................................................1

1.3 Related documents........................................................................................................2

2QUICK START GUIDE ............................................................................................. 3

2.1 Installation......................................................................................................................3

2.1.1 Battery.....................................................................................................................................3

2.1.2 Location considerations...........................................................................................................4

2.1.3 Mounting..................................................................................................................................4

2.1.3.1 Screws ...............................................................................................................................................4

2.2 Setup .............................................................................................................................4

2.3 Provisioning and activation.............................................................................................4

2.3.1 Iridium......................................................................................................................................4

2.3.1.1 Activation............................................................................................................................................4

2.3.1.2 Provisioning........................................................................................................................................4

2.4 Powering On/Off.............................................................................................................4

2.4.1 Power on .................................................................................................................................4

2.4.2 Power off .................................................................................................................................5

2.5 Testing...........................................................................................................................5

3OVER THE AIR (OTA) CONFIGURATION............................................................... 6

3.1 Simple Asset Tracker (ATapp) .......................................................................................6

3.1.1 Define parameters...................................................................................................................6

3.1.2 Status message.......................................................................................................................8

4MESSAGE PROTOCOL........................................................................................... 9

4.1 Message definitions .......................................................................................................9

4.1.1 Concatenated..........................................................................................................................9

4.1.2 Status ....................................................................................................................................10

4.1.3 Ack.........................................................................................................................................11

4.1.4 Nack ......................................................................................................................................12

4.1.5 Factory Reset........................................................................................................................13

4.1.6 Configuration.........................................................................................................................13

4.2 Message flows .............................................................................................................14

4.2.1 Message reporting flowchart .................................................................................................14

4.2.2 Communication path –Send a Status message...................................................................17

4.2.2.1 No configurations pending................................................................................................................17

4.2.2.2 One configuration pending ...............................................................................................................17

4.3 Failure modes..............................................................................................................18

4.3.1 Failure to get GPS fix ............................................................................................................18

4.3.2 Invalid configuration ..............................................................................................................18

4.3.3 Signal strength is unknown ...................................................................................................19

4.3.4 Unknown wakeup event ........................................................................................................19

4.3.5 Temperature is not calibrated or is unable to be read...........................................................20

4.3.6 No network available.............................................................................................................20

4.3.7 Message send failure ............................................................................................................20

5IRIDIUM NETWORK............................................................................................... 21

User Guide to PL131

Document Number 1155-4713 Rev E

Page iii

CONFIDENTIAL

Information classified Confidential - Do not copy (See last page for obligations)

This document contains confidential and proprietary information of Quake Global corporation. It may be used by recipient only for the purpose for which it was transmitted

and will be returned upon request or when no longer needed by recipient. Disclosure to unauthorized third parties or duplication without the express written permission of

5.1 Messaging....................................................................................................................21

6FILE OVER-THE-AIR TRANSFER (FOTA) SPECIFICATION ............................... 23

6.1 Creating a patch file .....................................................................................................23

6.1.1 BSDIFF details ......................................................................................................................23

6.1.2 Backend server validity checks.............................................................................................25

6.2 Delivering a patch file...................................................................................................26

6.2.1 FOTA protocol message definitions......................................................................................27

6.2.1.1 File header .......................................................................................................................................27

6.2.1.2 Data..................................................................................................................................................27

6.2.1.3 Header or Message Ack...................................................................................................................28

6.2.1.4 Header or Message Nack.................................................................................................................28

6.2.2 Example flow of communication............................................................................................29

APPENDIX A–GLOSSARY OF TERMS...................................................................... 30

List of Figures

Figure 5-1: Iridium network diagram ..........................................................................................................21

Figure 6-1: Output structure of the standard BSDIFF file ..........................................................................24

Figure 6-2: New output structure of the BSDIFF file..................................................................................25

Figure 6-3: Process flow of maximum application image size checks.......................................................26

List of Tables

Table 2-1: Battery voltage/LED operation....................................................................................................5

Table 4-1: Concatenated message..............................................................................................................9

Table 4-1.1: Example Concatenated message............................................................................................9

Table 4-2: Status message........................................................................................................................10

Table 4-2.1: Example Status message......................................................................................................11

Table 4-2.2: Example Status message - parsed........................................................................................11

Table 4-3: Ack message ............................................................................................................................11

Table 4-3.1: Example Ack message ..........................................................................................................12

Table 4-3.2: Example Ack message - parsed............................................................................................12

Table 4-4: Nack message..........................................................................................................................12

Table 4-4.1: Example Nack message........................................................................................................12

Table 4-4.2: Example Nack message - parsed..........................................................................................12

Table 4-5: Factory Reset message............................................................................................................13

Table 4-5.1: Example Factory Reset message..........................................................................................13

Table 4-5.2: Example Factory Reset message - parsed ...........................................................................13

Table 4-6: Configuration message.............................................................................................................13

Table 4-6.1: Example Configuration message...........................................................................................14

Table 4-6.2: Example Configuration message - parsed ............................................................................14

Table 6-1: FOTA file header message.......................................................................................................27

Table 6-2: FOTA data message.................................................................................................................27

Table 6-3: FOTA header or message Ack.................................................................................................28

Table 6-4: FOTA header or message Nack...............................................................................................28

User Guide to PL131

Document Number 1155-4713 Rev E

Page 1

CONFIDENTIAL

Information classified Confidential - Do not copy (See last page for obligations)

This document contains confidential and proprietary information of Quake Global corporation. It may be used by recipient only for the purpose for which it was transmitted

and will be returned upon request or when no longer needed by recipient. Disclosure to unauthorized third parties or duplication without the express written permission of

The information in this document is subject to change.

1 Introduction

1.1 Overview

The PL131 (Locator) is part of an end-to-end solution to locate assets. It has been specifically designed

to meet the demanding requirements of vehicular environments and is ready for global use.

The solution consists of three major parts:

1. The PL131 asset tracker module –this device communicates location, internal battery voltage, and

signal strength information to the CAT back-office via Iridium SBD.

The two components of this device are:

a radio-modem designed for two-way communication

a Global Positioning System (GPS) receiver capable of determining the position of the

device.

2. Wireless network: A communications network capable of sending information to and from the

device (Iridium SBD).

3. CAT Wireless Office System: A system of middleware that manages the collection and

communication from Caterpillar to the Communications network, and a web-based application that is

used by the dealer and end customers to display this information.

1.2 Scope

This document includes a description of the key features of the PL131, and instructions for installing and

setting up the device. The User Guide is divided into 6 chapters and 1 appendix, which are summarized

below:

Chapter 1: INTRODUCTION to the PL131 device contains an overview and scope of the document,

as well as a list of related documents.

Chapter 2: QUICK START GUIDE explains how to install and test the modem.

Chapter 3: OVER THE AIR (OTA) CONFIGURATION describes the web-based application, Simple

Asset Tracker (ATapp), that is used to perform OTA configuration of the PL131.

Chapter 4: MESSAGE PROTOCOL discusses the payload associated with each message type.

Chapter 5: IRIDIUM NETWORK describes how messaging is performed through the Iridium satellite

network.

Chapter 6: FILE OVER-THE-AIR TRANSFER (FOTA) SPECIFICATION describes the process and

logic of the FOTA procedure.

Appendix A - Glossary of terms

Note:

User Guide to PL131

Document Number 1155-4713 Rev E

Page 2

CONFIDENTIAL

Information classified Confidential - Do not copy (See last page for obligations)

This document contains confidential and proprietary information of Quake Global corporation. It may be used by recipient only for the purpose for which it was transmitted

and will be returned upon request or when no longer needed by recipient. Disclosure to unauthorized third parties or duplication without the express written permission of

1.3 Related documents

QUAKE

[1] CAT PL131 Technical Data Sheet

[2] Hardware Requirements Specification for the CAT PL131/PL141 (from 14 Aug 2013)

Iridium

[3] SBD Direct IP MO and MT Addresses V1.0

[4] SBD Best Practices Guide V1.1

User Guide to PL131

Document Number 1155-4713 Rev E

Page 3

CONFIDENTIAL

Information classified Confidential - Do not copy (See last page for obligations)

This document contains confidential and proprietary information of Quake Global corporation. It may be used by recipient only for the purpose for which it was transmitted

and will be returned upon request or when no longer needed by recipient. Disclosure to unauthorized third parties or duplication without the express written permission of

Caution! There is a risk of explosion if the battery is replaced by an incorrect

type. Dispose of used batteries according to the instructions.

In the modem’s PN field, the 'XX' represents the Change level of the next high level.

2 Quick Start Guide

2.1 Installation

2.1.1 Battery

Quake Global will install the battery prior to shipment.

To replace a battery:

1. Remove the three screws holding the battery cover.

2. Replace the battery with the type indicated on the label next to the battery housing.

3. Reattach the battery cover with the three screws.

Warning:

Note:

User Guide to PL131

Document Number 1155-4713 Rev E

Page 4

CONFIDENTIAL

Information classified Confidential - Do not copy (See last page for obligations)

This document contains confidential and proprietary information of Quake Global corporation. It may be used by recipient only for the purpose for which it was transmitted

and will be returned upon request or when no longer needed by recipient. Disclosure to unauthorized third parties or duplication without the express written permission of

2.1.2 Location considerations

The device must be installed:

in a location that ensures the internal antennae have an unobstructed view of the sky.

greater than 20cm from a person. If the device is installed within 20cm of a person, the system

integrator needs to assess the final product against SAR regulation.

If the antenna is co-located and transmitting simultaneously with another antenna, additional

FCC/IC testing may be required.

with care to avoid any interference with other electronic devices.

2.1.3 Mounting

2.1.3.1 Screws

M6 hex head or socket screws. The preference is Hex head; the design must also accommodate a deep

well socket. If socket head is chosen, a 12mm washer must be used.

The standard diameter of the socket wrenches to be used for mounting is 14mm.

2.2 Setup

2.3 Provisioning and activation

2.3.1 Iridium

2.3.1.1 Activation

Caterpillar is responsible for Activating Iridium units

2.3.1.2 Provisioning

Caterpillar is responsible for provisioning Iridium Units

2.4 Powering On/Off

2.4.1 Power on

The modem can be powered on in one of four ways:

1. install the battery;

2. utilize the push button;

3. the Real Time Clock (RTC) wake-up;

4. motion detection.

Battery installation - When the battery is installed, the device powers on, the software boots, and the

device begins operation.

Real Time Clock (RTC) –The on-board Real Time Clock (RTC) generates a signal that causes the

modem to power on from sleep mode. The RTC does not maintain the time if the battery is removed.

The time is reset when the modem re-establishes communication.

Motion detection –If this feature is enabled, and the customer configurable threshold is exceeded, the

modem will be powered on from sleep mode.

User Guide to PL131

Document Number 1155-4713 Rev E

Page 5

CONFIDENTIAL

Information classified Confidential - Do not copy (See last page for obligations)

This document contains confidential and proprietary information of Quake Global corporation. It may be used by recipient only for the purpose for which it was transmitted

and will be returned upon request or when no longer needed by recipient. Disclosure to unauthorized third parties or duplication without the express written permission of

2.4.2 Power off

To power-down the PL131, either remove the battery or utilize the push button.

2.5 Testing

When the battery is installed for the first time or being replaced, an LED located within the battery housing

will first blink once, and then flash for 5 seconds at one second intervals, denoting that the battery voltage

is good. The starting point for the messaging interval is established and a Status message will be sent as

long as the GPS is able to obtain a location fix and network communication can be established.

Table 2-1: Battery voltage/LED operation

VBAT

Num blinks

>3.3V

≤3.3V and >2.9V

≤2.9V

User Guide to PL131

Document Number 1155-4713 Rev E

Page 6

CONFIDENTIAL

Information classified Confidential - Do not copy (See last page for obligations)

This document contains confidential and proprietary information of Quake Global corporation. It may be used by recipient only for the purpose for which it was transmitted

and will be returned upon request or when no longer needed by recipient. Disclosure to unauthorized third parties or duplication without the express written permission of

3 Over The Air (OTA) configuration

The CAT Wireless Office System is a system of middleware that manages the collection and

communication of data from Caterpillar to the communications network, and a web-based application that

is used by the dealer and end customers to display this information. This web-based application, Simple

Asset Tracker (ATapp) is used to perform OTA configuration of the device at the device’s next scheduled

wake-up period. Three parameters can be configured:

1. the scheduling frequency for Status messages

2. the motion detection threshold

3. the operating temperature range.

3.1 Simple Asset Tracker (ATapp)

3.1.1 Define parameters

1. After signing into ATapp, select the Configure tab.

2. In the Configure page, select Configurations from the Add drop-down menu.

User Guide to PL131

Document Number 1155-4713 Rev E

Page 7

CONFIDENTIAL

Information classified Confidential - Do not copy (See last page for obligations)

This document contains confidential and proprietary information of Quake Global corporation. It may be used by recipient only for the purpose for which it was transmitted

and will be returned upon request or when no longer needed by recipient. Disclosure to unauthorized third parties or duplication without the express written permission of

3. In the Properties tab, set the following configuration parameters:

Breadcrumbs →this parameter determines the time interval at which the device sends back Status

messages. Set only the Satellite Breadcrumbs parameters.

For the Satellite Breadcrumbs, set the following parameters:

Enabled –turns this feature on.

Interval - determines how long the device will sleep between sending Status messages (the default

is 24 hours).

Minimum Distance –not enabled for the PL131.

Motion Detection →enabling this parameter will cause the device to send a message when motion in

excess of the Threshold parameter is detected.

Operating Temperature →the Low and High values set the range of temperature in which the device

will function. Temperatures outside of this range will cause the device to suspend operation until ambient

temperature returns to the specified range.

Time offset → This variable also known as “Minute of Day”. This offset if set to positive value from 1 to

1440 minutes (24 hours) will result in unit sending status messages at that particular time each day. For

example, offset of 360 will send the report at 6 am.

Note.

User Guide to PL131

Document Number 1155-4713 Rev E

Page 8

CONFIDENTIAL

Information classified Confidential - Do not copy (See last page for obligations)

This document contains confidential and proprietary information of Quake Global corporation. It may be used by recipient only for the purpose for which it was transmitted

and will be returned upon request or when no longer needed by recipient. Disclosure to unauthorized third parties or duplication without the express written permission of

Time offset and Interval can both be set at the same time.Before going to sleep the unit will decide

whether to wake up at “Minute of Day” or at another set interval. The minimum sleep time will be chosen.

4. In the Assets tab, select the device and press Save to apply the configuration to the device.

3.1.2 Status message

1. To view the Status messages sent by the device, select the Monitor tab.

2. In the Monitor page, select a Status message. The message information appears in the map

panel to the right.

The Status message contains the following information:

date

time

speed

reason for the message

current location

icons indicating:

a. signal strength (the green bars)

b. battery

c. the direction of travel (the green arrow).

User Guide to PL131

Document Number 1155-4713 Rev E

Page 9

CONFIDENTIAL

Information classified Confidential - Do not copy (See last page for obligations)

This document contains confidential and proprietary information of Quake Global corporation. It may be used by recipient only for the purpose for which it was transmitted

and will be returned upon request or when no longer needed by recipient. Disclosure to unauthorized third parties or duplication without the express written permission of

4 Message protocol

4.1 Message definitions

The payload associated with each message type is described in this section. All INT types are assumed

to be little endian.

4.1.1 Concatenated

This message is an MO message, and is less than or equal to 340 bytes. In the event the modem has

more than one message queued, the modem will send all queued messages in one concatenated

message.

Table 4-1: Concatenated message

Field

Name

Data

Type

Size

Notes

Message

opcode

0xA8

1 byte

Concatenated message

Length

Length of next message

1 byte

Length of next message

Message

Status message, Ack, Nack, etc

U8*

Variable

Length

Length of next message

1 byte

Length of next message

Message

Status message, Ack, Nack, etc

U8*

Variable

… length, message pattern continues for up

to 340 bytes

Table 4-1.1: Example Concatenated message

Data

Type

Size

A8 12 61 DA D0 4D 24 32 AA 01 8E F4 01 02 40 00 D2 1D 6A 01 08 36 C7 00 00 D2 1D 6A 01*

U8[]

29 bytes

*Individual messages highlighted in blue.

User Guide to PL131

Document Number 1155-4713 Rev E

Page 10

CONFIDENTIAL

Information classified Confidential - Do not copy (See last page for obligations)

This document contains confidential and proprietary information of Quake Global corporation. It may be used by recipient only for the purpose for which it was transmitted

and will be returned upon request or when no longer needed by recipient. Disclosure to unauthorized third parties or duplication without the express written permission of

4.1.2 Status

This message is an MO message.

Table 4-2: Status message

Field Name

Data

Type

Size

Notes

Message opcode

0x61

1 byte

Status message

Location

Geodetic compressed

Lat / Lon. If no fix is

available, the status bit

is set (see Reason

field in this table) and

the last known location

is used.

U8[6]

(3 Bytes Lat +

3 Bytes Lon)

6 bytes

Lat/Lon conversion to geodetic:

long double lat, lon, lon_code, lat_code;

lat = 90.0 - ((unsigned long)lat_code /

((double)0XFFFFFF)) *180.0;

lon = ((unsigned long)lon_code /

((double)0XFFFFFF))*360.0;

if(lon > 180.0)

lon = lon - 360.0;

See parsed example in Table 4-2.2.

Speed

Kilometers/Hour

1 byte

0-255 km/h

Cog

2 degrees per bit

1 byte

0-358

Battery voltage

1000ths of volts

U16

2 bytes

Range:

0 - 0xFFFD,

error - 0xFFFF

overflow - 0xFFFE

0 to 65.534 volts (sent in millivolts)

Signal strength

(rssi)

Received Signal

Strength Indication

Value between 0 - 99

(The server will map

this value to power

level (dBm) or “Signal

Value”.)

1 byte

To convert the rssi to dBm use the

following formula: (rssi * 2) –113

For example:

0- (-113) dBm or less

1- (-111) dBm

2..30 - (-109)dBm.(-53)dBm / 2 dBm

per step

31 - (-51) dBm or greater

99 - Not known or not detectable

Temperature

Ambient temp (C)

1 byte

-128C MIN / 127C MAX

Reason

The reason for the

transmittal of the

status message. This

is a bit field. If the bit

is set, the status was

true. (See example in

Table 4-2.1.)

1 byte

Reason

Value

Bit

Scheduled

Defaulted Configuration

Motion Detected

Estimated Time

Network Time

No Fix

Min Fix

Unused

128

User Guide to PL131

Document Number 1155-4713 Rev E

Page 11

CONFIDENTIAL

Information classified Confidential - Do not copy (See last page for obligations)

This document contains confidential and proprietary information of Quake Global corporation. It may be used by recipient only for the purpose for which it was transmitted

and will be returned upon request or when no longer needed by recipient. Disclosure to unauthorized third parties or duplication without the express written permission of

Field Name

Data

Type

Size

Notes

Timestamp

Seconds since

Nov 1, 2012

00:00:00 UTC. By

default the timestamp

will be based on GPS

time. If GPS time is

not available, either

the network time or

estimated time bit will

be set in the status bit

Reason field.

U32

4 bytes

Timestamp conversion:

NEW_EPOCH_OFFSET = 0x3DBC7E00u

Seconds difference between Jan. 6, 1980

(GPS Epoch) and Nov 1, 2012.

Timestamp = seconds since GPS Epoch -

NEW_EPOCH_OFFSET

Table 4-2.1: Example Status message

Data

Type

Size

61 DA D0 4D 24 32 AA 01 8E F4 01 02 40 21 D2 1D 6A 01

U8[]

18 bytes

Table 4-2.2: Example Status message - parsed

Field Name

Data (Hex)

Parsed Value

Message opcode

Status message

Location: Latitude/Longitude

DA D0 4D 24 32 AA

Lat: 35.2875, Lon: -120.6221

Speed

1 kph

Cog

284 degrees

Battery voltage

F4 01

.5 volts

Signal strength

-109dbm

Temperature

40 degrees Celsius

Reason

Scheduled, No Fix

Timestamp

D2 1D 6A 01

8/2/2013 4:07:46 PM

4.1.3 Ack

This message can be either MO or MT.

Table 4-3: Ack message

Name

Data

Type

Size

Notes

Message opcode

0x36

1 byte

Ack

Acked message

opcode

Opcode of message being

Acked

1 byte

Checksum

0x0000

U16

2 bytes

Reserved

Timestamp

Seconds since Nov 1, 2012

00:00:00 UTC

U32

4 bytes

Timestamp conversion:

NEW_EPOCH_OFFSET = 0x3DBC7E00u

Seconds difference between Jan. 6, 1980

(GPS Epoch) and Nov 1, 2012.

Timestamp = seconds since GPS Epoch -

NEW_EPOCH_OFFSET

User Guide to PL131

Document Number 1155-4713 Rev E

Page 12

CONFIDENTIAL

Information classified Confidential - Do not copy (See last page for obligations)

This document contains confidential and proprietary information of Quake Global corporation. It may be used by recipient only for the purpose for which it was transmitted

and will be returned upon request or when no longer needed by recipient. Disclosure to unauthorized third parties or duplication without the express written permission of

The following example Ack message was sent in response to a successful configuration.

Table 4-3.1: Example Ack message

Data

Size

36 C7 00 00 D2 1D 6A 01

8 bytes

Table 4-3.2: Example Ack message - parsed

Field Name

Data (Hex)

Parsed Value

Message opcode

Ack message

Acked message opcode

Configuration

Checksum

00 00

0000 (reserved)

Timestamp

D2 1D 6A 01

8/2/2013 4:07:46 PM

4.1.4 Nack

This message can be either MO or MT.

Table 4-4: Nack message

Name

Data

Type

Size

Notes

Message opcode

0x37

1 byte

Nack

Nacked msg opcode

Opcode of msg being Nacked

1 byte

Reserved

0x00

1 byte

Reserved

Reason

Why the Nack occurred: >=

0x19

1 byte

Enumeration starts at 0x19.

Reason

Val

Failed to parse config

0x19

Timestamp

Seconds since Nov 1, 2012

00:00:00 UTC

U32

4 bytes

Timestamp conversion:

NEW_EPOCH_OFFSET = 0x3DBC7E00u

Seconds difference between Jan. 6, 1980

(GPS Epoch) and Nov 1, 2012.

Timestamp = seconds since GPS Epoch -

NEW_EPOCH_OFFSET

The following example Nack message was sent in response to a failed configuration.

Table 4-4.1: Example Nack message

Data

Size

37 C7 00 19 D2 1D 6A 01

8 bytes

Table 4-4.2: Example Nack message - parsed

Field Name

Data (Hex)

Parsed Value

Message opcode

Nack message

Nacked message opcode

Configuration

Reserved

00 (reserved)

Reason

FailedToParseConfiguration

Timestamp

D2 1D 6A 01

8/2/2013 4:07:46 PM

User Guide to PL131

Document Number 1155-4713 Rev E

Page 13

CONFIDENTIAL

Information classified Confidential - Do not copy (See last page for obligations)

This document contains confidential and proprietary information of Quake Global corporation. It may be used by recipient only for the purpose for which it was transmitted

and will be returned upon request or when no longer needed by recipient. Disclosure to unauthorized third parties or duplication without the express written permission of

4.1.5 Factory Reset

This message is an MT message.

Table 4-5: Factory Reset message

Name

Data

Type

Size

Notes

Message opcode

0xAF

1 Byte

Resets unit to factory defaults

Type of object

0xFF

1 Byte

Configuration type. Set to 0xFF

ObjectId

0x0000

U16

2 Byte

Configuration setting. Set to 0x0000

Table 4-5.1: Example Factory Reset message

Data

Size

AF FF 00 00

4 bytes

Table 4-5.2: Example Factory Reset message - parsed

Field Name

Data (Hex)

Parsed Value

Message opcode

Factory Reset message

Type of object

Reserved

ObjectId

00 00

Reserved. Unit will default its configurations

4.1.6 Configuration

This message is an MT message.

Table 4-6: Configuration message

Name

Data

Type

Size

Notes

Message opcode

0xC7

1 Byte

Configuration

Enable Motion

Detection

True/False

boolean

1 Bit

0-disabled

1-enabled

Motion Detection

Threshold

milli-G

partial

U16

15 Bits

Minimum 100

Maximum 16000

Enable

Breadcrumbs

True/False

boolean

1 Bit

1-enabled

(cannot be disabled)

Breadcrumb

interval

Minutes

partial

U16

15 Bits

Time interval between breadcrumb messages

Minimum 1

Maximum 1440

Temperature

Threshold Low

Temp in C°

Default -1 C

Signed

Byte

1 Byte

Modem will not transmit below this temperature

Range (-128C –127C)

Low must be smaller than High

(High –Low) must be greater than 10

Temperature

Threshold High

Temp in C°

Default 50 C

Signed

Byte

1 Byte

Modem will not transmit above this temperature

Range (-128C –127C)

Low must be smaller than High

(High –Low) must be greater than 10

Time Offset

Time offset in

Minutes from

UTC 00:00:00

U16

2 Bytes

0 –1440 minutes. This will dictate at what time

of day the unit will report.

0xFFFF disables the “minute of day” reporting

User Guide to PL131

Document Number 1155-4713 Rev E

Page 14

CONFIDENTIAL

Information classified Confidential - Do not copy (See last page for obligations)

This document contains confidential and proprietary information of Quake Global corporation. It may be used by recipient only for the purpose for which it was transmitted

and will be returned upon request or when no longer needed by recipient. Disclosure to unauthorized third parties or duplication without the express written permission of

Table 4-6.1: Example Configuration message

Data

Size

C7 FA 80 A0 85 FF 40 1E

9 bytes

Table 4-6.2: Example Configuration message - parsed

Field Name

Data (Hex)

Parsed Value

Message opcode

Configuration message

Enable Motion Detection

FA 80

Enabled

Motion Detection Threshold

250 milli-G

Enable Breadcrumbs

A0 85

Enabled

Breadcrumb interval

1440 minutes

Temperature Threshold Low

-1 degree Celsius

Temperature Threshold High

50 degrees Celsius

Reporting Offset

Unit will report at 00:30:00 UTC

4.2 Message flows

4.2.1 Message reporting flowchart

Messages will be stored on the file system in a circular buffer (FIFO) that is 30 days deep. When

generated, the message is saved to the file system. Any and all pending messages should be sent

during a wake up session unless a failure occurs. Any messages not sent due to a failure will not be

deleted, and the unit will attempt to send them during the next wakeup session.

User Guide to PL131

Document Number 1155-4713 Rev E

Page 15

CONFIDENTIAL

Information classified Confidential - Do not copy (See last page for obligations)

This document contains confidential and proprietary information of Quake Global corporation. It may be used by recipient only for the purpose for which it was transmitted

and will be returned upon request or when no longer needed by recipient. Disclosure to unauthorized third parties or duplication without the express written permission of

Locator wakes up

Get:

 location fix from GPS

 temperature reading

 battery voltage

 signal strength

 wake-up event type

Is network

available?

Queue message

Attempt connection

to server

Did Locator

connect to

server?

Yes

Send

message

to server

Did

Locator receive a

message back from

server?

Did server

send new

configuration?

Did server send

factory reset?

Save

configuration

Queue ACK

Yes

Set Locator to

factory defaults

Did server send

NAK or ACK?

Remove msg

from queue

End Process

Queue NACK

Remove msg

from queue

configuration

valid?

Yes

Queue NACK

Yes

Remove msg

from queue

Did server send

FOTA header?

Did server send

FOTA data pkt?

Enough space in

file system?

Yes

Change retries to

20 for Sat

Queue ACK

BEGIN

FOTA

Yes

Is a FOTA in

progress?

Yes

Change retries to

20 for Sat

CONTINUE

FOTA

Yes

Queue message

Yes

End FOTA

No No

User Guide to PL131

Document Number 1155-4713 Rev E

Page 16

CONFIDENTIAL

Information classified Confidential - Do not copy (See last page for obligations)

This document contains confidential and proprietary information of Quake Global corporation. It may be used by recipient only for the purpose for which it was transmitted

and will be returned upon request or when no longer needed by recipient. Disclosure to unauthorized third parties or duplication without the express written permission of